Interface MailpitMessagesSummaryResponse

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

interface MailpitMessagesSummaryResponse {
    count: number;
    messages: {
        Attachments: number;
        Bcc: MailpitEmailAddressResponse[];
        Cc: MailpitEmailAddressResponse[];
        Created: string;
        From: MailpitEmailAddressResponse;
        ID: string;
        MessageID: string;
        Read: boolean;
        ReplyTo: MailpitEmailAddressResponse[];
        Size: number;
        Snippet: string;
        Subject: string;
        Tags: string[];
        To: MailpitEmailAddressResponse[];
        Username?: string;
    }[];
    messages_count: number;
    messages_unread: number;
    start: number;
    tags: string[];
    total: number;
    unread: number;
}

Index

Properties

count messages messages_count messages_unread start tags total unread

Properties

count

count: number

Deprecated

No longer documented upstream

messages

messages: {
    Attachments: number;
    Bcc: MailpitEmailAddressResponse[];
    Cc: MailpitEmailAddressResponse[];
    Created: string;
    From: MailpitEmailAddressResponse;
    ID: string;
    MessageID: string;
    Read: boolean;
    ReplyTo: MailpitEmailAddressResponse[];
    Size: number;
    Snippet: string;
    Subject: string;
    Tags: string[];
    To: MailpitEmailAddressResponse[];
    Username?: string;
}[]

Messages

Type declaration

Attachments: number
The number of attachments
Bcc: MailpitEmailAddressResponse[]
BCC addresses
Cc: MailpitEmailAddressResponse[]
CC addresses
Created: string
Created time in ISO format: 1970-01-01T00:00:00.000Z
From: MailpitEmailAddressResponse
Sender address
ID: string
Database ID
MessageID: string
Message ID
Read: boolean
Read status
ReplyTo: MailpitEmailAddressResponse[]
Reply-To addresses
Size: number
Message size in bytes (total)
Snippet: string
Message snippet includes up to 250 characters
Subject: string
Email subject
Tags: string[]
Message tags
To: MailpitEmailAddressResponse[]
To addresses
OptionalUsername?: string
Username used for authentication (if provided) with the SMTP or sendMessage

messages_count

messages_count: number

Total number of messages matching the current query

messages_unread

messages_unread: number

Total number of unread messages matching current query

start

start: number

Pagination offset

total

total: number

Total number of messages in mailbox

unread

unread: number

Total number of unread messages in mailbox

Interface MailpitMessagesSummaryResponse

Index

Properties

Properties

count

Deprecated

messages

Type declaration

Attachments: number

Bcc: MailpitEmailAddressResponse[]

Cc: MailpitEmailAddressResponse[]

Created: string

From: MailpitEmailAddressResponse

ID: string

MessageID: string

Read: boolean

ReplyTo: MailpitEmailAddressResponse[]

Size: number

Snippet: string

Subject: string

Tags: string[]

To: MailpitEmailAddressResponse[]

`Optional`Username?: string

messages_count

messages_unread

start

tags

total

unread

Settings

On This Page

Interface MailpitMessagesSummaryResponse

Index

Properties

Properties

count

Deprecated

messages

Type declaration

Attachments: number

Bcc: MailpitEmailAddressResponse[]

Cc: MailpitEmailAddressResponse[]

Created: string

From: MailpitEmailAddressResponse

ID: string

MessageID: string

Read: boolean

ReplyTo: MailpitEmailAddressResponse[]

Size: number

Snippet: string

Subject: string

Tags: string[]

To: MailpitEmailAddressResponse[]

OptionalUsername?: string

messages_count

messages_unread

start

tags

total

unread

Settings

On This Page

`Optional`Username?: string