IMAPClient Class

Properties Methods Events Configuration Settings Errors

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

Syntax

class secureblackbox.IMAPClient

Remarks

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

Property List

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


blocked_cert_count	The number of records in the BlockedCert arrays.
blocked_cert_bytes	Returns raw certificate data in DER format.
blocked_cert_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
client_cert_count	The number of records in the ClientCert arrays.
client_cert_bytes	Returns raw certificate data in DER format.
client_cert_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
conn_info_aead_cipher	Indicates whether the encryption algorithm used is an AEAD cipher.
conn_info_chain_validation_details	The details of a certificate chain validation outcome.
conn_info_chain_validation_result	The outcome of a certificate chain validation routine.
conn_info_ciphersuite	The cipher suite employed by this connection.
conn_info_client_authenticated	Specifies whether client authentication was performed during this connection.
conn_info_client_auth_requested	Specifies whether client authentication was requested during this connection.
conn_info_connection_established	Indicates whether the connection has been established fully.
conn_info_connection_id	The unique identifier assigned to this connection.
conn_info_digest_algorithm	The digest algorithm used in a TLS-enabled connection.
conn_info_encryption_algorithm	The symmetric encryption algorithm used in a TLS-enabled connection.
conn_info_exportable	Indicates whether a TLS connection uses a reduced-strength exportable cipher.
conn_info_key_exchange_algorithm	The key exchange algorithm used in a TLS-enabled connection.
conn_info_key_exchange_key_bits	The length of the key exchange key of a TLS-enabled connection.
conn_info_named_ec_curve	The elliptic curve used in this connection.
conn_info_pfs_cipher	Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).
conn_info_pre_shared_identity_hint	A hint professed by the server to help the client select the PSK identity to use.
conn_info_public_key_bits	The length of the public key.
conn_info_resumed_session	Indicates whether a TLS-enabled connection was spawned from another TLS connection.
conn_info_secure_connection	Indicates whether TLS or SSL is enabled for this connection.
conn_info_server_authenticated	Indicates whether server authentication was performed during a TLS-enabled connection.
conn_info_signature_algorithm	The signature algorithm used in a TLS handshake.
conn_info_symmetric_block_size	The block size of the symmetric algorithm used.
conn_info_symmetric_key_bits	The key length of the symmetric algorithm used.
conn_info_total_bytes_received	The total number of bytes received over this connection.
conn_info_total_bytes_sent	The total number of bytes sent over this connection.
conn_info_validation_log	Contains the server certificate's chain validation log.
conn_info_version	Indicates the version of SSL/TLS protocol negotiated during this connection.
curr_mailbox_message_flags	Contains message flags defined in the mailbox.
curr_mailbox_name	Specifies mailbox name.
curr_mailbox_next_uid	Returns the next unique identifier value.
curr_mailbox_permanent_flags	Contains a list of message flags that can be changed permanently.
curr_mailbox_read_only	Specifies whether the mailbox is write-protected.
curr_mailbox_recent_messages	The number of recent messages in the mailbox.
curr_mailbox_total_messages	Total number of messages in the mailbox.
curr_mailbox_uid_validity	Specifies UID validity value.
curr_mailbox_unseen_messages	The number of unseen messages in the mailbox.
known_cert_count	The number of records in the KnownCert arrays.
known_cert_bytes	Returns raw certificate data in DER format.
known_cert_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
known_crl_count	The number of records in the KnownCRL arrays.
known_crl_bytes	Returns raw CRL data in DER format.
known_crl_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
known_ocsp_count	The number of records in the KnownOCSP arrays.
known_ocsp_bytes	Buffer containing raw OCSP response data.
known_ocsp_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
mailbox_info_count	The number of records in the MailboxInfo arrays.
mailbox_info_delimiter	Mailbox hierarchy delimiter.
mailbox_info_has_children	Specifies whether the mailbox has \\HasChildren attribute specified.
mailbox_info_has_no_children	Specifies whether the mailbox has \\HasNoChildren attribute specified.
mailbox_info_marked	Specifies whether the mailbox has \\Marked attribute specified.
mailbox_info_name	Specifies mailbox name.
mailbox_info_no_inferiors	Specifies whether the mailbox has \\NoInferiors attribute specified.
mailbox_info_no_select	Specifies whether the mailbox has \\NoSelect attribute specified.
mailbox_info_unmarked	Specifies whether the mailbox has \\Unmarked attribute specified.
msg_attachment_count	Returns the number of attachments in this message.
msg_bcc	The contents of the BCC header property.
msg_cc	The value of the CC header property.
msg_comments	Contains additional information about the message body.
msg_date	The date and time when the message entered the mail delivery system.
msg_delivery_receipt	Enables delivery notification.
msg_from	Contains the value of the From header property.
msg_html_text	The HTML version of the message.
msg_id	The contents of the Message-ID header property.
msg_in_reply_to	The value of the In-Reply-To header property.
msg_keywords	The value of the Keywords header property.
msg_mailer	The name of the software that was used to send the message.
msg_plain_text	The plain text version of the message.
msg_priority	Specifies the message priority.
msg_read_receipt	Enables a read notification.
msg_references	The value of the References header property.
msg_reply_to	The value of the Reply-To header property.
msg_return_path	The value of the Return-Path header property.
msg_sender	The value of the Sender header property.
msg_send_to	The value of the To header property.
msg_subject	Contains the subject property of this message.
msg_info_count	The number of records in the MsgInfo arrays.
msg_info_date	Contains the value of the Date header property.
msg_info_flags	Returns the flags currently set to the mail message.
msg_info_from	Contains the value of the From header property.
msg_info_internal_date	Returns the internal date of the mail message.
msg_info_sent_to	Contains the value of the To header property.
msg_info_size	Returns the size of the message in bytes.
msg_info_subject	Contains the value of the Subject header property.
msg_info_uid	Returns the unique ID of the mail message.
password	The authentication password.
proxy_address	The IP address of the proxy server.
proxy_authentication	The authentication type used by the proxy server.
proxy_password	The password to authenticate to the proxy server.
proxy_port	The port on the proxy server to connect to.
proxy_proxy_type	The type of the proxy server.
proxy_request_headers	Contains HTTP request headers for WebTunnel and HTTP proxy.
proxy_response_body	Contains the HTTP or HTTPS (WebTunnel) proxy response body.
proxy_response_headers	Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.
proxy_use_i_pv6	Specifies whether IPv6 should be used when connecting through the proxy.
proxy_use_proxy	Enables or disables proxy-driven connection.
proxy_username	Specifies the username credential for proxy authentication.
server_cert_count	The number of records in the ServerCert arrays.
server_cert_bytes	Returns raw certificate data in DER format.
server_cert_ca_key_id	A unique identifier (fingerprint) of the CA certificate's private key.
server_cert_fingerprint	Contains the fingerprint (a hash imprint) of this certificate.
server_cert_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
server_cert_issuer	The common name of the certificate issuer (CA), typically a company name.
server_cert_issuer_rdn	A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
server_cert_key_algorithm	Specifies the public key algorithm of this certificate.
server_cert_key_bits	Returns the length of the public key.
server_cert_key_fingerprint	Returns a fingerprint of the public key contained in the certificate.
server_cert_key_usage	Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
server_cert_public_key_bytes	Contains the certificate's public key in DER format.
server_cert_self_signed	Indicates whether the certificate is self-signed (root) or signed by an external CA.
server_cert_serial_number	Returns the certificate's serial number.
server_cert_sig_algorithm	Indicates the algorithm that was used by the CA to sign this certificate.
server_cert_subject	The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
server_cert_subject_key_id	Contains a unique identifier (fingerprint) of the certificate's private key.
server_cert_subject_rdn	A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
server_cert_valid_from	The time point at which the certificate becomes valid, in UTC.
server_cert_valid_to	The time point at which the certificate expires, in UTC.
server_info_capabilities	Returns the list of server capabilities.
server_info_idle_supported	Indicates whether the IMAP server supports the IDLE command.
server_info_login_disabled	Specifies whether the server forbids login.
socket_dns_mode	Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system.
socket_dns_port	Specifies the port number to be used for sending queries to the DNS server.
socket_dns_query_timeout	The timeout (in milliseconds) for each DNS query.
socket_dns_servers	The addresses of DNS servers to use for address resolution, separated by commas or semicolons.
socket_dns_total_timeout	The timeout (in milliseconds) for the whole resolution process.
socket_incoming_speed_limit	The maximum number of bytes to read from the socket, per second.
socket_local_address	The local network interface to bind the socket to.
socket_local_port	The local port number to bind the socket to.
socket_outgoing_speed_limit	The maximum number of bytes to write to the socket, per second.
socket_timeout	The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
socket_use_i_pv6	Enables or disables IP protocol version 6.
tls_auto_validate_certificates	Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
tls_base_configuration	Selects the base configuration for the TLS settings.
tls_ciphersuites	A list of ciphersuites separated with commas or semicolons.
tlsec_curves	Defines the elliptic curves to enable.
tls_force_resume_if_destination_changes	Whether to force TLS session resumption when the destination address changes.
tls_pre_shared_identity	Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
tls_pre_shared_key	Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
tls_pre_shared_key_ciphersuite	Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
tls_renegotiation_attack_prevention_mode	Selects renegotiation attack prevention mechanism.
tls_revocation_check	Specifies the kind(s) of revocation check to perform.
tlsssl_options	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.
tlstls_mode	Specifies the TLS mode to use.
tls_use_extended_master_secret	Enables Extended Master Secret Extension, as defined in RFC 7627.
tls_use_session_resumption	Enables or disables TLS session resumption capability.
tls_versions	Th SSL/TLS versions to enable by default.
trusted_cert_count	The number of records in the TrustedCert arrays.
trusted_cert_bytes	Returns raw certificate data in DER format.
trusted_cert_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
username	The authentication username.

Method List

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


close_mailbox	Closes the current mailbox.
config	Sets or retrieves a configuration setting.
connect	Establishes a connection to the IMAP server.
copy_message	Copies a message to another mailbox.
create_mailbox	Creates a new mailbox.
delete_mailbox	Deletes an existing mailbox.
disconnect	Closes connection to the IMAP server.
examine_mailbox	Selects the mailbox in read-only mode.
get_mailbox_status	Requests a mailbox status.
list_all_messages	Queries a list of messages available in CurrentMailbox on the server.
list_deleted_messages	Queries a list of deleted messages in the current mailbox on the server.
list_mailboxes	Queries a list of mailboxes available on the server.
list_new_messages	Queries a list of new messages available in the current mailbox on the mail server.
list_recent_messages	Queries a list of recent messages available in the current mailbox on the server.
list_unseen_messages	Queries a list of unseen messages available in the current mailbox on the server.
mark_message_deleted	Sets a Deleted flag to the message.
mark_message_seen	Sets a Seen flag to the message.
ping	Sends a NOOP command to the IMAP server.
post_bytes	Uploads an e-mail message stored in a byte array.
post_file	Uploads a message stored in a file to the current mailbox on the IMAP server.
post_message	Uploads a pre-built message to the current mailbox on the IMAP server.
purge_messages	Permanently removes all deleted messages from the current mailbox.
receive_bytes	Downloads a message to a byte array.
receive_file	Downloads a message to a file.
receive_message	Downloads a message.
refresh_mailbox	Refreshes the state info of the current mailbox.
rename_mailbox	Renames an existing mailbox.
select_mailbox	Selects the specified mailbox.
update_message	Alters flags assotiated with a message in the current mailbox on the IMAP server.

Event List

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


on_before_auth	Fires before the authentication starts.
on_certificate_validate	Fires when the server's TLS certificate has to be validated.
on_command	Reports a command sent to the server.
on_command_data	Returns the data that accompanies the command.
on_command_reply	Reports the receipt of a reply to a command.
on_command_reply_data	Returns the data that accompanies a reply to a command.
on_error	Provides information about errors during SMTP operations.
on_mailbox_status	Reports the mailbox status returned from the server.
on_notification	This event notifies the application about an underlying control flow event.
on_progress	Reports the progress of the data transfer operation.

Configuration Settings

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


Authentications	Specifies enabled authentication methods and their priorities.
IdleAuto	Specifies whether idle mode should be requested automatically.
IdleTimeout	Specifies idle timeout in seconds.
IgnoreSystemTrust	Whether trusted Windows Certificate Stores should be treated as trusted.
ListCriteria	Specifies an advanced criteria for listing messages on the server.
MaxLineLength	Specifies maximum expected line length.
MessageHeaderZZZ[i]	A value of ZZZ header field for message i.
OtherHeaders	Specifies header fields to request when lists messages on the server.
TempPath	Path for storing temporary files.
TolerateMinorChainIssues	Whether to tolerate minor chain issues.
UseMicrosoftCTL	Enables or disables automatic use of Microsoft online certificate trust list.
UseSystemCertificates	Enables or disables the use of the system certificates.
CheckKeyIntegrityBeforeUse	Enables or disable private key integrity check before use.
CookieCaching	Specifies whether a cookie cache should be used for HTTP(S) transports.
Cookies	Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).
DefDeriveKeyIterations	Specifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHE	Enables or disables finite field DHE key exchange support in TLS clients.
GlobalCookies	Gets or sets global cookies for all the HTTP transports.
HttpUserAgent	Specifies the user agent name to be used by all HTTP clients.
LogDestination	Specifies the debug log destination.
LogDetails	Specifies the debug log details to dump.
LogFile	Specifies the debug log filename.
LogFilters	Specifies the debug log filters.
LogFlushMode	Specifies the log flush mode.
LogLevel	Specifies the debug log level.
LogMaxEventCount	Specifies the maximum number of events to cache before further action is taken.
LogRotationMode	Specifies the log rotation mode.
MaxASN1BufferLength	Specifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepth	Specifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithm	Specifies the hash algorithm to be used to identify certificates in OCSP requests.
UseOwnDNSResolver	Specifies whether the client classes should use own DNS resolver.
UseSharedSystemStorages	Specifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSS	Enforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandom	Enables or disables the use of the OS PRNG.