IMAPClient Class
Properties Methods Events Configuration 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.
BlockedCertificates | The certificates that must be rejected as trust anchors. |
ClientChain | The TLS client certificate chain. |
ConnectionInfo | Returns the details of the underlying network connection. |
CurrentMailbox | Returns the selected (active) mailbox status. |
KnownCertificates | Additional certificates for chain validation. |
KnownCRLs | Additional CRLs for chain validation. |
KnownOCSPs | Additional OCSP responses for chain validation. |
Mailboxes | Populates a list of mailboxes available on the server. |
Message | Contains a pinned e-mail message. |
Messages | Populates a list of messages returned by the last list call. |
Password | The authentication password. |
Proxy | The proxy server settings. |
ServerChain | The TLS server's certificate chain. |
ServerInfo | Encapsulates information about the server. |
SocketSettings | Manages network connection settings. |
TLSSettings | Manages TLS layer settings. |
TrustedCertificates | A list of trusted certificates for chain validation. |
Username | The authentication username. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
CloseMailbox | Closes the current mailbox. |
Config | Sets or retrieves a configuration setting. |
Connect | Establishes a connection to the IMAP server. |
CopyMessage | Copies a message to another mailbox. |
CreateMailbox | Creates a new mailbox. |
DeleteMailbox | Deletes an existing mailbox. |
Disconnect | Closes connection to the IMAP server. |
ExamineMailbox | Selects the mailbox in read-only mode. |
GetMailboxStatus | Requests a mailbox status. |
ListAllMessages | Queries a list of messages available in CurrentMailbox on the server. |
ListDeletedMessages | Queries a list of deleted messages in the current mailbox on the server. |
ListMailboxes | Queries a list of mailboxes available on the server. |
ListNewMessages | Queries a list of new messages available in the current mailbox on the mail server. |
ListRecentMessages | Queries a list of recent messages available in the current mailbox on the server. |
ListUnseenMessages | Queries a list of unseen messages available in the current mailbox on the server. |
MarkMessageDeleted | Sets a Deleted flag to the message. |
MarkMessageSeen | Sets a Seen flag to the message. |
Ping | Sends a NOOP command to the IMAP server. |
PostBytes | Uploads an e-mail message stored in a byte array. |
PostFile | Uploads a message stored in a file to the current mailbox on the IMAP server. |
PostMessage | Uploads a pre-built message to the current mailbox on the IMAP server. |
PostStream | Uploads a message stored in a stream to the current mailbox on the IMAP server. |
PurgeMessages | Permanently removes all deleted messages from the current mailbox. |
ReceiveBytes | Downloads a message to a byte array. |
ReceiveFile | Downloads a message to a file. |
ReceiveMessage | Downloads a message. |
ReceiveStream | Downloads a message to a stream. |
RefreshMailbox | Refreshes the state info of the current mailbox. |
RenameMailbox | Renames an existing mailbox. |
SelectMailbox | Selects the specified mailbox. |
UpdateMessage | Alters flags assotiated with a message in the current mailbox on the IMAP server. |
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.
BeforeAuth | Fires before the authentication starts. |
CertificateValidate | Fires when the server's TLS certificate has to be validated. |
Command | Reports a command sent to the server. |
CommandData | Returns the data that accompanies the command. |
CommandReply | Reports the receipt of a reply to a command. |
CommandReplyData | Returns the data that accompanies a reply to a command. |
Error | Provides information about errors during SMTP operations. |
MailboxStatus | Reports the mailbox status returned from the server. |
Notification | This event notifies the application about an underlying control flow event. |
Progress | Reports the progress of the data transfer operation. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
Authentications | Specifies enabled authentication methods and their priorities. |
IdleAuto | Specifies whether idle mode should be requested automatically. |
IdleTimeout | Specifies idle timeout in seconds. |
IgnoreSystemTrust | Whether trusted Windows Certificate Stores should be treated as trusted. |
ListCriteria | Specifies an advanced criteria for listing messages on the server. |
MaxLineLength | Specifies maximum expected line length. |
MessageHeaderZZZ[i] | A value of ZZZ header field for message i. |
OtherHeaders | Specifies header fields to request when lists messages on the server. |
TempPath | Path for storing temporary files. |
TolerateMinorChainIssues | Whether to tolerate minor chain issues. |
UseMicrosoftCTL | Enables or disables automatic use of Microsoft online certificate trust list. |
UseSystemCertificates | Enables or disables the use of the system certificates. |
CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
Cookies | Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only). |
DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
LogDestination | Specifies the debug log destination. |
LogDetails | Specifies the debug log details to dump. |
LogFile | Specifies the debug log filename. |
LogFilters | Specifies the debug log filters. |
LogFlushMode | Specifies the log flush mode. |
LogLevel | Specifies the debug log level. |
LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
LogRotationMode | Specifies the log rotation mode. |
MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
UseOwnDNSResolver | Specifies whether the client classes should use own DNS resolver. |
UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
UseSystemRandom | Enables or disables the use of the OS PRNG. |