PIMAP Module

Properties   Methods   Events   Config Settings   Errors  

The PIMAP module is used to communicate with IMAP servers to retrieve and process OpenPGP encrypted and/or signed messages and any attachments.

Syntax

IPWorksOpenPGP.PIMAP

Remarks

The PIMAP class offers an easy-to-use interface: it implements a standard IMAP client, as specified in RFC 1730 and RFC 2060, and supports decrypting and verifying signatures of encrypted and signed emails using OpenPGP. Additionally, it enables you to create messages bound for multiple recipients with different keys, simultaneously encrypt and compress with the most popular compression algorithms, and control other aspects such as the encrypting algorithm to use.

Connect to a Mail Server

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.

Examine a Mailbox

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 shows the flags pertaining to the mailbox.

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

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

Decrypt

To process an encrypted or signed message, first retrieve the message text and headers by calling RetrieveMessageHeaders and RetrieveMessageText. To decrypt a message specify the private key to be used for decryption by setting the Key* properties. For instance: PIMAP1.KeyCount = 1 PIMAP1.KeyKeyring(0) = "c:\my_keyring_dir" PIMAP1.KeyUserId(0) = "recipient@nsoftware.com" PIMAP1.KeyPassphrase(0) = "password" The specified private key will be used to decrypt the message when calling Decrypt.

Verify

To verify the signature of a message specify the public key to be used for signature verification by setting the SignerKey* properties. For instance: PIMAP1.SignerKeyCount = 1 PIMAP1.SignerKeyKeyring(0) = "c:\my_keyring_dir" PIMAP1.SignerKeyUserId(0) = "sender@nsoftware.com" The specified public key will be used to verify the signature when calling VerifySignature. To decrypt and verify in one step call DecryptAndVerifySignature.

Retrieve MIME Message Parts

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

Trace Client and Server Communication

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.

Method List

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

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.

Config Settings

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

AuthMechanism Property (PIMAP Module)

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

Syntax

• Swift
• Objective-C

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

public enum PIMAPAuthMechanisms: 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

AutoDecodeParts Property (PIMAP Module)

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

Syntax

• Swift
• Objective-C

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.

Connected Property (PIMAP Module)

Whether the module is connected.

Syntax

• Swift
• Objective-C

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

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

- (BOOL)connected;

Default Value

False

Remarks

This property is used to determine whether or not the class is connected to the remote host. Use the Connect and Disconnect methods to manage the connection.

This property is read-only.

EndByte Property (PIMAP Module)

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

Syntax

• Swift
• Objective-C

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 RetrieveMessagePart 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 (PIMAP Module)

A set of properties related to firewall access.

Syntax

• Swift
• Objective-C

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

The current status of the module.

Syntax

• Swift
• Objective-C

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

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

- (BOOL)idle;

Default Value

True

Remarks

This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.

This property is read-only.

Keys Property (PIMAP Module)

A collection of keys used for cryptographic operations.

Syntax

• Swift
• Objective-C

public var keys: Array<Key> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=keyCount,setter=setKeyCount:) int keyCount;

- (int)keyCount;
- (void)setKeyCount :(int)newKeyCount;

- (NSString*)keyEncoded:(int)keyIndex;
- (void)setKeyEncoded:(int)keyIndex :(NSString*)newKeyEncoded;

- (NSData*)keyEncodedB:(int)keyIndex;
- (void)setKeyEncodedB:(int)keyIndex :(NSData*)newKeyEncoded;
- (NSString*)keyKeyring:(int)keyIndex;
- (void)setKeyKeyring:(int)keyIndex :(NSString*)newKeyKeyring;

- (NSString*)keyPassphrase:(int)keyIndex;
- (void)setKeyPassphrase:(int)keyIndex :(NSString*)newKeyPassphrase;

- (NSString*)keyUserId:(int)keyIndex;
- (void)setKeyUserId:(int)keyIndex :(NSString*)newKeyUserId;

Default Value

""

Remarks

This collection holds keys that are used for signing and decrypting. In most cases only one key will be specified, however multiple keys may be needed in some cases.

LastReply Property (PIMAP Module)

This property indicates the last reply received from the server.

Syntax

• Swift
• Objective-C

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 also can be retrieved through the PITrail event.

This property is read-only.

LocalHost Property (PIMAP Module)

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

Syntax

• Swift
• Objective-C

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

This 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 multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

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 multihomed 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 (PIMAP Module)

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

Syntax

• Swift
• Objective-C

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

This property defines flags in the selected mailbox.

Syntax

• Swift
• Objective-C

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

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

Syntax

• Swift
• Objective-C

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

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

Syntax

• Swift
• Objective-C

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

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

Syntax

• Swift
• Objective-C

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

This property provides the raw message content.

Syntax

• Swift
• Objective-C

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 RetrieveMessagePart and holds the raw message content. This can be used to access the data before any processing is done by the class.

MessageContentEncoding Property (PIMAP Module)

This property includes the ContentEncoding of the selected message.

Syntax

• Swift
• Objective-C

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 RetrieveMessageInfo method.

This property is read-only.

MessageContentType Property (PIMAP Module)

This property includes the ContentType of the message.

Syntax

• Swift
• Objective-C

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

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

Syntax

• Swift
• Objective-C

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

The property includes the time the message was created.

Syntax

• Swift
• Objective-C

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

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

Syntax

• Swift
• Objective-C

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

This property contains the flags of the current message.

Syntax

• Swift
• Objective-C

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:

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

MessageFrom Property (PIMAP Module)

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

Syntax

• Swift
• Objective-C

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

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

Syntax

• Swift
• Objective-C

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 RetrieveMessageHeaders or the RetrieveMessagePartHeaders method.

MessageHeadersString Property (PIMAP Module)

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

Syntax

• Swift
• Objective-C

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 RetrieveMessageHeaders or the RetrieveMessagePartHeaders method.

MessageId Property (PIMAP Module)

This property includes the message identifier of the current message.

Syntax

• Swift
• Objective-C

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

This property includes the collection of messages retrieved by RetrieveMessageInfo .

Syntax

• Swift
• Objective-C

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

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

Syntax

• Swift
• Objective-C

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

This property includes the globally unique identifier of the message.

Syntax

• Swift
• Objective-C

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

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

Syntax

• Swift
• Objective-C

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 RetrieveMessageInfo. 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 (PIMAP Module)

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

Syntax

• Swift
• Objective-C

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 RetrieveMessageInfo method is called.

MessageReplyTo Property (PIMAP Module)

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

Syntax

• Swift
• Objective-C

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

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

Syntax

• Swift
• Objective-C

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

This property includes the set of messages to operate on.

Syntax

• Swift
• Objective-C

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.RetrieveMessageInfo() IMAPControl.MessageSet = "1:5" IMAPControl.RetrieveMessageInfo() IMAPControl.MessageSet = "1,5,7" IMAPControl.RetrieveMessageInfo()

MessageSize Property (PIMAP Module)

This property includes the size of the selected message.

Syntax

• Swift
• Objective-C

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

This property includes the subject of the message.

Syntax

• Swift
• Objective-C

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

This property includes the body of the retrieved message.

Syntax

• Swift
• Objective-C

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 RetrieveMessageText completes successfully and the LocalFile property is not set.

Overwrite Property (PIMAP Module)

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

Syntax

• Swift
• Objective-C

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

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

Syntax

• Swift
• Objective-C

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

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

Syntax

• Swift
• Objective-C

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

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

Syntax

• Swift
• Objective-C

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.

SignerKeys Property (PIMAP Module)

The collection of keys belonging to the signer of the message.

Syntax

• Swift
• Objective-C

public var signerKeys: Array<Key> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=signerKeyCount,setter=setSignerKeyCount:) int signerKeyCount;

- (int)signerKeyCount;
- (void)setSignerKeyCount :(int)newSignerKeyCount;

- (NSString*)signerKeyEncoded:(int)signerKeyIndex;
- (void)setSignerKeyEncoded:(int)signerKeyIndex :(NSString*)newSignerKeyEncoded;

- (NSData*)signerKeyEncodedB:(int)signerKeyIndex;
- (void)setSignerKeyEncodedB:(int)signerKeyIndex :(NSData*)newSignerKeyEncoded;
- (NSString*)signerKeyKeyring:(int)signerKeyIndex;
- (void)setSignerKeyKeyring:(int)signerKeyIndex :(NSString*)newSignerKeyKeyring;

- (NSString*)signerKeyUserId:(int)signerKeyIndex;
- (void)setSignerKeyUserId:(int)signerKeyIndex :(NSString*)newSignerKeyUserId;

Default Value

""

Remarks

This property contains the keys of the message signer.

Set this property before calling VerifySignature or DecryptAndVerifySignature.

SortCriteria Property (PIMAP Module)

This property sorts criteria to use for message retrieval operations.

Syntax

• Swift
• Objective-C

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

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

SSLAcceptServerCert Property (PIMAP Module)

Instructs the module to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

• Swift
• Objective-C

public var sslAcceptServerCert: Certificate {
  get {...}
  set {...}
}

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

- (NSString*)SSLAcceptServerCertEffectiveDate;

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

- (NSString*)SSLAcceptServerCertExpirationDate;

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

- (NSString*)SSLAcceptServerCertExtendedKeyUsage;

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

- (NSString*)SSLAcceptServerCertFingerprint;

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

- (NSString*)SSLAcceptServerCertFingerprintSHA1;

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

- (NSString*)SSLAcceptServerCertFingerprintSHA256;

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

- (NSString*)SSLAcceptServerCertIssuer;

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

- (NSString*)SSLAcceptServerCertPrivateKey;

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

- (BOOL)SSLAcceptServerCertPrivateKeyAvailable;

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

- (NSString*)SSLAcceptServerCertPrivateKeyContainer;

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

- (NSString*)SSLAcceptServerCertPublicKey;

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

- (NSString*)SSLAcceptServerCertPublicKeyAlgorithm;

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

- (int)SSLAcceptServerCertPublicKeyLength;

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

- (NSString*)SSLAcceptServerCertSerialNumber;

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

- (NSString*)SSLAcceptServerCertSignatureAlgorithm;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertStore,setter=setSSLAcceptServerCertStore:) NSString* SSLAcceptServerCertStore;

- (NSString*)SSLAcceptServerCertStore;
- (void)setSSLAcceptServerCertStore :(NSString*)newSSLAcceptServerCertStore;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertStoreB,setter=setSSLAcceptServerCertStoreB:) NSData* SSLAcceptServerCertStoreB;

- (NSData*)SSLAcceptServerCertStoreB;
- (void)setSSLAcceptServerCertStoreB :(NSData*)newSSLAcceptServerCertStore;
@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertStorePassword,setter=setSSLAcceptServerCertStorePassword:) NSString* SSLAcceptServerCertStorePassword;

- (NSString*)SSLAcceptServerCertStorePassword;
- (void)setSSLAcceptServerCertStorePassword :(NSString*)newSSLAcceptServerCertStorePassword;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertStoreType,setter=setSSLAcceptServerCertStoreType:) int SSLAcceptServerCertStoreType;

- (int)SSLAcceptServerCertStoreType;
- (void)setSSLAcceptServerCertStoreType :(int)newSSLAcceptServerCertStoreType;

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

- (NSString*)SSLAcceptServerCertSubjectAltNames;

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

- (NSString*)SSLAcceptServerCertThumbprintMD5;

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

- (NSString*)SSLAcceptServerCertThumbprintSHA1;

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

- (NSString*)SSLAcceptServerCertThumbprintSHA256;

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

- (NSString*)SSLAcceptServerCertUsage;

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

- (int)SSLAcceptServerCertUsageFlags;

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

- (NSString*)SSLAcceptServerCertVersion;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertSubject,setter=setSSLAcceptServerCertSubject:) NSString* SSLAcceptServerCertSubject;

- (NSString*)SSLAcceptServerCertSubject;
- (void)setSSLAcceptServerCertSubject :(NSString*)newSSLAcceptServerCertSubject;

@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

If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

SSLCert Property (PIMAP Module)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

• Swift
• Objective-C

public var sslCert: Certificate {
  get {...}
  set {...}
}

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

- (NSString*)SSLCertEffectiveDate;

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

- (NSString*)SSLCertExpirationDate;

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

- (NSString*)SSLCertExtendedKeyUsage;

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

- (NSString*)SSLCertFingerprint;

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

- (NSString*)SSLCertFingerprintSHA1;

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

- (NSString*)SSLCertFingerprintSHA256;

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

- (NSString*)SSLCertIssuer;

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

- (NSString*)SSLCertPrivateKey;

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

- (BOOL)SSLCertPrivateKeyAvailable;

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

- (NSString*)SSLCertPrivateKeyContainer;

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

- (NSString*)SSLCertPublicKey;

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

- (NSString*)SSLCertPublicKeyAlgorithm;

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

- (int)SSLCertPublicKeyLength;

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

- (NSString*)SSLCertSerialNumber;

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

- (NSString*)SSLCertSignatureAlgorithm;

@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;
@property (nonatomic,readwrite,assign,getter=SSLCertStorePassword,setter=setSSLCertStorePassword:) NSString* SSLCertStorePassword;

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

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

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

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

- (NSString*)SSLCertSubjectAltNames;

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

- (NSString*)SSLCertThumbprintMD5;

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

- (NSString*)SSLCertThumbprintSHA1;

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

- (NSString*)SSLCertThumbprintSHA256;

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

- (NSString*)SSLCertUsage;

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

- (int)SSLCertUsageFlags;

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

- (NSString*)SSLCertVersion;

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

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

@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 property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the field to the encoded certificate. To select a certificate, use the store and subject fields.

SSLEnabled Property (PIMAP Module)

This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled.

Syntax

• Swift
• Objective-C

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 property 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 (PIMAP Module)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

• Swift
• Objective-C

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

public enum PIMAPSSLProviders: 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 as follows:

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.

SSLServerCert Property (PIMAP Module)

The server certificate for the last established connection.

Syntax

• Swift
• Objective-C

public var sslServerCert: Certificate {
  get {...}
}

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

- (NSString*)SSLServerCertEffectiveDate;

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

- (NSString*)SSLServerCertExpirationDate;

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

- (NSString*)SSLServerCertExtendedKeyUsage;

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

- (NSString*)SSLServerCertFingerprint;

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

- (NSString*)SSLServerCertFingerprintSHA1;

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

- (NSString*)SSLServerCertFingerprintSHA256;

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

- (NSString*)SSLServerCertIssuer;

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

- (NSString*)SSLServerCertPrivateKey;

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

- (BOOL)SSLServerCertPrivateKeyAvailable;

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

- (NSString*)SSLServerCertPrivateKeyContainer;

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

- (NSString*)SSLServerCertPublicKey;

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

- (NSString*)SSLServerCertPublicKeyAlgorithm;

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

- (int)SSLServerCertPublicKeyLength;

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

- (NSString*)SSLServerCertSerialNumber;

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

- (NSString*)SSLServerCertSignatureAlgorithm;

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

- (NSString*)SSLServerCertStore;

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

- (NSData*)SSLServerCertStoreB;
@property (nonatomic,readonly,assign,getter=SSLServerCertStorePassword) NSString* SSLServerCertStorePassword;

- (NSString*)SSLServerCertStorePassword;

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

- (int)SSLServerCertStoreType;

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

- (NSString*)SSLServerCertSubjectAltNames;

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

- (NSString*)SSLServerCertThumbprintMD5;

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

- (NSString*)SSLServerCertThumbprintSHA1;

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

- (NSString*)SSLServerCertThumbprintSHA256;

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

- (NSString*)SSLServerCertUsage;

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

- (int)SSLServerCertUsageFlags;

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

- (NSString*)SSLServerCertVersion;

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

- (NSString*)SSLServerCertSubject;

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

- (NSString*)SSLServerCertEncoded;

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

- (NSData*)SSLServerCertEncodedB;
 

Default Value

""

Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

SSLStartMode Property (PIMAP Module)

This property determines how the module starts the Secure Sockets Layer (SSL) negotiation.

Syntax

• Swift
• Objective-C

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

public enum PIMAPSSLStartModes: 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:

StartByte Property (PIMAP Module)

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

Syntax

• Swift
• Objective-C

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 RetrieveMessagePart 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 (PIMAP Module)

The timeout for the module.

Syntax

• Swift
• Objective-C

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 .

Note: By default, all timeouts are inactivity timeouts, that is, 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 (PIMAP Module)

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

Syntax

• Swift
• Objective-C

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

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

Syntax

• Swift
• Objective-C

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

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

Syntax

• Swift
• Objective-C

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

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

Syntax

• Swift
• Objective-C

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:

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

AppendToMailbox Method (PIMAP Module)

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

Syntax

• Swift
• Objective-C

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

This method sends a CHECK command to the server.

Syntax

• Swift
• Objective-C

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

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

Syntax

• Swift
• Objective-C

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

Sets or retrieves a configuration setting.

Syntax

• Swift
• Objective-C

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

This method connects to an IMAP server.

Syntax

• Swift
• Objective-C

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

Copies the specified messages to another mailbox.

Syntax

• Swift
• Objective-C

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

This method creates a new mailbox specified by Mailbox .

Syntax

• Swift
• Objective-C

public func createMailbox() throws -> Void

- (void)createMailbox;

Remarks

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

Decrypt Method (PIMAP Module)

Decrypts the message.

Syntax

• Swift
• Objective-C

public func decrypt() throws -> Void

- (void)decrypt;

Remarks

This method decrypts the specified message.

The message will be decrypted using the keys specified in Keys. Before decryption begins the class will fire the RecipientInfo event with information about the encrypted message, including the key used to encrypt the message. Within this event you may use the available information to load the correct key into Keys.

DecryptAndVerifySignature Method (PIMAP Module)

Decrypts and verifies the signature of the message.

Syntax

• Swift
• Objective-C

public func decryptAndVerifySignature() throws -> Void

- (void)decryptAndVerifySignature;

Remarks

This method attempts to both decrypt and verify the signature of the message. All of the properties affected by calling the Decrypt and VerifySignature methods are affected in the same manner.

This method may be used when the data is signed, encrypted, or signed and encrypted. For instance, if the data is encrypted but not signed you may still use this method and the class will perform the decryption without error.

The message will be decrypted using the keys specified in Keys. Before decryption begins the class will fire the RecipientInfo event with information about the encrypted message, including the key used to encrypt the message. Within this event you may use the available information to load the correct key into Keys.

The message will be verified using the keys specified in SignerKeys. Before verification begins the class will fire the SignatureInfo event with information about the signature including the key used to sign the message. Within this event you may use the information available to load the correct key into SignerKeys.

By default, if the signature is not valid the class . The configuration setting RequireValidSignature may be set to False to disable this requirement. When RequireValidSignature is set to False, the Status parameter of the VerificationStatus event should be checked to determine the result of the operation.

NOTE: This method does not attempt to check the validity of the signing key itself.

DeleteFromMailbox Method (PIMAP Module)

The method marks the messages specified by MessageSet as deleted.

Syntax

• Swift
• Objective-C

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

This method deletes a mailbox specified by Mailbox .

Syntax

• Swift
• Objective-C

public func deleteMailbox() throws -> Void

- (void)deleteMailbox;

Remarks

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

DeleteMailboxACL Method (PIMAP Module)

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

Syntax

• Swift
• Objective-C

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

This method disconnects from an IMAP server.

Syntax

• Swift
• Objective-C

public func disconnect() throws -> Void

- (void)disconnect;

Remarks

This method logs out and disconnects from the IMAP server.

DoEvents Method (PIMAP Module)

This method processes events from the internal message queue.

Syntax

• Swift
• Objective-C

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

This method selects a mailbox in read-only mode.

Syntax

• Swift
• Objective-C

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

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

Syntax

• Swift
• Objective-C

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

GetMailboxACL Method (PIMAP Module)

This method retrieves mailbox access control rights.

Syntax

• Swift
• Objective-C

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:

Interrupt Method (PIMAP Module)

This method interrupts the current method.

Syntax

• Swift
• Objective-C

public func interrupt() throws -> Void

- (void)interrupt;

Remarks

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

ListMailboxes Method (PIMAP Module)

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

Syntax

• Swift
• Objective-C

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

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

Syntax

• Swift
• Objective-C

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

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

Syntax

• Swift
• Objective-C

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

Copies the specified messages to another mailbox and marks the original messages as deleted.

Syntax

• Swift
• Objective-C

public func moveToMailbox() throws -> Void

- (void)moveToMailbox;

Remarks

This method copies the messages specified by the MessageSet property to the mailbox specified by the Mailbox property. Additionally, the messages in the original mailbox are marked as deleted.

Calling this method is equivalent to calling the CopyToMailbox method immediately followed by the DeleteFromMailbox method.

Noop Method (PIMAP Module)

This method sends a NOOP command to the server.

Syntax

• Swift
• Objective-C

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

This method changes the name of Mailbox to NewName .

Syntax

• Swift
• Objective-C

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.

ResetMessageFlags Method (PIMAP Module)

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

Syntax

• Swift
• Objective-C

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:

RetrieveMessageHeaders Method (PIMAP Module)

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

Syntax

• Swift
• Objective-C

public func retrieveMessageHeaders() throws -> Void

- (void)retrieveMessageHeaders;

Remarks

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

RetrieveMessageInfo Method (PIMAP Module)

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

Syntax

• Swift
• Objective-C

public func retrieveMessageInfo() throws -> Void

- (void)retrieveMessageInfo;

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

RetrieveMessagePart Method (PIMAP Module)

This method retrieves the message part specified by PartID.

Syntax

• Swift
• Objective-C

public func retrieveMessagePart(partId: String) throws -> Void

- (void)retrieveMessagePart:(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 retrieval.

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.

RetrieveMessagePartHeaders Method (PIMAP Module)

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

Syntax

• Swift
• Objective-C

public func retrieveMessagePartHeaders(partId: String) throws -> Void

- (void)retrieveMessagePartHeaders:(NSString*)partId;

Remarks

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

RetrieveMessageText Method (PIMAP Module)

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

Syntax

• Swift
• Objective-C

public func retrieveMessageText() throws -> Void

- (void)retrieveMessageText;

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

SearchMailbox Method (PIMAP Module)

This method searches the selected mailbox for specified text.

Syntax

• Swift
• Objective-C

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

SelectMailbox Method (PIMAP Module)

This method selects a mailbox.

Syntax

• Swift
• Objective-C

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

This method sends the exact command directly to the server.

Syntax

• Swift
• Objective-C

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 or monitor the PITrail event to obtain the server's response.

SetMailboxACL Method (PIMAP Module)

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

Syntax

• Swift
• Objective-C

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:

StartIdle Method (PIMAP Module)

This method begins idling.

Syntax

• Swift
• Objective-C

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

This method stops idling.

Syntax

• Swift
• Objective-C

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

This method subscribes to the mailbox specified by Mailbox .

Syntax

• Swift
• Objective-C

public func subscribeMailbox() throws -> Void

- (void)subscribeMailbox;

Remarks

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

UnsetMessageFlags Method (PIMAP Module)

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

Syntax

• Swift
• Objective-C

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:

UnsubscribeMailbox Method (PIMAP Module)

This method unsubscribes from the mailbox specified by Mailbox .

Syntax

• Swift
• Objective-C

public func unsubscribeMailbox() throws -> Void

- (void)unsubscribeMailbox;

Remarks

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

VerifySignature Method (PIMAP Module)

Verifies the signature of the current message.

Syntax

• Swift
• Objective-C

public func verifySignature() throws -> Void

- (void)verifySignature;

Remarks

This method verifies the signature of the message.

The message will be verified using the keys specified in SignerKeys. Before verification begins the class will fire the SignatureInfo event with information about the signature including the key used to sign the message. Within this event you may use the information available to load the correct key into SignerKeys.

By default, if the signature is not valid the class . The configuration setting RequireValidSignature may be set to False to disable this requirement. When RequireValidSignature is set to False, the Status parameter of the VerificationStatus event should be checked to determine the result of the operation.

ConnectionStatus Event (PIMAP Module)

Fired to indicate changes in the connection state.

Syntax

• Swift
• Objective-C

func onConnectionStatus(connectionEvent: String, statusCode: Int32, description: String)

- (void)onConnectionStatus:(NSString*)connectionEvent :(int)statusCode :(NSString*)description;

Remarks

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

EndTransfer Event (PIMAP Module)

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

Syntax

• Swift
• Objective-C

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

Fired when information is available about errors during data delivery.

Syntax

• Swift
• Objective-C

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 .

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

Header Event (PIMAP Module)

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

Syntax

• Swift
• Objective-C

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

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

Syntax

• Swift
• Objective-C

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

KeyPassphrase Event (PIMAP Module)

Fired if the passphrase of current key is incorrect or empty.

Syntax

• Swift
• Objective-C

func onKeyPassphrase(userId: String, keyId: String, fingerprint: String, passphrase: inout String)

- (void)onKeyPassphrase:(NSString*)userId :(NSString*)keyId :(NSString*)fingerprint :(NSString**)passphrase;

Remarks

This event fires when the passphrase for the key is required. The passphrase must be specified before operations requiring the secret key are attempted. The passphrase may be supplied by setting the Passphrase parameter in this event, or by specifying the KeysPassphrase property before attempting the operation.

The passphrase is required when using the following methods in KeyMgr:

• AddUserId
• SignUserId
• ChangeExpirationDate
• ChangePassphrase

When using the OpenPGP class, or an email-based class, the following methods require a passphrase for the key:

• Decrypt
• Sign
• SignAndEncrypt

UserId holds the user Id of the key the passphrase is required for.

The UserId format is:

FirstName LastName (Comment) <Email>

Note that for OpenPGP v6, a key may be created with or without a UserId, as the field is optional. If a key was created without a UserId, the key's Fingerprint can be used as it's identifier instead.

KeyId is the hex-encoded, 4-byte or 8-byte Id of the key the passphrase is required for. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's Fingerprint. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's Fingerprint instead. For instance:

5E70662EA810E768

Fingerprint holds the hex-encoded, 20-byte fingerprint of the key the passphrase is required for. This is in the form:

5E70662EA810E768391A2FE8F7B7D49C89C9D7B1

MailboxACL Event (PIMAP Module)

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

Syntax

• Swift
• Objective-C

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:

MailboxList Event (PIMAP Module)

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

Syntax

• Swift
• Objective-C

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

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

Syntax

• Swift
• Objective-C

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

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

Syntax

• Swift
• Objective-C

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

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

Syntax

• Swift
• Objective-C

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:

Progress Event (PIMAP Module)

Fired as progress is made.

Syntax

• Swift
• Objective-C

func onProgress(bytesProcessed: Int64, percentProcessed: Int32)

- (void)onProgress:(long long)bytesProcessed :(int)percentProcessed;

Remarks

This event is fired automatically as data is processed by the class.

The PercentProcessed parameter indicates the current status of the operation.

The BytesProcessed parameter holds the total number of bytes processed so far.

RecipientInfo Event (PIMAP Module)

Fired for each recipient key of the encrypted message.

Syntax

• Swift
• Objective-C

func onRecipientInfo(keyId: String, fingerprint: String, publicKeyAlgorithm: String)

- (void)onRecipientInfo:(NSString*)keyId :(NSString*)fingerprint :(NSString*)publicKeyAlgorithm;

Remarks

This event fires when the Decrypt or DecryptAndVerifySignature method is called.

KeyId is the hex-encoded 4- or 8-byte Id of the key used to encrypt the message. If a subkey was used to encrypt the message this will be the Id of that subkey. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's Fingerprint. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's Fingerprint instead. For instance:

5E70662EA810E768

Fingerprint holds the hex-encoded, 20-byte fingerprint of the key. This is in the form:

5E70662EA810E768391A2FE8F7B7D49C89C9D7B1

The KeyId and Fingerprint parameters can be used to identify the correct key to specify in Keys. Keys can be set from within this event as this event fires directly before the decryption process begins.

It is recommended to use the Fingerprint to identify the correct key, as it is possible for different keys to have the same KeyId.

PublicKeyAlgorithm is the algorithm of the public key used to encrypt the message. Possible values are:

• RSA
• DSA
• ECDSA
• EdDSA
• Ed25519
• Ed448
• RSA-Legacy
• ECDH (Subkeys only)
• X25519 (Subkeys only)
• X448 (Subkeys only)

SignatureInfo Event (PIMAP Module)

Fired during verification of the signed message.

Syntax

• Swift
• Objective-C

func onSignatureInfo(keyId: String, fingerprint: String, signingAlgorithm: String, publicKeyAlgorithm: String)

- (void)onSignatureInfo:(NSString*)keyId :(NSString*)fingerprint :(NSString*)signingAlgorithm :(NSString*)publicKeyAlgorithm;

Remarks

This event fires when the VerifySignature or DecryptAndVerifySignature method is called. It provides information about the signature of the message.

KeyId is the hex-encoded 4- or 8-byte Id of the key used to sign the message. If a subkey was used to sign the message this will be the Id of that subkey. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's Fingerprint. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's Fingerprint instead. For instance:

5E70662EA810E768

Fingerprint holds the hex-encoded, 20-byte fingerprint of the key. This is in the form:

5E70662EA810E768391A2FE8F7B7D49C89C9D7B1

The KeyId and Fingerprint parameters can be used to identify the correct key to specify in SignerKeys. SignerKeys can be set from within this event as this event fires directly before the verification process begins.

It is recommended to use the Fingerprint to identify the correct key, as it is possible for different keys to have the same KeyId.

SigningAlgorithm describes the hash algorithm used when the message was originally signed. This value is applicable only to the message signature, not the key used to sign the message. Possible values are:

• SHA1
• MD5
• SHA256
• SHA384
• SHA512
• SHA224
• RIPEMD160
• SHA3-256
• SHA3-512

PublicKeyAlgorithm is the algorithm of the public key used to sign the message. Possible values are:

• RSA
• DSA
• ECDSA
• EdDSA
• Ed25519
• Ed448
• RSA-Legacy
• ECDH (Subkeys only)
• X25519 (Subkeys only)
• X448 (Subkeys only)

SSLServerAuthentication Event (PIMAP Module)

Fired after the server presents its certificate to the client.

Syntax

• Swift
• Objective-C

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

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (PIMAP Module)

Fired when secure connection progress messages are available.

Syntax

• Swift
• Objective-C

func onSSLStatus(message: String)

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

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

StartTransfer Event (PIMAP Module)

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

Syntax

• Swift
• Objective-C

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.

Status Event (PIMAP Module)

Shows the progress of the operation.

Syntax

• Swift
• Objective-C

func onStatus(message: String)

- (void)onStatus:(NSString*)message;

Remarks

The event is fired for informational and logging purposes only. It may be used to track the progress of an operation.

The level of detail is controlled by the LogLevel setting.

Transfer Event (PIMAP Module)

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

Syntax

• Swift
• Objective-C

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.

VerificationStatus Event (PIMAP Module)

Fired after verification of the signed message.

Syntax

• Swift
• Objective-C

func onVerificationStatus(keyId: String, fingerprint: String, status: Int32)

- (void)onVerificationStatus:(NSString*)keyId :(NSString*)fingerprint :(int)status;

Remarks

This event fires when VerifySignature or DecryptAndVerifySignature is called. It provides information about the result.

KeyId is the hex-encoded 4- or 8-byte Id of the key used to sign the message. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's Fingerprint. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's Fingerprint instead. For instance:

5E70662EA810E768

Fingerprint holds the hex-encoded, 20-byte fingerprint of the key. This is in the form:

5E70662EA810E768391A2FE8F7B7D49C89C9D7B1

Status holds the result of the operation. Possible values are:

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

public init()

public init(encoded: )

public init(storeType: , store: , storePassword: , subject: )

public init(storeType: , store: , storePassword: , subject: )

Firewall Type

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

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

Constructors

public init()

public init(field: , value: )

Key Type

The OpenPGP key being used.

Remarks

This type describes the current key. The key may be a public or secret key. The fields are used to identify or select the key.

Fields

5E70662EA810E768391A2FE8F7B7D49C89C9D7B1

5E70662EA810E768

FirstName LastName (Comment) <Email>

Constructors

public init(keyring: )

public init(encoded: )

public init(keyring: , userId: )

public init(encoded: , userId: )

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

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

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

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

Constructors

public init()

public init(address: )

Config Settings (PIMAP Module)

PIMAP Config Settings

SIMAP Config Settings

IMAP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings

Trappable Errors (PIMAP Module)

IMAP Errors

TCPClient Errors