@mxraven/admin - v2.1.0
    Preparing search index...

    Interface TerminalActionPayload

    The payload of a terminal action.

    All fields are optional; which ones apply depends on the action type. The factory functions on terminalActionPayload validate and build these shapes.

    interface TerminalActionPayload {
        auditReason?: string;
        enhancedStatusCode?: string;
        message?: string;
        poolId?: string;
        relayRef?: string;
        smtpStatusCode?: number;
        templateRef?: string;
    }
    Index
    auditReason?: string

    Audit reason, for DROP and REJECT.

    enhancedStatusCode?: string

    Enhanced status code, for REJECT.

    message?: string

    Rejection message, for REJECT.

    poolId?: string

    Dedicated IP pool id, for DELIVER_DEDICATED.

    relayRef?: string

    Relay reference, for SMARTHOST_RELAY and RELAY.

    smtpStatusCode?: number

    SMTP status code, for REJECT.

    templateRef?: string

    Auto-reply template reference, for AUTO_REPLY.