IMAPClient Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

class secureblackbox.IMAPClient

Remarks

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

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

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

Property List


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

access_tokenAn OAuth 2.0 access token to authenticate to the server.
blocked_cert_countThe number of records in the BlockedCert arrays.
blocked_cert_bytesReturns the raw certificate data in DER format.
blocked_cert_handleAllows to get or set a 'handle', a unique identifier of the underlying property object.
conn_info_aead_cipherIndicates whether the encryption algorithm used is an AEAD cipher.
conn_info_chain_validation_detailsThe details of a certificate chain validation outcome.
conn_info_chain_validation_resultThe outcome of a certificate chain validation routine.
conn_info_ciphersuiteThe cipher suite employed by this connection.
conn_info_client_authenticatedSpecifies whether client authentication was performed during this connection.
conn_info_client_auth_requestedSpecifies whether client authentication was requested during this connection.
conn_info_connection_establishedIndicates whether the connection has been established fully.
conn_info_connection_idThe unique identifier assigned to this connection.
conn_info_digest_algorithmThe digest algorithm used in a TLS-enabled connection.
conn_info_encryption_algorithmThe symmetric encryption algorithm used in a TLS-enabled connection.
conn_info_exportableIndicates whether a TLS connection uses a reduced-strength exportable cipher.
conn_info_idThe client connection's unique identifier.
conn_info_key_exchange_algorithmThe key exchange algorithm used in a TLS-enabled connection.
conn_info_key_exchange_key_bitsThe length of the key exchange key of a TLS-enabled connection.
conn_info_named_ec_curveThe elliptic curve used in this connection.
conn_info_pfs_cipherIndicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).
conn_info_pre_shared_identitySpecifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
conn_info_pre_shared_identity_hintA hint professed by the server to help the client select the PSK identity to use.
conn_info_public_key_bitsThe length of the public key.
conn_info_remote_addressThe client's IP address.
conn_info_remote_portThe remote port of the client connection.
conn_info_resumed_sessionIndicates whether a TLS-enabled connection was spawned from another TLS connection.
conn_info_secure_connectionIndicates whether TLS or SSL is enabled for this connection.
conn_info_server_authenticatedIndicates whether server authentication was performed during a TLS-enabled connection.
conn_info_signature_algorithmThe signature algorithm used in a TLS handshake.
conn_info_symmetric_block_sizeThe block size of the symmetric algorithm used.
conn_info_symmetric_key_bitsThe key length of the symmetric algorithm used.
conn_info_total_bytes_receivedThe total number of bytes received over this connection.
conn_info_total_bytes_sentThe total number of bytes sent over this connection.
conn_info_validation_logContains the server certificate's chain validation log.
conn_info_versionIndicates the version of SSL/TLS protocol negotiated during this connection.
fips_modeReserved.
known_cert_countThe number of records in the KnownCert arrays.
known_cert_bytesReturns the raw certificate data in DER format.
known_cert_handleAllows to get or set a 'handle', a unique identifier of the underlying property object.
known_crl_countThe number of records in the KnownCRL arrays.
known_crl_bytesReturns the raw CRL data in DER format.
known_crl_handleAllows to get or set a 'handle', a unique identifier of the underlying property object.
known_ocsp_countThe number of records in the KnownOCSP arrays.
known_ocsp_bytesA buffer containing the raw OCSP response data.
known_ocsp_handleAllows to get or set a 'handle', a unique identifier of the underlying property object.
mailbox_message_flagsContains message flags defined in the mailbox.
mailbox_nameSpecifies mailbox name.
mailbox_next_uidReturns the next unique identifier value.
mailbox_permanent_flagsContains a list of message flags that can be changed permanently.
mailbox_read_onlySpecifies whether the mailbox is write-protected.
mailbox_recent_messagesThe number of recent messages in the mailbox.
mailbox_total_messagesTotal number of messages in the mailbox.
mailbox_uid_validitySpecifies UID validity value.
mailbox_unseen_messagesThe number of unseen messages in the mailbox.
msg_attachment_countReturns the number of attachments in this message.
msg_bccThe contents of the BCC header property.
msg_ccThe value of the CC header property.
msg_commentsContains additional information about the message body.
msg_dateThe date and time when the message entered the mail delivery system.
msg_delivery_receiptEnables delivery notification.
msg_fromContains the value of the From header property.
msg_handleAllows to get or set a 'handle', a unique identifier of the underlying property object.
msg_html_textThe HTML version of the message.
msg_idThe contents of the Message-ID header property.
msg_in_reply_toThe value of the In-Reply-To header property.
msg_keywordsThe value of the Keywords header property.
msg_mailerThe name of the software that was used to send the message.
msg_plain_textThe plain text version of the message.
msg_prioritySpecifies the message priority.
msg_read_receiptEnables a read notification.
msg_referencesThe value of the References header property.
msg_reply_toThe value of the Reply-To header property.
msg_return_pathThe value of the Return-Path header property.
msg_senderThe value of the Sender header property.
msg_send_toThe value of the To header property.
msg_subjectContains the subject property of this message.
msg_info_countThe number of records in the MsgInfo arrays.
msg_info_dateContains the value of the Date header property.
msg_info_flagsReturns the flags currently set to the mail message.
msg_info_fromContains the value of the From header property.
msg_info_internal_dateReturns the internal date of the mail message.
msg_info_prioritySpecifies the message priority.
msg_info_sent_toContains the value of the To header property.
msg_info_sizeReturns the size of the message in bytes.
msg_info_subjectContains the value of the Subject header property.
msg_info_uidReturns the unique ID of the mail message.
passwordThe authentication password.
proxy_addressThe IP address of the proxy server.
proxy_authenticationThe authentication type used by the proxy server.
proxy_passwordThe password to authenticate to the proxy server.
proxy_portThe port on the proxy server to connect to.
proxy_proxy_typeThe type of the proxy server.
proxy_request_headersContains HTTP request headers for WebTunnel and HTTP proxy.
proxy_response_bodyContains the HTTP or HTTPS (WebTunnel) proxy response body.
proxy_response_headersContains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.
proxy_use_ipv6Specifies whether IPv6 should be used when connecting through the proxy.
proxy_usernameSpecifies the username credential for proxy authentication.
server_info_capabilitiesReturns the list of server capabilities.
server_info_featuresReturns the list of capabilities supported by the server.
server_info_supported_authsContains a comma-separated list of the authentication methods supported by the server.
session_logContains the complete log of the last session.
socket_dns_modeSelects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system.
socket_dns_portSpecifies the port number to be used for sending queries to the DNS server.
socket_dns_query_timeoutThe timeout (in milliseconds) for each DNS query.
socket_dns_serversThe addresses of DNS servers to use for address resolution, separated by commas or semicolons.
socket_dns_total_timeoutThe timeout (in milliseconds) for the whole resolution process.
socket_incoming_speed_limitThe maximum number of bytes to read from the socket, per second.
socket_local_addressThe local network interface to bind the socket to.
socket_local_portThe local port number to bind the socket to.
socket_outgoing_speed_limitThe maximum number of bytes to write to the socket, per second.
socket_timeoutThe maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
socket_use_ipv6Enables or disables IP protocol version 6.
tls_client_cert_countThe number of records in the TLSClientCert arrays.
tls_client_cert_bytesReturns the raw certificate data in DER format.
tls_client_cert_handleAllows to get or set a 'handle', a unique identifier of the underlying property object.
tls_server_cert_countThe number of records in the TLSServerCert arrays.
tls_server_cert_bytesReturns the raw certificate data in DER format.
tls_server_cert_fingerprintContains the fingerprint (a hash imprint) of this certificate.
tls_server_cert_handleAllows to get or set a 'handle', a unique identifier of the underlying property object.
tls_server_cert_issuerThe common name of the certificate issuer (CA), typically a company name.
tls_server_cert_issuer_rdnA list of Property=Value pairs that uniquely identify the certificate issuer.
tls_server_cert_key_algorithmSpecifies the public key algorithm of this certificate.
tls_server_cert_key_bitsReturns the length of the public key in bits.
tls_server_cert_key_usageIndicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
tls_server_cert_self_signedIndicates whether the certificate is self-signed (root) or signed by an external CA.
tls_server_cert_serial_numberReturns the certificate's serial number.
tls_server_cert_sig_algorithmIndicates the algorithm that was used by the CA to sign this certificate.
tls_server_cert_subjectThe common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
tls_server_cert_subject_rdnA list of Property=Value pairs that uniquely identify the certificate holder (subject).
tls_server_cert_valid_fromThe time point at which the certificate becomes valid, in UTC.
tls_server_cert_valid_toThe time point at which the certificate expires, in UTC.
tls_auto_validate_certificatesSpecifies whether server-side TLS certificates should be validated automatically using internal validation rules.
tls_base_configurationSelects the base configuration for the TLS settings.
tls_ciphersuitesA list of ciphersuites separated with commas or semicolons.
tls_client_authEnables or disables certificate-based client authentication.
tls_ec_curvesDefines the elliptic curves to enable.
tls_extensionsProvides access to TLS extensions.
tls_force_resume_if_destination_changesWhether to force TLS session resumption when the destination address changes.
tls_pre_shared_identityDefines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
tls_pre_shared_keyContains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
tls_pre_shared_key_ciphersuiteDefines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
tls_renegotiation_attack_prevention_modeSelects the renegotiation attack prevention mechanism.
tls_revocation_checkSpecifies the kind(s) of revocation check to perform.
tls_ssl_optionsVarious 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.
tls_tls_modeSpecifies the TLS mode to use.
tls_use_extended_master_secretEnables the Extended Master Secret Extension, as defined in RFC 7627.
tls_use_session_resumptionEnables or disables the TLS session resumption capability.
tls_versionsThe SSL/TLS versions to enable by default.
trusted_cert_countThe number of records in the TrustedCert arrays.
trusted_cert_bytesReturns the raw certificate data in DER format.
trusted_cert_handleAllows 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.

close_mailboxCloses the current mailbox.
configSets or retrieves a configuration setting.
connectEstablishes a connection to the IMAP server.
copy_messageCopies a message to another mailbox.
create_mailboxCreates a new mailbox.
delete_mailboxDeletes an existing mailbox.
disconnectCloses connection to the IMAP server.
do_actionPerforms an additional action.
get_mailbox_infoRequests mailbox status.
list_mailboxesQueries a list of mailboxes available on the server.
list_messagesQueries a list of messages available in the currently selected on the server.
open_mailboxOpens the specified mailbox.
pingSends a NOOP command to the IMAP server.
post_bytesUploads an e-mail message stored in a byte array.
post_fileUploads a message stored in a file to the current mailbox on the IMAP server.
post_messageUploads a pre-built message to the current mailbox on the IMAP server.
purge_messagesPermanently removes all deleted messages from the current mailbox.
receive_bytesDownloads a message to a byte array.
receive_fileDownloads a message to a file.
receive_messageDownloads a message.
refresh_mailboxRefreshes info about the currently selected mailbox.
rename_mailboxRenames an existing mailbox.
resetResets the class settings.
update_messageAlters 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.

on_auth_failedFires when an authentication attempt has failed.
on_auth_startFires when the authentication is about to be started.
on_auth_succeededFires when the authentication has succeeded.
on_commandReports a command sent to the server.
on_command_dataReturns the data that accompanies the command.
on_command_replyReports the receipt of a reply to a command.
on_command_reply_dataReturns the data that accompanies a reply to a command.
on_errorProvides information about errors during SMTP operations.
on_mailbox_foundProvides mailbox details.
on_mailbox_infoReports mailbox information returned from the server.
on_notificationThis event notifies the application about an underlying control flow event.
on_progressReports the progress of the data transfer operation.
on_tls_cert_neededFires when a remote TLS party requests a client certificate.
on_tls_cert_validateThis event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.
on_tls_establishedFires when a TLS handshake with Host successfully completes.
on_tls_handshakeFires when a new TLS handshake is initiated, before the handshake commences.
on_tls_pskNotifies the application about the PSK key exchange.
on_tls_shutdownReports 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.
SessionLogDetailsSpecifies whether login credentials should be written to the session log.
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.
TempPathPath for storing temporary files.
TLSExtensionsTBD.
TLSPeerExtensionsTBD.
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.
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.
ASN1UseGlobalTagCacheControls whether ASN.1 module should use a global object cache.
AssignSystemSmartCardPinsSpecifies whether CSP-level PINs should be assigned to CNG keys.
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.
DNSLocalSuffixThe suffix to assign for TLD names.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HardwareCryptoUsePolicyThe hardware crypto usage policy.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
HttpVersionThe HTTP version to use in any inner HTTP client classes created.
IgnoreExpiredMSCTLSigningCertWhether to tolerate the expired Windows Update signing certificate.
ListDelimiterThe delimiter character for multi-element lists.
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.
OldClientSideRSAFallbackSpecifies whether the SSH client should use a SHA1 fallback.
ProductVersionReturns the version of the SecureBlackbox library.
ServerSSLDHKeyLengthSets the size of the TLS DHE key exchange group.
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.
UseInternalRandomSwitches between SecureBlackbox-own and platform PRNGs.
UseLegacyAdESValidationEnables legacy AdES validation mode.
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.
UseSystemNativeSizeCalculationAn internal CryptoAPI access tweak.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.

access_token Property

An OAuth 2.0 access token to authenticate to the server.

Syntax

def get_access_token() -> str: ...
def set_access_token(value: str) -> None: ...

access_token = property(get_access_token, set_access_token)

Default Value

""

Remarks

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

blocked_cert_count Property

The number of records in the BlockedCert arrays.

Syntax

def get_blocked_cert_count() -> int: ...
def set_blocked_cert_count(value: int) -> None: ...

blocked_cert_count = property(get_blocked_cert_count, set_blocked_cert_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

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

blocked_cert_bytes Property

Returns the raw certificate data in DER format.

Syntax

def get_blocked_cert_bytes(blocked_cert_index: int) -> bytes: ...

Remarks

Returns the raw certificate data in DER format.

The blocked_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the blocked_cert_count property.

This property is read-only.

blocked_cert_handle Property

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

Syntax

def get_blocked_cert_handle(blocked_cert_index: int) -> int: ...
def set_blocked_cert_handle(blocked_cert_index: int, value: int) -> None: ...

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

conn_info_aead_cipher Property

Indicates whether the encryption algorithm used is an AEAD cipher.

Syntax

def get_conn_info_aead_cipher() -> bool: ...

conn_info_aead_cipher = property(get_conn_info_aead_cipher, None)

Default Value

FALSE

Remarks

Indicates whether the encryption algorithm used is an AEAD cipher.

This property is read-only.

conn_info_chain_validation_details Property

The details of a certificate chain validation outcome.

Syntax

def get_conn_info_chain_validation_details() -> int: ...

conn_info_chain_validation_details = property(get_conn_info_chain_validation_details, None)

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.

conn_info_chain_validation_result Property

The outcome of a certificate chain validation routine.

Syntax

def get_conn_info_chain_validation_result() -> int: ...

conn_info_chain_validation_result = property(get_conn_info_chain_validation_result, None)

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.

conn_info_ciphersuite Property

The cipher suite employed by this connection.

Syntax

def get_conn_info_ciphersuite() -> str: ...

conn_info_ciphersuite = property(get_conn_info_ciphersuite, None)

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.

conn_info_client_authenticated Property

Specifies whether client authentication was performed during this connection.

Syntax

def get_conn_info_client_authenticated() -> bool: ...

conn_info_client_authenticated = property(get_conn_info_client_authenticated, None)

Default Value

FALSE

Remarks

Specifies whether client authentication was performed during this connection.

This property is read-only.

conn_info_client_auth_requested Property

Specifies whether client authentication was requested during this connection.

Syntax

def get_conn_info_client_auth_requested() -> bool: ...

conn_info_client_auth_requested = property(get_conn_info_client_auth_requested, None)

Default Value

FALSE

Remarks

Specifies whether client authentication was requested during this connection.

This property is read-only.

conn_info_connection_established Property

Indicates whether the connection has been established fully.

Syntax

def get_conn_info_connection_established() -> bool: ...

conn_info_connection_established = property(get_conn_info_connection_established, None)

Default Value

FALSE

Remarks

Indicates whether the connection has been established fully.

This property is read-only.

conn_info_connection_id Property

The unique identifier assigned to this connection.

Syntax

def get_conn_info_connection_id() -> bytes: ...

conn_info_connection_id = property(get_conn_info_connection_id, None)

Remarks

The unique identifier assigned to this connection.

This property is read-only.

conn_info_digest_algorithm Property

The digest algorithm used in a TLS-enabled connection.

Syntax

def get_conn_info_digest_algorithm() -> str: ...

conn_info_digest_algorithm = property(get_conn_info_digest_algorithm, None)

Default Value

""

Remarks

The digest algorithm used in a TLS-enabled connection.

This property is read-only.

conn_info_encryption_algorithm Property

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

Syntax

def get_conn_info_encryption_algorithm() -> str: ...

conn_info_encryption_algorithm = property(get_conn_info_encryption_algorithm, None)

Default Value

""

Remarks

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

This property is read-only.

conn_info_exportable Property

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

Syntax

def get_conn_info_exportable() -> bool: ...

conn_info_exportable = property(get_conn_info_exportable, None)

Default Value

FALSE

Remarks

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

This property is read-only.

conn_info_id Property

The client connection's unique identifier.

Syntax

def get_conn_info_id() -> int: ...

conn_info_id = property(get_conn_info_id, None)

Default Value

-1

Remarks

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

This property is read-only.

conn_info_key_exchange_algorithm Property

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

Syntax

def get_conn_info_key_exchange_algorithm() -> str: ...

conn_info_key_exchange_algorithm = property(get_conn_info_key_exchange_algorithm, None)

Default Value

""

Remarks

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

This property is read-only.

conn_info_key_exchange_key_bits Property

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

Syntax

def get_conn_info_key_exchange_key_bits() -> int: ...

conn_info_key_exchange_key_bits = property(get_conn_info_key_exchange_key_bits, None)

Default Value

0

Remarks

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

This property is read-only.

conn_info_named_ec_curve Property

The elliptic curve used in this connection.

Syntax

def get_conn_info_named_ec_curve() -> str: ...

conn_info_named_ec_curve = property(get_conn_info_named_ec_curve, None)

Default Value

""

Remarks

The elliptic curve used in this connection.

This property is read-only.

conn_info_pfs_cipher Property

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

Syntax

def get_conn_info_pfs_cipher() -> bool: ...

conn_info_pfs_cipher = property(get_conn_info_pfs_cipher, None)

Default Value

FALSE

Remarks

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

This property is read-only.

conn_info_pre_shared_identity Property

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

Syntax

def get_conn_info_pre_shared_identity() -> str: ...

conn_info_pre_shared_identity = property(get_conn_info_pre_shared_identity, None)

Default Value

""

Remarks

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

This property is read-only.

conn_info_pre_shared_identity_hint Property

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

Syntax

def get_conn_info_pre_shared_identity_hint() -> str: ...

conn_info_pre_shared_identity_hint = property(get_conn_info_pre_shared_identity_hint, None)

Default Value

""

Remarks

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

This property is read-only.

conn_info_public_key_bits Property

The length of the public key.

Syntax

def get_conn_info_public_key_bits() -> int: ...

conn_info_public_key_bits = property(get_conn_info_public_key_bits, None)

Default Value

0

Remarks

The length of the public key.

This property is read-only.

conn_info_remote_address Property

The client's IP address.

Syntax

def get_conn_info_remote_address() -> str: ...

conn_info_remote_address = property(get_conn_info_remote_address, None)

Default Value

""

Remarks

The client's IP address.

This property is read-only.

conn_info_remote_port Property

The remote port of the client connection.

Syntax

def get_conn_info_remote_port() -> int: ...

conn_info_remote_port = property(get_conn_info_remote_port, None)

Default Value

0

Remarks

The remote port of the client connection.

This property is read-only.

conn_info_resumed_session Property

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

Syntax

def get_conn_info_resumed_session() -> bool: ...

conn_info_resumed_session = property(get_conn_info_resumed_session, None)

Default Value

FALSE

Remarks

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

This property is read-only.

conn_info_secure_connection Property

Indicates whether TLS or SSL is enabled for this connection.

Syntax

def get_conn_info_secure_connection() -> bool: ...

conn_info_secure_connection = property(get_conn_info_secure_connection, None)

Default Value

FALSE

Remarks

Indicates whether TLS or SSL is enabled for this connection.

This property is read-only.

conn_info_server_authenticated Property

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

Syntax

def get_conn_info_server_authenticated() -> bool: ...

conn_info_server_authenticated = property(get_conn_info_server_authenticated, None)

Default Value

FALSE

Remarks

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

This property is read-only.

conn_info_signature_algorithm Property

The signature algorithm used in a TLS handshake.

Syntax

def get_conn_info_signature_algorithm() -> str: ...

conn_info_signature_algorithm = property(get_conn_info_signature_algorithm, None)

Default Value

""

Remarks

The signature algorithm used in a TLS handshake.

This property is read-only.

conn_info_symmetric_block_size Property

The block size of the symmetric algorithm used.

Syntax

def get_conn_info_symmetric_block_size() -> int: ...

conn_info_symmetric_block_size = property(get_conn_info_symmetric_block_size, None)

Default Value

0

Remarks

The block size of the symmetric algorithm used.

This property is read-only.

conn_info_symmetric_key_bits Property

The key length of the symmetric algorithm used.

Syntax

def get_conn_info_symmetric_key_bits() -> int: ...

conn_info_symmetric_key_bits = property(get_conn_info_symmetric_key_bits, None)

Default Value

0

Remarks

The key length of the symmetric algorithm used.

This property is read-only.

conn_info_total_bytes_received Property

The total number of bytes received over this connection.

Syntax

def get_conn_info_total_bytes_received() -> int: ...

conn_info_total_bytes_received = property(get_conn_info_total_bytes_received, None)

Default Value

0

Remarks

The total number of bytes received over this connection.

This property is read-only.

conn_info_total_bytes_sent Property

The total number of bytes sent over this connection.

Syntax

def get_conn_info_total_bytes_sent() -> int: ...

conn_info_total_bytes_sent = property(get_conn_info_total_bytes_sent, None)

Default Value

0

Remarks

The total number of bytes sent over this connection.

This property is read-only.

conn_info_validation_log Property

Contains the server certificate's chain validation log.

Syntax

def get_conn_info_validation_log() -> str: ...

conn_info_validation_log = property(get_conn_info_validation_log, None)

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.

conn_info_version Property

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

Syntax

def get_conn_info_version() -> str: ...

conn_info_version = property(get_conn_info_version, None)

Default Value

""

Remarks

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

This property is read-only.

fips_mode Property

Reserved.

Syntax

def get_fips_mode() -> bool: ...
def set_fips_mode(value: bool) -> None: ...

fips_mode = property(get_fips_mode, set_fips_mode)

Default Value

FALSE

Remarks

This property is reserved for future use.

known_cert_count Property

The number of records in the KnownCert arrays.

Syntax

def get_known_cert_count() -> int: ...
def set_known_cert_count(value: int) -> None: ...

known_cert_count = property(get_known_cert_count, set_known_cert_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

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

known_cert_bytes Property

Returns the raw certificate data in DER format.

Syntax

def get_known_cert_bytes(known_cert_index: int) -> bytes: ...

Remarks

Returns the raw certificate data in DER format.

The known_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the known_cert_count property.

This property is read-only.

known_cert_handle Property

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

Syntax

def get_known_cert_handle(known_cert_index: int) -> int: ...
def set_known_cert_handle(known_cert_index: int, value: int) -> None: ...

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

known_crl_count Property

The number of records in the KnownCRL arrays.

Syntax

def get_known_crl_count() -> int: ...
def set_known_crl_count(value: int) -> None: ...

known_crl_count = property(get_known_crl_count, set_known_crl_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

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

known_crl_bytes Property

Returns the raw CRL data in DER format.

Syntax

def get_known_crl_bytes(known_crl_index: int) -> bytes: ...

Remarks

Returns the raw CRL data in DER format.

The known_crl_index parameter specifies the index of the item in the array. The size of the array is controlled by the known_crl_count property.

This property is read-only.

known_crl_handle Property

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

Syntax

def get_known_crl_handle(known_crl_index: int) -> int: ...
def set_known_crl_handle(known_crl_index: int, value: int) -> None: ...

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

known_ocsp_count Property

The number of records in the KnownOCSP arrays.

Syntax

def get_known_ocsp_count() -> int: ...
def set_known_ocsp_count(value: int) -> None: ...

known_ocsp_count = property(get_known_ocsp_count, set_known_ocsp_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

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

known_ocsp_bytes Property

A buffer containing the raw OCSP response data.

Syntax

def get_known_ocsp_bytes(known_ocsp_index: int) -> bytes: ...

Remarks

A buffer containing the raw OCSP response data.

The known_ocsp_index parameter specifies the index of the item in the array. The size of the array is controlled by the known_ocsp_count property.

This property is read-only.

known_ocsp_handle Property

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

Syntax

def get_known_ocsp_handle(known_ocsp_index: int) -> int: ...
def set_known_ocsp_handle(known_ocsp_index: int, value: int) -> None: ...

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

mailbox_message_flags Property

Contains message flags defined in the mailbox.

Syntax

def get_mailbox_message_flags() -> int: ...

mailbox_message_flags = property(get_mailbox_message_flags, None)

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.

mailbox_name Property

Specifies mailbox name.

Syntax

def get_mailbox_name() -> str: ...

mailbox_name = property(get_mailbox_name, None)

Default Value

""

Remarks

Specifies mailbox name.

This property is read-only.

mailbox_next_uid Property

Returns the next unique identifier value.

Syntax

def get_mailbox_next_uid() -> int: ...

mailbox_next_uid = property(get_mailbox_next_uid, None)

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.

mailbox_permanent_flags Property

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

Syntax

def get_mailbox_permanent_flags() -> int: ...

mailbox_permanent_flags = property(get_mailbox_permanent_flags, None)

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.

mailbox_read_only Property

Specifies whether the mailbox is write-protected.

Syntax

def get_mailbox_read_only() -> bool: ...

mailbox_read_only = property(get_mailbox_read_only, None)

Default Value

FALSE

Remarks

Specifies whether the mailbox is write-protected.

This property is read-only.

mailbox_recent_messages Property

The number of recent messages in the mailbox.

Syntax

def get_mailbox_recent_messages() -> int: ...

mailbox_recent_messages = property(get_mailbox_recent_messages, None)

Default Value

0

Remarks

The number of recent messages in the mailbox.

This property is read-only.

mailbox_total_messages Property

Total number of messages in the mailbox.

Syntax

def get_mailbox_total_messages() -> int: ...

mailbox_total_messages = property(get_mailbox_total_messages, None)

Default Value

0

Remarks

Total number of messages in the mailbox.

This property is read-only.

mailbox_uid_validity Property

Specifies UID validity value.

Syntax

def get_mailbox_uid_validity() -> int: ...

mailbox_uid_validity = property(get_mailbox_uid_validity, None)

Default Value

0

Remarks

Specifies UID validity value.

This property is read-only.

mailbox_unseen_messages Property

The number of unseen messages in the mailbox.

Syntax

def get_mailbox_unseen_messages() -> int: ...

mailbox_unseen_messages = property(get_mailbox_unseen_messages, None)

Default Value

0

Remarks

The number of unseen messages in the mailbox.

This property is read-only.

msg_attachment_count Property

Returns the number of attachments in this message.

Syntax

def get_msg_attachment_count() -> int: ...

msg_attachment_count = property(get_msg_attachment_count, None)

Default Value

0

Remarks

Returns the number of attachments in this message.

This property is read-only.

msg_bcc Property

The contents of the BCC header property.

Syntax

def get_msg_bcc() -> str: ...
def set_msg_bcc(value: str) -> None: ...

msg_bcc = property(get_msg_bcc, set_msg_bcc)

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.

msg_cc Property

The value of the CC header property.

Syntax

def get_msg_cc() -> str: ...
def set_msg_cc(value: str) -> None: ...

msg_cc = property(get_msg_cc, set_msg_cc)

Default Value

""

Remarks

The value of the CC header field.

The CC field contains the addresses of secondary recipients of the message.

msg_comments Property

Contains additional information about the message body.

Syntax

def get_msg_comments() -> str: ...
def set_msg_comments(value: str) -> None: ...

msg_comments = property(get_msg_comments, set_msg_comments)

Default Value

""

Remarks

Contains additional information about the message body.

msg_date Property

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

Syntax

def get_msg_date() -> str: ...
def set_msg_date(value: str) -> None: ...

msg_date = property(get_msg_date, set_msg_date)

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.

msg_delivery_receipt Property

Enables delivery notification.

Syntax

def get_msg_delivery_receipt() -> bool: ...
def set_msg_delivery_receipt(value: bool) -> None: ...

msg_delivery_receipt = property(get_msg_delivery_receipt, set_msg_delivery_receipt)

Default Value

FALSE

Remarks

Enables delivery notification.

msg_from Property

Contains the value of the From header property.

Syntax

def get_msg_from() -> str: ...
def set_msg_from(value: str) -> None: ...

msg_from = property(get_msg_from, set_msg_from)

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 msg_sender to specify the sender separately.

msg_handle Property

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

Syntax

def get_msg_handle() -> int: ...
def set_msg_handle(value: int) -> None: ...

msg_handle = property(get_msg_handle, set_msg_handle)

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());

msg_html_text Property

The HTML version of the message.

Syntax

def get_msg_html_text() -> str: ...
def set_msg_html_text(value: str) -> None: ...

msg_html_text = property(get_msg_html_text, set_msg_html_text)

Default Value

""

Remarks

The HTML version of the message.

msg_id Property

The contents of the Message-ID header property.

Syntax

def get_msg_id() -> str: ...
def set_msg_id(value: str) -> None: ...

msg_id = property(get_msg_id, set_msg_id)

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.

msg_in_reply_to Property

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

Syntax

def get_msg_in_reply_to() -> str: ...
def set_msg_in_reply_to(value: str) -> None: ...

msg_in_reply_to = property(get_msg_in_reply_to, set_msg_in_reply_to)

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.

msg_keywords Property

The value of the Keywords header property.

Syntax

def get_msg_keywords() -> str: ...
def set_msg_keywords(value: str) -> None: ...

msg_keywords = property(get_msg_keywords, set_msg_keywords)

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.

msg_mailer Property

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

Syntax

def get_msg_mailer() -> str: ...

msg_mailer = property(get_msg_mailer, None)

Default Value

""

Remarks

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

This property is read-only.

msg_plain_text Property

The plain text version of the message.

Syntax

def get_msg_plain_text() -> str: ...
def set_msg_plain_text(value: str) -> None: ...

msg_plain_text = property(get_msg_plain_text, set_msg_plain_text)

Default Value

""

Remarks

The plain text version of the message.

msg_priority Property

Specifies the message priority.

Syntax

def get_msg_priority() -> int: ...
def set_msg_priority(value: int) -> None: ...

msg_priority = property(get_msg_priority, set_msg_priority)

Default Value

2

Remarks

Specifies the message priority.

Available options:

mpLowest0
mpLow1
mpNormal2
mpHigh3
mpHighest4

msg_read_receipt Property

Enables a read notification.

Syntax

def get_msg_read_receipt() -> bool: ...
def set_msg_read_receipt(value: bool) -> None: ...

msg_read_receipt = property(get_msg_read_receipt, set_msg_read_receipt)

Default Value

FALSE

Remarks

Enables a read notification.

msg_references Property

The value of the References header property.

Syntax

def get_msg_references() -> str: ...
def set_msg_references(value: str) -> None: ...

msg_references = property(get_msg_references, set_msg_references)

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.

msg_reply_to Property

The value of the Reply-To header property.

Syntax

def get_msg_reply_to() -> str: ...
def set_msg_reply_to(value: str) -> None: ...

msg_reply_to = property(get_msg_reply_to, set_msg_reply_to)

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 msg_from field.

msg_return_path Property

The value of the Return-Path header property.

Syntax

def get_msg_return_path() -> str: ...
def set_msg_return_path(value: str) -> None: ...

msg_return_path = property(get_msg_return_path, set_msg_return_path)

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.

msg_sender Property

The value of the Sender header property.

Syntax

def get_msg_sender() -> str: ...
def set_msg_sender(value: str) -> None: ...

msg_sender = property(get_msg_sender, set_msg_sender)

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.

msg_send_to Property

The value of the To header property.

Syntax

def get_msg_send_to() -> str: ...
def set_msg_send_to(value: str) -> None: ...

msg_send_to = property(get_msg_send_to, set_msg_send_to)

Default Value

""

Remarks

The value of the To header field.

This field specifies the address(es) of the primary recipient(s) of the message.

msg_subject Property

Contains the subject property of this message.

Syntax

def get_msg_subject() -> str: ...
def set_msg_subject(value: str) -> None: ...

msg_subject = property(get_msg_subject, set_msg_subject)

Default Value

""

Remarks

Contains the subject field of this message.

msg_info_count Property

The number of records in the MsgInfo arrays.

Syntax

def get_msg_info_count() -> int: ...

msg_info_count = property(get_msg_info_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is read-only.

msg_info_date Property

Contains the value of the Date header property.

Syntax

def get_msg_info_date(msg_info_index: int) -> str: ...

Default Value

""

Remarks

Contains the value of the Date header field.

The msg_info_index parameter specifies the index of the item in the array. The size of the array is controlled by the msg_info_count property.

This property is read-only.

msg_info_flags Property

Returns the flags currently set to the mail message.

Syntax

def get_msg_info_flags(msg_info_index: int) -> int: ...

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

This property is read-only.

msg_info_from Property

Contains the value of the From header property.

Syntax

def get_msg_info_from(msg_info_index: int) -> str: ...

Default Value

""

Remarks

Contains the value of the From header field.

The msg_info_index parameter specifies the index of the item in the array. The size of the array is controlled by the msg_info_count property.

This property is read-only.

msg_info_internal_date Property

Returns the internal date of the mail message.

Syntax

def get_msg_info_internal_date(msg_info_index: int) -> str: ...

Default Value

""

Remarks

Returns the internal date of the mail message.

The msg_info_index parameter specifies the index of the item in the array. The size of the array is controlled by the msg_info_count property.

This property is read-only.

msg_info_priority Property

Specifies the message priority.

Syntax

def get_msg_info_priority(msg_info_index: int) -> int: ...

Default Value

2

Remarks

Specifies the message priority.

Available options:

mpLowest0
mpLow1
mpNormal2
mpHigh3
mpHighest4

The msg_info_index parameter specifies the index of the item in the array. The size of the array is controlled by the msg_info_count property.

This property is read-only.

msg_info_sent_to Property

Contains the value of the To header property.

Syntax

def get_msg_info_sent_to(msg_info_index: int) -> str: ...

Default Value

""

Remarks

Contains the value of the To header field.

The msg_info_index parameter specifies the index of the item in the array. The size of the array is controlled by the msg_info_count property.

This property is read-only.

msg_info_size Property

Returns the size of the message in bytes.

Syntax

def get_msg_info_size(msg_info_index: int) -> int: ...

Default Value

0

Remarks

Returns the size of the message in bytes.

The msg_info_index parameter specifies the index of the item in the array. The size of the array is controlled by the msg_info_count property.

This property is read-only.

msg_info_subject Property

Contains the value of the Subject header property.

Syntax

def get_msg_info_subject(msg_info_index: int) -> str: ...

Default Value

""

Remarks

Contains the value of the Subject header field.

The msg_info_index parameter specifies the index of the item in the array. The size of the array is controlled by the msg_info_count property.

This property is read-only.

msg_info_uid Property

Returns the unique ID of the mail message.

Syntax

def get_msg_info_uid(msg_info_index: int) -> int: ...

Default Value

0

Remarks

Returns the unique ID of the mail message.

The msg_info_index parameter specifies the index of the item in the array. The size of the array is controlled by the msg_info_count property.

This property is read-only.

password Property

The authentication password.

Syntax

def get_password() -> str: ...
def set_password(value: str) -> None: ...

password = property(get_password, set_password)

Default Value

""

Remarks

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

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

proxy_address Property

The IP address of the proxy server.

Syntax

def get_proxy_address() -> str: ...
def set_proxy_address(value: str) -> None: ...

proxy_address = property(get_proxy_address, set_proxy_address)

Default Value

""

Remarks

The IP address of the proxy server.

proxy_authentication Property

The authentication type used by the proxy server.

Syntax

def get_proxy_authentication() -> int: ...
def set_proxy_authentication(value: int) -> None: ...

proxy_authentication = property(get_proxy_authentication, set_proxy_authentication)

Default Value

0

Remarks

The authentication type used by the proxy server.

patNoAuthentication0
patBasic1
patDigest2
patNTLM3

proxy_password Property

The password to authenticate to the proxy server.

Syntax

def get_proxy_password() -> str: ...
def set_proxy_password(value: str) -> None: ...

proxy_password = property(get_proxy_password, set_proxy_password)

Default Value

""

Remarks

The password to authenticate to the proxy server.

proxy_port Property

The port on the proxy server to connect to.

Syntax

def get_proxy_port() -> int: ...
def set_proxy_port(value: int) -> None: ...

proxy_port = property(get_proxy_port, set_proxy_port)

Default Value

0

Remarks

The port on the proxy server to connect to.

proxy_proxy_type Property

The type of the proxy server.

Syntax

def get_proxy_proxy_type() -> int: ...
def set_proxy_proxy_type(value: int) -> None: ...

proxy_proxy_type = property(get_proxy_proxy_type, set_proxy_proxy_type)

Default Value

0

Remarks

The type of the proxy server.

cptNone0
cptSocks41
cptSocks52
cptWebTunnel3
cptHTTP4

proxy_request_headers Property

Contains HTTP request headers for WebTunnel and HTTP proxy.

Syntax

def get_proxy_request_headers() -> str: ...
def set_proxy_request_headers(value: str) -> None: ...

proxy_request_headers = property(get_proxy_request_headers, set_proxy_request_headers)

Default Value

""

Remarks

Contains HTTP request headers for WebTunnel and HTTP proxy.

proxy_response_body Property

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

Syntax

def get_proxy_response_body() -> str: ...
def set_proxy_response_body(value: str) -> None: ...

proxy_response_body = property(get_proxy_response_body, set_proxy_response_body)

Default Value

""

Remarks

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

proxy_response_headers Property

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

Syntax

def get_proxy_response_headers() -> str: ...
def set_proxy_response_headers(value: str) -> None: ...

proxy_response_headers = property(get_proxy_response_headers, set_proxy_response_headers)

Default Value

""

Remarks

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

proxy_use_ipv6 Property

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

Syntax

def get_proxy_use_ipv6() -> bool: ...
def set_proxy_use_ipv6(value: bool) -> None: ...

proxy_use_ipv6 = property(get_proxy_use_ipv6, set_proxy_use_ipv6)

Default Value

FALSE

Remarks

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

proxy_username Property

Specifies the username credential for proxy authentication.

Syntax

def get_proxy_username() -> str: ...
def set_proxy_username(value: str) -> None: ...

proxy_username = property(get_proxy_username, set_proxy_username)

Default Value

""

Remarks

Specifies the username credential for proxy authentication.

server_info_capabilities Property

Returns the list of server capabilities.

Syntax

def get_server_info_capabilities() -> str: ...

server_info_capabilities = property(get_server_info_capabilities, None)

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.

server_info_features Property

Returns the list of capabilities supported by the server.

Syntax

def get_server_info_features() -> int: ...

server_info_features = property(get_server_info_features, None)

Default Value

0

Remarks

Returns the list of capabilities supported by the server.

This value is bit mask of the following values:

imapLoginDisabled0x0001Specifies whether the server forbids login.

imapIdleSupported0x0002Indicates whether the IMAP server supports the IDLE command.

This property is read-only.

server_info_supported_auths Property

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

Syntax

def get_server_info_supported_auths() -> str: ...

server_info_supported_auths = property(get_server_info_supported_auths, None)

Default Value

""

Remarks

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

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

This property is read-only.

session_log Property

Contains the complete log of the last session.

Syntax

def get_session_log() -> str: ...

session_log = property(get_session_log, None)

Default Value

""

Remarks

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

See the SessionLogDetails config property for the log details settings.

This property is read-only.

socket_dns_mode Property

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

Syntax

def get_socket_dns_mode() -> int: ...
def set_socket_dns_mode(value: int) -> None: ...

socket_dns_mode = property(get_socket_dns_mode, set_socket_dns_mode)

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

socket_dns_port Property

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

Syntax

def get_socket_dns_port() -> int: ...
def set_socket_dns_port(value: int) -> None: ...

socket_dns_port = property(get_socket_dns_port, set_socket_dns_port)

Default Value

0

Remarks

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

socket_dns_query_timeout Property

The timeout (in milliseconds) for each DNS query.

Syntax

def get_socket_dns_query_timeout() -> int: ...
def set_socket_dns_query_timeout(value: int) -> None: ...

socket_dns_query_timeout = property(get_socket_dns_query_timeout, set_socket_dns_query_timeout)

Default Value

0

Remarks

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

socket_dns_servers Property

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

Syntax

def get_socket_dns_servers() -> str: ...
def set_socket_dns_servers(value: str) -> None: ...

socket_dns_servers = property(get_socket_dns_servers, set_socket_dns_servers)

Default Value

""

Remarks

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

socket_dns_total_timeout Property

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

Syntax

def get_socket_dns_total_timeout() -> int: ...
def set_socket_dns_total_timeout(value: int) -> None: ...

socket_dns_total_timeout = property(get_socket_dns_total_timeout, set_socket_dns_total_timeout)

Default Value

0

Remarks

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

socket_incoming_speed_limit Property

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

Syntax

def get_socket_incoming_speed_limit() -> int: ...
def set_socket_incoming_speed_limit(value: int) -> None: ...

socket_incoming_speed_limit = property(get_socket_incoming_speed_limit, set_socket_incoming_speed_limit)

Default Value

0

Remarks

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

socket_local_address Property

The local network interface to bind the socket to.

Syntax

def get_socket_local_address() -> str: ...
def set_socket_local_address(value: str) -> None: ...

socket_local_address = property(get_socket_local_address, set_socket_local_address)

Default Value

""

Remarks

The local network interface to bind the socket to.

socket_local_port Property

The local port number to bind the socket to.

Syntax

def get_socket_local_port() -> int: ...
def set_socket_local_port(value: int) -> None: ...

socket_local_port = property(get_socket_local_port, set_socket_local_port)

Default Value

0

Remarks

The local port number to bind the socket to.

socket_outgoing_speed_limit Property

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

Syntax

def get_socket_outgoing_speed_limit() -> int: ...
def set_socket_outgoing_speed_limit(value: int) -> None: ...

socket_outgoing_speed_limit = property(get_socket_outgoing_speed_limit, set_socket_outgoing_speed_limit)

Default Value

0

Remarks

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

socket_timeout Property

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

Syntax

def get_socket_timeout() -> int: ...
def set_socket_timeout(value: int) -> None: ...

socket_timeout = property(get_socket_timeout, set_socket_timeout)

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

socket_use_ipv6 Property

Enables or disables IP protocol version 6.

Syntax

def get_socket_use_ipv6() -> bool: ...
def set_socket_use_ipv6(value: bool) -> None: ...

socket_use_ipv6 = property(get_socket_use_ipv6, set_socket_use_ipv6)

Default Value

FALSE

Remarks

Enables or disables IP protocol version 6.

tls_client_cert_count Property

The number of records in the TLSClientCert arrays.

Syntax

def get_tls_client_cert_count() -> int: ...
def set_tls_client_cert_count(value: int) -> None: ...

tls_client_cert_count = property(get_tls_client_cert_count, set_tls_client_cert_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

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

tls_client_cert_bytes Property

Returns the raw certificate data in DER format.

Syntax

def get_tls_client_cert_bytes(tls_client_cert_index: int) -> bytes: ...

Remarks

Returns the raw certificate data in DER format.

The tls_client_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_client_cert_count property.

This property is read-only.

tls_client_cert_handle Property

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

Syntax

def get_tls_client_cert_handle(tls_client_cert_index: int) -> int: ...
def set_tls_client_cert_handle(tls_client_cert_index: int, value: int) -> None: ...

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

tls_server_cert_count Property

The number of records in the TLSServerCert arrays.

Syntax

def get_tls_server_cert_count() -> int: ...

tls_server_cert_count = property(get_tls_server_cert_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is read-only.

tls_server_cert_bytes Property

Returns the raw certificate data in DER format.

Syntax

def get_tls_server_cert_bytes(tls_server_cert_index: int) -> bytes: ...

Remarks

Returns the raw certificate data in DER format.

The tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.

This property is read-only.

tls_server_cert_fingerprint Property

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

Syntax

def get_tls_server_cert_fingerprint(tls_server_cert_index: int) -> str: ...

Default Value

""

Remarks

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

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

The tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.

This property is read-only.

tls_server_cert_handle Property

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

Syntax

def get_tls_server_cert_handle(tls_server_cert_index: int) -> int: ...

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

This property is read-only.

tls_server_cert_issuer Property

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

Syntax

def get_tls_server_cert_issuer(tls_server_cert_index: int) -> str: ...

Default Value

""

Remarks

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

The tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.

This property is read-only.

tls_server_cert_issuer_rdn Property

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

Syntax

def get_tls_server_cert_issuer_rdn(tls_server_cert_index: int) -> str: ...

Default Value

""

Remarks

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

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

The tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.

This property is read-only.

tls_server_cert_key_algorithm Property

Specifies the public key algorithm of this certificate.

Syntax

def get_tls_server_cert_key_algorithm(tls_server_cert_index: int) -> str: ...

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

Use the tls_key_bits, tls_curve, and tls_public_key_bytes properties to get more details about the key the certificate contains.

The tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.

This property is read-only.

tls_server_cert_key_bits Property

Returns the length of the public key in bits.

Syntax

def get_tls_server_cert_key_bits(tls_server_cert_index: int) -> int: ...

Default Value

0

Remarks

Returns the length of the public key in bits.

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

The tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.

This property is read-only.

tls_server_cert_key_usage Property

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

Syntax

def get_tls_server_cert_key_usage(tls_server_cert_index: int) -> int: ...

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

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

The tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.

This property is read-only.

tls_server_cert_self_signed Property

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

Syntax

def get_tls_server_cert_self_signed(tls_server_cert_index: int) -> bool: ...

Default Value

FALSE

Remarks

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

The tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.

This property is read-only.

tls_server_cert_serial_number Property

Returns the certificate's serial number.

Syntax

def get_tls_server_cert_serial_number(tls_server_cert_index: int) -> bytes: ...

Remarks

Returns the certificate's serial number.

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

The tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.

This property is read-only.

tls_server_cert_sig_algorithm Property

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

Syntax

def get_tls_server_cert_sig_algorithm(tls_server_cert_index: int) -> str: ...

Default Value

""

Remarks

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

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

The tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.

This property is read-only.

tls_server_cert_subject Property

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

Syntax

def get_tls_server_cert_subject(tls_server_cert_index: int) -> str: ...

Default Value

""

Remarks

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via tls_subject_rdn.

The tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.

This property is read-only.

tls_server_cert_subject_rdn Property

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

Syntax

def get_tls_server_cert_subject_rdn(tls_server_cert_index: int) -> str: ...

Default Value

""

Remarks

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

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

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

The tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.

This property is read-only.

tls_server_cert_valid_from Property

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

Syntax

def get_tls_server_cert_valid_from(tls_server_cert_index: int) -> str: ...

Default Value

""

Remarks

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

The tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.

This property is read-only.

tls_server_cert_valid_to Property

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

Syntax

def get_tls_server_cert_valid_to(tls_server_cert_index: int) -> str: ...

Default Value

""

Remarks

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

The tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.

This property is read-only.

tls_auto_validate_certificates Property

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

Syntax

def get_tls_auto_validate_certificates() -> bool: ...
def set_tls_auto_validate_certificates(value: bool) -> None: ...

tls_auto_validate_certificates = property(get_tls_auto_validate_certificates, set_tls_auto_validate_certificates)

Default Value

TRUE

Remarks

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

tls_base_configuration Property

Selects the base configuration for the TLS settings.

Syntax

def get_tls_base_configuration() -> int: ...
def set_tls_base_configuration(value: int) -> None: ...

tls_base_configuration = property(get_tls_base_configuration, set_tls_base_configuration)

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

tls_ciphersuites Property

A list of ciphersuites separated with commas or semicolons.

Syntax

def get_tls_ciphersuites() -> str: ...
def set_tls_ciphersuites(value: str) -> None: ...

tls_ciphersuites = property(get_tls_ciphersuites, set_tls_ciphersuites)

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

tls_client_auth Property

Enables or disables certificate-based client authentication.

Syntax

def get_tls_client_auth() -> int: ...
def set_tls_client_auth(value: int) -> None: ...

tls_client_auth = property(get_tls_client_auth, set_tls_client_auth)

Default Value

0

Remarks

Enables or disables certificate-based client authentication.

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

ccatNoAuth0
ccatRequestCert1
ccatRequireCert2

tls_ec_curves Property

Defines the elliptic curves to enable.

Syntax

def get_tls_ec_curves() -> str: ...
def set_tls_ec_curves(value: str) -> None: ...

tls_ec_curves = property(get_tls_ec_curves, set_tls_ec_curves)

Default Value

""

Remarks

Defines the elliptic curves to enable.

tls_extensions Property

Provides access to TLS extensions.

Syntax

def get_tls_extensions() -> str: ...
def set_tls_extensions(value: str) -> None: ...

tls_extensions = property(get_tls_extensions, set_tls_extensions)

Default Value

""

Remarks

Provides access to TLS extensions.

tls_force_resume_if_destination_changes Property

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

Syntax

def get_tls_force_resume_if_destination_changes() -> bool: ...
def set_tls_force_resume_if_destination_changes(value: bool) -> None: ...

tls_force_resume_if_destination_changes = property(get_tls_force_resume_if_destination_changes, set_tls_force_resume_if_destination_changes)

Default Value

FALSE

Remarks

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

tls_pre_shared_identity Property

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

Syntax

def get_tls_pre_shared_identity() -> str: ...
def set_tls_pre_shared_identity(value: str) -> None: ...

tls_pre_shared_identity = property(get_tls_pre_shared_identity, set_tls_pre_shared_identity)

Default Value

""

Remarks

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

tls_pre_shared_key Property

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

Syntax

def get_tls_pre_shared_key() -> str: ...
def set_tls_pre_shared_key(value: str) -> None: ...

tls_pre_shared_key = property(get_tls_pre_shared_key, set_tls_pre_shared_key)

Default Value

""

Remarks

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

tls_pre_shared_key_ciphersuite Property

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

Syntax

def get_tls_pre_shared_key_ciphersuite() -> str: ...
def set_tls_pre_shared_key_ciphersuite(value: str) -> None: ...

tls_pre_shared_key_ciphersuite = property(get_tls_pre_shared_key_ciphersuite, set_tls_pre_shared_key_ciphersuite)

Default Value

""

Remarks

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

tls_renegotiation_attack_prevention_mode Property

Selects the renegotiation attack prevention mechanism.

Syntax

def get_tls_renegotiation_attack_prevention_mode() -> int: ...
def set_tls_renegotiation_attack_prevention_mode(value: int) -> None: ...

tls_renegotiation_attack_prevention_mode = property(get_tls_renegotiation_attack_prevention_mode, set_tls_renegotiation_attack_prevention_mode)

Default Value

2

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.

tls_revocation_check Property

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

Syntax

def get_tls_revocation_check() -> int: ...
def set_tls_revocation_check(value: int) -> None: ...

tls_revocation_check = property(get_tls_revocation_check, set_tls_revocation_check)

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.

tls_ssl_options Property

Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size.

Syntax

def get_tls_ssl_options() -> int: ...
def set_tls_ssl_options(value: int) -> None: ...

tls_ssl_options = property(get_tls_ssl_options, set_tls_ssl_options)

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

tls_tls_mode Property

Specifies the TLS mode to use.

Syntax

def get_tls_tls_mode() -> int: ...
def set_tls_tls_mode(value: int) -> None: ...

tls_tls_mode = property(get_tls_tls_mode, set_tls_tls_mode)

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.

tls_use_extended_master_secret Property

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

Syntax

def get_tls_use_extended_master_secret() -> bool: ...
def set_tls_use_extended_master_secret(value: bool) -> None: ...

tls_use_extended_master_secret = property(get_tls_use_extended_master_secret, set_tls_use_extended_master_secret)

Default Value

FALSE

Remarks

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

tls_use_session_resumption Property

Enables or disables the TLS session resumption capability.

Syntax

def get_tls_use_session_resumption() -> bool: ...
def set_tls_use_session_resumption(value: bool) -> None: ...

tls_use_session_resumption = property(get_tls_use_session_resumption, set_tls_use_session_resumption)

Default Value

FALSE

Remarks

Enables or disables the TLS session resumption capability.

tls_versions Property

The SSL/TLS versions to enable by default.

Syntax

def get_tls_versions() -> int: ...
def set_tls_versions(value: int) -> None: ...

tls_versions = property(get_tls_versions, set_tls_versions)

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

trusted_cert_count Property

The number of records in the TrustedCert arrays.

Syntax

def get_trusted_cert_count() -> int: ...
def set_trusted_cert_count(value: int) -> None: ...

trusted_cert_count = property(get_trusted_cert_count, set_trusted_cert_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

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

trusted_cert_bytes Property

Returns the raw certificate data in DER format.

Syntax

def get_trusted_cert_bytes(trusted_cert_index: int) -> bytes: ...

Remarks

Returns the raw certificate data in DER format.

The trusted_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the trusted_cert_count property.

This property is read-only.

trusted_cert_handle Property

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

Syntax

def get_trusted_cert_handle(trusted_cert_index: int) -> int: ...
def set_trusted_cert_handle(trusted_cert_index: int, value: int) -> None: ...

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

username Property

The authentication username.

Syntax

def get_username() -> str: ...
def set_username(value: str) -> None: ...

username = property(get_username, set_username)

Default Value

""

Remarks

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

close_mailbox Method

Closes the current mailbox.

Syntax

def close_mailbox() -> None: ...

Remarks

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

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

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

Establishes a connection to the IMAP server.

Syntax

def connect(address: str, port: int) -> None: ...

Remarks

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

copy_message Method

Copies a message to another mailbox.

Syntax

def copy_message(uid: int, mailbox_name: str) -> None: ...

Remarks

Copies a message specified by its UID to another mailbox.

create_mailbox Method

Creates a new mailbox.

Syntax

def create_mailbox(name: str) -> None: ...

Remarks

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

delete_mailbox Method

Deletes an existing mailbox.

Syntax

def delete_mailbox(name: str) -> None: ...

Remarks

Call this method to delete a mailbox.

disconnect Method

Closes connection to the IMAP server.

Syntax

def disconnect() -> None: ...

Remarks

Call this method to gracefully terminate the connection.

do_action Method

Performs an additional action.

Syntax

def do_action(action_id: str, action_params: str) -> str: ...

Remarks

do_action 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

get_mailbox_info Method

Requests mailbox status.

Syntax

def get_mailbox_info(name: str) -> None: ...

Remarks

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

list_mailboxes Method

Queries a list of mailboxes available on the server.

Syntax

def list_mailboxes() -> str: ...

Remarks

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

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

list_messages Method

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

Syntax

def list_messages(flags_set: int, flags_not_set: int) -> None: ...

Remarks

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

FlagsSet and FlagsNotSet are bit masks of the following values:

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 listed messages should have a flag set, pass it to FlagsSet. If listed messages should not have a flag, pass it to FlagsNotSet.

For example:

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

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

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

open_mailbox Method

Opens the specified mailbox.

Syntax

def open_mailbox(name: str, read_only: bool) -> None: ...

Remarks

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

ping Method

Sends a NOOP command to the IMAP server.

Syntax

def ping() -> None: ...

Remarks

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

post_bytes Method

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

Syntax

def post_bytes(bytes: bytes, flags: int, internal_date: str) -> None: ...

Remarks

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

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.

post_file Method

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

Syntax

def post_file(file_name: str, flags: int, internal_date: str) -> None: ...

Remarks

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

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.

post_message Method

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

Syntax

def post_message(flags: int, internal_date: str) -> None: ...

Remarks

Use this message to upload message to mailbox.

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.

purge_messages Method

Permanently removes all deleted messages from the current mailbox.

Syntax

def purge_messages() -> None: ...

Remarks

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

receive_bytes Method

Downloads a message to a byte array.

Syntax

def receive_bytes(uid: int) -> bytes: ...

Remarks

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

receive_file Method

Downloads a message to a file.

Syntax

def receive_file(uid: int, file_name: str) -> None: ...

Remarks

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

receive_message Method

Downloads a message.

Syntax

def receive_message(uid: int) -> None: ...

Remarks

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

refresh_mailbox Method

Refreshes info about the currently selected mailbox.

Syntax

def refresh_mailbox() -> None: ...

Remarks

Use this method to refresh the mailbox info.

To request information about other mailbox, call get_mailbox_info.

rename_mailbox Method

Renames an existing mailbox.

Syntax

def rename_mailbox(name: str, new_name: str) -> None: ...

Remarks

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

reset Method

Resets the class settings.

Syntax

def reset() -> None: ...

Remarks

reset is a generic method available in every class.

update_message Method

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

Syntax

def update_message(uid: int, set_flags: int, clear_flags: int) -> None: ...

Remarks

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

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.

on_auth_failed Event

Fires when an authentication attempt has failed.

Syntax

class IMAPClientAuthFailedEventParams(object):
  @property
  def auth() -> str: ...

  @property
  def error_code() -> int: ...

  @property
  def error_message() -> str: ...

  @property
  def server_reply() -> str: ...

  @property
  def try_again() -> bool: ...
  @try_again.setter
  def try_again(value) -> None: ...

# In class IMAPClient:
@property
def on_auth_failed() -> Callable[[IMAPClientAuthFailedEventParams], None]: ...
@on_auth_failed.setter
def on_auth_failed(event_hook: Callable[[IMAPClientAuthFailedEventParams], None]) -> None: ...

Remarks

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

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

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

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

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

on_auth_start Event

Fires when the authentication is about to be started.

Syntax

class IMAPClientAuthStartEventParams(object):
  @property
  def usable_auths() -> str: ...

# In class IMAPClient:
@property
def on_auth_start() -> Callable[[IMAPClientAuthStartEventParams], None]: ...
@on_auth_start.setter
def on_auth_start(event_hook: Callable[[IMAPClientAuthStartEventParams], None]) -> None: ...

Remarks

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

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

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

on_auth_succeeded Event

Fires when the authentication has succeeded.

Syntax

class IMAPClientAuthSucceededEventParams(object):
  @property
  def auth() -> str: ...

# In class IMAPClient:
@property
def on_auth_succeeded() -> Callable[[IMAPClientAuthSucceededEventParams], None]: ...
@on_auth_succeeded.setter
def on_auth_succeeded(event_hook: Callable[[IMAPClientAuthSucceededEventParams], None]) -> None: ...

Remarks

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

on_command Event

Reports a command sent to the server.

Syntax

class IMAPClientCommandEventParams(object):
  @property
  def cmd() -> str: ...

# In class IMAPClient:
@property
def on_command() -> Callable[[IMAPClientCommandEventParams], None]: ...
@on_command.setter
def on_command(event_hook: Callable[[IMAPClientCommandEventParams], None]) -> None: ...

Remarks

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

on_command_data Event

Returns the data that accompanies the command.

Syntax

class IMAPClientCommandDataEventParams(object):
  @property
  def cmd() -> str: ...

  @property
  def data() -> str: ...

# In class IMAPClient:
@property
def on_command_data() -> Callable[[IMAPClientCommandDataEventParams], None]: ...
@on_command_data.setter
def on_command_data(event_hook: Callable[[IMAPClientCommandDataEventParams], None]) -> None: ...

Remarks

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

on_command_reply Event

Reports the receipt of a reply to a command.

Syntax

class IMAPClientCommandReplyEventParams(object):
  @property
  def cmd() -> str: ...

  @property
  def reply() -> str: ...

# In class IMAPClient:
@property
def on_command_reply() -> Callable[[IMAPClientCommandReplyEventParams], None]: ...
@on_command_reply.setter
def on_command_reply(event_hook: Callable[[IMAPClientCommandReplyEventParams], None]) -> None: ...

Remarks

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

on_command_reply_data Event

Returns the data that accompanies a reply to a command.

Syntax

class IMAPClientCommandReplyDataEventParams(object):
  @property
  def cmd() -> str: ...

  @property
  def data() -> str: ...

# In class IMAPClient:
@property
def on_command_reply_data() -> Callable[[IMAPClientCommandReplyDataEventParams], None]: ...
@on_command_reply_data.setter
def on_command_reply_data(event_hook: Callable[[IMAPClientCommandReplyDataEventParams], None]) -> None: ...

Remarks

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

on_error Event

Provides information about errors during SMTP operations.

Syntax

class IMAPClientErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class IMAPClient:
@property
def on_error() -> Callable[[IMAPClientErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[IMAPClientErrorEventParams], None]) -> None: ...

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.

on_mailbox_found Event

Provides mailbox details.

Syntax

class IMAPClientMailboxFoundEventParams(object):
  @property
  def name() -> str: ...

  @property
  def delimiter() -> str: ...

  @property
  def attributes() -> int: ...

# In class IMAPClient:
@property
def on_mailbox_found() -> Callable[[IMAPClientMailboxFoundEventParams], None]: ...
@on_mailbox_found.setter
def on_mailbox_found(event_hook: Callable[[IMAPClientMailboxFoundEventParams], None]) -> None: ...

Remarks

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

Delimiter is a mailbox hierarchy delimiter.

Attributes value is bit mask of the following values:

imapMailboxHasChildren0x0001Indicates whether the mailbox has \HasChildren attribute specified.

imapMailboxHasNoChildren0x0002Indicates whether the mailbox has \HasNoChildren attribute specified.

imapMailboxMarked0x0004Indicates whether the mailbox has \Marked attribute specified.

imapMailboxNoInferiors0x0008Indicates whether the mailbox has \NoInferiors attribute specified.

imapMailboxNoSelect0x0010Indicates whether the mailbox has \NoSelect attribute specified.

imapMailboxUnmarked0x0020Indicates whether the mailbox has \Unmarked attribute specified.

on_mailbox_info Event

Reports mailbox information returned from the server.

Syntax

class IMAPClientMailboxInfoEventParams(object):
  @property
  def name() -> str: ...

  @property
  def total_messages() -> int: ...

  @property
  def recent_messages() -> int: ...

  @property
  def unseen_messages() -> int: ...

  @property
  def next_uid() -> int: ...

  @property
  def uid_validity() -> int: ...

# In class IMAPClient:
@property
def on_mailbox_info() -> Callable[[IMAPClientMailboxInfoEventParams], None]: ...
@on_mailbox_info.setter
def on_mailbox_info(event_hook: Callable[[IMAPClientMailboxInfoEventParams], None]) -> None: ...

Remarks

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

on_notification Event

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

Syntax

class IMAPClientNotificationEventParams(object):
  @property
  def event_id() -> str: ...

  @property
  def event_param() -> str: ...

# In class IMAPClient:
@property
def on_notification() -> Callable[[IMAPClientNotificationEventParams], None]: ...
@on_notification.setter
def on_notification(event_hook: Callable[[IMAPClientNotificationEventParams], None]) -> None: ...

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.
TLSExtensions.CertificateStatusTBD
TLSExtensions.PreSharedIdentityHintTBD

on_progress Event

Reports the progress of the data transfer operation.

Syntax

class IMAPClientProgressEventParams(object):
  @property
  def total() -> int: ...

  @property
  def current() -> int: ...

  @property
  def cancel() -> bool: ...
  @cancel.setter
  def cancel(value) -> None: ...

# In class IMAPClient:
@property
def on_progress() -> Callable[[IMAPClientProgressEventParams], None]: ...
@on_progress.setter
def on_progress(event_hook: Callable[[IMAPClientProgressEventParams], None]) -> None: ...

Remarks

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

on_tls_cert_needed Event

Fires when a remote TLS party requests a client certificate.

Syntax

class IMAPClientTLSCertNeededEventParams(object):
  @property
  def host() -> str: ...

  @property
  def ca_names() -> str: ...

# In class IMAPClient:
@property
def on_tls_cert_needed() -> Callable[[IMAPClientTLSCertNeededEventParams], None]: ...
@on_tls_cert_needed.setter
def on_tls_cert_needed(event_hook: Callable[[IMAPClientTLSCertNeededEventParams], None]) -> None: ...

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 tls_client_chain 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 on_tls_handshake event for the given host and, if the certificate was accepted, succeeded by the on_tls_established event.

on_tls_cert_validate Event

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

Syntax

class IMAPClientTLSCertValidateEventParams(object):
  @property
  def server_host() -> str: ...

  @property
  def server_ip() -> str: ...

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class IMAPClient:
@property
def on_tls_cert_validate() -> Callable[[IMAPClientTLSCertValidateEventParams], None]: ...
@on_tls_cert_validate.setter
def on_tls_cert_validate(event_hook: Callable[[IMAPClientTLSCertValidateEventParams], None]) -> None: ...

Remarks

This event is fired during a TLS handshake. Use the tls_server_chain 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.

on_tls_established Event

Fires when a TLS handshake with Host successfully completes.

Syntax

class IMAPClientTLSEstablishedEventParams(object):
  @property
  def host() -> str: ...

  @property
  def version() -> str: ...

  @property
  def ciphersuite() -> str: ...

  @property
  def connection_id() -> bytes: ...

  @property
  def abort() -> bool: ...
  @abort.setter
  def abort(value) -> None: ...

# In class IMAPClient:
@property
def on_tls_established() -> Callable[[IMAPClientTLSEstablishedEventParams], None]: ...
@on_tls_established.setter
def on_tls_established(event_hook: Callable[[IMAPClientTLSEstablishedEventParams], None]) -> None: ...

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.

on_tls_handshake Event

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

Syntax

class IMAPClientTLSHandshakeEventParams(object):
  @property
  def host() -> str: ...

  @property
  def abort() -> bool: ...
  @abort.setter
  def abort(value) -> None: ...

# In class IMAPClient:
@property
def on_tls_handshake() -> Callable[[IMAPClientTLSHandshakeEventParams], None]: ...
@on_tls_handshake.setter
def on_tls_handshake(event_hook: Callable[[IMAPClientTLSHandshakeEventParams], None]) -> None: ...

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 on_tls_established event. If the server chooses to request a client certificate, the on_tls_cert_needed event will also be fired.

on_tls_psk Event

Notifies the application about the PSK key exchange.

Syntax

class IMAPClientTLSPSKEventParams(object):
  @property
  def host() -> str: ...

  @property
  def hint() -> str: ...

# In class IMAPClient:
@property
def on_tls_psk() -> Callable[[IMAPClientTLSPSKEventParams], None]: ...
@on_tls_psk.setter
def on_tls_psk(event_hook: Callable[[IMAPClientTLSPSKEventParams], None]) -> None: ...

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 tls_settings to provide the pre-shared key to the component.

on_tls_shutdown Event

Reports the graceful closure of a TLS connection.

Syntax

class IMAPClientTLSShutdownEventParams(object):
  @property
  def host() -> str: ...

# In class IMAPClient:
@property
def on_tls_shutdown() -> Callable[[IMAPClientTLSShutdownEventParams], None]: ...
@on_tls_shutdown.setter
def on_tls_shutdown(event_hook: Callable[[IMAPClientTLSShutdownEventParams], None]) -> None: ...

Remarks

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

IMAPClient Config Settings

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: SCRAM-SHA-256,SCRAM-SHA-1,DIGEST-MD5,CRAM-MD5,LOGIN

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

SessionLogDetails:   Specifies whether login credentials should be written to the session log.

Use this setting to configure the details written to SessionLog. Possible values are:

defaultLogin credentials are not logged.
fullLogin credentials appeare in the SessionLog.
noneNo SessionLog is created.
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.

TempPath:   Path for storing temporary files.

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

TLSExtensions:   TBD.

TBD

TLSPeerExtensions:   TBD.

TBD

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

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

ASN1UseGlobalTagCache:   Controls whether ASN.1 module should use a global object cache.

This is a performance setting. It is unlikely that you will ever need to adjust it.

AssignSystemSmartCardPins:   Specifies whether CSP-level PINs should be assigned to CNG keys.

This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it.

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.

DNSLocalSuffix:   The suffix to assign for TLD names.

Use this global setting to adjust the default suffix to assign to top-level domain names. The default is .local.

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

HardwareCryptoUsePolicy:   The hardware crypto usage policy.

This global setting controls the hardware cryptography usage policy: auto, enable, or disable.

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.

HttpVersion:   The HTTP version to use in any inner HTTP client components created.

Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use.

IgnoreExpiredMSCTLSigningCert:   Whether to tolerate the expired Windows Update signing certificate.

It is not uncommon for Microsoft Windows Update Certificate Trust List to be signed with an expired Microsoft certificate. Setting this global property to true makes SBB ignore the expired factor and take the Trust List into account.

ListDelimiter:   The delimiter character for multi-element lists.

Allows to set the delimiter for any multi-entry values returned by the component as a string object, such as file lists. For most of the components, this property is set to a newline sequence.

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.

OldClientSideRSAFallback:   Specifies whether the SSH client should use a SHA1 fallback.

Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak.

ProductVersion:   Returns the version of the SecureBlackbox library.

This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision).

ServerSSLDHKeyLength:   Sets the size of the TLS DHE key exchange group.

Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server.

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

UseInternalRandom:   Switches between SecureBlackbox-own and platform PRNGs.

Allows to switch between internal/native PRNG implementation and the one provided by the platform.

UseLegacyAdESValidation:   Enables legacy AdES validation mode.

Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details).

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.

UseSystemNativeSizeCalculation:   An internal CryptoAPI access tweak.

This is an internal setting. Please do not use it unless instructed by the support team.

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.

IMAPClient Errors

IMAPClient Errors

1048577   Invalid parameter (SB_ERROR_INVALID_PARAMETER)
1048578   Invalid configuration (SB_ERROR_INVALID_SETUP)
1048579   Invalid state (SB_ERROR_INVALID_STATE)
1048580   Invalid value (SB_ERROR_INVALID_VALUE)
1048581   Private key not found (SB_ERROR_NO_PRIVATE_KEY)
1048582   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER)
1048583   The file was not found (SB_ERROR_NO_SUCH_FILE)
1048584   Unsupported feature or operation (SB_ERROR_UNSUPPORTED_FEATURE)
1048585   General error (SB_ERROR_GENERAL_ERROR)