IMAPClient Class

Properties   Methods   Events   Config Settings   Errors  

The IMAPClient class provides client-side functionality for IMAP4 (Internet Message Access Protocol).

Syntax

secureblackbox.Imapclient

Remarks

Use this class to manage E-mail and retrieve E-mail messages from the remote IMAP servers.

Property List

---

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

Method List

---

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

Event List

---

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

Config Settings

---

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

BlockedCertificates Property (IMAPClient Class)

The certificates that must be rejected as trust anchors.

Syntax

public CertificateList getBlockedCertificates();


public void setBlockedCertificates(CertificateList blockedCertificates);

Remarks

Use this property to provide a list of compromised or blocked certificates. Any chain containing a blocked certificate will fail validation.

This property is not available at design time.

Please refer to the Certificate type for a complete list of fields.

ClientChain Property (IMAPClient Class)

The TLS client certificate chain.

Syntax

public CertificateList getClientChain();


public void setClientChain(CertificateList clientChain);

Remarks

Assign a certificate chain to this property to enable TLS client authentication in the class. Note that the client's end-entity certificate should have a private key associated with it.

Use CertificateStorage or CertificateManager components to import the certificate from a file, system store, or PKCS11 device.

This property is not available at design time.

Please refer to the Certificate type for a complete list of fields.

ConnectionInfo Property (IMAPClient Class)

Returns the details of the underlying network connection.

Syntax

public ConnectionInfo getConnectionInfo();

Remarks

Use this property to learn about the connection setup, such as the protocol security details and amounts of data transferred each way.

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

Please refer to the ConnectionInfo type for a complete list of fields.

CurrentMailbox Property (IMAPClient Class)

Returns the selected (active) mailbox status.

Syntax

public IMAPMailboxStatus getCurrentMailbox();

Remarks

Use this property to access the status of the mailbox that is currently selected (active).

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

Please refer to the IMAPMailboxStatus type for a complete list of fields.

FIPSMode Property (IMAPClient Class)

Reserved.

Syntax

public boolean isFIPSMode();


public void setFIPSMode(boolean FIPSMode);

Default Value

False

Remarks

This property is reserved for future use.

KnownCertificates Property (IMAPClient Class)

Additional certificates for chain validation.

Syntax

public CertificateList getKnownCertificates();


public void setKnownCertificates(CertificateList knownCertificates);

Remarks

Use this property to supply a list of additional certificates that might be needed for chain validation. An example of a scenario where you might want to do that is when intermediary CA certificates are absent from the standard system locations (or when there are no standard system locations), and therefore should be supplied to the class manually.

The purpose of the certificates to be added to this collection is roughly equivalent to that of the Intermediate Certification Authorities system store in Windows.

Do not add trust anchors or root certificates to this collection: add them to TrustedCertificates instead.

This property is not available at design time.

Please refer to the Certificate type for a complete list of fields.

KnownCRLs Property (IMAPClient Class)

Additional CRLs for chain validation.

Syntax

public CRLList getKnownCRLs();


public void setKnownCRLs(CRLList knownCRLs);

Remarks

Use this property to supply additional CRLs that might be needed for chain validation. This property may be helpful when a chain is validated in offline mode, and the associated CRLs are stored separately from the signed message or document.

This property is not available at design time.

Please refer to the CRL type for a complete list of fields.

KnownOCSPs Property (IMAPClient Class)

Additional OCSP responses for chain validation.

Syntax

public OCSPResponseList getKnownOCSPs();


public void setKnownOCSPs(OCSPResponseList knownOCSPs);

Remarks

Use this property to supply additional OCSP responses that might be needed for chain validation. This property may be helpful when a chain is validated in offline mode, and the associated OCSP responses are stored separately from the signed message or document.

This property is not available at design time.

Please refer to the OCSPResponse type for a complete list of fields.

Mailboxes Property (IMAPClient Class)

Populates a list of mailboxes available on the server.

Syntax

public IMAPMailboxInfoList getMailboxes();

Remarks

Use this property to access the details of mailboxes after a ListMailboxes call.

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

Please refer to the IMAPMailboxInfo type for a complete list of fields.

Message Property (IMAPClient Class)

Contains a pinned e-mail message.

Syntax

public MailMessage getMessage();


public void setMessage(MailMessage message);

Remarks

Use this property to access an e-mail message that was just downloaded with a ReceiveMessage call, or assign it with a message to be uploaded with PostMessage call.

This property is not available at design time.

Please refer to the MailMessage type for a complete list of fields.

Messages Property (IMAPClient Class)

Populates a list of messages returned by the last list call.

Syntax

public IMAPMessageInfoList getMessages();

Remarks

Use this property to access the details of messages after a call to one of the list methods.

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

Please refer to the IMAPMessageInfo type for a complete list of fields.

Password Property (IMAPClient Class)

The authentication password.

Syntax

public String getPassword();


public void setPassword(String password);

Default Value

""

Remarks

Use this property to provide the password for authenticating to the IMAP server.

Proxy Property (IMAPClient Class)

The proxy server settings.

Syntax

public ProxySettings getProxy();

Remarks

Use this property to tune up the proxy server settings.

This property is read-only.

Please refer to the ProxySettings type for a complete list of fields.

ServerChain Property (IMAPClient Class)

The TLS server's certificate chain.

Syntax

public CertificateList getServerChain();

Remarks

Use this property to access the certificate chain sent by the TLS server. This property is ready to read when OnCertificateValidate event is fired by the client component.

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

Please refer to the Certificate type for a complete list of fields.

ServerInfo Property (IMAPClient Class)

Encapsulates information about the server.

Syntax

public IMAPServerInfo getServerInfo();

Remarks

Use this property after establishing a connection to the server to learn about the IMAP server's capabilities.

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

Please refer to the IMAPServerInfo type for a complete list of fields.

SocketSettings Property (IMAPClient Class)

Manages network connection settings.

Syntax

public SocketSettings getSocketSettings();

Remarks

Use this property to tune up network connection parameters.

This property is read-only.

Please refer to the SocketSettings type for a complete list of fields.

TLSSettings Property (IMAPClient Class)

Manages TLS layer settings.

Syntax

public TLSSettings getTLSSettings();

Remarks

Use this property to tune up the TLS layer parameters.

This property is read-only.

Please refer to the TLSSettings type for a complete list of fields.

TrustedCertificates Property (IMAPClient Class)

A list of trusted certificates for chain validation.

Syntax

public CertificateList getTrustedCertificates();


public void setTrustedCertificates(CertificateList trustedCertificates);

Remarks

Use this property to supply a list of trusted certificates that might be needed for chain validation. An example of a scenario where you might want to do that is when root CA certificates are absent from the standard system locations (or when there are no standard system locations), and therefore should be supplied to the component manually.

The purpose of this certificate collection is largely the same as that of the Windows Trusted Root Certification Authorities system store.

Use this property with extreme care as it directly affects chain verifiability; a wrong certificate added to the trusted list may result in bad chains being accepted, and forfeited signatures being recognized as genuine. Only add certificates that originate from the parties that you know and trust.

This property is not available at design time.

Please refer to the Certificate type for a complete list of fields.

Username Property (IMAPClient Class)

The authentication username.

Syntax

public String getUsername();


public void setUsername(String username);

Default Value

""

Remarks

Use this property to provide the username for authenticating to the IMAP server.

CloseMailbox Method (Imapclient Class)

Closes the current mailbox.

Syntax

public void closeMailbox();

Remarks

Use this method to close the CurrentMailbox.

Config Method (Imapclient Class)

Sets or retrieves a configuration setting.

Syntax

public String config(String 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 (Imapclient Class)

Establishes a connection to the IMAP server.

Syntax

public void connect(String address, int port);

Remarks

Use this method to establish a connection to the IMAP server at Address and Port.

CopyMessage Method (Imapclient Class)

Copies a message to another mailbox.

Syntax

public void copyMessage(int UID, String mailboxName);

Remarks

Copies a message specified by its UID to another mailbox.

CreateMailbox Method (Imapclient Class)

Creates a new mailbox.

Syntax

public void createMailbox(String name);

Remarks

Call this method to create a new mailbox, providing the name via the Name parameter.

DeleteMailbox Method (Imapclient Class)

Deletes an existing mailbox.

Syntax

public void deleteMailbox(String name);

Remarks

Call this method to delete a mailbox.

Disconnect Method (Imapclient Class)

Closes connection to the IMAP server.

Syntax

public void disconnect();

Remarks

Call this method to gracefully terminate the connection.

DoAction Method (Imapclient Class)

Performs an additional action.

Syntax

public String doAction(String actionID, String actionParams);

Remarks

DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

ExamineMailbox Method (Imapclient Class)

Selects the mailbox in read-only mode.

Syntax

public void examineMailbox(String name);

Remarks

Use this method to select the specified mailbox on the server in read-only mode. Only one mailbox can be selected at a time. You can check the name of the currently selected mailbox using the CurrentMailbox property.

GetMailboxStatus Method (Imapclient Class)

Requests a mailbox status.

Syntax

public void getMailboxStatus(String name);

Remarks

Requests the status of the specified mailbox and returns it using MailboxStatus event.

ListAllMessages Method (Imapclient Class)

Queries a list of messages available in CurrentMailbox on the server.

Syntax

public void listAllMessages();

Remarks

Call this method to request a list of messages available in the current mailbox.

ListDeletedMessages Method (Imapclient Class)

Queries a list of deleted messages in the current mailbox on the server.

Syntax

public void listDeletedMessages();

Remarks

Call this method to enumerate deleted messages (i.e. those having Deleted flag set) in CurrentMailbox.

ListMailboxes Method (Imapclient Class)

Queries a list of mailboxes available on the server.

Syntax

public void listMailboxes();

Remarks

Use this method to request a list of mailboxes currently available on the server. Use the Mailboxes property to access the mailbox details.

ListNewMessages Method (Imapclient Class)

Queries a list of new messages available in the current mailbox on the mail server.

Syntax

public void listNewMessages();

Remarks

Retrieves a list of new messages (i.e. those having Recent flag set and not having Seen flag set) present in CurrentMailbox.

ListRecentMessages Method (Imapclient Class)

Queries a list of recent messages available in the current mailbox on the server.

Syntax

public void listRecentMessages();

Remarks

Retrieves a list of recent messages (i.e. those having Recent flag set) present in CurrentMailbox.

ListUnseenMessages Method (Imapclient Class)

Queries a list of unseen messages available in the current mailbox on the server.

Syntax

public void listUnseenMessages();

Remarks

Requests a list of unseen messages (i.e. not having Seen flag set) present in CurrentMailbox.

MarkMessageDeleted Method (Imapclient Class)

Sets a Deleted flag to the message.

Syntax

public void markMessageDeleted(int UID);

Remarks

Use this method to mark a message as deleted, then call PurgeMessages to remove all the marked messages from the server.

MarkMessageSeen Method (Imapclient Class)

Sets a Seen flag to the message.

Syntax

public void markMessageSeen(int UID);

Remarks

Use this method to mark a message as seen.

Ping Method (Imapclient Class)

Sends a NOOP command to the IMAP server.

Syntax

public void ping();

Remarks

This method sends a NOOP command to the server, effectively pinging the server and keeping the connection alive.

PostBytes Method (Imapclient Class)

Uploads an e-mail message stored in a byte array.

Syntax

public void postBytes(byte[] bytes, int flags, String internalDate);

Remarks

Use this method to send a message stored in a byte array specified by Bytes.

Supported flags are:

PostFile Method (Imapclient Class)

Uploads a message stored in a file to the current mailbox on the IMAP server.

Syntax

public void postFile(String filename, int flags, String internalDate);

Remarks

Use this method to upload an e-mail message stored in a file to CurrentMailbox.

Supported flags are:

PostMessage Method (Imapclient Class)

Uploads a pre-built message to the current mailbox on the IMAP server.

Syntax

public void postMessage(int flags, String internalDate);

Remarks

Use this message to upload Message to CurrentMailbox.

Supported flags are:

PostStream Method (Imapclient Class)

Uploads a message stored in a stream to the current mailbox on the IMAP server.

Syntax

public void postStream(java.io.InputStream stream, int flags, String internalDate);

Remarks

Use this message to upload a message provided in Stream to CurrentMailbox.

Supported flags are:

PurgeMessages Method (Imapclient Class)

Permanently removes all deleted messages from the current mailbox.

Syntax

public void purgeMessages();

Remarks

Use this method to permanently remove all messages in CurrentMailbox marked with the Deleted flag.

ReceiveBytes Method (Imapclient Class)

Downloads a message to a byte array.

Syntax

public byte[] receiveBytes(int UID);

Remarks

Use this method to download a server-side message to a byte array.

ReceiveFile Method (Imapclient Class)

Downloads a message to a file.

Syntax

public void receiveFile(int UID, String filename);

Remarks

Use this method to download a server-side message to a local file.

ReceiveMessage Method (Imapclient Class)

Downloads a message.

Syntax

public void receiveMessage(int UID);

Remarks

Use this method to download a server-side message to the Message object.

ReceiveStream Method (Imapclient Class)

Downloads a message to a stream.

Syntax

public void receiveStream(int UID, java.io.OutputStream stream);

Remarks

Use this method to download a server-side message to a stream object.

RefreshMailbox Method (Imapclient Class)

Refreshes the state info of the current mailbox.

Syntax

public void refreshMailbox();

Remarks

Use this method to refresh the CurrentMailbox info.

RenameMailbox Method (Imapclient Class)

Renames an existing mailbox.

Syntax

public void renameMailbox(String name, String newName);

Remarks

Use this method to rename an existing mailbox from Name to NewName.

SelectMailbox Method (Imapclient Class)

Selects the specified mailbox.

Syntax

public void selectMailbox(String name);

Remarks

Use this method to select the specified mailbox on the server. Only one mailbox can be selected at a time. You can check the name of the currently selected mailbox using the CurrentMailbox property.

UpdateMessage Method (Imapclient Class)

Alters flags assotiated with a message in the current mailbox on the IMAP server.

Syntax

public void updateMessage(int UID, int setFlags, int clearFlags);

Remarks

Use this method to alter flags associated with a UID message in CurrentMailbox.

Supported flags are:

If a flag is to be set, pass it to the SetFlags parameter. If a flag is to be cleared for a message, pass it to the ClearFlags parameter.

Notice: flags are cleared first, then set. So if you pass the same flag to both parameter, the flag will be set for the message.

BeforeAuth Event (Imapclient Class)

Fires before the authentication starts.

Syntax

public class DefaultImapclientEventListener implements ImapclientEventListener {
  ...
  public void beforeAuth(ImapclientBeforeAuthEvent e) {}
  ...
}

public class ImapclientBeforeAuthEvent {
}

Remarks

The class fires this event when it has established the TCP connection and is ready to proceed to the user authentication step.

Command Event (Imapclient Class)

Reports a command sent to the server.

Syntax

public class DefaultImapclientEventListener implements ImapclientEventListener {
  ...
  public void command(ImapclientCommandEvent e) {}
  ...
}

public class ImapclientCommandEvent {
  public String cmd;
}

Remarks

The class fires this event whenever it sends an IMAP command to the server. Use CommandReply and CommandReplyData to track the server's responses.

CommandData Event (Imapclient Class)

Returns the data that accompanies the command.

Syntax

public class DefaultImapclientEventListener implements ImapclientEventListener {
  ...
  public void commandData(ImapclientCommandDataEvent e) {}
  ...
}

public class ImapclientCommandDataEvent {
  public String cmd;
  public String data;
}

Remarks

Subscribe to this event to access data accompanying the outgoing commands.

CommandReply Event (Imapclient Class)

Reports the receipt of a reply to a command.

Syntax

public class DefaultImapclientEventListener implements ImapclientEventListener {
  ...
  public void commandReply(ImapclientCommandReplyEvent e) {}
  ...
}

public class ImapclientCommandReplyEvent {
  public String cmd;
  public String reply;
}

Remarks

Use this event to track command replies sent in by the server. Use Command to track the commands sent out by the client, and CommandReplyData to access the reply data for commands that assume it.

CommandReplyData Event (Imapclient Class)

Returns the data that accompanies a reply to a command.

Syntax

public class DefaultImapclientEventListener implements ImapclientEventListener {
  ...
  public void commandReplyData(ImapclientCommandReplyDataEvent e) {}
  ...
}

public class ImapclientCommandReplyDataEvent {
  public String cmd;
  public String data;
}

Remarks

Subscribe to this event to access data accompanying incoming command replies.

Error Event (Imapclient Class)

Provides information about errors during SMTP operations.

Syntax

public class DefaultImapclientEventListener implements ImapclientEventListener {
  ...
  public void error(ImapclientErrorEvent e) {}
  ...
}

public class ImapclientErrorEvent {
  public int errorCode;
  public String description;
}

Remarks

This event is fired in case of exceptional conditions occured during SMTP operations.

ErrorCode contains an error code and Description contains a textual description of the error.

MailboxStatus Event (Imapclient Class)

Reports the mailbox status returned from the server.

Syntax

public class DefaultImapclientEventListener implements ImapclientEventListener {
  ...
  public void mailboxStatus(ImapclientMailboxStatusEvent e) {}
  ...
}

public class ImapclientMailboxStatusEvent {
  public String name;
  public int totalMessages;
  public int recentMessages;
  public int unseenMessages;
  public int nextUID;
  public int UIDValidity;
}

Remarks

Subscribe to this event to be notified of mailbox status as returned by the IMAP server.

Notification Event (Imapclient Class)

This event notifies the application about an underlying control flow event.

Syntax

public class DefaultImapclientEventListener implements ImapclientEventListener {
  ...
  public void notification(ImapclientNotificationEvent e) {}
  ...
}

public class ImapclientNotificationEvent {
  public String eventID;
  public String eventParam;
}

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.

Progress Event (Imapclient Class)

Reports the progress of the data transfer operation.

Syntax

public class DefaultImapclientEventListener implements ImapclientEventListener {
  ...
  public void progress(ImapclientProgressEvent e) {}
  ...
}

public class ImapclientProgressEvent {
  public long total;
  public long current;
  public boolean cancel;
}

Remarks

The class fires this event repeatedly to report the progress of the data transfer operation.

TLSCertNeeded Event (Imapclient Class)

Fires when a remote TLS party requests a client certificate.

Syntax

public class DefaultImapclientEventListener implements ImapclientEventListener {
  ...
  public void TLSCertNeeded(ImapclientTLSCertNeededEvent e) {}
  ...
}

public class ImapclientTLSCertNeededEvent {
  public String host;
  public String CANames;
}

Remarks

This event fires to notify the implementation that a remote TLS server has requested a client certificate. The Host parameter identifies the host that makes a request, and the CANames parameter (optional, according to the TLS spec) advises on the accepted issuing CAs.

Use the TLSClientChain property in response to this event to provide the requested certificate. Please make sure the client certificate includes the associated private key. Note that you may set the certificates before the connection without waiting for this event to fire.

This event is preceded by the TLSHandshake event for the given host and, if the certificate was accepted, succeeded by the TLSEstablished event.

TLSCertValidate Event (Imapclient Class)

This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.

Syntax

public class DefaultImapclientEventListener implements ImapclientEventListener {
  ...
  public void TLSCertValidate(ImapclientTLSCertValidateEvent e) {}
  ...
}

public class ImapclientTLSCertValidateEvent {
  public String serverHost;
  public String serverIP;
  public boolean accept;
}

Remarks

This event is fired during a TLS handshake. Use the TLSServerChain property to access the certificate chain. In general, classes may contact a number of TLS endpoints during their work, depending on their configuration.

Accept is assigned in accordance with the outcome of the internal validation check performed by the class, and can be adjusted if needed.

TLSEstablished Event (Imapclient Class)

Fires when a TLS handshake with Host successfully completes.

Syntax

public class DefaultImapclientEventListener implements ImapclientEventListener {
  ...
  public void TLSEstablished(ImapclientTLSEstablishedEvent e) {}
  ...
}

public class ImapclientTLSEstablishedEvent {
  public String host;
  public String version;
  public String ciphersuite;
  public byte[] connectionId;
  public boolean abort;
}

Remarks

The class uses this event to notify the application about a successful completion of a TLS handshake.

The Version, Ciphersuite, and ConnectionId parameters indicate the security parameters of the new connection. Use the Abort parameter if you need to terminate the connection at this stage.

TLSHandshake Event (Imapclient Class)

Fires when a new TLS handshake is initiated, before the handshake commences.

Syntax

public class DefaultImapclientEventListener implements ImapclientEventListener {
  ...
  public void TLSHandshake(ImapclientTLSHandshakeEvent e) {}
  ...
}

public class ImapclientTLSHandshakeEvent {
  public String host;
  public boolean abort;
}

Remarks

The class uses this event to notify the application about the start of a new TLS handshake to Host. If the handshake is successful, this event will be followed by the TLSEstablished event. If the server chooses to request a client certificate, the TLSCertNeeded event will also be fired.

TLSPSK Event (Imapclient Class)

Notifies the application about the PSK key exchange.

Syntax

public class DefaultImapclientEventListener implements ImapclientEventListener {
  ...
  public void TLSPSK(ImapclientTLSPSKEvent e) {}
  ...
}

public class ImapclientTLSPSKEvent {
  public String host;
  public String hint;
}

Remarks

The class fires this event to notify the application about the beginning of TLS-PSK key exchange with Host. The Hint parameter may be used by the server to identify the key or service to use. Use the PreSharedKey field of TLSSettings to provide the pre-shared key to the component.

TLSShutdown Event (Imapclient Class)

Reports the graceful closure of a TLS connection.

Syntax

public class DefaultImapclientEventListener implements ImapclientEventListener {
  ...
  public void TLSShutdown(ImapclientTLSShutdownEvent e) {}
  ...
}

public class ImapclientTLSShutdownEvent {
  public String host;
}

Remarks

This event notifies the application about the closure of an earlier established TLS connection. Note that only graceful connection closures are reported.

Certificate Type

Provides details of an individual X.509 certificate.

Remarks

This type provides access to X.509 certificate details.

Fields

Constructors

public Certificate( bytes,  startIndex,  count,  password);

Loads the X.509 certificate from a memory buffer. Bytes is a buffer containing the raw certificate data. StartIndex and Count specify the starting position and number of bytes to be read from the buffer, respectively. Password is a password encrypting the certificate.

public Certificate( certBytes,  certStartIndex,  certCount,  keyBytes,  keyStartIndex,  keyCount,  password);

Loads the X.509 certificate from a memory buffer. CertBytes is a buffer containing the raw certificate data. CertStartIndex and CertCount specify the number of bytes to be read from the buffer, respectively. KeyBytes is a buffer containing the private key data. KeyStartIndex and KeyCount specify the starting position and number of bytes to be read from the buffer, respectively. Password is a password encrypting the certificate.

public Certificate( bytes,  startIndex,  count);

Loads the X.509 certificate from a memory buffer. Bytes is a buffer containing the raw certificate data. StartIndex and Count specify the starting position and number of bytes to be read from the buffer, respectively.

public Certificate( path,  password);

Loads the X.509 certificate from a file. Path specifies the full path to the file containing the certificate data. Password is a password encrypting the certificate.

public Certificate( certPath,  keyPath,  password);

Loads the X.509 certificate from a file. CertPath specifies the full path to the file containing the certificate data. KeyPath specifies the full path to the file containing the private key. Password is a password encrypting the certificate.

public Certificate( path);

Loads the X.509 certificate from a file. Path specifies the full path to the file containing the certificate data.

public Certificate( stream);

Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data.

public Certificate( stream,  password);

Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data. Password is a password encrypting the certificate.

public Certificate( certStream,  keyStream,  password);

Loads the X.509 certificate from a stream. CertStream is a stream containing the certificate data. KeyStream is a stream containing the private key. Password is a password encrypting the certificate.

public Certificate();

Creates a new object with default field values.

ConnectionInfo Type

Contains information about a network connection.

Remarks

Use this property to check various details of the network connection. These include the total amounts of data transferred, the availability of TLS, and its parameters.

Fields

Constructors

public ConnectionInfo();

Creates a new ConnectionInfo object.

CRL Type

Represents a Certificate Revocation List.

Remarks

CRLs store information about revoked certificates, i.e., certificates that have been identified as invalid by their issuing certificate authority (CA) for any number of reasons.

Each CRL object lists certificates from a single CA and identifies them by their serial numbers. A CA may or may not publish a CRL, may publish several CRLs, or may publish the same CRL in multiple locations.

Unlike OCSP responses, CRLs only list certificates that have been revoked. They do not list certificates that are still valid.

Fields

Constructors

public CRL( bytes,  startIndex,  count);

Creates a CRL object from a memory buffer. Bytes is a buffer containing raw (DER) CRL data, StartIndex and Count specify the starting position and the length of the CRL data in the buffer, respectively.

public CRL( location);

Creates a CRL object by downloading it from a remote location.

public CRL( stream);

Creates a CRL object from data contained in a stream.

public CRL();

Creates an empty CRL object.

IMAPMailboxInfo Type

Contains information about an IMAP mailbox.

Remarks

This compound object provides details of an IMAP mailbox.

Fields

IMAPMailboxStatus Type

Contains information about IMAP mailbox state.

Remarks

Provides details of current IMAP mailbox status.

Fields

IMAPMessageInfo Type

This type is a container for the server-side message details.

Remarks

Use this type to get the details of server-side messages after the list call.

Fields

IMAPServerInfo Type

Describes the IMAP server's capabilities.

Remarks

Check this object to learn about the IMAP server's technical capabilities.

Fields

MailMessage Type

Represents an e-mail message.

Remarks

This object is a container for an e-mail message.

A message consists of a header and a body. The header, in turn, consists of several header fields. The names, syntax, and expected contents of the header fields are standardized.

The message body can contain anything you like (a message may not even have a body at all).

Fields

Constructors

public MailMessage();

Creates a new empty mail message object.

OCSPResponse Type

Represents a single OCSP response originating from an OCSP responder.

Remarks

OCSP is a protocol that allows verification of certificate status in real-time, and is an alternative to Certificate Revocation Lists (CRLs).

An OCSP response is a snapshot of the certificate status at a given time.

Fields

Constructors

public OCSPResponse( bytes,  startIndex,  count);

Initializes the response from a memory buffer. Bytes is a buffer containing raw OCSP response data, StartIndex and Count specify the starting position and the number of bytes to be read from this buffer.

public OCSPResponse( location);

Downloads an OCSP response from a remote location.

public OCSPResponse( stream);

Initializes the response with the data from a stream.

public OCSPResponse();

Creates an empty OCSP response object.

ProxySettings Type

A container for proxy server settings.

Remarks

This type exposes a collection of properties for tuning up the proxy server configuration.

Fields

Constructors

public ProxySettings();

Creates a new ProxySettings object.

SocketSettings Type

A container for the socket settings.

Remarks

This type is a container for socket-layer parameters.

Fields

Constructors

public SocketSettings();

Creates a new SocketSettings object.

TLSSettings Type

A container for TLS connection settings.

Remarks

The TLS (Transport Layer Security) protocol provides security for information exchanged over insecure connections such as TCP/IP.

Fields

Constructors

public TLSSettings();

Creates a new TLSSettings object.

Config Settings (Imapclient Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

IMAPClient Config Settings

Base Config Settings

Trappable Errors (Imapclient Class)

IMAPClient Errors

	1048577   Invalid parameter value (SB_ERROR_INVALID_PARAMETER)
	1048578   Class is configured incorrectly (SB_ERROR_INVALID_SETUP)
	1048579   Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE)
	1048580   Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE)
	1048581   Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY)
	1048581   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER)