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;
}

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

total: number

Total number of messages in mailbox

unread: number

Total number of unread messages in mailbox