CardDAV Class

Properties   Methods   Events   Config Settings   Errors  

The CardDAV class makes it easy to access, share, manage, upload, and download contact data based on the vCard format within a CardDAV server.

Syntax

class ipworks.CardDAV

Remarks

The CardDAV class allows management of address books and their contacts. Capabilities include creation, deletion, updating, listing, copying, and moving of contacts and address books. The following sections provide additional details about common operations.

Authentication

This class may require authentication via OAuth 2.0 depending on the provider. For example Google requires OAuth 2.0. Perform OAuth authentication using the OAuth class or a separate process. Once complete, you should have an authorization string which looks like:

Bearer ACCESS_TOKEN_VALUE

Addressing Resources

The CardDAV class allows resources to be addressed using a resource URI. There is no standard format for a resource URI, though in most cases the URI format would be something like "https://mydavserver/.well-known/carddav/Address_Book_Name".

Google uses "https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default" to access the default address book. Below is an example of using the get_addressbook_report method, which makes a REPORT request to the given URI in the CardDAV server. cardDAV.GetAddressbookReport("https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default");

To add, delete, update, copy or move a contact from an address book, add its file name at the end of the address book URI, which typically has a vcf extension. Usually the filename of a contact is the same as the uid of the contact plus the vcf extension, but this depends on the way the CardDAV server manages resources.

Listing Address Books

list_addressbooks lists all address books that the current user can access. When this method is called the class will automatically perform a series of requests to obtain the calendar list. First, the class will send a PROPFIND request to the specified base URL to obtain the current-user-principle. Once the current user has been found, the class will then use that information to send a second PROPFIND request to get addressbook-home-set for the user. The addressbook-home-set is then used by the class to make a final PROPFIND request to get the list of address books for the user.

Once this method returns, the class will populate the Addressbook* properties. For example:

cardDAV.ListAddressbooks("https://mydavserver/.well-known/carddav/Address_Book_Name"); for (int i = 0; i < cardDAV.Addressbooks.Count; i++) { string url = cardDAV.Addressbooks[i].URL; string displayName = cardDAV.Addressbooks[i].DisplayName; }

Managing Address Books

To create an address book use the create_addressbook method. The resource URI would be similar to "https://mydavserver/.well-known/carddav/New_Address_Book" and it should be unique. The last part of the URI is not the display name of the address book, but is needed to retrieve/update/delete the addressbook. Specify the display name and the description as arguments when calling create_addressbook.

To update an address book iterate through addressbooks to find the index of the address book to be updated. Set the properties of the address book to the desired values and then make a call to update_addressbook.

To delete an address book use the delete_addressbook method and provide the URI of the address book. The following example shows how to create, update and delete an address book: //create an address book cardDAV.CreateAddressbook("https://mydavserver/.well-known/carddav/New_Address_Book", "display_name", "description"); //update the address book cardDAV.Addressbooks[0].DisplayName = "display_name_updated"; cardDAV.Addressbooks[0].Description = "description_updated"; cardDAV.UpdateAddressbook("https://mydavserver/.well-known/carddav/New_Address_Book", 0); //delete the address book cardDAV.DeleteAddressbook("https://mydavserver/.well-known/carddav/New_Address_Book");

Listing Contacts

To retrieve the contacts of an address book, invoke the get_addressbook_report method, which sends an addressbook-query request to the address book located at the specified ResourceURI. The response to an addressbook-query report will be parsed by the class, and information about the individual contacts will be provided in the on_contact_details event.

The following properties are used when calling create_contact, update_contact or export_vcf, and will be filled after calling get_contact or import_vcf. These will also be available from inside the on_contact_details event, which is fired for each contact received from the CardDAV server in response when calling get_addressbook_report.

• AddressLabels
• addresses
• Agent
• anniversary
• birth_day
• Categories
• Classification
• ContactURL
• custom_properties
• Depth
• e_mails
• formatted_name
• gender
• GeoLocation
• IMPPs
• kind
• languages
• Logo
• Mailer
• Member
• names
• nick_name
• note
• organization
• phone_numbers
• photo
• ProductId
• PublicKey
• Related
• RevisionTime
• role
• SortString
• Sound
• Timezone
• title
• uid
• url
• v_card_version
• XML

For example: cardDAV.User = "myusername"; cardDAV.Password = "mypassword"; cardDAV.GetAddressbookReport("https://www.googleapis.com/carddav/v1/principals/user@gmail.com/lists/default"); The following code inside the on_contact_details event will print the formatted name, phone number and email for each contact: Private Sub CardDAV_ContactDetails(ResourceURI As String, ResponseStatus As String, ETag As String, ContactData As String) Debug.Print cardDAV.FormattedName + " " + cardDAV.PhoneNumbers[0].Value + " " + cardDAV.EMails[0].Value End Sub The output from the above code will look like this:

John Smith  123-456-7890  john@example.com
Jane Doe  555-555-5555  jane@example.com
Alice Johnson 987-654-3210  alice@example.com 

Managing Contacts

The create_contact, update_contact, delete_contact, copy_contact, and move_contact methods provide a way to manage individual contacts within an address book.

When calling create_contact it is necessary to specify at least the formatted name of the object the contact represents. Additional information can be added to the contact by setting additional properties. Please refer to the create_contact documentation for a complete list of applicable properties.

When calling update_contact set the properties to change for the contact and then make a call to update_contact.

When calling move_contact or copy_contact specify the URI of the contact to be copied or moved, and the destination URI. When calling delete_contact specify the URI of the contact to delete.

The example below shows a few possible operations: cardDAV.User = "username"; cardDAV.Password = "password"; //create a contact cardDAV.FormattedName = "Mr. John Q. Public\, Esq."; cardDAV.PhoneNumbers.Add(new CardCustomProp("tel", "123456790")); cardDAV.EMails.Add(new CardCustomProp("email", "john@gmail.com")); CardCustomProp address1 = new CardCustomProp("address", ";;123 Main Street;Any Town;State;1234;Country Name"); address1.Attribute = "TYPE=home"; //optional cardDAV.Addresses.Add(address1); cardDAV.CreateContact("https://mydavserver/.well-known/carddav/Address_Book_Name/123456789.vcf"); //update the contact cardDAV.NickName = "Johny"; cardDAV.PhoneNumbers[0] = new CardCustomProp("tel", "0123456789"); cardDAV.UpdateContact("https://mydavserver/.well-known/carddav/Address_Book_Name/123456789.vcf"); //move the contact cardDAV.MoveContact("https://mydavserver/.well-known/carddav/Address_Book_Name/123456789.vcf", "https://mydavserver/.well-known/carddav/Another_Address_book/123456789.vcf"); //delete the contact cardDAV.DeleteContact("https://mydavserver/.well-known/carddav/Another_Address_book/123456789.vcf");

Creating and Retrieving Contacts using vCards

Another way to create a contact is by using import_vcf to import all the data from a vCard object. For example: String vCard = File.ReadAllText("path/to/vcf/file"); cardDAV.ImportVCF(vCard); cardDAV.CreateContact("https://mydavserver/.well-known/carddav/Address_Book_Name/123456789.vcf"); Retrieve a contact by using get_contact, then make a call to export_vcf, which will convert the retrieved data to a vCard object. This can later be written to a standard VCF file. For example: cardDAV.GetContact("https://mydavserver/.well-known/carddav/Address_Book_Name/123456789.vcf"); File.WriteAllText("path/to/vcf/file", cardDAV.ExportVCF());

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.

addressbook_count Property

The number of records in the Addressbook arrays.

Syntax

def get_addressbook_count() -> int: ...
def set_addressbook_count(value: int) -> None: ...

addressbook_count = property(get_addressbook_count, set_addressbook_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• addressbook_c_tag
• addressbook_description
• addressbook_display_name
• addressbook_property_count
• addressbook_property_index
• addressbook_property_name
• addressbook_property_value
• addressbook_url

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

addressbook_c_tag Property

This property holds the current ctag of the address book.

Syntax

def get_addressbook_c_tag(addressbook_index: int) -> str: ...
def set_addressbook_c_tag(addressbook_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property holds the current ctag of the address book. The ctag value is updated by the server when any changes have been made to the address book. This may be used to determine if any changes have been made to the address book since the last reported ctag.

The addressbook_index parameter specifies the index of the item in the array. The size of the array is controlled by the addressbook_count property.

addressbook_description Property

This property holds the description of the address book.

Syntax

def get_addressbook_description(addressbook_index: int) -> str: ...
def set_addressbook_description(addressbook_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property holds the description of the address book. This value corresponds to the addressbook-description property.

The addressbook_index parameter specifies the index of the item in the array. The size of the array is controlled by the addressbook_count property.

addressbook_display_name Property

This property holds the display name of the address book.

Syntax

def get_addressbook_display_name(addressbook_index: int) -> str: ...
def set_addressbook_display_name(addressbook_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property holds the display name of the address book.

The addressbook_index parameter specifies the index of the item in the array. The size of the array is controlled by the addressbook_count property.

addressbook_property_count Property

This property holds the total number of properties of the address book.

Syntax

def get_addressbook_property_count(addressbook_index: int) -> int: ...

Default Value

0

Remarks

This property holds the total number of properties of the address book. This property, in conjunction with address_property_index, address_property_name and address_property_value provide a way to obtain additional property values that do not correspond to existing properties. For instance: for (int i = 0; i < component.Addressbooks[0].PropertyCount; i++) { //Setting PropertyIndex selects the property component.Addressbooks[0].PropertyIndex = i; //After selecting the property by setting PropertyIndex output the property name and value Console.WriteLine(component.Addressbooks[0].PropertyName + ": " + component.Addressbooks[0].PropertyValue); }

Note that complex properties that include nested elements are not supported at this time and are not present in the property collection.

The addressbook_index parameter specifies the index of the item in the array. The size of the array is controlled by the addressbook_count property.

This property is read-only.

addressbook_property_index Property

This property specifies the currently selected property.

Syntax

def get_addressbook_property_index(addressbook_index: int) -> int: ...
def set_addressbook_property_index(addressbook_index: int, value: int) -> None: ...

Default Value

0

Remarks

This property specifies the currently selected property. Please see address_property_count for details.

The addressbook_index parameter specifies the index of the item in the array. The size of the array is controlled by the addressbook_count property.

addressbook_property_name Property

This property holds the name of the currently selected property.

Syntax

def get_addressbook_property_name(addressbook_index: int) -> str: ...

Default Value

"0"

Remarks

This property holds the name of the currently selected property. Please see address_property_count for details.

The addressbook_index parameter specifies the index of the item in the array. The size of the array is controlled by the addressbook_count property.

This property is read-only.

addressbook_property_value Property

This property holds the value of the currently selected property.

Syntax

def get_addressbook_property_value(addressbook_index: int) -> str: ...

Default Value

""

Remarks

This property holds the value of the currently selected property. Please see address_property_count for details.

The addressbook_index parameter specifies the index of the item in the array. The size of the array is controlled by the addressbook_count property.

This property is read-only.

addressbook_url Property

This property provides the URL of the address book.

Syntax

def get_addressbook_url(addressbook_index: int) -> str: ...
def set_addressbook_url(addressbook_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property provides the URL of the address book. This URL is used when managing events within an address book, or managing the address book itself.

The addressbook_index parameter specifies the index of the item in the array. The size of the array is controlled by the addressbook_count property.

address_count Property

The number of records in the Address arrays.

Syntax

def get_address_count() -> int: ...
def set_address_count(value: int) -> None: ...

address_count = property(get_address_count, set_address_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• address_attribute
• addressbook_c_tag
• addressbook_description
• addressbook_display_name
• addressbook_property_count
• addressbook_property_index
• addressbook_property_name
• addressbook_property_value
• addressbook_url
• address_name
• address_value

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

address_attribute Property

This property contains an optional attribute of the custom property.

Syntax

def get_address_attribute(address_index: int) -> str: ...
def set_address_attribute(address_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains an optional attribute of the custom property.

The address_index parameter specifies the index of the item in the array. The size of the array is controlled by the address_count property.

address_name Property

This property contains the textual name of the custom property.

Syntax

def get_address_name(address_index: int) -> str: ...
def set_address_name(address_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the textual name of the custom property.

The address_index parameter specifies the index of the item in the array. The size of the array is controlled by the address_count property.

address_value Property

This property contains the value of the custom property.

Syntax

def get_address_value(address_index: int) -> str: ...
def set_address_value(address_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the value of the custom property.

The address_index parameter specifies the index of the item in the array. The size of the array is controlled by the address_count property.

anniversary_attribute Property

This property contains an optional attribute of the custom property.

Syntax

def get_anniversary_attribute() -> str: ...
def set_anniversary_attribute(value: str) -> None: ...

anniversary_attribute = property(get_anniversary_attribute, set_anniversary_attribute)

Default Value

""

Remarks

This property contains an optional attribute of the custom property.

anniversary_name Property

This property contains the textual name of the custom property.

Syntax

def get_anniversary_name() -> str: ...
def set_anniversary_name(value: str) -> None: ...

anniversary_name = property(get_anniversary_name, set_anniversary_name)

Default Value

""

Remarks

This property contains the textual name of the custom property.

anniversary_value Property

This property contains the value of the custom property.

Syntax

def get_anniversary_value() -> str: ...
def set_anniversary_value(value: str) -> None: ...

anniversary_value = property(get_anniversary_value, set_anniversary_value)

Default Value

""

Remarks

This property contains the value of the custom property.

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.

birth_day_attribute Property

This property contains an optional attribute of the custom property.

Syntax

def get_birth_day_attribute() -> str: ...
def set_birth_day_attribute(value: str) -> None: ...

birth_day_attribute = property(get_birth_day_attribute, set_birth_day_attribute)

Default Value

""

Remarks

This property contains an optional attribute of the custom property.

birth_day_name Property

This property contains the textual name of the custom property.

Syntax

def get_birth_day_name() -> str: ...
def set_birth_day_name(value: str) -> None: ...

birth_day_name = property(get_birth_day_name, set_birth_day_name)

Default Value

""

Remarks

This property contains the textual name of the custom property.

birth_day_value Property

This property contains the value of the custom property.

Syntax

def get_birth_day_value() -> str: ...
def set_birth_day_value(value: str) -> None: ...

birth_day_value = property(get_birth_day_value, set_birth_day_value)

Default Value

""

Remarks

This property contains the value of the custom property.

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.

custom_property_count Property

The number of records in the CustomProperty arrays.

Syntax

def get_custom_property_count() -> int: ...
def set_custom_property_count(value: int) -> None: ...

custom_property_count = property(get_custom_property_count, set_custom_property_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• custom_property_attribute
• custom_property_name
• custom_property_value

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

custom_property_attribute Property

This property contains an optional attribute of the custom property.

Syntax

def get_custom_property_attribute(custom_property_index: int) -> str: ...
def set_custom_property_attribute(custom_property_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains an optional attribute of the custom property.

The custom_property_index parameter specifies the index of the item in the array. The size of the array is controlled by the custom_property_count property.

custom_property_name Property

This property contains the textual name of the custom property.

Syntax

def get_custom_property_name(custom_property_index: int) -> str: ...
def set_custom_property_name(custom_property_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the textual name of the custom property.

The custom_property_index parameter specifies the index of the item in the array. The size of the array is controlled by the custom_property_count property.

custom_property_value Property

This property contains the value of the custom property.

Syntax

def get_custom_property_value(custom_property_index: int) -> str: ...
def set_custom_property_value(custom_property_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the value of the custom property.

The custom_property_index parameter specifies the index of the item in the array. The size of the array is controlled by the custom_property_count property.

e_mail_count Property

The number of records in the EMail arrays.

Syntax

def get_e_mail_count() -> int: ...
def set_e_mail_count(value: int) -> None: ...

e_mail_count = property(get_e_mail_count, set_e_mail_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• e_mail_attribute
• e_mail_name
• e_mail_value

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

e_mail_attribute Property

This property contains an optional attribute of the custom property.

Syntax

def get_e_mail_attribute(e_mail_index: int) -> str: ...
def set_e_mail_attribute(e_mail_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains an optional attribute of the custom property.

The e_mail_index parameter specifies the index of the item in the array. The size of the array is controlled by the e_mail_count property.

e_mail_name Property

This property contains the textual name of the custom property.

Syntax

def get_e_mail_name(e_mail_index: int) -> str: ...
def set_e_mail_name(e_mail_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the textual name of the custom property.

The e_mail_index parameter specifies the index of the item in the array. The size of the array is controlled by the e_mail_count property.

e_mail_value Property

This property contains the value of the custom property.

Syntax

def get_e_mail_value(e_mail_index: int) -> str: ...
def set_e_mail_value(e_mail_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the value of the custom property.

The e_mail_index parameter specifies the index of the item in the array. The size of the array is controlled by the e_mail_count property.

e_tag Property

Identifier returned by the CardDAV server which is used to synchronize edits.

Syntax

def get_e_tag() -> str: ...
def set_e_tag(value: str) -> None: ...

e_tag = property(get_e_tag, set_e_tag)

Default Value

""

Remarks

This property identifies the state of the contact in the address book. e_tag is returned by the CardDAV server after a successful create_contact request. Every time a contact is updated, the e_tag changes. This gives you the ability to determine if another user has changed the contact you added.

You can use the e_tag value to maintain a cache. If you submit a get_addressbook_report request with the report_filter_return_contact_data property set to False, only the ResourceURI and ETag for each contact in the address book will be returned in from on_contact_details. You can cache the ETag; and URI locally, and then inspect the report for any changes and update only the contacts that have changed ETags.

This property is filled from the response to a get_contact, and is also used when creating a contact to be added using the create_contact method. However, when requesting a report using the get_addressbook_report method, the contents of this property will only be valid inside the on_contact_details event.

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.

formatted_name Property

The formatted name of the contact.

Syntax

def get_formatted_name() -> str: ...
def set_formatted_name(value: str) -> None: ...

formatted_name = property(get_formatted_name, set_formatted_name)

Default Value

""

Remarks

This property is used to specify the formatted name of the contact. It can be a single text value based on the semantics of the X.520 Common Name attribute. It is required when creating a contact.

This property is filled from the response to a get_contact, and is also used when creating a contact to be added using the create_contact method. However, when requesting a report using the get_addressbook_report method, the contents of this property will only be valid inside the on_contact_details event.

gender Property

The sex and gender identity of a contact.

Syntax

def get_gender() -> str: ...
def set_gender(value: str) -> None: ...

gender = property(get_gender, set_gender)

Default Value

""

Remarks

This property is used to specify the sex and gender identity of a contact. It must be a single structured value with two parts, which are optional, separated by a semicolon.

The first part is the sex (biological), which could be:

• M (male)
• F (female)
• O (other)
• N (None)
• U (Unknown)

This property is filled from the response to a get_contact, and is also used when creating a contact to be added using the create_contact method. However, when requesting a report using the get_addressbook_report method, the contents of this property will only be valid inside the on_contact_details event.

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.

kind Property

The kind of object the vCard represents.

Syntax

def get_kind() -> str: ...
def set_kind(value: str) -> None: ...

kind = property(get_kind, set_kind)

Default Value

""

Remarks

This property is used to specify the kind of object the contact represents. The value may be:

• individual for a vCard representing a single person or entity.
• group for a vCard representing a group of persons or entities.
• org for a vCard representing an organization.
• location for a named geographical place.

This property is filled from the response to a get_contact, and is also used when creating a contact to be added using the create_contact method. However, when requesting a report using the get_addressbook_report method, the contents of this property will only be valid inside the on_contact_details event.

language_count Property

The number of records in the Language arrays.

Syntax

def get_language_count() -> int: ...
def set_language_count(value: int) -> None: ...

language_count = property(get_language_count, set_language_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• language_attribute
• language_name
• language_value

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

language_attribute Property

This property contains an optional attribute of the custom property.

Syntax

def get_language_attribute(language_index: int) -> str: ...
def set_language_attribute(language_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains an optional attribute of the custom property.

The language_index parameter specifies the index of the item in the array. The size of the array is controlled by the language_count property.

language_name Property

This property contains the textual name of the custom property.

Syntax

def get_language_name(language_index: int) -> str: ...
def set_language_name(language_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the textual name of the custom property.

The language_index parameter specifies the index of the item in the array. The size of the array is controlled by the language_count property.

language_value Property

This property contains the value of the custom property.

Syntax

def get_language_value(language_index: int) -> str: ...
def set_language_value(language_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the value of the custom property.

The language_index parameter specifies the index of the item in the array. The size of the array is controlled by the language_count property.

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.

names Property

The name of a contact.

Syntax

def get_names() -> str: ...
def set_names(value: str) -> None: ...

names = property(get_names, set_names)

Default Value

""

Remarks

This property is used to specify the name of a contact. It can be a single structured text value. The structured type value corresponds, in sequence, to the Family Name, Given Name, Additional Names, Honorific Prefixes, and Honorific Suffixes. The text components are separated by the SEMI-COLON character (ASCII decimal 59). Individual text components can include multiple text values (e.g., multiple Additional Names) separated by the COMMA character (ASCII decimal 44).

This property is filled from the response to a get_contact, and is also used when creating a contact to be added using the create_contact method. However, when requesting a report using the get_addressbook_report method, the contents of this property will only be valid inside the on_contact_details event.

nick_name Property

The nickname of the object the vCard represents.

Syntax

def get_nick_name() -> str: ...
def set_nick_name(value: str) -> None: ...

nick_name = property(get_nick_name, set_nick_name)

Default Value

""

Remarks

This property is used to specify the text corresponding to the nickname of a contact. It can be a single text value or a list of comma separated text values.

This property is filled from the response to a get_contact, and is also used when creating a contact to be added using the create_contact method. However, when requesting a report using the get_addressbook_report method, the contents of this property will only be valid inside the on_contact_details event.

note Property

Provides additional information or comments about a contact.

Syntax

def get_note() -> str: ...
def set_note(value: str) -> None: ...

note = property(get_note, set_note)

Default Value

""

Remarks

This property is used to provide supplementary information or comments about a contact. It is typically used to record details such as personal preferences, specific instructions, reminders, or any other relevant information pertaining to the contact.

This property is filled from the response to a get_contact, and is also used when creating a contact to be added using the create_contact method. However, when requesting a report using the get_addressbook_report method, the contents of this property will only be valid inside the on_contact_details event.

organization Property

The organizational name and units associated with a contact.

Syntax

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

organization = property(get_organization, set_organization)

Default Value

""

Remarks

This property is used to specify the name of the organization and its units with which the contact is affiliated. It consists of one or more text values representing the organization's name and any additional units or divisions within the organization. The text components are separated by the SEMI-COLON character (ASCII decimal 59). Below is an example on how to use this property: cardDAV.Organization = "ABC Inc.;North American Division;Marketing";

This property is filled from the response to a get_contact, and is also used when creating a contact to be added using the create_contact method. However, when requesting a report using the get_addressbook_report method, the contents of this property will only be valid inside the on_contact_details event.

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.

For CardDAV, the "If-Match" header is extremely useful. After adding a contact with create_contact or retrieving a contact with get_contact, the e_tag property will contain a value indicating the current state of the contact. If you wish to update the contact, you may pass this returned e_tag in an "If-Match" header. If the contact on the server has been modified since you retrieved it (and the ETag on the server has changed), then the create_contact will fail with an HTTP Protocol Error: "409 Conflict", which indicates there is a conflict between the version you're trying to update and the current version on the sever. For instance: cardDAV.OtherHeaders = "If-Match: 1900-1900\r\ n";

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.

phone_number_count Property

The number of records in the PhoneNumber arrays.

Syntax

def get_phone_number_count() -> int: ...
def set_phone_number_count(value: int) -> None: ...

phone_number_count = property(get_phone_number_count, set_phone_number_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• phone_number_attribute
• phone_number_name
• phone_number_value

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

phone_number_attribute Property

This property contains an optional attribute of the custom property.

Syntax

def get_phone_number_attribute(phone_number_index: int) -> str: ...
def set_phone_number_attribute(phone_number_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains an optional attribute of the custom property.

The phone_number_index parameter specifies the index of the item in the array. The size of the array is controlled by the phone_number_count property.

phone_number_name Property

This property contains the textual name of the custom property.

Syntax

def get_phone_number_name(phone_number_index: int) -> str: ...
def set_phone_number_name(phone_number_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the textual name of the custom property.

The phone_number_index parameter specifies the index of the item in the array. The size of the array is controlled by the phone_number_count property.

phone_number_value Property

This property contains the value of the custom property.

Syntax

def get_phone_number_value(phone_number_index: int) -> str: ...
def set_phone_number_value(phone_number_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the value of the custom property.

The phone_number_index parameter specifies the index of the item in the array. The size of the array is controlled by the phone_number_count property.

photo_attribute Property

This property contains an optional attribute of the custom property.

Syntax

def get_photo_attribute() -> str: ...
def set_photo_attribute(value: str) -> None: ...

photo_attribute = property(get_photo_attribute, set_photo_attribute)

Default Value

""

Remarks

This property contains an optional attribute of the custom property.

photo_name Property

This property contains the textual name of the custom property.

Syntax

def get_photo_name() -> str: ...
def set_photo_name(value: str) -> None: ...

photo_name = property(get_photo_name, set_photo_name)

Default Value

""

Remarks

This property contains the textual name of the custom property.

photo_value Property

This property contains the value of the custom property.

Syntax

def get_photo_value() -> str: ...
def set_photo_value(value: str) -> None: ...

photo_value = property(get_photo_value, set_photo_value)

Default Value

""

Remarks

This property contains the value of the custom property.

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.

report_filter_custom_filter Property

Allows the user to specify his own filter XML.

Syntax

def get_report_filter_custom_filter() -> str: ...
def set_report_filter_custom_filter(value: str) -> None: ...

report_filter_custom_filter = property(get_report_filter_custom_filter, set_report_filter_custom_filter)

Default Value

""

Remarks

Allows the user to specify his own filter XML. This property must be properly-formed XML, and must be a supported CardDAV filter or the class fails with an error.

report_filter_property Property

Limits the contacts returned in a Report to only those which contain a matching property name and value.

Syntax

def get_report_filter_property() -> str: ...
def set_report_filter_property(value: str) -> None: ...

report_filter_property = property(get_report_filter_property, set_report_filter_property)

Default Value

""

Remarks

Limits the contacts returned in a Report to only those which contain a matching property name and value. For instance, setting the report_filter_property filter to "NickName" will return only contacts that have a nick name specified. Setting the report_filter_property filter to "FN=John" will return only contacts where the formatted name is equal or contains "John". Likewise, you can retrieve a report on a single contact by setting the report_filter_property filter with the UID of the needed resource. For example: report_filter_property = "UID=5674303C-0397-4568-82ED-98418FBB08B0.vcf";.

You may add multiple properties to the filter by separating them with commas. For example: "FN=John, GENDER=M".

For more advanced filtering, you may specify your own report_filter_custom_filter.

report_filter_return_contact_data Property

Controls whether the contents of each contact is returned in the report.

Syntax

def get_report_filter_return_contact_data() -> bool: ...
def set_report_filter_return_contact_data(value: bool) -> None: ...

report_filter_return_contact_data = property(get_report_filter_return_contact_data, set_report_filter_return_contact_data)

Default Value

TRUE

Remarks

Controls whether the contents of each contact is returned in the report.

If report_filter_return_contact_data is True (default), a report will contain the full contents of each contact in the address book. This can be a substantially large amount of data. However if report_filter_return_contact_data is False, the report returned will contain only URIs and ETags of each contact. You may compare the URIs against a cached list and retrieve any new URIs individually via the CardDAV.GetContact method. If the ETag for a cached URI has changed, it means that the contact has changed, and needs to be retrieved.

report_filter_uid Property

Limits the contacts returned in the report to only those with the specified UID.

Syntax

def get_report_filter_uid() -> str: ...
def set_report_filter_uid(value: str) -> None: ...

report_filter_uid = property(get_report_filter_uid, set_report_filter_uid)

Default Value

""

Remarks

Limits the contacts returned in the report to only those with the specified UID.

role Property

The function or part played in a particular situation by a contact.

Syntax

def get_role() -> str: ...
def set_role(value: str) -> None: ...

role = property(get_role, set_role)

Default Value

""

Remarks

The value of this property should be a single text value representing the role of the contact. This property provides additional contextual information about the contact's position within an organization or their function in a specific context.

This property is filled from the response to a get_contact, and is also used when creating a contact to be added using the create_contact method. However, when requesting a report using the get_addressbook_report method, the contents of this property will only be valid inside the on_contact_details event.

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.

title Property

The position or job of the object the vCard represents.

Syntax

def get_title() -> str: ...
def set_title(value: str) -> None: ...

title = property(get_title, set_title)

Default Value

""

Remarks

This property is used to specify the position or job of the object the vCard represents. Its value should be a single text value representing the title or honorific prefix of the contact.

This property is filled from the response to a get_contact, and is also used when creating a contact to be added using the create_contact method. However, when requesting a report using the get_addressbook_report method, the contents of this property will only be valid inside the on_contact_details event.

uid Property

A persistent, globally unique identifier for the contact.

Syntax

def get_uid() -> str: ...
def set_uid(value: str) -> None: ...

uid = property(get_uid, set_uid)

Default Value

""

Remarks

The value of the uid property should be a single text value that uniquely identifies a contact. This identifier remains consistent across modifications and updates to the contact, ensuring stable reference and synchronization. To generate a uid you can generate an ID based on a combination of timestamp and a random value or just a timestamp.

This property is filled from the response to a get_contact, and is also used when creating a contact to be added using the create_contact method. However, when requesting a report using the get_addressbook_report method, the contents of this property will only be valid inside the on_contact_details event.

url Property

Location of the contact resource on the CardDAV server.

Syntax

def get_url() -> str: ...

url = property(get_url, None)

Default Value

""

Remarks

This property is read-only, and will be filled with the location of the contact resource for each contact returned. This will only be returned in response to get_addressbook_report.

This property is filled from the response to a get_contact, and is also used when creating a contact to be added using the create_contact method. However, when requesting a report using the get_addressbook_report method, the contents of this property will only be valid inside the on_contact_details event.

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.

v_card_version Property

The vCard version format.

Syntax

def get_v_card_version() -> str: ...
def set_v_card_version(value: str) -> None: ...

v_card_version = property(get_v_card_version, set_v_card_version)

Default Value

""

Remarks

This property is used to specify the version of the vCard specification used to format this vCard. Its value should be a single text value indicating the version of the vCard format being used. Typically, this value will be "3.0" or "4.0" to denote the version of the vCard specification adhered to.

This property is filled from the response to a get_contact, and is also used when creating a contact to be added using the create_contact method. However, when requesting a report using the get_addressbook_report method, the contents of this property will only be valid inside the on_contact_details event.

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_custom_property Method

Adds a form variable and the corresponding value.

Syntax

def add_custom_property(var_name: str, var_value: str) -> None: ...

Remarks

This property adds a form variable and the corresponding value. For information on form variables and how they are managed, please refer to the custom_properties properties.

Example using the add_custom_property method:

CardDAV.Reset() CardDAV.AddCustomProperty("propname1", "propvalue1") CardDAV.AddCustomProperty("propname2", "propvalue2") Example using Custom Property arrays: CardDAV.Reset() CardDAV.CustomPropertyCount = 2 CardDAV.CustomPropertyName (0) = "propname1" CardDAV.CustomPropertyValue(0) = "propvalue1" CardDAV.CustomPropertyName (1) = "propname2" CardDAV.CustomPropertyValue(1) = "propvalue2"

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.

copy_contact Method

Copy contact to a new location.

Syntax

def copy_contact(source_resource_uri: str, destination_resource_uri: str) -> None: ...

Remarks

The copy_contact method will copy the resource indicated by SourceResourceURI to a new location under the resource indicated by DestinationResourceURI.

Note that neither Yahoo nor Google CardDAV servers support copying, or moving address book resources.

There is no standard format for a resource URI. Google for instance, uses "https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default" address to access the default address book. Here is an example of using the get_addressbook_report, that makes a REPORT request to the given URI in the CardDAV server. cardDAV.GetAddressbookReport("https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default");

Generally, the URI format would be something like "https://mydavserver/.well-known/carddav/Address_Book_Name". To add, delete, update, copy or move a contact from an address book, you can add its file name at the end of the address book URI, which typically has a vcf extension (not always). Usually the filename of a contact would be the same as the uid of the contact plus the vcf extension, but this depends on the way the CardDAV server manages resources. This is the resource URI you must use to retrieve the contact with get_contact. For example: cardDAV.GetContact("https://mydavserver/.well-known/carddav/Address_Book_Name/1234567890.vcf");

The examples below show a few possible transactions: cardDAV.User = "username"; cardDAV.Password = "password"; cardDAV.CreateAddressbook("https://mydavserver/.well-known/carddav/Address_Book_Name/", "My Address book", "My Address books"); cardDAV.FormattedName = "Mr. John Q. Public\, Esq."; cardDAV.PhoneNumbers.Add(new CardCustomProp("tel", "123456790")); cardDAV.CreateContact("https://mydavserver/.well-known/carddav/Address_Book_Name/123456789.vcf"); cardDAV.GetAddressbookReport("https://mydavserver/.well-known/carddav/Address_Book_Name/"); NextCloud's ResourceURIs always start with "http://www.nextcloud.com/remote.php/dav/addressbooks/users/" plus your user name, plus the name of your address book. For instance: "http://www.nextcloud.com/remote.php/dav/addressbooks/users/username/Contacts" for the default address book. Contact resources are located directly under the "username/Contacts" or "username/My_Addressbook" path. Here the filename doesn't have to be identical to the UID.

create_addressbook Method

Creates a new address book collection resource.

Syntax

def create_addressbook(resource_uri: str, display_name: str, description: str) -> None: ...

Remarks

The create_addressbook method creates a new address book collection resource. A server MAY restrict address book collection creation to particular collections.

Creating address book collections is not supported by all CardDAV servers. Some address book stores only support one address book per user (or principal), and those are typically pre-created for each account.

The DisplayName and Description parameters should be set to a human readable display name and description of the address book.

To successfully create an address book, the ResourceURI cannot already exist, and must point to a valid location where a new address book can be created. The DAV:bind privilege MUST be granted to the current user on the parent collection of the specified ResourceURI.

The following example shows how to create a simple new address book collection resource. cardDAV.CreateAddressbook("https://mydavserver/.well-known/carddav/TestAddressbook1", "My Display Name", "My Addressbook Description");

Note that Google does not support creating a new address book through CardDAV.

There is no standard format for a resource URI. Google for instance, uses "https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default" address to access the default address book. Here is an example of using the get_addressbook_report, that makes a REPORT request to the given URI in the CardDAV server. cardDAV.GetAddressbookReport("https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default");

Generally, the URI format would be something like "https://mydavserver/.well-known/carddav/Address_Book_Name". To add, delete, update, copy or move a contact from an address book, you can add its file name at the end of the address book URI, which typically has a vcf extension (not always). Usually the filename of a contact would be the same as the uid of the contact plus the vcf extension, but this depends on the way the CardDAV server manages resources. This is the resource URI you must use to retrieve the contact with get_contact. For example: cardDAV.GetContact("https://mydavserver/.well-known/carddav/Address_Book_Name/1234567890.vcf");

The examples below show a few possible transactions: cardDAV.User = "username"; cardDAV.Password = "password"; cardDAV.CreateAddressbook("https://mydavserver/.well-known/carddav/Address_Book_Name/", "My Address book", "My Address books"); cardDAV.FormattedName = "Mr. John Q. Public\, Esq."; cardDAV.PhoneNumbers.Add(new CardCustomProp("tel", "123456790")); cardDAV.CreateContact("https://mydavserver/.well-known/carddav/Address_Book_Name/123456789.vcf"); cardDAV.GetAddressbookReport("https://mydavserver/.well-known/carddav/Address_Book_Name/"); NextCloud's ResourceURIs always start with "http://www.nextcloud.com/remote.php/dav/addressbooks/users/" plus your user name, plus the name of your address book. For instance: "http://www.nextcloud.com/remote.php/dav/addressbooks/users/username/Contacts" for the default address book. Contact resources are located directly under the "username/Contacts" or "username/My_Addressbook" path. Here the filename doesn't have to be identical to the UID.

create_contact Method

Adds a contact resource at the specified ResourceURI using the CardDAV PUT method.

Syntax

def create_contact(resource_uri: str) -> None: ...

Remarks

This method adds a new contact to the address book collection at the specified ResourceURI. The ResourceURI must be a fully qualified URL to the location on the CardDAV server to which this contact will be saved. If the ResourceURI already exists, the contact at that URI will be overwritten.

The following properties are used when calling create_contact, update_contact or export_vcf, and will be filled after calling get_contact or import_vcf. These will also be available from inside the on_contact_details event, which is fired for each contact received from the CardDAV server in response when calling get_addressbook_report.

• AddressLabels
• addresses
• Agent
• anniversary
• birth_day
• Categories
• Classification
• ContactURL
• custom_properties
• Depth
• e_mails
• formatted_name
• gender
• GeoLocation
• IMPPs
• kind
• languages
• Logo
• Mailer
• Member
• names
• nick_name
• note
• organization
• phone_numbers
• photo
• ProductId
• PublicKey
• Related
• RevisionTime
• role
• SortString
• Sound
• Timezone
• title
• uid
• url
• v_card_version
• XML

There is no standard format for a resource URI. Google for instance, uses "https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default" address to access the default address book. Here is an example of using the get_addressbook_report, that makes a REPORT request to the given URI in the CardDAV server. cardDAV.GetAddressbookReport("https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default");

Generally, the URI format would be something like "https://mydavserver/.well-known/carddav/Address_Book_Name". To add, delete, update, copy or move a contact from an address book, you can add its file name at the end of the address book URI, which typically has a vcf extension (not always). Usually the filename of a contact would be the same as the uid of the contact plus the vcf extension, but this depends on the way the CardDAV server manages resources. This is the resource URI you must use to retrieve the contact with get_contact. For example: cardDAV.GetContact("https://mydavserver/.well-known/carddav/Address_Book_Name/1234567890.vcf");

The examples below show a few possible transactions: cardDAV.User = "username"; cardDAV.Password = "password"; cardDAV.CreateAddressbook("https://mydavserver/.well-known/carddav/Address_Book_Name/", "My Address book", "My Address books"); cardDAV.FormattedName = "Mr. John Q. Public\, Esq."; cardDAV.PhoneNumbers.Add(new CardCustomProp("tel", "123456790")); cardDAV.CreateContact("https://mydavserver/.well-known/carddav/Address_Book_Name/123456789.vcf"); cardDAV.GetAddressbookReport("https://mydavserver/.well-known/carddav/Address_Book_Name/"); NextCloud's ResourceURIs always start with "http://www.nextcloud.com/remote.php/dav/addressbooks/users/" plus your user name, plus the name of your address book. For instance: "http://www.nextcloud.com/remote.php/dav/addressbooks/users/username/Contacts" for the default address book. Contact resources are located directly under the "username/Contacts" or "username/My_Addressbook" path. Here the filename doesn't have to be identical to the UID.

delete_addressbook Method

Deletes an address book collection resource.

Syntax

def delete_addressbook(resource_uri: str) -> None: ...

Remarks

This method deletes an address book collection resource specified by ResourceURI. To successfully delete an address book, the ResourceURI should already exist, and must point to a valid location where an address book can be deleted. The DAV:bind privilege MUST be granted to the current user on the parent collection of the specified ResourceURI.

The following example shows how to delete an address book collection resource: cardDAV.DeleteAddressbook("https://mydavserver/.well-known/carddav/TestAddressbook1"); In a NextCloud server, if all address books are deleted, a new address book "Contacts" is automatically created.

Note that Google does not support deleting an address book through CardDAV.

There is no standard format for a resource URI. Google for instance, uses "https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default" address to access the default address book. Here is an example of using the get_addressbook_report, that makes a REPORT request to the given URI in the CardDAV server. cardDAV.GetAddressbookReport("https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default");

Generally, the URI format would be something like "https://mydavserver/.well-known/carddav/Address_Book_Name". To add, delete, update, copy or move a contact from an address book, you can add its file name at the end of the address book URI, which typically has a vcf extension (not always). Usually the filename of a contact would be the same as the uid of the contact plus the vcf extension, but this depends on the way the CardDAV server manages resources. This is the resource URI you must use to retrieve the contact with get_contact. For example: cardDAV.GetContact("https://mydavserver/.well-known/carddav/Address_Book_Name/1234567890.vcf");

The examples below show a few possible transactions: cardDAV.User = "username"; cardDAV.Password = "password"; cardDAV.CreateAddressbook("https://mydavserver/.well-known/carddav/Address_Book_Name/", "My Address book", "My Address books"); cardDAV.FormattedName = "Mr. John Q. Public\, Esq."; cardDAV.PhoneNumbers.Add(new CardCustomProp("tel", "123456790")); cardDAV.CreateContact("https://mydavserver/.well-known/carddav/Address_Book_Name/123456789.vcf"); cardDAV.GetAddressbookReport("https://mydavserver/.well-known/carddav/Address_Book_Name/"); NextCloud's ResourceURIs always start with "http://www.nextcloud.com/remote.php/dav/addressbooks/users/" plus your user name, plus the name of your address book. For instance: "http://www.nextcloud.com/remote.php/dav/addressbooks/users/username/Contacts" for the default address book. Contact resources are located directly under the "username/Contacts" or "username/My_Addressbook" path. Here the filename doesn't have to be identical to the UID.

delete_contact Method

Deletes a resource.

Syntax

def delete_contact(resource_uri: str) -> None: ...

Remarks

This method is used to delete the resource specified by ResourceURI. ResourceURI is first removed from any collection in which it is contained, it is then removed from the server.

There is no standard format for a resource URI. Google for instance, uses "https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default" address to access the default address book. Here is an example of using the get_addressbook_report, that makes a REPORT request to the given URI in the CardDAV server. cardDAV.GetAddressbookReport("https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default");

Generally, the URI format would be something like "https://mydavserver/.well-known/carddav/Address_Book_Name". To add, delete, update, copy or move a contact from an address book, you can add its file name at the end of the address book URI, which typically has a vcf extension (not always). Usually the filename of a contact would be the same as the uid of the contact plus the vcf extension, but this depends on the way the CardDAV server manages resources. This is the resource URI you must use to retrieve the contact with get_contact. For example: cardDAV.GetContact("https://mydavserver/.well-known/carddav/Address_Book_Name/1234567890.vcf");

The examples below show a few possible transactions: cardDAV.User = "username"; cardDAV.Password = "password"; cardDAV.CreateAddressbook("https://mydavserver/.well-known/carddav/Address_Book_Name/", "My Address book", "My Address books"); cardDAV.FormattedName = "Mr. John Q. Public\, Esq."; cardDAV.PhoneNumbers.Add(new CardCustomProp("tel", "123456790")); cardDAV.CreateContact("https://mydavserver/.well-known/carddav/Address_Book_Name/123456789.vcf"); cardDAV.GetAddressbookReport("https://mydavserver/.well-known/carddav/Address_Book_Name/"); NextCloud's ResourceURIs always start with "http://www.nextcloud.com/remote.php/dav/addressbooks/users/" plus your user name, plus the name of your address book. For instance: "http://www.nextcloud.com/remote.php/dav/addressbooks/users/username/Contacts" for the default address book. Contact resources are located directly under the "username/Contacts" or "username/My_Addressbook" path. Here the filename doesn't have to be identical to the UID.

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.

export_vcf Method

Generates a contact from the properties in the vCard format.

Syntax

def export_vcf() -> str: ...

Remarks

The export_vcf method is used to create a contact and export it in the vCard/VCF format, which can then be saved to disk and imported using any other software, even those that do not support CardDAV. The export_vcf method will create the exact same data as the create_contact method sends when adding or updating a contact to an address book.

Note that if export_vcf is called immediately after a successful get_contact, the unmodified data returned from the CardDAV server will be returned. However if any properties are changed between the get_contact and export_vcf calls, the class will generate and return a brand new contact.

The following properties are used when calling create_contact, update_contact or export_vcf, and will be filled after calling get_contact or import_vcf. These will also be available from inside the on_contact_details event, which is fired for each contact received from the CardDAV server in response when calling get_addressbook_report.

• AddressLabels
• addresses
• Agent
• anniversary
• birth_day
• Categories
• Classification
• ContactURL
• custom_properties
• Depth
• e_mails
• formatted_name
• gender
• GeoLocation
• IMPPs
• kind
• languages
• Logo
• Mailer
• Member
• names
• nick_name
• note
• organization
• phone_numbers
• photo
• ProductId
• PublicKey
• Related
• RevisionTime
• role
• SortString
• Sound
• Timezone
• title
• uid
• url
• v_card_version
• XML

get_addressbook_options Method

Retrieves options for the ResourceURI to determine whether it supports address book access.

Syntax

def get_addressbook_options(resource_uri: str) -> None: ...

Remarks

This method sends a request to the indicated ResourceURI. The server's response is available in the on_header event. If a server supports CardDAV address book access, the "DAV" header will contain the string "address book". The allowable CardDAV and WebDAV methods may also be returned in the "Allow" header.

For instance, the following headers may be returned from a call to the get_addressbook_options method:

There is no standard format for a resource URI. Google for instance, uses "https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default" address to access the default address book. Here is an example of using the get_addressbook_report, that makes a REPORT request to the given URI in the CardDAV server. cardDAV.GetAddressbookReport("https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default");

Generally, the URI format would be something like "https://mydavserver/.well-known/carddav/Address_Book_Name". To add, delete, update, copy or move a contact from an address book, you can add its file name at the end of the address book URI, which typically has a vcf extension (not always). Usually the filename of a contact would be the same as the uid of the contact plus the vcf extension, but this depends on the way the CardDAV server manages resources. This is the resource URI you must use to retrieve the contact with get_contact. For example: cardDAV.GetContact("https://mydavserver/.well-known/carddav/Address_Book_Name/1234567890.vcf");

The examples below show a few possible transactions: cardDAV.User = "username"; cardDAV.Password = "password"; cardDAV.CreateAddressbook("https://mydavserver/.well-known/carddav/Address_Book_Name/", "My Address book", "My Address books"); cardDAV.FormattedName = "Mr. John Q. Public\, Esq."; cardDAV.PhoneNumbers.Add(new CardCustomProp("tel", "123456790")); cardDAV.CreateContact("https://mydavserver/.well-known/carddav/Address_Book_Name/123456789.vcf"); cardDAV.GetAddressbookReport("https://mydavserver/.well-known/carddav/Address_Book_Name/"); NextCloud's ResourceURIs always start with "http://www.nextcloud.com/remote.php/dav/addressbooks/users/" plus your user name, plus the name of your address book. For instance: "http://www.nextcloud.com/remote.php/dav/addressbooks/users/username/Contacts" for the default address book. Contact resources are located directly under the "username/Contacts" or "username/My_Addressbook" path. Here the filename doesn't have to be identical to the UID.

get_addressbook_report Method

Generates a report on the indicated address book.

Syntax

def get_addressbook_report(resource_uri: str) -> None: ...

Remarks

This method is used to send a request to the address book located at the specified ResourceURI. The report_filter can be used to filter out and return only the contacts you wish to receive. The response to an addressbook-query report will be parsed by the class, and information about the individual contacts will be provided in the on_contact_details event.

The following properties are used when calling create_contact, update_contact or export_vcf, and will be filled after calling get_contact or import_vcf. These will also be available from inside the on_contact_details event, which is fired for each contact received from the CardDAV server in response when calling get_addressbook_report.

• AddressLabels
• addresses
• Agent
• anniversary
• birth_day
• Categories
• Classification
• ContactURL
• custom_properties
• Depth
• e_mails
• formatted_name
• gender
• GeoLocation
• IMPPs
• kind
• languages
• Logo
• Mailer
• Member
• names
• nick_name
• note
• organization
• phone_numbers
• photo
• ProductId
• PublicKey
• Related
• RevisionTime
• role
• SortString
• Sound
• Timezone
• title
• uid
• url
• v_card_version
• XML

For example: cardDAV.User = "myusername"; cardDAV.Password = "mypassword"; cardDAV.GetAddressbookReport("https://www.googleapis.com/carddav/v1/principals/user@gmail.com/lists/default"); The following code inside the on_contact_details event will print the formatted name, phone number and email for each contact: Private Sub CardDAV_ContactDetails(ResourceURI As String, ResponseStatus As String, ETag As String, ContactData As String) Debug.Print cardDAV.FormattedName + " " + cardDAV.PhoneNumbers[0].Value + " " + cardDAV.EMails[0].Value End Sub The output from the above code will look like this:

John Smith  123-456-7890  john@example.com
Jane Doe  555-555-5555  jane@example.com
Alice Johnson 987-654-3210  alice@example.com 

There is no standard format for a resource URI. Google for instance, uses "https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default" address to access the default address book. Here is an example of using the get_addressbook_report, that makes a REPORT request to the given URI in the CardDAV server. cardDAV.GetAddressbookReport("https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default");

Generally, the URI format would be something like "https://mydavserver/.well-known/carddav/Address_Book_Name". To add, delete, update, copy or move a contact from an address book, you can add its file name at the end of the address book URI, which typically has a vcf extension (not always). Usually the filename of a contact would be the same as the uid of the contact plus the vcf extension, but this depends on the way the CardDAV server manages resources. This is the resource URI you must use to retrieve the contact with get_contact. For example: cardDAV.GetContact("https://mydavserver/.well-known/carddav/Address_Book_Name/1234567890.vcf");

The examples below show a few possible transactions: cardDAV.User = "username"; cardDAV.Password = "password"; cardDAV.CreateAddressbook("https://mydavserver/.well-known/carddav/Address_Book_Name/", "My Address book", "My Address books"); cardDAV.FormattedName = "Mr. John Q. Public\, Esq."; cardDAV.PhoneNumbers.Add(new CardCustomProp("tel", "123456790")); cardDAV.CreateContact("https://mydavserver/.well-known/carddav/Address_Book_Name/123456789.vcf"); cardDAV.GetAddressbookReport("https://mydavserver/.well-known/carddav/Address_Book_Name/"); NextCloud's ResourceURIs always start with "http://www.nextcloud.com/remote.php/dav/addressbooks/users/" plus your user name, plus the name of your address book. For instance: "http://www.nextcloud.com/remote.php/dav/addressbooks/users/username/Contacts" for the default address book. Contact resources are located directly under the "username/Contacts" or "username/My_Addressbook" path. Here the filename doesn't have to be identical to the UID.

get_contact Method

Retrieves a single contact from the CardDAV server.

Syntax

def get_contact(resource_uri: str) -> None: ...

Remarks

This method retrieves a single contact from a server. The ResourceURI points to the exact location of the vCard (*.vcf) file you wish to retrieve. (If you do not know the URL of the contact you need, you can use get_addressbook_report along with the report_filter property to find it.)

The contact will be retrieved using the WebDAV GET method. The full response is delivered through the on_transfer event and the HTTP response headers through the on_header event. After a contact is retrieved with this method, the class parses the contact data into properties. You may then edit these properties and use update_contact to update the contact resource.

The following properties are used when calling create_contact, update_contact or export_vcf, and will be filled after calling get_contact or import_vcf. These will also be available from inside the on_contact_details event, which is fired for each contact received from the CardDAV server in response when calling get_addressbook_report.

• AddressLabels
• addresses
• Agent
• anniversary
• birth_day
• Categories
• Classification
• ContactURL
• custom_properties
• Depth
• e_mails
• formatted_name
• gender
• GeoLocation
• IMPPs
• kind
• languages
• Logo
• Mailer
• Member
• names
• nick_name
• note
• organization
• phone_numbers
• photo
• ProductId
• PublicKey
• Related
• RevisionTime
• role
• SortString
• Sound
• Timezone
• title
• uid
• url
• v_card_version
• XML

There is no standard format for a resource URI. Google for instance, uses "https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default" address to access the default address book. Here is an example of using the get_addressbook_report, that makes a REPORT request to the given URI in the CardDAV server. cardDAV.GetAddressbookReport("https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default");

Generally, the URI format would be something like "https://mydavserver/.well-known/carddav/Address_Book_Name". To add, delete, update, copy or move a contact from an address book, you can add its file name at the end of the address book URI, which typically has a vcf extension (not always). Usually the filename of a contact would be the same as the uid of the contact plus the vcf extension, but this depends on the way the CardDAV server manages resources. This is the resource URI you must use to retrieve the contact with get_contact. For example: cardDAV.GetContact("https://mydavserver/.well-known/carddav/Address_Book_Name/1234567890.vcf");

The examples below show a few possible transactions: cardDAV.User = "username"; cardDAV.Password = "password"; cardDAV.CreateAddressbook("https://mydavserver/.well-known/carddav/Address_Book_Name/", "My Address book", "My Address books"); cardDAV.FormattedName = "Mr. John Q. Public\, Esq."; cardDAV.PhoneNumbers.Add(new CardCustomProp("tel", "123456790")); cardDAV.CreateContact("https://mydavserver/.well-known/carddav/Address_Book_Name/123456789.vcf"); cardDAV.GetAddressbookReport("https://mydavserver/.well-known/carddav/Address_Book_Name/"); NextCloud's ResourceURIs always start with "http://www.nextcloud.com/remote.php/dav/addressbooks/users/" plus your user name, plus the name of your address book. For instance: "http://www.nextcloud.com/remote.php/dav/addressbooks/users/username/Contacts" for the default address book. Contact resources are located directly under the "username/Contacts" or "username/My_Addressbook" path. Here the filename doesn't have to be identical to the UID.

import_vcf Method

Imports contact data (contained in a VCF file) into the class's property list.

Syntax

def import_vcf(contact_data: str) -> None: ...

Remarks

This method is used to load contact data from an external source into the class. You may then submit this data with a call to update_contact or create_contact. If you edit any of the class properties between importing and calling update_contact or create_contact, the class will re-generate the request itself. If no properties are changed, the imported data will be submitted unaltered when calling update_contact or create_contact.

As the contact data is imported, the class will scan ContactData for any contacts. Each time a contact is discovered, the on_contact_details event will fire, and the contact properties will be updated.

After import_vcf completes, the contact properties will be set to the most recent contact found in ContactData.

interrupt Method

This method interrupts the current method.

Syntax

def interrupt() -> None: ...

Remarks

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

list_addressbooks Method

Lists all address books that the current user can access.

Syntax

def list_addressbooks(base_url: str) -> None: ...

Remarks

This method lists all address books the user can access.

The BaseURL parameter must be set to the base CardDAV URL for the server. For instance in the case of Google this is https://www.googleapis.com/carddav/v1/principals/. Other servers may use a format like https://mydavserver/.well-known/carddav/.

When this method is called the class will automatically perform a series of requests to obtain the calendar list. First, the class will send a PROPFIND request to the specified base URL to obtain the current-user-principle. Once the current user has been found, the class will then use that information to send a second PROPFIND request to get addressbook-home-set for the user. The addressbook-home-set is then used by the class to make a final PROPFIND request to get the list of address books for the user.

Once this method returns, the class will populate the Addressbook* properties. For example:

cardDAV.ListAddressbooks("https://mydavserver/.well-known/carddav/Address_Book_Name"); for (int i = 0; i < cardDAV.Addressbooks.Count; i++) { string url = cardDAV.Addressbooks[i].URL; string displayName = cardDAV.Addressbooks[i].DisplayName; }

move_contact Method

Moves one contact resource to a new location.

Syntax

def move_contact(source_resource_uri: str, destination_resource_uri: str) -> None: ...

Remarks

This method will move the resource indicated by SourceResourceURI to a new location under the resource indicated by DestinationResourceURI.

Note that Google CardDAV servers do not support copying, or moving contacts.

There is no standard format for a resource URI. Google for instance, uses "https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default" address to access the default address book. Here is an example of using the get_addressbook_report, that makes a REPORT request to the given URI in the CardDAV server. cardDAV.GetAddressbookReport("https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default");

Generally, the URI format would be something like "https://mydavserver/.well-known/carddav/Address_Book_Name". To add, delete, update, copy or move a contact from an address book, you can add its file name at the end of the address book URI, which typically has a vcf extension (not always). Usually the filename of a contact would be the same as the uid of the contact plus the vcf extension, but this depends on the way the CardDAV server manages resources. This is the resource URI you must use to retrieve the contact with get_contact. For example: cardDAV.GetContact("https://mydavserver/.well-known/carddav/Address_Book_Name/1234567890.vcf");

The examples below show a few possible transactions: cardDAV.User = "username"; cardDAV.Password = "password"; cardDAV.CreateAddressbook("https://mydavserver/.well-known/carddav/Address_Book_Name/", "My Address book", "My Address books"); cardDAV.FormattedName = "Mr. John Q. Public\, Esq."; cardDAV.PhoneNumbers.Add(new CardCustomProp("tel", "123456790")); cardDAV.CreateContact("https://mydavserver/.well-known/carddav/Address_Book_Name/123456789.vcf"); cardDAV.GetAddressbookReport("https://mydavserver/.well-known/carddav/Address_Book_Name/"); NextCloud's ResourceURIs always start with "http://www.nextcloud.com/remote.php/dav/addressbooks/users/" plus your user name, plus the name of your address book. For instance: "http://www.nextcloud.com/remote.php/dav/addressbooks/users/username/Contacts" for the default address book. Contact resources are located directly under the "username/Contacts" or "username/My_Addressbook" path. Here the filename doesn't have to be identical to the UID.

reset Method

Reset the class.

Syntax

def reset() -> None: ...

Remarks

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

send_custom_request Method

Sends a custom request to the server.

Syntax

def send_custom_request(http_method: str, url: str, request_body: str) -> None: ...

Remarks

Allows users to send personalized HTTP commands to a CardDAV server.

Valid values for HttpMethod are:

• GET (default if empty)
• HEAD
• POST
• PUT
• PATCH
• PROPFIND
• PROPPATCH
• MKCOL
• COPY
• MOVE

The value passed for URL is used as the location the request is made to. The RequestBody parameter is used to provide the component with the request body for the request. If no request body is needed for the request, the RequestBody parameter should also then be set to an empty string. Here is an example of how to create a contact: string contactData = @"BEGIN:VCARD PRODID:/n software IPWorks CardDAV Component - www.nsoftware.com UID:20240307T160700Z ANNIVERSARY:19961212 FN:John NICKNAME:John PHOTO:TestURI EMAIL:test@test.com TEL:123456789 END:VCARD"; cardDAV.SendCustomRequest("PUT", "https://mydavserver/.well-known/carddav/AddressbookName/contact.ics", contactData);

update_addressbook Method

Updates an address book collection resource.

Syntax

def update_addressbook(resource_uri: str, ab_index: int) -> None: ...

Remarks

This method updates an existing address book collection at the specified ResourceURI. To successfully update an address book, the ResourceURI should already exist, and must point to a valid location where an address book is saved. First iterate through addressbooks to find the index of the address book to be updated. Set the properties of the address book to the desired values and then make a call to update_addressbook.

The following example shows how to update an address book collection resource: cardDAV.CreateAddressbook("https://mydavserver/.well-known/carddav/TestAddressbook1", "display_name", "description"); cardDAV.Addressbooks[0].DisplayName = "display_name_updated"; cardDAV.Addressbooks[0].Description = "description_updated"; cardDAV.UpdateAddressbook("https://mydavserver/.well-known/carddav/TestAddressbook1", 0);

Note that Google does not support updating an address book through CardDAV.

There is no standard format for a resource URI. Google for instance, uses "https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default" address to access the default address book. Here is an example of using the get_addressbook_report, that makes a REPORT request to the given URI in the CardDAV server. cardDAV.GetAddressbookReport("https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default");

Generally, the URI format would be something like "https://mydavserver/.well-known/carddav/Address_Book_Name". To add, delete, update, copy or move a contact from an address book, you can add its file name at the end of the address book URI, which typically has a vcf extension (not always). Usually the filename of a contact would be the same as the uid of the contact plus the vcf extension, but this depends on the way the CardDAV server manages resources. This is the resource URI you must use to retrieve the contact with get_contact. For example: cardDAV.GetContact("https://mydavserver/.well-known/carddav/Address_Book_Name/1234567890.vcf");

The examples below show a few possible transactions: cardDAV.User = "username"; cardDAV.Password = "password"; cardDAV.CreateAddressbook("https://mydavserver/.well-known/carddav/Address_Book_Name/", "My Address book", "My Address books"); cardDAV.FormattedName = "Mr. John Q. Public\, Esq."; cardDAV.PhoneNumbers.Add(new CardCustomProp("tel", "123456790")); cardDAV.CreateContact("https://mydavserver/.well-known/carddav/Address_Book_Name/123456789.vcf"); cardDAV.GetAddressbookReport("https://mydavserver/.well-known/carddav/Address_Book_Name/"); NextCloud's ResourceURIs always start with "http://www.nextcloud.com/remote.php/dav/addressbooks/users/" plus your user name, plus the name of your address book. For instance: "http://www.nextcloud.com/remote.php/dav/addressbooks/users/username/Contacts" for the default address book. Contact resources are located directly under the "username/Contacts" or "username/My_Addressbook" path. Here the filename doesn't have to be identical to the UID.

update_contact Method

Updates a contact at the specified ResourceURI.

Syntax

def update_contact(resource_uri: str) -> None: ...

Remarks

This method updates an existing contact to the address book collection at the specified ResourceURI. The ResourceURI must be a fully qualified URL to the location on the CardDAV server to which this contact is saved.

The following properties are used when calling create_contact, update_contact or export_vcf, and will be filled after calling get_contact or import_vcf. These will also be available from inside the on_contact_details event, which is fired for each contact received from the CardDAV server in response when calling get_addressbook_report.

• AddressLabels
• addresses
• Agent
• anniversary
• birth_day
• Categories
• Classification
• ContactURL
• custom_properties
• Depth
• e_mails
• formatted_name
• gender
• GeoLocation
• IMPPs
• kind
• languages
• Logo
• Mailer
• Member
• names
• nick_name
• note
• organization
• phone_numbers
• photo
• ProductId
• PublicKey
• Related
• RevisionTime
• role
• SortString
• Sound
• Timezone
• title
• uid
• url
• v_card_version
• XML

There is no standard format for a resource URI. Google for instance, uses "https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default" address to access the default address book. Here is an example of using the get_addressbook_report, that makes a REPORT request to the given URI in the CardDAV server. cardDAV.GetAddressbookReport("https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default");

Generally, the URI format would be something like "https://mydavserver/.well-known/carddav/Address_Book_Name". To add, delete, update, copy or move a contact from an address book, you can add its file name at the end of the address book URI, which typically has a vcf extension (not always). Usually the filename of a contact would be the same as the uid of the contact plus the vcf extension, but this depends on the way the CardDAV server manages resources. This is the resource URI you must use to retrieve the contact with get_contact. For example: cardDAV.GetContact("https://mydavserver/.well-known/carddav/Address_Book_Name/1234567890.vcf");

The examples below show a few possible transactions: cardDAV.User = "username"; cardDAV.Password = "password"; cardDAV.CreateAddressbook("https://mydavserver/.well-known/carddav/Address_Book_Name/", "My Address book", "My Address books"); cardDAV.FormattedName = "Mr. John Q. Public\, Esq."; cardDAV.PhoneNumbers.Add(new CardCustomProp("tel", "123456790")); cardDAV.CreateContact("https://mydavserver/.well-known/carddav/Address_Book_Name/123456789.vcf"); cardDAV.GetAddressbookReport("https://mydavserver/.well-known/carddav/Address_Book_Name/"); NextCloud's ResourceURIs always start with "http://www.nextcloud.com/remote.php/dav/addressbooks/users/" plus your user name, plus the name of your address book. For instance: "http://www.nextcloud.com/remote.php/dav/addressbooks/users/username/Contacts" for the default address book. Contact resources are located directly under the "username/Contacts" or "username/My_Addressbook" path. Here the filename doesn't have to be identical to the UID.

on_connected Event

Fired immediately after a connection completes (or fails).

Syntax

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

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

# In class CardDAV:
@property
def on_connected() -> Callable[[CardDAVConnectedEventParams], None]: ...
@on_connected.setter
def on_connected(event_hook: Callable[[CardDAVConnectedEventParams], 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 CardDAVConnectionStatusEventParams(object):
  @property
  def connection_event() -> str: ...

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

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

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

Fires for each contact received.

Syntax

class CardDAVContactDetailsEventParams(object):
  @property
  def resource_uri() -> str: ...

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

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

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

# In class CardDAV:
@property
def on_contact_details() -> Callable[[CardDAVContactDetailsEventParams], None]: ...
@on_contact_details.setter
def on_contact_details(event_hook: Callable[[CardDAVContactDetailsEventParams], None]) -> None: ...

Remarks

This event fires for each VCARD contact received in response to a get_addressbook_report request. The ResourceURI parameter indicates the location of this particular contact on the CardDAV server, and the ETag parameter is used to indicate the current state of the contact. If the ETag is different from the value you have cached for the current ResourceURI, it means the contact has changed on the server since the last time you updated your cache. ResponseStatus indicates the HTTP status of CardDAV server received when attempting to retrieve this particular ResourceURI when it was building the report. The ContactData parameter contains the raw contact entry as returned by the CardDAV server. This data is also parsed into the following properties, and are valid for the current ResourceURI only inside this event.

• AddressLabels
• addresses
• Agent
• anniversary
• birth_day
• Categories
• Classification
• ContactURL
• custom_properties
• Depth
• e_mails
• formatted_name
• gender
• GeoLocation
• IMPPs
• kind
• languages
• Logo
• Mailer
• Member
• names
• nick_name
• note
• organization
• phone_numbers
• photo
• ProductId
• PublicKey
• Related
• RevisionTime
• role
• SortString
• Sound
• Timezone
• title
• uid
• url
• v_card_version
• XML

Note that for a large address book you may not wish to return the full contents of each contact, as this could be a substantially large amount of data. In this case, set the report_filter_return_contact_data property to false, and only the ResourceURI, ResponseStatus, and ETag parameters will be returned by the CardDAV server for each contact. The contents of the contact will not be returned, and the ContactData parameter will be empty.

on_disconnected Event

Fired when a connection is closed.

Syntax

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

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

# In class CardDAV:
@property
def on_disconnected() -> Callable[[CardDAVDisconnectedEventParams], None]: ...
@on_disconnected.setter
def on_disconnected(event_hook: Callable[[CardDAVDisconnectedEventParams], 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 CardDAVEndTransferEventParams(object):
  @property
  def direction() -> int: ...

# In class CardDAV:
@property
def on_end_transfer() -> Callable[[CardDAVEndTransferEventParams], None]: ...
@on_end_transfer.setter
def on_end_transfer(event_hook: Callable[[CardDAVEndTransferEventParams], 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 CardDAVErrorEventParams(object):
  @property
  def error_code() -> int: ...

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

# In class CardDAV:
@property
def on_error() -> Callable[[CardDAVErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[CardDAVErrorEventParams], 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 CardDAVHeaderEventParams(object):
  @property
  def field() -> str: ...

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

# In class CardDAV:
@property
def on_header() -> Callable[[CardDAVHeaderEventParams], None]: ...
@on_header.setter
def on_header(event_hook: Callable[[CardDAVHeaderEventParams], 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 CardDAVLogEventParams(object):
  @property
  def log_level() -> int: ...

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

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

# In class CardDAV:
@property
def on_log() -> Callable[[CardDAVLogEventParams], None]: ...
@on_log.setter
def on_log(event_hook: Callable[[CardDAVLogEventParams], 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_redirect Event

Fired when a redirection is received from the server.

Syntax

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

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

# In class CardDAV:
@property
def on_redirect() -> Callable[[CardDAVRedirectEventParams], None]: ...
@on_redirect.setter
def on_redirect(event_hook: Callable[[CardDAVRedirectEventParams], 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 CardDAVSetCookieEventParams(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 CardDAV:
@property
def on_set_cookie() -> Callable[[CardDAVSetCookieEventParams], None]: ...
@on_set_cookie.setter
def on_set_cookie(event_hook: Callable[[CardDAVSetCookieEventParams], 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 CardDAVSSLServerAuthenticationEventParams(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 CardDAV:
@property
def on_ssl_server_authentication() -> Callable[[CardDAVSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[CardDAVSSLServerAuthenticationEventParams], 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 CardDAVSSLStatusEventParams(object):
  @property
  def message() -> str: ...

# In class CardDAV:
@property
def on_ssl_status() -> Callable[[CardDAVSSLStatusEventParams], None]: ...
@on_ssl_status.setter
def on_ssl_status(event_hook: Callable[[CardDAVSSLStatusEventParams], 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 CardDAVStartTransferEventParams(object):
  @property
  def direction() -> int: ...

# In class CardDAV:
@property
def on_start_transfer() -> Callable[[CardDAVStartTransferEventParams], None]: ...
@on_start_transfer.setter
def on_start_transfer(event_hook: Callable[[CardDAVStartTransferEventParams], 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 CardDAVStatusEventParams(object):
  @property
  def http_version() -> str: ...

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

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

# In class CardDAV:
@property
def on_status() -> Callable[[CardDAVStatusEventParams], None]: ...
@on_status.setter
def on_status(event_hook: Callable[[CardDAVStatusEventParams], 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 CardDAVTransferEventParams(object):
  @property
  def direction() -> int: ...

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

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

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

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

CardDAV Config Settings

CardDAV Config Settings

WebDAV Config Settings

<firstlevel>
  <one>value</one>
  <two>
    <item>first</item>
    <item>second</item>
  </two>
  <three>value three</three>
</firstlevel>

{
  "firstlevel": {
    "one": "value",
    "two": ["first", "second"],
    "three": "value three"
  }
}

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