IMAP Class

Properties Methods Events Configuration Settings Errors

The IMAP Class is used to communicate with IMAP servers using the IMAP (Internet Message Access) protocol.

Syntax

IMAP

Remarks

The IMAP Class supports both plaintext and SSL/TLS connections (RFC 2595). When connecting over SSL/TLS the SSLServerAuthentication event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the SSL handshake. Additional SSL related settings are also supported via the Config method.

The IMAP Class implements a standard IMAP client as specified in RFC 1730 and RFC 2060.

The first step in using the class is specifying a MailServer, a User to connect as, and a Password to authenticate with. After that, one or more requests may be sent to the server via the class's methods. Results are retrieved through events and a number of key properties.

Normally, after connecting to the server a Mailbox is selected (or examined) using the ExamineMailbox method. After the Mailbox is selected, MessageCount and RecentMessageCount show the number of messages in the mailbox, and MailboxFlags show the flags pertaining to the mailbox.

A number of operations may be performed by the server in response to commands sent via the class's methods. The primary arguments for most commands are the Mailbox property and the MessageSet property. The MessageSet property denotes either a single message, or a range of messages. Other arguments are specified through other properties such as SortCriteria, MessageFlags, etc.

Responses are received through events such as MessageInfo, MailboxList, and also reflected to properties such as MessageText, MessageSubject, etc.

The MessagePart event describes the MIME structure of retrieved messages. One MessagePart event is fired for every message part, giving information about the particular part. Later on, message parts may be retrieved separately through the FetchMessagePart method. This speeds up processing by avoiding the need to retrieve full messages from the server.

The PITrail event traces the interaction between the client and the server. It includes all exchanges except for transfers of messages, message parts, and message headers.

Property List

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


AuthMechanism	The authentication mechanism to be used when connecting to the mail server.
AutoDecodeParts	Determines whether to automatically decode message parts.
Connected	This shows whether the class is connected.
EndByte	The byte index of the position where the transfer should end.
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.
Idle	The current status of the class.
LastReply	The last reply from the server.
LocalFile	The path to a local file for downloading the message body. If the file exists, it is overwritten (optional).
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Mailbox	Name of the mailbox selected on the server.
MailboxFlags	Defines flags in the selected mailbox.
MailboxListCount	The number of records in the MailboxList arrays.
MailboxListFlags	The mailbox flags in a mailbox listing.
MailboxListName	The mailbox name in a mailbox listing.
MailboxListSeparator	The Separator property contains the character that separates the different parts in the mailbox path hierarchy.
MailPort	The port of the IMAP server (default is 143).
MailServer	The name or address of the mail server (IMAP server).
Message	Provides the raw message content.
MessageContentEncoding	The ContentEncoding of the selected message.
MessageContentType	The ContentType of the message.
MessageCount	The total number of messages on the Mailbox .
MessageDate	The time the message was created.
MessageDeliveryTime	The time the message was delivered to the mail server.
MessageFlags	Contains the flags of the current message.
MessageFrom	The address of the author of the message.
MessageHeaderCount	The number of records in the MessageHeader arrays.
MessageHeaderField	This property contains the name of the HTTP header (this is the same case as it is delivered).
MessageHeaderValue	This property contains the header contents.
MessageHeadersString	String version of RFC822-encoded headers of the message.
MessageId	The message identifier of the current message.
MessageInfoCount	The number of records in the MessageInfo arrays.
MessageInfoDate	The date of a message in a message info listing.
MessageInfoFlags	Message flag in a message info listing.
MessageInfoFrom	The sender of a message in a message info listing.
MessageInfoMessageId	The unique identifier of a message in a message info listing.
MessageInfoSize	The size of a message in a message info listing.
MessageInfoSubject	The subject of a message in a message info listing.
MessageInReplyTo	The unique message identifier of the message this one is in reply to.
MessageNetId	The globally unique identifier of the message.
MessagePartCount	The number of records in the MessagePart arrays.
MessagePartContentDisposition	This property shows the value of the Content-Disposition header of the message part.
MessagePartContentEncoding	This property shows how the data is encoded.
MessagePartContentId	This property shows the value of the Content-Id header of the message part.
MessagePartContentType	This property shows the type of data contained in the message part.
MessagePartFilename	This property shows the filename corresponding to the part (if the part was included in the message as an attached file).
MessagePartId	This property contains the identifier of a part listing which may be identified in other parts or messages.
MessagePartMultipartMode	This property shows how this part relates to the message's whole multipart structure ('mixed', 'alternative', etc.
MessagePartParameters	This property contains the additional parameters passed to the ContentType header such as the part charset etc.
MessagePartSize	This property contains the size of a part in a message part listing.
MessageRecipientCount	The number of records in the MessageRecipient arrays.
MessageRecipientAddress	This property contains the email address of the recipient.
MessageRecipientName	This property contains 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.
MessageReplyTo	Email address(s) where replies to the message should be sent.
MessageSender	The address of the sender of the message.
MessageSet	The set of messages to operate on.
MessageSize	The size of the selected message.
MessageSubject	The subject of the message.
MessageText	The body of the retrieved message.
Overwrite	Indicates whether or not the class should overwrite files during transfer.
Password	The password used to authenticate to the MailServer .
PeekMode	When set to True, the message Seen flag is not changed during reading.
RecentMessageCount	Number of new messages in the Mailbox .
SortCriteria	Sorts criteria to use for message retrieval operations.
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.
SSLEnabled	Whether TLS/SSL is enabled.
SSLProvider	This specifies the SSL/TLS implementation to use.
SSLServerCertEncoded	This is the certificate (PEM/base64 encoded).
SSLStartMode	Determines how the class starts the SSL negotiation.
StartByte	The byte index of the position where the transfer should start.
Timeout	A timeout for the class.
UIDMode	If true, permanent message identifiers are used instead of the default temporary identifiers.
UIDValidity	The UIDValidity parameter sent from the server in response to SelectMailbox command.
User	The user name used to authenticate to the MailServer .

Method List

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


AddMessageFlags	Adds the specified flags to the messages specified by MessageSet .
AppendToMailbox	Appends the message in MessageText to the mailbox specified by Mailbox .
CheckMailbox	Sends a 'CHECK' command to the server.
CloseMailbox	Removes all messages marked with 'Deleted' flag from the currently selected mailbox and unselect mailbox.
Config	Sets or retrieves a configuration setting.
Connect	Connects to an IMAP server.
CopyToMailbox	Copies the messages specified by MessageSet to the mailbox specified by Mailbox .
CreateMailbox	Creates a new mailbox specified by Mailbox .
DeleteFromMailbox	Marks the messages specified by MessageSet as deleted.
DeleteMailbox	Deletes a mailbox specified by Mailbox .
DeleteMailboxACL	Deletes mailbox access control rights for a specific user.
Disconnect	Disconnects from an IMAP server.
DoEvents	Processes events from the internal message queue.
ExamineMailbox	Selects a Mailbox (Read-only mode).
ExpungeMailbox	Removes all messages marked with 'Deleted' flag from the currently selected mailbox.
FetchMessageHeaders	Retrieves the message headers of messages specified by the MessageSet property.
FetchMessageInfo	Retrieves information about messages specified by the MessageSet property.
FetchMessagePart	Retrieves the message part specified by PartID.
FetchMessagePartHeaders	Retrieves the headers of message part specified by PartID.
FetchMessageText	Retrieves the message text of messages specified by the MessageSet property.
GetMailboxACL	Retrieves mailbox access control rights.
Interrupt	Interrupt the current method.
ListMailboxes	Lists all mailboxes matching all criteria in the Mailbox property.
ListSubscribedMailboxes	Lists all subscribed mailboxes matching all criteria in the Mailbox property.
LocalizeDate	Converts a valid RFC 822 message date to local date and time.
MoveToMailbox	Moves the messages specified by MessageSet to the mailbox specified by Mailbox .
Noop	Sends a 'NOOP' command to the server.
RenameMailbox	Change the name of Mailbox to NewName .
Reset	Reset the class.
ResetMessageFlags	Replaces the flags of the messages specified by MessageSet with the flags specified by MessageFlags .
SearchMailbox	Search selected mailbox for specified text.
SelectMailbox	Select a Mailbox.
SendCommand	Sends the exact command directly to the server.
SetMailboxACL	Sets mailbox access control rights for a specific user.
StartIdle	Begins idling.
StopIdle	Stops idling.
SubscribeMailbox	Subscribes to the mailbox specified by Mailbox .
UnsetMessageFlags	Removes the flags specified by MessageFlags from the messages specified by MessageSet .
UnsubscribeMailbox	Unsubscribes from the mailbox specified by Mailbox .

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.


ConnectionStatus	Fired to indicate changes in connection state.
EndTransfer	Fired when the message or the part data finishes transferring.
Error	Information about errors during data delivery.
Header	Fired every time a header line comes in.
IdleInfo	Fires whenever responses from the server are received while idling.
MailboxACL	Fires for each set of access control rights returned by the server.
MailboxList	Fired for each mailbox received through the ListMailboxes and ListSubscribedMailboxes methods.
MessageInfo	Fired with information for the message(s) retrieved by the server.
MessagePart	Fired for each message part when FetchMessageInfo is called.
PITrail	Traces the commands sent to the mail server, and the respective replies.
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Shows the progress of the secure connection.
StartTransfer	Fired when the message or the part data starts transferring.
Transfer	Fired while the message gets transferred from the MailServer .

Configuration Settings

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


AlwaysReturnUIDs	Instructs the server to return UIDs even if not in UIDMode.
AppendToMailboxDateTime	Specifies the date-time parameter used in the initial APPEND request.
AuthorizationIdentity	The value to use as the authorization identity when SASL authentication is used.
AutoDecodeSubject	Instructs the class to automatically decode message subjects.
AutoDecodeText	Whether to decode MessageText when AutoDecodeParts is True.
FetchAfterSearch	Determines if messages matching the SearchCriteria are fetched after calling SearchMailbox.
FetchTextAndHeaders	Specifies whether the message body and headers are fetched in a single request.
IncludeHeaders	Instructs the class to include the headers in the LocalFile.
MaskSensitive	Whether sensitive properties should be masked when logging.
SendIDCommand	Instructs class to send the ID command if the server advertises support for it.
UTF7MailboxNames	Specifies whether or not to automatically encode and decode UTF-7 mailbox names.
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.
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.
SSLCACerts	A newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRL	Whether to check the Certificate Revocation List for the server certificate.
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 ciphersuite.
SSLNegotiatedCipherStrength	Returns the negotiated ciphersuite strength.
SSLNegotiatedCipherSuite	Returns the negotiated ciphersuite.
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.
UseInternalSecurityAPI	Tells the class whether or not to use the system security libraries or an internal implementation.

AuthMechanism Property (IMAP Class)

The authentication mechanism to be used when connecting to the mail server.

Syntax

int GetAuthMechanism();
int SetAuthMechanism(int iAuthMechanism);

Possible Values

AM_USER_PASSWORD(0), 
AM_CRAMMD5(1), 
AM_NTLM(2), 
AM_APOP(3), 
AM_SASLPLAIN(4), 
AM_SASLDIGEST_MD5(5), 
AM_KERBEROS(6), 
AM_XOAUTH2(7)

Default Value

Remarks


Auth Mechanism	Description
0 (amUserPassword - Default)	A user/password pair is sent in plaintext to login. (Default)
1 (amCRAMMD5)	CRAM-MD5 authentication.
2 (amNTLM)	NTLM authentication.
4 (amSASLPlain)	SASLPlain. Note, that servers will often require SSL be used when this authentication mechanism is requested. See AuthorizationIdentity.
5 (amSASLDigestMD5)	SASLDigestMD5. See AuthorizationIdentity.
6 (amKerberos)	Kerberos authentication. This option is available in Windows or other platforms when using the Java edition.
7 (mXOAUTH)	XOAUTH2 authentication. See AuthorizationIdentity.

Data Type

Integer

AutoDecodeParts Property (IMAP Class)

Determines whether to automatically decode message parts.

Syntax

bool GetAutoDecodeParts();
int SetAutoDecodeParts(bool bAutoDecodeParts);

Default Value

false

Remarks

This property determines whether or not to automatically decode message parts. Message parts, especially binary message parts, are normally sent by the server encoded (Base64 or other format). If this setting is True, the parts are automatically decoded while being received.

Data Type

Boolean

Connected Property (IMAP Class)

This shows whether the class is connected.

Syntax

bool GetConnected();
int SetConnected(bool bConnected);

Default Value

false

Remarks

This property is used to determine whether or not the class is connected to the remote host.

Note: It is recommended to use the Connect or Disconnect method instead of setting this property.

This property is not available at design time.

Data Type

Boolean

EndByte Property (IMAP Class)

The byte index of the position where the transfer should end.

Syntax

qint64 GetEndByte();
int SetEndByte(qint64 lEndByte);

Default Value

Remarks

StartByte and EndByte are used together with the FetchMessagePart method to specify the portion of the message part to be retrieved from the server.

When StartByte or EndByte contain values other than the defaults (0), only the corresponding portion of the message part is retrieved from the server.

Byte indexes start from 1. The default value for EndByte is 0, which corresponds to the end of the message.

This property is not available at design time.

Data Type

Long64

FirewallAutoDetect Property (IMAP Class)

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Syntax

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

This property determines the type of firewall to connect through.

Syntax

int GetFirewallType();
int SetFirewallType(int iFirewallType);

Possible Values

FW_NONE(0), 
FW_TUNNEL(1), 
FW_SOCKS4(2), 
FW_SOCKS5(3), 
FW_SOCKS4A(10)

Default Value

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

This property contains the name or IP address of firewall (optional).

Syntax

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

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

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

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Default Value

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

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

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

Idle Property (IMAP Class)

The current status of the class.

Syntax

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

LastReply Property (IMAP Class)

The last reply from the server.

Syntax

QString GetLastReply();

Default Value

Remarks

This property indicates the last reply received from the server. It can be used for informational purposes. The same information and more can also be retrieved through the PITrail event.

This property is read-only.

Data Type

String

LocalFile Property (IMAP Class)

The path to a local file for downloading the message body. If the file exists, it is overwritten (optional).

Syntax

QString GetLocalFile();
int SetLocalFile(QString qsLocalFile);

Default Value

Remarks

This property is used when retrieving a message.

If this property is empty then the received data is provided through the parameters of the Transfer event.

Data Type

String

LocalHost Property (IMAP Class)

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

Syntax

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

Mailbox Property (IMAP Class)

Name of the mailbox selected on the server.

Syntax

QString GetMailbox();
int SetMailbox(QString qsMailbox);

Default Value

"Inbox"

Remarks

This method contains the name of the mailbox selected on the server, and is also used as argument to most methods. Please refer to the class methods for more information.

Example (Open a Mailbox in Read/Write Mode)

IMAPControl.Mailbox = "INBOX" IMAPControl.SelectMailbox

Example (Open a Mailbox in Read-Only Mode)

IMAPControl.Mailbox = "INBOX.Folder" IMAPControl.ExamineMailbox

Data Type

String

MailboxFlags Property (IMAP Class)

Defines flags in the selected mailbox.

Syntax

QString GetMailboxFlags();

Default Value

Remarks

This method defines flags in the selected mailbox. The class fills out MessageCount, RecentMessageCount, and MailboxFlags after connecting to the MailServer and selecting or examining a Mailbox.

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

Data Type

String

MailboxListCount Property (IMAP Class)

The number of records in the MailboxList arrays.

Syntax

int GetMailboxListCount();

Default Value

Remarks

This property controls the size of the following arrays:

MailboxListFlags
MailboxListName
MailboxListSeparator

The array indices start at 0 and end at MailboxListCount - 1.

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

Data Type

Integer

MailboxListFlags Property (IMAP Class)

The mailbox flags in a mailbox listing.

Syntax

QString GetMailboxListFlags(int iMailboxListIndex);

Default Value

Remarks

The mailbox flags in a mailbox listing.

Examples of possible flag values are server dependent, but can include:


\Deleted	Mark a message as deleted (for removal by later ExpungeMailbox).
\Seen	Mark a message as read.
\Answered	Mark a message as answered.
\Flagged	Mark a message as flagged.
\Draft	Mark a message as being incomplete (under composition).

The MailboxListIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MailboxListCount property.

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

Data Type

String

MailboxListName Property (IMAP Class)

The mailbox name in a mailbox listing.

Syntax

QString GetMailboxListName(int iMailboxListIndex);

Default Value

Remarks

The mailbox name in a mailbox listing.

The MailboxListIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MailboxListCount property.

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

Data Type

String

MailboxListSeparator Property (IMAP Class)

The Separator property contains the character that separates the different parts in the mailbox path hierarchy.

Syntax

QString GetMailboxListSeparator(int iMailboxListIndex);

Default Value

Remarks

The MailboxListSeparator property contains the character that separates the different parts in the mailbox path hierarchy.

The MailboxListIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MailboxListCount property.

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

Data Type

String

MailPort Property (IMAP Class)

The port of the IMAP server (default is 143).

Syntax

int GetMailPort();
int SetMailPort(int iMailPort);

Default Value

143

Remarks

A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.

For implicit SSL, use port 993 (please refer to the SSLStartMode property for more information).

This property is not available at design time.

Data Type

Integer

MailServer Property (IMAP Class)

The name or address of the mail server (IMAP server).

Syntax

QString GetMailServer();
int SetMailServer(QString qsMailServer);

Default Value

Remarks

This property specifies the IP address (IP number in dotted internet format) or Domain Name of the mail server. It must be set before a connection is attempted and cannot be changed once a connection is in progress.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the MailServer property is set to the corresponding address. If the search is not successful, an error is returned.

If the class is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.

Data Type

String

Message Property (IMAP Class)

Provides the raw message content.

Syntax

QByteArray GetMessage();
int SetMessage(QByteArray qbaMessage);

Default Value

Remarks

This property is populated after calling FetchMessagePart and holds the raw message content. This can be used to access the data before any processing is done by the class.

This property is not available at design time.

Data Type

Byte Array

MessageContentEncoding Property (IMAP Class)

The ContentEncoding of the selected message.

Syntax

QString GetMessageContentEncoding();

Default Value

Remarks

The property is automatically set by the class when message information is retrieved via the FetchMessageInfo method.

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

Data Type

String

MessageContentType Property (IMAP Class)

The ContentType of the message.

Syntax

QString GetMessageContentType();

Default Value

Remarks

This property denotes the type of content contained in the message, such as plain, multipart, multipart/alternative etc. You may also need to check the MessageContentEncoding property or read the individual message parts.

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

Data Type

String

MessageCount Property (IMAP Class)

The total number of messages on the Mailbox .

Syntax

int GetMessageCount();

Default Value

Remarks

This property contains the total number of messages on the Mailbox. The class fills out MessageCount, RecentMessageCount, and MailboxFlags after connecting to the MailServer and selecting or examining a Mailbox.

This property is read-only.

Data Type

Integer

MessageDate Property (IMAP Class)

The time the message was created.

Syntax

QString GetMessageDate();

Default Value

Remarks

This property contains the date and time when the message was created. This value is taken from the ENVELOPE structure of the message corresponding to the date.

RFC 822 contains detailed date format specifications. An example of a valid date is "Fri, 1 Mar 96 21:24:52 EST".

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

Data Type

String

MessageDeliveryTime Property (IMAP Class)

The time the message was delivered to the mail server.

Syntax

QString GetMessageDeliveryTime();

Default Value

Remarks

This property contains the time the message was delivered to the mail server. This value is taken from the INTERNALDATE property of the message. The time format is defined in RFC821.

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

Data Type

String

MessageFlags Property (IMAP Class)

Contains the flags of the current message.

Syntax

QString GetMessageFlags();
int SetMessageFlags(QString qsMessageFlags);

Default Value

Remarks

This property contains the flags of the current message. It is also used to specify flags when AppendToMailbox is called.

Examples of possible flag values are server dependent, but can include:


\Deleted	Mark a message as deleted (for removal by later ExpungeMailbox).
\Seen	Mark a message as read.
\Answered	Mark a message as answered.
\Flagged	Mark a message as flagged.
\Draft	Mark a message as being incomplete (under composition).

Example (Setting MessageFlags)

IMAPControl.MessageSet = "1" IMAPControl.AddMessageFlags("\Deleted")

This property is not available at design time.

Data Type

String

MessageFrom Property (IMAP Class)

The address of the author of the message.

Syntax

QString GetMessageFrom();

Default Value

Remarks

This property normally has the same value as MessageSender.

There are cases when a message may have more than one From address. If this is the case, the addresses are provided in the MessageFrom property separated by commas.

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

Data Type

String

MessageHeaderCount Property (IMAP Class)

The number of records in the MessageHeader arrays.

Syntax

int GetMessageHeaderCount();
int SetMessageHeaderCount(int iMessageHeaderCount);

Default Value

Remarks

This property controls the size of the following arrays:

MessageHeaderField
MessageHeaderValue

The array indices start at 0 and end at MessageHeaderCount - 1.

This property is not available at design time.

Data Type

Integer

MessageHeaderField Property (IMAP Class)

This property contains the name of the HTTP header (this is the same case as it is delivered).

Syntax

QString GetMessageHeaderField(int iMessageHeaderIndex);
int SetMessageHeaderField(int iMessageHeaderIndex, QString qsMessageHeaderField);

Default Value

Remarks

This property contains the name of the HTTP Header (this is the same case as it is delivered).

The MessageHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageHeaderCount property.

This property is not available at design time.

Data Type

String

MessageHeaderValue Property (IMAP Class)

This property contains the header contents.

Syntax

QString GetMessageHeaderValue(int iMessageHeaderIndex);
int SetMessageHeaderValue(int iMessageHeaderIndex, QString qsMessageHeaderValue);

Default Value

Remarks

This property contains the Header contents.

The MessageHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageHeaderCount property.

This property is not available at design time.

Data Type

String

MessageHeadersString Property (IMAP Class)

String version of RFC822-encoded headers of the message.

Syntax

QString GetMessageHeadersString();
int SetMessageHeadersString(QString qsMessageHeadersString);

Default Value

Remarks

This property contains the full headers of the message in RFC822 format. The headers are retrieved by calling the FetchMessageHeaders or the FetchMessagePartHeaders method.

This property is not available at design time.

Data Type

String

MessageId Property (IMAP Class)

The message identifier of the current message.

Syntax

QString GetMessageId();

Default Value

Remarks

The class fills out this property when message information is retrieved from the MailServer.

The id is permanent if UIDMode is set, and temporary otherwise.

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

Data Type

String

MessageInfoCount Property (IMAP Class)

The number of records in the MessageInfo arrays.

Syntax

int GetMessageInfoCount();

Default Value

Remarks

This property controls the size of the following arrays:

MessageInfoDate
MessageInfoFlags
MessageInfoFrom
MessageInfoMessageId
MessageInfoSize
MessageInfoSubject

The array indices start at 0 and end at MessageInfoCount - 1.

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

Data Type

Integer

MessageInfoDate Property (IMAP Class)

The date of a message in a message info listing.

Syntax

QString GetMessageInfoDate(int iMessageInfoIndex);

Default Value

Remarks

The date of a message in a message info listing. This date is taken from the ENVELOPE structure of the message.

The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.

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

Data Type

String

MessageInfoFlags Property (IMAP Class)

Message flag in a message info listing.

Syntax

QString GetMessageInfoFlags(int iMessageInfoIndex);

Default Value

Remarks

Message flag in a message info listing.

Examples of possible flag values are server dependent, but can include:


\Deleted	Mark a message as deleted (for removal by later ExpungeMailbox).
\Seen	Mark a message as read.
\Answered	Mark a message as answered.
\Flagged	Mark a message as flagged.
\Draft	Mark a message as being incomplete (under composition).

The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.

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

Data Type

String

MessageInfoFrom Property (IMAP Class)

The sender of a message in a message info listing.

Syntax

QString GetMessageInfoFrom(int iMessageInfoIndex);

Default Value

Remarks

The sender of a message in a message info listing.

The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.

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

Data Type

String

MessageInfoMessageId Property (IMAP Class)

The unique identifier of a message in a message info listing.

Syntax

QString GetMessageInfoMessageId(int iMessageInfoIndex);

Default Value

Remarks

The unique identifier of a message in a message info listing.

The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.

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

Data Type

String

MessageInfoSize Property (IMAP Class)

The size of a message in a message info listing.

Syntax

qint64 GetMessageInfoSize(int iMessageInfoIndex);

Default Value

Remarks

The size of a message in a message info listing.

The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.

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

Data Type

Long64

MessageInfoSubject Property (IMAP Class)

The subject of a message in a message info listing.

Syntax

QString GetMessageInfoSubject(int iMessageInfoIndex);

Default Value

Remarks

The subject of a message in a message info listing.

The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.

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

Data Type

String

MessageInReplyTo Property (IMAP Class)

The unique message identifier of the message this one is in reply to.

Syntax

QString GetMessageInReplyTo();

Default Value

Remarks

The class fills out this property with the value of the In-Reply-To: message header.

This value can be useful when threading messages by referring to the message you are replying to.

The unique message identifier of the message itself is given by the MessageNetId property.

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

Data Type

String

MessageNetId Property (IMAP Class)

The globally unique identifier of the message.

Syntax

QString GetMessageNetId();

Default Value

Remarks

This property contains the globally unique identifier of the message. The class fills the MessageNetId with the value of the Message-Id: header. This is a globally unique value normally created by the first mail server the message is sent to.

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

Data Type

String

MessagePartCount Property (IMAP Class)

The number of records in the MessagePart arrays.

Syntax

int GetMessagePartCount();

Default Value

Remarks

This property controls the size of the following arrays:

MessagePartContentDisposition
MessagePartContentEncoding
MessagePartContentId
MessagePartContentType
MessagePartFilename
MessagePartId
MessagePartMultipartMode
MessagePartParameters
MessagePartSize

The array indices start at 0 and end at MessagePartCount - 1.

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

Data Type

Integer

MessagePartContentDisposition Property (IMAP Class)

This property shows the value of the Content-Disposition header of the message part.

Syntax

QString GetMessagePartContentDisposition(int iMessagePartIndex);

Default Value

Remarks

This property shows the value of the Content-Disposition header of the message part.

The MessagePartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagePartCount property.

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

Data Type

String

MessagePartContentEncoding Property (IMAP Class)

This property shows how the data is encoded.

Syntax

QString GetMessagePartContentEncoding(int iMessagePartIndex);

Default Value

Remarks

This property shows how the data is encoded.

The MessagePartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagePartCount property.

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

Data Type

String

MessagePartContentId Property (IMAP Class)

This property shows the value of the Content-Id header of the message part.

Syntax

QString GetMessagePartContentId(int iMessagePartIndex);

Default Value

Remarks

This property shows the value of the Content-Id header of the message part.

The MessagePartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagePartCount property.

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

Data Type

String

MessagePartContentType Property (IMAP Class)

This property shows the type of data contained in the message part.

Syntax

QString GetMessagePartContentType(int iMessagePartIndex);

Default Value

Remarks

This property shows the type of data contained in the message part.

The MessagePartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagePartCount property.

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

Data Type

String

MessagePartFilename Property (IMAP Class)

This property shows the filename corresponding to the part (if the part was included in the message as an attached file).

Syntax

QString GetMessagePartFilename(int iMessagePartIndex);

Default Value

Remarks

This property shows the filename corresponding to the part (if the part was included in the message as an attached file).

The MessagePartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagePartCount property.

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

Data Type

String

MessagePartId Property (IMAP Class)

This property contains the identifier of a part listing which may be identified in other parts or messages.

Syntax

QString GetMessagePartId(int iMessagePartIndex);

Default Value

Remarks

This property contains the identifier of a part listing which may be identified in other parts or messages. The format of part identifiers is specified by the IMAP RFCs.

The MessagePartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagePartCount property.

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

Data Type

String

MessagePartMultipartMode Property (IMAP Class)

This property shows how this part relates to the message's whole multipart structure ('mixed', 'alternative', etc.

Syntax

QString GetMessagePartMultipartMode(int iMessagePartIndex);

Default Value

Remarks

This property shows how this part relates to the message's whole multipart structure ('mixed', 'alternative', etc.).

The MessagePartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagePartCount property.

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

Data Type

String

MessagePartParameters Property (IMAP Class)

This property contains the additional parameters passed to the ContentType header such as the part charset etc.

Syntax

QString GetMessagePartParameters(int iMessagePartIndex);

Default Value

Remarks

This property contains the additional parameters passed to the ContentType header such as the part charset etc.

The MessagePartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagePartCount property.

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

Data Type

String

MessagePartSize Property (IMAP Class)

This property contains the size of a part in a message part listing.

Syntax

qint64 GetMessagePartSize(int iMessagePartIndex);

Default Value

Remarks

This property contains the size of a part in a message part listing.

The MessagePartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagePartCount property.

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

Data Type

Long64

MessageRecipientCount Property (IMAP Class)

The number of records in the MessageRecipient arrays.

Syntax

int GetMessageRecipientCount();

Default Value

Remarks

This property controls the size of the following arrays:

MessageRecipientAddress
MessageRecipientName
MessageRecipientOptions
MessageRecipientType

The array indices start at 0 and end at MessageRecipientCount - 1.

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

Data Type

Integer

MessageRecipientAddress Property (IMAP Class)

This property contains the email address of the recipient.

Syntax

QString GetMessageRecipientAddress(int iRecipientIndex);

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 read-only and not available at design time.

Data Type

String

MessageRecipientName Property (IMAP Class)

This property contains name of the recipient.

Syntax

QString GetMessageRecipientName(int iRecipientIndex);

Default Value

Remarks

This property contains 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 read-only and not available at design time.

Data Type

String

MessageRecipientOptions Property (IMAP Class)

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

Syntax

QString GetMessageRecipientOptions(int iRecipientIndex);

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 read-only and not available at design time.

Data Type

String

MessageRecipientType Property (IMAP Class)

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

Syntax

int GetMessageRecipientType(int iRecipientIndex);

Possible Values

RT_TO(0), 
RT_CC(1), 
RT_BCC(2)

Default Value

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 read-only and not available at design time.

Data Type

Integer

MessageReplyTo Property (IMAP Class)

Email address(s) where replies to the message should be sent.

Syntax

QString GetMessageReplyTo();

Default Value

Remarks

This property contains the email address(s) where replies to the message should be sent. There are cases when a message may have more than one Reply-To address. If this is the case, the addresses are provided in this property separated by commas.

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

Data Type

String

MessageSender Property (IMAP Class)

The address of the sender of the message.

Syntax

QString GetMessageSender();

Default Value

Remarks

This property contains the address of the sender of the message. Which is normally the same value as MessageFrom.

There are cases when a message may have more than one sender. If this is the case, the addresses are provided in the MessageSender property separated by commas.

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

Data Type

String

MessageSet Property (IMAP Class)

The set of messages to operate on.

Syntax

QString GetMessageSet();
int SetMessageSet(QString qsMessageSet);

Default Value

Remarks

This property indicates the set of messages to operate on. Used as an argument to most method calls.

It may consist of a single message number, a range of messages specified by two message numbers separated by ':' (e.g. "1:5"), and/or individual message numbers separated by ',' (e.g. "1:5,7,10").

Example (Setting MessageSet)

IMAPControl.MessageSet = "1" IMAPControl.FetchMessageInfo() IMAPControl.MessageSet = "1:5" IMAPControl.FetchMessageInfo() IMAPControl.MessageSet = "1,5,7" IMAPControl.FetchMessageInfo()

Data Type

String

MessageSize Property (IMAP Class)

The size of the selected message.

Syntax

qint64 GetMessageSize();

Default Value

Remarks

The class fills out this property with the size of the selected message when message information is retrieved from the MailServer.

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

Data Type

Long64

MessageSubject Property (IMAP Class)

The subject of the message.

Syntax

QString GetMessageSubject();

Default Value

Remarks

The class fills out this property with the subject of the message when message information is retrieved from the MailServer.

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

Data Type

String

MessageText Property (IMAP Class)

The body of the retrieved message.

Syntax

QString GetMessageText();
int SetMessageText(QString qsMessageText);

Default Value

Remarks

The class fills out this property with the contents of the message body (in RFC822 format) when a call to FetchMessageText completes successfully.

This property is not available at design time.

Data Type

String

Overwrite Property (IMAP Class)

Indicates whether or not the class should overwrite files during transfer.

Syntax

bool GetOverwrite();
int SetOverwrite(bool bOverwrite);

Default Value

false

Remarks

This property is a value indicating whether or not the class should overwrite files when downloading the message text or a message part and LocalFile is set. If Overwrite is false, an error will be thrown whenever LocalFile exists.

Data Type

Boolean

Password Property (IMAP Class)

The password used to authenticate to the MailServer .

Syntax

QString GetPassword();
int SetPassword(QString qsPassword);

Default Value

Remarks

This property contains the password used to authenticate to the MailServer. Both the User and Password properties must be set before connecting to the MailServer.

Data Type

String

PeekMode Property (IMAP Class)

When set to True, the message Seen flag is not changed during reading.

Syntax

bool GetPeekMode();
int SetPeekMode(bool bPeekMode);

Default Value

false

Remarks

This property contains a true or false to determine whether or not this message should be seen. When this property is set to True, a "PEEK" option is added to all IMAP FETCH commands sent to the server. An RFC compliant IMAP server should not set the "Seen" flag on the message in this case.

This property is not available at design time.

Data Type

Boolean

RecentMessageCount Property (IMAP Class)

Number of new messages in the Mailbox .

Syntax

int GetRecentMessageCount();

Default Value

Remarks

This property contains the number of new messages that are in the Mailbox. The class fills out MessageCount, RecentMessageCount, and MailboxFlags after connecting to the MailServer and selecting or examining a Mailbox.

This property is read-only.

Data Type

Integer

SortCriteria Property (IMAP Class)

Sorts criteria to use for message retrieval operations.

Syntax

QString GetSortCriteria();
int SetSortCriteria(QString qsSortCriteria);

Default Value

Remarks

This property sorts criteria to use for message retrieval operations. When set, the class will send the SORT command to the server before any retrieval. If the server supports the SORT command, the results from the fetch operation will be sorted according to SortCriteria. The format of the SortCriteria property consists of a parenthesized list of one or more sort keys.

Example (Setting SortCriteria)

IMAPControl.SortCriteria = "DATE" IMAPControl.SortCriteria = "SUBJECT FROM" IMAPControl.SortCriteria = "REVERSE SUBJECT"

Possible sort keys include:


ARRIVAL	Internal date and time of the message.
DATE	The value of the message's DATE header, adjusted by time zone
CC	The value of the message's CC header.
FROM	The value of the message's FROM header.
SUBJECT	The value of the message's SUBJECT header.
TO	The value of the message's TO header.
SIZE	The size of the message
REVERSE <criterion>	Followed by another sort criterion, has the effect of that criterion but in reverse (descending) order

Please note that IMAP SORT functionality is relatively new and not all servers may implement it.

Data Type

String

SSLAcceptServerCertEncoded Property (IMAP Class)

This is the certificate (PEM/base64 encoded).

Syntax

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

Byte Array

SSLCertEncoded Property (IMAP Class)

This is the certificate (PEM/base64 encoded).

Syntax

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

Byte Array

SSLCertStore Property (IMAP Class)

This is the name of the certificate store for the client certificate.

Syntax

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 are designations of 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. PKCS12 certificate store).

Data Type

Byte Array

SSLCertStorePassword Property (IMAP 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

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

This is the type of certificate store for this certificate.

Syntax

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_AUTO(99)

Default Value

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 (PKCS12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) 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 PKCS7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS7 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).
20 (cstSecurityKey)	The certificate is present on a physical security key accessible via a PKCS11 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 `cstSecurityKey`, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 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 `certmgr.CertStoreType = CertStoreTypes.cstSecurityKey; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstSecurityKey, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
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.
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 (IMAP Class)

This is the subject of the certificate used for client authentication.

Syntax

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 properites are set. When this property is set, a search is performed in the current certificate store certificate with 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 displayed below.


Field	Meaning
CN	Common Name. This is commonly a host name 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

SSLEnabled Property (IMAP Class)

Whether TLS/SSL is enabled.

Syntax

bool GetSSLEnabled();
int SetSSLEnabled(bool bSSLEnabled);

Default Value

false

Remarks

This setting specifies whether TLS/SSL is enabled in the class. When False (default) the class operates in plaintext mode. When True TLS/SSL is enabled.

TLS/SSL may also be enabled by setting SSLStartMode. Setting SSLStartMode will automatically update this property value.

This property is not available at design time.

Data Type

Boolean

SSLProvider Property (IMAP Class)

This specifies the SSL/TLS implementation to use.

Syntax

int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Possible Values

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1), 
SSLP_INTERNAL(2)

Default Value

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.

Additional Notes

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

This is the certificate (PEM/base64 encoded).

Syntax

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

Byte Array

SSLStartMode Property (IMAP Class)

Determines how the class starts the SSL negotiation.

Syntax

int GetSSLStartMode();
int SetSSLStartMode(int iSSLStartMode);

Possible Values

SSL_AUTOMATIC(0), 
SSL_IMPLICIT(1), 
SSL_EXPLICIT(2), 
SSL_NONE(3)

Default Value

Remarks

The SSLStartMode property may have one of the following values:


0 (sslAutomatic)	If the remote port is set to the standard plaintext port of the protocol (where applicable), the class will behave the same as if SSLStartMode is set to sslExplicit. In all other cases, SSL negotiation will be implicit (sslImplicit).
1 (sslImplicit)	The SSL negotiation will start immediately after the connection is established.
2 (sslExplicit)	The class will first connect in plaintext, and then explicitly start SSL negotiation through a protocol command such as STARTTLS.
3 (sslNone - default)	No SSL negotiation, no SSL security. All communication will be in plaintext mode.

Data Type

Integer

StartByte Property (IMAP Class)

The byte index of the position where the transfer should start.

Syntax

qint64 GetStartByte();
int SetStartByte(qint64 lStartByte);

Default Value

Remarks

StartByte and EndByte are used together with the FetchMessagePart method to specify the portion of the message part to be retrieved from the server.

When StartByte or EndByte contain values other than the defaults (0), only the corresponding portion of the message part is retrieved from the server.

Byte indexes start from 1. The default value for EndByte is 0, which corresponds to the end of the message.

This property is not available at design time.

Data Type

Long64

Timeout Property (IMAP Class)

A timeout for the class.

Syntax

int GetTimeout();
int SetTimeout(int iTimeout);

Default Value

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

UIDMode Property (IMAP Class)

If true, permanent message identifiers are used instead of the default temporary identifiers.

Syntax

bool GetUIDMode();
int SetUIDMode(bool bUIDMode);

Default Value

false

Remarks

This property indicates if a permanent identifier should be used. Normally, the IMAP server uses temporary message identifiers that are valid only during the current session. If UIDMode is true, permanent message identifiers are used instead.

The IMAP protocol operations where UID mode is used are the following: COPY, FETCH, STORE, SEARCH.

This property is not available at design time.

Data Type

Boolean

UIDValidity Property (IMAP Class)

The UIDValidity parameter sent from the server in response to SelectMailbox command.

Syntax

QString GetUIDValidity();

Default Value

Remarks

Every time a mailbox is selected a UIDValidity is returned from the server. Most of the time this value will not change from call to call. In case it does change, it means that all previously returned UIDs for messages inside this mailbox are now invalid.

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

Data Type

String

User Property (IMAP Class)

The user name used to authenticate to the MailServer .

Syntax

QString GetUser();
int SetUser(QString qsUser);

Default Value

Remarks

This property contains the user name used to authenticate to the MailServer. Both the User and Password properties must be set before connecting to the MailServer.

Data Type

String

AddMessageFlags Method (IMAP Class)

Adds the specified flags to the messages specified by MessageSet .

Syntax

int AddMessageFlags(const QString& qsFlags);

Remarks

This method adds the specified flags to the messages specified by the MessageSet property. The format of the flags is specified by the IMAP RFCs.

Examples of possible flag values are server dependent, but can include:


\Deleted	Mark a message as deleted (for removal by later ExpungeMailbox).
\Seen	Mark a message as read.
\Answered	Mark a message as answered.
\Flagged	Mark a message as flagged.
\Draft	Mark a message as being incomplete (under composition).

Example (Setting Adding Message Flags)

IMAPControl.MessageSet = "1" IMAPControl.AddMessageFlags("\Deleted")

Error Handling

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

AppendToMailbox Method (IMAP Class)

Appends the message in MessageText to the mailbox specified by Mailbox .

Syntax

int AppendToMailbox();

Remarks

This method appends the RFC822-encoded message in MessageText to the mailbox specified by Mailbox. If the MessageFlags property is not an empty string, it's contents are supplied with the 'APPEND' command sent to the server.

Example (Append Message to Mailbox)

IMAPControl.MessageText = MessageHeaders + CRLF + CRLF + MessageBody + CRLF IMAPControl.Mailbox = "INBOX" IMAPControl.MessageFlags = "\Deleted" IMAPControl.AppendToMailbox()

Error Handling

CheckMailbox Method (IMAP Class)

Sends a 'CHECK' command to the server.

Syntax

int CheckMailbox();

Remarks

This method sends a 'CHECK' command to the server, asking it to perform any necessary 'housekeeping' operations on, and update the state of the currently selected mailbox.

Error Handling

CloseMailbox Method (IMAP Class)

Removes all messages marked with 'Deleted' flag from the currently selected mailbox and unselect mailbox.

Syntax

int CloseMailbox();

Remarks

This method permanently removes all messages that have the 'Deleted' flag set from the current (selected) mailbox, and then closes (deselect) the mailbox.

Error Handling

Config Method (IMAP Class)

Sets or retrieves a configuration setting.

Syntax

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

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.

Connect Method (IMAP Class)

Connects to an IMAP server.

Syntax

int Connect();

Remarks

This method connects to the IMAP server specified by MailServer and authenticates using the user name and password supplied in the User and Password properties.

Example (Connect IMAP Server)

IMAPControl.MailServer = "myserver" IMAPControl.Mailbox = "INBOX" IMAPControl.User = "myusername" IMAPControl.Password = "mypassword" IMAPControl.Connect() IMAPControl.MailServer = "myserver" IMAPControl.Mailbox = "DOMAIN/USERNT/INBOX" IMAPControl.User = "myusername" IMAPControl.Password = "mypassword" IMAPControl.Connect()

Error Handling

CopyToMailbox Method (IMAP Class)

Copies the messages specified by MessageSet to the mailbox specified by Mailbox .

Syntax

int CopyToMailbox();

Remarks

This method copies the messages specified by the MessageSet property to the mailbox specified by the Mailbox property.

Error Handling

CreateMailbox Method (IMAP Class)

Creates a new mailbox specified by Mailbox .

Syntax

int CreateMailbox();

Remarks

This method creates a new mailbox. The mailbox name is specified by the Mailbox property.

Error Handling

DeleteFromMailbox Method (IMAP Class)

Marks the messages specified by MessageSet as deleted.

Syntax

int DeleteFromMailbox();

Remarks

This method marks the messages specified by MessageSet as deleted. Calling this method is equivalent to calling AddMessageFlags with "\Deleted" as the Flags parameter.

Error Handling

DeleteMailbox Method (IMAP Class)

Deletes a mailbox specified by Mailbox .

Syntax

int DeleteMailbox();

Remarks

This method deletes a mailbox. The mailbox name is specified by the Mailbox property.

Error Handling

DeleteMailboxACL Method (IMAP Class)

Deletes mailbox access control rights for a specific user.

Syntax

int DeleteMailboxACL(const QString& qsUser);

Remarks

This message asks the server to remove all rights associated with User from the mailbox specified in the Mailbox property. Refer to SetMailboxACL and GetMailboxACL for more information on mailbox access rights.

Error Handling

Disconnect Method (IMAP Class)

Disconnects from an IMAP server.

Syntax

int Disconnect();

Remarks

This method logs out and disconnects from the IMAP server.

Error Handling

DoEvents Method (IMAP Class)

Processes events from the internal message queue.

Syntax

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

ExamineMailbox Method (IMAP Class)

Selects a Mailbox (Read-only mode).

Syntax

int ExamineMailbox();

Remarks

This method asks the server to select the mailbox specified in the Mailbox property in read-only mode.

Example (Open a Mailbox in Read/Write Mode)

IMAPControl.Mailbox = "INBOX" IMAPControl.SelectMailbox

Example (Open a Mailbox in Read-Only Mode)

IMAPControl.Mailbox = "INBOX.Folder" IMAPControl.ExamineMailbox

Error Handling

ExpungeMailbox Method (IMAP Class)

Removes all messages marked with 'Deleted' flag from the currently selected mailbox.

Syntax

int ExpungeMailbox();

Remarks

This method permanently removes all messages that have the 'Deleted' flag set from the current (selected) mailbox. Example (Set "Deleted" flag and Expunge)

IMAPControl.MessageSet = "1" IMAPControl.AddMessageFlags("\Deleted") IMAPControl.ExpungeMailbox()

Error Handling

FetchMessageHeaders Method (IMAP Class)

Retrieves the message headers of messages specified by the MessageSet property.

Syntax

int FetchMessageHeaders();

Remarks

This method retrieves RFC822 headers of the message specified by MessageSet and stores them in the MessageHeaders property.

Error Handling

FetchMessageInfo Method (IMAP Class)

Retrieves information about messages specified by the MessageSet property.

Syntax

int FetchMessageInfo();

Remarks

This method retrieves information for the messages specified by the MessageSet property. This includes information about the message envelope as well as message structure. Every time a message envelope is retrieved, a MessageInfo event is fired, and message envelope information is stored in properties such as: MessageSubject, MessageFrom, MessageRecipients, etc. If the message is a multipart message, one or more MessagePart events are fired before the MessageInfo event - one for each message part.

Error Handling

FetchMessagePart Method (IMAP Class)

Retrieves the message part specified by PartID.

Syntax

int FetchMessagePart(const QString& qsPartId);

Remarks

This method retrieves the contents of the message part specified by the PartId property of the message specified by the MessageSet property. If the LocalFile property contains a file name, the message part is stored in LocalFile, and the Transfer events denote the progress. If the LocalFile property contains an empty string, the message part is stored in the MessageText property, as well as provided through the Transfer event.

The part identifiers of each message part (if any) are provided through the corresponding MessagePart events.

Error Handling

FetchMessagePartHeaders Method (IMAP Class)

Retrieves the headers of message part specified by PartID.

Syntax

int FetchMessagePartHeaders(const QString& qsPartId);

Remarks

This method retrieves RFC822 headers of the message part specified by PartID and stores them in the MessageHeaders property.

Error Handling

FetchMessageText Method (IMAP Class)

Retrieves the message text of messages specified by the MessageSet property.

Syntax

int FetchMessageText();

Remarks

This method retrieves the RFC822-encoded text of the message specified by MessageSet. If the LocalFile property contains a file name, the text is stored in LocalFile, and the Transfer events denote the progress. If the LocalFile property contains an empty string, the text is stored in the MessageText property, as well as provided through the Transfer event.

Error Handling

GetMailboxACL Method (IMAP Class)

Retrieves mailbox access control rights.

Syntax

int GetMailboxACL();

Remarks

This method retrieves the mailbox access control rights, which are provided through one or more MailboxACL events. Standard rights include:


l	Lookup (visible to be listed)
r	Read (Can be selected, fetched, searched, and copied)
s	Keep seen/unseen information across sessions
w	Write (Store flags other than SEEN and DELETED)
i	Insert (Can be appended, and copied into)
p	Post (Can send mail to submission address for mailbox)
c	Create (Can create new sub-mailboxes)
d	Delete (Store DELETED flag, perform EXPUNGE)
a	Administer (Set access permissions)

Error Handling

Interrupt Method (IMAP Class)

Interrupt the current method.

Syntax

int Interrupt();

Remarks

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

Error Handling

ListMailboxes Method (IMAP Class)

Lists all mailboxes matching all criteria in the Mailbox property.

Syntax

int ListMailboxes();

Remarks

This method lists all of the mailboxes matching the criteria in the Mailbox property. Matching mailboxes are returned through the MailboxList event.

Example (List All Mailboxes)

IMAPControl.Mailbox = "*" IMAPControl.ListMailboxes()

Example (List All Mailboxes Inside INBOX)

IMAPControl.Mailbox = "INBOX.*" IMAPControl.ListMailboxes()

Error Handling

ListSubscribedMailboxes Method (IMAP Class)

Lists all subscribed mailboxes matching all criteria in the Mailbox property.

Syntax

int ListSubscribedMailboxes();

Remarks

This method lists all subscribed mailboxes matching the criteria in the Mailbox property. Matching mailboxes are returned through MailboxList event.

Example (List All Subscribed Mailboxes)

IMAPControl.Mailbox = "*" IMAPControl.ListSubscribedMailboxes()

Example (List All Subscribed Mailboxes Inside INBOX)

IMAPControl.Mailbox = "INBOX.*" IMAPControl.ListSubscribedMailboxes()

Error Handling

LocalizeDate Method (IMAP Class)

Converts a valid RFC 822 message date to local date and time.

Syntax

QString LocalizeDate(const QString& qsDateTime);

Remarks

This method can be used to convert an RFC 822 date/time string to the corresponding local date and time.

Dates will be returned in the format: "MM/dd/yyyy hh:mm:ss".

Error Handling

MoveToMailbox Method (IMAP Class)

Moves the messages specified by MessageSet to the mailbox specified by Mailbox .

Syntax

int MoveToMailbox();

Remarks

This method moves the messages specified by the MessageSet property to the mailbox specified by the Mailbox property.

Error Handling

Noop Method (IMAP Class)

Sends a 'NOOP' command to the server.

Syntax

int Noop();

Remarks

This method sends an IMAP 'NOOP' command to the server. This is useful when the connection needs to be kept alive for long periods of time. (Normally, servers break the connection automatically after 30 minutes of inactivity).

Error Handling

RenameMailbox Method (IMAP Class)

Change the name of Mailbox to NewName .

Syntax

int RenameMailbox(const QString& qsNewName);

Remarks

This method allows the renaming of a mailbox. The mailbox is specified by the Mailbox property, and the new name is specified by the NewName parameter.

Error Handling

Reset Method (IMAP Class)

Reset the class.

Syntax

int Reset();

Remarks

This method will reset the class's properties to their default values.

Error Handling

ResetMessageFlags Method (IMAP Class)

Replaces the flags of the messages specified by MessageSet with the flags specified by MessageFlags .

Syntax

int ResetMessageFlags();

Remarks

This method replaces the flags of the messages specified by the MessageSet property with the flags specified by the MessageFlags property. The format of the flags is specified by the IMAP RFCs.

Examples of possible flag values are server dependent, but can include:


\Deleted	Mark a message as deleted (for removal by later ExpungeMailbox).
\Seen	Mark a message as read.
\Answered	Mark a message as answered.
\Flagged	Mark a message as flagged.
\Draft	Mark a message as being incomplete (under composition).

Error Handling

SearchMailbox Method (IMAP Class)

Search selected mailbox for specified text.

Syntax

int SearchMailbox(const QString& qsSearchCriteria);

Remarks

This method searches the selected mailbox using the criteria specified in the SearchCriteria parameter. For every message matching the criteria, the FetchMessageInfo method is called and a MessageInfo event is fired.

The exact format of the search criteria is specified by the IMAP RFCs. The string consists of one or more search keys and their corresponding values (if any) separated by spaces, for example: "SINCE 1-Feb-1994 NOT FROM Smith".

Possible search keys include:


<message set>	Messages with message sequence numbers corresponding to the specified message sequence number set
ALL	All messages in the mailbox - this is the default initial key for AND-ing.
ANSWERED	Messages with the \Answered flag set.
BCC <string>	Messages that contain the specified string in the envelope structure's BCC field.
BEFORE <date>	Messages whose internal date is earlier than the specified date.
BODY <string>	Messages that contain the specified string in the body of the message.
CC <string>	Messages that contain the specified string in the envelope structure's CC field.
DELETED	Messages with the \Deleted flag set.
DRAFT	Messages with the \Draft flag set.
FLAGGED	Messages with the \Flagged flag set.
FROM <string>	Messages that contain the specified string in the envelope structure's FROM field.
HEADER <field-name> <string>	Messages that have a header with the specified field-name (as defined in [RFC-822]) and that contains the specified string in the [RFC-822] field-body.
KEYWORD <flag>	Messages with the specified keyword set.
LARGER <n>	Messages with an RFC822.SIZE larger than the specified number of octets.
NEW	Messages that have the \Recent flag set but not the \Seen flag. This is functionally equivalent to "(RECENT UNSEEN)".
NOT <search-key>	Messages that do not match the specified search key.
OLD	Messages that do not have the \Recent flag set. This is functionally equivalent to "NOT RECENT" (as opposed to "NOT NEW").
ON <date>	Messages whose internal date is within the specified date.
OR <search-key1> <search-key2>	Messages that match either search key.
RECENT	Messages that have the \Recent flag set.
SEEN	Messages that have the \Seen flag set.
SENTBEFORE <date>	Messages whose [RFC-822] Date: header is earlier than the specified date.
SENTON <date>	Messages whose [RFC-822] Date: header is within the specified date.
SENTSINCE <date>	Messages whose [RFC-822] Date: header is within or later than the specified date.
SINCE <date>	Messages whose internal date is within or later than the specified date.
SMALLER <n>	Messages with an RFC822.SIZE smaller than the specified number of octets.
SUBJECT <string>	Messages that contain the specified string in the envelope structure's SUBJECT field.
TEXT <string>	Messages that contain the specified string in the header or body of the message.
TO <string>	Messages that contain the specified string in the envelope structure's TO field.
UID <message set>	Messages with unique identifiers corresponding to the specified unique identifier set.
UNANSWERED	Messages that do not have the \Answered flag set.
UNDELETED	Messages that do not have the \Deleted flag set.
UNDRAFT	Messages that do not have the \Draft flag set.
UNFLAGGED	Messages that do not have the \Flagged flag set.
UNKEYWORD <flag>	Messages that do not have the specified keyword set.
UNSEEN	Messages that do not have the \Seen flag set.

Error Handling

SelectMailbox Method (IMAP Class)

Select a Mailbox.

Syntax

int SelectMailbox();

Remarks

This method asks the server to select the mailbox specified in the Mailbox property. The mailbox is selected in read/write mode (if the server permits).

Example (Open a Mailbox in Read/Write Mode)

IMAPControl.Mailbox = "INBOX" IMAPControl.SelectMailbox

Example (Open a Mailbox in Read-Only Mode)

IMAPControl.Mailbox = "INBOX.Folder" IMAPControl.ExamineMailbox

Error Handling

SendCommand Method (IMAP Class)

Sends the exact command directly to the server.

Syntax

int SendCommand(const QString& qsCommand);

Remarks

This method sends the command specified by Command to the server exactly as it is provided. Use this method to send additional or custom commands directly to the server.

After calling this method check the LastReply property and/or monitor the PITrail event to obtain the server's response.

Error Handling

SetMailboxACL Method (IMAP Class)

Sets mailbox access control rights for a specific user.

Syntax

int SetMailboxACL(const QString& qsUser, const QString& qsRights);

Remarks

This method changes the access control list for the mailbox specified in the Mailbox property so that User is granted the permissions specified in Rights.

Rights is a string containing an optional plus ("+") or minus ("-") prefix, followed by zero or more rights characters. If the string starts with a plus, the rights are added to any existing rights for the identifier. If the string starts with a minus, the rights are removed from any existing rights for the identifier. If the string does not start with a plus or minus, the rights replace any existing rights for the identifier.

Standard rights include:


l	Lookup (visible to be listed)
r	Read (Can be selected, fetched, searched, and copied)
s	Keep seen/unseen information across sessions
w	Write (Store flags other than SEEN and DELETED)
i	Insert (Can be appended, and copied into)
p	Post (Can send mail to submission address for mailbox)
c	Create (Can create new sub-mailboxes)
d	Delete (Store DELETED flag, perform EXPUNGE)
a	Administer (Set access permissions)

Error Handling

StartIdle Method (IMAP Class)

Begins idling.

Syntax

int StartIdle();

Remarks

This method sends the IDLE command to the server and begins idling. As responses are received from the server the IdleInfo event fires. To stop idling call StopIdle.

If the class is being used in a formless application (such as a console application) be sure to call DoEvents in a loop after calling this method to make sure incoming events are processed.

Error Handling

StopIdle Method (IMAP Class)

Stops idling.

Syntax

int StopIdle();

Remarks

This method stops idling if it was previously started via StartIdle. If the class is not idling this method does nothing.

Error Handling

SubscribeMailbox Method (IMAP Class)

Subscribes to the mailbox specified by Mailbox .

Syntax

int SubscribeMailbox();

Remarks

This method subscribes to the mailbox specified by the Mailbox property.

Error Handling

UnsetMessageFlags Method (IMAP Class)

Removes the flags specified by MessageFlags from the messages specified by MessageSet .

Syntax

int UnsetMessageFlags();

Remarks

This method removes the flags specified by the MessageFlags property from the messages specified by the MessageSet property. The format of the flags is specified by the IMAP RFCs.

Examples of possible flag values are server dependent, but can include:


\Deleted	Mark a message as deleted (for removal by later ExpungeMailbox).
\Seen	Mark a message as read.
\Answered	Mark a message as answered.
\Flagged	Mark a message as flagged.
\Draft	Mark a message as being incomplete (under composition).

Error Handling

UnsubscribeMailbox Method (IMAP Class)

Unsubscribes from the mailbox specified by Mailbox .

Syntax

int UnsubscribeMailbox();

Remarks

This method unsubscribes from the mailbox specified by the Mailbox property.

Error Handling

ConnectionStatus Event (IMAP Class)

Fired to indicate changes in connection state.

Syntax

class IMAPConnectionStatusEventParams {
public:
  const QString &ConnectionEvent();

  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ConnectionStatus(IMAPConnectionStatusEventParams *e);

// Or, subclass IMAP and override this emitter function.
virtual int FireConnectionStatus(IMAPConnectionStatusEventParams *e) {...}

Remarks

The ConnectionStatus event is fired when the connection state changes: completion of a firewall or proxy connection, completion of a security handshake, etc.

The ConnectionEvent parameter indicates the type of connection event. Values may include:


	Firewall connection complete.
	SSL or S/Shell handshake complete (where applicable).
	Remote host connection complete.
	Remote host disconnected.
	SSL or S/Shell connection broken.
	Firewall host disconnected.

StatusCode has the error code returned by the TCP/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

EndTransfer Event (IMAP Class)

Fired when the message or the part data finishes transferring.

Syntax

class IMAPEndTransferEventParams {
public:
  int Direction();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void EndTransfer(IMAPEndTransferEventParams *e);

// Or, subclass IMAP and override this emitter function.
virtual int FireEndTransfer(IMAPEndTransferEventParams *e) {...}

Remarks

The EndTransfer event is fired when the requested message body or part completes transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Error Event (IMAP Class)

Information about errors during data delivery.

Syntax

class IMAPErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(IMAPErrorEventParams *e);

// Or, subclass IMAP and override this emitter function.
virtual int FireError(IMAPErrorEventParams *e) {...}

Remarks

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

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

Header Event (IMAP Class)

Fired every time a header line comes in.

Syntax

class IMAPHeaderEventParams {
public:
  const QString &Field();

  const QString &Value();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Header(IMAPHeaderEventParams *e);

// Or, subclass IMAP and override this emitter function.
virtual int FireHeader(IMAPHeaderEventParams *e) {...}

Remarks

The Field parameter contains the name of the HTTP header (same case as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

IdleInfo Event (IMAP Class)

Fires whenever responses from the server are received while idling.

Syntax

class IMAPIdleInfoEventParams {
public:
  const QString &Message();

  bool Cancel();
  void SetCancel(bool bCancel);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void IdleInfo(IMAPIdleInfoEventParams *e);

// Or, subclass IMAP and override this emitter function.
virtual int FireIdleInfo(IMAPIdleInfoEventParams *e) {...}

Remarks

This event fires each time a response is received from the server after calling StartIdle. This will fire with information from the server intended to update the client. The type of data sent by the server may vary.

Message holds the response received from the server.

Cancel may be set to stop idling from within the event. This is equivalent to calling StopIdle.

Some possible values returned by the server are:

+ idling
* 43 EXISTS
* 1 RECENT

MailboxACL Event (IMAP Class)

Fires for each set of access control rights returned by the server.

Syntax

class IMAPMailboxACLEventParams {
public:
  const QString &Mailbox();

  const QString &User();

  const QString &Rights();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void MailboxACL(IMAPMailboxACLEventParams *e);

// Or, subclass IMAP and override this emitter function.
virtual int FireMailboxACL(IMAPMailboxACLEventParams *e) {...}

Remarks

Fires for each set of access control rights returned by the server after a call to GetMailboxACL. Standard rights include:


l	Lookup (visible to be listed)
r	Read (Can be selected, fetched, searched, and copied)
s	Keep seen/unseen information across sessions
w	Write (Store flags other than SEEN and DELETED)
i	Insert (Can be appended, and copied into)
p	Post (Can send mail to submission address for mailbox)
c	Create (Can create new sub-mailboxes)
d	Delete (Store DELETED flag, perform EXPUNGE)
a	Administer (Set access permissions)

MailboxList Event (IMAP Class)

Fired for each mailbox received through the ListMailboxes and ListSubscribedMailboxes methods.

Syntax

class IMAPMailboxListEventParams {
public:
  const QString &Mailbox();

  const QString &Separator();

  const QString &Flags();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void MailboxList(IMAPMailboxListEventParams *e);

// Or, subclass IMAP and override this emitter function.
virtual int FireMailboxList(IMAPMailboxListEventParams *e) {...}

Remarks

This method is fired for each mailbox received through the ListMailboxes and ListSubscribedMailboxes methods. The Separator parameter contains the character that separates the different parts in the mailbox path hierarchy.

MessageInfo Event (IMAP Class)

Fired with information for the message(s) retrieved by the server.

Syntax

class IMAPMessageInfoEventParams {
public:
  const QString &MessageId();

  const QString &Subject();

  const QString &MessageDate();

  const QString &From();

  const QString &Flags();

  qint64 Size();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void MessageInfo(IMAPMessageInfoEventParams *e);

// Or, subclass IMAP and override this emitter function.
virtual int FireMessageInfo(IMAPMessageInfoEventParams *e) {...}

Remarks

The MessageInfo event is fired when messages are searched, listed, or message information is received.

Id is the Id of the message.

Subject is the message subject.

MessageDate is the date of the message.

From is the email address of the sender.

Flags is a list of flags associated with this message.

Size is the size of the message.

More information may be received from the respective properties, such as: MessageContentType, MessageContentEncoding, MessageRecipients, MessageDeliveryTime, MessageFlags, MessageHeaders, MessageInReplyTo, MessageNetId, MessageReplyTo, MessageSender, MessageSize, MessageSubject, MessageText, etc.

MessagePart Event (IMAP Class)

Fired for each message part when FetchMessageInfo is called.

Syntax

class IMAPMessagePartEventParams {
public:
  const QString &PartId();

  qint64 Size();

  const QString &ContentType();

  const QString &Filename();

  const QString &ContentEncoding();

  const QString &Parameters();

  const QString &MultipartMode();

  const QString &ContentId();

  const QString &ContentDisposition();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void MessagePart(IMAPMessagePartEventParams *e);

// Or, subclass IMAP and override this emitter function.
virtual int FireMessagePart(IMAPMessagePartEventParams *e) {...}

Remarks

The PartId parameter denotes the PartId which may be identified in other parts or messages. The format of part id-s is specified by the IMAP RFCs.

The Size parameter gives the size of this part.

The ContentType parameter shows the type of data contained in the part.

The ContentEncoding parameter shows how the data is encoded.

The Filename parameter shows the filename corresponding to the part (if the part was included in the message as an attached file).

The Parameters parameter contains the additional parameters passed to the ContentType header such as the part charset etc.

The MultipartMode parameter shows the how this part relates to the message's whole multipart structure ('mixed', 'alternative', etc.).

The ContentId parameter shows the value of the Content-Id header for the part.

The ContentEncoding parameter shows the value of the Content-Encoding header for the part.

PITrail Event (IMAP Class)

Traces the commands sent to the mail server, and the respective replies.

Syntax

class IMAPPITrailEventParams {
public:
  int Direction();

  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void PITrail(IMAPPITrailEventParams *e);

// Or, subclass IMAP and override this emitter function.
virtual int FirePITrail(IMAPPITrailEventParams *e) {...}

Remarks

The PITrail event is useful for debugging as well as learning purposes. It shows all the interaction between the client and the server, line by line, except for message header and body transfers.

The Message parameter contains the full text of the message. The Direction parameter shows the originator of the message:


0 (Client)	The `Message` originates from the client.
1 (Server)	The `Message` originates from the server.
2 (Information)	The `Message` is an informative message originating from the client software (the class code).

SSLServerAuthentication Event (IMAP Class)

Fired after the server presents its certificate to the client.

Syntax

class IMAPSSLServerAuthenticationEventParams {
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(IMAPSSLServerAuthenticationEventParams *e);

// Or, subclass IMAP and override this emitter function.
virtual int FireSSLServerAuthentication(IMAPSSLServerAuthenticationEventParams *e) {...}

Remarks

This event is where the client can decide whether to continue with the connection process or not. 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 to continue or not.

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

Shows the progress of the secure connection.

Syntax

class IMAPSSLStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLStatus(IMAPSSLStatusEventParams *e);

// Or, subclass IMAP and override this emitter function.
virtual int FireSSLStatus(IMAPSSLStatusEventParams *e) {...}

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

StartTransfer Event (IMAP Class)

Fired when the message or the part data starts transferring.

Syntax

class IMAPStartTransferEventParams {
public:
  int Direction();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void StartTransfer(IMAPStartTransferEventParams *e);

// Or, subclass IMAP and override this emitter function.
virtual int FireStartTransfer(IMAPStartTransferEventParams *e) {...}

Remarks

The StartTransfer event is fired when the message body or the part data starts transferring from the server to the local host. Further progress information is provided by the Transfer and EndTransfer events.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Transfer Event (IMAP Class)

Fired while the message gets transferred from the MailServer .

Syntax

class IMAPTransferEventParams {
public:
  int Direction();

  qint64 BytesTransferred();

  int PercentDone();

  const QString &Text();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Transfer(IMAPTransferEventParams *e);

// Or, subclass IMAP and override this emitter function.
virtual int FireTransfer(IMAPTransferEventParams *e) {...}

Remarks

The Transfer event is fired for every incoming line when receiving a message or part data from the MailServer

The Text parameter contains the portion of the message or the part data being retrieved.

The BytesTransferred parameter contains the number of bytes transferred since the beginning of the message, including header bytes. At the end of transmission (i.e. when the last Transfer event is fired), BytesTransferred equals the value of the MessageSize property.

The Transfer event is fired for every line of the message. There is no terminating newline at the end of the Text parameter. A faster way to retrieve a message is to assign a value to the LocalFile property and use the Transfer event only to check the progress rather than to get the actual data.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note that events are not re-entrant. Performing time consuming operations within this event will prevent it from firing again in a timely manner and may impact overall performance.

Configuration Settings (IMAP 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.

IMAP Configuration Settings

AlwaysReturnUIDs: Instructs the server to return UIDs even if not in UIDMode.

If UIDMode is set to false the MessageSet contains session message ids, and the response from the server is going to contain session message ids as well. In some cases it is desirable that the server sends back UIDs; set the AlwaysReturnUIDs to True to instruct the server to do so.

The default value for this setting is False.

AppendToMailboxDateTime: Specifies the date-time parameter used in the initial APPEND request.

When appending to a mailbox using the AppendToMailbox method, the IMAP RFC specifies a date-time parameter that can be used to set the internal date of the resulting message. This configuration setting can be used to specify the date-time parameter used in this case.

The date-time should be formatted according to the IMAP RFC specifications. For example, "22-Jan-2013 12:34:56 -0500" indicates January 22nd, 2013 at 12:34:56 PM EST.

By default, if this setting is not specified, no date-time is sent with the APPEND request and the server will use the current time.

AuthorizationIdentity: The value to use as the authorization identity when SASL authentication is used.

When AuthMechanism is set to amSASLPlain, amSASLDigestMD5, or amXOAUTH2 you may use this setting to specify an authorization identity to be used when authenticating. In the case of amXOAUTH2 this should be your OAUTH authorization string. For instance:

Bearer ya29.AHES6ZRmS-8xPbpGetC1VbABJIBRdKm-c4X7wMVGAbgxdGt5q8Ts3Q

Note: When using amXOAUTH2 User must be specified, but Password is not required.

AutoDecodeSubject: Instructs the class to automatically decode message subjects.

Subjects that have been Quoted-Printable or Base-64 encoded are automatically decoded when this configuration setting is True (default). Only subjects in the format "=?iso-8859-1?Q?data?=" will be correctly decoded.

AutoDecodeText: Whether to decode MessageText when AutoDecodeParts is True.

When AutoDecodeParts is True this setting controls whether MessageText is also decoded. When AutoDecodeText is True (default) MessageText is decoded. When set to False MessageText is not decoded. This setting is only applicable when AutoDecodeParts is set to True.

FetchAfterSearch: Determines if messages matching the SearchCriteria are fetched after calling SearchMailbox.

If set to False, FetchMessageInfo will not be called for messages matching the SearchCriteria after calling SearchMailbox. MessageInfo will still fire, but the MessageId parameter will be the only parameter populated. The default value of this setting is True.

FetchTextAndHeaders: Specifies whether the message body and headers are fetched in a single request.

This setting specifies whether the FetchMessageText method fetches both the message headers and text, or just the message text. By default this value is false and FetchMessageText will fetch only the message text from the server. When set to true the class will fetch both the message text and headers in a single request from the server and populate both MessageHeadersString and MessageText.

IncludeHeaders: Instructs the class to include the headers in the LocalFile.

When set to true, the headers for the message you are fetching will be written to the LocalFile before the message body. In this manner, the whole content of a MIME-encoded message will be written to the file.

MaskSensitive: Whether sensitive properties should be masked when logging.

By default, the PITrail event will include the raw commands sent to the IMAP server, including sensitive values like passwords. To prevent passwords from appearing in plain text when logging, set this option to True. The default value is False.

SendIDCommand: Instructs class to send the ID command if the server advertises support for it.

This setting specifies whether the class will use the IMAP4 ID Extension defined in RFC 2971 and send the ID command to the server. When set to true the class will send the ID command with the value IPWorksIMAP if the server supports this as defined in the server's response to the CAPABILITY command.

The default value is false and this command will not be sent.

UTF7MailboxNames: Specifies whether or not to automatically encode and decode UTF-7 mailbox names.

IMAP servers may represent some characters in a mailbox name in UTF-7 format. This setting determines whether or not the class should automatically encode and decode these values. When set to false no encoding or decoding will be performed by the class. The default value is true.

IPPort Configuration Settings

ConnectionTimeout: Sets a separate timeout value for establishing a connection.

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.

FirewallAutoDetect: Tells the class whether or not to automatically detect and use firewall system settings, if available.

This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallHost: Name or IP address of firewall (optional).

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.

FirewallPassword: Password to be used if authentication is to be used when connecting through the firewall.

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.

FirewallPort: The TCP port for the FirewallHost;.

Note that the FirewallPort is set automatically when FirewallType is set to a valid value.

NOTE: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallType: Determines the type of firewall to connect through.

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.

FirewallUser: A user name if authentication is to be used connecting through a firewall.

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.

KeepAliveInterval: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.

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 acknowledgement is received from the remote host the keep-alive packet will be re-sent. This 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.

KeepAliveTime: The inactivity time in milliseconds before a TCP keep-alive packet is sent.

When set, TCPKeepAlive will automatically be set to true. By default the operating system will determine the time a connection is idle before a 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.

Linger: When set to True, connections are terminated gracefully.

This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), there are two scenarios for determining how long the connection will linger. The first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP protocol timeout expires.

In the second scenario, 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 is 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 (by a client acknowledgment, for example), setting this property to False might be the appropriate course of action.

LingerTime: Time in seconds to have the connection linger.

LingerTime is the time, in seconds, to leave the socket connection linger. This value is 0 by default, which means it will use the default IP protocol timeout.

LocalHost: The name of the local host through which connections are initiated or accepted.

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.

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

LocalPort: The port in the local host where the class binds.

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: The maximum amount of data to accumulate when no EOL is found.

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.

MaxTransferRate: The transfer rate limit in bytes per second.

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

ProxyExceptionsList: A semicolon separated list of hosts and IPs to bypass when using a proxy.

This 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

TCPKeepAlive: Determines whether or not the keep alive socket option is enabled.

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.

TcpNoDelay: Whether or not to delay when sending packets.

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.

UseIPv6: Whether to use IPv6.

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 Configuration Settings

LogSSLPackets: Controls whether SSL packets are logged when using the internal security API.

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.

OpenSSLCADir: The path to a directory containing CA certificates.

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.

OpenSSLCAFile: Name of the file containing the list of CA's trusted by your application.

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.

OpenSSLCipherList: A string that controls the ciphers to be used by SSL.

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

OpenSSLPrngSeedData: The data to seed the pseudo random number generator (PRNG).

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.

ReuseSSLSession: Determines if the SSL session is reused.

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.

SSLCACerts: A newline separated list of CA certificate to use during SSL client authentication.

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

SSLCheckCRL: Whether to check the Certificate Revocation List for the server certificate.

This setting specifies whether the class will check the Certificate Revocation List specified by the server certificate. If set to 1 or 2, the class will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The class will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class fails with an error.

When set to 0 (default) the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.

This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.

SSLCipherStrength: The minimum cipher strength used for bulk encryption.

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.

SSLEnabledCipherSuites: The cipher suite to be used in an SSL negotiation.

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

Example values when SSLProvider is set to Internal:

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.

SSLEnabledProtocols: Used to enable/disable the supported security protocols.

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)
SSL2	12 (Hex 0C)

SSLEnabledProtocols - TLS 1.3 Notes

By default when TLS 1.3 is enabled the class will use the internal TLS implementation.

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.

SSLEnableRenegotiation: Whether the renegotiation_info SSL extension is supported.

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.

SSLIncludeCertChain: Whether the entire certificate chain is included in the SSLServerAuthentication event.

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.

SSLKeyLogFile: The location of a file where per-session secrets are written for debugging purposes.

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.

SSLNegotiatedCipher: Returns the negotiated ciphersuite.

Returns the ciphersuite negotiated during the SSL handshake.

Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipher[connId]");

SSLNegotiatedCipherStrength: Returns the negotiated ciphersuite strength.

Returns the strength of the ciphersuite negotiated during the SSL handshake.

Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherStrength[connId]");

SSLNegotiatedCipherSuite: Returns the negotiated ciphersuite.

Returns the ciphersuite negotiated during the SSL handshake represented as a single string.

Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherSuite[connId]");

SSLNegotiatedKeyExchange: Returns the negotiated key exchange algorithm.

Returns the key exchange algorithm negotiated during the SSL handshake.

Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchange[connId]");

SSLNegotiatedKeyExchangeStrength: Returns the negotiated key exchange algorithm strength.

Returns the strenghth of the key exchange algorithm negotiated during the SSL handshake.

Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchangeStrength[connId]");

SSLNegotiatedVersion: Returns the negotiated protocol version.

Returns the protocol version negotiated during the SSL handshake.

Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedVersion[connId]");

SSLSecurityFlags: Flags that control certificate verification.

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.

SSLServerCACerts: A newline separated list of CA certificate to use during SSL server certificate validation.

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

TLS12SignatureAlgorithms: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.

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: IPPort.SSLProvider = IpportSSLProviders.sslpInternal; IPPort.Config("SSLEnabledProtocols=3072"); //TLS 1.2 IPPort.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.

TLS12SupportedGroups: The supported groups for ECC.

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)

TLS13KeyShareGroups: The groups for which to pregenerate key shares.

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"

TLS13SignatureAlgorithms: The allowed certificate signature algorithms.

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)

The default value is rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448. This setting is only applicable when SSLEnabledProtocols includes TLS 1.3.

TLS13SupportedGroups: The supported groups for (EC)DHE key exchange.

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 Configuration Settings

AbsoluteTimeout: Determines whether timeouts are inactivity timeouts or absolute timeouts.

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.

FirewallData: Used to send extra data to the firewall.

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

InBufferSize: The size in bytes of the incoming queue of the socket.

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.

OutBufferSize: The size in bytes of the outgoing queue of the socket.

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 Configuration Settings

BuildInfo: Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage: The system code page used for Unicode to Multibyte translations.

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

The following is a list of valid code page identifiers for Mac OS only:


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

LicenseInfo: Information about the current license.

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.

UseInternalSecurityAPI: Tells the class whether or not to use the system security libraries or an internal implementation.

By default the class will use the system security libraries to perform cryptographic functions where applicable. Setting this to true tells the class to use the internal implementation instead of using the system's security API.

Trappable Errors (IMAP Class)

IMAP Errors

118   Firewall Error. Error message contains detailed description.
311   Protocol error.
312   Busy executing current method.
314   A Mailbox must be selected before calling this method.
315   Invalid argument. Please specify a valid MessageSet.
317   Unknown content encoding.
318   LocalFile already exists and Overwrite is False.

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

IPPort 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   Cannot change 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).


	118 Firewall Error. Error message contains detailed description.
	311 Protocol error.
	312 Busy executing current method.
	314 A Mailbox must be selected before calling this method.
	315 Invalid argument. Please specify a valid MessageSet.
	317 Unknown content encoding.
	318 LocalFile already exists and Overwrite is False.


	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 Cannot change 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.


	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.


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

IPWorks 2022 Qt Edition

IMAP Class

Syntax

Remarks

Property List

Method List

Event List

Configuration Settings

AuthMechanism Property (IMAP Class)

Syntax

Possible Values

Default Value

Remarks

Data Type

AutoDecodeParts Property (IMAP Class)

Syntax

Default Value

Remarks

Data Type

Connected Property (IMAP Class)

Syntax

Default Value

Remarks

Data Type

EndByte Property (IMAP Class)

Syntax

Default Value

Remarks

Data Type

FirewallAutoDetect Property (IMAP Class)

Syntax

Default Value

Remarks

Data Type

FirewallType Property (IMAP Class)

Syntax

Possible Values

Default Value

Remarks

Data Type

FirewallHost Property (IMAP Class)

Syntax

Default Value

Remarks

Data Type

FirewallPassword Property (IMAP Class)

Syntax

Default Value

Remarks

Data Type

FirewallPort Property (IMAP Class)

Syntax

Default Value

Remarks

Data Type

FirewallUser Property (IMAP Class)

Syntax

Default Value

Remarks

Data Type

Idle Property (IMAP Class)

Syntax

Default Value

Remarks

Data Type

LastReply Property (IMAP Class)

Syntax

Default Value

Remarks

Data Type

LocalFile Property (IMAP Class)

Syntax

Default Value

Remarks

Data Type

LocalHost Property (IMAP Class)

Syntax

Default Value

Remarks

Data Type