AmazonSES Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

class 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.

Property List

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

Method List

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

Event List

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

Config Settings

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

access_key Property

The Access Key Id for the Amazon Web Services account.

Syntax

def get_access_key() -> str: ...
def set_access_key(value: str) -> None: ...

access_key = property(get_access_key, set_access_key)

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.

attachment_count Property

The number of records in the Attachment arrays.

Syntax

def get_attachment_count() -> int: ...
def set_attachment_count(value: int) -> None: ...

attachment_count = property(get_attachment_count, set_attachment_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• attachment_data
• attachment_file
• attachment_name

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

attachment_data Property

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

Syntax

def get_attachment_data(attachment_index: int) -> bytes: ...
def set_attachment_data(attachment_index: int, value: bytes) -> None: ...

Default Value

""

Remarks

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

The attachment_index parameter specifies the index of the item in the array. The size of the array is controlled by the attachment_count property.

attachment_file Property

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

Syntax

def get_attachment_file(attachment_index: int) -> str: ...
def set_attachment_file(attachment_index: int, value: str) -> None: ...

Default Value

""

Remarks

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

The attachment_index parameter specifies the index of the item in the array. The size of the array is controlled by the attachment_count property.

attachment_name Property

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

Syntax

def get_attachment_name(attachment_index: int) -> str: ...
def set_attachment_name(attachment_index: int, value: str) -> None: ...

Default Value

""

Remarks

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

The attachment_index parameter specifies the index of the item in the array. The size of the array is controlled by the attachment_count property.

b_cc Property

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

Syntax

def get_b_cc() -> str: ...
def set_b_cc(value: str) -> None: ...

b_cc = property(get_b_cc, set_b_cc)

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 class 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.

cc Property

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

Syntax

def get_cc() -> str: ...
def set_cc(value: str) -> None: ...

cc = property(get_cc, set_cc)

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 class 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.

delivery_notification_to Property

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

Syntax

def get_delivery_notification_to() -> str: ...
def set_delivery_notification_to(value: str) -> None: ...

delivery_notification_to = property(get_delivery_notification_to, set_delivery_notification_to)

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.

firewall_auto_detect Property

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Syntax

def get_firewall_auto_detect() -> bool: ...
def set_firewall_auto_detect(value: bool) -> None: ...

firewall_auto_detect = property(get_firewall_auto_detect, set_firewall_auto_detect)

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

firewall_type Property

This property determines the type of firewall to connect through.

Syntax

def get_firewall_type() -> int: ...
def set_firewall_type(value: int) -> None: ...

firewall_type = property(get_firewall_type, set_firewall_type)

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

firewall_host Property

This property contains the name or IP address of firewall (optional).

Syntax

def get_firewall_host() -> str: ...
def set_firewall_host(value: str) -> None: ...

firewall_host = property(get_firewall_host, set_firewall_host)

Default Value

""

Remarks

This property contains the name or IP address of 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 class fails with an error.

firewall_password Property

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

def get_firewall_password() -> str: ...
def set_firewall_password(value: str) -> None: ...

firewall_password = property(get_firewall_password, set_firewall_password)

Default Value

""

Remarks

This property contains 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 class fails with an error.

firewall_port Property

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

def get_firewall_port() -> int: ...
def set_firewall_port(value: int) -> None: ...

firewall_port = property(get_firewall_port, set_firewall_port)

Default Value

0

Remarks

This property contains 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_type is set to a valid value. See the description of the firewall_type property for details.

firewall_user Property

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

def get_firewall_user() -> str: ...
def set_firewall_user(value: str) -> None: ...

firewall_user = property(get_firewall_user, set_firewall_user)

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the firewall_host is specified, this property and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

from_ Property

The email address of the sender (required).

Syntax

def get_from() -> str: ...
def set_from(value: str) -> None: ...

from_ = property(get_from, set_from)

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: "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.

identity_count Property

The number of records in the Identity arrays.

Syntax

def get_identity_count() -> int: ...

identity_count = property(get_identity_count, None)

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.

identity_attributes_type Property

Specifies the type of attribute.

Syntax

def get_identity_attributes_type(identity_index: int) -> int: ...

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 identity_index parameter specifies the index of the item in the array. The size of the array is controlled by the identity_count property.

This property is read-only.

identity_name Property

The current identity name.

Syntax

def get_identity_name(identity_index: int) -> str: ...

Default Value

""

Remarks

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

The identity_index parameter specifies the index of the item in the array. The size of the array is controlled by the identity_count property.

This property is read-only.

identity_notification_bounce_topic Property

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

Syntax

def get_identity_notification_bounce_topic(identity_index: int) -> str: ...

Default Value

""

Remarks

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

The identity_index parameter specifies the index of the item in the array. The size of the array is controlled by the identity_count property.

This property is read-only.

identity_notification_complaint_topic Property

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

Syntax

def get_identity_notification_complaint_topic(identity_index: int) -> str: ...

Default Value

""

Remarks

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

The identity_index parameter specifies the index of the item in the array. The size of the array is controlled by the identity_count property.

This property is read-only.

identity_notification_forwarding_enabled Property

Specifies whether or not Amazon will forward feedback as email.

Syntax

def get_identity_notification_forwarding_enabled(identity_index: int) -> bool: ...

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 identity_index parameter specifies the index of the item in the array. The size of the array is controlled by the identity_count property.

This property is read-only.

identity_verification_status Property

The current verification status of the identity.

Syntax

def get_identity_verification_status(identity_index: int) -> str: ...

Default Value

""

Remarks

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

• Pending
• Success
• Failed
• TemporaryFailure
• NotStarted

The identity_index parameter specifies the index of the item in the array. The size of the array is controlled by the identity_count property.

This property is read-only.

identity_verification_token Property

The verification token for the domain.

Syntax

def get_identity_verification_token(identity_index: int) -> str: ...

Default Value

""

Remarks

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

The identity_index parameter specifies the index of the item in the array. The size of the array is controlled by the identity_count property.

This property is read-only.

identity_marker Property

The offset marker used to navigate paged results.

Syntax

def get_identity_marker() -> str: ...
def set_identity_marker(value: str) -> None: ...

identity_marker = property(get_identity_marker, set_identity_marker)

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.

idle Property

The current status of the class.

Syntax

def get_idle() -> bool: ...

idle = property(get_idle, None)

Default Value

TRUE

Remarks

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

This property is read-only.

image_count Property

The number of records in the Image arrays.

Syntax

def get_image_count() -> int: ...
def set_image_count(value: int) -> None: ...

image_count = property(get_image_count, set_image_count)

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.

image_data Property

This property optionally specifies the image data.

Syntax

def get_image_data(image_index: int) -> bytes: ...
def set_image_data(image_index: int, value: bytes) -> None: ...

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 image_index parameter specifies the index of the item in the array. The size of the array is controlled by the image_count property.

image_file Property

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

Syntax

def get_image_file(image_index: int) -> str: ...
def set_image_file(image_index: int, value: str) -> None: ...

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 image_index parameter specifies the index of the item in the array. The size of the array is controlled by the image_count property.

image_id Property

This property contains the content identifier for embedded images.

Syntax

def get_image_id(image_index: int) -> str: ...
def set_image_id(image_index: int, value: str) -> None: ...

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 image_index parameter specifies the index of the item in the array. The size of the array is controlled by the image_count property.

image_type Property

This property contains the content type for embedded images.

Syntax

def get_image_type(image_index: int) -> str: ...
def set_image_type(image_index: int, value: str) -> None: ...

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 image_index parameter specifies the index of the item in the array. The size of the array is controlled by the image_count property.

importance Property

Importance of the mail message (optional).

Syntax

def get_importance() -> int: ...
def set_importance(value: int) -> None: ...

importance = property(get_importance, set_importance)

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 how important the message is. The possible values are Unspecified (0), High (1), Normal (2), and Low (3).

local_host Property

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

Syntax

def get_local_host() -> str: ...
def set_local_host(value: str) -> None: ...

local_host = property(get_local_host, set_local_host)

Default Value

""

Remarks

The local_host 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 multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class 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 multi-homed 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.

message_html Property

This property includes the HTML version of the message.

Syntax

def get_message_html() -> str: ...
def set_message_html(value: str) -> None: ...

message_html = property(get_message_html, set_message_html)

Default Value

""

Remarks

This property contains the HTML version of the message.

When this property is set, the class 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>";

message_recipient_count Property

The number of records in the MessageRecipient arrays.

Syntax

def get_message_recipient_count() -> int: ...
def set_message_recipient_count(value: int) -> None: ...

message_recipient_count = property(get_message_recipient_count, set_message_recipient_count)

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.

message_recipient_address Property

This property contains the email address of the recipient.

Syntax

def get_message_recipient_address(recipient_index: int) -> str: ...
def set_message_recipient_address(recipient_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the email address of the recipient.

The recipient_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_recipient_count property.

message_recipient_name Property

This property contains the name of the recipient.

Syntax

def get_message_recipient_name(recipient_index: int) -> str: ...
def set_message_recipient_name(recipient_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the name of the recipient.

The recipient_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_recipient_count property.

message_recipient_options Property

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

Syntax

def get_message_recipient_options(recipient_index: int) -> str: ...
def set_message_recipient_options(recipient_index: int, value: str) -> None: ...

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 recipient_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_recipient_count property.

message_recipient_type Property

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

Syntax

def get_message_recipient_type(recipient_index: int) -> int: ...
def set_message_recipient_type(recipient_index: int, value: int) -> None: ...

Default Value

0

Remarks

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

The recipient_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_recipient_count property.

message_text Property

This property includes the plaintext version of the message.

Syntax

def get_message_text() -> str: ...
def set_message_text(value: str) -> None: ...

message_text = property(get_message_text, set_message_text)

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 class 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.

other_headers Property

An RFC 822 compliant string consisting of extra headers.

Syntax

def get_other_headers() -> str: ...
def set_other_headers(value: str) -> None: ...

other_headers = property(get_other_headers, set_other_headers)

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, etc.

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 class. 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 (Send an Email With 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();

proxy_auth_scheme Property

This property is used to tell the class which type of authorization to perform when connecting to the proxy.

Syntax

def get_proxy_auth_scheme() -> int: ...
def set_proxy_auth_scheme(value: int) -> None: ...

proxy_auth_scheme = property(get_proxy_auth_scheme, set_proxy_auth_scheme)

Default Value

0

Remarks

This property is used to tell the class which 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 component 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 class. Look at the configuration file for the class 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.

proxy_auto_detect Property

This property tells the class whether or not to automatically detect and use proxy system settings, if available.

Syntax

def get_proxy_auto_detect() -> bool: ...
def set_proxy_auto_detect(value: bool) -> None: ...

proxy_auto_detect = property(get_proxy_auto_detect, set_proxy_auto_detect)

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is False.

proxy_password Property

This property contains a password if authentication is to be used for the proxy.

Syntax

def get_proxy_password() -> str: ...
def set_proxy_password(value: str) -> None: ...

proxy_password = property(get_proxy_password, set_proxy_password)

Default Value

""

Remarks

This property contains 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 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.

proxy_port Property

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

def get_proxy_port() -> int: ...
def set_proxy_port(value: int) -> None: ...

proxy_port = property(get_proxy_port, set_proxy_port)

Default Value

80

Remarks

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

proxy_server Property

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

Syntax

def get_proxy_server() -> str: ...
def set_proxy_server(value: str) -> None: ...

proxy_server = property(get_proxy_server, set_proxy_server)

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.

proxy_ssl Property

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

def get_proxy_ssl() -> int: ...
def set_proxy_ssl(value: int) -> None: ...

proxy_ssl = property(get_proxy_ssl, set_proxy_ssl)

Default Value

0

Remarks

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

proxy_user Property

This property contains a user name, if authentication is to be used for the proxy.

Syntax

def get_proxy_user() -> str: ...
def set_proxy_user(value: str) -> None: ...

proxy_user = property(get_proxy_user, set_proxy_user)

Default Value

""

Remarks

This property contains 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.

quota_max_per_24_hours Property

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

Syntax

def get_quota_max_per_24_hours() -> str: ...

quota_max_per_24_hours = property(get_quota_max_per_24_hours, None)

Default Value

""

Remarks

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

This property is read-only.

quota_max_per_second Property

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

Syntax

def get_quota_max_per_second() -> str: ...

quota_max_per_second = property(get_quota_max_per_second, None)

Default Value

""

Remarks

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

This property is read-only.

quota_sent_last_24_hours Property

The number of emails sent during the previous 24 hours.

Syntax

def get_quota_sent_last_24_hours() -> str: ...

quota_sent_last_24_hours = property(get_quota_sent_last_24_hours, None)

Default Value

""

Remarks

The number of emails sent during the previous 24 hours.

This property is read-only.

read_receipt_to Property

Email address to send a read receipt to.

Syntax

def get_read_receipt_to() -> str: ...
def set_read_receipt_to(value: str) -> None: ...

read_receipt_to = property(get_read_receipt_to, set_read_receipt_to)

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 which should receive the read-receipt.

reply_to Property

A mail address to which to reply (optional).

Syntax

def get_reply_to() -> str: ...
def set_reply_to(value: str) -> None: ...

reply_to = property(get_reply_to, set_reply_to)

Default Value

""

Remarks

If this property contains a non-empty string, a Reply-To SMTP header is created for the message. This header shows the address to use for replies (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.

secret_key Property

The Secret Access Key for the Amazon Web Services account.

Syntax

def get_secret_key() -> str: ...
def set_secret_key(value: str) -> None: ...

secret_key = property(get_secret_key, set_secret_key)

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.

send_stat_count Property

The number of records in the SendStat arrays.

Syntax

def get_send_stat_count() -> int: ...

send_stat_count = property(get_send_stat_count, None)

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.

send_stat_bounces Property

The number of emails that bounced.

Syntax

def get_send_stat_bounces(send_stat_index: int) -> int: ...

Default Value

0

Remarks

The number of emails that bounced.

The send_stat_index parameter specifies the index of the item in the array. The size of the array is controlled by the send_stat_count property.

This property is read-only.

send_stat_complaints Property

The number of emails that were rejected by the recipient.

Syntax

def get_send_stat_complaints(send_stat_index: int) -> int: ...

Default Value

0

Remarks

The number of emails that were rejected by the recipient.

The send_stat_index parameter specifies the index of the item in the array. The size of the array is controlled by the send_stat_count property.

This property is read-only.

send_stat_delivery_attempts Property

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

Syntax

def get_send_stat_delivery_attempts(send_stat_index: int) -> int: ...

Default Value

0

Remarks

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

The send_stat_index parameter specifies the index of the item in the array. The size of the array is controlled by the send_stat_count property.

This property is read-only.

send_stat_rejects Property

The number of emails rejected by Amazon SES.

Syntax

def get_send_stat_rejects(send_stat_index: int) -> int: ...

Default Value

0

Remarks

The number of emails rejected by Amazon SES.

The send_stat_index parameter specifies the index of the item in the array. The size of the array is controlled by the send_stat_count property.

This property is read-only.

send_stat_timestamp Property

The time of the data point.

Syntax

def get_send_stat_timestamp(send_stat_index: int) -> str: ...

Default Value

""

Remarks

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

The send_stat_index parameter specifies the index of the item in the array. The size of the array is controlled by the send_stat_count property.

This property is read-only.

send_to Property

A comma separated list of addresses for destinations (required).

Syntax

def get_send_to() -> str: ...
def set_send_to(value: str) -> None: ...

send_to = property(get_send_to, set_send_to)

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: "Friendly Name" <address@company.com> or address@company.com

The class 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 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.

ssl_accept_server_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_ssl_accept_server_cert_encoded() -> bytes: ...
def set_ssl_accept_server_cert_encoded(value: bytes) -> None: ...

ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded)

Default Value

""

Remarks

This is 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.

ssl_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_ssl_cert_encoded() -> bytes: ...
def set_ssl_cert_encoded(value: bytes) -> None: ...

ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)

Default Value

""

Remarks

This is 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.

ssl_cert_store Property

This is the name of the certificate store for the client certificate.

Syntax

def get_ssl_cert_store() -> bytes: ...
def set_ssl_cert_store(value: bytes) -> None: ...

ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)

Default Value

"MY"

Remarks

This is 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 PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

ssl_cert_store_password Property

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

Syntax

def get_ssl_cert_store_password() -> str: ...
def set_ssl_cert_store_password(value: str) -> None: ...

ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)

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.

ssl_cert_store_type Property

This is the type of certificate store for this certificate.

Syntax

def get_ssl_cert_store_type() -> int: ...
def set_ssl_cert_store_type(value: int) -> None: ...

ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

ssl_cert_subject Property

This is the subject of the certificate used for client authentication.

Syntax

def get_ssl_cert_subject() -> str: ...
def set_ssl_cert_subject(value: str) -> None: ...

ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)

Default Value

""

Remarks

This is 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=support@nsoftware.com". Common fields and their meanings are as follows:

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

ssl_provider Property

This specifies the SSL/TLS implementation to use.

Syntax

def get_ssl_provider() -> int: ...
def set_ssl_provider(value: int) -> None: ...

ssl_provider = property(get_ssl_provider, set_ssl_provider)

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 class 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:

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

When Automatic is selected, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

ssl_server_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_ssl_server_cert_encoded() -> bytes: ...

ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)

Default Value

""

Remarks

This is 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.

subject Property

The subject of the mail message (optional).

Syntax

def get_subject() -> str: ...
def set_subject(value: str) -> None: ...

subject = property(get_subject, set_subject)

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.

timeout Property

A timeout for the class.

Syntax

def get_timeout() -> int: ...
def set_timeout(value: int) -> None: ...

timeout = property(get_timeout, set_timeout)

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 class will wait for the operation to complete before returning control.

The class 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 class fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. 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.

add_attachment Method

This adds FileName as an attachment.

Syntax

def add_attachment(file_name: str) -> None: ...

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

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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

Deletes the identity.

Syntax

def delete_identity(identity: str) -> None: ...

Remarks

This method deletes the identity specified by Identity.

do_events Method

Processes events from the internal message queue.

Syntax

def do_events() -> None: ...

Remarks

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

get_identity_attributes Method

Gets the attributes of the given identity.

Syntax

def get_identity_attributes(identity: str, attribute_type: int) -> None: ...

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

Gets send quota information.

Syntax

def get_send_quota() -> None: ...

Remarks

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

• quota_max_per_24_hours
• quota_max_per_second
• quota_sent_last_24_hours

get_send_statistics Method

Gets the user's sending statistics.

Syntax

def get_send_statistics() -> None: ...

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_x_value Method

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

Syntax

def get_x_value(xpath: str) -> str: ...

Remarks

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

interrupt Method

Interrupt the current method.

Syntax

def interrupt() -> None: ...

Remarks

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

list_identities Method

Lists the identities of the given type.

Syntax

def list_identities(identity_type: int) -> None: ...

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

Resets request-related properties.

Syntax

def reset() -> None: ...

Remarks

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

send Method

Sends the message.

Syntax

def send() -> None: ...

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

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

Syntax

def send_custom_request(url: str, request_data: str, other_headers: str) -> str: ...

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

Enables or Disables feedback forwarding for the identity.

Syntax

def set_identity_feedback_forwarding(identity: str, forwarding_enabled: bool) -> None: ...

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

Sets the Bounce or Complaint notification topic for an identity.

Syntax

def set_identity_notification_topic(identity: str, notification_type: int, sns_topic: str) -> None: ...

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

Verifies a domain.

Syntax

def verify_domain(identity: str) -> str: ...

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

Verifies an email address.

Syntax

def verify_email(identity: str) -> None: ...

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

Information about errors during data delivery.

Syntax

class AmazonSESErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class AmazonSES:
@property
def on_error() -> Callable[[AmazonSESErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[AmazonSESErrorEventParams], None]) -> None: ...

Remarks

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

The ErrorCode 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

Fired for every identity when ListIdentities is called.

Syntax

class AmazonSESIdentityListEventParams(object):
  @property
  def identity() -> str: ...

# In class AmazonSES:
@property
def on_identity_list() -> Callable[[AmazonSESIdentityListEventParams], None]: ...
@on_identity_list.setter
def on_identity_list(event_hook: Callable[[AmazonSESIdentityListEventParams], None]) -> None: ...

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

This event fires once for each log message.

Syntax

class AmazonSESLogEventParams(object):
  @property
  def log_level() -> int: ...

  @property
  def message() -> str: ...

  @property
  def log_type() -> str: ...

# In class AmazonSES:
@property
def on_log() -> Callable[[AmazonSESLogEventParams], None]: ...
@on_log.setter
def on_log(event_hook: Callable[[AmazonSESLogEventParams], None]) -> None: ...

Remarks

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

LogLevel 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.

LogType 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

Fired after the server presents its certificate to the client.

Syntax

class AmazonSESSSLServerAuthenticationEventParams(object):
  @property
  def cert_encoded() -> bytes: ...

  @property
  def cert_subject() -> str: ...

  @property
  def cert_issuer() -> str: ...

  @property
  def status() -> str: ...

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class AmazonSES:
@property
def on_ssl_server_authentication() -> Callable[[AmazonSESSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[AmazonSESSSLServerAuthenticationEventParams], None]) -> None: ...

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

Shows the progress of the secure connection.

Syntax

class AmazonSESSSLStatusEventParams(object):
  @property
  def message() -> str: ...

# In class AmazonSES:
@property
def on_ssl_status() -> Callable[[AmazonSESSSLStatusEventParams], None]: ...
@on_ssl_status.setter
def on_ssl_status(event_hook: Callable[[AmazonSESSSLStatusEventParams], None]) -> None: ...

Remarks

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

AmazonSES Config Settings

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
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

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

Socket Config Settings

Base Config Settings

AmazonSES Errors

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