Variable terminalActionPayloadConst

Type Declaration

• autoReply: function

  • autoReply(templateRef: string): TerminalActionPayload

    Builds an AUTO_REPLY payload.

    Parameters

    • templateRef: string

      The template reference.

    Returns TerminalActionPayload

    The payload.

• deliver: function

  • deliver(): TerminalActionPayload

    The shared-path delivery payload, which is empty.

    Returns TerminalActionPayload

    An empty payload.

• deliverDedicated: function

  • deliverDedicated(poolId: string): TerminalActionPayload

    Builds a DELIVER_DEDICATED payload.

    Parameters

    • poolId: string

      The dedicated IP pool id.

    Returns TerminalActionPayload

    The payload.

    Throws

    Error When the pool id is not a UUID.

• drop: function

  • drop(auditReason?: string): TerminalActionPayload

    Builds a DROP payload.

    Parameters

    • OptionalauditReason: string

      An optional audit reason.

    Returns TerminalActionPayload

    The payload.

• empty: function

  • empty(): TerminalActionPayload

    An empty payload, for actions that take none.

    Returns TerminalActionPayload

    An empty payload.

• of: function

  • of(values: TerminalActionPayload): TerminalActionPayload

    Wraps a raw payload, for shapes not covered by the typed factories.

    Parameters

    • values: TerminalActionPayload

      The payload.

    Returns TerminalActionPayload

    The payload unchanged.

• reject: function

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

    Builds a REJECT payload.

    Parameters

    • smtpStatusCode: number

      The SMTP status code, in the 5xx range.

    • enhancedStatusCode: string

      The enhanced status code, in class.subject.detail form.

    • message: string

      The rejection message.

    • OptionalauditReason: string

      An optional audit reason.

    Returns TerminalActionPayload

    The payload.

    Throws

    Error When a field fails validation.

• relay: function

  • relay(relayRef: string): TerminalActionPayload

    Builds a RELAY payload.

    Parameters

    • relayRef: string

      The relay reference.

    Returns TerminalActionPayload

    The payload.

• smartHostRelay: function

  • smartHostRelay(relayRef: string): TerminalActionPayload

    Builds a SMARTHOST_RELAY payload.

    Parameters

    • relayRef: string

      The relay reference.

    Returns TerminalActionPayload

    The payload.