Cloud Mail 2020 Android Edition

Questions / Feedback?

AmazonSES Component

Properties   Methods   Events   Configuration Settings   Errors  

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

Syntax

CloudMail.Amazonses

Remarks

The AmazonSES component allows you to quickly and easily access Amazon's Simple Email Service (SES). AmazonSES allows you to send both plaintext and HTML e-mails to recipients through your AWS account.

After signing up for AmazonSES you will use the Amazon provided AccessKey and SecretKey to authenticate to Amazon. To send an e-mail set MessageHTML or MessageText along with From, Subject, SendTo and call Send.

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

Property List


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

AccessKeyThe Access Key Id for the Amazon Web Services account.
AttachmentsThe paths of files to attach to the message.
BCcA comma separated list of addresses for blind carbon copies (optional).
CcA comma separated list of addresses for carbon copies (optional).
DeliveryNotificationToEmail address to send to which to send a delivery notification.
FirewallA set of properties related to firewall access.
FromThe email address of the sender (required).
IdentitiesA collection of identity attributes.
IdentityMarkerThe offset marker used to navigate paged results.
IdleThe current status of the component.
ImagesThe embedded images in the HTML message.
ImportanceImportance of the mail message (optional).
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
MessageHTMLThe HTML version of the message.
MessageRecipientsThe collection of recipients of the message.
MessageTextThe plain text version of the message.
OtherHeadersAn RFC 822 compliant string consisting of extra headers.
ProxyA set of properties related to proxy access.
QuotaInfoHolds information about current the current send quotas.
ReadReceiptToEmail address to send a read receipt to.
ReplyToA mail address to which to reply (optional).
SecretKeyThe Secret Access Key for the Amazon Web Services account.
SendStatDetailsA collection of sending statistic data points.
SendToA comma separated list of addresses for destinations (required).
SSLAcceptServerCertInstructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to be used during SSL negotiation.
SSLServerCertThe server certificate for the last established connection.
SubjectThe subject of the mail message (optional).
TimeoutA 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.

addAttachmentAdds FileName as an attachment.
configSets or retrieves a configuration setting.
deleteIdentityDeletes the identity.
doEventsProcesses events from the internal message queue.
getIdentityAttributesGets the attributes of the given identity.
getSendQuotaGets send quota information.
getSendStatisticsGets the user's sending statistics.
getXValueRetrieves a valid XPath expression from the HTTP response after calling SendCustomRequest .
interruptInterrupt the current method.
listIdentitiesLists the identities of the given type.
resetResets request-related properties.
sendSends the message.
sendCustomRequestAllows the sending of a custom request to an Amazon web service.
setIdentityFeedbackForwardingEnables or Disables feedback forwarding for the identity.
setIdentityNotificationTopicSets the Bounce or Complaint notification topic for an identity.
setMessageHTMLStreamSets the stream from which the component will read the HTML version of the message.
verifyDomainVerifies a domain.
verifyEmailVerifies 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.

ErrorInformation about errors during data delivery.
IdentityListFired for every identity when ListIdentities is called.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows 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.

APIVersionService's API version.
HTTPMethodSpecifies the HTTP method to use when sending a custom request.
IsPagedSpecifies whether or not the results are paged.
MaxListIdentityResultsThat maximum number of identities to return when ListIdentities is called.
MessageDateThe date of the mail message.
MessageIdThe message id of the mail message.
ParseHTMLWhether or not to create a plaintext part from the HTML message.
PriorityThe priority of the mail message.
SignCustomRequestTells the component to sign the outgoing request.
TransferredDataReturns the entire XML response received from the server.
URLIf set, the default URL will be overridden by this value.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowHTTPFallbackWhether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AllowNTLMFallbackWhether to allow fallback from Negotiate to NTLM when authenticating.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequestSet to true to compress the body of a PUT or POST request.
EncodeURLIf set to true the URL will be encoded by the component.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the component will perform a GET on the new location.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersionThe version of HTTP used by the component.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
LogLevelThe level of detail that is logged.
MaxHeadersInstructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.
MaxHTTPCookiesInstructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
NegotiatedHTTPVersionThe negotiated HTTP version.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
SentHeadersThe full set of headers as sent by the client.
StatusLineThe first line of the last response from the server.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the component.
TransferredHeadersThe full set of headers as received from the server.
TransferredRequestThe full request as sent by the client.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
UseIDNsWhether to encode hostnames to internationalized domain names.
UsePlatformDeflateWhether to use the platform implementation to decompress compressed responses.
UsePlatformHTTPClientWhether or not to use the platform HTTP client.
UserAgentInformation about the user agent (browser).
CloseStreamAfterTransferIf true, the component will close the upload or download stream after the transfer.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallListenerIf true, the component binds to a SOCKS firewall as a server (IPPort only).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
UseNTLMv2Whether to use NTLM V2.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLContextProtocolThe protocol used when getting an SSLContext instance.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLProviderThe name of the security provider to use.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
SSLTrustManagerFactoryAlgorithmThe algorithm to be used to create a TrustManager through TrustManagerFactory.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
Cloud Mail 2020 Android Edition - Version 20.0 [Build 7718]