AmazonSES Class

Properties   Methods   Events   Configuration 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). 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.

AccessKeyThe Access Key Id for the Amazon Web Services account.
AttachmentCountThe number of records in the Attachment arrays.
AttachmentFileThis property contains the path of a file on your system that you would like to send as an attachment with your message.
AttachmentNameThis property contains the name of the attachment to be sent.
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.
FirewallAutoDetectThis property tells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallTypeThis property determines the type of firewall to connect through.
FirewallHostThis property contains the name or IP address of firewall (optional).
FirewallPasswordThis property contains a password if authentication is to be used when connecting through the firewall.
FirewallPortThis property contains the TCP port for the firewall Host .
FirewallUserThis property contains a user name if authentication is to be used connecting through a firewall.
FromThe email address of the sender (required).
IdentityCountThe number of records in the Identity arrays.
IdentityAttributesTypeSpecifies the type of attribute.
IdentityNameThe current identity name.
IdentityNotificationBounceTopicThe Amazon Simple Notification Service (SNS) topic to which Amazon will publish bounce notifications.
IdentityNotificationComplaintTopicThe Amazon Simple Notification Service (SNS) topic to which Amazon will publish complaint notifications.
IdentityNotificationForwardingEnabledSpecifies whether or not Amazon will forward feedback as email.
IdentityVerificationStatusThe current verification status of the identity.
IdentityVerificationTokenThe verification token for the domain.
IdentityMarkerThe offset marker used to navigate paged results.
IdleThe current status of the class.
ImageCountThe number of records in the Image arrays.
ImageDataThis property optionally specifies the image data.
ImageFileThis property contains the name of the image files embedded into the HTML message.
ImageIdThis property contains the content identifier for embedded images.
ImageTypeThis property contains the content type for embedded images.
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.
MessageRecipientCountThe number of records in the MessageRecipient arrays.
MessageRecipientAddressThis property contains the email address of the recipient.
MessageRecipientNameThis property contains name of the recipient.
MessageRecipientOptionsThis property contains the recipient sending options (used only by SMTP).
MessageRecipientTypeThis property contains the recipient type: To, Cc, or BCc.
MessageTextThe plain text version of the message.
OtherHeadersAn RFC 822 compliant string consisting of extra headers.
ProxyAuthSchemeThis property is used to tell the class which type of authorization to perform when connecting to the proxy.
ProxyAutoDetectThis property tells the class whether or not to automatically detect and use proxy system settings, if available.
ProxyPasswordThis property contains a password if authentication is to be used for the proxy.
ProxyPortThis property contains the TCP port for the proxy Server (default 80).
ProxyServerIf a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSLThis property determines when to use SSL for the connection to the proxy.
ProxyUserThis property contains a user name, if authentication is to be used for the proxy.
QuotaMaxPer24HoursThe maximum number of emails that can be sent in a 24 hour period.
QuotaMaxPerSecondThe maximum number of emails that can be sent per second.
QuotaSentLast24HoursThe number of emails sent during the previous 24 hours.
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.
SendStatCountThe number of records in the SendStat arrays.
SendStatBouncesThe number of emails that bounced.
SendStatComplaintsThe number of emails that were rejected by the recipient.
SendStatDeliveryAttemptsThe number of emails that have been sent or are queued to be sent.
SendStatRejectsThe number of emails rejected by Amazon SES.
SendStatTimestampThe time of the data point.
SendToA comma separated list of addresses for destinations (required).
SSLAcceptServerCertEncodedThe certificate (PEM/base64 encoded).
SSLCertEncodedThe certificate (PEM/base64 encoded).
SSLCertStoreThe name of the certificate store for the client certificate.
SSLCertStorePasswordIf the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
SSLCertStoreTypeThe type of certificate store for this certificate.
SSLCertSubjectThe subject of the certificate used for client authentication.
SSLServerCertEncodedThe certificate (PEM/base64 encoded).
SubjectThe subject of the mail message (optional).
TimeoutA timeout for the class.

Method List


The following is the full list of the methods of the class 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.
VerifyDomainVerifies a domain.
VerifyEmailVerifies an email address.

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.

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 class 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 class 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.
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 class.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the class 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 class.
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.
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 class.
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.
UsePlatformHTTPClientWhether or not to use the platform HTTP client.
UserAgentInformation about the user agent (browser).
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
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 class 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.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertFilePathsThe paths to CA certificate files on Unix/Linux.
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.
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.
SSLSecurityFlagsFlags that control certificate verification.
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 PHP Edition - Version 20.0 [Build 7718]