IMAPClient Class

Properties   Methods   Events   Config 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.

Method List

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

Event List

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

Config Settings

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

BlockedCertCount Property (IMAPClient Class)

The number of records in the BlockedCert arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetBlockedCertCount();
int SetBlockedCertCount(int iBlockedCertCount);

Unicode (Windows)
INT GetBlockedCertCount();
INT SetBlockedCertCount(INT iBlockedCertCount);

int secureblackbox_imapclient_getblockedcertcount(void* lpObj);
int secureblackbox_imapclient_setblockedcertcount(void* lpObj, int iBlockedCertCount);

int GetBlockedCertCount();
int SetBlockedCertCount(int iBlockedCertCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• BlockedCertBytes
• BlockedCertHandle

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 the raw certificate data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetBlockedCertBytes(int iBlockedCertIndex, char* &lpBlockedCertBytes, int &lenBlockedCertBytes);

Unicode (Windows)
INT GetBlockedCertBytes(INT iBlockedCertIndex, LPSTR &lpBlockedCertBytes, INT &lenBlockedCertBytes);

int secureblackbox_imapclient_getblockedcertbytes(void* lpObj, int blockedcertindex, char** lpBlockedCertBytes, int* lenBlockedCertBytes);

QByteArray GetBlockedCertBytes(int iBlockedCertIndex);

Remarks

Returns the 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

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetBlockedCertHandle(int iBlockedCertIndex);
int SetBlockedCertHandle(int iBlockedCertIndex, int64 lBlockedCertHandle);

Unicode (Windows)
LONG64 GetBlockedCertHandle(INT iBlockedCertIndex);
INT SetBlockedCertHandle(INT iBlockedCertIndex, LONG64 lBlockedCertHandle);

int64 secureblackbox_imapclient_getblockedcerthandle(void* lpObj, int blockedcertindex);
int secureblackbox_imapclient_setblockedcerthandle(void* lpObj, int blockedcertindex, int64 lBlockedCertHandle);

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.

 
 Copy
  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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetClientCertCount();
int SetClientCertCount(int iClientCertCount);

Unicode (Windows)
INT GetClientCertCount();
INT SetClientCertCount(INT iClientCertCount);

int secureblackbox_imapclient_getclientcertcount(void* lpObj);
int secureblackbox_imapclient_setclientcertcount(void* lpObj, int iClientCertCount);

int GetClientCertCount();
int SetClientCertCount(int iClientCertCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• ClientCertBytes
• ClientCertHandle

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 the raw certificate data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetClientCertBytes(int iClientCertIndex, char* &lpClientCertBytes, int &lenClientCertBytes);

Unicode (Windows)
INT GetClientCertBytes(INT iClientCertIndex, LPSTR &lpClientCertBytes, INT &lenClientCertBytes);

int secureblackbox_imapclient_getclientcertbytes(void* lpObj, int clientcertindex, char** lpClientCertBytes, int* lenClientCertBytes);

QByteArray GetClientCertBytes(int iClientCertIndex);

Remarks

Returns the 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

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetClientCertHandle(int iClientCertIndex);
int SetClientCertHandle(int iClientCertIndex, int64 lClientCertHandle);

Unicode (Windows)
LONG64 GetClientCertHandle(INT iClientCertIndex);
INT SetClientCertHandle(INT iClientCertIndex, LONG64 lClientCertHandle);

int64 secureblackbox_imapclient_getclientcerthandle(void* lpObj, int clientcertindex);
int secureblackbox_imapclient_setclientcerthandle(void* lpObj, int clientcertindex, int64 lClientCertHandle);

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.

 
 Copy
  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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoAEADCipher();

Unicode (Windows)
BOOL GetConnInfoAEADCipher();

int secureblackbox_imapclient_getconninfoaeadcipher(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoChainValidationDetails();

Unicode (Windows)
INT GetConnInfoChainValidationDetails();

int secureblackbox_imapclient_getconninfochainvalidationdetails(void* lpObj);

int GetConnInfoChainValidationDetails();

Default Value

0

Remarks

The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result.

Returns a bit mask of the following options:

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoChainValidationResult();

Unicode (Windows)
INT GetConnInfoChainValidationResult();

CVT_VALID(0), 
CVT_VALID_BUT_UNTRUSTED(1), 
CVT_INVALID(2), 
CVT_CANT_BE_ESTABLISHED(3)

int secureblackbox_imapclient_getconninfochainvalidationresult(void* lpObj);

int GetConnInfoChainValidationResult();

Default Value

0

Remarks

The outcome of a certificate chain validation routine.

Available options:

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnInfoCiphersuite();

Unicode (Windows)
LPWSTR GetConnInfoCiphersuite();

char* secureblackbox_imapclient_getconninfociphersuite(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoClientAuthenticated();

Unicode (Windows)
BOOL GetConnInfoClientAuthenticated();

int secureblackbox_imapclient_getconninfoclientauthenticated(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoClientAuthRequested();

Unicode (Windows)
BOOL GetConnInfoClientAuthRequested();

int secureblackbox_imapclient_getconninfoclientauthrequested(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoConnectionEstablished();

Unicode (Windows)
BOOL GetConnInfoConnectionEstablished();

int secureblackbox_imapclient_getconninfoconnectionestablished(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoConnectionID(char* &lpConnInfoConnectionID, int &lenConnInfoConnectionID);

Unicode (Windows)
INT GetConnInfoConnectionID(LPSTR &lpConnInfoConnectionID, INT &lenConnInfoConnectionID);

int secureblackbox_imapclient_getconninfoconnectionid(void* lpObj, char** lpConnInfoConnectionID, int* lenConnInfoConnectionID);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnInfoDigestAlgorithm();

Unicode (Windows)
LPWSTR GetConnInfoDigestAlgorithm();

char* secureblackbox_imapclient_getconninfodigestalgorithm(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnInfoEncryptionAlgorithm();

Unicode (Windows)
LPWSTR GetConnInfoEncryptionAlgorithm();

char* secureblackbox_imapclient_getconninfoencryptionalgorithm(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoExportable();

Unicode (Windows)
BOOL GetConnInfoExportable();

int secureblackbox_imapclient_getconninfoexportable(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnInfoKeyExchangeAlgorithm();

Unicode (Windows)
LPWSTR GetConnInfoKeyExchangeAlgorithm();

char* secureblackbox_imapclient_getconninfokeyexchangealgorithm(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoKeyExchangeKeyBits();

Unicode (Windows)
INT GetConnInfoKeyExchangeKeyBits();

int secureblackbox_imapclient_getconninfokeyexchangekeybits(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnInfoNamedECCurve();

Unicode (Windows)
LPWSTR GetConnInfoNamedECCurve();

char* secureblackbox_imapclient_getconninfonamedeccurve(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoPFSCipher();

Unicode (Windows)
BOOL GetConnInfoPFSCipher();

int secureblackbox_imapclient_getconninfopfscipher(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnInfoPreSharedIdentityHint();

Unicode (Windows)
LPWSTR GetConnInfoPreSharedIdentityHint();

char* secureblackbox_imapclient_getconninfopresharedidentityhint(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoPublicKeyBits();

Unicode (Windows)
INT GetConnInfoPublicKeyBits();

int secureblackbox_imapclient_getconninfopublickeybits(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoResumedSession();

Unicode (Windows)
BOOL GetConnInfoResumedSession();

int secureblackbox_imapclient_getconninforesumedsession(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoSecureConnection();

Unicode (Windows)
BOOL GetConnInfoSecureConnection();

int secureblackbox_imapclient_getconninfosecureconnection(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoServerAuthenticated();

Unicode (Windows)
BOOL GetConnInfoServerAuthenticated();

int secureblackbox_imapclient_getconninfoserverauthenticated(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnInfoSignatureAlgorithm();

Unicode (Windows)
LPWSTR GetConnInfoSignatureAlgorithm();

char* secureblackbox_imapclient_getconninfosignaturealgorithm(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoSymmetricBlockSize();

Unicode (Windows)
INT GetConnInfoSymmetricBlockSize();

int secureblackbox_imapclient_getconninfosymmetricblocksize(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnInfoSymmetricKeyBits();

Unicode (Windows)
INT GetConnInfoSymmetricKeyBits();

int secureblackbox_imapclient_getconninfosymmetrickeybits(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetConnInfoTotalBytesReceived();

Unicode (Windows)
LONG64 GetConnInfoTotalBytesReceived();

int64 secureblackbox_imapclient_getconninfototalbytesreceived(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetConnInfoTotalBytesSent();

Unicode (Windows)
LONG64 GetConnInfoTotalBytesSent();

int64 secureblackbox_imapclient_getconninfototalbytessent(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnInfoValidationLog();

Unicode (Windows)
LPWSTR GetConnInfoValidationLog();

char* secureblackbox_imapclient_getconninfovalidationlog(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnInfoVersion();

Unicode (Windows)
LPWSTR GetConnInfoVersion();

char* secureblackbox_imapclient_getconninfoversion(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCurrMailboxMessageFlags();

Unicode (Windows)
INT GetCurrMailboxMessageFlags();

int secureblackbox_imapclient_getcurrmailboxmessageflags(void* lpObj);

int GetCurrMailboxMessageFlags();

Default Value

0

Remarks

Contains message flags defined in the mailbox.

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

Data Type

Integer

CurrMailboxName Property (IMAPClient Class)

Specifies mailbox name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCurrMailboxName();

Unicode (Windows)
LPWSTR GetCurrMailboxName();

char* secureblackbox_imapclient_getcurrmailboxname(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCurrMailboxNextUID();

Unicode (Windows)
INT GetCurrMailboxNextUID();

int secureblackbox_imapclient_getcurrmailboxnextuid(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCurrMailboxPermanentFlags();

Unicode (Windows)
INT GetCurrMailboxPermanentFlags();

int secureblackbox_imapclient_getcurrmailboxpermanentflags(void* lpObj);

int GetCurrMailboxPermanentFlags();

Default Value

0

Remarks

Contains a list of message flags that can be changed permanently.

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCurrMailboxReadOnly();

Unicode (Windows)
BOOL GetCurrMailboxReadOnly();

int secureblackbox_imapclient_getcurrmailboxreadonly(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCurrMailboxRecentMessages();

Unicode (Windows)
INT GetCurrMailboxRecentMessages();

int secureblackbox_imapclient_getcurrmailboxrecentmessages(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCurrMailboxTotalMessages();

Unicode (Windows)
INT GetCurrMailboxTotalMessages();

int secureblackbox_imapclient_getcurrmailboxtotalmessages(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCurrMailboxUIDValidity();

Unicode (Windows)
INT GetCurrMailboxUIDValidity();

int secureblackbox_imapclient_getcurrmailboxuidvalidity(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCurrMailboxUnseenMessages();

Unicode (Windows)
INT GetCurrMailboxUnseenMessages();

int secureblackbox_imapclient_getcurrmailboxunseenmessages(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFIPSMode();
int SetFIPSMode(int bFIPSMode);

Unicode (Windows)
BOOL GetFIPSMode();
INT SetFIPSMode(BOOL bFIPSMode);

int secureblackbox_imapclient_getfipsmode(void* lpObj);
int secureblackbox_imapclient_setfipsmode(void* lpObj, int bFIPSMode);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKnownCertCount();
int SetKnownCertCount(int iKnownCertCount);

Unicode (Windows)
INT GetKnownCertCount();
INT SetKnownCertCount(INT iKnownCertCount);

int secureblackbox_imapclient_getknowncertcount(void* lpObj);
int secureblackbox_imapclient_setknowncertcount(void* lpObj, int iKnownCertCount);

int GetKnownCertCount();
int SetKnownCertCount(int iKnownCertCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• KnownCertBytes
• KnownCertHandle

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 the raw certificate data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKnownCertBytes(int iKnownCertIndex, char* &lpKnownCertBytes, int &lenKnownCertBytes);

Unicode (Windows)
INT GetKnownCertBytes(INT iKnownCertIndex, LPSTR &lpKnownCertBytes, INT &lenKnownCertBytes);

int secureblackbox_imapclient_getknowncertbytes(void* lpObj, int knowncertindex, char** lpKnownCertBytes, int* lenKnownCertBytes);

QByteArray GetKnownCertBytes(int iKnownCertIndex);

Remarks

Returns the 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

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetKnownCertHandle(int iKnownCertIndex);
int SetKnownCertHandle(int iKnownCertIndex, int64 lKnownCertHandle);

Unicode (Windows)
LONG64 GetKnownCertHandle(INT iKnownCertIndex);
INT SetKnownCertHandle(INT iKnownCertIndex, LONG64 lKnownCertHandle);

int64 secureblackbox_imapclient_getknowncerthandle(void* lpObj, int knowncertindex);
int secureblackbox_imapclient_setknowncerthandle(void* lpObj, int knowncertindex, int64 lKnownCertHandle);

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.

 
 Copy
  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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKnownCRLCount();
int SetKnownCRLCount(int iKnownCRLCount);

Unicode (Windows)
INT GetKnownCRLCount();
INT SetKnownCRLCount(INT iKnownCRLCount);

int secureblackbox_imapclient_getknowncrlcount(void* lpObj);
int secureblackbox_imapclient_setknowncrlcount(void* lpObj, int iKnownCRLCount);

int GetKnownCRLCount();
int SetKnownCRLCount(int iKnownCRLCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• KnownCRLBytes
• KnownCRLHandle

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 the raw CRL data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKnownCRLBytes(int iKnownCRLIndex, char* &lpKnownCRLBytes, int &lenKnownCRLBytes);

Unicode (Windows)
INT GetKnownCRLBytes(INT iKnownCRLIndex, LPSTR &lpKnownCRLBytes, INT &lenKnownCRLBytes);

int secureblackbox_imapclient_getknowncrlbytes(void* lpObj, int knowncrlindex, char** lpKnownCRLBytes, int* lenKnownCRLBytes);

QByteArray GetKnownCRLBytes(int iKnownCRLIndex);

Remarks

Returns the 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

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetKnownCRLHandle(int iKnownCRLIndex);
int SetKnownCRLHandle(int iKnownCRLIndex, int64 lKnownCRLHandle);

Unicode (Windows)
LONG64 GetKnownCRLHandle(INT iKnownCRLIndex);
INT SetKnownCRLHandle(INT iKnownCRLIndex, LONG64 lKnownCRLHandle);

int64 secureblackbox_imapclient_getknowncrlhandle(void* lpObj, int knowncrlindex);
int secureblackbox_imapclient_setknowncrlhandle(void* lpObj, int knowncrlindex, int64 lKnownCRLHandle);

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.

 
 Copy
  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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKnownOCSPCount();
int SetKnownOCSPCount(int iKnownOCSPCount);

Unicode (Windows)
INT GetKnownOCSPCount();
INT SetKnownOCSPCount(INT iKnownOCSPCount);

int secureblackbox_imapclient_getknownocspcount(void* lpObj);
int secureblackbox_imapclient_setknownocspcount(void* lpObj, int iKnownOCSPCount);

int GetKnownOCSPCount();
int SetKnownOCSPCount(int iKnownOCSPCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• KnownOCSPBytes
• KnownOCSPHandle

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)

A buffer containing the raw OCSP response data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKnownOCSPBytes(int iKnownOCSPIndex, char* &lpKnownOCSPBytes, int &lenKnownOCSPBytes);

Unicode (Windows)
INT GetKnownOCSPBytes(INT iKnownOCSPIndex, LPSTR &lpKnownOCSPBytes, INT &lenKnownOCSPBytes);

int secureblackbox_imapclient_getknownocspbytes(void* lpObj, int knownocspindex, char** lpKnownOCSPBytes, int* lenKnownOCSPBytes);

QByteArray GetKnownOCSPBytes(int iKnownOCSPIndex);

Remarks

A buffer containing the 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

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetKnownOCSPHandle(int iKnownOCSPIndex);
int SetKnownOCSPHandle(int iKnownOCSPIndex, int64 lKnownOCSPHandle);

Unicode (Windows)
LONG64 GetKnownOCSPHandle(INT iKnownOCSPIndex);
INT SetKnownOCSPHandle(INT iKnownOCSPIndex, LONG64 lKnownOCSPHandle);

int64 secureblackbox_imapclient_getknownocsphandle(void* lpObj, int knownocspindex);
int secureblackbox_imapclient_setknownocsphandle(void* lpObj, int knownocspindex, int64 lKnownOCSPHandle);

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.

 
 Copy
  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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMailboxInfoCount();

Unicode (Windows)
INT GetMailboxInfoCount();

int secureblackbox_imapclient_getmailboxinfocount(void* lpObj);

int GetMailboxInfoCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• MailboxInfoDelimiter
• MailboxInfoHasChildren
• MailboxInfoHasNoChildren
• MailboxInfoMarked
• MailboxInfoName
• MailboxInfoNoInferiors
• MailboxInfoNoSelect
• MailboxInfoUnmarked

The array indices start at 0 and end at MailboxInfoCount - 1.

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

Data Type

Integer

MailboxInfoDelimiter Property (IMAPClient Class)

Mailbox hierarchy delimiter.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMailboxInfoDelimiter(int iMailboxInfoIndex);

Unicode (Windows)
LPWSTR GetMailboxInfoDelimiter(INT iMailboxInfoIndex);

char* secureblackbox_imapclient_getmailboxinfodelimiter(void* lpObj, int mailboxinfoindex);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMailboxInfoHasChildren(int iMailboxInfoIndex);

Unicode (Windows)
BOOL GetMailboxInfoHasChildren(INT iMailboxInfoIndex);

int secureblackbox_imapclient_getmailboxinfohaschildren(void* lpObj, int mailboxinfoindex);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMailboxInfoHasNoChildren(int iMailboxInfoIndex);

Unicode (Windows)
BOOL GetMailboxInfoHasNoChildren(INT iMailboxInfoIndex);

int secureblackbox_imapclient_getmailboxinfohasnochildren(void* lpObj, int mailboxinfoindex);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMailboxInfoMarked(int iMailboxInfoIndex);

Unicode (Windows)
BOOL GetMailboxInfoMarked(INT iMailboxInfoIndex);

int secureblackbox_imapclient_getmailboxinfomarked(void* lpObj, int mailboxinfoindex);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMailboxInfoName(int iMailboxInfoIndex);

Unicode (Windows)
LPWSTR GetMailboxInfoName(INT iMailboxInfoIndex);

char* secureblackbox_imapclient_getmailboxinfoname(void* lpObj, int mailboxinfoindex);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMailboxInfoNoInferiors(int iMailboxInfoIndex);

Unicode (Windows)
BOOL GetMailboxInfoNoInferiors(INT iMailboxInfoIndex);

int secureblackbox_imapclient_getmailboxinfonoinferiors(void* lpObj, int mailboxinfoindex);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMailboxInfoNoSelect(int iMailboxInfoIndex);

Unicode (Windows)
BOOL GetMailboxInfoNoSelect(INT iMailboxInfoIndex);

int secureblackbox_imapclient_getmailboxinfonoselect(void* lpObj, int mailboxinfoindex);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMailboxInfoUnmarked(int iMailboxInfoIndex);

Unicode (Windows)
BOOL GetMailboxInfoUnmarked(INT iMailboxInfoIndex);

int secureblackbox_imapclient_getmailboxinfounmarked(void* lpObj, int mailboxinfoindex);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMsgAttachmentCount();

Unicode (Windows)
INT GetMsgAttachmentCount();

int secureblackbox_imapclient_getmsgattachmentcount(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMsgBcc();
int SetMsgBcc(const char* lpszMsgBcc);

Unicode (Windows)
LPWSTR GetMsgBcc();
INT SetMsgBcc(LPCWSTR lpszMsgBcc);

char* secureblackbox_imapclient_getmsgbcc(void* lpObj);
int secureblackbox_imapclient_setmsgbcc(void* lpObj, const char* lpszMsgBcc);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMsgCc();
int SetMsgCc(const char* lpszMsgCc);

Unicode (Windows)
LPWSTR GetMsgCc();
INT SetMsgCc(LPCWSTR lpszMsgCc);

char* secureblackbox_imapclient_getmsgcc(void* lpObj);
int secureblackbox_imapclient_setmsgcc(void* lpObj, const char* lpszMsgCc);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMsgComments();
int SetMsgComments(const char* lpszMsgComments);

Unicode (Windows)
LPWSTR GetMsgComments();
INT SetMsgComments(LPCWSTR lpszMsgComments);

char* secureblackbox_imapclient_getmsgcomments(void* lpObj);
int secureblackbox_imapclient_setmsgcomments(void* lpObj, const char* lpszMsgComments);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMsgDate();
int SetMsgDate(const char* lpszMsgDate);

Unicode (Windows)
LPWSTR GetMsgDate();
INT SetMsgDate(LPCWSTR lpszMsgDate);

char* secureblackbox_imapclient_getmsgdate(void* lpObj);
int secureblackbox_imapclient_setmsgdate(void* lpObj, const char* lpszMsgDate);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMsgDeliveryReceipt();
int SetMsgDeliveryReceipt(int bMsgDeliveryReceipt);

Unicode (Windows)
BOOL GetMsgDeliveryReceipt();
INT SetMsgDeliveryReceipt(BOOL bMsgDeliveryReceipt);

int secureblackbox_imapclient_getmsgdeliveryreceipt(void* lpObj);
int secureblackbox_imapclient_setmsgdeliveryreceipt(void* lpObj, int bMsgDeliveryReceipt);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMsgFrom();
int SetMsgFrom(const char* lpszMsgFrom);

Unicode (Windows)
LPWSTR GetMsgFrom();
INT SetMsgFrom(LPCWSTR lpszMsgFrom);

char* secureblackbox_imapclient_getmsgfrom(void* lpObj);
int secureblackbox_imapclient_setmsgfrom(void* lpObj, const char* lpszMsgFrom);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetMsgHandle();
int SetMsgHandle(int64 lMsgHandle);

Unicode (Windows)
LONG64 GetMsgHandle();
INT SetMsgHandle(LONG64 lMsgHandle);

int64 secureblackbox_imapclient_getmsghandle(void* lpObj);
int secureblackbox_imapclient_setmsghandle(void* lpObj, int64 lMsgHandle);

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.

 
 Copy
  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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMsgHtmlText();
int SetMsgHtmlText(const char* lpszMsgHtmlText);

Unicode (Windows)
LPWSTR GetMsgHtmlText();
INT SetMsgHtmlText(LPCWSTR lpszMsgHtmlText);

char* secureblackbox_imapclient_getmsghtmltext(void* lpObj);
int secureblackbox_imapclient_setmsghtmltext(void* lpObj, const char* lpszMsgHtmlText);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMsgID();
int SetMsgID(const char* lpszMsgID);

Unicode (Windows)
LPWSTR GetMsgID();
INT SetMsgID(LPCWSTR lpszMsgID);

char* secureblackbox_imapclient_getmsgid(void* lpObj);
int secureblackbox_imapclient_setmsgid(void* lpObj, const char* lpszMsgID);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMsgInReplyTo();
int SetMsgInReplyTo(const char* lpszMsgInReplyTo);

Unicode (Windows)
LPWSTR GetMsgInReplyTo();
INT SetMsgInReplyTo(LPCWSTR lpszMsgInReplyTo);

char* secureblackbox_imapclient_getmsginreplyto(void* lpObj);
int secureblackbox_imapclient_setmsginreplyto(void* lpObj, const char* lpszMsgInReplyTo);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMsgKeywords();
int SetMsgKeywords(const char* lpszMsgKeywords);

Unicode (Windows)
LPWSTR GetMsgKeywords();
INT SetMsgKeywords(LPCWSTR lpszMsgKeywords);

char* secureblackbox_imapclient_getmsgkeywords(void* lpObj);
int secureblackbox_imapclient_setmsgkeywords(void* lpObj, const char* lpszMsgKeywords);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMsgMailer();

Unicode (Windows)
LPWSTR GetMsgMailer();

char* secureblackbox_imapclient_getmsgmailer(void* lpObj);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMsgPlainText();
int SetMsgPlainText(const char* lpszMsgPlainText);

Unicode (Windows)
LPWSTR GetMsgPlainText();
INT SetMsgPlainText(LPCWSTR lpszMsgPlainText);

char* secureblackbox_imapclient_getmsgplaintext(void* lpObj);
int secureblackbox_imapclient_setmsgplaintext(void* lpObj, const char* lpszMsgPlainText);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMsgPriority();
int SetMsgPriority(int iMsgPriority);

Unicode (Windows)
INT GetMsgPriority();
INT SetMsgPriority(INT iMsgPriority);

MP_LOWEST(0), 
MP_LOW(1), 
MP_NORMAL(2), 
MP_HIGH(3), 
MP_HIGHEST(4)

int secureblackbox_imapclient_getmsgpriority(void* lpObj);
int secureblackbox_imapclient_setmsgpriority(void* lpObj, int iMsgPriority);

int GetMsgPriority();
int SetMsgPriority(int iMsgPriority);

Default Value

2

Remarks

Specifies the message priority.

Available options:

This property is not available at design time.

Data Type

Integer

MsgReadReceipt Property (IMAPClient Class)

Enables a read notification.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMsgReadReceipt();
int SetMsgReadReceipt(int bMsgReadReceipt);

Unicode (Windows)
BOOL GetMsgReadReceipt();
INT SetMsgReadReceipt(BOOL bMsgReadReceipt);

int secureblackbox_imapclient_getmsgreadreceipt(void* lpObj);
int secureblackbox_imapclient_setmsgreadreceipt(void* lpObj, int bMsgReadReceipt);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMsgReferences();
int SetMsgReferences(const char* lpszMsgReferences);

Unicode (Windows)
LPWSTR GetMsgReferences();
INT SetMsgReferences(LPCWSTR lpszMsgReferences);

char* secureblackbox_imapclient_getmsgreferences(void* lpObj);
int secureblackbox_imapclient_setmsgreferences(void* lpObj, const char* lpszMsgReferences);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMsgReplyTo();
int SetMsgReplyTo(const char* lpszMsgReplyTo);

Unicode (Windows)
LPWSTR GetMsgReplyTo();
INT SetMsgReplyTo(LPCWSTR lpszMsgReplyTo);

char* secureblackbox_imapclient_getmsgreplyto(void* lpObj);
int secureblackbox_imapclient_setmsgreplyto(void* lpObj, const char* lpszMsgReplyTo);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMsgReturnPath();
int SetMsgReturnPath(const char* lpszMsgReturnPath);

Unicode (Windows)
LPWSTR GetMsgReturnPath();
INT SetMsgReturnPath(LPCWSTR lpszMsgReturnPath);

char* secureblackbox_imapclient_getmsgreturnpath(void* lpObj);
int secureblackbox_imapclient_setmsgreturnpath(void* lpObj, const char* lpszMsgReturnPath);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMsgSender();
int SetMsgSender(const char* lpszMsgSender);

Unicode (Windows)
LPWSTR GetMsgSender();
INT SetMsgSender(LPCWSTR lpszMsgSender);

char* secureblackbox_imapclient_getmsgsender(void* lpObj);
int secureblackbox_imapclient_setmsgsender(void* lpObj, const char* lpszMsgSender);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMsgSendTo();
int SetMsgSendTo(const char* lpszMsgSendTo);

Unicode (Windows)
LPWSTR GetMsgSendTo();
INT SetMsgSendTo(LPCWSTR lpszMsgSendTo);

char* secureblackbox_imapclient_getmsgsendto(void* lpObj);
int secureblackbox_imapclient_setmsgsendto(void* lpObj, const char* lpszMsgSendTo);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMsgSubject();
int SetMsgSubject(const char* lpszMsgSubject);

Unicode (Windows)
LPWSTR GetMsgSubject();
INT SetMsgSubject(LPCWSTR lpszMsgSubject);

char* secureblackbox_imapclient_getmsgsubject(void* lpObj);
int secureblackbox_imapclient_setmsgsubject(void* lpObj, const char* lpszMsgSubject);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMsgInfoCount();

Unicode (Windows)
INT GetMsgInfoCount();

int secureblackbox_imapclient_getmsginfocount(void* lpObj);

int GetMsgInfoCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• MsgInfoDate
• MsgInfoFlags
• MsgInfoFrom
• MsgInfoInternalDate
• MsgInfoPriority
• MsgInfoSentTo
• MsgInfoSize
• MsgInfoSubject
• MsgInfoUID

The array indices start at 0 and end at MsgInfoCount - 1.

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMsgInfoDate(int iMsgInfoIndex);

Unicode (Windows)
LPWSTR GetMsgInfoDate(INT iMsgInfoIndex);

char* secureblackbox_imapclient_getmsginfodate(void* lpObj, int msginfoindex);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMsgInfoFlags(int iMsgInfoIndex);

Unicode (Windows)
INT GetMsgInfoFlags(INT iMsgInfoIndex);

int secureblackbox_imapclient_getmsginfoflags(void* lpObj, int msginfoindex);

int GetMsgInfoFlags(int iMsgInfoIndex);

Default Value

0

Remarks

Returns the flags currently set to the mail message.

Supported flags are:

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMsgInfoFrom(int iMsgInfoIndex);

Unicode (Windows)
LPWSTR GetMsgInfoFrom(INT iMsgInfoIndex);

char* secureblackbox_imapclient_getmsginfofrom(void* lpObj, int msginfoindex);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMsgInfoInternalDate(int iMsgInfoIndex);

Unicode (Windows)
LPWSTR GetMsgInfoInternalDate(INT iMsgInfoIndex);

char* secureblackbox_imapclient_getmsginfointernaldate(void* lpObj, int msginfoindex);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMsgInfoPriority(int iMsgInfoIndex);

Unicode (Windows)
INT GetMsgInfoPriority(INT iMsgInfoIndex);

MP_LOWEST(0), 
MP_LOW(1), 
MP_NORMAL(2), 
MP_HIGH(3), 
MP_HIGHEST(4)

int secureblackbox_imapclient_getmsginfopriority(void* lpObj, int msginfoindex);

int GetMsgInfoPriority(int iMsgInfoIndex);

Default Value

2

Remarks

Specifies the message priority.

Available options:

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMsgInfoSentTo(int iMsgInfoIndex);

Unicode (Windows)
LPWSTR GetMsgInfoSentTo(INT iMsgInfoIndex);

char* secureblackbox_imapclient_getmsginfosentto(void* lpObj, int msginfoindex);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetMsgInfoSize(int iMsgInfoIndex);

Unicode (Windows)
LONG64 GetMsgInfoSize(INT iMsgInfoIndex);

int64 secureblackbox_imapclient_getmsginfosize(void* lpObj, int msginfoindex);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMsgInfoSubject(int iMsgInfoIndex);

Unicode (Windows)
LPWSTR GetMsgInfoSubject(INT iMsgInfoIndex);

char* secureblackbox_imapclient_getmsginfosubject(void* lpObj, int msginfoindex);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMsgInfoUID(int iMsgInfoIndex);

Unicode (Windows)
INT GetMsgInfoUID(INT iMsgInfoIndex);

int secureblackbox_imapclient_getmsginfouid(void* lpObj, int msginfoindex);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPassword();
int SetPassword(const char* lpszPassword);

Unicode (Windows)
LPWSTR GetPassword();
INT SetPassword(LPCWSTR lpszPassword);

char* secureblackbox_imapclient_getpassword(void* lpObj);
int secureblackbox_imapclient_setpassword(void* lpObj, const char* lpszPassword);

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyAddress();
int SetProxyAddress(const char* lpszProxyAddress);

Unicode (Windows)
LPWSTR GetProxyAddress();
INT SetProxyAddress(LPCWSTR lpszProxyAddress);

char* secureblackbox_imapclient_getproxyaddress(void* lpObj);
int secureblackbox_imapclient_setproxyaddress(void* lpObj, const char* lpszProxyAddress);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyAuthentication();
int SetProxyAuthentication(int iProxyAuthentication);

Unicode (Windows)
INT GetProxyAuthentication();
INT SetProxyAuthentication(INT iProxyAuthentication);

PAT_NO_AUTHENTICATION(0), 
PAT_BASIC(1), 
PAT_DIGEST(2), 
PAT_NTLM(3)

int secureblackbox_imapclient_getproxyauthentication(void* lpObj);
int secureblackbox_imapclient_setproxyauthentication(void* lpObj, int iProxyAuthentication);

int GetProxyAuthentication();
int SetProxyAuthentication(int iProxyAuthentication);

Default Value

0

Remarks

The authentication type used by the proxy server.

Data Type

Integer

ProxyPassword Property (IMAPClient Class)

The password to authenticate to the proxy server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyPassword();
int SetProxyPassword(const char* lpszProxyPassword);

Unicode (Windows)
LPWSTR GetProxyPassword();
INT SetProxyPassword(LPCWSTR lpszProxyPassword);

char* secureblackbox_imapclient_getproxypassword(void* lpObj);
int secureblackbox_imapclient_setproxypassword(void* lpObj, const char* lpszProxyPassword);

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

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyPort();
int SetProxyPort(int iProxyPort);

Unicode (Windows)
INT GetProxyPort();
INT SetProxyPort(INT iProxyPort);

int secureblackbox_imapclient_getproxyport(void* lpObj);
int secureblackbox_imapclient_setproxyport(void* lpObj, int iProxyPort);

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