Skip to main content

EmailOverrideDto

Per-request overrides for the email channel.

bccstring[]nullable

Canonical blind-carbon-copy recipients. Count-capped, each address syntactically validated like reply_to.

ccstring[]nullable

Canonical carbon-copy recipients. Count-capped, each address syntactically validated like reply_to.

customHeaders object | null

Additional SMTP headers to attach, such as X-Campaign-Id. Headers that carry routing or authentication identity (From, Reply-To, DKIM-Signature, …) are refused at ingress; a caller sets those through the canonical fields instead.

property name*string
fromstring | nullnullable

Canonical From address for this message (e.g. billing@yourcompany.com).

This is the only email sender field on the wire: the deprecated umbrella sender spelling was removed with proto tag 1 reserved (ticket 32). Shape-checked on ingress; whether the workspace actually owns the address is decided by the worker.

from_namestring | nullnullable

Optional display name paired with from (e.g. "Nervly Billing").

providerstring | nullnullable

Preferred or forced email provider for this event (e.g. "resend", "zeptomail").

Example: resend
reply_tostring | nullnullable

Canonical reply-to address. A single, syntactically valid address.

EmailOverrideDto
{
"bcc": "Unknown Type: array,null",
"cc": "Unknown Type: array,null",
"customHeaders": "Unknown Type: object,null",
"from": "string",
"from_name": "string",
"provider": "resend",
"reply_to": "string"
}