AmazonSES Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

CloudMail_AmazonSES

Procedural Interface

 cloudmail_amazonses_open();
 cloudmail_amazonses_close($res);
 cloudmail_amazonses_register_callback($res, $id, $function);
 cloudmail_amazonses_get_last_error($res);
 cloudmail_amazonses_get_last_error_code($res);
 cloudmail_amazonses_set($res, $id, $index, $value);
 cloudmail_amazonses_get($res, $id, $index);
 cloudmail_amazonses_do_addattachment($res, $filename);
 cloudmail_amazonses_do_config($res, $configurationstring);
 cloudmail_amazonses_do_deleteidentity($res, $identity);
 cloudmail_amazonses_do_doevents($res);
 cloudmail_amazonses_do_getidentityattributes($res, $identity, $attributetype);
 cloudmail_amazonses_do_getsendquota($res);
 cloudmail_amazonses_do_getsendstatistics($res);
 cloudmail_amazonses_do_getxvalue($res, $xpath);
 cloudmail_amazonses_do_interrupt($res);
 cloudmail_amazonses_do_listidentities($res, $identitytype);
 cloudmail_amazonses_do_reset($res);
 cloudmail_amazonses_do_send($res);
 cloudmail_amazonses_do_sendcustomrequest($res, $url, $requestdata, $otherheaders);
 cloudmail_amazonses_do_setidentityfeedbackforwarding($res, $identity, $forwardingenabled);
 cloudmail_amazonses_do_setidentitynotificationtopic($res, $identity, $notificationtype, $snstopic);
 cloudmail_amazonses_do_verifydomain($res, $identity);
 cloudmail_amazonses_do_verifyemail($res, $identity);

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

Method List

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

Event List

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

Config Settings

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

AccessKey Property (CloudMail_AmazonSES Class)

The Access Key Id for the Amazon Web Services account.

Object Oriented Interface

public function getAccessKey();
public function setAccessKey($value);

Procedural Interface

cloudmail_amazonses_get($res, 1 );
cloudmail_amazonses_set($res, 1, $value );

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 (CloudMail_AmazonSES Class)

The number of records in the Attachment arrays.

Object Oriented Interface

public function getAttachmentCount();
public function setAttachmentCount($value);

Procedural Interface

cloudmail_amazonses_get($res, 2 );
cloudmail_amazonses_set($res, 2, $value );

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 (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getAttachmentData($attachmentindex);
public function setAttachmentData($attachmentindex, $value);

Procedural Interface

cloudmail_amazonses_get($res, 3 , $attachmentindex);
cloudmail_amazonses_set($res, 3, $value , $attachmentindex);

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.

This property is not available at design time.

Data Type

Binary String

AttachmentFileName Property (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getAttachmentFileName($attachmentindex);
public function setAttachmentFileName($attachmentindex, $value);

Procedural Interface

cloudmail_amazonses_get($res, 4 , $attachmentindex);
cloudmail_amazonses_set($res, 4, $value , $attachmentindex);

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 (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getAttachmentName($attachmentindex);
public function setAttachmentName($attachmentindex, $value);

Procedural Interface

cloudmail_amazonses_get($res, 6 , $attachmentindex);
cloudmail_amazonses_set($res, 6, $value , $attachmentindex);

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 (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getBCc();
public function setBCc($value);

Procedural Interface

cloudmail_amazonses_get($res, 7 );
cloudmail_amazonses_set($res, 7, $value );

Default Value

''

Remarks

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

The class will return an error if the 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 (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getCc();
public function setCc($value);

Procedural Interface

cloudmail_amazonses_get($res, 8 );
cloudmail_amazonses_set($res, 8, $value );

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 class 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 (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getDeliveryNotificationTo();
public function setDeliveryNotificationTo($value);

Procedural Interface

cloudmail_amazonses_get($res, 9 );
cloudmail_amazonses_set($res, 9, $value );

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 (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getFirewallAutoDetect();
public function setFirewallAutoDetect($value);

Procedural Interface

cloudmail_amazonses_get($res, 10 );
cloudmail_amazonses_set($res, 10, $value );

Default Value

false

Remarks

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

Data Type

Boolean

FirewallType Property (CloudMail_AmazonSES Class)

The type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();
public function setFirewallType($value);

Procedural Interface

cloudmail_amazonses_get($res, 11 );
cloudmail_amazonses_set($res, 11, $value );

Default Value

0

Remarks

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

Data Type

Integer

FirewallHost Property (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getFirewallHost();
public function setFirewallHost($value);

Procedural Interface

cloudmail_amazonses_get($res, 12 );
cloudmail_amazonses_set($res, 12, $value );

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

Data Type

String

FirewallPassword Property (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getFirewallPassword();
public function setFirewallPassword($value);

Procedural Interface

cloudmail_amazonses_get($res, 13 );
cloudmail_amazonses_set($res, 13, $value );

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

Data Type

String

FirewallPort Property (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getFirewallPort();
public function setFirewallPort($value);

Procedural Interface

cloudmail_amazonses_get($res, 14 );
cloudmail_amazonses_set($res, 14, $value );

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 (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getFirewallUser();
public function setFirewallUser($value);

Procedural Interface

cloudmail_amazonses_get($res, 15 );
cloudmail_amazonses_set($res, 15, $value );

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

Data Type

String

From Property (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getFrom();
public function setFrom($value);

Procedural Interface

cloudmail_amazonses_get($res, 16 );
cloudmail_amazonses_set($res, 16, $value );

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 (CloudMail_AmazonSES Class)

The number of records in the Identity arrays.

Object Oriented Interface

public function getIdentityCount();

Procedural Interface

cloudmail_amazonses_get($res, 17 );

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 (CloudMail_AmazonSES Class)

Specifies the type of attribute.

Object Oriented Interface

public function getIdentityAttributesType($identityindex);

Procedural Interface

cloudmail_amazonses_get($res, 18 , $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 (CloudMail_AmazonSES Class)

The current identity name.

Object Oriented Interface

public function getIdentityName($identityindex);

Procedural Interface

cloudmail_amazonses_get($res, 19 , $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 (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getIdentityNotificationBounceTopic($identityindex);

Procedural Interface

cloudmail_amazonses_get($res, 20 , $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 (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getIdentityNotificationComplaintTopic($identityindex);

Procedural Interface

cloudmail_amazonses_get($res, 21 , $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 (CloudMail_AmazonSES Class)

Specifies whether or not Amazon will forward feedback as email.

Object Oriented Interface

public function getIdentityNotificationForwardingEnabled($identityindex);

Procedural Interface

cloudmail_amazonses_get($res, 22 , $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 (CloudMail_AmazonSES Class)

The current verification status of the identity.

Object Oriented Interface

public function getIdentityVerificationStatus($identityindex);

Procedural Interface

cloudmail_amazonses_get($res, 23 , $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 (CloudMail_AmazonSES Class)

The verification token for the domain.

Object Oriented Interface

public function getIdentityVerificationToken($identityindex);

Procedural Interface

cloudmail_amazonses_get($res, 24 , $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 (CloudMail_AmazonSES Class)

The offset marker used to navigate paged results.

Object Oriented Interface

public function getIdentityMarker();
public function setIdentityMarker($value);

Procedural Interface

cloudmail_amazonses_get($res, 25 );
cloudmail_amazonses_set($res, 25, $value );

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 (CloudMail_AmazonSES Class)

The current status of the class.

Object Oriented Interface

public function getIdle();

Procedural Interface

cloudmail_amazonses_get($res, 26 );

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 (CloudMail_AmazonSES Class)

The number of records in the Image arrays.

Object Oriented Interface

public function getImageCount();
public function setImageCount($value);

Procedural Interface

cloudmail_amazonses_get($res, 27 );
cloudmail_amazonses_set($res, 27, $value );

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 (CloudMail_AmazonSES Class)

This property optionally specifies the image data.

Object Oriented Interface

public function getImageData($imageindex);
public function setImageData($imageindex, $value);

Procedural Interface

cloudmail_amazonses_get($res, 28 , $imageindex);
cloudmail_amazonses_set($res, 28, $value , $imageindex);

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

Binary String

ImageFile Property (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getImageFile($imageindex);
public function setImageFile($imageindex, $value);

Procedural Interface

cloudmail_amazonses_get($res, 29 , $imageindex);
cloudmail_amazonses_set($res, 29, $value , $imageindex);

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 (CloudMail_AmazonSES Class)

This property contains the content identifier for embedded images.

Object Oriented Interface

public function getImageId($imageindex);
public function setImageId($imageindex, $value);

Procedural Interface

cloudmail_amazonses_get($res, 30 , $imageindex);
cloudmail_amazonses_set($res, 30, $value , $imageindex);

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 (CloudMail_AmazonSES Class)

This property contains the content type for embedded images.

Object Oriented Interface

public function getImageType($imageindex);
public function setImageType($imageindex, $value);

Procedural Interface

cloudmail_amazonses_get($res, 31 , $imageindex);
cloudmail_amazonses_set($res, 31, $value , $imageindex);

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 (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getImportance();
public function setImportance($value);

Procedural Interface

cloudmail_amazonses_get($res, 32 );
cloudmail_amazonses_set($res, 32, $value );

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 (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getLocalHost();
public function setLocalHost($value);

Procedural Interface

cloudmail_amazonses_get($res, 33 );
cloudmail_amazonses_set($res, 33, $value );

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 class initiate connections (or accept in the case of server classs) 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 class 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 (CloudMail_AmazonSES Class)

This property includes the HTML version of the message.

Object Oriented Interface

public function getMessageHTML();
public function setMessageHTML($value);

Procedural Interface

cloudmail_amazonses_get($res, 34 );
cloudmail_amazonses_set($res, 34, $value );

Default Value

''

Remarks

This property contains the HTML version of the message.

When this property is set, the class automatically computes a plaintext version of the text and puts it into 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 (CloudMail_AmazonSES Class)

The number of records in the MessageRecipient arrays.

Object Oriented Interface

public function getMessageRecipientCount();
public function setMessageRecipientCount($value);

Procedural Interface

cloudmail_amazonses_get($res, 35 );
cloudmail_amazonses_set($res, 35, $value );

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 (CloudMail_AmazonSES Class)

This property contains the email address of the recipient.

Object Oriented Interface

public function getMessageRecipientAddress($recipientindex);
public function setMessageRecipientAddress($recipientindex, $value);

Procedural Interface

cloudmail_amazonses_get($res, 36 , $recipientindex);
cloudmail_amazonses_set($res, 36, $value , $recipientindex);

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 (CloudMail_AmazonSES Class)

This property contains the name of the recipient.

Object Oriented Interface

public function getMessageRecipientName($recipientindex);
public function setMessageRecipientName($recipientindex, $value);

Procedural Interface

cloudmail_amazonses_get($res, 37 , $recipientindex);
cloudmail_amazonses_set($res, 37, $value , $recipientindex);

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 (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getMessageRecipientOptions($recipientindex);
public function setMessageRecipientOptions($recipientindex, $value);

Procedural Interface

cloudmail_amazonses_get($res, 38 , $recipientindex);
cloudmail_amazonses_set($res, 38, $value , $recipientindex);

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 (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getMessageRecipientType($recipientindex);
public function setMessageRecipientType($recipientindex, $value);

Procedural Interface

cloudmail_amazonses_get($res, 39 , $recipientindex);
cloudmail_amazonses_set($res, 39, $value , $recipientindex);

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 (CloudMail_AmazonSES Class)

This property includes the plaintext version of the message.

Object Oriented Interface

public function getMessageText();
public function setMessageText($value);

Procedural Interface

cloudmail_amazonses_get($res, 40 );
cloudmail_amazonses_set($res, 40, $value );

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 class automatically computes a plaintext version of the text and puts it into this property. You may choose to override this default text with your own version.

Data Type

String

OtherHeaders Property (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getOtherHeaders();
public function setOtherHeaders($value);

Procedural Interface

cloudmail_amazonses_get($res, 41 );
cloudmail_amazonses_set($res, 41, $value );

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 ("\r\n") .

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

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

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

Example. 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 (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getProxyAuthScheme();
public function setProxyAuthScheme($value);

Procedural Interface

cloudmail_amazonses_get($res, 42 );
cloudmail_amazonses_set($res, 42, $value );

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 class 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 class. Look at the configuration file for the class 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 (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getProxyAutoDetect();
public function setProxyAutoDetect($value);

Procedural Interface

cloudmail_amazonses_get($res, 43 );
cloudmail_amazonses_set($res, 43, $value );

Default Value

false

Remarks

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

Data Type

Boolean

ProxyPassword Property (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getProxyPassword();
public function setProxyPassword($value);

Procedural Interface

cloudmail_amazonses_get($res, 44 );
cloudmail_amazonses_set($res, 44, $value );

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 (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getProxyPort();
public function setProxyPort($value);

Procedural Interface

cloudmail_amazonses_get($res, 45 );
cloudmail_amazonses_set($res, 45, $value );

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 (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getProxyServer();
public function setProxyServer($value);

Procedural Interface

cloudmail_amazonses_get($res, 46 );
cloudmail_amazonses_set($res, 46, $value );

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 (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getProxySSL();
public function setProxySSL($value);

Procedural Interface

cloudmail_amazonses_get($res, 47 );
cloudmail_amazonses_set($res, 47, $value );

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 (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getProxyUser();
public function setProxyUser($value);

Procedural Interface

cloudmail_amazonses_get($res, 48 );
cloudmail_amazonses_set($res, 48, $value );

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 (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getQuotaMaxPer24Hours();

Procedural Interface

cloudmail_amazonses_get($res, 49 );

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 (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getQuotaMaxPerSecond();

Procedural Interface

cloudmail_amazonses_get($res, 50 );

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 (CloudMail_AmazonSES Class)

The number of emails sent during the previous 24 hours.

Object Oriented Interface

public function getQuotaSentLast24Hours();

Procedural Interface

cloudmail_amazonses_get($res, 51 );

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 (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getReadReceiptTo();
public function setReadReceiptTo($value);

Procedural Interface

cloudmail_amazonses_get($res, 52 );
cloudmail_amazonses_set($res, 52, $value );

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 (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getReplyTo();
public function setReplyTo($value);

Procedural Interface

cloudmail_amazonses_get($res, 53 );
cloudmail_amazonses_set($res, 53, $value );

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 (CloudMail_AmazonSES Class)

The Secret Access Key for the Amazon Web Services account.

Object Oriented Interface

public function getSecretKey();
public function setSecretKey($value);

Procedural Interface

cloudmail_amazonses_get($res, 54 );
cloudmail_amazonses_set($res, 54, $value );

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 (CloudMail_AmazonSES Class)

The number of records in the SendStat arrays.

Object Oriented Interface

public function getSendStatCount();

Procedural Interface

cloudmail_amazonses_get($res, 55 );

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 (CloudMail_AmazonSES Class)

The number of emails that bounced.

Object Oriented Interface

public function getSendStatBounces($sendstatindex);

Procedural Interface

cloudmail_amazonses_get($res, 56 , $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 (CloudMail_AmazonSES Class)

The number of emails that were rejected by the recipient.

Object Oriented Interface

public function getSendStatComplaints($sendstatindex);

Procedural Interface

cloudmail_amazonses_get($res, 57 , $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 (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getSendStatDeliveryAttempts($sendstatindex);

Procedural Interface

cloudmail_amazonses_get($res, 58 , $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 (CloudMail_AmazonSES Class)

The number of emails rejected by Amazon SES.

Object Oriented Interface

public function getSendStatRejects($sendstatindex);

Procedural Interface

cloudmail_amazonses_get($res, 59 , $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 (CloudMail_AmazonSES Class)

The time of the data point.

Object Oriented Interface

public function getSendStatTimestamp($sendstatindex);

Procedural Interface

cloudmail_amazonses_get($res, 60 , $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 (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getSendTo();
public function setSendTo($value);

Procedural Interface

cloudmail_amazonses_get($res, 61 );
cloudmail_amazonses_set($res, 61, $value );

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 class 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 (CloudMail_AmazonSES Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLAcceptServerCertEffectiveDate();

Procedural Interface

cloudmail_amazonses_get($res, 62 );

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 (CloudMail_AmazonSES Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLAcceptServerCertExpirationDate();

Procedural Interface

cloudmail_amazonses_get($res, 63 );

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 (CloudMail_AmazonSES Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLAcceptServerCertExtendedKeyUsage();

Procedural Interface

cloudmail_amazonses_get($res, 64 );

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 (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprint();

Procedural Interface

cloudmail_amazonses_get($res, 65 );

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 (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA1();

Procedural Interface

cloudmail_amazonses_get($res, 66 );

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 (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA256();

Procedural Interface

cloudmail_amazonses_get($res, 67 );

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 (CloudMail_AmazonSES Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertIssuer();

Procedural Interface

cloudmail_amazonses_get($res, 68 );

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 (CloudMail_AmazonSES Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKey();

Procedural Interface

cloudmail_amazonses_get($res, 69 );

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 (CloudMail_AmazonSES Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyAvailable();

Procedural Interface

cloudmail_amazonses_get($res, 70 );

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 (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyContainer();

Procedural Interface

cloudmail_amazonses_get($res, 71 );

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 (CloudMail_AmazonSES Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKey();

Procedural Interface

cloudmail_amazonses_get($res, 72 );

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 (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyAlgorithm();

Procedural Interface

cloudmail_amazonses_get($res, 73 );

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 (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyLength();

Procedural Interface

cloudmail_amazonses_get($res, 74 );

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 (CloudMail_AmazonSES Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLAcceptServerCertSerialNumber();

Procedural Interface

cloudmail_amazonses_get($res, 75 );

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 (CloudMail_AmazonSES Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertSignatureAlgorithm();

Procedural Interface

cloudmail_amazonses_get($res, 76 );

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 (CloudMail_AmazonSES Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStore();
public function setSSLAcceptServerCertStore($value);

Procedural Interface

cloudmail_amazonses_get($res, 77 );
cloudmail_amazonses_set($res, 77, $value );

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

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertStorePassword();
public function setSSLAcceptServerCertStorePassword($value);

Procedural Interface

cloudmail_amazonses_get($res, 78 );
cloudmail_amazonses_set($res, 78, $value );

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 (CloudMail_AmazonSES Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStoreType();
public function setSSLAcceptServerCertStoreType($value);

Procedural Interface

cloudmail_amazonses_get($res, 79 );
cloudmail_amazonses_set($res, 79, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertSubjectAltNames();

Procedural Interface

cloudmail_amazonses_get($res, 80 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (CloudMail_AmazonSES Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintMD5();

Procedural Interface

cloudmail_amazonses_get($res, 81 );

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 (CloudMail_AmazonSES Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA1();

Procedural Interface

cloudmail_amazonses_get($res, 82 );

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 (CloudMail_AmazonSES Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA256();

Procedural Interface

cloudmail_amazonses_get($res, 83 );

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 (CloudMail_AmazonSES Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLAcceptServerCertUsage();

Procedural Interface

cloudmail_amazonses_get($res, 84 );

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 (CloudMail_AmazonSES Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertUsageFlags();

Procedural Interface

cloudmail_amazonses_get($res, 85 );

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 (CloudMail_AmazonSES Class)

The certificate's version number.

Object Oriented Interface

public function getSSLAcceptServerCertVersion();

Procedural Interface

cloudmail_amazonses_get($res, 86 );

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 (CloudMail_AmazonSES Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLAcceptServerCertSubject();
public function setSSLAcceptServerCertSubject($value);

Procedural Interface

cloudmail_amazonses_get($res, 87 );
cloudmail_amazonses_set($res, 87, $value );

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 (CloudMail_AmazonSES Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();
public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

cloudmail_amazonses_get($res, 88 );
cloudmail_amazonses_set($res, 88, $value );

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.

This property is not available at design time.

Data Type

Binary String

SSLCertEffectiveDate Property (CloudMail_AmazonSES Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

cloudmail_amazonses_get($res, 89 );

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 (CloudMail_AmazonSES Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

cloudmail_amazonses_get($res, 90 );

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 (CloudMail_AmazonSES Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

cloudmail_amazonses_get($res, 91 );

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 (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

cloudmail_amazonses_get($res, 92 );

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 (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

cloudmail_amazonses_get($res, 93 );

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 (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

cloudmail_amazonses_get($res, 94 );

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 (CloudMail_AmazonSES Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

cloudmail_amazonses_get($res, 95 );

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 (CloudMail_AmazonSES Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

cloudmail_amazonses_get($res, 96 );

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 (CloudMail_AmazonSES Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

cloudmail_amazonses_get($res, 97 );

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 (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

cloudmail_amazonses_get($res, 98 );

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 (CloudMail_AmazonSES Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

cloudmail_amazonses_get($res, 99 );

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 (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

cloudmail_amazonses_get($res, 100 );

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 (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

cloudmail_amazonses_get($res, 101 );

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 (CloudMail_AmazonSES Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

cloudmail_amazonses_get($res, 102 );

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 (CloudMail_AmazonSES Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

cloudmail_amazonses_get($res, 103 );

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 (CloudMail_AmazonSES Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();
public function setSSLCertStore($value);

Procedural Interface

cloudmail_amazonses_get($res, 104 );
cloudmail_amazonses_set($res, 104, $value );

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

Data Type

Binary String

SSLCertStorePassword Property (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getSSLCertStorePassword();
public function setSSLCertStorePassword($value);

Procedural Interface

cloudmail_amazonses_get($res, 105 );
cloudmail_amazonses_set($res, 105, $value );

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 (CloudMail_AmazonSES Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();
public function setSSLCertStoreType($value);

Procedural Interface

cloudmail_amazonses_get($res, 106 );
cloudmail_amazonses_set($res, 106, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubjectAltNames Property (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

cloudmail_amazonses_get($res, 107 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (CloudMail_AmazonSES Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

cloudmail_amazonses_get($res, 108 );

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 (CloudMail_AmazonSES Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

cloudmail_amazonses_get($res, 109 );

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 (CloudMail_AmazonSES Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

cloudmail_amazonses_get($res, 110 );

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 (CloudMail_AmazonSES Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

cloudmail_amazonses_get($res, 111 );

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 (CloudMail_AmazonSES Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

cloudmail_amazonses_get($res, 112 );

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 (CloudMail_AmazonSES Class)

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

cloudmail_amazonses_get($res, 113 );

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 (CloudMail_AmazonSES Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();
public function setSSLCertSubject($value);

Procedural Interface

cloudmail_amazonses_get($res, 114 );
cloudmail_amazonses_set($res, 114, $value );

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 (CloudMail_AmazonSES Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();
public function setSSLCertEncoded($value);

Procedural Interface

cloudmail_amazonses_get($res, 115 );
cloudmail_amazonses_set($res, 115, $value );

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.

This property is not available at design time.

Data Type

Binary String

SSLProvider Property (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getSSLProvider();
public function setSSLProvider($value);

Procedural Interface

cloudmail_amazonses_get($res, 116 );
cloudmail_amazonses_set($res, 116, $value );

Default Value

0

Remarks

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

Possible values are as follows:

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

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

Data Type

Integer

SSLServerCertEffectiveDate Property (CloudMail_AmazonSES Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLServerCertEffectiveDate();

Procedural Interface

cloudmail_amazonses_get($res, 117 );

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 (CloudMail_AmazonSES Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLServerCertExpirationDate();

Procedural Interface

cloudmail_amazonses_get($res, 118 );

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 (CloudMail_AmazonSES Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLServerCertExtendedKeyUsage();

Procedural Interface

cloudmail_amazonses_get($res, 119 );

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 (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getSSLServerCertFingerprint();

Procedural Interface

cloudmail_amazonses_get($res, 120 );

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 (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getSSLServerCertFingerprintSHA1();

Procedural Interface

cloudmail_amazonses_get($res, 121 );

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 (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getSSLServerCertFingerprintSHA256();

Procedural Interface

cloudmail_amazonses_get($res, 122 );

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 (CloudMail_AmazonSES Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLServerCertIssuer();

Procedural Interface

cloudmail_amazonses_get($res, 123 );

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 (CloudMail_AmazonSES Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKey();

Procedural Interface

cloudmail_amazonses_get($res, 124 );

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 (CloudMail_AmazonSES Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLServerCertPrivateKeyAvailable();

Procedural Interface

cloudmail_amazonses_get($res, 125 );

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 (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getSSLServerCertPrivateKeyContainer();

Procedural Interface

cloudmail_amazonses_get($res, 126 );

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 (CloudMail_AmazonSES Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLServerCertPublicKey();

Procedural Interface

cloudmail_amazonses_get($res, 127 );

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 (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getSSLServerCertPublicKeyAlgorithm();

Procedural Interface

cloudmail_amazonses_get($res, 128 );

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 (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getSSLServerCertPublicKeyLength();

Procedural Interface

cloudmail_amazonses_get($res, 129 );

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 (CloudMail_AmazonSES Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLServerCertSerialNumber();

Procedural Interface

cloudmail_amazonses_get($res, 130 );

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 (CloudMail_AmazonSES Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLServerCertSignatureAlgorithm();

Procedural Interface

cloudmail_amazonses_get($res, 131 );

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 (CloudMail_AmazonSES Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLServerCertStore();

Procedural Interface

cloudmail_amazonses_get($res, 132 );

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

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword Property (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getSSLServerCertStorePassword();

Procedural Interface

cloudmail_amazonses_get($res, 133 );

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 (CloudMail_AmazonSES Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLServerCertStoreType();

Procedural Interface

cloudmail_amazonses_get($res, 134 );

Default Value

0

Remarks

The type of certificate store for this certificate.

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

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getSSLServerCertSubjectAltNames();

Procedural Interface

cloudmail_amazonses_get($res, 135 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (CloudMail_AmazonSES Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintMD5();

Procedural Interface

cloudmail_amazonses_get($res, 136 );

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 (CloudMail_AmazonSES Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA1();

Procedural Interface

cloudmail_amazonses_get($res, 137 );

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 (CloudMail_AmazonSES Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA256();

Procedural Interface

cloudmail_amazonses_get($res, 138 );

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 (CloudMail_AmazonSES Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLServerCertUsage();

Procedural Interface

cloudmail_amazonses_get($res, 139 );

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 (CloudMail_AmazonSES Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLServerCertUsageFlags();

Procedural Interface

cloudmail_amazonses_get($res, 140 );

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 (CloudMail_AmazonSES Class)

The certificate's version number.

Object Oriented Interface

public function getSSLServerCertVersion();

Procedural Interface

cloudmail_amazonses_get($res, 141 );

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 (CloudMail_AmazonSES Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLServerCertSubject();

Procedural Interface

cloudmail_amazonses_get($res, 142 );

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 (CloudMail_AmazonSES Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

cloudmail_amazonses_get($res, 143 );

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.

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

Data Type

Binary String

Subject Property (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function getSubject();
public function setSubject($value);

Procedural Interface

cloudmail_amazonses_get($res, 144 );
cloudmail_amazonses_set($res, 144, $value );

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 (CloudMail_AmazonSES Class)

The timeout for the class.

Object Oriented Interface

public function getTimeout();
public function setTimeout($value);

Procedural Interface

cloudmail_amazonses_get($res, 145 );
cloudmail_amazonses_set($res, 145, $value );

Default Value

60

Remarks

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

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

The class will use 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 class 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 (CloudMail_AmazonSES Class)

This adds FileName as an attachment.

Object Oriented Interface

public function doAddAttachment($filename);

Procedural Interface

cloudmail_amazonses_do_addattachment($res, $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 (CloudMail_AmazonSES Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

cloudmail_amazonses_do_config($res, $configurationstring);

Remarks

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

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

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

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

DeleteIdentity Method (CloudMail_AmazonSES Class)

Deletes the identity.

Object Oriented Interface

public function doDeleteIdentity($identity);

Procedural Interface

cloudmail_amazonses_do_deleteidentity($res, $identity);

Remarks

This method deletes the identity specified by Identity.

DoEvents Method (CloudMail_AmazonSES Class)

This method processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

cloudmail_amazonses_do_doevents($res);

Remarks

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

GetIdentityAttributes Method (CloudMail_AmazonSES Class)

Gets the attributes of the given identity.

Object Oriented Interface

public function doGetIdentityAttributes($identity, $attributetype);

Procedural Interface

cloudmail_amazonses_do_getidentityattributes($res, $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 (CloudMail_AmazonSES Class)

Gets send quota information.

Object Oriented Interface

public function doGetSendQuota();

Procedural Interface

cloudmail_amazonses_do_getsendquota($res);

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 (CloudMail_AmazonSES Class)

Gets the user's sending statistics.

Object Oriented Interface

public function doGetSendStatistics();

Procedural Interface

cloudmail_amazonses_do_getsendstatistics($res);

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 (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function doGetXValue($xpath);

Procedural Interface

cloudmail_amazonses_do_getxvalue($res, $xpath);

Remarks

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

Interrupt Method (CloudMail_AmazonSES Class)

This method interrupts the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

cloudmail_amazonses_do_interrupt($res);

Remarks

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

ListIdentities Method (CloudMail_AmazonSES Class)

Lists the identities of the given type.

Object Oriented Interface

public function doListIdentities($identitytype);

Procedural Interface

cloudmail_amazonses_do_listidentities($res, $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 (CloudMail_AmazonSES Class)

Resets request-related properties.

Object Oriented Interface

public function doReset();

Procedural Interface

cloudmail_amazonses_do_reset($res);

Remarks

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

Send Method (CloudMail_AmazonSES Class)

Sends the message.

Object Oriented Interface

public function doSend();

Procedural Interface

cloudmail_amazonses_do_send($res);

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 (CloudMail_AmazonSES Class)

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

Object Oriented Interface

public function doSendCustomRequest($url, $requestdata, $otherheaders);

Procedural Interface

cloudmail_amazonses_do_sendcustomrequest($res, $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 (CloudMail_AmazonSES Class)

Enables or Disables feedback forwarding for the identity.

Object Oriented Interface

public function doSetIdentityFeedbackForwarding($identity, $forwardingenabled);

Procedural Interface

cloudmail_amazonses_do_setidentityfeedbackforwarding($res, $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 (CloudMail_AmazonSES Class)

Sets the Bounce or Complaint notification topic for an identity.

Object Oriented Interface

public function doSetIdentityNotificationTopic($identity, $notificationtype, $snstopic);

Procedural Interface

cloudmail_amazonses_do_setidentitynotificationtopic($res, $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 (CloudMail_AmazonSES Class)

Verifies a domain.

Object Oriented Interface

public function doVerifyDomain($identity);

Procedural Interface

cloudmail_amazonses_do_verifydomain($res, $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 (CloudMail_AmazonSES Class)

Verifies an email address.

Object Oriented Interface

public function doVerifyEmail($identity);

Procedural Interface

cloudmail_amazonses_do_verifyemail($res, $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 (CloudMail_AmazonSES Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

cloudmail_amazonses_register_callback($res, 1, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

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

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

IdentityList Event (CloudMail_AmazonSES Class)

Fired for every identity when ListIdentities is called.

Object Oriented Interface

public function fireIdentityList($param);

Procedural Interface

cloudmail_amazonses_register_callback($res, 2, array($this, 'fireIdentityList'));

Parameter List

 'identity'

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 (CloudMail_AmazonSES Class)

Fired once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

cloudmail_amazonses_register_callback($res, 3, array($this, 'fireLog'));

Parameter List

 'loglevel'
 'message'
 'logtype'

Remarks

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

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

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

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

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

Message is the log entry.

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

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

SSLServerAuthentication Event (CloudMail_AmazonSES Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

cloudmail_amazonses_register_callback($res, 4, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

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 (CloudMail_AmazonSES Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

cloudmail_amazonses_register_callback($res, 5, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

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

Config Settings (AmazonSES Class)

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

SES Errors

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

HTTP Errors

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

TCPClient Errors

SSL Errors