Auto-Generated Documentation

This set of documentation is automatically generated from source, and will help ensure any change to functionality will always be documented and available on release.

Email

Event details relating to an email transaction.

Field	Type	Description	Required	Default
attachments	List [Attachment]	None	Optional	None
bcc	Address	The email address of BCC recipient.	Optional	None
cc	Address	The email address of CC recipient.	Optional	None
content_type	Keyword	Information about how the message is to be displayed.	Optional	None
delivery_timestamp	Date	The date and time when the email message was received by the service or client.	Optional	None
direction	Keyword	The direction of the message based on the sending and receiving domains.	Optional	None
from	Address	The email address of the sender, typically from the RFC 5322 From: header field.	Optional	None
local_id	Keyword	Unique identifier given to the email by the source that created the event.	Optional	None
message_id	Keyword	Identifier from the RFC 5322 Message-ID: email header that refers to a particular email message.	Optional	None
origination_timestamp	Date	The date and time the email message was composed.	Optional	None
reply_to	Address	The address that replies should be delivered to based on the value in the RFC 5322 Reply-To: header.	Optional	None
sender	Address	Per RFC 5322, specifies the address responsible for the actual transmission of the message.	Optional	None
subject	Keyword	A brief summary of the topic of the message.	Optional	None
to	Address	The email address of recipient.	Optional	None
x_mailer	Keyword	The name of the application that was used to draft and send the original email message.	Optional	None
parent	ParentEmail	Metadata about the parent email.	Optional	None