IMAP Class

Properties   Methods   Events   Config Settings   Errors  

The IMAP Class is used to communicate with IMAP servers using the Internet Message Access Protocol (IMAP).

Syntax

class ipworks.IMAP

Remarks

The IMAP Class supports both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections (RFC 2595). When connecting over Secure Sockets Layer/Transport Layer Security (SSL/TLS) the on_ssl_server_authentication event allows you to check the server identity and other security attributes. The on_ssl_status event provides information about the SSL handshake. Additional SSL-related settings are also supported through the config method.

The IMAP Class implements a standard IMAP client as specified in RFC 1730 and RFC 2060.

The first step in using the class is specifying a mail_server, a user to connect as, and a password to authenticate with. After that, one or more requests may be sent to the server via the class's methods. Results are retrieved through events and a number of key properties.

Normally, after connecting to the server, a mailbox is selected (or examined) using the examine_mailbox method. After the mailbox is selected, message_count and recent_message_count show the number of messages in the mailbox, and mailbox_flags show the flags pertaining to the mailbox.

A number of operations may be performed by the server in response to commands sent using the class's methods. The primary arguments for most commands are the mailbox property and the message_set property. The message_set property denotes either a single message, or a range of messages. Other arguments are specified through other properties, such as sort_criteria and message_flags.

Responses are received through events, such as on_message_info and on_mailbox_list, and also are reflected to properties, such as message_text and message_subject.

The on_message_part event describes the MIME structure of the retrieved messages. One on_message_part event is fired for every message part, giving information about the particular part. Later on, message parts may be retrieved separately through the retrieve_message_part method. This speeds up processing by avoiding the need to retrieve full messages from the server.

The on_pi_trail event traces the interaction between the client and the server. It includes all exchanges except for transfers of messages, message parts, and message headers.

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.

auth_mechanism Property

This property includes the authentication mechanism to be used when connecting to the mail server.

Syntax

def get_auth_mechanism() -> int: ...
def set_auth_mechanism(value: int) -> None: ...

auth_mechanism = property(get_auth_mechanism, set_auth_mechanism)

Default Value

0

Remarks

auto_decode_parts Property

This property determines whether or not to automatically decode message parts.

Syntax

def get_auto_decode_parts() -> bool: ...
def set_auto_decode_parts(value: bool) -> None: ...

auto_decode_parts = property(get_auto_decode_parts, set_auto_decode_parts)

Default Value

FALSE

Remarks

This property determines whether or not to automatically decode message parts. Message parts, especially binary message parts, are normally sent by the server encoded (Base64 or other format). If this setting is True, the parts are automatically decoded while being received.

connected Property

Whether the class is connected.

Syntax

def get_connected() -> bool: ...

connected = property(get_connected, None)

Default Value

FALSE

Remarks

This property is used to determine whether or not the class is connected to the remote host. Use the connect and disconnect methods to manage the connection.

This property is read-only.

end_byte Property

This property includes the byte index of the position where the transfer should end.

Syntax

def get_end_byte() -> int: ...
def set_end_byte(value: int) -> None: ...

end_byte = property(get_end_byte, set_end_byte)

Default Value

0

Remarks

start_byte and end_byte are used together with the retrieve_message_part method to specify the portion of the message to be retrieved from the server.

When start_byte or end_byte contain values other than the default (0), only the corresponding portion of the message is retrieved from the server.

Byte indexes start from 1. The default value for end_byte is 0, which corresponds to the end of the message.

firewall_auto_detect Property

Whether to automatically detect and use firewall system settings, if available.

Syntax

def get_firewall_auto_detect() -> bool: ...
def set_firewall_auto_detect(value: bool) -> None: ...

firewall_auto_detect = property(get_firewall_auto_detect, set_firewall_auto_detect)

Default Value

FALSE

Remarks

Whether to automatically detect and use firewall system settings, if available.

firewall_type Property

The type of firewall to connect through.

Syntax

def get_firewall_type() -> int: ...
def set_firewall_type(value: int) -> None: ...

firewall_type = property(get_firewall_type, set_firewall_type)

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

firewall_host Property

The name or IP address of the firewall (optional).

Syntax

def get_firewall_host() -> str: ...
def set_firewall_host(value: str) -> None: ...

firewall_host = property(get_firewall_host, set_firewall_host)

Default Value

""

Remarks

The name or IP address of the firewall (optional). If a firewall_host is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

firewall_password Property

A password if authentication is to be used when connecting through the firewall.

Syntax

def get_firewall_password() -> str: ...
def set_firewall_password(value: str) -> None: ...

firewall_password = property(get_firewall_password, set_firewall_password)

Default Value

""

Remarks

A password if authentication is to be used when connecting through the firewall. If firewall_host is specified, the firewall_user and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

firewall_port Property

The Transmission Control Protocol (TCP) port for the firewall Host .

Syntax

def get_firewall_port() -> int: ...
def set_firewall_port(value: int) -> None: ...

firewall_port = property(get_firewall_port, set_firewall_port)

Default Value

0

Remarks

The Transmission Control Protocol (TCP) port for the firewall firewall_host. See the description of the firewall_host property for details.

Note: This property is set automatically when firewall_type is set to a valid value. See the description of the firewall_type property for details.

firewall_user Property

A username if authentication is to be used when connecting through a firewall.

Syntax

def get_firewall_user() -> str: ...
def set_firewall_user(value: str) -> None: ...

firewall_user = property(get_firewall_user, set_firewall_user)

Default Value

""

Remarks

A username if authentication is to be used when connecting through a firewall. If firewall_host is specified, this property and the firewall_password property are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

idle Property

The current status of the class.

Syntax

def get_idle() -> bool: ...

idle = property(get_idle, None)

Default Value

TRUE

Remarks

This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.

This property is read-only.

last_reply Property

This property indicates the last reply received from the server.

Syntax

def get_last_reply() -> str: ...

last_reply = property(get_last_reply, None)

Default Value

""

Remarks

This property indicates the last reply received from the server. It can be used for informational purposes. The same information and more also can be retrieved through the on_pi_trail event.

This property is read-only.

local_file Property

This property includes the path to a local file for downloading the message body.

Syntax

def get_local_file() -> str: ...
def set_local_file(value: str) -> None: ...

local_file = property(get_local_file, set_local_file)

Default Value

""

Remarks

This property is used when retrieving a message. If the file exists, and the overwrite property is set to true, then the component will overwrite the file.

If this property is empty, then the received data is provided through the message_text property and the parameters for the on_transfer event.

local_host Property

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

def get_local_host() -> str: ...
def set_local_host(value: str) -> None: ...

local_host = property(get_local_host, set_local_host)

Default Value

""

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the class is connected, the local_host property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

Note: local_host is not persistent. You must always set it in code, and never in the property window.

mailbox Property

This property includes the name of the mailbox selected on the server.

Syntax

def get_mailbox() -> str: ...
def set_mailbox(value: str) -> None: ...

mailbox = property(get_mailbox, set_mailbox)

Default Value

"Inbox"

Remarks

This method contains the name of the mailbox selected on the server and also is used as argument to most methods. Please refer to the class methods for more information.

Example 1. Open a Mailbox in Read/Write Mode:

IMAPControl.Mailbox = "INBOX" IMAPControl.SelectMailbox

Example 2. Open a Mailbox in Read-Only Mode:

IMAPControl.Mailbox = "INBOX.Folder" IMAPControl.ExamineMailbox

mailbox_flags Property

This property defines flags in the selected mailbox.

Syntax

def get_mailbox_flags() -> str: ...

mailbox_flags = property(get_mailbox_flags, None)

Default Value

""

Remarks

This property defines flags in the selected mailbox. The class fills out message_count, recent_message_count, and mailbox_flags after connecting to the mail_server and selecting or examining a mailbox.

This property is read-only.

mailbox_list_count Property

The number of records in the MailboxList arrays.

Syntax

def get_mailbox_list_count() -> int: ...

mailbox_list_count = property(get_mailbox_list_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• mailbox_list_flags
• mailbox_list_name
• mailbox_list_separator

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

This property is read-only.

mailbox_list_flags Property

This property contains the mailbox flags in a mailbox listing.

Syntax

def get_mailbox_list_flags(mailbox_list_index: int) -> str: ...

Default Value

""

Remarks

This property contains the mailbox flags in a mailbox listing.

Examples of possible flag values are server dependent, but they can include the following:

The mailbox_list_index parameter specifies the index of the item in the array. The size of the array is controlled by the mailbox_list_count property.

This property is read-only.

mailbox_list_name Property

This property contains the mailbox name in a mailbox listing.

Syntax

def get_mailbox_list_name(mailbox_list_index: int) -> str: ...

Default Value

""

Remarks

This property contains the mailbox name in a mailbox listing.

The mailbox_list_index parameter specifies the index of the item in the array. The size of the array is controlled by the mailbox_list_count property.

This property is read-only.

mailbox_list_separator Property

The Separator property contains the character that separates the different parts in the mailbox path hierarchy.

Syntax

def get_mailbox_list_separator(mailbox_list_index: int) -> str: ...

Default Value

""

Remarks

The mailbox_list_separator property contains the character that separates the different parts in the mailbox path hierarchy.

The mailbox_list_index parameter specifies the index of the item in the array. The size of the array is controlled by the mailbox_list_count property.

This property is read-only.

mail_port Property

This property includes the port of the IMAP server (default is 143).

Syntax

def get_mail_port() -> int: ...
def set_mail_port(value: int) -> None: ...

mail_port = property(get_mail_port, set_mail_port)

Default Value

143

Remarks

A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.

For the implicit Secure Sockets Layer (SSL), use port 993 (please refer to the ssl_start_mode property for more information).

mail_server Property

This property includes the name or address of the mail server (IMAP server).

Syntax

def get_mail_server() -> str: ...
def set_mail_server(value: str) -> None: ...

mail_server = property(get_mail_server, set_mail_server)

Default Value

""

Remarks

This property specifies the IP address (IP number in dotted internet format) or domain name of the mail server. It must be set before a connection is attempted and cannot be changed once a connection is in progress.

If this property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the mail_server property is set to the corresponding address. If the search is not successful, an error is returned.

If the class is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.

message Property

This property provides the raw message content.

Syntax

def get_message() -> bytes: ...
def set_message(value: bytes) -> None: ...

message = property(get_message, set_message)

Default Value

""

Remarks

This property is populated after calling retrieve_message_part and holds the raw message content. This can be used to access the data before any processing is done by the class.

message_content_encoding Property

This property includes the ContentEncoding of the selected message.

Syntax

def get_message_content_encoding() -> str: ...

message_content_encoding = property(get_message_content_encoding, None)

Default Value

""

Remarks

The property is automatically set by the class when message information is retrieved through the retrieve_message_info method.

This property is read-only.

message_content_type Property

This property includes the ContentType of the message.

Syntax

def get_message_content_type() -> str: ...

message_content_type = property(get_message_content_type, None)

Default Value

""

Remarks

This property denotes the type of content contained in the message, such as plain, multipart, or multipart/alternative. You also may need to check the message_content_encoding property or read the individual message parts.

This property is read-only.

message_count Property

This property includes the total number of messages on the Mailbox .

Syntax

def get_message_count() -> int: ...

message_count = property(get_message_count, None)

Default Value

0

Remarks

This property contains the total number of messages on the mailbox. The class fills out message_count, recent_message_count, and mailbox_flags after connecting to the mail_server and selecting or examining a mailbox.

This property is read-only.

message_date Property

The property includes the time the message was created.

Syntax

def get_message_date() -> str: ...

message_date = property(get_message_date, None)

Default Value

""

Remarks

This property contains the date and time when the message was created. This value is taken from the ENVELOPE structure of the message corresponding to the date.

RFC 822 contains detailed date format specifications. An example of a valid date is "Fri, 1 Mar 96 21:24:52 EST".

This property is read-only.

message_delivery_time Property

This property includes the time the message was delivered to the mail server.

Syntax

def get_message_delivery_time() -> str: ...

message_delivery_time = property(get_message_delivery_time, None)

Default Value

""

Remarks

This property contains the time the message was delivered to the mail server. This value is taken from the INTERNALDATE property of the message. The time format is defined in RFC 821.

This property is read-only.

message_flags Property

This property contains the flags of the current message.

Syntax

def get_message_flags() -> str: ...
def set_message_flags(value: str) -> None: ...

message_flags = property(get_message_flags, set_message_flags)

Default Value

""

Remarks

This property contains the flags of the current message. It also is used to specify flags when append_to_mailbox is called.

Examples of possible flag values are server dependent, but they can include the following:

IMAPControl.MessageSet = "1" IMAPControl.AddMessageFlags("\Deleted")

message_from Property

This property includes the address of the author of the message.

Syntax

def get_message_from() -> str: ...

message_from = property(get_message_from, None)

Default Value

""

Remarks

This property normally has the same value as message_sender.

In some cases, a message may have more than one From address. If this is the case, the addresses are provided in the message_from property and are separated by commas.

This property is read-only.

message_header_count Property

The number of records in the MessageHeader arrays.

Syntax

def get_message_header_count() -> int: ...
def set_message_header_count(value: int) -> None: ...

message_header_count = property(get_message_header_count, set_message_header_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• message_header_field
• message_header_value

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

message_header_field Property

This property contains the name of the HTTP header (this is the same case as it is delivered).

Syntax

def get_message_header_field(message_header_index: int) -> str: ...
def set_message_header_field(message_header_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the name of the HTTP Header (this is the same case as it is delivered).

The message_header_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_header_count property.

message_header_value Property

This property contains the header contents.

Syntax

def get_message_header_value(message_header_index: int) -> str: ...
def set_message_header_value(message_header_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the Header contents.

The message_header_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_header_count property.

message_headers_string Property

This property includes the string version of the RFC 822-encoded headers in the message.

Syntax

def get_message_headers_string() -> str: ...
def set_message_headers_string(value: str) -> None: ...

message_headers_string = property(get_message_headers_string, set_message_headers_string)

Default Value

""

Remarks

This property contains the full headers of the message in RFC 822 format. The headers are retrieved by calling the retrieve_message_headers or the retrieve_message_part_headers method.

message_id Property

This property includes the message identifier of the current message.

Syntax

def get_message_id() -> str: ...

message_id = property(get_message_id, None)

Default Value

""

Remarks

The class fills out this property when message information is retrieved from the mail_server.

This Id is permanent if uid_mode is set, and otherwise is temporary.

This property is read-only.

message_info_count Property

The number of records in the MessageInfo arrays.

Syntax

def get_message_info_count() -> int: ...

message_info_count = property(get_message_info_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• message_info_date
• message_info_flags
• message_info_from
• message_info_message_id
• message_info_size
• message_info_subject

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

This property is read-only.

message_info_date Property

This property contains the date of a message in a message information listing.

Syntax

def get_message_info_date(message_info_index: int) -> str: ...

Default Value

""

Remarks

This property contains the date of a message in a message information listing. This date is taken from the ENVELOPE structure of the message.

The message_info_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_info_count property.

This property is read-only.

message_info_flags Property

This property contains a message flag in a message information listing.

Syntax

def get_message_info_flags(message_info_index: int) -> str: ...

Default Value

""

Remarks

This property contains a message flag in a message information listing.

Examples of possible flag values are server dependent, but they can include the following:

The message_info_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_info_count property.

This property is read-only.

message_info_from Property

This property contains the sender of a message in a message information listing.

Syntax

def get_message_info_from(message_info_index: int) -> str: ...

Default Value

""

Remarks

This property contains the sender of a message in a message information listing.

The message_info_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_info_count property.

This property is read-only.

message_info_message_id Property

The unique identifier of a message in a message information listing.

Syntax

def get_message_info_message_id(message_info_index: int) -> str: ...

Default Value

""

Remarks

The unique identifier of a message in a message information listing.

The message_info_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_info_count property.

This property is read-only.

message_info_size Property

This property contains the size of a message in a message information listing.

Syntax

def get_message_info_size(message_info_index: int) -> int: ...

Default Value

0

Remarks

This property contains the size of a message in a message information listing.

The message_info_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_info_count property.

This property is read-only.

message_info_subject Property

This property contains the subject of a message in a message information listing.

Syntax

def get_message_info_subject(message_info_index: int) -> str: ...

Default Value

""

Remarks

This property contains the subject of a message in a message information listing.

The message_info_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_info_count property.

This property is read-only.

message_in_reply_to Property

This property includes the unique message identifier of the message being replied to.

Syntax

def get_message_in_reply_to() -> str: ...

message_in_reply_to = property(get_message_in_reply_to, None)

Default Value

""

Remarks

The class fills out this property with the value of the In-Reply-To: message header.

This value can be useful when threading messages by referring to the message being replied to.

The unique message identifier of the message itself is given by the message_net_id property.

This property is read-only.

message_net_id Property

This property includes the globally unique identifier of the message.

Syntax

def get_message_net_id() -> str: ...

message_net_id = property(get_message_net_id, None)

Default Value

""

Remarks

This property contains the globally unique identifier of the message. The class fills the message_net_id with the value of the Message-Id: header. This is a globally unique value normally created by the first mail server the message is sent to.

This property is read-only.

message_part_count Property

The number of records in the MessagePart arrays.

Syntax

def get_message_part_count() -> int: ...

message_part_count = property(get_message_part_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• message_part_content_disposition
• message_part_content_encoding
• message_part_content_id
• message_part_content_type
• message_part_file_name
• message_part_id
• message_part_multipart_mode
• message_part_parameters
• message_part_size

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

This property is read-only.

message_part_content_disposition Property

This property shows the value of the Content-Disposition header of the message part.

Syntax

def get_message_part_content_disposition(message_part_index: int) -> str: ...

Default Value

""

Remarks

This property shows the value of the Content-Disposition header of the message part.

The message_part_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_part_count property.

This property is read-only.

message_part_content_encoding Property

This property shows how the data are encoded.

Syntax

def get_message_part_content_encoding(message_part_index: int) -> str: ...

Default Value

""

Remarks

This property shows how the data are encoded.

The message_part_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_part_count property.

This property is read-only.

message_part_content_id Property

This property shows the value of the Content-Id header of the message part.

Syntax

def get_message_part_content_id(message_part_index: int) -> str: ...

Default Value

""

Remarks

This property shows the value of the Content-Id header of the message part.

The message_part_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_part_count property.

This property is read-only.

message_part_content_type Property

This property shows the type of data contained in the message part.

Syntax

def get_message_part_content_type(message_part_index: int) -> str: ...

Default Value

""

Remarks

This property shows the type of data contained in the message part.

The message_part_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_part_count property.

This property is read-only.

message_part_file_name Property

This property shows the filename corresponding to the part (if the part was included in the message as an attached file).

Syntax

def get_message_part_file_name(message_part_index: int) -> str: ...

Default Value

""

Remarks

This property shows the filename corresponding to the part (if the part was included in the message as an attached file).

The message_part_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_part_count property.

This property is read-only.

message_part_id Property

This property contains the identifier of a part listing that may be identified in other parts or messages.

Syntax

def get_message_part_id(message_part_index: int) -> str: ...

Default Value

""

Remarks

This property contains the identifier of a part listing that may be identified in other parts or messages. The format of part identifiers is specified by the IMAP RFCs.

The message_part_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_part_count property.

This property is read-only.

message_part_multipart_mode Property

This property shows how this part relates to the message's whole multipart structure (e.

Syntax

def get_message_part_multipart_mode(message_part_index: int) -> str: ...

Default Value

""

Remarks

This property shows how this part relates to the message's whole multipart structure (e.g., 'mixed' or 'alternative').

The message_part_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_part_count property.

This property is read-only.

message_part_parameters Property

This property contains the additional parameters passed to the ContentType header, such as the part charset.

Syntax

def get_message_part_parameters(message_part_index: int) -> str: ...

Default Value

""

Remarks

This property contains the additional parameters passed to the ContentType header, such as the part charset.

The message_part_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_part_count property.

This property is read-only.

message_part_size Property

This property contains the size of a part in a message part listing.

Syntax

def get_message_part_size(message_part_index: int) -> int: ...

Default Value

0

Remarks

This property contains the size of a part in a message part listing.

The message_part_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_part_count property.

This property is read-only.

message_recipient_count Property

The number of records in the MessageRecipient arrays.

Syntax

def get_message_recipient_count() -> int: ...

message_recipient_count = property(get_message_recipient_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• message_recipient_address
• message_recipient_name
• message_recipient_options
• message_recipient_type

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

This property is read-only.

message_recipient_address Property

This property contains the email address of the recipient.

Syntax

def get_message_recipient_address(recipient_index: int) -> str: ...

Default Value

""

Remarks

This property contains the email address of the recipient.

The recipient_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_recipient_count property.

This property is read-only.

message_recipient_name Property

This property contains the name of the recipient.

Syntax

def get_message_recipient_name(recipient_index: int) -> str: ...

Default Value

""

Remarks

This property contains the name of the recipient.

The recipient_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_recipient_count property.

This property is read-only.

message_recipient_options Property

This property contains the recipient sending options (used only by SMTP).

Syntax

def get_message_recipient_options(recipient_index: int) -> str: ...

Default Value

""

Remarks

This property contains the recipient sending options (used only by SMTP). This must be a string of RFC-compliant recipient options (used by SMTP).

One type of option is a delivery status notification sent per recipient, which is specified by RFC 1891.

component.MessageRecipientOptions(0) = "NOTIFY SUCCESS,FAILURE,DELAY";

The recipient_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_recipient_count property.

This property is read-only.

message_recipient_type Property

This property contains the recipient type: To, Cc, or Bcc.

Syntax

def get_message_recipient_type(recipient_index: int) -> int: ...

Default Value

0

Remarks

This property contains the recipient type: To, Cc, or Bcc.

The recipient_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_recipient_count property.

This property is read-only.

message_reply_to Property

This property includes the email addresses to which replies to the message should be sent.

Syntax

def get_message_reply_to() -> str: ...

message_reply_to = property(get_message_reply_to, None)

Default Value

""

Remarks

This property contains the email addresses to which replies to the message should be sent. In some cases, a message may have more than one Reply-To address. If this is the case, the addresses are provided in this property and are separated by commas.

This property is read-only.

message_sender Property

This property includes the address of the sender of the message.

Syntax

def get_message_sender() -> str: ...

message_sender = property(get_message_sender, None)

Default Value

""

Remarks

This property contains the address of the sender of the message. This normally is the same value as message_from.

In some cases, a message may have more than one sender. If this is the case, the addresses are provided in the message_sender property and are separated by commas.

This property is read-only.

message_set Property

This property includes the set of messages to operate on.

Syntax

def get_message_set() -> str: ...
def set_message_set(value: str) -> None: ...

message_set = property(get_message_set, set_message_set)

Default Value

""

Remarks

This property indicates the set of messages to operate on. This is used as an argument to most method calls.

It may consist of a single message number, a range of messages specified by two message numbers separated by ':' (e.g. "1:5"), and/or individual message numbers separated by ',' (e.g. "1:5,7,10").

Example 1. Setting MessageSet:

IMAPControl.MessageSet = "1" IMAPControl.RetrieveMessageInfo() IMAPControl.MessageSet = "1:5" IMAPControl.RetrieveMessageInfo() IMAPControl.MessageSet = "1,5,7" IMAPControl.RetrieveMessageInfo()

message_size Property

This property includes the size of the selected message.

Syntax

def get_message_size() -> int: ...

message_size = property(get_message_size, None)

Default Value

0

Remarks

The class fills out this property with the size of the selected message when message information is retrieved from the mail_server.

This property is read-only.

message_subject Property

This property includes the subject of the message.

Syntax

def get_message_subject() -> str: ...

message_subject = property(get_message_subject, None)

Default Value

""

Remarks

The class fills out this property with the subject of the message when message information is retrieved from the mail_server.

This property is read-only.

message_text Property

This property includes the body of the retrieved message.

Syntax

def get_message_text() -> str: ...
def set_message_text(value: str) -> None: ...

message_text = property(get_message_text, set_message_text)

Default Value

""

Remarks

The class fills out this property with the contents of the message body (in RFC 822 format) when a call to retrieve_message_text completes successfully and the local_file property is not set.

overwrite Property

This property indicates whether or not the class should overwrite files during transfer.

Syntax

def get_overwrite() -> bool: ...
def set_overwrite(value: bool) -> None: ...

overwrite = property(get_overwrite, set_overwrite)

Default Value

FALSE

Remarks

This property is a value indicating whether or not the class should overwrite files when downloading the message text or a message part and local_file is set. If overwrite is False, an error will be thrown whenever local_file exists.

password Property

This property includes the password to be used to authenticate to the MailServer .

Syntax

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

password = property(get_password, set_password)

Default Value

""

Remarks

This property contains the password used to authenticate to the mail_server. Both the user and password properties must be set before connecting to the mail_server.

peek_mode Property

When set to True, the message Seen flag is not changed during reading.

Syntax

def get_peek_mode() -> bool: ...
def set_peek_mode(value: bool) -> None: ...

peek_mode = property(get_peek_mode, set_peek_mode)

Default Value

FALSE

Remarks

This property contains a True or False to determine whether or not this message should be seen. When this property is set to True, a PEEK option is added to all IMAP FETCH commands sent to the server. In this case, an RFC-compliant IMAP server should not set the Seen flag on the message.

recent_message_count Property

This property includes the number of new messages in the Mailbox .

Syntax

def get_recent_message_count() -> int: ...

recent_message_count = property(get_recent_message_count, None)

Default Value

0

Remarks

This property contains the number of new messages that are in the mailbox. The class fills out message_count, recent_message_count, and mailbox_flags after connecting to the mail_server and selecting or examining a mailbox.

This property is read-only.

sort_criteria Property

This property sorts criteria to use for message retrieval operations.

Syntax

def get_sort_criteria() -> str: ...
def set_sort_criteria(value: str) -> None: ...

sort_criteria = property(get_sort_criteria, set_sort_criteria)

Default Value

""

Remarks

This property sorts criteria to use for message retrieval operations. When set, the class will send the SORT command to the server before any retrieval. If the server supports the SORT command, the results from the retrieve operation will be sorted according to sort_criteria. The format of the sort_criteria property consists of a parenthesized list of one or more sort keys.

Example. Setting SortCriteria:

IMAPControl.SortCriteria = "DATE" IMAPControl.SortCriteria = "SUBJECT FROM" IMAPControl.SortCriteria = "REVERSE SUBJECT"

Possible sort keys include the following:

Note: IMAP SORT functionality is relatively new and not all servers may implement it.

ssl_accept_server_cert_effective_date Property

The date on which this certificate becomes valid.

Syntax

def get_ssl_accept_server_cert_effective_date() -> str: ...

ssl_accept_server_cert_effective_date = property(get_ssl_accept_server_cert_effective_date, None)

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

ssl_accept_server_cert_expiration_date Property

The date on which the certificate expires.

Syntax

def get_ssl_accept_server_cert_expiration_date() -> str: ...

ssl_accept_server_cert_expiration_date = property(get_ssl_accept_server_cert_expiration_date, None)

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

ssl_accept_server_cert_extended_key_usage Property

A comma-delimited list of extended key usage identifiers.

Syntax

def get_ssl_accept_server_cert_extended_key_usage() -> str: ...

ssl_accept_server_cert_extended_key_usage = property(get_ssl_accept_server_cert_extended_key_usage, None)

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

ssl_accept_server_cert_fingerprint Property

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

def get_ssl_accept_server_cert_fingerprint() -> str: ...

ssl_accept_server_cert_fingerprint = property(get_ssl_accept_server_cert_fingerprint, None)

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

ssl_accept_server_cert_fingerprint_sha1 Property

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

def get_ssl_accept_server_cert_fingerprint_sha1() -> str: ...

ssl_accept_server_cert_fingerprint_sha1 = property(get_ssl_accept_server_cert_fingerprint_sha1, None)

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

ssl_accept_server_cert_fingerprint_sha256 Property

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

def get_ssl_accept_server_cert_fingerprint_sha256() -> str: ...

ssl_accept_server_cert_fingerprint_sha256 = property(get_ssl_accept_server_cert_fingerprint_sha256, None)

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

ssl_accept_server_cert_issuer Property

The issuer of the certificate.

Syntax

def get_ssl_accept_server_cert_issuer() -> str: ...

ssl_accept_server_cert_issuer = property(get_ssl_accept_server_cert_issuer, None)

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

ssl_accept_server_cert_private_key Property

The private key of the certificate (if available).

Syntax

def get_ssl_accept_server_cert_private_key() -> str: ...

ssl_accept_server_cert_private_key = property(get_ssl_accept_server_cert_private_key, None)

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The ssl_accept_server_cert_private_key may be available but not exportable. In this case, ssl_accept_server_cert_private_key returns an empty string.

This property is read-only.

ssl_accept_server_cert_private_key_available Property

Whether a PrivateKey is available for the selected certificate.

Syntax

def get_ssl_accept_server_cert_private_key_available() -> bool: ...

ssl_accept_server_cert_private_key_available = property(get_ssl_accept_server_cert_private_key_available, None)

Default Value

FALSE

Remarks

Whether a ssl_accept_server_cert_private_key is available for the selected certificate. If ssl_accept_server_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

ssl_accept_server_cert_private_key_container Property

The name of the PrivateKey container for the certificate (if available).

Syntax

def get_ssl_accept_server_cert_private_key_container() -> str: ...

ssl_accept_server_cert_private_key_container = property(get_ssl_accept_server_cert_private_key_container, None)

Default Value

""

Remarks

The name of the ssl_accept_server_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

ssl_accept_server_cert_public_key Property

The public key of the certificate.

Syntax

def get_ssl_accept_server_cert_public_key() -> str: ...

ssl_accept_server_cert_public_key = property(get_ssl_accept_server_cert_public_key, None)

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

ssl_accept_server_cert_public_key_algorithm Property

The textual description of the certificate's public key algorithm.

Syntax

def get_ssl_accept_server_cert_public_key_algorithm() -> str: ...

ssl_accept_server_cert_public_key_algorithm = property(get_ssl_accept_server_cert_public_key_algorithm, None)

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_accept_server_cert_public_key_length Property

The length of the certificate's public key (in bits).

Syntax

def get_ssl_accept_server_cert_public_key_length() -> int: ...

ssl_accept_server_cert_public_key_length = property(get_ssl_accept_server_cert_public_key_length, None)

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

ssl_accept_server_cert_serial_number Property

The serial number of the certificate encoded as a string.

Syntax

def get_ssl_accept_server_cert_serial_number() -> str: ...

ssl_accept_server_cert_serial_number = property(get_ssl_accept_server_cert_serial_number, None)

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

ssl_accept_server_cert_signature_algorithm Property

The text description of the certificate's signature algorithm.

Syntax

def get_ssl_accept_server_cert_signature_algorithm() -> str: ...

ssl_accept_server_cert_signature_algorithm = property(get_ssl_accept_server_cert_signature_algorithm, None)

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_accept_server_cert_store Property

The name of the certificate store for the client certificate.

Syntax

def get_ssl_accept_server_cert_store() -> bytes: ...
def set_ssl_accept_server_cert_store(value: bytes) -> None: ...

ssl_accept_server_cert_store = property(get_ssl_accept_server_cert_store, set_ssl_accept_server_cert_store)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_accept_server_cert_store_type property denotes the type of the certificate store specified by ssl_accept_server_cert_store. If the store is password-protected, specify the password in ssl_accept_server_cert_store_password.

ssl_accept_server_cert_store is used in conjunction with the ssl_accept_server_cert_subject property to specify client certificates. If ssl_accept_server_cert_store has a value, and ssl_accept_server_cert_subject or ssl_accept_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_accept_server_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

ssl_accept_server_cert_store_password Property

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

def get_ssl_accept_server_cert_store_password() -> str: ...
def set_ssl_accept_server_cert_store_password(value: str) -> None: ...

ssl_accept_server_cert_store_password = property(get_ssl_accept_server_cert_store_password, set_ssl_accept_server_cert_store_password)

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

ssl_accept_server_cert_store_type Property

The type of certificate store for this certificate.

Syntax

def get_ssl_accept_server_cert_store_type() -> int: ...
def set_ssl_accept_server_cert_store_type(value: int) -> None: ...

ssl_accept_server_cert_store_type = property(get_ssl_accept_server_cert_store_type, set_ssl_accept_server_cert_store_type)

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

ssl_accept_server_cert_subject_alt_names Property

Comma-separated lists of alternative subject names for the certificate.

Syntax

def get_ssl_accept_server_cert_subject_alt_names() -> str: ...

ssl_accept_server_cert_subject_alt_names = property(get_ssl_accept_server_cert_subject_alt_names, None)

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

ssl_accept_server_cert_thumbprint_md5 Property

The MD5 hash of the certificate.

Syntax

def get_ssl_accept_server_cert_thumbprint_md5() -> str: ...

ssl_accept_server_cert_thumbprint_md5 = property(get_ssl_accept_server_cert_thumbprint_md5, None)

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_accept_server_cert_thumbprint_sha1 Property

The SHA-1 hash of the certificate.

Syntax

def get_ssl_accept_server_cert_thumbprint_sha1() -> str: ...

ssl_accept_server_cert_thumbprint_sha1 = property(get_ssl_accept_server_cert_thumbprint_sha1, None)

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_accept_server_cert_thumbprint_sha256 Property

The SHA-256 hash of the certificate.

Syntax

def get_ssl_accept_server_cert_thumbprint_sha256() -> str: ...

ssl_accept_server_cert_thumbprint_sha256 = property(get_ssl_accept_server_cert_thumbprint_sha256, None)

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_accept_server_cert_usage Property

The text description of UsageFlags .

Syntax

def get_ssl_accept_server_cert_usage() -> str: ...

ssl_accept_server_cert_usage = property(get_ssl_accept_server_cert_usage, None)

Default Value

""

Remarks

The text description of ssl_accept_server_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

ssl_accept_server_cert_usage_flags Property

The flags that show intended use for the certificate.

Syntax

def get_ssl_accept_server_cert_usage_flags() -> int: ...

ssl_accept_server_cert_usage_flags = property(get_ssl_accept_server_cert_usage_flags, None)

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_accept_server_cert_usage_flags is a combination of the following flags:

Please see the ssl_accept_server_cert_usage property for a text representation of ssl_accept_server_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

ssl_accept_server_cert_version Property

The certificate's version number.

Syntax

def get_ssl_accept_server_cert_version() -> str: ...

ssl_accept_server_cert_version = property(get_ssl_accept_server_cert_version, None)

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

ssl_accept_server_cert_subject Property

The subject of the certificate used for client authentication.

Syntax

def get_ssl_accept_server_cert_subject() -> str: ...
def set_ssl_accept_server_cert_subject(value: str) -> None: ...

ssl_accept_server_cert_subject = property(get_ssl_accept_server_cert_subject, set_ssl_accept_server_cert_subject)

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

ssl_accept_server_cert_encoded Property

The certificate (PEM/Base64 encoded).

Syntax

def get_ssl_accept_server_cert_encoded() -> bytes: ...
def set_ssl_accept_server_cert_encoded(value: bytes) -> None: ...

ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded)

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_accept_server_cert_store and ssl_accept_server_cert_subject properties also may be used to specify a certificate.

When ssl_accept_server_cert_encoded is set, a search is initiated in the current ssl_accept_server_cert_store for the private key of the certificate. If the key is found, ssl_accept_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_accept_server_cert_subject is set to an empty string.

ssl_cert_effective_date Property

The date on which this certificate becomes valid.

Syntax

def get_ssl_cert_effective_date() -> str: ...

ssl_cert_effective_date = property(get_ssl_cert_effective_date, None)

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

ssl_cert_expiration_date Property

The date on which the certificate expires.

Syntax

def get_ssl_cert_expiration_date() -> str: ...

ssl_cert_expiration_date = property(get_ssl_cert_expiration_date, None)

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

ssl_cert_extended_key_usage Property

A comma-delimited list of extended key usage identifiers.

Syntax

def get_ssl_cert_extended_key_usage() -> str: ...

ssl_cert_extended_key_usage = property(get_ssl_cert_extended_key_usage, None)

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

ssl_cert_fingerprint Property

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

def get_ssl_cert_fingerprint() -> str: ...

ssl_cert_fingerprint = property(get_ssl_cert_fingerprint, None)

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

ssl_cert_fingerprint_sha1 Property

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

def get_ssl_cert_fingerprint_sha1() -> str: ...

ssl_cert_fingerprint_sha1 = property(get_ssl_cert_fingerprint_sha1, None)

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

ssl_cert_fingerprint_sha256 Property

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

def get_ssl_cert_fingerprint_sha256() -> str: ...

ssl_cert_fingerprint_sha256 = property(get_ssl_cert_fingerprint_sha256, None)

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

ssl_cert_issuer Property

The issuer of the certificate.

Syntax

def get_ssl_cert_issuer() -> str: ...

ssl_cert_issuer = property(get_ssl_cert_issuer, None)

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

ssl_cert_private_key Property

The private key of the certificate (if available).

Syntax

def get_ssl_cert_private_key() -> str: ...

ssl_cert_private_key = property(get_ssl_cert_private_key, None)

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The ssl_cert_private_key may be available but not exportable. In this case, ssl_cert_private_key returns an empty string.

This property is read-only.

ssl_cert_private_key_available Property

Whether a PrivateKey is available for the selected certificate.

Syntax

def get_ssl_cert_private_key_available() -> bool: ...

ssl_cert_private_key_available = property(get_ssl_cert_private_key_available, None)

Default Value

FALSE

Remarks

Whether a ssl_cert_private_key is available for the selected certificate. If ssl_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

ssl_cert_private_key_container Property

The name of the PrivateKey container for the certificate (if available).

Syntax

def get_ssl_cert_private_key_container() -> str: ...

ssl_cert_private_key_container = property(get_ssl_cert_private_key_container, None)

Default Value

""

Remarks

The name of the ssl_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

ssl_cert_public_key Property

The public key of the certificate.

Syntax

def get_ssl_cert_public_key() -> str: ...

ssl_cert_public_key = property(get_ssl_cert_public_key, None)

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

ssl_cert_public_key_algorithm Property

The textual description of the certificate's public key algorithm.

Syntax

def get_ssl_cert_public_key_algorithm() -> str: ...

ssl_cert_public_key_algorithm = property(get_ssl_cert_public_key_algorithm, None)

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_cert_public_key_length Property

The length of the certificate's public key (in bits).

Syntax

def get_ssl_cert_public_key_length() -> int: ...

ssl_cert_public_key_length = property(get_ssl_cert_public_key_length, None)

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

ssl_cert_serial_number Property

The serial number of the certificate encoded as a string.

Syntax

def get_ssl_cert_serial_number() -> str: ...

ssl_cert_serial_number = property(get_ssl_cert_serial_number, None)

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

ssl_cert_signature_algorithm Property

The text description of the certificate's signature algorithm.

Syntax

def get_ssl_cert_signature_algorithm() -> str: ...

ssl_cert_signature_algorithm = property(get_ssl_cert_signature_algorithm, None)

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_cert_store Property

The name of the certificate store for the client certificate.

Syntax

def get_ssl_cert_store() -> bytes: ...
def set_ssl_cert_store(value: bytes) -> None: ...

ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password-protected, specify the password in ssl_cert_store_password.

ssl_cert_store is used in conjunction with the ssl_cert_subject property to specify client certificates. If ssl_cert_store has a value, and ssl_cert_subject or ssl_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

ssl_cert_store_password Property

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

def get_ssl_cert_store_password() -> str: ...
def set_ssl_cert_store_password(value: str) -> None: ...

ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

ssl_cert_store_type Property

The type of certificate store for this certificate.

Syntax

def get_ssl_cert_store_type() -> int: ...
def set_ssl_cert_store_type(value: int) -> None: ...

ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

ssl_cert_subject_alt_names Property

Comma-separated lists of alternative subject names for the certificate.

Syntax

def get_ssl_cert_subject_alt_names() -> str: ...

ssl_cert_subject_alt_names = property(get_ssl_cert_subject_alt_names, None)

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

ssl_cert_thumbprint_md5 Property

The MD5 hash of the certificate.

Syntax

def get_ssl_cert_thumbprint_md5() -> str: ...

ssl_cert_thumbprint_md5 = property(get_ssl_cert_thumbprint_md5, None)

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_cert_thumbprint_sha1 Property

The SHA-1 hash of the certificate.

Syntax

def get_ssl_cert_thumbprint_sha1() -> str: ...

ssl_cert_thumbprint_sha1 = property(get_ssl_cert_thumbprint_sha1, None)

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_cert_thumbprint_sha256 Property

The SHA-256 hash of the certificate.

Syntax

def get_ssl_cert_thumbprint_sha256() -> str: ...

ssl_cert_thumbprint_sha256 = property(get_ssl_cert_thumbprint_sha256, None)

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_cert_usage Property

The text description of UsageFlags .

Syntax

def get_ssl_cert_usage() -> str: ...

ssl_cert_usage = property(get_ssl_cert_usage, None)

Default Value

""

Remarks

The text description of ssl_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

ssl_cert_usage_flags Property

The flags that show intended use for the certificate.

Syntax

def get_ssl_cert_usage_flags() -> int: ...

ssl_cert_usage_flags = property(get_ssl_cert_usage_flags, None)

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_cert_usage_flags is a combination of the following flags:

Please see the ssl_cert_usage property for a text representation of ssl_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

ssl_cert_version Property

The certificate's version number.

Syntax

def get_ssl_cert_version() -> str: ...

ssl_cert_version = property(get_ssl_cert_version, None)

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

ssl_cert_subject Property

The subject of the certificate used for client authentication.

Syntax

def get_ssl_cert_subject() -> str: ...
def set_ssl_cert_subject(value: str) -> None: ...

ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

ssl_cert_encoded Property

The certificate (PEM/Base64 encoded).

Syntax

def get_ssl_cert_encoded() -> bytes: ...
def set_ssl_cert_encoded(value: bytes) -> None: ...

ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_cert_store and ssl_cert_subject properties also may be used to specify a certificate.

When ssl_cert_encoded is set, a search is initiated in the current ssl_cert_store for the private key of the certificate. If the key is found, ssl_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_cert_subject is set to an empty string.

ssl_enabled Property

This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled.

Syntax

def get_ssl_enabled() -> bool: ...
def set_ssl_enabled(value: bool) -> None: ...

ssl_enabled = property(get_ssl_enabled, set_ssl_enabled)

Default Value

FALSE

Remarks

This property specifies whether TLS/SSL is enabled in the class. When False (default), the class operates in plaintext mode. When True, TLS/SSL is enabled.

TLS/SSL may also be enabled by setting ssl_start_mode. Setting ssl_start_mode will automatically update this property value.

ssl_provider Property

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

def get_ssl_provider() -> int: ...
def set_ssl_provider(value: int) -> None: ...

ssl_provider = property(get_ssl_provider, set_ssl_provider)

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

ssl_server_cert_effective_date Property

The date on which this certificate becomes valid.

Syntax

def get_ssl_server_cert_effective_date() -> str: ...

ssl_server_cert_effective_date = property(get_ssl_server_cert_effective_date, None)

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

ssl_server_cert_expiration_date Property

The date on which the certificate expires.

Syntax

def get_ssl_server_cert_expiration_date() -> str: ...

ssl_server_cert_expiration_date = property(get_ssl_server_cert_expiration_date, None)

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

ssl_server_cert_extended_key_usage Property

A comma-delimited list of extended key usage identifiers.

Syntax

def get_ssl_server_cert_extended_key_usage() -> str: ...

ssl_server_cert_extended_key_usage = property(get_ssl_server_cert_extended_key_usage, None)

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

ssl_server_cert_fingerprint Property

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

def get_ssl_server_cert_fingerprint() -> str: ...

ssl_server_cert_fingerprint = property(get_ssl_server_cert_fingerprint, None)

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

ssl_server_cert_fingerprint_sha1 Property

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

def get_ssl_server_cert_fingerprint_sha1() -> str: ...

ssl_server_cert_fingerprint_sha1 = property(get_ssl_server_cert_fingerprint_sha1, None)

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

ssl_server_cert_fingerprint_sha256 Property

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

def get_ssl_server_cert_fingerprint_sha256() -> str: ...

ssl_server_cert_fingerprint_sha256 = property(get_ssl_server_cert_fingerprint_sha256, None)

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

ssl_server_cert_issuer Property

The issuer of the certificate.

Syntax

def get_ssl_server_cert_issuer() -> str: ...

ssl_server_cert_issuer = property(get_ssl_server_cert_issuer, None)

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

ssl_server_cert_private_key Property

The private key of the certificate (if available).

Syntax

def get_ssl_server_cert_private_key() -> str: ...

ssl_server_cert_private_key = property(get_ssl_server_cert_private_key, None)

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The ssl_server_cert_private_key may be available but not exportable. In this case, ssl_server_cert_private_key returns an empty string.

This property is read-only.

ssl_server_cert_private_key_available Property

Whether a PrivateKey is available for the selected certificate.

Syntax

def get_ssl_server_cert_private_key_available() -> bool: ...

ssl_server_cert_private_key_available = property(get_ssl_server_cert_private_key_available, None)

Default Value

FALSE

Remarks

Whether a ssl_server_cert_private_key is available for the selected certificate. If ssl_server_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

ssl_server_cert_private_key_container Property

The name of the PrivateKey container for the certificate (if available).

Syntax

def get_ssl_server_cert_private_key_container() -> str: ...

ssl_server_cert_private_key_container = property(get_ssl_server_cert_private_key_container, None)

Default Value

""

Remarks

The name of the ssl_server_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

ssl_server_cert_public_key Property

The public key of the certificate.

Syntax

def get_ssl_server_cert_public_key() -> str: ...

ssl_server_cert_public_key = property(get_ssl_server_cert_public_key, None)

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

ssl_server_cert_public_key_algorithm Property

The textual description of the certificate's public key algorithm.

Syntax

def get_ssl_server_cert_public_key_algorithm() -> str: ...

ssl_server_cert_public_key_algorithm = property(get_ssl_server_cert_public_key_algorithm, None)

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_server_cert_public_key_length Property

The length of the certificate's public key (in bits).

Syntax

def get_ssl_server_cert_public_key_length() -> int: ...

ssl_server_cert_public_key_length = property(get_ssl_server_cert_public_key_length, None)

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

ssl_server_cert_serial_number Property

The serial number of the certificate encoded as a string.

Syntax

def get_ssl_server_cert_serial_number() -> str: ...

ssl_server_cert_serial_number = property(get_ssl_server_cert_serial_number, None)

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

ssl_server_cert_signature_algorithm Property

The text description of the certificate's signature algorithm.

Syntax

def get_ssl_server_cert_signature_algorithm() -> str: ...

ssl_server_cert_signature_algorithm = property(get_ssl_server_cert_signature_algorithm, None)

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_server_cert_store Property

The name of the certificate store for the client certificate.

Syntax

def get_ssl_server_cert_store() -> bytes: ...

ssl_server_cert_store = property(get_ssl_server_cert_store, None)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_server_cert_store_type property denotes the type of the certificate store specified by ssl_server_cert_store. If the store is password-protected, specify the password in ssl_server_cert_store_password.

ssl_server_cert_store is used in conjunction with the ssl_server_cert_subject property to specify client certificates. If ssl_server_cert_store has a value, and ssl_server_cert_subject or ssl_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_server_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is read-only.

ssl_server_cert_store_password Property

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

def get_ssl_server_cert_store_password() -> str: ...

ssl_server_cert_store_password = property(get_ssl_server_cert_store_password, None)

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

This property is read-only.

ssl_server_cert_store_type Property

The type of certificate store for this certificate.

Syntax

def get_ssl_server_cert_store_type() -> int: ...

ssl_server_cert_store_type = property(get_ssl_server_cert_store_type, None)

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

This property is read-only.

ssl_server_cert_subject_alt_names Property

Comma-separated lists of alternative subject names for the certificate.

Syntax

def get_ssl_server_cert_subject_alt_names() -> str: ...

ssl_server_cert_subject_alt_names = property(get_ssl_server_cert_subject_alt_names, None)

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

ssl_server_cert_thumbprint_md5 Property

The MD5 hash of the certificate.

Syntax

def get_ssl_server_cert_thumbprint_md5() -> str: ...

ssl_server_cert_thumbprint_md5 = property(get_ssl_server_cert_thumbprint_md5, None)

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_server_cert_thumbprint_sha1 Property

The SHA-1 hash of the certificate.

Syntax

def get_ssl_server_cert_thumbprint_sha1() -> str: ...

ssl_server_cert_thumbprint_sha1 = property(get_ssl_server_cert_thumbprint_sha1, None)

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_server_cert_thumbprint_sha256 Property

The SHA-256 hash of the certificate.

Syntax

def get_ssl_server_cert_thumbprint_sha256() -> str: ...

ssl_server_cert_thumbprint_sha256 = property(get_ssl_server_cert_thumbprint_sha256, None)

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_server_cert_usage Property

The text description of UsageFlags .

Syntax

def get_ssl_server_cert_usage() -> str: ...

ssl_server_cert_usage = property(get_ssl_server_cert_usage, None)

Default Value

""

Remarks

The text description of ssl_server_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

ssl_server_cert_usage_flags Property

The flags that show intended use for the certificate.

Syntax

def get_ssl_server_cert_usage_flags() -> int: ...

ssl_server_cert_usage_flags = property(get_ssl_server_cert_usage_flags, None)

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_server_cert_usage_flags is a combination of the following flags:

Please see the ssl_server_cert_usage property for a text representation of ssl_server_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

ssl_server_cert_version Property

The certificate's version number.

Syntax

def get_ssl_server_cert_version() -> str: ...

ssl_server_cert_version = property(get_ssl_server_cert_version, None)

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

ssl_server_cert_subject Property

The subject of the certificate used for client authentication.

Syntax

def get_ssl_server_cert_subject() -> str: ...

ssl_server_cert_subject = property(get_ssl_server_cert_subject, None)

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

This property is read-only.

ssl_server_cert_encoded Property

The certificate (PEM/Base64 encoded).

Syntax

def get_ssl_server_cert_encoded() -> bytes: ...

ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_server_cert_store and ssl_server_cert_subject properties also may be used to specify a certificate.

When ssl_server_cert_encoded is set, a search is initiated in the current ssl_server_cert_store for the private key of the certificate. If the key is found, ssl_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_server_cert_subject is set to an empty string.

This property is read-only.

ssl_start_mode Property

This property determines how the class starts the Secure Sockets Layer (SSL) negotiation.

Syntax

def get_ssl_start_mode() -> int: ...
def set_ssl_start_mode(value: int) -> None: ...

ssl_start_mode = property(get_ssl_start_mode, set_ssl_start_mode)

Default Value

3

Remarks

The ssl_start_mode property may have one of the following values:

start_byte Property

This property includes the byte index of the position where the transfer should start.

Syntax

def get_start_byte() -> int: ...
def set_start_byte(value: int) -> None: ...

start_byte = property(get_start_byte, set_start_byte)

Default Value

0

Remarks

start_byte and end_byte are used together with the retrieve_message_part method to specify the portion of the message to be retrieved from the server.

When start_byte or end_byte contain values other than the default (0), only the corresponding portion of the message is retrieved from the server.

Byte indexes start from 1. The default value for end_byte is 0, which corresponds to the end of the message.

timeout Property

The timeout for the class.

Syntax

def get_timeout() -> int: ...
def set_timeout(value: int) -> None: ...

timeout = property(get_timeout, set_timeout)

Default Value

60

Remarks

If the timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use do_events to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If timeout expires, and the operation is not yet complete, the class fails with an error.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by timeout seconds when any amount of data is successfully sent or received.

The default value for the timeout property is 60 seconds.

uid_mode Property

If True, this property indicates whether permanent message identifiers are used instead of the default temporary identifiers.

Syntax

def get_uid_mode() -> bool: ...
def set_uid_mode(value: bool) -> None: ...

uid_mode = property(get_uid_mode, set_uid_mode)

Default Value

FALSE

Remarks

This property indicates if a permanent identifier should be used. Normally, the IMAP server uses temporary message identifiers that are valid only during the current session. If uid_mode is True, permanent message identifiers are used instead.

The following IMAP protocol operations use the UID mode: COPY, FETCH, STORE, and SEARCH.

uid_validity Property

This property includes the UIDValidity parameter sent from the server in response to SelectMailbox command.

Syntax

def get_uid_validity() -> str: ...

uid_validity = property(get_uid_validity, None)

Default Value

""

Remarks

Every time a mailbox is selected, a uid_validity is returned from the server. Most of the time, this value will not change from call to call. If it does change, this means that all previously returned UIDs for messages inside this mailbox are now invalid.

This property is read-only.

user Property

This property includes the username used to authenticate to the MailServer .

Syntax

def get_user() -> str: ...
def set_user(value: str) -> None: ...

user = property(get_user, set_user)

Default Value

""

Remarks

This property contains the username used to authenticate to the mail_server. Both the user and password properties must be set before connecting to the mail_server.

add_message_flags Method

This method adds the specified flags to the messages specified by MessageSet .

Syntax

def add_message_flags(flags: str) -> None: ...

Remarks

This method adds the specified flags to the messages specified by the message_set property. The format of the flags is specified by the IMAP RFCs.

Examples of possible flag values are server dependent, but they can include the following:

IMAPControl.MessageSet = "1" IMAPControl.AddMessageFlags("\Deleted")

append_to_mailbox Method

This method appends the message in MessageText to the mailbox specified by Mailbox .

Syntax

def append_to_mailbox() -> None: ...

Remarks

This method appends the RFC 822-encoded message in message_text to the mailbox specified by mailbox. If the message_flags property is not an empty string, its contents are supplied with the APPEND command sent to the server.

Example. Append Message to Mailbox:

IMAPControl.MessageText = MessageHeaders + CRLF + CRLF + MessageBody + CRLF IMAPControl.Mailbox = "INBOX" IMAPControl.MessageFlags = "\Deleted" IMAPControl.AppendToMailbox()

check_mailbox Method

This method sends a CHECK command to the server.

Syntax

def check_mailbox() -> None: ...

Remarks

This method sends a CHECK command to the server, asking it to perform any necessary housekeeping operations on and to update the state of the currently selected mailbox.

close_mailbox Method

This method removes all messages marked with a 'Deleted' flag from the currently selected mailbox and closes the unselected mailbox.

Syntax

def close_mailbox() -> None: ...

Remarks

This method permanently removes all messages that have a 'Deleted' flag that have been set from the current (selected) mailbox. It then closes (deselected) the mailbox.

config Method

Sets or retrieves a configuration setting.

Syntax

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

Remarks

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

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

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

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

connect Method

This method connects to an IMAP server.

Syntax

def connect() -> None: ...

Remarks

This method connects to the IMAP server specified by mail_server and authenticates it using the username and password supplied in the user and password properties.

Example. Connect IMAP Server:

IMAPControl.MailServer = "myserver" IMAPControl.Mailbox = "INBOX" IMAPControl.User = "myusername" IMAPControl.Password = "mypassword" IMAPControl.Connect() IMAPControl.MailServer = "myserver" IMAPControl.Mailbox = "DOMAIN/USERNT/INBOX" IMAPControl.User = "myusername" IMAPControl.Password = "mypassword" IMAPControl.Connect()

copy_to_mailbox Method

Copies the specified messages to another mailbox.

Syntax

def copy_to_mailbox() -> None: ...

Remarks

This method copies the messages specified by the message_set property to the mailbox specified by the mailbox property.

create_mailbox Method

This method creates a new mailbox specified by Mailbox .

Syntax

def create_mailbox() -> None: ...

Remarks

This method creates a new mailbox. The mailbox name is specified by the mailbox property.

delete_from_mailbox Method

The method marks the messages specified by MessageSet as deleted.

Syntax

def delete_from_mailbox() -> None: ...

Remarks

This method marks the messages specified by message_set as deleted. Calling this method is equivalent to calling add_message_flags with "\Deleted" as the Flags parameter.

delete_mailbox Method

This method deletes a mailbox specified by Mailbox .

Syntax

def delete_mailbox() -> None: ...

Remarks

This method deletes a mailbox. The mailbox name is specified by the mailbox property.

delete_mailbox_acl Method

This method deletes mailbox access control rights for a specific user.

Syntax

def delete_mailbox_acl(user: str) -> None: ...

Remarks

This message asks the server to remove all rights associated with User from the mailbox specified in the mailbox property. Refer to set_mailbox_acl and get_mailbox_acl for more information on mailbox access rights.

disconnect Method

This method disconnects from an IMAP server.

Syntax

def disconnect() -> None: ...

Remarks

This method logs out and disconnects from the IMAP server.

do_events Method

This method processes events from the internal message queue.

Syntax

def do_events() -> None: ...

Remarks

When do_events is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

examine_mailbox Method

This method selects a mailbox in read-only mode.

Syntax

def examine_mailbox() -> None: ...

Remarks

This method asks the server to select the mailbox specified in the mailbox property in read-only mode.

Example 1. Open a Mailbox in Read/Write Mode:

IMAPControl.Mailbox = "INBOX" IMAPControl.SelectMailbox

Example 2. Open a Mailbox in Read-Only Mode:

IMAPControl.Mailbox = "INBOX.Folder" IMAPControl.ExamineMailbox

expunge_mailbox Method

This method removes all messages marked with a 'Deleted' flag from the currently selected mailbox.

Syntax

def expunge_mailbox() -> None: ...

Remarks

This method permanently removes all messages that have a 'Deleted' flag from the current (selected) mailbox. Example. Set "Deleted" Flag and Expunge:

IMAPControl.MessageSet = "1" IMAPControl.AddMessageFlags("\Deleted") IMAPControl.ExpungeMailbox()

get_mailbox_acl Method

This method retrieves mailbox access control rights.

Syntax

def get_mailbox_acl() -> None: ...

Remarks

This method retrieves the mailbox access control rights, which are provided through one or more on_mailbox_acl events. Standard rights include the following:

interrupt Method

This method interrupts the current method.

Syntax

def interrupt() -> None: ...

Remarks

If there is no method in progress, interrupt simply returns, doing nothing.

list_mailboxes Method

This method lists all of the mailboxes matching all criteria in the Mailbox property.

Syntax

def list_mailboxes() -> None: ...

Remarks

This method lists all of the mailboxes matching the criteria in the mailbox property. Matching mailboxes are returned through the on_mailbox_list event.

Example 1. List All Mailboxes:

IMAPControl.Mailbox = "*" IMAPControl.ListMailboxes()

Example 2. List All Mailboxes Inside INBOX:

IMAPControl.Mailbox = "INBOX.*" IMAPControl.ListMailboxes()

list_subscribed_mailboxes Method

This method lists all subscribed mailboxes matching all criteria in the Mailbox property.

Syntax

def list_subscribed_mailboxes() -> None: ...

Remarks

This method lists all subscribed mailboxes matching the criteria in the mailbox property. Matching mailboxes are returned through on_mailbox_list event.

Example 1. List All Subscribed Mailboxes:

IMAPControl.Mailbox = "*" IMAPControl.ListSubscribedMailboxes()

Example 2. List All Subscribed Mailboxes Inside INBOX:

IMAPControl.Mailbox = "INBOX.*" IMAPControl.ListSubscribedMailboxes()

localize_date Method

This method converts a valid RFC 822 message date to a local date and time.

Syntax

def localize_date(date_time: str) -> str: ...

Remarks

This method can be used to convert an RFC 822 date and time string to the corresponding local date and time.

Note: Dates will be returned in the format: "MM/dd/yyyy hh:mm:ss".

move_to_mailbox Method

Copies the specified messages to another mailbox and marks the original messages as deleted.

Syntax

def move_to_mailbox() -> None: ...

Remarks

This method copies the messages specified by the message_set property to the mailbox specified by the mailbox property. Additionally, the messages in the original mailbox are marked as deleted.

Calling this method is equivalent to calling the copy_to_mailbox method immediately followed by the delete_from_mailbox method.

noop Method

This method sends a NOOP command to the server.

Syntax

def noop() -> None: ...

Remarks

This method sends an IMAP NOOP command to the server. This is useful when the connection needs to be kept alive for long periods of time. (Normally, servers break the connection automatically after 30 minutes of inactivity.)

rename_mailbox Method

This method changes the name of Mailbox to NewName .

Syntax

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

Remarks

This method allows a mailbox to be renamed. The mailbox is specified by the mailbox property, and the new name is specified by the NewName parameter.

reset Method

This method will reset the class.

Syntax

def reset() -> None: ...

Remarks

This method will reset the class's properties to their default values.

reset_message_flags Method

This method replaces the flags of the messages specified by MessageSet with the flags specified by MessageFlags .

Syntax

def reset_message_flags() -> None: ...

Remarks

This method replaces the flags of the messages specified by the message_set property with the flags specified by the message_flags property. The format of the flags is specified by the IMAP RFCs.

Examples of possible flag values are server dependent, but they can include the following:

retrieve_message_headers Method

This method retrieves the message headers of the messages specified by the MessageSet property.

Syntax

def retrieve_message_headers() -> None: ...

Remarks

This method retrieves RFC 822 headers of the messages specified by message_set and stores them in the message_headers property.

retrieve_message_info Method

This method retrieves information about messages specified by the MessageSet property.

Syntax

def retrieve_message_info() -> None: ...

Remarks

This method retrieves information for the messages specified by the message_set property. This includes information about the message envelope as well as message structure. Every time a message envelope is retrieved, a on_message_info event is fired, and message envelope information is stored in properties, such as the following: message_subject, message_from, and message_recipients. If the message is a multipart message, one or more on_message_part events will be fired before the on_message_info event (one for each message part).

retrieve_message_part Method

This method retrieves the message part specified by PartID.

Syntax

def retrieve_message_part(part_id: str) -> None: ...

Remarks

This method retrieves the contents of the message part specified by the PartId property of the messages specified by the message_set property. If the local_file property contains a file name, the message part is stored in local_file. If the local_file property is set to an empty string, then the message part is stored in the message_text property. Additionally, the on_transfer will also provide the message part and denote the progress of the retrieval.

The part identifiers for each message part (if any) are provided through the corresponding on_message_part events. This method retrieves the RFC 822-encoded text of the messages specified by message_set.

retrieve_message_part_headers Method

This method retrieves the headers of message part specified by PartID.

Syntax

def retrieve_message_part_headers(part_id: str) -> None: ...

Remarks

This method retrieves RFC 822 headers of the message part specified by PartID and stores them in the message_headers property.

retrieve_message_text Method

This method retrieves the message text of the messages specified by the MessageSet property.

Syntax

def retrieve_message_text() -> None: ...

Remarks

This method retrieves the RFC 822-encoded text of the messages specified by message_set. If the local_file property contains a file name, the text is stored in local_file. If the local_file property is set to an empty string, then the text is stored in the message_text property. Additionally, the on_transfer event will also provide the text and denote the progress of the retrieval.

search_mailbox Method

This method searches the selected mailbox for specified text.

Syntax

def search_mailbox(search_criteria: str) -> None: ...

Remarks

This method searches the selected mailbox using the criteria specified in the SearchCriteria parameter. For every message matching the criteria, the retrieve_message_info method is called and a on_message_info event is fired.

The exact format of the search criteria is specified by the IMAP RFCs. The string consists of one or more search keys and their corresponding values (if any) separated by spaces, for example: "SINCE 1-Feb-1994 NOT FROM Smith".

Possible search keys include the following:

select_mailbox Method

This method selects a mailbox.

Syntax

def select_mailbox() -> None: ...

Remarks

This method asks the server to select the mailbox specified in the mailbox property. The mailbox is selected in read/write mode (if the server permits).

Example 1. Open a Mailbox in Read/Write Mode:

IMAPControl.Mailbox = "INBOX" IMAPControl.SelectMailbox

Example 2. Open a Mailbox in Read-Only Mode:

IMAPControl.Mailbox = "INBOX.Folder" IMAPControl.ExamineMailbox

send_command Method

This method sends the exact command directly to the server.

Syntax

def send_command(command: str) -> None: ...

Remarks

This method sends the command specified by Command to the server exactly as it is provided. Use this method to send additional or custom commands directly to the server.

After calling this method, check the last_reply property or monitor the on_pi_trail event to obtain the server's response.

set_mailbox_acl Method

This method sets mailbox access control rights for a specific user.

Syntax

def set_mailbox_acl(user: str, rights: str) -> None: ...

Remarks

This method changes the access control list for the mailbox specified in the mailbox property so that User is granted the permissions specified in Rights.

Rights is a string containing an optional plus ("+") or minus ("-") prefix, followed by zero or more rights characters. If the string starts with a plus, the rights are added to any existing rights for the identifier. If the string starts with a minus, the rights are removed from any existing rights for the identifier. If the string does not start with a plus or minus, the rights replace any existing rights for the identifier.

Standard rights include the following:

start_idle Method

This method begins idling.

Syntax

def start_idle() -> None: ...

Remarks

This method sends the IDLE command to the server and begins idling. As responses are received from the server the on_idle_info event fires. To stop idling, call stop_idle.

If the class is being used in a formless application (such as a console application) be sure to call do_events in a loop after calling this method to ensure that incoming events are processed.

stop_idle Method

This method stops idling.

Syntax

def stop_idle() -> None: ...

Remarks

This method stops idling if it was previously started via start_idle. If the class is not idling, this method does nothing.

subscribe_mailbox Method

This method subscribes to the mailbox specified by Mailbox .

Syntax

def subscribe_mailbox() -> None: ...

Remarks

This method subscribes to the mailbox specified by the mailbox property.

unset_message_flags Method

This method removes the flags specified by MessageFlags from the messages specified by MessageSet .

Syntax

def unset_message_flags() -> None: ...

Remarks

This method removes the flags specified by the message_flags property from the messages specified by the message_set property. The format of the flags is specified by the IMAP RFCs.

Examples of possible flag values are server dependent, but they can include the following:

unsubscribe_mailbox Method

This method unsubscribes from the mailbox specified by Mailbox .

Syntax

def unsubscribe_mailbox() -> None: ...

Remarks

This method unsubscribes from the mailbox specified by the mailbox property.

on_connection_status Event

Fired to indicate changes in the connection state.

Syntax

class IMAPConnectionStatusEventParams(object):
  @property
  def connection_event() -> str: ...

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

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

# In class IMAP:
@property
def on_connection_status() -> Callable[[IMAPConnectionStatusEventParams], None]: ...
@on_connection_status.setter
def on_connection_status(event_hook: Callable[[IMAPConnectionStatusEventParams], None]) -> None: ...

Remarks

This event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:

on_end_transfer Event

This event is fired when the message or the part data finishes transferring.

Syntax

class IMAPEndTransferEventParams(object):
  @property
  def direction() -> int: ...

# In class IMAP:
@property
def on_end_transfer() -> Callable[[IMAPEndTransferEventParams], None]: ...
@on_end_transfer.setter
def on_end_transfer(event_hook: Callable[[IMAPEndTransferEventParams], None]) -> None: ...

Remarks

The on_end_transfer event is fired when the requested message body or part completes transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

on_error Event

Fired when information is available about errors during data delivery.

Syntax

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

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

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

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

on_header Event

This event is fired every time a header line comes in.

Syntax

class IMAPHeaderEventParams(object):
  @property
  def field() -> str: ...

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

# In class IMAP:
@property
def on_header() -> Callable[[IMAPHeaderEventParams], None]: ...
@on_header.setter
def on_header(event_hook: Callable[[IMAPHeaderEventParams], None]) -> None: ...

Remarks

The Field parameter contains the name of the HTTP header (in the same case as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

on_idle_info Event

This event fires whenever responses from the server are received while idling.

Syntax

class IMAPIdleInfoEventParams(object):
  @property
  def message() -> str: ...

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

# In class IMAP:
@property
def on_idle_info() -> Callable[[IMAPIdleInfoEventParams], None]: ...
@on_idle_info.setter
def on_idle_info(event_hook: Callable[[IMAPIdleInfoEventParams], None]) -> None: ...

Remarks

This event fires each time a response is received from the server after calling start_idle. This will fire with information from the server intended to update the client. The type of data sent by the server may vary.

Message holds the response received from the server.

Cancel may be set to stop idling from within the event. This is equivalent to calling stop_idle.

The following are possible values returned by the server:

+ idling
* 43 EXISTS
* 1 RECENT

on_mailbox_acl Event

This event fires for each set of access control rights returned by the server.

Syntax

class IMAPMailboxACLEventParams(object):
  @property
  def mailbox() -> str: ...

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

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

# In class IMAP:
@property
def on_mailbox_acl() -> Callable[[IMAPMailboxACLEventParams], None]: ...
@on_mailbox_acl.setter
def on_mailbox_acl(event_hook: Callable[[IMAPMailboxACLEventParams], None]) -> None: ...

Remarks

The event fires for each set of access control rights returned by the server after a call to get_mailbox_acl. Standard rights include the following:

on_mailbox_list Event

This event fires for each mailbox received through the ListMailboxes and ListSubscribedMailboxes methods.

Syntax

class IMAPMailboxListEventParams(object):
  @property
  def mailbox() -> str: ...

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

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

# In class IMAP:
@property
def on_mailbox_list() -> Callable[[IMAPMailboxListEventParams], None]: ...
@on_mailbox_list.setter
def on_mailbox_list(event_hook: Callable[[IMAPMailboxListEventParams], None]) -> None: ...

Remarks

This method is fired for each mailbox received through the list_mailboxes and list_subscribed_mailboxes methods. The Separator parameter contains the character that separates the different parts in the mailbox path hierarchy.

on_message_info Event

This event is fired with information for the messages retrieved by the server.

Syntax

class IMAPMessageInfoEventParams(object):
  @property
  def message_id() -> str: ...

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

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

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

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

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

# In class IMAP:
@property
def on_message_info() -> Callable[[IMAPMessageInfoEventParams], None]: ...
@on_message_info.setter
def on_message_info(event_hook: Callable[[IMAPMessageInfoEventParams], None]) -> None: ...

Remarks

The on_message_info event is fired when messages are searched, listed, or message information is received.

Id is the Id of the message.

Subject is the message subject.

MessageDate is the date of the message.

From is the email address of the sender.

Flags is a list of flags associated with this message.

Size is the size of the message.

More information may be received from the respective properties, such as the following: message_content_type, message_content_encoding, message_recipients, message_delivery_time, message_flags, message_headers, message_in_reply_to, message_net_id, message_reply_to, message_sender, message_size, message_subject, message_text, etc.

on_message_part Event

This event is fired for each message part when RetrieveMessageInfo is called.

Syntax

class IMAPMessagePartEventParams(object):
  @property
  def part_id() -> str: ...

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

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

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

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

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

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

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

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

# In class IMAP:
@property
def on_message_part() -> Callable[[IMAPMessagePartEventParams], None]: ...
@on_message_part.setter
def on_message_part(event_hook: Callable[[IMAPMessagePartEventParams], None]) -> None: ...

Remarks

The PartId parameter denotes the PartId that may be identified in other parts or messages. The format of PartIds is specified by the IMAP RFCs.

The Size parameter gives the size of this part.

The ContentType parameter shows the type of data contained in the part.

The ContentEncoding parameter shows how data are encoded.

The FileName parameter shows the filename corresponding to the part (if the part was included in the message as an attached file).

The Parameters parameter contains the additional parameters passed to the ContentType header, such as the part charset.

The MultipartMode parameter shows the how this part relates to the message's whole multipart structure (e.g., 'mixed', 'alternative', etc.).

The ContentId parameter shows the value of the Content-Id header for the part.

The ContentDisposition parameter shows the value of the Content-Disposition header for the part.

on_pi_trail Event

This event traces the commands sent to the mail server, and the respective replies.

Syntax

class IMAPPITrailEventParams(object):
  @property
  def direction() -> int: ...

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

# In class IMAP:
@property
def on_pi_trail() -> Callable[[IMAPPITrailEventParams], None]: ...
@on_pi_trail.setter
def on_pi_trail(event_hook: Callable[[IMAPPITrailEventParams], None]) -> None: ...

Remarks

The on_pi_trail event is useful for debugging and learning purposes. It shows all of the interactions between the client and the server, line by line, except for message header and body transfers.

The Message parameter contains the full text of the message. The Direction parameter shows the originator of the message:

on_ssl_server_authentication Event

Fired after the server presents its certificate to the client.

Syntax

class IMAPSSLServerAuthenticationEventParams(object):
  @property
  def cert_encoded() -> bytes: ...

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

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

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

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

# In class IMAP:
@property
def on_ssl_server_authentication() -> Callable[[IMAPSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[IMAPSSLServerAuthenticationEventParams], None]) -> None: ...

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

on_ssl_status Event

Fired when secure connection progress messages are available.

Syntax

class IMAPSSLStatusEventParams(object):
  @property
  def message() -> str: ...

# In class IMAP:
@property
def on_ssl_status() -> Callable[[IMAPSSLStatusEventParams], None]: ...
@on_ssl_status.setter
def on_ssl_status(event_hook: Callable[[IMAPSSLStatusEventParams], None]) -> None: ...

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

on_start_transfer Event

This event is fired when the message body or the part data start transferring.

Syntax

class IMAPStartTransferEventParams(object):
  @property
  def direction() -> int: ...

# In class IMAP:
@property
def on_start_transfer() -> Callable[[IMAPStartTransferEventParams], None]: ...
@on_start_transfer.setter
def on_start_transfer(event_hook: Callable[[IMAPStartTransferEventParams], None]) -> None: ...

Remarks

The on_start_transfer event is fired when the message body or the part data start transferring from the server to the local host. Further progress information is provided by the on_transfer and on_end_transfer events.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

on_transfer Event

This event is fired while the message is transferred from the MailServer .

Syntax

class IMAPTransferEventParams(object):
  @property
  def direction() -> int: ...

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

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

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

# In class IMAP:
@property
def on_transfer() -> Callable[[IMAPTransferEventParams], None]: ...
@on_transfer.setter
def on_transfer(event_hook: Callable[[IMAPTransferEventParams], None]) -> None: ...

Remarks

The on_transfer event is fired for every incoming line when receiving a message or part data from the mail_server

The Text parameter contains the portion of the message or the part data being retrieved.

The BytesTransferred parameter contains the number of bytes transferred since the beginning of the message, including header bytes. At the end of transmission (i.e., when the last on_transfer event is fired), BytesTransferred equals the value of the message_size property.

The on_transfer event is fired for every line of the message. There is no terminating newline at the end of the Text parameter. A faster way to retrieve a message is to assign a value to the local_file property and use the on_transfer event to check the progress only rather than to get the actual data.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

IMAP Config Settings

IMAP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings

IMAP Errors

IMAP Errors

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

SSL Errors

TCP/IP Errors