Email Transmission Object


An email transmission represents a single email send request, including its recipients, HTML content, sender information, type, and delivery status. Creating an email transmission triggers the email to be sent asynchronously to all specified recipients.

Properties
createdDatestringRead-onlyformat date-time

Date and time the email transmission was created.


customHeadersMap <string, string>maxItems 20format map

Custom headers to include in the email. Keys should have max length of 64 and must start with a letter and contain only letters, digits and hyphens. Keys are case insensitive and must be unique (for example, "X-Foo" and "x-foo" cannot both be provided). Values should have max length of 900 and must contain only printable ASCII characters (0x20-0x7E). The keys should not contain reserved headers (case insensitive) from this list:

  • BCC
  • CC
  • Content-Type
  • Content-Transfer-Encoding
  • DKIM-Signature
  • Feedback-ID
  • From
  • Precedence
  • Received
  • Reply-To
  • Return-Path
  • Sender
  • Subject
  • To
  • X-Abuse-Id If provided header happens to be also set by the system internally (for example "List-Unsubscribe"), provided header value will then be overridden.

emailHtmlContentstringmaxLength 1000000

Full HTML content of the email.

Not returned in queryEmailTransmissions. Use getEmailTransmission to retrieve the HTML content of a specific transmission.

Stored for 30 days after the transmission is created. After that, this field returns "<expired>".


emailSubjectstringmaxLength 200

Subject line of the email.


emailTextContentstringminLength 1maxLength 200000

Plain text content of the email (optional).

Not returned in queryEmailTransmissions. Use getEmailTransmission to retrieve the text content of a specific transmission.

Stored for 30 days after the transmission is created. After that, this field returns "<expired>".


idstringRead-onlyformat GUID

Email transmission ID.


metadataMap <string, string>maxItems 10format map

Custom key-value pairs attached to the transmission to identify the context in which the email was sent. These values are passed to the email service provider and included in domain event payloads. Keys and values support letters, numbers, and hyphens only (no spaces or other special characters).

Default: {}


replyToRecipient

Recipient that receives replies to this email. When a recipient replies, the reply is directed to this address instead of the sender address.

Default: When senderEmailAddress is provided and the email is sent from the Wix shared sender address, replies are automatically directed to senderEmailAddress.


revisionstringRead-onlyformat int64

Revision number, which increments by 1 each time the email transmission is updated.


senderEmailAddressstringformat EMAIL

Sender email address. Must be verified using the Sender Emails API before use.

If the provided address can't be used as a FROM address (for example, addresses from free email providers such as gmail.com), the email is sent from no-reply@et.wixsitemail.com and the provided address is automatically used as the reply-to address instead.

Default: no-reply@et.wixsitemail.com


senderNamestringminLength 1maxLength 50

Display name shown as the sender.

Default: None (no display name is set).


statusstringRead-only

Current status of the email transmission.


rejectedOptionsRejectedOptionsRead-only

Details about why the email transmission was rejected.

Returned only when status is REJECTED.


toRecipientsArray <Recipient>minItems 1maxItems 100

List of recipients the email is sent to.


typestring

Email type.


marketingOptionsMarketingOptions

Options for marketing emails.

Used only when type is MARKETING.


updatedDatestringRead-onlyformat date-time

Date and time the email transmission was last updated.

Did this help?