POP3Client Class

Properties   Methods   Events   Config Settings   Errors  

The POP3Client class provides client-side functionality of the POP3 protocol for collecting E-mail messages from the server.

Syntax

class secureblackbox.POP3Client

Remarks

Use this class to retrieve e-mail messages from a POP3 server.

Property List

---

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

Method List

---

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

Event List

---

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

Config Settings

---

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

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:

• blocked_cert_bytes
• blocked_cert_handle

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.

client_cert_count Property

The number of records in the ClientCert arrays.

Syntax

def get_client_cert_count() -> int: ...
def set_client_cert_count(value: int) -> None: ...

client_cert_count = property(get_client_cert_count, set_client_cert_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• client_cert_bytes
• client_cert_handle

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

client_cert_bytes Property

Returns the raw certificate data in DER format.

Syntax

def get_client_cert_bytes(client_cert_index: int) -> bytes: ...

Remarks

Returns the raw certificate data in DER format.

The client_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the client_cert_count property.

This property is read-only.

client_cert_handle Property

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

Syntax

def get_client_cert_handle(client_cert_index: int) -> int: ...
def set_client_cert_handle(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 client_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the client_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:

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:

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

external_crypto_async_document_id Property

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Syntax

def get_external_crypto_async_document_id() -> str: ...
def set_external_crypto_async_document_id(value: str) -> None: ...

external_crypto_async_document_id = property(get_external_crypto_async_document_id, set_external_crypto_async_document_id)

Default Value

""

Remarks

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses.

If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

external_crypto_custom_params Property

Custom parameters to be passed to the signing service (uninterpreted).

Syntax

def get_external_crypto_custom_params() -> str: ...
def set_external_crypto_custom_params(value: str) -> None: ...

external_crypto_custom_params = property(get_external_crypto_custom_params, set_external_crypto_custom_params)

Default Value

""

Remarks

Custom parameters to be passed to the signing service (uninterpreted).

external_crypto_data Property

Additional data to be included in the async state and mirrored back by the requestor.

Syntax

def get_external_crypto_data() -> str: ...
def set_external_crypto_data(value: str) -> None: ...

external_crypto_data = property(get_external_crypto_data, set_external_crypto_data)

Default Value

""

Remarks

Additional data to be included in the async state and mirrored back by the requestor.

external_crypto_external_hash_calculation Property

Specifies whether the message hash is to be calculated at the external endpoint.

Syntax

def get_external_crypto_external_hash_calculation() -> bool: ...
def set_external_crypto_external_hash_calculation(value: bool) -> None: ...

external_crypto_external_hash_calculation = property(get_external_crypto_external_hash_calculation, set_external_crypto_external_hash_calculation)

Default Value

FALSE

Remarks

Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth class.

If set to true, the class will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called.

external_crypto_hash_algorithm Property

Specifies the request's signature hash algorithm.

Syntax

def get_external_crypto_hash_algorithm() -> str: ...
def set_external_crypto_hash_algorithm(value: str) -> None: ...

external_crypto_hash_algorithm = property(get_external_crypto_hash_algorithm, set_external_crypto_hash_algorithm)

Default Value

"SHA256"

Remarks

Specifies the request's signature hash algorithm.

external_crypto_key_id Property

The ID of the pre-shared key used for DC request authentication.

Syntax

def get_external_crypto_key_id() -> str: ...
def set_external_crypto_key_id(value: str) -> None: ...

external_crypto_key_id = property(get_external_crypto_key_id, set_external_crypto_key_id)

Default Value

""

Remarks

The ID of the pre-shared key used for DC request authentication.

Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use external_crypto_key_secret to pass the key itself.

The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted.

Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users.

Example: signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789";

external_crypto_key_secret Property

The pre-shared key used for DC request authentication.

Syntax

def get_external_crypto_key_secret() -> str: ...
def set_external_crypto_key_secret(value: str) -> None: ...

external_crypto_key_secret = property(get_external_crypto_key_secret, set_external_crypto_key_secret)

Default Value

""

Remarks

The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work.

Read more about configuring authentication in the external_crypto_key_id topic.

external_crypto_method Property

Specifies the asynchronous signing method.

Syntax

def get_external_crypto_method() -> int: ...
def set_external_crypto_method(value: int) -> None: ...

external_crypto_method = property(get_external_crypto_method, set_external_crypto_method)

Default Value

0

Remarks

Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.

Available options:

external_crypto_mode Property

Specifies the external cryptography mode.

Syntax

def get_external_crypto_mode() -> int: ...
def set_external_crypto_mode(value: int) -> None: ...

external_crypto_mode = property(get_external_crypto_mode, set_external_crypto_mode)

Default Value

0

Remarks

Specifies the external cryptography mode.

Available options:

external_crypto_public_key_algorithm Property

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.

Syntax

def get_external_crypto_public_key_algorithm() -> str: ...
def set_external_crypto_public_key_algorithm(value: str) -> None: ...

external_crypto_public_key_algorithm = property(get_external_crypto_public_key_algorithm, set_external_crypto_public_key_algorithm)

Default Value

""

Remarks

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.

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:

• known_cert_bytes
• known_cert_handle

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:

• known_crl_bytes
• known_crl_handle

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:

• known_ocsp_bytes
• known_ocsp_handle

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.

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

msg_bcc = property(get_msg_bcc, None)

Default Value

""

Remarks

The contents of the BCC header field.

The BCC header field contains the addresses of secondary recipients of the message whose addresses are not to be revealed to other recipients of the message. Mail servers remove the BCC header when processing the message and use its value for dispatching the message only.

This property is read-only.

msg_cc Property

The value of the CC header property.

Syntax

def get_msg_cc() -> str: ...

msg_cc = property(get_msg_cc, None)

Default Value

""

Remarks

The value of the CC header field.

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

This property is read-only.

msg_comments Property

Contains additional information about the message body.

Syntax

def get_msg_comments() -> str: ...

msg_comments = property(get_msg_comments, None)

Default Value

""

Remarks

Contains additional information about the message body.

This property is read-only.

msg_date Property

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

Syntax

def get_msg_date() -> str: ...

msg_date = property(get_msg_date, None)

Default Value

""

Remarks

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

This field contains the date and time at which the creator of the message posted the message to the mail delivery system.

The date is returned and accepted in UTC time zone.

This property is read-only.

msg_delivery_receipt Property

Enables delivery notification.

Syntax

def get_msg_delivery_receipt() -> bool: ...

msg_delivery_receipt = property(get_msg_delivery_receipt, None)

Default Value

FALSE

Remarks

Enables delivery notification.

This property is read-only.

msg_from Property

Contains the value of the From header property.

Syntax

def get_msg_from() -> str: ...

msg_from = property(get_msg_from, None)

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.

This property is read-only.

msg_handle Property

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

Syntax

def get_msg_handle() -> int: ...

msg_handle = property(get_msg_handle, 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());

This property is read-only.

msg_html_text Property

The HTML version of the message.

Syntax

def get_msg_html_text() -> str: ...

msg_html_text = property(get_msg_html_text, None)

Default Value

""

Remarks

The HTML version of the message.

This property is read-only.

msg_id Property

The contents of the Message-ID header property.

Syntax

def get_msg_id() -> str: ...

msg_id = property(get_msg_id, None)

Default Value

""

Remarks

The contents of the Message-ID header field.

This field contains a unique identifier that refers to a particular version of this message.

This property is read-only.

msg_in_reply_to Property

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

Syntax

def get_msg_in_reply_to() -> str: ...

msg_in_reply_to = property(get_msg_in_reply_to, None)

Default Value

""

Remarks

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

A reply message should have the "In-Reply-To:" header field which may be used to identify the message (or messages) to which the new message is a reply.

This property is read-only.

msg_keywords Property

The value of the Keywords header property.

Syntax

def get_msg_keywords() -> str: ...

msg_keywords = property(get_msg_keywords, None)

Default Value

""

Remarks

The value of the Keywords header field.

This field can be used to add some important words and phrases that might be useful for the recipient.

This property is read-only.

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

msg_plain_text = property(get_msg_plain_text, None)

Default Value

""

Remarks

The plain text version of the message.

This property is read-only.

msg_priority Property

Specifies the message priority.

Syntax

def get_msg_priority() -> int: ...

msg_priority = property(get_msg_priority, None)

Default Value

2

Remarks

Specifies the message priority.

Available options:

This property is read-only.

msg_read_receipt Property

Enables a read notification.

Syntax

def get_msg_read_receipt() -> bool: ...

msg_read_receipt = property(get_msg_read_receipt, None)

Default Value

FALSE

Remarks

Enables a read notification.

This property is read-only.

msg_references Property

The value of the References header property.

Syntax

def get_msg_references() -> str: ...

msg_references = property(get_msg_references, None)

Default Value

""

Remarks

The value of the References header field.

A reply message should include a "References:" header field which may be used to identify the "conversation thread". If the initial message is a reply itself, the References of the reply contain combined content of its "References:", "InReplyTo:" and "MessageID:" fields, subject to their presence in the original message.

This property is read-only.

msg_reply_to Property

The value of the Reply-To header property.

Syntax

def get_msg_reply_to() -> str: ...

msg_reply_to = property(get_msg_reply_to, None)

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.

This property is read-only.

msg_return_path Property

The value of the Return-Path header property.

Syntax

def get_msg_return_path() -> str: ...

msg_return_path = property(get_msg_return_path, None)

Default Value

""

Remarks

The value of the Return-Path header field.

This field contains the address to which this message shall be returned in case of unsuccessful delivery.

This property is read-only.

msg_sender Property

The value of the Sender header property.

Syntax

def get_msg_sender() -> str: ...

msg_sender = property(get_msg_sender, None)

Default Value

""

Remarks

The value of the Sender header field.

This field specifies the mailbox of the agent responsible for the actual transmission of this message. If the originator of the message can be indicated by a single mailbox and both the author and the transmitter are identical, the "Sender:" field is deemed excessive and should not be used.

This property is read-only.

msg_send_to Property

The value of the To header property.

Syntax

def get_msg_send_to() -> str: ...

msg_send_to = property(get_msg_send_to, None)

Default Value

""

Remarks

The value of the To header field.

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

This property is read-only.

msg_subject Property

Contains the subject property of this message.

Syntax

def get_msg_subject() -> str: ...

msg_subject = property(get_msg_subject, None)

Default Value

""

Remarks

Contains the subject field of this message.

This property is read-only.

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:

• msg_info_size
• msg_info_uid

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

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_uid Property

Returns the unique ID of the mail message.

Syntax

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

Default Value

""

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

A password to authenticate to the POP3 server.

Syntax

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

password = property(get_password, set_password)

Default Value

""

Remarks

Use this property together with username to provide an authentication password. In order to use OAuth 2.0 authentication to access the POP3 server, assign the access token to this property prepending it with "oauth:".

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.

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.

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

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_use_proxy Property

Enables or disables proxy-driven connection.

Syntax

def get_proxy_use_proxy() -> bool: ...
def set_proxy_use_proxy(value: bool) -> None: ...

proxy_use_proxy = property(get_proxy_use_proxy, set_proxy_use_proxy)

Default Value

FALSE

Remarks

Enables or disables proxy-driven connection.

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_cert_count Property

The number of records in the ServerCert arrays.

Syntax

def get_server_cert_count() -> int: ...

server_cert_count = property(get_server_cert_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• server_cert_bytes
• server_cert_ca_key_id
• server_cert_fingerprint
• server_cert_handle
• server_cert_issuer
• server_cert_issuer_rdn
• server_cert_key_algorithm
• server_cert_key_bits
• server_cert_key_fingerprint
• server_cert_key_usage
• server_cert_public_key_bytes
• server_cert_self_signed
• server_cert_serial_number
• server_cert_sig_algorithm
• server_cert_subject
• server_cert_subject_key_id
• server_cert_subject_rdn
• server_cert_valid_from
• server_cert_valid_to

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

This property is read-only.

server_cert_bytes Property

Returns the raw certificate data in DER format.

Syntax

def get_server_cert_bytes(server_cert_index: int) -> bytes: ...

Remarks

Returns the raw certificate data in DER format.

The server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the server_cert_count property.

This property is read-only.

server_cert_ca_key_id Property

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

Syntax

def get_server_cert_ca_key_id(server_cert_index: int) -> bytes: ...

Remarks

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

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

The server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the server_cert_count property.

This property is read-only.

server_cert_fingerprint Property

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

Syntax

def get_server_cert_fingerprint(server_cert_index: int) -> bytes: ...

Remarks

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

The server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the server_cert_count property.

This property is read-only.

server_cert_handle Property

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

Syntax

def get_server_cert_handle(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 server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the server_cert_count property.

This property is read-only.

server_cert_issuer Property

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

Syntax

def get_server_cert_issuer(server_cert_index: int) -> str: ...

Default Value

""

Remarks

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

The server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the server_cert_count property.

This property is read-only.

server_cert_issuer_rdn Property

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

Syntax

def get_server_cert_issuer_rdn(server_cert_index: int) -> str: ...

Default Value

""

Remarks

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

The server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the server_cert_count property.

This property is read-only.

server_cert_key_algorithm Property

Specifies the public key algorithm of this certificate.

Syntax

def get_server_cert_key_algorithm(server_cert_index: int) -> str: ...

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

The server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the server_cert_count property.

This property is read-only.

server_cert_key_bits Property

Returns the length of the public key.

Syntax

def get_server_cert_key_bits(server_cert_index: int) -> int: ...

Default Value

0

Remarks

Returns the length of the public key.

The server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the server_cert_count property.

This property is read-only.

server_cert_key_fingerprint Property

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

Syntax

def get_server_cert_key_fingerprint(server_cert_index: int) -> bytes: ...

Remarks

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

The server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the server_cert_count property.

This property is read-only.

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_server_cert_key_usage(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:

The server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the server_cert_count property.

This property is read-only.

server_cert_public_key_bytes Property

Contains the certificate's public key in DER format.

Syntax

def get_server_cert_public_key_bytes(server_cert_index: int) -> bytes: ...

Remarks

Contains the certificate's public key in DER format.

The server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the server_cert_count property.

This property is read-only.

server_cert_self_signed Property

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

Syntax

def get_server_cert_self_signed(server_cert_index: int) -> bool: ...

Default Value

FALSE

Remarks

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

The server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the server_cert_count property.

This property is read-only.

server_cert_serial_number Property

Returns the certificate's serial number.

Syntax

def get_server_cert_serial_number(server_cert_index: int) -> bytes: ...

Remarks

Returns the certificate's serial number.

The server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the server_cert_count property.

This property is read-only.

server_cert_sig_algorithm Property

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

Syntax

def get_server_cert_sig_algorithm(server_cert_index: int) -> str: ...

Default Value

""

Remarks

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

The server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the server_cert_count property.

This property is read-only.

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_server_cert_subject(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.

The server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the server_cert_count property.

This property is read-only.

server_cert_subject_key_id Property

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

Syntax

def get_server_cert_subject_key_id(server_cert_index: int) -> bytes: ...

Remarks

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

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

The server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the server_cert_count property.

This property is read-only.

server_cert_subject_rdn Property

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

Syntax

def get_server_cert_subject_rdn(server_cert_index: int) -> str: ...

Default Value

""

Remarks

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

The server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the server_cert_count property.

This property is read-only.

server_cert_valid_from Property

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

Syntax

def get_server_cert_valid_from(server_cert_index: int) -> str: ...

Default Value

""

Remarks

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

The server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the server_cert_count property.

This property is read-only.

server_cert_valid_to Property

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

Syntax

def get_server_cert_valid_to(server_cert_index: int) -> str: ...

Default Value

""

Remarks

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

The server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the server_cert_count property.

This property is read-only.

server_info_apop_supported Property

Indicates whether the POP3 server supports the APOP command.

Syntax

def get_server_info_apop_supported() -> bool: ...

server_info_apop_supported = property(get_server_info_apop_supported, None)

Default Value

FALSE

Remarks

Indicates whether the POP3 server supports the APOP command.

This property is read-only.

server_info_available Property

Indicates whether the details of the server capabilities are available.

Syntax

def get_server_info_available() -> bool: ...

server_info_available = property(get_server_info_available, None)

Default Value

FALSE

Remarks

Indicates whether the details of the server capabilities are available.

This property is read-only.

server_info_expiration_period Property

Contains the parameter of EXPIRE capability.

Syntax

def get_server_info_expiration_period() -> int: ...

server_info_expiration_period = property(get_server_info_expiration_period, None)

Default Value

-1

Remarks

Contains the parameter of EXPIRE capability.

This property is read-only.

server_info_expire_supported Property

Indicates whether the POP3 server supports the EXPIRE extension.

Syntax

def get_server_info_expire_supported() -> bool: ...

server_info_expire_supported = property(get_server_info_expire_supported, None)

Default Value

FALSE

Remarks

Indicates whether the POP3 server supports the EXPIRE extension. See server_info_expiration_period field.

This property is read-only.

server_info_implementation_supported Property

Indicates whether the POP3 server supports the IMPLEMENTATION extension.

Syntax

def get_server_info_implementation_supported() -> bool: ...

server_info_implementation_supported = property(get_server_info_implementation_supported, None)

Default Value

FALSE

Remarks

Indicates whether the POP3 server supports the IMPLEMENTATION extension. See server_info_server_details field.

This property is read-only.

server_info_login_delay Property

Returns the parameter of LOGIN-DELAY capability.

Syntax

def get_server_info_login_delay() -> int: ...

server_info_login_delay = property(get_server_info_login_delay, None)

Default Value

0

Remarks

Returns the parameter of LOGIN-DELAY capability.

The LOGIN-DELAY parameter indicates the minimum number of seconds between unsuccessful login attempts. See RFC 2449, Section 6.5 for more information.

This property is read-only.

server_info_login_delay_supported Property

Indicates whether the POP3 server supports the LOGIN-DELAY extension.

Syntax

def get_server_info_login_delay_supported() -> bool: ...

server_info_login_delay_supported = property(get_server_info_login_delay_supported, None)

Default Value

FALSE

Remarks

Indicates whether the POP3 server supports the LOGIN-DELAY extension.

See server_info_login_delay property for the details.

This property is read-only.

server_info_resp_codes_supported Property

Indicates whether the POP3 server supports the RESP-CODES extension.

Syntax

def get_server_info_resp_codes_supported() -> bool: ...

server_info_resp_codes_supported = property(get_server_info_resp_codes_supported, None)

Default Value

FALSE

Remarks

Indicates whether the POP3 server supports the RESP-CODES extension.

The RESP-CODES capability indicates that any response text issued by this server which begins with an open square bracket ("[") is an extended response code (see section 8 of RFC 2449). For more information see For more information see RFC 2449, Section 6.4.

This property is read-only.

server_info_sasl_supported Property

Indicates whether the POP3 server supports SASL authentication.

Syntax

def get_server_info_sasl_supported() -> bool: ...

server_info_sasl_supported = property(get_server_info_sasl_supported, None)

Default Value

FALSE

Remarks

Indicates whether the POP3 server supports SASL authentication.

This property is read-only.

server_info_server_details Property

Contains the parameter of the IMPLEMENTATION capability.

Syntax

def get_server_info_server_details() -> str: ...

server_info_server_details = property(get_server_info_server_details, None)

Default Value

""

Remarks

Contains the parameter of the IMPLEMENTATION capability.

The value of this property only makes sense if server_info_available and server_info_implementation_supported parameters are true.

The parameter to the IMPLEMENTATION capability consists of one or more tokens that identify the server. For more information see RFC 2449, Section 6.9.

This property is read-only.

server_info_top_supported Property

Indicates whether the POP3 server supports the TOP command.

Syntax

def get_server_info_top_supported() -> bool: ...

server_info_top_supported = property(get_server_info_top_supported, None)

Default Value

FALSE

Remarks

Indicates whether the POP3 server supports the TOP command.

This property is read-only.

server_info_uidl_supported Property

Indicates whether the POP3 server supports the UIDL command.

Syntax

def get_server_info_uidl_supported() -> bool: ...

server_info_uidl_supported = property(get_server_info_uidl_supported, None)

Default Value

FALSE

Remarks

Indicates whether the POP3 server supports the UIDL command.

This property is read-only.

server_info_user_supported Property

Indicates whether the POP3 server supports the USER command.

Syntax

def get_server_info_user_supported() -> bool: ...

server_info_user_supported = property(get_server_info_user_supported, None)

Default Value

FALSE

Remarks

Indicates whether the POP3 server supports the USER command.

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.

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

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_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

0

Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:

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.

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

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.

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.

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:

• trusted_cert_bytes
• trusted_cert_handle

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

A username to authenticate to the POP3 server.

Syntax

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

username = property(get_username, set_username)

Default Value

""

Remarks

Use this property together with password to provide authentication credentials to the component.

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 connection to the POP3 server.

Syntax

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

Remarks

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

delete_message Method

Deletes a message from the server-side mailbox.

Syntax

def delete_message(index: int) -> None: ...

Remarks

Call this method to delete a message from the mailbox.

Note that the message may not be deleted immediately. It is typical for POP3 servers to only mark messages for deletion upon receipt of this command, and only delete them after the connection has been gracefully closed.

If needed, messages can be "undeleted" during the same session by calling the undelete method.

disconnect Method

Closes connection to the POP3 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;....

list_messages Method

Queries a list of messages available on the server.

Syntax

def list_messages() -> None: ...

Remarks

Use this method to request a list of messages currently available on the server. Use the messages property to access the message details.

ping Method

Sends a NOOP command to the POP3 server.

Syntax

def ping() -> None: ...

Remarks

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

receive_bytes Method

Downloads a message to a byte array.

Syntax

def receive_bytes(index: 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(index: int, filename: 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(index: int) -> None: ...

Remarks

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

undelete Method

Undeletes messages marked for deletion.

Syntax

def undelete() -> None: ...

Remarks

This method sends an RSET command, which tells the server to undelete all previously deleted messages by removing their 'delete' marks.

Note that this method only applies to messages deleted within the same session.

on_before_auth Event

Fires before the authentication starts.

Syntax

class POP3ClientBeforeAuthEventParams(object):
# In class POP3Client:
@property
def on_before_auth() -> Callable[[POP3ClientBeforeAuthEventParams], None]: ...
@on_before_auth.setter
def on_before_auth(event_hook: Callable[[POP3ClientBeforeAuthEventParams], 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.

on_command Event

Reports a command sent to the server.

Syntax

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

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

Remarks

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

on_command_reply Event

Reports the receipt of a reply to a command.

Syntax

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

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

# In class POP3Client:
@property
def on_command_reply() -> Callable[[POP3ClientCommandReplyEventParams], None]: ...
@on_command_reply.setter
def on_command_reply(event_hook: Callable[[POP3ClientCommandReplyEventParams], 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 POP3ClientCommandReplyDataEventParams(object):
  @property
  def cmd() -> str: ...

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

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

Remarks

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

on_error Event

Provides information about errors during POP3 operations.

Syntax

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

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

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

Remarks

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

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

on_external_sign Event

Handles remote or external signing initiated by the SignExternal method or other source.

Syntax

class POP3ClientExternalSignEventParams(object):
  @property
  def operation_id() -> str: ...

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

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

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

  @property
  def signed_data() -> str: ...
  @signed_data.setter
  def signed_data(value) -> None: ...

# In class POP3Client:
@property
def on_external_sign() -> Callable[[POP3ClientExternalSignEventParams], None]: ...
@on_external_sign.setter
def on_external_sign(event_hook: Callable[[POP3ClientExternalSignEventParams], None]) -> None: ...

Remarks

Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed.

The event handler must pass the value of Data to the signer, obtain the signature, and pass it back to the class via the SignedData parameter.

OperationId provides a comment about the operation and its origin. It depends on the exact class being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contains algorithm-dependent parameters.

The class uses base16 (hex) encoding for the Data, SignedData, and Pars parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing.

A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16

A sample event handler that uses the .NET RSACryptoServiceProvider class may look like the following: signer.OnExternalSign += (s, e) => { var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable); var key = (RSACryptoServiceProvider)cert.PrivateKey; var dataToSign = e.Data.FromBase16String(); var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1"); e.SignedData = signedData.ToBase16String(); };

on_notification Event

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

Syntax

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

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

# In class POP3Client:
@property
def on_notification() -> Callable[[POP3ClientNotificationEventParams], None]: ...
@on_notification.setter
def on_notification(event_hook: Callable[[POP3ClientNotificationEventParams], 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.

on_progress Event

Reports the progress of the data transfer operation.

Syntax

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

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

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

# In class POP3Client:
@property
def on_progress() -> Callable[[POP3ClientProgressEventParams], None]: ...
@on_progress.setter
def on_progress(event_hook: Callable[[POP3ClientProgressEventParams], 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 POP3ClientTLSCertNeededEventParams(object):
  @property
  def host() -> str: ...

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

# In class POP3Client:
@property
def on_tls_cert_needed() -> Callable[[POP3ClientTLSCertNeededEventParams], None]: ...
@on_tls_cert_needed.setter
def on_tls_cert_needed(event_hook: Callable[[POP3ClientTLSCertNeededEventParams], 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 POP3ClientTLSCertValidateEventParams(object):
  @property
  def server_host() -> str: ...

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

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

# In class POP3Client:
@property
def on_tls_cert_validate() -> Callable[[POP3ClientTLSCertValidateEventParams], None]: ...
@on_tls_cert_validate.setter
def on_tls_cert_validate(event_hook: Callable[[POP3ClientTLSCertValidateEventParams], 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 POP3ClientTLSEstablishedEventParams(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 POP3Client:
@property
def on_tls_established() -> Callable[[POP3ClientTLSEstablishedEventParams], None]: ...
@on_tls_established.setter
def on_tls_established(event_hook: Callable[[POP3ClientTLSEstablishedEventParams], 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 POP3ClientTLSHandshakeEventParams(object):
  @property
  def host() -> str: ...

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

# In class POP3Client:
@property
def on_tls_handshake() -> Callable[[POP3ClientTLSHandshakeEventParams], None]: ...
@on_tls_handshake.setter
def on_tls_handshake(event_hook: Callable[[POP3ClientTLSHandshakeEventParams], 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 POP3ClientTLSPSKEventParams(object):
  @property
  def host() -> str: ...

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

# In class POP3Client:
@property
def on_tls_psk() -> Callable[[POP3ClientTLSPSKEventParams], None]: ...
@on_tls_psk.setter
def on_tls_psk(event_hook: Callable[[POP3ClientTLSPSKEventParams], 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 POP3ClientTLSShutdownEventParams(object):
  @property
  def host() -> str: ...

# In class POP3Client:
@property
def on_tls_shutdown() -> Callable[[POP3ClientTLSShutdownEventParams], None]: ...
@on_tls_shutdown.setter
def on_tls_shutdown(event_hook: Callable[[POP3ClientTLSShutdownEventParams], 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.

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

POP3Client Config Settings

Base Config Settings

POP3Client Errors

POP3Client Errors

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