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_examinemailbox($res, $name);
 secureblackbox_imapclient_do_getmailboxstatus($res, $name);
 secureblackbox_imapclient_do_listallmessages($res);
 secureblackbox_imapclient_do_listdeletedmessages($res);
 secureblackbox_imapclient_do_listmailboxes($res);
 secureblackbox_imapclient_do_listnewmessages($res);
 secureblackbox_imapclient_do_listrecentmessages($res);
 secureblackbox_imapclient_do_listunseenmessages($res);
 secureblackbox_imapclient_do_markmessagedeleted($res, $uid);
 secureblackbox_imapclient_do_markmessageseen($res, $uid);
 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_selectmailbox($res, $name);
 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.

Property List


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

BlockedCertCountThe number of records in the BlockedCert arrays.
BlockedCertBytesReturns the raw certificate data in DER format.
BlockedCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
ClientCertCountThe number of records in the ClientCert arrays.
ClientCertBytesReturns the raw certificate data in DER format.
ClientCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
ConnInfoAEADCipherIndicates whether the encryption algorithm used is an AEAD cipher.
ConnInfoChainValidationDetailsThe details of a certificate chain validation outcome.
ConnInfoChainValidationResultThe outcome of a certificate chain validation routine.
ConnInfoCiphersuiteThe cipher suite employed by this connection.
ConnInfoClientAuthenticatedSpecifies whether client authentication was performed during this connection.
ConnInfoClientAuthRequestedSpecifies whether client authentication was requested during this connection.
ConnInfoConnectionEstablishedIndicates whether the connection has been established fully.
ConnInfoConnectionIDThe unique identifier assigned to this connection.
ConnInfoDigestAlgorithmThe digest algorithm used in a TLS-enabled connection.
ConnInfoEncryptionAlgorithmThe symmetric encryption algorithm used in a TLS-enabled connection.
ConnInfoExportableIndicates whether a TLS connection uses a reduced-strength exportable cipher.
ConnInfoKeyExchangeAlgorithmThe key exchange algorithm used in a TLS-enabled connection.
ConnInfoKeyExchangeKeyBitsThe length of the key exchange key of a TLS-enabled connection.
ConnInfoNamedECCurveThe elliptic curve used in this connection.
ConnInfoPFSCipherIndicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).
ConnInfoPreSharedIdentityHintA hint professed by the server to help the client select the PSK identity to use.
ConnInfoPublicKeyBitsThe length of the public key.
ConnInfoResumedSessionIndicates whether a TLS-enabled connection was spawned from another TLS connection.
ConnInfoSecureConnectionIndicates whether TLS or SSL is enabled for this connection.
ConnInfoServerAuthenticatedIndicates whether server authentication was performed during a TLS-enabled connection.
ConnInfoSignatureAlgorithmThe signature algorithm used in a TLS handshake.
ConnInfoSymmetricBlockSizeThe block size of the symmetric algorithm used.
ConnInfoSymmetricKeyBitsThe key length of the symmetric algorithm used.
ConnInfoTotalBytesReceivedThe total number of bytes received over this connection.
ConnInfoTotalBytesSentThe total number of bytes sent over this connection.
ConnInfoValidationLogContains the server certificate's chain validation log.
ConnInfoVersionIndicates the version of SSL/TLS protocol negotiated during this connection.
CurrMailboxMessageFlagsContains message flags defined in the mailbox.
CurrMailboxNameSpecifies mailbox name.
CurrMailboxNextUIDReturns the next unique identifier value.
CurrMailboxPermanentFlagsContains a list of message flags that can be changed permanently.
CurrMailboxReadOnlySpecifies whether the mailbox is write-protected.
CurrMailboxRecentMessagesThe number of recent messages in the mailbox.
CurrMailboxTotalMessagesTotal number of messages in the mailbox.
CurrMailboxUIDValiditySpecifies UID validity value.
CurrMailboxUnseenMessagesThe number of unseen messages in the mailbox.
FIPSModeReserved.
KnownCertCountThe number of records in the KnownCert arrays.
KnownCertBytesReturns the raw certificate data in DER format.
KnownCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
KnownCRLCountThe number of records in the KnownCRL arrays.
KnownCRLBytesReturns the raw CRL data in DER format.
KnownCRLHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
KnownOCSPCountThe number of records in the KnownOCSP arrays.
KnownOCSPBytesA buffer containing the raw OCSP response data.
KnownOCSPHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
MailboxInfoCountThe number of records in the MailboxInfo arrays.
MailboxInfoDelimiterMailbox hierarchy delimiter.
MailboxInfoHasChildrenSpecifies whether the mailbox has \\HasChildren attribute specified.
MailboxInfoHasNoChildrenSpecifies whether the mailbox has \\HasNoChildren attribute specified.
MailboxInfoMarkedSpecifies whether the mailbox has \\Marked attribute specified.
MailboxInfoNameSpecifies mailbox name.
MailboxInfoNoInferiorsSpecifies whether the mailbox has \\NoInferiors attribute specified.
MailboxInfoNoSelectSpecifies whether the mailbox has \\NoSelect attribute specified.
MailboxInfoUnmarkedSpecifies whether the mailbox has \\Unmarked attribute specified.
MsgAttachmentCountReturns the number of attachments in this message.
MsgBccThe contents of the BCC header property.
MsgCcThe value of the CC header property.
MsgCommentsContains additional information about the message body.
MsgDateThe date and time when the message entered the mail delivery system.
MsgDeliveryReceiptEnables delivery notification.
MsgFromContains the value of the From header property.
MsgHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
MsgHtmlTextThe HTML version of the message.
MsgIDThe contents of the Message-ID header property.
MsgInReplyToThe value of the In-Reply-To header property.
MsgKeywordsThe value of the Keywords header property.
MsgMailerThe name of the software that was used to send the message.
MsgPlainTextThe plain text version of the message.
MsgPrioritySpecifies the message priority.
MsgReadReceiptEnables a read notification.
MsgReferencesThe value of the References header property.
MsgReplyToThe value of the Reply-To header property.
MsgReturnPathThe value of the Return-Path header property.
MsgSenderThe value of the Sender header property.
MsgSendToThe value of the To header property.
MsgSubjectContains the subject property of this message.
MsgInfoCountThe number of records in the MsgInfo arrays.
MsgInfoDateContains the value of the Date header property.
MsgInfoFlagsReturns the flags currently set to the mail message.
MsgInfoFromContains the value of the From header property.
MsgInfoInternalDateReturns the internal date of the mail message.
MsgInfoPrioritySpecifies the message priority.
MsgInfoSentToContains the value of the To header property.
MsgInfoSizeReturns the size of the message in bytes.
MsgInfoSubjectContains the value of the Subject header property.
MsgInfoUIDReturns the unique ID of the mail message.
PasswordThe authentication password.
ProxyAddressThe IP address of the proxy server.
ProxyAuthenticationThe authentication type used by the proxy server.
ProxyPasswordThe password to authenticate to the proxy server.
ProxyPortThe port on the proxy server to connect to.
ProxyProxyTypeThe type of the proxy server.
ProxyRequestHeadersContains HTTP request headers for WebTunnel and HTTP proxy.
ProxyResponseBodyContains the HTTP or HTTPS (WebTunnel) proxy response body.
ProxyResponseHeadersContains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.
ProxyUseIPv6Specifies whether IPv6 should be used when connecting through the proxy.
ProxyUseProxyEnables or disables proxy-driven connection.
ProxyUsernameSpecifies the username credential for proxy authentication.
ServerCertCountThe number of records in the ServerCert arrays.
ServerCertBytesReturns the raw certificate data in DER format.
ServerCertCAKeyIDA unique identifier (fingerprint) of the CA certificate's private key.
ServerCertFingerprintContains the fingerprint (a hash imprint) of this certificate.
ServerCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
ServerCertIssuerThe common name of the certificate issuer (CA), typically a company name.
ServerCertIssuerRDNA collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
ServerCertKeyAlgorithmSpecifies the public key algorithm of this certificate.
ServerCertKeyBitsReturns the length of the public key.
ServerCertKeyFingerprintReturns a fingerprint of the public key contained in the certificate.
ServerCertKeyUsageIndicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
ServerCertPublicKeyBytesContains the certificate's public key in DER format.
ServerCertSelfSignedIndicates whether the certificate is self-signed (root) or signed by an external CA.
ServerCertSerialNumberReturns the certificate's serial number.
ServerCertSigAlgorithmIndicates the algorithm that was used by the CA to sign this certificate.
ServerCertSubjectThe common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
ServerCertSubjectKeyIDContains a unique identifier (fingerprint) of the certificate's private key.
ServerCertSubjectRDNA collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
ServerCertValidFromThe time point at which the certificate becomes valid, in UTC.
ServerCertValidToThe time point at which the certificate expires, in UTC.
ServerInfoCapabilitiesReturns the list of server capabilities.
ServerInfoIdleSupportedIndicates whether the IMAP server supports the IDLE command.
ServerInfoLoginDisabledSpecifies whether the server forbids login.
SocketDNSModeSelects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system.
SocketDNSPortSpecifies the port number to be used for sending queries to the DNS server.
SocketDNSQueryTimeoutThe timeout (in milliseconds) for each DNS query.
SocketDNSServersThe addresses of DNS servers to use for address resolution, separated by commas or semicolons.
SocketDNSTotalTimeoutThe timeout (in milliseconds) for the whole resolution process.
SocketIncomingSpeedLimitThe maximum number of bytes to read from the socket, per second.
SocketLocalAddressThe local network interface to bind the socket to.
SocketLocalPortThe local port number to bind the socket to.
SocketOutgoingSpeedLimitThe maximum number of bytes to write to the socket, per second.
SocketTimeoutThe maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
SocketUseIPv6Enables or disables IP protocol version 6.
TLSAutoValidateCertificatesSpecifies whether server-side TLS certificates should be validated automatically using internal validation rules.
TLSBaseConfigurationSelects the base configuration for the TLS settings.
TLSCiphersuitesA list of ciphersuites separated with commas or semicolons.
TLSECCurvesDefines the elliptic curves to enable.
TLSExtensionsProvides access to TLS extensions.
TLSForceResumeIfDestinationChangesWhether to force TLS session resumption when the destination address changes.
TLSPreSharedIdentityDefines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
TLSPreSharedKeyContains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
TLSPreSharedKeyCiphersuiteDefines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
TLSRenegotiationAttackPreventionModeSelects the renegotiation attack prevention mechanism.
TLSRevocationCheckSpecifies the kind(s) of revocation check to perform.
TLSSSLOptionsVarious 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.
TLSTLSModeSpecifies the TLS mode to use.
TLSUseExtendedMasterSecretEnables the Extended Master Secret Extension, as defined in RFC 7627.
TLSUseSessionResumptionEnables or disables the TLS session resumption capability.
TLSVersionsThe SSL/TLS versions to enable by default.
TrustedCertCountThe number of records in the TrustedCert arrays.
TrustedCertBytesReturns the raw certificate data in DER format.
TrustedCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
UsernameThe authentication username.

Method List


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

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

Event List


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

BeforeAuthFires before the authentication starts.
CommandReports a command sent to the server.
CommandDataReturns the data that accompanies the command.
CommandReplyReports the receipt of a reply to a command.
CommandReplyDataReturns the data that accompanies a reply to a command.
ErrorProvides information about errors during SMTP operations.
MailboxStatusReports the mailbox status returned from the server.
NotificationThis event notifies the application about an underlying control flow event.
ProgressReports the progress of the data transfer operation.
TLSCertNeededFires when a remote TLS party requests a client certificate.
TLSCertValidateThis event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.
TLSEstablishedFires when a TLS handshake with Host successfully completes.
TLSHandshakeFires when a new TLS handshake is initiated, before the handshake commences.
TLSPSKNotifies the application about the PSK key exchange.
TLSShutdownReports the graceful closure of a TLS connection.

Config Settings


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

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

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, 1 );


secureblackbox_imapclient_set($res, 1, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is not available at design time.

Data Type

Integer

BlockedCertBytes Property (SecureBlackbox_IMAPClient Class)

Returns the raw certificate data in DER format.

Object Oriented Interface


public function getBlockedCertBytes($blockedcertindex);


Procedural Interface


secureblackbox_imapclient_get($res, 2 , $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, 9 , $blockedcertindex);


secureblackbox_imapclient_set($res, 9, $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

ClientCertCount Property (SecureBlackbox_IMAPClient Class)

The number of records in the ClientCert arrays.

Object Oriented Interface


public function getClientCertCount();


public function setClientCertCount($value);

Procedural Interface


secureblackbox_imapclient_get($res, 36 );


secureblackbox_imapclient_set($res, 36, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is not available at design time.

Data Type

Integer

ClientCertBytes Property (SecureBlackbox_IMAPClient Class)

Returns the raw certificate data in DER format.

Object Oriented Interface


public function getClientCertBytes($clientcertindex);


Procedural Interface


secureblackbox_imapclient_get($res, 37 , $clientcertindex);


Remarks

Returns the raw certificate data in DER format.

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

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

Data Type

Byte Array

ClientCertHandle Property (SecureBlackbox_IMAPClient Class)

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

Object Oriented Interface


public function getClientCertHandle($clientcertindex);


public function setClientCertHandle($clientcertindex, $value);

Procedural Interface


secureblackbox_imapclient_get($res, 44 , $clientcertindex);


secureblackbox_imapclient_set($res, 44, $value , $clientcertindex);

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

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

This property is not available at design time.

Data Type

Long64

ConnInfoAEADCipher Property (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, 71 );


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, 72 );


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:

cvrBadData0x0001One or more certificates in the validation path are malformed

cvrRevoked0x0002One or more certificates are revoked

cvrNotYetValid0x0004One or more certificates are not yet valid

cvrExpired0x0008One or more certificates are expired

cvrInvalidSignature0x0010A certificate contains a non-valid digital signature

cvrUnknownCA0x0020A CA certificate for one or more certificates has not been found (chain incomplete)

cvrCAUnauthorized0x0040One of the CA certificates are not authorized to act as CA

cvrCRLNotVerified0x0080One or more CRLs could not be verified

cvrOCSPNotVerified0x0100One or more OCSP responses could not be verified

cvrIdentityMismatch0x0200The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate

cvrNoKeyUsage0x0400A mandatory key usage is not enabled in one of the chain certificates

cvrBlocked0x0800One or more certificates are blocked

cvrFailure0x1000General validation failure

cvrChainLoop0x2000Chain loop: one of the CA certificates recursively signs itself

cvrWeakAlgorithm0x4000A weak algorithm is used in one of certificates or revocation elements

cvrUserEnforced0x8000The chain was considered invalid following intervention from a user code

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

Data Type

Integer

ConnInfoChainValidationResult Property (SecureBlackbox_IMAPClient Class)

The outcome of a certificate chain validation routine.

Object Oriented Interface


public function getConnInfoChainValidationResult();


Procedural Interface


secureblackbox_imapclient_get($res, 73 );


Default Value

0

Remarks

The outcome of a certificate chain validation routine.

Available options:

cvtValid0The chain is valid

cvtValidButUntrusted1The chain is valid, but the root certificate is not trusted

cvtInvalid2The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature)

cvtCantBeEstablished3The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses)

Use the ValidationLog property to access the detailed validation log.

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

Data Type

Integer

ConnInfoCiphersuite Property (SecureBlackbox_IMAPClient Class)

The cipher suite employed by this connection.

Object Oriented Interface


public function getConnInfoCiphersuite();


Procedural Interface


secureblackbox_imapclient_get($res, 74 );


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, 75 );


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, 76 );


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, 77 );


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, 78 );


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, 79 );


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, 80 );


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, 81 );


Default Value

false

Remarks

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

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

Data Type

Boolean

ConnInfoKeyExchangeAlgorithm Property (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, 82 );


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, 83 );


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, 84 );


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, 85 );


Default Value

false

Remarks

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

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

Data Type

Boolean

ConnInfoPreSharedIdentityHint Property (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, 86 );


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, 87 );


Default Value

0

Remarks

The length of the public key.

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

Data Type

Integer

ConnInfoResumedSession Property (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, 88 );


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, 89 );


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, 90 );


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, 91 );


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, 92 );


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, 93 );


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, 94 );


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, 95 );


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, 96 );


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, 97 );


Default Value

''

Remarks

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

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

Data Type

String

CurrMailboxMessageFlags Property (SecureBlackbox_IMAPClient Class)

Contains message flags defined in the mailbox.

Object Oriented Interface


public function getCurrMailboxMessageFlags();


Procedural Interface


secureblackbox_imapclient_get($res, 98 );


Default Value

0

Remarks

Contains message flags defined in the mailbox.

imapMessageAnswered0x01Message has been answered.

imapMessageDeleted0x02Message is 'deleted' for removal later.

imapMessageDraft0x04Message has not completed composition (marked as a draft).

imapMessageFlagged0x08Message is 'flagged' for urgent/special attention.

imapMessageRecent0x10Message is 'recently' arrived in this mailbox. This session is the first session to have been notified about this message.

imapMessageSeen0x20Message has been read.

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

Data Type

Integer

CurrMailboxName Property (SecureBlackbox_IMAPClient Class)

Specifies mailbox name.

Object Oriented Interface


public function getCurrMailboxName();


Procedural Interface


secureblackbox_imapclient_get($res, 99 );


Default Value

''

Remarks

Specifies mailbox name.

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

Data Type

String

CurrMailboxNextUID Property (SecureBlackbox_IMAPClient Class)

Returns the next unique identifier value.

Object Oriented Interface


public function getCurrMailboxNextUID();


Procedural Interface


secureblackbox_imapclient_get($res, 100 );


Default Value

0

Remarks

Returns the next unique identifier value.

Use this property to get or set the next unique identifier (corresponds to UIDNEXT status code).

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

Data Type

Integer

CurrMailboxPermanentFlags Property (SecureBlackbox_IMAPClient Class)

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

Object Oriented Interface


public function getCurrMailboxPermanentFlags();


Procedural Interface


secureblackbox_imapclient_get($res, 101 );


Default Value

0

Remarks

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

imapMessageAnswered0x01Message has been answered.

imapMessageDeleted0x02Message is 'deleted' for removal later.

imapMessageDraft0x04Message has not completed composition (marked as a draft).

imapMessageFlagged0x08Message is 'flagged' for urgent/special attention.

imapMessageRecent0x10Message is 'recently' arrived in this mailbox. This session is the first session to have been notified about this message.

imapMessageSeen0x20Message has been read.

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

Data Type

Integer

CurrMailboxReadOnly Property (SecureBlackbox_IMAPClient Class)

Specifies whether the mailbox is write-protected.

Object Oriented Interface


public function getCurrMailboxReadOnly();


Procedural Interface


secureblackbox_imapclient_get($res, 102 );


Default Value

false

Remarks

Specifies whether the mailbox is write-protected.

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

Data Type

Boolean

CurrMailboxRecentMessages Property (SecureBlackbox_IMAPClient Class)

The number of recent messages in the mailbox.

Object Oriented Interface


public function getCurrMailboxRecentMessages();


Procedural Interface


secureblackbox_imapclient_get($res, 103 );


Default Value

0

Remarks

The number of recent messages in the mailbox.

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

Data Type

Integer

CurrMailboxTotalMessages Property (SecureBlackbox_IMAPClient Class)

Total number of messages in the mailbox.

Object Oriented Interface


public function getCurrMailboxTotalMessages();


Procedural Interface


secureblackbox_imapclient_get($res, 104 );


Default Value

0

Remarks

Total number of messages in the mailbox.

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

Data Type

Integer

CurrMailboxUIDValidity Property (SecureBlackbox_IMAPClient Class)

Specifies UID validity value.

Object Oriented Interface


public function getCurrMailboxUIDValidity();


Procedural Interface


secureblackbox_imapclient_get($res, 105 );


Default Value

0

Remarks

Specifies UID validity value.

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

Data Type

Integer

CurrMailboxUnseenMessages Property (SecureBlackbox_IMAPClient Class)

The number of unseen messages in the mailbox.

Object Oriented Interface


public function getCurrMailboxUnseenMessages();


Procedural Interface


secureblackbox_imapclient_get($res, 106 );


Default Value

0

Remarks

The number of unseen messages in the mailbox.

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

Data Type

Integer

FIPSMode Property (SecureBlackbox_IMAPClient Class)

Reserved.

Object Oriented Interface


public function getFIPSMode();


public function setFIPSMode($value);

Procedural Interface


secureblackbox_imapclient_get($res, 107 );


secureblackbox_imapclient_set($res, 107, $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, 108 );


secureblackbox_imapclient_set($res, 108, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is not available at design time.

Data Type

Integer

KnownCertBytes Property (SecureBlackbox_IMAPClient Class)

Returns the raw certificate data in DER format.

Object Oriented Interface


public function getKnownCertBytes($knowncertindex);


Procedural Interface


secureblackbox_imapclient_get($res, 109 , $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, 116 , $knowncertindex);


secureblackbox_imapclient_set($res, 116, $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, 143 );


secureblackbox_imapclient_set($res, 143, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is not available at design time.

Data Type

Integer

KnownCRLBytes Property (SecureBlackbox_IMAPClient Class)

Returns the raw CRL data in DER format.

Object Oriented Interface


public function getKnownCRLBytes($knowncrlindex);


Procedural Interface


secureblackbox_imapclient_get($res, 144 , $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, 147 , $knowncrlindex);


secureblackbox_imapclient_set($res, 147, $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, 155 );


secureblackbox_imapclient_set($res, 155, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is not available at design time.

Data Type

Integer

KnownOCSPBytes Property (SecureBlackbox_IMAPClient Class)

A buffer containing the raw OCSP response data.

Object Oriented Interface


public function getKnownOCSPBytes($knownocspindex);


Procedural Interface


secureblackbox_imapclient_get($res, 156 , $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, 158 , $knownocspindex);


secureblackbox_imapclient_set($res, 158, $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

MailboxInfoCount Property (SecureBlackbox_IMAPClient Class)

The number of records in the MailboxInfo arrays.

Object Oriented Interface


public function getMailboxInfoCount();


Procedural Interface


secureblackbox_imapclient_get($res, 163 );


Default Value

0

Remarks

This property controls the size of the following arrays:

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

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

Data Type

Integer

MailboxInfoDelimiter Property (SecureBlackbox_IMAPClient Class)

Mailbox hierarchy delimiter.

Object Oriented Interface


public function getMailboxInfoDelimiter($mailboxinfoindex);


Procedural Interface


secureblackbox_imapclient_get($res, 164 , $mailboxinfoindex);


Default Value

''

Remarks

Mailbox hierarchy delimiter.

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

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

Data Type

String

MailboxInfoHasChildren Property (SecureBlackbox_IMAPClient Class)

Specifies whether the mailbox has \\HasChildren attribute specified.

Object Oriented Interface


public function getMailboxInfoHasChildren($mailboxinfoindex);


Procedural Interface


secureblackbox_imapclient_get($res, 165 , $mailboxinfoindex);


Default Value

false

Remarks

Specifies whether the mailbox has \HasChildren attribute specified.

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

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

Data Type

Boolean

MailboxInfoHasNoChildren Property (SecureBlackbox_IMAPClient Class)

Specifies whether the mailbox has \\HasNoChildren attribute specified.

Object Oriented Interface


public function getMailboxInfoHasNoChildren($mailboxinfoindex);


Procedural Interface


secureblackbox_imapclient_get($res, 166 , $mailboxinfoindex);


Default Value

false

Remarks

Specifies whether the mailbox has \HasNoChildren attribute specified.

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

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

Data Type

Boolean

MailboxInfoMarked Property (SecureBlackbox_IMAPClient Class)

Specifies whether the mailbox has \\Marked attribute specified.

Object Oriented Interface


public function getMailboxInfoMarked($mailboxinfoindex);


Procedural Interface


secureblackbox_imapclient_get($res, 167 , $mailboxinfoindex);


Default Value

false

Remarks

Specifies whether the mailbox has \Marked attribute specified.

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

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

Data Type

Boolean

MailboxInfoName Property (SecureBlackbox_IMAPClient Class)

Specifies mailbox name.

Object Oriented Interface


public function getMailboxInfoName($mailboxinfoindex);


Procedural Interface


secureblackbox_imapclient_get($res, 168 , $mailboxinfoindex);


Default Value

''

Remarks

Specifies mailbox name.

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

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

Data Type

String

MailboxInfoNoInferiors Property (SecureBlackbox_IMAPClient Class)

Specifies whether the mailbox has \\NoInferiors attribute specified.

Object Oriented Interface


public function getMailboxInfoNoInferiors($mailboxinfoindex);


Procedural Interface


secureblackbox_imapclient_get($res, 169 , $mailboxinfoindex);


Default Value

false

Remarks

Specifies whether the mailbox has \NoInferiors attribute specified.

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

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

Data Type

Boolean

MailboxInfoNoSelect Property (SecureBlackbox_IMAPClient Class)

Specifies whether the mailbox has \\NoSelect attribute specified.

Object Oriented Interface


public function getMailboxInfoNoSelect($mailboxinfoindex);


Procedural Interface


secureblackbox_imapclient_get($res, 170 , $mailboxinfoindex);


Default Value

false

Remarks

Specifies whether the mailbox has \NoSelect attribute specified.

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

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

Data Type

Boolean

MailboxInfoUnmarked Property (SecureBlackbox_IMAPClient Class)

Specifies whether the mailbox has \\Unmarked attribute specified.

Object Oriented Interface


public function getMailboxInfoUnmarked($mailboxinfoindex);


Procedural Interface


secureblackbox_imapclient_get($res, 171 , $mailboxinfoindex);


Default Value

false

Remarks

Specifies whether the mailbox has \Unmarked attribute specified.

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

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

Data Type

Boolean

MsgAttachmentCount Property (SecureBlackbox_IMAPClient Class)

Returns the number of attachments in this message.

Object Oriented Interface


public function getMsgAttachmentCount();


Procedural Interface


secureblackbox_imapclient_get($res, 172 );


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, 173 );


secureblackbox_imapclient_set($res, 173, $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, 174 );


secureblackbox_imapclient_set($res, 174, $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, 175 );


secureblackbox_imapclient_set($res, 175, $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, 176 );


secureblackbox_imapclient_set($res, 176, $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, 177 );


secureblackbox_imapclient_set($res, 177, $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, 178 );


secureblackbox_imapclient_set($res, 178, $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, 179 );


secureblackbox_imapclient_set($res, 179, $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, 180 );


secureblackbox_imapclient_set($res, 180, $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, 181 );


secureblackbox_imapclient_set($res, 181, $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, 182 );


secureblackbox_imapclient_set($res, 182, $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, 183 );


secureblackbox_imapclient_set($res, 183, $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, 184 );


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, 185 );


secureblackbox_imapclient_set($res, 185, $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, 186 );


secureblackbox_imapclient_set($res, 186, $value );

Default Value

2

Remarks

Specifies the message priority.

Available options:

mpLowest0
mpLow1
mpNormal2
mpHigh3
mpHighest4

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, 187 );


secureblackbox_imapclient_set($res, 187, $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, 188 );


secureblackbox_imapclient_set($res, 188, $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, 189 );


secureblackbox_imapclient_set($res, 189, $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, 190 );


secureblackbox_imapclient_set($res, 190, $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, 191 );


secureblackbox_imapclient_set($res, 191, $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, 192 );


secureblackbox_imapclient_set($res, 192, $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, 193 );


secureblackbox_imapclient_set($res, 193, $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, 194 );


Default Value

0

Remarks

This property controls the size of the following arrays:

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, 195 , $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, 196 , $msginfoindex);


Default Value

0

Remarks

Returns the flags currently set to the mail message.

Supported flags are:

imapMessageAnswered0x01Message has been answered.

imapMessageDeleted0x02Message is 'deleted' for removal later.

imapMessageDraft0x04Message has not completed composition (marked as a draft).

imapMessageFlagged0x08Message is 'flagged' for urgent/special attention.

imapMessageRecent0x10Message is 'recently' arrived in this mailbox. This session is the first session to have been notified about this message.

imapMessageSeen0x20Message has been read.

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, 197 , $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, 198 , $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, 199 , $msginfoindex);


Default Value

2

Remarks

Specifies the message priority.

Available options:

mpLowest0
mpLow1
mpNormal2
mpHigh3
mpHighest4

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, 200 , $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, 201 , $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, 202 , $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, 203 , $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, 204 );


secureblackbox_imapclient_set($res, 204, $value );

Default Value

''

Remarks

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

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, 205 );


secureblackbox_imapclient_set($res, 205, $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, 206 );


secureblackbox_imapclient_set($res, 206, $value );

Default Value

0

Remarks

The authentication type used by the proxy server.

patNoAuthentication0
patBasic1
patDigest2
patNTLM3

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, 207 );


secureblackbox_imapclient_set($res, 207, $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, 208 );


secureblackbox_imapclient_set($res, 208, $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, 209 );


secureblackbox_imapclient_set($res, 209, $value );

Default Value

0

Remarks

The type of the proxy server.

The WebTunnel proxy is also known as HTTPS proxy. Unlike HTTP proxy, HTTPS proxy (WebTunnel) provides end-to-end security.

cptNone0
cptSocks41
cptSocks52
cptWebTunnel3
cptHTTP4

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, 210 );


secureblackbox_imapclient_set($res, 210, $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, 211 );


secureblackbox_imapclient_set($res, 211, $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, 212 );


secureblackbox_imapclient_set($res, 212, $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, 213 );


secureblackbox_imapclient_set($res, 213, $value );

Default Value

false

Remarks

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

Data Type

Boolean

ProxyUseProxy Property (SecureBlackbox_IMAPClient Class)

Enables or disables proxy-driven connection.

Object Oriented Interface


public function getProxyUseProxy();


public function setProxyUseProxy($value);

Procedural Interface


secureblackbox_imapclient_get($res, 214 );


secureblackbox_imapclient_set($res, 214, $value );

Default Value

false

Remarks

Enables or disables proxy-driven connection.

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, 215 );


secureblackbox_imapclient_set($res, 215, $value );

Default Value

''

Remarks

Specifies the username credential for proxy authentication.

Data Type

String

ServerCertCount Property (SecureBlackbox_IMAPClient Class)

The number of records in the ServerCert arrays.

Object Oriented Interface


public function getServerCertCount();


Procedural Interface


secureblackbox_imapclient_get($res, 216 );


Default Value

0

Remarks

This property controls the size of the following arrays:

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

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

Data Type

Integer

ServerCertBytes Property (SecureBlackbox_IMAPClient Class)

Returns the raw certificate data in DER format.

Object Oriented Interface


public function getServerCertBytes($servercertindex);


Procedural Interface


secureblackbox_imapclient_get($res, 217 , $servercertindex);


Remarks

Returns the raw certificate data in DER format.

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

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

Data Type

Byte Array

ServerCertCAKeyID Property (SecureBlackbox_IMAPClient Class)

A unique identifier (fingerprint) of the CA certificate's private key.

Object Oriented Interface


public function getServerCertCAKeyID($servercertindex);


Procedural Interface


secureblackbox_imapclient_get($res, 219 , $servercertindex);


Remarks

A unique identifier (fingerprint) of the CA certificate's private key.

Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys.

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

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

Data Type

Byte Array

ServerCertFingerprint Property (SecureBlackbox_IMAPClient Class)

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

Object Oriented Interface


public function getServerCertFingerprint($servercertindex);


Procedural Interface


secureblackbox_imapclient_get($res, 222 , $servercertindex);


Remarks

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

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

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

Data Type

Byte Array

ServerCertHandle Property (SecureBlackbox_IMAPClient Class)

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

Object Oriented Interface


public function getServerCertHandle($servercertindex);


Procedural Interface


secureblackbox_imapclient_get($res, 224 , $servercertindex);


Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

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

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

Data Type

Long64

ServerCertIssuer Property (SecureBlackbox_IMAPClient Class)

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

Object Oriented Interface


public function getServerCertIssuer($servercertindex);


Procedural Interface


secureblackbox_imapclient_get($res, 226 , $servercertindex);


Default Value

''

Remarks

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

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

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

Data Type

String

ServerCertIssuerRDN Property (SecureBlackbox_IMAPClient Class)

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.

Object Oriented Interface


public function getServerCertIssuerRDN($servercertindex);


Procedural Interface


secureblackbox_imapclient_get($res, 227 , $servercertindex);


Default Value

''

Remarks

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.

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

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

Data Type

String

ServerCertKeyAlgorithm Property (SecureBlackbox_IMAPClient Class)

Specifies the public key algorithm of this certificate.

Object Oriented Interface


public function getServerCertKeyAlgorithm($servercertindex);


Procedural Interface


secureblackbox_imapclient_get($res, 228 , $servercertindex);


Default Value

'0'

Remarks

Specifies the public key algorithm of this certificate.

SB_CERT_ALGORITHM_ID_RSA_ENCRYPTIONrsaEncryption
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTIONmd2withRSAEncryption
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTIONmd5withRSAEncryption
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTIONsha1withRSAEncryption
SB_CERT_ALGORITHM_ID_DSAid-dsa
SB_CERT_ALGORITHM_ID_DSA_SHA1id-dsa-with-sha1
SB_CERT_ALGORITHM_DH_PUBLICdhpublicnumber
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTIONsha224WithRSAEncryption
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTIONsha256WithRSAEncryption
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTIONsha384WithRSAEncryption
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTIONsha512WithRSAEncryption
SB_CERT_ALGORITHM_ID_RSAPSSid-RSASSA-PSS
SB_CERT_ALGORITHM_ID_RSAOAEPid-RSAES-OAEP
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160ripemd160withRSA
SB_CERT_ALGORITHM_ID_ELGAMALelGamal
SB_CERT_ALGORITHM_SHA1_ECDSAecdsa-with-SHA1
SB_CERT_ALGORITHM_RECOMMENDED_ECDSAecdsa-recommended
SB_CERT_ALGORITHM_SHA224_ECDSAecdsa-with-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSAecdsa-with-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSAecdsa-with-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSAecdsa-with-SHA512
SB_CERT_ALGORITHM_ECid-ecPublicKey
SB_CERT_ALGORITHM_SPECIFIED_ECDSAecdsa-specified
SB_CERT_ALGORITHM_GOST_R3410_1994id-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3410_2001id-GostR3410-2001
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994id-GostR3411-94-with-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001id-GostR3411-94-with-GostR3410-2001
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAINecdsa-plain-SHA1
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAINecdsa-plain-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAINecdsa-plain-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAINecdsa-plain-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAINecdsa-plain-SHA512
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAINecdsa-plain-RIPEMD160
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTIONwhirlpoolWithRSAEncryption
SB_CERT_ALGORITHM_ID_DSA_SHA224id-dsa-with-sha224
SB_CERT_ALGORITHM_ID_DSA_SHA256id-dsa-with-sha256
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSAid-ecdsa-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSAid-ecdsa-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSAid-ecdsa-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSAid-ecdsa-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAINid-ecdsa-plain-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAINid-ecdsa-plain-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAINid-ecdsa-plain-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAINid-ecdsa-plain-with-sha3-512
SB_CERT_ALGORITHM_ID_DSA_SHA3_224id-dsa-with-sha3-224
SB_CERT_ALGORITHM_ID_DSA_SHA3_256id-dsa-with-sha3-256
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSAid-ecdsa-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSAid-ecdsa-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSAid-ecdsa-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSAid-ecdsa-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSAid-ecdsa-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSAid-ecdsa-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSAid-ecdsa-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSAid-ecdsa-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAINid-ecdsa-plain-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAINid-ecdsa-plain-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAINid-ecdsa-plain-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAINid-ecdsa-plain-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAINid-ecdsa-plain-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAINid-ecdsa-plain-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAINid-ecdsa-plain-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAINid-ecdsa-plain-with-blake2b512
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224id-dsa-with-blake2s224
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256id-dsa-with-blake2s256
SB_CERT_ALGORITHM_EDDSA_ED25519id-Ed25519
SB_CERT_ALGORITHM_EDDSA_ED448id-Ed448
SB_CERT_ALGORITHM_EDDSA_ED25519_PHid-Ed25519ph
SB_CERT_ALGORITHM_EDDSA_ED448_PHid-Ed448ph
SB_CERT_ALGORITHM_EDDSAid-EdDSA
SB_CERT_ALGORITHM_EDDSA_SIGNATUREid-EdDSA-sig

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

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

Data Type

String

ServerCertKeyBits Property (SecureBlackbox_IMAPClient Class)

Returns the length of the public key.

Object Oriented Interface


public function getServerCertKeyBits($servercertindex);


Procedural Interface


secureblackbox_imapclient_get($res, 229 , $servercertindex);


Default Value

0

Remarks

Returns the length of the public key.

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

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

Data Type

Integer

ServerCertKeyFingerprint Property (SecureBlackbox_IMAPClient Class)

Returns a fingerprint of the public key contained in the certificate.

Object Oriented Interface


public function getServerCertKeyFingerprint($servercertindex);


Procedural Interface


secureblackbox_imapclient_get($res, 230 , $servercertindex);


Remarks

Returns a fingerprint of the public key contained in the certificate.

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

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

Data Type

Byte Array

ServerCertKeyUsage Property (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 getServerCertKeyUsage($servercertindex);


Procedural Interface


secureblackbox_imapclient_get($res, 231 , $servercertindex);


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:

ckuUnknown0x00000Unknown key usage

ckuDigitalSignature0x00001Digital signature

ckuNonRepudiation0x00002Non-repudiation

ckuKeyEncipherment0x00004Key encipherment

ckuDataEncipherment0x00008Data encipherment

ckuKeyAgreement0x00010Key agreement

ckuKeyCertSign0x00020Certificate signing

ckuCRLSign0x00040Revocation signing

ckuEncipherOnly0x00080Encipher only

ckuDecipherOnly0x00100Decipher only

ckuServerAuthentication0x00200Server authentication

ckuClientAuthentication0x00400Client authentication

ckuCodeSigning0x00800Code signing

ckuEmailProtection0x01000Email protection

ckuTimeStamping0x02000Timestamping

ckuOCSPSigning0x04000OCSP signing

ckuSmartCardLogon0x08000Smartcard logon

ckuKeyPurposeClientAuth0x10000Kerberos - client authentication

ckuKeyPurposeKDC0x20000Kerberos - KDC

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

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

Data Type

Integer

ServerCertPublicKeyBytes Property (SecureBlackbox_IMAPClient Class)

Contains the certificate's public key in DER format.

Object Oriented Interface


public function getServerCertPublicKeyBytes($servercertindex);


Procedural Interface


secureblackbox_imapclient_get($res, 240 , $servercertindex);


Remarks

Contains the certificate's public key in DER format.

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

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

Data Type

Byte Array

ServerCertSelfSigned Property (SecureBlackbox_IMAPClient Class)

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

Object Oriented Interface


public function getServerCertSelfSigned($servercertindex);


Procedural Interface


secureblackbox_imapclient_get($res, 242 , $servercertindex);


Default Value

false

Remarks

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

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

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

Data Type

Boolean

ServerCertSerialNumber Property (SecureBlackbox_IMAPClient Class)

Returns the certificate's serial number.

Object Oriented Interface


public function getServerCertSerialNumber($servercertindex);


Procedural Interface


secureblackbox_imapclient_get($res, 243 , $servercertindex);


Remarks

Returns the certificate's serial number.

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

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

Data Type

Byte Array

ServerCertSigAlgorithm Property (SecureBlackbox_IMAPClient Class)

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

Object Oriented Interface


public function getServerCertSigAlgorithm($servercertindex);


Procedural Interface


secureblackbox_imapclient_get($res, 244 , $servercertindex);


Default Value

''

Remarks

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

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

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

Data Type

String

ServerCertSubject Property (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 getServerCertSubject($servercertindex);


Procedural Interface


secureblackbox_imapclient_get($res, 245 , $servercertindex);


Default Value

''

Remarks

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

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

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

Data Type

String

ServerCertSubjectKeyID Property (SecureBlackbox_IMAPClient Class)

Contains a unique identifier (fingerprint) of the certificate's private key.

Object Oriented Interface


public function getServerCertSubjectKeyID($servercertindex);


Procedural Interface


secureblackbox_imapclient_get($res, 247 , $servercertindex);


Remarks

Contains a unique identifier (fingerprint) of the certificate's private key.

Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key.

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

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

Data Type

Byte Array

ServerCertSubjectRDN Property (SecureBlackbox_IMAPClient Class)

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

Object Oriented Interface


public function getServerCertSubjectRDN($servercertindex);


Procedural Interface


secureblackbox_imapclient_get($res, 248 , $servercertindex);


Default Value

''

Remarks

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

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

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

Data Type

String

ServerCertValidFrom Property (SecureBlackbox_IMAPClient Class)

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

Object Oriented Interface


public function getServerCertValidFrom($servercertindex);


Procedural Interface


secureblackbox_imapclient_get($res, 249 , $servercertindex);


Default Value

''

Remarks

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

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

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

Data Type

String

ServerCertValidTo Property (SecureBlackbox_IMAPClient Class)

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

Object Oriented Interface


public function getServerCertValidTo($servercertindex);


Procedural Interface


secureblackbox_imapclient_get($res, 250 , $servercertindex);


Default Value

''

Remarks

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

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

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

Data Type

String

ServerInfoCapabilities Property (SecureBlackbox_IMAPClient Class)

Returns the list of server capabilities.

Object Oriented Interface


public function getServerInfoCapabilities();


Procedural Interface


secureblackbox_imapclient_get($res, 251 );


Default Value

''

Remarks

Returns the list of server capabilities.

Use this property to get the list of IMAP capabilities (i.e., optional functionality of the server as defined in [RFC 3501]) obtained from the server.

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

Data Type

String

ServerInfoIdleSupported Property (SecureBlackbox_IMAPClient Class)

Indicates whether the IMAP server supports the IDLE command.

Object Oriented Interface


public function getServerInfoIdleSupported();


Procedural Interface


secureblackbox_imapclient_get($res, 252 );


Default Value

false

Remarks

Indicates whether the IMAP server supports the IDLE command.

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

Data Type

Boolean

ServerInfoLoginDisabled Property (SecureBlackbox_IMAPClient Class)

Specifies whether the server forbids login.

Object Oriented Interface


public function getServerInfoLoginDisabled();


Procedural Interface


secureblackbox_imapclient_get($res, 253 );


Default Value

false

Remarks

Specifies whether the server forbids login.

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

Data Type

Boolean

SocketDNSMode Property (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, 254 );


secureblackbox_imapclient_set($res, 254, $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.

dmAuto0
dmPlatform1
dmOwn2
dmOwnSecure3

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, 255 );


secureblackbox_imapclient_set($res, 255, $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, 256 );


secureblackbox_imapclient_set($res, 256, $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, 257 );


secureblackbox_imapclient_set($res, 257, $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, 258 );


secureblackbox_imapclient_set($res, 258, $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, 259 );


secureblackbox_imapclient_set($res, 259, $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, 260 );


secureblackbox_imapclient_set($res, 260, $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, 261 );


secureblackbox_imapclient_set($res, 261, $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, 262 );


secureblackbox_imapclient_set($res, 262, $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, 263 );


secureblackbox_imapclient_set($res, 263, $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, 264 );


secureblackbox_imapclient_set($res, 264, $value );

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

Boolean

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, 265 );


secureblackbox_imapclient_set($res, 265, $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, 266 );


secureblackbox_imapclient_set($res, 266, $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.

stpcDefault0
stpcCompatible1
stpcComprehensiveInsecure2
stpcHighlySecure3

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, 267 );


secureblackbox_imapclient_set($res, 267, $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

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, 268 );


secureblackbox_imapclient_set($res, 268, $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, 269 );


secureblackbox_imapclient_set($res, 269, $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, 270 );


secureblackbox_imapclient_set($res, 270, $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, 271 );


secureblackbox_imapclient_set($res, 271, $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, 272 );


secureblackbox_imapclient_set($res, 272, $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, 273 );


secureblackbox_imapclient_set($res, 273, $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, 274 );


secureblackbox_imapclient_set($res, 274, $value );

Default Value

0

Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:

crapmCompatible0TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled).
crapmStrict1Renegotiation attack prevention is enabled and enforced.
crapmAuto2Automatically choose whether to enable or disable renegotiation attack prevention.

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, 275 );


secureblackbox_imapclient_set($res, 275, $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.

crcNone0No revocation checking.
crcAuto1Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future.
crcAllCRL2All provided CRL endpoints will be checked, and all checks must succeed.
crcAllOCSP3All provided OCSP endpoints will be checked, and all checks must succeed.
crcAllCRLAndOCSP4All provided CRL and OCSP endpoints will be checked, and all checks must succeed.
crcAnyCRL5All provided CRL endpoints will be checked, and at least one check must succeed.
crcAnyOCSP6All provided OCSP endpoints will be checked, and at least one check must succeed.
crcAnyCRLOrOCSP7All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first.
crcAnyOCSPOrCRL8All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first.

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, 276 );


secureblackbox_imapclient_set($res, 276, $value );

Default Value

16

Remarks

Various SSL (TLS) protocol options, set of

cssloExpectShutdownMessage0x001Wait for the close-notify message when shutting down the connection

cssloOpenSSLDTLSWorkaround0x002(DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions

cssloDisableKexLengthAlignment0x004Do not align the client-side PMS by the RSA modulus size. It is unlikely that you will ever need to adjust it.

cssloForceUseOfClientCertHashAlg0x008Enforce the use of the client certificate hash algorithm. It is unlikely that you will ever need to adjust it.

cssloAutoAddServerNameExtension0x010Automatically add the server name extension when known

cssloAcceptTrustedSRPPrimesOnly0x020Accept trusted SRP primes only

cssloDisableSignatureAlgorithmsExtension0x040Disable (do not send) the signature algorithms extension. It is unlikely that you will ever need to adjust it.

cssloIntolerateHigherProtocolVersions0x080(server option) Do not allow fallback from TLS versions higher than currently enabled

cssloStickToPrefCertHashAlg0x100Stick to preferred certificate hash algorithms

cssloNoImplicitTLS12Fallback0x200Disable implicit TLS 1.3 to 1.2 fallbacks

cssloUseHandshakeBatches0x400Send the handshake message as large batches rather than individually

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, 277 );


secureblackbox_imapclient_set($res, 277, $value );

Default Value

0

Remarks

Specifies the TLS mode to use.

smDefault0
smNoTLS1Do not use TLS
smExplicitTLS2Connect to the server without any encryption and then request an SSL session.
smImplicitTLS3Connect to the specified port, and establish the SSL session at once.
smMixedTLS4Connect to the specified port, and establish the SSL session at once, but allow plain data.

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, 278 );


secureblackbox_imapclient_set($res, 278, $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, 279 );


secureblackbox_imapclient_set($res, 279, $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, 280 );


secureblackbox_imapclient_set($res, 280, $value );

Default Value

16

Remarks

The SSL/TLS versions to enable by default.

csbSSL20x01SSL 2

csbSSL30x02SSL 3

csbTLS10x04TLS 1.0

csbTLS110x08TLS 1.1

csbTLS120x10TLS 1.2

csbTLS130x20TLS 1.3

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, 281 );


secureblackbox_imapclient_set($res, 281, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is not available at design time.

Data Type

Integer

TrustedCertBytes Property (SecureBlackbox_IMAPClient Class)

Returns the raw certificate data in DER format.

Object Oriented Interface


public function getTrustedCertBytes($trustedcertindex);


Procedural Interface


secureblackbox_imapclient_get($res, 282 , $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, 289 , $trustedcertindex);


secureblackbox_imapclient_set($res, 289, $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, 316 );


secureblackbox_imapclient_set($res, 316, $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 the CurrentMailbox.

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;....

ActionParametersReturned value
SearchA criteria for the SEARCH command. If the value is empty, the criteria is considered 'ALL'. For more details, see SEARCH command in RFC 3501UIDs of messages relevant to the criteria, separated by a space

ExamineMailbox Method (SecureBlackbox_IMAPClient Class)

Selects the mailbox in read-only mode.

Object Oriented Interface

public function doExamineMailbox($name);

Procedural Interface

secureblackbox_imapclient_do_examinemailbox($res, $name);

Remarks

Use this method to select the specified mailbox on the server in read-only mode. Only one mailbox can be selected at a time. You can check the name of the currently selected mailbox using the CurrentMailbox property.

GetMailboxStatus Method (SecureBlackbox_IMAPClient Class)

Requests a mailbox status.

Object Oriented Interface

public function doGetMailboxStatus($name);

Procedural Interface

secureblackbox_imapclient_do_getmailboxstatus($res, $name);

Remarks

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

ListAllMessages Method (SecureBlackbox_IMAPClient Class)

Queries a list of messages available in CurrentMailbox on the server.

Object Oriented Interface

public function doListAllMessages();

Procedural Interface

secureblackbox_imapclient_do_listallmessages($res);

Remarks

Call this method to request a list of messages available in the current mailbox.

ListDeletedMessages Method (SecureBlackbox_IMAPClient Class)

Queries a list of deleted messages in the current mailbox on the server.

Object Oriented Interface

public function doListDeletedMessages();

Procedural Interface

secureblackbox_imapclient_do_listdeletedmessages($res);

Remarks

Call this method to enumerate deleted messages (i.e. those having Deleted flag set) in CurrentMailbox.

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. Use the Mailboxes property to access the mailbox details.

ListNewMessages Method (SecureBlackbox_IMAPClient Class)

Queries a list of new messages available in the current mailbox on the mail server.

Object Oriented Interface

public function doListNewMessages();

Procedural Interface

secureblackbox_imapclient_do_listnewmessages($res);

Remarks

Retrieves a list of new messages (i.e. those having Recent flag set and not having Seen flag set) present in CurrentMailbox.

ListRecentMessages Method (SecureBlackbox_IMAPClient Class)

Queries a list of recent messages available in the current mailbox on the server.

Object Oriented Interface

public function doListRecentMessages();

Procedural Interface

secureblackbox_imapclient_do_listrecentmessages($res);

Remarks

Retrieves a list of recent messages (i.e. those having Recent flag set) present in CurrentMailbox.

ListUnseenMessages Method (SecureBlackbox_IMAPClient Class)

Queries a list of unseen messages available in the current mailbox on the server.

Object Oriented Interface

public function doListUnseenMessages();

Procedural Interface

secureblackbox_imapclient_do_listunseenmessages($res);

Remarks

Requests a list of unseen messages (i.e. not having Seen flag set) present in CurrentMailbox.

MarkMessageDeleted Method (SecureBlackbox_IMAPClient Class)

Sets a Deleted flag to the message.

Object Oriented Interface

public function doMarkMessageDeleted($uid);

Procedural Interface

secureblackbox_imapclient_do_markmessagedeleted($res, $uid);

Remarks

Use this method to mark a message as deleted, then call PurgeMessages to remove all the marked messages from the server.

MarkMessageSeen Method (SecureBlackbox_IMAPClient Class)

Sets a Seen flag to the message.

Object Oriented Interface

public function doMarkMessageSeen($uid);

Procedural Interface

secureblackbox_imapclient_do_markmessageseen($res, $uid);

Remarks

Use this method to mark a message as seen.

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 send a message stored in a byte array specified by Bytes.

Supported flags are:

imapMessageAnswered0x01Message has been answered.

imapMessageDeleted0x02Message is 'deleted' for removal later.

imapMessageDraft0x04Message has not completed composition (marked as a draft).

imapMessageFlagged0x08Message is 'flagged' for urgent/special attention.

imapMessageRecent0x10Message is 'recently' arrived in this mailbox. This session is the first session to have been notified about this message.

imapMessageSeen0x20Message has been read.

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 CurrentMailbox.

Supported flags are:

imapMessageAnswered0x01Message has been answered.

imapMessageDeleted0x02Message is 'deleted' for removal later.

imapMessageDraft0x04Message has not completed composition (marked as a draft).

imapMessageFlagged0x08Message is 'flagged' for urgent/special attention.

imapMessageRecent0x10Message is 'recently' arrived in this mailbox. This session is the first session to have been notified about this message.

imapMessageSeen0x20Message has been read.

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 CurrentMailbox.

Supported flags are:

imapMessageAnswered0x01Message has been answered.

imapMessageDeleted0x02Message is 'deleted' for removal later.

imapMessageDraft0x04Message has not completed composition (marked as a draft).

imapMessageFlagged0x08Message is 'flagged' for urgent/special attention.

imapMessageRecent0x10Message is 'recently' arrived in this mailbox. This session is the first session to have been notified about this message.

imapMessageSeen0x20Message has been read.

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 CurrentMailbox 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 the state info of the current mailbox.

Object Oriented Interface

public function doRefreshMailbox();

Procedural Interface

secureblackbox_imapclient_do_refreshmailbox($res);

Remarks

Use this method to refresh the CurrentMailbox info.

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.

SelectMailbox Method (SecureBlackbox_IMAPClient Class)

Selects the specified mailbox.

Object Oriented Interface

public function doSelectMailbox($name);

Procedural Interface

secureblackbox_imapclient_do_selectmailbox($res, $name);

Remarks

Use this method to select the specified mailbox on the server. Only one mailbox can be selected at a time. You can check the name of the currently selected mailbox using the CurrentMailbox property.

UpdateMessage Method (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 CurrentMailbox.

Supported flags are:

imapMessageAnswered0x01Message has been answered.

imapMessageDeleted0x02Message is 'deleted' for removal later.

imapMessageDraft0x04Message has not completed composition (marked as a draft).

imapMessageFlagged0x08Message is 'flagged' for urgent/special attention.

imapMessageRecent0x10Message is 'recently' arrived in this mailbox. This session is the first session to have been notified about this message.

imapMessageSeen0x20Message has been read.

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.

BeforeAuth Event (SecureBlackbox_IMAPClient Class)

Fires before the authentication starts.

Object Oriented Interface

public function fireBeforeAuth($param);

Procedural Interface

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

Parameter List


Remarks

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

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, 2, 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, 3, 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, 4, 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, 5, 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, 6, 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.

MailboxStatus Event (SecureBlackbox_IMAPClient Class)

Reports the mailbox status returned from the server.

Object Oriented Interface

public function fireMailboxStatus($param);

Procedural Interface

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

Parameter List

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

Remarks

Subscribe to this event to be notified of mailbox status as returned by the IMAP server.

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, 8, 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.

EventIDEventParam
MessageAddedNumber of messages in the current mailbox.
MessageDeletedUID of the deleted message if the message is in the current message list.
MessageUpdatedUID of the updated message if the message is in the current message list.

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, 9, 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, 10, 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, 11, 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, 12, 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, 13, 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, 14, 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, 15, 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

Authentications:   Specifies enabled authentication methods and their priorities.

Use this setting to enable or disable authentication methods and specify their priorities. The setting contains a comma-separated list of authentication methods. The first method in the list has the highest priority, and so on. The class will use the first method from the list which is supported by the server.

Supported methods: PLAIN, LOGIN, CRAM-MD5, DIGEST-MD5, NTLM, GSSAPI, XOAUTH2, SCRAM-SHA-1, SCRAM-SHA-256

Default value: PLAIN,DIGEST-MD5,CRAM-MD5,NTLM

IdleAuto:   Specifies whether idle mode should be requested automatically.

Set this property to true to force this client to automatically send IDLE request to the server. Default value is false.

IdleTimeout:   Specifies idle timeout in seconds.

If IDLE command is running on a server, and a client has been inactive for some time, the server may log the client off. Set this property to a maximum period of time after which this client should resend the IDLE command. The default value is 1740 seconds (29 minutes).

IgnoreSystemTrust:   Whether trusted Windows Certificate Stores should be treated as trusted.

Specifies whether, during chain validation, the class should respect the trust to CA certificates as configured in the operating system. In Windows this effectively defines whether the class should trust the certificates residing in the Trusted Root Certification Authorities store.

If IgnoreSystemTrust is True, certificates residing in the trusted root store are treated as if they are known, rather than trusted. Only certificates provided via other means (such as the TrustedCertificates property) are considered trusted.

ListCriteria:   Specifies an advanced criteria for listing messages on the server.

Use this setting to list messages based on additional criteria like message date, size, etc. For more details, see SEARCH command in RFC 3501

MaxLineLength:   Specifies maximum expected line length.

Use this setting to specify how long the expected mail line can be. Setting the very long value leads to memory increase. Default value is 10000.

MessageHeaderZZZ[i]:   A value of ZZZ header field for message i.

Returns the value of the header field named ZZZ for the message with index i. If the message doesn't contain such header field, the returned value is an empty line.

For example, to get a value of the Content-Type header field, use MessageHeaderContentType[i] config name.

OtherHeaders:   Specifies header fields to request when lists messages on the server.

Use this setting to request additional header fields for each message on the server. The setting contains a comma-separated list of header field names that should be requested when the class lists messages. To request all the fields, use "OtherHeaders=*". To not request additional header fields, use "OtherHeaders=".

SendingBufferSize:   Specifies the size of the buffer used to post messages to the server.

Use this setting to specify how much memory to use for the temporary buffer when a message is uploaded to the server. Default value is 64KB.

TempPath:   Path for storing temporary files.

This setting specifies an absolute path to the location on disk where temporary files are stored.

TolerateMinorChainIssues:   Whether to tolerate minor chain issues.

This parameter controls whether the chain validator should tolerate minor technical issues when validating the chain. Those are:

  • CA, revocation source, TLS key usage requirements are not mandated
  • Violation of OCSP issuer requirements are ignored
  • The AuthorityKeyID extension in CRL- and certificate-issuing CAs are ignored (helps with incorrectly renewed certificates)
  • Basic constraints and name constraints of CA certificates are ignored
  • Some weaker algorithms are tolerated
UseMicrosoftCTL:   Enables or disables the automatic use of the Microsoft online certificate trust list.

Enable this property to make the chain validation module automatically look up missing CA certificates in the public Windows Update repository.

UseSystemCertificates:   Enables or disables the use of the system certificates.

Use this property to tell the chain validation module to automatically look up missing CA certificates in the system certificates. In many cases it is beneficial to switch this property on, as the operating system certificate configuration provides a representative trust framework.

Base Config Settings

CheckKeyIntegrityBeforeUse:   Enables or disable private key integrity check before use.

This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used.

You can switch this property off to improve performance if your project only uses known, good private keys.

CookieCaching:   Specifies whether a cookie cache should be used for HTTP(S) transports.

Set this property to enable or disable cookies caching for the class.

Supported values are:

offNo caching (default)
localLocal caching
globalGlobal caching

Cookies:   Gets or sets local cookies for the class.

Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions.

DefDeriveKeyIterations:   Specifies the default key derivation algorithm iteration count.

This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided.

EnableClientSideSSLFFDHE:   Enables or disables finite field DHE key exchange support in TLS clients.

This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections.

This setting only applies to sessions negotiated with TLS version 1.3.

GlobalCookies:   Gets or sets global cookies for all the HTTP transports.

Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its CookieCaching property set to "global".

HttpUserAgent:   Specifies the user agent name to be used by all HTTP clients.

This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes.

LogDestination:   Specifies the debug log destination.

Contains a comma-separated list of values that specifies where debug log should be dumped.

Supported values are:

fileFile
consoleConsole
systemlogSystem Log (supported for Android only)
debuggerDebugger (supported for VCL for Windows and .Net)

LogDetails:   Specifies the debug log details to dump.

Contains a comma-separated list of values that specifies which debug log details to dump.

Supported values are:

timeCurrent time
levelLevel
packagePackage name
moduleModule name
classClass name
methodMethod name
threadidThread Id
contenttypeContent type
contentContent
allAll details

LogFile:   Specifies the debug log filename.

Use this property to provide a path to the log file.

LogFilters:   Specifies the debug log filters.

Contains a comma-separated list of value pairs ("name:value") that describe filters.

Supported filter names are:

exclude-packageExclude a package specified in the value
exclude-moduleExclude a module specified in the value
exclude-classExclude a class specified in the value
exclude-methodExclude a method specified in the value
include-packageInclude a package specified in the value
include-moduleInclude a module specified in the value
include-classInclude a class specified in the value
include-methodInclude a method specified in the value

LogFlushMode:   Specifies the log flush mode.

Use this property to set the log flush mode. The following values are defined:

noneNo flush (caching only)
immediateImmediate flush (real-time logging)
maxcountFlush cached entries upon reaching LogMaxEventCount entries in the cache.

LogLevel:   Specifies the debug log level.

Use this property to provide the desired debug log level.

Supported values are:

noneNone (by default)
fatalSevere errors that cause premature termination.
errorOther runtime errors or unexpected conditions.
warningUse of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".
infoInteresting runtime events (startup/shutdown).
debugDetailed information on flow of through the system.
traceMore detailed information.

LogMaxEventCount:   Specifies the maximum number of events to cache before further action is taken.

Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode.

The default value of this setting is 100.

LogRotationMode:   Specifies the log rotation mode.

Use this property to set the log rotation mode. The following values are defined:

noneNo rotation
deleteolderDelete older entries from the cache upon reaching LogMaxEventCount
keepolderKeep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded)

MaxASN1BufferLength:   Specifies the maximal allowed length for ASN.1 primitive tag data.

This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks.

MaxASN1TreeDepth:   Specifies the maximal depth for processed ASN.1 trees.

This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks.

OCSPHashAlgorithm:   Specifies the hash algorithm to be used to identify certificates in OCSP requests.

This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful.

StaticDNS:   Specifies whether static DNS rules should be used.

Set this property to enable or disable static DNS rules for the class. Works only if UseOwnDNSResolver is set to true.

Supported values are:

noneNo static DNS rules (default)
localLocal static DNS rules
globalGlobal static DNS rules

StaticIPAddress[domain]:   Gets or sets an IP address for the specified domain name.

Use this property to get or set an IP address for the specified domain name in the internal (of the class) or global DNS rules storage depending on the StaticDNS value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are devided by the | (pipe) character.

StaticIPAddresses:   Gets or sets all the static DNS rules.

Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If StaticDNS of the class is set to "local", the property returns/restores the rules from/to the internal storage of the class. If StaticDNS of the class is set to "global", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format.

Tag:   Allows to store any custom data.

Use this config property to store any custom data.

TLSSessionGroup:   Specifies the group name of TLS sessions to be used for session resumption.

Use this property to limit the search of chached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the classes.

TLSSessionLifetime:   Specifies lifetime in seconds of the cached TLS session.

Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes).

TLSSessionPurgeInterval:   Specifies how often the session cache should remove the expired TLS sessions.

Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute).

UseOwnDNSResolver:   Specifies whether the client components should use own DNS resolver.

Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one.

UseSharedSystemStorages:   Specifies whether the validation engine should use a global per-process copy of the system certificate stores.

Set this global property to false to make each validation run use its own copy of system certificate stores.

UseSystemOAEPAndPSS:   Enforces or disables the use of system-driven RSA OAEP and PSS computations.

This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation.

This setting only applies to certificates originating from a Windows system store.

UseSystemRandom:   Enables or disables the use of the OS PRNG.

Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.

Trappable Errors (IMAPClient Class)

IMAPClient Errors

1048577   Invalid parameter value (SB_ERROR_INVALID_PARAMETER)
1048578   Class is configured incorrectly (SB_ERROR_INVALID_SETUP)
1048579   Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE)
1048580   Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE)
1048581   Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY)
1048581   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER)