Interface ForwardableEmailMessage

An email message that is sent to a consumer Worker and can be rejected/forwarded.

interface ForwardableEmailMessage {
    from: string;
    headers: Headers;
    raw: ReadableStream<Uint8Array>;
    rawSize: number;
    to: string;
    forward(rcptTo, headers?): Promise<void>;
    setReject(reason): void;
}

Hierarchy (view full)

Properties

from headers raw rawSize to

Methods

forward setReject

Properties

Readonly from

from: string

Envelope From attribute of the email message.

Readonly headers

headers: Headers

An Headers object.

Readonly raw

raw: ReadableStream<Uint8Array>

Stream of the email message content.

Readonly rawSize

rawSize: number

Size of the email message content.

Readonly to

to: string

Envelope To attribute of the email message.

Methods

forward

  • forward(rcptTo, headers?): Promise<void>

  • Forward this email message to a verified destination address of the account.

    Parameters

    Returns Promise<void>

    A promise that resolves when the email message is forwarded.

setReject

  • setReject(reason): void

  • Reject this email message by returning a permanent SMTP error back to the connecting client including the given reason.

    Parameters

    • reason: string

      The reject reason.

    Returns void

    void

Settings

Member Visibility

Theme

On This Page

fromheadersrawrawSizetoforwardsetReject