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

    Interface MailpitInfoResponse

    Response for the getInfo() API containing information about the Mailpit instance.

    interface MailpitInfoResponse {
        Database: string;
        DatabaseSize: number;
        LatestVersion: string;
        Messages: number;
        RuntimeStats: {
            Memory: number;
            MessagesDeleted: number;
            SMTPAccepted: number;
            SMTPAcceptedSize: number;
            SMTPIgnored: number;
            SMTPRejected: number;
            Uptime: number;
        };
        Tags: { [key: string]: number };
        Unread: number;
        Version: string;
    }
    Index

    Properties

    Database DatabaseSize LatestVersion Messages RuntimeStats Tags Unread Version

    Properties

    Database: string

    Database path

    DatabaseSize: number

    Datacase size in bytes

    LatestVersion: string

    Latest Mailpit version

    Messages: number

    Total number of messages in the database

    RuntimeStats: {
        Memory: number;
        MessagesDeleted: number;
        SMTPAccepted: number;
        SMTPAcceptedSize: number;
        SMTPIgnored: number;
        SMTPRejected: number;
        Uptime: number;
    }

    Runtime statistics

    Type declaration

    • Memory: number

      Current memory usage in bytes

    • MessagesDeleted: number

      Database runtime messages deleted

    • SMTPAccepted: number

      Accepted runtime SMTP messages

    • SMTPAcceptedSize: number

      Total runtime accepted messages size in bytes

    • SMTPIgnored: number

      Ignored runtime SMTP messages (when using --ignore-duplicate-ids)

    • SMTPRejected: number

      Rejected runtime SMTP messages

    • Uptime: number

      Mailpit server uptime in seconds

    Tags: { [key: string]: number }

    Tag information

    Type declaration

    • [key: string]: number

      Tag names and the total messages per tag

    Unread: number

    Total number of messages in the database

    Version: string

    Current Mailpit version

    Settings

    Member Visibility

    On This Page

    Properties