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

    Interface RoutingRulePayload

    The payload of a routing-rule action.

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

    interface RoutingRulePayload {
        auditReason?: string;
        destinationRef?: string;
        enhancedStatusCode?: string;
        message?: string;
        objectKeyPrefix?: string;
        objectKeyTemplate?: string;
        operations?: readonly ModifyHeaderOperation[];
        poolId?: string;
        recipients?: readonly string[];
        relayRef?: string;
        smtpStatusCode?: number;
        storageRef?: string;
        templateRef?: string;
        webhookRef?: string;
    }
    Index
    auditReason? destinationRef? enhancedStatusCode? message? objectKeyPrefix? objectKeyTemplate? operations? poolId? recipients? relayRef? smtpStatusCode? storageRef? templateRef? webhookRef?
    auditReason?: string

    Audit reason, for DROP and REJECT.

    destinationRef?: string

    Destination reference, for SMTP_FORWARD.

    enhancedStatusCode?: string

    Enhanced status code, for REJECT.

    message?: string

    Rejection message, for REJECT.

    objectKeyPrefix?: string

    Object-key prefix, for S3_STORE.

    objectKeyTemplate?: string

    Object-key template, for S3_STORE.

    operations?: readonly ModifyHeaderOperation[]

    Header operations, for MODIFY_HEADER.

    poolId?: string

    Dedicated IP pool id, for DELIVER_DEDICATED.

    recipients?: readonly string[]

    Added recipients, for ADD_RECIPIENT.

    relayRef?: string

    Relay reference, for SMARTHOST_RELAY and RELAY.

    smtpStatusCode?: number

    SMTP status code, for REJECT.

    storageRef?: string

    Storage reference, for S3_STORE.

    templateRef?: string

    Template reference, for AUTO_REPLY.

    webhookRef?: string

    Webhook reference, for NOTIFY_WEBHOOK and DELIVER_WEBHOOK.

    Settings
    Member Visibility

    On This Page
    Properties