IMAP Module

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

IPWorks.Imap

Remarks

The IMAP Class supports both plaintext and Secure Sockets Layer/Transport Layer Security (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 using 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 and MessageFlags.

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

The MessagePart event describes the MIME structure of the 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 module with short descriptions. Click on the links for further details.

AuthMechanismThis property includes the authentication mechanism to be used when connecting to the mail server.
AutoDecodePartsThis property determines whether or not to automatically decode message parts.
CommandThis property can be used to send additional commands directly to the server.
ConnectedThis shows whether the module is connected.
EndByteThis property includes the byte index of the position where the transfer should end.
FirewallA set of properties related to firewall access.
IdleThe current status of the module.
LastReplyThe last reply from the server.
LocalFileThis property includes the path to a local file for downloading the message body.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
MailboxThis property includes the name of the mailbox selected on the server.
MailboxFlagsThis property defines flags in the selected mailbox.
MailboxListThe property includes the collection of mailboxes listed by the server.
MailPortThis property includes the port of the IMAP server (default is 143).
MailServerThis property includes the name or address of the mail server (IMAP server).
MessageThis property provides the raw message content.
MessageContentEncodingThis property includes the ContentEncoding of the selected message.
MessageContentTypeThis property includes the ContentType of the message.
MessageCountThis property includes the total number of messages on the Mailbox .
MessageDateThe property includes the time the message was created.
MessageDeliveryTimeThis property includes the time the message was delivered to the mail server.
MessageFlagsThis property contains the flags of the current message.
MessageFromThis property includes the address of the author of the message.
MessageHeadersThis property includes the collection of RFC 822-encoded headers of the message.
MessageHeadersStringThis property includes the string version of the RFC 822-encoded headers in the message.
MessageIdThis property includes the message identifier of the current message.
MessageInfoThis property includes the collection of messages retrieved by FetchMessageInfo .
MessageInReplyToThis property includes the unique message identifier of the message being replied to.
MessageNetIdThis property includes the globally unique identifier of the message.
MessagePartsThis property includes a collection of message parts collected by FetchMessageInfo .
MessageRecipientsThis property includes a collection of recipients for the current message.
MessageReplyToThis property includes the email addresses to which replies to the message should be sent.
MessageSenderThis property includes the address of the sender of the message.
MessageSetThis property includes the set of messages to operate on.
MessageSizeThis property includes the size of the selected message.
MessageSubjectThis property includes the subject of the message.
MessageTextThis property includes the body of the retrieved message.
OverwriteThis property indicates whether or not the module should overwrite files during transfer.
PasswordThis property includes the password to be used to authenticate to the MailServer .
PeekModeWhen set to True, the message Seen flag is not changed during reading.
RecentMessageCountThis property includes the number of new messages in the Mailbox .
SortCriteriaThis property sorts criteria to use for message retrieval operations.
SSLAcceptServerCertEncodedThis is the certificate (PEM/base64 encoded).
SSLCertEncodedThis is the certificate (PEM/base64 encoded).
SSLCertStoreThis is the name of the certificate store for the client certificate.
SSLCertStorePasswordIf the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SSLCertStoreTypeThis is the type of certificate store for this certificate.
SSLCertSubjectThis is the subject of the certificate used for client authentication.
SSLEnabledWhether TLS/SSL is enabled.
SSLProviderThis specifies the SSL/TLS implementation to use.
SSLServerCertEncodedThis is the certificate (PEM/base64 encoded).
SSLStartModeDetermines how the module starts the SSL negotiation.
StartByteThis property includes the byte index of the position where the transfer should start.
TimeoutA timeout for the module.
UIDModeIf True, this property indicates whether permanent message identifiers are used instead of the default temporary identifiers.
UIDValidityThis property includes the UIDValidity parameter sent from the server in response to SelectMailbox command.
UserThis property includes the username used to authenticate to the MailServer .

Method List


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

AddMessageFlagsThis method adds the specified flags to the messages specified by MessageSet .
AppendToMailboxThis method appends the message in MessageText to the mailbox specified by Mailbox .
CheckMailboxThis method sends a CHECK command to the server.
CloseMailboxThis method removes all messages marked with a 'Deleted' flag from the currently selected mailbox and closes the unselected mailbox.
ConfigSets or retrieves a configuration setting.
ConnectThis method connects to an IMAP server.
CopyToMailboxThis method copies the messages specified by MessageSet to the mailbox specified by Mailbox .
CreateMailboxThis method creates a new mailbox specified by Mailbox .
DeleteFromMailboxThe method marks the messages specified by MessageSet as deleted.
DeleteMailboxThis method deletes a mailbox specified by Mailbox .
DeleteMailboxACLThis method deletes mailbox access control rights for a specific user.
DisconnectThis method disconnects from an IMAP server.
DoEventsProcesses events from the internal message queue.
ExamineMailboxThis method selects a mailbox in read-only mode.
ExpungeMailboxThis method removes all messages marked with a 'Deleted' flag from the currently selected mailbox.
FetchMessageHeadersThis method retrieves the message headers of the messages specified by the MessageSet property.
FetchMessageInfoThis method retrieves information about messages specified by the MessageSet property.
FetchMessagePartThis method retrieves the message part specified by PartID.
FetchMessagePartHeadersThis method retrieves the headers of message part specified by PartID.
FetchMessageTextThis method retrieves the message text of the messages specified by the MessageSet property.
GetMailboxACLThis method retrieves mailbox access control rights.
InterruptInterrupt the current method.
ListMailboxesThis method lists all of the mailboxes matching all criteria in the Mailbox property.
ListSubscribedMailboxesThis method lists all subscribed mailboxes matching all criteria in the Mailbox property.
LocalizeDateThis method converts a valid RFC 822 message date to a local date and time.
MoveToMailboxThis method moves the messages specified by MessageSet to the mailbox specified by Mailbox .
NoopThis method sends a NOOP command to the server.
RenameMailboxThis method changes the name of Mailbox to NewName .
ResetReset the module.
ResetMessageFlagsThis method replaces the flags of the messages specified by MessageSet with the flags specified by MessageFlags .
SearchMailboxThis method searches the selected mailbox for specified text.
SelectMailboxThis method selects a mailbox.
SendCommandSends the exact command directly to the server.
SetMailboxACLThis method sets mailbox access control rights for a specific user.
StartIdleThis method begins idling.
StopIdleThis method stops idling.
SubscribeMailboxThis method subscribes to the mailbox specified by Mailbox .
UnsetMessageFlagsThis method removes the flags specified by MessageFlags from the messages specified by MessageSet .
UnsubscribeMailboxThis method unsubscribes from the mailbox specified by Mailbox .

Event List


The following is the full list of the events fired by the module with short descriptions. Click on the links for further details.

ConnectionStatusThis event is fired to indicate changes in the connection state.
EndTransferThis event is fired when the message or the part data finishes transferring.
ErrorInformation about errors during data delivery.
HeaderThis event is fired every time a header line comes in.
IdleInfoThis event fires whenever responses from the server are received while idling.
MailboxACLThis event fires for each set of access control rights returned by the server.
MailboxListThis event fires for each mailbox received through the ListMailboxes and ListSubscribedMailboxes methods.
MessageInfoThis event is fired with information for the messages retrieved by the server.
MessagePartThis event is fired for each message part when FetchMessageInfo is called.
PITrailThis event traces the commands sent to the mail server, and the respective replies.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
StartTransferThis event is fired when the message body or the part data start transferring.
TransferThis event is fired while the message is transferred from the MailServer .

Config Settings


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

AlwaysReturnUIDsInstructs the server to return UIDs even if not in UIDMode.
AppendToMailboxDateTimeSpecifies the date-time parameter used in the initial APPEND request.
AuthorizationIdentityThe value to use as the authorization identity when SASL authentication is used.
AutoDecodeSubjectInstructs the module to automatically decode message subjects.
AutoDecodeTextWhether to decode MessageText when AutoDecodeParts is True.
FetchAfterSearchDetermines if messages matching the SearchCriteria are fetched after calling SearchMailbox.
FetchTextAndHeadersSpecifies whether the message body and headers are fetched in a single request.
IncludeHeadersInstructs the module to include the headers in the LocalFile.
MaskSensitiveWhether sensitive properties should be masked when logging.
SendIDCommandInstructs module to send the ID command if the server advertises support for it.
UTF7MailboxNamesSpecifies whether or not to automatically encode and decode UTF-7 mailbox names.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the module whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the module binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCheckOCSPWhether to use OCSP to check the status of the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFileThe location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipherReturns the negotiated cipher suite.
SSLNegotiatedCipherStrengthReturns the negotiated cipher suite strength.
SSLNegotiatedCipherSuiteReturns the negotiated cipher suite.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedVersionReturns the negotiated protocol version.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
MaskSensitiveWhether sensitive data is masked in log messages.
UseInternalSecurityAPITells the module whether or not to use the system security libraries or an internal implementation.

AuthMechanism Property (IMAP Module)

This property includes the authentication mechanism to be used when connecting to the mail server.

Syntax

public var authMechanism: ImapAuthMechanisms {
  get {...}
  set {...}
}

public enum ImapAuthMechanisms: Int32 { case amUserPassword = 0 case amCRAMMD5 = 1 case amNTLM = 2 case amAPOP = 3 case amSASLPlain = 4 case amSASLDigestMD5 = 5 case amKerberos = 6 case amXOAUTH2 = 7 }

@property (nonatomic,readwrite,assign,getter=authMechanism,setter=setAuthMechanism:) int authMechanism;

- (int)authMechanism;
- (void)setAuthMechanism :(int)newAuthMechanism;

Default Value

0

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: Servers often require the Secure Sockets Layer (SSL) to 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.

AutoDecodeParts Property (IMAP Module)

This property determines whether or not to automatically decode message parts.

Syntax

public var autoDecodeParts: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=autoDecodeParts,setter=setAutoDecodeParts:) BOOL autoDecodeParts;

- (BOOL)autoDecodeParts;
- (void)setAutoDecodeParts :(BOOL)newAutoDecodeParts;

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.

Command Property (IMAP Module)

This property can be used to send additional commands directly to the server.

Syntax

public var command: String {  set {...}
}

@property (nonatomic,readwrite,assign,getter=command,setter=setCommand:) NSString* command;

- (NSString*)command;
- (void)setCommand :(NSString*)newCommand;

Default Value

""

Remarks

Setting this property directs the class to send the assigned command to the MailServer.

Check the LastReply property or trap the PITrail events coming from the server to get the responses.

This property is write-only.

Connected Property (IMAP Module)

This shows whether the module is connected.

Syntax

public var connected: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=connected,setter=setConnected:) BOOL connected;

- (BOOL)connected;
- (void)setConnected :(BOOL)newConnected;

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.

EndByte Property (IMAP Module)

This property includes the byte index of the position where the transfer should end.

Syntax

public var endByte: Int64 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=endByte,setter=setEndByte:) long long endByte;

- (long long)endByte;
- (void)setEndByte :(long long)newEndByte;

Default Value

0

Remarks

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

When StartByte or EndByte contain values other than the default (0), only the corresponding portion of the message 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.

Firewall Property (IMAP Module)

A set of properties related to firewall access.

Syntax

public var firewall: Firewall {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=firewallAutoDetect,setter=setFirewallAutoDetect:) BOOL firewallAutoDetect;

- (BOOL)firewallAutoDetect;
- (void)setFirewallAutoDetect :(BOOL)newFirewallAutoDetect;

@property (nonatomic,readwrite,assign,getter=firewallType,setter=setFirewallType:) int firewallType;

- (int)firewallType;
- (void)setFirewallType :(int)newFirewallType;

@property (nonatomic,readwrite,assign,getter=firewallHost,setter=setFirewallHost:) NSString* firewallHost;

- (NSString*)firewallHost;
- (void)setFirewallHost :(NSString*)newFirewallHost;

@property (nonatomic,readwrite,assign,getter=firewallPassword,setter=setFirewallPassword:) NSString* firewallPassword;

- (NSString*)firewallPassword;
- (void)setFirewallPassword :(NSString*)newFirewallPassword;

@property (nonatomic,readwrite,assign,getter=firewallPort,setter=setFirewallPort:) int firewallPort;

- (int)firewallPort;
- (void)setFirewallPort :(int)newFirewallPort;

@property (nonatomic,readwrite,assign,getter=firewallUser,setter=setFirewallUser:) NSString* firewallUser;

- (NSString*)firewallUser;
- (void)setFirewallUser :(NSString*)newFirewallUser;

 

Default Value

""

Remarks

This is a Firewall type property which contains fields describing the firewall through which the class will attempt to connect.

Idle Property (IMAP Module)

The current status of the module.

Syntax

public var idle: Bool {
  get {...}
}

@property (nonatomic,readonly,assign,getter=idle) BOOL idle;

- (BOOL)idle;

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.

LastReply Property (IMAP Module)

The last reply from the server.

Syntax

public var lastReply: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=lastReply) NSString* lastReply;

- (NSString*)lastReply;

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.

LocalFile Property (IMAP Module)

This property includes the path to a local file for downloading the message body.

Syntax

public var localFile: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=localFile,setter=setLocalFile:) NSString* localFile;

- (NSString*)localFile;
- (void)setLocalFile :(NSString*)newLocalFile;

Default Value

""

Remarks

This property is used when retrieving a message. If the file exists, and the Overwrite property is set to true, then the component will overwrite the file.

If this property is empty, then the received data is provided through the MessageText property and the parameters for the Transfer event.

LocalHost Property (IMAP Module)

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

Syntax

public var localHost: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=localHost,setter=setLocalHost:) NSString* localHost;

- (NSString*)localHost;
- (void)setLocalHost :(NSString*)newLocalHost;

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.

Mailbox Property (IMAP Module)

This property includes the name of the mailbox selected on the server.

Syntax

public var mailbox: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=mailbox,setter=setMailbox:) NSString* mailbox;

- (NSString*)mailbox;
- (void)setMailbox :(NSString*)newMailbox;

Default Value

"Inbox"

Remarks

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

Example 1. Open a Mailbox in Read/Write Mode:

IMAPControl.Mailbox = "INBOX" IMAPControl.SelectMailbox

Example 2. Open a Mailbox in Read-Only Mode:

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

MailboxFlags Property (IMAP Module)

This property defines flags in the selected mailbox.

Syntax

public var mailboxFlags: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=mailboxFlags) NSString* mailboxFlags;

- (NSString*)mailboxFlags;

Default Value

""

Remarks

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

MailboxList Property (IMAP Module)

The property includes the collection of mailboxes listed by the server.

Syntax

public var mailboxList: Array<Mailbox> {
  get {...}
}

@property (nonatomic,readonly,assign,getter=mailboxListCount) int mailboxListCount;

- (int)mailboxListCount;

- (NSString*)mailboxListFlags:(int)mailboxListIndex;

- (NSString*)mailboxListName:(int)mailboxListIndex;

- (NSString*)mailboxListSeparator:(int)mailboxListIndex;

Default Value

""

Remarks

This collection contains a list of mailboxes returned by the server when ListMailboxes or ListSubscribedMailboxes is called.

MailboxLimit can be used to control the number of mailboxes saved.

MailPort Property (IMAP Module)

This property includes the port of the IMAP server (default is 143).

Syntax

public var mailPort: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=mailPort,setter=setMailPort:) int mailPort;

- (int)mailPort;
- (void)setMailPort :(int)newMailPort;

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 the implicit Secure Sockets Layer (SSL), use port 993 (please refer to the SSLStartMode property for more information).

MailServer Property (IMAP Module)

This property includes the name or address of the mail server (IMAP server).

Syntax

public var mailServer: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=mailServer,setter=setMailServer:) NSString* mailServer;

- (NSString*)mailServer;
- (void)setMailServer :(NSString*)newMailServer;

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.

Message Property (IMAP Module)

This property provides the raw message content.

Syntax

public var message: String {
  get {...}
  set {...}
}

public var messageB: Data { get {...} set {...} }

@property (nonatomic,readwrite,assign,getter=message,setter=setMessage:) NSString* message;

- (NSString*)message;
- (void)setMessage :(NSString*)newMessage;

@property (nonatomic,readwrite,assign,getter=messageB,setter=setMessageB:) NSData* messageB;

- (NSData*)messageB;
- (void)setMessageB :(NSData*)newMessage;

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.

MessageContentEncoding Property (IMAP Module)

This property includes the ContentEncoding of the selected message.

Syntax

public var messageContentEncoding: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=messageContentEncoding) NSString* messageContentEncoding;

- (NSString*)messageContentEncoding;

Default Value

""

Remarks

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

This property is read-only.

MessageContentType Property (IMAP Module)

This property includes the ContentType of the message.

Syntax

public var messageContentType: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=messageContentType) NSString* messageContentType;

- (NSString*)messageContentType;

Default Value

""

Remarks

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

This property is read-only.

MessageCount Property (IMAP Module)

This property includes the total number of messages on the Mailbox .

Syntax

public var messageCount: Int32 {
  get {...}
}

@property (nonatomic,readonly,assign,getter=messageCount) int messageCount;

- (int)messageCount;

Default Value

0

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.

MessageDate Property (IMAP Module)

The property includes the time the message was created.

Syntax

public var messageDate: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=messageDate) NSString* messageDate;

- (NSString*)messageDate;

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.

MessageDeliveryTime Property (IMAP Module)

This property includes the time the message was delivered to the mail server.

Syntax

public var messageDeliveryTime: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=messageDeliveryTime) NSString* messageDeliveryTime;

- (NSString*)messageDeliveryTime;

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 RFC 821.

This property is read-only.

MessageFlags Property (IMAP Module)

This property contains the flags of the current message.

Syntax

public var messageFlags: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=messageFlags,setter=setMessageFlags:) NSString* messageFlags;

- (NSString*)messageFlags;
- (void)setMessageFlags :(NSString*)newMessageFlags;

Default Value

""

Remarks

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

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

\Deleted Mark a message as deleted (for removal later by 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")

MessageFrom Property (IMAP Module)

This property includes the address of the author of the message.

Syntax

public var messageFrom: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=messageFrom) NSString* messageFrom;

- (NSString*)messageFrom;

Default Value

""

Remarks

This property normally has the same value as MessageSender.

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

This property is read-only.

MessageHeaders Property (IMAP Module)

This property includes the collection of RFC 822-encoded headers of the message.

Syntax

public var messageHeaders: Array<Header> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=messageHeaderCount,setter=setMessageHeaderCount:) int messageHeaderCount;

- (int)messageHeaderCount;
- (void)setMessageHeaderCount :(int)newMessageHeaderCount;

- (NSString*)messageHeaderField:(int)messageHeaderIndex;
- (void)setMessageHeaderField:(int)messageHeaderIndex :(NSString*)newMessageHeaderField;

- (NSString*)messageHeaderValue:(int)messageHeaderIndex;
- (void)setMessageHeaderValue:(int)messageHeaderIndex :(NSString*)newMessageHeaderValue;

Default Value

""

Remarks

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

MessageHeadersString Property (IMAP Module)

This property includes the string version of the RFC 822-encoded headers in the message.

Syntax

public var messageHeadersString: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=messageHeadersString,setter=setMessageHeadersString:) NSString* messageHeadersString;

- (NSString*)messageHeadersString;
- (void)setMessageHeadersString :(NSString*)newMessageHeadersString;

Default Value

""

Remarks

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

MessageId Property (IMAP Module)

This property includes the message identifier of the current message.

Syntax

public var messageId: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=messageId) NSString* messageId;

- (NSString*)messageId;

Default Value

""

Remarks

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

This Id is permanent if UIDMode is set, and otherwise is temporary.

This property is read-only.

MessageInfo Property (IMAP Module)

This property includes the collection of messages retrieved by FetchMessageInfo .

Syntax

public var messageInfo: Array<MessageInfo> {
  get {...}
}

@property (nonatomic,readonly,assign,getter=messageInfoCount) int messageInfoCount;

- (int)messageInfoCount;

- (NSString*)messageInfoDate:(int)messageInfoIndex;

- (NSString*)messageInfoFlags:(int)messageInfoIndex;

- (NSString*)messageInfoFrom:(int)messageInfoIndex;

- (NSString*)messageInfoMessageId:(int)messageInfoIndex;

- (long long)messageInfoSize:(int)messageInfoIndex;

- (NSString*)messageInfoSubject:(int)messageInfoIndex;

Default Value

""

Remarks

This property is populated when messages are searched or listed or when message information is received from the server. The collection contains a list of each message's MessageInfo as returned by the server.

MessageInfoLimit can be used to control the number of MessageInfos saved.

MessageInReplyTo Property (IMAP Module)

This property includes the unique message identifier of the message being replied to.

Syntax

public var messageInReplyTo: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=messageInReplyTo) NSString* messageInReplyTo;

- (NSString*)messageInReplyTo;

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 being replied to.

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

This property is read-only.

MessageNetId Property (IMAP Module)

This property includes the globally unique identifier of the message.

Syntax

public var messageNetId: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=messageNetId) NSString* messageNetId;

- (NSString*)messageNetId;

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.

MessageParts Property (IMAP Module)

This property includes a collection of message parts collected by FetchMessageInfo .

Syntax

public var messageParts: Array<MessagePart> {
  get {...}
}

@property (nonatomic,readonly,assign,getter=messagePartCount) int messagePartCount;

- (int)messagePartCount;

- (NSString*)messagePartContentDisposition:(int)messagePartIndex;

- (NSString*)messagePartContentEncoding:(int)messagePartIndex;

- (NSString*)messagePartContentId:(int)messagePartIndex;

- (NSString*)messagePartContentType:(int)messagePartIndex;

- (NSString*)messagePartFilename:(int)messagePartIndex;

- (NSString*)messagePartId:(int)messagePartIndex;

- (NSString*)messagePartMultipartMode:(int)messagePartIndex;

- (NSString*)messagePartParameters:(int)messagePartIndex;

- (long long)messagePartSize:(int)messagePartIndex;

Default Value

""

Remarks

This property contains a collection of message parts that is populated when you call FetchMessageInfo. Once the message is received from the server, the class parses the different parts and their corresponding information into the MESSAGEPARTS collection. Each MessagePart contains a unique .

MessagePartLimit can be used to control the number of message parts saved.

MessageRecipients Property (IMAP Module)

This property includes a collection of recipients for the current message.

Syntax

public var messageRecipients: Array<MessageRecipient> {
  get {...}
}

@property (nonatomic,readonly,assign,getter=messageRecipientCount) int messageRecipientCount;

- (int)messageRecipientCount;

- (NSString*)messageRecipientAddress:(int)recipientIndex;

- (NSString*)messageRecipientName:(int)recipientIndex;

- (NSString*)messageRecipientOptions:(int)recipientIndex;

- (int)messageRecipientType:(int)recipientIndex;

Default Value

""

Remarks

This property contains a collection of the people to whom the message was sent. Each MessageRecipient contains information describing that recipient, and what type of recipient it is. This collection is populated when the FetchMessageInfo method is called.

MessageReplyTo Property (IMAP Module)

This property includes the email addresses to which replies to the message should be sent.

Syntax

public var messageReplyTo: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=messageReplyTo) NSString* messageReplyTo;

- (NSString*)messageReplyTo;

Default Value

""

Remarks

This property contains the email addresses to which replies to the message should be sent. In some cases, a message may have more than one Reply-To address. If this is the case, the addresses are provided in this property and are separated by commas.

This property is read-only.

MessageSender Property (IMAP Module)

This property includes the address of the sender of the message.

Syntax

public var messageSender: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=messageSender) NSString* messageSender;

- (NSString*)messageSender;

Default Value

""

Remarks

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

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

This property is read-only.

MessageSet Property (IMAP Module)

This property includes the set of messages to operate on.

Syntax

public var messageSet: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=messageSet,setter=setMessageSet:) NSString* messageSet;

- (NSString*)messageSet;
- (void)setMessageSet :(NSString*)newMessageSet;

Default Value

""

Remarks

This property indicates the set of messages to operate on. This is 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 1. Setting MessageSet:

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

MessageSize Property (IMAP Module)

This property includes the size of the selected message.

Syntax

public var messageSize: Int64 {
  get {...}
}

@property (nonatomic,readonly,assign,getter=messageSize) long long messageSize;

- (long long)messageSize;

Default Value

0

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.

MessageSubject Property (IMAP Module)

This property includes the subject of the message.

Syntax

public var messageSubject: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=messageSubject) NSString* messageSubject;

- (NSString*)messageSubject;

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.

MessageText Property (IMAP Module)

This property includes the body of the retrieved message.

Syntax

public var messageText: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=messageText,setter=setMessageText:) NSString* messageText;

- (NSString*)messageText;
- (void)setMessageText :(NSString*)newMessageText;

Default Value

""

Remarks

The class fills out this property with the contents of the message body (in RFC 822 format) when a call to FetchMessageText completes successfully and the LocalFile property is not set.

Overwrite Property (IMAP Module)

This property indicates whether or not the module should overwrite files during transfer.

Syntax

public var overwrite: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=overwrite,setter=setOverwrite:) BOOL overwrite;

- (BOOL)overwrite;
- (void)setOverwrite :(BOOL)newOverwrite;

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.

Password Property (IMAP Module)

This property includes the password to be used to authenticate to the MailServer .

Syntax

public var password: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=password,setter=setPassword:) NSString* password;

- (NSString*)password;
- (void)setPassword :(NSString*)newPassword;

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.

PeekMode Property (IMAP Module)

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

Syntax

public var peekMode: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=peekMode,setter=setPeekMode:) BOOL peekMode;

- (BOOL)peekMode;
- (void)setPeekMode :(BOOL)newPeekMode;

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. In this case, an RFC-compliant IMAP server should not set the Seen flag on the message.

RecentMessageCount Property (IMAP Module)

This property includes the number of new messages in the Mailbox .

Syntax

public var recentMessageCount: Int32 {
  get {...}
}

@property (nonatomic,readonly,assign,getter=recentMessageCount) int recentMessageCount;

- (int)recentMessageCount;

Default Value

0

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.

SortCriteria Property (IMAP Module)

This property sorts criteria to use for message retrieval operations.

Syntax

public var sortCriteria: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=sortCriteria,setter=setSortCriteria:) NSString* sortCriteria;

- (NSString*)sortCriteria;
- (void)setSortCriteria :(NSString*)newSortCriteria;

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 the following:

ARRIVALInternal date and time of the message.
DATEThe 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.
SIZEThe size of the message
REVERSE <criterion>Followed by another sort criterion, this sort key has the effect of that criterion but in reverse (descending) order.

Note: IMAP SORT functionality is relatively new and not all servers may implement it.

SSLAcceptServerCertEncoded Property (IMAP Module)

This is the certificate (PEM/base64 encoded).

Syntax

public var sslAcceptServerCertEncoded: String {
  get {...}
  set {...}
}

public var sslAcceptServerCertEncodedB: Data { get {...} set {...} }

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncoded,setter=setSSLAcceptServerCertEncoded:) NSString* SSLAcceptServerCertEncoded;

- (NSString*)SSLAcceptServerCertEncoded;
- (void)setSSLAcceptServerCertEncoded :(NSString*)newSSLAcceptServerCertEncoded;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncodedB,setter=setSSLAcceptServerCertEncodedB:) NSData* SSLAcceptServerCertEncodedB;

- (NSData*)SSLAcceptServerCertEncodedB;
- (void)setSSLAcceptServerCertEncodedB :(NSData*)newSSLAcceptServerCertEncoded;

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.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLAcceptServerCertEncodedB(sslAcceptServerCertEncoded: Data) throws
public func setSSLAcceptServerCertEncoded(sslAcceptServerCertEncoded: String) throws

SSLCertEncoded Property (IMAP Module)

This is the certificate (PEM/base64 encoded).

Syntax

public var sslCertEncoded: String {
  get {...}
  set {...}
}

public var sslCertEncodedB: Data { get {...} set {...} }

@property (nonatomic,readwrite,assign,getter=SSLCertEncoded,setter=setSSLCertEncoded:) NSString* SSLCertEncoded;

- (NSString*)SSLCertEncoded;
- (void)setSSLCertEncoded :(NSString*)newSSLCertEncoded;

@property (nonatomic,readwrite,assign,getter=SSLCertEncodedB,setter=setSSLCertEncodedB:) NSData* SSLCertEncodedB;

- (NSData*)SSLCertEncodedB;
- (void)setSSLCertEncodedB :(NSData*)newSSLCertEncoded;

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.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLCertEncodedB(sslCertEncoded: Data) throws
public func setSSLCertEncoded(sslCertEncoded: String) throws

SSLCertStore Property (IMAP Module)

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

Syntax

public var sslCertStore: String {
  get {...}
  set {...}
}

public var sslCertStoreB: Data { get {...} set {...} }

@property (nonatomic,readwrite,assign,getter=SSLCertStore,setter=setSSLCertStore:) NSString* SSLCertStore;

- (NSString*)SSLCertStore;
- (void)setSSLCertStore :(NSString*)newSSLCertStore;

@property (nonatomic,readwrite,assign,getter=SSLCertStoreB,setter=setSSLCertStoreB:) NSData* SSLCertStoreB;

- (NSData*)SSLCertStoreB;
- (void)setSSLCertStoreB :(NSData*)newSSLCertStore;

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:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot 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).

SSLCertStorePassword Property (IMAP Module)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

public var sslCertStorePassword: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLCertStorePassword,setter=setSSLCertStorePassword:) NSString* SSLCertStorePassword;

- (NSString*)SSLCertStorePassword;
- (void)setSSLCertStorePassword :(NSString*)newSSLCertStorePassword;

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.

SSLCertStoreType Property (IMAP Module)

This is the type of certificate store for this certificate.

Syntax

public var sslCertStoreType: ImapSSLCertStoreTypes {
  get {...}
  set {...}
}

public enum ImapSSLCertStoreTypes: Int32 { case cstUser = 0 case cstMachine = 1 case cstPFXFile = 2 case cstPFXBlob = 3 case cstJKSFile = 4 case cstJKSBlob = 5 case cstPEMKeyFile = 6 case cstPEMKeyBlob = 7 case cstPublicKeyFile = 8 case cstPublicKeyBlob = 9 case cstSSHPublicKeyBlob = 10 case cstP7BFile = 11 case cstP7BBlob = 12 case cstSSHPublicKeyFile = 13 case cstPPKFile = 14 case cstPPKBlob = 15 case cstXMLFile = 16 case cstXMLBlob = 17 case cstJWKFile = 18 case cstJWKBlob = 19 case cstSecurityKey = 20 case cstBCFKSFile = 21 case cstBCFKSBlob = 22 case cstPKCS11 = 23 case cstAuto = 99 }

@property (nonatomic,readwrite,assign,getter=SSLCertStoreType,setter=setSSLCertStoreType:) int SSLCertStoreType;

- (int)SSLCertStoreType;
- (void)setSSLCertStoreType :(int)newSSLCertStoreType;

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:

0 (cstUser - default)For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java.
1 (cstMachine)For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.
2 (cstPFXFile)The certificate store is the name of a PFX (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).
21 (cstBCFKSFile)The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET.
22 (cstBCFKSBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET.
23 (cstPKCS11)The certificate is present on a physical security key accessible via a 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 cstPKCS11, 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.cstPKCS11; 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.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

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.

SSLCertSubject Property (IMAP Module)

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

Syntax

public var sslCertSubject: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLCertSubject,setter=setSSLCertSubject:) NSString* SSLCertSubject;

- (NSString*)SSLCertSubject;
- (void)setSSLCertSubject :(NSString*)newSSLCertSubject;

Default Value

""

Remarks

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

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.

FieldMeaning
CNCommon Name. This is commonly a host name like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

If a field value contains a comma it must be quoted.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLCertSubject(sslCertSubject: String) throws

SSLEnabled Property (IMAP Module)

Whether TLS/SSL is enabled.

Syntax

public var sslEnabled: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLEnabled,setter=setSSLEnabled:) BOOL SSLEnabled;

- (BOOL)SSLEnabled;
- (void)setSSLEnabled :(BOOL)newSSLEnabled;

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.

SSLProvider Property (IMAP Module)

This specifies the SSL/TLS implementation to use.

Syntax

public var sslProvider: ImapSSLProviders {
  get {...}
  set {...}
}

public enum ImapSSLProviders: Int32 { case sslpAutomatic = 0 case sslpPlatform = 1 case sslpInternal = 2 }

@property (nonatomic,readwrite,assign,getter=SSLProvider,setter=setSSLProvider:) int SSLProvider;

- (int)SSLProvider;
- (void)setSSLProvider :(int)newSSLProvider;

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

0 (sslpAutomatic - default)Automatically selects the appropriate implementation.
1 (sslpPlatform) Uses the platform/system implementation.
2 (sslpInternal) Uses the internal implementation.
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 the platform implementation will be used by default in all cases in the macOS edition.

SSLServerCertEncoded Property (IMAP Module)

This is the certificate (PEM/base64 encoded).

Syntax

public var sslServerCertEncoded: String {
  get {...}
}

public var sslServerCertEncodedB: Data { get {...} }

@property (nonatomic,readonly,assign,getter=SSLServerCertEncoded) NSString* SSLServerCertEncoded;

- (NSString*)SSLServerCertEncoded;

@property (nonatomic,readonly,assign,getter=SSLServerCertEncodedB) NSData* SSLServerCertEncodedB;

- (NSData*)SSLServerCertEncodedB;

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.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLServerCertEncodedB(sslServerCertEncoded: Data) throws
public func setSSLServerCertEncoded(sslServerCertEncoded: String) throws

SSLStartMode Property (IMAP Module)

Determines how the module starts the SSL negotiation.

Syntax

public var sslStartMode: ImapSSLStartModes {
  get {...}
  set {...}
}

public enum ImapSSLStartModes: Int32 { case sslAutomatic = 0 case sslImplicit = 1 case sslExplicit = 2 case sslNone = 3 }

@property (nonatomic,readwrite,assign,getter=SSLStartMode,setter=setSSLStartMode:) int SSLStartMode;

- (int)SSLStartMode;
- (void)setSSLStartMode :(int)newSSLStartMode;

Default Value

3

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.

StartByte Property (IMAP Module)

This property includes the byte index of the position where the transfer should start.

Syntax

public var startByte: Int64 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=startByte,setter=setStartByte:) long long startByte;

- (long long)startByte;
- (void)setStartByte :(long long)newStartByte;

Default Value

0

Remarks

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

When StartByte or EndByte contain values other than the default (0), only the corresponding portion of the message 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.

Timeout Property (IMAP Module)

A timeout for the module.

Syntax

public var timeout: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=timeout,setter=setTimeout:) int timeout;

- (int)timeout;
- (void)setTimeout :(int)newTimeout;

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the class .

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.

UIDMode Property (IMAP Module)

If True, this property indicates whether permanent message identifiers are used instead of the default temporary identifiers.

Syntax

public var uidMode: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=UIDMode,setter=setUIDMode:) BOOL UIDMode;

- (BOOL)UIDMode;
- (void)setUIDMode :(BOOL)newUIDMode;

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 following IMAP protocol operations use the UID mode: COPY, FETCH, STORE, and SEARCH.

UIDValidity Property (IMAP Module)

This property includes the UIDValidity parameter sent from the server in response to SelectMailbox command.

Syntax

public var uidValidity: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=UIDValidity) NSString* UIDValidity;

- (NSString*)UIDValidity;

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. If it does change, this means that all previously returned UIDs for messages inside this mailbox are now invalid.

This property is read-only.

User Property (IMAP Module)

This property includes the username used to authenticate to the MailServer .

Syntax

public var user: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=user,setter=setUser:) NSString* user;

- (NSString*)user;
- (void)setUser :(NSString*)newUser;

Default Value

""

Remarks

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

AddMessageFlags Method (IMAP Module)

This method adds the specified flags to the messages specified by MessageSet .

Syntax

public func addMessageFlags(flags: String) throws -> Void
- (void)addMessageFlags:(NSString*)flags;

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 they can include the following:

\Deleted Mark a message as deleted (for removal later by 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")

AppendToMailbox Method (IMAP Module)

This method appends the message in MessageText to the mailbox specified by Mailbox .

Syntax

public func appendToMailbox() throws -> Void
- (void)appendToMailbox;

Remarks

This method appends the RFC 822-encoded message in MessageText to the mailbox specified by Mailbox. If the MessageFlags property is not an empty string, its 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()

CheckMailbox Method (IMAP Module)

This method sends a CHECK command to the server.

Syntax

public func checkMailbox() throws -> Void
- (void)checkMailbox;

Remarks

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

CloseMailbox Method (IMAP Module)

This method removes all messages marked with a 'Deleted' flag from the currently selected mailbox and closes the unselected mailbox.

Syntax

public func closeMailbox() throws -> Void
- (void)closeMailbox;

Remarks

This method permanently removes all messages that have a 'Deleted' flag that have been set from the current (selected) mailbox. It then closes (deselected) the mailbox.

Config Method (IMAP Module)

Sets or retrieves a configuration setting.

Syntax

public func config(configurationString: String) throws -> String
- (NSString*)config:(NSString*)configurationString;

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.

Connect Method (IMAP Module)

This method connects to an IMAP server.

Syntax

public func connect() throws -> Void
- (void)connect;

Remarks

This method connects to the IMAP server specified by MailServer and authenticates it using the username 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()

CopyToMailbox Method (IMAP Module)

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

Syntax

public func copyToMailbox() throws -> Void
- (void)copyToMailbox;

Remarks

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

CreateMailbox Method (IMAP Module)

This method creates a new mailbox specified by Mailbox .

Syntax

public func createMailbox() throws -> Void
- (void)createMailbox;

Remarks

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

DeleteFromMailbox Method (IMAP Module)

The method marks the messages specified by MessageSet as deleted.

Syntax

public func deleteFromMailbox() throws -> Void
- (void)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.

DeleteMailbox Method (IMAP Module)

This method deletes a mailbox specified by Mailbox .

Syntax

public func deleteMailbox() throws -> Void
- (void)deleteMailbox;

Remarks

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

DeleteMailboxACL Method (IMAP Module)

This method deletes mailbox access control rights for a specific user.

Syntax

public func deleteMailboxACL(user: String) throws -> Void
- (void)deleteMailboxACL:(NSString*)user;

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.

Disconnect Method (IMAP Module)

This method disconnects from an IMAP server.

Syntax

public func disconnect() throws -> Void
- (void)disconnect;

Remarks

This method logs out and disconnects from the IMAP server.

DoEvents Method (IMAP Module)

Processes events from the internal message queue.

Syntax

public func doEvents() throws -> Void
- (void)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.

ExamineMailbox Method (IMAP Module)

This method selects a mailbox in read-only mode.

Syntax

public func examineMailbox() throws -> Void
- (void)examineMailbox;

Remarks

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

Example 1. Open a Mailbox in Read/Write Mode:

IMAPControl.Mailbox = "INBOX" IMAPControl.SelectMailbox

Example 2. Open a Mailbox in Read-Only Mode:

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

ExpungeMailbox Method (IMAP Module)

This method removes all messages marked with a 'Deleted' flag from the currently selected mailbox.

Syntax

public func expungeMailbox() throws -> Void
- (void)expungeMailbox;

Remarks

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

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

FetchMessageHeaders Method (IMAP Module)

This method retrieves the message headers of the messages specified by the MessageSet property.

Syntax

public func fetchMessageHeaders() throws -> Void
- (void)fetchMessageHeaders;

Remarks

This method retrieves RFC 822 headers of the messages specified by MessageSet and stores them in the MessageHeaders property.

FetchMessageInfo Method (IMAP Module)

This method retrieves information about messages specified by the MessageSet property.

Syntax

public func fetchMessageInfo() throws -> Void
- (void)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 the following: MessageSubject, MessageFrom, and MessageRecipients. If the message is a multipart message, one or more MessagePart events will be fired before the MessageInfo event (one for each message part).

FetchMessagePart Method (IMAP Module)

This method retrieves the message part specified by PartID.

Syntax

public func fetchMessagePart(partId: String) throws -> Void
- (void)fetchMessagePart:(NSString*)partId;

Remarks

This method retrieves the contents of the message part specified by the PartId property of the messages specified by the MessageSet property. If the LocalFile property contains a file name, the message part is stored in LocalFile. If the LocalFile property is set to an empty string, then the message part is stored in the MessageText property. Additionally, the Transfer will also provide the message part and denote the progress of the fetch.

The part identifiers for each message part (if any) are provided through the corresponding MessagePart events. This method retrieves the RFC 822-encoded text of the messages specified by MessageSet.

FetchMessagePartHeaders Method (IMAP Module)

This method retrieves the headers of message part specified by PartID.

Syntax

public func fetchMessagePartHeaders(partId: String) throws -> Void
- (void)fetchMessagePartHeaders:(NSString*)partId;

Remarks

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

FetchMessageText Method (IMAP Module)

This method retrieves the message text of the messages specified by the MessageSet property.

Syntax

public func fetchMessageText() throws -> Void
- (void)fetchMessageText;

Remarks

This method retrieves the RFC 822-encoded text of the messages specified by MessageSet. If the LocalFile property contains a file name, the text is stored in LocalFile. If the LocalFile property is set to an empty string, then the text is stored in the MessageText property. Additionally, the Transfer event will also provide the text and denote the progress of the fetch.

GetMailboxACL Method (IMAP Module)

This method retrieves mailbox access control rights.

Syntax

public func getMailboxACL() throws -> Void
- (void)getMailboxACL;

Remarks

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

lLookup (Visible to be listed)
rRead (Can be selected, fetched, searched, and copied)
sKeep (Seen/unseen information across sessions)
wWrite (Stores flags other than SEEN and DELETED)
iInsert (Can be appended and copied into)
pPost (Can send mail to submission address for mailbox)
cCreate (Can create new sub-mailboxes)
dDelete (Stores DELETED flag and performs EXPUNGE)
aAdminister (Set access permissions)

Interrupt Method (IMAP Module)

Interrupt the current method.

Syntax

public func interrupt() throws -> Void
- (void)interrupt;

Remarks

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

ListMailboxes Method (IMAP Module)

This method lists all of the mailboxes matching all criteria in the Mailbox property.

Syntax

public func listMailboxes() throws -> Void
- (void)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 1. List All Mailboxes:

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

Example 2. List All Mailboxes Inside INBOX:

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

ListSubscribedMailboxes Method (IMAP Module)

This method lists all subscribed mailboxes matching all criteria in the Mailbox property.

Syntax

public func listSubscribedMailboxes() throws -> Void
- (void)listSubscribedMailboxes;

Remarks

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

Example 1. List All Subscribed Mailboxes:

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

Example 2. List All Subscribed Mailboxes Inside INBOX:

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

LocalizeDate Method (IMAP Module)

This method converts a valid RFC 822 message date to a local date and time.

Syntax

public func localizeDate(dateTime: String) throws -> String
- (NSString*)localizeDate:(NSString*)dateTime;

Remarks

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

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

MoveToMailbox Method (IMAP Module)

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

Syntax

public func moveToMailbox() throws -> Void
- (void)moveToMailbox;

Remarks

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

Noop Method (IMAP Module)

This method sends a NOOP command to the server.

Syntax

public func noop() throws -> Void
- (void)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.)

RenameMailbox Method (IMAP Module)

This method changes the name of Mailbox to NewName .

Syntax

public func renameMailbox(newName: String) throws -> Void
- (void)renameMailbox:(NSString*)newName;

Remarks

This method allows a mailbox to be renamed. The mailbox is specified by the Mailbox property, and the new name is specified by the NewName parameter.

Reset Method (IMAP Module)

Reset the component.

Syntax

public func reset() throws -> Void
- (void)reset;

Remarks

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

ResetMessageFlags Method (IMAP Module)

This method replaces the flags of the messages specified by MessageSet with the flags specified by MessageFlags .

Syntax

public func resetMessageFlags() throws -> Void
- (void)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 they can include the following:

\Deleted Mark a message as deleted (for removal later by 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).

SearchMailbox Method (IMAP Module)

This method searches the selected mailbox for specified text.

Syntax

public func searchMailbox(searchCriteria: String) throws -> Void
- (void)searchMailbox:(NSString*)searchCriteria;

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 the following:

<message set>Messages with message sequence numbers corresponding to the specified message sequence number set.
ALLAll messages in the mailbox; this is the default initial key for AND-ing.
ANSWEREDMessages 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.

SelectMailbox Method (IMAP Module)

This method selects a mailbox.

Syntax

public func selectMailbox() throws -> Void
- (void)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 1. Open a Mailbox in Read/Write Mode:

IMAPControl.Mailbox = "INBOX" IMAPControl.SelectMailbox

Example 2. Open a Mailbox in Read-Only Mode:

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

SendCommand Method (IMAP Module)

Sends the exact command directly to the server.

Syntax

public func sendCommand(command: String) throws -> Void
- (void)sendCommand:(NSString*)command;

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.

SetMailboxACL Method (IMAP Module)

This method sets mailbox access control rights for a specific user.

Syntax

public func setMailboxACL(user: String, rights: String) throws -> Void
- (void)setMailboxACL:(NSString*)user :(NSString*)rights;

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 the following:

lLookup (Visible to be listed)
rRead (Can be selected, fetched, searched, and copied)
sKeep (Seen/unseen information across sessions)
wWrite (Stores flags other than SEEN and DELETED)
iInsert (Can be appended and copied into)
pPost (Can send mail to submission address for mailbox)
cCreate (Can create new sub-mailboxes)
dDelete (Stores DELETED flag and performs EXPUNGE)
aAdminister (Set access permissions)

StartIdle Method (IMAP Module)

This method begins idling.

Syntax

public func startIdle() throws -> Void
- (void)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 ensure that incoming events are processed.

StopIdle Method (IMAP Module)

This method stops idling.

Syntax

public func stopIdle() throws -> Void
- (void)stopIdle;

Remarks

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

SubscribeMailbox Method (IMAP Module)

This method subscribes to the mailbox specified by Mailbox .

Syntax

public func subscribeMailbox() throws -> Void
- (void)subscribeMailbox;

Remarks

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

UnsetMessageFlags Method (IMAP Module)

This method removes the flags specified by MessageFlags from the messages specified by MessageSet .

Syntax

public func unsetMessageFlags() throws -> Void
- (void)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 they can include the following:

\Deleted Mark a message as deleted (for removal later by 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).

UnsubscribeMailbox Method (IMAP Module)

This method unsubscribes from the mailbox specified by Mailbox .

Syntax

public func unsubscribeMailbox() throws -> Void
- (void)unsubscribeMailbox;

Remarks

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

ConnectionStatus Event (IMAP Module)

This event is fired to indicate changes in the connection state.

Syntax

func onConnectionStatus(connectionEvent: String, statusCode: Int32, description: String)
- (void)onConnectionStatus:(NSString*)connectionEvent :(int)statusCode :(NSString*)description;

Remarks

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

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

Firewall connection complete.
Secure Sockets Layer (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 Transmission Control Protocol (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 Module)

This event is fired when the message or the part data finishes transferring.

Syntax

func onEndTransfer(direction: Int32)
- (void)onEndTransfer:(int)direction;

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

Information about errors during data delivery.

Syntax

func onError(errorCode: Int32, description: String)
- (void)onError:(int)errorCode :(NSString*)description;

Remarks

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

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

This event is fired every time a header line comes in.

Syntax

func onHeader(field: String, value: String)
- (void)onHeader:(NSString*)field :(NSString*)value;

Remarks

The Field parameter contains the name of the HTTP header (in the 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 Module)

This event fires whenever responses from the server are received while idling.

Syntax

func onIdleInfo(message: String, cancel: inout Bool)
- (void)onIdleInfo:(NSString*)message :(int*)cancel;

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.

The following are possible values returned by the server:

+ idling
* 43 EXISTS
* 1 RECENT

MailboxACL Event (IMAP Module)

This event fires for each set of access control rights returned by the server.

Syntax

func onMailboxACL(mailbox: String, user: String, rights: String)
- (void)onMailboxACL:(NSString*)mailbox :(NSString*)user :(NSString*)rights;

Remarks

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

lLookup (Visible to be listed)
rRead (Can be selected, fetched, searched, and copied)
sKeep (Seen/unseen information across sessions)
wWrite (Stores flags other than SEEN and DELETED)
iInsert (Can be appended and copied into)
pPost (Can send mail to submission address for mailbox)
cCreate (Can create new sub-mailboxes)
dDelete (Stores DELETED flag and performs EXPUNGE)
aAdminister (Set access permissions)

MailboxList Event (IMAP Module)

This event fires for each mailbox received through the ListMailboxes and ListSubscribedMailboxes methods.

Syntax

func onMailboxList(mailbox: String, separator: String, flags: String)
- (void)onMailboxList:(NSString*)mailbox :(NSString*)separator :(NSString*)flags;

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

This event is fired with information for the messages retrieved by the server.

Syntax

func onMessageInfo(messageId: String, subject: String, messageDate: String, from: String, flags: String, size: Int64)
- (void)onMessageInfo:(NSString*)messageId :(NSString*)subject :(NSString*)messageDate :(NSString*)from :(NSString*)flags :(long long)size;

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 the following: MessageContentType, MessageContentEncoding, MessageRecipients, MessageDeliveryTime, MessageFlags, MessageHeaders, MessageInReplyTo, MessageNetId, MessageReplyTo, MessageSender, MessageSize, MessageSubject, MessageText, etc.

MessagePart Event (IMAP Module)

This event is fired for each message part when FetchMessageInfo is called.

Syntax

func onMessagePart(partId: String, size: Int64, contentType: String, filename: String, contentEncoding: String, parameters: String, multipartMode: String, contentId: String, contentDisposition: String)
- (void)onMessagePart:(NSString*)partId :(long long)size :(NSString*)contentType :(NSString*)filename :(NSString*)contentEncoding :(NSString*)parameters :(NSString*)multipartMode :(NSString*)contentId :(NSString*)contentDisposition;

Remarks

The PartId parameter denotes the PartId that may be identified in other parts or messages. The format of PartIds 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 data are 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.

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

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

The ContentDisposition parameter shows the value of the Content-Disposition header for the part.

PITrail Event (IMAP Module)

This event traces the commands sent to the mail server, and the respective replies.

Syntax

func onPITrail(direction: Int32, message: String)
- (void)onPITrail:(int)direction :(NSString*)message;

Remarks

The PITrail event is useful for debugging and learning purposes. It shows all of the interactions 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 Module)

Fired after the server presents its certificate to the client.

Syntax

func onSSLServerAuthentication(certEncoded: Data, certSubject: String, certIssuer: String, status: String, accept: inout Bool)
- (void)onSSLServerAuthentication:(NSData*)certEncoded :(NSString*)certSubject :(NSString*)certIssuer :(NSString*)status :(int*)accept;

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

Shows the progress of the secure connection.

Syntax

func onSSLStatus(message: String)
- (void)onSSLStatus:(NSString*)message;

Remarks

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

StartTransfer Event (IMAP Module)

This event is fired when the message body or the part data start transferring.

Syntax

func onStartTransfer(direction: Int32)
- (void)onStartTransfer:(int)direction;

Remarks

The StartTransfer event is fired when the message body or the part data start 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 Module)

This event is fired while the message is transferred from the MailServer .

Syntax

func onTransfer(direction: Int32, bytesTransferred: Int64, percentDone: Int32, text: String)
- (void)onTransfer:(int)direction :(long long)bytesTransferred :(int)percentDone :(NSString*)text;

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 to check the progress only 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: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Firewall Type

This is the firewall the component will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall and the .

Fields

autoDetect
Bool

Default Value: False

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

firewallType
FirewallTypes

Default Value: 0

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. is set to 80.
fwSOCKS4 (2)Connect through a SOCKS4 Proxy. is set to 1080.
fwSOCKS5 (3)Connect through a SOCKS5 Proxy. is set to 1080.
fwSOCKS4A (10)Connect through a SOCKS4A Proxy. is set to 1080.

host
String

Default Value: ""

This property contains the name or IP address of firewall (optional). If a 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 .

password
String

Default Value: ""

This property contains a password if authentication is to be used when connecting through the firewall. If is specified, the and properties are used to connect and authenticate to the given firewall. If the authentication fails, the class .

port
Int32

Default Value: 0

This property contains the transmission control protocol (TCP) port for the firewall . See the description of the property for details.

Note: This property is set automatically when is set to a valid value. See the description of the property for details.

user
String

Default Value: ""

This property contains a user name if authentication is to be used connecting through a firewall. If the is specified, this property and properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class .

Constructors

public init()

Header Type

This is an HTTP header as it is received from the server.

Remarks

When a header is received through a Header event, it is parsed into a Header type. This type contains a , and its corresponding .

Fields

field
String

Default Value: ""

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

value
String

Default Value: ""

This property contains the Header contents.

Constructors

public init()
public init(field: , value: )

Mailbox Type

This type includes mailboxes collected when calling ListMailboxes or ListSubscribedMailboxes .

Remarks

This type includes the information for each mailbox as it is returned by the server after either ListMailboxes or ListSubscribedMailboxes have been called.

Fields

flags
String (read-only)

Default Value: ""

This property contains the mailbox flags in a mailbox listing.

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

\Deleted Mark a message as deleted (for removal later by 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).

name
String (read-only)

Default Value: ""

This property contains the mailbox name in a mailbox listing.

separator
String (read-only)

Default Value: ""

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

Constructors

public init()

MessageInfo Type

This is a listing of information for a message returned by the server.

Remarks

The MessageInfo event is fired when messages are searched or listed or when message information is received. When a MessageInfo event is fired, this type is returned, which contains all of the information from the message.

Fields

date
String (read-only)

Default Value: ""

This property contains the date of a message in a message information listing. This date is taken from the ENVELOPE structure of the message.

flags
String (read-only)

Default Value: ""

This property contains a message flag in a message information listing.

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

\Deleted Mark a message as deleted (for removal later by 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).

from
String (read-only)

Default Value: ""

This property contains the sender of a message in a message information listing.

messageId
String (read-only)

Default Value: ""

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

size
Int64 (read-only)

Default Value: 0

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

subject
String (read-only)

Default Value: ""

This property contains the subject of a message in a message information listing.

Constructors

public init()

MessagePart Type

A message part of a message listing.

Remarks

Messages are split into message parts. Each MessagePart is specified by a unique identifier, namely, the field. Each part contains data and other fields describing that part.

Fields

contentDisposition
String (read-only)

Default Value: ""

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

contentEncoding
String (read-only)

Default Value: ""

This property shows how the data are encoded.

contentId
String (read-only)

Default Value: ""

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

contentType
String (read-only)

Default Value: ""

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

filename
String (read-only)

Default Value: ""

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

id
String (read-only)

Default Value: ""

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

multipartMode
String (read-only)

Default Value: ""

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

parameters
String (read-only)

Default Value: ""

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

size
Int64 (read-only)

Default Value: 0

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

Constructors

public init()

MessageRecipient Type

This types describes the message recipient.

Remarks

This type describes who the message is sent to. It includes fields to denote the name and email address of the recipient of the message. The type of recipient must also be specified if the class is sending the message.

Fields

address
String

Default Value: ""

This property contains the email address of the recipient.

name
String

Default Value: ""

This property contains the name of the recipient.

options
String

Default Value: ""

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

recipientType
EmailRecipientTypes

Default Value: 0

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

Constructors

public init()
public init(address: )

Config Settings (IMAP Module)

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 Config 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 also will contain session message Ids. 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 Base64 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 applicable only 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 , and FetchMessageText will fetch only the message text from the server. When set to , 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 plaintext when logging, set this option to True. The default value is True.

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

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

TCPClient Config 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 configuration 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 .

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

FirewallPort:   The TCP port for the FirewallHost;.

The FirewallPort is set automatically when FirewallType is set to a valid value.

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

FirewallType:   Determines the type of firewall to connect through.

The appropriate values are as follows:

0No firewall (default setting).
1Connect through a tunneling proxy. FirewallPort is set to 80.
2Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
3Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
10Connect 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 .

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 acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

Note: This value is not applicable in macOS.

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 Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.

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), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.

In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.

LingerTime:   Time in seconds to have the connection linger.

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

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.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

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 configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.

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

This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:

www.google.com;www.nsoftware.com

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

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.

SSLCheckOCSP:   Whether to use OCSP to check the status of the server certificate.

This setting specifies whether the class will use OCSP to check the validity of the server certificate. If set to 1 or 2, the class will first obtain the OCSP URL from the server certificate's OCSP extension. The class will then locate the issuing certificate and make an HTTP request to the OCSP 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 .

When set to 0 (default) the class will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP 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.312288 (Hex 3000)
TLS1.23072 (Hex C00) (Default)
TLS1.1768 (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 when the SSLProvider is set to Automatic for all editions.

In editions which are designed to run on Windows SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is only supported on Windows 11 / Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.

If set to 1 (Platform provider) please be aware of the following notes:

  • The platform provider is only available on Windows 11 / Windows Server 2022 and up.
  • SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
  • If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2 the above restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.

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 by default, but can be set to 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 cipher suite.

Returns the cipher suite negotiated during the SSL handshake.

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

SSLNegotiatedCipherStrength:   Returns the negotiated cipher suite strength.

Returns the strength of the cipher suite negotiated during the SSL handshake.

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

SSLNegotiatedCipherSuite:   Returns the negotiated cipher suite.

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

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

SSLNegotiatedKeyExchange:   Returns the negotiated key exchange algorithm.

Returns the key exchange algorithm negotiated during the SSL handshake.

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

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

0x00000001Ignore time validity status of certificate.
0x00000002Ignore time validity status of CTL.
0x00000004Ignore non-nested certificate times.
0x00000010Allow unknown Certificate Authority.
0x00000020Ignore wrong certificate usage.
0x00000100Ignore unknown certificate revocation status.
0x00000200Ignore unknown CTL signer revocation status.
0x00000400Ignore unknown Certificate Authority revocation status.
0x00000800Ignore unknown Root revocation status.
0x00008000Allow test Root certificate.
0x00004000Trust test Root certificate.
0x80000000Ignore 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 .

The format of this value is a comma separated list of hash-signature combinations. For instance: component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); The default value for this setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.

In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

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

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8
The following is a list of valid code page identifiers for Mac OS only:
IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

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.
MaskSensitive:   Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to to mask sensitive data. The default is .

This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

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

When set to , the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this setting to tells the class to use the internal implementation instead of using the system security libraries.

This setting is set to by default on all platforms.

Trappable Errors (IMAP Module)

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.

TCPClient Errors

100   You cannot change the RemotePort at this time. A connection is in progress.
101   You cannot change the RemoteHost (Server) at this time. A connection is in progress.
102   The RemoteHost address is invalid (0.0.0.0).
104   Already connected. If you want to reconnect, close the current connection first.
106   You cannot change the LocalPort at this time. A connection is in progress.
107   You cannot change the LocalHost at this time. A connection is in progress.
112   You cannot change MaxLineLength at this time. A connection is in progress.
116   RemotePort cannot be zero. Please specify a valid service port number.
117   You cannot change the UseConnection option while the class is active.
135   Operation would block.
201   Timeout.
211   Action impossible in control's present state.
212   Action impossible while not connected.
213   Action impossible while listening.
301   Timeout.
302   Could not open file.
434   Unable to convert string to selected CodePage.
1105   Already connecting. If you want to reconnect, close the current connection first.
1117   You need to connect first.
1119   You cannot change the LocalHost at this time. A connection is in progress.
1120   Connection dropped by remote host.

SSL Errors

270   Cannot load specified security library.
271   Cannot open certificate store.
272   Cannot find specified certificate.
273   Cannot acquire security credentials.
274   Cannot find certificate chain.
275   Cannot verify certificate chain.
276   Error during handshake.
280   Error verifying certificate.
281   Could not find client certificate.
282   Could not find server certificate.
283   Error encrypting data.
284   Error decrypting data.

TCP/IP Errors

10004   [10004] Interrupted system call.
10009   [10009] Bad file number.
10013   [10013] Access denied.
10014   [10014] Bad address.
10022   [10022] Invalid argument.
10024   [10024] Too many open files.
10035   [10035] Operation would block.
10036   [10036] Operation now in progress.
10037   [10037] Operation already in progress.
10038   [10038] Socket operation on non-socket.
10039   [10039] Destination address required.
10040   [10040] Message too long.
10041   [10041] Protocol wrong type for socket.
10042   [10042] Bad protocol option.
10043   [10043] Protocol not supported.
10044   [10044] Socket type not supported.
10045   [10045] Operation not supported on socket.
10046   [10046] Protocol family not supported.
10047   [10047] Address family not supported by protocol family.
10048   [10048] Address already in use.
10049   [10049] Can't assign requested address.
10050   [10050] Network is down.
10051   [10051] Network is unreachable.
10052   [10052] Net dropped connection or reset.
10053   [10053] Software caused connection abort.
10054   [10054] Connection reset by peer.
10055   [10055] No buffer space available.
10056   [10056] Socket is already connected.
10057   [10057] Socket is not connected.
10058   [10058] Can't send after socket shutdown.
10059   [10059] Too many references, can't splice.
10060   [10060] Connection timed out.
10061   [10061] Connection refused.
10062   [10062] Too many levels of symbolic links.
10063   [10063] File name too long.
10064   [10064] Host is down.
10065   [10065] No route to host.
10066   [10066] Directory not empty
10067   [10067] Too many processes.
10068   [10068] Too many users.
10069   [10069] Disc Quota Exceeded.
10070   [10070] Stale NFS file handle.
10071   [10071] Too many levels of remote in path.
10091   [10091] Network subsystem is unavailable.
10092   [10092] WINSOCK DLL Version out of range.
10093   [10093] Winsock not loaded yet.
11001   [11001] Host not found.
11002   [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
11003   [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
11004   [11004] Valid name, no data record (check DNS setup).