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

    Interface MailpitMessageSummaryResponse

    Response for the getMessageSummary() API containing the summary of a message

    interface MailpitMessageSummaryResponse {
        Attachments: MailpitAttachmentResponse[];
        Bcc: MailpitEmailAddressResponse[];
        Cc: MailpitEmailAddressResponse[];
        Date: string;
        From: MailpitEmailAddressResponse;
        HTML: string;
        ID: string;
        Inline: MailpitAttachmentResponse[];
        ListUnsubscribe: {
            Errors: string;
            Header: string;
            HeaderPost: string;
            Links: string[];
        };
        MessageID: string;
        ReplyTo: MailpitEmailAddressResponse[];
        ReturnPath: string;
        Size: number;
        Subject: string;
        Tags: string[];
        Text: string;
        To: MailpitEmailAddressResponse[];
        Username?: string;
    }
    Index

    Properties

    Attachments Bcc Cc Date From HTML ID Inline ListUnsubscribe MessageID ReplyTo ReturnPath Size Subject Tags Text To Username?

    Properties

    Attachments: MailpitAttachmentResponse[]

    Message Attachmets

    Bcc: MailpitEmailAddressResponse[]

    BCC addresses

    Cc: MailpitEmailAddressResponse[]

    CC addresses

    Date: string

    Message date if set, else date received. In ISO format: 1970-01-01T00:00:00.000Z

    From: MailpitEmailAddressResponse

    sender address

    HTML: string

    Message body HTML

    ID: string

    Database ID

    Inline: MailpitAttachmentResponse[]

    Inline message attachements

    ListUnsubscribe: {
        Errors: string;
        Header: string;
        HeaderPost: string;
        Links: string[];
    }

    ListUnsubscribe contains a summary of List-Unsubscribe & List-Unsubscribe-Post headers including validation of the link structure

    Type declaration

    • Errors: string

      Validation errors (if any)

    • Header: string

      List-Unsubscrobe header value

    • HeaderPost: string

      List-Unsubscribe-Post valie (if set)

    • Links: string[]

      Detected links, maximum one email and one HTTP(S) link

    MessageID: string

    Message ID

    ReplyTo: MailpitEmailAddressResponse[]

    ReplyTo addresses

    ReturnPath: string

    Return-Path

    Size: number

    Message size in bytes

    Subject: string

    Message subject

    Tags: string[]

    Messages tags

    Text

    Text: string

    Message body text

    To: MailpitEmailAddressResponse[]

    To addresses

    Username?: string

    Username used for authentication (if provided) with the SMTP or sendMessage

    Settings

    Member Visibility

    On This Page

    Properties