spamassassin-client/lib/spamassassin_client.d.ts

SpamAssassin client, that lets you check if an email is spam or ham.

// spamassassin-client
// Copyright 2024, Valerian Saliou
// Author: Valerian Saliou <valerian@valeriansaliou.name>

export declare interface Options {
  host?: string;
  port?: number;
  timeout?: number;
}

export declare interface GenericResult {
  code: number;
  message: string;
}

export declare interface CheckResult extends GenericResult {
  spam: boolean;
  score: number;
}

export declare interface SymbolsResult extends CheckResult {
  symbols: Array<string>;
}

export declare interface ReportResult extends CheckResult {
  report: string;
}

export declare class SpamAssassinClient {
  constructor(options: Options);
  check(message: string | Buffer): Promise<CheckResult>;
  symbols(message: string | Buffer): Promise<SymbolsResult>;
  report(message: string | Buffer): Promise<ReportResult>;
  ping(): Promise<GenericResult>;
}

export {};