SPOP Class

Properties   Methods   Events   Config Settings   Errors  

The SPOP Class is used to easily retrieve electronic mail from internet post office servers (POP).

Syntax

class ipworkssmime.SPOP

Remarks

The SPOP Class is the S/MIME-enabled equivalent of the IPWorks POP Class. In addition to standard POP functions, the SPOP class can decrypt and verify message signatures. The methods and properties for decrypting and verifying signatures are identical to those provided with the S/MIME Class. When attempting to verify a signed message or when decrypting a message call, the decrypt, verify_signature, or decrypt_and_verify_signature methods and the resulting text will be replaced in message.

The SPOP Class implements a standard internet post office (POP3) client as specified in RFC 1725.

To connect to a mail_server, first set the appropriate user and password and then connect by calling the connect method. Upon successful connection to the mail_server, the number of waiting messages is shown by the message_count property. A message is selected by setting the message_number property to a number between 1 and message_count (inclusive). Then, the message text and headers are received by calling the retrieve method.

The message text is received through the on_transfer event, whereas the message headers are received through the on_header event. Additionally, up to max_lines from the message body are provided in the message_text property. The body of the message is also saved in the file specified by the local_file property. on_start_transfer and on_end_transfer events are fired at the beginning and end of message transmission. The on_pi_trail event provides a trace of the interaction between the client and server (excluding message transfers).

Property List

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

Method List

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

Event List

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

Config Settings

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

auth_mechanism Property

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

Syntax

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

auth_mechanism = property(get_auth_mechanism, set_auth_mechanism)

Default Value

0

Remarks

This property is used as the authentication mechanism when connecting to the mail server. By default, this property is amUserPassword (0), and default plaintext authentication is used to log in to the server. Other, more secure, options include amCRAMMD5 (1) for CRAM-MD5, amNTLM (2) for NTLM authentication, amAPOP (3) for APOP authentication, and amSASLDigestMD5 (5) for SASL DIGEST-MD5 authentication.

amSASLPlain (4) is also available, but most servers require a Secure Sockets Layer (SSL) connection when utilizing this authentication mechanism.

amKerberos (6) is for Kerberos authentication. Note: This functionality is available only in Windows.

cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_cert_encoded() -> bytes: ...
def set_cert_encoded(value: bytes) -> None: ...

cert_encoded = property(get_cert_encoded, set_cert_encoded)

Default Value

""

Remarks

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

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

cert_store Property

This is the name of the certificate store for the client certificate.

Syntax

def get_cert_store() -> bytes: ...
def set_cert_store(value: bytes) -> None: ...

cert_store = property(get_cert_store, set_cert_store)

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The cert_store_type property denotes the type of the certificate store specified by cert_store. If the store is password protected, specify the password in cert_store_password.

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

Designations of certificate stores are platform dependent.

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

When the certificate store type is 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).

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_cert_store_password() -> str: ...
def set_cert_store_password(value: str) -> None: ...

cert_store_password = property(get_cert_store_password, set_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.

cert_store_type Property

This is the type of certificate store for this certificate.

Syntax

def get_cert_store_type() -> int: ...
def set_cert_store_type(value: int) -> None: ...

cert_store_type = property(get_cert_store_type, set_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:

cert_subject Property

This is the subject of the certificate used for client authentication.

Syntax

def get_cert_subject() -> str: ...
def set_cert_subject(value: str) -> None: ...

cert_subject = property(get_cert_subject, set_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:

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

command Property

This property is used to send additional commands directly to the server.

Syntax

def set_command(value: str) -> None: ...

command = property(None, set_command)

Default Value

""

Remarks

This property can be used to send additional commands directly to the server. Check the last_reply property or trap the on_pi_trail events coming from the server to get the response.

This property is write-only.

connected Property

This shows whether the class is connected.

Syntax

def get_connected() -> bool: ...
def set_connected(value: bool) -> None: ...

connected = property(get_connected, set_connected)

Default Value

FALSE

Remarks

This property is used to determine whether or not the class is connected to the remote host.

Note: It is recommended to use the connect or disconnect method instead of setting this property.

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:

firewall_host Property

This property contains the name or IP address of 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 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 user name if authentication is to be used 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 user name if authentication is to be used connecting through a firewall. If the firewall_host is specified, this property and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

idle Property

The current status of the class.

Syntax

def get_idle() -> bool: ...

idle = property(get_idle, None)

Default Value

TRUE

Remarks

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

This property is read-only.

include_headers Property

This property instructs the class to include the headers in the MessageText and LocalFile.

Syntax

def get_include_headers() -> bool: ...
def set_include_headers(value: bool) -> None: ...

include_headers = property(get_include_headers, set_include_headers)

Default Value

FALSE

Remarks

This property instructs the component to include the headers in the MessageText and LocalFile. If set to True, the headers for the message being retrieved will be placed before the message body in the message_text property;. If local_file is set, then the headers will be written to that file before the message body. In this manner, the whole content of a MIME-encoded message can be passed to the MIME class for further message processing.

last_reply Property

The last reply 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 can also be retrieved through the on_pi_trail event.

This property is read-only.

local_host Property

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

Syntax

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

local_host = property(get_local_host, set_local_host)

Default Value

""

Remarks

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 multi-homed 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 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 multi-homed 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.

mail_port Property

This property includes the server port for POP (default 110).

Syntax

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

mail_port = property(get_mail_port, set_mail_port)

Default Value

110

Remarks

This property contains the server port for POP (default 110). 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 implicit Secure Sockets Layer (SSL), use port 995 (please refer to the ssl_start_mode property for more information).

mail_server Property

This property includes the name or address of a mail server (internet post office 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 the domain name of the mail server. It is 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, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

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.

max_lines Property

This property includes the maximum number of message lines other than headers to retrieve.

Syntax

def get_max_lines() -> int: ...
def set_max_lines(value: int) -> None: ...

max_lines = property(get_max_lines, set_max_lines)

Default Value

0

Remarks

This property is used to limit the number of text lines other than headers retrieved for messages. It can be used to preview message headers and a portion of their contents, without incurring the overhead of downloading the entire message.

The default value of the property is 0. In this case, the entire message will be retrieved, without interruptions. Note: If you are not retrieving the entire message (max_lines is nonzero), no data will be written to local_file.

message Property

This property provides the raw message content.

Syntax

def get_message() -> bytes: ...

message = property(get_message, None)

Default Value

""

Remarks

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

This property is read-only.

message_cc Property

This property includes the value of the CC header of the last retrieved message.

Syntax

def get_message_cc() -> str: ...

message_cc = property(get_message_cc, None)

Default Value

""

Remarks

This property contains the value of the CC header of the last retrieved message. The same information also may be retrieved through the on_header event.

This property is read-only.

message_count Property

This property includes the number of messages in the mailbox.

Syntax

def get_message_count() -> int: ...

message_count = property(get_message_count, None)

Default Value

0

Remarks

This property contains the number of messages in the mailbox. When the class is not connected to the server, the value of this property is 0. When connected, it contains the number of messages in the mailbox as reported by the POP server.

This property is read-only.

message_date Property

This property includes the value of the date header of the last retrieved message.

Syntax

def get_message_date() -> str: ...

message_date = property(get_message_date, None)

Default Value

""

Remarks

This property contains the value of the date header of the last retrieved message. The same information also may be retrieved through the on_header event.

This property is read-only.

message_encrypted Property

This property specifies whether or not the current message is encrypted.

Syntax

def get_message_encrypted() -> bool: ...

message_encrypted = property(get_message_encrypted, None)

Default Value

FALSE

Remarks

This property indicates whether or not the current message is encrypted. This property will return True if the current message appears to be encrypted, according to the value of message_headers.

This property is read-only.

message_from Property

This property includes the value of the from header of the last retrieved message.

Syntax

def get_message_from() -> str: ...

message_from = property(get_message_from, None)

Default Value

""

Remarks

This property contains the value of the from header of the last retrieved message. The same information also may be retrieved through the on_header event.

This property is read-only.

message_header_count Property

The number of records in the MessageHeader arrays.

Syntax

def get_message_header_count() -> int: ...

message_header_count = property(get_message_header_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• message_header_field
• message_header_value

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

This property is read-only.

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

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.

This property is read-only.

message_header_value Property

This property contains the header contents.

Syntax

def get_message_header_value(message_header_index: int) -> str: ...

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.

This property is read-only.

message_headers_string Property

This property includes a string representation of the full headers of the message as retrieved from the server.

Syntax

def get_message_headers_string() -> str: ...

message_headers_string = property(get_message_headers_string, None)

Default Value

""

Remarks

This property contains a string representation of the full headers of the message as retrieved from the server. If the class is not connected, or message_number does not contain a valid message number, the value of this property is an empty string. Otherwise, it contains the full headers of the mail message as reported by the server.

The mail_server is asked about the headers of the message only if the message_number property has changed. If message_number has not changed, the class returns a cached value.

Example. Connect and Retrieve Messages:

POPControl.MailServer = "MyPOPServer" POPControl.User = "username" POPControl.Password = "password" POPControl.Connect() POPControl.MessageNumber = 1 MessageText = POPControl.MessageText MessageHeadersString = POPControl.MessageHeadersString

This property is read-only.

message_number Property

This property includes the current (selected) message.

Syntax

def get_message_number() -> int: ...
def set_message_number(value: int) -> None: ...

message_number = property(get_message_number, set_message_number)

Default Value

1

Remarks

This property indicates the current (selected) message. This property specifies a message number in between 1 and message_count. The various class methods related to single messages use this property as a message pointer (see method descriptions and the message_size property).

message_recipient_count Property

The number of records in the MessageRecipient arrays.

Syntax

def get_message_recipient_count() -> int: ...

message_recipient_count = property(get_message_recipient_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• message_recipient_address
• message_recipient_name
• message_recipient_options
• message_recipient_type

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

This property is read-only.

message_recipient_address Property

This property contains the email address of the recipient.

Syntax

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

Default Value

""

Remarks

This property contains the email address of the recipient.

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

This property is read-only.

message_recipient_name Property

This property contains the name of the recipient.

Syntax

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

Default Value

""

Remarks

This property contains the name of the recipient.

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

This property is read-only.

message_recipient_options Property

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

Syntax

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

Default Value

""

Remarks

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

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

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

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

This property is read-only.

message_recipient_type Property

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

Syntax

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

Default Value

0

Remarks

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

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

This property is read-only.

message_reply_to Property

This property includes the value of the Reply-To header of the last retrieved message.

Syntax

def get_message_reply_to() -> str: ...

message_reply_to = property(get_message_reply_to, None)

Default Value

""

Remarks

This property contains the value of the Reply-To header of the last retrieved message. The same information also may be retrieved through the on_header event.

This property is read-only.

message_signed Property

This property specifies whether or not the current message is signed.

Syntax

def get_message_signed() -> bool: ...

message_signed = property(get_message_signed, None)

Default Value

FALSE

Remarks

This property indicates whether or not the current message is signed. This property will return True if the current message appears to be signed, according to the value of message_headers.

Note: A message that is both signed and encrypted will not appear to be signed until after it is decrypted.

This property is read-only.

message_size Property

This property includes the size in bytes of the current message.

Syntax

def get_message_size() -> int: ...

message_size = property(get_message_size, None)

Default Value

0

Remarks

This property contains the size in bytes of the current message. If the class is not connected, or message_number does not contain a valid message number, the value of this property is 0. Otherwise, it contains the size of the mail message (including headers) as reported by the server.

The mail_server is asked about the size of the message only if the message_number property has changed. If message_number has not changed, the class returns a cached value.

This property is read-only.

message_subject Property

This property includes the value of the Subject header of the last retrieved message.

Syntax

def get_message_subject() -> str: ...

message_subject = property(get_message_subject, None)

Default Value

""

Remarks

This property contains the value of the Subject header of the last retrieved message. The same information also may be retrieved through the on_header event.

This property is read-only.

message_text Property

This property includes the full text of the message as retrieved from the server.

Syntax

def get_message_text() -> str: ...

message_text = property(get_message_text, None)

Default Value

""

Remarks

This property contains the full text of the message as retrieved from the server. If the class is not connected, or message_number does not contain a valid message number, the value of this property is an empty string. Otherwise, it contains the text of the mail message as reported by the server (a maximum of max_lines).

The mail_server is asked about the text of the message only if the message_number property has changed. If message_number has not changed, the class returns a cached value.

Example. Connect and Retrieve Messages:

POPControl.MailServer = "MyPOPServer" POPControl.User = "username" POPControl.Password = "password" POPControl.Connect() POPControl.MessageNumber = 1 MessageText = POPControl.MessageText MessageHeaders = POPControl.MessageHeaders

This property is read-only.

message_to Property

This property includes the value of the To header of the last retrieved message.

Syntax

def get_message_to() -> str: ...

message_to = property(get_message_to, None)

Default Value

""

Remarks

This property contains the value of the To header of the last retrieved message. The same information also may be retrieved through the on_header event.

This property is read-only.

message_uid Property

This property includes the unique identifier of the message as specified by the server.

Syntax

def get_message_uid() -> str: ...

message_uid = property(get_message_uid, None)

Default Value

""

Remarks

This property contains the unique identifier of the message as specified by the server. If the class is not connected, or message_number does not contain a valid message number, the value of this property is an empty string. Otherwise, it contains the UID of the mail message as reported by the server.

The mail_server is asked about the UID of the message only if the message_number property has changed. If message_number has not changed, the class returns a cached value.

This property is read-only.

password Property

This property includes the password for the mailbox user.

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 for the mailbox user. This property must be set before the class connects to the mail_server.

signer_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_signer_cert_encoded() -> bytes: ...
def set_signer_cert_encoded(value: bytes) -> None: ...

signer_cert_encoded = property(get_signer_cert_encoded, set_signer_cert_encoded)

Default Value

""

Remarks

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

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

signer_cert_issuer Property

This is the issuer of the certificate.

Syntax

def get_signer_cert_issuer() -> str: ...

signer_cert_issuer = property(get_signer_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.

signer_cert_serial_number Property

This is the serial number of the certificate encoded as a string.

Syntax

def get_signer_cert_serial_number() -> str: ...

signer_cert_serial_number = property(get_signer_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.

signer_cert_store Property

This is the name of the certificate store for the client certificate.

Syntax

def get_signer_cert_store() -> bytes: ...
def set_signer_cert_store(value: bytes) -> None: ...

signer_cert_store = property(get_signer_cert_store, set_signer_cert_store)

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The signer_cert_store_type property denotes the type of the certificate store specified by signer_cert_store. If the store is password protected, specify the password in signer_cert_store_password.

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

Designations of certificate stores are platform dependent.

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

When the certificate store type is 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).

signer_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_signer_cert_store_password() -> str: ...
def set_signer_cert_store_password(value: str) -> None: ...

signer_cert_store_password = property(get_signer_cert_store_password, set_signer_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.

signer_cert_store_type Property

This is the type of certificate store for this certificate.

Syntax

def get_signer_cert_store_type() -> int: ...
def set_signer_cert_store_type(value: int) -> None: ...

signer_cert_store_type = property(get_signer_cert_store_type, set_signer_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:

signer_cert_subject Property

This is the subject of the certificate used for client authentication.

Syntax

def get_signer_cert_subject() -> str: ...
def set_signer_cert_subject(value: str) -> None: ...

signer_cert_subject = property(get_signer_cert_subject, set_signer_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:

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

signer_cert_chain_count Property

The number of records in the SignerCertChain arrays.

Syntax

def get_signer_cert_chain_count() -> int: ...

signer_cert_chain_count = property(get_signer_cert_chain_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• signer_cert_chain_encoded

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

This property is read-only.

signer_cert_chain_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_signer_cert_chain_encoded(signer_cert_chain_index: int) -> bytes: ...

Default Value

""

Remarks

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

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

The signer_cert_chain_index parameter specifies the index of the item in the array. The size of the array is controlled by the signer_cert_chain_count property.

This property is read-only.

signing_algorithm Property

This property includes a textual description of the signature hash algorithm.

Syntax

def get_signing_algorithm() -> str: ...
def set_signing_algorithm(value: str) -> None: ...

signing_algorithm = property(get_signing_algorithm, set_signing_algorithm)

Default Value

"SHA256"

Remarks

This property specifies the hash algorithm used to prepare the message digest for signature.

This property must contain either the name of the algorithm (such as MD5 or SHA1), or an object Id (OID) string representing the hash algorithm. Possible values are as follows:

• sha1
• md5
• sha-256 (default)
• sha-384
• sha-512
• sha-224

When read, the value of the property always contains the OID of the algorithm, or an empty string if the algorithm is unknown.

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

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:

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:

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

ssl_enabled Property

Whether 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 setting 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 specifies the 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:

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

Determines how the class starts the 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:

timeout Property

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

Please note that by default, all timeouts are inactivity timeouts, i.e. 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.

total_size Property

This property includes cumulative size in bytes of messages in the mailbox (including headers).

Syntax

def get_total_size() -> int: ...

total_size = property(get_total_size, None)

Default Value

0

Remarks

This property contains the cumulative size in bytes of messages in the mailbox (including headers). When the class is not connected to the server, the value of this property is 0. When connected, it contains the cumulative size of all the messages in the mail box as reported by the POP server.

This property is read-only.

user Property

This property includes the user identifier for the mailbox.

Syntax

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

user = property(get_user, set_user)

Default Value

""

Remarks

This property contains the user identifier for the mailbox. This property must be set before the class connects to the mail_server.

check_message_encrypted Method

This method checks whether or not the current message is encrypted.

Syntax

def check_message_encrypted() -> bool: ...

Remarks

This method is used to check whether or not the current message is encrypted. This method will return True, if the current message appears to be encrypted, according to the value of output_message_headers.

check_message_signed Method

This method checks whether or not the current message is signed.

Syntax

def check_message_signed() -> bool: ...

Remarks

This method is used to check whether or not the current message is signed. This method will return True, if the current message appears to be signed, according to the value of output_message_headers.

Note: A message that is both signed and encrypted will not appear to be signed until after it is decrypted.

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 the mail server and attempts to log in.

Syntax

def connect() -> None: ...

Remarks

This method connects to the mail server and attempts to log in using the current user and password. Then it retrieves the initial statistics about the mailbox contents (message_count and total_size).

Example. Connect to POP Mailbox:

POPControl.MailServer = "MyPOPServer" POPControl.User = "username" POPControl.Password = "password" POPControl.Connect() POPControl.MessageNumber = 1 POPControl.Retrieve() MessageText = POPControl.MessageText MessageHeaders = POPControl.MessageHeaders

decrypt Method

This method decrypts the current Message .

Syntax

def decrypt() -> None: ...

Remarks

This method attempts to decrypt the encrypted message using the certificate in certificate.

decrypt_and_verify_signature Method

This method decrypts and verifies the signature of the current message.

Syntax

def decrypt_and_verify_signature() -> None: ...

Remarks

This method attempts to both decrypt and verify the signature of the message. All of the properties affected by calling the decrypt and verify_signature methods are affected in the same manner.

Note: This function does not attempt to check the validity of the signing certificate.

delete Method

This method deletes a message specified by MessageNumber on the server.

Syntax

def delete() -> None: ...

Remarks

This method asks the mail_server to delete the message specified by message_number. The message will not actually be deleted from the server until the connection is closed. To cancel a previous Delete, use the reset method.

disconnect Method

This method disconnects from the mail server.

Syntax

def disconnect() -> None: ...

Remarks

This method makes the class disconnect from the mail_server by sending the QUIT command. If successful, all changes to the mailbox are committed by the server. Otherwise, changes are rolled back to the initial state that the server was in before the connection.

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

interrupt Method

Interrupt the current method.

Syntax

def interrupt() -> None: ...

Remarks

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

list_message_sizes Method

This method retrieves a list of all message sizes from the server.

Syntax

def list_message_sizes() -> None: ...

Remarks

This message retrieves a list of all message sizes from the server. For each message listed, a on_message_list event will fire containing the number and size of the message.

list_message_ui_ds Method

This method retrieves a list of all message UIDs from the server.

Syntax

def list_message_ui_ds() -> None: ...

Remarks

This method retrieves a list of all message UIDs from the server. For each message listed, a on_message_list event will fire containing the number and UID of the message.

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

query_message_size Method

This method returns the size in bytes of the current message.

Syntax

def query_message_size() -> int: ...

Remarks

This method queries the server for the size in bytes of the message specified by message_number. The method returns the size (in bytes) of the message.

If the class is not connected, or message_number does not contain a valid message number, the return value is 0. Otherwise, it returns the size of the mail message (including headers) as reported by the server.

The mail_server is asked about the size of the message only if the message_number property has changed. If message_number has not changed, the class returns a cached value.

query_message_uid Method

This method returns the unique identifier (UID) of the message as specified by the server.

Syntax

def query_message_uid() -> str: ...

Remarks

This method returns the unique identifier (UID) of the message specified by message_number. If the class is not connected, or message_number does not contain a valid message number, the return value of this method is an empty string. Otherwise, it returns the UID of the mail message as reported by the server.

The mail_server is asked about the UID of the message only if the message_number property has changed. If message_number has not changed, the class returns a cached value.

query_total_size Method

This method returns the cumulative size in bytes of messages in the mailbox (including headers).

Syntax

def query_total_size() -> int: ...

Remarks

This method returns the cumulative size in bytes of messages in the mailbox (including headers). When the class is not connected to the server, the return value of this method is 0. When connected, it returns the cumulative size of all the messages in the mail box as reported by the POP server.

reset Method

This method resets all changes and revert back to the state when the user first connected.

Syntax

def reset() -> None: ...

Remarks

This method is used to reset all changes and revert back to the state when the user first connected. Asks the mail_server to reset all changes and revert back to the state it was when connected.

retrieve Method

This method retrieves a message specified by MessageNumber from the server.

Syntax

def retrieve() -> None: ...

Remarks

This method is used to retrieve a message specified by message_number from the server. It asks the mail_server to retrieve the message specified by message_number. The message headers will arrive in the on_header event, and the message text will arrive in the on_transfer event.

The max_lines property defines the number of lines retrieved.

Example. Connect and Retrieve Messages:

POPControl.MailServer = "MyPOPServer" POPControl.User = "username" POPControl.Password = "password" POPControl.Connect() POPControl.MessageNumber = 1 POPControl.Retrieve()

retrieve_headers Method

This method retrieves headers for a message specified by MessageNumber .

Syntax

def retrieve_headers() -> None: ...

Remarks

Calling this method will retrieve the headers for the message specified by the message_number property. The message headers will be provided by the on_header event and also stored in the message_headers property.

Example. Connect and Retrieve Message Headers:

POPControl.MailServer = "MyPOPServer" POPControl.User = "username" POPControl.Password = "password" POPControl.Connect() POPControl.MessageNumber = 1 POPControl.RetrieveHeaders()

send_command 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 and/or monitor the on_pi_trail event to obtain the server's response.

verify_signature Method

This method verifies the signature of the current message.

Syntax

def verify_signature() -> None: ...

Remarks

This method attempts to verify the signature of the input message. If the message does not have a certificate attached, the class will attempt to verify the signature using the certificate supplied in signer_cert (if any). If no certificate is found, the class fails with an error.

If this method is successful, the signer_cert property will contain the certificate information of the message signer.

Note: This function does not attempt to check the validity of the signing certificate.

on_connection_status Event

This event is fired to indicate changes in the connection state.

Syntax

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

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

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

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

on_end_transfer Event

This event is fired when the message completes transferring.

Syntax

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

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

Remarks

The on_end_transfer event is fired when the message body 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

Information about errors during data delivery.

Syntax

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

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

# In class SPOP:
@property
def on_error() -> Callable[[SPOPErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[SPOPErrorEventParams], 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 for every message header being retrieved.

Syntax

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

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

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

Remarks

The Field parameter contains the name of the 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_message_list Event

This event is fired for every message listed by ListMessageSizes and/or ListMessageUIDs .

Syntax

class SPOPMessageListEventParams(object):
  @property
  def message_number() -> int: ...

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

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

# In class SPOP:
@property
def on_message_list() -> Callable[[SPOPMessageListEventParams], None]: ...
@on_message_list.setter
def on_message_list(event_hook: Callable[[SPOPMessageListEventParams], None]) -> None: ...

Remarks

When list_message_sizes is called, MessageSize is valid, and MessageUID is always an empty string.

When list_message_ui_ds is called, MessageUID is valid, and MessageSize is 0.

on_pi_trail Event

Traces the commands sent to the mail server, and the respective replies.

Syntax

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

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

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

Remarks

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

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

on_ssl_server_authentication Event

Fired after the server presents its certificate to the client.

Syntax

class SPOPSSLServerAuthenticationEventParams(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 SPOP:
@property
def on_ssl_server_authentication() -> Callable[[SPOPSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[SPOPSSLServerAuthenticationEventParams], 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

Shows the progress of the secure connection.

Syntax

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

# In class SPOP:
@property
def on_ssl_status() -> Callable[[SPOPSSLStatusEventParams], None]: ...
@on_ssl_status.setter
def on_ssl_status(event_hook: Callable[[SPOPSSLStatusEventParams], 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 starts transferring.

Syntax

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

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

Remarks

The on_start_transfer event is fired when the message body starts 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_transfer Event

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

Syntax

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

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

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

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

  @property
  def eol() -> bool: ...

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

Remarks

The Text parameter contains the portion of the message data to be 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. For complete lines, there is no terminating newline at the end of the Text parameter, and EOL is True. The EOL parameter is False when a line is broken (usually for being too long).

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

Note: For the PercentDone parameter value to be correct, the GetMessageSize configuration setting must be set to True.

SPOP Config Settings

POP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

Socket Config Settings

Base Config Settings

SPOP Errors

POP Errors

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

TCPClient Errors

SSL Errors

TCP/IP Errors