AmazonSES Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

TcmAmazonSES

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 component with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

AccessKey Property (AmazonSES Component)

The Access Key Id for the Amazon Web Services account.

Syntax

__property String AccessKey = { read=FAccessKey, write=FSetAccessKey };

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

The number of records in the Attachment arrays.

Syntax

__property int AttachmentCount = { read=FAttachmentCount, write=FSetAttachmentCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• AttachmentData
• AttachmentFile
• 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 Component)

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

Syntax

__property String AttachmentData[int AttachmentIndex] = { read=FAttachmentData, write=FSetAttachmentData };
__property DynamicArray<Byte> AttachmentDataB[int AttachmentIndex] = { read=FAttachmentDataB, write=FSetAttachmentDataB };

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

Byte Array

AttachmentFile Property (AmazonSES Component)

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

Syntax

__property String AttachmentFile[int AttachmentIndex] = { read=FAttachmentFile, write=FSetAttachmentFile };

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

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

Syntax

__property String AttachmentName[int AttachmentIndex] = { read=FAttachmentName, write=FSetAttachmentName };

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

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

Syntax

__property String BCc = { read=FBCc, write=FSetBCc };

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 component 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 Component)

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

Syntax

__property String Cc = { read=FCc, write=FSetCc };

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 component 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 Component)

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

Syntax

__property String DeliveryNotificationTo = { read=FDeliveryNotificationTo, write=FSetDeliveryNotificationTo };

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

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

Syntax

__property bool FirewallAutoDetect = { read=FFirewallAutoDetect, write=FSetFirewallAutoDetect };

Default Value

False

Remarks

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

Data Type

Boolean

FirewallType Property (AmazonSES Component)

This property determines the type of firewall to connect through.

Syntax

__property TcmAmazonSESFirewallTypes FirewallType = { read=FFirewallType, write=FSetFirewallType };

enum TcmAmazonSESFirewallTypes {
  fwNone=0,
  fwTunnel=1,
  fwSOCKS4=2,
  fwSOCKS5=3,
  fwSOCKS4A=10
};

Default Value

fwNone

Remarks

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

Data Type

Integer

FirewallHost Property (AmazonSES Component)

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

Syntax

__property String FirewallHost = { read=FFirewallHost, write=FSetFirewallHost };

Default Value

""

Remarks

This property contains the name or IP address of 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 component raises an exception.

Data Type

String

FirewallPassword Property (AmazonSES Component)

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

Syntax

__property String FirewallPassword = { read=FFirewallPassword, write=FSetFirewallPassword };

Default Value

""

Remarks

This property contains 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 component raises an exception.

Data Type

String

FirewallPort Property (AmazonSES Component)

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

Syntax

__property int FirewallPort = { read=FFirewallPort, write=FSetFirewallPort };

Default Value

0

Remarks

This property contains 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 Component)

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

Syntax

__property String FirewallUser = { read=FFirewallUser, write=FSetFirewallUser };

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the component raises an exception.

Data Type

String

From Property (AmazonSES Component)

The email address of the sender (required).

Syntax

__property String From = { read=FFrom, write=FSetFrom };

Default Value

""

Remarks

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

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

Data Type

String

IdentityCount Property (AmazonSES Component)

The number of records in the Identity arrays.

Syntax

__property int IdentityCount = { read=FIdentityCount };

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

Specifies the type of attribute.

Syntax

__property int IdentityAttributesType[int IdentityIndex] = { read=FIdentityAttributesType };

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

The current identity name.

Syntax

__property String IdentityName[int IdentityIndex] = { read=FIdentityName };

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

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

Syntax

__property String IdentityNotificationBounceTopic[int IdentityIndex] = { read=FIdentityNotificationBounceTopic };

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

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

Syntax

__property String IdentityNotificationComplaintTopic[int IdentityIndex] = { read=FIdentityNotificationComplaintTopic };

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

Specifies whether or not Amazon will forward feedback as email.

Syntax

__property bool IdentityNotificationForwardingEnabled[int IdentityIndex] = { read=FIdentityNotificationForwardingEnabled };

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

The current verification status of the identity.

Syntax

__property String IdentityVerificationStatus[int IdentityIndex] = { read=FIdentityVerificationStatus };

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

The verification token for the domain.

Syntax

__property String IdentityVerificationToken[int IdentityIndex] = { read=FIdentityVerificationToken };

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

The offset marker used to navigate paged results.

Syntax

__property String IdentityMarker = { read=FIdentityMarker, write=FSetIdentityMarker };

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

The current status of the component.

Syntax

__property bool Idle = { read=FIdle };

Default Value

True

Remarks

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

This property is read-only.

Data Type

Boolean

ImageCount Property (AmazonSES Component)

The number of records in the Image arrays.

Syntax

__property int ImageCount = { read=FImageCount, write=FSetImageCount };

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

This property optionally specifies the image data.

Syntax

__property String ImageData[int ImageIndex] = { read=FImageData, write=FSetImageData };
__property DynamicArray<Byte> ImageDataB[int ImageIndex] = { read=FImageDataB, write=FSetImageDataB };

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.

This property is not available at design time.

Data Type

Byte Array

ImageFile Property (AmazonSES Component)

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

Syntax

__property String ImageFile[int ImageIndex] = { read=FImageFile, write=FSetImageFile };

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

This property contains the content identifier for embedded images.

Syntax

__property String ImageId[int ImageIndex] = { read=FImageId, write=FSetImageId };

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

This property contains the content type for embedded images.

Syntax

__property String ImageType[int ImageIndex] = { read=FImageType, write=FSetImageType };

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

Importance of the mail message (optional).

Syntax

__property TcmAmazonSESImportances Importance = { read=FImportance, write=FSetImportance };

enum TcmAmazonSESImportances {
  miUnspecified=0,
  miHigh=1,
  miNormal=2,
  miLow=3
};

Default Value

miUnspecified

Remarks

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

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

Data Type

Integer

LocalHost Property (AmazonSES Component)

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

Syntax

__property String LocalHost = { read=FLocalHost, write=FSetLocalHost };

Default Value

""

Remarks

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

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the component initiate connections (or accept in the case of server components) only through that interface.

If the component 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 multi-homed 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 Component)

This property includes the HTML version of the message.

Syntax

__property String MessageHTML = { read=FMessageHTML, write=FSetMessageHTML };

Default Value

""

Remarks

This property contains the HTML version of the message.

When this property is set, the component 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 Component)

The number of records in the MessageRecipient arrays.

Syntax

__property int MessageRecipientCount = { read=FMessageRecipientCount, write=FSetMessageRecipientCount };

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

This property contains the email address of the recipient.

Syntax

__property String MessageRecipientAddress[int RecipientIndex] = { read=FMessageRecipientAddress, write=FSetMessageRecipientAddress };

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

This property contains the name of the recipient.

Syntax

__property String MessageRecipientName[int RecipientIndex] = { read=FMessageRecipientName, write=FSetMessageRecipientName };

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

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

Syntax

__property String MessageRecipientOptions[int RecipientIndex] = { read=FMessageRecipientOptions, write=FSetMessageRecipientOptions };

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

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

Syntax

__property TcmAmazonSESMessageRecipientTypes MessageRecipientType[int RecipientIndex] = { read=FMessageRecipientType, write=FSetMessageRecipientType };

enum TcmAmazonSESMessageRecipientTypes {
  rtTo=0,
  rtCc=1,
  rtBCc=2
};

Default Value

rtTo

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

This property includes the plaintext version of the message.

Syntax

__property String MessageText = { read=FMessageText, write=FSetMessageText };

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 component 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 Component)

An RFC 822 compliant string consisting of extra headers.

Syntax

__property String OtherHeaders = { read=FOtherHeaders, write=FSetOtherHeaders };

Default Value

""

Remarks

This property contains a string of headers to be appended to the message headers created from other properties like SendTo, Subject, etc.

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

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

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

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

Example (Send an Email With Additional Header)

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

This property is not available at design time.

Data Type

String

ProxyAuthScheme Property (AmazonSES Component)

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

Syntax

__property TcmAmazonSESProxyAuthSchemes ProxyAuthScheme = { read=FProxyAuthScheme, write=FSetProxyAuthScheme };

enum TcmAmazonSESProxyAuthSchemes {
  authBasic=0,
  authDigest=1,
  authProprietary=2,
  authNone=3,
  authNtlm=4,
  authNegotiate=5
};

Default Value

authBasic

Remarks

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

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

Syntax

__property bool ProxyAutoDetect = { read=FProxyAutoDetect, write=FSetProxyAutoDetect };

Default Value

False

Remarks

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

Data Type

Boolean

ProxyPassword Property (AmazonSES Component)

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

Syntax

__property String ProxyPassword = { read=FProxyPassword, write=FSetProxyPassword };

Default Value

""

Remarks

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

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword 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 Component)

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

Syntax

__property int ProxyPort = { read=FProxyPort, write=FSetProxyPort };

Default Value

80

Remarks

This property contains 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 Component)

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

Syntax

__property String ProxyServer = { read=FProxyServer, write=FSetProxyServer };

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

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

Syntax

__property TcmAmazonSESProxySSLs ProxySSL = { read=FProxySSL, write=FSetProxySSL };

enum TcmAmazonSESProxySSLs {
  psAutomatic=0,
  psAlways=1,
  psNever=2,
  psTunnel=3
};

Default Value

psAutomatic

Remarks

This property determines 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 Component)

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

Syntax

__property String ProxyUser = { read=FProxyUser, write=FSetProxyUser };

Default Value

""

Remarks

This property contains 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 Component)

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

Syntax

__property String QuotaMaxPer24Hours = { read=FQuotaMaxPer24Hours };

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

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

Syntax

__property String QuotaMaxPerSecond = { read=FQuotaMaxPerSecond };

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

The number of emails sent during the previous 24 hours.

Syntax

__property String QuotaSentLast24Hours = { read=FQuotaSentLast24Hours };

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

Email address to send a read receipt to.

Syntax

__property String ReadReceiptTo = { read=FReadReceiptTo, write=FSetReadReceiptTo };

Default Value

""

Remarks

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

Data Type

String

ReplyTo Property (AmazonSES Component)

A mail address to which to reply (optional).

Syntax

__property String ReplyTo = { read=FReplyTo, write=FSetReplyTo };

Default Value

""

Remarks

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

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

Data Type

String

SecretKey Property (AmazonSES Component)

The Secret Access Key for the Amazon Web Services account.

Syntax

__property String SecretKey = { read=FSecretKey, write=FSetSecretKey };

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

The number of records in the SendStat arrays.

Syntax

__property int SendStatCount = { read=FSendStatCount };

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

The number of emails that bounced.

Syntax

__property __int64 SendStatBounces[int SendStatIndex] = { read=FSendStatBounces };

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

The number of emails that were rejected by the recipient.

Syntax

__property __int64 SendStatComplaints[int SendStatIndex] = { read=FSendStatComplaints };

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

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

Syntax

__property __int64 SendStatDeliveryAttempts[int SendStatIndex] = { read=FSendStatDeliveryAttempts };

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

The number of emails rejected by Amazon SES.

Syntax

__property __int64 SendStatRejects[int SendStatIndex] = { read=FSendStatRejects };

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

The time of the data point.

Syntax

__property String SendStatTimestamp[int SendStatIndex] = { read=FSendStatTimestamp };

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

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

Syntax

__property String SendTo = { read=FSendTo, write=FSetSendTo };

Default Value

""

Remarks

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

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

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

SSLAcceptServerCertEncoded Property (AmazonSES Component)

This is the certificate (PEM/base64 encoded).

Syntax

__property String SSLAcceptServerCertEncoded = { read=FSSLAcceptServerCertEncoded, write=FSetSSLAcceptServerCertEncoded };
__property DynamicArray<Byte> SSLAcceptServerCertEncodedB = { read=FSSLAcceptServerCertEncodedB, write=FSetSSLAcceptServerCertEncodedB };

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

Byte Array

SSLCertEncoded Property (AmazonSES Component)

This is the certificate (PEM/base64 encoded).

Syntax

__property String SSLCertEncoded = { read=FSSLCertEncoded, write=FSetSSLCertEncoded };
__property DynamicArray<Byte> SSLCertEncodedB = { read=FSSLCertEncodedB, write=FSetSSLCertEncodedB };

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

Byte Array

SSLCertStore Property (AmazonSES Component)

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

Syntax

__property String SSLCertStore = { read=FSSLCertStore, write=FSetSSLCertStore };
__property DynamicArray<Byte> SSLCertStoreB = { read=FSSLCertStoreB, write=FSetSSLCertStoreB };

Default Value

"MY"

Remarks

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

Data Type

Byte Array

SSLCertStorePassword Property (AmazonSES Component)

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

Syntax

__property String SSLCertStorePassword = { read=FSSLCertStorePassword, write=FSetSSLCertStorePassword };

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

This is the type of certificate store for this certificate.

Syntax

__property TcmAmazonSESSSLCertStoreTypes SSLCertStoreType = { read=FSSLCertStoreType, write=FSetSSLCertStoreType };

enum TcmAmazonSESSSLCertStoreTypes {
  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

cstUser

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubject Property (AmazonSES Component)

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

Syntax

__property String SSLCertSubject = { read=FSSLCertSubject, write=FSetSSLCertSubject };

Default Value

""

Remarks

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

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

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

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

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

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

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

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

Data Type

String

SSLProvider Property (AmazonSES Component)

This specifies the SSL/TLS implementation to use.

Syntax

__property TcmAmazonSESSSLProviders SSLProvider = { read=FSSLProvider, write=FSetSSLProvider };

enum TcmAmazonSESSSLProviders {
  sslpAutomatic=0,
  sslpPlatform=1,
  sslpInternal=2
};

Default Value

sslpAutomatic

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 component will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

In most cases using the default value (Automatic) is recommended. The component 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

SSLServerCertEncoded Property (AmazonSES Component)

This is the certificate (PEM/base64 encoded).

Syntax

__property String SSLServerCertEncoded = { read=FSSLServerCertEncoded };
__property DynamicArray<Byte> SSLServerCertEncodedB = { read=FSSLServerCertEncodedB };

Default Value

""

Remarks

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

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

Data Type

Byte Array

Subject Property (AmazonSES Component)

The subject of the mail message (optional).

Syntax

__property String Subject = { read=FSubject, write=FSetSubject };

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

A timeout for the component.

Syntax

__property int Timeout = { read=FTimeout, write=FSetTimeout };

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

The component 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 component raises an exception.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

AddAttachment Method (AmazonSES Component)

This adds FileName as an attachment.

Syntax

void __fastcall AddAttachment(String 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 Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

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

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

Deletes the identity.

Syntax

void __fastcall DeleteIdentity(String Identity);

Remarks

This method deletes the identity specified by Identity.

DoEvents Method (AmazonSES Component)

Processes events from the internal message queue.

Syntax

void __fastcall DoEvents();

Remarks

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

GetIdentityAttributes Method (AmazonSES Component)

Gets the attributes of the given identity.

Syntax

void __fastcall GetIdentityAttributes(String Identity, int 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 Component)

Gets send quota information.

Syntax

void __fastcall 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 Component)

Gets the user's sending statistics.

Syntax

void __fastcall 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 Component)

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

Syntax

String __fastcall GetXValue(String XPath);

Remarks

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

Interrupt Method (AmazonSES Component)

Interrupt the current method.

Syntax

void __fastcall Interrupt();

Remarks

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

ListIdentities Method (AmazonSES Component)

Lists the identities of the given type.

Syntax

void __fastcall ListIdentities(int 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 Component)

Resets request-related properties.

Syntax

void __fastcall Reset();

Remarks

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

Send Method (AmazonSES Component)

Sends the message.

Syntax

void __fastcall 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 Component)

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

Syntax

String __fastcall SendCustomRequest(String Url, String RequestData, String 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 Component)

Enables or Disables feedback forwarding for the identity.

Syntax

void __fastcall SetIdentityFeedbackForwarding(String Identity, bool 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 Component)

Sets the Bounce or Complaint notification topic for an identity.

Syntax

void __fastcall SetIdentityNotificationTopic(String Identity, int NotificationType, String 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 Component)

Verifies a domain.

Syntax

String __fastcall VerifyDomain(String 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 Component)

Verifies an email address.

Syntax

void __fastcall VerifyEmail(String 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 Component)

Information about errors during data delivery.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TcmAmazonSESErrorEventParams;
typedef void __fastcall (__closure *TcmAmazonSESErrorEvent)(System::TObject* Sender, TcmAmazonSESErrorEventParams *e);
__property TcmAmazonSESErrorEvent OnError = { read=FOnError, write=FOnError };

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.

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

Fired for every identity when ListIdentities is called.

Syntax

typedef struct {
  String Identity;
} TcmAmazonSESIdentityListEventParams;
typedef void __fastcall (__closure *TcmAmazonSESIdentityListEvent)(System::TObject* Sender, TcmAmazonSESIdentityListEventParams *e);
__property TcmAmazonSESIdentityListEvent OnIdentityList = { read=FOnIdentityList, write=FOnIdentityList };

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

This event fires once for each log message.

Syntax

typedef struct {
  int LogLevel;
  String Message;
  String LogType;
} TcmAmazonSESLogEventParams;
typedef void __fastcall (__closure *TcmAmazonSESLogEvent)(System::TObject* Sender, TcmAmazonSESLogEventParams *e);
__property TcmAmazonSESLogEvent OnLog = { read=FOnLog, write=FOnLog };

Remarks

This event fires once for each log message generated by the component. 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 Component)

Fired after the server presents its certificate to the client.

Syntax

typedef struct {
  String CertEncoded;
  DynamicArray<Byte> CertEncodedB;
  String CertSubject;
  String CertIssuer;
  String Status;
  bool Accept;
} TcmAmazonSESSSLServerAuthenticationEventParams;
typedef void __fastcall (__closure *TcmAmazonSESSSLServerAuthenticationEvent)(System::TObject* Sender, TcmAmazonSESSSLServerAuthenticationEventParams *e);
__property TcmAmazonSESSSLServerAuthenticationEvent OnSSLServerAuthentication = { read=FOnSSLServerAuthentication, write=FOnSSLServerAuthentication };

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

Shows the progress of the secure connection.

Syntax

typedef struct {
  String Message;
} TcmAmazonSESSSLStatusEventParams;
typedef void __fastcall (__closure *TcmAmazonSESSSLStatusEvent)(System::TObject* Sender, TcmAmazonSESSSLStatusEventParams *e);
__property TcmAmazonSESSSLStatusEvent OnSSLStatus = { read=FOnSSLStatus, write=FOnSSLStatus };

Remarks

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

Config Settings (AmazonSES Component)

SES Config Settings

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

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

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

Socket Config Settings

Base Config Settings

Trappable Errors (AmazonSES Component)

SES Errors

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

HTTP Errors

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

TCPClient Errors

SSL Errors

TCP/IP Errors