Documentation
    Preparing search index...

    Interface MailpitWaitForMessagesRequest

    Request parameters for the waitForMessages() API.

    interface MailpitWaitForMessagesRequest {
        count?: number;
        exact?: boolean;
        limit?: number;
        query?: string;
        start?: number;
        tz?: string;
    }
    Index

    Properties

    count? exact? limit? query? start? tz?

    Properties

    count?: number

    Number of messages to wait for.

    1
    exact?: boolean

    If true, require messages_count === count. If false (default), require messages_count >= count. When count is 0, always uses exact match regardless of this option.

    false
    limit?: number

    Limit results

    query?: string

    Optional Search query. If omitted, polls all messages.

    start?: number

    Pagination offset

    tz?: string

    Timezone identifier used only for before: & after: searches (eg: "Pacific/Auckland").

    Settings

    Member Visibility

    On This Page

    Properties