mailpit-api - v1.7.2
    Preparing search index...

    Interface MailpitSpamAssassinResponse

    Response from the spamAssassinCheck() API containing containing SpamAssassin check results.

    interface MailpitSpamAssassinResponse {
        Error: string;
        IsSpam: boolean;
        Rules: { Description: string; Name: string; Score: number }[] | null;
        Score: number;
    }
    Index

    Properties

    Error IsSpam Rules Score

    Properties

    Error: string

    If populated will return an error string

    IsSpam: boolean

    Whether the message is spam or not

    Rules: { Description: string; Name: string; Score: number }[] | null

    Spam rules triggered and their score.

    Type Declaration

    • { Description: string; Name: string; Score: number }[]
      • Description: string

        SpamAssassin rule description

      • Name: string

        SpamAssassin rule name

      • Score: number

        Spam rule score

    • null

    The rules may return null if there is an error. Check the Error property for details.

    Score: number

    Total spam score based on triggered rules

    Settings

    Member Visibility

    On This Page

    Properties