SecureBlackbox 2020 macOS Edition

Questions / Feedback?

IMAPClient Module

Properties   Methods   Events   Configuration Settings   Errors  

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




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 module with short descriptions. Click on the links for further details.

BlockedCertificatesThe certificates that must be rejected as trust anchors.
ClientChainThe TLS client certificate chain.
ConnectionInfoReturns the details of the underlying network connection.
CurrentMailboxReturns the selected (active) mailbox status.
KnownCertificatesAdditional certificates for chain validation.
KnownCRLsAdditional CRLs for chain validation.
KnownOCSPsAdditional OCSP responses for chain validation.
MailboxesPopulates a list of mailboxes available on the server.
MessageContains a pinned e-mail message.
MessagesPopulates a list of messages returned by the last list call.
PasswordThe authentication password.
ProxyThe proxy server settings.
ServerChainThe TLS server's certificate chain.
ServerInfoEncapsulates information about the server.
SocketSettingsManages network connection settings.
TLSSettingsManages TLS layer settings.
TrustedCertificatesA list of trusted certificates for chain validation.
UsernameThe authentication username.

Method List

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

CloseMailboxCloses the current mailbox.
ConfigSets or retrieves a configuration setting.
ConnectEstablishes a connection to the IMAP server.
CopyMessageCopies a message to another mailbox.
CreateMailboxCreates a new mailbox.
DeleteMailboxDeletes an existing mailbox.
DisconnectCloses connection to the IMAP server.
ExamineMailboxSelects the mailbox in read-only mode.
GetMailboxStatusRequests a mailbox status.
ListAllMessagesQueries a list of messages available in CurrentMailbox on the server.
ListDeletedMessagesQueries a list of deleted messages in the current mailbox on the server.
ListMailboxesQueries a list of mailboxes available on the server.
ListNewMessagesQueries a list of new messages available in the current mailbox on the mail server.
ListRecentMessagesQueries a list of recent messages available in the current mailbox on the server.
ListUnseenMessagesQueries a list of unseen messages available in the current mailbox on the server.
MarkMessageDeletedSets a Deleted flag to the message.
MarkMessageSeenSets a Seen flag to the message.
PingSends a NOOP command to the IMAP server.
PostBytesUploads an e-mail message stored in a byte array.
PostFileUploads a message stored in a file to the current mailbox on the IMAP server.
PostMessageUploads a pre-built message to the current mailbox on the IMAP server.
PurgeMessagesPermanently removes all deleted messages from the current mailbox.
ReceiveBytesDownloads a message to a byte array.
ReceiveFileDownloads a message to a file.
ReceiveMessageDownloads a message.
RefreshMailboxRefreshes the state info of the current mailbox.
RenameMailboxRenames an existing mailbox.
SelectMailboxSelects the specified mailbox.
UpdateMessageAlters 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 module with short descriptions. Click on the links for further details.

BeforeAuthFires before the authentication starts.
CertificateValidateFires when the server's TLS certificate has to be validated.
CommandReports a command sent to the server.
CommandDataReturns the data that accompanies the command.
CommandReplyReports the receipt of a reply to a command.
CommandReplyDataReturns the data that accompanies a reply to a command.
ErrorProvides information about errors during SMTP operations.
MailboxStatusReports the mailbox status returned from the server.
NotificationThis event notifies the application about an underlying control flow event.
ProgressReports the progress of the data transfer operation.

Configuration Settings

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

AuthenticationsSpecifies enabled authentication methods and their priorities.
IdleAutoSpecifies whether idle mode should be requested automatically.
IdleTimeoutSpecifies idle timeout in seconds.
IgnoreSystemTrustWhether trusted Windows Certificate Stores should be treated as trusted.
ListCriteriaSpecifies an advanced criteria for listing messages on the server.
MaxLineLengthSpecifies maximum expected line length.
MessageHeaderZZZ[i]A value of ZZZ header field for message i.
OtherHeadersSpecifies header fields to request when lists messages on the server.
TempPathPath for storing temporary files.
TolerateMinorChainIssuesWhether to tolerate minor chain issues.
UseMicrosoftCTLEnables or disables automatic use of Microsoft online certificate trust list.
UseSystemCertificatesEnables or disables the use of the system certificates.
CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the component (supported for HTTPClient, RESTClient and SOAPClient only).
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
UseOwnDNSResolverSpecifies whether the client components should use own DNS resolver.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox 2020 macOS Edition - Version 20.0 [Build 8165]