Struct cloudmail::AmazonSES

Properties   Methods   Events   Config Settings   Errors  

The AmazonSES struct provides a simple interface to Amazon's Simple Email Service (SES).

Syntax

cloudmail::AmazonSES

Remarks

The AmazonSES component allows you to quickly and easily access Amazon's Simple Email Service (SES) through version 1 of the Amazon SES API. AmazonSES allows you to send both plaintext and HTML e-mails to recipients through your AWS account.

After signing up for AmazonSES you will use the Amazon provided access_key and secret_key to authenticate to Amazon. To send an e-mail set message_html or message_text along with from, subject, send_to and call send.

Various other administrative methods are also available, such as list_identities, verify_domain, verify_email, and more.

Object Lifetime

The new() method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by CloudMail. Due to this, the AmazonSES struct cannot be disposed of automatically. Please, call the dispose(&mut self) method of AmazonSES when you have finished using the instance.

Property List

The following is the full list of the properties of the struct with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the struct with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the struct with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the struct with short descriptions. Click on the links for further details.

access_key property (AmazonSES Struct)

The Access Key Id for the Amazon Web Services account.

Syntax

fn access_key(&self ) -> Result<String, CloudMailError> 
fn set_access_key(&self, value : &str) ->  Option<CloudMailError> 
fn set_access_key_ref(&self, value : &String) ->  Option<CloudMailError> 

Default Value

""

Remarks

This is the username for the Amazon Web Services account. No two accounts may have the same Access Key. This is used along with the secret_key to authenticate with Amazon servers.

Data Type

String

attachment_count property (AmazonSES Struct)

The number of records in the Attachment arrays.

Syntax

fn attachment_count(&self ) -> Result<i32, CloudMailError> 
fn set_attachment_count(&self, value : i32) ->  Option<CloudMailError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• attachment_data
• attachment_file_name
• attachment_name

The array indices start at 0 and end at attachment_count - 1.

Data Type

i32

attachment_data property (AmazonSES Struct)

The raw data for the attachment that will be sent with your message.

Syntax

fn attachment_data(&self , AttachmentIndex : i32) -> Result<Vec<u8>, CloudMailError> 
fn set_attachment_data(&self, AttachmentIndex : i32, value : Vec<u8>) ->  Option<CloudMailError> 
fn set_attachment_data_ref(&self, AttachmentIndex : i32, value : &[u8]) ->  Option<CloudMailError> 

Default Value

""

Remarks

The raw data for the attachment that will be sent with your message. This field is used if attachment_file_name is not set.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

Data Type

Vec

attachment_file_name property (AmazonSES Struct)

This property contains the path of a file on your system to be sent as an attachment with your message.

Syntax

fn attachment_file_name(&self , AttachmentIndex : i32) -> Result<String, CloudMailError> 
fn set_attachment_file_name(&self, AttachmentIndex : i32, value : &str) ->  Option<CloudMailError> 
fn set_attachment_file_name_ref(&self, AttachmentIndex : i32, value : &String) ->  Option<CloudMailError> 

Default Value

""

Remarks

This property contains the path of a file on your system to be sent as an attachment with your message.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

Data Type

String

attachment_name property (AmazonSES Struct)

This property contains the name of the attachment to be sent.

Syntax

fn attachment_name(&self , AttachmentIndex : i32) -> Result<String, CloudMailError> 
fn set_attachment_name(&self, AttachmentIndex : i32, value : &str) ->  Option<CloudMailError> 
fn set_attachment_name_ref(&self, AttachmentIndex : i32, value : &String) ->  Option<CloudMailError> 

Default Value

""

Remarks

This property contains the name of the attachment to be sent.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

Data Type

String

b_cc property (AmazonSES Struct)

This property includes a comma-separated list of addresses for blind carbon copies (optional).

Syntax

fn b_cc(&self ) -> Result<String, CloudMailError> 
fn set_b_cc(&self, value : &str) ->  Option<CloudMailError> 
fn set_b_cc_ref(&self, value : &String) ->  Option<CloudMailError> 

Default Value

""

Remarks

This property specifies a comma-separated list of destinations for blind carbon copies of the mail message. A copy of the message is sent to each destination. Because no BCc SMTP header is created containing the destination addresses, individual recipients never see the list of the other recipients.

The struct will return an error if the mail_server returns an error code about any email address specified in send_to or cc but it will fire an on_error event only if the same thing happens with an email address specified in this property.

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 822 specifications.

NOTE: You must clear the message_recipients properties before setting this property to remove previous recipients.

Data Type

String

cc property (AmazonSES Struct)

This property includes a comma-separated list of addresses for carbon copies (optional).

Syntax

fn cc(&self ) -> Result<String, CloudMailError> 
fn set_cc(&self, value : &str) ->  Option<CloudMailError> 
fn set_cc_ref(&self, value : &String) ->  Option<CloudMailError> 

Default Value

""

Remarks

This property specifies a comma-separated list of destinations for carbon copies of the mail message. A copy of the message is sent to each destination, and a Cc SMTP header is created containing the destination addresses. This header is sent to every recipient of the message. If you don't want to copy this information to every recipient, then use blind carbon copies instead (see the description of the b_cc).

The struct will return an error if the mail_server returns an error code about any email address specified in send_to or cc but it will fire an on_error event only if the same thing happens with an email address specified in b_cc.

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 822 specifications.

NOTE: You must clear the message_recipients properties before setting this property to remove previous recipients.

Data Type

String

delivery_notification_to property (AmazonSES Struct)

This property includes the email address to which to send a delivery notification.

Syntax

fn delivery_notification_to(&self ) -> Result<String, CloudMailError> 
fn set_delivery_notification_to(&self, value : &str) ->  Option<CloudMailError> 
fn set_delivery_notification_to_ref(&self, value : &String) ->  Option<CloudMailError> 

Default Value

""

Remarks

This property contains the email address to send to which to send a delivery notification. When set, a Return-Receipt-To header is added to the message. This property should be set to an email address that can receive the delivery notification.

Data Type

String

firewall_auto_detect property (AmazonSES Struct)

Whether to automatically detect and use firewall system settings, if available.

Syntax

fn firewall_auto_detect(&self ) -> Result<bool, CloudMailError> 
fn set_firewall_auto_detect(&self, value : bool) ->  Option<CloudMailError> 

Default Value

false

Remarks

Whether to automatically detect and use firewall system settings, if available.

Data Type

bool

firewall_type property (AmazonSES Struct)

The type of firewall to connect through.

Syntax

fn firewall_type(&self ) -> Result<i32, CloudMailError> 
fn set_firewall_type(&self, value : i32) ->  Option<CloudMailError> 

Possible Values

0   // None
1   // Tunnel
2   // SOCKS4
3   // SOCKS5
10   // SOCKS4A

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

Data Type

i32

firewall_host property (AmazonSES Struct)

The name or IP address of the firewall (optional).

Syntax

fn firewall_host(&self ) -> Result<String, CloudMailError> 
fn set_firewall_host(&self, value : &str) ->  Option<CloudMailError> 
fn set_firewall_host_ref(&self, value : &String) ->  Option<CloudMailError> 

Default Value

""

Remarks

The name or IP address of the firewall (optional). If a firewall_host is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the struct fails with an error.

Data Type

String

firewall_password property (AmazonSES Struct)

A password if authentication is to be used when connecting through the firewall.

Syntax

fn firewall_password(&self ) -> Result<String, CloudMailError> 
fn set_firewall_password(&self, value : &str) ->  Option<CloudMailError> 
fn set_firewall_password_ref(&self, value : &String) ->  Option<CloudMailError> 

Default Value

""

Remarks

A password if authentication is to be used when connecting through the firewall. If firewall_host is specified, the firewall_user and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the struct fails with an error.

Data Type

String

firewall_port property (AmazonSES Struct)

The Transmission Control Protocol (TCP) port for the firewall Host .

Syntax

fn firewall_port(&self ) -> Result<i32, CloudMailError> 
fn set_firewall_port(&self, value : i32) ->  Option<CloudMailError> 

Default Value

0

Remarks

The Transmission Control Protocol (TCP) port for the firewall firewall_host. See the description of the firewall_host property for details.

NOTE: This property is set automatically when firewall_firewall_type is set to a valid value. See the description of the firewall_firewall_type property for details.

Data Type

i32

firewall_user property (AmazonSES Struct)

A username if authentication is to be used when connecting through a firewall.

Syntax

fn firewall_user(&self ) -> Result<String, CloudMailError> 
fn set_firewall_user(&self, value : &str) ->  Option<CloudMailError> 
fn set_firewall_user_ref(&self, value : &String) ->  Option<CloudMailError> 

Default Value

""

Remarks

A username if authentication is to be used when connecting through a firewall. If firewall_host is specified, this property and the firewall_password property are used to connect and authenticate to the given Firewall. If the authentication fails, the struct fails with an error.

Data Type

String

from property (AmazonSES Struct)

This property includes the email address of the sender (required).

Syntax

fn from(&self ) -> Result<String, CloudMailError> 
fn set_from(&self, value : &str) ->  Option<CloudMailError> 
fn set_from_ref(&self, value : &String) ->  Option<CloudMailError> 

Default Value

""

Remarks

This property is used to create a From SMTP header. This header identifies the sender of the message. A valid email address is required. Examples of valid addresses are as follows: "Friendly Name" <address@company.com> or address@company.com

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 822 specifications.

Data Type

String

identity_count property (AmazonSES Struct)

The number of records in the Identity arrays.

Syntax

fn identity_count(&self ) -> Result<i32, CloudMailError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• identity_attributes_type
• identity_name
• identity_notification_bounce_topic
• identity_notification_complaint_topic
• identity_notification_forwarding_enabled
• identity_verification_status
• identity_verification_token

The array indices start at 0 and end at identity_count - 1.

This property is read-only.

Data Type

i32

identity_attributes_type property (AmazonSES Struct)

Specifies the type of attribute.

Syntax

fn identity_attributes_type(&self , IdentityIndex : i32) -> Result<i32, CloudMailError> 

Default Value

0

Remarks

Specifies the type of attribute. When calling get_identity_attributes either Notification or Verification attributes are retrieved. This property indicates which type the current attribute is. Possible values are:

• identity_name
• identity_notification_bounce_topic
• identity_notification_complaint_topic
• identity_notification_forwarding_enabled

• identity_name
• identity_verification_status
• identity_verification_token

The IdentityIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IdentityCount property.

This property is read-only.

Data Type

i32

identity_name property (AmazonSES Struct)

The current identity name.

Syntax

fn identity_name(&self , IdentityIndex : i32) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The current identity name. This is either an email address or domain.

The IdentityIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IdentityCount property.

This property is read-only.

Data Type

String

identity_notification_bounce_topic property (AmazonSES Struct)

The Amazon Simple Notification Service (SNS) topic to which Amazon will publish bounce notifications.

Syntax

fn identity_notification_bounce_topic(&self , IdentityIndex : i32) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The Amazon Simple Notification Service (SNS) topic to which Amazon will publish bounce notifications.

The IdentityIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IdentityCount property.

This property is read-only.

Data Type

String

identity_notification_complaint_topic property (AmazonSES Struct)

The Amazon Simple Notification Service (SNS) topic to which Amazon will publish complaint notifications.

Syntax

fn identity_notification_complaint_topic(&self , IdentityIndex : i32) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The Amazon Simple Notification Service (SNS) topic to which Amazon will publish complaint notifications.

The IdentityIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IdentityCount property.

This property is read-only.

Data Type

String

identity_notification_forwarding_enabled property (AmazonSES Struct)

Specifies whether or not Amazon will forward feedback as email.

Syntax

fn identity_notification_forwarding_enabled(&self , IdentityIndex : i32) -> Result<bool, CloudMailError> 

Default Value

false

Remarks

Specifies whether or not Amazon will forward feedback as email. True indicates feedback will be sent as email. A value of False indicates that feedback will only be published to the identity_notification_bounce_topic and identity_notification_complaint_topic SNS topics.

The IdentityIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IdentityCount property.

This property is read-only.

Data Type

bool

identity_verification_status property (AmazonSES Struct)

The current verification status of the identity.

Syntax

fn identity_verification_status(&self , IdentityIndex : i32) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The current verification status of the identity. Possible values are:

• Pending
• Success
• Failed
• TemporaryFailure
• NotStarted

The IdentityIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IdentityCount property.

This property is read-only.

Data Type

String

identity_verification_token property (AmazonSES Struct)

The verification token for the domain.

Syntax

fn identity_verification_token(&self , IdentityIndex : i32) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The verification token for the domain. This is only applicable to domains. The value will be empty for email addresses.

The IdentityIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IdentityCount property.

This property is read-only.

Data Type

String

identity_marker property (AmazonSES Struct)

The offset marker used to navigate paged results.

Syntax

fn identity_marker(&self ) -> Result<String, CloudMailError> 
fn set_identity_marker(&self, value : &str) ->  Option<CloudMailError> 
fn set_identity_marker_ref(&self, value : &String) ->  Option<CloudMailError> 

Default Value

""

Remarks

This property holds the offset marker used to request the next page of results. This may be automatically populated after a call to list_identities. If this holds a value, subsequent calls to list_identities will use this value to get the next page of results. See also: list_identities, IsPaged.

Data Type

String

idle property (AmazonSES Struct)

The current status of the struct.

Syntax

fn idle(&self ) -> Result<bool, CloudMailError> 

Default Value

true

Remarks

This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.

This property is read-only.

Data Type

bool

image_count property (AmazonSES Struct)

The number of records in the Image arrays.

Syntax

fn image_count(&self ) -> Result<i32, CloudMailError> 
fn set_image_count(&self, value : i32) ->  Option<CloudMailError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• image_data
• image_file
• image_id
• image_type

The array indices start at 0 and end at image_count - 1.

Data Type

i32

image_data property (AmazonSES Struct)

This property optionally specifies the image data.

Syntax

fn image_data(&self , ImageIndex : i32) -> Result<Vec<u8>, CloudMailError> 
fn set_image_data(&self, ImageIndex : i32, value : Vec<u8>) ->  Option<CloudMailError> 
fn set_image_data_ref(&self, ImageIndex : i32, value : &[u8]) ->  Option<CloudMailError> 

Default Value

""

Remarks

This property optionally specifies the image data. This may be used instead of specifying an image by file. The value specified here may be either the hex-encoded image data or the raw unencoded image data.

The ImageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ImageCount property.

Data Type

Vec

image_file property (AmazonSES Struct)

This property contains the name of the image files embedded into the HTML message.

Syntax

fn image_file(&self , ImageIndex : i32) -> Result<String, CloudMailError> 
fn set_image_file(&self, ImageIndex : i32, value : &str) ->  Option<CloudMailError> 
fn set_image_file_ref(&self, ImageIndex : i32, value : &String) ->  Option<CloudMailError> 

Default Value

""

Remarks

This property contains the name of the image files embedded into the HTML message. This value is updated every time message_html is set. You may change the file names before sending (e.g., if they don't point to valid files).

The ImageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ImageCount property.

Data Type

String

image_id property (AmazonSES Struct)

This property contains the content identifier for embedded images.

Syntax

fn image_id(&self , ImageIndex : i32) -> Result<String, CloudMailError> 
fn set_image_id(&self, ImageIndex : i32, value : &str) ->  Option<CloudMailError> 
fn set_image_id_ref(&self, ImageIndex : i32, value : &String) ->  Option<CloudMailError> 

Default Value

""

Remarks

This property contains the content identifier for embedded images. This value is computed automatically, unless parse_html is False, in which case you are responsible for providing it.

The ImageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ImageCount property.

Data Type

String

image_type property (AmazonSES Struct)

This property contains the content type for embedded images.

Syntax

fn image_type(&self , ImageIndex : i32) -> Result<String, CloudMailError> 
fn set_image_type(&self, ImageIndex : i32, value : &str) ->  Option<CloudMailError> 
fn set_image_type_ref(&self, ImageIndex : i32, value : &String) ->  Option<CloudMailError> 

Default Value

""

Remarks

This property contains the content type for embedded images. This value is determined automatically, unless parse_html is False, in which case you are responsible for providing it.

The ImageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ImageCount property.

Data Type

String

importance property (AmazonSES Struct)

This property indicates the importance of the mail message (optional).

Syntax

fn importance(&self ) -> Result<i32, CloudMailError> 
fn set_importance(&self, value : i32) ->  Option<CloudMailError> 

Possible Values

0   // Unspecified
1   // High
2   // Normal
3   // Low

Default Value

0

Remarks

This property indicates the importance of the mail message (optional). When set, an Importance header will be added to the message.

Importance is an indication to the recipient(s) about the level of importance of the message. The possible values are Unspecified (0), High (1), Normal (2), and Low (3).

Data Type

i32

local_host property (AmazonSES Struct)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

fn local_host(&self ) -> Result<String, CloudMailError> 
fn set_local_host(&self, value : &str) ->  Option<CloudMailError> 
fn set_local_host_ref(&self, value : &String) ->  Option<CloudMailError> 

Default Value

""

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the struct initiate connections (or accept in the case of server structs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the struct is connected, the local_host property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

NOTE: local_host is not persistent. You must always set it in code, and never in the property window.

Data Type

String

message_html property (AmazonSES Struct)

This property includes the HTML version of the message.

Syntax

fn message_html(&self ) -> Result<String, CloudMailError> 
fn set_message_html(&self, value : &str) ->  Option<CloudMailError> 
fn set_message_html_ref(&self, value : &String) ->  Option<CloudMailError> 

Default Value

""

Remarks

This property contains the HTML version of the message.

When this property is set, the struct automatically computes a plaintext version of the text and puts it into message_text. You may choose to override this default text with your own version.

Example. Setting MessageHTML:

component.MessageHTML = "<b>Hello</b>, my name is <i>Tom</i>";

Data Type

String

message_recipient_count property (AmazonSES Struct)

The number of records in the MessageRecipient arrays.

Syntax

fn message_recipient_count(&self ) -> Result<i32, CloudMailError> 
fn set_message_recipient_count(&self, value : i32) ->  Option<CloudMailError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• message_recipient_address
• message_recipient_name
• message_recipient_options
• message_recipient_type

The array indices start at 0 and end at message_recipient_count - 1.

Data Type

i32

message_recipient_address property (AmazonSES Struct)

This property contains the email address of the recipient.

Syntax

fn message_recipient_address(&self , RecipientIndex : i32) -> Result<String, CloudMailError> 
fn set_message_recipient_address(&self, RecipientIndex : i32, value : &str) ->  Option<CloudMailError> 
fn set_message_recipient_address_ref(&self, RecipientIndex : i32, value : &String) ->  Option<CloudMailError> 

Default Value

""

Remarks

This property contains the email address of the recipient.

The RecipientIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageRecipientCount property.

Data Type

String

message_recipient_name property (AmazonSES Struct)

This property contains the name of the recipient.

Syntax

fn message_recipient_name(&self , RecipientIndex : i32) -> Result<String, CloudMailError> 
fn set_message_recipient_name(&self, RecipientIndex : i32, value : &str) ->  Option<CloudMailError> 
fn set_message_recipient_name_ref(&self, RecipientIndex : i32, value : &String) ->  Option<CloudMailError> 

Default Value

""

Remarks

This property contains the name of the recipient.

The RecipientIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageRecipientCount property.

Data Type

String

message_recipient_options property (AmazonSES Struct)

This property contains the recipient sending options (used only by SMTP).

Syntax

fn message_recipient_options(&self , RecipientIndex : i32) -> Result<String, CloudMailError> 
fn set_message_recipient_options(&self, RecipientIndex : i32, value : &str) ->  Option<CloudMailError> 
fn set_message_recipient_options_ref(&self, RecipientIndex : i32, value : &String) ->  Option<CloudMailError> 

Default Value

""

Remarks

This property contains the recipient sending options (used only by SMTP). This must be a string of RFC-compliant recipient options (used by SMTP).

One type of option is a delivery status notification sent per recipient, which is specified by RFC 1891.

component.MessageRecipientOptions(0) = "NOTIFY SUCCESS,FAILURE,DELAY";

The RecipientIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageRecipientCount property.

Data Type

String

message_recipient_type property (AmazonSES Struct)

This property contains the recipient type: To, Cc, or Bcc.

Syntax

fn message_recipient_type(&self , RecipientIndex : i32) -> Result<i32, CloudMailError> 
fn set_message_recipient_type(&self, RecipientIndex : i32, value : i32) ->  Option<CloudMailError> 

Possible Values

0   // To
1   // Cc
2   // BCc

Default Value

0

Remarks

This property contains the recipient type: To, Cc, or Bcc.

The RecipientIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageRecipientCount property.

Data Type

i32

message_text property (AmazonSES Struct)

This property includes the plaintext version of the message.

Syntax

fn message_text(&self ) -> Result<String, CloudMailError> 
fn set_message_text(&self, value : &str) ->  Option<CloudMailError> 
fn set_message_text_ref(&self, value : &String) ->  Option<CloudMailError> 

Default Value

""

Remarks

This property is a plaintext version of the HTML message. This is necessary for recipients with legacy mail readers that do not support HTML.

The message_html property contains the HTML version of the message. When message_html is set, the struct automatically computes a plaintext version of the text and puts it into this property. You may choose to override this default text with your own version.

Data Type

String

other_headers property (AmazonSES Struct)

This property includes an RFC 822-compliant string consisting of extra headers.

Syntax

fn other_headers(&self ) -> Result<String, CloudMailError> 
fn set_other_headers(&self, value : &str) ->  Option<CloudMailError> 
fn set_other_headers_ref(&self, value : &String) ->  Option<CloudMailError> 

Default Value

""

Remarks

This property contains a string of headers to be appended to the message headers created from other properties like send_to, subject, and so on.

The headers must be of the format "header: value" as specified in RFC 822. Header lines should be separated by CRLF ("\r\n") .

Use this property with caution. If this property contains invalid headers, message delivery might not be successful.

This property is useful for extending the functionality of the struct. A good example is delivery of MIME-encoded messages.

Special case: If this property starts with an empty line (CRLF), then the value of this property is used instead of the normally computed message headers.

Example. Sending an Email with an Additional Header:

component.MailServer = "MyServer"; component.From = "me@server.com"; component.SendTo = "recipient@server.com"; component.Subject = "My Subject"; component.MessageText = "This is the message body."; component.OtherHeaders = "HeaderName: HeaderValue"; component.Send();

Data Type

String

proxy_auth_scheme property (AmazonSES Struct)

The type of authorization to perform when connecting to the proxy.

Syntax

fn proxy_auth_scheme(&self ) -> Result<i32, CloudMailError> 
fn set_proxy_auth_scheme(&self, value : i32) ->  Option<CloudMailError> 

Possible Values

0   // Basic
1   // Digest
2   // Proprietary
3   // None
4   // Ntlm
5   // Negotiate

Default Value

0

Remarks

The type of authorization to perform when connecting to the proxy. This is used only when the proxy_user and proxy_password properties are set.

proxy_auth_scheme should be set to authNone (3) when no authentication is expected.

By default, proxy_auth_scheme is authBasic (0), and if the proxy_user and proxy_password properties are set, the struct will attempt basic authentication.

If proxy_auth_scheme is set to authDigest (1), digest authentication will be attempted instead.

If proxy_auth_scheme is set to authProprietary (2), then the authorization token will not be generated by the struct. Look at the configuration file for the struct being used to find more information about manually setting this token.

If proxy_auth_scheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of proxy_user and proxy_password.

Data Type

i32

proxy_auto_detect property (AmazonSES Struct)

Whether to automatically detect and use proxy system settings, if available.

Syntax

fn proxy_auto_detect(&self ) -> Result<bool, CloudMailError> 
fn set_proxy_auto_detect(&self, value : bool) ->  Option<CloudMailError> 

Default Value

false

Remarks

Whether to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

bool

proxy_password property (AmazonSES Struct)

A password if authentication is to be used for the proxy.

Syntax

fn proxy_password(&self ) -> Result<String, CloudMailError> 
fn set_proxy_password(&self, value : &str) ->  Option<CloudMailError> 
fn set_proxy_password_ref(&self, value : &String) ->  Option<CloudMailError> 

Default Value

""

Remarks

A password if authentication is to be used for the proxy.

If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

Data Type

String

proxy_port property (AmazonSES Struct)

The Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

fn proxy_port(&self ) -> Result<i32, CloudMailError> 
fn set_proxy_port(&self, value : i32) ->  Option<CloudMailError> 

Default Value

80

Remarks

The Transmission Control Protocol (TCP) port for the proxy proxy_server (default 80). See the description of the proxy_server property for details.

Data Type

i32

proxy_server property (AmazonSES Struct)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

fn proxy_server(&self ) -> Result<String, CloudMailError> 
fn set_proxy_server(&self, value : &str) ->  Option<CloudMailError> 
fn set_proxy_server_ref(&self, value : &String) ->  Option<CloudMailError> 

Default Value

""

Remarks

If a proxy proxy_server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the proxy_server property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the proxy_server property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

proxy_ssl property (AmazonSES Struct)

When to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

fn proxy_ssl(&self ) -> Result<i32, CloudMailError> 
fn set_proxy_ssl(&self, value : i32) ->  Option<CloudMailError> 

Possible Values

0   // Automatic
1   // Always
2   // Never
3   // Tunnel

Default Value

0

Remarks

When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

i32

proxy_user property (AmazonSES Struct)

A username if authentication is to be used for the proxy.

Syntax

fn proxy_user(&self ) -> Result<String, CloudMailError> 
fn set_proxy_user(&self, value : &str) ->  Option<CloudMailError> 
fn set_proxy_user_ref(&self, value : &String) ->  Option<CloudMailError> 

Default Value

""

Remarks

A username if authentication is to be used for the proxy.

If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

Data Type

String

quota_max_per24_hours property (AmazonSES Struct)

The maximum number of emails that can be sent in a 24 hour period.

Syntax

fn quota_max_per24_hours(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The maximum number of emails that can be sent in a 24 hour period.

This property is read-only.

Data Type

String

quota_max_per_second property (AmazonSES Struct)

The maximum number of emails that can be sent per second.

Syntax

fn quota_max_per_second(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The maximum number of emails that can be sent per second.

This property is read-only.

Data Type

String

quota_sent_last24_hours property (AmazonSES Struct)

The number of emails sent during the previous 24 hours.

Syntax

fn quota_sent_last24_hours(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The number of emails sent during the previous 24 hours.

This property is read-only.

Data Type

String

read_receipt_to property (AmazonSES Struct)

This property includes the email address to send a read-receipt to.

Syntax

fn read_receipt_to(&self ) -> Result<String, CloudMailError> 
fn set_read_receipt_to(&self, value : &str) ->  Option<CloudMailError> 
fn set_read_receipt_to_ref(&self, value : &String) ->  Option<CloudMailError> 

Default Value

""

Remarks

When this property is set, a Disposition-Notification-To header is added to the message. This property should be set to an email address that should receive the read-receipt.

Data Type

String

reply_to property (AmazonSES Struct)

This property includes a mail address to which to reply (optional).

Syntax

fn reply_to(&self ) -> Result<String, CloudMailError> 
fn set_reply_to(&self, value : &str) ->  Option<CloudMailError> 
fn set_reply_to_ref(&self, value : &String) ->  Option<CloudMailError> 

Default Value

""

Remarks

If this property contains a nonempty string, a Reply-To SMTP header is created for the message. This header shows the address to use for replies, which is useful if this address is different from the one in from.

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 822 specifications.

Data Type

String

secret_key property (AmazonSES Struct)

The Secret Access Key for the Amazon Web Services account.

Syntax

fn secret_key(&self ) -> Result<String, CloudMailError> 
fn set_secret_key(&self, value : &str) ->  Option<CloudMailError> 
fn set_secret_key_ref(&self, value : &String) ->  Option<CloudMailError> 

Default Value

""

Remarks

This property describes the secret key to the Amazon account. It should not be shared with others. The secret_key is used along with the access_key in the authentication process with Amazon servers.

Data Type

String

send_stat_count property (AmazonSES Struct)

The number of records in the SendStat arrays.

Syntax

fn send_stat_count(&self ) -> Result<i32, CloudMailError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• send_stat_bounces
• send_stat_complaints
• send_stat_delivery_attempts
• send_stat_rejects
• send_stat_timestamp

The array indices start at 0 and end at send_stat_count - 1.

This property is read-only.

Data Type

i32

send_stat_bounces property (AmazonSES Struct)

The number of emails that bounced.

Syntax

fn send_stat_bounces(&self , SendStatIndex : i32) -> Result<i64, CloudMailError> 

Default Value

0

Remarks

The number of emails that bounced.

The SendStatIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SendStatCount property.

This property is read-only.

Data Type

i64

send_stat_complaints property (AmazonSES Struct)

The number of emails that were rejected by the recipient.

Syntax

fn send_stat_complaints(&self , SendStatIndex : i32) -> Result<i64, CloudMailError> 

Default Value

0

Remarks

The number of emails that were rejected by the recipient.

The SendStatIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SendStatCount property.

This property is read-only.

Data Type

i64

send_stat_delivery_attempts property (AmazonSES Struct)

The number of emails that have been sent or are queued to be sent.

Syntax

fn send_stat_delivery_attempts(&self , SendStatIndex : i32) -> Result<i64, CloudMailError> 

Default Value

0

Remarks

The number of emails that have been sent or are queued to be sent.

The SendStatIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SendStatCount property.

This property is read-only.

Data Type

i64

send_stat_rejects property (AmazonSES Struct)

The number of emails rejected by Amazon SES.

Syntax

fn send_stat_rejects(&self , SendStatIndex : i32) -> Result<i64, CloudMailError> 

Default Value

0

Remarks

The number of emails rejected by Amazon SES.

The SendStatIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SendStatCount property.

This property is read-only.

Data Type

i64

send_stat_timestamp property (AmazonSES Struct)

The time of the data point.

Syntax

fn send_stat_timestamp(&self , SendStatIndex : i32) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The time of the data point. For instance "2012-09-18T13:00:01Z".

The SendStatIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SendStatCount property.

This property is read-only.

Data Type

String

send_to property (AmazonSES Struct)

This property includes a comma-separated list of addresses for destinations (required).

Syntax

fn send_to(&self ) -> Result<String, CloudMailError> 
fn set_send_to(&self, value : &str) ->  Option<CloudMailError> 
fn set_send_to_ref(&self, value : &String) ->  Option<CloudMailError> 

Default Value

""

Remarks

This property specifies a comma-separated list of destinations for the mail message. A copy of the message is sent to each of them, and a To SMTP header is created containing the destination addresses.

Examples of valid addresses are as follows: "Friendly Name" <address@company.com> or address@company.com

The struct will fail if the mail_server returns an error code about any email address specified in SendTo or cc but it will silently ignore the error if the same thing happens with an email address specified in b_cc.

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 822 specifications.

NOTE: You must clear the message_recipients properties before setting this property to remove previous recipients.

Data Type

String

ssl_accept_server_cert_effective_date property (AmazonSES Struct)

The date on which this certificate becomes valid.

Syntax

fn ssl_accept_server_cert_effective_date(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

ssl_accept_server_cert_expiration_date property (AmazonSES Struct)

The date on which the certificate expires.

Syntax

fn ssl_accept_server_cert_expiration_date(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

ssl_accept_server_cert_extended_key_usage property (AmazonSES Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn ssl_accept_server_cert_extended_key_usage(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

ssl_accept_server_cert_fingerprint property (AmazonSES Struct)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fn ssl_accept_server_cert_fingerprint(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

ssl_accept_server_cert_fingerprint_sha1 property (AmazonSES Struct)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fn ssl_accept_server_cert_fingerprint_sha1(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

ssl_accept_server_cert_fingerprint_sha256 property (AmazonSES Struct)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fn ssl_accept_server_cert_fingerprint_sha256(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

ssl_accept_server_cert_issuer property (AmazonSES Struct)

The issuer of the certificate.

Syntax

fn ssl_accept_server_cert_issuer(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

ssl_accept_server_cert_private_key property (AmazonSES Struct)

The private key of the certificate (if available).

Syntax

fn ssl_accept_server_cert_private_key(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The ssl_accept_server_cert_private_key may be available but not exportable. In this case, ssl_accept_server_cert_private_key returns an empty string.

This property is read-only.

Data Type

String

ssl_accept_server_cert_private_key_available property (AmazonSES Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn ssl_accept_server_cert_private_key_available(&self ) -> Result<bool, CloudMailError> 

Default Value

false

Remarks

Whether a ssl_accept_server_cert_private_key is available for the selected certificate. If ssl_accept_server_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

ssl_accept_server_cert_private_key_container property (AmazonSES Struct)

The name of the PrivateKey container for the certificate (if available).

Syntax

fn ssl_accept_server_cert_private_key_container(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The name of the ssl_accept_server_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

ssl_accept_server_cert_public_key property (AmazonSES Struct)

The public key of the certificate.

Syntax

fn ssl_accept_server_cert_public_key(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

ssl_accept_server_cert_public_key_algorithm property (AmazonSES Struct)

The textual description of the certificate's public key algorithm.

Syntax

fn ssl_accept_server_cert_public_key_algorithm(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_accept_server_cert_public_key_length property (AmazonSES Struct)

The length of the certificate's public key (in bits).

Syntax

fn ssl_accept_server_cert_public_key_length(&self ) -> Result<i32, CloudMailError> 

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

i32

ssl_accept_server_cert_serial_number property (AmazonSES Struct)

The serial number of the certificate encoded as a string.

Syntax

fn ssl_accept_server_cert_serial_number(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

ssl_accept_server_cert_signature_algorithm property (AmazonSES Struct)

The text description of the certificate's signature algorithm.

Syntax

fn ssl_accept_server_cert_signature_algorithm(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_accept_server_cert_store property (AmazonSES Struct)

The name of the certificate store for the client certificate.

Syntax

fn ssl_accept_server_cert_store(&self ) -> Result<Vec<u8>, CloudMailError> 
fn set_ssl_accept_server_cert_store(&self, value : Vec<u8>) ->  Option<CloudMailError> 
fn set_ssl_accept_server_cert_store_ref(&self, value : &[u8]) ->  Option<CloudMailError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_accept_server_cert_store_type property denotes the type of the certificate store specified by ssl_accept_server_cert_store. If the store is password-protected, specify the password in ssl_accept_server_cert_store_password.

ssl_accept_server_cert_store is used in conjunction with the ssl_accept_server_cert_subject property to specify client certificates. If ssl_accept_server_cert_store has a value, and ssl_accept_server_cert_subject or ssl_accept_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_accept_server_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Vec

ssl_accept_server_cert_store_password property (AmazonSES Struct)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

fn ssl_accept_server_cert_store_password(&self ) -> Result<String, CloudMailError> 
fn set_ssl_accept_server_cert_store_password(&self, value : &str) ->  Option<CloudMailError> 
fn set_ssl_accept_server_cert_store_password_ref(&self, value : &String) ->  Option<CloudMailError> 

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

ssl_accept_server_cert_store_type property (AmazonSES Struct)

The type of certificate store for this certificate.

Syntax

fn ssl_accept_server_cert_store_type(&self ) -> Result<i32, CloudMailError> 
fn set_ssl_accept_server_cert_store_type(&self, value : i32) ->  Option<CloudMailError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

Data Type

i32

ssl_accept_server_cert_subject_alt_names property (AmazonSES Struct)

Comma-separated lists of alternative subject names for the certificate.

Syntax

fn ssl_accept_server_cert_subject_alt_names(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

ssl_accept_server_cert_thumbprint_md5 property (AmazonSES Struct)

The MD5 hash of the certificate.

Syntax

fn ssl_accept_server_cert_thumbprint_md5(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_accept_server_cert_thumbprint_sha1 property (AmazonSES Struct)

The SHA-1 hash of the certificate.

Syntax

fn ssl_accept_server_cert_thumbprint_sha1(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_accept_server_cert_thumbprint_sha256 property (AmazonSES Struct)

The SHA-256 hash of the certificate.

Syntax

fn ssl_accept_server_cert_thumbprint_sha256(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_accept_server_cert_usage property (AmazonSES Struct)

The text description of UsageFlags .

Syntax

fn ssl_accept_server_cert_usage(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The text description of ssl_accept_server_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

ssl_accept_server_cert_usage_flags property (AmazonSES Struct)

The flags that show intended use for the certificate.

Syntax

fn ssl_accept_server_cert_usage_flags(&self ) -> Result<i32, CloudMailError> 

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_accept_server_cert_usage_flags is a combination of the following flags:

Please see the ssl_accept_server_cert_usage property for a text representation of ssl_accept_server_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

i32

ssl_accept_server_cert_version property (AmazonSES Struct)

The certificate's version number.

Syntax

fn ssl_accept_server_cert_version(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

ssl_accept_server_cert_subject property (AmazonSES Struct)

The subject of the certificate used for client authentication.

Syntax

fn ssl_accept_server_cert_subject(&self ) -> Result<String, CloudMailError> 
fn set_ssl_accept_server_cert_subject(&self, value : &str) ->  Option<CloudMailError> 
fn set_ssl_accept_server_cert_subject_ref(&self, value : &String) ->  Option<CloudMailError> 

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

ssl_accept_server_cert_encoded property (AmazonSES Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn ssl_accept_server_cert_encoded(&self ) -> Result<Vec<u8>, CloudMailError> 
fn set_ssl_accept_server_cert_encoded(&self, value : Vec<u8>) ->  Option<CloudMailError> 
fn set_ssl_accept_server_cert_encoded_ref(&self, value : &[u8]) ->  Option<CloudMailError> 

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_accept_server_cert_store and ssl_accept_server_cert_subject properties also may be used to specify a certificate.

When ssl_accept_server_cert_encoded is set, a search is initiated in the current ssl_accept_server_cert_store for the private key of the certificate. If the key is found, ssl_accept_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_accept_server_cert_subject is set to an empty string.

Data Type

Vec

ssl_cert_effective_date property (AmazonSES Struct)

The date on which this certificate becomes valid.

Syntax

fn ssl_cert_effective_date(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

ssl_cert_expiration_date property (AmazonSES Struct)

The date on which the certificate expires.

Syntax

fn ssl_cert_expiration_date(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

ssl_cert_extended_key_usage property (AmazonSES Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn ssl_cert_extended_key_usage(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

ssl_cert_fingerprint property (AmazonSES Struct)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fn ssl_cert_fingerprint(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

ssl_cert_fingerprint_sha1 property (AmazonSES Struct)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fn ssl_cert_fingerprint_sha1(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

ssl_cert_fingerprint_sha256 property (AmazonSES Struct)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fn ssl_cert_fingerprint_sha256(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

ssl_cert_issuer property (AmazonSES Struct)

The issuer of the certificate.

Syntax

fn ssl_cert_issuer(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

ssl_cert_private_key property (AmazonSES Struct)

The private key of the certificate (if available).

Syntax

fn ssl_cert_private_key(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The ssl_cert_private_key may be available but not exportable. In this case, ssl_cert_private_key returns an empty string.

This property is read-only.

Data Type

String

ssl_cert_private_key_available property (AmazonSES Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn ssl_cert_private_key_available(&self ) -> Result<bool, CloudMailError> 

Default Value

false

Remarks

Whether a ssl_cert_private_key is available for the selected certificate. If ssl_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

ssl_cert_private_key_container property (AmazonSES Struct)

The name of the PrivateKey container for the certificate (if available).

Syntax

fn ssl_cert_private_key_container(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The name of the ssl_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

ssl_cert_public_key property (AmazonSES Struct)

The public key of the certificate.

Syntax

fn ssl_cert_public_key(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

ssl_cert_public_key_algorithm property (AmazonSES Struct)

The textual description of the certificate's public key algorithm.

Syntax

fn ssl_cert_public_key_algorithm(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_cert_public_key_length property (AmazonSES Struct)

The length of the certificate's public key (in bits).

Syntax

fn ssl_cert_public_key_length(&self ) -> Result<i32, CloudMailError> 

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

i32

ssl_cert_serial_number property (AmazonSES Struct)

The serial number of the certificate encoded as a string.

Syntax

fn ssl_cert_serial_number(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

ssl_cert_signature_algorithm property (AmazonSES Struct)

The text description of the certificate's signature algorithm.

Syntax

fn ssl_cert_signature_algorithm(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_cert_store property (AmazonSES Struct)

The name of the certificate store for the client certificate.

Syntax

fn ssl_cert_store(&self ) -> Result<Vec<u8>, CloudMailError> 
fn set_ssl_cert_store(&self, value : Vec<u8>) ->  Option<CloudMailError> 
fn set_ssl_cert_store_ref(&self, value : &[u8]) ->  Option<CloudMailError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password-protected, specify the password in ssl_cert_store_password.

ssl_cert_store is used in conjunction with the ssl_cert_subject property to specify client certificates. If ssl_cert_store has a value, and ssl_cert_subject or ssl_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Vec

ssl_cert_store_password property (AmazonSES Struct)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

fn ssl_cert_store_password(&self ) -> Result<String, CloudMailError> 
fn set_ssl_cert_store_password(&self, value : &str) ->  Option<CloudMailError> 
fn set_ssl_cert_store_password_ref(&self, value : &String) ->  Option<CloudMailError> 

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

ssl_cert_store_type property (AmazonSES Struct)

The type of certificate store for this certificate.

Syntax

fn ssl_cert_store_type(&self ) -> Result<i32, CloudMailError> 
fn set_ssl_cert_store_type(&self, value : i32) ->  Option<CloudMailError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

Data Type

i32

ssl_cert_subject_alt_names property (AmazonSES Struct)

Comma-separated lists of alternative subject names for the certificate.

Syntax

fn ssl_cert_subject_alt_names(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

ssl_cert_thumbprint_md5 property (AmazonSES Struct)

The MD5 hash of the certificate.

Syntax

fn ssl_cert_thumbprint_md5(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_cert_thumbprint_sha1 property (AmazonSES Struct)

The SHA-1 hash of the certificate.

Syntax

fn ssl_cert_thumbprint_sha1(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_cert_thumbprint_sha256 property (AmazonSES Struct)

The SHA-256 hash of the certificate.

Syntax

fn ssl_cert_thumbprint_sha256(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_cert_usage property (AmazonSES Struct)

The text description of UsageFlags .

Syntax

fn ssl_cert_usage(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The text description of ssl_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

ssl_cert_usage_flags property (AmazonSES Struct)

The flags that show intended use for the certificate.

Syntax

fn ssl_cert_usage_flags(&self ) -> Result<i32, CloudMailError> 

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_cert_usage_flags is a combination of the following flags:

Please see the ssl_cert_usage property for a text representation of ssl_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

i32

ssl_cert_version property (AmazonSES Struct)

The certificate's version number.

Syntax

fn ssl_cert_version(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

ssl_cert_subject property (AmazonSES Struct)

The subject of the certificate used for client authentication.

Syntax

fn ssl_cert_subject(&self ) -> Result<String, CloudMailError> 
fn set_ssl_cert_subject(&self, value : &str) ->  Option<CloudMailError> 
fn set_ssl_cert_subject_ref(&self, value : &String) ->  Option<CloudMailError> 

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

ssl_cert_encoded property (AmazonSES Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn ssl_cert_encoded(&self ) -> Result<Vec<u8>, CloudMailError> 
fn set_ssl_cert_encoded(&self, value : Vec<u8>) ->  Option<CloudMailError> 
fn set_ssl_cert_encoded_ref(&self, value : &[u8]) ->  Option<CloudMailError> 

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_cert_store and ssl_cert_subject properties also may be used to specify a certificate.

When ssl_cert_encoded is set, a search is initiated in the current ssl_cert_store for the private key of the certificate. If the key is found, ssl_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_cert_subject is set to an empty string.

Data Type

Vec

ssl_provider property (AmazonSES Struct)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

fn ssl_provider(&self ) -> Result<i32, CloudMailError> 
fn set_ssl_provider(&self, value : i32) ->  Option<CloudMailError> 

Possible Values

0   // Automatic
1   // Platform
2   // Internal

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the struct will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

In most cases using the default value (Automatic) is recommended. The struct will select a provider depending on the current platform.

When Automatic is selected, on Windows, the struct will use the platform implementation. On Linux/macOS, the struct will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the struct will always try and use the platform implementation. If the platform TLS 1.3 implementation is not available, the internal implementation will be used.

Data Type

i32

ssl_server_cert_effective_date property (AmazonSES Struct)

The date on which this certificate becomes valid.

Syntax

fn ssl_server_cert_effective_date(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

ssl_server_cert_expiration_date property (AmazonSES Struct)

The date on which the certificate expires.

Syntax

fn ssl_server_cert_expiration_date(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

ssl_server_cert_extended_key_usage property (AmazonSES Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn ssl_server_cert_extended_key_usage(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

ssl_server_cert_fingerprint property (AmazonSES Struct)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fn ssl_server_cert_fingerprint(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

ssl_server_cert_fingerprint_sha1 property (AmazonSES Struct)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fn ssl_server_cert_fingerprint_sha1(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

ssl_server_cert_fingerprint_sha256 property (AmazonSES Struct)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fn ssl_server_cert_fingerprint_sha256(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

ssl_server_cert_issuer property (AmazonSES Struct)

The issuer of the certificate.

Syntax

fn ssl_server_cert_issuer(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

ssl_server_cert_private_key property (AmazonSES Struct)

The private key of the certificate (if available).

Syntax

fn ssl_server_cert_private_key(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The ssl_server_cert_private_key may be available but not exportable. In this case, ssl_server_cert_private_key returns an empty string.

This property is read-only.

Data Type

String

ssl_server_cert_private_key_available property (AmazonSES Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn ssl_server_cert_private_key_available(&self ) -> Result<bool, CloudMailError> 

Default Value

false

Remarks

Whether a ssl_server_cert_private_key is available for the selected certificate. If ssl_server_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

ssl_server_cert_private_key_container property (AmazonSES Struct)

The name of the PrivateKey container for the certificate (if available).

Syntax

fn ssl_server_cert_private_key_container(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The name of the ssl_server_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

ssl_server_cert_public_key property (AmazonSES Struct)

The public key of the certificate.

Syntax

fn ssl_server_cert_public_key(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

ssl_server_cert_public_key_algorithm property (AmazonSES Struct)

The textual description of the certificate's public key algorithm.

Syntax

fn ssl_server_cert_public_key_algorithm(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_server_cert_public_key_length property (AmazonSES Struct)

The length of the certificate's public key (in bits).

Syntax

fn ssl_server_cert_public_key_length(&self ) -> Result<i32, CloudMailError> 

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

i32

ssl_server_cert_serial_number property (AmazonSES Struct)

The serial number of the certificate encoded as a string.

Syntax

fn ssl_server_cert_serial_number(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

ssl_server_cert_signature_algorithm property (AmazonSES Struct)

The text description of the certificate's signature algorithm.

Syntax

fn ssl_server_cert_signature_algorithm(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_server_cert_store property (AmazonSES Struct)

The name of the certificate store for the client certificate.

Syntax

fn ssl_server_cert_store(&self ) -> Result<Vec<u8>, CloudMailError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_server_cert_store_type property denotes the type of the certificate store specified by ssl_server_cert_store. If the store is password-protected, specify the password in ssl_server_cert_store_password.

ssl_server_cert_store is used in conjunction with the ssl_server_cert_subject property to specify client certificates. If ssl_server_cert_store has a value, and ssl_server_cert_subject or ssl_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_server_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is read-only.

Data Type

Vec

ssl_server_cert_store_password property (AmazonSES Struct)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

fn ssl_server_cert_store_password(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

This property is read-only.

Data Type

String

ssl_server_cert_store_type property (AmazonSES Struct)

The type of certificate store for this certificate.

Syntax

fn ssl_server_cert_store_type(&self ) -> Result<i32, CloudMailError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

This property is read-only.

Data Type

i32

ssl_server_cert_subject_alt_names property (AmazonSES Struct)

Comma-separated lists of alternative subject names for the certificate.

Syntax

fn ssl_server_cert_subject_alt_names(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

ssl_server_cert_thumbprint_md5 property (AmazonSES Struct)

The MD5 hash of the certificate.

Syntax

fn ssl_server_cert_thumbprint_md5(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_server_cert_thumbprint_sha1 property (AmazonSES Struct)

The SHA-1 hash of the certificate.

Syntax

fn ssl_server_cert_thumbprint_sha1(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_server_cert_thumbprint_sha256 property (AmazonSES Struct)

The SHA-256 hash of the certificate.

Syntax

fn ssl_server_cert_thumbprint_sha256(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_server_cert_usage property (AmazonSES Struct)

The text description of UsageFlags .

Syntax

fn ssl_server_cert_usage(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The text description of ssl_server_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

ssl_server_cert_usage_flags property (AmazonSES Struct)

The flags that show intended use for the certificate.

Syntax

fn ssl_server_cert_usage_flags(&self ) -> Result<i32, CloudMailError> 

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_server_cert_usage_flags is a combination of the following flags:

Please see the ssl_server_cert_usage property for a text representation of ssl_server_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

i32

ssl_server_cert_version property (AmazonSES Struct)

The certificate's version number.

Syntax

fn ssl_server_cert_version(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

ssl_server_cert_subject property (AmazonSES Struct)

The subject of the certificate used for client authentication.

Syntax

fn ssl_server_cert_subject(&self ) -> Result<String, CloudMailError> 

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

This property is read-only.

Data Type

String

ssl_server_cert_encoded property (AmazonSES Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn ssl_server_cert_encoded(&self ) -> Result<Vec<u8>, CloudMailError> 

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_server_cert_store and ssl_server_cert_subject properties also may be used to specify a certificate.

When ssl_server_cert_encoded is set, a search is initiated in the current ssl_server_cert_store for the private key of the certificate. If the key is found, ssl_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_server_cert_subject is set to an empty string.

This property is read-only.

Data Type

Vec

subject property (AmazonSES Struct)

This property includes the subject of the mail message (optional).

Syntax

fn subject(&self ) -> Result<String, CloudMailError> 
fn set_subject(&self, value : &str) ->  Option<CloudMailError> 
fn set_subject_ref(&self, value : &String) ->  Option<CloudMailError> 

Default Value

""

Remarks

The string in this property is sent with a Subject SMTP header to the mail recipient.

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 822 specifications.

Data Type

String

timeout property (AmazonSES Struct)

The timeout for the struct.

Syntax

fn timeout(&self ) -> Result<i32, CloudMailError> 
fn set_timeout(&self, value : i32) ->  Option<CloudMailError> 

Default Value

60

Remarks

If the timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If timeout is set to a positive value, the struct will wait for the operation to complete before returning control.

The struct will use do_events to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If timeout expires, and the operation is not yet complete, the struct fails with an error.

NOTE: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by timeout seconds when any amount of data is successfully sent or received.

The default value for the timeout property is 60 seconds.

Data Type

i32

add_attachment method (AmazonSES Struct)

This adds FileName as an attachment.

Syntax

fn add_attachment(&self, file_name : &str) -> Result<(), CloudMailError>

Remarks

This method adds the file name as an attachment. The full list of attachments is contained in the attachments property.

Example 1: Adding an Attachment

component.AddAttachment("C:\file1.zip"); component.AddAttachment("C:\file2.zip"); component.Send(); Example 3: Using an Attachments Array

component.AttachmentCount = 1; component.AttachmentName(0) = "name"; component.AttachmentFile(0) = "C:\file.txt";

config method (AmazonSES Struct)

Sets or retrieves a configuration setting.

Syntax

fn config(&self, configuration_string : &str) ->  Result<String, CloudMailError>

Remarks

config is a generic method available in every struct. It is used to set and retrieve configuration settings for the struct.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

delete_identity method (AmazonSES Struct)

Deletes the identity.

Syntax

fn delete_identity(&self, identity : &str) -> Result<(), CloudMailError>

Remarks

This method deletes the identity specified by Identity.

do_events method (AmazonSES Struct)

This method processes events from the internal message queue.

Syntax

fn do_events(&self) -> Result<(), CloudMailError>

Remarks

When do_events is called, the struct processes any available events. If no events are available, it waits for a preset period of time, and then returns.

get_identity_attributes method (AmazonSES Struct)

Gets the attributes of the given identity.

Syntax

fn get_identity_attributes(&self, identity : &str, attribute_type : i32) -> Result<(), CloudMailError>

Remarks

This method returns attributes about a given identity. The Identity parameter is the e-mail or domain for which the attributes will be retrieved. There are two types of attributes that can be retrieved, Notification and Verification. The AttributeType parameter determines which type of attributes are returned. Possible values are:

The attributes that are returned will be present in identities. Notification attributes include the Bounce Topic, Complaint Topic, and ForwardingEnabled status. Verification attributes include the Verification Status and Verification Token.

Multiple identities may be specified by passing a comma separated list in the Identity parameter.

get_send_quota method (AmazonSES Struct)

Gets send quota information.

Syntax

fn get_send_quota(&self) -> Result<(), CloudMailError>

Remarks

This method gets the current send quota information. The following properties will be populated with information from the response:

• quota_max_per24_hours
• quota_max_per_second
• quota_sent_last24_hours

get_send_statistics method (AmazonSES Struct)

Gets the user's sending statistics.

Syntax

fn get_send_statistics(&self) -> Result<(), CloudMailError>

Remarks

This method gets the users sending statistics. The server will return a set of data points with information about the user's sending activity. Each data point represents a 15 minute interval of sending activity.

The following properties will be populated for each data point.

• send_stat_bounces
• send_stat_complaints
• send_stat_delivery_attempts
• send_stat_rejects
• send_stat_timestamp

get_xvalue method (AmazonSES Struct)

Retrieves a valid XPath expression from the HTTP response after calling SendCustomRequest .

Syntax

fn get_xvalue(&self, xpath : &str) ->  Result<String, CloudMailError>

Remarks

This method allows a user to retrieve a valid XPath expression from the HTTP response after calling send_custom_request.

interrupt method (AmazonSES Struct)

This method interrupts the current method.

Syntax

fn interrupt(&self) -> Result<(), CloudMailError>

Remarks

If there is no method in progress, interrupt simply returns, doing nothing.

list_identities method (AmazonSES Struct)

Lists the identities of the given type.

Syntax

fn list_identities(&self, identity_type : i32) -> Result<(), CloudMailError>

Remarks

This method is used to list the identities of the specified type. The IdentityType parameter specifies the type of identities you wish to list. Possible values are:

If the number of results exceeds MaxListIdentityResults the results will be paged. When the results are paged the IsPaged configuration setting will return "True" and the identity_marker property will be populated. To obtain the next page of results simply call list_identities again. The identity_marker value determines the results offset. On the last page of results the IsPaged configuration setting will return "False" and identity_marker will be set to empty string. With this design to get all of the results you can repeatedly call list_identities until IsPaged returns "False" or identity_marker is set to empty string.

reset method (AmazonSES Struct)

Resets request-related properties.

Syntax

fn reset(&self) -> Result<(), CloudMailError>

Remarks

Calling this method will reset the component to the original state.

send method (AmazonSES Struct)

Sends the message.

Syntax

fn send(&self) -> Result<(), CloudMailError>

Remarks

This method sends the message specified by message_html or message_text.

Example (Send an Email) component.AccessKey = "my access key"; component.SecretKey = "my secret key"; component.From = "verified.email@host.com"; component.SendTo = "recipient@mail.com"; component.Subject = "Test SES Email"; component.MessageHTML = "<html><body><b>Hello World!</b></body></html>";

send_custom_request method (AmazonSES Struct)

Allows the sending of a custom request to an Amazon web service.

Syntax

fn send_custom_request(&self, url : &str, request_data : &str, other_headers : &str) ->  Result<String, CloudMailError>

Remarks

Allows the sending of a custom request to the Amazon web service. The URL parameter describes the endpoint that is being targeted. The RequestData is set to any data required for the request. The OtherHeaders parameter is used to set any additional headers that should be set for the request.

Example: ses.SendCustomRequest("https://email.us-east-1.amazonaws.com", "AWSAccessKeyId={ACCESS_ID}&Action=GetSendStatistics&Timestamp=2022-02-08T22%3A12%3A10.716Z", "");

set_identity_feedback_forwarding method (AmazonSES Struct)

Enables or Disables feedback forwarding for the identity.

Syntax

fn set_identity_feedback_forwarding(&self, identity : &str, forwarding_enabled : bool) -> Result<(), CloudMailError>

Remarks

This method enables or disables feedback forwarding for the identity. The Identity parameter specifies the identity on which you are operating.

The ForwardingEnabled parameter specifies whether or not feedback forwarding is enabled. A value of True indicates feedback will be sent as email. A value of False indicates that feedback will only be published to the identity_notification_bounce_topic and identity_notification_complaint_topic SNS topics.

set_identity_notification_topic method (AmazonSES Struct)

Sets the Bounce or Complaint notification topic for an identity.

Syntax

fn set_identity_notification_topic(&self, identity : &str, notification_type : i32, sns_topic : &str) -> Result<(), CloudMailError>

Remarks

This method sets the Simple Notification Service (SNS) topic used by Amazon when reporting Bounce or Complaint notifications. The Identity parameter specifies the identity for which you are setting the notification topic.

The NotificationType parameter specifies whether you are setting the topic for Bounce or Complaint notifications. Possible values are:

The SnsTopic parameter specifies Amazon Resource Name (ARN) of the Simple Notification Service (SNS) topic. This value is of the form "arn:aws:sns:us-east-1:1234567890123456:mytopic" and is returned by Amazon when creating a new topic.

verify_domain method (AmazonSES Struct)

Verifies a domain.

Syntax

fn verify_domain(&self, identity : &str) ->  Result<String, CloudMailError>

Remarks

This method send the domain specified by Identity to Amazon for verification. The method returns the verification token provided by Amazon. This is a TXT record that must be placed in the DNS settings for the domain in order to complete the verification process.

verify_email method (AmazonSES Struct)

Verifies an email address.

Syntax

fn verify_email(&self, identity : &str) -> Result<(), CloudMailError>

Remarks

This method verifies an email address specified by Identity. Amazon will send a verification e-mail to the provided address. The verification will not be complete until the user follows the instructions in the email.

on_error event (AmazonSES Struct)

Fired when information is available about errors during data delivery.

Syntax

// AmazonSESErrorEventArgs carries the AmazonSES Error event's parameters.
pub struct AmazonSESErrorEventArgs {
  fn error_code(&self) -> i32
  fn description(&self) -> &String
}

// AmazonSESErrorEvent defines the signature of the AmazonSES Error event's handler function.
pub trait AmazonSESErrorEvent {
  fn on_error(&self, sender : AmazonSES, e : &mut AmazonSESErrorEventArgs);
}

impl <'a> AmazonSES<'a> {
  pub fn on_error(&self) -> &'a dyn AmazonSESErrorEvent;
  pub fn set_on_error(&mut self, value : &'a dyn AmazonSESErrorEvent);
  ...
}

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the struct fails with an error.

The error_code parameter contains an error code, and the description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

on_identity_list event (AmazonSES Struct)

Fired for every identity when ListIdentities is called.

Syntax

// AmazonSESIdentityListEventArgs carries the AmazonSES IdentityList event's parameters.
pub struct AmazonSESIdentityListEventArgs {
  fn identity(&self) -> &String
}

// AmazonSESIdentityListEvent defines the signature of the AmazonSES IdentityList event's handler function.
pub trait AmazonSESIdentityListEvent {
  fn on_identity_list(&self, sender : AmazonSES, e : &mut AmazonSESIdentityListEventArgs);
}

impl <'a> AmazonSES<'a> {
  pub fn on_identity_list(&self) -> &'a dyn AmazonSESIdentityListEvent;
  pub fn set_on_identity_list(&mut self, value : &'a dyn AmazonSESIdentityListEvent);
  ...
}

Remarks

This event fires for each identity when list_identities is called. The Identity parameter will contain either an email address or domain depending on the parameter specified in the call to list_identities.

identities will also be populated.

on_log event (AmazonSES Struct)

Fired once for each log message.

Syntax

// AmazonSESLogEventArgs carries the AmazonSES Log event's parameters.
pub struct AmazonSESLogEventArgs {
  fn log_level(&self) -> i32
  fn message(&self) -> &String
  fn log_type(&self) -> &String
}

// AmazonSESLogEvent defines the signature of the AmazonSES Log event's handler function.
pub trait AmazonSESLogEvent {
  fn on_log(&self, sender : AmazonSES, e : &mut AmazonSESLogEventArgs);
}

impl <'a> AmazonSES<'a> {
  pub fn on_log(&self) -> &'a dyn AmazonSESLogEvent;
  pub fn set_on_log(&mut self, value : &'a dyn AmazonSESLogEvent);
  ...
}

Remarks

This event is fired once for each log message generated by the struct. The verbosity is controlled by the LogLevel setting.

log_level indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

message is the log entry.

log_type identifies the type of log entry. Possible values are as follows:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"

on_ssl_server_authentication event (AmazonSES Struct)

Fired after the server presents its certificate to the client.

Syntax

// AmazonSESSSLServerAuthenticationEventArgs carries the AmazonSES SSLServerAuthentication event's parameters.
pub struct AmazonSESSSLServerAuthenticationEventArgs {
  fn cert_encoded(&self) -> &[u8]
  fn cert_subject(&self) -> &String
  fn cert_issuer(&self) -> &String
  fn status(&self) -> &String
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// AmazonSESSSLServerAuthenticationEvent defines the signature of the AmazonSES SSLServerAuthentication event's handler function.
pub trait AmazonSESSSLServerAuthenticationEvent {
  fn on_ssl_server_authentication(&self, sender : AmazonSES, e : &mut AmazonSESSSLServerAuthenticationEventArgs);
}

impl <'a> AmazonSES<'a> {
  pub fn on_ssl_server_authentication(&self) -> &'a dyn AmazonSESSSLServerAuthenticationEvent;
  pub fn set_on_ssl_server_authentication(&mut self, value : &'a dyn AmazonSESSSLServerAuthenticationEvent);
  ...
}

Remarks

During this event, the client can decide whether or not to continue with the connection process. The accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When accept is False, status shows why the verification failed (otherwise, status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the accept parameter to True.

on_ssl_status event (AmazonSES Struct)

Fired when secure connection progress messages are available.

Syntax

// AmazonSESSSLStatusEventArgs carries the AmazonSES SSLStatus event's parameters.
pub struct AmazonSESSSLStatusEventArgs {
  fn message(&self) -> &String
}

// AmazonSESSSLStatusEvent defines the signature of the AmazonSES SSLStatus event's handler function.
pub trait AmazonSESSSLStatusEvent {
  fn on_ssl_status(&self, sender : AmazonSES, e : &mut AmazonSESSSLStatusEventArgs);
}

impl <'a> AmazonSES<'a> {
  pub fn on_ssl_status(&self) -> &'a dyn AmazonSESSSLStatusEvent;
  pub fn set_on_ssl_status(&mut self, value : &'a dyn AmazonSESSSLStatusEvent);
  ...
}

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

Config Settings (AmazonSES Struct)

SES Config Settings

<firstlevel>
  <one>value</one>
  <two>
    <item>first</item>
    <item>second</item>
  </two>
  <three>value three</three>
</firstlevel>

{
  "firstlevel": {
    "one": "value",
    "two": ["first", "second"],
    "three": "value three"
  }
}

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings

Trappable Errors (AmazonSES Struct)

SES Errors

The class may also return one of the following error codes, which are inherited from other classes.

HTTP Errors

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

SSL Errors

TCP/IP Errors