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

    Interface MailpitConfigurationResponse

    Response for the getConfiguraton() API containing configuration for the Mailpit web UI.

    interface MailpitConfigurationResponse {
        ChaosEnabled: boolean;
        DuplicatesIgnored: boolean;
        HideDeleteAllButton: boolean;
        Label: string;
        MessageRelay: {
            AllowedRecipients: string;
            BlockedRecipients: string;
            Enabled: boolean;
            OverrideFrom: string;
            PreserveMessageIDs: boolean;
            RecipientAllowlist: string;
            ReturnPath: string;
            SMTPServer: string;
        };
        SpamAssassin: boolean;
    }
    Index

    Properties

    ChaosEnabled DuplicatesIgnored HideDeleteAllButton Label MessageRelay SpamAssassin

    Properties

    ChaosEnabled: boolean

    Whether Chaos support is enabled at runtime

    DuplicatesIgnored: boolean

    Whether messages with duplicate IDs are ignored

    HideDeleteAllButton: boolean

    Whether the delete button should be hidden

    Label: string

    Label to identify this Mailpit instance

    MessageRelay: {
        AllowedRecipients: string;
        BlockedRecipients: string;
        Enabled: boolean;
        OverrideFrom: string;
        PreserveMessageIDs: boolean;
        RecipientAllowlist: string;
        ReturnPath: string;
        SMTPServer: string;
    }

    Type declaration

    • AllowedRecipients: string

      Only allow relaying to these recipients (regex)

    • BlockedRecipients: string

      Block relaying to these recipients (regex)

    • Enabled: boolean

      Whether message relaying (release) is enabled

    • OverrideFrom: string

      Overrides the "From" address for all relayed messages

    • PreserveMessageIDs: boolean

      Preserve the original Message-IDs when relaying messages

    • RecipientAllowlist: string

      Refer to AllowedRecipients instead. No longer documented upstream

    • ReturnPath: string

      Enforced Return-Path (if set) for relay bounces

    • SMTPServer: string

      The configured SMTP server address

    SpamAssassin: boolean

    Whether SpamAssassin is enabled

    Settings

    Member Visibility

    On This Page

    Properties