RSS Class

Properties   Methods   Events   Config Settings   Errors  

The RSS Class is used to retrieve, parse, edit, and write RSS-syndicated content.

Syntax

class ipworks.RSS

Remarks

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

The RSS Class implements a standard RSS newsreader with extended capabilities as specified at http://backend.userland.com/rss2.

The class contains a number of properties that map directly to RSS fields. To receive a feed, call the get_feed method with the URL or file to retrieve as specified in the URL parameter. The RSS class also can generate RSS feeds, which can be retrieved through the rss_data property or written through the write_file method.

The RSS Class supports all RSS feed properties that are standard in versions 0.91, 0.92, and 2.0 of the RSS protocol through a number of class properties. It also supports nonstandard properties as specified in the RSS protocol through the namespaces properties and the get_property and set_property methods.

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.

accept Property

This property includes a list of acceptable MIME types for the request.

Syntax

def get_accept() -> str: ...
def set_accept(value: str) -> None: ...

accept = property(get_accept, set_accept)

Default Value

""

Remarks

If this property contains a nonempty string, an HTTP Accept header is added to the request.

The Accept header is used for content negotiation. It provides the server with a comma-separated list of MIME types that are acceptable for its response.

authorization Property

This property includes the Authorization string to be sent to the server.

Syntax

def get_authorization() -> str: ...
def set_authorization(value: str) -> None: ...

authorization = property(get_authorization, set_authorization)

Default Value

""

Remarks

If the authorization property contains a nonempty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

A common use for this property is to specify OAuth authorization string.

This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.

The auth_scheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time user and password are set, they are Base64 encoded, and the result is put in the authorization property in the form "Basic [encoded-user-password]".

auth_scheme Property

This property specifies the authentication scheme to use when server authentication is required.

Syntax

def get_auth_scheme() -> int: ...
def set_auth_scheme(value: int) -> None: ...

auth_scheme = property(get_auth_scheme, set_auth_scheme)

Default Value

0

Remarks

This property will tell the class which type of authorization to perform when the user and password properties are set.

This property should be set to authNone (3) when no authentication is to be performed.

By default, this property is authBasic (0), and if the user and password properties are set, the class will attempt HTTP Basic Authentication. If auth_scheme is set to authDigest (1), authNtlm (4), or authNegotiate (5), then Digest, NTLM, or Windows Negotiate (Kerberos) authentication will be attempted instead.

If auth_scheme is set to authProprietary (2), then the authorization token must be supplied through the authorization property.

If auth_scheme is set to authOAuth (6), then the authorization string must be supplied through the authorization property.

Note: If you set the authorization property and auth_scheme is not authProprietary or authOAuth, then the auth_scheme will be set automatically to authProprietary (2) by the class.

For security, changing the value of this property will cause the class to clear the values of user, password, and Authorization.

channel_category Property

The value of this property is a forward-slash-separated string that identifies a hierarchical location in a particular hierarchy.

Syntax

def get_channel_category() -> str: ...
def set_channel_category(value: str) -> None: ...

channel_category = property(get_channel_category, set_channel_category)

Default Value

""

Remarks

The value of this property is a forward-slash-separated string that identifies a hierarchical location in a particular hierarchy. The conventions used to interpret an RSS channel's category depend upon the processor.

channel_category_domain Property

This property contains the URL indicating the definition of the current RSS channel's category.

Syntax

def get_channel_category_domain() -> str: ...
def set_channel_category_domain(value: str) -> None: ...

channel_category_domain = property(get_channel_category_domain, set_channel_category_domain)

Default Value

""

Remarks

This property contains the URL indicating the definition of the current RSS channel's category. This points to a location that defines the category indicated by the channel_category property.

channel_copyright Property

This property contains the copyright information for the current RSS channel (500 character maximum).

Syntax

def get_channel_copyright() -> str: ...
def set_channel_copyright(value: str) -> None: ...

channel_copyright = property(get_channel_copyright, set_channel_copyright)

Default Value

""

Remarks

This property contains the copyright information for the current RSS channel (500 character maximum).

channel_description Property

This property contains a textual description of the current RSS feed (500 character maximum required).

Syntax

def get_channel_description() -> str: ...
def set_channel_description(value: str) -> None: ...

channel_description = property(get_channel_description, set_channel_description)

Default Value

""

Remarks

This property contains a textual description of the current RSS feed (500 character maximum required).

This property is filled in automatically after calling get_feed.

Required fields for building RSS feeds include the channel's channel_link, channel_title, and channel_description fields.

channel_docs Property

This property should contain the URL for the documentation describing the format that was used to create the current RSS channel.

Syntax

def get_channel_docs() -> str: ...
def set_channel_docs(value: str) -> None: ...

channel_docs = property(get_channel_docs, set_channel_docs)

Default Value

"http://backend.userland.com/rss2"

Remarks

This property should contain the URL for the documentation describing the format that was used to create the current RSS channel. The default value points to the standard RSS 2.0 documentation found at "http://backend.userland.com/rss2".

channel_generator Property

This property contains the name of the program that created the RSS feed.

Syntax

def get_channel_generator() -> str: ...
def set_channel_generator(value: str) -> None: ...

channel_generator = property(get_channel_generator, set_channel_generator)

Default Value

"IPWorks Version 8.0 RSS Component"

Remarks

This property contains the name of the program that created the RSS feed.

channel_image_description Property

This property is used to specify text that is included in the title attribute of the image's link formed in the HTML rendering.

Syntax

def get_channel_image_description() -> str: ...
def set_channel_image_description(value: str) -> None: ...

channel_image_description = property(get_channel_image_description, set_channel_image_description)

Default Value

""

Remarks

This property is used to specify text that is included in the title attribute of the image's link formed in the HTML rendering.

channel_image_height Property

This property contains the height of the image in pixels.

Syntax

def get_channel_image_height() -> str: ...
def set_channel_image_height(value: str) -> None: ...

channel_image_height = property(get_channel_image_height, set_channel_image_height)

Default Value

""

Remarks

This property contains the height of the image in pixels.

channel_image_link Property

This property contains the URL associated with the channel's associated image.

Syntax

def get_channel_image_link() -> str: ...
def set_channel_image_link(value: str) -> None: ...

channel_image_link = property(get_channel_image_link, set_channel_image_link)

Default Value

""

Remarks

This property contains the URL associated with the channel's associated image.

Images are required for RSS channels that conform to versions 0.91 and 0.92 of the RSS protocol. The following properties are required for an image:

channel_image_title Property

This property contains the title of the channel's associated image.

Syntax

def get_channel_image_title() -> str: ...
def set_channel_image_title(value: str) -> None: ...

channel_image_title = property(get_channel_image_title, set_channel_image_title)

Default Value

""

Remarks

This property contains the title of the channel's associated image.

Images are required for RSS channels that conform to versions 0.91 and 0.92 of the RSS protocol. The following properties are required for an image:

channel_image_url Property

This property contains the URL location of the channel's associated image.

Syntax

def get_channel_image_url() -> str: ...
def set_channel_image_url(value: str) -> None: ...

channel_image_url = property(get_channel_image_url, set_channel_image_url)

Default Value

""

Remarks

This property contains the URL location of the channel's associated image.

Images are required for RSS channels that conform to versions 0.91 and 0.92 of the RSS protocol. The following properties are required for an image:

channel_image_width Property

This property contains the width of the image in pixels.

Syntax

def get_channel_image_width() -> str: ...
def set_channel_image_width(value: str) -> None: ...

channel_image_width = property(get_channel_image_width, set_channel_image_width)

Default Value

""

Remarks

This property contains the width of the image in pixels.

channel_language Property

This property is required for feeds that conform to versions 0.

Syntax

def get_channel_language() -> str: ...
def set_channel_language(value: str) -> None: ...

channel_language = property(get_channel_language, set_channel_language)

Default Value

""

Remarks

This property is required for feeds that conform to versions 0.91 of the RSS protocol. It contains the language code used to identify the language of the current RSS channel.

Example. Language Codes:

For a detailed explanation about language codes, please refer to RFC 1766.

channel_last_build_date Property

This property contains the date of the current RSS channel's most recent content changes.

Syntax

def get_channel_last_build_date() -> str: ...
def set_channel_last_build_date(value: str) -> None: ...

channel_last_build_date = property(get_channel_last_build_date, set_channel_last_build_date)

Default Value

""

Remarks

This property contains the date of the current RSS channel's most recent content changes. It should conform to the standards set in RFC 822, with the exception that years can be either two or four characters long.

channel_link Property

This property contains the URL that corresponds to the website where the RSS channel is located (500 character maximum required).

Syntax

def get_channel_link() -> str: ...
def set_channel_link(value: str) -> None: ...

channel_link = property(get_channel_link, set_channel_link)

Default Value

""

Remarks

This property contains the URL that corresponds to the website where the RSS channel is located (500 character maximum required).

This property is filled in automatically after calling get_feed.

Required fields for building RSS feeds include the channel's channel_link, channel_title, and channel_description fields.

channel_managing_editor Property

This property contains the email address or contact information for the current RSS channel's editor.

Syntax

def get_channel_managing_editor() -> str: ...
def set_channel_managing_editor(value: str) -> None: ...

channel_managing_editor = property(get_channel_managing_editor, set_channel_managing_editor)

Default Value

""

Remarks

This property contains the email address or contact information for the current RSS channel's editor.

channel_pub_date Property

This property contains the date of the current RSS channel's most recent publication.

Syntax

def get_channel_pub_date() -> str: ...
def set_channel_pub_date(value: str) -> None: ...

channel_pub_date = property(get_channel_pub_date, set_channel_pub_date)

Default Value

""

Remarks

This property contains the date of the current RSS channel's most recent publication. It should conform to the standards set in RFC 822, with the exception that years can be either two or four characters long.

channel_skip_days Property

This property contains a list of days in which aggregators may skip reading the channel.

Syntax

def get_channel_skip_days() -> str: ...
def set_channel_skip_days(value: str) -> None: ...

channel_skip_days = property(get_channel_skip_days, set_channel_skip_days)

Default Value

""

Remarks

This property contains a list of days in which aggregators may skip reading the channel. When using this property, its value must contain "<day>" XML subelements. Each subelement's value must be a valid day of the week, such as Monday, Tuesday, Wednesday, and so on. Up to seven days may be specified for this property.

channel_skip_hours Property

This property contains a list of hours in which aggregators may skip reading the channel.

Syntax

def get_channel_skip_hours() -> str: ...
def set_channel_skip_hours(value: str) -> None: ...

channel_skip_hours = property(get_channel_skip_hours, set_channel_skip_hours)

Default Value

""

Remarks

This property contains a list of hours in which aggregators may skip reading the channel. When using this property, its value must contain "<hour>" XML subelements. Each subelement's value must be a valid hour between 0 and 23, representing a time in GMT. Up to 24 subelements may be specified for this property.

Note: Hour zero is the hour starting at midnight.

channel_title Property

This property contains the title of the current RSS feed (40 character maximum required).

Syntax

def get_channel_title() -> str: ...
def set_channel_title(value: str) -> None: ...

channel_title = property(get_channel_title, set_channel_title)

Default Value

""

Remarks

This property contains the title of the current RSS feed (40 character maximum required). Typically, the title of the channel is similar to that of the web page where the RSS content is hosted.

This property is filled in automatically after calling get_feed.

Required fields for building RSS feeds include the channel's channel_link, channel_title, and channel_description fields.

channel_ttl Property

This property contains the number of minutes that represents how long the channel may be cached before it needs to be refreshed from the source.

Syntax

def get_channel_ttl() -> str: ...
def set_channel_ttl(value: str) -> None: ...

channel_ttl = property(get_channel_ttl, set_channel_ttl)

Default Value

""

Remarks

This property contains the number of minutes that represents how long the channel may be cached before it needs to be refreshed from the source.

channel_web_master Property

This property contains the email address or contact information for the current RSS channel's webmaster.

Syntax

def get_channel_web_master() -> str: ...
def set_channel_web_master(value: str) -> None: ...

channel_web_master = property(get_channel_web_master, set_channel_web_master)

Default Value

""

Remarks

This property contains the email address or contact information for the current RSS channel's webmaster.

connected Property

Whether the class is connected.

Syntax

def get_connected() -> bool: ...

connected = property(get_connected, None)

Default Value

FALSE

Remarks

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

This property is read-only.

cookie_count Property

The number of records in the Cookie arrays.

Syntax

def get_cookie_count() -> int: ...
def set_cookie_count(value: int) -> None: ...

cookie_count = property(get_cookie_count, set_cookie_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• cookie_domain
• cookie_expiration
• cookie_name
• cookie_path
• cookie_secure
• cookie_value

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

cookie_domain Property

The domain of a received cookie.

Syntax

def get_cookie_domain(cookie_index: int) -> str: ...

Default Value

""

Remarks

The domain of a received cookie. This property contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, this property will contain an empty string. The convention in this case is to use the server name specified by url_server as the cookie domain.

The cookie_index parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.

This property is read-only.

cookie_expiration Property

An expiration time for the cookie (if provided by the server).

Syntax

def get_cookie_expiration(cookie_index: int) -> str: ...

Default Value

""

Remarks

An expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, this property will contain an empty string. The convention is to drop the cookie at the end of the session.

The cookie_index parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.

This property is read-only.

cookie_name Property

The name of the cookie.

Syntax

def get_cookie_name(cookie_index: int) -> str: ...
def set_cookie_name(cookie_index: int, value: str) -> None: ...

Default Value

""

Remarks

The name of the cookie.

This property, along with cookie_value, stores the cookie that is to be sent to the server. The on_set_cookie event displays the cookies sent by the server and their properties.

The cookie_index parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.

cookie_path Property

A path name to limit the cookie to (if provided by the server).

Syntax

def get_cookie_path(cookie_index: int) -> str: ...

Default Value

""

Remarks

A path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the path property will be an empty string. The convention in this case is to use the path specified by url_path as the cookie path.

The cookie_index parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.

This property is read-only.

cookie_secure Property

The security flag of the received cookie.

Syntax

def get_cookie_secure(cookie_index: int) -> bool: ...

Default Value

FALSE

Remarks

The security flag of the received cookie. This property specifies whether the cookie is secure. If the value of this property is True, the cookie value must be submitted only through a secure (HTTPS) connection.

The cookie_index parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.

This property is read-only.

cookie_value Property

The value of the cookie.

Syntax

def get_cookie_value(cookie_index: int) -> str: ...
def set_cookie_value(cookie_index: int, value: str) -> None: ...

Default Value

""

Remarks

The value of the cookie. A corresponding value is associated with the cookie specified by cookie_name. This property holds that value.

The on_set_cookie event provides the cookies set by the server.

The cookie_index parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.

firewall_auto_detect Property

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

Syntax

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

firewall_auto_detect = property(get_firewall_auto_detect, set_firewall_auto_detect)

Default Value

FALSE

Remarks

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

firewall_type Property

The type of firewall to connect through.

Syntax

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

firewall_type = property(get_firewall_type, set_firewall_type)

Default Value

0

Remarks

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

firewall_host Property

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

Syntax

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

firewall_host = property(get_firewall_host, set_firewall_host)

Default Value

""

Remarks

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

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

firewall_password Property

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

Syntax

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

firewall_password = property(get_firewall_password, set_firewall_password)

Default Value

""

Remarks

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

firewall_port Property

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

Syntax

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

firewall_port = property(get_firewall_port, set_firewall_port)

Default Value

0

Remarks

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

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

firewall_user Property

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

Syntax

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

firewall_user = property(get_firewall_user, set_firewall_user)

Default Value

""

Remarks

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

follow_redirects Property

Determines what happens when the server issues a redirect.

Syntax

def get_follow_redirects() -> int: ...
def set_follow_redirects(value: int) -> None: ...

follow_redirects = property(get_follow_redirects, set_follow_redirects)

Default Value

0

Remarks

This property determines what happens when the server issues a redirect. Normally, the class returns an error if the server responds with an "Object Moved" message. If this property is set to frAlways (1), the new url for the object is retrieved automatically every time.

If this property is set to frSameScheme (2), the new url is retrieved automatically only if the url_scheme is the same; otherwise, the class fails with an error.

Note: Following the HTTP specification, unless this property is set to frAlways (1), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server or port are different from the existing one, user and password are also reset to empty. If, however, this property is set to frAlways (1), the same credentials are used to connect to the new server.

A on_redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the on_redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).

The default value is frNever (0). In this case, redirects are never followed, and the class fails with an error instead.

idle Property

The current status of the class.

Syntax

def get_idle() -> bool: ...

idle = property(get_idle, None)

Default Value

TRUE

Remarks

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

This property is read-only.

if_modified_since Property

This property includes a date determining the maximum age of the desired document.

Syntax

def get_if_modified_since() -> str: ...
def set_if_modified_since(value: str) -> None: ...

if_modified_since = property(get_if_modified_since, set_if_modified_since)

Default Value

""

Remarks

If this property contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: If the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the class fails with an error

The format of the date value for if_modified_since is detailed in the HTTP specs. An example is Sat, 29 Oct 1994 19:43:31 GMT.

item_count Property

The number of records in the Item arrays.

Syntax

def get_item_count() -> int: ...
def set_item_count(value: int) -> None: ...

item_count = property(get_item_count, set_item_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• item_author
• item_category
• item_category_domain
• item_comments
• item_description
• item_enclosure_length
• item_enclosure_type
• item_enclosure_url
• item_guid
• item_guid_is_perma_link
• item_link
• item_pub_date
• item_source
• item_source_url
• item_title
• item_xml

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

item_author Property

This property contains the email address or contact information for the current item's author.

Syntax

def get_item_author(item_index: int) -> str: ...
def set_item_author(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the email address or contact information for the current item's author.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

item_category Property

This property contains the location of the current item within a hierarchy.

Syntax

def get_item_category(item_index: int) -> str: ...
def set_item_category(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the location of the current item within a hierarchy. The value of this property is a forward-slash-separated string that identifies a hierarchical location in a particular hierarchy. The conventions used to interpret an RSS item's category depend on the processor.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

item_category_domain Property

This property contains the URL indicating the definition of the current item's category.

Syntax

def get_item_category_domain(item_index: int) -> str: ...
def set_item_category_domain(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the URL indicating the definition of the current item's category. This points to a location that defines the category indicated by the item_category, which is provided in the items properties.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

item_comments Property

If present, this property should point to the URL location of a page for comments related to the current item.

Syntax

def get_item_comments(item_index: int) -> str: ...
def set_item_comments(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

If present, this property should point to the URL location of a page for comments related to the current item.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

item_description Property

This property contains the description of the content of the current item.

Syntax

def get_item_description(item_index: int) -> str: ...
def set_item_description(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the description of the content of the current item. For abstracts, item_link should point to the complete text of the item.

This property is required for RSS feeds that conform to version 0.91 of the RSS protocol. For later versions, an item must have either a item_title or item_description defined.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

item_enclosure_length Property

This property indicates how large the enclosure is in bytes.

Syntax

def get_item_enclosure_length(item_index: int) -> str: ...
def set_item_enclosure_length(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property indicates how large the enclosure is in bytes.

An enclosure specifies a media object that is attached to the item. The fields item_enclosure_length, item_enclosure_type, and item_enclosure_url all are required when specifying an enclosure.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

item_enclosure_type Property

This property specifies the type of enclosure.

Syntax

def get_item_enclosure_type(item_index: int) -> str: ...
def set_item_enclosure_type(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property specifies the type of enclosure. This property must contain a standard MIME type, such as "audio/mpeg".

An enclosure specifies a media object that is attached to the item. The fields item_enclosure_length, item_enclosure_type, and item_enclosure_url all are required when specifying an enclosure.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

item_enclosure_url Property

This property contains the URL where the enclosure is located.

Syntax

def get_item_enclosure_url(item_index: int) -> str: ...
def set_item_enclosure_url(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the URL where the enclosure is located.

An enclosure specifies a media object that is attached to the item. The fields item_enclosure_length, item_enclosure_type, and item_enclosure_url all are required when specifying an enclosure.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

item_guid Property

This property contains the globally unique identifier for the current item.

Syntax

def get_item_guid(item_index: int) -> str: ...
def set_item_guid(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the globally unique identifier for the current item. It is a string that uniquely identifies the item. Aggregators can use this property to determine whether or not an item is new.

Aggregators should view this value as a string, but it is up to the source of the feed to guarantee its uniqueness. The value may be the URL link to the full text of the item to help guarantee that it is unique.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

item_guid_is_perma_link Property

When this property is set to True, the reader may assume that the guide is a permalink to the item.

Syntax

def get_item_guid_is_perma_link(item_index: int) -> bool: ...
def set_item_guid_is_perma_link(item_index: int, value: bool) -> None: ...

Default Value

TRUE

Remarks

When this property is set to True, the reader may assume that the guide is a permalink to the item. A permalink is a URL that can be opened in a web browser, which contains the full item contents from the original RSS feed.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

item_xml Property

This property contains the full XML contents of the item.

Syntax

def get_item_xml(item_index: int) -> str: ...
def set_item_xml(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the full XML contents of the item. Unless the properties of the RSS item are modified, this value will contain the original XML from the RSS feed.

Note: When setting this property, the entire contents of the item must be supplied, including the item tags. All previous item values will be lost.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

item_link Property

For headline or abstract items, this property should be the location of the full text of the item.

Syntax

def get_item_link(item_index: int) -> str: ...
def set_item_link(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

For headline or abstract items, this property should be the location of the full text of the item.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

item_pub_date Property

This property contains the date of the current item's most recent publication.

Syntax

def get_item_pub_date(item_index: int) -> str: ...
def set_item_pub_date(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the date of the current item's most recent publication. It should conform to the standards set in RFC 822, with the exception that years can be either two or four characters long.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

item_source Property

This property contains the name of the RSS feed in which the item was originally published, derived from the feed's title.

Syntax

def get_item_source(item_index: int) -> str: ...
def set_item_source(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the name of the RSS feed in which the item was originally published, derived from the feed's title. If this property or item_source_url are empty, they should be filled with the values contained in item_title and item_link properties of the channel before forwarding the feed from a news aggregator to a blog.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

item_source_url Property

This property contains the URL location of the XML-version of the current item's source.

Syntax

def get_item_source_url(item_index: int) -> str: ...
def set_item_source_url(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the URL location of the XML-version of the current item's source. This is required if item_source is defined. It is a URL that points to the XML representation of the source of the current item.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

item_title Property

This property contains the title or headline of the current item.

Syntax

def get_item_title(item_index: int) -> str: ...
def set_item_title(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the title or headline of the current item. This property is required for RSS feeds that conform to version 0.91 of the RSS protocol. For later versions, an item must have either item_title or item_description defined.

This property should contain a short description of the item, or a headline if item_description is defined.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

local_file Property

This property includes the path to a local file for downloading. If the file exists, it is overwritten.

Syntax

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

local_file = property(get_local_file, set_local_file)

Default Value

""

Remarks

This property is used when getting a document.

If this property is empty, then the received data are provided through transferred_data and the on_transfer event.

local_host Property

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

Syntax

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

local_host = property(get_local_host, set_local_host)

Default Value

""

Remarks

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

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

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

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

namespace_count Property

The number of records in the Namespace arrays.

Syntax

def get_namespace_count() -> int: ...
def set_namespace_count(value: int) -> None: ...

namespace_count = property(get_namespace_count, set_namespace_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• namespace_prefix
• namespace_uri

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

namespace_prefix Property

This property contains the Prefix for the Namespace .

Syntax

def get_namespace_prefix(namespace_index: int) -> str: ...
def set_namespace_prefix(namespace_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the namespace_prefix for the namespace.

The namespace_index parameter specifies the index of the item in the array. The size of the array is controlled by the namespace_count property.

namespace_uri Property

This property contains the namespace URI associated with the corresponding Prefix .

Syntax

def get_namespace_uri(namespace_index: int) -> str: ...
def set_namespace_uri(namespace_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the namespace URI associated with the corresponding namespace_prefix. This URL is usually pointing to the XML schema for the namespace.

The namespace_index parameter specifies the index of the item in the array. The size of the array is controlled by the namespace_count property.

other_headers Property

Other headers as determined by the user (optional).

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 can be set to a string of headers to be appended to the HTTP request headers created from other properties like content_type and from_.

The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

Use this property with caution. If this property contains invalid headers, HTTP requests may fail.

This property is useful for extending the functionality of the class beyond what is provided.

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 a password if authentication is to be used.

Syntax

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

password = property(get_password, set_password)

Default Value

""

Remarks

This property contains a password if authentication is to be used. If auth_scheme is set to HTTP Basic Authentication, the user and password are Base64 encoded and the result is put in the Authorization configuration setting in the form "Basic [encoded-user-password]".

If auth_scheme is set to HTTP Digest Authentication, the user and password properties are used to respond to the HTTP Digest Authentication challenge from the server.

If auth_scheme is set to NTLM, NTLM authentication will be attempted. If auth_scheme is set to NTLM and user and password are empty, the class will attempt to authenticate using the current user's credentials.

proxy_auth_scheme Property

The type of authorization to perform when connecting to the proxy.

Syntax

def get_proxy_auth_scheme() -> int: ...
def set_proxy_auth_scheme(value: int) -> None: ...

proxy_auth_scheme = property(get_proxy_auth_scheme, set_proxy_auth_scheme)

Default Value

0

Remarks

The type of authorization to perform when connecting to the proxy. This is used only when the proxy_user and proxy_password properties are set.

proxy_auth_scheme should be set to authNone (3) when no authentication is expected.

By default, proxy_auth_scheme is authBasic (0), and if the proxy_user and proxy_password properties are set, the class will attempt basic authentication.

If proxy_auth_scheme is set to authDigest (1), digest authentication will be attempted instead.

If proxy_auth_scheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If proxy_auth_scheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of proxy_user and proxy_password.

proxy_auto_detect Property

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

Syntax

def get_proxy_auto_detect() -> bool: ...
def set_proxy_auto_detect(value: bool) -> None: ...

proxy_auto_detect = property(get_proxy_auto_detect, set_proxy_auto_detect)

Default Value

FALSE

Remarks

Whether to automatically detect and use proxy system settings, if available. The default value is False.

proxy_password Property

A password if authentication is to be used for the proxy.

Syntax

def get_proxy_password() -> str: ...
def set_proxy_password(value: str) -> None: ...

proxy_password = property(get_proxy_password, set_proxy_password)

Default Value

""

Remarks

A password if authentication is to be used for the proxy.

If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

proxy_port Property

The Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

def get_proxy_port() -> int: ...
def set_proxy_port(value: int) -> None: ...

proxy_port = property(get_proxy_port, set_proxy_port)

Default Value

80

Remarks

The Transmission Control Protocol (TCP) port for the proxy proxy_server (default 80). See the description of the proxy_server property for details.

proxy_server Property

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

def get_proxy_server() -> str: ...
def set_proxy_server(value: str) -> None: ...

proxy_server = property(get_proxy_server, set_proxy_server)

Default Value

""

Remarks

If a proxy proxy_server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

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

proxy_ssl Property

When to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

def get_proxy_ssl() -> int: ...
def set_proxy_ssl(value: int) -> None: ...

proxy_ssl = property(get_proxy_ssl, set_proxy_ssl)

Default Value

0

Remarks

When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

proxy_user Property

A username if authentication is to be used for the proxy.

Syntax

def get_proxy_user() -> str: ...
def set_proxy_user(value: str) -> None: ...

proxy_user = property(get_proxy_user, set_proxy_user)

Default Value

""

Remarks

A username if authentication is to be used for the proxy.

If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

referer Property

This property includes the referer URL/document (optional).

Syntax

def get_referer() -> str: ...
def set_referer(value: str) -> None: ...

referer = property(get_referer, set_referer)

Default Value

""

Remarks

If this property contains a nonempty string, a Referer HTTP request header is added to the request. The purpose of the header is to show the document referring the requested URL.

rss_data Property

This property includes the complete text of the RSS XML file.

Syntax

def get_rss_data() -> str: ...
def set_rss_data(value: str) -> None: ...

rss_data = property(get_rss_data, set_rss_data)

Default Value

""

Remarks

When retrieving RSS feeds through the get_feed or HTML through the get_url method, this property will contain the complete original text of the feed. When writing an RSS feed using the write_file method, the class rss_data will be generated from the existing properties.

rss_version Property

This property includes the RSS protocol version of the current RSS feed.

Syntax

def get_rss_version() -> int: ...
def set_rss_version(value: int) -> None: ...

rss_version = property(get_rss_version, set_rss_version)

Default Value

3

Remarks

This property contains the protocol version to which the current RSS feed conforms. Each version has slightly different requirements and a different set of defined standard properties. When generating an RSS feed, the class will check this value and throw an error for missing required properties.

The following values are currently recognized by the class:

To set properties not defined in the given version, use the namespaces properties, to list and define namespaces and the get_property and set_property methods, and to list and define each nonstandard property.

ssl_accept_server_cert_effective_date Property

The date on which this certificate becomes valid.

Syntax

def get_ssl_accept_server_cert_effective_date() -> str: ...

ssl_accept_server_cert_effective_date = property(get_ssl_accept_server_cert_effective_date, None)

Default Value

""

Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

ssl_accept_server_cert_expiration_date Property

The date on which the certificate expires.

Syntax

def get_ssl_accept_server_cert_expiration_date() -> str: ...

ssl_accept_server_cert_expiration_date = property(get_ssl_accept_server_cert_expiration_date, None)

Default Value

""

Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

ssl_accept_server_cert_extended_key_usage Property

A comma-delimited list of extended key usage identifiers.

Syntax

def get_ssl_accept_server_cert_extended_key_usage() -> str: ...

ssl_accept_server_cert_extended_key_usage = property(get_ssl_accept_server_cert_extended_key_usage, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_accept_server_cert_fingerprint Property

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

Syntax

def get_ssl_accept_server_cert_fingerprint() -> str: ...

ssl_accept_server_cert_fingerprint = property(get_ssl_accept_server_cert_fingerprint, None)

Default Value

""

Remarks

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

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

This property is read-only.

ssl_accept_server_cert_fingerprint_sha1 Property

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

Syntax

def get_ssl_accept_server_cert_fingerprint_sha1() -> str: ...

ssl_accept_server_cert_fingerprint_sha1 = property(get_ssl_accept_server_cert_fingerprint_sha1, None)

Default Value

""

Remarks

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

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

This property is read-only.

ssl_accept_server_cert_fingerprint_sha256 Property

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

Syntax

def get_ssl_accept_server_cert_fingerprint_sha256() -> str: ...

ssl_accept_server_cert_fingerprint_sha256 = property(get_ssl_accept_server_cert_fingerprint_sha256, None)

Default Value

""

Remarks

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

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

This property is read-only.

ssl_accept_server_cert_issuer Property

The issuer of the certificate.

Syntax

def get_ssl_accept_server_cert_issuer() -> str: ...

ssl_accept_server_cert_issuer = property(get_ssl_accept_server_cert_issuer, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_accept_server_cert_private_key Property

The private key of the certificate (if available).

Syntax

def get_ssl_accept_server_cert_private_key() -> str: ...

ssl_accept_server_cert_private_key = property(get_ssl_accept_server_cert_private_key, None)

Default Value

""

Remarks

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

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

This property is read-only.

ssl_accept_server_cert_private_key_available Property

Whether a PrivateKey is available for the selected certificate.

Syntax

def get_ssl_accept_server_cert_private_key_available() -> bool: ...

ssl_accept_server_cert_private_key_available = property(get_ssl_accept_server_cert_private_key_available, None)

Default Value

FALSE

Remarks

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

This property is read-only.

ssl_accept_server_cert_private_key_container Property

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

Syntax

def get_ssl_accept_server_cert_private_key_container() -> str: ...

ssl_accept_server_cert_private_key_container = property(get_ssl_accept_server_cert_private_key_container, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_accept_server_cert_public_key Property

The public key of the certificate.

Syntax

def get_ssl_accept_server_cert_public_key() -> str: ...

ssl_accept_server_cert_public_key = property(get_ssl_accept_server_cert_public_key, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_accept_server_cert_public_key_algorithm Property

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

Syntax

def get_ssl_accept_server_cert_public_key_algorithm() -> str: ...

ssl_accept_server_cert_public_key_algorithm = property(get_ssl_accept_server_cert_public_key_algorithm, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_accept_server_cert_public_key_length Property

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

Syntax

def get_ssl_accept_server_cert_public_key_length() -> int: ...

ssl_accept_server_cert_public_key_length = property(get_ssl_accept_server_cert_public_key_length, None)

Default Value

0

Remarks

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

This property is read-only.

ssl_accept_server_cert_serial_number Property

The serial number of the certificate encoded as a string.

Syntax

def get_ssl_accept_server_cert_serial_number() -> str: ...

ssl_accept_server_cert_serial_number = property(get_ssl_accept_server_cert_serial_number, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_accept_server_cert_signature_algorithm Property

The text description of the certificate's signature algorithm.

Syntax

def get_ssl_accept_server_cert_signature_algorithm() -> str: ...

ssl_accept_server_cert_signature_algorithm = property(get_ssl_accept_server_cert_signature_algorithm, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_accept_server_cert_store Property

The name of the certificate store for the client certificate.

Syntax

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

ssl_accept_server_cert_store = property(get_ssl_accept_server_cert_store, set_ssl_accept_server_cert_store)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

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

ssl_accept_server_cert_store_password Property

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

Syntax

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

ssl_accept_server_cert_store_password = property(get_ssl_accept_server_cert_store_password, set_ssl_accept_server_cert_store_password)

Default Value

""

Remarks

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

ssl_accept_server_cert_store_type Property

The type of certificate store for this certificate.

Syntax

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

ssl_accept_server_cert_store_type = property(get_ssl_accept_server_cert_store_type, set_ssl_accept_server_cert_store_type)

Default Value

0

Remarks

The type of certificate store for this certificate.

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

ssl_accept_server_cert_subject_alt_names Property

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

Syntax

def get_ssl_accept_server_cert_subject_alt_names() -> str: ...

ssl_accept_server_cert_subject_alt_names = property(get_ssl_accept_server_cert_subject_alt_names, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_accept_server_cert_thumbprint_md5 Property

The MD5 hash of the certificate.

Syntax

def get_ssl_accept_server_cert_thumbprint_md5() -> str: ...

ssl_accept_server_cert_thumbprint_md5 = property(get_ssl_accept_server_cert_thumbprint_md5, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_accept_server_cert_thumbprint_sha1 Property

The SHA-1 hash of the certificate.

Syntax

def get_ssl_accept_server_cert_thumbprint_sha1() -> str: ...

ssl_accept_server_cert_thumbprint_sha1 = property(get_ssl_accept_server_cert_thumbprint_sha1, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_accept_server_cert_thumbprint_sha256 Property

The SHA-256 hash of the certificate.

Syntax

def get_ssl_accept_server_cert_thumbprint_sha256() -> str: ...

ssl_accept_server_cert_thumbprint_sha256 = property(get_ssl_accept_server_cert_thumbprint_sha256, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_accept_server_cert_usage Property

The text description of UsageFlags .

Syntax

def get_ssl_accept_server_cert_usage() -> str: ...

ssl_accept_server_cert_usage = property(get_ssl_accept_server_cert_usage, None)

Default Value

""

Remarks

The text description of ssl_accept_server_cert_usage_flags.

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

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

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

This property is read-only.

ssl_accept_server_cert_usage_flags Property

The flags that show intended use for the certificate.

Syntax

def get_ssl_accept_server_cert_usage_flags() -> int: ...

ssl_accept_server_cert_usage_flags = property(get_ssl_accept_server_cert_usage_flags, None)

Default Value

0

Remarks

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

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

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

This property is read-only.

ssl_accept_server_cert_version Property

The certificate's version number.

Syntax

def get_ssl_accept_server_cert_version() -> str: ...

ssl_accept_server_cert_version = property(get_ssl_accept_server_cert_version, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_accept_server_cert_subject Property

The subject of the certificate used for client authentication.

Syntax

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

ssl_accept_server_cert_subject = property(get_ssl_accept_server_cert_subject, set_ssl_accept_server_cert_subject)

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

ssl_accept_server_cert_encoded Property

The certificate (PEM/Base64 encoded).

Syntax

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

ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded)

Default Value

""

Remarks

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

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

ssl_cert_effective_date Property

The date on which this certificate becomes valid.

Syntax

def get_ssl_cert_effective_date() -> str: ...

ssl_cert_effective_date = property(get_ssl_cert_effective_date, None)

Default Value

""

Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

ssl_cert_expiration_date Property

The date on which the certificate expires.

Syntax

def get_ssl_cert_expiration_date() -> str: ...

ssl_cert_expiration_date = property(get_ssl_cert_expiration_date, None)

Default Value

""

Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

ssl_cert_extended_key_usage Property

A comma-delimited list of extended key usage identifiers.

Syntax

def get_ssl_cert_extended_key_usage() -> str: ...

ssl_cert_extended_key_usage = property(get_ssl_cert_extended_key_usage, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_cert_fingerprint Property

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

Syntax

def get_ssl_cert_fingerprint() -> str: ...

ssl_cert_fingerprint = property(get_ssl_cert_fingerprint, None)

Default Value

""

Remarks

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

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

This property is read-only.

ssl_cert_fingerprint_sha1 Property

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

Syntax

def get_ssl_cert_fingerprint_sha1() -> str: ...

ssl_cert_fingerprint_sha1 = property(get_ssl_cert_fingerprint_sha1, None)

Default Value

""

Remarks

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

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

This property is read-only.

ssl_cert_fingerprint_sha256 Property

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

Syntax

def get_ssl_cert_fingerprint_sha256() -> str: ...

ssl_cert_fingerprint_sha256 = property(get_ssl_cert_fingerprint_sha256, None)

Default Value

""

Remarks

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

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

This property is read-only.

ssl_cert_issuer Property

The issuer of the certificate.

Syntax

def get_ssl_cert_issuer() -> str: ...

ssl_cert_issuer = property(get_ssl_cert_issuer, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_cert_private_key Property

The private key of the certificate (if available).

Syntax

def get_ssl_cert_private_key() -> str: ...

ssl_cert_private_key = property(get_ssl_cert_private_key, None)

Default Value

""

Remarks

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

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

This property is read-only.

ssl_cert_private_key_available Property

Whether a PrivateKey is available for the selected certificate.

Syntax

def get_ssl_cert_private_key_available() -> bool: ...

ssl_cert_private_key_available = property(get_ssl_cert_private_key_available, None)

Default Value

FALSE

Remarks

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

This property is read-only.

ssl_cert_private_key_container Property

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

Syntax

def get_ssl_cert_private_key_container() -> str: ...

ssl_cert_private_key_container = property(get_ssl_cert_private_key_container, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_cert_public_key Property

The public key of the certificate.

Syntax

def get_ssl_cert_public_key() -> str: ...

ssl_cert_public_key = property(get_ssl_cert_public_key, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_cert_public_key_algorithm Property

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

Syntax

def get_ssl_cert_public_key_algorithm() -> str: ...

ssl_cert_public_key_algorithm = property(get_ssl_cert_public_key_algorithm, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_cert_public_key_length Property

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

Syntax

def get_ssl_cert_public_key_length() -> int: ...

ssl_cert_public_key_length = property(get_ssl_cert_public_key_length, None)

Default Value

0

Remarks

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

This property is read-only.

ssl_cert_serial_number Property

The serial number of the certificate encoded as a string.

Syntax

def get_ssl_cert_serial_number() -> str: ...

ssl_cert_serial_number = property(get_ssl_cert_serial_number, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_cert_signature_algorithm Property

The text description of the certificate's signature algorithm.

Syntax

def get_ssl_cert_signature_algorithm() -> str: ...

ssl_cert_signature_algorithm = property(get_ssl_cert_signature_algorithm, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_cert_store Property

The name of the certificate store for the client certificate.

Syntax

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

ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

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

ssl_cert_store_password Property

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

Syntax

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

ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)

Default Value

""

Remarks

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

ssl_cert_store_type Property

The type of certificate store for this certificate.

Syntax

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

ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)

Default Value

0

Remarks

The type of certificate store for this certificate.

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

ssl_cert_subject_alt_names Property

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

Syntax

def get_ssl_cert_subject_alt_names() -> str: ...

ssl_cert_subject_alt_names = property(get_ssl_cert_subject_alt_names, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_cert_thumbprint_md5 Property

The MD5 hash of the certificate.

Syntax

def get_ssl_cert_thumbprint_md5() -> str: ...

ssl_cert_thumbprint_md5 = property(get_ssl_cert_thumbprint_md5, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_cert_thumbprint_sha1 Property

The SHA-1 hash of the certificate.

Syntax

def get_ssl_cert_thumbprint_sha1() -> str: ...

ssl_cert_thumbprint_sha1 = property(get_ssl_cert_thumbprint_sha1, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_cert_thumbprint_sha256 Property

The SHA-256 hash of the certificate.

Syntax

def get_ssl_cert_thumbprint_sha256() -> str: ...

ssl_cert_thumbprint_sha256 = property(get_ssl_cert_thumbprint_sha256, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_cert_usage Property

The text description of UsageFlags .

Syntax

def get_ssl_cert_usage() -> str: ...

ssl_cert_usage = property(get_ssl_cert_usage, None)

Default Value

""

Remarks

The text description of ssl_cert_usage_flags.

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

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

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

This property is read-only.

ssl_cert_usage_flags Property

The flags that show intended use for the certificate.

Syntax

def get_ssl_cert_usage_flags() -> int: ...

ssl_cert_usage_flags = property(get_ssl_cert_usage_flags, None)

Default Value

0

Remarks

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

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

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

This property is read-only.

ssl_cert_version Property

The certificate's version number.

Syntax

def get_ssl_cert_version() -> str: ...

ssl_cert_version = property(get_ssl_cert_version, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_cert_subject Property

The subject of the certificate used for client authentication.

Syntax

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

ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

ssl_cert_encoded Property

The certificate (PEM/Base64 encoded).

Syntax

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

ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)

Default Value

""

Remarks

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

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

ssl_provider Property

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

Syntax

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

ssl_provider = property(get_ssl_provider, set_ssl_provider)

Default Value

0

Remarks

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

Possible values are as follows:

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

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

ssl_server_cert_effective_date Property

The date on which this certificate becomes valid.

Syntax

def get_ssl_server_cert_effective_date() -> str: ...

ssl_server_cert_effective_date = property(get_ssl_server_cert_effective_date, None)

Default Value

""

Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

ssl_server_cert_expiration_date Property

The date on which the certificate expires.

Syntax

def get_ssl_server_cert_expiration_date() -> str: ...

ssl_server_cert_expiration_date = property(get_ssl_server_cert_expiration_date, None)

Default Value

""

Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

ssl_server_cert_extended_key_usage Property

A comma-delimited list of extended key usage identifiers.

Syntax

def get_ssl_server_cert_extended_key_usage() -> str: ...

ssl_server_cert_extended_key_usage = property(get_ssl_server_cert_extended_key_usage, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_server_cert_fingerprint Property

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

Syntax

def get_ssl_server_cert_fingerprint() -> str: ...

ssl_server_cert_fingerprint = property(get_ssl_server_cert_fingerprint, None)

Default Value

""

Remarks

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

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

This property is read-only.

ssl_server_cert_fingerprint_sha1 Property

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

Syntax

def get_ssl_server_cert_fingerprint_sha1() -> str: ...

ssl_server_cert_fingerprint_sha1 = property(get_ssl_server_cert_fingerprint_sha1, None)

Default Value

""

Remarks

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

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

This property is read-only.

ssl_server_cert_fingerprint_sha256 Property

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

Syntax

def get_ssl_server_cert_fingerprint_sha256() -> str: ...

ssl_server_cert_fingerprint_sha256 = property(get_ssl_server_cert_fingerprint_sha256, None)

Default Value

""

Remarks

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

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

This property is read-only.

ssl_server_cert_issuer Property

The issuer of the certificate.

Syntax

def get_ssl_server_cert_issuer() -> str: ...

ssl_server_cert_issuer = property(get_ssl_server_cert_issuer, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_server_cert_private_key Property

The private key of the certificate (if available).

Syntax

def get_ssl_server_cert_private_key() -> str: ...

ssl_server_cert_private_key = property(get_ssl_server_cert_private_key, None)

Default Value

""

Remarks

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

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

This property is read-only.

ssl_server_cert_private_key_available Property

Whether a PrivateKey is available for the selected certificate.

Syntax

def get_ssl_server_cert_private_key_available() -> bool: ...

ssl_server_cert_private_key_available = property(get_ssl_server_cert_private_key_available, None)

Default Value

FALSE

Remarks

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

This property is read-only.

ssl_server_cert_private_key_container Property

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

Syntax

def get_ssl_server_cert_private_key_container() -> str: ...

ssl_server_cert_private_key_container = property(get_ssl_server_cert_private_key_container, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_server_cert_public_key Property

The public key of the certificate.

Syntax

def get_ssl_server_cert_public_key() -> str: ...

ssl_server_cert_public_key = property(get_ssl_server_cert_public_key, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_server_cert_public_key_algorithm Property

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

Syntax

def get_ssl_server_cert_public_key_algorithm() -> str: ...

ssl_server_cert_public_key_algorithm = property(get_ssl_server_cert_public_key_algorithm, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_server_cert_public_key_length Property

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

Syntax

def get_ssl_server_cert_public_key_length() -> int: ...

ssl_server_cert_public_key_length = property(get_ssl_server_cert_public_key_length, None)

Default Value

0

Remarks

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

This property is read-only.

ssl_server_cert_serial_number Property

The serial number of the certificate encoded as a string.

Syntax

def get_ssl_server_cert_serial_number() -> str: ...

ssl_server_cert_serial_number = property(get_ssl_server_cert_serial_number, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_server_cert_signature_algorithm Property

The text description of the certificate's signature algorithm.

Syntax

def get_ssl_server_cert_signature_algorithm() -> str: ...

ssl_server_cert_signature_algorithm = property(get_ssl_server_cert_signature_algorithm, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_server_cert_store Property

The name of the certificate store for the client certificate.

Syntax

def get_ssl_server_cert_store() -> bytes: ...

ssl_server_cert_store = property(get_ssl_server_cert_store, None)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

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

This property is read-only.

ssl_server_cert_store_password Property

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

Syntax

def get_ssl_server_cert_store_password() -> str: ...

ssl_server_cert_store_password = property(get_ssl_server_cert_store_password, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_server_cert_store_type Property

The type of certificate store for this certificate.

Syntax

def get_ssl_server_cert_store_type() -> int: ...

ssl_server_cert_store_type = property(get_ssl_server_cert_store_type, None)

Default Value

0

Remarks

The type of certificate store for this certificate.

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

This property is read-only.

ssl_server_cert_subject_alt_names Property

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

Syntax

def get_ssl_server_cert_subject_alt_names() -> str: ...

ssl_server_cert_subject_alt_names = property(get_ssl_server_cert_subject_alt_names, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_server_cert_thumbprint_md5 Property

The MD5 hash of the certificate.

Syntax

def get_ssl_server_cert_thumbprint_md5() -> str: ...

ssl_server_cert_thumbprint_md5 = property(get_ssl_server_cert_thumbprint_md5, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_server_cert_thumbprint_sha1 Property

The SHA-1 hash of the certificate.

Syntax

def get_ssl_server_cert_thumbprint_sha1() -> str: ...

ssl_server_cert_thumbprint_sha1 = property(get_ssl_server_cert_thumbprint_sha1, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_server_cert_thumbprint_sha256 Property

The SHA-256 hash of the certificate.

Syntax

def get_ssl_server_cert_thumbprint_sha256() -> str: ...

ssl_server_cert_thumbprint_sha256 = property(get_ssl_server_cert_thumbprint_sha256, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_server_cert_usage Property

The text description of UsageFlags .

Syntax

def get_ssl_server_cert_usage() -> str: ...

ssl_server_cert_usage = property(get_ssl_server_cert_usage, None)

Default Value

""

Remarks

The text description of ssl_server_cert_usage_flags.

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

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

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

This property is read-only.

ssl_server_cert_usage_flags Property

The flags that show intended use for the certificate.

Syntax

def get_ssl_server_cert_usage_flags() -> int: ...

ssl_server_cert_usage_flags = property(get_ssl_server_cert_usage_flags, None)

Default Value

0

Remarks

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

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

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

This property is read-only.

ssl_server_cert_version Property

The certificate's version number.

Syntax

def get_ssl_server_cert_version() -> str: ...

ssl_server_cert_version = property(get_ssl_server_cert_version, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_server_cert_subject Property

The subject of the certificate used for client authentication.

Syntax

def get_ssl_server_cert_subject() -> str: ...

ssl_server_cert_subject = property(get_ssl_server_cert_subject, None)

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

This property is read-only.

ssl_server_cert_encoded Property

The certificate (PEM/Base64 encoded).

Syntax

def get_ssl_server_cert_encoded() -> bytes: ...

ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)

Default Value

""

Remarks

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

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

This property is read-only.

timeout Property

The timeout for the class.

Syntax

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

timeout = property(get_timeout, set_timeout)

Default Value

60

Remarks

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

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

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

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

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

The default value for the timeout property is 60 seconds.

transferred_data Property

This property includes the contents of the last response from the server.

Syntax

def get_transferred_data() -> bytes: ...

transferred_data = property(get_transferred_data, None)

Default Value

""

Remarks

This property contains the contents of the last response from the server. If the local_file is empty, the data are accumulated in transferred_data and also can be received in the on_transfer event. Otherwise, this property returns an empty string.

transferred_data_limit controls the maximum amount of data accumulated in transferred_data (by default there is no limit).

This property is read-only.

transferred_data_limit Property

This property includes the maximum number of bytes of data to be transferred.

Syntax

def get_transferred_data_limit() -> int: ...
def set_transferred_data_limit(value: int) -> None: ...

transferred_data_limit = property(get_transferred_data_limit, set_transferred_data_limit)

Default Value

0

Remarks

This property defines the maximum number of bytes of data to be transferred. The default value is zero, which means there is no limit to the amount of data the class will accumulate and parse. If this value is set to a number n that is greater than zero, the class will receive only the first n bytes of data from the server.

transferred_headers Property

The full set of headers as received from the server.

Syntax

def get_transferred_headers() -> str: ...

transferred_headers = property(get_transferred_headers, None)

Default Value

""

Remarks

This property returns the complete set of raw headers as received from the server.

The on_header event shows the individual headers as parsed by the class.

This property is read-only.

user Property

This property includes a user name if authentication is to be used.

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 name if authentication is to be used. If auth_scheme is set to HTTP Basic Authentication, The user and password are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

If auth_scheme is set to HTTP Digest Authentication, the user and password properties are used to respond to the HTTP Digest Authentication challenge from the server.

If auth_scheme is set to NTLM, NTLM authentication will be attempted. If auth_scheme is set to NTLM, and user and password are empty, the class will attempt to authenticate using the current user's credentials.

add_cookie Method

Adds a cookie and the corresponding value to the outgoing request headers.

Syntax

def add_cookie(cookie_name: str, cookie_value: str) -> None: ...

Remarks

This method adds a cookie and the corresponding value to the outgoing request headers. Please refer to the cookies property for more information on cookies and how they are managed.

add_item Method

This method inserts a new item into the beginning of an RSS feed.

Syntax

def add_item(title: str, description: str, link: str) -> None: ...

Remarks

This method assumes that the items are new and more important than existing items and thus adds the item to the beginning of the current item list. This method requires the three standard fields Title, Description, and Link to be specified.

Example 1. Add a New Item: RSSControl.AddItem("New Item Title", "Item Description", "http://www.itemsource.com") RSSControl.WriteFile(filename) Example 2. Add a New Item Using the Item Arrays: RSSControl.ItemCount = 1 RSSControl.ItemTitle(0) = "New Item Title" RSSControl.ItemDescription(0) = "Item Description" RSSControl.ItemLink(0) = "http://www.itemsource.com" RSSControl.WriteFile(filename)

add_namespace Method

This method adds a namespace to the Namespaces properties.

Syntax

def add_namespace(prefix: str, namespace_uri: str) -> None: ...

Remarks

This method adds a namespace to the namespaces properties. Prefix specifies the namespace prefix, and NamespaceURI specifies the namespace.

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.

do_events Method

This method processes events from the internal message queue.

Syntax

def do_events() -> None: ...

Remarks

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

get_feed Method

This method retrieves an RSS feed.

Syntax

def get_feed(url: str) -> None: ...

Remarks

This method retrieves documents using the HTTP GET method. The document contents are delivered in the rss_data property, as well as through the on_transfer event, and the HTTP response headers through the on_header event. If the local_file property has been set, the class will write the transferred data there.

The class will then attempt to parse the RSS feed, filling in the channel and item properties as it goes. The feed properties can be accessed either directly through the named properties, or through the get_property and set_property methods.

get_property Method

This method gets the value of a specific RSS feed item element or attribute.

Syntax

def get_property(property_name: str) -> str: ...

Remarks

This method is intended to extend the functionality of the RSS class. It will get the value for a specific item element or attribute of this RSS feed. Property is the XPath of the element or attribute according to the following convention: root/element@attribute. The @attribute part is optional, and the root field can be any of the four following values:

The element field can be any property of the root field, and attribute can be any property of that field. If an attribute is not supplied, this method will return the text portion of element.

Example. GetProperty:

RSSControl.GetProperty("item[5]/guid@isPermaLink") RSSControl.GetProperty("item[5]/link") RSSControl.GetProperty("/channel/title")

Note: To add nonstandard fields (i.e., fields that are not defined in the RSS specification), element must be prefixed with a namespace that defines that field. The same applies for the attribute field. Use the namespaces properties to define and list namespaces.

get_url Method

This method retrieves an RSS feed.

Syntax

def get_url(url: str) -> None: ...

Remarks

This method retrieves the document using the HTTP GET method. The document contents are delivered in the rss_data property, as well as through the on_transfer event, and the HTTP response headers are delivered through the on_header event. If the local_file property has been set, the class will write the transferred data there.

The class will not parse the data returned by the server. For more control over the retrieval of the item link, please use the HTTP class.

interrupt Method

This method interrupts the current method.

Syntax

def interrupt() -> None: ...

Remarks

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

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

opml_attr Method

This method returns the value of the attribute specified in the parameter.

Syntax

def opml_attr(attr_name: str) -> str: ...

Remarks

This method may be used to get the value of an attribute for an outline entry of an OPML document. The desired attribute must be specified in the parameter of this method. This method also must be invoked inside the on_opml_outline event.

put Method

This method sends data to the HTTP server using the HTTP PUT method.

Syntax

def put(url: str) -> None: ...

Remarks

This method sends data to the HTTP server. The data are taken from the post_data or attached_file properties. The server response text is received through the on_transfer event, and the HTTP response headers are received through the on_header event. If local_file is not empty, the data (not the headers) are written there as well. The user normally should have assigned the correct values to user and password or Authorization.

read_file Method

This method loads an RSS file into the class.

Syntax

def read_file(file_name: str) -> None: ...

Remarks

This method loads an RSS file and attempts to parse it, filling in the properties as it goes. The feed properties can be accessed either directly through the named properties or through the get_property and set_property methods.

read_opml Method

This method reads and parses an OPML file.

Syntax

def read_opml(opml_file: str) -> None: ...

Remarks

This method reads in the OPML file specified by OPMLFile. The class then parses the file and returns the data to the user in the on_opml_header and on_opml_outline events.

reset Method

This method resets all properties of the class.

Syntax

def reset() -> None: ...

Remarks

This method resets all properties to the class's default settings. This is an easy way to clear all of the property values before repopulating the RSS feed.

set_property Method

This method sets the value of a specific RSS feed property.

Syntax

def set_property(property_name: str, property_value: str) -> None: ...

Remarks

This method is intended to extend the functionality of the RSS class. It will set the value for a specific field of this RSS feed. Property is the name of the property according to the following convention: root/element@attribute. The root field can be any of the four following values:

The element field can be any property of the root field, and attribute can be any property of that field. If an attribute is not supplied, Value will be placed in the text portion of element. Example. SetProperty:

RSSControl.SetProperty("item[5]/guid@isPermaLink", "true")

Note: To add nonstandard fields (i.e., fields that are not defined in the RSS specification), element must be prefixed with a namespace that defines that field. The same applies for the attribute field. Use the namespaces properties to define and list namespaces.

write_file Method

This method writes an RSS feed from the class.

Syntax

def write_file(file_name: str) -> None: ...

Remarks

This method will write an RSS feed from the existing property values to FileName. The RSS feed will be preverified, and if there are any missing required fields, the class fails with an error.

Example 1. Add a New Item: RSSControl.AddItem("New Item Title", "Item Description", "http://www.itemsource.com") RSSControl.WriteFile(filename) Example 3. Add a New Item Using the Item Arrays: RSSControl.ItemCount = 1 RSSControl.ItemTitle(0) = "New Item Title" RSSControl.ItemDescription(0) = "Item Description" RSSControl.ItemLink(0) = "http://www.itemsource.com" RSSControl.WriteFile(filename)

on_connected Event

Fired immediately after a connection completes (or fails).

Syntax

class RSSConnectedEventParams(object):
  @property
  def status_code() -> int: ...

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

# In class RSS:
@property
def on_connected() -> Callable[[RSSConnectedEventParams], None]: ...
@on_connected.setter
def on_connected(event_hook: Callable[[RSSConnectedEventParams], None]) -> None: ...

Remarks

If the connection is made normally, StatusCode is 0 and Description is "OK".

If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Please refer to the Error Codes section for more information.

on_connection_status Event

Fired to indicate changes in the connection state.

Syntax

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

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

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

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

Remarks

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

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

on_disconnected Event

Fired when a connection is closed.

Syntax

class RSSDisconnectedEventParams(object):
  @property
  def status_code() -> int: ...

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

# In class RSS:
@property
def on_disconnected() -> Callable[[RSSDisconnectedEventParams], None]: ...
@on_disconnected.setter
def on_disconnected(event_hook: Callable[[RSSDisconnectedEventParams], None]) -> None: ...

Remarks

If the connection is broken normally, StatusCode is 0 and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

on_end_transfer Event

This event is fired when a document finishes transferring.

Syntax

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

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

Remarks

The on_end_transfer event is fired when the document text finishes transferring from the server to the local host.

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

on_error Event

Fired when information is available about errors during data delivery.

Syntax

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

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

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

Remarks

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

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

on_header Event

Fired every time a header line comes in.

Syntax

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

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

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

Remarks

The Field parameter contains the name of the HTTP header (which is the same 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_log Event

Fired once for each log message.

Syntax

class RSSLogEventParams(object):
  @property
  def log_level() -> int: ...

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

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

# In class RSS:
@property
def on_log() -> Callable[[RSSLogEventParams], None]: ...
@on_log.setter
def on_log(event_hook: Callable[[RSSLogEventParams], None]) -> None: ...

Remarks

This event is fired once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"

on_opml_header Event

This event is fired for each value in the header section of the current OPML document.

Syntax

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

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

# In class RSS:
@property
def on_opml_header() -> Callable[[RSSOPMLHeaderEventParams], None]: ...
@on_opml_header.setter
def on_opml_header(event_hook: Callable[[RSSOPMLHeaderEventParams], None]) -> None: ...

Remarks

This event is fired when the class is parsing an OPML document after a call to read_opml is made. The class parses each header field and value from the OPML document and fires on_opml_header once for each header present.

on_opml_outline Event

This event is fired for each outline in the current OPML document.

Syntax

class RSSOPMLOutlineEventParams(object):
  @property
  def level() -> int: ...

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

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

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

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

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

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

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

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

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

# In class RSS:
@property
def on_opml_outline() -> Callable[[RSSOPMLOutlineEventParams], None]: ...
@on_opml_outline.setter
def on_opml_outline(event_hook: Callable[[RSSOPMLOutlineEventParams], None]) -> None: ...

Remarks

This event is fired for each outline in the OPML document.

The Level parameter contains the depth of the current outline in the OPML document.

Each outline contains a Text attribute, which is parsed out, and returned in the Text parameter.

The Type attribute is a string that describes how the other attributes of the outline are interpreted and is returned in the TypeName parameter.

The Title parameter refers to the title of the outline.

The URL parameter indicates the external location of the outline.

The XMLURL parameter is usually set to an RSS, Atom, or OPML file.

The HTMLURL parameter specifies an HTMLURL attribute, which may be used instead of the URL attribute.

The Created parameter contains the date the outline node was created.

The OtherAttrs parameter contains a list of other attributes for the current outline. In this case, you must use the opml_attr method to get the attribute's corresponding values from the parser.

on_redirect Event

Fired when a redirection is received from the server.

Syntax

class RSSRedirectEventParams(object):
  @property
  def location() -> str: ...

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

# In class RSS:
@property
def on_redirect() -> Callable[[RSSRedirectEventParams], None]: ...
@on_redirect.setter
def on_redirect(event_hook: Callable[[RSSRedirectEventParams], None]) -> None: ...

Remarks

This event is fired in cases in which the client can decide whether or not to continue with the redirection process. The Accept parameter is always True by default, but if you do not want to follow the redirection, Accept may be set to False, in which case the class fails with an error. Location is the location to which the client is being redirected. Further control over redirection is provided in the follow_redirects property.

on_set_cookie Event

Fired for every cookie set by the server.

Syntax

class RSSSetCookieEventParams(object):
  @property
  def name() -> str: ...

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

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

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

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

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

# In class RSS:
@property
def on_set_cookie() -> Callable[[RSSSetCookieEventParams], None]: ...
@on_set_cookie.setter
def on_set_cookie(event_hook: Callable[[RSSSetCookieEventParams], None]) -> None: ...

Remarks

This event is fired for every Set-Cookie: header received from the HTTP server.

The Name parameter contains the name of the cookie, with the corresponding value supplied in the Value parameter.

The Expires parameter contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, the Expires parameter will be an empty string. In this case, the convention is to drop the cookie at the end of the session.

The Domain parameter contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, the Domain parameter will be an empty string. The convention in this case is to use the server specified in the URL (url_server) as the cookie domain.

The Path parameter contains a path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the Path parameter will be an empty string. The convention in this case is to use the path specified in the URL (url_path) as the cookie path.

The Secure parameter specifies whether the cookie is secure. If the value of this parameter is True, the cookie value must be submitted only through a secure (HTTPS) connection.

on_ssl_server_authentication Event

Fired after the server presents its certificate to the client.

Syntax

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

Remarks

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

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

on_ssl_status Event

Fired when secure connection progress messages are available.

Syntax

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

# In class RSS:
@property
def on_ssl_status() -> Callable[[RSSSSLStatusEventParams], None]: ...
@on_ssl_status.setter
def on_ssl_status(event_hook: Callable[[RSSSSLStatusEventParams], 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 a document starts transferring (after the headers).

Syntax

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

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

Remarks

The on_start_transfer event is fired when the document text starts transferring from the server to the local host.

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

on_status Event

Fired when the HTTP status line is received from the server.

Syntax

class RSSStatusEventParams(object):
  @property
  def http_version() -> str: ...

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

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

# In class RSS:
@property
def on_status() -> Callable[[RSSStatusEventParams], None]: ...
@on_status.setter
def on_status(event_hook: Callable[[RSSStatusEventParams], None]) -> None: ...

Remarks

HTTPVersion is a string containing the HTTP version string as returned from the server (e.g., "1.1").

StatusCode contains the HTTP status code (e.g., 200), and Description the associated message returned by the server (e.g., "OK").

on_transfer Event

Fired while a document transfers (delivers document).

Syntax

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

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

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

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

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

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

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.

RSS Config Settings

RSS Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

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

Socket Config Settings

Base Config Settings

RSS Errors

RSS Errors

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

HTTP 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

XML Errors