AmazonSES Class
Properties Methods Events Config Settings Errors
The AmazonSES class provides a simple interface to Amazon's Simple Email Service (SES).
Syntax
AmazonSES
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.
AccessKey | The Access Key Id for the Amazon Web Services account. |
AttachmentCount | The number of records in the Attachment arrays. |
AttachmentData | The raw data for the attachment that will be sent with your message. |
AttachmentFile | This property contains the path of a file on your system to be sent as an attachment with your message. |
AttachmentInputStream | When this property is set to a valid stream, the class will attach the data from the stream as the current attachment. |
AttachmentName | This property contains the name of the attachment to be sent. |
BCc | This property includes a comma-separated list of addresses for blind carbon copies (optional). |
Cc | This property includes a comma-separated list of addresses for carbon copies (optional). |
DeliveryNotificationTo | This property includes the email address to which to send a delivery notification. |
FirewallAutoDetect | This property tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallType | This property determines the type of firewall to connect through. |
FirewallHost | This property contains the name or IP address of firewall (optional). |
FirewallPassword | This property contains a password if authentication is to be used when connecting through the firewall. |
FirewallPort | This property contains the transmission control protocol (TCP) port for the firewall Host . |
FirewallUser | This property contains a user name if authentication is to be used connecting through a firewall. |
From | The email address of the sender (required). |
IdentityCount | The number of records in the Identity arrays. |
IdentityAttributesType | Specifies the type of attribute. |
IdentityName | The current identity name. |
IdentityNotificationBounceTopic | The Amazon Simple Notification Service (SNS) topic to which Amazon will publish bounce notifications. |
IdentityNotificationComplaintTopic | The Amazon Simple Notification Service (SNS) topic to which Amazon will publish complaint notifications. |
IdentityNotificationForwardingEnabled | Specifies whether or not Amazon will forward feedback as email. |
IdentityVerificationStatus | The current verification status of the identity. |
IdentityVerificationToken | The verification token for the domain. |
IdentityMarker | The offset marker used to navigate paged results. |
Idle | The current status of the class. |
ImageCount | The number of records in the Image arrays. |
ImageData | This property optionally specifies the image data. |
ImageFile | This property contains the name of the image files embedded into the HTML message. |
ImageId | This property contains the content identifier for embedded images. |
ImageType | This property contains the content type for embedded images. |
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 | This property includes the HTML version of the message. |
MessageRecipientCount | The number of records in the MessageRecipient arrays. |
MessageRecipientAddress | This property contains the email address of the recipient. |
MessageRecipientName | This property contains the name of the recipient. |
MessageRecipientOptions | This property contains the recipient sending options (used only by SMTP). |
MessageRecipientType | This property contains the recipient type: To, Cc, or Bcc. |
MessageText | This property includes the plaintext version of the message. |
OtherHeaders | An RFC 822 compliant string consisting of extra headers. |
ProxyAuthScheme | This property is used to tell the class which type of authorization to perform when connecting to the proxy. |
ProxyAutoDetect | This property tells the class whether or not to automatically detect and use proxy system settings, if available. |
ProxyPassword | This property contains a password if authentication is to be used for the proxy. |
ProxyPort | This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80). |
ProxyServer | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
ProxySSL | This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. |
ProxyUser | This property contains a username if authentication is to be used for the proxy. |
QuotaMaxPer24Hours | The maximum number of emails that can be sent in a 24 hour period. |
QuotaMaxPerSecond | The maximum number of emails that can be sent per second. |
QuotaSentLast24Hours | The number of emails sent during the previous 24 hours. |
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. |
SendStatCount | The number of records in the SendStat arrays. |
SendStatBounces | The number of emails that bounced. |
SendStatComplaints | The number of emails that were rejected by the recipient. |
SendStatDeliveryAttempts | The number of emails that have been sent or are queued to be sent. |
SendStatRejects | The number of emails rejected by Amazon SES. |
SendStatTimestamp | The time of the data point. |
SendTo | A comma separated list of addresses for destinations (required). |
SSLAcceptServerCertEncoded | This is the certificate (PEM/Base64 encoded). |
SSLCertEncoded | This is the certificate (PEM/Base64 encoded). |
SSLCertStore | This is the name of the certificate store for the client certificate. |
SSLCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLCertStoreType | This is the type of certificate store for this certificate. |
SSLCertSubject | This is the subject of the certificate used for client authentication. |
SSLProvider | This specifies the SSL/TLS implementation to use. |
SSLServerCertEncoded | This is the certificate (PEM/Base64 encoded). |
Subject | The subject of the mail message (optional). |
Timeout | A 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.
AddAttachment | This 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. |
SetAttachmentInStream | Sets an attachment using a stream. |
SetIdentityFeedbackForwarding | Enables or Disables feedback forwarding for the identity. |
SetIdentityNotificationTopic | Sets the Bounce or Complaint notification topic for an identity. |
SetMessageHTMLStream | This method sets the stream from which the class 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 class with short descriptions. Click on the links for further details.
Error | Fired when information is available about errors during data delivery. |
IdentityList | Fired for every identity when ListIdentities is called. |
Log | This event fires once for each log message. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Fired when secure connection progress messages are available. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
APIVersion | Service's API version. |
HTTPMethod | Specifies the HTTP method to use when sending a custom request. |
IsPaged | Specifies whether or not the results are paged. |
MaxListIdentityResults | That maximum number of identities to return when ListIdentities is called. |
MessageDate | The date of the mail message. |
MessageId | The message id of the mail message. |
MIMEMessage | MIME encoded message to send. |
ParseHTML | Whether or not to create a plaintext part from the HTML message. |
Priority | The priority of the mail message. |
Region | The region the class will make requests against. |
SignCustomRequest | Tells the class to sign the outgoing request. |
TransferredData | Returns the entire XML response received from the server. |
URL | If set, the default URL will be overridden by this value. |
XPath | Provides a way to point to a specific element in the returned XML or JSON response. |
XText | The text of the current element. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
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. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
EncodeURL | If set to True the URL will be encoded by the class. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to True the class will perform a GET on the new location. |
HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
HTTPVersion | The version of HTTP used by the class. |
IfModifiedSince | A date determining the maximum age of the desired document. |
KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
LogLevel | The level of detail that is logged. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
NegotiatedHTTPVersion | The negotiated HTTP version. |
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. |
SentHeaders | The full set of headers as sent by the client. |
StatusCode | The status code of the last response from the server. |
StatusLine | The first line of the last response from the server. |
TransferredData | The contents of the last response from the server. |
TransferredDataLimit | The maximum number of incoming bytes to be stored by the class. |
TransferredHeaders | The full set of headers as received from the server. |
TransferredRequest | The full request as sent by the client. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
UseIDNs | Whether to encode hostnames to internationalized domain names. |
UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
UseProxyAutoConfigURL | Whether to use a Proxy auto-config file when attempting a connection. |
UserAgent | Information about the user agent (browser). |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the class 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. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveRetryCount | The number of keep-alive packets to be sent before the remotehost is considered disconnected. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
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 port in the local host where the class binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
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). |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACertFilePaths | The paths to CA certificate files on Unix/Linux. |
SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
SSLNegotiatedCipher | Returns the negotiated cipher suite. |
SSLNegotiatedCipherStrength | Returns the negotiated cipher suite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated cipher suite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLServerCACerts | A newline separated list of CA certificate to use during SSL server certificate validation. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
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. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitive | Whether sensitive data is masked in log messages. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseFIPSCompliantAPI | Tells the class whether or not to use FIPS certified APIs. |
UseFIPSCompliantAPI | Tells the class whether or not to use FIPS certified APIs. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
AccessKey Property (AmazonSES Class)
The Access Key Id for the Amazon Web Services account.
Syntax
ANSI (Cross Platform) char* GetAccessKey();
int SetAccessKey(const char* lpszAccessKey); Unicode (Windows) LPWSTR GetAccessKey();
INT SetAccessKey(LPCWSTR lpszAccessKey);
char* cloudmail_amazonses_getaccesskey(void* lpObj);
int cloudmail_amazonses_setaccesskey(void* lpObj, const char* lpszAccessKey);
QString GetAccessKey();
int SetAccessKey(QString qsAccessKey);
Default Value
""
Remarks
This is the username for the Amazon Web Services account. No two accounts may have the same Access Key. This is used along with the SecretKey to authenticate with Amazon servers.
Data Type
String
AttachmentCount Property (AmazonSES Class)
The number of records in the Attachment arrays.
Syntax
ANSI (Cross Platform) int GetAttachmentCount();
int SetAttachmentCount(int iAttachmentCount); Unicode (Windows) INT GetAttachmentCount();
INT SetAttachmentCount(INT iAttachmentCount);
int cloudmail_amazonses_getattachmentcount(void* lpObj);
int cloudmail_amazonses_setattachmentcount(void* lpObj, int iAttachmentCount);
int GetAttachmentCount();
int SetAttachmentCount(int iAttachmentCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at AttachmentCount - 1.
This property is not available at design time.
Data Type
Integer
AttachmentData Property (AmazonSES Class)
The raw data for the attachment that will be sent with your message.
Syntax
ANSI (Cross Platform) int GetAttachmentData(int iAttachmentIndex, char* &lpAttachmentData, int &lenAttachmentData);
int SetAttachmentData(int iAttachmentIndex, const char* lpAttachmentData, int lenAttachmentData); Unicode (Windows) INT GetAttachmentData(INT iAttachmentIndex, LPSTR &lpAttachmentData, INT &lenAttachmentData);
INT SetAttachmentData(INT iAttachmentIndex, LPCSTR lpAttachmentData, INT lenAttachmentData);
int cloudmail_amazonses_getattachmentdata(void* lpObj, int attachmentindex, char** lpAttachmentData, int* lenAttachmentData);
int cloudmail_amazonses_setattachmentdata(void* lpObj, int attachmentindex, const char* lpAttachmentData, int lenAttachmentData);
QByteArray GetAttachmentData(int iAttachmentIndex);
int SetAttachmentData(int iAttachmentIndex, QByteArray qbaAttachmentData);
Default Value
""
Remarks
The raw data for the attachment that will be sent with your message. This field is used if AttachmentInputStream and AttachmentFile are 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
AttachmentFile Property (AmazonSES Class)
This property contains the path of a file on your system to be sent as an attachment with your message.
Syntax
ANSI (Cross Platform) char* GetAttachmentFile(int iAttachmentIndex);
int SetAttachmentFile(int iAttachmentIndex, const char* lpszAttachmentFile); Unicode (Windows) LPWSTR GetAttachmentFile(INT iAttachmentIndex);
INT SetAttachmentFile(INT iAttachmentIndex, LPCWSTR lpszAttachmentFile);
char* cloudmail_amazonses_getattachmentfile(void* lpObj, int attachmentindex);
int cloudmail_amazonses_setattachmentfile(void* lpObj, int attachmentindex, const char* lpszAttachmentFile);
QString GetAttachmentFile(int iAttachmentIndex);
int SetAttachmentFile(int iAttachmentIndex, QString qsAttachmentFile);
Default Value
""
Remarks
This property contains the path of a file on your system to be sent as an attachment with your message. Not used if AttachmentInputStream is 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
String
AttachmentInputStream Property (AmazonSES Class)
When this property is set to a valid stream, the class will attach the data from the stream as the current attachment.
Syntax
ANSI (Cross Platform) int SetAttachmentInputStream(int iAttachmentIndex, CloudMailStream* sAttachmentInputStream); Unicode (Windows) INT SetAttachmentInputStream(INT iAttachmentIndex, CloudMailStream* sAttachmentInputStream);
int cloudmail_amazonses_setattachmentinputstream(void* lpObj, int attachmentindex, CloudMailStream* sAttachmentInputStream);
int SetAttachmentInputStream(int iAttachmentIndex, CloudMailStream* sAttachmentInputStream);
Remarks
When this property is set to a valid stream, the class will attach the data from the stream as the current attachment.
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 write-only and not available at design time.
Data Type
AttachmentName Property (AmazonSES Class)
This property contains the name of the attachment to be sent.
Syntax
ANSI (Cross Platform) char* GetAttachmentName(int iAttachmentIndex);
int SetAttachmentName(int iAttachmentIndex, const char* lpszAttachmentName); Unicode (Windows) LPWSTR GetAttachmentName(INT iAttachmentIndex);
INT SetAttachmentName(INT iAttachmentIndex, LPCWSTR lpszAttachmentName);
char* cloudmail_amazonses_getattachmentname(void* lpObj, int attachmentindex);
int cloudmail_amazonses_setattachmentname(void* lpObj, int attachmentindex, const char* lpszAttachmentName);
QString GetAttachmentName(int iAttachmentIndex);
int SetAttachmentName(int iAttachmentIndex, QString qsAttachmentName);
Default Value
""
Remarks
This property contains the name of the attachment to be sent.
The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.
This property is not available at design time.
Data Type
String
BCc Property (AmazonSES Class)
This property includes a comma-separated list of addresses for blind carbon copies (optional).
Syntax
ANSI (Cross Platform) char* GetBCc();
int SetBCc(const char* lpszBCc); Unicode (Windows) LPWSTR GetBCc();
INT SetBCc(LPCWSTR lpszBCc);
char* cloudmail_amazonses_getbcc(void* lpObj);
int cloudmail_amazonses_setbcc(void* lpObj, const char* lpszBCc);
QString GetBCc();
int SetBCc(QString qsBCc);
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 (AmazonSES Class)
This property includes a comma-separated list of addresses for carbon copies (optional).
Syntax
ANSI (Cross Platform) char* GetCc();
int SetCc(const char* lpszCc); Unicode (Windows) LPWSTR GetCc();
INT SetCc(LPCWSTR lpszCc);
char* cloudmail_amazonses_getcc(void* lpObj);
int cloudmail_amazonses_setcc(void* lpObj, const char* lpszCc);
QString GetCc();
int SetCc(QString qsCc);
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 (AmazonSES Class)
This property includes the email address to which to send a delivery notification.
Syntax
ANSI (Cross Platform) char* GetDeliveryNotificationTo();
int SetDeliveryNotificationTo(const char* lpszDeliveryNotificationTo); Unicode (Windows) LPWSTR GetDeliveryNotificationTo();
INT SetDeliveryNotificationTo(LPCWSTR lpszDeliveryNotificationTo);
char* cloudmail_amazonses_getdeliverynotificationto(void* lpObj);
int cloudmail_amazonses_setdeliverynotificationto(void* lpObj, const char* lpszDeliveryNotificationTo);
QString GetDeliveryNotificationTo();
int SetDeliveryNotificationTo(QString qsDeliveryNotificationTo);
Default Value
""
Remarks
This property contains the email address to send to which to send a delivery notification. When set, a Return-Receipt-To header is added to the message. This property should be set to an email address that can receive the delivery notification.
Data Type
String
FirewallAutoDetect Property (AmazonSES Class)
This property tells the class whether or not to automatically detect and use firewall system settings, if available.
Syntax
ANSI (Cross Platform) int GetFirewallAutoDetect();
int SetFirewallAutoDetect(int bFirewallAutoDetect); Unicode (Windows) BOOL GetFirewallAutoDetect();
INT SetFirewallAutoDetect(BOOL bFirewallAutoDetect);
int cloudmail_amazonses_getfirewallautodetect(void* lpObj);
int cloudmail_amazonses_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);
bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect);
Default Value
FALSE
Remarks
This property tells the class whether or not to automatically detect and use firewall system settings, if available.
Data Type
Boolean
FirewallType Property (AmazonSES Class)
This property determines the type of firewall to connect through.
Syntax
ANSI (Cross Platform) int GetFirewallType();
int SetFirewallType(int iFirewallType); Unicode (Windows) INT GetFirewallType();
INT SetFirewallType(INT iFirewallType);
Possible Values
FW_NONE(0),
FW_TUNNEL(1),
FW_SOCKS4(2),
FW_SOCKS5(3),
FW_SOCKS4A(10)
int cloudmail_amazonses_getfirewalltype(void* lpObj);
int cloudmail_amazonses_setfirewalltype(void* lpObj, int iFirewallType);
int GetFirewallType();
int SetFirewallType(int iFirewallType);
Default Value
0
Remarks
This property determines the type of firewall to connect through. The applicable values are as follows:
fwNone (0) | No firewall (default setting). |
fwTunnel (1) | Connect through a tunneling proxy. FirewallPort is set to 80. |
fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Data Type
Integer
FirewallHost Property (AmazonSES Class)
This property contains the name or IP address of firewall (optional).
Syntax
ANSI (Cross Platform) char* GetFirewallHost();
int SetFirewallHost(const char* lpszFirewallHost); Unicode (Windows) LPWSTR GetFirewallHost();
INT SetFirewallHost(LPCWSTR lpszFirewallHost);
char* cloudmail_amazonses_getfirewallhost(void* lpObj);
int cloudmail_amazonses_setfirewallhost(void* lpObj, const char* lpszFirewallHost);
QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost);
Default Value
""
Remarks
This property contains the name or IP address of firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.
If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.
Data Type
String
FirewallPassword Property (AmazonSES Class)
This property contains a password if authentication is to be used when connecting through the firewall.
Syntax
ANSI (Cross Platform) char* GetFirewallPassword();
int SetFirewallPassword(const char* lpszFirewallPassword); Unicode (Windows) LPWSTR GetFirewallPassword();
INT SetFirewallPassword(LPCWSTR lpszFirewallPassword);
char* cloudmail_amazonses_getfirewallpassword(void* lpObj);
int cloudmail_amazonses_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);
QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword);
Default Value
""
Remarks
This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.
Data Type
String
FirewallPort Property (AmazonSES Class)
This property contains the transmission control protocol (TCP) port for the firewall Host .
Syntax
ANSI (Cross Platform) int GetFirewallPort();
int SetFirewallPort(int iFirewallPort); Unicode (Windows) INT GetFirewallPort();
INT SetFirewallPort(INT iFirewallPort);
int cloudmail_amazonses_getfirewallport(void* lpObj);
int cloudmail_amazonses_setfirewallport(void* lpObj, int iFirewallPort);
int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);
Default Value
0
Remarks
This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.
Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.
Data Type
Integer
FirewallUser Property (AmazonSES Class)
This property contains a user name if authentication is to be used connecting through a firewall.
Syntax
ANSI (Cross Platform) char* GetFirewallUser();
int SetFirewallUser(const char* lpszFirewallUser); Unicode (Windows) LPWSTR GetFirewallUser();
INT SetFirewallUser(LPCWSTR lpszFirewallUser);
char* cloudmail_amazonses_getfirewalluser(void* lpObj);
int cloudmail_amazonses_setfirewalluser(void* lpObj, const char* lpszFirewallUser);
QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);
Default Value
""
Remarks
This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.
Data Type
String
From Property (AmazonSES Class)
The email address of the sender (required).
Syntax
ANSI (Cross Platform) char* GetFrom();
int SetFrom(const char* lpszFrom); Unicode (Windows) LPWSTR GetFrom();
INT SetFrom(LPCWSTR lpszFrom);
char* cloudmail_amazonses_getfrom(void* lpObj);
int cloudmail_amazonses_setfrom(void* lpObj, const char* lpszFrom);
QString GetFrom();
int SetFrom(QString qsFrom);
Default Value
""
Remarks
This property is used to create a From SMTP header. This header identifies the sender of the message. A valid email address is required. Examples of valid addresses are: "Friendly Name" <address@company.com> or address@company.com
If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 822 specifications.
Data Type
String
IdentityCount Property (AmazonSES Class)
The number of records in the Identity arrays.
Syntax
ANSI (Cross Platform) int GetIdentityCount(); Unicode (Windows) INT GetIdentityCount();
int cloudmail_amazonses_getidentitycount(void* lpObj);
int GetIdentityCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
- IdentityAttributesType
- IdentityName
- IdentityNotificationBounceTopic
- IdentityNotificationComplaintTopic
- IdentityNotificationForwardingEnabled
- IdentityVerificationStatus
- IdentityVerificationToken
The array indices start at 0 and end at IdentityCount - 1.
This property is read-only and not available at design time.
Data Type
Integer
IdentityAttributesType Property (AmazonSES Class)
Specifies the type of attribute.
Syntax
ANSI (Cross Platform) int GetIdentityAttributesType(int iIdentityIndex); Unicode (Windows) INT GetIdentityAttributesType(INT iIdentityIndex);
int cloudmail_amazonses_getidentityattributestype(void* lpObj, int identityindex);
int GetIdentityAttributesType(int iIdentityIndex);
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:
AttributesType | Meaning |
0 | Notification |
1 | Verification |
2 | None. This will be the case when ListIdentities is called. Only the IdentityName property will be populated. |
- IdentityName
- IdentityNotificationBounceTopic
- IdentityNotificationComplaintTopic
- IdentityNotificationForwardingEnabled
The IdentityIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IdentityCount property.
This property is read-only and not available at design time.
Data Type
Integer
IdentityName Property (AmazonSES Class)
The current identity name.
Syntax
ANSI (Cross Platform) char* GetIdentityName(int iIdentityIndex); Unicode (Windows) LPWSTR GetIdentityName(INT iIdentityIndex);
char* cloudmail_amazonses_getidentityname(void* lpObj, int identityindex);
QString GetIdentityName(int iIdentityIndex);
Default Value
""
Remarks
The current identity name. This is either an email address or domain.
The IdentityIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IdentityCount property.
This property is read-only and not available at design time.
Data Type
String
IdentityNotificationBounceTopic Property (AmazonSES Class)
The Amazon Simple Notification Service (SNS) topic to which Amazon will publish bounce notifications.
Syntax
ANSI (Cross Platform) char* GetIdentityNotificationBounceTopic(int iIdentityIndex); Unicode (Windows) LPWSTR GetIdentityNotificationBounceTopic(INT iIdentityIndex);
char* cloudmail_amazonses_getidentitynotificationbouncetopic(void* lpObj, int identityindex);
QString GetIdentityNotificationBounceTopic(int iIdentityIndex);
Default Value
""
Remarks
The Amazon Simple Notification Service (SNS) topic to which Amazon will publish bounce notifications.
The IdentityIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IdentityCount property.
This property is read-only and not available at design time.
Data Type
String
IdentityNotificationComplaintTopic Property (AmazonSES Class)
The Amazon Simple Notification Service (SNS) topic to which Amazon will publish complaint notifications.
Syntax
ANSI (Cross Platform) char* GetIdentityNotificationComplaintTopic(int iIdentityIndex); Unicode (Windows) LPWSTR GetIdentityNotificationComplaintTopic(INT iIdentityIndex);
char* cloudmail_amazonses_getidentitynotificationcomplainttopic(void* lpObj, int identityindex);
QString GetIdentityNotificationComplaintTopic(int iIdentityIndex);
Default Value
""
Remarks
The Amazon Simple Notification Service (SNS) topic to which Amazon will publish complaint notifications.
The IdentityIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IdentityCount property.
This property is read-only and not available at design time.
Data Type
String
IdentityNotificationForwardingEnabled Property (AmazonSES Class)
Specifies whether or not Amazon will forward feedback as email.
Syntax
ANSI (Cross Platform) int GetIdentityNotificationForwardingEnabled(int iIdentityIndex); Unicode (Windows) BOOL GetIdentityNotificationForwardingEnabled(INT iIdentityIndex);
int cloudmail_amazonses_getidentitynotificationforwardingenabled(void* lpObj, int identityindex);
bool GetIdentityNotificationForwardingEnabled(int iIdentityIndex);
Default Value
FALSE
Remarks
Specifies whether or not Amazon will forward feedback as email. True indicates feedback will be sent as email. A value of False indicates that feedback will only be published to the IdentityNotificationBounceTopic and IdentityNotificationComplaintTopic SNS topics.
The IdentityIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IdentityCount property.
This property is read-only and not available at design time.
Data Type
Boolean
IdentityVerificationStatus Property (AmazonSES Class)
The current verification status of the identity.
Syntax
ANSI (Cross Platform) char* GetIdentityVerificationStatus(int iIdentityIndex); Unicode (Windows) LPWSTR GetIdentityVerificationStatus(INT iIdentityIndex);
char* cloudmail_amazonses_getidentityverificationstatus(void* lpObj, int identityindex);
QString GetIdentityVerificationStatus(int iIdentityIndex);
Default Value
""
Remarks
The current verification status of the identity. Possible values are:
- Pending
- Success
- Failed
- TemporaryFailure
- NotStarted
The IdentityIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IdentityCount property.
This property is read-only and not available at design time.
Data Type
String
IdentityVerificationToken Property (AmazonSES Class)
The verification token for the domain.
Syntax
ANSI (Cross Platform) char* GetIdentityVerificationToken(int iIdentityIndex); Unicode (Windows) LPWSTR GetIdentityVerificationToken(INT iIdentityIndex);
char* cloudmail_amazonses_getidentityverificationtoken(void* lpObj, int identityindex);
QString GetIdentityVerificationToken(int iIdentityIndex);
Default Value
""
Remarks
The verification token for the domain. This is only applicable to domains. The value will be empty for email addresses.
The IdentityIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IdentityCount property.
This property is read-only and not available at design time.
Data Type
String
IdentityMarker Property (AmazonSES Class)
The offset marker used to navigate paged results.
Syntax
ANSI (Cross Platform) char* GetIdentityMarker();
int SetIdentityMarker(const char* lpszIdentityMarker); Unicode (Windows) LPWSTR GetIdentityMarker();
INT SetIdentityMarker(LPCWSTR lpszIdentityMarker);
char* cloudmail_amazonses_getidentitymarker(void* lpObj);
int cloudmail_amazonses_setidentitymarker(void* lpObj, const char* lpszIdentityMarker);
QString GetIdentityMarker();
int SetIdentityMarker(QString qsIdentityMarker);
Default Value
""
Remarks
This property holds the offset marker used to request the next page of results. This may be automatically populated after a call to ListIdentities. If this holds a value, subsequent calls to ListIdentities will use this value to get the next page of results. See also: ListIdentities, IsPaged.
This property is not available at design time.
Data Type
String
Idle Property (AmazonSES Class)
The current status of the class.
Syntax
ANSI (Cross Platform) int GetIdle(); Unicode (Windows) BOOL GetIdle();
int cloudmail_amazonses_getidle(void* lpObj);
bool GetIdle();
Default Value
TRUE
Remarks
Idle will be False if the component is currently busy (communicating and/or waiting for an answer), and True at all other times.
This property is read-only.
Data Type
Boolean
ImageCount Property (AmazonSES Class)
The number of records in the Image arrays.
Syntax
ANSI (Cross Platform) int GetImageCount();
int SetImageCount(int iImageCount); Unicode (Windows) INT GetImageCount();
INT SetImageCount(INT iImageCount);
int cloudmail_amazonses_getimagecount(void* lpObj);
int cloudmail_amazonses_setimagecount(void* lpObj, int iImageCount);
int GetImageCount();
int SetImageCount(int iImageCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at ImageCount - 1.
This property is not available at design time.
Data Type
Integer
ImageData Property (AmazonSES Class)
This property optionally specifies the image data.
Syntax
ANSI (Cross Platform) int GetImageData(int iImageIndex, char* &lpImageData, int &lenImageData);
int SetImageData(int iImageIndex, const char* lpImageData, int lenImageData); Unicode (Windows) INT GetImageData(INT iImageIndex, LPSTR &lpImageData, INT &lenImageData);
INT SetImageData(INT iImageIndex, LPCSTR lpImageData, INT lenImageData);
int cloudmail_amazonses_getimagedata(void* lpObj, int imageindex, char** lpImageData, int* lenImageData);
int cloudmail_amazonses_setimagedata(void* lpObj, int imageindex, const char* lpImageData, int lenImageData);
QByteArray GetImageData(int iImageIndex);
int SetImageData(int iImageIndex, QByteArray qbaImageData);
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 (AmazonSES Class)
This property contains the name of the image files embedded into the HTML message.
Syntax
ANSI (Cross Platform) char* GetImageFile(int iImageIndex);
int SetImageFile(int iImageIndex, const char* lpszImageFile); Unicode (Windows) LPWSTR GetImageFile(INT iImageIndex);
INT SetImageFile(INT iImageIndex, LPCWSTR lpszImageFile);
char* cloudmail_amazonses_getimagefile(void* lpObj, int imageindex);
int cloudmail_amazonses_setimagefile(void* lpObj, int imageindex, const char* lpszImageFile);
QString GetImageFile(int iImageIndex);
int SetImageFile(int iImageIndex, QString qsImageFile);
Default Value
""
Remarks
This property contains the name of the image files embedded into the HTML message. This value is updated every time MessageHTML is set. You may change the file names before sending (e.g., if they don't point to valid files).
The ImageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ImageCount property.
This property is not available at design time.
Data Type
String
ImageId Property (AmazonSES Class)
This property contains the content identifier for embedded images.
Syntax
ANSI (Cross Platform) char* GetImageId(int iImageIndex);
int SetImageId(int iImageIndex, const char* lpszImageId); Unicode (Windows) LPWSTR GetImageId(INT iImageIndex);
INT SetImageId(INT iImageIndex, LPCWSTR lpszImageId);
char* cloudmail_amazonses_getimageid(void* lpObj, int imageindex);
int cloudmail_amazonses_setimageid(void* lpObj, int imageindex, const char* lpszImageId);
QString GetImageId(int iImageIndex);
int SetImageId(int iImageIndex, QString qsImageId);
Default Value
""
Remarks
This property contains the content identifier for embedded images. This value is computed automatically, unless ParseHTML is False, in which case you are responsible for providing it.
The ImageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ImageCount property.
This property is not available at design time.
Data Type
String
ImageType Property (AmazonSES Class)
This property contains the content type for embedded images.
Syntax
ANSI (Cross Platform) char* GetImageType(int iImageIndex);
int SetImageType(int iImageIndex, const char* lpszImageType); Unicode (Windows) LPWSTR GetImageType(INT iImageIndex);
INT SetImageType(INT iImageIndex, LPCWSTR lpszImageType);
char* cloudmail_amazonses_getimagetype(void* lpObj, int imageindex);
int cloudmail_amazonses_setimagetype(void* lpObj, int imageindex, const char* lpszImageType);
QString GetImageType(int iImageIndex);
int SetImageType(int iImageIndex, QString qsImageType);
Default Value
""
Remarks
This property contains the content type for embedded images. This value is determined automatically, unless ParseHTML is False, in which case you are responsible for providing it.
The ImageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ImageCount property.
This property is not available at design time.
Data Type
String
Importance Property (AmazonSES Class)
Importance of the mail message (optional).
Syntax
ANSI (Cross Platform) int GetImportance();
int SetImportance(int iImportance); Unicode (Windows) INT GetImportance();
INT SetImportance(INT iImportance);
Possible Values
MI_UNSPECIFIED(0),
MI_HIGH(1),
MI_NORMAL(2),
MI_LOW(3)
int cloudmail_amazonses_getimportance(void* lpObj);
int cloudmail_amazonses_setimportance(void* lpObj, int iImportance);
int GetImportance();
int SetImportance(int iImportance);
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 how important the message is. The possible values are Unspecified (0), High (1), Normal (2), and Low (3).
Data Type
Integer
LocalHost Property (AmazonSES Class)
The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
ANSI (Cross Platform) char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost); Unicode (Windows) LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);
char* cloudmail_amazonses_getlocalhost(void* lpObj);
int cloudmail_amazonses_setlocalhost(void* lpObj, const char* lpszLocalHost);
QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);
Default Value
""
Remarks
The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.
In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.
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 multi-homed hosts (machines with more than one IP interface).
NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.
Data Type
String
MessageHTML Property (AmazonSES Class)
This property includes the HTML version of the message.
Syntax
ANSI (Cross Platform) char* GetMessageHTML();
int SetMessageHTML(const char* lpszMessageHTML); Unicode (Windows) LPWSTR GetMessageHTML();
INT SetMessageHTML(LPCWSTR lpszMessageHTML);
char* cloudmail_amazonses_getmessagehtml(void* lpObj);
int cloudmail_amazonses_setmessagehtml(void* lpObj, const char* lpszMessageHTML);
QString GetMessageHTML();
int SetMessageHTML(QString qsMessageHTML);
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 (AmazonSES Class)
The number of records in the MessageRecipient arrays.
Syntax
ANSI (Cross Platform) int GetMessageRecipientCount();
int SetMessageRecipientCount(int iMessageRecipientCount); Unicode (Windows) INT GetMessageRecipientCount();
INT SetMessageRecipientCount(INT iMessageRecipientCount);
int cloudmail_amazonses_getmessagerecipientcount(void* lpObj);
int cloudmail_amazonses_setmessagerecipientcount(void* lpObj, int iMessageRecipientCount);
int GetMessageRecipientCount();
int SetMessageRecipientCount(int iMessageRecipientCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at MessageRecipientCount - 1.
This property is not available at design time.
Data Type
Integer
MessageRecipientAddress Property (AmazonSES Class)
This property contains the email address of the recipient.
Syntax
ANSI (Cross Platform) char* GetMessageRecipientAddress(int iRecipientIndex);
int SetMessageRecipientAddress(int iRecipientIndex, const char* lpszMessageRecipientAddress); Unicode (Windows) LPWSTR GetMessageRecipientAddress(INT iRecipientIndex);
INT SetMessageRecipientAddress(INT iRecipientIndex, LPCWSTR lpszMessageRecipientAddress);
char* cloudmail_amazonses_getmessagerecipientaddress(void* lpObj, int recipientindex);
int cloudmail_amazonses_setmessagerecipientaddress(void* lpObj, int recipientindex, const char* lpszMessageRecipientAddress);
QString GetMessageRecipientAddress(int iRecipientIndex);
int SetMessageRecipientAddress(int iRecipientIndex, QString qsMessageRecipientAddress);
Default Value
""
Remarks
This property contains the email address of the recipient.
The RecipientIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageRecipientCount property.
This property is not available at design time.
Data Type
String
MessageRecipientName Property (AmazonSES Class)
This property contains the name of the recipient.
Syntax
ANSI (Cross Platform) char* GetMessageRecipientName(int iRecipientIndex);
int SetMessageRecipientName(int iRecipientIndex, const char* lpszMessageRecipientName); Unicode (Windows) LPWSTR GetMessageRecipientName(INT iRecipientIndex);
INT SetMessageRecipientName(INT iRecipientIndex, LPCWSTR lpszMessageRecipientName);
char* cloudmail_amazonses_getmessagerecipientname(void* lpObj, int recipientindex);
int cloudmail_amazonses_setmessagerecipientname(void* lpObj, int recipientindex, const char* lpszMessageRecipientName);
QString GetMessageRecipientName(int iRecipientIndex);
int SetMessageRecipientName(int iRecipientIndex, QString qsMessageRecipientName);
Default Value
""
Remarks
This property contains the name of the recipient.
The RecipientIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageRecipientCount property.
This property is not available at design time.
Data Type
String
MessageRecipientOptions Property (AmazonSES Class)
This property contains the recipient sending options (used only by SMTP).
Syntax
ANSI (Cross Platform) char* GetMessageRecipientOptions(int iRecipientIndex);
int SetMessageRecipientOptions(int iRecipientIndex, const char* lpszMessageRecipientOptions); Unicode (Windows) LPWSTR GetMessageRecipientOptions(INT iRecipientIndex);
INT SetMessageRecipientOptions(INT iRecipientIndex, LPCWSTR lpszMessageRecipientOptions);
char* cloudmail_amazonses_getmessagerecipientoptions(void* lpObj, int recipientindex);
int cloudmail_amazonses_setmessagerecipientoptions(void* lpObj, int recipientindex, const char* lpszMessageRecipientOptions);
QString GetMessageRecipientOptions(int iRecipientIndex);
int SetMessageRecipientOptions(int iRecipientIndex, QString qsMessageRecipientOptions);
Default Value
""
Remarks
This property contains the recipient sending options (used only by SMTP). This must be a string of RFC-compliant recipient options (used by SMTP).
One type of option is a delivery status notification sent per recipient, which is specified by RFC 1891.
component.MessageRecipientOptions(0) = "NOTIFY SUCCESS,FAILURE,DELAY";
The RecipientIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageRecipientCount property.
This property is not available at design time.
Data Type
String
MessageRecipientType Property (AmazonSES Class)
This property contains the recipient type: To, Cc, or Bcc.
Syntax
ANSI (Cross Platform) int GetMessageRecipientType(int iRecipientIndex);
int SetMessageRecipientType(int iRecipientIndex, int iMessageRecipientType); Unicode (Windows) INT GetMessageRecipientType(INT iRecipientIndex);
INT SetMessageRecipientType(INT iRecipientIndex, INT iMessageRecipientType);
Possible Values
RT_TO(0),
RT_CC(1),
RT_BCC(2)
int cloudmail_amazonses_getmessagerecipienttype(void* lpObj, int recipientindex);
int cloudmail_amazonses_setmessagerecipienttype(void* lpObj, int recipientindex, int iMessageRecipientType);
int GetMessageRecipientType(int iRecipientIndex);
int SetMessageRecipientType(int iRecipientIndex, int iMessageRecipientType);
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 (AmazonSES Class)
This property includes the plaintext version of the message.
Syntax
ANSI (Cross Platform) char* GetMessageText();
int SetMessageText(const char* lpszMessageText); Unicode (Windows) LPWSTR GetMessageText();
INT SetMessageText(LPCWSTR lpszMessageText);
char* cloudmail_amazonses_getmessagetext(void* lpObj);
int cloudmail_amazonses_setmessagetext(void* lpObj, const char* lpszMessageText);
QString GetMessageText();
int SetMessageText(QString qsMessageText);
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 (AmazonSES Class)
An RFC 822 compliant string consisting of extra headers.
Syntax
ANSI (Cross Platform) char* GetOtherHeaders();
int SetOtherHeaders(const char* lpszOtherHeaders); Unicode (Windows) LPWSTR GetOtherHeaders();
INT SetOtherHeaders(LPCWSTR lpszOtherHeaders);
char* cloudmail_amazonses_getotherheaders(void* lpObj);
int cloudmail_amazonses_setotherheaders(void* lpObj, const char* lpszOtherHeaders);
QString GetOtherHeaders();
int SetOtherHeaders(QString qsOtherHeaders);
Default Value
""
Remarks
This property contains a string of headers to be appended to the message headers created from other properties like SendTo, Subject, etc.
The headers must be of the format "header: value" as specified in RFC 822. Header lines should be separated by CRLF ("\r\n") .
Use this property with caution. If this property contains invalid headers, message delivery might not be successful.
This property is useful for extending the functionality of the 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 (Send an Email With Additional Header)
component.MailServer = "MyServer";
component.From = "me@server.com";
component.SendTo = "recipient@server.com";
component.Subject = "My Subject";
component.MessageText = "This is the message body.";
component.OtherHeaders = "HeaderName: HeaderValue";
component.Send();
This property is not available at design time.
Data Type
String
ProxyAuthScheme Property (AmazonSES Class)
This property is used to tell the class which type of authorization to perform when connecting to the proxy.
Syntax
ANSI (Cross Platform) int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme); Unicode (Windows) INT GetProxyAuthScheme();
INT SetProxyAuthScheme(INT iProxyAuthScheme);
Possible Values
AUTH_BASIC(0),
AUTH_DIGEST(1),
AUTH_PROPRIETARY(2),
AUTH_NONE(3),
AUTH_NTLM(4),
AUTH_NEGOTIATE(5)
int cloudmail_amazonses_getproxyauthscheme(void* lpObj);
int cloudmail_amazonses_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);
int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);
Default Value
0
Remarks
This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.
ProxyAuthScheme should be set to authNone (3) when no authentication is expected.
By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.
If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.
If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the 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 (AmazonSES Class)
This property tells the class whether or not to automatically detect and use proxy system settings, if available.
Syntax
ANSI (Cross Platform) int GetProxyAutoDetect();
int SetProxyAutoDetect(int bProxyAutoDetect); Unicode (Windows) BOOL GetProxyAutoDetect();
INT SetProxyAutoDetect(BOOL bProxyAutoDetect);
int cloudmail_amazonses_getproxyautodetect(void* lpObj);
int cloudmail_amazonses_setproxyautodetect(void* lpObj, int bProxyAutoDetect);
bool GetProxyAutoDetect();
int SetProxyAutoDetect(bool bProxyAutoDetect);
Default Value
FALSE
Remarks
This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is false.
Data Type
Boolean
ProxyPassword Property (AmazonSES Class)
This property contains a password if authentication is to be used for the proxy.
Syntax
ANSI (Cross Platform) char* GetProxyPassword();
int SetProxyPassword(const char* lpszProxyPassword); Unicode (Windows) LPWSTR GetProxyPassword();
INT SetProxyPassword(LPCWSTR lpszProxyPassword);
char* cloudmail_amazonses_getproxypassword(void* lpObj);
int cloudmail_amazonses_setproxypassword(void* lpObj, const char* lpszProxyPassword);
QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);
Default Value
""
Remarks
This property contains a password if authentication is to be used for the proxy.
If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.
If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.
Data Type
String
ProxyPort Property (AmazonSES Class)
This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).
Syntax
ANSI (Cross Platform) int GetProxyPort();
int SetProxyPort(int iProxyPort); Unicode (Windows) INT GetProxyPort();
INT SetProxyPort(INT iProxyPort);
int cloudmail_amazonses_getproxyport(void* lpObj);
int cloudmail_amazonses_setproxyport(void* lpObj, int iProxyPort);
int GetProxyPort();
int SetProxyPort(int iProxyPort);
Default Value
80
Remarks
This property contains the Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.
Data Type
Integer
ProxyServer Property (AmazonSES Class)
If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
Syntax
ANSI (Cross Platform) char* GetProxyServer();
int SetProxyServer(const char* lpszProxyServer); Unicode (Windows) LPWSTR GetProxyServer();
INT SetProxyServer(LPCWSTR lpszProxyServer);
char* cloudmail_amazonses_getproxyserver(void* lpObj);
int cloudmail_amazonses_setproxyserver(void* lpObj, const char* lpszProxyServer);
QString GetProxyServer();
int SetProxyServer(QString qsProxyServer);
Default Value
""
Remarks
If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.
Data Type
String
ProxySSL Property (AmazonSES Class)
This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.
Syntax
ANSI (Cross Platform) int GetProxySSL();
int SetProxySSL(int iProxySSL); Unicode (Windows) INT GetProxySSL();
INT SetProxySSL(INT iProxySSL);
Possible Values
PS_AUTOMATIC(0),
PS_ALWAYS(1),
PS_NEVER(2),
PS_TUNNEL(3)
int cloudmail_amazonses_getproxyssl(void* lpObj);
int cloudmail_amazonses_setproxyssl(void* lpObj, int iProxySSL);
int GetProxySSL();
int SetProxySSL(int iProxySSL);
Default Value
0
Remarks
This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:
psAutomatic (0) | Default setting. If the URL is an https URL, the class will use the psTunnel option. If the URL is an http URL, the class will use the psNever option. |
psAlways (1) | The connection is always SSL enabled. |
psNever (2) | The connection is not SSL enabled. |
psTunnel (3) | The connection is made through a tunneling (HTTP) proxy. |
Data Type
Integer
ProxyUser Property (AmazonSES Class)
This property contains a username if authentication is to be used for the proxy.
Syntax
ANSI (Cross Platform) char* GetProxyUser();
int SetProxyUser(const char* lpszProxyUser); Unicode (Windows) LPWSTR GetProxyUser();
INT SetProxyUser(LPCWSTR lpszProxyUser);
char* cloudmail_amazonses_getproxyuser(void* lpObj);
int cloudmail_amazonses_setproxyuser(void* lpObj, const char* lpszProxyUser);
QString GetProxyUser();
int SetProxyUser(QString qsProxyUser);
Default Value
""
Remarks
This property contains a username if authentication is to be used for the proxy.
If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.
If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.
Data Type
String
QuotaMaxPer24Hours Property (AmazonSES Class)
The maximum number of emails that can be sent in a 24 hour period.
Syntax
ANSI (Cross Platform) char* GetQuotaMaxPer24Hours(); Unicode (Windows) LPWSTR GetQuotaMaxPer24Hours();
char* cloudmail_amazonses_getquotamaxper24hours(void* lpObj);
QString GetQuotaMaxPer24Hours();
Default Value
""
Remarks
The maximum number of emails that can be sent in a 24 hour period.
This property is read-only and not available at design time.
Data Type
String
QuotaMaxPerSecond Property (AmazonSES Class)
The maximum number of emails that can be sent per second.
Syntax
ANSI (Cross Platform) char* GetQuotaMaxPerSecond(); Unicode (Windows) LPWSTR GetQuotaMaxPerSecond();
char* cloudmail_amazonses_getquotamaxpersecond(void* lpObj);
QString GetQuotaMaxPerSecond();
Default Value
""
Remarks
The maximum number of emails that can be sent per second.
This property is read-only and not available at design time.
Data Type
String
QuotaSentLast24Hours Property (AmazonSES Class)
The number of emails sent during the previous 24 hours.
Syntax
ANSI (Cross Platform) char* GetQuotaSentLast24Hours(); Unicode (Windows) LPWSTR GetQuotaSentLast24Hours();
char* cloudmail_amazonses_getquotasentlast24hours(void* lpObj);
QString GetQuotaSentLast24Hours();
Default Value
""
Remarks
The number of emails sent during the previous 24 hours.
This property is read-only and not available at design time.
Data Type
String
ReadReceiptTo Property (AmazonSES Class)
Email address to send a read receipt to.
Syntax
ANSI (Cross Platform) char* GetReadReceiptTo();
int SetReadReceiptTo(const char* lpszReadReceiptTo); Unicode (Windows) LPWSTR GetReadReceiptTo();
INT SetReadReceiptTo(LPCWSTR lpszReadReceiptTo);
char* cloudmail_amazonses_getreadreceiptto(void* lpObj);
int cloudmail_amazonses_setreadreceiptto(void* lpObj, const char* lpszReadReceiptTo);
QString GetReadReceiptTo();
int SetReadReceiptTo(QString qsReadReceiptTo);
Default Value
""
Remarks
When this property is set, a Disposition-Notification-To header is added to the message. This property should be set to an email address which should receive the read-receipt.
Data Type
String
ReplyTo Property (AmazonSES Class)
A mail address to which to reply (optional).
Syntax
ANSI (Cross Platform) char* GetReplyTo();
int SetReplyTo(const char* lpszReplyTo); Unicode (Windows) LPWSTR GetReplyTo();
INT SetReplyTo(LPCWSTR lpszReplyTo);
char* cloudmail_amazonses_getreplyto(void* lpObj);
int cloudmail_amazonses_setreplyto(void* lpObj, const char* lpszReplyTo);
QString GetReplyTo();
int SetReplyTo(QString qsReplyTo);
Default Value
""
Remarks
If this property contains a non-empty string, a Reply-To SMTP header is created for the message. This header shows the address to use for replies (useful if this address is different from the one in From).
If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 822 specifications.
Data Type
String
SecretKey Property (AmazonSES Class)
The Secret Access Key for the Amazon Web Services account.
Syntax
ANSI (Cross Platform) char* GetSecretKey();
int SetSecretKey(const char* lpszSecretKey); Unicode (Windows) LPWSTR GetSecretKey();
INT SetSecretKey(LPCWSTR lpszSecretKey);
char* cloudmail_amazonses_getsecretkey(void* lpObj);
int cloudmail_amazonses_setsecretkey(void* lpObj, const char* lpszSecretKey);
QString GetSecretKey();
int SetSecretKey(QString qsSecretKey);
Default Value
""
Remarks
This property describes the secret key to the Amazon account. It should not be shared with others. The SecretKey is used along with the AccessKey in the authentication process with Amazon servers.
Data Type
String
SendStatCount Property (AmazonSES Class)
The number of records in the SendStat arrays.
Syntax
ANSI (Cross Platform) int GetSendStatCount(); Unicode (Windows) INT GetSendStatCount();
int cloudmail_amazonses_getsendstatcount(void* lpObj);
int GetSendStatCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at SendStatCount - 1.
This property is read-only and not available at design time.
Data Type
Integer
SendStatBounces Property (AmazonSES Class)
The number of emails that bounced.
Syntax
ANSI (Cross Platform) int64 GetSendStatBounces(int iSendStatIndex); Unicode (Windows) LONG64 GetSendStatBounces(INT iSendStatIndex);
int64 cloudmail_amazonses_getsendstatbounces(void* lpObj, int sendstatindex);
qint64 GetSendStatBounces(int iSendStatIndex);
Default Value
0
Remarks
The number of emails that bounced.
The SendStatIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SendStatCount property.
This property is read-only and not available at design time.
Data Type
Long64
SendStatComplaints Property (AmazonSES Class)
The number of emails that were rejected by the recipient.
Syntax
ANSI (Cross Platform) int64 GetSendStatComplaints(int iSendStatIndex); Unicode (Windows) LONG64 GetSendStatComplaints(INT iSendStatIndex);
int64 cloudmail_amazonses_getsendstatcomplaints(void* lpObj, int sendstatindex);
qint64 GetSendStatComplaints(int iSendStatIndex);
Default Value
0
Remarks
The number of emails that were rejected by the recipient.
The SendStatIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SendStatCount property.
This property is read-only and not available at design time.
Data Type
Long64
SendStatDeliveryAttempts Property (AmazonSES Class)
The number of emails that have been sent or are queued to be sent.
Syntax
ANSI (Cross Platform) int64 GetSendStatDeliveryAttempts(int iSendStatIndex); Unicode (Windows) LONG64 GetSendStatDeliveryAttempts(INT iSendStatIndex);
int64 cloudmail_amazonses_getsendstatdeliveryattempts(void* lpObj, int sendstatindex);
qint64 GetSendStatDeliveryAttempts(int iSendStatIndex);
Default Value
0
Remarks
The number of emails that have been sent or are queued to be sent.
The SendStatIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SendStatCount property.
This property is read-only and not available at design time.
Data Type
Long64
SendStatRejects Property (AmazonSES Class)
The number of emails rejected by Amazon SES.
Syntax
ANSI (Cross Platform) int64 GetSendStatRejects(int iSendStatIndex); Unicode (Windows) LONG64 GetSendStatRejects(INT iSendStatIndex);
int64 cloudmail_amazonses_getsendstatrejects(void* lpObj, int sendstatindex);
qint64 GetSendStatRejects(int iSendStatIndex);
Default Value
0
Remarks
The number of emails rejected by Amazon SES.
The SendStatIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SendStatCount property.
This property is read-only and not available at design time.
Data Type
Long64
SendStatTimestamp Property (AmazonSES Class)
The time of the data point.
Syntax
ANSI (Cross Platform) char* GetSendStatTimestamp(int iSendStatIndex); Unicode (Windows) LPWSTR GetSendStatTimestamp(INT iSendStatIndex);
char* cloudmail_amazonses_getsendstattimestamp(void* lpObj, int sendstatindex);
QString GetSendStatTimestamp(int iSendStatIndex);
Default Value
""
Remarks
The time of the data point. For instance "2012-09-18T13:00:01Z".
The SendStatIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SendStatCount property.
This property is read-only and not available at design time.
Data Type
String
SendTo Property (AmazonSES Class)
A comma separated list of addresses for destinations (required).
Syntax
ANSI (Cross Platform) char* GetSendTo();
int SetSendTo(const char* lpszSendTo); Unicode (Windows) LPWSTR GetSendTo();
INT SetSendTo(LPCWSTR lpszSendTo);
char* cloudmail_amazonses_getsendto(void* lpObj);
int cloudmail_amazonses_setsendto(void* lpObj, const char* lpszSendTo);
QString GetSendTo();
int SetSendTo(QString qsSendTo);
Default Value
""
Remarks
This property specifies a comma separated list of destinations for the mail message. A copy of the message is sent to each of them, and a To SMTP header is created containing the destination addresses.
Examples of valid addresses are: "Friendly Name" <address@company.com> or address@company.com
The 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 happens with an email address specified in BCc.
If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 822 specifications.
NOTE: You must clear the MessageRecipients properties before setting this property to remove previous recipients.
Data Type
String
SSLAcceptServerCertEncoded Property (AmazonSES Class)
This is the certificate (PEM/Base64 encoded).
Syntax
ANSI (Cross Platform) int GetSSLAcceptServerCertEncoded(char* &lpSSLAcceptServerCertEncoded, int &lenSSLAcceptServerCertEncoded);
int SetSSLAcceptServerCertEncoded(const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded); Unicode (Windows) INT GetSSLAcceptServerCertEncoded(LPSTR &lpSSLAcceptServerCertEncoded, INT &lenSSLAcceptServerCertEncoded);
INT SetSSLAcceptServerCertEncoded(LPCSTR lpSSLAcceptServerCertEncoded, INT lenSSLAcceptServerCertEncoded);
int cloudmail_amazonses_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int cloudmail_amazonses_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);
QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.
When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.
This property is not available at design time.
Data Type
Binary String
SSLCertEncoded Property (AmazonSES Class)
This is the certificate (PEM/Base64 encoded).
Syntax
ANSI (Cross Platform) int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded); Unicode (Windows) INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);
int cloudmail_amazonses_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int cloudmail_amazonses_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);
QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.
When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.
This property is not available at design time.
Data Type
Binary String
SSLCertStore Property (AmazonSES Class)
This is the name of the certificate store for the client certificate.
Syntax
ANSI (Cross Platform) int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore); Unicode (Windows) INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);
int cloudmail_amazonses_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int cloudmail_amazonses_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);
QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.
SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
Data Type
Binary String
SSLCertStorePassword Property (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.
Syntax
ANSI (Cross Platform) char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword); Unicode (Windows) LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);
char* cloudmail_amazonses_getsslcertstorepassword(void* lpObj);
int cloudmail_amazonses_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);
QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Data Type
String
SSLCertStoreType Property (AmazonSES Class)
This is the type of certificate store for this certificate.
Syntax
ANSI (Cross Platform) int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType); Unicode (Windows) INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);
Possible Values
CST_USER(0),
CST_MACHINE(1),
CST_PFXFILE(2),
CST_PFXBLOB(3),
CST_JKSFILE(4),
CST_JKSBLOB(5),
CST_PEMKEY_FILE(6),
CST_PEMKEY_BLOB(7),
CST_PUBLIC_KEY_FILE(8),
CST_PUBLIC_KEY_BLOB(9),
CST_SSHPUBLIC_KEY_BLOB(10),
CST_P7BFILE(11),
CST_P7BBLOB(12),
CST_SSHPUBLIC_KEY_FILE(13),
CST_PPKFILE(14),
CST_PPKBLOB(15),
CST_XMLFILE(16),
CST_XMLBLOB(17),
CST_JWKFILE(18),
CST_JWKBLOB(19),
CST_SECURITY_KEY(20),
CST_BCFKSFILE(21),
CST_BCFKSBLOB(22),
CST_PKCS11(23),
CST_AUTO(99)
int cloudmail_amazonses_getsslcertstoretype(void* lpObj);
int cloudmail_amazonses_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);
Default Value
0
Remarks
This is 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:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLCertStore and set SSLCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
Data Type
Integer
SSLCertSubject Property (AmazonSES Class)
This is the subject of the certificate used for client authentication.
Syntax
ANSI (Cross Platform) char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject); Unicode (Windows) LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);
char* cloudmail_amazonses_getsslcertsubject(void* lpObj);
int cloudmail_amazonses_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);
QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);
Default Value
""
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
Data Type
String
SSLProvider Property (AmazonSES Class)
This specifies the SSL/TLS implementation to use.
Syntax
ANSI (Cross Platform) int GetSSLProvider();
int SetSSLProvider(int iSSLProvider); Unicode (Windows) INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);
Possible Values
SSLP_AUTOMATIC(0),
SSLP_PLATFORM(1),
SSLP_INTERNAL(2)
int cloudmail_amazonses_getsslprovider(void* lpObj);
int cloudmail_amazonses_setsslprovider(void* lpObj, int iSSLProvider);
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);
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:
0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
1 (sslpPlatform) | Uses the platform/system implementation. |
2 (sslpInternal) | Uses the internal implementation. |
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
SSLServerCertEncoded Property (AmazonSES Class)
This is the certificate (PEM/Base64 encoded).
Syntax
ANSI (Cross Platform) int GetSSLServerCertEncoded(char* &lpSSLServerCertEncoded, int &lenSSLServerCertEncoded); Unicode (Windows) INT GetSSLServerCertEncoded(LPSTR &lpSSLServerCertEncoded, INT &lenSSLServerCertEncoded);
int cloudmail_amazonses_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);
QByteArray GetSSLServerCertEncoded();
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.
When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.
This property is read-only and not available at design time.
Data Type
Binary String
Subject Property (AmazonSES Class)
The subject of the mail message (optional).
Syntax
ANSI (Cross Platform) char* GetSubject();
int SetSubject(const char* lpszSubject); Unicode (Windows) LPWSTR GetSubject();
INT SetSubject(LPCWSTR lpszSubject);
char* cloudmail_amazonses_getsubject(void* lpObj);
int cloudmail_amazonses_setsubject(void* lpObj, const char* lpszSubject);
QString GetSubject();
int SetSubject(QString qsSubject);
Default Value
""
Remarks
The string in this property is sent with a Subject SMTP header to the mail recipient.
If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 822 specifications.
Data Type
String
Timeout Property (AmazonSES Class)
A timeout for the class.
Syntax
ANSI (Cross Platform) int GetTimeout();
int SetTimeout(int iTimeout); Unicode (Windows) INT GetTimeout();
INT SetTimeout(INT iTimeout);
int cloudmail_amazonses_gettimeout(void* lpObj);
int cloudmail_amazonses_settimeout(void* lpObj, int iTimeout);
int GetTimeout();
int SetTimeout(int iTimeout);
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.
Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.
The default value for the Timeout property is 60 seconds.
Data Type
Integer
AddAttachment Method (AmazonSES Class)
This adds FileName as an attachment.
Syntax
ANSI (Cross Platform) int AddAttachment(const char* lpszFileName); Unicode (Windows) INT AddAttachment(LPCWSTR lpszFileName);
int cloudmail_amazonses_addattachment(void* lpObj, const char* lpszFileName);
int AddAttachment(const QString& qsFileName);
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";
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Config Method (AmazonSES Class)
Sets or retrieves a configuration setting.
Syntax
ANSI (Cross Platform) char* Config(const char* lpszConfigurationString); Unicode (Windows) LPWSTR Config(LPCWSTR lpszConfigurationString);
char* cloudmail_amazonses_config(void* lpObj, const char* lpszConfigurationString);
QString Config(const QString& qsConfigurationString);
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.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
DeleteIdentity Method (AmazonSES Class)
Deletes the identity.
Syntax
ANSI (Cross Platform) int DeleteIdentity(const char* lpszIdentity); Unicode (Windows) INT DeleteIdentity(LPCWSTR lpszIdentity);
int cloudmail_amazonses_deleteidentity(void* lpObj, const char* lpszIdentity);
int DeleteIdentity(const QString& qsIdentity);
Remarks
This method deletes the identity specified by Identity.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
DoEvents Method (AmazonSES Class)
Processes events from the internal message queue.
Syntax
ANSI (Cross Platform) int DoEvents(); Unicode (Windows) INT DoEvents();
int cloudmail_amazonses_doevents(void* lpObj);
int DoEvents();
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.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
GetIdentityAttributes Method (AmazonSES Class)
Gets the attributes of the given identity.
Syntax
ANSI (Cross Platform) int GetIdentityAttributes(const char* lpszIdentity, int iAttributeType); Unicode (Windows) INT GetIdentityAttributes(LPCWSTR lpszIdentity, INT iAttributeType);
int cloudmail_amazonses_getidentityattributes(void* lpObj, const char* lpszIdentity, int iAttributeType);
int GetIdentityAttributes(const QString& qsIdentity, int iAttributeType);
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:
AttributeType | Meaning |
0 | Notification |
1 | Verification |
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.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
GetSendQuota Method (AmazonSES Class)
Gets send quota information.
Syntax
ANSI (Cross Platform) int GetSendQuota(); Unicode (Windows) INT GetSendQuota();
int cloudmail_amazonses_getsendquota(void* lpObj);
int GetSendQuota();
Remarks
This method gets the current send quota information. The following properties will be populated with information from the response:
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
GetSendStatistics Method (AmazonSES Class)
Gets the user's sending statistics.
Syntax
ANSI (Cross Platform) int GetSendStatistics(); Unicode (Windows) INT GetSendStatistics();
int cloudmail_amazonses_getsendstatistics(void* lpObj);
int GetSendStatistics();
Remarks
This method gets the users sending statistics. The server will return a set of data points with information about the user's sending activity. Each data point represents a 15 minute interval of sending activity.
The following properties will be populated for each data point.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
GetXValue Method (AmazonSES Class)
Retrieves a valid XPath expression from the HTTP response after calling SendCustomRequest .
Syntax
ANSI (Cross Platform) char* GetXValue(const char* lpszXPath); Unicode (Windows) LPWSTR GetXValue(LPCWSTR lpszXPath);
char* cloudmail_amazonses_getxvalue(void* lpObj, const char* lpszXPath);
QString GetXValue(const QString& qsXPath);
Remarks
This method allows a user to retrieve a valid XPath expression from the HTTP response after calling SendCustomRequest.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
Interrupt Method (AmazonSES Class)
Interrupt the current method.
Syntax
ANSI (Cross Platform) int Interrupt(); Unicode (Windows) INT Interrupt();
int cloudmail_amazonses_interrupt(void* lpObj);
int Interrupt();
Remarks
If there is no method in progress, Interrupt simply returns, doing nothing.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
ListIdentities Method (AmazonSES Class)
Lists the identities of the given type.
Syntax
ANSI (Cross Platform) int ListIdentities(int iIdentityType); Unicode (Windows) INT ListIdentities(INT iIdentityType);
int cloudmail_amazonses_listidentities(void* lpObj, int iIdentityType);
int ListIdentities(int iIdentityType);
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:
IdentityType | Meaning |
0 | |
1 | Domain |
2 | Both Email and Domain |
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.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Reset Method (AmazonSES Class)
Resets request-related properties.
Syntax
ANSI (Cross Platform) int Reset(); Unicode (Windows) INT Reset();
int cloudmail_amazonses_reset(void* lpObj);
int Reset();
Remarks
Calling this method will reset the component to the original state.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Send Method (AmazonSES Class)
Sends the message.
Syntax
ANSI (Cross Platform) int Send(); Unicode (Windows) INT Send();
int cloudmail_amazonses_send(void* lpObj);
int Send();
Remarks
This method sends the message specified by MessageHTML or MessageText.
Example (Send an Email)
component.AccessKey = "my access key";
component.SecretKey = "my secret key";
component.From = "verified.email@host.com";
component.SendTo = "recipient@mail.com";
component.Subject = "Test SES Email";
component.MessageHTML = "<html><body><b>Hello World!</b></body></html>";
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SendCustomRequest Method (AmazonSES Class)
Allows the sending of a custom request to an Amazon web service.
Syntax
ANSI (Cross Platform) char* SendCustomRequest(const char* lpszUrl, const char* lpszRequestData, const char* lpszOtherHeaders); Unicode (Windows) LPWSTR SendCustomRequest(LPCWSTR lpszUrl, LPCWSTR lpszRequestData, LPCWSTR lpszOtherHeaders);
char* cloudmail_amazonses_sendcustomrequest(void* lpObj, const char* lpszUrl, const char* lpszRequestData, const char* lpszOtherHeaders);
QString SendCustomRequest(const QString& qsUrl, const QString& qsRequestData, const QString& qsOtherHeaders);
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",
"");
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
SetAttachmentInStream Method (AmazonSES Class)
Sets an attachment using a stream.
Syntax
ANSI (Cross Platform) int SetAttachmentInStream(int iIndex, CloudMailStream* sInputStream); Unicode (Windows) INT SetAttachmentInStream(INT iIndex, CloudMailStream* sInputStream);
int cloudmail_amazonses_setattachmentinstream(void* lpObj, int iIndex, CloudMailStream* sInputStream);
int SetAttachmentInStream(int iIndex, CloudMailStream* sInputStream);
Remarks
This method allows for setting an attachment in the Attachments* properties through a stream using the InputStream parameter. The Index parameter specifies which attachment in the Attachments* properties the stream will affect.
Note: When multiple attachment sources are provided, the class prioritizes the input stream first, followed by the file path and finally the raw data.
Example
component.Attachments.Add(new FileAttachment("attachment1.txt"));
component.SetAttachmentInStream(0, new FileStream("C:\attachment1.txt", FileMode.Open));
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SetIdentityFeedbackForwarding Method (AmazonSES Class)
Enables or Disables feedback forwarding for the identity.
Syntax
ANSI (Cross Platform) int SetIdentityFeedbackForwarding(const char* lpszIdentity, int bForwardingEnabled); Unicode (Windows) INT SetIdentityFeedbackForwarding(LPCWSTR lpszIdentity, BOOL bForwardingEnabled);
int cloudmail_amazonses_setidentityfeedbackforwarding(void* lpObj, const char* lpszIdentity, int bForwardingEnabled);
int SetIdentityFeedbackForwarding(const QString& qsIdentity, bool bForwardingEnabled);
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.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SetIdentityNotificationTopic Method (AmazonSES Class)
Sets the Bounce or Complaint notification topic for an identity.
Syntax
ANSI (Cross Platform) int SetIdentityNotificationTopic(const char* lpszIdentity, int iNotificationType, const char* lpszSnsTopic); Unicode (Windows) INT SetIdentityNotificationTopic(LPCWSTR lpszIdentity, INT iNotificationType, LPCWSTR lpszSnsTopic);
int cloudmail_amazonses_setidentitynotificationtopic(void* lpObj, const char* lpszIdentity, int iNotificationType, const char* lpszSnsTopic);
int SetIdentityNotificationTopic(const QString& qsIdentity, int iNotificationType, const QString& qsSnsTopic);
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:
NotificationType | Meaning |
0 | Bounce Notifications |
1 | Complaint Notifications |
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.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SetMessageHTMLStream Method (AmazonSES Class)
This method sets the stream from which the class will read the HTML version of the message.
Syntax
ANSI (Cross Platform) int SetMessageHTMLStream(CloudMailStream* sMessageStream); Unicode (Windows) INT SetMessageHTMLStream(CloudMailStream* sMessageStream);
int cloudmail_amazonses_setmessagehtmlstream(void* lpObj, CloudMailStream* sMessageStream);
int SetMessageHTMLStream(CloudMailStream* sMessageStream);
Remarks
This method sets the stream from which the class will read the HTML version of the message. Once set, the class reads the content of the stream and populates the MessageHTML property with the HTML version of the message. The corresponding plaintext version is provided in the MessageText property.
When this property is called, 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.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
VerifyDomain Method (AmazonSES Class)
Verifies a domain.
Syntax
ANSI (Cross Platform) char* VerifyDomain(const char* lpszIdentity); Unicode (Windows) LPWSTR VerifyDomain(LPCWSTR lpszIdentity);
char* cloudmail_amazonses_verifydomain(void* lpObj, const char* lpszIdentity);
QString VerifyDomain(const QString& qsIdentity);
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.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
VerifyEmail Method (AmazonSES Class)
Verifies an email address.
Syntax
ANSI (Cross Platform) int VerifyEmail(const char* lpszIdentity); Unicode (Windows) INT VerifyEmail(LPCWSTR lpszIdentity);
int cloudmail_amazonses_verifyemail(void* lpObj, const char* lpszIdentity);
int VerifyEmail(const QString& qsIdentity);
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 Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Error Event (AmazonSES Class)
Fired when information is available about errors during data delivery.
Syntax
ANSI (Cross Platform) virtual int FireError(AmazonSESErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } AmazonSESErrorEventParams;
Unicode (Windows) virtual INT FireError(AmazonSESErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } AmazonSESErrorEventParams;
#define EID_AMAZONSES_ERROR 1 virtual INT CLOUDMAIL_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
class AmazonSESErrorEventParams { public: int ErrorCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Error(AmazonSESErrorEventParams *e);
// Or, subclass AmazonSES and override this emitter function. virtual int FireError(AmazonSESErrorEventParams *e) {...}
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 (AmazonSES Class)
Fired for every identity when ListIdentities is called.
Syntax
ANSI (Cross Platform) virtual int FireIdentityList(AmazonSESIdentityListEventParams *e);
typedef struct {
const char *Identity; int reserved; } AmazonSESIdentityListEventParams;
Unicode (Windows) virtual INT FireIdentityList(AmazonSESIdentityListEventParams *e);
typedef struct {
LPCWSTR Identity; INT reserved; } AmazonSESIdentityListEventParams;
#define EID_AMAZONSES_IDENTITYLIST 2 virtual INT CLOUDMAIL_CALL FireIdentityList(LPSTR &lpszIdentity);
class AmazonSESIdentityListEventParams { public: const QString &Identity(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void IdentityList(AmazonSESIdentityListEventParams *e);
// Or, subclass AmazonSES and override this emitter function. virtual int FireIdentityList(AmazonSESIdentityListEventParams *e) {...}
Remarks
This event fires for each identity when ListIdentities is called. The Identity parameter will contain either an email address or domain depending on the parameter specified in the call to ListIdentities.
Identities will also be populated.
Log Event (AmazonSES Class)
This event fires once for each log message.
Syntax
ANSI (Cross Platform) virtual int FireLog(AmazonSESLogEventParams *e);
typedef struct {
int LogLevel;
const char *Message;
const char *LogType; int reserved; } AmazonSESLogEventParams;
Unicode (Windows) virtual INT FireLog(AmazonSESLogEventParams *e);
typedef struct {
INT LogLevel;
LPCWSTR Message;
LPCWSTR LogType; INT reserved; } AmazonSESLogEventParams;
#define EID_AMAZONSES_LOG 3 virtual INT CLOUDMAIL_CALL FireLog(INT &iLogLevel, LPSTR &lpszMessage, LPSTR &lpszLogType);
class AmazonSESLogEventParams { public: int LogLevel(); const QString &Message(); const QString &LogType(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Log(AmazonSESLogEventParams *e);
// Or, subclass AmazonSES and override this emitter function. virtual int FireLog(AmazonSESLogEventParams *e) {...}
Remarks
This event fires 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:
0 (None) | No events are logged. |
1 (Info - default) | Informational events are logged. |
2 (Verbose) | Detailed data are logged. |
3 (Debug) | Debug data are logged. |
The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.
The value 2 (Verbose) logs additional information about the request and response.
The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).
Message is the log entry.
LogType identifies the type of log entry. Possible values are as follows:
- "Info"
- "RequestHeaders"
- "ResponseHeaders"
- "RequestBody"
- "ResponseBody"
- "ProxyRequest"
- "ProxyResponse"
- "FirewallRequest"
- "FirewallResponse"
SSLServerAuthentication Event (AmazonSES Class)
Fired after the server presents its certificate to the client.
Syntax
ANSI (Cross Platform) virtual int FireSSLServerAuthentication(AmazonSESSSLServerAuthenticationEventParams *e);
typedef struct {
const char *CertEncoded; int lenCertEncoded;
const char *CertSubject;
const char *CertIssuer;
const char *Status;
int Accept; int reserved; } AmazonSESSSLServerAuthenticationEventParams;
Unicode (Windows) virtual INT FireSSLServerAuthentication(AmazonSESSSLServerAuthenticationEventParams *e);
typedef struct {
LPCSTR CertEncoded; INT lenCertEncoded;
LPCWSTR CertSubject;
LPCWSTR CertIssuer;
LPCWSTR Status;
BOOL Accept; INT reserved; } AmazonSESSSLServerAuthenticationEventParams;
#define EID_AMAZONSES_SSLSERVERAUTHENTICATION 4 virtual INT CLOUDMAIL_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);
class AmazonSESSSLServerAuthenticationEventParams { public: const QByteArray &CertEncoded(); const QString &CertSubject(); const QString &CertIssuer(); const QString &Status(); bool Accept(); void SetAccept(bool bAccept); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SSLServerAuthentication(AmazonSESSSLServerAuthenticationEventParams *e);
// Or, subclass AmazonSES and override this emitter function. virtual int FireSSLServerAuthentication(AmazonSESSSLServerAuthenticationEventParams *e) {...}
Remarks
During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.
When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.
SSLStatus Event (AmazonSES Class)
Fired when secure connection progress messages are available.
Syntax
ANSI (Cross Platform) virtual int FireSSLStatus(AmazonSESSSLStatusEventParams *e);
typedef struct {
const char *Message; int reserved; } AmazonSESSSLStatusEventParams;
Unicode (Windows) virtual INT FireSSLStatus(AmazonSESSSLStatusEventParams *e);
typedef struct {
LPCWSTR Message; INT reserved; } AmazonSESSSLStatusEventParams;
#define EID_AMAZONSES_SSLSTATUS 5 virtual INT CLOUDMAIL_CALL FireSSLStatus(LPSTR &lpszMessage);
class AmazonSESSSLStatusEventParams { public: const QString &Message(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SSLStatus(AmazonSESSSLStatusEventParams *e);
// Or, subclass AmazonSES and override this emitter function. virtual int FireSSLStatus(AmazonSESSSLStatusEventParams *e) {...}
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
CloudMailStream Type
Syntax
CloudMailStream (declared in cloudmail.h)
Remarks
The AmazonSES class includes one or more API members that take a stream object as a parameter. To use such API members, create a concrete class that implements the CloudMailStream interface and pass the AmazonSES class an instance of that concrete class.
When implementing the CloudMailStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur.
Config Settings (AmazonSES Class)
The class accepts one or more of the following configuration settings. Configuration 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.SES Config Settings
This describes the API version as defined by the service of the current protocol. The default is set to the version that the class was designed around, but may be changed to a different version.
Amazon defines each version as the date it was released. An example is: "2009-07-15".
The following methods are supported: GET,PUT,HEAD,POST and DELETE and are only used when SendCustomRequest is called. The default value is "" (empty string) in which case the default HTTP methods are used (more details about the default behavior can be found on the SendCustomRequest page).
This setting indicates whether or not the results from a call to ListIdentities are paged.
This setting controls the maximum number of identities that will be returned from a call to ListIdentities. This value is sent to Amazon and the results will be paged according to this limit. Possible value are from 1 to 100 inclusive. The default value is 100.
By default the class will automatically set the date to the current time when sending. To manually specify the date you may use this setting. This sets the value of the SMTP Date header. RFC 822 contains detailed date format specifications. An example of a valid date is "Fri, 1 Mar 12 21:24:52 EST".
By default the class will automatically set the MessageId. If you wish to specify your own value set this here. This sets the value of the Message-ID header.
When set with a MIME message, the Send method will use the MIME message rather than the Message* properties.
component.Config("MIMEMessage" + MIME_MESSAGE);
component.Send();
When MessageHTML is set the class will automatically create a corresponding plaintext part if this value is True. Set this value to False to prevent the class from parsing the HTML and creating a plaintext part. The default value is True.
This setting controls the priority of the message being sent. Possible values are:
Priority | Meaning |
0 (default) | Unspecified |
1 | Normal |
2 | Urgent |
3 | Non-Urgent |
This property controls which region the class will make requests against. By default the class uses us-east-1, the US East (N. Virginia) region. This property should be changed to create or access resources in other regions.
Regions:
Value | Region |
us-east-1 (Default) | US East (N. Virginia) |
us-east-2 | US East (Ohio) |
us-west-1 | US West (N. California) |
us-west-2 | US West (Oregon) |
ap-east-1 | Asia Pacific (Hong Kong) |
ap-northeast-1 | Asia Pacific (Tokyo) |
ap-northeast-2 | Asia Pacific (Seoul) |
ap-northeast-3 | Asia Pacific (Osaka-Local) |
ap-south-1 | Asia Pacific (Mumbai) |
ap-southeast-1 | Asia Pacific (Singapore) |
ap-southeast-2 | Asia Pacific (Sydney) |
ca-central-1 | Canada (Central) |
cn-north-1 | China (Beijing) |
cn-northwest-1 | China (Ningxia) |
eu-central-1 | Europe (Frankfurt) |
eu-north-1 | Europe (Stockholm) |
eu-south-1 | Europe (Milan) |
eu-west-1 | Europe (Ireland) |
eu-west-2 | Europe (London) |
eu-west-3 | Europe (Paris) |
me-south-1 | Middle East (Bahrain) |
sa-east-1 | South America (Sao Paulo) |
The class will always convert this property's value to lowercase. If this property is cleared, the class will reset it to the default value.
By default, this configuration is True, and when SendCustomRequest is called the class will sign the specified request to authenticate with the service. If set to False, the request will be sent as is, without signing.
By default, the class uses the service's URL. Setting this config will override this value.
The XPath setting allows you to point to specific elements in the XML or JSON response.
XPath Syntax
XPath syntax is available for both XML and JSON documents. An XPath is a series of one or more element accessors separated by the / character, for example: /A/B/C/D. An XPath can be absolute (i.e., it starts with /), or it can be relative to the current XPath location.
The following are possible values for an element accessor, which operates relative to the current location specified by the XPath accessors which proceed it in the overall XPath string:
Accessor | Description |
name | The first element with a particular name. Can be *. |
[i] | The i-th element. |
name[i] | The i-th element with a particular name. |
[last()] | The last element. |
[last()-i] | The element i before the last element. |
name[@attrname="attrvalue"] | The first element with a particular name that contains the specified attribute-value pair.
Supports single and double quotes. (XML Only) |
. | The current element. |
.. | The parent element. |
XPath Examples
Assuming the following XML response:
<firstlevel> <one>value</one> <two> <item>first</item> <item>second</item> </two> <three>value three</three> </firstlevel>
Or, alternatively, the following JSON response:
{ "firstlevel": { "one": "value", "two": ["first", "second"], "three": "value three" } }
Here are some examples of valid XPaths:
Description | XML XPath | JSON XPath |
Document root | / | /json |
Specific element | /firstlevel/one | /json/firstlevel/one |
i-th child | /firstlevel/two/item[2] | /json/firstlevel/two/[2] |
This is not an exhaustive list by any means, but should provide a general idea of the possibilities.
Provides the inner text of the current element.
The current element is specified in the XPath configuration setting. This configuration setting is read-only.
HTTP Config Settings
When AllowHTTPCompression is True, the class adds an Accept-Encoding header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the Accept-Encoding header. Note: The class only supports gzip and deflate decompression algorithms.
This configuration setting enables HTTP compression for receiving data. When set to True (default), the class will accept compressed data. It then will uncompress the data it has received. The class will handle data compressed by both gzip and deflate compression algorithms.
When True, the class adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate".
The default value is True.
This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when HTTPVersion is set to "2.0".
If set to True (default), the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class fails with an error if the server does not support HTTP/2.
The default value is True.
This configuration setting determines whether data will be appended when writing to LocalFile. When set to True, downloaded data will be appended to LocalFile. This may be used in conjunction with Range to resume a failed download. This is applicable only when LocalFile is set. The default value is False.
If the Authorization property contains a nonempty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.
This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.
The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".
This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the Transfer event, by BytesTransferred.
This is applicable only when UseChunkedEncoding is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384.
If set to True, the body of a PUT or POST request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request.
The default value is False.
If set to True, the URL passed to the class will be URL encoded. The default value is False.
This option determines what happens when the server issues a redirect. Normally, the class returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new URL for the object is retrieved automatically every time.
If this property is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same; otherwise, the class fails with an error.
Note: Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.
Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.
A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).
The default value is 0 (Never). In this case, redirects are never followed, and the class fails with an error instead.
Following are the valid options:
- 0 - Never
- 1 - Always
- 2 - Same Scheme
The default value is False. If set to True, the class will perform a GET on the new location. Otherwise, it will use the same HTTP method again.
HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names.
This property specifies the HTTP version used by the class. Possible values are as follows:
- "1.0"
- "1.1" (default)
- "2.0"
- "3.0"
When using HTTP/2 ("2.0"), additional restrictions apply. Please see the following notes for details.
HTTP/2 Notes
When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.
If the server does not support HTTP/2, the class will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.
HTTP/3 Notes
HTTP/3 is supported only in .NET and Java.
When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.
If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception
The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:
Sat, 29 Oct 2017 19:43:31 GMT.
If true, the component will not send the Connection: Close header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. Note: Not all servers support persistent connections. If false, the connection will be closed immediately after the server response is received.
The default value for KeepAlive is false.
If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here.
This configuration setting controls the level of detail that is logged through the Log event. Possible values are as follows:
0 (None) | No events are logged. |
1 (Info - default) | Informational events are logged. |
2 (Verbose) | Detailed data are logged. |
3 (Debug) | Debug data are logged. |
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).
When FollowRedirects is set to any value other than frNever, the class will follow redirects until this maximum number of redirect attempts are made. The default value is 20.
This configuration setting may be queried after the request is complete to indicate the HTTP version used. When HTTPVersion is set to "2.0" (if the server does not support "2.0"), then the class will fall back to using "1.1" automatically. This setting will indicate which version was used.
This configuration setting can be set to a string of headers to be appended to the HTTP request headers.
The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .
Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail.
This configuration setting is useful for extending the functionality of the class beyond what is provided.
This is similar to the Authorization configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a Proxy-Authorization HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If ProxyUser and ProxyPassword are specified, this value is calculated using the algorithm specified by ProxyAuthScheme.
This configuration setting is provided for use by classs that do not directly expose Proxy properties.
This configuration setting is provided for use by classs that do not directly expose Proxy properties.
This configuration setting is provided for use by classs that do not directly expose Proxy properties.
This configuration setting is provided for use by classs that do not directly expose Proxy properties.
This configuration setting is provided for use by classs that do not directly expose Proxy properties.
This configuration setting returns the complete set of raw headers as sent by the client.
This configuration setting contains the result code of the last response from the server.
This setting contains the first line of the last response from the server. The format of the line will be [HTTP version] [Result Code] [Description].
This configuration setting contains the contents of the last response from the server.
If TransferredDataLimit is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the class.
This configuration setting returns the complete set of raw headers as received from the server.
This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request:
.NET
Http http = new Http();
http.Config("TransferredRequest=on");
http.PostData = "body";
http.Post("http://someserver.com");
Console.WriteLine(http.Config("TransferredRequest"));
C++
HTTP http;
http.Config("TransferredRequest=on");
http.SetPostData("body", 5);
http.Post("http://someserver.com");
printf("%s\r\n", http.Config("TransferredRequest"));
If UseChunkedEncoding is set to True, the class will use HTTP-chunked encoding when posting, if possible. HTTP-chunked encoding allows large files to be sent in chunks instead of all at once. If set to False, the class will not use HTTP-chunked encoding. The default value is False.
Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.
This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name).
The default value is False and the hostname will always be used exactly as specified. Note: The CodePage setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set CodePage to 65001. In the C++ Edition for Windows, the *W version of the class must be used. For instance, DNSW or HTTPW.
When using this configuration setting, if True, the component will use the default HTTP client for the platform (URLConnection in Java, WebRequest in .NET, or CFHTTPMessage in Mac/iOS) instead of the internal HTTP implementation. This is important for environments in which direct access to sockets is limited or not allowed (e.g., in the Google AppEngine).
Note: This setting is applicable only to Mac/iOS editions.
This configuration specifies whether the class will attempt to use the Proxy auto-config URL when establishing a connection and ProxyAutoDetect is set to True.
When True (default), the class will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.
This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com".
Override the default with the name and version of your software.
TCPClient Config Settings
When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use Timeout for establishing a connection and transmitting/receiving data.
This configuration setting is provided for use by classs that do not directly expose Firewall properties.
If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.
If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
The FirewallPort is set automatically when FirewallType is set to a valid value.
Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.
The appropriate values are as follows:
0 | No firewall (default setting). |
1 | Connect through a tunneling proxy. FirewallPort is set to 80. |
2 | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
3 | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
10 | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the class fails with an error.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.
Note: This value is not applicable in macOS.
When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the number of times that the keep-alive packets will be sent before the remote host is considered disconnected. The system default if this value is not specified here is 9.
Note: This configuration setting is only available in the Unix platform. It is not supported in masOS or FreeBSD.
When set, TCPKeepAlive will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.
This property controls how a connection is closed. The default is True.
In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.
In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.
The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).
Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.
LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.
The LocalHost setting contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.
In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.
If the class is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).
This must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.
LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.
This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.
MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL string.
If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.
If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.
The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.
This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.
This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:
www.google.com;www.nsoftware.com
If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets.
Note: This value is not applicable in Java.
When true, the socket will send all data that is ready to send at once. When false, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.
By default, this config is set to false.
When set to 0 (default), the class will use IPv4 exclusively. When set to 1, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0. Possible values are:
0 | IPv4 Only |
1 | IPv6 Only |
2 | IPv6 with IPv4 fallback |
SSL Config Settings
When SSLProvider is set to Internal, this setting controls whether SSL packets should be logged. By default, this setting is False, as it is only useful for debugging purposes.
When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.
Enabling this setting has no effect if SSLProvider is set to Platform.
This functionality is available only when the provider is OpenSSL.
The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g. 9d66eef0.0, 9d66eef0.1 etc). OpenSSL recommends to use the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
This functionality is available only when the provider is OpenSSL.
The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by
-----BEGIN CERTIFICATE-----
... (CA certificate in base64 encoding) ...
-----END CERTIFICATE-----
sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
This functionality is available only when the provider is OpenSSL.
The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".
This functionality is available only when the provider is OpenSSL.
By default OpenSSL uses the device file "/dev/urandom" to seed the PRNG and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.
If set to true, the class will reuse the context if and only if the following criteria are met:
- The target host name is the same.
- The system cache entry has not expired (default timeout is 10 hours).
- The application process that calls the function is the same.
- The logon session is the same.
- The instance of the class is the same.
This setting specifies the paths on disk to CA certificate files on Unix/Linux.
The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.
The default value is:
/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem
This setting specifies one or more CA certificates to be included in the request when performing SSL client authentication. Some servers require the entire chain, including CA certificates, to be presented when performing SSL client authentication. The value of this setting is a newline (CrLf) separated list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
This minimum cipher strength largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.
Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.
Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.
When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList config setting.
The enabled cipher suites to be used in SSL negotiation.
By default, the enabled cipher suites will include all available ciphers ("*").
The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.
Multiple cipher suites are separated by semicolons.
Example values when SSLProvider is set to Platform:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
Possible values when SSLProvider is set to Platform include:
- CALG_3DES
- CALG_3DES_112
- CALG_AES
- CALG_AES_128
- CALG_AES_192
- CALG_AES_256
- CALG_AGREEDKEY_ANY
- CALG_CYLINK_MEK
- CALG_DES
- CALG_DESX
- CALG_DH_EPHEM
- CALG_DH_SF
- CALG_DSS_SIGN
- CALG_ECDH
- CALG_ECDH_EPHEM
- CALG_ECDSA
- CALG_ECMQV
- CALG_HASH_REPLACE_OWF
- CALG_HUGHES_MD5
- CALG_HMAC
- CALG_KEA_KEYX
- CALG_MAC
- CALG_MD2
- CALG_MD4
- CALG_MD5
- CALG_NO_SIGN
- CALG_OID_INFO_CNG_ONLY
- CALG_OID_INFO_PARAMETERS
- CALG_PCT1_MASTER
- CALG_RC2
- CALG_RC4
- CALG_RC5
- CALG_RSA_KEYX
- CALG_RSA_SIGN
- CALG_SCHANNEL_ENC_KEY
- CALG_SCHANNEL_MAC_KEY
- CALG_SCHANNEL_MASTER_HASH
- CALG_SEAL
- CALG_SHA
- CALG_SHA1
- CALG_SHA_256
- CALG_SHA_384
- CALG_SHA_512
- CALG_SKIPJACK
- CALG_SSL2_MASTER
- CALG_SSL3_MASTER
- CALG_SSL3_SHAMD5
- CALG_TEK
- CALG_TLS1_MASTER
- CALG_TLS1PRF
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA");
Possible values when SSLProvider is set to Internal include:
- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
- TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
- TLS_DH_RSA_WITH_AES_128_GCM_SHA256 (Not Recommended)
- TLS_DH_RSA_WITH_AES_256_GCM_SHA384 (Not Recommended)
- TLS_DH_DSS_WITH_AES_128_GCM_SHA256 (Not Recommended)
- TLS_DH_DSS_WITH_AES_256_GCM_SHA384 (Not Recommended)
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_DES_CBC_SHA
- TLS_DHE_RSA_WITH_DES_CBC_SHA
- TLS_DHE_DSS_WITH_DES_CBC_SHA
- TLS_RSA_WITH_RC4_128_MD5
- TLS_RSA_WITH_RC4_128_SHA
When TLS 1.3 is negotiated (see SSLEnabledProtocols) only the following cipher suites are supported:
- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256
SSLEnabledCipherSuites is used together with SSLCipherStrength.
Used to enable/disable the supported security protocols.
Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:
TLS1.3 | 12288 (Hex 3000) |
TLS1.2 | 3072 (Hex C00) (Default) |
TLS1.1 | 768 (Hex 300) (Default) |
TLS1 | 192 (Hex C0) (Default) |
SSL3 | 48 (Hex 30) [Platform Only] |
SSL2 | 12 (Hex 0C) [Platform Only] |
SSLEnabledProtocols - TLS 1.3 Notes
By default when TLS 1.3 is enabled the class will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.
In editions which are designed to run on Windows SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is only supported on Windows 11 / Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.
If set to 1 (Platform provider) please be aware of the following notes:
- The platform provider is only available on Windows 11 / Windows Server 2022 and up.
- SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
- If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2 the above restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.
SSLEnabledProtocols: SSL2 and SSL3 Notes:
SSL 2.0 and 3.0 are not supported by the class when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.
This setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This setting is true by default, but can be set to false to disable the extension.
This setting is only applicable when SSLProvider is set to Internal.
This setting specifies whether the Encoded parameter of the SSLServerAuthentication event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the SSLServerAuthentication event.
If set to True all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.
This setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.
When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffice for debugging purposes. When writing to this file the class will only append, it will not overwrite previous values.
Note: This setting is only applicable when SSLProvider is set to Internal.
Returns the cipher suite negotiated during the SSL handshake.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Returns the strength of the cipher suite negotiated during the SSL handshake.
Note: For server components (e.g.TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Returns the cipher suite negotiated during the SSL handshake represented as a single string.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Returns the key exchange algorithm negotiated during the SSL handshake.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Returns the strenghth of the key exchange algorithm negotiated during the SSL handshake.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Returns the protocol version negotiated during the SSL handshake.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
The following flags are defined (specified in hexadecimal notation). They can be or-ed together to exclude multiple conditions:
0x00000001 | Ignore time validity status of certificate. |
0x00000002 | Ignore time validity status of CTL. |
0x00000004 | Ignore non-nested certificate times. |
0x00000010 | Allow unknown Certificate Authority. |
0x00000020 | Ignore wrong certificate usage. |
0x00000100 | Ignore unknown certificate revocation status. |
0x00000200 | Ignore unknown CTL signer revocation status. |
0x00000400 | Ignore unknown Certificate Authority revocation status. |
0x00000800 | Ignore unknown Root revocation status. |
0x00008000 | Allow test Root certificate. |
0x00004000 | Trust test Root certificate. |
0x80000000 | Ignore non-matching CN (certificate CN not-matching server name). |
This functionality is currently not available when the provider is OpenSSL.
This setting optionally specifies one or more CA certificates to be used when verifying the server certificate. When verifying the server's certificate the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This setting should only be set if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.
The value of this setting is a newline (CrLf) separated list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
This setting specifies the allowed server certificate signature algorithms when SSLProvider is set to Internal and SSLEnabledProtocols is set to allow TLS 1.2.
When specified the class will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the class fails with an error.
The format of this value is a comma separated list of hash-signature combinations. For instance:
component.SSLProvider = TCPClientSSLProviders.sslpInternal;
component.Config("SSLEnabledProtocols=3072"); //TLS 1.2
component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");
The default value for this setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.
In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.
This setting specifies a comma separated list of named groups used in TLS 1.2 for ECC.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.
When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional round trip during the handshake if the group is supported by the server.
The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting.
Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group.
In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so.
The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448"
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1"
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096"
- "ffdhe_6144"
- "ffdhe_8192"
This setting holds a comma separated list of allowed signature algorithms. Possible values are:
- "ed25519" (default)
- "ed448" (default)
- "ecdsa_secp256r1_sha256" (default)
- "ecdsa_secp384r1_sha384" (default)
- "ecdsa_secp521r1_sha512" (default)
- "rsa_pkcs1_sha256" (default)
- "rsa_pkcs1_sha384" (default)
- "rsa_pkcs1_sha512" (default)
- "rsa_pss_sha256" (default)
- "rsa_pss_sha384" (default)
- "rsa_pss_sha512" (default)
This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. This setting should only be modified if there is a specific reason to do so.
The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448" (default)
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096" (default)
- "ffdhe_6144" (default)
- "ffdhe_8192" (default)
Socket Config Settings
If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.
Note: This option is not valid for UDP ports.
When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes).
This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. Increasing the value of the OutBufferSize setting can provide significant improvements in performance in some cases.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Base Config Settings
When queried, this setting will return a string containing information about the product's build.
The default code page is Unicode UTF-8 (65001).
The following is a list of valid code page identifiers:
Identifier | Name |
037 | IBM EBCDIC - U.S./Canada |
437 | OEM - United States |
500 | IBM EBCDIC - International |
708 | Arabic - ASMO 708 |
709 | Arabic - ASMO 449+, BCON V4 |
710 | Arabic - Transparent Arabic |
720 | Arabic - Transparent ASMO |
737 | OEM - Greek (formerly 437G) |
775 | OEM - Baltic |
850 | OEM - Multilingual Latin I |
852 | OEM - Latin II |
855 | OEM - Cyrillic (primarily Russian) |
857 | OEM - Turkish |
858 | OEM - Multilingual Latin I + Euro symbol |
860 | OEM - Portuguese |
861 | OEM - Icelandic |
862 | OEM - Hebrew |
863 | OEM - Canadian-French |
864 | OEM - Arabic |
865 | OEM - Nordic |
866 | OEM - Russian |
869 | OEM - Modern Greek |
870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
875 | IBM EBCDIC - Modern Greek |
932 | ANSI/OEM - Japanese, Shift-JIS |
936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
949 | ANSI/OEM - Korean (Unified Hangul Code) |
950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
1026 | IBM EBCDIC - Turkish (Latin-5) |
1047 | IBM EBCDIC - Latin 1/Open System |
1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
1147 | IBM EBCDIC - France (20297 + Euro symbol) |
1148 | IBM EBCDIC - International (500 + Euro symbol) |
1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
1201 | Unicode UCS-2 Big-Endian |
1250 | ANSI - Central European |
1251 | ANSI - Cyrillic |
1252 | ANSI - Latin I |
1253 | ANSI - Greek |
1254 | ANSI - Turkish |
1255 | ANSI - Hebrew |
1256 | ANSI - Arabic |
1257 | ANSI - Baltic |
1258 | ANSI/OEM - Vietnamese |
1361 | Korean (Johab) |
10000 | MAC - Roman |
10001 | MAC - Japanese |
10002 | MAC - Traditional Chinese (Big5) |
10003 | MAC - Korean |
10004 | MAC - Arabic |
10005 | MAC - Hebrew |
10006 | MAC - Greek I |
10007 | MAC - Cyrillic |
10008 | MAC - Simplified Chinese (GB 2312) |
10010 | MAC - Romania |
10017 | MAC - Ukraine |
10021 | MAC - Thai |
10029 | MAC - Latin II |
10079 | MAC - Icelandic |
10081 | MAC - Turkish |
10082 | MAC - Croatia |
12000 | Unicode UCS-4 Little-Endian |
12001 | Unicode UCS-4 Big-Endian |
20000 | CNS - Taiwan |
20001 | TCA - Taiwan |
20002 | Eten - Taiwan |
20003 | IBM5550 - Taiwan |
20004 | TeleText - Taiwan |
20005 | Wang - Taiwan |
20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
20106 | IA5 German (7-bit) |
20107 | IA5 Swedish (7-bit) |
20108 | IA5 Norwegian (7-bit) |
20127 | US-ASCII (7-bit) |
20261 | T.61 |
20269 | ISO 6937 Non-Spacing Accent |
20273 | IBM EBCDIC - Germany |
20277 | IBM EBCDIC - Denmark/Norway |
20278 | IBM EBCDIC - Finland/Sweden |
20280 | IBM EBCDIC - Italy |
20284 | IBM EBCDIC - Latin America/Spain |
20285 | IBM EBCDIC - United Kingdom |
20290 | IBM EBCDIC - Japanese Katakana Extended |
20297 | IBM EBCDIC - France |
20420 | IBM EBCDIC - Arabic |
20423 | IBM EBCDIC - Greek |
20424 | IBM EBCDIC - Hebrew |
20833 | IBM EBCDIC - Korean Extended |
20838 | IBM EBCDIC - Thai |
20866 | Russian - KOI8-R |
20871 | IBM EBCDIC - Icelandic |
20880 | IBM EBCDIC - Cyrillic (Russian) |
20905 | IBM EBCDIC - Turkish |
20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
20932 | JIS X 0208-1990 & 0121-1990 |
20936 | Simplified Chinese (GB2312) |
21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
21027 | Extended Alpha Lowercase |
21866 | Ukrainian (KOI8-U) |
28591 | ISO 8859-1 Latin I |
28592 | ISO 8859-2 Central Europe |
28593 | ISO 8859-3 Latin 3 |
28594 | ISO 8859-4 Baltic |
28595 | ISO 8859-5 Cyrillic |
28596 | ISO 8859-6 Arabic |
28597 | ISO 8859-7 Greek |
28598 | ISO 8859-8 Hebrew |
28599 | ISO 8859-9 Latin 5 |
28605 | ISO 8859-15 Latin 9 |
29001 | Europa 3 |
38598 | ISO 8859-8 Hebrew |
50220 | ISO 2022 Japanese with no halfwidth Katakana |
50221 | ISO 2022 Japanese with halfwidth Katakana |
50222 | ISO 2022 Japanese JIS X 0201-1989 |
50225 | ISO 2022 Korean |
50227 | ISO 2022 Simplified Chinese |
50229 | ISO 2022 Traditional Chinese |
50930 | Japanese (Katakana) Extended |
50931 | US/Canada and Japanese |
50933 | Korean Extended and Korean |
50935 | Simplified Chinese Extended and Simplified Chinese |
50936 | Simplified Chinese |
50937 | US/Canada and Traditional Chinese |
50939 | Japanese (Latin) Extended and Japanese |
51932 | EUC - Japanese |
51936 | EUC - Simplified Chinese |
51949 | EUC - Korean |
51950 | EUC - Traditional Chinese |
52936 | HZ-GB2312 Simplified Chinese |
54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
57002 | ISCII Devanagari |
57003 | ISCII Bengali |
57004 | ISCII Tamil |
57005 | ISCII Telugu |
57006 | ISCII Assamese |
57007 | ISCII Oriya |
57008 | ISCII Kannada |
57009 | ISCII Malayalam |
57010 | ISCII Gujarati |
57011 | ISCII Punjabi |
65000 | Unicode UTF-7 |
65001 | Unicode UTF-8 |
Identifier | Name |
1 | ASCII |
2 | NEXTSTEP |
3 | JapaneseEUC |
4 | UTF8 |
5 | ISOLatin1 |
6 | Symbol |
7 | NonLossyASCII |
8 | ShiftJIS |
9 | ISOLatin2 |
10 | Unicode |
11 | WindowsCP1251 |
12 | WindowsCP1252 |
13 | WindowsCP1253 |
14 | WindowsCP1254 |
15 | WindowsCP1250 |
21 | ISO2022JP |
30 | MacOSRoman |
10 | UTF16String |
0x90000100 | UTF16BigEndian |
0x94000100 | UTF16LittleEndian |
0x8c000100 | UTF32String |
0x98000100 | UTF32BigEndian |
0x9c000100 | UTF32LittleEndian |
65536 | Proprietary |
When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.
If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.
When set to true, the class will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle FIPS, while all the other Windows editions make use of Microsoft security libraries.
FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to true. This is a static setting which applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.
For more details please see the FIPS 140-2 Compliance article.
Note: This setting is only applicable on Windows.
Note: Enabling FIPS-compliance requires a special license; please contact sales@nsoftware.com for details.
Tells the class whether or not to use FIPS certified APIs.When set to true, the class will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle FIPS, while all the other Windows editions make use of Microsoft security libraries.
FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to true. This is a static setting which applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.
For more details please see the FIPS 140-2 Compliance article.
Note: This setting is only applicable on Windows.
Note: Enabling FIPS-compliance requires a special license; please contact sales@nsoftware.com for details.
When set to true, the class will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle FIPS, while all the other Windows editions make use of Microsoft security libraries.
FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to true. This is a static setting which applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.
For more details please see the FIPS 140-2 Compliance article.
Note: This setting is only applicable on Windows.
Note: Enabling FIPS-compliance requires a special license; please contact sales@nsoftware.com for details.
Tells the class whether or not to use FIPS certified APIs.When set to true, the class will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle FIPS, while all the other Windows editions make use of Microsoft security libraries.
FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to true. This is a static setting which applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.
For more details please see the FIPS 140-2 Compliance article.
Note: This setting is only applicable on Windows.
Note: Enabling FIPS-compliance requires a special license; please contact sales@nsoftware.com for details.
When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.
Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.
On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.
To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.
Trappable Errors (AmazonSES Class)
Error Handling (C++)
Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
SES Errors
601 An error was returned from the server. Please refer to the error message for additional information. | |
602 The cryptographic operation failed. Please see the error message for additional information. | |
603 Invalid SendStatDetail index. | |
604 Invalid Identity index. | |
605 Invalid Identity. | |
606 Invalid Identity type. | |
607 Invalid attribute type. | |
608 Invalid notification type. |
The class may also return one of the following error codes, which are inherited from other classes.
HTTP Errors
118 Firewall Error. Error description contains detailed message. | |
143 Busy executing current method. | |
151 HTTP protocol error. The error message has the server response. | |
152 No server specified in URL | |
153 Specified URLScheme is invalid. | |
155 Range operation is not supported by server. | |
156 Invalid cookie index (out of range). | |
301 Interrupted. | |
302 Can't open AttachedFile. |
The class may also return one of the following error codes, which are inherited from other classes.
TCPClient Errors
100 You cannot change the RemotePort at this time. A connection is in progress. | |
101 You cannot change the RemoteHost (Server) at this time. A connection is in progress. | |
102 The RemoteHost address is invalid (0.0.0.0). | |
104 Already connected. If you want to reconnect, close the current connection first. | |
106 You cannot change the LocalPort at this time. A connection is in progress. | |
107 You cannot change the LocalHost at this time. A connection is in progress. | |
112 You cannot change MaxLineLength at this time. A connection is in progress. | |
116 RemotePort cannot be zero. Please specify a valid service port number. | |
117 You cannot change the UseConnection option while the class is active. | |
135 Operation would block. | |
201 Timeout. | |
211 Action impossible in control's present state. | |
212 Action impossible while not connected. | |
213 Action impossible while listening. | |
301 Timeout. | |
302 Could not open file. | |
434 Unable to convert string to selected CodePage. | |
1105 Already connecting. If you want to reconnect, close the current connection first. | |
1117 You need to connect first. | |
1119 You cannot change the LocalHost at this time. A connection is in progress. | |
1120 Connection dropped by remote host. |
SSL Errors
270 Cannot load specified security library. | |
271 Cannot open certificate store. | |
272 Cannot find specified certificate. | |
273 Cannot acquire security credentials. | |
274 Cannot find certificate chain. | |
275 Cannot verify certificate chain. | |
276 Error during handshake. | |
280 Error verifying certificate. | |
281 Could not find client certificate. | |
282 Could not find server certificate. | |
283 Error encrypting data. | |
284 Error decrypting data. |
TCP/IP Errors
10004 [10004] Interrupted system call. | |
10009 [10009] Bad file number. | |
10013 [10013] Access denied. | |
10014 [10014] Bad address. | |
10022 [10022] Invalid argument. | |
10024 [10024] Too many open files. | |
10035 [10035] Operation would block. | |
10036 [10036] Operation now in progress. | |
10037 [10037] Operation already in progress. | |
10038 [10038] Socket operation on non-socket. | |
10039 [10039] Destination address required. | |
10040 [10040] Message too long. | |
10041 [10041] Protocol wrong type for socket. | |
10042 [10042] Bad protocol option. | |
10043 [10043] Protocol not supported. | |
10044 [10044] Socket type not supported. | |
10045 [10045] Operation not supported on socket. | |
10046 [10046] Protocol family not supported. | |
10047 [10047] Address family not supported by protocol family. | |
10048 [10048] Address already in use. | |
10049 [10049] Can't assign requested address. | |
10050 [10050] Network is down. | |
10051 [10051] Network is unreachable. | |
10052 [10052] Net dropped connection or reset. | |
10053 [10053] Software caused connection abort. | |
10054 [10054] Connection reset by peer. | |
10055 [10055] No buffer space available. | |
10056 [10056] Socket is already connected. | |
10057 [10057] Socket is not connected. | |
10058 [10058] Can't send after socket shutdown. | |
10059 [10059] Too many references, can't splice. | |
10060 [10060] Connection timed out. | |
10061 [10061] Connection refused. | |
10062 [10062] Too many levels of symbolic links. | |
10063 [10063] File name too long. | |
10064 [10064] Host is down. | |
10065 [10065] No route to host. | |
10066 [10066] Directory not empty | |
10067 [10067] Too many processes. | |
10068 [10068] Too many users. | |
10069 [10069] Disc Quota Exceeded. | |
10070 [10070] Stale NFS file handle. | |
10071 [10071] Too many levels of remote in path. | |
10091 [10091] Network subsystem is unavailable. | |
10092 [10092] WINSOCK DLL Version out of range. | |
10093 [10093] Winsock not loaded yet. | |
11001 [11001] Host not found. | |
11002 [11002] Non-authoritative 'Host not found' (try again or check DNS setup). | |
11003 [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP. | |
11004 [11004] Valid name, no data record (check DNS setup). |