IMAPClient Module
Properties Methods Events Configuration Settings Errors
The IMAPClient module 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 module 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. |
| FIPSMode | Reserved. |
| 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 module 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. |
| DoAction | Performs an additional action. |
| 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. |
| 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. |
| 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 module 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. |
| TLSEstablished | TBD. |
| TLSHandshake | TBD. |
| TLSPSK | TBD. |
| TLSShutdown | TBD. |
Configuration Settings
The following is a list of configuration settings for the module 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 module (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. |
| Tag | Allows to store any custom data. |
| 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. |
BlockedCertificates Property (IMAPClient Module)
The certificates that must be rejected as trust anchors.
Syntax
public var blockedCertificates: Array<Certificate> {
get {...} }
@property (nonatomic,readwrite,assign,getter=blockedCertCount,setter=setBlockedCertCount:) int blockedCertCount; - (int)blockedCertCount; - (void)setBlockedCertCount :(int)newBlockedCertCount; - (NSData*)blockedCertBytes:(int)blockedCertIndex; - (long long)blockedCertHandle:(int)blockedCertIndex; - (void)setBlockedCertHandle:(int)blockedCertIndex :(long long)newBlockedCertHandle;
Default Value
""
Remarks
Use this property to provide the username for authenticating to the IMAP server.
ClientChain Property (IMAPClient Module)
The TLS client certificate chain.
Syntax
public var clientChain: Array<Certificate> {
get {...} }
@property (nonatomic,readwrite,assign,getter=clientCertCount,setter=setClientCertCount:) int clientCertCount; - (int)clientCertCount; - (void)setClientCertCount :(int)newClientCertCount; - (NSData*)clientCertBytes:(int)clientCertIndex; - (long long)clientCertHandle:(int)clientCertIndex; - (void)setClientCertHandle:(int)clientCertIndex :(long long)newClientCertHandle;
Default Value
""
Remarks
Use this property to provide the username for authenticating to the IMAP server.
ConnectionInfo Property (IMAPClient Module)
Returns the details of the underlying network connection.
Syntax
public var connectionInfo: ConnectionInfo {
get {...} }
@property (nonatomic,readonly,assign,getter=connInfoAEADCipher) BOOL connInfoAEADCipher; - (BOOL)connInfoAEADCipher; @property (nonatomic,readonly,assign,getter=connInfoChainValidationDetails) int connInfoChainValidationDetails; - (int)connInfoChainValidationDetails; @property (nonatomic,readonly,assign,getter=connInfoChainValidationResult) int connInfoChainValidationResult; - (int)connInfoChainValidationResult; @property (nonatomic,readonly,assign,getter=connInfoCiphersuite) NSString* connInfoCiphersuite; - (NSString*)connInfoCiphersuite; @property (nonatomic,readonly,assign,getter=connInfoClientAuthenticated) BOOL connInfoClientAuthenticated; - (BOOL)connInfoClientAuthenticated; @property (nonatomic,readonly,assign,getter=connInfoClientAuthRequested) BOOL connInfoClientAuthRequested; - (BOOL)connInfoClientAuthRequested; @property (nonatomic,readonly,assign,getter=connInfoConnectionEstablished) BOOL connInfoConnectionEstablished; - (BOOL)connInfoConnectionEstablished; @property (nonatomic,readonly,assign,getter=connInfoConnectionID) NSData* connInfoConnectionID; - (NSData*)connInfoConnectionID; @property (nonatomic,readonly,assign,getter=connInfoDigestAlgorithm) NSString* connInfoDigestAlgorithm; - (NSString*)connInfoDigestAlgorithm; @property (nonatomic,readonly,assign,getter=connInfoEncryptionAlgorithm) NSString* connInfoEncryptionAlgorithm; - (NSString*)connInfoEncryptionAlgorithm; @property (nonatomic,readonly,assign,getter=connInfoExportable) BOOL connInfoExportable; - (BOOL)connInfoExportable; @property (nonatomic,readonly,assign,getter=connInfoKeyExchangeAlgorithm) NSString* connInfoKeyExchangeAlgorithm; - (NSString*)connInfoKeyExchangeAlgorithm; @property (nonatomic,readonly,assign,getter=connInfoKeyExchangeKeyBits) int connInfoKeyExchangeKeyBits; - (int)connInfoKeyExchangeKeyBits; @property (nonatomic,readonly,assign,getter=connInfoNamedECCurve) NSString* connInfoNamedECCurve; - (NSString*)connInfoNamedECCurve; @property (nonatomic,readonly,assign,getter=connInfoPFSCipher) BOOL connInfoPFSCipher; - (BOOL)connInfoPFSCipher; @property (nonatomic,readonly,assign,getter=connInfoPreSharedIdentityHint) NSString* connInfoPreSharedIdentityHint; - (NSString*)connInfoPreSharedIdentityHint; @property (nonatomic,readonly,assign,getter=connInfoPublicKeyBits) int connInfoPublicKeyBits; - (int)connInfoPublicKeyBits; @property (nonatomic,readonly,assign,getter=connInfoResumedSession) BOOL connInfoResumedSession; - (BOOL)connInfoResumedSession; @property (nonatomic,readonly,assign,getter=connInfoSecureConnection) BOOL connInfoSecureConnection; - (BOOL)connInfoSecureConnection; @property (nonatomic,readonly,assign,getter=connInfoServerAuthenticated) BOOL connInfoServerAuthenticated; - (BOOL)connInfoServerAuthenticated; @property (nonatomic,readonly,assign,getter=connInfoSignatureAlgorithm) NSString* connInfoSignatureAlgorithm; - (NSString*)connInfoSignatureAlgorithm; @property (nonatomic,readonly,assign,getter=connInfoSymmetricBlockSize) int connInfoSymmetricBlockSize; - (int)connInfoSymmetricBlockSize; @property (nonatomic,readonly,assign,getter=connInfoSymmetricKeyBits) int connInfoSymmetricKeyBits; - (int)connInfoSymmetricKeyBits; @property (nonatomic,readonly,assign,getter=connInfoTotalBytesReceived) long long connInfoTotalBytesReceived; - (long long)connInfoTotalBytesReceived; @property (nonatomic,readonly,assign,getter=connInfoTotalBytesSent) long long connInfoTotalBytesSent; - (long long)connInfoTotalBytesSent; @property (nonatomic,readonly,assign,getter=connInfoValidationLog) NSString* connInfoValidationLog; - (NSString*)connInfoValidationLog; @property (nonatomic,readonly,assign,getter=connInfoVersion) NSString* connInfoVersion; - (NSString*)connInfoVersion;
Default Value
""
Remarks
Use this property to provide the username for authenticating to the IMAP server.
CurrentMailbox Property (IMAPClient Module)
Returns the selected (active) mailbox status.
Syntax
public var currentMailbox: IMAPMailboxStatus {
get {...} }
@property (nonatomic,readonly,assign,getter=currMailboxMessageFlags) int currMailboxMessageFlags; - (int)currMailboxMessageFlags; @property (nonatomic,readonly,assign,getter=currMailboxName) NSString* currMailboxName; - (NSString*)currMailboxName; @property (nonatomic,readonly,assign,getter=currMailboxNextUID) int currMailboxNextUID; - (int)currMailboxNextUID; @property (nonatomic,readonly,assign,getter=currMailboxPermanentFlags) int currMailboxPermanentFlags; - (int)currMailboxPermanentFlags; @property (nonatomic,readonly,assign,getter=currMailboxReadOnly) BOOL currMailboxReadOnly; - (BOOL)currMailboxReadOnly; @property (nonatomic,readonly,assign,getter=currMailboxRecentMessages) int currMailboxRecentMessages; - (int)currMailboxRecentMessages; @property (nonatomic,readonly,assign,getter=currMailboxTotalMessages) int currMailboxTotalMessages; - (int)currMailboxTotalMessages; @property (nonatomic,readonly,assign,getter=currMailboxUIDValidity) int currMailboxUIDValidity; - (int)currMailboxUIDValidity; @property (nonatomic,readonly,assign,getter=currMailboxUnseenMessages) int currMailboxUnseenMessages; - (int)currMailboxUnseenMessages;
Default Value
""
Remarks
Use this property to provide the username for authenticating to the IMAP server.
FIPSMode Property (IMAPClient Module)
Reserved.
Syntax
public var fipsMode: Bool {
get {...}
set {...} }
@property (nonatomic,readwrite,assign,getter=FIPSMode,setter=setFIPSMode:) BOOL FIPSMode; - (BOOL)FIPSMode; - (void)setFIPSMode :(BOOL)newFIPSMode;
Default Value
False
Remarks
This property is reserved for future use.
KnownCertificates Property (IMAPClient Module)
Additional certificates for chain validation.
Syntax
public var knownCertificates: Array<Certificate> {
get {...} }
@property (nonatomic,readwrite,assign,getter=knownCertCount,setter=setKnownCertCount:) int knownCertCount; - (int)knownCertCount; - (void)setKnownCertCount :(int)newKnownCertCount; - (NSData*)knownCertBytes:(int)knownCertIndex; - (long long)knownCertHandle:(int)knownCertIndex; - (void)setKnownCertHandle:(int)knownCertIndex :(long long)newKnownCertHandle;
Default Value
""
Remarks
Use this property to provide the username for authenticating to the IMAP server.
KnownCRLs Property (IMAPClient Module)
Additional CRLs for chain validation.
Syntax
public var knownCRLs: Array<CRL> {
get {...} }
@property (nonatomic,readwrite,assign,getter=knownCRLCount,setter=setKnownCRLCount:) int knownCRLCount; - (int)knownCRLCount; - (void)setKnownCRLCount :(int)newKnownCRLCount; - (NSData*)knownCRLBytes:(int)knownCRLIndex; - (long long)knownCRLHandle:(int)knownCRLIndex; - (void)setKnownCRLHandle:(int)knownCRLIndex :(long long)newKnownCRLHandle;
Default Value
""
Remarks
Use this property to provide the username for authenticating to the IMAP server.
KnownOCSPs Property (IMAPClient Module)
Additional OCSP responses for chain validation.
Syntax
public var knownOCSPs: Array<OCSPResponse> {
get {...} }
@property (nonatomic,readwrite,assign,getter=knownOCSPCount,setter=setKnownOCSPCount:) int knownOCSPCount; - (int)knownOCSPCount; - (void)setKnownOCSPCount :(int)newKnownOCSPCount; - (NSData*)knownOCSPBytes:(int)knownOCSPIndex; - (long long)knownOCSPHandle:(int)knownOCSPIndex; - (void)setKnownOCSPHandle:(int)knownOCSPIndex :(long long)newKnownOCSPHandle;
Default Value
""
Remarks
Use this property to provide the username for authenticating to the IMAP server.
Mailboxes Property (IMAPClient Module)
Populates a list of mailboxes available on the server.
Syntax
public var mailboxes: Array<IMAPMailboxInfo> {
get {...} }
@property (nonatomic,readonly,assign,getter=mailboxInfoCount) int mailboxInfoCount; - (int)mailboxInfoCount; - (NSString*)mailboxInfoDelimiter:(int)mailboxInfoIndex; - (BOOL)mailboxInfoHasChildren:(int)mailboxInfoIndex; - (BOOL)mailboxInfoHasNoChildren:(int)mailboxInfoIndex; - (BOOL)mailboxInfoMarked:(int)mailboxInfoIndex; - (NSString*)mailboxInfoName:(int)mailboxInfoIndex; - (BOOL)mailboxInfoNoInferiors:(int)mailboxInfoIndex; - (BOOL)mailboxInfoNoSelect:(int)mailboxInfoIndex; - (BOOL)mailboxInfoUnmarked:(int)mailboxInfoIndex;
Default Value
""
Remarks
Use this property to provide the username for authenticating to the IMAP server.
Message Property (IMAPClient Module)
Contains a pinned e-mail message.
Syntax
public var message: MailMessage {
get {...}
set {...} }
@property (nonatomic,readonly,assign,getter=msgAttachmentCount) int msgAttachmentCount; - (int)msgAttachmentCount; @property (nonatomic,readwrite,assign,getter=msgBcc,setter=setMsgBcc:) NSString* msgBcc; - (NSString*)msgBcc; - (void)setMsgBcc :(NSString*)newMsgBcc; @property (nonatomic,readwrite,assign,getter=msgCc,setter=setMsgCc:) NSString* msgCc; - (NSString*)msgCc; - (void)setMsgCc :(NSString*)newMsgCc; @property (nonatomic,readwrite,assign,getter=msgComments,setter=setMsgComments:) NSString* msgComments; - (NSString*)msgComments; - (void)setMsgComments :(NSString*)newMsgComments; @property (nonatomic,readwrite,assign,getter=msgDate,setter=setMsgDate:) NSString* msgDate; - (NSString*)msgDate; - (void)setMsgDate :(NSString*)newMsgDate; @property (nonatomic,readwrite,assign,getter=msgDeliveryReceipt,setter=setMsgDeliveryReceipt:) BOOL msgDeliveryReceipt; - (BOOL)msgDeliveryReceipt; - (void)setMsgDeliveryReceipt :(BOOL)newMsgDeliveryReceipt; @property (nonatomic,readwrite,assign,getter=msgFrom,setter=setMsgFrom:) NSString* msgFrom; - (NSString*)msgFrom; - (void)setMsgFrom :(NSString*)newMsgFrom; @property (nonatomic,readwrite,assign,getter=msgHandle,setter=setMsgHandle:) long long msgHandle; - (long long)msgHandle; - (void)setMsgHandle :(long long)newMsgHandle; @property (nonatomic,readwrite,assign,getter=msgHtmlText,setter=setMsgHtmlText:) NSString* msgHtmlText; - (NSString*)msgHtmlText; - (void)setMsgHtmlText :(NSString*)newMsgHtmlText; @property (nonatomic,readwrite,assign,getter=msgID,setter=setMsgID:) NSString* msgID; - (NSString*)msgID; - (void)setMsgID :(NSString*)newMsgID; @property (nonatomic,readwrite,assign,getter=msgInReplyTo,setter=setMsgInReplyTo:) NSString* msgInReplyTo; - (NSString*)msgInReplyTo; - (void)setMsgInReplyTo :(NSString*)newMsgInReplyTo; @property (nonatomic,readwrite,assign,getter=msgKeywords,setter=setMsgKeywords:) NSString* msgKeywords; - (NSString*)msgKeywords; - (void)setMsgKeywords :(NSString*)newMsgKeywords; @property (nonatomic,readonly,assign,getter=msgMailer) NSString* msgMailer; - (NSString*)msgMailer; @property (nonatomic,readwrite,assign,getter=msgPlainText,setter=setMsgPlainText:) NSString* msgPlainText; - (NSString*)msgPlainText; - (void)setMsgPlainText :(NSString*)newMsgPlainText; @property (nonatomic,readwrite,assign,getter=msgPriority,setter=setMsgPriority:) int msgPriority; - (int)msgPriority; - (void)setMsgPriority :(int)newMsgPriority; @property (nonatomic,readwrite,assign,getter=msgReadReceipt,setter=setMsgReadReceipt:) BOOL msgReadReceipt; - (BOOL)msgReadReceipt; - (void)setMsgReadReceipt :(BOOL)newMsgReadReceipt; @property (nonatomic,readwrite,assign,getter=msgReferences,setter=setMsgReferences:) NSString* msgReferences; - (NSString*)msgReferences; - (void)setMsgReferences :(NSString*)newMsgReferences; @property (nonatomic,readwrite,assign,getter=msgReplyTo,setter=setMsgReplyTo:) NSString* msgReplyTo; - (NSString*)msgReplyTo; - (void)setMsgReplyTo :(NSString*)newMsgReplyTo; @property (nonatomic,readwrite,assign,getter=msgReturnPath,setter=setMsgReturnPath:) NSString* msgReturnPath; - (NSString*)msgReturnPath; - (void)setMsgReturnPath :(NSString*)newMsgReturnPath; @property (nonatomic,readwrite,assign,getter=msgSender,setter=setMsgSender:) NSString* msgSender; - (NSString*)msgSender; - (void)setMsgSender :(NSString*)newMsgSender; @property (nonatomic,readwrite,assign,getter=msgSendTo,setter=setMsgSendTo:) NSString* msgSendTo; - (NSString*)msgSendTo; - (void)setMsgSendTo :(NSString*)newMsgSendTo; @property (nonatomic,readwrite,assign,getter=msgSubject,setter=setMsgSubject:) NSString* msgSubject; - (NSString*)msgSubject; - (void)setMsgSubject :(NSString*)newMsgSubject;
Default Value
""
Remarks
Use this property to provide the username for authenticating to the IMAP server.
Messages Property (IMAPClient Module)
Populates a list of messages returned by the last list call.
Syntax
public var messages: Array<IMAPMessageInfo> {
get {...} }
@property (nonatomic,readonly,assign,getter=msgInfoCount) int msgInfoCount; - (int)msgInfoCount; - (NSString*)msgInfoDate:(int)msgInfoIndex; - (int)msgInfoFlags:(int)msgInfoIndex; - (NSString*)msgInfoFrom:(int)msgInfoIndex; - (NSString*)msgInfoInternalDate:(int)msgInfoIndex; - (int)msgInfoPriority:(int)msgInfoIndex; - (NSString*)msgInfoSentTo:(int)msgInfoIndex; - (long long)msgInfoSize:(int)msgInfoIndex; - (NSString*)msgInfoSubject:(int)msgInfoIndex; - (int)msgInfoUID:(int)msgInfoIndex;
Default Value
""
Remarks
Use this property to provide the username for authenticating to the IMAP server.
Password Property (IMAPClient Module)
The authentication password.
Syntax
public var password: String {
get {...}
set {...} }
@property (nonatomic,readwrite,assign,getter=password,setter=setPassword:) NSString* password; - (NSString*)password; - (void)setPassword :(NSString*)newPassword;
Default Value
""
Remarks
Use this property to provide the password for authenticating to the IMAP server.
Proxy Property (IMAPClient Module)
The proxy server settings.
Syntax
public var proxy: ProxySettings {
get {...} }
@property (nonatomic,readwrite,assign,getter=proxyAddress,setter=setProxyAddress:) NSString* proxyAddress; - (NSString*)proxyAddress; - (void)setProxyAddress :(NSString*)newProxyAddress; @property (nonatomic,readwrite,assign,getter=proxyAuthentication,setter=setProxyAuthentication:) int proxyAuthentication; - (int)proxyAuthentication; - (void)setProxyAuthentication :(int)newProxyAuthentication; @property (nonatomic,readwrite,assign,getter=proxyPassword,setter=setProxyPassword:) NSString* proxyPassword; - (NSString*)proxyPassword; - (void)setProxyPassword :(NSString*)newProxyPassword; @property (nonatomic,readwrite,assign,getter=proxyPort,setter=setProxyPort:) int proxyPort; - (int)proxyPort; - (void)setProxyPort :(int)newProxyPort; @property (nonatomic,readwrite,assign,getter=proxyProxyType,setter=setProxyProxyType:) int proxyProxyType; - (int)proxyProxyType; - (void)setProxyProxyType :(int)newProxyProxyType; @property (nonatomic,readwrite,assign,getter=proxyRequestHeaders,setter=setProxyRequestHeaders:) NSString* proxyRequestHeaders; - (NSString*)proxyRequestHeaders; - (void)setProxyRequestHeaders :(NSString*)newProxyRequestHeaders; @property (nonatomic,readwrite,assign,getter=proxyResponseBody,setter=setProxyResponseBody:) NSString* proxyResponseBody; - (NSString*)proxyResponseBody; - (void)setProxyResponseBody :(NSString*)newProxyResponseBody; @property (nonatomic,readwrite,assign,getter=proxyResponseHeaders,setter=setProxyResponseHeaders:) NSString* proxyResponseHeaders; - (NSString*)proxyResponseHeaders; - (void)setProxyResponseHeaders :(NSString*)newProxyResponseHeaders; @property (nonatomic,readwrite,assign,getter=proxyUseIPv6,setter=setProxyUseIPv6:) BOOL proxyUseIPv6; - (BOOL)proxyUseIPv6; - (void)setProxyUseIPv6 :(BOOL)newProxyUseIPv6; @property (nonatomic,readwrite,assign,getter=proxyUseProxy,setter=setProxyUseProxy:) BOOL proxyUseProxy; - (BOOL)proxyUseProxy; - (void)setProxyUseProxy :(BOOL)newProxyUseProxy; @property (nonatomic,readwrite,assign,getter=proxyUsername,setter=setProxyUsername:) NSString* proxyUsername; - (NSString*)proxyUsername; - (void)setProxyUsername :(NSString*)newProxyUsername;
Default Value
""
Remarks
Use this property to provide the username for authenticating to the IMAP server.
ServerChain Property (IMAPClient Module)
The TLS server's certificate chain.
Syntax
public var serverChain: Array<Certificate> {
get {...} }
@property (nonatomic,readonly,assign,getter=serverCertCount) int serverCertCount; - (int)serverCertCount; - (NSData*)serverCertBytes:(int)serverCertIndex; - (NSData*)serverCertCAKeyID:(int)serverCertIndex; - (NSData*)serverCertFingerprint:(int)serverCertIndex; - (long long)serverCertHandle:(int)serverCertIndex; - (NSString*)serverCertIssuer:(int)serverCertIndex; - (NSString*)serverCertIssuerRDN:(int)serverCertIndex; - (NSString*)serverCertKeyAlgorithm:(int)serverCertIndex; - (int)serverCertKeyBits:(int)serverCertIndex; - (NSData*)serverCertKeyFingerprint:(int)serverCertIndex; - (int)serverCertKeyUsage:(int)serverCertIndex; - (NSData*)serverCertPublicKeyBytes:(int)serverCertIndex; - (BOOL)serverCertSelfSigned:(int)serverCertIndex; - (NSData*)serverCertSerialNumber:(int)serverCertIndex; - (NSString*)serverCertSigAlgorithm:(int)serverCertIndex; - (NSString*)serverCertSubject:(int)serverCertIndex; - (NSData*)serverCertSubjectKeyID:(int)serverCertIndex; - (NSString*)serverCertSubjectRDN:(int)serverCertIndex; - (NSString*)serverCertValidFrom:(int)serverCertIndex; - (NSString*)serverCertValidTo:(int)serverCertIndex;
Default Value
""
Remarks
Use this property to provide the username for authenticating to the IMAP server.
ServerInfo Property (IMAPClient Module)
Encapsulates information about the server.
Syntax
public var serverInfo: IMAPServerInfo {
get {...} }
@property (nonatomic,readonly,assign,getter=serverInfoCapabilities) NSString* serverInfoCapabilities; - (NSString*)serverInfoCapabilities; @property (nonatomic,readonly,assign,getter=serverInfoIdleSupported) BOOL serverInfoIdleSupported; - (BOOL)serverInfoIdleSupported; @property (nonatomic,readonly,assign,getter=serverInfoLoginDisabled) BOOL serverInfoLoginDisabled; - (BOOL)serverInfoLoginDisabled;
Default Value
""
Remarks
Use this property to provide the username for authenticating to the IMAP server.
SocketSettings Property (IMAPClient Module)
Manages network connection settings.
Syntax
public var socketSettings: SocketSettings {
get {...} }
@property (nonatomic,readwrite,assign,getter=socketDNSMode,setter=setSocketDNSMode:) int socketDNSMode; - (int)socketDNSMode; - (void)setSocketDNSMode :(int)newSocketDNSMode; @property (nonatomic,readwrite,assign,getter=socketDNSPort,setter=setSocketDNSPort:) int socketDNSPort; - (int)socketDNSPort; - (void)setSocketDNSPort :(int)newSocketDNSPort; @property (nonatomic,readwrite,assign,getter=socketDNSQueryTimeout,setter=setSocketDNSQueryTimeout:) int socketDNSQueryTimeout; - (int)socketDNSQueryTimeout; - (void)setSocketDNSQueryTimeout :(int)newSocketDNSQueryTimeout; @property (nonatomic,readwrite,assign,getter=socketDNSServers,setter=setSocketDNSServers:) NSString* socketDNSServers; - (NSString*)socketDNSServers; - (void)setSocketDNSServers :(NSString*)newSocketDNSServers; @property (nonatomic,readwrite,assign,getter=socketDNSTotalTimeout,setter=setSocketDNSTotalTimeout:) int socketDNSTotalTimeout; - (int)socketDNSTotalTimeout; - (void)setSocketDNSTotalTimeout :(int)newSocketDNSTotalTimeout; @property (nonatomic,readwrite,assign,getter=socketIncomingSpeedLimit,setter=setSocketIncomingSpeedLimit:) int socketIncomingSpeedLimit; - (int)socketIncomingSpeedLimit; - (void)setSocketIncomingSpeedLimit :(int)newSocketIncomingSpeedLimit; @property (nonatomic,readwrite,assign,getter=socketLocalAddress,setter=setSocketLocalAddress:) NSString* socketLocalAddress; - (NSString*)socketLocalAddress; - (void)setSocketLocalAddress :(NSString*)newSocketLocalAddress; @property (nonatomic,readwrite,assign,getter=socketLocalPort,setter=setSocketLocalPort:) int socketLocalPort; - (int)socketLocalPort; - (void)setSocketLocalPort :(int)newSocketLocalPort; @property (nonatomic,readwrite,assign,getter=socketOutgoingSpeedLimit,setter=setSocketOutgoingSpeedLimit:) int socketOutgoingSpeedLimit; - (int)socketOutgoingSpeedLimit; - (void)setSocketOutgoingSpeedLimit :(int)newSocketOutgoingSpeedLimit; @property (nonatomic,readwrite,assign,getter=socketTimeout,setter=setSocketTimeout:) int socketTimeout; - (int)socketTimeout; - (void)setSocketTimeout :(int)newSocketTimeout; @property (nonatomic,readwrite,assign,getter=socketUseIPv6,setter=setSocketUseIPv6:) BOOL socketUseIPv6; - (BOOL)socketUseIPv6; - (void)setSocketUseIPv6 :(BOOL)newSocketUseIPv6;
Default Value
""
Remarks
Use this property to provide the username for authenticating to the IMAP server.
TLSSettings Property (IMAPClient Module)
Manages TLS layer settings.
Syntax
public var tlsSettings: TLSSettings {
get {...} }
@property (nonatomic,readwrite,assign,getter=TLSAutoValidateCertificates,setter=setTLSAutoValidateCertificates:) BOOL TLSAutoValidateCertificates; - (BOOL)TLSAutoValidateCertificates; - (void)setTLSAutoValidateCertificates :(BOOL)newTLSAutoValidateCertificates; @property (nonatomic,readwrite,assign,getter=TLSBaseConfiguration,setter=setTLSBaseConfiguration:) int TLSBaseConfiguration; - (int)TLSBaseConfiguration; - (void)setTLSBaseConfiguration :(int)newTLSBaseConfiguration; @property (nonatomic,readwrite,assign,getter=TLSCiphersuites,setter=setTLSCiphersuites:) NSString* TLSCiphersuites; - (NSString*)TLSCiphersuites; - (void)setTLSCiphersuites :(NSString*)newTLSCiphersuites; @property (nonatomic,readwrite,assign,getter=TLSECCurves,setter=setTLSECCurves:) NSString* TLSECCurves; - (NSString*)TLSECCurves; - (void)setTLSECCurves :(NSString*)newTLSECCurves; @property (nonatomic,readwrite,assign,getter=TLSExtensions,setter=setTLSExtensions:) NSString* TLSExtensions; - (NSString*)TLSExtensions; - (void)setTLSExtensions :(NSString*)newTLSExtensions; @property (nonatomic,readwrite,assign,getter=TLSForceResumeIfDestinationChanges,setter=setTLSForceResumeIfDestinationChanges:) BOOL TLSForceResumeIfDestinationChanges; - (BOOL)TLSForceResumeIfDestinationChanges; - (void)setTLSForceResumeIfDestinationChanges :(BOOL)newTLSForceResumeIfDestinationChanges; @property (nonatomic,readwrite,assign,getter=TLSPreSharedIdentity,setter=setTLSPreSharedIdentity:) NSString* TLSPreSharedIdentity; - (NSString*)TLSPreSharedIdentity; - (void)setTLSPreSharedIdentity :(NSString*)newTLSPreSharedIdentity; @property (nonatomic,readwrite,assign,getter=TLSPreSharedKey,setter=setTLSPreSharedKey:) NSString* TLSPreSharedKey; - (NSString*)TLSPreSharedKey; - (void)setTLSPreSharedKey :(NSString*)newTLSPreSharedKey; @property (nonatomic,readwrite,assign,getter=TLSPreSharedKeyCiphersuite,setter=setTLSPreSharedKeyCiphersuite:) NSString* TLSPreSharedKeyCiphersuite; - (NSString*)TLSPreSharedKeyCiphersuite; - (void)setTLSPreSharedKeyCiphersuite :(NSString*)newTLSPreSharedKeyCiphersuite; @property (nonatomic,readwrite,assign,getter=TLSRenegotiationAttackPreventionMode,setter=setTLSRenegotiationAttackPreventionMode:) int TLSRenegotiationAttackPreventionMode; - (int)TLSRenegotiationAttackPreventionMode; - (void)setTLSRenegotiationAttackPreventionMode :(int)newTLSRenegotiationAttackPreventionMode; @property (nonatomic,readwrite,assign,getter=TLSRevocationCheck,setter=setTLSRevocationCheck:) int TLSRevocationCheck; - (int)TLSRevocationCheck; - (void)setTLSRevocationCheck :(int)newTLSRevocationCheck; @property (nonatomic,readwrite,assign,getter=TLSSSLOptions,setter=setTLSSSLOptions:) int TLSSSLOptions; - (int)TLSSSLOptions; - (void)setTLSSSLOptions :(int)newTLSSSLOptions; @property (nonatomic,readwrite,assign,getter=TLSTLSMode,setter=setTLSTLSMode:) int TLSTLSMode; - (int)TLSTLSMode; - (void)setTLSTLSMode :(int)newTLSTLSMode; @property (nonatomic,readwrite,assign,getter=TLSUseExtendedMasterSecret,setter=setTLSUseExtendedMasterSecret:) BOOL TLSUseExtendedMasterSecret; - (BOOL)TLSUseExtendedMasterSecret; - (void)setTLSUseExtendedMasterSecret :(BOOL)newTLSUseExtendedMasterSecret; @property (nonatomic,readwrite,assign,getter=TLSUseSessionResumption,setter=setTLSUseSessionResumption:) BOOL TLSUseSessionResumption; - (BOOL)TLSUseSessionResumption; - (void)setTLSUseSessionResumption :(BOOL)newTLSUseSessionResumption; @property (nonatomic,readwrite,assign,getter=TLSVersions,setter=setTLSVersions:) int TLSVersions; - (int)TLSVersions; - (void)setTLSVersions :(int)newTLSVersions;
Default Value
""
Remarks
Use this property to provide the username for authenticating to the IMAP server.
TrustedCertificates Property (IMAPClient Module)
A list of trusted certificates for chain validation.
Syntax
public var trustedCertificates: Array<Certificate> {
get {...} }
@property (nonatomic,readwrite,assign,getter=trustedCertCount,setter=setTrustedCertCount:) int trustedCertCount; - (int)trustedCertCount; - (void)setTrustedCertCount :(int)newTrustedCertCount; - (NSData*)trustedCertBytes:(int)trustedCertIndex; - (long long)trustedCertHandle:(int)trustedCertIndex; - (void)setTrustedCertHandle:(int)trustedCertIndex :(long long)newTrustedCertHandle;
Default Value
""
Remarks
Use this property to provide the username for authenticating to the IMAP server.
Username Property (IMAPClient Module)
The authentication username.
Syntax
public var username: String {
get {...}
set {...} }
@property (nonatomic,readwrite,assign,getter=username,setter=setUsername:) NSString* username; - (NSString*)username; - (void)setUsername :(NSString*)newUsername;
Default Value
""
Remarks
Use this property to provide the username for authenticating to the IMAP server.
CloseMailbox Method (IMAPClient Module)
Closes the current mailbox.
Syntax
public func closeMailbox() throws -> Void
- (void)closeMailbox;
Remarks
Use this method to close the CurrentMailbox.
Config Method (IMAPClient Module)
Sets or retrieves a configuration setting.
Syntax
- (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 (IMAPClient Module)
Establishes a connection to the IMAP server.
Syntax
- (void)connect:(NSString*)address :(int)port;
Remarks
Use this method to establish a connection to the IMAP server at Address and Port.
CopyMessage Method (IMAPClient Module)
Copies a message to another mailbox.
Syntax
- (void)copyMessage:(int)UID :(NSString*)mailboxName;
Remarks
Copies a message specified by its UID to another mailbox.
CreateMailbox Method (IMAPClient Module)
Creates a new mailbox.
Syntax
Remarks
Call this method to create a new mailbox, providing the name via the Name parameter.
DeleteMailbox Method (IMAPClient Module)
Deletes an existing mailbox.
Syntax
Remarks
Call this method to delete a mailbox.
Disconnect Method (IMAPClient Module)
Closes connection to the IMAP server.
Syntax
public func disconnect() throws -> Void
- (void)disconnect;
Remarks
Call this method to gracefully terminate the connection.
DoAction Method (IMAPClient Module)
Performs an additional action.
Syntax
- (NSString*)doAction:(NSString*)actionID :(NSString*)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 of the action is provided in ActionID parameter. ActionParams contains a list of parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....
ExamineMailbox Method (IMAPClient Module)
Selects the mailbox in read-only mode.
Syntax
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 Module)
Requests a mailbox status.
Syntax
Remarks
Requests the status of the specified mailbox and returns it using MailboxStatus event.
ListAllMessages Method (IMAPClient Module)
Queries a list of messages available in CurrentMailbox on the server.
Syntax
public func listAllMessages() throws -> Void
- (void)listAllMessages;
Remarks
Call this method to request a list of messages available in the current mailbox.
ListDeletedMessages Method (IMAPClient Module)
Queries a list of deleted messages in the current mailbox on the server.
Syntax
public func listDeletedMessages() throws -> Void
- (void)listDeletedMessages;
Remarks
Call this method to enumerate deleted messages (i.e. those having Deleted flag set) in CurrentMailbox.
ListMailboxes Method (IMAPClient Module)
Queries a list of mailboxes available on the server.
Syntax
public func listMailboxes() throws -> Void
- (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 Module)
Queries a list of new messages available in the current mailbox on the mail server.
Syntax
public func listNewMessages() throws -> Void
- (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 Module)
Queries a list of recent messages available in the current mailbox on the server.
Syntax
public func listRecentMessages() throws -> Void
- (void)listRecentMessages;
Remarks
Retrieves a list of recent messages (i.e. those having Recent flag set) present in CurrentMailbox.
ListUnseenMessages Method (IMAPClient Module)
Queries a list of unseen messages available in the current mailbox on the server.
Syntax
public func listUnseenMessages() throws -> Void
- (void)listUnseenMessages;
Remarks
Requests a list of unseen messages (i.e. not having Seen flag set) present in CurrentMailbox.
MarkMessageDeleted Method (IMAPClient Module)
Sets a Deleted flag to the message.
Syntax
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 Module)
Sets a Seen flag to the message.
Syntax
Remarks
Use this method to mark a message as seen.
Ping Method (IMAPClient Module)
Sends a NOOP command to the IMAP server.
Syntax
public func ping() throws -> Void
- (void)ping;
Remarks
This method sends a NOOP command to the server, effectively pinging the server and keeping the connection alive.
PostBytes Method (IMAPClient Module)
Uploads an e-mail message stored in a byte array.
Syntax
- (void)postBytes:(NSData*)bytes :(int)flags :(NSString*)internalDate;
Remarks
Use this method to send a message stored in a byte array specified by Bytes.
PostFile Method (IMAPClient Module)
Uploads a message stored in a file to the current mailbox on the IMAP server.
Syntax
- (void)postFile:(NSString*)filename :(int)flags :(NSString*)internalDate;
Remarks
Use this method to upload an e-mail message stored in a file to CurrentMailbox.
PostMessage Method (IMAPClient Module)
Uploads a pre-built message to the current mailbox on the IMAP server.
Syntax
- (void)postMessage:(int)flags :(NSString*)internalDate;
Remarks
Use this message to upload Message to CurrentMailbox.
PurgeMessages Method (IMAPClient Module)
Permanently removes all deleted messages from the current mailbox.
Syntax
public func purgeMessages() throws -> Void
- (void)purgeMessages;
Remarks
Use this method to permanently remove all messages in CurrentMailbox marked with the Deleted flag.
ReceiveBytes Method (IMAPClient Module)
Downloads a message to a byte array.
Syntax
Remarks
Use this method to download a server-side message to a byte array.
ReceiveFile Method (IMAPClient Module)
Downloads a message to a file.
Syntax
- (void)receiveFile:(int)UID :(NSString*)filename;
Remarks
Use this method to download a server-side message to a local file.
ReceiveMessage Method (IMAPClient Module)
Downloads a message.
Syntax
Remarks
Use this method to download a server-side message to the Message object.
RefreshMailbox Method (IMAPClient Module)
Refreshes the state info of the current mailbox.
Syntax
public func refreshMailbox() throws -> Void
- (void)refreshMailbox;
Remarks
Use this method to refresh the CurrentMailbox info.
RenameMailbox Method (IMAPClient Module)
Renames an existing mailbox.
Syntax
- (void)renameMailbox:(NSString*)name :(NSString*)newName;
Remarks
Use this method to rename an existing mailbox from Name to NewName.
SelectMailbox Method (IMAPClient Module)
Selects the specified mailbox.
Syntax
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 Module)
Alters flags assotiated with a message in the current mailbox on the IMAP server.
Syntax
- (void)updateMessage:(int)UID :(int)setFlags :(int)clearFlags;
Remarks
Use this method to alter flags associated with a UID message in CurrentMailbox.
BeforeAuth Event (IMAPClient Module)
Fires before the authentication starts.
Syntax
func onBeforeAuth()
- (void)onBeforeAuth;
Remarks
The class fires this event when it has established the TCP connection and is ready to proceed to the user authentication step.
CertificateValidate Event (IMAPClient Module)
Fires when the server's TLS certificate has to be validated.
Syntax
func onCertificateValidate(address: String, accept: inout Bool)
- (void)onCertificateValidate:(NSString*)address :(int*)accept;
Remarks
The class fires this event upon receiving the server's certificate during TLS handshake. The subscriber to this event has to validate the certificate and return its status back to the class using the Accept parameter.
The Address parameter indicates the address of the server the connection is being established to.
This event is fired independently of the AutoValidateCertificates setting. If this setting is false, the event handler (and your code) is responsible for validating the certificate chain and returning the result back to the component through the Accept parameter. Note that setting AutoValidateCertificates to false and not performing any validation inside the handler of this event creates a serious security vulnerability, which can lead to grave consequences.
The exact validation method to use depends on your circumstances, and may range from comparing the certificate to its legit and trusted copy (sometimes called certificate pinning), to fully-fledged chain validation. CertificateValidator component is one of the options to build your chain validation on.
If AutoValidateCertificates is true, the chain has already been validated internally by the component by the time this event fires, and the value of Accept reflects the outcome of that check. You can perform your own, additional validation even when using AutoValidateCertificates mode, and adjust Accept if needed.
Command Event (IMAPClient Module)
Reports a command sent to the server.
Syntax
func onCommand(cmd: String)
- (void)onCommand:(NSString*)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 Module)
Returns the data that accompanies the command.
Syntax
- (void)onCommandData:(NSString*)cmd :(NSString*)data;
Remarks
Subscribe to this event to access data accompanying the outgoing commands.
CommandReply Event (IMAPClient Module)
Reports the receipt of a reply to a command.
Syntax
- (void)onCommandReply:(NSString*)cmd :(NSString*)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 Module)
Returns the data that accompanies a reply to a command.
Syntax
- (void)onCommandReplyData:(NSString*)cmd :(NSString*)data;
Remarks
Subscribe to this event to access data accompanying incoming command replies.
Error Event (IMAPClient Module)
Provides information about errors during SMTP operations.
Syntax
- (void)onError:(int)errorCode :(NSString*)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 Module)
Reports the mailbox status returned from the server.
Syntax
func onMailboxStatus(name: String, totalMessages: Int32, recentMessages: Int32, unseenMessages: Int32, nextUID: Int32, uidValidity: Int32)
- (void)onMailboxStatus:(NSString*)name :(int)totalMessages :(int)recentMessages :(int)unseenMessages :(int)nextUID :(int)UIDValidity;
Remarks
Subscribe to this event to be notified of mailbox status as returned by the IMAP server.
Notification Event (IMAPClient Module)
This event notifies the application about an underlying control flow event.
Syntax
- (void)onNotification:(NSString*)eventID :(NSString*)eventParam;
Remarks
The class fires this event to let the application know about some event, occurrence, or milestone in the component. 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 EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.
| EventID | EventParam | |
| MessageAdded | Number of messages in the current mailbox. | |
| MessageDeleted | UID of the deleted message if the message is in the current message list. | |
| MessageUpdated | UID of the updated message if the message is in the current message list. |
Progress Event (IMAPClient Module)
Reports the progress of the data transfer operation.
Syntax
func onProgress(total: Int64, current: Int64, cancel: inout Bool)
- (void)onProgress:(long long)total :(long long)current :(int*)cancel;
Remarks
The class fires this event repeatedly to report the progress of the data transfer operation.
TLSEstablished Event (IMAPClient Module)
TBD.
Syntax
func onTLSEstablished()
- (void)onTLSEstablished;
Remarks
TBD
TLSHandshake Event (IMAPClient Module)
TBD.
Syntax
func onTLSHandshake()
- (void)onTLSHandshake;
Remarks
TBD
TLSPSK Event (IMAPClient Module)
TBD.
Syntax
func onTLSPSK(hint: String)
- (void)onTLSPSK:(NSString*)hint;
Remarks
TBD
TLSShutdown Event (IMAPClient Module)
TBD.
Syntax
func onTLSShutdown()
- (void)onTLSShutdown;
Remarks
TBD
Certificate Type
Provides details of an individual X.509 certificate.
Remarks
This type provides access to X.509 certificate details.
Fields
|
bytes Data |
Returns raw certificate data in DER format. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ca Bool |
Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
caKeyID Data |
A unique identifier (fingerprint) of the CA certificate's private key. Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
crlDistributionPoints String |
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
curve String |
Specifies the elliptic curve of the EC public key.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
fingerprint Data |
Contains the fingerprint (a hash imprint) of this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
friendlyName String |
Contains an associated alias (friendly name) of the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
handle Int64 |
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
hashAlgorithm String |
Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
issuer String |
The common name of the certificate issuer (CA), typically a company name. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
issuerRDN String |
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
keyAlgorithm String |
Specifies the public key algorithm of this certificate.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
keyBits Int32 |
Returns the length of the public key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
keyFingerprint Data |
Returns a fingerprint of the public key contained in the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
keyUsage Int32 |
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. This value is a bit mask of the following values:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
keyValid Bool |
Returns True if the certificate's key is cryptographically valid, and False otherwise. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ocspLocations String |
Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ocspNoCheck Bool |
TBD. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
origin Int32 |
Returns the origin of this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
policyIDs String |
Contains identifiers (OIDs) of the applicable certificate policies. The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
privateKeyBytes Data |
Contains the certificate's private key. It is normal for this property to be empty if the private key is non-exportable. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
privateKeyExists Bool |
Indicates whether the certificate has an associated private key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
privateKeyExtractable Bool |
Indicates whether the private key is extractable |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
publicKeyBytes Data |
Contains the certificate's public key in DER format. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
qualifiedStatements QualifiedStatementsTypes |
TBD |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
selfSigned Bool |
Indicates whether the certificate is self-signed (root) or signed by an external CA. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
serialNumber Data |
Returns the certificate's serial number. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
sigAlgorithm String |
Indicates the algorithm that was used by the CA to sign this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
subject String |
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
subjectAlternativeName String |
TBD. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
subjectKeyID Data |
Contains a unique identifier (fingerprint) of the certificate's private key. Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
subjectRDN String |
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
validFrom String |
The time point at which the certificate becomes valid, in UTC. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
validTo String |
The time point at which the certificate expires, in UTC. |
Constructors
public init(stream: InputStream?)
Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data.
public init()
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
|
aeadCipher Bool |
Indicates whether the encryption algorithm used is an AEAD cipher. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
chainValidationDetails Int32 |
The details of a certificate chain validation outcome. They may often suggest what reasons that contributed to the overall validation result. Returns a bit mask of the following options:
|
||||||||||||||||||||||||||||||||||||||||||||||||
|
chainValidationResult ChainValidities |
The outcome of a certificate chain validation routine. Available options:
Use the ValidationLog property to access the detailed validation log. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
ciphersuite String |
The cipher suite employed by this connection. For TLS connections, this property returns the ciphersuite that was/is employed by the connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
clientAuthenticated Bool |
Specifies whether client authentication was performed during this connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
clientAuthRequested Bool |
Specifies whether client authentication was requested during this connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
connectionEstablished Bool |
Indicates whether the connection has been established fully. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
connectionID Data |
The unique identifier assigned to this connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
digestAlgorithm String |
The digest algorithm used in a TLS-enabled connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
encryptionAlgorithm String |
The symmetric encryption algorithm used in a TLS-enabled connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
exportable Bool |
Indicates whether a TLS connection uses a reduced-strength exportable cipher. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
keyExchangeAlgorithm String |
The key exchange algorithm used in a TLS-enabled connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
keyExchangeKeyBits Int32 |
The length of the key exchange key of a TLS-enabled connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
namedECCurve String |
The elliptic curve used in this connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
pfsCipher Bool |
Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS). |
||||||||||||||||||||||||||||||||||||||||||||||||
|
preSharedIdentityHint String |
A hint professed by the server to help the client select the PSK identity to use. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
publicKeyBits Int32 |
The length of the public key. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
resumedSession Bool |
Indicates whether a TLS-enabled connection was spawned from another TLS connection |
||||||||||||||||||||||||||||||||||||||||||||||||
|
secureConnection Bool |
Indicates whether TLS or SSL is enabled for this connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
serverAuthenticated Bool |
Indicates whether server authentication was performed during a TLS-enabled connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
signatureAlgorithm String |
The signature algorithm used in a TLS handshake. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
symmetricBlockSize Int32 |
The block size of the symmetric algorithm used. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
symmetricKeyBits Int32 |
The key length of the symmetric algorithm used. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
totalBytesReceived Int64 |
The total number of bytes received over this connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
totalBytesSent Int64 |
The total number of bytes sent over this connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
validationLog String |
Contains the server certificate's chain validation log. This information may be very useful in investigating chain validation failures. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
version String |
Indicates the version of SSL/TLS protocol negotiated during this connection. |
Constructors
public init()
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
|
bytes Data |
Returns raw CRL data in DER format. |
|
caKeyID Data |
A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL. |
|
entryCount Int32 |
Returns the number of certificate status entries in the CRL. |
|
handle Int64 |
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
|
|
issuer String |
The common name of the CRL issuer (CA), typically a company name. |
|
issuerRDN String |
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer. |
|
location String |
The URL that the CRL was downloaded from. |
|
nextUpdate String |
The planned time and date of the next version of this CRL to be published. |
|
sigAlgorithm String |
The public key algorithm that was used by the CA to sign this CRL. |
|
tbs Data |
The to-be-signed part of the CRL (the CRL without the signature part). |
|
thisUpdate String |
The date and time at which this version of the CRL was published. |
Constructors
public init()
Creates an empty CRL object.
IMAPMailboxInfo Type
Contains information about an IMAP mailbox.
Remarks
This compound object provides details of an IMAP mailbox.
Fields
|
delimiter String |
Mailbox hierarchy delimiter. |
|
hasChildren Bool |
Specifies whether the mailbox has \HasChildren attribute specified. |
|
hasNoChildren Bool |
Specifies whether the mailbox has \HasNoChildren attribute specified. |
|
marked Bool |
Specifies whether the mailbox has \Marked attribute specified. |
|
name String |
Specifies mailbox name. |
|
noInferiors Bool |
Specifies whether the mailbox has \NoInferiors attribute specified. |
|
noSelect Bool |
Specifies whether the mailbox has \NoSelect attribute specified. |
|
unmarked Bool |
Specifies whether the mailbox has \Unmarked attribute specified. |
IMAPMailboxStatus Type
Contains information about IMAP mailbox state.
Remarks
Provides details of current IMAP mailbox status.
Fields
|
messageFlags Int32 |
Contains message flags defined in the mailbox.
|
||||||||||||||||||
|
name String |
Specifies mailbox name. |
||||||||||||||||||
|
nextUID Int32 |
Returns the next unique identifier value. Use this property to get or set the next unique identifier (corresponds to UIDNEXT status code). |
||||||||||||||||||
|
permanentFlags Int32 |
Contains a list of message flags that can be changed permanently.
|
||||||||||||||||||
|
readOnly Bool |
Specifies whether the mailbox is write-protected. |
||||||||||||||||||
|
recentMessages Int32 |
The number of recent messages in the mailbox. |
||||||||||||||||||
|
totalMessages Int32 |
Total number of messages in the mailbox. |
||||||||||||||||||
|
uidValidity Int32 |
Specifies UID validity value. |
||||||||||||||||||
|
unseenMessages Int32 |
The number of unseen messages in the mailbox. |
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
|
date String |
Contains the value of the Date header field. |
||||||||||
|
flags Int32 |
Returns the flags currently set to the mail message. |
||||||||||
|
from String |
Contains the value of the From header field. |
||||||||||
|
internalDate String |
Returns the internal date of the mail message. |
||||||||||
|
priority MailPriorities |
Specifies the message priority. Available options:
|
||||||||||
|
sentTo String |
Contains the value of the To header field. |
||||||||||
|
size Int64 |
Returns the size of the message in bytes. |
||||||||||
|
subject String |
Contains the value of the Subject header field. |
||||||||||
|
uid Int32 |
Returns the unique ID of the mail message. |
IMAPServerInfo Type
Describes the IMAP server's capabilities.
Remarks
Check this object to learn about the IMAP server's technical capabilities.
Fields
|
capabilities String |
Returns the list of server capabilities. Use this property to get the list of IMAP capabilities (i.e., optional functionality of the server as defined in [RFC 3501]) obtained from the server. |
|
idleSupported Bool |
Indicates whether the IMAP server supports the IDLE command. |
|
loginDisabled Bool |
Specifies whether the server forbids login. |
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
|
attachmentCount Int32 |
Returns the number of attachments in this message. |
||||||||||
|
bcc String |
The contents of the BCC header field. The BCC header field contains the addresses of secondary recipients of the message whose addresses are not to be revealed to other recipients of the message. Mail servers remove the BCC header when processing the message and use its value for dispatching the message only. |
||||||||||
|
cc String |
The value of the CC header field. The CC field contains the addresses of secondary recipients of the message. |
||||||||||
|
comments String |
Contains additional information about the message body. |
||||||||||
|
date String |
The date and time when the message entered the mail delivery system. This field contains the date and time at which the creator of the message posted the message to the mail delivery system. The date is returned and accepted in UTC time zone. |
||||||||||
|
deliveryReceipt Bool |
Enables delivery notification. |
||||||||||
|
from String |
Contains the value of the From header field. This field contains the address(es) of the message author(s). If the actual sender is not the author of the message, use to specify the sender separately. |
||||||||||
|
handle Int64 |
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
|
||||||||||
|
htmlText String |
The HTML version of the message. |
||||||||||
|
id String |
The contents of the Message-ID header field. This field contains a unique identifier that refers to a particular version of this message. |
||||||||||
|
inReplyTo String |
The value of the In-Reply-To header field. A reply message should have the "In-Reply-To:" header field which may be used to identify the message (or messages) to which the new message is a reply. |
||||||||||
|
keywords String |
The value of the Keywords header field. This field can be used to add some important words and phrases that might be useful for the recipient. |
||||||||||
|
mailer String |
The name of the software that was used to send the message. |
||||||||||
|
plainText String |
The plain text version of the message. |
||||||||||
|
priority MailPriorities |
Specifies the message priority. Available options:
|
||||||||||
|
readReceipt Bool |
Enables a read notification. |
||||||||||
|
references String |
The value of the References header field. A reply message should include a "References:" header field which may be used to identify the "conversation thread". If the initial message is a reply itself, the References of the reply contain combined content of its "References:", "InReplyTo:" and "MessageID:" fields, subject to their presence in the original message. |
||||||||||
|
replyTo String |
The value of the Reply-To header field. This field contains the addresses to which the replies to this message should be sent. This field is optional. If not specified, the replies must be sent to the addresses specified in the field. |
||||||||||
|
returnPath String |
The value of the Return-Path header field. This field contains the address to which this message shall be returned in case of unsuccessful delivery. |
||||||||||
|
sender String |
The value of the Sender header field. This field specifies the mailbox of the agent responsible for the actual transmission of this message. If the originator of the message can be indicated by a single mailbox and both the author and the transmitter are identical, the "Sender:" field is deemed excessive and should not be used. |
||||||||||
|
sendTo String |
The value of the To header field. This field specifies the address(es) of the primary recipient(s) of the message. |
||||||||||
|
subject String |
Contains the subject field of this message. |
Constructors
public init()
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 (CRL).
An OCSP response is a snapshot of the certificate status at a given time.
Fields
|
bytes Data |
Buffer containing raw OCSP response data. |
|
entryCount Int32 |
The number of SingleResponse elements contained in this OCSP response. Each SingleResponse element corresponds to a certificate status. |
|
handle Int64 |
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
|
|
issuer String |
Indicates the issuer of this response (a CA or its authorized representative). |
|
issuerRDN String |
Indicates the RDN of the issuer of this response (a CA or its authorized representative). |
|
location String |
Location of the OCSP responder. |
|
producedAt String |
Specifies the time when the response was produced, in UTC. |
Constructors
public init()
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
|
address String |
The IP address of the proxy server. |
||||||||||
|
authentication ProxyAuthTypes |
The authentication type used by the proxy server.
|
||||||||||
|
password String |
The password to authenticate to the proxy server. |
||||||||||
|
port Int32 |
The port on the proxy server to connect to. |
||||||||||
|
proxyType ProxyTypes |
The type of the proxy server. The WebTunnel proxy is also known as HTTPS proxy. Unlike HTTP proxy, HTTPS proxy (WebTunnel) provides end-to-end security.
|
||||||||||
|
requestHeaders String |
Contains HTTP request headers for WebTunnel and HTTP proxy. |
||||||||||
|
responseBody String |
Contains the HTTP or HTTPS (WebTunnel) proxy response body. |
||||||||||
|
responseHeaders String |
Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. |
||||||||||
|
useIPv6 Bool |
Specifies whether IPv6 should be used when connecting through the proxy. |
||||||||||
|
useProxy Bool |
Enables or disables proxy-driven connection. |
||||||||||
|
username String |
Specifies the username credential for proxy authentication. |
Constructors
public init()
Creates a new ProxySettings object.
SocketSettings Type
A container for the socket settings.
Remarks
This type is a container for socket-layer parameters.
Fields
|
dnsMode DNSResolveModes |
Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.
|
||||||||
|
dnsPort Int32 |
Specifies the port number to be used for sending queries to the DNS server. |
||||||||
|
dnsQueryTimeout Int32 |
The timeout (in milliseconds) for each DNS query. The value of 0 indicates the infinite timeout. |
||||||||
|
dnsServers String |
The addresses of DNS servers to use for address resolution, separated by commas or semicolons. |
||||||||
|
dnsTotalTimeout Int32 |
The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates the infinite timeout. |
||||||||
|
incomingSpeedLimit Int32 |
The maximum number of bytes to read from the socket, per second. |
||||||||
|
localAddress String |
The local network interface to bind the socket to. |
||||||||
|
localPort Int32 |
The local port number to bind the socket to. |
||||||||
|
outgoingSpeedLimit Int32 |
The maximum number of bytes to write to the socket, per second. |
||||||||
|
timeout Int32 |
The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. If Timeout is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack). |
||||||||
|
useIPv6 Bool |
Enables or disables IP protocol version 6. |
Constructors
public init()
Creates a new SocketSettings object.
TLSSettings Type
A container for TLS connection settings.
Remarks
TLS (Transport Layer Security) protocol provides security for information exchanged over insecure connections such as TCP/IP.
Fields
|
autoValidateCertificates Bool |
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. |
|||||||||||||||||||||||||||||||||
|
baseConfiguration SecureTransportPredefinedConfigurations |
Selects the base configuration for the TLS settings. Several profiles are on offer, tuned up for different purposes, such as high security or higher compatibility.
|
|||||||||||||||||||||||||||||||||
|
ciphersuites String |
A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the all (and -all) aliases that allow to blanketly enable or disable all ciphersuites at once. Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by BaseConfiguration. Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:
|
|||||||||||||||||||||||||||||||||
|
ecCurves String |
Defines the elliptic curves to enable. |
|||||||||||||||||||||||||||||||||
|
extensions String |
Provides access to TLS extensions. |
|||||||||||||||||||||||||||||||||
|
forceResumeIfDestinationChanges Bool |
Whether to force TLS session resumption when the destination address changes. |
|||||||||||||||||||||||||||||||||
|
preSharedIdentity String |
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. |
|||||||||||||||||||||||||||||||||
|
preSharedKey String |
Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. |
|||||||||||||||||||||||||||||||||
|
preSharedKeyCiphersuite String |
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. |
|||||||||||||||||||||||||||||||||
|
renegotiationAttackPreventionMode RenegotiationAttackPreventionModes |
Selects renegotiation attack prevention mechanism. The following options are available:
|
|||||||||||||||||||||||||||||||||
|
revocationCheck RevocationCheckKinds |
Specifies the kind(s) of revocation check to perform. Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.
This setting controls the way the revocation checks are performed. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time. There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs). This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to faster OCSP route and only demand one source to succeed) is a good choice for most of typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential. |
|||||||||||||||||||||||||||||||||
|
sslOptions Int32 |
Various SSL (TLS) protocol options, set of
|
|||||||||||||||||||||||||||||||||
|
tlsMode SSLModes |
Specifies the TLS mode to use.
|
|||||||||||||||||||||||||||||||||
|
useExtendedMasterSecret Bool |
Enables Extended Master Secret Extension, as defined in RFC 7627. |
|||||||||||||||||||||||||||||||||
|
useSessionResumption Bool |
Enables or disables TLS session resumption capability. |
|||||||||||||||||||||||||||||||||
|
versions Int32 |
Th SSL/TLS versions to enable by default.
|
Constructors
public init()
Creates a new TLSSettings object.
Configuration Settings (IMAPClient Module)
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.IMAPClient Configuration Settings | ||||||||||||||||||||||||||||||
| Authentications:
Specifies enabled authentication methods and their priorities.Use this setting to enable or disable authentication methods and specify their priorities. The setting contains
a comma-separated list of authentication methods. The first method in the list has the highest priority, and so on.
The class will use the first method from the list which is supported by the server.
Supported methods: PLAIN, LOGIN, CRAM-MD5, DIGEST-MD5, NTLM, GSSAPI, XOAUTH2 Default value: PLAIN,DIGEST-MD5,CRAM-MD5,NTLM |
||||||||||||||||||||||||||||||
| IdleAuto: Specifies whether idle mode should be requested automatically.Set this property to true to force this client to automatically send IDLE request to the server. Default value is false. | ||||||||||||||||||||||||||||||
| IdleTimeout: Specifies idle timeout in seconds.If IDLE command is running on a server, and a client has been inactive for some time, the server may log the client off. Set this property to a maximum period of time after which this client should resend the IDLE command. The default value is 1740 seconds (29 minutes). | ||||||||||||||||||||||||||||||
| IgnoreSystemTrust:
Whether trusted Windows Certificate Stores should be treated as trusted.Specifies whether, during chain validation, the component should respect
the trust to CA certificates as configured in the operating system.
In Windows this effectively defines whether the component should trust the
certificates residing in the Trusted Root Certification Authorities store.
If IgnoreSystemTrust is True, certificates residing in the trusted root store are treated as if they are known, rather than trusted. Only certificates provided via other means (such as TrustedCertificates property) are considered trusted. |
||||||||||||||||||||||||||||||
| ListCriteria: Specifies an advanced criteria for listing messages on the server.Use this setting to list messages based on additional criteria like message date, size, etc. For more details, see SEARCH command in RFC 3501 | ||||||||||||||||||||||||||||||
| MaxLineLength: Specifies maximum expected line length.Use this setting to specify how long the expected mail line can be. Setting the very long value leads to memory increase. Default value is 10000. | ||||||||||||||||||||||||||||||
| MessageHeaderZZZ[i]:
A value of ZZZ header field for message i.Returns the value of the header field named ZZZ for the message with index i. If the message doesn't contain such
header field, the returned value is an empty line.
For example, to get a value of the Content-Type header field, use MessageHeaderContentType[i] config name. |
||||||||||||||||||||||||||||||
| OtherHeaders: Specifies header fields to request when lists messages on the server.Use this setting to request additional header fields for each message on the server. The setting contains a comma-separated list of header field names that should be requested when the class lists messages. To request all the fields, use "OtherHeaders=*". To not request additional header fields, use "OtherHeaders=". | ||||||||||||||||||||||||||||||
| TempPath: Path for storing temporary files.This setting specifies an absolute path to the location on disk where temporary files are stored. | ||||||||||||||||||||||||||||||
| TolerateMinorChainIssues: Whether to tolerate minor chain issues.TBD | ||||||||||||||||||||||||||||||
| UseMicrosoftCTL: Enables or disables automatic use of Microsoft online certificate trust list.Enable this property to make the chain validation module automatically look up missing CA certificates in the public Windows Update repository. | ||||||||||||||||||||||||||||||
| UseSystemCertificates: Enables or disables the use of the system certificates.Use this property to tell chain validation module automatically look up missing CA certificates in the system certificates. In many cases it is beneficial to switch this property on, as the operating system certificate configuration provides a representative trust framework. | ||||||||||||||||||||||||||||||
Base Configuration Settings | ||||||||||||||||||||||||||||||
| CheckKeyIntegrityBeforeUse:
Enables or disable private key integrity check before use.This global property enables or disables private key material check before each signing operation. This slows down performance a bit,
but prevents a selection of attacks on RSA keys where keys with unknown origins are used.
You can switch this property off to improve performance if your project only uses known, good private keys. |
||||||||||||||||||||||||||||||
| CookieCaching:
Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the class.
Supported values are:
|
||||||||||||||||||||||||||||||
| Cookies: Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions. | ||||||||||||||||||||||||||||||
| DefDeriveKeyIterations: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided. | ||||||||||||||||||||||||||||||
| EnableClientSideSSLFFDHE:
Enables or disables finite field DHE key exchange support in TLS clients.This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower
algorithm if compared to EC DHE; enabling it may result in slower connections.
This setting only applies to sessions negotiated with TLS version 1.3. |
||||||||||||||||||||||||||||||
| GlobalCookies: Gets or sets global cookies for all the HTTP transports.Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its CookieCaching property set to "global". | ||||||||||||||||||||||||||||||
| HttpUserAgent: Specifies the user agent name to be used by all HTTP clients.This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes. | ||||||||||||||||||||||||||||||
| LogDestination:
Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped.
Supported values are:
|
||||||||||||||||||||||||||||||
| LogDetails:
Specifies the debug log details to dump.Contains a comma-separated list of values that specifies which debug log details to dump.
Supported values are:
|
||||||||||||||||||||||||||||||
| LogFile: Specifies the debug log filename.Use this property to provide a path to the log file. | ||||||||||||||||||||||||||||||
| LogFilters:
Specifies the debug log filters.Contains a comma-separated list of value pairs ("name:value") that describe filters.
Supported filter names are:
|
||||||||||||||||||||||||||||||
LogFlushMode:
Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined:
|
||||||||||||||||||||||||||||||
| LogLevel:
Specifies the debug log level.Use this property to provide the desired debug log level.
Supported values are:
|
||||||||||||||||||||||||||||||
| LogMaxEventCount:
Specifies the maximum number of events to cache before further action is taken.Use this property to specify the log event number threshold. This threshold may have different effects,
depending on the rotation setting and/or the flush mode.
The default value of this setting is 100. |
||||||||||||||||||||||||||||||
LogRotationMode:
Specifies the log rotation mode.Use this property to set the log rotation mode. The following values are defined:
|
||||||||||||||||||||||||||||||
| MaxASN1BufferLength: Specifies the maximal allowed length for ASN.1 primitive tag data.This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks. | ||||||||||||||||||||||||||||||
| MaxASN1TreeDepth: Specifies the maximal depth for processed ASN.1 trees.This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks. | ||||||||||||||||||||||||||||||
| OCSPHashAlgorithm: Specifies the hash algorithm to be used to identify certificates in OCSP requests.This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful. | ||||||||||||||||||||||||||||||
| Tag: Allows to store any custom data.Use this config property to store any custom data. | ||||||||||||||||||||||||||||||
| UseSharedSystemStorages: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores. | ||||||||||||||||||||||||||||||
| UseSystemOAEPAndPSS:
Enforces or disables the use of system-driven RSA OAEP and PSS computations.This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable.
If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations
using its own OAEP/PSS implementation.
This setting only applies to certificates originating from a Windows system store. |
||||||||||||||||||||||||||||||
| UseSystemRandom: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation. |
Trappable Errors (IMAPClient Module)
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) |