IPWorks S/MIME 2020 Python Edition

Questions / Feedback?

SPOP Class

Properties   Methods   Events   Configuration 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/or 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, message text and/or 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.

auth_mechanismThe authentication mechanism to be used when connecting to the mail server.
cert_encodedThe certificate (PEM/base64 encoded).
cert_storeThe name of the certificate store for the client certificate.
cert_store_passwordIf the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
cert_store_typeThe type of certificate store for this certificate.
cert_subjectThe subject of the certificate used for client authentication.
commandUsed to send additional commands directly to the server.
connectedShows whether the class is connected.
firewall_auto_detectThis property tells the class whether or not to automatically detect and use firewall system settings, if available.
firewall_typeThis property determines the type of firewall to connect through.
firewall_hostThis property contains the name or IP address of firewall (optional).
firewall_passwordThis property contains a password if authentication is to be used when connecting through the firewall.
firewall_portThis property contains the TCP port for the firewall Host .
firewall_userThis property contains a user name if authentication is to be used connecting through a firewall.
idleThe current status of the class.
include_headersInstructs the class to include the headers in the MessageText and LocalFile.
last_replyThe last reply from the server.
local_hostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
mail_portThe server port for POP (default 110).
mail_serverThe name or address of a mail server (internet post office server).
max_linesThe maximum number of message lines besides headers to retrieve.
messageProvides the raw message content.
message_ccThe value of the CC header of the last retrieved message.
message_countThe number of messages in the mailbox.
message_dateThe value of the date header of the last retrieved message.
message_encryptedWhether or not the current message is encrypted.
message_fromThe value of the from header of the last retrieved message.
message_header_countThe number of records in the MessageHeader arrays.
message_header_fieldThis property contains the name of the HTTP header (same case as it is delivered).
message_header_valueThis property contains the header contents.
message_headers_stringA string representation of the full headers of the message as retrieved from the server.
message_numberCurrent (selected) message.
message_recipient_countThe number of records in the MessageRecipient arrays.
message_recipient_addressThis property contains the email address of the recipient.
message_recipient_nameThis property contains name of the recipient.
message_recipient_optionsThis property contains the recipient sending options (used only by SMTP).
message_recipient_typeThis property contains the recipient type: To, Cc, or BCc.
message_reply_toThe value of the Reply-To header of the last retrieved message.
message_signedWhether or not the current message is signed.
message_sizeThe size in bytes of the current message.
message_subjectThe value of the Subject header of the last retrieved message.
message_textThe full text of the message as retrieved from the server.
message_toThe value of the To header of the last retrieved message.
message_uidThe unique identifier of the message as specified by the server.
passwordThe password for the mailbox user.
signer_cert_encodedThe certificate (PEM/base64 encoded).
signer_cert_issuerThe issuer of the certificate.
signer_cert_serial_numberThe serial number of the certificate encoded as a string.
signer_cert_storeThe name of the certificate store for the client certificate.
signer_cert_store_passwordIf the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
signer_cert_store_typeThe type of certificate store for this certificate.
signer_cert_subjectThe subject of the certificate used for client authentication.
signer_cert_chain_countThe number of records in the SignerCertChain arrays.
signer_cert_chain_encodedThe certificate (PEM/base64 encoded).
signing_algorithmTextual description of the signature hash algorithm.
ssl_accept_server_cert_encodedThe certificate (PEM/base64 encoded).
ssl_cert_encodedThe certificate (PEM/base64 encoded).
ssl_cert_storeThe name of the certificate store for the client certificate.
ssl_cert_store_passwordIf the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
ssl_cert_store_typeThe type of certificate store for this certificate.
ssl_cert_subjectThe subject of the certificate used for client authentication.
ssl_enabledWhether TLS/SSL is enabled.
ssl_server_cert_encodedThe certificate (PEM/base64 encoded).
ssl_start_modeDetermines how the class starts the SSL negotiation.
timeoutA timeout for the class.
total_sizeCumulative size in bytes of messages in the mailbox (including headers).
userThe user identifier for the mailbox.

Method List


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

configSets or retrieves a configuration setting.
connectConnects to the mail server and attempts to login.
decryptDecrypts the current Message .
decrypt_and_verify_signatureDecrypts and verifies the signature of the current message.
deleteDeletes a message specified by MessageNumber on the server.
disconnectDisconnects from the mail server.
do_eventsProcesses events from the internal message queue.
interruptInterrupt the current method.
list_message_sizesRetrieves a list of all message sizes from the server.
list_message_ui_dsRetrieves a list of all message UIDs from the server.
localize_dateConverts a valid RFC 822 message date to local date and time.
resetResets all changes and revert back to the state when the user first connected.
retrieveRetrieves a message specified by MessageNumber from the server.
retrieve_headersRetrieves headers for a message specified by MessageNumber .
verify_signatureVerifies the signature of the current message.

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_statusFired to indicate changes in connection state.
on_end_transferFired when the message completes transferring.
on_errorInformation about errors during data delivery.
on_headerFired for every message header being retrieved.
on_message_listFired for every message listed by ListMessageSizes and/or ListMessageUIDs .
on_pi_trailTraces the commands sent to the mail server, and the respective replies.
on_ssl_server_authenticationFired after the server presents its certificate to the client.
on_ssl_statusShows the progress of the secure connection.
on_start_transferFired when the message starts transferring.
on_transferFired while the message gets transferred from MailServer .

Configuration Settings


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

AuthorizationIdentityThe value to use as the authorization identity when SASL authentication is used.
AutoDecodeSubjectInstructs the class to automatically decode message subjects.
GetMessageSizeWhether to poll the server for the message size prior to retrieving it.
MaxLineLengthThe maximum expected length for message lines.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the class binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertFilePathsThe paths to CA certificate files on Unix/Linux.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks S/MIME 2020 Python Edition - Version 20.0 [Build 7941]