Struct Email 

pub struct Email { /* private fields */ }

Event details relating to an email transaction.

This field set focuses on the email message header, body, and attachments. Network protocols that send and receive email messages such as SMTP are outside the scope of the email.* fields.

Implementations

impl Email

pub fn get_attachments(&self) -> &Vec<String>

A list of objects describing the attachment files sent along with an email message.

pub fn add_attachment(&mut self, attachment_arg: String)

A list of objects describing the attachment files sent along with an email message.

pub fn get_attachments_file_extension(&self) -> Option<&String>

Attachment file extension, excluding the leading dot.

pub fn set_attachments_file_extension( &mut self, attachments_file_extension_arg: String, )

Attachment file extension, excluding the leading dot.

Example

txt

pub fn get_attachments_file_mime_type(&self) -> Option<&String>

The MIME media type of the attachment.

This value will typically be extracted from the Content-Type MIME header field.

pub fn set_attachments_file_mime_type( &mut self, attachments_file_mime_type_arg: String, )

The MIME media type of the attachment.

This value will typically be extracted from the Content-Type MIME header field.

Example

text/plain

pub fn get_attachments_file_name(&self) -> Option<&String>

Name of the attachment file including the file extension.

pub fn set_attachments_file_name(&mut self, attachments_file_name_arg: String)

Name of the attachment file including the file extension.

Example

attachment.txt

pub fn get_attachments_file_size(&self) -> Option<&u64>

Attachment file size in bytes.

pub fn set_attachments_file_size(&mut self, attachments_file_size_arg: u64)

Attachment file size in bytes.

Example

64329

pub fn get_bcc_address(&self) -> &Vec<String>

The email address of BCC recipient

pub fn add_bcc_addres(&mut self, bcc_addres_arg: String)

The email address of BCC recipient

Example

bcc.user1@example.com

pub fn get_cc_address(&self) -> &Vec<String>

The email address of CC recipient

pub fn add_cc_addres(&mut self, cc_addres_arg: String)

The email address of CC recipient

Example

cc.user1@example.com

pub fn get_content_type(&self) -> Option<&String>

Information about how the message is to be displayed.

Typically a MIME type.

pub fn set_content_type(&mut self, content_type_arg: String)

Information about how the message is to be displayed.

Typically a MIME type.

Example

text/plain

pub fn get_delivery_timestamp(&self) -> Option<&Timestamp>

The date and time when the email message was received by the service or client.

pub fn set_delivery_timestamp(&mut self, delivery_timestamp_arg: Timestamp)

The date and time when the email message was received by the service or client.

Example

2020-11-10T22:12:34.8196921Z

pub fn get_direction(&self) -> Option<&String>

The direction of the message based on the sending and receiving domains.

pub fn set_direction(&mut self, direction_arg: String)

The direction of the message based on the sending and receiving domains.

Example

inbound

pub fn get_from_address(&self) -> &Vec<String>

The email address of the sender, typically from the RFC 5322 From: header field.

pub fn add_from_addres(&mut self, from_addres_arg: String)

The email address of the sender, typically from the RFC 5322 From: header field.

Example

sender@example.com

pub fn get_local_id(&self) -> Option<&String>

Unique identifier given to the email by the source that created the event.

Identifier is not persistent across hops.

pub fn set_local_id(&mut self, local_id_arg: String)

Unique identifier given to the email by the source that created the event.

Identifier is not persistent across hops.

Example

c26dbea0-80d5-463b-b93c-4e8b708219ce

pub fn get_message_id(&self) -> Option<&String>

Identifier from the RFC 5322 Message-ID: email header that refers to a particular email message.

pub fn set_message_id(&mut self, message_id_arg: String)

Identifier from the RFC 5322 Message-ID: email header that refers to a particular email message.

Example

81ce15$8r2j59@mail01.example.com

pub fn get_origination_timestamp(&self) -> Option<&Timestamp>

The date and time the email message was composed. Many email clients will fill in this value automatically when the message is sent by a user.

pub fn set_origination_timestamp( &mut self, origination_timestamp_arg: Timestamp, )

The date and time the email message was composed. Many email clients will fill in this value automatically when the message is sent by a user.

Example

2020-11-10T22:12:34.8196921Z

pub fn get_reply_to_address(&self) -> &Vec<String>

The address that replies should be delivered to based on the value in the RFC 5322 Reply-To: header.

pub fn add_reply_to_addres(&mut self, reply_to_addres_arg: String)

The address that replies should be delivered to based on the value in the RFC 5322 Reply-To: header.

Example

reply.here@example.com

pub fn get_sender_address(&self) -> Option<&String>

Per RFC 5322, specifies the address responsible for the actual transmission of the message.

pub fn set_sender_address(&mut self, sender_address_arg: String)

Per RFC 5322, specifies the address responsible for the actual transmission of the message.

pub fn get_subject(&self) -> Option<&String>

A brief summary of the topic of the message.

pub fn set_subject(&mut self, subject_arg: String)

A brief summary of the topic of the message.

Example

Please see this important message.

pub fn get_to_address(&self) -> &Vec<String>

The email address of recipient

pub fn add_to_addres(&mut self, to_addres_arg: String)

The email address of recipient

Example

user1@example.com

pub fn get_x_mailer(&self) -> Option<&String>

The name of the application that was used to draft and send the original email message.

pub fn set_x_mailer(&mut self, x_mailer_arg: String)

The name of the application that was used to draft and send the original email message.

Example

Spambot v2.5

Trait Implementations

impl Clone for Email

fn clone(&self) -> Email

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for Email

fn default() -> Email

Returns the “default value” for a type.

impl Serialize for Email

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.