CardDAV Class
Properties Methods Events Config Settings Errors
The CardDAV class makes it easy to access, share, manage, upload, download contact data based on the vCard format within a CardDAV server.
Syntax
class ipworks.CardDAV
Remarks
The CardDAV class allows remote management of address books and their contacts. Capabilities include creation, deletion, updating, listing, copying, and moving of contacts, creation, deletion, updating, listing of address books and resource locking.
Authentication
This class may require authentication via OAuth 2.0 depending on the provider. For example Google will require OAuth 2.0. In that case first, 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_VALUEAssign this value to the authorization property before attempting any operations. For Example:
oauth.ClientId = "CLIENT_ID";
oauth.ClientSecret = "CLIENT_SECRET";
oauth.ServerAuthURL = "https://accounts.google.com/o/oauth2/auth";
oauth.ServerTokenURL = "https://accounts.google.com/o/oauth2/token";
oauth.AuthorizationScope = "https://www.googleapis.com/auth/carddav";
cardDAV.Authorization = oauth.GetAuthorization();
Consult the documentation for the service for more information about supported scope values and more details on OAuth authentication.
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. Here is an example of using the get_addressbook_report method, 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");
To add, delete, update, copy, move or lock 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 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.
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 specifeid 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 be 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;
}
Creating, Updating, and Deleting 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 needed to retrieve/update/delete the addressbook but it is not the display name of it,. Specify the display name and the description as arguments when calling create_addressbook.
To update an address book search through addressbooks to find the index of the address book to be updated. Set the properties of the found 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 then delete an address book collection resource:
//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");
Locking and Unlocking Address Books
To lock an address book, use the lock_addressbook method. This method will request a new lock to be placed on ResourceURI in the user's name so that only the user can operate on it. This method is linked to a number of properties that it uses to generate the lock request:
lock_owner | The principle that will own the lock. |
lock_scope | The scope of the lock. The class only currently supports locks of scope "exclusive" and "shared". |
lock_timeout | The amount of time that the lock is allowed to exist before ResourceURI is automatically unlocked by the server. |
lock_tokens | The lock itself. If the user sets this before making the request, the timeout on the existing lock will be refreshed (reset to 0). Otherwise, a new set of lock tokens will be returned. |
lock_type | The type of lock. The class only currently supports of type "write". |
This method is associated with the Depth config. If Depth is set to "0", the class will lock only ResourceURI and its properties. If Depth is set to "infinity", the class will lock ResourceURI and its entire subtree.
If move_contact or copy_contact are used to place a resource or collection in a location under a resource locked with "infinity", the new resource or collection will be added to the lock. Any lock on a collection will prevent non-lock owners from adding resources to that collection.
To unlock an address book, use the unlock_addressbook method. This method unlocks an addressbook resource. Before calling unlock_addressbook on a particular addressbook resource, the lock_tokens property must be set to the lock tokens for ResourceURI. The method will remove the lock, allowing other users or non-privileged users to access and operate on the file.
Listing Contacts of Address Books
To retrieve the contacts of an address book, the class sends an addressbook-query request to the addressbook located at the specified ResourceURI. The response to an addressbook-query report will be parsed by the class, and information about the individual contacts contained within shall be fired in the on_contact_details event.
The following properties are used when creating a request with 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 to a get_addressbook_report.
- AddressLabels
- addresses
- Agent
- anniversary
- birth_day
- Categories
- Classification
- ContURL
- 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
Creating, Updating, Deleting, Copying, and Moving Contacts
To create a contact use: | create_contact |
To update a contact use: | update_contact |
To delete a contact use: | delete_contact |
To copy a contact use: | copy_contact |
To move a contact use: | move_contact |
The example below shows a few possible actions:
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 vCard objects in VCF format
Another way to create a contact is by using import_vcf to import all the data from a vCard object. Here is an 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. Here is an 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.
addressbook_count | The number of records in the Addressbook arrays. |
addressbook_c_tag | This property holds the current ctag of the address book. |
addressbook_description | This property holds the description of the address book. |
addressbook_display_name | This property holds the display name of the address book. |
addressbook_property_count | This property holds the total number of properties of the address book. |
addressbook_property_index | This property specifies the currently selected property. |
addressbook_property_name | This property holds the name of the currently selected property. |
addressbook_property_value | This property holds the value of the currently selected property. |
addressbook_url | This property provides the URL of the address book. |
address_count | The number of records in the Address arrays. |
address_attribute | This property contains an optional attribute of the custom property. |
address_name | This property contains the textual name of the custom property. |
address_value | This property contains the value of the custom property. |
anniversary_attribute | This property contains an optional attribute of the custom property. |
anniversary_name | This property contains the textual name of the custom property. |
anniversary_value | This property contains the value of the custom property. |
authorization | This property includes the Authorization string to be sent to the server. |
auth_scheme | This property specifies the authentication scheme to use when server authentication is required. |
birth_day_attribute | This property contains an optional attribute of the custom property. |
birth_day_name | This property contains the textual name of the custom property. |
birth_day_value | This property contains the value of the custom property. |
connected | This property shows whether the class is connected. |
cookie_count | The number of records in the Cookie arrays. |
cookie_domain | This is the domain of a received cookie. |
cookie_expiration | This property contains an expiration time for the cookie (if provided by the server). |
cookie_name | This property, contains the name of the cookie. |
cookie_path | This property contains a path name to limit the cookie to (if provided by the server). |
cookie_secure | This property contains the security flag of the received cookie. |
cookie_value | This property contains the value of the cookie. |
custom_property_count | The number of records in the CustomProperty arrays. |
custom_property_attribute | This property contains an optional attribute of the custom property. |
custom_property_name | This property contains the textual name of the custom property. |
custom_property_value | This property contains the value of the custom property. |
e_mail_count | The number of records in the EMail arrays. |
e_mail_attribute | This property contains an optional attribute of the custom property. |
e_mail_name | This property contains the textual name of the custom property. |
e_mail_value | This property contains the value of the custom property. |
e_tag | Identifier returned by the CardDAV server which is used to synchronize edits. |
firewall_auto_detect | This property tells the class whether or not to automatically detect and use firewall system settings, if available. |
firewall_type | This property determines the type of firewall to connect through. |
firewall_host | This property contains the name or IP address of the firewall (optional). |
firewall_password | This property contains a password if authentication is to be used when connecting through the firewall. |
firewall_port | This property contains the Transmission Control Protocol (TCP) port for the firewall Host . |
firewall_user | This property contains a user name if authentication is to be used when connecting through a firewall. |
follow_redirects | This property determines what happens when the server issues a redirect. |
formatted_name | To specify the formatted text corresponding to the name of the contact. |
gender | To specify the classes of the sex and gender identity of a contact. |
idle | This property specifies the current status of the class. |
kind | To specify the kind of object the vCard represents. |
language_count | The number of records in the Language arrays. |
language_attribute | This property contains an optional attribute of the custom property. |
language_name | This property contains the textual name of the custom property. |
language_value | This property contains the value of the custom property. |
local_host | This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
lock_type | The type of the current resource lock. |
lock_owner | The principle that owns the current resource lock. |
lock_scope | The scope of the current resource lock. |
lock_timeout | The time to live for the current resource lock. |
lock_tokens | The lock string to be used when submitting operations on a locked resource. |
names | To specify the name of a contact. |
nick_name | The nickname of the object the vCard represents. One or more text values separated by a COMMA character (ASCII decimal 44). |
note | To provide additional information or comments about a contact. |
organization | To specify the organizational name and units associated with a contact. |
other_headers | This property includes other headers as determined by the user (optional). |
parsed_header_count | The number of records in the ParsedHeader arrays. |
parsed_header_field | This property contains the name of the HTTP header (this is the same case as it is delivered). |
parsed_header_value | This property contains the header contents. |
password | This property includes a password if authentication is to be used. |
phone_number_count | The number of records in the PhoneNumber arrays. |
phone_number_attribute | This property contains an optional attribute of the custom property. |
phone_number_name | This property contains the textual name of the custom property. |
phone_number_value | This property contains the value of the custom property. |
photo_attribute | This property contains an optional attribute of the custom property. |
photo_name | This property contains the textual name of the custom property. |
photo_value | This property contains the value of the custom property. |
proxy_auth_scheme | This property is used to tell the class which type of authorization to perform when connecting to the proxy. |
proxy_auto_detect | This property tells the class whether or not to automatically detect and use proxy system settings, if available. |
proxy_password | This property contains a password if authentication is to be used for the proxy. |
proxy_port | This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80). |
proxy_server | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
proxy_ssl | This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. |
proxy_user | This property contains a user name if authentication is to be used for the proxy. |
report_filter_custom_filter | Allows the user to specify his own filter XML. |
report_filter_property | Limits the contacts returned in a Report to only those which contain a matching property name and value. |
report_filter_return_contact_data | Controls whether the contents of each contact is returned in the report. |
report_filter_uid | Limits the contacts returned in the report to only those with the specified UID. |
role | To specify the function or part played in a particular situation by a contact. |
ssl_accept_server_cert_effective_date | This is the date on which this certificate becomes valid. |
ssl_accept_server_cert_expiration_date | This is the date the certificate expires. |
ssl_accept_server_cert_extended_key_usage | This is a comma-delimited list of extended key usage identifiers. |
ssl_accept_server_cert_fingerprint | This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. |
ssl_accept_server_cert_fingerprint_sha1 | This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
ssl_accept_server_cert_fingerprint_sha256 | This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
ssl_accept_server_cert_issuer | This is the issuer of the certificate. |
ssl_accept_server_cert_private_key | This is the private key of the certificate (if available). |
ssl_accept_server_cert_private_key_available | This property shows whether a PrivateKey is available for the selected certificate. |
ssl_accept_server_cert_private_key_container | This is the name of the PrivateKey container for the certificate (if available). |
ssl_accept_server_cert_public_key | This is the public key of the certificate. |
ssl_accept_server_cert_public_key_algorithm | This property contains the textual description of the certificate's public key algorithm. |
ssl_accept_server_cert_public_key_length | This is the length of the certificate's public key (in bits). |
ssl_accept_server_cert_serial_number | This is the serial number of the certificate encoded as a string. |
ssl_accept_server_cert_signature_algorithm | The property contains the text description of the certificate's signature algorithm. |
ssl_accept_server_cert_store | This is the name of the certificate store for the client certificate. |
ssl_accept_server_cert_store_password | 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 | This is the type of certificate store for this certificate. |
ssl_accept_server_cert_subject_alt_names | This property contains comma-separated lists of alternative subject names for the certificate. |
ssl_accept_server_cert_thumbprint_md5 | This property contains the MD5 hash of the certificate. |
ssl_accept_server_cert_thumbprint_sha1 | This property contains the SHA-1 hash of the certificate. |
ssl_accept_server_cert_thumbprint_sha256 | This property contains the SHA-256 hash of the certificate. |
ssl_accept_server_cert_usage | This property contains the text description of UsageFlags . |
ssl_accept_server_cert_usage_flags | This property contains the flags that show intended use for the certificate. |
ssl_accept_server_cert_version | This property contains the certificate's version number. |
ssl_accept_server_cert_subject | This is the subject of the certificate used for client authentication. |
ssl_accept_server_cert_encoded | This is the certificate (PEM/base64 encoded). |
ssl_cert_effective_date | This is the date on which this certificate becomes valid. |
ssl_cert_expiration_date | This is the date the certificate expires. |
ssl_cert_extended_key_usage | This is a comma-delimited list of extended key usage identifiers. |
ssl_cert_fingerprint | This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. |
ssl_cert_fingerprint_sha1 | This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
ssl_cert_fingerprint_sha256 | This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
ssl_cert_issuer | This is the issuer of the certificate. |
ssl_cert_private_key | This is the private key of the certificate (if available). |
ssl_cert_private_key_available | This property shows whether a PrivateKey is available for the selected certificate. |
ssl_cert_private_key_container | This is the name of the PrivateKey container for the certificate (if available). |
ssl_cert_public_key | This is the public key of the certificate. |
ssl_cert_public_key_algorithm | This property contains the textual description of the certificate's public key algorithm. |
ssl_cert_public_key_length | This is the length of the certificate's public key (in bits). |
ssl_cert_serial_number | This is the serial number of the certificate encoded as a string. |
ssl_cert_signature_algorithm | The property contains the text description of the certificate's signature algorithm. |
ssl_cert_store | This is the name of the certificate store for the client certificate. |
ssl_cert_store_password | 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 | This is the type of certificate store for this certificate. |
ssl_cert_subject_alt_names | This property contains comma-separated lists of alternative subject names for the certificate. |
ssl_cert_thumbprint_md5 | This property contains the MD5 hash of the certificate. |
ssl_cert_thumbprint_sha1 | This property contains the SHA-1 hash of the certificate. |
ssl_cert_thumbprint_sha256 | This property contains the SHA-256 hash of the certificate. |
ssl_cert_usage | This property contains the text description of UsageFlags . |
ssl_cert_usage_flags | This property contains the flags that show intended use for the certificate. |
ssl_cert_version | This property contains the certificate's version number. |
ssl_cert_subject | This is the subject of the certificate used for client authentication. |
ssl_cert_encoded | This is the certificate (PEM/base64 encoded). |
ssl_provider | This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
ssl_server_cert_effective_date | This is the date on which this certificate becomes valid. |
ssl_server_cert_expiration_date | This is the date the certificate expires. |
ssl_server_cert_extended_key_usage | This is a comma-delimited list of extended key usage identifiers. |
ssl_server_cert_fingerprint | This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. |
ssl_server_cert_fingerprint_sha1 | This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
ssl_server_cert_fingerprint_sha256 | This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
ssl_server_cert_issuer | This is the issuer of the certificate. |
ssl_server_cert_private_key | This is the private key of the certificate (if available). |
ssl_server_cert_private_key_available | This property shows whether a PrivateKey is available for the selected certificate. |
ssl_server_cert_private_key_container | This is the name of the PrivateKey container for the certificate (if available). |
ssl_server_cert_public_key | This is the public key of the certificate. |
ssl_server_cert_public_key_algorithm | This property contains the textual description of the certificate's public key algorithm. |
ssl_server_cert_public_key_length | This is the length of the certificate's public key (in bits). |
ssl_server_cert_serial_number | This is the serial number of the certificate encoded as a string. |
ssl_server_cert_signature_algorithm | The property contains the text description of the certificate's signature algorithm. |
ssl_server_cert_store | This is the name of the certificate store for the client certificate. |
ssl_server_cert_store_password | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
ssl_server_cert_store_type | This is the type of certificate store for this certificate. |
ssl_server_cert_subject_alt_names | This property contains comma-separated lists of alternative subject names for the certificate. |
ssl_server_cert_thumbprint_md5 | This property contains the MD5 hash of the certificate. |
ssl_server_cert_thumbprint_sha1 | This property contains the SHA-1 hash of the certificate. |
ssl_server_cert_thumbprint_sha256 | This property contains the SHA-256 hash of the certificate. |
ssl_server_cert_usage | This property contains the text description of UsageFlags . |
ssl_server_cert_usage_flags | This property contains the flags that show intended use for the certificate. |
ssl_server_cert_version | This property contains the certificate's version number. |
ssl_server_cert_subject | This is the subject of the certificate used for client authentication. |
ssl_server_cert_encoded | This is the certificate (PEM/base64 encoded). |
timeout | This property includes the timeout for the class. |
title | To specify the position or job of the object the vCard represents. |
uid | A persistent, globally unique identifier for the contact. |
url | Location of the contact resource on the CardDAV server. |
user | This property includes a user name if authentication is to be used. |
v_card_version | Specifies the vCard version format. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
add_cookie | This method adds a cookie and the corresponding value to the outgoing request headers. |
add_custom_property | Adds a form variable and the corresponding value. |
config | This method sets or retrieves a configuration setting. |
copy_contact | Copy contact to a new location. |
create_addressbook | Creates a new address book collection resource. |
create_contact | Adds a contact resource at the specified ResourceURI using the CardDAV PUT method. |
delete_addressbook | Deletes an address book collection resource. |
delete_contact | Deletes a resource. |
do_events | This method processes events from the internal message queue. |
export_vcf | Generates a contact from the properties in the vCard (.VCF) format. |
get_addressbook_options | Retrieves options for the ResourceURI to determines whether it supports address book access. |
get_addressbook_report | Generates a report on the indicated address book collection resource. |
get_contact | Retrieves a single contact from the CardDAV server. |
import_vcf | Imports contact data (contained in a VCF file) into the class's property list. |
interrupt | This method interrupts the current method. |
list_addressbooks | Lists all address books that the current user can access. |
lock_addressbook | Obtain a lock for a specified address book resource. |
move_contact | Moves one contact resource to a new location. |
reset | Reset the class. |
send_custom_request | Sends a request to the CardDAV server to do CRUD operations. |
unlock_addressbook | Unlocks an address book resource. |
update_addressbook | Updates an address book collection resource. |
update_contact | Updates a contact at the specified ResourceURI using the CardDAV PUT method. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
on_connected | This event is fired immediately after a connection completes (or fails). |
on_connection_status | This event is fired to indicate changes in the connection state. |
on_contact_details | Fires for each contact received. |
on_disconnected | This event is fired when a connection is closed. |
on_end_transfer | This event is fired when a document finishes transferring. |
on_error | This event is fired for information about errors during data delivery. |
on_header | This event is fired every time a header line comes in. |
on_log | This event fires once for each log message. |
on_redirect | This event is fired when a redirection is received from the server. |
on_set_cookie | This event is fired for every cookie set by the server. |
on_ssl_server_authentication | This event is fired after the server presents its certificate to the client. |
on_ssl_status | This event shows the progress of the secure connection. |
on_start_transfer | This event is fired when a document starts transferring (after the headers). |
on_status | This event is fired when the HTTP status line is received from the server. |
on_transfer | This event is fired while a document transfers (delivers document). |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
AddressbookHomeSet | URI of address book collections owned by the principal. |
AddressLabels | Delivery address of the contact. |
Agent | Information about another person who will act on behalf of the individual or resource associated with the contact. |
AuthScheme | The authentication scheme to use for server authorization. |
Categories | One or more comma separated categories or groups to which the contact belongs. |
Classification | The sensitivity level or access classification of the contact. |
ContURL | The URL associated with a contact. |
Depth | The depth associated with the current operation. |
GeoLocation | Information related to the global positioning of a contact. |
IMPPs | The URI for instant messaging and presence protocol communications with a contact. |
Logo | A graphic image of a logo associated with a contact. |
Mailer | The type of electronic mail software that is used by the individual associated with the contact. |
Member | a member in the group this vCard represents. |
ProductId | Specifies the identifier for the product that created the vCard object. |
PublicKey | Public key or authentication certificate associated with a contact. |
Related | A relationship between another entity and the entity represented by this contact. |
RevisionTime | The revision date and time of a contact information. |
SortString | A name to be used for national-language-specific sorting. |
Sound | A sound clip associated with a contact. |
Timezone | Information related to the time zone of a contact. |
XML | XML-encoded vCard data in a plain vCard. |
EncodeURL | If set to true the URL will be encoded by the class. |
IsDir[i] | Whether or not the resource at the specified index is a directory. |
TransferredData | Contains the contents of the last response from the server. |
TransferredDataLimit | The maximum amount of data to be transferred. |
XChildCount | The number of child elements of the current element. |
XChildName[i] | The name of the child element. |
XChildXText[i] | The inner text of the child element. |
XElement | The name of the current element. |
XParent | The parent of the current element. |
XPath | Provides a way to point to a specific element in the returned XML or JSON response. |
XSubTree | A snapshot of the current element in the document. |
XText | The text of the current element. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
Append | Whether to append data to LocalFile. |
Authorization | The Authorization string to be sent to the server. |
BytesTransferred | Contains the number of bytes transferred in the response data. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
EncodeURL | If set to True the URL will be encoded by the class. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to True the class will perform a GET on the new location. |
HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
HTTPVersion | The version of HTTP used by the class. |
IfModifiedSince | A date determining the maximum age of the desired document. |
KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
LogLevel | The level of detail that is logged. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
NegotiatedHTTPVersion | The negotiated HTTP version. |
OtherHeaders | Other headers as determined by the user (optional). |
ProxyAuthorization | The authorization string to be sent to the proxy server. |
ProxyAuthScheme | The authorization scheme to be used for the proxy. |
ProxyPassword | A password if authentication is to be used for the proxy. |
ProxyPort | Port for the proxy server (default 80). |
ProxyServer | Name or IP address of a proxy server (optional). |
ProxyUser | A user name if authentication is to be used for the proxy. |
SentHeaders | The full set of headers as sent by the client. |
StatusCode | The status code of the last response from the server. |
StatusLine | The first line of the last response from the server. |
TransferredData | The contents of the last response from the server. |
TransferredDataLimit | The maximum number of incoming bytes to be stored by the class. |
TransferredHeaders | The full set of headers as received from the server. |
TransferredRequest | The full request as sent by the client. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
UseIDNs | Whether to encode hostnames to internationalized domain names. |
UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
UseProxyAutoConfigURL | Whether to use a Proxy auto-config file when attempting a connection. |
UserAgent | Information about the user agent (browser). |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the class binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
OpenSSLCADir | The path to a directory containing CA certificates. |
OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACertFilePaths | The paths to CA certificate files on Unix/Linux. |
SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCheckOCSP | Whether to use OCSP to check the status of the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
SSLNegotiatedCipher | Returns the negotiated cipher suite. |
SSLNegotiatedCipherStrength | Returns the negotiated cipher suite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated cipher suite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLServerCACerts | A newline separated list of CA certificate to use during SSL server certificate validation. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitiveData | Whether sensitive data is masked in log messages. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseInternalSecurityAPI | Tells the class whether or not to use the system security libraries or an internal implementation. |
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
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
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
This property shows 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:
The array indices start at 0 and end at cookie_count - 1.cookie_domain Property
This is the domain of a received cookie.
Syntax
def get_cookie_domain(cookie_index: int) -> str: ...
Default Value
""
Remarks
This is 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
This property contains an expiration time for the cookie (if provided by the server).
Syntax
def get_cookie_expiration(cookie_index: int) -> str: ...
Default Value
""
Remarks
This property 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, 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
This property, contains 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
This property, contains 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
This property contains 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
This property 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 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
This property contains the security flag of the received cookie.
Syntax
def get_cookie_secure(cookie_index: int) -> bool: ...
Default Value
FALSE
Remarks
This property contains 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
This property contains 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
This property contains 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:
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:
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. An ETag is returned by the CardDAV server after a successful create_contact request. Every time a contact is updated, the ETag changes. This gives you the ability to determine if another user has changed the contact you added.
You can use this ETag 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 URI and ETags for each contact in the address book will be returned in the report. 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
This property tells the class whether or not to automatically detect and use firewall system settings, if available.
Syntax
def get_firewall_auto_detect() -> bool: ... def set_firewall_auto_detect(value: bool) -> None: ...
firewall_auto_detect = property(get_firewall_auto_detect, set_firewall_auto_detect)
Default Value
FALSE
Remarks
This property tells the class whether or not to automatically detect and use firewall system settings, if available.
firewall_type Property
This property determines the type of firewall to connect through.
Syntax
def get_firewall_type() -> int: ... def set_firewall_type(value: int) -> None: ...
firewall_type = property(get_firewall_type, set_firewall_type)
Default Value
0
Remarks
This property determines the type of firewall to connect through. The applicable values are as follows:
fwNone (0) | No firewall (default setting). |
fwTunnel (1) | Connect through a tunneling proxy. firewall_port is set to 80. |
fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. firewall_port is set to 1080. |
fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. firewall_port is set to 1080. |
fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. firewall_port is set to 1080. |
firewall_host Property
This property contains 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
This property contains 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
This property contains a password if authentication is to be used when connecting through the firewall.
Syntax
def get_firewall_password() -> str: ... def set_firewall_password(value: str) -> None: ...
firewall_password = property(get_firewall_password, set_firewall_password)
Default Value
""
Remarks
This property contains a password if authentication is to be used when connecting through the firewall. If firewall_host is specified, the firewall_user and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.
firewall_port Property
This property contains the Transmission Control Protocol (TCP) port for the firewall Host .
Syntax
def get_firewall_port() -> int: ... def set_firewall_port(value: int) -> None: ...
firewall_port = property(get_firewall_port, set_firewall_port)
Default Value
0
Remarks
This property contains the Transmission Control Protocol (TCP) port for the firewall firewall_host. See the description of the firewall_host property for details.
Note: This property is set automatically when firewall_type is set to a valid value. See the description of the firewall_type property for details.
firewall_user Property
This property contains a user name if authentication is to be used 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
This property contains a user name 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
This 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
To specify the formatted text corresponding to the 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 text corresponding to the 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
To specify the classes of 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 components of the sex and gender identity of a contact. It has to be a single structured value with two parts, which are optional, separated by a semicolon. The first one is the sex (biological), which could be: M (male), F (female), O (other), N (None), U (Unknown). The second one is the gender identity, a free-form text.
Below is an example on how to use this property:
cardDAV.Gender = "O;intersex";
//or
//cardDAV.Gender = "F";
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
This property specifies the current status of the class.
Syntax
def get_idle() -> bool: ...
idle = property(get_idle, None)
Default Value
TRUE
Remarks
idle will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.
This property is read-only.
kind Property
To specify 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:
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
This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
def get_local_host() -> str: ... def set_local_host(value: str) -> None: ...
local_host = property(get_local_host, set_local_host)
Default Value
""
Remarks
The local_host property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.
In multihomed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.
If the class is connected, the local_host property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for 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.
lock_type Property
The type of the current resource lock.
Syntax
def get_lock_type() -> str: ... def set_lock_type(value: str) -> None: ...
lock_type = property(get_lock_type, set_lock_type)
Default Value
"write"
Remarks
The type of the current resource lock.
Before the calendar resource can be locked, the lock_type may be set to the type of lock being requested. Currently, the class only supports requesting locks of type "write", although the protocol defines an optional "read" lock. After a successful LockAddressbook operation, the class will set the lock_type property to the correct value returned in the server's response.
lock_owner Property
The principle that owns the current resource lock.
Syntax
def get_lock_owner() -> str: ... def set_lock_owner(value: str) -> None: ...
lock_owner = property(get_lock_owner, set_lock_owner)
Default Value
""
Remarks
The principle that owns the current resource lock.
Before the address book resource can be locked, the Lock lock_owner may be set to the name of a principle or group of principles that will own the lock. If no owner is specified, the server will automatically associate the lock with the requesting principle. After a successful LockAddressbook operation, the class will set the lock_owner property to the correct value returned in the server's response.
lock_scope Property
The scope of the current resource lock.
Syntax
def get_lock_scope() -> str: ... def set_lock_scope(value: str) -> None: ...
lock_scope = property(get_lock_scope, set_lock_scope)
Default Value
""
Remarks
The scope of the current resource lock.
Before the address book resource can be locked, the Lock lock_scope may be set to the type of scope needed for the lock. Currently the class will only allow two types of scopes to be requested:
"exclusive" | The lock belongs exclusively to the requesting principle. No other principle may modify the locked resource URI. |
"shared" | The locked resource may not be modified by non-trusted principles. Users who have access rights, however, may request a shared lock which they can then use to modify or operate on the resource. |
If no scope is specified, the protocol default scope, "exclusive", will be requested. After a successful LockCalendar operation, the class will set the lock_scope property to the correct value returned in the server's response.
lock_timeout Property
The time to live for the current resource lock.
Syntax
def get_lock_timeout() -> int: ... def set_lock_timeout(value: int) -> None: ...
lock_timeout = property(get_lock_timeout, set_lock_timeout)
Default Value
0
Remarks
The time to live for the current resource lock.
Before the address book resource can be locked, the Lock lock_timeout may be set to a specific amount of time needed for the locked operation to take place. The timeout is used to determine how long the lock may exist before the server automatically unlocks the resource URI. If lock_timeout of 0 is specified, the server will use a default timeout. After a successful LockAddressbook operation, the class will set the Lock lock_timeout property to the correct value returned in the server's response.
lock_tokens Property
The lock string to be used when submitting operations on a locked resource.
Syntax
def get_lock_tokens() -> str: ... def set_lock_tokens(value: str) -> None: ...
lock_tokens = property(get_lock_tokens, set_lock_tokens)
Default Value
""
Remarks
The lock string to be used when submitting operations on a locked resource.
Before the address book resource can be locked, the Lock lock_tokens may be set to the tokens returned by a previous lock operation. This is useful when renewing a timeout. The server will respond with a new timeout value, which will be stored in lock_timeout. If the lock request is not a lock refresh, lock_tokens must be empty, and will be parsed out of the server response after a successful LockAddressbook operation.
names Property
To specify 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. One or more text values separated by a COMMA character (ASCII decimal 44).
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
To provide 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
To specify 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
This property includes 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 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:
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:
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
This property is used to tell the class which 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
This property is used to tell the class which 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 component 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
This property tells the class whether or not 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
This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is False.
proxy_password Property
This property contains 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
This property contains 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
This property contains 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
This property contains 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
This property determines 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
This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:
psAutomatic (0) | Default setting. If the url is an https URL, the class will use the psTunnel option. If the url is an http URL, the class will use the psNever option. |
psAlways (1) | The connection is always SSL-enabled. |
psNever (2) | The connection is not SSL-enabled. |
psTunnel (3) | The connection is made through a tunneling (HTTP) proxy. |
proxy_user Property
This property contains a user name 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
This property contains a user name 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 conacts 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 contans "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
To specify 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 or job title of the contact. This property provides essential 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
This is 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
This is the date on which this certificate becomes valid. Before this date, it is not valid. 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
This is the date 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
This is the date the certificate expires. After this date, the certificate will no longer be valid. 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
This is 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
This is 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
This is 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
This is 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
This is 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
This is 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
This is 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
This is 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
This is 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
This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
ssl_accept_server_cert_private_key Property
This is 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
This is 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
This property shows 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
This property shows 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
This is 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
This is 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
This is 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
This is 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
This property contains 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
This property contains 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
This is 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
This is 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
This is 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
This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
ssl_accept_server_cert_signature_algorithm Property
The property contains 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 property contains 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
This is 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
This is 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:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS12 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
This is 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
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The list_store_certificates method may be called after setting cert_store_type to cstPKCS11, cert_store_password to the PIN, and cert_store to the full path of the PKCS11 dll. The certificate information returned in the on_cert_list event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the ssl_accept_server_cert_store and set ssl_accept_server_cert_store_password to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
ssl_accept_server_cert_subject_alt_names Property
This property contains 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
This property contains comma-separated lists of alternative subject names for the certificate.
This property is read-only.
ssl_accept_server_cert_thumbprint_md5 Property
This property contains 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
This property contains 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
This property contains 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
This property contains 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
This property contains 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
This property contains 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
This property contains 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
This property contains the text description of ssl_accept_server_cert_usage_flags.
This value will be of 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
This property contains 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
This property contains 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:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
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
This property contains 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
This property contains 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
This is 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
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, or E=support@nsoftware.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a host name like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
ssl_accept_server_cert_encoded Property
This is the certificate (PEM/base64 encoded).
Syntax
def get_ssl_accept_server_cert_encoded() -> bytes: ... def set_ssl_accept_server_cert_encoded(value: bytes) -> None: ...
ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded)
Default Value
""
Remarks
This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The ssl_accept_server_cert_store and ssl_accept_server_cert_subject properties also may be used to specify a certificate.
When ssl_accept_server_cert_encoded is set, a search is initiated in the current ssl_accept_server_cert_store for the private key of the certificate. If the key is found, ssl_accept_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_accept_server_cert_subject is set to an empty string.
ssl_cert_effective_date Property
This is 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
This is the date on which this certificate becomes valid. Before this date, it is not valid. 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
This is the date 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
This is the date the certificate expires. After this date, the certificate will no longer be valid. 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
This is 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
This is 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
This is 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
This is 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
This is 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
This is 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
This is 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
This is 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
This is the issuer of the certificate.
Syntax
def get_ssl_cert_issuer() -> str: ...
ssl_cert_issuer = property(get_ssl_cert_issuer, None)
Default Value
""
Remarks
This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
ssl_cert_private_key Property
This is 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
This is 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
This property shows 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
This property shows 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
This is 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
This is 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
This is 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
This is 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
This property contains 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
This property contains 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
This is 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
This is 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
This is 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
This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
ssl_cert_signature_algorithm Property
The property contains 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 property contains 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
This is the name of the certificate store for the client certificate.
Syntax
def get_ssl_cert_store() -> bytes: ... def set_ssl_cert_store(value: bytes) -> None: ...
ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password protected, specify the password in ssl_cert_store_password.
ssl_cert_store is used in conjunction with the ssl_cert_subject property to specify client certificates. If ssl_cert_store has a value, and ssl_cert_subject or ssl_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_cert_subject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS12 certificate store).
ssl_cert_store_password Property
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
def get_ssl_cert_store_password() -> str: ... def set_ssl_cert_store_password(value: str) -> None: ...
ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
ssl_cert_store_type Property
This is the type of certificate store for this certificate.
Syntax
def get_ssl_cert_store_type() -> int: ... def set_ssl_cert_store_type(value: int) -> None: ...
ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The list_store_certificates method may be called after setting cert_store_type to cstPKCS11, cert_store_password to the PIN, and cert_store to the full path of the PKCS11 dll. The certificate information returned in the on_cert_list event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the ssl_cert_store and set ssl_cert_store_password to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
ssl_cert_subject_alt_names Property
This property contains 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
This property contains comma-separated lists of alternative subject names for the certificate.
This property is read-only.
ssl_cert_thumbprint_md5 Property
This property contains 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
This property contains 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
This property contains 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
This property contains 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
This property contains 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
This property contains 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
This property contains the text description of UsageFlags .
Syntax
def get_ssl_cert_usage() -> str: ...
ssl_cert_usage = property(get_ssl_cert_usage, None)
Default Value
""
Remarks
This property contains the text description of ssl_cert_usage_flags.
This value will be of 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
This property contains 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
This property contains the flags that show intended use for the certificate. The value of ssl_cert_usage_flags is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
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
This property contains the certificate's version number.
Syntax
def get_ssl_cert_version() -> str: ...
ssl_cert_version = property(get_ssl_cert_version, None)
Default Value
""
Remarks
This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
ssl_cert_subject Property
This is the subject of the certificate used for client authentication.
Syntax
def get_ssl_cert_subject() -> str: ... def set_ssl_cert_subject(value: str) -> None: ...
ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)
Default Value
""
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, or E=support@nsoftware.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a host name like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
ssl_cert_encoded Property
This is the certificate (PEM/base64 encoded).
Syntax
def get_ssl_cert_encoded() -> bytes: ... def set_ssl_cert_encoded(value: bytes) -> None: ...
ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)
Default Value
""
Remarks
This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The ssl_cert_store and ssl_cert_subject properties also may be used to specify a certificate.
When ssl_cert_encoded is set, a search is initiated in the current ssl_cert_store for the private key of the certificate. If the key is found, ssl_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_cert_subject is set to an empty string.
ssl_provider Property
This property specifies 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:
0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
1 (sslpPlatform) | Uses the platform/system implementation. |
2 (sslpInternal) | Uses the internal implementation. |
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
This is 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
This is the date on which this certificate becomes valid. Before this date, it is not valid. 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
This is the date 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
This is the date the certificate expires. After this date, the certificate will no longer be valid. 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
This is 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
This is 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
This is 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
This is 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
This is 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
This is 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
This is 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
This is 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
This is 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
This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
ssl_server_cert_private_key Property
This is 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
This is 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
This property shows 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
This property shows 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
This is 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
This is 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
This is 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
This is 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
This property contains 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
This property contains 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
This is 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
This is 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
This is 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
This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
ssl_server_cert_signature_algorithm Property
The property contains 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 property contains 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
This is 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
This is 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:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS12 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
This is 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
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The list_store_certificates method may be called after setting cert_store_type to cstPKCS11, cert_store_password to the PIN, and cert_store to the full path of the PKCS11 dll. The certificate information returned in the on_cert_list event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the ssl_server_cert_store and set ssl_server_cert_store_password to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
This property is read-only.
ssl_server_cert_subject_alt_names Property
This property contains 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
This property contains comma-separated lists of alternative subject names for the certificate.
This property is read-only.
ssl_server_cert_thumbprint_md5 Property
This property contains 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
This property contains 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
This property contains 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
This property contains 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
This property contains 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
This property contains 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
This property contains 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
This property contains the text description of ssl_server_cert_usage_flags.
This value will be of 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
This property contains 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
This property contains the flags that show intended use for the certificate. The value of ssl_server_cert_usage_flags is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
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
This property contains 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
This property contains 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
This is 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
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, or E=support@nsoftware.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a host name like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
This property is read-only.
ssl_server_cert_encoded Property
This is the certificate (PEM/base64 encoded).
Syntax
def get_ssl_server_cert_encoded() -> bytes: ...
ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)
Default Value
""
Remarks
This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The ssl_server_cert_store and ssl_server_cert_subject properties also may be used to specify a certificate.
When ssl_server_cert_encoded is set, a search is initiated in the current ssl_server_cert_store for the private key of the certificate. If the key is found, ssl_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_server_cert_subject is set to an empty string.
This property is read-only.
timeout Property
This property includes 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
To specify 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
Specifies 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
This 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 property 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
This 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.
If the user has acquired a lock_addressbook of infinite depth on either DestinationResourceURI or any collection it is under, SourceResourceURI will be added to that lock.
Note that neither Yahoo nor Google CardDAV servers support locking, 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, move or lock a contact from an address book, you can add its file name at the end of the addresbbok URI, which tipically 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, move or lock a contact from an address book, you can add its file name at the end of the addresbbok URI, which tipically 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 creating a request with 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 to a get_addressbook_report.
- AddressLabels
- addresses
- Agent
- anniversary
- birth_day
- Categories
- Classification
- ContURL
- 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, move or lock a contact from an address book, you can add its file name at the end of the addresbbok URI, which tipically 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, move or lock a contact from an address book, you can add its file name at the end of the addresbbok URI, which tipically 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, move or lock a contact from an address book, you can add its file name at the end of the addresbbok URI, which tipically 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 (.VCF) 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 creating a request with 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 to a get_addressbook_report.
- AddressLabels
- addresses
- Agent
- anniversary
- birth_day
- Categories
- Classification
- ContURL
- 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 determines whether it supports address book access.
Syntax
def get_addressbook_options(resource_uri: str) -> None: ...
Remarks
This method sends an OPTIONS HTTP request to the indicated ResourceURI. The server will respond with an 200 OK HTTP message, and the supported options will fire one-by-one 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:
Field | Value |
Allow | OPTIONS, GET, HEAD, DELETE, PROPFIND, PUT, PROPPATCH, COPY, MOVE, REPORT |
DAV | 1, 3, extended-mkcol, access-control, calendarserver-principal-property-search, oc-resource-sharing, address book, nextcloud-checksum-update, nc-calendar-search, nc-enable-birthday-calendar |
Date | Wed, 28 Feb 2024 14:12:03 GMT |
Content-Length | 0 |
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, move or lock a contact from an address book, you can add its file name at the end of the addresbbok URI, which tipically 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 collection resource.
Syntax
def get_addressbook_report(resource_uri: str) -> None: ...
Remarks
This method is used to send an addressbook-query 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 contained within shall be fired in the on_contact_details event.
The following properties are used when creating a request with 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 to a get_addressbook_report.
- AddressLabels
- addresses
- Agent
- anniversary
- birth_day
- Categories
- Classification
- ContURL
- 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, move or lock a contact from an address book, you can add its file name at the end of the addresbbok URI, which tipically 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 CardDAV 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 the get_addressbook_report method 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 creating a request with 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 to a get_addressbook_report.
- AddressLabels
- addresses
- Agent
- anniversary
- birth_day
- Categories
- Classification
- ContURL
- 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, move or lock a contact from an address book, you can add its file name at the end of the addresbbok URI, which tipically 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 PUT 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 specifeid 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 be 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;
}
lock_addressbook Method
Obtain a lock for a specified address book resource.
Syntax
def lock_addressbook(resource_uri: str) -> None: ...
Remarks
This method will request a new lock to be placed on ResourceURI in the user's name so that only the user can operate on it. The method is linked to a number of properties that it uses to generate the lock request:
lock_owner | The principle that will own the lock. |
lock_scope | The scope of the lock. The class only currently supports locks of scope "exclusive" and "shared". |
lock_timeout | The amount of time that the lock is allowed to exist before ResourceURI is automatically unlocked by the server. |
lock_tokens | The lock itself. If the user sets this before making the request, the timeout on the existing lock will be refreshed (reset to 0). Otherwise, a new set of lock tokens will be returned. |
lock_type | The type of lock. The class only currently supports of type "write". |
This method is associated with the depth property. If depth is set to "0", the class will lock only ResourceURI and its properties. If depth is set to "infinity", the class will lock ResourceURI and its entire subtree.
If move_contact or copy_contact are used to place a resource or collection in a location under a resource locked with "infinity", the new resource or collection will be added to the lock. Any lock on a collection will prevent non-lock owners from adding resources to that collection.
Note that Google CalDAV servers don't support copying or moving address book resources.
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 don't support locking, 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, move or lock a contact from an address book, you can add its file name at the end of the addresbbok URI, which tipically 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 request to the CardDAV server to do CRUD operations.
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. It requires three parameters: httpMethod indicates the desired action (e.g., "GET," "POST"), url specifies the target resource's URL, and requestBody includes data sent with the request.
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);
unlock_addressbook Method
Unlocks an address book resource.
Syntax
def unlock_addressbook(resource_uri: str) -> None: ...
Remarks
This method unlocks an address book resource. Before calling unlock_addressbook on a particular address book resource, the lock_tokens property must be set to the lock tokens for ResourceURI. The method will remove the lock, allowing other users or non-privileged users to access and operate on the file.
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. This method requires the specified address book collection index. Use list_addressbooks and search through addressbooks to find the index of the address book to be updated.
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, move or lock a contact from an address book, you can add its file name at the end of the addresbbok URI, which tipically 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 using the CardDAV PUT method.
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 creating a request with 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 to a get_addressbook_report.
- AddressLabels
- addresses
- Agent
- anniversary
- birth_day
- Categories
- Classification
- ContURL
- 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, move or lock a contact from an address book, you can add its file name at the end of the addresbbok URI, which tipically 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
This event is 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
This event is 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
The on_connection_status event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.
The ConnectionEvent parameter indicates the type of connection event. Values may include the following:
Firewall connection complete. | |
Secure Sockets Layer (SSL) or S/Shell handshake complete (where applicable). | |
Remote host connection complete. | |
Remote host disconnected. | |
SSL or S/Shell connection broken. | |
Firewall host disconnected. |
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
- ContURL
- 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
This event is 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
This event is fired for information 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.
ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
on_header Event
This event is fired 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
This event fires 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 fires 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:
0 (None) | No events are logged. |
1 (Info - default) | Informational events are logged. |
2 (Verbose) | Detailed data are logged. |
3 (Debug) | Debug data are logged. |
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
This event is 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
This event is 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
The on_set_cookie 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
This event is 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
This event shows the progress of the secure connection.
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
This event is 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
This event is 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
The class accepts one or more of the following configuration settings. Configuration 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.CardDAV Config Settings
This property may have attributes. In this case the value will start with the semicolon character ";" following the attributes list divided by semicolon, then the value itself after the colon character ":". For example ConfigSetting=Attribute1=attr1Value:settingValue or ConfigSetting=;Attribute1=attrValue1:settingValue1\n;Attribute1=attrValue2:settingValue2
This property may have attributes. In this case the value will start with the semicolon character ";" following the attributes list divided by semicolon, then the value itself after the colon character ":". For example ConfigSetting=Attribute1=attr1Value:settingValue or ConfigSetting=;Attribute1=attrValue1:settingValue1\n;Attribute1=attrValue2:settingValue2
0 | Basic |
1 | Digest |
2 | Proprietary |
3 | None |
4 | NTLM |
Note that if the AuthScheme is set to Proprietary (2) then the authorization token must be supplied through Authorization setting.
For security purposes, changing the value of this property will cause the class to clear the values of user, password and Authorization.
0 (Unspecified - default) | Unspecified. The server will use the protocol default depth for the operation (this is normally "infinity"). |
1 (Resource Only) | The server will operate only on the collection resource URI, and not on any of its internal member resources. |
2 (Immediate Children) | The server will operate on the collection resource URI and all of its immediate member resources (but on none of their member resources). |
3 Infinity (Infinity) | The server will recursively operate on the target resource URI and all of its internal member URIs through all levels of the collection hierarchy. |
Depth is applicable to the following methods: lock_addressbook, move_event, copy_event, and get_addressbook_report
This property may have attributes. In this case the value will start with the semicolon character ";" following the attributes list divided by semicolon, then the value itself after the colon character ":". For example ConfigSetting=Attribute1=attr1Value:settingValue or ConfigSetting=;Attribute1=attrValue1:settingValue1\n;Attribute1=attrValue2:settingValue2
This property may have attributes. In this case the value will start with the semicolon character ";" following the attributes list divided by semicolon, then the value itself after the colon character ":". For example ConfigSetting=Attribute1=attr1Value:settingValue or ConfigSetting=;Attribute1=attrValue1:settingValue1\n;Attribute1=attrValue2:settingValue2
This property may have attributes. In this case the value will start with the semicolon character ";" following the attributes list divided by semicolon, then the value itself after the colon character ":". For example ConfigSetting=Attribute1=attr1Value:settingValue or ConfigSetting=;Attribute1=attrValue1:settingValue1\n;Attribute1=attrValue2:settingValue2
This setting should not be used to alter the interpretation of a contact resource. For example, it is not to be used to further the understanding of non-standard properties.
This setting is required to have a value when creating a new contact resource via the create_contact method. For all others it is optional.
This property may have attributes. In this case the value will start with the semicolon character ";" following the attributes list divided by semicolon, then the value itself after the colon character ":". For example ConfigSetting=Attribute1=attr1Value:settingValue or ConfigSetting=;Attribute1=attrValue1:settingValue1\n;Attribute1=attrValue2:settingValue2
This property may have attributes. In this case the value will start with the semicolon character ";" following the attributes list divided by semicolon, then the value itself after the colon character ":". For example ConfigSetting=Attribute1=attr1Value:settingValue or ConfigSetting=;Attribute1=attrValue1:settingValue1\n;Attribute1=attrValue2:settingValue2
This property may have attributes. In this case the value will start with the semicolon character ";" following the attributes list divided by semicolon, then the value itself after the colon character ":". For example ConfigSetting=Attribute1=attr1Value:settingValue or ConfigSetting=;Attribute1=attrValue1:settingValue1\n;Attribute1=attrValue2:settingValue2
This property may have attributes. In this case the value will start with the semicolon character ";" following the attributes list divided by semicolon, then the value itself after the colon character ":". For example ConfigSetting=Attribute1=attr1Value:settingValue or ConfigSetting=;Attribute1=attrValue1:settingValue1\n;Attribute1=attrValue2:settingValue2
WebDAV Config Settings
webdav.ListDirectory("https://localhost/DAV/");
bool isDir = Convert.ToBoolean(webdav.Config("IsDir[0]"));
An exception will be thrown if an invalid index is specified.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
When XPath is set to a valid path, XElement points to the name of the element, with XText, XParent, XSubTree, XChildCount, XChildName[i], and XChildXText[i] providing other properties of the element.
XPath syntax is available for both XML and JSON documents. An XPath is a series of one or more element accessors separated by the / character, for example, /A/B/C/D. An XPath can be absolute (i.e., it starts with /), or it can be relative to the current XPath location.
The following are possible values for an element accessor, which operates relative to the current location specified by the XPath accessors, which proceed it in the overall XPath string:
Accessor | Description |
name | The first element with a particular name. Can be *. |
[i] | The i-th element. |
name[i] | The i-th element with a particular name. |
[last()] | The last element. |
[last()-i] | The element i before the last element. |
name[@attrname="attrvalue"] | The first element with a particular name that contains the specified attribute-value pair.
Supports single and double quotes. (XML Only) |
. | The current element. |
.. | The parent element. |
For example, assume the following XML and JSON responses.
XML:
<firstlevel> <one>value</one> <two> <item>first</item> <item>second</item> </two> <three>value three</three> </firstlevel>
JSON:
{ "firstlevel": { "one": "value", "two": ["first", "second"], "three": "value three" } }
The following are examples of valid XPaths for these responses:
Description | XML XPath | JSON XPath |
Document root | / | /json |
Specific element | /firstlevel/one | /json/firstlevel/one |
i-th child | /firstlevel/two/item[2] | /json/firstlevel/two/[2] |
This list is not exhaustive, but it provides a general idea of the possibilities.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified in the XPath configuration setting. This configuration setting is read-only.
HTTP Config Settings
When True, the class adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate".
The default value is True.
If set to True (default), the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class fails with an error if the server does not support HTTP/2.
The default value is True.
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]".
The default value is False.
If this property is set to 2 (Same Scheme), 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 option is set to 1 (Always), 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, unless this property is set to 1 (Always), in which case 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 0 (Never). In this case, redirects are never followed, and the class fails with an error instead.
Following are the valid options:
- 0 - Never
- 1 - Always
- 2 - Same Scheme
- "1.0"
- "1.1" (default)
- "2.0"
- "3.0"
When using HTTP/2 ("2.0"), additional restrictions apply. Please see the following notes for details.
HTTP/2 Notes
When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.
If the server does not support HTTP/2, the class will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.
HTTP/3 Notes
HTTP/3 is supported only in .NET and Java.
When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.
The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:
Sat, 29 Oct 2017 19:43:31 GMT.
The default value for KeepAlive is False.
0 (None) | No events are logged. |
1 (Info - default) | Informational events are logged. |
2 (Verbose) | Detailed data are logged. |
3 (Debug) | Debug data are logged. |
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).
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 configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail.
This configuration setting is useful for extending the functionality of the class beyond what is provided.
.NET
Http http = new Http();
http.Config("TransferredRequest=on");
http.PostData = "body";
http.Post("http://someserver.com");
Console.WriteLine(http.Config("TransferredRequest"));
C++
HTTP http;
http.Config("TransferredRequest=on");
http.SetPostData("body", 5);
http.Post("http://someserver.com");
printf("%s\r\n", http.Config("TransferredRequest"));
Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.
The default value is False and the hostname will always be used exactly as specified. Note: The CodePage setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set CodePage to 65001. In the C++ Edition for Windows, the *W version of the class must be used. For instance, DNSW or HTTPW.
Note: This setting is applicable only to Mac/iOS editions.
When True (default), the class will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.
Override the default with the name and version of your software.
TCPClient Config Settings
If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.
0 | No firewall (default setting). |
1 | Connect through a tunneling proxy. FirewallPort is set to 80. |
2 | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
3 | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
10 | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.
In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.
The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).
Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.
In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.
If the class is connected, the local_host setting 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).
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by local_port after the connection is established.
local_port cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.
This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.
If an eol string is found in the input stream before MaxLineLength bytes are received, the on_data_in event is fired with the EOL parameter set to True, and the buffer is reset.
If no eol is found, and MaxLineLength bytes are accumulated in the buffer, the on_data_in event is fired with the EOL parameter set to False, and the buffer is reset.
The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this configuration setting is set to False.
0 | IPv4 only |
1 | IPv6 only |
2 | IPv6 with IPv4 fallback |
SSL Config Settings
When enabled, SSL packet logs are output using the on_ssl_status event, which will fire each time an SSL packet is sent or received.
Enabling this configuration setting has no effect if ssl_provider is set to Platform.
The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g., 9d66eef0.0, 9d66eef0.1). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by the following sequences:
-----BEGIN CERTIFICATE-----
... (CA certificate in base64 encoding) ...
-----END CERTIFICATE-----
Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".
By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.
If set to True, the class will reuse the context if and only if the following criteria are met:
- The target host name is the same.
- The system cache entry has not expired (default timeout is 10 hours).
- The application process that calls the function is the same.
- The logon session is the same.
- The instance of the class is the same.
The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found, the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.
The default value is as follows:
/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When set to 0 (default), the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.
This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
When set to 0 (default), the class will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.
This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
Note: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the on_ssl_status event.
Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.
When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList configuration setting.
By default, the enabled cipher suites will include all available ciphers ("*").
The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.
Multiple cipher suites are separated by semicolons.
Example values when ssl_provider is set to Platform include the following:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
Possible values when ssl_provider is set to Platform include the following:
- CALG_3DES
- CALG_3DES_112
- CALG_AES
- CALG_AES_128
- CALG_AES_192
- CALG_AES_256
- CALG_AGREEDKEY_ANY
- CALG_CYLINK_MEK
- CALG_DES
- CALG_DESX
- CALG_DH_EPHEM
- CALG_DH_SF
- CALG_DSS_SIGN
- CALG_ECDH
- CALG_ECDH_EPHEM
- CALG_ECDSA
- CALG_ECMQV
- CALG_HASH_REPLACE_OWF
- CALG_HUGHES_MD5
- CALG_HMAC
- CALG_KEA_KEYX
- CALG_MAC
- CALG_MD2
- CALG_MD4
- CALG_MD5
- CALG_NO_SIGN
- CALG_OID_INFO_CNG_ONLY
- CALG_OID_INFO_PARAMETERS
- CALG_PCT1_MASTER
- CALG_RC2
- CALG_RC4
- CALG_RC5
- CALG_RSA_KEYX
- CALG_RSA_SIGN
- CALG_SCHANNEL_ENC_KEY
- CALG_SCHANNEL_MAC_KEY
- CALG_SCHANNEL_MASTER_HASH
- CALG_SEAL
- CALG_SHA
- CALG_SHA1
- CALG_SHA_256
- CALG_SHA_384
- CALG_SHA_512
- CALG_SKIPJACK
- CALG_SSL2_MASTER
- CALG_SSL3_MASTER
- CALG_SSL3_SHAMD5
- CALG_TEK
- CALG_TLS1_MASTER
- CALG_TLS1PRF
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA");
Possible values when ssl_provider is set to Internal include the following:
- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
- TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_DES_CBC_SHA
- TLS_DHE_RSA_WITH_DES_CBC_SHA
- TLS_DHE_DSS_WITH_DES_CBC_SHA
- TLS_RSA_WITH_RC4_128_MD5
- TLS_RSA_WITH_RC4_128_SHA
When TLS 1.3 is negotiated (see SSLEnabledProtocols), only the following cipher suites are supported:
- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256
SSLEnabledCipherSuites is used together with SSLCipherStrength.
Not all supported protocols are enabled by default (the value of this configuration setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary OR of one or more of the following values:
TLS1.3 | 12288 (Hex 3000) |
TLS1.2 | 3072 (Hex C00) (Default) |
TLS1.1 | 768 (Hex 300) (Default) |
TLS1 | 192 (Hex C0) (Default) |
SSL3 | 48 (Hex 30) |
SSL2 | 12 (Hex 0C) |
SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:
By default when TLS 1.3 is enabled, the class will use the internal TLS implementation when the ssl_provider is set to Automatic for all editions.
In editions that are designed to run on Windows, ssl_provider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.
If set to 1 (Platform provider), please be aware of the following notes:
- The platform provider is available only on Windows 11/Windows Server 2022 and up.
- SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
- If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.
This configuration setting is applicable only when ssl_provider is set to Internal.
If set to True, all certificates returned by the server will be present in the Encoded parameter of the on_ssl_server_authentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.
When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the class will only append, it will not overwrite previous values.
Note: This configuration setting is applicable only when ssl_provider is set to Internal.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
0x00000001 | Ignore time validity status of certificate. |
0x00000002 | Ignore time validity status of CTL. |
0x00000004 | Ignore non-nested certificate times. |
0x00000010 | Allow unknown certificate authority. |
0x00000020 | Ignore wrong certificate usage. |
0x00000100 | Ignore unknown certificate revocation status. |
0x00000200 | Ignore unknown CTL signer revocation status. |
0x00000400 | Ignore unknown certificate authority revocation status. |
0x00000800 | Ignore unknown root revocation status. |
0x00008000 | Allow test root certificate. |
0x00004000 | Trust test root certificate. |
0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). |
This functionality is currently not available when the provider is OpenSSL.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When specified the class will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the class fails with an error.
The format of this value is a comma-separated list of hash-signature combinations. For instance:
component.SSLProvider = TCPClientSSLProviders.sslpInternal;
component.Config("SSLEnabledProtocols=3072"); //TLS 1.2
component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");
The default value for this configuration setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.
To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.
When using TLS 1.2 and ssl_provider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting.
Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group.
In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so.
The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448"
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1"
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096"
- "ffdhe_6144"
- "ffdhe_8192"
- "ed25519" (default)
- "ed448" (default)
- "ecdsa_secp256r1_sha256" (default)
- "ecdsa_secp384r1_sha384" (default)
- "ecdsa_secp521r1_sha512" (default)
- "rsa_pkcs1_sha256" (default)
- "rsa_pkcs1_sha384" (default)
- "rsa_pkcs1_sha512" (default)
- "rsa_pss_sha256" (default)
- "rsa_pss_sha384" (default)
- "rsa_pss_sha512" (default)
The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448" (default)
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096" (default)
- "ffdhe_6144" (default)
- "ffdhe_8192" (default)
Socket Config Settings
Note: This option is not valid for User Datagram Protocol (UDP) ports.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Base Config Settings
The following is a list of valid code page identifiers:
Identifier | Name |
037 | IBM EBCDIC - U.S./Canada |
437 | OEM - United States |
500 | IBM EBCDIC - International |
708 | Arabic - ASMO 708 |
709 | Arabic - ASMO 449+, BCON V4 |
710 | Arabic - Transparent Arabic |
720 | Arabic - Transparent ASMO |
737 | OEM - Greek (formerly 437G) |
775 | OEM - Baltic |
850 | OEM - Multilingual Latin I |
852 | OEM - Latin II |
855 | OEM - Cyrillic (primarily Russian) |
857 | OEM - Turkish |
858 | OEM - Multilingual Latin I + Euro symbol |
860 | OEM - Portuguese |
861 | OEM - Icelandic |
862 | OEM - Hebrew |
863 | OEM - Canadian-French |
864 | OEM - Arabic |
865 | OEM - Nordic |
866 | OEM - Russian |
869 | OEM - Modern Greek |
870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
875 | IBM EBCDIC - Modern Greek |
932 | ANSI/OEM - Japanese, Shift-JIS |
936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
949 | ANSI/OEM - Korean (Unified Hangul Code) |
950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
1026 | IBM EBCDIC - Turkish (Latin-5) |
1047 | IBM EBCDIC - Latin 1/Open System |
1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
1147 | IBM EBCDIC - France (20297 + Euro symbol) |
1148 | IBM EBCDIC - International (500 + Euro symbol) |
1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
1201 | Unicode UCS-2 Big-Endian |
1250 | ANSI - Central European |
1251 | ANSI - Cyrillic |
1252 | ANSI - Latin I |
1253 | ANSI - Greek |
1254 | ANSI - Turkish |
1255 | ANSI - Hebrew |
1256 | ANSI - Arabic |
1257 | ANSI - Baltic |
1258 | ANSI/OEM - Vietnamese |
1361 | Korean (Johab) |
10000 | MAC - Roman |
10001 | MAC - Japanese |
10002 | MAC - Traditional Chinese (Big5) |
10003 | MAC - Korean |
10004 | MAC - Arabic |
10005 | MAC - Hebrew |
10006 | MAC - Greek I |
10007 | MAC - Cyrillic |
10008 | MAC - Simplified Chinese (GB 2312) |
10010 | MAC - Romania |
10017 | MAC - Ukraine |
10021 | MAC - Thai |
10029 | MAC - Latin II |
10079 | MAC - Icelandic |
10081 | MAC - Turkish |
10082 | MAC - Croatia |
12000 | Unicode UCS-4 Little-Endian |
12001 | Unicode UCS-4 Big-Endian |
20000 | CNS - Taiwan |
20001 | TCA - Taiwan |
20002 | Eten - Taiwan |
20003 | IBM5550 - Taiwan |
20004 | TeleText - Taiwan |
20005 | Wang - Taiwan |
20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
20106 | IA5 German (7-bit) |
20107 | IA5 Swedish (7-bit) |
20108 | IA5 Norwegian (7-bit) |
20127 | US-ASCII (7-bit) |
20261 | T.61 |
20269 | ISO 6937 Non-Spacing Accent |
20273 | IBM EBCDIC - Germany |
20277 | IBM EBCDIC - Denmark/Norway |
20278 | IBM EBCDIC - Finland/Sweden |
20280 | IBM EBCDIC - Italy |
20284 | IBM EBCDIC - Latin America/Spain |
20285 | IBM EBCDIC - United Kingdom |
20290 | IBM EBCDIC - Japanese Katakana Extended |
20297 | IBM EBCDIC - France |
20420 | IBM EBCDIC - Arabic |
20423 | IBM EBCDIC - Greek |
20424 | IBM EBCDIC - Hebrew |
20833 | IBM EBCDIC - Korean Extended |
20838 | IBM EBCDIC - Thai |
20866 | Russian - KOI8-R |
20871 | IBM EBCDIC - Icelandic |
20880 | IBM EBCDIC - Cyrillic (Russian) |
20905 | IBM EBCDIC - Turkish |
20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
20932 | JIS X 0208-1990 & 0121-1990 |
20936 | Simplified Chinese (GB2312) |
21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
21027 | Extended Alpha Lowercase |
21866 | Ukrainian (KOI8-U) |
28591 | ISO 8859-1 Latin I |
28592 | ISO 8859-2 Central Europe |
28593 | ISO 8859-3 Latin 3 |
28594 | ISO 8859-4 Baltic |
28595 | ISO 8859-5 Cyrillic |
28596 | ISO 8859-6 Arabic |
28597 | ISO 8859-7 Greek |
28598 | ISO 8859-8 Hebrew |
28599 | ISO 8859-9 Latin 5 |
28605 | ISO 8859-15 Latin 9 |
29001 | Europa 3 |
38598 | ISO 8859-8 Hebrew |
50220 | ISO 2022 Japanese with no halfwidth Katakana |
50221 | ISO 2022 Japanese with halfwidth Katakana |
50222 | ISO 2022 Japanese JIS X 0201-1989 |
50225 | ISO 2022 Korean |
50227 | ISO 2022 Simplified Chinese |
50229 | ISO 2022 Traditional Chinese |
50930 | Japanese (Katakana) Extended |
50931 | US/Canada and Japanese |
50933 | Korean Extended and Korean |
50935 | Simplified Chinese Extended and Simplified Chinese |
50936 | Simplified Chinese |
50937 | US/Canada and Traditional Chinese |
50939 | Japanese (Latin) Extended and Japanese |
51932 | EUC - Japanese |
51936 | EUC - Simplified Chinese |
51949 | EUC - Korean |
51950 | EUC - Traditional Chinese |
52936 | HZ-GB2312 Simplified Chinese |
54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
57002 | ISCII Devanagari |
57003 | ISCII Bengali |
57004 | ISCII Tamil |
57005 | ISCII Telugu |
57006 | ISCII Assamese |
57007 | ISCII Oriya |
57008 | ISCII Kannada |
57009 | ISCII Malayalam |
57010 | ISCII Gujarati |
57011 | ISCII Punjabi |
65000 | Unicode UTF-7 |
65001 | Unicode UTF-8 |
Identifier | Name |
1 | ASCII |
2 | NEXTSTEP |
3 | JapaneseEUC |
4 | UTF8 |
5 | ISOLatin1 |
6 | Symbol |
7 | NonLossyASCII |
8 | ShiftJIS |
9 | ISOLatin2 |
10 | Unicode |
11 | WindowsCP1251 |
12 | WindowsCP1252 |
13 | WindowsCP1253 |
14 | WindowsCP1254 |
15 | WindowsCP1250 |
21 | ISO2022JP |
30 | MacOSRoman |
10 | UTF16String |
0x90000100 | UTF16BigEndian |
0x94000100 | UTF16LittleEndian |
0x8c000100 | UTF32String |
0x98000100 | UTF32BigEndian |
0x9c000100 | UTF32LittleEndian |
65536 | Proprietary |
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
Setting this configuration setting to True tells the class to use the internal implementation instead of using the system security libraries.
On Windows, this setting is set to False by default. On Linux/macOS, this setting is set to True by default.
To use the system security libraries for Linux, Open Secure Sockets Layer (OpenSSL) support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.
CardDAV Errors
CardDAV Errors
222 | Property set with an improper enumeration value. |
234 | Missing required field. |
432 | Invalid array property index. |
471 | Server error. Description contains detailed information. |
476 | No lock tokens. |
700 | Bad response received from CardDAV server. Unable to parse. |
701 | The CardDAV server returned an empty address book. |
704 | The class was unable to complete the requested action because a required property has not been set. |
The class may also return one of the following error codes, which are inherited from other classes.
HTTP Errors
118 | Firewall Error. Error description contains detailed message. |
143 | Busy executing current method. |
151 | HTTP protocol error. The error message has the server response. |
152 | No server specified in url |
153 | Specified url_scheme is invalid. |
155 | Range operation is not supported by server. |
156 | Invalid cookie index (out of range). |
301 | Interrupted. |
302 | Can't open attached_file. |
The class may also return one of the following error codes, which are inherited from other classes.
TCPClient Errors
100 | You cannot change the remote_port at this time. A connection is in progress. |
101 | You cannot change the remote_host (Server) at this time. A connection is in progress. |
102 | The remote_host address is invalid (0.0.0.0). |
104 | Already connected. If you want to reconnect, close the current connection first. |
106 | You cannot change the local_port at this time. A connection is in progress. |
107 | You cannot change the local_host at this time. A connection is in progress. |
112 | You cannot change MaxLineLength at this time. A connection is in progress. |
116 | remote_port cannot be zero. Please specify a valid service port number. |
117 | You cannot change the UseConnection option while the class is active. |
135 | Operation would block. |
201 | Timeout. |
211 | Action impossible in control's present state. |
212 | Action impossible while not connected. |
213 | Action impossible while listening. |
301 | Timeout. |
302 | Could not open file. |
434 | Unable to convert string to selected CodePage. |
1105 | Already connecting. If you want to reconnect, close the current connection first. |
1117 | You need to connect first. |
1119 | You cannot change the LocalHost at this time. A connection is in progress. |
1120 | Connection dropped by remote host. |
SSL Errors
270 | Cannot load specified security library. |
271 | Cannot open certificate store. |
272 | Cannot find specified certificate. |
273 | Cannot acquire security credentials. |
274 | Cannot find certificate chain. |
275 | Cannot verify certificate chain. |
276 | Error during handshake. |
280 | Error verifying certificate. |
281 | Could not find client certificate. |
282 | Could not find server certificate. |
283 | Error encrypting data. |
284 | Error decrypting data. |
TCP/IP Errors
10004 | [10004] Interrupted system call. |
10009 | [10009] Bad file number. |
10013 | [10013] Access denied. |
10014 | [10014] Bad address. |
10022 | [10022] Invalid argument. |
10024 | [10024] Too many open files. |
10035 | [10035] Operation would block. |
10036 | [10036] Operation now in progress. |
10037 | [10037] Operation already in progress. |
10038 | [10038] Socket operation on nonsocket. |
10039 | [10039] Destination address required. |
10040 | [10040] Message is too long. |
10041 | [10041] Protocol wrong type for socket. |
10042 | [10042] Bad protocol option. |
10043 | [10043] Protocol is not supported. |
10044 | [10044] Socket type is not supported. |
10045 | [10045] Operation is not supported on socket. |
10046 | [10046] Protocol family is not supported. |
10047 | [10047] Address family is not supported by protocol family. |
10048 | [10048] Address already in use. |
10049 | [10049] Cannot assign requested address. |
10050 | [10050] Network is down. |
10051 | [10051] Network is unreachable. |
10052 | [10052] Net dropped connection or reset. |
10053 | [10053] Software caused connection abort. |
10054 | [10054] Connection reset by peer. |
10055 | [10055] No buffer space available. |
10056 | [10056] Socket is already connected. |
10057 | [10057] Socket is not connected. |
10058 | [10058] Cannot send after socket shutdown. |
10059 | [10059] Too many references, cannot splice. |
10060 | [10060] Connection timed out. |
10061 | [10061] Connection refused. |
10062 | [10062] Too many levels of symbolic links. |
10063 | [10063] File name is too long. |
10064 | [10064] Host is down. |
10065 | [10065] No route to host. |
10066 | [10066] Directory is not empty |
10067 | [10067] Too many processes. |
10068 | [10068] Too many users. |
10069 | [10069] Disc Quota Exceeded. |
10070 | [10070] Stale NFS file handle. |
10071 | [10071] Too many levels of remote in path. |
10091 | [10091] Network subsystem is unavailable. |
10092 | [10092] WINSOCK DLL Version out of range. |
10093 | [10093] Winsock is not loaded yet. |
11001 | [11001] Host not found. |
11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). |
11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. |
11004 | [11004] Valid name, no data record (check DNS setup). |