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.
auth_mechanism | This property includes the authentication mechanism to be used when connecting to the mail server. |
auto_decode_parts | This property determines whether or not to automatically decode message parts. |
connected | This property shows whether the class is connected. |
end_byte | This property includes the byte index of the position where the transfer should end. |
firewall_auto_detect | This property tells the class whether or not to automatically detect and use firewall system settings, if available. |
firewall_type | This property determines the type of firewall to connect through. |
firewall_host | This property contains the name or IP address of the firewall (optional). |
firewall_password | This property contains a password if authentication is to be used when connecting through the firewall. |
firewall_port | This property contains the Transmission Control Protocol (TCP) port for the firewall Host . |
firewall_user | This property contains a username if authentication is to be used when connecting through a firewall. |
idle | This property specifies the current status of the class. |
last_reply | This property indicates the last reply received from the server. |
local_file | This property includes the path to a local file for downloading the message body. |
local_host | This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
mailbox | This property includes the name of the mailbox selected on the server. |
mailbox_flags | This property defines flags in the selected mailbox. |
mailbox_list_count | The number of records in the MailboxList arrays. |
mailbox_list_flags | This property contains the mailbox flags in a mailbox listing. |
mailbox_list_name | This property contains the mailbox name in a mailbox listing. |
mailbox_list_separator | The Separator property contains the character that separates the different parts in the mailbox path hierarchy. |
mail_port | This property includes the port of the IMAP server (default is 143). |
mail_server | This property includes the name or address of the mail server (IMAP server). |
message | This property provides the raw message content. |
message_content_encoding | This property includes the ContentEncoding of the selected message. |
message_content_type | This property includes the ContentType of the message. |
message_count | This property includes the total number of messages on the Mailbox . |
message_date | The property includes the time the message was created. |
message_delivery_time | This property includes the time the message was delivered to the mail server. |
message_flags | This property contains the flags of the current message. |
message_from | This property includes the address of the author of the message. |
message_header_count | The number of records in the MessageHeader arrays. |
message_header_field | This property contains the name of the HTTP header (this is the same case as it is delivered). |
message_header_value | This property contains the header contents. |
message_headers_string | This property includes the string version of the RFC 822-encoded headers in the message. |
message_id | This property includes the message identifier of the current message. |
message_info_count | The number of records in the MessageInfo arrays. |
message_info_date | This property contains the date of a message in a message information listing. |
message_info_flags | This property contains a message flag in a message information listing. |
message_info_from | This property contains the sender of a message in a message information listing. |
message_info_message_id | The unique identifier of a message in a message information listing. |
message_info_size | This property contains the size of a message in a message information listing. |
message_info_subject | This property contains the subject of a message in a message information listing. |
message_in_reply_to | This property includes the unique message identifier of the message being replied to. |
message_net_id | This property includes the globally unique identifier of the message. |
message_part_count | The number of records in the MessagePart arrays. |
message_part_content_disposition | This property shows the value of the Content-Disposition header of the message part. |
message_part_content_encoding | This property shows how the data are encoded. |
message_part_content_id | This property shows the value of the Content-Id header of the message part. |
message_part_content_type | This property shows the type of data contained in the message part. |
message_part_file_name | This property shows the filename corresponding to the part (if the part was included in the message as an attached file). |
message_part_id | This property contains the identifier of a part listing that may be identified in other parts or messages. |
message_part_multipart_mode | This property shows how this part relates to the message's whole multipart structure (e. |
message_part_parameters | This property contains the additional parameters passed to the ContentType header, such as the part charset. |
message_part_size | This property contains the size of a part in a message part listing. |
message_recipient_count | The number of records in the MessageRecipient arrays. |
message_recipient_address | This property contains the email address of the recipient. |
message_recipient_name | This property contains the name of the recipient. |
message_recipient_options | This property contains the recipient sending options (used only by SMTP). |
message_recipient_type | This property contains the recipient type: To, Cc, or Bcc. |
message_reply_to | This property includes the email addresses to which replies to the message should be sent. |
message_sender | This property includes the address of the sender of the message. |
message_set | This property includes the set of messages to operate on. |
message_size | This property includes the size of the selected message. |
message_subject | This property includes the subject of the message. |
message_text | This property includes the body of the retrieved message. |
overwrite | This property indicates whether or not the class should overwrite files during transfer. |
password | This property includes the password to be used to authenticate to the MailServer . |
peek_mode | When set to True, the message Seen flag is not changed during reading. |
recent_message_count | This property includes the number of new messages in the Mailbox . |
sort_criteria | This property sorts criteria to use for message retrieval operations. |
ssl_accept_server_cert_effective_date | This is the date on which this certificate becomes valid. |
ssl_accept_server_cert_expiration_date | This is the date the certificate expires. |
ssl_accept_server_cert_extended_key_usage | This is a comma-delimited list of extended key usage identifiers. |
ssl_accept_server_cert_fingerprint | This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. |
ssl_accept_server_cert_fingerprint_sha1 | This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
ssl_accept_server_cert_fingerprint_sha256 | This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
ssl_accept_server_cert_issuer | This is the issuer of the certificate. |
ssl_accept_server_cert_private_key | This is the private key of the certificate (if available). |
ssl_accept_server_cert_private_key_available | This property shows whether a PrivateKey is available for the selected certificate. |
ssl_accept_server_cert_private_key_container | This is the name of the PrivateKey container for the certificate (if available). |
ssl_accept_server_cert_public_key | This is the public key of the certificate. |
ssl_accept_server_cert_public_key_algorithm | This property contains the textual description of the certificate's public key algorithm. |
ssl_accept_server_cert_public_key_length | This is the length of the certificate's public key (in bits). |
ssl_accept_server_cert_serial_number | This is the serial number of the certificate encoded as a string. |
ssl_accept_server_cert_signature_algorithm | The property contains the text description of the certificate's signature algorithm. |
ssl_accept_server_cert_store | This is the name of the certificate store for the client certificate. |
ssl_accept_server_cert_store_password | 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 | This is the type of certificate store for this certificate. |
ssl_accept_server_cert_subject_alt_names | This property contains comma-separated lists of alternative subject names for the certificate. |
ssl_accept_server_cert_thumbprint_md5 | This property contains the MD5 hash of the certificate. |
ssl_accept_server_cert_thumbprint_sha1 | This property contains the SHA-1 hash of the certificate. |
ssl_accept_server_cert_thumbprint_sha256 | This property contains the SHA-256 hash of the certificate. |
ssl_accept_server_cert_usage | This property contains the text description of UsageFlags . |
ssl_accept_server_cert_usage_flags | This property contains the flags that show intended use for the certificate. |
ssl_accept_server_cert_version | This property contains the certificate's version number. |
ssl_accept_server_cert_subject | This is the subject of the certificate used for client authentication. |
ssl_accept_server_cert_encoded | This is the certificate (PEM/Base64 encoded). |
ssl_cert_effective_date | This is the date on which this certificate becomes valid. |
ssl_cert_expiration_date | This is the date the certificate expires. |
ssl_cert_extended_key_usage | This is a comma-delimited list of extended key usage identifiers. |
ssl_cert_fingerprint | This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. |
ssl_cert_fingerprint_sha1 | This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
ssl_cert_fingerprint_sha256 | This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
ssl_cert_issuer | This is the issuer of the certificate. |
ssl_cert_private_key | This is the private key of the certificate (if available). |
ssl_cert_private_key_available | This property shows whether a PrivateKey is available for the selected certificate. |
ssl_cert_private_key_container | This is the name of the PrivateKey container for the certificate (if available). |
ssl_cert_public_key | This is the public key of the certificate. |
ssl_cert_public_key_algorithm | This property contains the textual description of the certificate's public key algorithm. |
ssl_cert_public_key_length | This is the length of the certificate's public key (in bits). |
ssl_cert_serial_number | This is the serial number of the certificate encoded as a string. |
ssl_cert_signature_algorithm | The property contains the text description of the certificate's signature algorithm. |
ssl_cert_store | This is the name of the certificate store for the client certificate. |
ssl_cert_store_password | 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 | This is the type of certificate store for this certificate. |
ssl_cert_subject_alt_names | This property contains comma-separated lists of alternative subject names for the certificate. |
ssl_cert_thumbprint_md5 | This property contains the MD5 hash of the certificate. |
ssl_cert_thumbprint_sha1 | This property contains the SHA-1 hash of the certificate. |
ssl_cert_thumbprint_sha256 | This property contains the SHA-256 hash of the certificate. |
ssl_cert_usage | This property contains the text description of UsageFlags . |
ssl_cert_usage_flags | This property contains the flags that show intended use for the certificate. |
ssl_cert_version | This property contains the certificate's version number. |
ssl_cert_subject | This is the subject of the certificate used for client authentication. |
ssl_cert_encoded | This is the certificate (PEM/Base64 encoded). |
ssl_enabled | This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled. |
ssl_provider | This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
ssl_server_cert_effective_date | This is the date on which this certificate becomes valid. |
ssl_server_cert_expiration_date | This is the date the certificate expires. |
ssl_server_cert_extended_key_usage | This is a comma-delimited list of extended key usage identifiers. |
ssl_server_cert_fingerprint | This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. |
ssl_server_cert_fingerprint_sha1 | This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
ssl_server_cert_fingerprint_sha256 | This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
ssl_server_cert_issuer | This is the issuer of the certificate. |
ssl_server_cert_private_key | This is the private key of the certificate (if available). |
ssl_server_cert_private_key_available | This property shows whether a PrivateKey is available for the selected certificate. |
ssl_server_cert_private_key_container | This is the name of the PrivateKey container for the certificate (if available). |
ssl_server_cert_public_key | This is the public key of the certificate. |
ssl_server_cert_public_key_algorithm | This property contains the textual description of the certificate's public key algorithm. |
ssl_server_cert_public_key_length | This is the length of the certificate's public key (in bits). |
ssl_server_cert_serial_number | This is the serial number of the certificate encoded as a string. |
ssl_server_cert_signature_algorithm | The property contains the text description of the certificate's signature algorithm. |
ssl_server_cert_store | This is the name of the certificate store for the client certificate. |
ssl_server_cert_store_password | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
ssl_server_cert_store_type | This is the type of certificate store for this certificate. |
ssl_server_cert_subject_alt_names | This property contains comma-separated lists of alternative subject names for the certificate. |
ssl_server_cert_thumbprint_md5 | This property contains the MD5 hash of the certificate. |
ssl_server_cert_thumbprint_sha1 | This property contains the SHA-1 hash of the certificate. |
ssl_server_cert_thumbprint_sha256 | This property contains the SHA-256 hash of the certificate. |
ssl_server_cert_usage | This property contains the text description of UsageFlags . |
ssl_server_cert_usage_flags | This property contains the flags that show intended use for the certificate. |
ssl_server_cert_version | This property contains the certificate's version number. |
ssl_server_cert_subject | This is the subject of the certificate used for client authentication. |
ssl_server_cert_encoded | This is the certificate (PEM/Base64 encoded). |
ssl_start_mode | This property determines how the class starts the Secure Sockets Layer (SSL) negotiation. |
start_byte | This property includes the byte index of the position where the transfer should start. |
timeout | This property includes the timeout for the class. |
uid_mode | If True, this property indicates whether permanent message identifiers are used instead of the default temporary identifiers. |
uid_validity | This property includes the UIDValidity parameter sent from the server in response to SelectMailbox command. |
user | This property includes the username used to authenticate to the MailServer . |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
add_message_flags | This method adds the specified flags to the messages specified by MessageSet . |
append_to_mailbox | This method appends the message in MessageText to the mailbox specified by Mailbox . |
check_mailbox | This method sends a CHECK command to the server. |
close_mailbox | This method removes all messages marked with a 'Deleted' flag from the currently selected mailbox and closes the unselected mailbox. |
config | Sets or retrieves a configuration setting. |
connect | This method connects to an IMAP server. |
copy_to_mailbox | This method copies the messages specified by MessageSet to the mailbox specified by Mailbox . |
create_mailbox | This method creates a new mailbox specified by Mailbox . |
delete_from_mailbox | The method marks the messages specified by MessageSet as deleted. |
delete_mailbox | This method deletes a mailbox specified by Mailbox . |
delete_mailbox_acl | This method deletes mailbox access control rights for a specific user. |
disconnect | This method disconnects from an IMAP server. |
do_events | This method processes events from the internal message queue. |
examine_mailbox | This method selects a mailbox in read-only mode. |
expunge_mailbox | This method removes all messages marked with a 'Deleted' flag from the currently selected mailbox. |
get_mailbox_acl | This method retrieves mailbox access control rights. |
interrupt | This method interrupts the current method. |
list_mailboxes | This method lists all of the mailboxes matching all criteria in the Mailbox property. |
list_subscribed_mailboxes | This method lists all subscribed mailboxes matching all criteria in the Mailbox property. |
localize_date | This method converts a valid RFC 822 message date to a local date and time. |
move_to_mailbox | This method moves the messages specified by MessageSet to the mailbox specified by Mailbox . |
noop | This method sends a NOOP command to the server. |
rename_mailbox | This method changes the name of Mailbox to NewName . |
reset | This method will reset the class. |
reset_message_flags | This method replaces the flags of the messages specified by MessageSet with the flags specified by MessageFlags . |
retrieve_message_headers | This method retrieves the message headers of the messages specified by the MessageSet property. |
retrieve_message_info | This method retrieves information about messages specified by the MessageSet property. |
retrieve_message_part | This method retrieves the message part specified by PartID. |
retrieve_message_part_headers | This method retrieves the headers of message part specified by PartID. |
retrieve_message_text | This method retrieves the message text of the messages specified by the MessageSet property. |
search_mailbox | This method searches the selected mailbox for specified text. |
select_mailbox | This method selects a mailbox. |
send_command | This method sends the exact command directly to the server. |
set_mailbox_acl | This method sets mailbox access control rights for a specific user. |
start_idle | This method begins idling. |
stop_idle | This method stops idling. |
subscribe_mailbox | This method subscribes to the mailbox specified by Mailbox . |
unset_message_flags | This method removes the flags specified by MessageFlags from the messages specified by MessageSet . |
unsubscribe_mailbox | This method unsubscribes from the mailbox specified by Mailbox . |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
on_connection_status | This event is fired to indicate changes in the connection state. |
on_end_transfer | This event is fired when the message or the part data finishes transferring. |
on_error | Fired when information is available about errors during data delivery. |
on_header | This event is fired every time a header line comes in. |
on_idle_info | This event fires whenever responses from the server are received while idling. |
on_mailbox_acl | This event fires for each set of access control rights returned by the server. |
on_mailbox_list | This event fires for each mailbox received through the ListMailboxes and ListSubscribedMailboxes methods. |
on_message_info | This event is fired with information for the messages retrieved by the server. |
on_message_part | This event is fired for each message part when RetrieveMessageInfo is called. |
on_pi_trail | This event traces the commands sent to the mail server, and the respective replies. |
on_ssl_server_authentication | Fired after the server presents its certificate to the client. |
on_ssl_status | Fired when secure connection progress messages are available. |
on_start_transfer | This event is fired when the message body or the part data start transferring. |
on_transfer | This event is fired while the message is transferred from the MailServer . |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
AlwaysReturnUIDs | Instructs the server to return UIDs even if not in UIDMode. |
AppendToMailboxDateTime | Specifies the date-time parameter used in the initial APPEND request. |
AuthorizationIdentity | The value to use as the authorization identity when SASL authentication is used. |
AutoDecodeSubject | Instructs the class to automatically decode message subjects. |
AutoDecodeText | Whether to decode MessageText when AutoDecodeParts is True. |
IncludeHeaders | Instructs the class to include the headers in the LocalFile. |
MaskSensitiveData | Whether sensitive properties should be masked when logging. |
RetrieveAfterSearch | Determines if messages matching the SearchCriteria are retrieved after calling SearchMailbox. |
RetrieveTextAndHeaders | Specifies whether the message body and headers are retrieved in a single request. |
SendIDCommand | Instructs class to send the ID command if the server advertises support for it. |
UTF7MailboxNames | Specifies whether or not to automatically encode and decode UTF-7 mailbox names. |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the class binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
OpenSSLCADir | The path to a directory containing CA certificates. |
OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACertFilePaths | The paths to CA certificate files on Unix/Linux. |
SSLCACerts | A newline separated list of CA certificate to be included when performing an SSL handshake. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCheckOCSP | Whether to use OCSP to check the status of the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLClientCACerts | A newline separated list of CA certificates to use during SSL client certificate validation. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
SSLNegotiatedCipher | Returns the negotiated cipher suite. |
SSLNegotiatedCipherStrength | Returns the negotiated cipher suite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated cipher suite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLServerCACerts | A newline separated list of CA certificates to use during SSL server certificate validation. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitiveData | Whether sensitive data is masked in log messages. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
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
Auth Mechanism | Description |
0 (amUserPassword - Default) | A user/password pair is sent in plaintext to login (default). |
1 (amCRAMMD5) | CRAM-MD5 authentication. |
2 (amNTLM) | NTLM authentication. |
4 (amSASLPlain) | SASLPlain. Note: Servers often require the Secure Sockets Layer (SSL) to be used when this authentication mechanism is requested. See AuthorizationIdentity. |
5 (amSASLDigestMD5) | SASLDigestMD5. See AuthorizationIdentity. |
6 (amKerberos) | Kerberos authentication. This option is available in Windows or other platforms when using the Java edition. |
7 (mXOAUTH) | XOAUTH2 authentication. See AuthorizationIdentity. |
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
This property shows 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
This property tells the class whether or not 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
This property tells the class whether or not to automatically detect and use firewall system settings, if available.
firewall_type Property
This property determines 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
This property determines the type of firewall to connect through. The applicable values are as follows:
fwNone (0) | No firewall (default setting). |
fwTunnel (1) | Connect through a tunneling proxy. firewall_port is set to 80. |
fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. firewall_port is set to 1080. |
fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. firewall_port is set to 1080. |
fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. firewall_port is set to 1080. |
firewall_host Property
This property contains 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
This property contains 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
This property contains 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
This property contains 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
This property contains 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
This property contains 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
This property contains 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
This property contains 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
This property specifies the current status of the class.
Syntax
def get_idle() -> bool: ...
idle = property(get_idle, None)
Default Value
TRUE
Remarks
idle 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
This property includes 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
The local_host 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:
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:
\Deleted | Mark a message as deleted (for removal later by expunge_mailbox). |
\Seen | Mark a message as read. |
\Answered | Mark a message as answered. |
\Flagged | Mark a message as flagged. |
\Draft | Mark a message as being incomplete (under composition). |
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:
\Deleted | Mark a message as deleted (for removal later by expunge_mailbox). |
\Seen | Mark a message as read. |
\Answered | Mark a message as answered. |
\Flagged | Mark a message as flagged. |
\Draft | Mark a message as being incomplete (under composition). |
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:
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
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:
\Deleted | Mark a message as deleted (for removal later by expunge_mailbox). |
\Seen | Mark a message as read. |
\Answered | Mark a message as answered. |
\Flagged | Mark a message as flagged. |
\Draft | Mark a message as being incomplete (under composition). |
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
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:
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:
ARRIVAL | Internal date and time of the message. |
DATE | The value of the message's DATE header, adjusted by time zone. |
CC | The value of the message's CC header. |
FROM | The value of the message's FROM header. |
SUBJECT | The value of the message's SUBJECT header. |
TO | The value of the message's TO header. |
SIZE | The size of the message |
REVERSE <criterion> | Followed by another sort criterion, this sort key has the effect of that criterion but in reverse (descending) order. |
Note: IMAP SORT functionality is relatively new and not all servers may implement it.
ssl_accept_server_cert_effective_date Property
This is 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
This is 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
This is the date 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
This is the date 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
This is 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
This is 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
This is 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
This is 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
This is 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
This is 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
This is 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
This is 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
This is 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
This is 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
This is 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
This is 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
This property shows 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
This property shows 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
This is 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
This is 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
This is 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
This is 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
This property contains 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
This property contains 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
This is 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
This is 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
This is 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
This is 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 property contains 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 property contains 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
This is 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
This is 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:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, 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
This is 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
This is 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:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The list_store_certificates method may be called after setting cert_store_type to cstPKCS11, cert_store_password to the PIN, and cert_store to the full path of the PKCS#11 DLL. The certificate information returned in the on_cert_list event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the ssl_accept_server_cert_store and set ssl_accept_server_cert_store_password to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
ssl_accept_server_cert_subject_alt_names Property
This property contains 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
This property contains comma-separated lists of alternative subject names for the certificate.
This property is read-only.
ssl_accept_server_cert_thumbprint_md5 Property
This property contains 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
This property contains 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
This property contains 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
This property contains 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
This property contains 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
This property contains 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
This property contains 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
This property contains the text description of ssl_accept_server_cert_usage_flags.
This value will be of 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
This property contains 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
This property contains 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:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
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
This property contains 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
This property contains 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
This is 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
This is 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:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
ssl_accept_server_cert_encoded Property
This is 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
This is 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
This is 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
This is 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
This is the date 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
This is the date 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
This is 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
This is 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
This is 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
This is 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
This is 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
This is 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
This is 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
This is 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
This is the issuer of the certificate.
Syntax
def get_ssl_cert_issuer() -> str: ...
ssl_cert_issuer = property(get_ssl_cert_issuer, None)
Default Value
""
Remarks
This is 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
This is 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
This is 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
This property shows 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
This property shows 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
This is 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
This is 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
This is 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
This is 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
This property contains 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
This property contains 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
This is 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
This is 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
This is 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
This is 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 property contains 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 property contains 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
This is 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
This is 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:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, 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
This is 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
This is 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:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The list_store_certificates method may be called after setting cert_store_type to cstPKCS11, cert_store_password to the PIN, and cert_store to the full path of the PKCS#11 DLL. The certificate information returned in the on_cert_list event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the ssl_cert_store and set ssl_cert_store_password to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
ssl_cert_subject_alt_names Property
This property contains 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
This property contains comma-separated lists of alternative subject names for the certificate.
This property is read-only.
ssl_cert_thumbprint_md5 Property
This property contains 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
This property contains 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
This property contains 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
This property contains 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
This property contains 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
This property contains 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
This property contains the text description of UsageFlags .
Syntax
def get_ssl_cert_usage() -> str: ...
ssl_cert_usage = property(get_ssl_cert_usage, None)
Default Value
""
Remarks
This property contains the text description of ssl_cert_usage_flags.
This value will be of 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
This property contains 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
This property contains the flags that show intended use for the certificate. The value of ssl_cert_usage_flags is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
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
This property contains the certificate's version number.
Syntax
def get_ssl_cert_version() -> str: ...
ssl_cert_version = property(get_ssl_cert_version, None)
Default Value
""
Remarks
This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
ssl_cert_subject Property
This is 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
This is 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:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
ssl_cert_encoded Property
This is 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
This is 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
This property specifies 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:
0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
1 (sslpPlatform) | Uses the platform/system implementation. |
2 (sslpInternal) | Uses the internal implementation. |
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
This is 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
This is 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
This is the date 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
This is the date 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
This is 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
This is 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
This is 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
This is 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
This is 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
This is 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
This is 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
This is 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
This is 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
This is 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
This is 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
This is 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
This property shows 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
This property shows 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
This is 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
This is 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
This is 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
This is 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
This property contains 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
This property contains 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
This is 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
This is 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
This is 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
This is 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 property contains 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 property contains 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
This is 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
This is 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:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, 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
This is 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
This is 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:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The list_store_certificates method may be called after setting cert_store_type to cstPKCS11, cert_store_password to the PIN, and cert_store to the full path of the PKCS#11 DLL. The certificate information returned in the on_cert_list event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the ssl_server_cert_store and set ssl_server_cert_store_password to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
This property is read-only.
ssl_server_cert_subject_alt_names Property
This property contains 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
This property contains comma-separated lists of alternative subject names for the certificate.
This property is read-only.
ssl_server_cert_thumbprint_md5 Property
This property contains 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
This property contains 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
This property contains 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
This property contains 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
This property contains 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
This property contains 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
This property contains 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
This property contains the text description of ssl_server_cert_usage_flags.
This value will be of 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
This property contains 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
This property contains the flags that show intended use for the certificate. The value of ssl_server_cert_usage_flags is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
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
This property contains 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
This property contains 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
This is 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
This is 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:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
This property is read-only.
ssl_server_cert_encoded Property
This is 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
This is 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:
0 (sslAutomatic) | If the remote port is set to the standard plaintext port of the protocol (where applicable), the class will behave the same as if ssl_start_mode is set to sslExplicit. In all other cases, SSL negotiation will be implicit (sslImplicit). |
1 (sslImplicit) | The SSL negotiation will start immediately after the connection is established. |
2 (sslExplicit) | The class will first connect in plaintext, and then will explicitly start SSL negotiation through a protocol command such as STARTTLS. |
3 (sslNone - default) | No SSL negotiation; no SSL security. All communication will be in plaintext mode. |
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
This property includes 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:
\Deleted | Mark a message as deleted (for removal later by expunge_mailbox). |
\Seen | Mark a message as read. |
\Answered | Mark a message as answered. |
\Flagged | Mark a message as flagged. |
\Draft | Mark a message as being incomplete (under composition). |
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
This method copies the messages specified by MessageSet to the mailbox specified by 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:
l | Lookup (Visible to be listed) |
r | Read (Can be selected, retrieved, searched, and copied) |
s | Keep (Seen/unseen information across sessions) |
w | Write (Stores flags other than SEEN and DELETED) |
i | Insert (Can be appended and copied into) |
p | Post (Can send mail to submission address for mailbox) |
c | Create (Can create new sub-mailboxes) |
d | Delete (Stores DELETED flag and performs EXPUNGE) |
a | Administer (Set access permissions) |
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
This method moves the messages specified by MessageSet to the mailbox specified by Mailbox .
Syntax
def move_to_mailbox() -> None: ...
Remarks
This method moves the messages specified by the message_set property to the mailbox specified by the mailbox property.
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:
\Deleted | Mark a message as deleted (for removal later by expunge_mailbox). |
\Seen | Mark a message as read. |
\Answered | Mark a message as answered. |
\Flagged | Mark a message as flagged. |
\Draft | Mark a message as being incomplete (under composition). |
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:
<message set> | Messages with message sequence numbers corresponding to the specified message sequence number set. |
ALL | All messages in the mailbox; this is the default initial key for AND-ing. |
ANSWERED | Messages with the \Answered flag set. |
BCC <string> | Messages that contain the specified string in the envelope structure's BCC field. |
BEFORE <date> | Messages whose internal date is earlier than the specified date. |
BODY <string> | Messages that contain the specified string in the body of the message. |
CC <string> | Messages that contain the specified string in the envelope structure's CC field. |
DELETED | Messages with the \Deleted flag set. |
DRAFT | Messages with the \Draft flag set. |
FLAGGED | Messages with the \Flagged flag set. |
FROM <string> | Messages that contain the specified string in the envelope structure's FROM field. |
HEADER <field-name> <string> | Messages that have a header with the specified field-name (as defined in [RFC-822]) and that contains the specified string in the [RFC-822] field-body. |
KEYWORD <flag> | Messages with the specified keyword set. |
LARGER <n> | Messages with an RFC822.SIZE larger than the specified number of octets. |
NEW | Messages that have the \Recent flag set but not the \Seen flag. This is functionally equivalent to "(RECENT UNSEEN)". |
NOT <search-key> | Messages that do not match the specified search key. |
OLD | Messages that do not have the \Recent flag set. This is functionally equivalent to "NOT RECENT" (as opposed to "NOT NEW"). |
ON <date> | Messages whose internal date is within the specified date. |
OR <search-key1> <search-key2> | Messages that match either search key. |
RECENT | Messages that have the \Recent flag set. |
SEEN | Messages that have the \Seen flag set. |
SENTBEFORE <date> | Messages whose [RFC-822] Date: header is earlier than the specified date. |
SENTON <date> | Messages whose [RFC-822] Date: header is within the specified date. |
SENTSINCE <date> | Messages whose [RFC-822] Date: header is within or later than the specified date. |
SINCE <date> | Messages whose internal date is within or later than the specified date. |
SMALLER <n> | Messages with an RFC822.SIZE smaller than the specified number of octets. |
SUBJECT <string> | Messages that contain the specified string in the envelope structure's SUBJECT field. |
TEXT <string> | Messages that contain the specified string in the header or body of the message. |
TO <string> | Messages that contain the specified string in the envelope structure's TO field. |
UID <message set> | Messages with unique identifiers corresponding to the specified unique identifier set. |
UNANSWERED | Messages that do not have the \Answered flag set. |
UNDELETED | Messages that do not have the \Deleted flag set. |
UNDRAFT | Messages that do not have the \Draft flag set. |
UNFLAGGED | Messages that do not have the \Flagged flag set. |
UNKEYWORD <flag> | Messages that do not have the specified keyword set. |
UNSEEN | Messages that do not have the \Seen flag set. |
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:
l | Lookup (Visible to be listed) |
r | Read (Can be selected, retrieved, searched, and copied) |
s | Keep (Seen/unseen information across sessions) |
w | Write (Stores flags other than SEEN and DELETED) |
i | Insert (Can be appended and copied into) |
p | Post (Can send mail to submission address for mailbox) |
c | Create (Can create new sub-mailboxes) |
d | Delete (Stores DELETED flag and performs EXPUNGE) |
a | Administer (Set access permissions) |
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:
\Deleted | Mark a message as deleted (for removal later by expunge_mailbox). |
\Seen | Mark a message as read. |
\Answered | Mark a message as answered. |
\Flagged | Mark a message as flagged. |
\Draft | Mark a message as being incomplete (under composition). |
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
This event is 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
The on_connection_status 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:
Firewall connection complete. | |
Secure Sockets Layer (SSL) or S/Shell handshake complete (where applicable). | |
Remote host connection complete. | |
Remote host disconnected. | |
SSL or S/Shell connection broken. | |
Firewall host disconnected. |
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:
l | Lookup (Visible to be listed) |
r | Read (Can be selected, retrieved, searched, and copied) |
s | Keep (Seen/unseen information across sessions) |
w | Write (Stores flags other than SEEN and DELETED) |
i | Insert (Can be appended and copied into) |
p | Post (Can send mail to submission address for mailbox) |
c | Create (Can create new sub-mailboxes) |
d | Delete (Stores DELETED flag and performs EXPUNGE) |
a | Administer (Set access permissions) |
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:
0 (Client) | The Message originates from the client. |
1 (Server) | The Message originates from the server. |
2 (Information) | The Message is an informative message originating from the client software (the class code). |
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
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.
IMAP Config Settings
The default value for this setting is False.
The date-time should be formatted according to the IMAP RFC specifications. For example, "22-Jan-2013 12:34:56 -0500" indicates January 22nd, 2013, at 12:34:56 PM EST.
By default, if this setting is not specified, no date-time is sent with the APPEND request, and the server will use the current time.
Bearer ya29.AHES6ZRmS-8xPbpGetC1VbABJIBRdKm-c4X7wMVGAbgxdGt5q8Ts3Q
Note: When using amXOAUTH2, user must be specified, but password is not required.
This configuration setting specifies whether the class will use the IMAP4 Id extension defined in RFC 2971 and send the Id command to the server. When set to True, the class will send the Id command with the value IPWorksIMAP if the server supports this as defined in the server's response to the CAPABILITY command.
The default value is False, and this command will not be sent.
TCPClient Config Settings
If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.
0 | No firewall (default setting). |
1 | Connect through a tunneling proxy. FirewallPort is set to 80. |
2 | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
3 | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
10 | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.
In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.
The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).
Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.
In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.
If the class is connected, the local_host setting 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).
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by local_port after the connection is established.
local_port cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.
This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.
If an eol string is found in the input stream before MaxLineLength bytes are received, the on_data_in event is fired with the EOL parameter set to True, and the buffer is reset.
If no eol is found, and MaxLineLength bytes are accumulated in the buffer, the on_data_in event is fired with the EOL parameter set to False, and the buffer is reset.
The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this configuration setting is set to False.
0 | IPv4 only |
1 | IPv6 only |
2 | IPv6 with IPv4 fallback |
SSL Config Settings
When enabled, SSL packet logs are output using the on_ssl_status event, which will fire each time an SSL packet is sent or received.
Enabling this configuration setting has no effect if ssl_provider is set to Platform.
The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g., 9d66eef0.0, 9d66eef0.1). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by the following sequences:
-----BEGIN CERTIFICATE-----
... (CA certificate in base64 encoding) ...
-----END CERTIFICATE-----
Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".
By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.
If set to True, the class will reuse the context if and only if the following criteria are met:
- The target host name is the same.
- The system cache entry has not expired (default timeout is 10 hours).
- The application process that calls the function is the same.
- The logon session is the same.
- The instance of the class is the same.
The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found, the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.
The default value is as follows:
/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermedaite Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When set to 0 (default), the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.
This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
When set to 0 (default), the class will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.
This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
Note: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the on_ssl_status event.
Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.
When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList configuration setting.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----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-----
By default, the enabled cipher suites will include all available ciphers ("*").
The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.
Multiple cipher suites are separated by semicolons.
Example values when ssl_provider is set to Platform include the following:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
Possible values when ssl_provider is set to Platform include the following:
- CALG_3DES
- CALG_3DES_112
- CALG_AES
- CALG_AES_128
- CALG_AES_192
- CALG_AES_256
- CALG_AGREEDKEY_ANY
- CALG_CYLINK_MEK
- CALG_DES
- CALG_DESX
- CALG_DH_EPHEM
- CALG_DH_SF
- CALG_DSS_SIGN
- CALG_ECDH
- CALG_ECDH_EPHEM
- CALG_ECDSA
- CALG_ECMQV
- CALG_HASH_REPLACE_OWF
- CALG_HUGHES_MD5
- CALG_HMAC
- CALG_KEA_KEYX
- CALG_MAC
- CALG_MD2
- CALG_MD4
- CALG_MD5
- CALG_NO_SIGN
- CALG_OID_INFO_CNG_ONLY
- CALG_OID_INFO_PARAMETERS
- CALG_PCT1_MASTER
- CALG_RC2
- CALG_RC4
- CALG_RC5
- CALG_RSA_KEYX
- CALG_RSA_SIGN
- CALG_SCHANNEL_ENC_KEY
- CALG_SCHANNEL_MAC_KEY
- CALG_SCHANNEL_MASTER_HASH
- CALG_SEAL
- CALG_SHA
- CALG_SHA1
- CALG_SHA_256
- CALG_SHA_384
- CALG_SHA_512
- CALG_SKIPJACK
- CALG_SSL2_MASTER
- CALG_SSL3_MASTER
- CALG_SSL3_SHAMD5
- CALG_TEK
- CALG_TLS1_MASTER
- CALG_TLS1PRF
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA");
Possible values when ssl_provider is set to Internal include the following:
- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
- TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_DES_CBC_SHA
- TLS_DHE_RSA_WITH_DES_CBC_SHA
- TLS_DHE_DSS_WITH_DES_CBC_SHA
- TLS_RSA_WITH_RC4_128_MD5
- TLS_RSA_WITH_RC4_128_SHA
When TLS 1.3 is negotiated (see SSLEnabledProtocols), only the following cipher suites are supported:
- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256
SSLEnabledCipherSuites is used together with SSLCipherStrength.
Not all supported protocols are enabled by default. The default value is 4032 for client components, and 3072 for server components. To specify a combination of enabled protocol versions set this config to the binary OR of one or more of the following values:
TLS1.3 | 12288 (Hex 3000) |
TLS1.2 | 3072 (Hex C00) (Default - Client and Server) |
TLS1.1 | 768 (Hex 300) (Default - Client) |
TLS1 | 192 (Hex C0) (Default - Client) |
SSL3 | 48 (Hex 30) |
SSL2 | 12 (Hex 0C) |
Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.
SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:
By default when TLS 1.3 is enabled, the class will use the internal TLS implementation when the ssl_provider is set to Automatic for all editions.
In editions that are designed to run on Windows, ssl_provider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.
If set to 1 (Platform provider), please be aware of the following notes:
- The platform provider is available only on Windows 11/Windows Server 2022 and up.
- SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
- If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.
SSLEnabledProtocols: SSL2 and SSL3 Notes:
SSL 2.0 and 3.0 are not supported by the class when the ssl_provider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and ssl_provider needs to be set to platform.
This configuration setting is applicable only when ssl_provider is set to Internal.
If set to True, all certificates returned by the server will be present in the Encoded parameter of the on_ssl_server_authentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.
When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the class will only append, it will not overwrite previous values.
Note: This configuration setting is applicable only when ssl_provider is set to Internal.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
0x00000001 | Ignore time validity status of certificate. |
0x00000002 | Ignore time validity status of CTL. |
0x00000004 | Ignore non-nested certificate times. |
0x00000010 | Allow unknown certificate authority. |
0x00000020 | Ignore wrong certificate usage. |
0x00000100 | Ignore unknown certificate revocation status. |
0x00000200 | Ignore unknown CTL signer revocation status. |
0x00000400 | Ignore unknown certificate authority revocation status. |
0x00000800 | Ignore unknown root revocation status. |
0x00008000 | Allow test root certificate. |
0x00004000 | Trust test root certificate. |
0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). |
This functionality is currently not available when the provider is OpenSSL.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----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-----
When specified the class will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the class fails with an error.
The format of this value is a comma-separated list of hash-signature combinations. For instance:
component.SSLProvider = TCPClientSSLProviders.sslpInternal;
component.Config("SSLEnabledProtocols=3072"); //TLS 1.2
component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");
The default value for this configuration setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.
To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.
When using TLS 1.2 and ssl_provider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting.
Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group.
In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so.
The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448"
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1"
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096"
- "ffdhe_6144"
- "ffdhe_8192"
- "ed25519" (default)
- "ed448" (default)
- "ecdsa_secp256r1_sha256" (default)
- "ecdsa_secp384r1_sha384" (default)
- "ecdsa_secp521r1_sha512" (default)
- "rsa_pkcs1_sha256" (default)
- "rsa_pkcs1_sha384" (default)
- "rsa_pkcs1_sha512" (default)
- "rsa_pss_sha256" (default)
- "rsa_pss_sha384" (default)
- "rsa_pss_sha512" (default)
The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448" (default)
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096" (default)
- "ffdhe_6144" (default)
- "ffdhe_8192" (default)
Socket Config Settings
Note: This option is not valid for User Datagram Protocol (UDP) ports.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Base Config Settings
The following is a list of valid code page identifiers:
Identifier | Name |
037 | IBM EBCDIC - U.S./Canada |
437 | OEM - United States |
500 | IBM EBCDIC - International |
708 | Arabic - ASMO 708 |
709 | Arabic - ASMO 449+, BCON V4 |
710 | Arabic - Transparent Arabic |
720 | Arabic - Transparent ASMO |
737 | OEM - Greek (formerly 437G) |
775 | OEM - Baltic |
850 | OEM - Multilingual Latin I |
852 | OEM - Latin II |
855 | OEM - Cyrillic (primarily Russian) |
857 | OEM - Turkish |
858 | OEM - Multilingual Latin I + Euro symbol |
860 | OEM - Portuguese |
861 | OEM - Icelandic |
862 | OEM - Hebrew |
863 | OEM - Canadian-French |
864 | OEM - Arabic |
865 | OEM - Nordic |
866 | OEM - Russian |
869 | OEM - Modern Greek |
870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
875 | IBM EBCDIC - Modern Greek |
932 | ANSI/OEM - Japanese, Shift-JIS |
936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
949 | ANSI/OEM - Korean (Unified Hangul Code) |
950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
1026 | IBM EBCDIC - Turkish (Latin-5) |
1047 | IBM EBCDIC - Latin 1/Open System |
1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
1147 | IBM EBCDIC - France (20297 + Euro symbol) |
1148 | IBM EBCDIC - International (500 + Euro symbol) |
1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
1201 | Unicode UCS-2 Big-Endian |
1250 | ANSI - Central European |
1251 | ANSI - Cyrillic |
1252 | ANSI - Latin I |
1253 | ANSI - Greek |
1254 | ANSI - Turkish |
1255 | ANSI - Hebrew |
1256 | ANSI - Arabic |
1257 | ANSI - Baltic |
1258 | ANSI/OEM - Vietnamese |
1361 | Korean (Johab) |
10000 | MAC - Roman |
10001 | MAC - Japanese |
10002 | MAC - Traditional Chinese (Big5) |
10003 | MAC - Korean |
10004 | MAC - Arabic |
10005 | MAC - Hebrew |
10006 | MAC - Greek I |
10007 | MAC - Cyrillic |
10008 | MAC - Simplified Chinese (GB 2312) |
10010 | MAC - Romania |
10017 | MAC - Ukraine |
10021 | MAC - Thai |
10029 | MAC - Latin II |
10079 | MAC - Icelandic |
10081 | MAC - Turkish |
10082 | MAC - Croatia |
12000 | Unicode UCS-4 Little-Endian |
12001 | Unicode UCS-4 Big-Endian |
20000 | CNS - Taiwan |
20001 | TCA - Taiwan |
20002 | Eten - Taiwan |
20003 | IBM5550 - Taiwan |
20004 | TeleText - Taiwan |
20005 | Wang - Taiwan |
20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
20106 | IA5 German (7-bit) |
20107 | IA5 Swedish (7-bit) |
20108 | IA5 Norwegian (7-bit) |
20127 | US-ASCII (7-bit) |
20261 | T.61 |
20269 | ISO 6937 Non-Spacing Accent |
20273 | IBM EBCDIC - Germany |
20277 | IBM EBCDIC - Denmark/Norway |
20278 | IBM EBCDIC - Finland/Sweden |
20280 | IBM EBCDIC - Italy |
20284 | IBM EBCDIC - Latin America/Spain |
20285 | IBM EBCDIC - United Kingdom |
20290 | IBM EBCDIC - Japanese Katakana Extended |
20297 | IBM EBCDIC - France |
20420 | IBM EBCDIC - Arabic |
20423 | IBM EBCDIC - Greek |
20424 | IBM EBCDIC - Hebrew |
20833 | IBM EBCDIC - Korean Extended |
20838 | IBM EBCDIC - Thai |
20866 | Russian - KOI8-R |
20871 | IBM EBCDIC - Icelandic |
20880 | IBM EBCDIC - Cyrillic (Russian) |
20905 | IBM EBCDIC - Turkish |
20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
20932 | JIS X 0208-1990 & 0121-1990 |
20936 | Simplified Chinese (GB2312) |
21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
21027 | Extended Alpha Lowercase |
21866 | Ukrainian (KOI8-U) |
28591 | ISO 8859-1 Latin I |
28592 | ISO 8859-2 Central Europe |
28593 | ISO 8859-3 Latin 3 |
28594 | ISO 8859-4 Baltic |
28595 | ISO 8859-5 Cyrillic |
28596 | ISO 8859-6 Arabic |
28597 | ISO 8859-7 Greek |
28598 | ISO 8859-8 Hebrew |
28599 | ISO 8859-9 Latin 5 |
28605 | ISO 8859-15 Latin 9 |
29001 | Europa 3 |
38598 | ISO 8859-8 Hebrew |
50220 | ISO 2022 Japanese with no halfwidth Katakana |
50221 | ISO 2022 Japanese with halfwidth Katakana |
50222 | ISO 2022 Japanese JIS X 0201-1989 |
50225 | ISO 2022 Korean |
50227 | ISO 2022 Simplified Chinese |
50229 | ISO 2022 Traditional Chinese |
50930 | Japanese (Katakana) Extended |
50931 | US/Canada and Japanese |
50933 | Korean Extended and Korean |
50935 | Simplified Chinese Extended and Simplified Chinese |
50936 | Simplified Chinese |
50937 | US/Canada and Traditional Chinese |
50939 | Japanese (Latin) Extended and Japanese |
51932 | EUC - Japanese |
51936 | EUC - Simplified Chinese |
51949 | EUC - Korean |
51950 | EUC - Traditional Chinese |
52936 | HZ-GB2312 Simplified Chinese |
54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
57002 | ISCII Devanagari |
57003 | ISCII Bengali |
57004 | ISCII Tamil |
57005 | ISCII Telugu |
57006 | ISCII Assamese |
57007 | ISCII Oriya |
57008 | ISCII Kannada |
57009 | ISCII Malayalam |
57010 | ISCII Gujarati |
57011 | ISCII Punjabi |
65000 | Unicode UTF-7 |
65001 | Unicode UTF-8 |
Identifier | Name |
1 | ASCII |
2 | NEXTSTEP |
3 | JapaneseEUC |
4 | UTF8 |
5 | ISOLatin1 |
6 | Symbol |
7 | NonLossyASCII |
8 | ShiftJIS |
9 | ISOLatin2 |
10 | Unicode |
11 | WindowsCP1251 |
12 | WindowsCP1252 |
13 | WindowsCP1253 |
14 | WindowsCP1254 |
15 | WindowsCP1250 |
21 | ISO2022JP |
30 | MacOSRoman |
10 | UTF16String |
0x90000100 | UTF16BigEndian |
0x94000100 | UTF16LittleEndian |
0x8c000100 | UTF32String |
0x98000100 | UTF32BigEndian |
0x9c000100 | UTF32LittleEndian |
65536 | Proprietary |
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
Setting this configuration setting to True tells the class to use the internal implementation instead of using the system security libraries.
On Windows, this setting is set to False by default. On Linux/macOS, this setting is set to True by default.
To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.
IMAP Errors
IMAP Errors
118 | Firewall error. Error message contains detailed description. |
311 | Protocol error. |
312 | Busy executing current method. |
314 | A mailbox must be selected before calling this method. |
315 | Invalid argument. Please specify a valid message_set. |
317 | Unknown content encoding. |
318 | LocalFile already exists and overwrite is False. |
The class may also return one of the following error codes, which are inherited from other classes.
TCPClient Errors
100 | You cannot change the remote_port at this time. A connection is in progress. |
101 | You cannot change the remote_host (Server) at this time. A connection is in progress. |
102 | The remote_host address is invalid (0.0.0.0). |
104 | Already connected. If you want to reconnect, close the current connection first. |
106 | You cannot change the local_port at this time. A connection is in progress. |
107 | You cannot change the local_host at this time. A connection is in progress. |
112 | You cannot change MaxLineLength at this time. A connection is in progress. |
116 | remote_port cannot be zero. Please specify a valid service port number. |
117 | You cannot change the UseConnection option while the class is active. |
135 | Operation would block. |
201 | Timeout. |
211 | Action impossible in control's present state. |
212 | Action impossible while not connected. |
213 | Action impossible while listening. |
301 | Timeout. |
302 | Could not open file. |
434 | Unable to convert string to selected CodePage. |
1105 | Already connecting. If you want to reconnect, close the current connection first. |
1117 | You need to connect first. |
1119 | You cannot change the LocalHost at this time. A connection is in progress. |
1120 | Connection dropped by remote host. |
SSL Errors
270 | Cannot load specified security library. |
271 | Cannot open certificate store. |
272 | Cannot find specified certificate. |
273 | Cannot acquire security credentials. |
274 | Cannot find certificate chain. |
275 | Cannot verify certificate chain. |
276 | Error during handshake. |
280 | Error verifying certificate. |
281 | Could not find client certificate. |
282 | Could not find server certificate. |
283 | Error encrypting data. |
284 | Error decrypting data. |
TCP/IP Errors
10004 | [10004] Interrupted system call. |
10009 | [10009] Bad file number. |
10013 | [10013] Access denied. |
10014 | [10014] Bad address. |
10022 | [10022] Invalid argument. |
10024 | [10024] Too many open files. |
10035 | [10035] Operation would block. |
10036 | [10036] Operation now in progress. |
10037 | [10037] Operation already in progress. |
10038 | [10038] Socket operation on nonsocket. |
10039 | [10039] Destination address required. |
10040 | [10040] Message is too long. |
10041 | [10041] Protocol wrong type for socket. |
10042 | [10042] Bad protocol option. |
10043 | [10043] Protocol is not supported. |
10044 | [10044] Socket type is not supported. |
10045 | [10045] Operation is not supported on socket. |
10046 | [10046] Protocol family is not supported. |
10047 | [10047] Address family is not supported by protocol family. |
10048 | [10048] Address already in use. |
10049 | [10049] Cannot assign requested address. |
10050 | [10050] Network is down. |
10051 | [10051] Network is unreachable. |
10052 | [10052] Net dropped connection or reset. |
10053 | [10053] Software caused connection abort. |
10054 | [10054] Connection reset by peer. |
10055 | [10055] No buffer space available. |
10056 | [10056] Socket is already connected. |
10057 | [10057] Socket is not connected. |
10058 | [10058] Cannot send after socket shutdown. |
10059 | [10059] Too many references, cannot splice. |
10060 | [10060] Connection timed out. |
10061 | [10061] Connection refused. |
10062 | [10062] Too many levels of symbolic links. |
10063 | [10063] File name is too long. |
10064 | [10064] Host is down. |
10065 | [10065] No route to host. |
10066 | [10066] Directory is not empty |
10067 | [10067] Too many processes. |
10068 | [10068] Too many users. |
10069 | [10069] Disc Quota Exceeded. |
10070 | [10070] Stale NFS file handle. |
10071 | [10071] Too many levels of remote in path. |
10091 | [10091] Network subsystem is unavailable. |
10092 | [10092] WINSOCK DLL Version out of range. |
10093 | [10093] Winsock is not loaded yet. |
11001 | [11001] Host not found. |
11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). |
11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. |
11004 | [11004] Valid name, no data record (check DNS setup). |