SES Component
Properties Methods Events Configuration Settings Errors
The SES component provides a simple interface to Amazon's Simple Email Service (SES).
Syntax
nsoftware.InAmazon.Ses
Remarks
The SES component allows you to quickly and easily access Amazon's Simple Email Service (SES). SES allows you to send both plaintext and HTML e-mails to recipients through your AWS account.
After signing up for SES you will use the Amazon provided AccessKey and SecretKey to authenticate to Amazon. To send an e-mail set MessageHTML or MessageText along with From, Subject, SendTo and call Send.
Various other administrative methods are also available, such as ListIdentities, VerifyDomain, VerifyEmail, and more.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
| AccessKey | The Access Key Id for the Amazon Web Services account. |
| Attachments | The paths of files to attach to the message. |
| BCc | A comma separated list of addresses for blind carbon copies (optional). |
| Cc | A comma separated list of addresses for carbon copies (optional). |
| DeliveryNotificationTo | Email address to send to which to send a delivery notification. |
| Firewall | A set of properties related to firewall access. |
| From | The email address of the sender (required). |
| Identities | A collection of identity attributes. |
| IdentityMarker | The offset marker used to navigate paged results. |
| Idle | The current status of the component. |
| Images | The embedded images in the HTML message. |
| Importance | Importance of the mail message (optional). |
| LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| MessageHTML | The HTML version of the message. |
| MessageRecipients | The collection of recipients of the message. |
| MessageText | The plain text version of the message. |
| OtherHeaders | An RFC 822 compliant string consisting of extra headers. |
| Proxy | A set of properties related to proxy access. |
| QuotaInfo | Holds information about current the current send quotas. |
| ReadReceiptTo | Email address to send a read receipt to. |
| ReplyTo | A mail address to which to reply (optional). |
| SecretKey | The Secret Access Key for the Amazon Web Services account. |
| SendStatDetails | A collection of sending statistic data points. |
| SendTo | A comma separated list of addresses for destinations (required). |
| SSLAcceptServerCert | Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. |
| SSLCert | The certificate to be used during SSL negotiation. |
| SSLServerCert | The server certificate for the last established connection. |
| Subject | The subject of the mail message (optional). |
| Timeout | A timeout for the component. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
| AddAttachment | Adds FileName as an attachment. |
| Config | Sets or retrieves a configuration setting . |
| DeleteIdentity | Deletes the identity. |
| DoEvents | Processes events from the internal message queue. |
| GetIdentityAttributes | Gets the attributes of the given identity. |
| GetSendQuota | Gets send quota information. |
| GetSendStatistics | Gets the user's sending statistics. |
| GetXValue | Retrieves a valid XPath expression from the HTTP response after calling SendCustomRequest . |
| Interrupt | Interrupt the current method. |
| ListIdentities | Lists the identities of the given type. |
| Reset | Resets request-related properties. |
| Send | Sends the message. |
| SendCustomRequest | Allows the sending of a custom request to an Amazon web service. |
| SetIdentityFeedbackForwarding | Enables or Disables feedback forwarding for the identity. |
| SetIdentityNotificationTopic | Sets the Bounce or Complaint notification topic for an identity. |
| SetMessageHTMLStream | Sets the stream from which the component will read the HTML version of the message. |
| VerifyDomain | Verifies a domain. |
| VerifyEmail | Verifies an email address. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
| Error | Information about errors during data delivery. |
| IdentityList | Fired for every identity when ListIdentities is called. |
| SSLServerAuthentication | Fired after the server presents its certificate to the client. |
| SSLStatus | Shows the progress of the secure connection. |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
| APIVersion | Amazon's API version. |
| HTTPMethod | Specifies the HTTP method to use when sending a custom request. |
| SignCustomRequest | Tells the component to sign the outgoing request. |
| TransferredData | Returns the entire XML response received from Amazon. |
| URL | If set, the default URL will be overridden by this value. |
| MessageDate | The date of the mail message. |
| MessageId | The message id of the mail message. |
| ParseHTML | Whether or not to create a plaintext part from the HTML message. |
| Priority | The priority of the mail message. |
| MaxListIdentityResults | That maximum number of identities to return when ListIdentities is called. |
| IsPaged | Specifies whether or not the results are paged. |
| AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
| AllowHTTPCompression | This property enables HTTP compression for receiving data. |
| AllowIdenticalRedirectURL | Allow redirects to the same URL. |
| Append | Whether to append data to LocalFile. |
| Authorization | The Authorization string to be sent to the server. |
| BytesTransferred | Contains the number of bytes transferred in the response data. |
| EncodeURL | If set to true the URL will be encoded by the component. |
| FollowRedirects | Determines what happens when the server issues a redirect. |
| GetOn302Redirect | If set to true the component will perform a GET on the new location. |
| HTTPVersion | The version of HTTP used by the component. |
| IfModifiedSince | A date determining the maximum age of the desired document. |
| KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
| MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
| OtherHeaders | Other headers as determined by the user (optional). |
| ProxyAuthorization | The authorization string to be sent to the proxy server. |
| ProxyAuthScheme | The authorization scheme to be used for the proxy. |
| ProxyPassword | A password if authentication is to be used for the proxy. |
| ProxyPort | Port for the proxy server (default 80). |
| ProxyServer | Name or IP address of a proxy server (optional). |
| ProxyUser | A user name if authentication is to be used for the proxy. |
| TransferredDataLimit | The maximum number of incoming bytes to be stored by the component. |
| TransferredHeaders | The full set of headers as received from the server. |
| UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
| ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
| UserAgent | Information about the user agent (browser). |
| KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
| ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
| FirewallAutoDetect | Tells the component whether or not to automatically detect and use firewall system settings, if available. |
| FirewallHost | Name or IP address of firewall (optional). |
| FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
| FirewallPort | The TCP port for the FirewallHost;. |
| FirewallType | Determines the type of firewall to connect through. |
| FirewallUser | A user name if authentication is to be used connecting through a firewall. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| Linger | When set to True, connections are terminated gracefully. |
| LingerTime | Time in seconds to have the connection linger. |
| LocalHost | The name of the local host through which connections are initiated or accepted. |
| LocalPort | The TCP port in the local host where the component binds. |
| MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
| MaxTransferRate | The transfer rate limit in bytes per second. |
| RecordLength | The length of received data records. |
| TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
| UseIPv6 | Whether to use IPv6. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| ReuseSSLSession | Determines if the SSL session is reused. |
| SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
| SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
| SSLProvider | The name of the security provider to use. |
| SSLSecurityFlags | Flags that control certificate verification. |
| OpenSSLCADir | The path to a directory containing CA certificates. |
| OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
| OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
| OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| FirewallData | Used to send extra data to the firewall. |
| InBufferSize | The size in bytes of the incoming queue of the socket. |
| OutBufferSize | The size in bytes of the outgoing queue of the socket. |
| CodePage | The system code page used for Unicode to Multibyte translations. |