ForwardableEmailMessage

Defined in: .pnpm-home/store/v11/links/@cloudflare/workers-types/4.20251118.0/2891147a4db443bf13ca098dcb7381fb6bac5793758b7fd187ebaf5bc0deb969/node_modules/@cloudflare/workers-types/index.ts:8699

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

Extends

EmailMessage

Properties

from

readonly from: string

Defined in: .pnpm-home/store/v11/links/@cloudflare/workers-types/4.20251118.0/2891147a4db443bf13ca098dcb7381fb6bac5793758b7fd187ebaf5bc0deb969/node_modules/@cloudflare/workers-types/index.ts:8690

Envelope From attribute of the email message.

Inherited from

EmailMessage.from

headers

readonly headers: Headers

Defined in: .pnpm-home/store/v11/links/@cloudflare/workers-types/4.20251118.0/2891147a4db443bf13ca098dcb7381fb6bac5793758b7fd187ebaf5bc0deb969/node_modules/@cloudflare/workers-types/index.ts:8707

An Headers object.

raw

readonly raw: ReadableStream<Uint8Array<ArrayBufferLike>>

Defined in: .pnpm-home/store/v11/links/@cloudflare/workers-types/4.20251118.0/2891147a4db443bf13ca098dcb7381fb6bac5793758b7fd187ebaf5bc0deb969/node_modules/@cloudflare/workers-types/index.ts:8703

Stream of the email message content.

rawSize

readonly rawSize: number

Defined in: .pnpm-home/store/v11/links/@cloudflare/workers-types/4.20251118.0/2891147a4db443bf13ca098dcb7381fb6bac5793758b7fd187ebaf5bc0deb969/node_modules/@cloudflare/workers-types/index.ts:8711

Size of the email message content.

to

readonly to: string

Defined in: .pnpm-home/store/v11/links/@cloudflare/workers-types/4.20251118.0/2891147a4db443bf13ca098dcb7381fb6bac5793758b7fd187ebaf5bc0deb969/node_modules/@cloudflare/workers-types/index.ts:8694

Envelope To attribute of the email message.

Inherited from

EmailMessage.to

Methods

forward()

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

Defined in: .pnpm-home/store/v11/links/@cloudflare/workers-types/4.20251118.0/2891147a4db443bf13ca098dcb7381fb6bac5793758b7fd187ebaf5bc0deb969/node_modules/@cloudflare/workers-types/index.ts:8724

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

Parameters

rcptTo

string

Verified destination address.

headers?

Headers

A Headers object.

Returns

Promise<void>

A promise that resolves when the email message is forwarded.

reply()

reply(message): Promise<void>

Defined in: .pnpm-home/store/v11/links/@cloudflare/workers-types/4.20251118.0/2891147a4db443bf13ca098dcb7381fb6bac5793758b7fd187ebaf5bc0deb969/node_modules/@cloudflare/workers-types/index.ts:8730

Reply to the sender of this email message with a new EmailMessage object.

Parameters

message

EmailMessage

The reply message.

Returns

Promise<void>

A promise that resolves when the email message is replied.

setReject()

setReject(reason): void

Defined in: .pnpm-home/store/v11/links/@cloudflare/workers-types/4.20251118.0/2891147a4db443bf13ca098dcb7381fb6bac5793758b7fd187ebaf5bc0deb969/node_modules/@cloudflare/workers-types/index.ts:8717

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