Variable routingRuleActionConst

Type Declaration

• addRecipient: function

  • addRecipient(recipients: readonly string[]): RoutingRuleAction

    Builds an ADD_RECIPIENT action.

    Parameters

    • recipients: readonly string[]

      The recipients to add, 1–100.

    Returns RoutingRuleAction

    The action.

• autoReply: function

  • autoReply(templateRef: string): RoutingRuleAction

    Builds an AUTO_REPLY action.

    Parameters

    • templateRef: string

      The template reference.

    Returns RoutingRuleAction

    The action.

• deliver: function

  • deliver(): RoutingRuleAction

    Builds a DELIVER action.

    Returns RoutingRuleAction

    The action.

• deliverDedicated: function

  • deliverDedicated(poolId: string): RoutingRuleAction

    Builds a DELIVER_DEDICATED action.

    Parameters

    • poolId: string

      The dedicated IP pool id.

    Returns RoutingRuleAction

    The action.

• deliverWebhook: function

  • deliverWebhook(webhookRef: string): RoutingRuleAction

    Builds a DELIVER_WEBHOOK action.

    Parameters

    • webhookRef: string

      The webhook reference.

    Returns RoutingRuleAction

    The action.

• drop: function

  • drop(auditReason?: string): RoutingRuleAction

    Builds a DROP action.

    Parameters

    • OptionalauditReason: string

      An optional audit reason.

    Returns RoutingRuleAction

    The action.

• modifyHeader: function

  • modifyHeader(operations: readonly ModifyHeaderOperation[]): RoutingRuleAction

    Builds a MODIFY_HEADER action.

    Parameters

    • operations: readonly ModifyHeaderOperation[]

      The header operations, 1–100.

    Returns RoutingRuleAction

    The action.

• notifyWebhook: function

  • notifyWebhook(webhookRef: string): RoutingRuleAction

    Builds a NOTIFY_WEBHOOK action.

    Parameters

    • webhookRef: string

      The webhook reference.

    Returns RoutingRuleAction

    The action.

• of: function

  • of(
        actionType: RoutingRuleActionKind,
        actionPayload: RoutingRulePayload,
    ): RoutingRuleAction

    Wraps a raw action.

    Parameters

    • actionType: RoutingRuleActionKind

      The action kind.

    • actionPayload: RoutingRulePayload

      The action payload.

    Returns RoutingRuleAction

    The action.

• reject: function

  • reject(
        smtpStatusCode: number,
        enhancedStatusCode: string,
        message: string,
        auditReason?: string,
    ): RoutingRuleAction

    Builds a REJECT action.

    Parameters

    • smtpStatusCode: number

      The SMTP status code, in the 5xx range.

    • enhancedStatusCode: string

      The enhanced status code, 5.subject.detail.

    • message: string

      The rejection message.

    • OptionalauditReason: string

      An optional audit reason.

    Returns RoutingRuleAction

    The action.

• relay: function

  • relay(relayRef: string): RoutingRuleAction

    Builds a RELAY action.

    Parameters

    • relayRef: string

      The relay reference.

    Returns RoutingRuleAction

    The action.

• s3Store: function

  • s3Store(
        storageRef: string,
        objectKeyPrefix?: string,
        objectKeyTemplate?: string,
    ): RoutingRuleAction

    Builds an S3_STORE action.

    Parameters

    • storageRef: string

      The storage reference.

    • OptionalobjectKeyPrefix: string

      An object-key prefix ending in /, or undefined.

    • OptionalobjectKeyTemplate: string

      An object-key template, or undefined.

    Returns RoutingRuleAction

    The action.

• smartHostRelay: function

  • smartHostRelay(relayRef: string): RoutingRuleAction

    Builds a SMARTHOST_RELAY action.

    Parameters

    • relayRef: string

      The relay reference.

    Returns RoutingRuleAction

    The action.

• smtpForward: function

  • smtpForward(destinationRef: string): RoutingRuleAction

    Builds an SMTP_FORWARD action.

    Parameters

    • destinationRef: string

      The destination reference.

    Returns RoutingRuleAction

    The action.