SNNTP Class

Properties   Methods   Events   Config Settings   Errors  

The SNNTP Class is used to read, search, and post articles on Usenet news servers.

Syntax

class ipworkssmime.SNNTP

Remarks

The SNNTP Class is the S/MIME enabled equivalent of the IPWorks NNTP class. In addition to standard NNTP functions the SNNTP class can sign, encrypt, decrypt, and verify message signatures. The methods and properties for encrypting, signing, decrypting, and verifying signatures are identical to those provided with the S/MIME class. After setting the certificate properties, and specifying article_text, call the encrypt, sign or sign_and_encrypt method before posting, and the result will be stored in article_text. 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 article_text.

The SNNTP Class implements a standard Usenet news reader as specified in RFC 977. It can be used to browse Usenet news groups and to read and post articles.

The current_group property sets the current newsgroup. From then on, news articles from that group can be read by setting the article number in current_article and then calling the appropriate method. Properties, such as article_count, first_article, and last_article, provide information about the current state.

The headers and text of the articles are received through the on_header and on_transfer events, respectively. Additionally, up to max_lines from the article body are provided in the article_text property. The on_group_overview event returns information about a range of articles (overview_range) in current_group, and the on_group_list event is used when listing newsgroup names. The on_pi_trail event provides a trace of the interaction with the server.

The class supports posting of articles through the article_text and attached_file properties. The article text is specified in one or both of the above, and then the post_article method is called. Article headers are given in a series of properties, such as article_from, article_subject, and organization, that map directly to the Usenet article header with the same name.

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.

article_count Property

This property includes the estimated number of articles in CurrentGroup .

Syntax

def get_article_count() -> int: ...

article_count = property(get_article_count, None)

Default Value

0

Remarks

This property contains the estimated number of articles in current_group. The value of this property is 0 if there is no current group (current_group is ""). Otherwise, when current_group is set, it is the number of articles in the group as shown by the news server. For most news servers, this is an estimated value of the number of the articles, rather than the exact value.

This property is read-only.

article_date Property

This property includes the date of the current article.

Syntax

def get_article_date() -> str: ...

article_date = property(get_article_date, None)

Default Value

""

Remarks

This property contains the date of the current article. If the class is not connected or current_article is empty, the value of this property is an empty string. Otherwise, it contains the date of the article as reported by the server. The NewsServer is asked about the headers of the article only if the current_article property has changed. If current_article has not changed, the class returns a cached value.

This property is read-only.

article_from Property

This property includes the email address of the author (for posting articles).

Syntax

def get_article_from() -> str: ...
def set_article_from(value: str) -> None: ...

article_from = property(get_article_from, set_article_from)

Default Value

""

Remarks

This property contains the email address of the author (for posting articles). The string in this property is posted with a From article header to the news server.

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 850 specifications.

article_headers Property

This property includes the full headers of the article as retrieved from the server.

Syntax

def get_article_headers() -> str: ...

article_headers = property(get_article_headers, None)

Default Value

""

Remarks

This property contains the full headers of the article as retrieved from the server. If the class is not connected or the current_article is empty, the value of this property is an empty string. Otherwise, it contains the full headers of the article as reported by the server.

The news_server is asked about the headers of the article only if the current_article property has changed. If current_article has not changed, the class returns a cached value.

This property is read-only.

article_id Property

This property includes the message identifier of the current article.

Syntax

def get_article_id() -> str: ...

article_id = property(get_article_id, None)

Default Value

""

Remarks

This property contains the message identifier of the current article. If the class is not connected or the current_article is empty, the value of this property is an empty string. Otherwise, it contains the message identifier of the article as reported by the server. The NewsServer is asked about the headers of the article only if the current_article property has changed. If the current_article has not changed, the class returns a cached value.

This property is read-only.

group_overview_count Property

The number of records in the GroupOverview arrays.

Syntax

def get_group_overview_count() -> int: ...

group_overview_count = property(get_group_overview_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• group_overview_article_lines
• group_overview_article_number
• group_overview_article_size
• group_overview_date
• group_overview_from
• group_overview_message_id
• group_overview_other_headers
• group_overview_references
• group_overview_subject

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

This property is read-only.

group_overview_article_lines Property

This is the number of lines of an article in a newsgroup overview.

Syntax

def get_group_overview_article_lines(group_overview_index: int) -> int: ...

Default Value

0

Remarks

This is the number of lines of an article in a newsgroup overview.

The group_overview_index parameter specifies the index of the item in the array. The size of the array is controlled by the group_overview_count property.

This property is read-only.

group_overview_article_number Property

This is the number of an article in a newsgroup overview.

Syntax

def get_group_overview_article_number(group_overview_index: int) -> int: ...

Default Value

0

Remarks

This is the number of an article in a newsgroup overview.

The group_overview_index parameter specifies the index of the item in the array. The size of the array is controlled by the group_overview_count property.

This property is read-only.

group_overview_article_size Property

This is the size of an article in a newsgroup overview.

Syntax

def get_group_overview_article_size(group_overview_index: int) -> int: ...

Default Value

0

Remarks

This is the size of an article in a newsgroup overview.

The group_overview_index parameter specifies the index of the item in the array. The size of the array is controlled by the group_overview_count property.

This property is read-only.

group_overview_date Property

This is the date of an article in a newsgroup overview.

Syntax

def get_group_overview_date(group_overview_index: int) -> str: ...

Default Value

""

Remarks

This is the date of an article in a newsgroup overview.

The group_overview_index parameter specifies the index of the item in the array. The size of the array is controlled by the group_overview_count property.

This property is read-only.

group_overview_from Property

This is the sender of an article in a newsgroup overview.

Syntax

def get_group_overview_from(group_overview_index: int) -> str: ...

Default Value

""

Remarks

This is the sender of an article in a newsgroup overview.

The group_overview_index parameter specifies the index of the item in the array. The size of the array is controlled by the group_overview_count property.

This property is read-only.

group_overview_message_id Property

This is the unique message Id of an article in a newsgroup overview.

Syntax

def get_group_overview_message_id(group_overview_index: int) -> str: ...

Default Value

""

Remarks

This is the unique message Id of an article in a newsgroup overview.

The group_overview_index parameter specifies the index of the item in the array. The size of the array is controlled by the group_overview_count property.

This property is read-only.

group_overview_other_headers Property

This is the remaining headers of an article in a newsgroup overview.

Syntax

def get_group_overview_other_headers(group_overview_index: int) -> str: ...

Default Value

""

Remarks

This is the remaining headers of an article in a newsgroup overview.

The group_overview_index parameter specifies the index of the item in the array. The size of the array is controlled by the group_overview_count property.

This property is read-only.

group_overview_references Property

This is the references of an article in a newsgroup overview.

Syntax

def get_group_overview_references(group_overview_index: int) -> str: ...

Default Value

""

Remarks

This is the references of an article in a newsgroup overview.

The group_overview_index parameter specifies the index of the item in the array. The size of the array is controlled by the group_overview_count property.

This property is read-only.

group_overview_subject Property

This is the subject of an article in a newsgroup overview.

Syntax

def get_group_overview_subject(group_overview_index: int) -> str: ...

Default Value

""

Remarks

This is the subject of an article in a newsgroup overview.

The group_overview_index parameter specifies the index of the item in the array. The size of the array is controlled by the group_overview_count property.

This property is read-only.

article_references Property

This property includes articles to which the posted article follows up.

Syntax

def get_article_references() -> str: ...
def set_article_references(value: str) -> None: ...

article_references = property(get_article_references, set_article_references)

Default Value

""

Remarks

This property contains articles to which the posted article follows up. If this property contains a nonempty string, a References article header is created for the article. This header shows the article identifiers for the posted article to which it refers.

The references must be separated by space characters.

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 850 specifications.

article_reply_to Property

This property includes the address to reply to (for posting articles).

Syntax

def get_article_reply_to() -> str: ...
def set_article_reply_to(value: str) -> None: ...

article_reply_to = property(get_article_reply_to, set_article_reply_to)

Default Value

""

Remarks

This property contains the address to reply to (for posting articles). If this property contains a nonempty string, a Reply-To article header is created for the article. This header shows the address to use for replies, which is useful if this address is different from the one in article_from.

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 850 specifications.

article_subject Property

This property includes the article subject (for posted articles).

Syntax

def get_article_subject() -> str: ...
def set_article_subject(value: str) -> None: ...

article_subject = property(get_article_subject, set_article_subject)

Default Value

""

Remarks

The string in this property is posted with a Subject article header to the news server.

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 850 specifications.

article_text Property

This property includes the full text of the article (without the headers).

Syntax

def get_article_text() -> str: ...
def set_article_text(value: str) -> None: ...

article_text = property(get_article_text, set_article_text)

Default Value

""

Remarks

This property contains the full text of the article (without the headers). If the class is not connected or current_article is empty, the value of this property is an empty string. Otherwise, it contains the full text of the article as reported by the server.

The news_server is asked about the text of the article only if the current_article property has changed. If current_article has not changed, the class returns a cached value.

When posting articles, this property contains the full text of the article to post.

It is advisable that the text contained in this property be a collection of lines with lengths less than or equal to 80 bytes separated by CRLF ("\r\n") . The text in the article lines must contain 7-bit characters so that the article can be successfully transferred through the various Usenet news servers on the Internet.

The class automatically escapes lines that start with a "." by adding another "." as specified in RFC 977. The article text is unescaped by the news server, so the process is fully transparent.

attached_file Property

This property includes a filename for which the contents will be appended to the ArticleText when posting articles.

Syntax

def get_attached_file() -> str: ...
def set_attached_file(value: str) -> None: ...

attached_file = property(get_attached_file, set_attached_file)

Default Value

""

Remarks

The content of this property is appended to the text in article_text (if any) and sent to the news server. This property is useful for posting arbitrarily large articles or sending MIME attachments.

It is advisable that the text contained in the file be a collection of lines with lengths less than or equal to 80 bytes separated by CRLF ("\r\n") . The text in the message lines must contain only 7-bit characters so that the message may be sent successfully through the various Usenet news servers on the Internet.

The class automatically escapes lines that start with a "." by adding another as specified in RFC 822. The article text is unescaped by the news server, so the process is fully transparent.

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.

check_date Property

This property includes the date (format YYMMDD HHMMSS) to check for the creation of new groups. If the group was created after the date specified, it is considered new.

Syntax

def get_check_date() -> str: ...
def set_check_date(value: str) -> None: ...

check_date = property(get_check_date, set_check_date)

Default Value

"000101 000000"

Remarks

This property contains the date (format YYMMDD HHMMSS) to check for the creation of new groups. If the group was created after the date specified, it is considered new. The value of this property is used as an argument for the list_new_groups method.

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.

current_article Property

This property includes the number or message identifier of the current article.

Syntax

def get_current_article() -> str: ...
def set_current_article(value: str) -> None: ...

current_article = property(get_current_article, set_current_article)

Default Value

""

Remarks

This property specifies either a message identifier or an article number uniquely identifying a particular article. It is then used as an argument to methods such as fetch_article.

current_group Property

This property includes the name of the current group.

Syntax

def get_current_group() -> str: ...
def set_current_group(value: str) -> None: ...

current_group = property(get_current_group, set_current_group)

Default Value

""

Remarks

This property contains the name of the current group. When this property is set to a valid group name, the class sends a Network News Transfer Protocol (NNTP) GROUP command to the news_server and enters the specified group. If the command is successful, first_article, last_article, and article_count are set to the reported values for the group. This property is then used for all references to articles (until it is changed to another group).

Note: It is recommended to use the change_current_group method instead of setting this property.

encrypting_algorithm Property

The property includes textual description of the encrypting algorithm.

Syntax

def get_encrypting_algorithm() -> str: ...
def set_encrypting_algorithm(value: str) -> None: ...

encrypting_algorithm = property(get_encrypting_algorithm, set_encrypting_algorithm)

Default Value

"3DES"

Remarks

This property contains either the name of the algorithm (such as 3DES or AES), or an object identifier (OID) string representing the algorithm.

Possible values are as follows:

• "3DES"
• "DES"
• "RC2CBC40"
• "RC2CBC64"
• "RC2CBC128" or "RC2"
• "AESCBC128" or "AES"
• "AESCBC192"
• "AESCBC256"
• "AESGCM128" or "AESGCM"
• "AESGCM192"
• "AESGCM256"

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.

first_article Property

This property includes the number of the first article in CurrentGroup .

Syntax

def get_first_article() -> int: ...

first_article = property(get_first_article, None)

Default Value

0

Remarks

This property contains the number of the first article in current_group. The value of this property is zero if there is no current group (current_group is "").

This property is read-only.

group_list_count Property

The number of records in the GroupList arrays.

Syntax

def get_group_list_count() -> int: ...

group_list_count = property(get_group_list_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• group_list_can_post
• group_list_first_article
• group_list_group
• group_list_last_article

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

This property is read-only.

group_list_can_post Property

This property indicates whether a group in a newsgroup listing allows postings or articles.

Syntax

def get_group_list_can_post(group_list_index: int) -> bool: ...

Default Value

FALSE

Remarks

This property indicates whether a group in a newsgroup listing allows postings or articles.

The group_list_index parameter specifies the index of the item in the array. The size of the array is controlled by the group_list_count property.

This property is read-only.

group_list_first_article Property

This property shows the first available article in a newsgroup listing.

Syntax

def get_group_list_first_article(group_list_index: int) -> int: ...

Default Value

0

Remarks

This property shows the first available article in a newsgroup listing.

The group_list_index parameter specifies the index of the item in the array. The size of the array is controlled by the group_list_count property.

This property is read-only.

group_list_group Property

This property shows the group name in a newsgroup listing.

Syntax

def get_group_list_group(group_list_index: int) -> str: ...

Default Value

""

Remarks

This property shows the group name in a newsgroup listing.

The group_list_index parameter specifies the index of the item in the array. The size of the array is controlled by the group_list_count property.

This property is read-only.

group_list_last_article Property

This property shows the last available article in a newsgroup listing.

Syntax

def get_group_list_last_article(group_list_index: int) -> int: ...

Default Value

0

Remarks

This property shows the last available article in a newsgroup listing.

The group_list_index parameter specifies the index of the item in the array. The size of the array is controlled by the group_list_count property.

This property is read-only.

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_certificate Property

This property specifies whether to include the signer's certificate with the signed message.

Syntax

def get_include_certificate() -> bool: ...
def set_include_certificate(value: bool) -> None: ...

include_certificate = property(get_include_certificate, set_include_certificate)

Default Value

TRUE

Remarks

If this property is set to True, the certificate used to sign the message will be encoded and included in a message signature when calling sign or sign_and_encrypt.

Including a certificate is the preferred method of building signed messages. If you do not include a certificate, the message recipient may not be able to verify the sender's signature.

include_chain Property

This property specifies whether to include the signer's certificate chain with the signed message.

Syntax

def get_include_chain() -> bool: ...
def set_include_chain(value: bool) -> None: ...

include_chain = property(get_include_chain, set_include_chain)

Default Value

FALSE

Remarks

If this property is set to True, the entire certificate's chain that was used to sign the message will be encoded and included in the message signature when calling sign or sign_and_encrypt.

Note: To include the chain, the include_certificate property must also be set to true.

last_article Property

This property includes the number of the last article in CurrentGroup .

Syntax

def get_last_article() -> int: ...

last_article = property(get_last_article, None)

Default Value

0

Remarks

This property contains the number of the last article in current_group. The value of this property is zero if there is no current group (current_group is "").

This property is read-only.

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.

max_lines Property

This property includes the maximum number of message lines aside from 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 aside from headers retrieved for messages. This property is used in conjunction with the article_text property.

Note: Because of the Network News Transfer Protocol (NNTP) limitations, the full text of the article is always retrieved from the server, but only max_lines will be stored in article_text.

The default value of the property is zero. In this case, the entire message will be retrieved, without interruptions.

newsgroups Property

This property includes a comma-separated list of newsgroups in which to post the article.

Syntax

def get_newsgroups() -> str: ...
def set_newsgroups(value: str) -> None: ...

newsgroups = property(get_newsgroups, set_newsgroups)

Default Value

""

Remarks

The string in this property is posted with a Newsgroups article header to the news server. It specifies the list of groups where the article is posted (comma separated).

If this property contains "" (empty string), then the value of the current_group property is used to specify the target newsgroup for the posted article.

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 850 specifications.

news_port Property

This property includes the server port for the secure Network News Transfer Protocol (NNTP) (default 119).

Syntax

def get_news_port() -> int: ...
def set_news_port(value: int) -> None: ...

news_port = property(get_news_port, set_news_port)

Default Value

119

Remarks

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

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.

news_server Property

This property includes the name or address of a news server.

Syntax

def get_news_server() -> str: ...
def set_news_server(value: str) -> None: ...

news_server = property(get_news_server, set_news_server)

Default Value

""

Remarks

This property specifies the IP address (IP number in dotted internet format) or the domain name for the news 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, 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.

organization Property

This property includes the organization of the author (for posting articles).

Syntax

def get_organization() -> str: ...
def set_organization(value: str) -> None: ...

organization = property(get_organization, set_organization)

Default Value

""

Remarks

This property contains the organization of the article's author. If this property contains a nonempty string, an Organization article header is created for the article. This header shows the organization of the author and is used for information purposes only.

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 850 specifications.

other_headers Property

This property includes an RFC 850-compliant string consisting of extra headers (for posting articles).

Syntax

def get_other_headers() -> str: ...
def set_other_headers(value: str) -> None: ...

other_headers = property(get_other_headers, set_other_headers)

Default Value

""

Remarks

This property contains a string of headers to be appended to the message headers created from other properties like from_ and subject.

The headers must be of the format "header: value" as specified in RFC 850. Header lines should be separated by CRLF ("\r\n") .

Use this property with caution. If this property contains invalid headers, article posting might not be successful.

This property is useful for extending the functionality of the class. A good example is posting of MIME attachments.

Special Case: If this property starts with an empty line (e.g., carriage return line feed, CRLF), then the value of this property is used instead of the normally computed article headers.

overview_range Property

This property includes the range for the GroupOverview method (first-last).

Syntax

def get_overview_range() -> str: ...
def set_overview_range(value: str) -> None: ...

overview_range = property(get_overview_range, set_overview_range)

Default Value

"-"

Remarks

This property specifies a range of articles for which to retrieve article overviews from the server. The format is 'first-last' where first is "" (empty string) or a positive number, and last is "" (empty string), a positive number, or the token end.

The default value of this property is '-', meaning 'all articles in the group'.

parsed_header_count Property

The number of records in the ParsedHeader arrays.

Syntax

def get_parsed_header_count() -> int: ...

parsed_header_count = property(get_parsed_header_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• parsed_header_field
• parsed_header_value

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

This property is read-only.

parsed_header_field Property

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

Syntax

def get_parsed_header_field(parsed_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 parsed_header_index parameter specifies the index of the item in the array. The size of the array is controlled by the parsed_header_count property.

This property is read-only.

parsed_header_value Property

This property contains the header contents.

Syntax

def get_parsed_header_value(parsed_header_index: int) -> str: ...

Default Value

""

Remarks

This property contains the Header contents.

The parsed_header_index parameter specifies the index of the item in the array. The size of the array is controlled by the parsed_header_count property.

This property is read-only.

password Property

This property includes the logon password for the NewsServer .

Syntax

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

password = property(get_password, set_password)

Default Value

""

Remarks

This property contains a logon password for the news_server. If this property is set to a nonempty string, then when connecting to the news_server an AUTHINFO PASS command is sent to provide authentication information for the user. This command is not part of the Network News Transfer Protocol (NNTP), but it is widely used by popular news servers.

recipient_cert_count Property

The number of records in the RecipientCert arrays.

Syntax

def get_recipient_cert_count() -> int: ...
def set_recipient_cert_count(value: int) -> None: ...

recipient_cert_count = property(get_recipient_cert_count, set_recipient_cert_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• recipient_cert_encoded
• recipient_cert_store
• recipient_cert_store_password
• recipient_cert_store_type
• recipient_cert_subject

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

recipient_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_recipient_cert_encoded(recipient_cert_index: int) -> bytes: ...
def set_recipient_cert_encoded(recipient_cert_index: int, value: bytes) -> None: ...

Default Value

""

Remarks

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

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

The recipient_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the recipient_cert_count property.

recipient_cert_store Property

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

Syntax

def get_recipient_cert_store(recipient_cert_index: int) -> bytes: ...
def set_recipient_cert_store(recipient_cert_index: int, value: bytes) -> None: ...

Default Value

"MY"

Remarks

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

The recipient_cert_store_type property denotes the type of the certificate store specified by recipient_cert_store. If the store is password protected, specify the password in recipient_cert_store_password.

recipient_cert_store is used in conjunction with the recipient_cert_subject property to specify client certificates. If recipient_cert_store has a value, and recipient_cert_subject or recipient_cert_encoded is set, a search for a certificate is initiated. Please see the recipient_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).

The recipient_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the recipient_cert_count property.

recipient_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_recipient_cert_store_password(recipient_cert_index: int) -> str: ...
def set_recipient_cert_store_password(recipient_cert_index: int, value: str) -> 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.

The recipient_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the recipient_cert_count property.

recipient_cert_store_type Property

This is the type of certificate store for this certificate.

Syntax

def get_recipient_cert_store_type(recipient_cert_index: int) -> int: ...
def set_recipient_cert_store_type(recipient_cert_index: int, value: int) -> 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:

The recipient_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the recipient_cert_count property.

recipient_cert_subject Property

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

Syntax

def get_recipient_cert_subject(recipient_cert_index: int) -> str: ...
def set_recipient_cert_subject(recipient_cert_index: int, value: str) -> 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:

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

The recipient_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the recipient_cert_count property.

search_header Property

This property includes a header for the GroupSearch method.

Syntax

def get_search_header() -> str: ...
def set_search_header(value: str) -> None: ...

search_header = property(get_search_header, set_search_header)

Default Value

""

Remarks

This property specifies the header to search for search_pattern (e.g., Subject).

search_pattern Property

This property includes a search pattern for the GroupSearch method.

Syntax

def get_search_pattern() -> str: ...
def set_search_pattern(value: str) -> None: ...

search_pattern = property(get_search_pattern, set_search_pattern)

Default Value

""

Remarks

This property contains a search pattern for the group_search method. The format of the pattern is the same as the patterns used by the UNIX Find command.

As an example, "* new *" will match all headers that contain the word "new".

search_range Property

This property includes the range for the GroupSearch method (first-last).

Syntax

def get_search_range() -> str: ...
def set_search_range(value: str) -> None: ...

search_range = property(get_search_range, set_search_range)

Default Value

"-"

Remarks

This property specifies a range of articles for which to do a search on the server. The format is First-Last where First is "" (empty string) or a positive number, and Last is "" (empty string), a positive number, or the token End.

The default value of the property is "-", meaning "search all articles in the group".

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.

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.

user Property

This property includes a user identifier to login as in the NewsServer .

Syntax

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

user = property(get_user, set_user)

Default Value

""

Remarks

This property contains a user identifier to login as in the news_server. If this property is set to a nonempty string, then when connecting to the news_server an AUTHINFO USER command is sent to provide authentication information for the user. Although this command is not part of the Network News Transfer Protocol (NNTP), it is widely used by news servers for authentication purposes.

add_recipient_cert Method

This method is used to add recipient certificates used to encrypt messages.

Syntax

def add_recipient_cert(cert_encoded: bytes) -> None: ...

Remarks

This method is used to add recipient certificates to the internal message_recipients properties used to encrypt the message. The recipient certificate must be a valid PKCS-encoded certificate. If the certificate provided is Base64 encoded, it will be decoded first by the object.

The CertMgr class may be used to retrieve the appropriate certificate from the system.

This method is used to add recipient certificates to the internal message_recipients properties used to encrypt the message. The recipient certificate must be a valid PKCS-encoded certificate. If the certificate provided is Base64 encoded, it will be decoded first by the object.

The CertMgr class may be used to retrieve the appropriate certificate from the system.

change_current_group Method

This method changes the current group.

Syntax

def change_current_group(group: str) -> None: ...

Remarks

This method changes the current group. When calling this method, the class sends a Network News Transfer Protocol (NNTP) GROUP command to the news_server and enters the specified group. If the command is successful, first_article, last_article, and article_count are set to the reported values for the group.

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

Syntax

def connect() -> None: ...

Remarks

This method is used to connect to the news server. If the user and/or password are set, then corresponding AUTHINFO commands are sent to the news_server as well.

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.

disconnect Method

This method disconnects from the news server.

Syntax

def disconnect() -> None: ...

Remarks

This method is used to disconnect from the news_server. The class first attempts to send a QUIT command, and if that fails, the connection is broken.

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.

encrypt Method

This method encrypts the message.

Syntax

def encrypt() -> None: ...

Remarks

This method encrypts the input message in a Public Key Cryptography Standards (PKCS)-encoded envelope with all of the recipient certificates specified in the message_recipients properties.

Note: The message headers, including the Sender, Recipient(s), and Subject, are not encrypted. If this is sensitive information, consider including these headers in the message body as a MIME entity, and providing other headers for the S/MIME wrapper.

fetch_article Method

This method gets the headers and body of an article specified in CurrentArticle .

Syntax

def fetch_article() -> None: ...

Remarks

This method gets the headers and body of the article specified in current_article. The headers are delivered through the on_header event, and the article body is delivered through the on_transfer event.

If a connection to the news_server does not already exist, a new one is created.

fetch_article_body Method

This method gets only the body of an article specified in CurrentArticle .

Syntax

def fetch_article_body() -> None: ...

Remarks

This method gets only the body of the article specified in current_article. The body is delivered through the on_transfer event.

If a connection to the news_server does not already exist, a new one is created.

fetch_article_headers Method

This method gets only the headers of an article specified in CurrentArticle .

Syntax

def fetch_article_headers() -> None: ...

Remarks

This method gets only the headers of the article specified in current_article. The headers are delivered through the on_header event.

If a connection to the news_server does not already exist, a new one is created.

group_overview Method

This method receives an overview for the articles in range OverviewRange in the CurrentGroup .

Syntax

def group_overview() -> None: ...

Remarks

This method receives an overview for the articles in range overview_range in the current_group. The overview data are delivered through the on_group_overview event.

If a connection to the news_server does not already exist, a new one is created.

group_search Method

This method receives an overview for the articles in the range SearchRange in the CurrentGroup .

Syntax

def group_search() -> None: ...

Remarks

This method searches the current newsgroup for articles in the range search_range in the current_group, where search_header matches search_pattern. The results are delivered through the on_group_search event.

If a connection to the news_server does not already exist, a new one is created.

interrupt Method

Interrupt the current method.

Syntax

def interrupt() -> None: ...

Remarks

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

list_groups Method

This method lists all newsgroups on the server.

Syntax

def list_groups() -> None: ...

Remarks

This method asks the server to list all of its newsgroups. Use this method with caution as listing groups may take quite a long time over slow links. The group names and other information are returned via the on_group_list event.

If a connection to the news_server does not already exist, a new one is created.

list_new_groups Method

This method lists all newgroups on the server.

Syntax

def list_new_groups() -> None: ...

Remarks

This method asks the server to list all of the newsgroups created since check_date. The group names (if any) and other information are returned via the on_group_list event.

If a connection to the news_server does not already exist, a new one is created.

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

post_article Method

This method posts the current article and attached file.

Syntax

def post_article() -> None: ...

Remarks

This method posts the current article and attached file (if any). If a connection to the news_server does not already exist, a new one is created.

reset Method

This method resets the class.

Syntax

def reset() -> None: ...

Remarks

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

reset_headers Method

This method resets all of the article headers.

Syntax

def reset_headers() -> None: ...

Remarks

This method resets all the article headers to "" (empty string). Use this method before posting a new article, so that headers from the previous article are not carried over to the next one.

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.

sign Method

Signs the current message.

Syntax

def sign() -> None: ...

Remarks

This method digitally signs the input data with the certificate provided. Certificates are provided by specifying the certificate property. The include_certificate property allows you to specify whether to include the certificate when signing the message.

sign_and_encrypt Method

Signs and encrypts the current message.

Syntax

def sign_and_encrypt() -> None: ...

Remarks

This method both signs and encrypts the input message into a single PKCS encoded envelope.

Please note that the message headers, including the Sender, Recipient(s), and Subject, are not encrypted. If this is sensitive information, consider including these headers in the message body as a MIME entity, and providing other headers for the S/MIME wrapper.

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 SNNTPConnectionStatusEventParams(object):
  @property
  def connection_event() -> str: ...

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

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

# In class SNNTP:
@property
def on_connection_status() -> Callable[[SNNTPConnectionStatusEventParams], None]: ...
@on_connection_status.setter
def on_connection_status(event_hook: Callable[[SNNTPConnectionStatusEventParams], 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 article text completes transferring.

Syntax

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

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

Remarks

The purpose of the on_end_transfer event is twofold: (1) during article retrieval, it fires when the article body finishes transferring from the news_server to the local host; and (2) during article posting, it fires after the article body has been sent to the news_server.

If article_text is not empty, the on_end_transfer event is fired when the article_text finishes transferring from the local host to the news_server. If article_text is empty, the event is not fired.

If a file is attached to the article_text through the attached_file property, then on_end_transfer fires again when the file finishes transferring. Please see the description of the attached_file property for more information.

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 SNNTPErrorEventParams(object):
  @property
  def error_code() -> int: ...

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

# In class SNNTP:
@property
def on_error() -> Callable[[SNNTPErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[SNNTPErrorEventParams], 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_group_list Event

This event is fired while group data transfers (during group listings).

Syntax

class SNNTPGroupListEventParams(object):
  @property
  def group() -> str: ...

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

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

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

# In class SNNTP:
@property
def on_group_list() -> Callable[[SNNTPGroupListEventParams], None]: ...
@on_group_list.setter
def on_group_list(event_hook: Callable[[SNNTPGroupListEventParams], None]) -> None: ...

Remarks

The on_group_list event is fired for every group reported by the news_server when the list_groups or list_new_groups method is called.

The Group parameter shows the name of the group.

The FirstArticle and LastArticle parameters contain the article numbers for the first and last articles in the group.

The CanPost is True or False depending on whether article posting is allowed in the group specified by Group.

on_group_overview Event

This event is fired for each line of article overview data (during group overviews).

Syntax

class SNNTPGroupOverviewEventParams(object):
  @property
  def article_number() -> int: ...

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

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

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

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

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

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

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

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

# In class SNNTP:
@property
def on_group_overview() -> Callable[[SNNTPGroupOverviewEventParams], None]: ...
@on_group_overview.setter
def on_group_overview(event_hook: Callable[[SNNTPGroupOverviewEventParams], None]) -> None: ...

Remarks

ArticleNumber contains the number of the article within the group.

Subject contains the subject of the article.

From contains the email address of the article author.

ArticleDate contains the date the article was posted.

MessageId contains the unique message Id for the article.

References contains the message Ids for the articles this article refers to (separated by spaces).

ArticleSize contains the size of the article in bytes.

ArticleLines contains the number of lines in the article.

OtherHeaders contains any other article headers that news_server chooses to display for the article.

on_group_search Event

This event is fired for each line of group search data (during group searches).

Syntax

class SNNTPGroupSearchEventParams(object):
  @property
  def article_number() -> int: ...

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

# In class SNNTP:
@property
def on_group_search() -> Callable[[SNNTPGroupSearchEventParams], None]: ...
@on_group_search.setter
def on_group_search(event_hook: Callable[[SNNTPGroupSearchEventParams], None]) -> None: ...

Remarks

ArticleNumber contains the number of the article within the group.

Header contains the matching header.

on_header Event

This event is fired for every article header being retrieved during article retrieval.

Syntax

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

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

# In class SNNTP:
@property
def on_header() -> Callable[[SNNTPHeaderEventParams], None]: ...
@on_header.setter
def on_header(event_hook: Callable[[SNNTPHeaderEventParams], 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_pi_trail Event

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

Syntax

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

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

# In class SNNTP:
@property
def on_pi_trail() -> Callable[[SNNTPPITrailEventParams], None]: ...
@on_pi_trail.setter
def on_pi_trail(event_hook: Callable[[SNNTPPITrailEventParams], 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 group listings, group overviews, article header, and article 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 SNNTPSSLServerAuthenticationEventParams(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 SNNTP:
@property
def on_ssl_server_authentication() -> Callable[[SNNTPSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[SNNTPSSLServerAuthenticationEventParams], 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 SNNTPSSLStatusEventParams(object):
  @property
  def message() -> str: ...

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

Syntax

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

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

Remarks

The purpose of the on_start_transfer event is twofold: during article retrieval, it fires when the article body starts transferring from the news_server to the local host, and during article posting, it fires before the article body is sent to the news_server.

If article_text is not empty, the on_start_transfer event is fired when the article_text starts transferring from the local host to the news_server. If article_text is empty, the event is not fired.

If a file is attached to the article_text via the attached_file property, then on_start_transfer fires again when the file starts transferring. Please go to the description of the attached_file property for more information.

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 article text gets transferred (to or from the NewsServer ).

Syntax

class SNNTPTransferEventParams(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 SNNTP:
@property
def on_transfer() -> Callable[[SNNTPTransferEventParams], None]: ...
@on_transfer.setter
def on_transfer(event_hook: Callable[[SNNTPTransferEventParams], None]) -> None: ...

Remarks

One or more on_transfer events are fired during article retrieval. The Text parameter contains the portion of article data being retrieved.

The BytesTransferred parameter contains the number of bytes transferred since the beginning of the article, including header bytes.

One or more on_transfer events are also fired during article posting. Articles consist of article_text and an optional attached_file. The BytesTransferred parameter shows the number of bytes sent starting from the beginning of article_text and/or attached_file.

The on_transfer event is fired for every line of the article. 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).

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.

SNNTP Config Settings

NNTP 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

SNNTP Errors

NNTP 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