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.


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.

Default: None (email is sent without a subject line).


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 alphanumeric characters only (letters and numbers, no spaces or 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@wixsitemail.com and the provided address is automatically used as the reply-to address instead.

Default: no-reply@wixsitemail.com


senderNamestringminLength 1maxLength 50

Display name shown as the sender.

Default: None (no display name is set).


statusstringRead-only

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

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?