AmazonSES Control

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

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 AccessKey and SecretKey to authenticate to Amazon. To send an e-mail set MessageHTML or MessageText along with From, Subject, SendTo and call Send.

Various other administrative methods are also available, such as ListIdentities, VerifyDomain, VerifyEmail, and more.

Property List

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

Method List

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

Event List

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

Config Settings

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

AccessKey Property (AmazonSES Control)

The Access Key Id for the Amazon Web Services account.

Syntax

amazonsescontrol.AccessKey[=string]

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 SecretKey to authenticate with Amazon servers.

Data Type

String

AttachmentCount Property (AmazonSES Control)

The number of records in the Attachment arrays.

Syntax

amazonsescontrol.AttachmentCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

• AttachmentData
• AttachmentFileName
• AttachmentName

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

This property is not available at design time.

Data Type

Integer

AttachmentData Property (AmazonSES Control)

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

Syntax

amazonsescontrol.AttachmentData(AttachmentIndex)[=string]

Default Value

""

Remarks

The raw data for the attachment that will be sent with your message. This field is used if AttachmentFileName 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.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .AttachmentDataB.

This property is not available at design time.

Data Type

Binary String

AttachmentFileName Property (AmazonSES Control)

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

Syntax

amazonsescontrol.AttachmentFileName(AttachmentIndex)[=string]

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.

This property is not available at design time.

Data Type

String

AttachmentName Property (AmazonSES Control)

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

Syntax

amazonsescontrol.AttachmentName(AttachmentIndex)[=string]

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.

This property is not available at design time.

Data Type

String

BCc Property (AmazonSES Control)

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

Syntax

amazonsescontrol.BCc[=string]

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 control will return an error if the MailServer returns an error code about any email address specified in SendTo or Cc but it will fire an 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 MessageRecipients properties before setting this property to remove previous recipients.

Data Type

String

Cc Property (AmazonSES Control)

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

Syntax

amazonsescontrol.Cc[=string]

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 BCc).

The control will return an error if the MailServer returns an error code about any email address specified in SendTo or Cc but it will fire an Error event only if the same thing happens with an email address specified in BCc.

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

Note: You must clear the MessageRecipients properties before setting this property to remove previous recipients.

Data Type

String

DeliveryNotificationTo Property (AmazonSES Control)

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

Syntax

amazonsescontrol.DeliveryNotificationTo[=string]

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

FirewallAutoDetect Property (AmazonSES Control)

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

Syntax

amazonsescontrol.FirewallAutoDetect[=boolean]

Default Value

False

Remarks

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

Data Type

Boolean

FirewallType Property (AmazonSES Control)

The type of firewall to connect through.

Syntax

amazonsescontrol.FirewallType[=integer]

Possible Values

fwNone(0), 
fwTunnel(1), 
fwSOCKS4(2), 
fwSOCKS5(3), 
fwSOCKS4A(10)

Default Value

0

Remarks

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

Data Type

Integer

FirewallHost Property (AmazonSES Control)

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

Syntax

amazonsescontrol.FirewallHost[=string]

Default Value

""

Remarks

The name or IP address of the firewall (optional). If a FirewallHost 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 control fails with an error.

Data Type

String

FirewallPassword Property (AmazonSES Control)

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

Syntax

amazonsescontrol.FirewallPassword[=string]

Default Value

""

Remarks

A password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the control fails with an error.

Data Type

String

FirewallPort Property (AmazonSES Control)

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

Syntax

amazonsescontrol.FirewallPort[=integer]

Default Value

0

Remarks

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

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

Data Type

Integer

FirewallUser Property (AmazonSES Control)

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

Syntax

amazonsescontrol.FirewallUser[=string]

Default Value

""

Remarks

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

Data Type

String

From Property (AmazonSES Control)

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

Syntax

amazonsescontrol.From[=string]

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

IdentityCount Property (AmazonSES Control)

The number of records in the Identity arrays.

Syntax

amazonsescontrol.IdentityCount

Default Value

0

Remarks

This property controls the size of the following arrays:

• IdentityAttributesType
• IdentityName
• IdentityNotificationBounceTopic
• IdentityNotificationComplaintTopic
• IdentityNotificationForwardingEnabled
• IdentityVerificationStatus
• IdentityVerificationToken

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

This property is read-only and not available at design time.

Data Type

Integer

IdentityAttributesType Property (AmazonSES Control)

Specifies the type of attribute.

Syntax

amazonsescontrol.IdentityAttributesType(IdentityIndex)

Default Value

0

Remarks

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

• IdentityName
• IdentityNotificationBounceTopic
• IdentityNotificationComplaintTopic
• IdentityNotificationForwardingEnabled

• IdentityName
• IdentityVerificationStatus
• IdentityVerificationToken

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 and not available at design time.

Data Type

Integer

IdentityName Property (AmazonSES Control)

The current identity name.

Syntax

amazonsescontrol.IdentityName(IdentityIndex)

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 and not available at design time.

Data Type

String

IdentityNotificationBounceTopic Property (AmazonSES Control)

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

Syntax

amazonsescontrol.IdentityNotificationBounceTopic(IdentityIndex)

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 and not available at design time.

Data Type

String

IdentityNotificationComplaintTopic Property (AmazonSES Control)

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

Syntax

amazonsescontrol.IdentityNotificationComplaintTopic(IdentityIndex)

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 and not available at design time.

Data Type

String

IdentityNotificationForwardingEnabled Property (AmazonSES Control)

Specifies whether or not Amazon will forward feedback as email.

Syntax

amazonsescontrol.IdentityNotificationForwardingEnabled(IdentityIndex)

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 IdentityNotificationBounceTopic and IdentityNotificationComplaintTopic 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 and not available at design time.

Data Type

Boolean

IdentityVerificationStatus Property (AmazonSES Control)

The current verification status of the identity.

Syntax

amazonsescontrol.IdentityVerificationStatus(IdentityIndex)

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 and not available at design time.

Data Type

String

IdentityVerificationToken Property (AmazonSES Control)

The verification token for the domain.

Syntax

amazonsescontrol.IdentityVerificationToken(IdentityIndex)

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 and not available at design time.

Data Type

String

IdentityMarker Property (AmazonSES Control)

The offset marker used to navigate paged results.

Syntax

amazonsescontrol.IdentityMarker[=string]

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 ListIdentities. If this holds a value, subsequent calls to ListIdentities will use this value to get the next page of results. See also: ListIdentities, IsPaged.

This property is not available at design time.

Data Type

String

Idle Property (AmazonSES Control)

The current status of the control.

Syntax

amazonsescontrol.Idle

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

Boolean

ImageCount Property (AmazonSES Control)

The number of records in the Image arrays.

Syntax

amazonsescontrol.ImageCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

• ImageData
• ImageFile
• ImageId
• ImageType

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

This property is not available at design time.

Data Type

Integer

ImageData Property (AmazonSES Control)

This property optionally specifies the image data.

Syntax

amazonsescontrol.ImageData(ImageIndex)[=string]

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.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .ImageDataB.

This property is not available at design time.

Data Type

Binary String

ImageFile Property (AmazonSES Control)

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

Syntax

amazonsescontrol.ImageFile(ImageIndex)[=string]

Default Value

""

Remarks

This property contains the name of the image files embedded into the HTML message. This value is updated every time MessageHTML 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.

This property is not available at design time.

Data Type

String

ImageId Property (AmazonSES Control)

This property contains the content identifier for embedded images.

Syntax

amazonsescontrol.ImageId(ImageIndex)[=string]

Default Value

""

Remarks

This property contains the content identifier for embedded images. This value is computed automatically, unless ParseHTML 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.

This property is not available at design time.

Data Type

String

ImageType Property (AmazonSES Control)

This property contains the content type for embedded images.

Syntax

amazonsescontrol.ImageType(ImageIndex)[=string]

Default Value

""

Remarks

This property contains the content type for embedded images. This value is determined automatically, unless ParseHTML 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.

This property is not available at design time.

Data Type

String

Importance Property (AmazonSES Control)

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

Syntax

amazonsescontrol.Importance[=integer]

Possible Values

miUnspecified(0), 
miHigh(1), 
miNormal(2), 
miLow(3)

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

Integer

LocalHost Property (AmazonSES Control)

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

Syntax

amazonsescontrol.LocalHost[=string]

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 control initiate connections (or accept in the case of server controls) 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 control is connected, the LocalHost 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: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

MessageHTML Property (AmazonSES Control)

This property includes the HTML version of the message.

Syntax

amazonsescontrol.MessageHTML[=string]

Default Value

""

Remarks

This property contains the HTML version of the message.

When this property is set, the control automatically computes a plaintext version of the text and puts it into MessageText. 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

MessageRecipientCount Property (AmazonSES Control)

The number of records in the MessageRecipient arrays.

Syntax

amazonsescontrol.MessageRecipientCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

• MessageRecipientAddress
• MessageRecipientName
• MessageRecipientOptions
• MessageRecipientType

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

This property is not available at design time.

Data Type

Integer

MessageRecipientAddress Property (AmazonSES Control)

This property contains the email address of the recipient.

Syntax

amazonsescontrol.MessageRecipientAddress(RecipientIndex)[=string]

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.

This property is not available at design time.

Data Type

String

MessageRecipientName Property (AmazonSES Control)

This property contains the name of the recipient.

Syntax

amazonsescontrol.MessageRecipientName(RecipientIndex)[=string]

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.

This property is not available at design time.

Data Type

String

MessageRecipientOptions Property (AmazonSES Control)

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

Syntax

amazonsescontrol.MessageRecipientOptions(RecipientIndex)[=string]

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.

This property is not available at design time.

Data Type

String

MessageRecipientType Property (AmazonSES Control)

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

Syntax

amazonsescontrol.MessageRecipientType(RecipientIndex)[=integer]

Possible Values

rtTo(0), 
rtCc(1), 
rtBCc(2)

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.

This property is not available at design time.

Data Type

Integer

MessageText Property (AmazonSES Control)

This property includes the plaintext version of the message.

Syntax

amazonsescontrol.MessageText[=string]

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 MessageHTML property contains the HTML version of the message. When MessageHTML is set, the control 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

OtherHeaders Property (AmazonSES Control)

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

Syntax

amazonsescontrol.OtherHeaders[=string]

Default Value

""

Remarks

This property contains a string of headers to be appended to the message headers created from other properties like SendTo, 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 (Chr$(13) & Chr$(10)) .

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 control. 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();

This property is not available at design time.

Data Type

String

ProxyAuthScheme Property (AmazonSES Control)

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

Syntax

amazonsescontrol.ProxyAuthScheme[=integer]

Possible Values

authBasic(0), 
authDigest(1), 
authProprietary(2), 
authNone(3), 
authNtlm(4), 
authNegotiate(5)

Default Value

0

Remarks

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

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

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the control will attempt basic authentication.

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

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

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

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (AmazonSES Control)

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

Syntax

amazonsescontrol.ProxyAutoDetect[=boolean]

Default Value

False

Remarks

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

Data Type

Boolean

ProxyPassword Property (AmazonSES Control)

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

Syntax

amazonsescontrol.ProxyPassword[=string]

Default Value

""

Remarks

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

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

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (AmazonSES Control)

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

Syntax

amazonsescontrol.ProxyPort[=integer]

Default Value

80

Remarks

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

Data Type

Integer

ProxyServer Property (AmazonSES Control)

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

Syntax

amazonsescontrol.ProxyServer[=string]

Default Value

""

Remarks

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

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

Data Type

String

ProxySSL Property (AmazonSES Control)

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

Syntax

amazonsescontrol.ProxySSL[=integer]

Possible Values

psAutomatic(0), 
psAlways(1), 
psNever(2), 
psTunnel(3)

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

Integer

ProxyUser Property (AmazonSES Control)

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

Syntax

amazonsescontrol.ProxyUser[=string]

Default Value

""

Remarks

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

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

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

QuotaMaxPer24Hours Property (AmazonSES Control)

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

Syntax

amazonsescontrol.QuotaMaxPer24Hours

Default Value

""

Remarks

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

This property is read-only and not available at design time.

Data Type

String

QuotaMaxPerSecond Property (AmazonSES Control)

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

Syntax

amazonsescontrol.QuotaMaxPerSecond

Default Value

""

Remarks

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

This property is read-only and not available at design time.

Data Type

String

QuotaSentLast24Hours Property (AmazonSES Control)

The number of emails sent during the previous 24 hours.

Syntax

amazonsescontrol.QuotaSentLast24Hours

Default Value

""

Remarks

The number of emails sent during the previous 24 hours.

This property is read-only and not available at design time.

Data Type

String

ReadReceiptTo Property (AmazonSES Control)

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

Syntax

amazonsescontrol.ReadReceiptTo[=string]

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

ReplyTo Property (AmazonSES Control)

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

Syntax

amazonsescontrol.ReplyTo[=string]

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

SecretKey Property (AmazonSES Control)

The Secret Access Key for the Amazon Web Services account.

Syntax

amazonsescontrol.SecretKey[=string]

Default Value

""

Remarks

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

Data Type

String

SendStatCount Property (AmazonSES Control)

The number of records in the SendStat arrays.

Syntax

amazonsescontrol.SendStatCount

Default Value

0

Remarks

This property controls the size of the following arrays:

• SendStatBounces
• SendStatComplaints
• SendStatDeliveryAttempts
• SendStatRejects
• SendStatTimestamp

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

This property is read-only and not available at design time.

Data Type

Integer

SendStatBounces Property (AmazonSES Control)

The number of emails that bounced.

Syntax

amazonsescontrol.SendStatBounces(SendStatIndex)

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 and not available at design time.

Data Type

Long64

SendStatComplaints Property (AmazonSES Control)

The number of emails that were rejected by the recipient.

Syntax

amazonsescontrol.SendStatComplaints(SendStatIndex)

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 and not available at design time.

Data Type

Long64

SendStatDeliveryAttempts Property (AmazonSES Control)

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

Syntax

amazonsescontrol.SendStatDeliveryAttempts(SendStatIndex)

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 and not available at design time.

Data Type

Long64

SendStatRejects Property (AmazonSES Control)

The number of emails rejected by Amazon SES.

Syntax

amazonsescontrol.SendStatRejects(SendStatIndex)

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 and not available at design time.

Data Type

Long64

SendStatTimestamp Property (AmazonSES Control)

The time of the data point.

Syntax

amazonsescontrol.SendStatTimestamp(SendStatIndex)

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 and not available at design time.

Data Type

String

SendTo Property (AmazonSES Control)

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

Syntax

amazonsescontrol.SendTo[=string]

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 control will fail if the MailServer 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 BCc.

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

Note: You must clear the MessageRecipients properties before setting this property to remove previous recipients.

Data Type

String

SSLAcceptServerCertEffectiveDate Property (AmazonSES Control)

The date on which this certificate becomes valid.

Syntax

amazonsescontrol.SSLAcceptServerCertEffectiveDate

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

SSLAcceptServerCertExpirationDate Property (AmazonSES Control)

The date on which the certificate expires.

Syntax

amazonsescontrol.SSLAcceptServerCertExpirationDate

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

SSLAcceptServerCertExtendedKeyUsage Property (AmazonSES Control)

A comma-delimited list of extended key usage identifiers.

Syntax

amazonsescontrol.SSLAcceptServerCertExtendedKeyUsage

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

SSLAcceptServerCertFingerprint Property (AmazonSES Control)

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

Syntax

amazonsescontrol.SSLAcceptServerCertFingerprint

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

SSLAcceptServerCertFingerprintSHA1 Property (AmazonSES Control)

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

Syntax

amazonsescontrol.SSLAcceptServerCertFingerprintSHA1

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

SSLAcceptServerCertFingerprintSHA256 Property (AmazonSES Control)

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

Syntax

amazonsescontrol.SSLAcceptServerCertFingerprintSHA256

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

SSLAcceptServerCertIssuer Property (AmazonSES Control)

The issuer of the certificate.

Syntax

amazonsescontrol.SSLAcceptServerCertIssuer

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

SSLAcceptServerCertPrivateKey Property (AmazonSES Control)

The private key of the certificate (if available).

Syntax

amazonsescontrol.SSLAcceptServerCertPrivateKey

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (AmazonSES Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

amazonsescontrol.SSLAcceptServerCertPrivateKeyAvailable

Default Value

False

Remarks

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

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (AmazonSES Control)

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

Syntax

amazonsescontrol.SSLAcceptServerCertPrivateKeyContainer

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (AmazonSES Control)

The public key of the certificate.

Syntax

amazonsescontrol.SSLAcceptServerCertPublicKey

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

SSLAcceptServerCertPublicKeyAlgorithm Property (AmazonSES Control)

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

Syntax

amazonsescontrol.SSLAcceptServerCertPublicKeyAlgorithm

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

SSLAcceptServerCertPublicKeyLength Property (AmazonSES Control)

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

Syntax

amazonsescontrol.SSLAcceptServerCertPublicKeyLength

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

Integer

SSLAcceptServerCertSerialNumber Property (AmazonSES Control)

The serial number of the certificate encoded as a string.

Syntax

amazonsescontrol.SSLAcceptServerCertSerialNumber

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

SSLAcceptServerCertSignatureAlgorithm Property (AmazonSES Control)

The text description of the certificate's signature algorithm.

Syntax

amazonsescontrol.SSLAcceptServerCertSignatureAlgorithm

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

SSLAcceptServerCertStore Property (AmazonSES Control)

The name of the certificate store for the client certificate.

Syntax

amazonsescontrol.SSLAcceptServerCertStore[=string]

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject 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).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertStoreB.

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (AmazonSES Control)

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

Syntax

amazonsescontrol.SSLAcceptServerCertStorePassword[=string]

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

SSLAcceptServerCertStoreType Property (AmazonSES Control)

The type of certificate store for this certificate.

Syntax

amazonsescontrol.SSLAcceptServerCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (AmazonSES Control)

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

Syntax

amazonsescontrol.SSLAcceptServerCertSubjectAltNames

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (AmazonSES Control)

The MD5 hash of the certificate.

Syntax

amazonsescontrol.SSLAcceptServerCertThumbprintMD5

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

SSLAcceptServerCertThumbprintSHA1 Property (AmazonSES Control)

The SHA-1 hash of the certificate.

Syntax

amazonsescontrol.SSLAcceptServerCertThumbprintSHA1

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

SSLAcceptServerCertThumbprintSHA256 Property (AmazonSES Control)

The SHA-256 hash of the certificate.

Syntax

amazonsescontrol.SSLAcceptServerCertThumbprintSHA256

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

SSLAcceptServerCertUsage Property (AmazonSES Control)

The text description of UsageFlags .

Syntax

amazonsescontrol.SSLAcceptServerCertUsage

Default Value

""

Remarks

The text description of SSLAcceptServerCertUsageFlags.

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

SSLAcceptServerCertUsageFlags Property (AmazonSES Control)

The flags that show intended use for the certificate.

Syntax

amazonsescontrol.SSLAcceptServerCertUsageFlags

Default Value

0

Remarks

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

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (AmazonSES Control)

The certificate's version number.

Syntax

amazonsescontrol.SSLAcceptServerCertVersion

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

SSLAcceptServerCertSubject Property (AmazonSES Control)

The subject of the certificate used for client authentication.

Syntax

amazonsescontrol.SSLAcceptServerCertSubject[=string]

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

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

Data Type

String

SSLAcceptServerCertEncoded Property (AmazonSES Control)

The certificate (PEM/Base64 encoded).

Syntax

amazonsescontrol.SSLAcceptServerCertEncoded[=string]

Default Value

""

Remarks

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

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

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertEffectiveDate Property (AmazonSES Control)

The date on which this certificate becomes valid.

Syntax

amazonsescontrol.SSLCertEffectiveDate

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

SSLCertExpirationDate Property (AmazonSES Control)

The date on which the certificate expires.

Syntax

amazonsescontrol.SSLCertExpirationDate

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

SSLCertExtendedKeyUsage Property (AmazonSES Control)

A comma-delimited list of extended key usage identifiers.

Syntax

amazonsescontrol.SSLCertExtendedKeyUsage

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

SSLCertFingerprint Property (AmazonSES Control)

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

Syntax

amazonsescontrol.SSLCertFingerprint

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

SSLCertFingerprintSHA1 Property (AmazonSES Control)

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

Syntax

amazonsescontrol.SSLCertFingerprintSHA1

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

SSLCertFingerprintSHA256 Property (AmazonSES Control)

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

Syntax

amazonsescontrol.SSLCertFingerprintSHA256

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

SSLCertIssuer Property (AmazonSES Control)

The issuer of the certificate.

Syntax

amazonsescontrol.SSLCertIssuer

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

SSLCertPrivateKey Property (AmazonSES Control)

The private key of the certificate (if available).

Syntax

amazonsescontrol.SSLCertPrivateKey

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (AmazonSES Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

amazonsescontrol.SSLCertPrivateKeyAvailable

Default Value

False

Remarks

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

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (AmazonSES Control)

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

Syntax

amazonsescontrol.SSLCertPrivateKeyContainer

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertPublicKey Property (AmazonSES Control)

The public key of the certificate.

Syntax

amazonsescontrol.SSLCertPublicKey

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

SSLCertPublicKeyAlgorithm Property (AmazonSES Control)

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

Syntax

amazonsescontrol.SSLCertPublicKeyAlgorithm

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

SSLCertPublicKeyLength Property (AmazonSES Control)

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

Syntax

amazonsescontrol.SSLCertPublicKeyLength

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

Integer

SSLCertSerialNumber Property (AmazonSES Control)

The serial number of the certificate encoded as a string.

Syntax

amazonsescontrol.SSLCertSerialNumber

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

SSLCertSignatureAlgorithm Property (AmazonSES Control)

The text description of the certificate's signature algorithm.

Syntax

amazonsescontrol.SSLCertSignatureAlgorithm

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

SSLCertStore Property (AmazonSES Control)

The name of the certificate store for the client certificate.

Syntax

amazonsescontrol.SSLCertStore[=string]

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password-protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject 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).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertStoreB.

Data Type

Binary String

SSLCertStorePassword Property (AmazonSES Control)

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

Syntax

amazonsescontrol.SSLCertStorePassword[=string]

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

SSLCertStoreType Property (AmazonSES Control)

The type of certificate store for this certificate.

Syntax

amazonsescontrol.SSLCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubjectAltNames Property (AmazonSES Control)

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

Syntax

amazonsescontrol.SSLCertSubjectAltNames

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (AmazonSES Control)

The MD5 hash of the certificate.

Syntax

amazonsescontrol.SSLCertThumbprintMD5

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

SSLCertThumbprintSHA1 Property (AmazonSES Control)

The SHA-1 hash of the certificate.

Syntax

amazonsescontrol.SSLCertThumbprintSHA1

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

SSLCertThumbprintSHA256 Property (AmazonSES Control)

The SHA-256 hash of the certificate.

Syntax

amazonsescontrol.SSLCertThumbprintSHA256

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

SSLCertUsage Property (AmazonSES Control)

The text description of UsageFlags .

Syntax

amazonsescontrol.SSLCertUsage

Default Value

""

Remarks

The text description of SSLCertUsageFlags.

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

SSLCertUsageFlags Property (AmazonSES Control)

The flags that show intended use for the certificate.

Syntax

amazonsescontrol.SSLCertUsageFlags

Default Value

0

Remarks

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

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SSLCertVersion Property (AmazonSES Control)

The certificate's version number.

Syntax

amazonsescontrol.SSLCertVersion

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

SSLCertSubject Property (AmazonSES Control)

The subject of the certificate used for client authentication.

Syntax

amazonsescontrol.SSLCertSubject[=string]

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

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

Data Type

String

SSLCertEncoded Property (AmazonSES Control)

The certificate (PEM/Base64 encoded).

Syntax

amazonsescontrol.SSLCertEncoded[=string]

Default Value

""

Remarks

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

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

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLProvider Property (AmazonSES Control)

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

Syntax

amazonsescontrol.SSLProvider[=integer]

Possible Values

sslpAutomatic(0), 
sslpPlatform(1), 
sslpInternal(2)

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 control 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 control will select a provider depending on the current platform.

When Automatic is selected, the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used.

Data Type

Integer

SSLServerCertEffectiveDate Property (AmazonSES Control)

The date on which this certificate becomes valid.

Syntax

amazonsescontrol.SSLServerCertEffectiveDate

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

SSLServerCertExpirationDate Property (AmazonSES Control)

The date on which the certificate expires.

Syntax

amazonsescontrol.SSLServerCertExpirationDate

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

SSLServerCertExtendedKeyUsage Property (AmazonSES Control)

A comma-delimited list of extended key usage identifiers.

Syntax

amazonsescontrol.SSLServerCertExtendedKeyUsage

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

SSLServerCertFingerprint Property (AmazonSES Control)

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

Syntax

amazonsescontrol.SSLServerCertFingerprint

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

SSLServerCertFingerprintSHA1 Property (AmazonSES Control)

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

Syntax

amazonsescontrol.SSLServerCertFingerprintSHA1

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

SSLServerCertFingerprintSHA256 Property (AmazonSES Control)

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

Syntax

amazonsescontrol.SSLServerCertFingerprintSHA256

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

SSLServerCertIssuer Property (AmazonSES Control)

The issuer of the certificate.

Syntax

amazonsescontrol.SSLServerCertIssuer

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

SSLServerCertPrivateKey Property (AmazonSES Control)

The private key of the certificate (if available).

Syntax

amazonsescontrol.SSLServerCertPrivateKey

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (AmazonSES Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

amazonsescontrol.SSLServerCertPrivateKeyAvailable

Default Value

False

Remarks

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

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (AmazonSES Control)

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

Syntax

amazonsescontrol.SSLServerCertPrivateKeyContainer

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (AmazonSES Control)

The public key of the certificate.

Syntax

amazonsescontrol.SSLServerCertPublicKey

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

SSLServerCertPublicKeyAlgorithm Property (AmazonSES Control)

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

Syntax

amazonsescontrol.SSLServerCertPublicKeyAlgorithm

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

SSLServerCertPublicKeyLength Property (AmazonSES Control)

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

Syntax

amazonsescontrol.SSLServerCertPublicKeyLength

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

Integer

SSLServerCertSerialNumber Property (AmazonSES Control)

The serial number of the certificate encoded as a string.

Syntax

amazonsescontrol.SSLServerCertSerialNumber

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

SSLServerCertSignatureAlgorithm Property (AmazonSES Control)

The text description of the certificate's signature algorithm.

Syntax

amazonsescontrol.SSLServerCertSignatureAlgorithm

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

SSLServerCertStore Property (AmazonSES Control)

The name of the certificate store for the client certificate.

Syntax

amazonsescontrol.SSLServerCertStore

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.

SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject 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).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertStoreB.

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword Property (AmazonSES Control)

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

Syntax

amazonsescontrol.SSLServerCertStorePassword

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

SSLServerCertStoreType Property (AmazonSES Control)

The type of certificate store for this certificate.

Syntax

amazonsescontrol.SSLServerCertStoreType

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

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

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (AmazonSES Control)

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

Syntax

amazonsescontrol.SSLServerCertSubjectAltNames

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (AmazonSES Control)

The MD5 hash of the certificate.

Syntax

amazonsescontrol.SSLServerCertThumbprintMD5

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

SSLServerCertThumbprintSHA1 Property (AmazonSES Control)

The SHA-1 hash of the certificate.

Syntax

amazonsescontrol.SSLServerCertThumbprintSHA1

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

SSLServerCertThumbprintSHA256 Property (AmazonSES Control)

The SHA-256 hash of the certificate.

Syntax

amazonsescontrol.SSLServerCertThumbprintSHA256

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

SSLServerCertUsage Property (AmazonSES Control)

The text description of UsageFlags .

Syntax

amazonsescontrol.SSLServerCertUsage

Default Value

""

Remarks

The text description of SSLServerCertUsageFlags.

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

SSLServerCertUsageFlags Property (AmazonSES Control)

The flags that show intended use for the certificate.

Syntax

amazonsescontrol.SSLServerCertUsageFlags

Default Value

0

Remarks

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

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (AmazonSES Control)

The certificate's version number.

Syntax

amazonsescontrol.SSLServerCertVersion

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

SSLServerCertSubject Property (AmazonSES Control)

The subject of the certificate used for client authentication.

Syntax

amazonsescontrol.SSLServerCertSubject

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=support@nsoftware.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

SSLServerCertEncoded Property (AmazonSES Control)

The certificate (PEM/Base64 encoded).

Syntax

amazonsescontrol.SSLServerCertEncoded

Default Value

""

Remarks

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

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

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertEncodedB.

This property is read-only and not available at design time.

Data Type

Binary String

Subject Property (AmazonSES Control)

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

Syntax

amazonsescontrol.Subject[=string]

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 Control)

The timeout for the control.

Syntax

amazonsescontrol.Timeout[=integer]

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

The control will use DoEvents 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 control 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

Integer

AddAttachment Method (AmazonSES Control)

This adds FileName as an attachment.

Syntax

amazonsescontrol.AddAttachment FileName

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 Control)

Sets or retrieves a configuration setting.

Syntax

amazonsescontrol.Config ConfigurationString

Remarks

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

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

DeleteIdentity Method (AmazonSES Control)

Deletes the identity.

Syntax

amazonsescontrol.DeleteIdentity Identity

Remarks

This method deletes the identity specified by Identity.

DoEvents Method (AmazonSES Control)

This method processes events from the internal message queue.

Syntax

amazonsescontrol.DoEvents 

Remarks

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

GetIdentityAttributes Method (AmazonSES Control)

Gets the attributes of the given identity.

Syntax

amazonsescontrol.GetIdentityAttributes Identity, AttributeType

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.

GetSendQuota Method (AmazonSES Control)

Gets send quota information.

Syntax

amazonsescontrol.GetSendQuota 

Remarks

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

• QuotaMaxPer24Hours
• QuotaMaxPerSecond
• QuotaSentLast24Hours

GetSendStatistics Method (AmazonSES Control)

Gets the user's sending statistics.

Syntax

amazonsescontrol.GetSendStatistics 

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.

• SendStatBounces
• SendStatComplaints
• SendStatDeliveryAttempts
• SendStatRejects
• SendStatTimestamp

GetXValue Method (AmazonSES Control)

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

Syntax

amazonsescontrol.GetXValue XPath

Remarks

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

Interrupt Method (AmazonSES Control)

This method interrupts the current method.

Syntax

amazonsescontrol.Interrupt 

Remarks

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

ListIdentities Method (AmazonSES Control)

Lists the identities of the given type.

Syntax

amazonsescontrol.ListIdentities IdentityType

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 IdentityMarker property will be populated. To obtain the next page of results simply call ListIdentities again. The IdentityMarker value determines the results offset. On the last page of results the IsPaged configuration setting will return "False" and IdentityMarker will be set to empty string. With this design to get all of the results you can repeatedly call ListIdentities until IsPaged returns "False" or IdentityMarker is set to empty string.

Reset Method (AmazonSES Control)

Resets request-related properties.

Syntax

amazonsescontrol.Reset 

Remarks

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

Send Method (AmazonSES Control)

Sends the message.

Syntax

amazonsescontrol.Send 

Remarks

This method sends the message specified by MessageHTML or MessageText.

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>";

SendCustomRequest Method (AmazonSES Control)

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

Syntax

amazonsescontrol.SendCustomRequest Url, RequestData, OtherHeaders

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", "");

SetIdentityFeedbackForwarding Method (AmazonSES Control)

Enables or Disables feedback forwarding for the identity.

Syntax

amazonsescontrol.SetIdentityFeedbackForwarding Identity, ForwardingEnabled

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 IdentityNotificationBounceTopic and IdentityNotificationComplaintTopic SNS topics.

SetIdentityNotificationTopic Method (AmazonSES Control)

Sets the Bounce or Complaint notification topic for an identity.

Syntax

amazonsescontrol.SetIdentityNotificationTopic Identity, NotificationType, SnsTopic

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.

VerifyDomain Method (AmazonSES Control)

Verifies a domain.

Syntax

amazonsescontrol.VerifyDomain Identity

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.

VerifyEmail Method (AmazonSES Control)

Verifies an email address.

Syntax

amazonsescontrol.VerifyEmail Identity

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.

Error Event (AmazonSES Control)

Fired when information is available about errors during data delivery.

Syntax

Sub amazonsescontrol_Error(ErrorCode As Integer, Description As String)

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the control 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.

IdentityList Event (AmazonSES Control)

Fired for every identity when ListIdentities is called.

Syntax

Sub amazonsescontrol_IdentityList(Identity As String)

Remarks

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

Identities will also be populated.

Log Event (AmazonSES Control)

Fired once for each log message.

Syntax

Sub amazonsescontrol_Log(LogLevel As Integer, Message As String, LogType As String)

Remarks

This event is fired once for each log message generated by the control. 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"

SSLServerAuthentication Event (AmazonSES Control)

Fired after the server presents its certificate to the client.

Syntax

Sub amazonsescontrol_SSLServerAuthentication(CertEncoded As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean)

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.

SSLStatus Event (AmazonSES Control)

Fired when secure connection progress messages are available.

Syntax

Sub amazonsescontrol_SSLStatus(Message As String)

Remarks

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

Config Settings (AmazonSES Control)

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 Control)

SES Errors

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

HTTP Errors

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

TCPClient Errors

SSL Errors

TCP/IP Errors