IMAPClient Class
Properties Methods Events Configuration Settings Errors
The IMAPClient class provides client-side functionality for IMAP4 (Internet Message Access Protocol).
Syntax
IMAPClient
Remarks
Use this class to manage E-mail and retrieve E-mail messages from the remote IMAP servers.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
BlockedCertCount | The number of records in the BlockedCert arrays. |
BlockedCertBytes | Returns raw certificate data in DER format. |
BlockedCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
ClientCertCount | The number of records in the ClientCert arrays. |
ClientCertBytes | Returns raw certificate data in DER format. |
ClientCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
ConnInfoAEADCipher | Indicates whether the encryption algorithm used is an AEAD cipher. |
ConnInfoChainValidationDetails | The details of a certificate chain validation outcome. |
ConnInfoChainValidationResult | The outcome of a certificate chain validation routine. |
ConnInfoCiphersuite | The cipher suite employed by this connection. |
ConnInfoClientAuthenticated | Specifies whether client authentication was performed during this connection. |
ConnInfoClientAuthRequested | Specifies whether client authentication was requested during this connection. |
ConnInfoConnectionEstablished | Indicates whether the connection has been established fully. |
ConnInfoConnectionID | The unique identifier assigned to this connection. |
ConnInfoDigestAlgorithm | The digest algorithm used in a TLS-enabled connection. |
ConnInfoEncryptionAlgorithm | The symmetric encryption algorithm used in a TLS-enabled connection. |
ConnInfoExportable | Indicates whether a TLS connection uses a reduced-strength exportable cipher. |
ConnInfoKeyExchangeAlgorithm | The key exchange algorithm used in a TLS-enabled connection. |
ConnInfoKeyExchangeKeyBits | The length of the key exchange key of a TLS-enabled connection. |
ConnInfoNamedECCurve | The elliptic curve used in this connection. |
ConnInfoPFSCipher | Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS). |
ConnInfoPreSharedIdentityHint | A hint professed by the server to help the client select the PSK identity to use. |
ConnInfoPublicKeyBits | The length of the public key. |
ConnInfoResumedSession | Indicates whether a TLS-enabled connection was spawned from another TLS connection. |
ConnInfoSecureConnection | Indicates whether TLS or SSL is enabled for this connection. |
ConnInfoServerAuthenticated | Indicates whether server authentication was performed during a TLS-enabled connection. |
ConnInfoSignatureAlgorithm | The signature algorithm used in a TLS handshake. |
ConnInfoSymmetricBlockSize | The block size of the symmetric algorithm used. |
ConnInfoSymmetricKeyBits | The key length of the symmetric algorithm used. |
ConnInfoTotalBytesReceived | The total number of bytes received over this connection. |
ConnInfoTotalBytesSent | The total number of bytes sent over this connection. |
ConnInfoValidationLog | Contains the server certificate's chain validation log. |
ConnInfoVersion | Indicates the version of SSL/TLS protocol negotiated during this connection. |
CurrMailboxMessageFlags | Contains message flags defined in the mailbox. |
CurrMailboxName | Specifies mailbox name. |
CurrMailboxNextUID | Returns the next unique identifier value. |
CurrMailboxPermanentFlags | Contains a list of message flags that can be changed permanently. |
CurrMailboxReadOnly | Specifies whether the mailbox is write-protected. |
CurrMailboxRecentMessages | The number of recent messages in the mailbox. |
CurrMailboxTotalMessages | Total number of messages in the mailbox. |
CurrMailboxUIDValidity | Specifies UID validity value. |
CurrMailboxUnseenMessages | The number of unseen messages in the mailbox. |
FIPSMode | Reserved. |
KnownCertCount | The number of records in the KnownCert arrays. |
KnownCertBytes | Returns raw certificate data in DER format. |
KnownCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
KnownCRLCount | The number of records in the KnownCRL arrays. |
KnownCRLBytes | Returns raw CRL data in DER format. |
KnownCRLHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
KnownOCSPCount | The number of records in the KnownOCSP arrays. |
KnownOCSPBytes | Buffer containing raw OCSP response data. |
KnownOCSPHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
MailboxInfoCount | The number of records in the MailboxInfo arrays. |
MailboxInfoDelimiter | Mailbox hierarchy delimiter. |
MailboxInfoHasChildren | Specifies whether the mailbox has \\HasChildren attribute specified. |
MailboxInfoHasNoChildren | Specifies whether the mailbox has \\HasNoChildren attribute specified. |
MailboxInfoMarked | Specifies whether the mailbox has \\Marked attribute specified. |
MailboxInfoName | Specifies mailbox name. |
MailboxInfoNoInferiors | Specifies whether the mailbox has \\NoInferiors attribute specified. |
MailboxInfoNoSelect | Specifies whether the mailbox has \\NoSelect attribute specified. |
MailboxInfoUnmarked | Specifies whether the mailbox has \\Unmarked attribute specified. |
MsgAttachmentCount | Returns the number of attachments in this message. |
MsgBcc | The contents of the BCC header property. |
MsgCc | The value of the CC header property. |
MsgComments | Contains additional information about the message body. |
MsgDate | The date and time when the message entered the mail delivery system. |
MsgDeliveryReceipt | Enables delivery notification. |
MsgFrom | Contains the value of the From header property. |
MsgHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
MsgHtmlText | The HTML version of the message. |
MsgID | The contents of the Message-ID header property. |
MsgInReplyTo | The value of the In-Reply-To header property. |
MsgKeywords | The value of the Keywords header property. |
MsgMailer | The name of the software that was used to send the message. |
MsgPlainText | The plain text version of the message. |
MsgPriority | Specifies the message priority. |
MsgReadReceipt | Enables a read notification. |
MsgReferences | The value of the References header property. |
MsgReplyTo | The value of the Reply-To header property. |
MsgReturnPath | The value of the Return-Path header property. |
MsgSender | The value of the Sender header property. |
MsgSendTo | The value of the To header property. |
MsgSubject | Contains the subject property of this message. |
MsgInfoCount | The number of records in the MsgInfo arrays. |
MsgInfoDate | Contains the value of the Date header property. |
MsgInfoFlags | Returns the flags currently set to the mail message. |
MsgInfoFrom | Contains the value of the From header property. |
MsgInfoInternalDate | Returns the internal date of the mail message. |
MsgInfoPriority | Specifies the message priority. |
MsgInfoSentTo | Contains the value of the To header property. |
MsgInfoSize | Returns the size of the message in bytes. |
MsgInfoSubject | Contains the value of the Subject header property. |
MsgInfoUID | Returns the unique ID of the mail message. |
Password | The authentication password. |
ProxyAddress | The IP address of the proxy server. |
ProxyAuthentication | The authentication type used by the proxy server. |
ProxyPassword | The password to authenticate to the proxy server. |
ProxyPort | The port on the proxy server to connect to. |
ProxyProxyType | The type of the proxy server. |
ProxyRequestHeaders | Contains HTTP request headers for WebTunnel and HTTP proxy. |
ProxyResponseBody | Contains the HTTP or HTTPS (WebTunnel) proxy response body. |
ProxyResponseHeaders | Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. |
ProxyUseIPv6 | Specifies whether IPv6 should be used when connecting through the proxy. |
ProxyUseProxy | Enables or disables proxy-driven connection. |
ProxyUsername | Specifies the username credential for proxy authentication. |
ServerCertCount | The number of records in the ServerCert arrays. |
ServerCertBytes | Returns raw certificate data in DER format. |
ServerCertCAKeyID | A unique identifier (fingerprint) of the CA certificate's private key. |
ServerCertFingerprint | Contains the fingerprint (a hash imprint) of this certificate. |
ServerCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
ServerCertIssuer | The common name of the certificate issuer (CA), typically a company name. |
ServerCertIssuerRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
ServerCertKeyAlgorithm | Specifies the public key algorithm of this certificate. |
ServerCertKeyBits | Returns the length of the public key. |
ServerCertKeyFingerprint | Returns a fingerprint of the public key contained in the certificate. |
ServerCertKeyUsage | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
ServerCertPublicKeyBytes | Contains the certificate's public key in DER format. |
ServerCertSelfSigned | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
ServerCertSerialNumber | Returns the certificate's serial number. |
ServerCertSigAlgorithm | Indicates the algorithm that was used by the CA to sign this certificate. |
ServerCertSubject | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
ServerCertSubjectKeyID | Contains a unique identifier (fingerprint) of the certificate's private key. |
ServerCertSubjectRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
ServerCertValidFrom | The time point at which the certificate becomes valid, in UTC. |
ServerCertValidTo | The time point at which the certificate expires, in UTC. |
ServerInfoCapabilities | Returns the list of server capabilities. |
ServerInfoIdleSupported | Indicates whether the IMAP server supports the IDLE command. |
ServerInfoLoginDisabled | Specifies whether the server forbids login. |
SocketDNSMode | Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system. |
SocketDNSPort | Specifies the port number to be used for sending queries to the DNS server. |
SocketDNSQueryTimeout | The timeout (in milliseconds) for each DNS query. |
SocketDNSServers | The addresses of DNS servers to use for address resolution, separated by commas or semicolons. |
SocketDNSTotalTimeout | The timeout (in milliseconds) for the whole resolution process. |
SocketIncomingSpeedLimit | The maximum number of bytes to read from the socket, per second. |
SocketLocalAddress | The local network interface to bind the socket to. |
SocketLocalPort | The local port number to bind the socket to. |
SocketOutgoingSpeedLimit | The maximum number of bytes to write to the socket, per second. |
SocketTimeout | The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. |
SocketUseIPv6 | Enables or disables IP protocol version 6. |
TLSAutoValidateCertificates | Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. |
TLSBaseConfiguration | Selects the base configuration for the TLS settings. |
TLSCiphersuites | A list of ciphersuites separated with commas or semicolons. |
TLSECCurves | Defines the elliptic curves to enable. |
TLSExtensions | Provides access to TLS extensions. |
TLSForceResumeIfDestinationChanges | Whether to force TLS session resumption when the destination address changes. |
TLSPreSharedIdentity | Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. |
TLSPreSharedKey | Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. |
TLSPreSharedKeyCiphersuite | Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. |
TLSRenegotiationAttackPreventionMode | Selects renegotiation attack prevention mechanism. |
TLSRevocationCheck | Specifies the kind(s) of revocation check to perform. |
TLSSSLOptions | Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size. |
TLSTLSMode | Specifies the TLS mode to use. |
TLSUseExtendedMasterSecret | Enables Extended Master Secret Extension, as defined in RFC 7627. |
TLSUseSessionResumption | Enables or disables TLS session resumption capability. |
TLSVersions | Th SSL/TLS versions to enable by default. |
TrustedCertCount | The number of records in the TrustedCert arrays. |
TrustedCertBytes | Returns raw certificate data in DER format. |
TrustedCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
Username | The authentication username. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
CloseMailbox | Closes the current mailbox. |
Config | Sets or retrieves a configuration setting. |
Connect | Establishes a connection to the IMAP server. |
CopyMessage | Copies a message to another mailbox. |
CreateMailbox | Creates a new mailbox. |
DeleteMailbox | Deletes an existing mailbox. |
Disconnect | Closes connection to the IMAP server. |
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 class with short descriptions. Click on the links for further details.
BeforeAuth | Fires before the authentication starts. |
CertificateValidate | Fires when the server's TLS certificate has to be validated. |
Command | Reports a command sent to the server. |
CommandData | Returns the data that accompanies the command. |
CommandReply | Reports the receipt of a reply to a command. |
CommandReplyData | Returns the data that accompanies a reply to a command. |
Error | Provides information about errors during SMTP operations. |
MailboxStatus | Reports the mailbox status returned from the server. |
Notification | This event notifies the application about an underlying control flow event. |
Progress | Reports the progress of the data transfer operation. |
TLSEstablished | TBD. |
TLSHandshake | TBD. |
TLSPSK | TBD. |
TLSShutdown | TBD. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
Authentications | Specifies enabled authentication methods and their priorities. |
IdleAuto | Specifies whether idle mode should be requested automatically. |
IdleTimeout | Specifies idle timeout in seconds. |
IgnoreSystemTrust | Whether trusted Windows Certificate Stores should be treated as trusted. |
ListCriteria | Specifies an advanced criteria for listing messages on the server. |
MaxLineLength | Specifies maximum expected line length. |
MessageHeaderZZZ[i] | A value of ZZZ header field for message i. |
OtherHeaders | Specifies header fields to request when lists messages on the server. |
TempPath | Path for storing temporary files. |
TolerateMinorChainIssues | Whether to tolerate minor chain issues. |
UseMicrosoftCTL | Enables or disables automatic use of Microsoft online certificate trust list. |
UseSystemCertificates | Enables or disables the use of the system certificates. |
CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
Cookies | Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only). |
DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
LogDestination | Specifies the debug log destination. |
LogDetails | Specifies the debug log details to dump. |
LogFile | Specifies the debug log filename. |
LogFilters | Specifies the debug log filters. |
LogFlushMode | Specifies the log flush mode. |
LogLevel | Specifies the debug log level. |
LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
LogRotationMode | Specifies the log rotation mode. |
MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
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. |
BlockedCertCount Property (IMAPClient Class)
The number of records in the BlockedCert arrays.
Syntax
int GetBlockedCertCount();
int SetBlockedCertCount(int iBlockedCertCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at BlockedCertCount - 1.This property is not available at design time.
Data Type
Integer
BlockedCertBytes Property (IMAPClient Class)
Returns raw certificate data in DER format.
Syntax
QByteArray GetBlockedCertBytes(int iBlockedCertIndex);
Remarks
Returns raw certificate data in DER format.
The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
BlockedCertHandle Property (IMAPClient Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetBlockedCertHandle(int iBlockedCertIndex);
int SetBlockedCertHandle(int iBlockedCertIndex, qint64 lBlockedCertHandle);
Default Value
0
Remarks
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.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.
This property is not available at design time.
Data Type
Long64
ClientCertCount Property (IMAPClient Class)
The number of records in the ClientCert arrays.
Syntax
int GetClientCertCount();
int SetClientCertCount(int iClientCertCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at ClientCertCount - 1.This property is not available at design time.
Data Type
Integer
ClientCertBytes Property (IMAPClient Class)
Returns raw certificate data in DER format.
Syntax
QByteArray GetClientCertBytes(int iClientCertIndex);
Remarks
Returns raw certificate data in DER format.
The ClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
ClientCertHandle Property (IMAPClient Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetClientCertHandle(int iClientCertIndex);
int SetClientCertHandle(int iClientCertIndex, qint64 lClientCertHandle);
Default Value
0
Remarks
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.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The ClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCertCount property.
This property is not available at design time.
Data Type
Long64
ConnInfoAEADCipher Property (IMAPClient Class)
Indicates whether the encryption algorithm used is an AEAD cipher.
Syntax
bool GetConnInfoAEADCipher();
Default Value
false
Remarks
Indicates whether the encryption algorithm used is an AEAD cipher.
This property is read-only and not available at design time.
Data Type
Boolean
ConnInfoChainValidationDetails Property (IMAPClient Class)
The details of a certificate chain validation outcome.
Syntax
int GetConnInfoChainValidationDetails();
Default Value
0
Remarks
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:
cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
cvrRevoked | 0x0002 | One or more certificates are revoked |
cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
cvrExpired | 0x0008 | One or more certificates are expired |
cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
cvrBlocked | 0x0800 | One or more certificates are blocked |
cvrFailure | 0x1000 | General validation failure |
cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
This property is read-only and not available at design time.
Data Type
Integer
ConnInfoChainValidationResult Property (IMAPClient Class)
The outcome of a certificate chain validation routine.
Syntax
int GetConnInfoChainValidationResult();
Possible Values
CVT_VALID(0),
CVT_VALID_BUT_UNTRUSTED(1),
CVT_INVALID(2),
CVT_CANT_BE_ESTABLISHED(3)
Default Value
0
Remarks
The outcome of a certificate chain validation routine.
Available options:
cvtValid | 0 | The chain is valid |
cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
Use the ValidationLog property to access the detailed validation log.
This property is read-only and not available at design time.
Data Type
Integer
ConnInfoCiphersuite Property (IMAPClient Class)
The cipher suite employed by this connection.
Syntax
QString GetConnInfoCiphersuite();
Default Value
""
Remarks
The cipher suite employed by this connection.
For TLS connections, this property returns the ciphersuite that was/is employed by the connection.
This property is read-only and not available at design time.
Data Type
String
ConnInfoClientAuthenticated Property (IMAPClient Class)
Specifies whether client authentication was performed during this connection.
Syntax
bool GetConnInfoClientAuthenticated();
Default Value
false
Remarks
Specifies whether client authentication was performed during this connection.
This property is read-only and not available at design time.
Data Type
Boolean
ConnInfoClientAuthRequested Property (IMAPClient Class)
Specifies whether client authentication was requested during this connection.
Syntax
bool GetConnInfoClientAuthRequested();
Default Value
false
Remarks
Specifies whether client authentication was requested during this connection.
This property is read-only and not available at design time.
Data Type
Boolean
ConnInfoConnectionEstablished Property (IMAPClient Class)
Indicates whether the connection has been established fully.
Syntax
bool GetConnInfoConnectionEstablished();
Default Value
false
Remarks
Indicates whether the connection has been established fully.
This property is read-only and not available at design time.
Data Type
Boolean
ConnInfoConnectionID Property (IMAPClient Class)
The unique identifier assigned to this connection.
Syntax
QByteArray GetConnInfoConnectionID();
Remarks
The unique identifier assigned to this connection.
This property is read-only and not available at design time.
Data Type
Byte Array
ConnInfoDigestAlgorithm Property (IMAPClient Class)
The digest algorithm used in a TLS-enabled connection.
Syntax
QString GetConnInfoDigestAlgorithm();
Default Value
""
Remarks
The digest algorithm used in a TLS-enabled connection.
This property is read-only and not available at design time.
Data Type
String
ConnInfoEncryptionAlgorithm Property (IMAPClient Class)
The symmetric encryption algorithm used in a TLS-enabled connection.
Syntax
QString GetConnInfoEncryptionAlgorithm();
Default Value
""
Remarks
The symmetric encryption algorithm used in a TLS-enabled connection.
This property is read-only and not available at design time.
Data Type
String
ConnInfoExportable Property (IMAPClient Class)
Indicates whether a TLS connection uses a reduced-strength exportable cipher.
Syntax
bool GetConnInfoExportable();
Default Value
false
Remarks
Indicates whether a TLS connection uses a reduced-strength exportable cipher.
This property is read-only and not available at design time.
Data Type
Boolean
ConnInfoKeyExchangeAlgorithm Property (IMAPClient Class)
The key exchange algorithm used in a TLS-enabled connection.
Syntax
QString GetConnInfoKeyExchangeAlgorithm();
Default Value
""
Remarks
The key exchange algorithm used in a TLS-enabled connection.
This property is read-only and not available at design time.
Data Type
String
ConnInfoKeyExchangeKeyBits Property (IMAPClient Class)
The length of the key exchange key of a TLS-enabled connection.
Syntax
int GetConnInfoKeyExchangeKeyBits();
Default Value
0
Remarks
The length of the key exchange key of a TLS-enabled connection.
This property is read-only and not available at design time.
Data Type
Integer
ConnInfoNamedECCurve Property (IMAPClient Class)
The elliptic curve used in this connection.
Syntax
QString GetConnInfoNamedECCurve();
Default Value
""
Remarks
The elliptic curve used in this connection.
This property is read-only and not available at design time.
Data Type
String
ConnInfoPFSCipher Property (IMAPClient Class)
Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).
Syntax
bool GetConnInfoPFSCipher();
Default Value
false
Remarks
Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).
This property is read-only and not available at design time.
Data Type
Boolean
ConnInfoPreSharedIdentityHint Property (IMAPClient Class)
A hint professed by the server to help the client select the PSK identity to use.
Syntax
QString GetConnInfoPreSharedIdentityHint();
Default Value
""
Remarks
A hint professed by the server to help the client select the PSK identity to use.
This property is read-only and not available at design time.
Data Type
String
ConnInfoPublicKeyBits Property (IMAPClient Class)
The length of the public key.
Syntax
int GetConnInfoPublicKeyBits();
Default Value
0
Remarks
The length of the public key.
This property is read-only and not available at design time.
Data Type
Integer
ConnInfoResumedSession Property (IMAPClient Class)
Indicates whether a TLS-enabled connection was spawned from another TLS connection.
Syntax
bool GetConnInfoResumedSession();
Default Value
false
Remarks
Indicates whether a TLS-enabled connection was spawned from another TLS connection
This property is read-only and not available at design time.
Data Type
Boolean
ConnInfoSecureConnection Property (IMAPClient Class)
Indicates whether TLS or SSL is enabled for this connection.
Syntax
bool GetConnInfoSecureConnection();
Default Value
false
Remarks
Indicates whether TLS or SSL is enabled for this connection.
This property is read-only and not available at design time.
Data Type
Boolean
ConnInfoServerAuthenticated Property (IMAPClient Class)
Indicates whether server authentication was performed during a TLS-enabled connection.
Syntax
bool GetConnInfoServerAuthenticated();
Default Value
false
Remarks
Indicates whether server authentication was performed during a TLS-enabled connection.
This property is read-only and not available at design time.
Data Type
Boolean
ConnInfoSignatureAlgorithm Property (IMAPClient Class)
The signature algorithm used in a TLS handshake.
Syntax
QString GetConnInfoSignatureAlgorithm();
Default Value
""
Remarks
The signature algorithm used in a TLS handshake.
This property is read-only and not available at design time.
Data Type
String
ConnInfoSymmetricBlockSize Property (IMAPClient Class)
The block size of the symmetric algorithm used.
Syntax
int GetConnInfoSymmetricBlockSize();
Default Value
0
Remarks
The block size of the symmetric algorithm used.
This property is read-only and not available at design time.
Data Type
Integer
ConnInfoSymmetricKeyBits Property (IMAPClient Class)
The key length of the symmetric algorithm used.
Syntax
int GetConnInfoSymmetricKeyBits();
Default Value
0
Remarks
The key length of the symmetric algorithm used.
This property is read-only and not available at design time.
Data Type
Integer
ConnInfoTotalBytesReceived Property (IMAPClient Class)
The total number of bytes received over this connection.
Syntax
qint64 GetConnInfoTotalBytesReceived();
Default Value
0
Remarks
The total number of bytes received over this connection.
This property is read-only and not available at design time.
Data Type
Long64
ConnInfoTotalBytesSent Property (IMAPClient Class)
The total number of bytes sent over this connection.
Syntax
qint64 GetConnInfoTotalBytesSent();
Default Value
0
Remarks
The total number of bytes sent over this connection.
This property is read-only and not available at design time.
Data Type
Long64
ConnInfoValidationLog Property (IMAPClient Class)
Contains the server certificate's chain validation log.
Syntax
QString GetConnInfoValidationLog();
Default Value
""
Remarks
Contains the server certificate's chain validation log. This information may be very useful in investigating chain validation failures.
This property is read-only and not available at design time.
Data Type
String
ConnInfoVersion Property (IMAPClient Class)
Indicates the version of SSL/TLS protocol negotiated during this connection.
Syntax
QString GetConnInfoVersion();
Default Value
""
Remarks
Indicates the version of SSL/TLS protocol negotiated during this connection.
This property is read-only and not available at design time.
Data Type
String
CurrMailboxMessageFlags Property (IMAPClient Class)
Contains message flags defined in the mailbox.
Syntax
int GetCurrMailboxMessageFlags();
Default Value
0
Remarks
Contains message flags defined in the mailbox.
imapMessageAnswered | 0x01 | Message has been answered. |
imapMessageDeleted | 0x02 | Message is 'deleted' for removal later. |
imapMessageDraft | 0x04 | Message has not completed composition (marked as a draft). |
imapMessageFlagged | 0x08 | Message is 'flagged' for urgent/special attention. |
imapMessageRecent | 0x10 | Message is 'recently' arrived in this mailbox. This session is the first session to have been notified about this message. |
imapMessageSeen | 0x20 | Message has been read. |
This property is read-only and not available at design time.
Data Type
Integer
CurrMailboxName Property (IMAPClient Class)
Specifies mailbox name.
Syntax
QString GetCurrMailboxName();
Default Value
""
Remarks
Specifies mailbox name.
This property is read-only and not available at design time.
Data Type
String
CurrMailboxNextUID Property (IMAPClient Class)
Returns the next unique identifier value.
Syntax
int GetCurrMailboxNextUID();
Default Value
0
Remarks
Returns the next unique identifier value.
Use this property to get or set the next unique identifier (corresponds to UIDNEXT status code).
This property is read-only and not available at design time.
Data Type
Integer
CurrMailboxPermanentFlags Property (IMAPClient Class)
Contains a list of message flags that can be changed permanently.
Syntax
int GetCurrMailboxPermanentFlags();
Default Value
0
Remarks
Contains a list of message flags that can be changed permanently.
imapMessageAnswered | 0x01 | Message has been answered. |
imapMessageDeleted | 0x02 | Message is 'deleted' for removal later. |
imapMessageDraft | 0x04 | Message has not completed composition (marked as a draft). |
imapMessageFlagged | 0x08 | Message is 'flagged' for urgent/special attention. |
imapMessageRecent | 0x10 | Message is 'recently' arrived in this mailbox. This session is the first session to have been notified about this message. |
imapMessageSeen | 0x20 | Message has been read. |
This property is read-only and not available at design time.
Data Type
Integer
CurrMailboxReadOnly Property (IMAPClient Class)
Specifies whether the mailbox is write-protected.
Syntax
bool GetCurrMailboxReadOnly();
Default Value
false
Remarks
Specifies whether the mailbox is write-protected.
This property is read-only and not available at design time.
Data Type
Boolean
CurrMailboxRecentMessages Property (IMAPClient Class)
The number of recent messages in the mailbox.
Syntax
int GetCurrMailboxRecentMessages();
Default Value
0
Remarks
The number of recent messages in the mailbox.
This property is read-only and not available at design time.
Data Type
Integer
CurrMailboxTotalMessages Property (IMAPClient Class)
Total number of messages in the mailbox.
Syntax
int GetCurrMailboxTotalMessages();
Default Value
0
Remarks
Total number of messages in the mailbox.
This property is read-only and not available at design time.
Data Type
Integer
CurrMailboxUIDValidity Property (IMAPClient Class)
Specifies UID validity value.
Syntax
int GetCurrMailboxUIDValidity();
Default Value
0
Remarks
Specifies UID validity value.
This property is read-only and not available at design time.
Data Type
Integer
CurrMailboxUnseenMessages Property (IMAPClient Class)
The number of unseen messages in the mailbox.
Syntax
int GetCurrMailboxUnseenMessages();
Default Value
0
Remarks
The number of unseen messages in the mailbox.
This property is read-only and not available at design time.
Data Type
Integer
FIPSMode Property (IMAPClient Class)
Reserved.
Syntax
bool GetFIPSMode();
int SetFIPSMode(bool bFIPSMode);
Default Value
false
Remarks
This property is reserved for future use.
Data Type
Boolean
KnownCertCount Property (IMAPClient Class)
The number of records in the KnownCert arrays.
Syntax
int GetKnownCertCount();
int SetKnownCertCount(int iKnownCertCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at KnownCertCount - 1.This property is not available at design time.
Data Type
Integer
KnownCertBytes Property (IMAPClient Class)
Returns raw certificate data in DER format.
Syntax
QByteArray GetKnownCertBytes(int iKnownCertIndex);
Remarks
Returns raw certificate data in DER format.
The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
KnownCertHandle Property (IMAPClient Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetKnownCertHandle(int iKnownCertIndex);
int SetKnownCertHandle(int iKnownCertIndex, qint64 lKnownCertHandle);
Default Value
0
Remarks
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.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.
This property is not available at design time.
Data Type
Long64
KnownCRLCount Property (IMAPClient Class)
The number of records in the KnownCRL arrays.
Syntax
int GetKnownCRLCount();
int SetKnownCRLCount(int iKnownCRLCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at KnownCRLCount - 1.This property is not available at design time.
Data Type
Integer
KnownCRLBytes Property (IMAPClient Class)
Returns raw CRL data in DER format.
Syntax
QByteArray GetKnownCRLBytes(int iKnownCRLIndex);
Remarks
Returns raw CRL data in DER format.
The KnownCRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCRLCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
KnownCRLHandle Property (IMAPClient Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetKnownCRLHandle(int iKnownCRLIndex);
int SetKnownCRLHandle(int iKnownCRLIndex, qint64 lKnownCRLHandle);
Default Value
0
Remarks
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.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The KnownCRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCRLCount property.
This property is not available at design time.
Data Type
Long64
KnownOCSPCount Property (IMAPClient Class)
The number of records in the KnownOCSP arrays.
Syntax
int GetKnownOCSPCount();
int SetKnownOCSPCount(int iKnownOCSPCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at KnownOCSPCount - 1.This property is not available at design time.
Data Type
Integer
KnownOCSPBytes Property (IMAPClient Class)
Buffer containing raw OCSP response data.
Syntax
QByteArray GetKnownOCSPBytes(int iKnownOCSPIndex);
Remarks
Buffer containing raw OCSP response data.
The KnownOCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownOCSPCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
KnownOCSPHandle Property (IMAPClient Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetKnownOCSPHandle(int iKnownOCSPIndex);
int SetKnownOCSPHandle(int iKnownOCSPIndex, qint64 lKnownOCSPHandle);
Default Value
0
Remarks
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.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The KnownOCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownOCSPCount property.
This property is not available at design time.
Data Type
Long64
MailboxInfoCount Property (IMAPClient Class)
The number of records in the MailboxInfo arrays.
Syntax
int GetMailboxInfoCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
- MailboxInfoDelimiter
- MailboxInfoHasChildren
- MailboxInfoHasNoChildren
- MailboxInfoMarked
- MailboxInfoName
- MailboxInfoNoInferiors
- MailboxInfoNoSelect
- MailboxInfoUnmarked
This property is read-only and not available at design time.
Data Type
Integer
MailboxInfoDelimiter Property (IMAPClient Class)
Mailbox hierarchy delimiter.
Syntax
QString GetMailboxInfoDelimiter(int iMailboxInfoIndex);
Default Value
""
Remarks
Mailbox hierarchy delimiter.
The MailboxInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MailboxInfoCount property.
This property is read-only and not available at design time.
Data Type
String
MailboxInfoHasChildren Property (IMAPClient Class)
Specifies whether the mailbox has \\HasChildren attribute specified.
Syntax
bool GetMailboxInfoHasChildren(int iMailboxInfoIndex);
Default Value
false
Remarks
Specifies whether the mailbox has \HasChildren attribute specified.
The MailboxInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MailboxInfoCount property.
This property is read-only and not available at design time.
Data Type
Boolean
MailboxInfoHasNoChildren Property (IMAPClient Class)
Specifies whether the mailbox has \\HasNoChildren attribute specified.
Syntax
bool GetMailboxInfoHasNoChildren(int iMailboxInfoIndex);
Default Value
false
Remarks
Specifies whether the mailbox has \HasNoChildren attribute specified.
The MailboxInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MailboxInfoCount property.
This property is read-only and not available at design time.
Data Type
Boolean
MailboxInfoMarked Property (IMAPClient Class)
Specifies whether the mailbox has \\Marked attribute specified.
Syntax
bool GetMailboxInfoMarked(int iMailboxInfoIndex);
Default Value
false
Remarks
Specifies whether the mailbox has \Marked attribute specified.
The MailboxInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MailboxInfoCount property.
This property is read-only and not available at design time.
Data Type
Boolean
MailboxInfoName Property (IMAPClient Class)
Specifies mailbox name.
Syntax
QString GetMailboxInfoName(int iMailboxInfoIndex);
Default Value
""
Remarks
Specifies mailbox name.
The MailboxInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MailboxInfoCount property.
This property is read-only and not available at design time.
Data Type
String
MailboxInfoNoInferiors Property (IMAPClient Class)
Specifies whether the mailbox has \\NoInferiors attribute specified.
Syntax
bool GetMailboxInfoNoInferiors(int iMailboxInfoIndex);
Default Value
false
Remarks
Specifies whether the mailbox has \NoInferiors attribute specified.
The MailboxInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MailboxInfoCount property.
This property is read-only and not available at design time.
Data Type
Boolean
MailboxInfoNoSelect Property (IMAPClient Class)
Specifies whether the mailbox has \\NoSelect attribute specified.
Syntax
bool GetMailboxInfoNoSelect(int iMailboxInfoIndex);
Default Value
false
Remarks
Specifies whether the mailbox has \NoSelect attribute specified.
The MailboxInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MailboxInfoCount property.
This property is read-only and not available at design time.
Data Type
Boolean
MailboxInfoUnmarked Property (IMAPClient Class)
Specifies whether the mailbox has \\Unmarked attribute specified.
Syntax
bool GetMailboxInfoUnmarked(int iMailboxInfoIndex);
Default Value
false
Remarks
Specifies whether the mailbox has \Unmarked attribute specified.
The MailboxInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MailboxInfoCount property.
This property is read-only and not available at design time.
Data Type
Boolean
MsgAttachmentCount Property (IMAPClient Class)
Returns the number of attachments in this message.
Syntax
int GetMsgAttachmentCount();
Default Value
0
Remarks
Returns the number of attachments in this message.
This property is read-only and not available at design time.
Data Type
Integer
MsgBcc Property (IMAPClient Class)
The contents of the BCC header property.
Syntax
QString GetMsgBcc();
int SetMsgBcc(QString qsMsgBcc);
Default Value
""
Remarks
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.
This property is not available at design time.
Data Type
String
MsgCc Property (IMAPClient Class)
The value of the CC header property.
Syntax
QString GetMsgCc();
int SetMsgCc(QString qsMsgCc);
Default Value
""
Remarks
The value of the CC header field.
The CC field contains the addresses of secondary recipients of the message.
This property is not available at design time.
Data Type
String
MsgComments Property (IMAPClient Class)
Contains additional information about the message body.
Syntax
QString GetMsgComments();
int SetMsgComments(QString qsMsgComments);
Default Value
""
Remarks
Contains additional information about the message body.
This property is not available at design time.
Data Type
String
MsgDate Property (IMAPClient Class)
The date and time when the message entered the mail delivery system.
Syntax
QString GetMsgDate();
int SetMsgDate(QString qsMsgDate);
Default Value
""
Remarks
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.
This property is not available at design time.
Data Type
String
MsgDeliveryReceipt Property (IMAPClient Class)
Enables delivery notification.
Syntax
bool GetMsgDeliveryReceipt();
int SetMsgDeliveryReceipt(bool bMsgDeliveryReceipt);
Default Value
false
Remarks
Enables delivery notification.
This property is not available at design time.
Data Type
Boolean
MsgFrom Property (IMAPClient Class)
Contains the value of the From header property.
Syntax
QString GetMsgFrom();
int SetMsgFrom(QString qsMsgFrom);
Default Value
""
Remarks
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 MsgSender to specify the sender separately.
This property is not available at design time.
Data Type
String
MsgHandle Property (IMAPClient Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetMsgHandle();
int SetMsgHandle(qint64 lMsgHandle);
Default Value
0
Remarks
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.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
This property is not available at design time.
Data Type
Long64
MsgHtmlText Property (IMAPClient Class)
The HTML version of the message.
Syntax
QString GetMsgHtmlText();
int SetMsgHtmlText(QString qsMsgHtmlText);
Default Value
""
Remarks
The HTML version of the message.
This property is not available at design time.
Data Type
String
MsgID Property (IMAPClient Class)
The contents of the Message-ID header property.
Syntax
QString GetMsgID();
int SetMsgID(QString qsMsgID);
Default Value
""
Remarks
The contents of the Message-ID header field.
This field contains a unique identifier that refers to a particular version of this message.
This property is not available at design time.
Data Type
String
MsgInReplyTo Property (IMAPClient Class)
The value of the In-Reply-To header property.
Syntax
QString GetMsgInReplyTo();
int SetMsgInReplyTo(QString qsMsgInReplyTo);
Default Value
""
Remarks
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.
This property is not available at design time.
Data Type
String
MsgKeywords Property (IMAPClient Class)
The value of the Keywords header property.
Syntax
QString GetMsgKeywords();
int SetMsgKeywords(QString qsMsgKeywords);
Default Value
""
Remarks
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.
This property is not available at design time.
Data Type
String
MsgMailer Property (IMAPClient Class)
The name of the software that was used to send the message.
Syntax
QString GetMsgMailer();
Default Value
""
Remarks
The name of the software that was used to send the message.
This property is read-only and not available at design time.
Data Type
String
MsgPlainText Property (IMAPClient Class)
The plain text version of the message.
Syntax
QString GetMsgPlainText();
int SetMsgPlainText(QString qsMsgPlainText);
Default Value
""
Remarks
The plain text version of the message.
This property is not available at design time.
Data Type
String
MsgPriority Property (IMAPClient Class)
Specifies the message priority.
Syntax
int GetMsgPriority();
int SetMsgPriority(int iMsgPriority);
Possible Values
MP_LOWEST(0),
MP_LOW(1),
MP_NORMAL(2),
MP_HIGH(3),
MP_HIGHEST(4)
Default Value
2
Remarks
Specifies the message priority.
Available options:
mpLowest | 0 |
mpLow | 1 |
mpNormal | 2 |
mpHigh | 3 |
mpHighest | 4 |
This property is not available at design time.
Data Type
Integer
MsgReadReceipt Property (IMAPClient Class)
Enables a read notification.
Syntax
bool GetMsgReadReceipt();
int SetMsgReadReceipt(bool bMsgReadReceipt);
Default Value
false
Remarks
Enables a read notification.
This property is not available at design time.
Data Type
Boolean
MsgReferences Property (IMAPClient Class)
The value of the References header property.
Syntax
QString GetMsgReferences();
int SetMsgReferences(QString qsMsgReferences);
Default Value
""
Remarks
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.
This property is not available at design time.
Data Type
String
MsgReplyTo Property (IMAPClient Class)
The value of the Reply-To header property.
Syntax
QString GetMsgReplyTo();
int SetMsgReplyTo(QString qsMsgReplyTo);
Default Value
""
Remarks
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 MsgFrom field.
This property is not available at design time.
Data Type
String
MsgReturnPath Property (IMAPClient Class)
The value of the Return-Path header property.
Syntax
QString GetMsgReturnPath();
int SetMsgReturnPath(QString qsMsgReturnPath);
Default Value
""
Remarks
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.
This property is not available at design time.
Data Type
String
MsgSender Property (IMAPClient Class)
The value of the Sender header property.
Syntax
QString GetMsgSender();
int SetMsgSender(QString qsMsgSender);
Default Value
""
Remarks
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.
This property is not available at design time.
Data Type
String
MsgSendTo Property (IMAPClient Class)
The value of the To header property.
Syntax
QString GetMsgSendTo();
int SetMsgSendTo(QString qsMsgSendTo);
Default Value
""
Remarks
The value of the To header field.
This field specifies the address(es) of the primary recipient(s) of the message.
This property is not available at design time.
Data Type
String
MsgSubject Property (IMAPClient Class)
Contains the subject property of this message.
Syntax
QString GetMsgSubject();
int SetMsgSubject(QString qsMsgSubject);
Default Value
""
Remarks
Contains the subject field of this message.
This property is not available at design time.
Data Type
String
MsgInfoCount Property (IMAPClient Class)
The number of records in the MsgInfo arrays.
Syntax
int GetMsgInfoCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
- MsgInfoDate
- MsgInfoFlags
- MsgInfoFrom
- MsgInfoInternalDate
- MsgInfoPriority
- MsgInfoSentTo
- MsgInfoSize
- MsgInfoSubject
- MsgInfoUID
This property is read-only and not available at design time.
Data Type
Integer
MsgInfoDate Property (IMAPClient Class)
Contains the value of the Date header property.
Syntax
QString GetMsgInfoDate(int iMsgInfoIndex);
Default Value
""
Remarks
Contains the value of the Date header field.
The MsgInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MsgInfoCount property.
This property is read-only and not available at design time.
Data Type
String
MsgInfoFlags Property (IMAPClient Class)
Returns the flags currently set to the mail message.
Syntax
int GetMsgInfoFlags(int iMsgInfoIndex);
Default Value
0
Remarks
Returns the flags currently set to the mail message.
The MsgInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MsgInfoCount property.
This property is read-only and not available at design time.
Data Type
Integer
MsgInfoFrom Property (IMAPClient Class)
Contains the value of the From header property.
Syntax
QString GetMsgInfoFrom(int iMsgInfoIndex);
Default Value
""
Remarks
Contains the value of the From header field.
The MsgInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MsgInfoCount property.
This property is read-only and not available at design time.
Data Type
String
MsgInfoInternalDate Property (IMAPClient Class)
Returns the internal date of the mail message.
Syntax
QString GetMsgInfoInternalDate(int iMsgInfoIndex);
Default Value
""
Remarks
Returns the internal date of the mail message.
The MsgInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MsgInfoCount property.
This property is read-only and not available at design time.
Data Type
String
MsgInfoPriority Property (IMAPClient Class)
Specifies the message priority.
Syntax
int GetMsgInfoPriority(int iMsgInfoIndex);
Possible Values
MP_LOWEST(0),
MP_LOW(1),
MP_NORMAL(2),
MP_HIGH(3),
MP_HIGHEST(4)
Default Value
2
Remarks
Specifies the message priority.
Available options:
mpLowest | 0 |
mpLow | 1 |
mpNormal | 2 |
mpHigh | 3 |
mpHighest | 4 |
The MsgInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MsgInfoCount property.
This property is read-only and not available at design time.
Data Type
Integer
MsgInfoSentTo Property (IMAPClient Class)
Contains the value of the To header property.
Syntax
QString GetMsgInfoSentTo(int iMsgInfoIndex);
Default Value
""
Remarks
Contains the value of the To header field.
The MsgInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MsgInfoCount property.
This property is read-only and not available at design time.
Data Type
String
MsgInfoSize Property (IMAPClient Class)
Returns the size of the message in bytes.
Syntax
qint64 GetMsgInfoSize(int iMsgInfoIndex);
Default Value
0
Remarks
Returns the size of the message in bytes.
The MsgInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MsgInfoCount property.
This property is read-only and not available at design time.
Data Type
Long64
MsgInfoSubject Property (IMAPClient Class)
Contains the value of the Subject header property.
Syntax
QString GetMsgInfoSubject(int iMsgInfoIndex);
Default Value
""
Remarks
Contains the value of the Subject header field.
The MsgInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MsgInfoCount property.
This property is read-only and not available at design time.
Data Type
String
MsgInfoUID Property (IMAPClient Class)
Returns the unique ID of the mail message.
Syntax
int GetMsgInfoUID(int iMsgInfoIndex);
Default Value
0
Remarks
Returns the unique ID of the mail message.
The MsgInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MsgInfoCount property.
This property is read-only and not available at design time.
Data Type
Integer
Password Property (IMAPClient Class)
The authentication password.
Syntax
QString GetPassword();
int SetPassword(QString qsPassword);
Default Value
""
Remarks
Use this property to provide the password for authenticating to the IMAP server.
Data Type
String
ProxyAddress Property (IMAPClient Class)
The IP address of the proxy server.
Syntax
QString GetProxyAddress();
int SetProxyAddress(QString qsProxyAddress);
Default Value
""
Remarks
The IP address of the proxy server.
Data Type
String
ProxyAuthentication Property (IMAPClient Class)
The authentication type used by the proxy server.
Syntax
int GetProxyAuthentication();
int SetProxyAuthentication(int iProxyAuthentication);
Possible Values
PAT_NO_AUTHENTICATION(0),
PAT_BASIC(1),
PAT_DIGEST(2),
PAT_NTLM(3)
Default Value
0
Remarks
The authentication type used by the proxy server.
patNoAuthentication | 0 |
patBasic | 1 |
patDigest | 2 |
patNTLM | 3 |
Data Type
Integer
ProxyPassword Property (IMAPClient Class)
The password to authenticate to the proxy server.
Syntax
QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);
Default Value
""
Remarks
The password to authenticate to the proxy server.
Data Type
String
ProxyPort Property (IMAPClient Class)
The port on the proxy server to connect to.
Syntax
int GetProxyPort();
int SetProxyPort(int iProxyPort);
Default Value
0
Remarks
The port on the proxy server to connect to.
Data Type
Integer
ProxyProxyType Property (IMAPClient Class)
The type of the proxy server.
Syntax
int GetProxyProxyType();
int SetProxyProxyType(int iProxyProxyType);
Possible Values
CPT_NONE(0),
CPT_SOCKS_4(1),
CPT_SOCKS_5(2),
CPT_WEB_TUNNEL(3),
CPT_HTTP(4)
Default Value
0
Remarks
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.
cptNone | 0 |
cptSocks4 | 1 |
cptSocks5 | 2 |
cptWebTunnel | 3 |
cptHTTP | 4 |
Data Type
Integer
ProxyRequestHeaders Property (IMAPClient Class)
Contains HTTP request headers for WebTunnel and HTTP proxy.
Syntax
QString GetProxyRequestHeaders();
int SetProxyRequestHeaders(QString qsProxyRequestHeaders);
Default Value
""
Remarks
Contains HTTP request headers for WebTunnel and HTTP proxy.
Data Type
String
ProxyResponseBody Property (IMAPClient Class)
Contains the HTTP or HTTPS (WebTunnel) proxy response body.
Syntax
QString GetProxyResponseBody();
int SetProxyResponseBody(QString qsProxyResponseBody);
Default Value
""
Remarks
Contains the HTTP or HTTPS (WebTunnel) proxy response body.
Data Type
String
ProxyResponseHeaders Property (IMAPClient Class)
Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.
Syntax
QString GetProxyResponseHeaders();
int SetProxyResponseHeaders(QString qsProxyResponseHeaders);
Default Value
""
Remarks
Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.
Data Type
String
ProxyUseIPv6 Property (IMAPClient Class)
Specifies whether IPv6 should be used when connecting through the proxy.
Syntax
bool GetProxyUseIPv6();
int SetProxyUseIPv6(bool bProxyUseIPv6);
Default Value
false
Remarks
Specifies whether IPv6 should be used when connecting through the proxy.
Data Type
Boolean
ProxyUseProxy Property (IMAPClient Class)
Enables or disables proxy-driven connection.
Syntax
bool GetProxyUseProxy();
int SetProxyUseProxy(bool bProxyUseProxy);
Default Value
false
Remarks
Enables or disables proxy-driven connection.
Data Type
Boolean
ProxyUsername Property (IMAPClient Class)
Specifies the username credential for proxy authentication.
Syntax
QString GetProxyUsername();
int SetProxyUsername(QString qsProxyUsername);
Default Value
""
Remarks
Specifies the username credential for proxy authentication.
Data Type
String
ServerCertCount Property (IMAPClient Class)
The number of records in the ServerCert arrays.
Syntax
int GetServerCertCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
- ServerCertBytes
- ServerCertCAKeyID
- ServerCertFingerprint
- ServerCertHandle
- ServerCertIssuer
- ServerCertIssuerRDN
- ServerCertKeyAlgorithm
- ServerCertKeyBits
- ServerCertKeyFingerprint
- ServerCertKeyUsage
- ServerCertPublicKeyBytes
- ServerCertSelfSigned
- ServerCertSerialNumber
- ServerCertSigAlgorithm
- ServerCertSubject
- ServerCertSubjectKeyID
- ServerCertSubjectRDN
- ServerCertValidFrom
- ServerCertValidTo
This property is read-only and not available at design time.
Data Type
Integer
ServerCertBytes Property (IMAPClient Class)
Returns raw certificate data in DER format.
Syntax
QByteArray GetServerCertBytes(int iServerCertIndex);
Remarks
Returns raw certificate data in DER format.
The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
ServerCertCAKeyID Property (IMAPClient Class)
A unique identifier (fingerprint) of the CA certificate's private key.
Syntax
QByteArray GetServerCertCAKeyID(int iServerCertIndex);
Remarks
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.
The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
ServerCertFingerprint Property (IMAPClient Class)
Contains the fingerprint (a hash imprint) of this certificate.
Syntax
QByteArray GetServerCertFingerprint(int iServerCertIndex);
Remarks
Contains the fingerprint (a hash imprint) of this certificate.
The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
ServerCertHandle Property (IMAPClient Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetServerCertHandle(int iServerCertIndex);
Default Value
0
Remarks
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.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.
This property is read-only and not available at design time.
Data Type
Long64
ServerCertIssuer Property (IMAPClient Class)
The common name of the certificate issuer (CA), typically a company name.
Syntax
QString GetServerCertIssuer(int iServerCertIndex);
Default Value
""
Remarks
The common name of the certificate issuer (CA), typically a company name.
The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.
This property is read-only and not available at design time.
Data Type
String
ServerCertIssuerRDN Property (IMAPClient Class)
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
Syntax
QString GetServerCertIssuerRDN(int iServerCertIndex);
Default Value
""
Remarks
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.
This property is read-only and not available at design time.
Data Type
String
ServerCertKeyAlgorithm Property (IMAPClient Class)
Specifies the public key algorithm of this certificate.
Syntax
QString GetServerCertKeyAlgorithm(int iServerCertIndex);
Default Value
"0"
Remarks
Specifies the public key algorithm of this certificate.
SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | |
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | |
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | |
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA | id-dsa | |
SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | |
SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | |
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | |
SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | |
SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | |
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | |
SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | |
SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | |
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | |
SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | |
SB_CERT_ALGORITHM_EC | id-ecPublicKey | |
SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | |
SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | |
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | |
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | |
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | |
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | |
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | |
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | |
SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | |
SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | |
SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | |
SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | |
SB_CERT_ALGORITHM_EDDSA | id-EdDSA | |
SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig |
The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.
This property is read-only and not available at design time.
Data Type
String
ServerCertKeyBits Property (IMAPClient Class)
Returns the length of the public key.
Syntax
int GetServerCertKeyBits(int iServerCertIndex);
Default Value
0
Remarks
Returns the length of the public key.
The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.
This property is read-only and not available at design time.
Data Type
Integer
ServerCertKeyFingerprint Property (IMAPClient Class)
Returns a fingerprint of the public key contained in the certificate.
Syntax
QByteArray GetServerCertKeyFingerprint(int iServerCertIndex);
Remarks
Returns a fingerprint of the public key contained in the certificate.
The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
ServerCertKeyUsage Property (IMAPClient Class)
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
Syntax
int GetServerCertKeyUsage(int iServerCertIndex);
Default Value
0
Remarks
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:
ckuUnknown | 0x00000 | Unknown key usage |
ckuDigitalSignature | 0x00001 | Digital signature |
ckuNonRepudiation | 0x00002 | Non-repudiation |
ckuKeyEncipherment | 0x00004 | Key encipherment |
ckuDataEncipherment | 0x00008 | Data encipherment |
ckuKeyAgreement | 0x00010 | Key agreement |
ckuKeyCertSign | 0x00020 | Certificate signing |
ckuCRLSign | 0x00040 | Revocation signing |
ckuEncipherOnly | 0x00080 | Encipher only |
ckuDecipherOnly | 0x00100 | Decipher only |
ckuServerAuthentication | 0x00200 | Server authentication |
ckuClientAuthentication | 0x00400 | Client authentication |
ckuCodeSigning | 0x00800 | Code signing |
ckuEmailProtection | 0x01000 | Email protection |
ckuTimeStamping | 0x02000 | Timestamping |
ckuOCSPSigning | 0x04000 | OCSP signing |
ckuSmartCardLogon | 0x08000 | Smartcard logon |
ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication |
ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC |
The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.
This property is read-only and not available at design time.
Data Type
Integer
ServerCertPublicKeyBytes Property (IMAPClient Class)
Contains the certificate's public key in DER format.
Syntax
QByteArray GetServerCertPublicKeyBytes(int iServerCertIndex);
Remarks
Contains the certificate's public key in DER format.
The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
ServerCertSelfSigned Property (IMAPClient Class)
Indicates whether the certificate is self-signed (root) or signed by an external CA.
Syntax
bool GetServerCertSelfSigned(int iServerCertIndex);
Default Value
false
Remarks
Indicates whether the certificate is self-signed (root) or signed by an external CA.
The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.
This property is read-only and not available at design time.
Data Type
Boolean
ServerCertSerialNumber Property (IMAPClient Class)
Returns the certificate's serial number.
Syntax
QByteArray GetServerCertSerialNumber(int iServerCertIndex);
Remarks
Returns the certificate's serial number.
The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
ServerCertSigAlgorithm Property (IMAPClient Class)
Indicates the algorithm that was used by the CA to sign this certificate.
Syntax
QString GetServerCertSigAlgorithm(int iServerCertIndex);
Default Value
""
Remarks
Indicates the algorithm that was used by the CA to sign this certificate.
The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.
This property is read-only and not available at design time.
Data Type
String
ServerCertSubject Property (IMAPClient Class)
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
Syntax
QString GetServerCertSubject(int iServerCertIndex);
Default Value
""
Remarks
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.
This property is read-only and not available at design time.
Data Type
String
ServerCertSubjectKeyID Property (IMAPClient Class)
Contains a unique identifier (fingerprint) of the certificate's private key.
Syntax
QByteArray GetServerCertSubjectKeyID(int iServerCertIndex);
Remarks
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.
The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
ServerCertSubjectRDN Property (IMAPClient Class)
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
Syntax
QString GetServerCertSubjectRDN(int iServerCertIndex);
Default Value
""
Remarks
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.
This property is read-only and not available at design time.
Data Type
String
ServerCertValidFrom Property (IMAPClient Class)
The time point at which the certificate becomes valid, in UTC.
Syntax
QString GetServerCertValidFrom(int iServerCertIndex);
Default Value
""
Remarks
The time point at which the certificate becomes valid, in UTC.
The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.
This property is read-only and not available at design time.
Data Type
String
ServerCertValidTo Property (IMAPClient Class)
The time point at which the certificate expires, in UTC.
Syntax
QString GetServerCertValidTo(int iServerCertIndex);
Default Value
""
Remarks
The time point at which the certificate expires, in UTC.
The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.
This property is read-only and not available at design time.
Data Type
String
ServerInfoCapabilities Property (IMAPClient Class)
Returns the list of server capabilities.
Syntax
QString GetServerInfoCapabilities();
Default Value
""
Remarks
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.
This property is read-only and not available at design time.
Data Type
String
ServerInfoIdleSupported Property (IMAPClient Class)
Indicates whether the IMAP server supports the IDLE command.
Syntax
bool GetServerInfoIdleSupported();
Default Value
false
Remarks
Indicates whether the IMAP server supports the IDLE command.
This property is read-only and not available at design time.
Data Type
Boolean
ServerInfoLoginDisabled Property (IMAPClient Class)
Specifies whether the server forbids login.
Syntax
bool GetServerInfoLoginDisabled();
Default Value
false
Remarks
Specifies whether the server forbids login.
This property is read-only and not available at design time.
Data Type
Boolean
SocketDNSMode Property (IMAPClient Class)
Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system.
Syntax
int GetSocketDNSMode();
int SetSocketDNSMode(int iSocketDNSMode);
Possible Values
DM_AUTO(0),
DM_PLATFORM(1),
DM_OWN(2),
DM_OWN_SECURE(3)
Default Value
0
Remarks
Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.
dmAuto | 0 |
dmPlatform | 1 |
dmOwn | 2 |
dmOwnSecure | 3 |
Data Type
Integer
SocketDNSPort Property (IMAPClient Class)
Specifies the port number to be used for sending queries to the DNS server.
Syntax
int GetSocketDNSPort();
int SetSocketDNSPort(int iSocketDNSPort);
Default Value
0
Remarks
Specifies the port number to be used for sending queries to the DNS server.
Data Type
Integer
SocketDNSQueryTimeout Property (IMAPClient Class)
The timeout (in milliseconds) for each DNS query.
Syntax
int GetSocketDNSQueryTimeout();
int SetSocketDNSQueryTimeout(int iSocketDNSQueryTimeout);
Default Value
0
Remarks
The timeout (in milliseconds) for each DNS query. The value of 0 indicates the infinite timeout.
Data Type
Integer
SocketDNSServers Property (IMAPClient Class)
The addresses of DNS servers to use for address resolution, separated by commas or semicolons.
Syntax
QString GetSocketDNSServers();
int SetSocketDNSServers(QString qsSocketDNSServers);
Default Value
""
Remarks
The addresses of DNS servers to use for address resolution, separated by commas or semicolons.
Data Type
String
SocketDNSTotalTimeout Property (IMAPClient Class)
The timeout (in milliseconds) for the whole resolution process.
Syntax
int GetSocketDNSTotalTimeout();
int SetSocketDNSTotalTimeout(int iSocketDNSTotalTimeout);
Default Value
0
Remarks
The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates the infinite timeout.
Data Type
Integer
SocketIncomingSpeedLimit Property (IMAPClient Class)
The maximum number of bytes to read from the socket, per second.
Syntax
int GetSocketIncomingSpeedLimit();
int SetSocketIncomingSpeedLimit(int iSocketIncomingSpeedLimit);
Default Value
0
Remarks
The maximum number of bytes to read from the socket, per second.
Data Type
Integer
SocketLocalAddress Property (IMAPClient Class)
The local network interface to bind the socket to.
Syntax
QString GetSocketLocalAddress();
int SetSocketLocalAddress(QString qsSocketLocalAddress);
Default Value
""
Remarks
The local network interface to bind the socket to.
Data Type
String
SocketLocalPort Property (IMAPClient Class)
The local port number to bind the socket to.
Syntax
int GetSocketLocalPort();
int SetSocketLocalPort(int iSocketLocalPort);
Default Value
0
Remarks
The local port number to bind the socket to.
Data Type
Integer
SocketOutgoingSpeedLimit Property (IMAPClient Class)
The maximum number of bytes to write to the socket, per second.
Syntax
int GetSocketOutgoingSpeedLimit();
int SetSocketOutgoingSpeedLimit(int iSocketOutgoingSpeedLimit);
Default Value
0
Remarks
The maximum number of bytes to write to the socket, per second.
Data Type
Integer
SocketTimeout Property (IMAPClient Class)
The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
Syntax
int GetSocketTimeout();
int SetSocketTimeout(int iSocketTimeout);
Default Value
60000
Remarks
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).
Data Type
Integer
SocketUseIPv6 Property (IMAPClient Class)
Enables or disables IP protocol version 6.
Syntax
bool GetSocketUseIPv6();
int SetSocketUseIPv6(bool bSocketUseIPv6);
Default Value
false
Remarks
Enables or disables IP protocol version 6.
Data Type
Boolean
TLSAutoValidateCertificates Property (IMAPClient Class)
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
Syntax
bool GetTLSAutoValidateCertificates();
int SetTLSAutoValidateCertificates(bool bTLSAutoValidateCertificates);
Default Value
true
Remarks
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
Data Type
Boolean
TLSBaseConfiguration Property (IMAPClient Class)
Selects the base configuration for the TLS settings.
Syntax
int GetTLSBaseConfiguration();
int SetTLSBaseConfiguration(int iTLSBaseConfiguration);
Possible Values
STPC_DEFAULT(0),
STPC_COMPATIBLE(1),
STPC_COMPREHENSIVE_INSECURE(2),
STPC_HIGHLY_SECURE(3)
Default Value
0
Remarks
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.
stpcDefault | 0 | |
stpcCompatible | 1 | |
stpcComprehensiveInsecure | 2 | |
stpcHighlySecure | 3 |
Data Type
Integer
TLSCiphersuites Property (IMAPClient Class)
A list of ciphersuites separated with commas or semicolons.
Syntax
QString GetTLSCiphersuites();
int SetTLSCiphersuites(QString qsTLSCiphersuites);
Default Value
""
Remarks
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:
- NULL_NULL_NULL
- RSA_NULL_MD5
- RSA_NULL_SHA
- RSA_RC4_MD5
- RSA_RC4_SHA
- RSA_RC2_MD5
- RSA_IDEA_MD5
- RSA_IDEA_SHA
- RSA_DES_MD5
- RSA_DES_SHA
- RSA_3DES_MD5
- RSA_3DES_SHA
- RSA_AES128_SHA
- RSA_AES256_SHA
- DH_DSS_DES_SHA
- DH_DSS_3DES_SHA
- DH_DSS_AES128_SHA
- DH_DSS_AES256_SHA
- DH_RSA_DES_SHA
- DH_RSA_3DES_SHA
- DH_RSA_AES128_SHA
- DH_RSA_AES256_SHA
- DHE_DSS_DES_SHA
- DHE_DSS_3DES_SHA
- DHE_DSS_AES128_SHA
- DHE_DSS_AES256_SHA
- DHE_RSA_DES_SHA
- DHE_RSA_3DES_SHA
- DHE_RSA_AES128_SHA
- DHE_RSA_AES256_SHA
- DH_ANON_RC4_MD5
- DH_ANON_DES_SHA
- DH_ANON_3DES_SHA
- DH_ANON_AES128_SHA
- DH_ANON_AES256_SHA
- RSA_RC2_MD5_EXPORT
- RSA_RC4_MD5_EXPORT
- RSA_DES_SHA_EXPORT
- DH_DSS_DES_SHA_EXPORT
- DH_RSA_DES_SHA_EXPORT
- DHE_DSS_DES_SHA_EXPORT
- DHE_RSA_DES_SHA_EXPORT
- DH_ANON_RC4_MD5_EXPORT
- DH_ANON_DES_SHA_EXPORT
- RSA_CAMELLIA128_SHA
- DH_DSS_CAMELLIA128_SHA
- DH_RSA_CAMELLIA128_SHA
- DHE_DSS_CAMELLIA128_SHA
- DHE_RSA_CAMELLIA128_SHA
- DH_ANON_CAMELLIA128_SHA
- RSA_CAMELLIA256_SHA
- DH_DSS_CAMELLIA256_SHA
- DH_RSA_CAMELLIA256_SHA
- DHE_DSS_CAMELLIA256_SHA
- DHE_RSA_CAMELLIA256_SHA
- DH_ANON_CAMELLIA256_SHA
- PSK_RC4_SHA
- PSK_3DES_SHA
- PSK_AES128_SHA
- PSK_AES256_SHA
- DHE_PSK_RC4_SHA
- DHE_PSK_3DES_SHA
- DHE_PSK_AES128_SHA
- DHE_PSK_AES256_SHA
- RSA_PSK_RC4_SHA
- RSA_PSK_3DES_SHA
- RSA_PSK_AES128_SHA
- RSA_PSK_AES256_SHA
- RSA_SEED_SHA
- DH_DSS_SEED_SHA
- DH_RSA_SEED_SHA
- DHE_DSS_SEED_SHA
- DHE_RSA_SEED_SHA
- DH_ANON_SEED_SHA
- SRP_SHA_3DES_SHA
- SRP_SHA_RSA_3DES_SHA
- SRP_SHA_DSS_3DES_SHA
- SRP_SHA_AES128_SHA
- SRP_SHA_RSA_AES128_SHA
- SRP_SHA_DSS_AES128_SHA
- SRP_SHA_AES256_SHA
- SRP_SHA_RSA_AES256_SHA
- SRP_SHA_DSS_AES256_SHA
- ECDH_ECDSA_NULL_SHA
- ECDH_ECDSA_RC4_SHA
- ECDH_ECDSA_3DES_SHA
- ECDH_ECDSA_AES128_SHA
- ECDH_ECDSA_AES256_SHA
- ECDHE_ECDSA_NULL_SHA
- ECDHE_ECDSA_RC4_SHA
- ECDHE_ECDSA_3DES_SHA
- ECDHE_ECDSA_AES128_SHA
- ECDHE_ECDSA_AES256_SHA
- ECDH_RSA_NULL_SHA
- ECDH_RSA_RC4_SHA
- ECDH_RSA_3DES_SHA
- ECDH_RSA_AES128_SHA
- ECDH_RSA_AES256_SHA
- ECDHE_RSA_NULL_SHA
- ECDHE_RSA_RC4_SHA
- ECDHE_RSA_3DES_SHA
- ECDHE_RSA_AES128_SHA
- ECDHE_RSA_AES256_SHA
- ECDH_ANON_NULL_SHA
- ECDH_ANON_RC4_SHA
- ECDH_ANON_3DES_SHA
- ECDH_ANON_AES128_SHA
- ECDH_ANON_AES256_SHA
- RSA_NULL_SHA256
- RSA_AES128_SHA256
- RSA_AES256_SHA256
- DH_DSS_AES128_SHA256
- DH_RSA_AES128_SHA256
- DHE_DSS_AES128_SHA256
- DHE_RSA_AES128_SHA256
- DH_DSS_AES256_SHA256
- DH_RSA_AES256_SHA256
- DHE_DSS_AES256_SHA256
- DHE_RSA_AES256_SHA256
- DH_ANON_AES128_SHA256
- DH_ANON_AES256_SHA256
- RSA_AES128_GCM_SHA256
- RSA_AES256_GCM_SHA384
- DHE_RSA_AES128_GCM_SHA256
- DHE_RSA_AES256_GCM_SHA384
- DH_RSA_AES128_GCM_SHA256
- DH_RSA_AES256_GCM_SHA384
- DHE_DSS_AES128_GCM_SHA256
- DHE_DSS_AES256_GCM_SHA384
- DH_DSS_AES128_GCM_SHA256
- DH_DSS_AES256_GCM_SHA384
- DH_ANON_AES128_GCM_SHA256
- DH_ANON_AES256_GCM_SHA384
- ECDHE_ECDSA_AES128_SHA256
- ECDHE_ECDSA_AES256_SHA384
- ECDH_ECDSA_AES128_SHA256
- ECDH_ECDSA_AES256_SHA384
- ECDHE_RSA_AES128_SHA256
- ECDHE_RSA_AES256_SHA384
- ECDH_RSA_AES128_SHA256
- ECDH_RSA_AES256_SHA384
- ECDHE_ECDSA_AES128_GCM_SHA256
- ECDHE_ECDSA_AES256_GCM_SHA384
- ECDH_ECDSA_AES128_GCM_SHA256
- ECDH_ECDSA_AES256_GCM_SHA384
- ECDHE_RSA_AES128_GCM_SHA256
- ECDHE_RSA_AES256_GCM_SHA384
- ECDH_RSA_AES128_GCM_SHA256
- ECDH_RSA_AES256_GCM_SHA384
- PSK_AES128_GCM_SHA256
- PSK_AES256_GCM_SHA384
- DHE_PSK_AES128_GCM_SHA256
- DHE_PSK_AES256_GCM_SHA384
- RSA_PSK_AES128_GCM_SHA256
- RSA_PSK_AES256_GCM_SHA384
- PSK_AES128_SHA256
- PSK_AES256_SHA384
- PSK_NULL_SHA256
- PSK_NULL_SHA384
- DHE_PSK_AES128_SHA256
- DHE_PSK_AES256_SHA384
- DHE_PSK_NULL_SHA256
- DHE_PSK_NULL_SHA384
- RSA_PSK_AES128_SHA256
- RSA_PSK_AES256_SHA384
- RSA_PSK_NULL_SHA256
- RSA_PSK_NULL_SHA384
- RSA_CAMELLIA128_SHA256
- DH_DSS_CAMELLIA128_SHA256
- DH_RSA_CAMELLIA128_SHA256
- DHE_DSS_CAMELLIA128_SHA256
- DHE_RSA_CAMELLIA128_SHA256
- DH_ANON_CAMELLIA128_SHA256
- RSA_CAMELLIA256_SHA256
- DH_DSS_CAMELLIA256_SHA256
- DH_RSA_CAMELLIA256_SHA256
- DHE_DSS_CAMELLIA256_SHA256
- DHE_RSA_CAMELLIA256_SHA256
- DH_ANON_CAMELLIA256_SHA256
- ECDHE_ECDSA_CAMELLIA128_SHA256
- ECDHE_ECDSA_CAMELLIA256_SHA384
- ECDH_ECDSA_CAMELLIA128_SHA256
- ECDH_ECDSA_CAMELLIA256_SHA384
- ECDHE_RSA_CAMELLIA128_SHA256
- ECDHE_RSA_CAMELLIA256_SHA384
- ECDH_RSA_CAMELLIA128_SHA256
- ECDH_RSA_CAMELLIA256_SHA384
- RSA_CAMELLIA128_GCM_SHA256
- RSA_CAMELLIA256_GCM_SHA384
- DHE_RSA_CAMELLIA128_GCM_SHA256
- DHE_RSA_CAMELLIA256_GCM_SHA384
- DH_RSA_CAMELLIA128_GCM_SHA256
- DH_RSA_CAMELLIA256_GCM_SHA384
- DHE_DSS_CAMELLIA128_GCM_SHA256
- DHE_DSS_CAMELLIA256_GCM_SHA384
- DH_DSS_CAMELLIA128_GCM_SHA256
- DH_DSS_CAMELLIA256_GCM_SHA384
- DH_anon_CAMELLIA128_GCM_SHA256
- DH_anon_CAMELLIA256_GCM_SHA384
- ECDHE_ECDSA_CAMELLIA128_GCM_SHA256
- ECDHE_ECDSA_CAMELLIA256_GCM_SHA384
- ECDH_ECDSA_CAMELLIA128_GCM_SHA256
- ECDH_ECDSA_CAMELLIA256_GCM_SHA384
- ECDHE_RSA_CAMELLIA128_GCM_SHA256
- ECDHE_RSA_CAMELLIA256_GCM_SHA384
- ECDH_RSA_CAMELLIA128_GCM_SHA256
- ECDH_RSA_CAMELLIA256_GCM_SHA384
- PSK_CAMELLIA128_GCM_SHA256
- PSK_CAMELLIA256_GCM_SHA384
- DHE_PSK_CAMELLIA128_GCM_SHA256
- DHE_PSK_CAMELLIA256_GCM_SHA384
- RSA_PSK_CAMELLIA128_GCM_SHA256
- RSA_PSK_CAMELLIA256_GCM_SHA384
- PSK_CAMELLIA128_SHA256
- PSK_CAMELLIA256_SHA384
- DHE_PSK_CAMELLIA128_SHA256
- DHE_PSK_CAMELLIA256_SHA384
- RSA_PSK_CAMELLIA128_SHA256
- RSA_PSK_CAMELLIA256_SHA384
- ECDHE_PSK_CAMELLIA128_SHA256
- ECDHE_PSK_CAMELLIA256_SHA384
- ECDHE_PSK_RC4_SHA
- ECDHE_PSK_3DES_SHA
- ECDHE_PSK_AES128_SHA
- ECDHE_PSK_AES256_SHA
- ECDHE_PSK_AES128_SHA256
- ECDHE_PSK_AES256_SHA384
- ECDHE_PSK_NULL_SHA
- ECDHE_PSK_NULL_SHA256
- ECDHE_PSK_NULL_SHA384
- ECDHE_RSA_CHACHA20_POLY1305_SHA256
- ECDHE_ECDSA_CHACHA20_POLY1305_SHA256
- DHE_RSA_CHACHA20_POLY1305_SHA256
- PSK_CHACHA20_POLY1305_SHA256
- ECDHE_PSK_CHACHA20_POLY1305_SHA256
- DHE_PSK_CHACHA20_POLY1305_SHA256
- RSA_PSK_CHACHA20_POLY1305_SHA256
- AES128_GCM_SHA256
- AES256_GCM_SHA384
- CHACHA20_POLY1305_SHA256
- AES128_CCM_SHA256
- AES128_CCM8_SHA256
Data Type
String
TLSECCurves Property (IMAPClient Class)
Defines the elliptic curves to enable.
Syntax
QString GetTLSECCurves();
int SetTLSECCurves(QString qsTLSECCurves);
Default Value
""
Remarks
Defines the elliptic curves to enable.
Data Type
String
TLSExtensions Property (IMAPClient Class)
Provides access to TLS extensions.
Syntax
QString GetTLSExtensions();
int SetTLSExtensions(QString qsTLSExtensions);
Default Value
""
Remarks
Provides access to TLS extensions.
Data Type
String
TLSForceResumeIfDestinationChanges Property (IMAPClient Class)
Whether to force TLS session resumption when the destination address changes.
Syntax
bool GetTLSForceResumeIfDestinationChanges();
int SetTLSForceResumeIfDestinationChanges(bool bTLSForceResumeIfDestinationChanges);
Default Value
false
Remarks
Whether to force TLS session resumption when the destination address changes.
Data Type
Boolean
TLSPreSharedIdentity Property (IMAPClient Class)
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
Syntax
QString GetTLSPreSharedIdentity();
int SetTLSPreSharedIdentity(QString qsTLSPreSharedIdentity);
Default Value
""
Remarks
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
This property is not available at design time.
Data Type
String
TLSPreSharedKey Property (IMAPClient Class)
Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
Syntax
QString GetTLSPreSharedKey();
int SetTLSPreSharedKey(QString qsTLSPreSharedKey);
Default Value
""
Remarks
Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
This property is not available at design time.
Data Type
String
TLSPreSharedKeyCiphersuite Property (IMAPClient Class)
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
Syntax
QString GetTLSPreSharedKeyCiphersuite();
int SetTLSPreSharedKeyCiphersuite(QString qsTLSPreSharedKeyCiphersuite);
Default Value
""
Remarks
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
Data Type
String
TLSRenegotiationAttackPreventionMode Property (IMAPClient Class)
Selects renegotiation attack prevention mechanism.
Syntax
int GetTLSRenegotiationAttackPreventionMode();
int SetTLSRenegotiationAttackPreventionMode(int iTLSRenegotiationAttackPreventionMode);
Possible Values
CRAPM_COMPATIBLE(0),
CRAPM_STRICT(1),
CRAPM_AUTO(2)
Default Value
0
Remarks
Selects renegotiation attack prevention mechanism.
The following options are available:
crapmCompatible | 0 | TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled). |
crapmStrict | 1 | Renegotiation attack prevention is enabled and enforced. |
crapmAuto | 2 | Automatically choose whether to enable or disable renegotiation attack prevention. |
Data Type
Integer
TLSRevocationCheck Property (IMAPClient Class)
Specifies the kind(s) of revocation check to perform.
Syntax
int GetTLSRevocationCheck();
int SetTLSRevocationCheck(int iTLSRevocationCheck);
Possible Values
CRC_NONE(0),
CRC_AUTO(1),
CRC_ALL_CRL(2),
CRC_ALL_OCSP(3),
CRC_ALL_CRLAND_OCSP(4),
CRC_ANY_CRL(5),
CRC_ANY_OCSP(6),
CRC_ANY_CRLOR_OCSP(7),
CRC_ANY_OCSPOR_CRL(8)
Default Value
1
Remarks
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.
crcNone (0) | No revocation checking |
crcAuto (1) | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. |
crcAllCRL (2) | Check all provided CRL endpoints for all chain certificates. |
crcAllOCSP (3) | Check all provided OCSP endpoints for all chain certificates. |
crcAllCRLAndOCSP (4) | Check all CRL and OCSP endpoints for all chain certificates. |
crcAnyCRL (5) | At least one CRL check for every certificate in the chain must succeed. |
crcAnyOCSP (6) | At least one OCSP check for every certificate in the chain must succeed. |
crcAnyCRLOrOCSP (7) | At least one CRL or OCSP check for every certificate in the chain must succeed. CRL endpoints are checked first. |
crcAnyOCSPOrCRL (8) | At least one CRL or OCSP check for every certificate in the chain must succeed. OCSP endpoints are checked first. |
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.
This property is not available at design time.
Data Type
Integer
TLSSSLOptions Property (IMAPClient Class)
Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size.
Syntax
int GetTLSSSLOptions();
int SetTLSSSLOptions(int iTLSSSLOptions);
Default Value
16
Remarks
Various SSL (TLS) protocol options, set of
cssloExpectShutdownMessage | 0x001 | Wait for the close-notify message when shutting down the connection |
cssloOpenSSLDTLSWorkaround | 0x002 | (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions |
cssloDisableKexLengthAlignment | 0x004 | Do not align the client-side PMS by the RSA modulus size. It is unlikely that you will ever need to adjust it. |
cssloForceUseOfClientCertHashAlg | 0x008 | Enforce use of client certificate hash algorithm. It is unlikely that you will ever need to adjust it. |
cssloAutoAddServerNameExtension | 0x010 | Automatically add server name extension when known |
cssloAcceptTrustedSRPPrimesOnly | 0x020 | Accept trusted SRP primes only |
cssloDisableSignatureAlgorithmsExtension | 0x040 | Disable (not send) signature algorithms extension. It is unlikely that you will ever need to adjust it. |
cssloIntolerateHigherProtocolVersions | 0x080 | (server option) Do not allow fallback from TLS versions higher than currently enabled |
cssloStickToPrefCertHashAlg | 0x100 | Stick to preferred certificate hash algorithms |
cssloNoImplicitTLS12Fallback | 0x200 | Disable implicit TLS 1.3 to 1.2 fallbacks |
cssloUseHandshakeBatches | 0x400 | Send handshake message as large batches rather than individually |
Data Type
Integer
TLSTLSMode Property (IMAPClient Class)
Specifies the TLS mode to use.
Syntax
int GetTLSTLSMode();
int SetTLSTLSMode(int iTLSTLSMode);
Possible Values
SM_DEFAULT(0),
SM_NO_TLS(1),
SM_EXPLICIT_TLS(2),
SM_IMPLICIT_TLS(3),
SM_MIXED_TLS(4)
Default Value
0
Remarks
Specifies the TLS mode to use.
smDefault | 0 | |
smNoTLS | 1 | Do not use TLS |
smExplicitTLS | 2 | Connect to the server without any encryption and then request an SSL session. |
smImplicitTLS | 3 | Connect to the specified port, and establish the SSL session at once. |
smMixedTLS | 4 | Connect to the specified port, and establish the SSL session at once, allow plain data. |
Data Type
Integer
TLSUseExtendedMasterSecret Property (IMAPClient Class)
Enables Extended Master Secret Extension, as defined in RFC 7627.
Syntax
bool GetTLSUseExtendedMasterSecret();
int SetTLSUseExtendedMasterSecret(bool bTLSUseExtendedMasterSecret);
Default Value
false
Remarks
Enables Extended Master Secret Extension, as defined in RFC 7627.
Data Type
Boolean
TLSUseSessionResumption Property (IMAPClient Class)
Enables or disables TLS session resumption capability.
Syntax
bool GetTLSUseSessionResumption();
int SetTLSUseSessionResumption(bool bTLSUseSessionResumption);
Default Value
false
Remarks
Enables or disables TLS session resumption capability.
Data Type
Boolean
TLSVersions Property (IMAPClient Class)
Th SSL/TLS versions to enable by default.
Syntax
int GetTLSVersions();
int SetTLSVersions(int iTLSVersions);
Default Value
16
Remarks
Th SSL/TLS versions to enable by default.
csbSSL2 | 0x01 | SSL 2 |
csbSSL3 | 0x02 | SSL 3 |
csbTLS1 | 0x04 | TLS 1.0 |
csbTLS11 | 0x08 | TLS 1.1 |
csbTLS12 | 0x10 | TLS 1.2 |
csbTLS13 | 0x20 | TLS 1.3 |
Data Type
Integer
TrustedCertCount Property (IMAPClient Class)
The number of records in the TrustedCert arrays.
Syntax
int GetTrustedCertCount();
int SetTrustedCertCount(int iTrustedCertCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at TrustedCertCount - 1.This property is not available at design time.
Data Type
Integer
TrustedCertBytes Property (IMAPClient Class)
Returns raw certificate data in DER format.
Syntax
QByteArray GetTrustedCertBytes(int iTrustedCertIndex);
Remarks
Returns raw certificate data in DER format.
The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
TrustedCertHandle Property (IMAPClient Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetTrustedCertHandle(int iTrustedCertIndex);
int SetTrustedCertHandle(int iTrustedCertIndex, qint64 lTrustedCertHandle);
Default Value
0
Remarks
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.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.
This property is not available at design time.
Data Type
Long64
Username Property (IMAPClient Class)
The authentication username.
Syntax
QString GetUsername();
int SetUsername(QString qsUsername);
Default Value
""
Remarks
Use this property to provide the username for authenticating to the IMAP server.
Data Type
String
CloseMailbox Method (IMAPClient Class)
Closes the current mailbox.
Syntax
int CloseMailbox();
Remarks
Use this method to close the CurrentMailbox.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Config Method (IMAPClient Class)
Sets or retrieves a configuration setting.
Syntax
QString Config(const QString& qsConfigurationString);
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.
Error Handling
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
Connect Method (IMAPClient Class)
Establishes a connection to the IMAP server.
Syntax
int Connect(const QString& qsAddress, int iPort);
Remarks
Use this method to establish a connection to the IMAP server at Address and Port.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
CopyMessage Method (IMAPClient Class)
Copies a message to another mailbox.
Syntax
int CopyMessage(int iUID, const QString& qsMailboxName);
Remarks
Copies a message specified by its UID to another mailbox.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
CreateMailbox Method (IMAPClient Class)
Creates a new mailbox.
Syntax
int CreateMailbox(const QString& qsName);
Remarks
Call this method to create a new mailbox, providing the name via the Name parameter.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
DeleteMailbox Method (IMAPClient Class)
Deletes an existing mailbox.
Syntax
int DeleteMailbox(const QString& qsName);
Remarks
Call this method to delete a mailbox.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Disconnect Method (IMAPClient Class)
Closes connection to the IMAP server.
Syntax
int Disconnect();
Remarks
Call this method to gracefully terminate the connection.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
DoAction Method (IMAPClient Class)
Performs an additional action.
Syntax
QString DoAction(const QString& qsActionID, const QString& qsActionParams);
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;....
Error Handling
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
ExamineMailbox Method (IMAPClient Class)
Selects the mailbox in read-only mode.
Syntax
int ExamineMailbox(const QString& qsName);
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.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
GetMailboxStatus Method (IMAPClient Class)
Requests a mailbox status.
Syntax
int GetMailboxStatus(const QString& qsName);
Remarks
Requests the status of the specified mailbox and returns it using MailboxStatus event.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
ListAllMessages Method (IMAPClient Class)
Queries a list of messages available in CurrentMailbox on the server.
Syntax
int ListAllMessages();
Remarks
Call this method to request a list of messages available in the current mailbox.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
ListDeletedMessages Method (IMAPClient Class)
Queries a list of deleted messages in the current mailbox on the server.
Syntax
int ListDeletedMessages();
Remarks
Call this method to enumerate deleted messages (i.e. those having Deleted flag set) in CurrentMailbox.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
ListMailboxes Method (IMAPClient Class)
Queries a list of mailboxes available on the server.
Syntax
int 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.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
ListNewMessages Method (IMAPClient Class)
Queries a list of new messages available in the current mailbox on the mail server.
Syntax
int ListNewMessages();
Remarks
Retrieves a list of new messages (i.e. those having Recent flag set and not having Seen flag set) present in CurrentMailbox.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
ListRecentMessages Method (IMAPClient Class)
Queries a list of recent messages available in the current mailbox on the server.
Syntax
int ListRecentMessages();
Remarks
Retrieves a list of recent messages (i.e. those having Recent flag set) present in CurrentMailbox.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
ListUnseenMessages Method (IMAPClient Class)
Queries a list of unseen messages available in the current mailbox on the server.
Syntax
int ListUnseenMessages();
Remarks
Requests a list of unseen messages (i.e. not having Seen flag set) present in CurrentMailbox.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
MarkMessageDeleted Method (IMAPClient Class)
Sets a Deleted flag to the message.
Syntax
int MarkMessageDeleted(int iUID);
Remarks
Use this method to mark a message as deleted, then call PurgeMessages to remove all the marked messages from the server.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
MarkMessageSeen Method (IMAPClient Class)
Sets a Seen flag to the message.
Syntax
int MarkMessageSeen(int iUID);
Remarks
Use this method to mark a message as seen.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Ping Method (IMAPClient Class)
Sends a NOOP command to the IMAP server.
Syntax
int Ping();
Remarks
This method sends a NOOP command to the server, effectively pinging the server and keeping the connection alive.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
PostBytes Method (IMAPClient Class)
Uploads an e-mail message stored in a byte array.
Syntax
int PostBytes(QByteArray qbaBytes, int iFlags, const QString& qsInternalDate);
Remarks
Use this method to send a message stored in a byte array specified by Bytes.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
PostFile Method (IMAPClient Class)
Uploads a message stored in a file to the current mailbox on the IMAP server.
Syntax
int PostFile(const QString& qsFilename, int iFlags, const QString& qsInternalDate);
Remarks
Use this method to upload an e-mail message stored in a file to CurrentMailbox.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
PostMessage Method (IMAPClient Class)
Uploads a pre-built message to the current mailbox on the IMAP server.
Syntax
int PostMessage(int iFlags, const QString& qsInternalDate);
Remarks
Use this message to upload Message to CurrentMailbox.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
PurgeMessages Method (IMAPClient Class)
Permanently removes all deleted messages from the current mailbox.
Syntax
int PurgeMessages();
Remarks
Use this method to permanently remove all messages in CurrentMailbox marked with the Deleted flag.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
ReceiveBytes Method (IMAPClient Class)
Downloads a message to a byte array.
Syntax
QByteArray ReceiveBytes(int iUID);
Remarks
Use this method to download a server-side message to a byte array.
Error Handling
This method returns a Binary String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
ReceiveFile Method (IMAPClient Class)
Downloads a message to a file.
Syntax
int ReceiveFile(int iUID, const QString& qsFilename);
Remarks
Use this method to download a server-side message to a local file.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
ReceiveMessage Method (IMAPClient Class)
Downloads a message.
Syntax
int ReceiveMessage(int iUID);
Remarks
Use this method to download a server-side message to the Message object.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
RefreshMailbox Method (IMAPClient Class)
Refreshes the state info of the current mailbox.
Syntax
int RefreshMailbox();
Remarks
Use this method to refresh the CurrentMailbox info.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
RenameMailbox Method (IMAPClient Class)
Renames an existing mailbox.
Syntax
int RenameMailbox(const QString& qsName, const QString& qsNewName);
Remarks
Use this method to rename an existing mailbox from Name to NewName.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SelectMailbox Method (IMAPClient Class)
Selects the specified mailbox.
Syntax
int SelectMailbox(const QString& qsName);
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.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
UpdateMessage Method (IMAPClient Class)
Alters flags assotiated with a message in the current mailbox on the IMAP server.
Syntax
int UpdateMessage(int iUID, int iSetFlags, int iClearFlags);
Remarks
Use this method to alter flags associated with a UID message in CurrentMailbox.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
BeforeAuth Event (IMAPClient Class)
Fires before the authentication starts.
Syntax
class IMAPClientBeforeAuthEventParams { public: int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void BeforeAuth(IMAPClientBeforeAuthEventParams *e);
// Or, subclass IMAPClient and override this emitter function. virtual int FireBeforeAuth(IMAPClientBeforeAuthEventParams *e) {...}
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 Class)
Fires when the server's TLS certificate has to be validated.
Syntax
class IMAPClientCertificateValidateEventParams { public: const QString &Address(); bool Accept(); void SetAccept(bool bAccept); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void CertificateValidate(IMAPClientCertificateValidateEventParams *e);
// Or, subclass IMAPClient and override this emitter function. virtual int FireCertificateValidate(IMAPClientCertificateValidateEventParams *e) {...}
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 Class)
Reports a command sent to the server.
Syntax
class IMAPClientCommandEventParams { public: const QString &Cmd(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Command(IMAPClientCommandEventParams *e);
// Or, subclass IMAPClient and override this emitter function. virtual int FireCommand(IMAPClientCommandEventParams *e) {...}
Remarks
The class fires this event whenever it sends an IMAP command to the server. Use CommandReply and CommandReplyData to track the server's responses.
CommandData Event (IMAPClient Class)
Returns the data that accompanies the command.
Syntax
class IMAPClientCommandDataEventParams { public: const QString &Cmd(); const QString &Data(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void CommandData(IMAPClientCommandDataEventParams *e);
// Or, subclass IMAPClient and override this emitter function. virtual int FireCommandData(IMAPClientCommandDataEventParams *e) {...}
Remarks
Subscribe to this event to access data accompanying the outgoing commands.
CommandReply Event (IMAPClient Class)
Reports the receipt of a reply to a command.
Syntax
class IMAPClientCommandReplyEventParams { public: const QString &Cmd(); const QString &Reply(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void CommandReply(IMAPClientCommandReplyEventParams *e);
// Or, subclass IMAPClient and override this emitter function. virtual int FireCommandReply(IMAPClientCommandReplyEventParams *e) {...}
Remarks
Use this event to track command replies sent in by the server. Use Command to track the commands sent out by the client, and CommandReplyData to access the reply data for commands that assume it.
CommandReplyData Event (IMAPClient Class)
Returns the data that accompanies a reply to a command.
Syntax
class IMAPClientCommandReplyDataEventParams { public: const QString &Cmd(); const QString &Data(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void CommandReplyData(IMAPClientCommandReplyDataEventParams *e);
// Or, subclass IMAPClient and override this emitter function. virtual int FireCommandReplyData(IMAPClientCommandReplyDataEventParams *e) {...}
Remarks
Subscribe to this event to access data accompanying incoming command replies.
Error Event (IMAPClient Class)
Provides information about errors during SMTP operations.
Syntax
class IMAPClientErrorEventParams { public: int ErrorCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Error(IMAPClientErrorEventParams *e);
// Or, subclass IMAPClient and override this emitter function. virtual int FireError(IMAPClientErrorEventParams *e) {...}
Remarks
This event is fired in case of exceptional conditions occured during SMTP operations.
ErrorCode contains an error code and Description contains a textual description of the error.
MailboxStatus Event (IMAPClient Class)
Reports the mailbox status returned from the server.
Syntax
class IMAPClientMailboxStatusEventParams { public: const QString &Name(); int TotalMessages(); int RecentMessages(); int UnseenMessages(); int NextUID(); int UIDValidity(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void MailboxStatus(IMAPClientMailboxStatusEventParams *e);
// Or, subclass IMAPClient and override this emitter function. virtual int FireMailboxStatus(IMAPClientMailboxStatusEventParams *e) {...}
Remarks
Subscribe to this event to be notified of mailbox status as returned by the IMAP server.
Notification Event (IMAPClient Class)
This event notifies the application about an underlying control flow event.
Syntax
class IMAPClientNotificationEventParams { public: const QString &EventID(); const QString &EventParam(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Notification(IMAPClientNotificationEventParams *e);
// Or, subclass IMAPClient and override this emitter function. virtual int FireNotification(IMAPClientNotificationEventParams *e) {...}
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 Class)
Reports the progress of the data transfer operation.
Syntax
class IMAPClientProgressEventParams { public: qint64 Total(); qint64 Current(); bool Cancel(); void SetCancel(bool bCancel); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Progress(IMAPClientProgressEventParams *e);
// Or, subclass IMAPClient and override this emitter function. virtual int FireProgress(IMAPClientProgressEventParams *e) {...}
Remarks
The class fires this event repeatedly to report the progress of the data transfer operation.
TLSEstablished Event (IMAPClient Class)
TBD.
Syntax
class IMAPClientTLSEstablishedEventParams { public: int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSEstablished(IMAPClientTLSEstablishedEventParams *e);
// Or, subclass IMAPClient and override this emitter function. virtual int FireTLSEstablished(IMAPClientTLSEstablishedEventParams *e) {...}
Remarks
TBD
TLSHandshake Event (IMAPClient Class)
TBD.
Syntax
class IMAPClientTLSHandshakeEventParams { public: int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSHandshake(IMAPClientTLSHandshakeEventParams *e);
// Or, subclass IMAPClient and override this emitter function. virtual int FireTLSHandshake(IMAPClientTLSHandshakeEventParams *e) {...}
Remarks
TBD
TLSPSK Event (IMAPClient Class)
TBD.
Syntax
class IMAPClientTLSPSKEventParams { public: const QString &Hint(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSPSK(IMAPClientTLSPSKEventParams *e);
// Or, subclass IMAPClient and override this emitter function. virtual int FireTLSPSK(IMAPClientTLSPSKEventParams *e) {...}
Remarks
TBD
TLSShutdown Event (IMAPClient Class)
TBD.
Syntax
class IMAPClientTLSShutdownEventParams { public: int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSShutdown(IMAPClientTLSShutdownEventParams *e);
// Or, subclass IMAPClient and override this emitter function. virtual int FireTLSShutdown(IMAPClientTLSShutdownEventParams *e) {...}
Remarks
TBD
Configuration Settings (IMAPClient Class)
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.IMAPClient 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 Class)
IMAPClient Errors
1048577 Invalid parameter value (SB_ERROR_INVALID_PARAMETER) | |
1048578 Class is configured incorrectly (SB_ERROR_INVALID_SETUP) | |
1048579 Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE) | |
1048580 Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE) | |
1048581 Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY) | |
1048581 Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) |