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

    Interface MailpitMessagesSummaryResponse

    Response for the listMessages() API containing the summary of multiple messages.

    interface MailpitMessagesSummaryResponse {
        count: number;
        messages: MailpitMessageListItem[];
        messages_count: number;
        messages_unread: number;
        start: number;
        tags: string[];
        total: number;
        unread: number;
    }
    Index

    Properties

    count: number

    No longer documented upstream

    Messages

    messages_count: number

    Total number of messages matching the current query

    messages_unread: number

    Total number of unread messages matching current query

    start: number

    Pagination offset

    tags: string[]

    All current tags

    total: number

    Total number of messages in mailbox

    unread: number

    Total number of unread messages in mailbox