IMAPClient Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

SecureBlackbox_IMAPClient

Procedural Interface

 secureblackbox_imapclient_open();
 secureblackbox_imapclient_close($res);
 secureblackbox_imapclient_register_callback($res, $id, $function);
 secureblackbox_imapclient_get_last_error($res);
 secureblackbox_imapclient_get_last_error_code($res);
 secureblackbox_imapclient_set($res, $id, $index, $value);
 secureblackbox_imapclient_get($res, $id, $index);
 secureblackbox_imapclient_do_closemailbox($res);
 secureblackbox_imapclient_do_config($res, $configurationstring);
 secureblackbox_imapclient_do_connect($res, $address, $port);
 secureblackbox_imapclient_do_copymessage($res, $uid, $mailboxname);
 secureblackbox_imapclient_do_createmailbox($res, $name);
 secureblackbox_imapclient_do_deletemailbox($res, $name);
 secureblackbox_imapclient_do_disconnect($res);
 secureblackbox_imapclient_do_doaction($res, $actionid, $actionparams);
 secureblackbox_imapclient_do_getmailboxinfo($res, $name);
 secureblackbox_imapclient_do_listmailboxes($res);
 secureblackbox_imapclient_do_listmessages($res, $flagsset, $flagsnotset);
 secureblackbox_imapclient_do_openmailbox($res, $name, $readonly);
 secureblackbox_imapclient_do_ping($res);
 secureblackbox_imapclient_do_postbytes($res, $bytes, $flags, $internaldate);
 secureblackbox_imapclient_do_postfile($res, $filename, $flags, $internaldate);
 secureblackbox_imapclient_do_postmessage($res, $flags, $internaldate);
 secureblackbox_imapclient_do_purgemessages($res);
 secureblackbox_imapclient_do_receivebytes($res, $uid);
 secureblackbox_imapclient_do_receivefile($res, $uid, $filename);
 secureblackbox_imapclient_do_receivemessage($res, $uid);
 secureblackbox_imapclient_do_refreshmailbox($res);
 secureblackbox_imapclient_do_renamemailbox($res, $name, $newname);
 secureblackbox_imapclient_do_reset($res);
 secureblackbox_imapclient_do_updatemessage($res, $uid, $setflags, $clearflags);

Remarks

Use this class to manage e-mail and retrieve e-mail messages from the remote IMAP servers.

Downloading only the recent messages to local files IMAPClient client = new IMAPClient(); client.Username= "user"; client.Password= "password"; client.Connect("mail.domain.com", 993); client.OpenMailbox("INBOX", true); client.ListMessages(Constants.imapMessageRecent, 0); foreach (IMAPMessageInfo info in client.Messages) client.ReceiveFile(info.UID, $"path\\{info.UID}.eml"); client.Disconnect();

Use Command and CommandReply events to get a session log. IMAPClient client = new IMAPClient(); client.OnCommand += (s, e) => { Console.WriteLine($"C: {e.Cmd}"); }; client.OnCommandReply += (s, e) => { Console.WriteLine($"S: {e.Reply}"); };

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.

AccessToken Property (SecureBlackbox_IMAPClient Class)

An OAuth 2.0 access token to authenticate to the server.

Object Oriented Interface

public function getAccessToken();


public function setAccessToken($value);

Procedural Interface

secureblackbox_imapclient_get($res, 1 );


secureblackbox_imapclient_set($res, 1, $value );

Default Value

''

Remarks

Use this property to provide the access token to be used to authenticate to the destination server.

Data Type

String

BlockedCertCount Property (SecureBlackbox_IMAPClient Class)

The number of records in the BlockedCert arrays.

Object Oriented Interface

public function getBlockedCertCount();


public function setBlockedCertCount($value);

Procedural Interface

secureblackbox_imapclient_get($res, 2 );


secureblackbox_imapclient_set($res, 2, $value );

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 (SecureBlackbox_IMAPClient Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getBlockedCertBytes($blockedcertindex);

Procedural Interface

secureblackbox_imapclient_get($res, 3 , $blockedcertindex);

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 (SecureBlackbox_IMAPClient Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Object Oriented Interface

public function getBlockedCertHandle($blockedcertindex);


public function setBlockedCertHandle($blockedcertindex, $value);

Procedural Interface

secureblackbox_imapclient_get($res, 11 , $blockedcertindex);


secureblackbox_imapclient_set($res, 11, $value , $blockedcertindex);

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

ConnInfoAEADCipher Property (SecureBlackbox_IMAPClient Class)

Indicates whether the encryption algorithm used is an AEAD cipher.

Object Oriented Interface

public function getConnInfoAEADCipher();

Procedural Interface

secureblackbox_imapclient_get($res, 42 );

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 (SecureBlackbox_IMAPClient Class)

The details of a certificate chain validation outcome.

Object Oriented Interface

public function getConnInfoChainValidationDetails();

Procedural Interface

secureblackbox_imapclient_get($res, 43 );

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 (SecureBlackbox_IMAPClient Class)

The outcome of a certificate chain validation routine.

Object Oriented Interface

public function getConnInfoChainValidationResult();

Procedural Interface

secureblackbox_imapclient_get($res, 44 );

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 (SecureBlackbox_IMAPClient Class)

The cipher suite employed by this connection.

Object Oriented Interface

public function getConnInfoCiphersuite();

Procedural Interface

secureblackbox_imapclient_get($res, 45 );

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 (SecureBlackbox_IMAPClient Class)

Specifies whether client authentication was performed during this connection.

Object Oriented Interface

public function getConnInfoClientAuthenticated();

Procedural Interface

secureblackbox_imapclient_get($res, 46 );

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 (SecureBlackbox_IMAPClient Class)

Specifies whether client authentication was requested during this connection.

Object Oriented Interface

public function getConnInfoClientAuthRequested();

Procedural Interface

secureblackbox_imapclient_get($res, 47 );

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 (SecureBlackbox_IMAPClient Class)

Indicates whether the connection has been established fully.

Object Oriented Interface

public function getConnInfoConnectionEstablished();

Procedural Interface

secureblackbox_imapclient_get($res, 48 );

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 (SecureBlackbox_IMAPClient Class)

The unique identifier assigned to this connection.

Object Oriented Interface

public function getConnInfoConnectionID();

Procedural Interface

secureblackbox_imapclient_get($res, 49 );

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 (SecureBlackbox_IMAPClient Class)

The digest algorithm used in a TLS-enabled connection.

Object Oriented Interface

public function getConnInfoDigestAlgorithm();

Procedural Interface

secureblackbox_imapclient_get($res, 50 );

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 (SecureBlackbox_IMAPClient Class)

The symmetric encryption algorithm used in a TLS-enabled connection.

Object Oriented Interface

public function getConnInfoEncryptionAlgorithm();

Procedural Interface

secureblackbox_imapclient_get($res, 51 );

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 (SecureBlackbox_IMAPClient Class)

Indicates whether a TLS connection uses a reduced-strength exportable cipher.

Object Oriented Interface

public function getConnInfoExportable();

Procedural Interface

secureblackbox_imapclient_get($res, 52 );

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

ConnInfoID Property (SecureBlackbox_IMAPClient Class)

The client connection's unique identifier.

Object Oriented Interface

public function getConnInfoID();

Procedural Interface

secureblackbox_imapclient_get($res, 53 );

Default Value

-1

Remarks

The client connection's unique identifier. This value is used throughout to refer to a particular client connection.

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

Data Type

Long64

ConnInfoKeyExchangeAlgorithm Property (SecureBlackbox_IMAPClient Class)

The key exchange algorithm used in a TLS-enabled connection.

Object Oriented Interface

public function getConnInfoKeyExchangeAlgorithm();

Procedural Interface

secureblackbox_imapclient_get($res, 54 );

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 (SecureBlackbox_IMAPClient Class)

The length of the key exchange key of a TLS-enabled connection.

Object Oriented Interface

public function getConnInfoKeyExchangeKeyBits();

Procedural Interface

secureblackbox_imapclient_get($res, 55 );

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 (SecureBlackbox_IMAPClient Class)

The elliptic curve used in this connection.

Object Oriented Interface

public function getConnInfoNamedECCurve();

Procedural Interface

secureblackbox_imapclient_get($res, 56 );

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 (SecureBlackbox_IMAPClient Class)

Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).

Object Oriented Interface

public function getConnInfoPFSCipher();

Procedural Interface

secureblackbox_imapclient_get($res, 57 );

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

ConnInfoPreSharedIdentity Property (SecureBlackbox_IMAPClient Class)

Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

Object Oriented Interface

public function getConnInfoPreSharedIdentity();

Procedural Interface

secureblackbox_imapclient_get($res, 58 );

Default Value

''

Remarks

Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

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

Data Type

String

ConnInfoPreSharedIdentityHint Property (SecureBlackbox_IMAPClient Class)

A hint professed by the server to help the client select the PSK identity to use.

Object Oriented Interface

public function getConnInfoPreSharedIdentityHint();

Procedural Interface

secureblackbox_imapclient_get($res, 59 );

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 (SecureBlackbox_IMAPClient Class)

The length of the public key.

Object Oriented Interface

public function getConnInfoPublicKeyBits();

Procedural Interface

secureblackbox_imapclient_get($res, 60 );

Default Value

0

Remarks

The length of the public key.

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

Data Type

Integer

ConnInfoRemoteAddress Property (SecureBlackbox_IMAPClient Class)

The client's IP address.

Object Oriented Interface

public function getConnInfoRemoteAddress();

Procedural Interface

secureblackbox_imapclient_get($res, 61 );

Default Value

''

Remarks

The client's IP address.

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

Data Type

String

ConnInfoRemotePort Property (SecureBlackbox_IMAPClient Class)

The remote port of the client connection.

Object Oriented Interface

public function getConnInfoRemotePort();

Procedural Interface

secureblackbox_imapclient_get($res, 62 );

Default Value

0

Remarks

The remote port of the client connection.

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

Data Type

Integer

ConnInfoResumedSession Property (SecureBlackbox_IMAPClient Class)

Indicates whether a TLS-enabled connection was spawned from another TLS connection.

Object Oriented Interface

public function getConnInfoResumedSession();

Procedural Interface

secureblackbox_imapclient_get($res, 63 );

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 (SecureBlackbox_IMAPClient Class)

Indicates whether TLS or SSL is enabled for this connection.

Object Oriented Interface

public function getConnInfoSecureConnection();

Procedural Interface

secureblackbox_imapclient_get($res, 64 );

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 (SecureBlackbox_IMAPClient Class)

Indicates whether server authentication was performed during a TLS-enabled connection.

Object Oriented Interface

public function getConnInfoServerAuthenticated();

Procedural Interface

secureblackbox_imapclient_get($res, 65 );

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 (SecureBlackbox_IMAPClient Class)

The signature algorithm used in a TLS handshake.

Object Oriented Interface

public function getConnInfoSignatureAlgorithm();

Procedural Interface

secureblackbox_imapclient_get($res, 66 );

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 (SecureBlackbox_IMAPClient Class)

The block size of the symmetric algorithm used.

Object Oriented Interface

public function getConnInfoSymmetricBlockSize();

Procedural Interface

secureblackbox_imapclient_get($res, 67 );

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 (SecureBlackbox_IMAPClient Class)

The key length of the symmetric algorithm used.

Object Oriented Interface

public function getConnInfoSymmetricKeyBits();

Procedural Interface

secureblackbox_imapclient_get($res, 68 );

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 (SecureBlackbox_IMAPClient Class)

The total number of bytes received over this connection.

Object Oriented Interface

public function getConnInfoTotalBytesReceived();

Procedural Interface

secureblackbox_imapclient_get($res, 69 );

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 (SecureBlackbox_IMAPClient Class)

The total number of bytes sent over this connection.

Object Oriented Interface

public function getConnInfoTotalBytesSent();

Procedural Interface

secureblackbox_imapclient_get($res, 70 );

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 (SecureBlackbox_IMAPClient Class)

Contains the server certificate's chain validation log.

Object Oriented Interface

public function getConnInfoValidationLog();

Procedural Interface

secureblackbox_imapclient_get($res, 71 );

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 (SecureBlackbox_IMAPClient Class)

Indicates the version of SSL/TLS protocol negotiated during this connection.

Object Oriented Interface

public function getConnInfoVersion();

Procedural Interface

secureblackbox_imapclient_get($res, 72 );

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

FIPSMode Property (SecureBlackbox_IMAPClient Class)

Reserved.

Object Oriented Interface

public function getFIPSMode();


public function setFIPSMode($value);

Procedural Interface

secureblackbox_imapclient_get($res, 73 );


secureblackbox_imapclient_set($res, 73, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

KnownCertCount Property (SecureBlackbox_IMAPClient Class)

The number of records in the KnownCert arrays.

Object Oriented Interface

public function getKnownCertCount();


public function setKnownCertCount($value);

Procedural Interface

secureblackbox_imapclient_get($res, 74 );


secureblackbox_imapclient_set($res, 74, $value );

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 (SecureBlackbox_IMAPClient Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getKnownCertBytes($knowncertindex);

Procedural Interface

secureblackbox_imapclient_get($res, 75 , $knowncertindex);

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 (SecureBlackbox_IMAPClient Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Object Oriented Interface

public function getKnownCertHandle($knowncertindex);


public function setKnownCertHandle($knowncertindex, $value);

Procedural Interface

secureblackbox_imapclient_get($res, 83 , $knowncertindex);


secureblackbox_imapclient_set($res, 83, $value , $knowncertindex);

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 (SecureBlackbox_IMAPClient Class)

The number of records in the KnownCRL arrays.

Object Oriented Interface

public function getKnownCRLCount();


public function setKnownCRLCount($value);

Procedural Interface

secureblackbox_imapclient_get($res, 114 );


secureblackbox_imapclient_set($res, 114, $value );

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 (SecureBlackbox_IMAPClient Class)

Returns the raw CRL data in DER format.

Object Oriented Interface

public function getKnownCRLBytes($knowncrlindex);

Procedural Interface

secureblackbox_imapclient_get($res, 115 , $knowncrlindex);

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 (SecureBlackbox_IMAPClient Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Object Oriented Interface

public function getKnownCRLHandle($knowncrlindex);


public function setKnownCRLHandle($knowncrlindex, $value);

Procedural Interface

secureblackbox_imapclient_get($res, 118 , $knowncrlindex);


secureblackbox_imapclient_set($res, 118, $value , $knowncrlindex);

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 (SecureBlackbox_IMAPClient Class)

The number of records in the KnownOCSP arrays.

Object Oriented Interface

public function getKnownOCSPCount();


public function setKnownOCSPCount($value);

Procedural Interface

secureblackbox_imapclient_get($res, 127 );


secureblackbox_imapclient_set($res, 127, $value );

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 (SecureBlackbox_IMAPClient Class)

A buffer containing the raw OCSP response data.

Object Oriented Interface

public function getKnownOCSPBytes($knownocspindex);

Procedural Interface

secureblackbox_imapclient_get($res, 128 , $knownocspindex);

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 (SecureBlackbox_IMAPClient Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Object Oriented Interface

public function getKnownOCSPHandle($knownocspindex);


public function setKnownOCSPHandle($knownocspindex, $value);

Procedural Interface

secureblackbox_imapclient_get($res, 130 , $knownocspindex);


secureblackbox_imapclient_set($res, 130, $value , $knownocspindex);

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

MailboxMessageFlags Property (SecureBlackbox_IMAPClient Class)

Contains message flags defined in the mailbox.

Object Oriented Interface

public function getMailboxMessageFlags();

Procedural Interface

secureblackbox_imapclient_get($res, 137 );

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

MailboxName Property (SecureBlackbox_IMAPClient Class)

Specifies mailbox name.

Object Oriented Interface

public function getMailboxName();

Procedural Interface

secureblackbox_imapclient_get($res, 138 );

Default Value

''

Remarks

Specifies mailbox name.

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

Data Type

String

MailboxNextUID Property (SecureBlackbox_IMAPClient Class)

Returns the next unique identifier value.

Object Oriented Interface

public function getMailboxNextUID();

Procedural Interface

secureblackbox_imapclient_get($res, 139 );

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

MailboxPermanentFlags Property (SecureBlackbox_IMAPClient Class)

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

Object Oriented Interface

public function getMailboxPermanentFlags();

Procedural Interface

secureblackbox_imapclient_get($res, 140 );

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

MailboxReadOnly Property (SecureBlackbox_IMAPClient Class)

Specifies whether the mailbox is write-protected.

Object Oriented Interface

public function getMailboxReadOnly();

Procedural Interface

secureblackbox_imapclient_get($res, 141 );

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

MailboxRecentMessages Property (SecureBlackbox_IMAPClient Class)

The number of recent messages in the mailbox.

Object Oriented Interface

public function getMailboxRecentMessages();

Procedural Interface

secureblackbox_imapclient_get($res, 142 );

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

MailboxTotalMessages Property (SecureBlackbox_IMAPClient Class)

Total number of messages in the mailbox.

Object Oriented Interface

public function getMailboxTotalMessages();

Procedural Interface

secureblackbox_imapclient_get($res, 143 );

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

MailboxUIDValidity Property (SecureBlackbox_IMAPClient Class)

Specifies UID validity value.

Object Oriented Interface

public function getMailboxUIDValidity();

Procedural Interface

secureblackbox_imapclient_get($res, 144 );

Default Value

0

Remarks

Specifies UID validity value.

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

Data Type

Integer

MailboxUnseenMessages Property (SecureBlackbox_IMAPClient Class)

The number of unseen messages in the mailbox.

Object Oriented Interface

public function getMailboxUnseenMessages();

Procedural Interface

secureblackbox_imapclient_get($res, 145 );

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

MsgAttachmentCount Property (SecureBlackbox_IMAPClient Class)

Returns the number of attachments in this message.

Object Oriented Interface

public function getMsgAttachmentCount();

Procedural Interface

secureblackbox_imapclient_get($res, 146 );

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 (SecureBlackbox_IMAPClient Class)

The contents of the BCC header property.

Object Oriented Interface

public function getMsgBcc();


public function setMsgBcc($value);

Procedural Interface

secureblackbox_imapclient_get($res, 147 );


secureblackbox_imapclient_set($res, 147, $value );

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 (SecureBlackbox_IMAPClient Class)

The value of the CC header property.

Object Oriented Interface

public function getMsgCc();


public function setMsgCc($value);

Procedural Interface

secureblackbox_imapclient_get($res, 148 );


secureblackbox_imapclient_set($res, 148, $value );

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 (SecureBlackbox_IMAPClient Class)

Contains additional information about the message body.

Object Oriented Interface

public function getMsgComments();


public function setMsgComments($value);

Procedural Interface

secureblackbox_imapclient_get($res, 149 );


secureblackbox_imapclient_set($res, 149, $value );

Default Value

''

Remarks

Contains additional information about the message body.

This property is not available at design time.

Data Type

String

MsgDate Property (SecureBlackbox_IMAPClient Class)

The date and time when the message entered the mail delivery system.

Object Oriented Interface

public function getMsgDate();


public function setMsgDate($value);

Procedural Interface

secureblackbox_imapclient_get($res, 150 );


secureblackbox_imapclient_set($res, 150, $value );

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 (SecureBlackbox_IMAPClient Class)

Enables delivery notification.

Object Oriented Interface

public function getMsgDeliveryReceipt();


public function setMsgDeliveryReceipt($value);

Procedural Interface

secureblackbox_imapclient_get($res, 151 );


secureblackbox_imapclient_set($res, 151, $value );

Default Value

false

Remarks

Enables delivery notification.

This property is not available at design time.

Data Type

Boolean

MsgFrom Property (SecureBlackbox_IMAPClient Class)

Contains the value of the From header property.

Object Oriented Interface

public function getMsgFrom();


public function setMsgFrom($value);

Procedural Interface

secureblackbox_imapclient_get($res, 152 );


secureblackbox_imapclient_set($res, 152, $value );

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 (SecureBlackbox_IMAPClient Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Object Oriented Interface

public function getMsgHandle();


public function setMsgHandle($value);

Procedural Interface

secureblackbox_imapclient_get($res, 153 );


secureblackbox_imapclient_set($res, 153, $value );

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 (SecureBlackbox_IMAPClient Class)

The HTML version of the message.

Object Oriented Interface

public function getMsgHtmlText();


public function setMsgHtmlText($value);

Procedural Interface

secureblackbox_imapclient_get($res, 154 );


secureblackbox_imapclient_set($res, 154, $value );

Default Value

''

Remarks

The HTML version of the message.

This property is not available at design time.

Data Type

String

MsgID Property (SecureBlackbox_IMAPClient Class)

The contents of the Message-ID header property.

Object Oriented Interface

public function getMsgID();


public function setMsgID($value);

Procedural Interface

secureblackbox_imapclient_get($res, 155 );


secureblackbox_imapclient_set($res, 155, $value );

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 (SecureBlackbox_IMAPClient Class)

The value of the In-Reply-To header property.

Object Oriented Interface

public function getMsgInReplyTo();


public function setMsgInReplyTo($value);

Procedural Interface

secureblackbox_imapclient_get($res, 156 );


secureblackbox_imapclient_set($res, 156, $value );

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 (SecureBlackbox_IMAPClient Class)

The value of the Keywords header property.

Object Oriented Interface

public function getMsgKeywords();


public function setMsgKeywords($value);

Procedural Interface

secureblackbox_imapclient_get($res, 157 );


secureblackbox_imapclient_set($res, 157, $value );

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 (SecureBlackbox_IMAPClient Class)

The name of the software that was used to send the message.

Object Oriented Interface

public function getMsgMailer();

Procedural Interface

secureblackbox_imapclient_get($res, 158 );

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 (SecureBlackbox_IMAPClient Class)

The plain text version of the message.

Object Oriented Interface

public function getMsgPlainText();


public function setMsgPlainText($value);

Procedural Interface

secureblackbox_imapclient_get($res, 159 );


secureblackbox_imapclient_set($res, 159, $value );

Default Value

''

Remarks

The plain text version of the message.

This property is not available at design time.

Data Type

String

MsgPriority Property (SecureBlackbox_IMAPClient Class)

Specifies the message priority.

Object Oriented Interface

public function getMsgPriority();


public function setMsgPriority($value);

Procedural Interface

secureblackbox_imapclient_get($res, 160 );


secureblackbox_imapclient_set($res, 160, $value );

Default Value

2

Remarks

Specifies the message priority.

Available options:

This property is not available at design time.

Data Type

Integer

MsgReadReceipt Property (SecureBlackbox_IMAPClient Class)

Enables a read notification.

Object Oriented Interface

public function getMsgReadReceipt();


public function setMsgReadReceipt($value);

Procedural Interface

secureblackbox_imapclient_get($res, 161 );


secureblackbox_imapclient_set($res, 161, $value );

Default Value

false

Remarks

Enables a read notification.

This property is not available at design time.

Data Type

Boolean

MsgReferences Property (SecureBlackbox_IMAPClient Class)

The value of the References header property.

Object Oriented Interface

public function getMsgReferences();


public function setMsgReferences($value);

Procedural Interface

secureblackbox_imapclient_get($res, 162 );


secureblackbox_imapclient_set($res, 162, $value );

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 (SecureBlackbox_IMAPClient Class)

The value of the Reply-To header property.

Object Oriented Interface

public function getMsgReplyTo();


public function setMsgReplyTo($value);

Procedural Interface

secureblackbox_imapclient_get($res, 163 );


secureblackbox_imapclient_set($res, 163, $value );

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 (SecureBlackbox_IMAPClient Class)

The value of the Return-Path header property.

Object Oriented Interface

public function getMsgReturnPath();


public function setMsgReturnPath($value);

Procedural Interface

secureblackbox_imapclient_get($res, 164 );


secureblackbox_imapclient_set($res, 164, $value );

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 (SecureBlackbox_IMAPClient Class)

The value of the Sender header property.

Object Oriented Interface

public function getMsgSender();


public function setMsgSender($value);

Procedural Interface

secureblackbox_imapclient_get($res, 165 );


secureblackbox_imapclient_set($res, 165, $value );

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 (SecureBlackbox_IMAPClient Class)

The value of the To header property.

Object Oriented Interface

public function getMsgSendTo();


public function setMsgSendTo($value);

Procedural Interface

secureblackbox_imapclient_get($res, 166 );


secureblackbox_imapclient_set($res, 166, $value );

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 (SecureBlackbox_IMAPClient Class)

Contains the subject property of this message.

Object Oriented Interface

public function getMsgSubject();


public function setMsgSubject($value);

Procedural Interface

secureblackbox_imapclient_get($res, 167 );


secureblackbox_imapclient_set($res, 167, $value );

Default Value

''

Remarks

Contains the subject field of this message.

This property is not available at design time.

Data Type

String

MsgInfoCount Property (SecureBlackbox_IMAPClient Class)

The number of records in the MsgInfo arrays.

Object Oriented Interface

public function getMsgInfoCount();

Procedural Interface

secureblackbox_imapclient_get($res, 168 );

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 (SecureBlackbox_IMAPClient Class)

Contains the value of the Date header property.

Object Oriented Interface

public function getMsgInfoDate($msginfoindex);

Procedural Interface

secureblackbox_imapclient_get($res, 169 , $msginfoindex);

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 (SecureBlackbox_IMAPClient Class)

Returns the flags currently set to the mail message.

Object Oriented Interface

public function getMsgInfoFlags($msginfoindex);

Procedural Interface

secureblackbox_imapclient_get($res, 170 , $msginfoindex);

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 (SecureBlackbox_IMAPClient Class)

Contains the value of the From header property.

Object Oriented Interface

public function getMsgInfoFrom($msginfoindex);

Procedural Interface

secureblackbox_imapclient_get($res, 171 , $msginfoindex);

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 (SecureBlackbox_IMAPClient Class)

Returns the internal date of the mail message.

Object Oriented Interface

public function getMsgInfoInternalDate($msginfoindex);

Procedural Interface

secureblackbox_imapclient_get($res, 172 , $msginfoindex);

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 (SecureBlackbox_IMAPClient Class)

Specifies the message priority.

Object Oriented Interface

public function getMsgInfoPriority($msginfoindex);

Procedural Interface

secureblackbox_imapclient_get($res, 173 , $msginfoindex);

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 (SecureBlackbox_IMAPClient Class)

Contains the value of the To header property.

Object Oriented Interface

public function getMsgInfoSentTo($msginfoindex);

Procedural Interface

secureblackbox_imapclient_get($res, 174 , $msginfoindex);

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 (SecureBlackbox_IMAPClient Class)

Returns the size of the message in bytes.

Object Oriented Interface

public function getMsgInfoSize($msginfoindex);

Procedural Interface

secureblackbox_imapclient_get($res, 175 , $msginfoindex);

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 (SecureBlackbox_IMAPClient Class)

Contains the value of the Subject header property.

Object Oriented Interface

public function getMsgInfoSubject($msginfoindex);

Procedural Interface

secureblackbox_imapclient_get($res, 176 , $msginfoindex);

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 (SecureBlackbox_IMAPClient Class)

Returns the unique ID of the mail message.

Object Oriented Interface

public function getMsgInfoUID($msginfoindex);

Procedural Interface

secureblackbox_imapclient_get($res, 177 , $msginfoindex);

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 (SecureBlackbox_IMAPClient Class)

The authentication password.

Object Oriented Interface

public function getPassword();


public function setPassword($value);

Procedural Interface

secureblackbox_imapclient_get($res, 178 );


secureblackbox_imapclient_set($res, 178, $value );

Default Value

''

Remarks

Use this property to provide the password for authenticating to the IMAP server.

In order to use OAuth 2.0 authentication to access the IMAP server, use the AccessToken property instead.

Data Type

String

ProxyAddress Property (SecureBlackbox_IMAPClient Class)

The IP address of the proxy server.

Object Oriented Interface

public function getProxyAddress();


public function setProxyAddress($value);

Procedural Interface

secureblackbox_imapclient_get($res, 179 );


secureblackbox_imapclient_set($res, 179, $value );

Default Value

''

Remarks

The IP address of the proxy server.

Data Type

String

ProxyAuthentication Property (SecureBlackbox_IMAPClient Class)

The authentication type used by the proxy server.

Object Oriented Interface

public function getProxyAuthentication();


public function setProxyAuthentication($value);

Procedural Interface

secureblackbox_imapclient_get($res, 180 );


secureblackbox_imapclient_set($res, 180, $value );

Default Value

0

Remarks

The authentication type used by the proxy server.

Data Type

Integer

ProxyPassword Property (SecureBlackbox_IMAPClient Class)

The password to authenticate to the proxy server.

Object Oriented Interface

public function getProxyPassword();


public function setProxyPassword($value);

Procedural Interface

secureblackbox_imapclient_get($res, 181 );


secureblackbox_imapclient_set($res, 181, $value );

Default Value

''

Remarks

The password to authenticate to the proxy server.

Data Type

String

ProxyPort Property (SecureBlackbox_IMAPClient Class)

The port on the proxy server to connect to.

Object Oriented Interface

public function getProxyPort();


public function setProxyPort($value);

Procedural Interface

secureblackbox_imapclient_get($res, 182 );


secureblackbox_imapclient_set($res, 182, $value );

Default Value

0

Remarks

The port on the proxy server to connect to.

Data Type

Integer

ProxyProxyType Property (SecureBlackbox_IMAPClient Class)

The type of the proxy server.

Object Oriented Interface

public function getProxyProxyType();


public function setProxyProxyType($value);

Procedural Interface

secureblackbox_imapclient_get($res, 183 );


secureblackbox_imapclient_set($res, 183, $value );

Default Value

0

Remarks

The type of the proxy server.

Data Type

Integer

ProxyRequestHeaders Property (SecureBlackbox_IMAPClient Class)

Contains HTTP request headers for WebTunnel and HTTP proxy.

Object Oriented Interface

public function getProxyRequestHeaders();


public function setProxyRequestHeaders($value);

Procedural Interface

secureblackbox_imapclient_get($res, 184 );


secureblackbox_imapclient_set($res, 184, $value );

Default Value

''

Remarks

Contains HTTP request headers for WebTunnel and HTTP proxy.

Data Type

String

ProxyResponseBody Property (SecureBlackbox_IMAPClient Class)

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

Object Oriented Interface

public function getProxyResponseBody();


public function setProxyResponseBody($value);

Procedural Interface

secureblackbox_imapclient_get($res, 185 );


secureblackbox_imapclient_set($res, 185, $value );

Default Value

''

Remarks

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

Data Type

String

ProxyResponseHeaders Property (SecureBlackbox_IMAPClient Class)

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

Object Oriented Interface

public function getProxyResponseHeaders();


public function setProxyResponseHeaders($value);

Procedural Interface

secureblackbox_imapclient_get($res, 186 );


secureblackbox_imapclient_set($res, 186, $value );

Default Value

''

Remarks

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

Data Type

String

ProxyUseIPv6 Property (SecureBlackbox_IMAPClient Class)

Specifies whether IPv6 should be used when connecting through the proxy.

Object Oriented Interface

public function getProxyUseIPv6();


public function setProxyUseIPv6($value);

Procedural Interface

secureblackbox_imapclient_get($res, 187 );


secureblackbox_imapclient_set($res, 187, $value );

Default Value

false

Remarks

Specifies whether IPv6 should be used when connecting through the proxy.

Data Type

Boolean

ProxyUsername Property (SecureBlackbox_IMAPClient Class)

Specifies the username credential for proxy authentication.

Object Oriented Interface

public function getProxyUsername();


public function setProxyUsername($value);

Procedural Interface

secureblackbox_imapclient_get($res, 188 );


secureblackbox_imapclient_set($res, 188, $value );

Default Value

''

Remarks

Specifies the username credential for proxy authentication.

Data Type

String

ServerInfoCapabilities Property (SecureBlackbox_IMAPClient Class)

Returns the list of server capabilities.

Object Oriented Interface

public function getServerInfoCapabilities();

Procedural Interface

secureblackbox_imapclient_get($res, 189 );

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

ServerInfoFeatures Property (SecureBlackbox_IMAPClient Class)

Returns the list of capabilities supported by the server.

Object Oriented Interface

public function getServerInfoFeatures();

Procedural Interface

secureblackbox_imapclient_get($res, 190 );

Default Value

0

Remarks

Returns the list of capabilities supported by the server.

This value is bit mask of the following values:

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

Data Type

Long64

ServerInfoSupportedAuths Property (SecureBlackbox_IMAPClient Class)

Contains a comma-separated list of the authentication methods supported by the server.

Object Oriented Interface

public function getServerInfoSupportedAuths();

Procedural Interface

secureblackbox_imapclient_get($res, 191 );

Default Value

''

Remarks

Contains a comma-separated list of the authentication methods supported by the server.

Use this value to setup the Authentications config property if needed.

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

Data Type

String

SessionLog Property (SecureBlackbox_IMAPClient Class)

Contains the complete log of the last session.

Object Oriented Interface

public function getSessionLog();

Procedural Interface

secureblackbox_imapclient_get($res, 192 );

Default Value

''

Remarks

Use this property to access the session log produced by the class. The log can be very useful when investigating connection issues.

See the SessionLogDetails config property for the log details settings.

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

Data Type

String

SocketDNSMode Property (SecureBlackbox_IMAPClient Class)

Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system.

Object Oriented Interface

public function getSocketDNSMode();


public function setSocketDNSMode($value);

Procedural Interface

secureblackbox_imapclient_get($res, 193 );


secureblackbox_imapclient_set($res, 193, $value );

Default Value

0

Remarks

Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.

Data Type

Integer

SocketDNSPort Property (SecureBlackbox_IMAPClient Class)

Specifies the port number to be used for sending queries to the DNS server.

Object Oriented Interface

public function getSocketDNSPort();


public function setSocketDNSPort($value);

Procedural Interface

secureblackbox_imapclient_get($res, 194 );


secureblackbox_imapclient_set($res, 194, $value );

Default Value

0

Remarks

Specifies the port number to be used for sending queries to the DNS server.

Data Type

Integer

SocketDNSQueryTimeout Property (SecureBlackbox_IMAPClient Class)

The timeout (in milliseconds) for each DNS query.

Object Oriented Interface

public function getSocketDNSQueryTimeout();


public function setSocketDNSQueryTimeout($value);

Procedural Interface

secureblackbox_imapclient_get($res, 195 );


secureblackbox_imapclient_set($res, 195, $value );

Default Value

0

Remarks

The timeout (in milliseconds) for each DNS query. The value of 0 indicates an infinite timeout.

Data Type

Integer

SocketDNSServers Property (SecureBlackbox_IMAPClient Class)

The addresses of DNS servers to use for address resolution, separated by commas or semicolons.

Object Oriented Interface

public function getSocketDNSServers();


public function setSocketDNSServers($value);

Procedural Interface

secureblackbox_imapclient_get($res, 196 );


secureblackbox_imapclient_set($res, 196, $value );

Default Value

''

Remarks

The addresses of DNS servers to use for address resolution, separated by commas or semicolons.

Data Type

String

SocketDNSTotalTimeout Property (SecureBlackbox_IMAPClient Class)

The timeout (in milliseconds) for the whole resolution process.

Object Oriented Interface

public function getSocketDNSTotalTimeout();


public function setSocketDNSTotalTimeout($value);

Procedural Interface

secureblackbox_imapclient_get($res, 197 );


secureblackbox_imapclient_set($res, 197, $value );

Default Value

0

Remarks

The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates an infinite timeout.

Data Type

Integer

SocketIncomingSpeedLimit Property (SecureBlackbox_IMAPClient Class)

The maximum number of bytes to read from the socket, per second.

Object Oriented Interface

public function getSocketIncomingSpeedLimit();


public function setSocketIncomingSpeedLimit($value);

Procedural Interface

secureblackbox_imapclient_get($res, 198 );


secureblackbox_imapclient_set($res, 198, $value );

Default Value

0

Remarks

The maximum number of bytes to read from the socket, per second.

Data Type

Integer

SocketLocalAddress Property (SecureBlackbox_IMAPClient Class)

The local network interface to bind the socket to.

Object Oriented Interface

public function getSocketLocalAddress();


public function setSocketLocalAddress($value);

Procedural Interface

secureblackbox_imapclient_get($res, 199 );


secureblackbox_imapclient_set($res, 199, $value );

Default Value

''

Remarks

The local network interface to bind the socket to.

Data Type

String

SocketLocalPort Property (SecureBlackbox_IMAPClient Class)

The local port number to bind the socket to.

Object Oriented Interface

public function getSocketLocalPort();


public function setSocketLocalPort($value);

Procedural Interface

secureblackbox_imapclient_get($res, 200 );


secureblackbox_imapclient_set($res, 200, $value );

Default Value

0

Remarks

The local port number to bind the socket to.

Data Type

Integer

SocketOutgoingSpeedLimit Property (SecureBlackbox_IMAPClient Class)

The maximum number of bytes to write to the socket, per second.

Object Oriented Interface

public function getSocketOutgoingSpeedLimit();


public function setSocketOutgoingSpeedLimit($value);

Procedural Interface

secureblackbox_imapclient_get($res, 201 );


secureblackbox_imapclient_set($res, 201, $value );

Default Value

0

Remarks

The maximum number of bytes to write to the socket, per second.

Data Type

Integer

SocketTimeout Property (SecureBlackbox_IMAPClient Class)

The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.

Object Oriented Interface

public function getSocketTimeout();


public function setSocketTimeout($value);

Procedural Interface

secureblackbox_imapclient_get($res, 202 );


secureblackbox_imapclient_set($res, 202, $value );

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 (SecureBlackbox_IMAPClient Class)

Enables or disables IP protocol version 6.

Object Oriented Interface

public function getSocketUseIPv6();


public function setSocketUseIPv6($value);

Procedural Interface

secureblackbox_imapclient_get($res, 203 );


secureblackbox_imapclient_set($res, 203, $value );

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

Boolean

TLSClientCertCount Property (SecureBlackbox_IMAPClient Class)

The number of records in the TLSClientCert arrays.

Object Oriented Interface

public function getTLSClientCertCount();


public function setTLSClientCertCount($value);

Procedural Interface

secureblackbox_imapclient_get($res, 204 );


secureblackbox_imapclient_set($res, 204, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• TLSClientCertBytes
• TLSClientCertHandle

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

This property is not available at design time.

Data Type

Integer

TLSClientCertBytes Property (SecureBlackbox_IMAPClient Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getTLSClientCertBytes($tlsclientcertindex);

Procedural Interface

secureblackbox_imapclient_get($res, 205 , $tlsclientcertindex);

Remarks

Returns the raw certificate data in DER format.

The $tlsclientcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSClientCertCount property.

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

Data Type

Byte Array

TLSClientCertHandle Property (SecureBlackbox_IMAPClient Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Object Oriented Interface

public function getTLSClientCertHandle($tlsclientcertindex);


public function setTLSClientCertHandle($tlsclientcertindex, $value);

Procedural Interface

secureblackbox_imapclient_get($res, 213 , $tlsclientcertindex);


secureblackbox_imapclient_set($res, 213, $value , $tlsclientcertindex);

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 $tlsclientcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSClientCertCount property.

This property is not available at design time.

Data Type

Long64

TLSServerCertCount Property (SecureBlackbox_IMAPClient Class)

The number of records in the TLSServerCert arrays.

Object Oriented Interface

public function getTLSServerCertCount();

Procedural Interface

secureblackbox_imapclient_get($res, 244 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• TLSServerCertBytes
• TLSServerCertFingerprint
• TLSServerCertHandle
• TLSServerCertIssuer
• TLSServerCertIssuerRDN
• TLSServerCertKeyAlgorithm
• TLSServerCertKeyBits
• TLSServerCertKeyUsage
• TLSServerCertSelfSigned
• TLSServerCertSerialNumber
• TLSServerCertSigAlgorithm
• TLSServerCertSubject
• TLSServerCertSubjectRDN
• TLSServerCertValidFrom
• TLSServerCertValidTo

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

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

Data Type

Integer

TLSServerCertBytes Property (SecureBlackbox_IMAPClient Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getTLSServerCertBytes($tlsservercertindex);

Procedural Interface

secureblackbox_imapclient_get($res, 245 , $tlsservercertindex);

Remarks

Returns the raw certificate data in DER format.

The $tlsservercertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

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

Data Type

Byte Array

TLSServerCertFingerprint Property (SecureBlackbox_IMAPClient Class)

Contains the fingerprint (a hash imprint) of this certificate.

Object Oriented Interface

public function getTLSServerCertFingerprint($tlsservercertindex);

Procedural Interface

secureblackbox_imapclient_get($res, 251 , $tlsservercertindex);

Default Value

''

Remarks

Contains the fingerprint (a hash imprint) of this certificate.

While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.

The $tlsservercertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

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

Data Type

String

TLSServerCertHandle Property (SecureBlackbox_IMAPClient Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Object Oriented Interface

public function getTLSServerCertHandle($tlsservercertindex);

Procedural Interface

secureblackbox_imapclient_get($res, 253 , $tlsservercertindex);

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 $tlsservercertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

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

Data Type

Long64

TLSServerCertIssuer Property (SecureBlackbox_IMAPClient Class)

The common name of the certificate issuer (CA), typically a company name.

Object Oriented Interface

public function getTLSServerCertIssuer($tlsservercertindex);

Procedural Interface

secureblackbox_imapclient_get($res, 255 , $tlsservercertindex);

Default Value

''

Remarks

The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via TLSIssuerRDN.

The $tlsservercertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

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

Data Type

String

TLSServerCertIssuerRDN Property (SecureBlackbox_IMAPClient Class)

A list of Property=Value pairs that uniquely identify the certificate issuer.

Object Oriented Interface

public function getTLSServerCertIssuerRDN($tlsservercertindex);

Procedural Interface

secureblackbox_imapclient_get($res, 256 , $tlsservercertindex);

Default Value

''

Remarks

A list of Property=Value pairs that uniquely identify the certificate issuer.

Example: /C=US/O=Nationwide CA/CN=Web Certification Authority

The $tlsservercertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

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

Data Type

String

TLSServerCertKeyAlgorithm Property (SecureBlackbox_IMAPClient Class)

Specifies the public key algorithm of this certificate.

Object Oriented Interface

public function getTLSServerCertKeyAlgorithm($tlsservercertindex);

Procedural Interface

secureblackbox_imapclient_get($res, 257 , $tlsservercertindex);

Default Value

'0'

Remarks

Specifies the public key algorithm of this certificate.

Use the TLSKeyBits, TLSCurve, and TLSPublicKeyBytes properties to get more details about the key the certificate contains.

The $tlsservercertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

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

Data Type

String

TLSServerCertKeyBits Property (SecureBlackbox_IMAPClient Class)

Returns the length of the public key in bits.

Object Oriented Interface

public function getTLSServerCertKeyBits($tlsservercertindex);

Procedural Interface

secureblackbox_imapclient_get($res, 258 , $tlsservercertindex);

Default Value

0

Remarks

Returns the length of the public key in bits.

This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the TLSPublicKeyBytes or TLSPrivateKeyBytes property would typically contain auxiliary values, and therefore be longer.

The $tlsservercertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

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

Data Type

Integer

TLSServerCertKeyUsage Property (SecureBlackbox_IMAPClient Class)

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

Object Oriented Interface

public function getTLSServerCertKeyUsage($tlsservercertindex);

Procedural Interface

secureblackbox_imapclient_get($res, 260 , $tlsservercertindex);

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:

Set this property before generating the certificate to propagate the key usage flags to the new certificate.

The $tlsservercertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

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

Data Type

Integer

TLSServerCertSelfSigned Property (SecureBlackbox_IMAPClient Class)

Indicates whether the certificate is self-signed (root) or signed by an external CA.

Object Oriented Interface

public function getTLSServerCertSelfSigned($tlsservercertindex);

Procedural Interface

secureblackbox_imapclient_get($res, 273 , $tlsservercertindex);

Default Value

false

Remarks

Indicates whether the certificate is self-signed (root) or signed by an external CA.

The $tlsservercertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

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

Data Type

Boolean

TLSServerCertSerialNumber Property (SecureBlackbox_IMAPClient Class)

Returns the certificate's serial number.

Object Oriented Interface

public function getTLSServerCertSerialNumber($tlsservercertindex);

Procedural Interface

secureblackbox_imapclient_get($res, 274 , $tlsservercertindex);

Remarks

Returns the certificate's serial number.

The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.

The $tlsservercertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

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

Data Type

Byte Array

TLSServerCertSigAlgorithm Property (SecureBlackbox_IMAPClient Class)

Indicates the algorithm that was used by the CA to sign this certificate.

Object Oriented Interface

public function getTLSServerCertSigAlgorithm($tlsservercertindex);

Procedural Interface

secureblackbox_imapclient_get($res, 275 , $tlsservercertindex);

Default Value

''

Remarks

Indicates the algorithm that was used by the CA to sign this certificate.

A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.

The $tlsservercertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

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

Data Type

String

TLSServerCertSubject Property (SecureBlackbox_IMAPClient Class)

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

Object Oriented Interface

public function getTLSServerCertSubject($tlsservercertindex);

Procedural Interface

secureblackbox_imapclient_get($res, 277 , $tlsservercertindex);

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. This is part of a larger set of credentials available via TLSSubjectRDN.

The $tlsservercertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

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

Data Type

String

TLSServerCertSubjectRDN Property (SecureBlackbox_IMAPClient Class)

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Object Oriented Interface

public function getTLSServerCertSubjectRDN($tlsservercertindex);

Procedural Interface

secureblackbox_imapclient_get($res, 280 , $tlsservercertindex);

Default Value

''

Remarks

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.

Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.

The $tlsservercertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

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

Data Type

String

TLSServerCertValidFrom Property (SecureBlackbox_IMAPClient Class)

The time point at which the certificate becomes valid, in UTC.

Object Oriented Interface

public function getTLSServerCertValidFrom($tlsservercertindex);

Procedural Interface

secureblackbox_imapclient_get($res, 282 , $tlsservercertindex);

Default Value

''

Remarks

The time point at which the certificate becomes valid, in UTC.

The $tlsservercertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

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

Data Type

String

TLSServerCertValidTo Property (SecureBlackbox_IMAPClient Class)

The time point at which the certificate expires, in UTC.

Object Oriented Interface

public function getTLSServerCertValidTo($tlsservercertindex);

Procedural Interface

secureblackbox_imapclient_get($res, 283 , $tlsservercertindex);

Default Value

''

Remarks

The time point at which the certificate expires, in UTC.

The $tlsservercertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

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

Data Type

String

TLSAutoValidateCertificates Property (SecureBlackbox_IMAPClient Class)

Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.

Object Oriented Interface

public function getTLSAutoValidateCertificates();


public function setTLSAutoValidateCertificates($value);

Procedural Interface

secureblackbox_imapclient_get($res, 284 );


secureblackbox_imapclient_set($res, 284, $value );

Default Value

true

Remarks

Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.

Data Type

Boolean

TLSBaseConfiguration Property (SecureBlackbox_IMAPClient Class)

Selects the base configuration for the TLS settings.

Object Oriented Interface

public function getTLSBaseConfiguration();


public function setTLSBaseConfiguration($value);

Procedural Interface

secureblackbox_imapclient_get($res, 285 );


secureblackbox_imapclient_set($res, 285, $value );

Default Value

0

Remarks

Selects the base configuration for the TLS settings. Several profiles are offered and tuned up for different purposes, such as high security or higher compatibility.

Data Type

Integer

TLSCiphersuites Property (SecureBlackbox_IMAPClient Class)

A list of ciphersuites separated with commas or semicolons.

Object Oriented Interface

public function getTLSCiphersuites();


public function setTLSCiphersuites($value);

Procedural Interface

secureblackbox_imapclient_get($res, 286 );


secureblackbox_imapclient_set($res, 286, $value );

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, allowing all ciphersuites to be blanketly enabled or disabled at once.

Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by TLSBaseConfiguration. 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

TLSClientAuth Property (SecureBlackbox_IMAPClient Class)

Enables or disables certificate-based client authentication.

Object Oriented Interface

public function getTLSClientAuth();


public function setTLSClientAuth($value);

Procedural Interface

secureblackbox_imapclient_get($res, 287 );


secureblackbox_imapclient_set($res, 287, $value );

Default Value

0

Remarks

Enables or disables certificate-based client authentication.

Set this property to true to tune up the client authentication type:

Data Type

Integer

TLSECCurves Property (SecureBlackbox_IMAPClient Class)

Defines the elliptic curves to enable.

Object Oriented Interface

public function getTLSECCurves();


public function setTLSECCurves($value);

Procedural Interface

secureblackbox_imapclient_get($res, 288 );


secureblackbox_imapclient_set($res, 288, $value );

Default Value

''

Remarks

Defines the elliptic curves to enable.

Data Type

String

TLSExtensions Property (SecureBlackbox_IMAPClient Class)

Provides access to TLS extensions.

Object Oriented Interface

public function getTLSExtensions();


public function setTLSExtensions($value);

Procedural Interface

secureblackbox_imapclient_get($res, 289 );


secureblackbox_imapclient_set($res, 289, $value );

Default Value

''

Remarks

Provides access to TLS extensions.

Data Type

String

TLSForceResumeIfDestinationChanges Property (SecureBlackbox_IMAPClient Class)

Whether to force TLS session resumption when the destination address changes.

Object Oriented Interface

public function getTLSForceResumeIfDestinationChanges();


public function setTLSForceResumeIfDestinationChanges($value);

Procedural Interface

secureblackbox_imapclient_get($res, 290 );


secureblackbox_imapclient_set($res, 290, $value );

Default Value

false

Remarks

Whether to force TLS session resumption when the destination address changes.

Data Type

Boolean

TLSPreSharedIdentity Property (SecureBlackbox_IMAPClient Class)

Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

Object Oriented Interface

public function getTLSPreSharedIdentity();


public function setTLSPreSharedIdentity($value);

Procedural Interface

secureblackbox_imapclient_get($res, 291 );


secureblackbox_imapclient_set($res, 291, $value );

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 (SecureBlackbox_IMAPClient Class)

Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.

Object Oriented Interface

public function getTLSPreSharedKey();


public function setTLSPreSharedKey($value);

Procedural Interface

secureblackbox_imapclient_get($res, 292 );


secureblackbox_imapclient_set($res, 292, $value );

Default Value

''

Remarks

Contains the pre-shared key 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 (SecureBlackbox_IMAPClient Class)

Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.

Object Oriented Interface

public function getTLSPreSharedKeyCiphersuite();


public function setTLSPreSharedKeyCiphersuite($value);

Procedural Interface

secureblackbox_imapclient_get($res, 293 );


secureblackbox_imapclient_set($res, 293, $value );

Default Value

''

Remarks

Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.

Data Type

String

TLSRenegotiationAttackPreventionMode Property (SecureBlackbox_IMAPClient Class)

Selects the renegotiation attack prevention mechanism.

Object Oriented Interface

public function getTLSRenegotiationAttackPreventionMode();


public function setTLSRenegotiationAttackPreventionMode($value);

Procedural Interface

secureblackbox_imapclient_get($res, 294 );


secureblackbox_imapclient_set($res, 294, $value );

Default Value

2

Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:

Data Type

Integer

TLSRevocationCheck Property (SecureBlackbox_IMAPClient Class)

Specifies the kind(s) of revocation check to perform.

Object Oriented Interface

public function getTLSRevocationCheck();


public function setTLSRevocationCheck($value);

Procedural Interface

secureblackbox_imapclient_get($res, 295 );


secureblackbox_imapclient_set($res, 295, $value );

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.

This setting controls the way the revocation checks are performed for every certificate in the chain. 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 the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.

Note: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable.

Note: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails.

This property is not available at design time.

Data Type

Integer

TLSSSLOptions Property (SecureBlackbox_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.

Object Oriented Interface

public function getTLSSSLOptions();


public function setTLSSSLOptions($value);

Procedural Interface

secureblackbox_imapclient_get($res, 296 );


secureblackbox_imapclient_set($res, 296, $value );

Default Value

16

Remarks

Various SSL (TLS) protocol options, set of

Data Type

Integer

TLSTLSMode Property (SecureBlackbox_IMAPClient Class)

Specifies the TLS mode to use.

Object Oriented Interface

public function getTLSTLSMode();


public function setTLSTLSMode($value);

Procedural Interface

secureblackbox_imapclient_get($res, 297 );


secureblackbox_imapclient_set($res, 297, $value );

Default Value

0

Remarks

Specifies the TLS mode to use.

Data Type

Integer

TLSUseExtendedMasterSecret Property (SecureBlackbox_IMAPClient Class)

Enables the Extended Master Secret Extension, as defined in RFC 7627.

Object Oriented Interface

public function getTLSUseExtendedMasterSecret();


public function setTLSUseExtendedMasterSecret($value);

Procedural Interface

secureblackbox_imapclient_get($res, 298 );


secureblackbox_imapclient_set($res, 298, $value );

Default Value

false

Remarks

Enables the Extended Master Secret Extension, as defined in RFC 7627.

Data Type

Boolean

TLSUseSessionResumption Property (SecureBlackbox_IMAPClient Class)

Enables or disables the TLS session resumption capability.

Object Oriented Interface

public function getTLSUseSessionResumption();


public function setTLSUseSessionResumption($value);

Procedural Interface

secureblackbox_imapclient_get($res, 299 );


secureblackbox_imapclient_set($res, 299, $value );

Default Value

false

Remarks

Enables or disables the TLS session resumption capability.

Data Type

Boolean

TLSVersions Property (SecureBlackbox_IMAPClient Class)

The SSL/TLS versions to enable by default.

Object Oriented Interface

public function getTLSVersions();


public function setTLSVersions($value);

Procedural Interface

secureblackbox_imapclient_get($res, 300 );


secureblackbox_imapclient_set($res, 300, $value );

Default Value

16

Remarks

The SSL/TLS versions to enable by default.

Data Type

Integer

TrustedCertCount Property (SecureBlackbox_IMAPClient Class)

The number of records in the TrustedCert arrays.

Object Oriented Interface

public function getTrustedCertCount();


public function setTrustedCertCount($value);

Procedural Interface

secureblackbox_imapclient_get($res, 301 );


secureblackbox_imapclient_set($res, 301, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• TrustedCertBytes
• TrustedCertHandle

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

This property is not available at design time.

Data Type

Integer

TrustedCertBytes Property (SecureBlackbox_IMAPClient Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getTrustedCertBytes($trustedcertindex);

Procedural Interface

secureblackbox_imapclient_get($res, 302 , $trustedcertindex);

Remarks

Returns the 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 (SecureBlackbox_IMAPClient Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Object Oriented Interface

public function getTrustedCertHandle($trustedcertindex);


public function setTrustedCertHandle($trustedcertindex, $value);

Procedural Interface

secureblackbox_imapclient_get($res, 310 , $trustedcertindex);


secureblackbox_imapclient_set($res, 310, $value , $trustedcertindex);

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 (SecureBlackbox_IMAPClient Class)

The authentication username.

Object Oriented Interface

public function getUsername();


public function setUsername($value);

Procedural Interface

secureblackbox_imapclient_get($res, 341 );


secureblackbox_imapclient_set($res, 341, $value );

Default Value

''

Remarks

Use this property to provide the username for authenticating to the IMAP server.

Data Type

String

CloseMailbox Method (SecureBlackbox_IMAPClient Class)

Closes the current mailbox.

Object Oriented Interface

public function doCloseMailbox();

Procedural Interface

secureblackbox_imapclient_do_closemailbox($res);

Remarks

Use this method to close (i.e. deselect) the currently selected mailbox.

Config Method (SecureBlackbox_IMAPClient Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

secureblackbox_imapclient_do_config($res, $configurationstring);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Connect Method (SecureBlackbox_IMAPClient Class)

Establishes a connection to the IMAP server.

Object Oriented Interface

public function doConnect($address, $port);

Procedural Interface

secureblackbox_imapclient_do_connect($res, $address, $port);

Remarks

Use this method to establish a connection to the IMAP server at Address and Port.

CopyMessage Method (SecureBlackbox_IMAPClient Class)

Copies a message to another mailbox.

Object Oriented Interface

public function doCopyMessage($uid, $mailboxname);

Procedural Interface

secureblackbox_imapclient_do_copymessage($res, $uid, $mailboxname);

Remarks

Copies a message specified by its UID to another mailbox.

CreateMailbox Method (SecureBlackbox_IMAPClient Class)

Creates a new mailbox.

Object Oriented Interface

public function doCreateMailbox($name);

Procedural Interface

secureblackbox_imapclient_do_createmailbox($res, $name);

Remarks

Call this method to create a new mailbox, providing the name via the Name parameter.

DeleteMailbox Method (SecureBlackbox_IMAPClient Class)

Deletes an existing mailbox.

Object Oriented Interface

public function doDeleteMailbox($name);

Procedural Interface

secureblackbox_imapclient_do_deletemailbox($res, $name);

Remarks

Call this method to delete a mailbox.

Disconnect Method (SecureBlackbox_IMAPClient Class)

Closes connection to the IMAP server.

Object Oriented Interface

public function doDisconnect();

Procedural Interface

secureblackbox_imapclient_do_disconnect($res);

Remarks

Call this method to gracefully terminate the connection.

DoAction Method (SecureBlackbox_IMAPClient Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

secureblackbox_imapclient_do_doaction($res, $actionid, $actionparams);

Remarks

DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

GetMailboxInfo Method (SecureBlackbox_IMAPClient Class)

Requests mailbox status.

Object Oriented Interface

public function doGetMailboxInfo($name);

Procedural Interface

secureblackbox_imapclient_do_getmailboxinfo($res, $name);

Remarks

Requests status information of the specified mailbox and returns it using MailboxInfo event.

ListMailboxes Method (SecureBlackbox_IMAPClient Class)

Queries a list of mailboxes available on the server.

Object Oriented Interface

public function doListMailboxes();

Procedural Interface

secureblackbox_imapclient_do_listmailboxes($res);

Remarks

Use this method to request a list of mailboxes currently available on the server. The mailbox names are separated from each other with a CRLF sequence.

Another way to handle mailboxes is to subscribe to the MailboxFound event. Using the event, it's possible to get not only mailbox names but mailbox attributes as well.

ListMessages Method (SecureBlackbox_IMAPClient Class)

Queries a list of messages available in the currently selected on the server.

Object Oriented Interface

public function doListMessages($flagsset, $flagsnotset);

Procedural Interface

secureblackbox_imapclient_do_listmessages($res, $flagsset, $flagsnotset);

Remarks

Call this method to request a list of messages with the set or not set flags available in the current mailbox.

FlagsSet and FlagsNotSet are bit masks of the following values:

If listed messages should have a flag set, pass it to FlagsSet. If listed messages should not have a flag, pass it to FlagsNotSet.

For example:

• if you need messages with the "draft" flag set, add imapMessageDraft to FlagsSet;
• if you need messages with no "seen" flag set, add imapMessageSeen to FlagsNotSet.

The flags in the parameters can be combined. For example, if you need messages with "answered" flag set but with no "flagged" flag set, pass imapMessageAnswered to FlagsSet and imapMessageFlagged to FlagsNotSet.

To list all the messages available in the selected mailbox, pass 0 to both parameters.

OpenMailbox Method (SecureBlackbox_IMAPClient Class)

Opens the specified mailbox.

Object Oriented Interface

public function doOpenMailbox($name, $readonly);

Procedural Interface

secureblackbox_imapclient_do_openmailbox($res, $name, $readonly);

Remarks

Use this method to open (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 Mailbox property.

Ping Method (SecureBlackbox_IMAPClient Class)

Sends a NOOP command to the IMAP server.

Object Oriented Interface

public function doPing();

Procedural Interface

secureblackbox_imapclient_do_ping($res);

Remarks

This method sends a NOOP command to the server, effectively pinging the server and keeping the connection alive.

PostBytes Method (SecureBlackbox_IMAPClient Class)

Uploads an e-mail message stored in a byte array.

Object Oriented Interface

public function doPostBytes($bytes, $flags, $internaldate);

Procedural Interface

secureblackbox_imapclient_do_postbytes($res, $bytes, $flags, $internaldate);

Remarks

Use this method to upload a message stored in a byte array specified by Bytes to Mailbox.

Supported flags are:

PostFile Method (SecureBlackbox_IMAPClient Class)

Uploads a message stored in a file to the current mailbox on the IMAP server.

Object Oriented Interface

public function doPostFile($filename, $flags, $internaldate);

Procedural Interface

secureblackbox_imapclient_do_postfile($res, $filename, $flags, $internaldate);

Remarks

Use this method to upload an e-mail message stored in a file to Mailbox.

Supported flags are:

PostMessage Method (SecureBlackbox_IMAPClient Class)

Uploads a pre-built message to the current mailbox on the IMAP server.

Object Oriented Interface

public function doPostMessage($flags, $internaldate);

Procedural Interface

secureblackbox_imapclient_do_postmessage($res, $flags, $internaldate);

Remarks

Use this message to upload Message to Mailbox.

Supported flags are:

PurgeMessages Method (SecureBlackbox_IMAPClient Class)

Permanently removes all deleted messages from the current mailbox.

Object Oriented Interface

public function doPurgeMessages();

Procedural Interface

secureblackbox_imapclient_do_purgemessages($res);

Remarks

Use this method to permanently remove all messages in Mailbox marked with the Deleted flag.

ReceiveBytes Method (SecureBlackbox_IMAPClient Class)

Downloads a message to a byte array.

Object Oriented Interface

public function doReceiveBytes($uid);

Procedural Interface

secureblackbox_imapclient_do_receivebytes($res, $uid);

Remarks

Use this method to download a server-side message to a byte array.

ReceiveFile Method (SecureBlackbox_IMAPClient Class)

Downloads a message to a file.

Object Oriented Interface

public function doReceiveFile($uid, $filename);

Procedural Interface

secureblackbox_imapclient_do_receivefile($res, $uid, $filename);

Remarks

Use this method to download a server-side message to a local file.

ReceiveMessage Method (SecureBlackbox_IMAPClient Class)

Downloads a message.

Object Oriented Interface

public function doReceiveMessage($uid);

Procedural Interface

secureblackbox_imapclient_do_receivemessage($res, $uid);

Remarks

Use this method to download a server-side message to the Message object.

RefreshMailbox Method (SecureBlackbox_IMAPClient Class)

Refreshes info about the currently selected mailbox.

Object Oriented Interface

public function doRefreshMailbox();

Procedural Interface

secureblackbox_imapclient_do_refreshmailbox($res);

Remarks

Use this method to refresh the Mailbox info.

To request information about other mailbox, call GetMailboxInfo.

RenameMailbox Method (SecureBlackbox_IMAPClient Class)

Renames an existing mailbox.

Object Oriented Interface

public function doRenameMailbox($name, $newname);

Procedural Interface

secureblackbox_imapclient_do_renamemailbox($res, $name, $newname);

Remarks

Use this method to rename an existing mailbox from Name to NewName.

Reset Method (SecureBlackbox_IMAPClient Class)

Resets the class settings.

Object Oriented Interface

public function doReset();

Procedural Interface

secureblackbox_imapclient_do_reset($res);

Remarks

Reset is a generic method available in every class.

UpdateMessage Method (SecureBlackbox_IMAPClient Class)

Alters flags assotiated with a message in the current mailbox on the IMAP server.

Object Oriented Interface

public function doUpdateMessage($uid, $setflags, $clearflags);

Procedural Interface

secureblackbox_imapclient_do_updatemessage($res, $uid, $setflags, $clearflags);

Remarks

Use this method to alter flags associated with a UID message in the currently selected mailbox.

Supported flags are:

If a flag is to be set, pass it to the SetFlags parameter. If a flag is to be cleared for a message, pass it to the ClearFlags parameter.

Notice: flags are cleared first, then set. So if you pass the same flag to both parameter, the flag will be set for the message.

AuthFailed Event (SecureBlackbox_IMAPClient Class)

Fires when an authentication attempt has failed.

Object Oriented Interface

public function fireAuthFailed($param);

Procedural Interface

secureblackbox_imapclient_register_callback($res, 1, array($this, 'fireAuthFailed'));

Parameter List

 'auth'
 'errorcode'
 'errormessage'
 'serverreply'
 'tryagain'

Remarks

The class fires this event when an authentication attempt has failed for some reason.

Auth reports the authentication method that has failed. You can adjust the Authentications config property to try another method.

ErrorCode contains an error code, and ErrorMessage contains an error message.

ServerReply provides the error info reported by the server. This info depends on the transport protocol and on the authentication method.

Set the TryAgain parameter to true if the class should try to authenticate again. If the parameter remains false, the authentication will fail with an exception.

AuthStart Event (SecureBlackbox_IMAPClient Class)

Fires when the authentication is about to be started.

Object Oriented Interface

public function fireAuthStart($param);

Procedural Interface

secureblackbox_imapclient_register_callback($res, 2, array($this, 'fireAuthStart'));

Parameter List

 'usableauths'

Remarks

The class fires this event when it has established the TCP connection and is ready to proceed to the user authentication step.

The UsableAuths parameter contains a comma-separated list of the authentication methods supported by both, the client and the server.

In this event handler it's possible to update the method list in the Authentications config property according to the provided list of usable methods. The full list of the authentication methods supported by the server is available in ServerInfo.SupportedAuths.

AuthSucceeded Event (SecureBlackbox_IMAPClient Class)

Fires when the authentication has succeeded.

Object Oriented Interface

public function fireAuthSucceeded($param);

Procedural Interface

secureblackbox_imapclient_register_callback($res, 3, array($this, 'fireAuthSucceeded'));

Parameter List

 'auth'

Remarks

The class fires this event when it has succeeded to authenticate to the server. Auth reports the authentication method that has succeeded.

Command Event (SecureBlackbox_IMAPClient Class)

Reports a command sent to the server.

Object Oriented Interface

public function fireCommand($param);

Procedural Interface

secureblackbox_imapclient_register_callback($res, 4, array($this, 'fireCommand'));

Parameter List

 'cmd'

Remarks

The class fires this event whenever it sends an IMAP command to the server. Use CommandReply and CommandReplyData to track the server's responses.

CommandData Event (SecureBlackbox_IMAPClient Class)

Returns the data that accompanies the command.

Object Oriented Interface

public function fireCommandData($param);

Procedural Interface

secureblackbox_imapclient_register_callback($res, 5, array($this, 'fireCommandData'));

Parameter List

 'cmd'
 'data'

Remarks

Subscribe to this event to access data accompanying the outgoing commands.

CommandReply Event (SecureBlackbox_IMAPClient Class)

Reports the receipt of a reply to a command.

Object Oriented Interface

public function fireCommandReply($param);

Procedural Interface

secureblackbox_imapclient_register_callback($res, 6, array($this, 'fireCommandReply'));

Parameter List

 'cmd'
 'reply'

Remarks

Use this event to track command replies sent in by the server. Use Command to track the commands sent out by the client, and CommandReplyData to access the reply data for commands that assume it.

CommandReplyData Event (SecureBlackbox_IMAPClient Class)

Returns the data that accompanies a reply to a command.

Object Oriented Interface

public function fireCommandReplyData($param);

Procedural Interface

secureblackbox_imapclient_register_callback($res, 7, array($this, 'fireCommandReplyData'));

Parameter List

 'cmd'
 'data'

Remarks

Subscribe to this event to access data accompanying incoming command replies.

Error Event (SecureBlackbox_IMAPClient Class)

Provides information about errors during SMTP operations.

Object Oriented Interface

public function fireError($param);

Procedural Interface

secureblackbox_imapclient_register_callback($res, 8, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

This event is fired in case of exceptional conditions occured during SMTP operations.

ErrorCode contains an error code and Description contains a textual description of the error.

MailboxFound Event (SecureBlackbox_IMAPClient Class)

Provides mailbox details.

Object Oriented Interface

public function fireMailboxFound($param);

Procedural Interface

secureblackbox_imapclient_register_callback($res, 9, array($this, 'fireMailboxFound'));

Parameter List

 'name'
 'delimiter'
 'attributes'

Remarks

Subscribe to this event to get mailbox details published by ListMailboxes.

Delimiter is a mailbox hierarchy delimiter.

Attributes value is bit mask of the following values:

MailboxInfo Event (SecureBlackbox_IMAPClient Class)

Reports mailbox information returned from the server.

Object Oriented Interface

public function fireMailboxInfo($param);

Procedural Interface

secureblackbox_imapclient_register_callback($res, 10, array($this, 'fireMailboxInfo'));

Parameter List

 'name'
 'totalmessages'
 'recentmessages'
 'unseenmessages'
 'nextuid'
 'uidvalidity'

Remarks

Subscribe to this event to be notified of mailbox info as returned by the IMAP server on GetMailboxInfo call.

Notification Event (SecureBlackbox_IMAPClient Class)

This event notifies the application about an underlying control flow event.

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

secureblackbox_imapclient_register_callback($res, 11, array($this, 'fireNotification'));

Parameter List

 'eventid'
 'eventparam'

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. 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 the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.

Progress Event (SecureBlackbox_IMAPClient Class)

Reports the progress of the data transfer operation.

Object Oriented Interface

public function fireProgress($param);

Procedural Interface

secureblackbox_imapclient_register_callback($res, 12, array($this, 'fireProgress'));

Parameter List

 'total'
 'current'
 'cancel'

Remarks

The class fires this event repeatedly to report the progress of the data transfer operation.

TLSCertNeeded Event (SecureBlackbox_IMAPClient Class)

Fires when a remote TLS party requests a client certificate.

Object Oriented Interface

public function fireTLSCertNeeded($param);

Procedural Interface

secureblackbox_imapclient_register_callback($res, 13, array($this, 'fireTLSCertNeeded'));

Parameter List

 'host'
 'canames'

Remarks

This event fires to notify the implementation that a remote TLS server has requested a client certificate. The Host parameter identifies the host that makes a request, and the CANames parameter (optional, according to the TLS spec) advises on the accepted issuing CAs.

Use the TLSClientChain property in response to this event to provide the requested certificate. Please make sure the client certificate includes the associated private key. Note that you may set the certificates before the connection without waiting for this event to fire.

This event is preceded by the TLSHandshake event for the given host and, if the certificate was accepted, succeeded by the TLSEstablished event.

TLSCertValidate Event (SecureBlackbox_IMAPClient Class)

This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.

Object Oriented Interface

public function fireTLSCertValidate($param);

Procedural Interface

secureblackbox_imapclient_register_callback($res, 14, array($this, 'fireTLSCertValidate'));

Parameter List

 'serverhost'
 'serverip'
 'accept'

Remarks

This event is fired during a TLS handshake. Use the TLSServerChain property to access the certificate chain. In general, classes may contact a number of TLS endpoints during their work, depending on their configuration.

Accept is assigned in accordance with the outcome of the internal validation check performed by the class, and can be adjusted if needed.

TLSEstablished Event (SecureBlackbox_IMAPClient Class)

Fires when a TLS handshake with Host successfully completes.

Object Oriented Interface

public function fireTLSEstablished($param);

Procedural Interface

secureblackbox_imapclient_register_callback($res, 15, array($this, 'fireTLSEstablished'));

Parameter List

 'host'
 'version'
 'ciphersuite'
 'connectionid'
 'abort'

Remarks

The class uses this event to notify the application about a successful completion of a TLS handshake.

The Version, Ciphersuite, and ConnectionId parameters indicate the security parameters of the new connection. Use the Abort parameter if you need to terminate the connection at this stage.

TLSHandshake Event (SecureBlackbox_IMAPClient Class)

Fires when a new TLS handshake is initiated, before the handshake commences.

Object Oriented Interface

public function fireTLSHandshake($param);

Procedural Interface

secureblackbox_imapclient_register_callback($res, 16, array($this, 'fireTLSHandshake'));

Parameter List

 'host'
 'abort'

Remarks

The class uses this event to notify the application about the start of a new TLS handshake to Host. If the handshake is successful, this event will be followed by the TLSEstablished event. If the server chooses to request a client certificate, the TLSCertNeeded event will also be fired.

TLSPSK Event (SecureBlackbox_IMAPClient Class)

Notifies the application about the PSK key exchange.

Object Oriented Interface

public function fireTLSPSK($param);

Procedural Interface

secureblackbox_imapclient_register_callback($res, 17, array($this, 'fireTLSPSK'));

Parameter List

 'host'
 'hint'

Remarks

The class fires this event to notify the application about the beginning of TLS-PSK key exchange with Host. The Hint parameter may be used by the server to identify the key or service to use. Use the PreSharedKey field of TLSSettings to provide the pre-shared key to the component.

TLSShutdown Event (SecureBlackbox_IMAPClient Class)

Reports the graceful closure of a TLS connection.

Object Oriented Interface

public function fireTLSShutdown($param);

Procedural Interface

secureblackbox_imapclient_register_callback($res, 18, array($this, 'fireTLSShutdown'));

Parameter List

 'host'

Remarks

This event notifies the application about the closure of an earlier established TLS connection. Note that only graceful connection closures are reported.

Config 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 Config Settings

Base Config Settings

Trappable Errors (IMAPClient Class)

IMAPClient Errors