CardDAV Class

Properties Methods Events Config Settings Errors

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

Syntax

ipworks.carddav()

Remarks

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

Authentication

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

Bearer ACCESS_TOKEN_VALUE

Assign 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. Below is an example of using the GetAddressbookReport method, which makes a REPORT request to the given URI in the CardDAV server. cardDAV.GetAddressbookReport("https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default");

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

Listing Address Books

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

Once this method returns, the class will populate the Addressbooks collection. For example:

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

Managing Address Books

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

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

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

Listing Contacts

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

The following properties are used when calling CreateContact, UpdateContact or ExportVCF, and will be filled after calling GetContact or ImportVCF. These will also be available from inside the ContactDetails event, which is fired for each contact received from the CardDAV server in response when calling GetAddressbookReport.

AddressLabels
Addresses
Agent
Anniversary
BirthDay
Categories
Classification
ContactURL
CustomProperties
Depth
EMails
FormattedName
Gender
GeoLocation
IMPPs
Kind
Languages
Logo
Mailer
Member
Names
NickName
Note
Organization
PhoneNumbers
Photo
ProductId
PublicKey
Related
RevisionTime
Role
SortString
Sound
Timezone
Title
UID
URL
VCardVersion
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 ContactDetails event will print the formatted name, phone number and email for each contact: Private Sub CardDAV_ContactDetails(ResourceURI As String, ResponseStatus As String, ETag As String, ContactData As String) Debug.Print cardDAV.FormattedName + " " + cardDAV.PhoneNumbers[0].Value + " " + cardDAV.EMails[0].Value End Sub The output from the above code will look like this:

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

Managing Contacts

The CreateContact, UpdateContact, DeleteContact, CopyContact, and MoveContact methods provide a way to manage individual contacts within an address book.

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

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

When calling MoveContact or CopyContact specify the URI of the contact to be copied or moved, and the destination URI. When calling DeleteContact specify the URI of the contact to delete.

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

Creating and Retrieving Contacts using vCards

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

Property List

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


Addressbooks	A collection of address books.
Addresses	The address information for a contact.
Anniversary	The date of marriage, or equivalent for a contact.
Authorization	This property includes the Authorization string to be sent to the server.
AuthScheme	This property specifies the authentication scheme to use when server authentication is required.
BirthDay	The birth date of the contact.
Connected	Whether the class is connected.
Cookies	A collection of cookies.
CustomProperties	List of extra properties that may be used to extend the functionality of this class.
EMails	The email address of a contact.
ETag	Identifier returned by the CardDAV server which is used to synchronize edits.
Firewall	A set of properties related to firewall access.
FollowRedirects	Determines what happens when the server issues a redirect.
FormattedName	The formatted name of the contact.
Gender	The sex and gender identity of a contact.
Idle	The current status of the class.
Kind	The kind of object the vCard represents.
Languages	The language(s) that may be used for contacting the entity associated with the vCard.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Names	The name of a contact.
NickName	The nickname of the object the vCard represents.
Note	Provides additional information or comments about a contact.
Organization	The organizational name and units associated with a contact.
OtherHeaders	Other headers as determined by the user (optional).
ParsedHeaders	This property includes a collection of headers returned from the last request.
Password	This property includes a password if authentication is to be used.
PhoneNumbers	The telephone number of a contact.
Photo	A photograph or image associated with a contact.
Proxy	A set of properties related to proxy access.
ReportFilter	Criteria used to filter reports.
Role	The function or part played in a particular situation by a contact.
SSLAcceptServerCert	Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.
SSLCert	The certificate to be used during Secure Sockets Layer (SSL) negotiation.
SSLProvider	The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
SSLServerCert	The server certificate for the last established connection.
Timeout	The timeout for the class.
Title	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.
VCardVersion	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.


AddCookie	Adds a cookie and the corresponding value to the outgoing request headers.
AddCustomProperty	Adds a form variable and the corresponding value.
Config	Sets or retrieves a configuration setting.
CopyContact	Copy contact to a new location.
CreateAddressbook	Creates a new address book collection resource.
CreateContact	Adds a contact resource at the specified ResourceURI using the CardDAV PUT method.
DeleteAddressbook	Deletes an address book collection resource.
DeleteContact	Deletes a resource.
DoEvents	This method processes events from the internal message queue.
ExportVCF	Generates a contact from the properties in the vCard format.
GetAddressbookOptions	Retrieves options for the ResourceURI to determine whether it supports address book access.
GetAddressbookReport	Generates a report on the indicated address book.
GetContact	Retrieves a single contact from the CardDAV server.
ImportVCF	Imports contact data (contained in a VCF file) into the class's property list.
Interrupt	This method interrupts the current method.
ListAddressbooks	Lists all address books that the current user can access.
MoveContact	Moves one contact resource to a new location.
Reset	Reset the class.
SendCustomRequest	Sends a custom request to the server.
UpdateAddressbook	Updates an address book collection resource.
UpdateContact	Updates a contact at the specified ResourceURI.

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.


Connected	Fired immediately after a connection completes (or fails).
ConnectionStatus	Fired to indicate changes in the connection state.
ContactDetails	Fires for each contact received.
Disconnected	Fired when a connection is closed.
EndTransfer	This event is fired when a document finishes transferring.
Error	Fired when information is available about errors during data delivery.
Header	Fired every time a header line comes in.
Log	Fired once for each log message.
Redirect	Fired when a redirection is received from the server.
SetCookie	Fired for every cookie set by the server.
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Fired when secure connection progress messages are available.
StartTransfer	This event is fired when a document starts transferring (after the headers).
Status	Fired when the HTTP status line is received from the server.
Transfer	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.
ContactURL	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.
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.
SSLAcceptAnyServerCert	Whether to trust any certificate presented by the server.
SSLCACerts	A newline separated list of CA certificates to be included when performing an SSL handshake.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLClientCACerts	A newline separated list of CA certificates to use during SSL client certificate validation.
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 certificates 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.
UseInternalSecurityAPI	Whether or not to use the system security libraries or an internal implementation.

CardDAV.Addressbooks Property

A collection of address books.

Syntax

getAddressbooks(): CardAddressbookInfoList;
setAddressbooks(addressbooks: CardAddressbookInfoList): void;

Default Value

Remarks

This collection will hold data for each CardAddressbookInfo available to the current user. Calling ListAddressbooks will populate this collection.

Please refer to the CardAddressbookInfo type for a complete list of fields.

CardDAV.Addresses Property

The address information for a contact.

Syntax

getAddresses(): CardCustomPropList;
setAddresses(addresses: CardCustomPropList): void;

Default Value

Remarks

This property is used to specify one or more physical addresses associated with a contact. Its value consists of multiple structured text values representing different parts of the address, where each part is separated by the SEMI-COLON character (ASCII decimal 59). The structured address value corresponds, in sequence, to the post office box; the extended address; the street address; the locality (e.g., city); the region (e.g., state or province); the postal code; the country name. When a component value is missing, the associated component separator MUST still be specified. Each address can include parameters such as TYPE to specify the type of address (e.g., home, work, postal, etc.). Below is an example on how to use this property: CardCustomProp address1 = new CardCustomProp("address", "PO Box 123;123 Extended Address;123 Main Street;Any Town;State;1234;Country Name"); address1.Attribute = "TYPE=home"; //optional cardDAV.Addresses.Add(address1); CardCustomProp address1 = new CardCustomProp("address", ";;456 Main Street;Any Town;State;5678;Country Name"); address1.Attribute = "TYPE=work"; //optional cardDAV.Addresses.Add(address2);

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

Please refer to the CardCustomProp type for a complete list of fields.

CardDAV.Anniversary Property

The date of marriage, or equivalent for a contact.

Syntax

getAnniversary(): CardCustomProp;
setAnniversary(anniversary: CardCustomProp): void;

Default Value

Remarks

This property represents the date of marriage, or equivalent, for a contact. It can be a single date-and-or-time or a single text value, for example: cardDAV.Anniversary = new CardCustomProp("anniversary", "19961212");

Please refer to the CardCustomProp type for a complete list of fields.

CardDAV.Authorization Property

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

Syntax

getAuthorization(): string;
setAuthorization(authorization: string): void;

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

CardDAV.AuthScheme Property

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

Syntax

getAuthScheme(): CardDAVAuthSchemes;
setAuthScheme(authScheme: CardDAVAuthSchemes): void;

enum CardDAVAuthSchemes {
  authBasic,
  authDigest,
  authProprietary,
  authNone,
  authNtlm,
  authNegotiate,
  authOAuth
}

Default Value

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 AuthScheme is set to authDigest (1), authNtlm (4), or authNegotiate (5), then Digest, NTLM, or Windows Negotiate (Kerberos) authentication will be attempted instead.

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

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

Note: If you set the Authorization property and AuthScheme is not authProprietary or authOAuth, then the AuthScheme 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.

CardDAV.BirthDay Property

The birth date of the contact.

Syntax

getBirthDay(): CardCustomProp;
setBirthDay(birthDay: CardCustomProp): void;

Default Value

Remarks

This property is used to specify the birth date of a contact. It can be a date-time value or a date value. Below is an example on how to use this property: cardDAV.BirthDay = new CardCustomProp("birthday", "1996-04-15");

Please refer to the CardCustomProp type for a complete list of fields.

CardDAV.Connected Property

Whether the class is connected.

Syntax

isConnected(): boolean;

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 and not available at design time.

CardDAV.Cookies Property

A collection of cookies.

Syntax

getCookies(): HTTPCookieList;
setCookies(cookies: HTTPCookieList): void;

Default Value

Remarks

This property contains a collection of cookies. To add cookies to outgoing HTTP requests, add cookies (of type HTTPCookie) to this collection.

To see cookies that are set by the server, use the SetCookie event, which displays the cookies and their properties as set by the server. Those cookies also are added to Cookies.

MaxHTTPCookies can be used to control the maximum number of cookies saved.

This property is not available at design time.

Please refer to the HTTPCookie type for a complete list of fields.

CardDAV.CustomProperties Property

List of extra properties that may be used to extend the functionality of this class.

Syntax

getCustomProperties(): CardCustomPropList;
setCustomProperties(customProperties: CardCustomPropList): void;

Default Value

Remarks

This property is used to add additional name/value pairs to the request. It is valid only for the CreateContact and UpdateContact methods. You may use this property to submit any CardDAV fields that are not directly supported by this class. You may also use it to send custom properties that are specific on the address book that you are using. Such custom properties normally start with "X-". For instance: cardDAV.CustomProperties.Add(new CardCustomProp("TEL", "123456789", "TYPE=home"));

Or alternatively: cardDAV.CustomProperties.Add(new CardCustomProp()); cardDAV.CustomProperties[0].Name = "TEL"; cardDAV.CustomProperties[0].Value = "123456789"; cardDAV.CustomProperties[0].Attribute = "TYPE=home";

The contents of the CustomProperties collection will only be added to the CreateContact or UpdateContact requests. They will be ignored for all other methods.

This property is not available at design time.

Please refer to the CardCustomProp type for a complete list of fields.

CardDAV.EMails Property

The email address of a contact.

Syntax

getEMails(): CardCustomPropList;
setEMails(EMails: CardCustomPropList): void;

Default Value

Remarks

This property is used to specify the email address for communication with a contact. It consists of a single text value representing the email address. Multiple EMails properties can be used to represent multiple email addresses for a contact. Additionally, each EMails property can include parameters such as TYPE to specify the type of email address (e.g., work, home, or other).

Please refer to the CardCustomProp type for a complete list of fields.

CardDAV.ETag Property

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

Syntax

getETag(): string;
setETag(ETag: string): void;

Default Value

Remarks

This property identifies the state of the contact in the address book. ETag is returned by the CardDAV server after a successful CreateContact 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 the ETag value to maintain a cache. If you submit a GetAddressbookReport request with the ReportFilterReturnContactData property set to False, only the ResourceURI and ETag for each contact in the address book will be returned in from ContactDetails. 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.

CardDAV.Firewall Property

A set of properties related to firewall access.

Syntax

getFirewall(): Firewall;
setFirewall(firewall: Firewall): void;

Default Value

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the class will attempt to connect.

Please refer to the Firewall type for a complete list of fields.

CardDAV.FollowRedirects Property

Determines what happens when the server issues a redirect.

Syntax

getFollowRedirects(): CardDAVFollowRedirects;
setFollowRedirects(followRedirects: CardDAVFollowRedirects): void;

enum CardDAVFollowRedirects {
  frNever,
  frAlways,
  frSameScheme
}

Default Value

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 URLScheme is the same; otherwise, the class .

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 Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the 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 instead.

CardDAV.FormattedName Property

The formatted name of the contact.

Syntax

getFormattedName(): string;
setFormattedName(formattedName: string): void;

Default Value

Remarks

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

CardDAV.Gender Property

The sex and gender identity of a contact.

Syntax

getGender(): string;
setGender(gender: string): void;

Default Value

Remarks

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

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

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

The second part 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";

CardDAV.Idle Property

The current status of the class.

Syntax

isIdle(): boolean;

Default Value

TRUE

Remarks

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

This property is read-only.

CardDAV.Kind Property

The kind of object the vCard represents.

Syntax

getKind(): string;
setKind(kind: string): void;

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.

CardDAV.Languages Property

The language(s) that may be used for contacting the entity associated with the vCard.

Syntax

getLanguages(): CardCustomPropList;
setLanguages(languages: CardCustomPropList): void;

Default Value

Remarks

This property is used to specify the language(s) that may be used for contacting the entity associated with the vCard.

Please refer to the CardCustomProp type for a complete list of fields.

CardDAV.LocalHost Property

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

Syntax

getLocalHost(): string;
setLocalHost(localHost: string): void;

Default Value

Remarks

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

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

If the class is connected, the LocalHost 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: LocalHost is not persistent. You must always set it in code, and never in the property window.

CardDAV.Names Property

The name of a contact.

Syntax

getNames(): string;
setNames(names: string): void;

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

CardDAV.NickName Property

The nickname of the object the vCard represents.

Syntax

getNickName(): string;
setNickName(nickName: string): void;

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.

CardDAV.Note Property

Provides additional information or comments about a contact.

Syntax

getNote(): string;
setNote(note: string): void;

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.

CardDAV.Organization Property

The organizational name and units associated with a contact.

Syntax

getOrganization(): string;
setOrganization(organization: string): void;

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

CardDAV.OtherHeaders Property

Other headers as determined by the user (optional).

Syntax

getOtherHeaders(): string;
setOtherHeaders(otherHeaders: string): void;

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 ContentType and From.

The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by .

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

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

For CardDAV, the "If-Match" header is extremely useful. After adding a contact with CreateContact or retrieving a contact with GetContact, the ETag property will contain a value indicating the current state of the contact. If you wish to update the contact, you may pass this returned ETag 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 CreateContact 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";

This property is not available at design time.

CardDAV.ParsedHeaders Property

This property includes a collection of headers returned from the last request.

Syntax

getParsedHeaders(): HeaderList;

Default Value

Remarks

This property contains a collection of headers returned from the last request. Whenever headers are returned from the server, the headers are parsed into a collection of headers. Each Header in this collection contains information describing that header.

MaxHeaders can be used to control the maximum number of headers saved.

This property is read-only and not available at design time.

Please refer to the Header type for a complete list of fields.

CardDAV.Password Property

This property includes a password if authentication is to be used.

Syntax

getPassword(): string;
setPassword(password: string): void;

Default Value

Remarks

This property contains a password if authentication is to be used. If AuthScheme 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 AuthScheme 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 AuthScheme is set to NTLM, NTLM authentication will be attempted. If AuthScheme is set to NTLM and User and Password are empty, the class will attempt to authenticate using the current user's credentials.

CardDAV.PhoneNumbers Property

The telephone number of a contact.

Syntax

getPhoneNumbers(): CardCustomPropList;
setPhoneNumbers(phoneNumbers: CardCustomPropList): void;

Default Value

Remarks

This property is used to specify one or more telephone numbers associated with a contact. Each phone number consists of a single text value and can include parameters such as TYPE to specify the type of telephone number (e.g., home, msg, voice, fax, cell, video, pager, bbs, modem, car isdn, pcs etc.). Below is an example on how to use this property: CardCustomProp phoneNumber = new CardCustomProp("phone number", "+1-213-555-1234"); phoneNumber.Attribute = "TYPE=home,voice"; //optional cardDAV.PhoneNumbers.Add(phoneNumber); phoneNumber = new CardCustomProp("phone number", "+1-789-666-4321"); phoneNumber.Attribute = "TYPE=work,voice,pref,msg"; //optional cardDAV.PhoneNumbers.Add(phoneNumber);

Please refer to the CardCustomProp type for a complete list of fields.

CardDAV.Photo Property

A photograph or image associated with a contact.

Syntax

getPhoto(): CardCustomProp;
setPhoto(photo: CardCustomProp): void;

Default Value

Remarks

This property is used to specify a photograph or image associated with a contact. Its value can be either a URI pointing to the location of the photograph/image or an inline binary representation of the image data. When using inline binary representation, the encoding must be reset to "b" using the ENCODING parameter. Below is an example on how to use this property: CardCustomProp photo = new CardCustomProp("photo", "http://www.abc.com/pub/photos/jqpublic.gif"); //or //CardCustomProp photo = new CardCustomProp("photo", "MIICajCCAdOgAwIBAgICBEUwDQYJ...QQLExNJbmZvcm1hdGlvbiBTeXN0"); //photo.Attribute = "ENCODING=b;TYPE=JPEG"; cardDAV.Photo = photo;

Please refer to the CardCustomProp type for a complete list of fields.

CardDAV.Proxy Property

A set of properties related to proxy access.

Syntax

getProxy(): Proxy;
setProxy(proxy: Proxy): void;

Default Value

Remarks

This property contains fields describing the proxy through which the class will attempt to connect.

Please refer to the Proxy type for a complete list of fields.

CardDAV.ReportFilter Property

Criteria used to filter reports.

Syntax

getReportFilter(): CardReportFilter;
setReportFilter(reportFilter: CardReportFilter): void;

Default Value

Remarks

This property may be used to restrict the results of reports to only those that match your search criteria.The GetAddressbookReport method will normally return the entire address book collection at the specified ResourceURI. You can restrict results to only contacts within a specified criteria. You can restrict results to only those contacts which contain a specific (either by property name, or name and a specific value). You can use to specify a properly-formed XML which a contact has to match. To find a specific contact you can use the and the result of the report will contain only the contact with that UID or no contacts if none match. You can use to decide whether the contents of each contact are returned in the report. Below is an example on how to use this property: // cardDAV.ReportFilter.UID = "734D516F-932B-45BD"; // the report will contain only one contact, the one that has the specified UID // cardDAV.ReportFilter.Property = "FN:Abby,ORG:CompanyName"; // the report will contain contacts that have the Formatted Name equals to "Abby" and Organization equals to "CompanyName" cardDAV.ReportFilter.ReturnContactData = false; //the report will contain only URIs and ETags of each contact. cardDAV.GetAddressbookReport("https://mydavserver/.well-known/carddav/AddressbookName");

Please refer to the CardReportFilter type for a complete list of fields.

CardDAV.Role Property

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

Syntax

getRole(): string;
setRole(role: string): void;

Default Value

Remarks

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

CardDAV.SSLAcceptServerCert Property

Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

getSSLAcceptServerCert(): Certificate;
setSSLAcceptServerCert(SSLAcceptServerCert: Certificate): void;

Default Value

Remarks

If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

Please refer to the Certificate type for a complete list of fields.

CardDAV.SSLCert Property

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

getSSLCert(): Certificate;
setSSLCert(SSLCert: Certificate): void;

Default Value

Remarks

This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the field to the encoded certificate. To select a certificate, use the store and subject fields.

Please refer to the Certificate type for a complete list of fields.

CardDAV.SSLProvider Property

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

Syntax

getSSLProvider(): CardDAVSSLProviders;
setSSLProvider(SSLProvider: CardDAVSSLProviders): void;

enum CardDAVSSLProviders {
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
}

Default Value

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.

Additional Notes

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, the platform implementation will be used by default in all cases in the JavaScript edition.

Note: The internal provider is not support at this time.

CardDAV.SSLServerCert Property

The server certificate for the last established connection.

Syntax

getSSLServerCert(): Certificate;

Default Value

Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Please refer to the Certificate type for a complete list of fields.

CardDAV.Timeout Property

The timeout for the class.

Syntax

getTimeout(): number;
setTimeout(timeout: number): void;

Default Value

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

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.

CardDAV.Title Property

The position or job of the object the vCard represents.

Syntax

getTitle(): string;
setTitle(title: string): void;

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.

CardDAV.UID Property

A persistent, globally unique identifier for the contact.

Syntax

getUID(): string;
setUID(UID: string): void;

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.

CardDAV.URL Property

Location of the contact resource on the CardDAV server.

Syntax

getURL(): string;

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

This property is read-only.

CardDAV.User Property

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

Syntax

getUser(): string;
setUser(user: string): void;

Default Value

Remarks

This property contains a user name if authentication is to be used. If AuthScheme 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 AuthScheme 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 AuthScheme is set to NTLM, NTLM authentication will be attempted. If AuthScheme is set to NTLM, and User and Password are empty, the class will attempt to authenticate using the current user's credentials.

CardDAV.VCardVersion Property

The vCard version format.

Syntax

getVCardVersion(): string;
setVCardVersion(VCardVersion: string): void;

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.

CardDAV.addCookie Method

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

Syntax

async carddav.addCookie(cookieName : string, cookieValue : string): Promise<void>

Remarks

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

CardDAV.addCustomProperty Method

Adds a form variable and the corresponding value.

Syntax

async carddav.addCustomProperty(varName : string, varValue : string): Promise<void>

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 CustomProperties properties.

Example using the AddCustomProperty 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"

CardDAV.config Method

Sets or retrieves a configuration setting.

Syntax

async carddav.config(configurationString : string): Promise<string>

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.

CardDAV.copyContact Method

Copy contact to a new location.

Syntax

async carddav.copyContact(sourceResourceURI : string, destinationResourceURI : string): Promise<void>

Remarks

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

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

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

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

CardDAV.createAddressbook Method

Creates a new address book collection resource.

Syntax

async carddav.createAddressbook(resourceURI : string, displayName : string, description : string): Promise<void>

Remarks

The CreateAddressbook 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.

CardDAV.createContact Method

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

Syntax

async carddav.createContact(resourceURI : string): Promise<void>

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.

AddressLabels
Addresses
Agent
Anniversary
BirthDay
Categories
Classification
ContactURL
CustomProperties
Depth
EMails
FormattedName
Gender
GeoLocation
IMPPs
Kind
Languages
Logo
Mailer
Member
Names
NickName
Note
Organization
PhoneNumbers
Photo
ProductId
PublicKey
Related
RevisionTime
Role
SortString
Sound
Timezone
Title
UID
URL
VCardVersion
XML

CardDAV.deleteAddressbook Method

Deletes an address book collection resource.

Syntax

async carddav.deleteAddressbook(resourceURI : string): Promise<void>

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.

CardDAV.deleteContact Method

Deletes a resource.

Syntax

async carddav.deleteContact(resourceURI : string): Promise<void>

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.

CardDAV.doEvents Method

This method processes events from the internal message queue.

Syntax

async carddav.doEvents(): Promise<void>

Remarks

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

CardDAV.exportVCF Method

Generates a contact from the properties in the vCard format.

Syntax

async carddav.exportVCF(): Promise<string>

Remarks

The ExportVCF 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 ExportVCF method will create the exact same data as the CreateContact method sends when adding or updating a contact to an address book.

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

AddressLabels
Addresses
Agent
Anniversary
BirthDay
Categories
Classification
ContactURL
CustomProperties
Depth
EMails
FormattedName
Gender
GeoLocation
IMPPs
Kind
Languages
Logo
Mailer
Member
Names
NickName
Note
Organization
PhoneNumbers
Photo
ProductId
PublicKey
Related
RevisionTime
Role
SortString
Sound
Timezone
Title
UID
URL
VCardVersion
XML

CardDAV.getAddressbookOptions Method

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

Syntax

async carddav.getAddressbookOptions(resourceURI : string): Promise<void>

Remarks

This method sends a request to the indicated ResourceURI. The server's response is available in the 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 GetAddressbookOptions 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

Since the "DAV" header contains "address book", CardDAV is supported on this ResourceURI.

CardDAV.getAddressbookReport Method

Generates a report on the indicated address book.

Syntax

async carddav.getAddressbookReport(resourceURI : string): Promise<void>

Remarks

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

AddressLabels
Addresses
Agent
Anniversary
BirthDay
Categories
Classification
ContactURL
CustomProperties
Depth
EMails
FormattedName
Gender
GeoLocation
IMPPs
Kind
Languages
Logo
Mailer
Member
Names
NickName
Note
Organization
PhoneNumbers
Photo
ProductId
PublicKey
Related
RevisionTime
Role
SortString
Sound
Timezone
Title
UID
URL
VCardVersion
XML

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

CardDAV.getContact Method

Retrieves a single contact from the CardDAV server.

Syntax

async carddav.getContact(resourceURI : string): Promise<void>

Remarks

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

The contact will be retrieved using the WebDAV GET method. The full response is delivered through the Transfer event and the HTTP response headers through the 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 UpdateContact to update the contact resource.

AddressLabels
Addresses
Agent
Anniversary
BirthDay
Categories
Classification
ContactURL
CustomProperties
Depth
EMails
FormattedName
Gender
GeoLocation
IMPPs
Kind
Languages
Logo
Mailer
Member
Names
NickName
Note
Organization
PhoneNumbers
Photo
ProductId
PublicKey
Related
RevisionTime
Role
SortString
Sound
Timezone
Title
UID
URL
VCardVersion
XML

CardDAV.importVCF Method

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

Syntax

async carddav.importVCF(contactData : string): Promise<void>

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 UpdateContact or CreateContact. If you edit any of the class properties between importing and calling UpdateContact or CreateContact, the class will re-generate the request itself. If no properties are changed, the imported data will be submitted unaltered when calling UpdateContact or CreateContact.

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

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

CardDAV.interrupt Method

This method interrupts the current method.

Syntax

async carddav.interrupt(): Promise<void>

Remarks

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

CardDAV.listAddressbooks Method

Lists all address books that the current user can access.

Syntax

async carddav.listAddressbooks(baseURL : string): Promise<void>

Remarks

This method lists all address books the user can access.

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

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

Once this method returns, the class will populate the Addressbooks collection. For example:

CardDAV.moveContact Method

Moves one contact resource to a new location.

Syntax

async carddav.moveContact(sourceResourceURI : string, destinationResourceURI : string): Promise<void>

Remarks

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

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

CardDAV.reset Method

Reset the class.

Syntax

async carddav.reset(): Promise<void>

Remarks

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

CardDAV.sendCustomRequest Method

Sends a custom request to the server.

Syntax

async carddav.sendCustomRequest(httpMethod : string, url : string, requestBody : string): Promise<void>

Remarks

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

Valid values for HttpMethod are:

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

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

CardDAV.updateAddressbook Method

Updates an address book collection resource.

Syntax

async carddav.updateAddressbook(resourceURI : string, ABIndex : number): Promise<void>

Remarks

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

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.

CardDAV.updateContact Method

Updates a contact at the specified ResourceURI.

Syntax

async carddav.updateContact(resourceURI : string): Promise<void>

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.

AddressLabels
Addresses
Agent
Anniversary
BirthDay
Categories
Classification
ContactURL
CustomProperties
Depth
EMails
FormattedName
Gender
GeoLocation
IMPPs
Kind
Languages
Logo
Mailer
Member
Names
NickName
Note
Organization
PhoneNumbers
Photo
ProductId
PublicKey
Related
RevisionTime
Role
SortString
Sound
Timezone
Title
UID
URL
VCardVersion
XML

CardDAV.Connected Event

Fired immediately after a connection completes (or fails).

Syntax

carddav.on('Connected', listener: (e: {readonly statusCode: number, readonly description: string}) => void )

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.

CardDAV.ConnectionStatus Event

Fired to indicate changes in the connection state.

Syntax

carddav.on('ConnectionStatus', listener: (e: {readonly connectionEvent: string, readonly statusCode: number, readonly description: string}) => void )

Remarks

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

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


	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.

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.

CardDAV.ContactDetails Event

Fires for each contact received.

Syntax

carddav.on('ContactDetails', listener: (e: {readonly resourceURI: string, readonly responseStatus: string, readonly ETag: string, readonly contactData: string}) => void )

Remarks

This event fires for each VCARD contact received in response to a GetAddressbookReport 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
BirthDay
Categories
Classification
ContactURL
CustomProperties
Depth
EMails
FormattedName
Gender
GeoLocation
IMPPs
Kind
Languages
Logo
Mailer
Member
Names
NickName
Note
Organization
PhoneNumbers
Photo
ProductId
PublicKey
Related
RevisionTime
Role
SortString
Sound
Timezone
Title
UID
URL
VCardVersion
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 ReportFilterReturnContactData 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.

CardDAV.Disconnected Event

Fired when a connection is closed.

Syntax

carddav.on('Disconnected', listener: (e: {readonly statusCode: number, readonly description: string}) => void )

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.

CardDAV.EndTransfer Event

This event is fired when a document finishes transferring.

Syntax

carddav.on('EndTransfer', listener: (e: {readonly direction: number}) => void )

Remarks

The EndTransfer 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.

CardDAV.Error Event

Fired when information is available about errors during data delivery.

Syntax

carddav.on('Error', listener: (e: {readonly errorCode: number, readonly description: string}) => void )

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class .

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

CardDAV.Header Event

Fired every time a header line comes in.

Syntax

carddav.on('Header', listener: (e: {readonly field: string, readonly value: string}) => void )

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

CardDAV.Log Event

Fired once for each log message.

Syntax

carddav.on('Log', listener: (e: {readonly logLevel: number, readonly message: string, readonly logType: string}) => void )

Remarks

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

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


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"

CardDAV.Redirect Event

Fired when a redirection is received from the server.

Syntax

carddav.on('Redirect', listener: (e: {readonly location: string, accept: boolean}) => void )

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 . Location is the location to which the client is being redirected. Further control over redirection is provided in the FollowRedirects property.

CardDAV.SetCookie Event

Fired for every cookie set by the server.

Syntax

carddav.on('SetCookie', listener: (e: {readonly name: string, readonly value: string, readonly expires: string, readonly domain: string, readonly path: string, readonly secure: boolean}) => void )

Remarks

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

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

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

The Domain parameter contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, the Domain parameter will be an empty string. The convention in this case is to use the server specified in the URL (URLServer) 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 (URLPath) 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.

CardDAV.SSLServerAuthentication Event

Fired after the server presents its certificate to the client.

Syntax

carddav.on('SSLServerAuthentication', listener: (e: {readonly certEncoded: string, readonly certEncodedB: Uint8Array, readonly certSubject: string, readonly certIssuer: string, readonly status: string, accept: boolean}) => void )

Remarks

This event fires with information about the server certificate. The Status property shows why verification failed (otherwise, Status contains the string OK). To manually accept an untrusted certificate, the SSLAcceptAnyServerCert setting must be set to True before initiating the connection.

CardDAV.SSLStatus Event

Fired when secure connection progress messages are available.

Syntax

carddav.on('SSLStatus', listener: (e: {readonly message: string}) => void )

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

CardDAV.StartTransfer Event

This event is fired when a document starts transferring (after the headers).

Syntax

carddav.on('StartTransfer', listener: (e: {readonly direction: number}) => void )

Remarks

The StartTransfer 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.

CardDAV.Status Event

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

Syntax

carddav.on('Status', listener: (e: {readonly HTTPVersion: string, readonly statusCode: number, readonly description: string}) => void )

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

CardDAV.Transfer Event

Fired while a document transfers (delivers document).

Syntax

carddav.on('Transfer', listener: (e: {readonly direction: number, readonly bytesTransferred: number, readonly percentDone: number, readonly text: string, readonly textB: Uint8Array}) => void )

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.

CardAddressbookInfo Type

Contains the details of an address book.

Remarks

This type contains the details of an address book.

The following fields are available:

Fields

CTag
string
Default Value: ""

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.

Description
string
Default Value: ""

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

DisplayName
string
Default Value: ""

This property holds the display name of the address book.

PropertyCount
number (read-only)
Default Value: 0

This property holds the total number of properties of the address book. This property, in conjunction with , and 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.

PropertyIndex
number
Default Value: 0

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

PropertyName
string (read-only)
Default Value: "0"

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

PropertyValue
string (read-only)
Default Value: ""

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

URL
string
Default Value: ""

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.

Constructors

public CardAddressbookInfo();

CardCustomProp Type

Name/Value pair of custom properties to add to the request.

Remarks

This type describes a form variable that is to be posted to the Resource URI when Putting a contact or creating a new address book. The type contains fields which describe this variable's name, value, and attribute.

The following fields are available:

Attribute

Name

Value

Fields

Attribute
string
Default Value: ""

This property contains an optional attribute of the custom property.

Name
string
Default Value: ""

This property contains the textual name of the custom property.

Value
string
Default Value: ""

This property contains the value of the custom property.

Constructors

public CardCustomProp();

public CardCustomProp(String name, String value);

public CardCustomProp(String name, String value, String attribute);

CardReportFilter Type

Used to restrict the results of a Report returned from the CardDAV server.

Remarks

You can restrict results to only contacts within a specified criteria. You can restrict results to only those events which contain a specific (either by property name, or name and a specific value). The can be used to specify a XML to filter the contacts. The can be used to filter contacts with a specific UID, which would lead to only one contact being received, because contacts have unique UIDs.

The following fields are available:

Fields

CustomFilter
string
Default Value: ""

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 .

Property
string
Default Value: ""

Limits the contacts returned in a Report to only those which contain a matching property name and value. For instance, setting the filter to "NickName" will return only contacts that have a nick name specified. Setting the filter to "FN=John" will return only contacts where the formatted name is equal or contains "John". Likewise, you can retrieve a report on a single contact by setting the filter with the UID of the needed resource. For example: = "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 .

ReturnContactData
boolean
Default Value: True

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

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

UID
string
Default Value: ""

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

Constructors

public CardReportFilter();

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

The following fields are available:

Fields

EffectiveDate
string (read-only)
Default Value: ""

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

23-Jan-2000 15:00:00.

ExpirationDate
string (read-only)
Default Value: ""

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

23-Jan-2001 15:00:00.

ExtendedKeyUsage
string (read-only)
Default Value: ""

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

Fingerprint
string (read-only)
Default Value: ""

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

FingerprintSHA1
string (read-only)
Default Value: ""

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

FingerprintSHA256
string (read-only)
Default Value: ""

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

Issuer
string (read-only)
Default Value: ""

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

KeyPassword
string
Default Value: ""

The password for the certificate's private key (if any).

Some certificate stores may individually protect certificates' private keys, separate from the standard protection offered by the . This property can be used to read such password-protected private keys.

Note: This property defaults to the value of . To clear it, you must set the property to the empty string (""). It can be set at any time, but when the private key's password is different from the store's password, then it must be set before calling .

PrivateKey
string (read-only)
Default Value: ""

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

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

PrivateKeyAvailable
boolean (read-only)
Default Value: False

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

PrivateKeyContainer
string (read-only)
Default Value: ""

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

PublicKey
string (read-only)
Default Value: ""

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

PublicKeyAlgorithm
string (read-only)
Default Value: ""

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.

PublicKeyLength
number (read-only)
Default Value: 0

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

SerialNumber
string (read-only)
Default Value: ""

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.

SignatureAlgorithm
string (read-only)
Default Value: ""

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.

Store
string
Default Value: "MY"

The name of the certificate store for the client certificate.

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

is used in conjunction with the property to specify client certificates. If has a value, and or is set, a search for a certificate is initiated. Please see the 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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

StoreB
Uint8Array
Default Value: "MY"

The name of the certificate store for the client certificate.

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

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

StorePassword
string
Default Value: ""

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

StoreType
CertStoreTypes
Default Value: 0

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 (PKCS#12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) 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 PKCS#7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS#7 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 PKCS#11 interface. To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to `cstPKCS11`, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's `CertEncoded` parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the and set to the PIN. Code Example. SSH Authentication with Security Key: `certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
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.

SubjectAltNames
string (read-only)
Default Value: ""

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

ThumbprintMD5
string (read-only)
Default Value: ""

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.

ThumbprintSHA1
string (read-only)
Default Value: ""

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.

ThumbprintSHA256
string (read-only)
Default Value: ""

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.

Usage
string (read-only)
Default Value: ""

The text description of .

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

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

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

UsageFlags
number (read-only)
Default Value: 0

The flags that show intended use for the certificate. The value of 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 property for a text representation of .

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

Version
string (read-only)
Default Value: ""

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

Subject
string
Default Value: ""

The subject of the certificate used for client authentication.

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

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

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

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

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

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


Field	Meaning
CN	Common Name. This is commonly a hostname 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.

Encoded
string
Default Value: ""

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

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

EncodedB
Uint8Array
Default Value: ""

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

Constructors

public Certificate();

Creates a instance whose properties can be set. This is useful for use with when generating new certificates.

public Certificate(String certificateFile);

Opens CertificateFile and reads out the contents as an X.509 public key.

public Certificate(byte[] encoded);

Parses Encoded as an X.509 public key.

public Certificate(int storeType, String store, String storePassword, String subject);

StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store.

After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

public Certificate(int storeType, String store, String storePassword, String subject, String configurationString);

ConfigurationString is a newline-separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to the cstUser , cstMachine , cstPublicKeyFile , and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations.

public Certificate(int storeType, String store, String storePassword, byte[] encoded);

After the store has been successfully opened, the class will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

public Certificate(int storeType, byte[] store, String storePassword, String subject);

StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a byte array containing the certificate data. StorePassword is the password used to protect the store.

public Certificate(int storeType, byte[] store, String storePassword, String subject, String configurationString);

public Certificate(int storeType, byte[] store, String storePassword, byte[] encoded);

After the store has been successfully opened, the class will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

Firewall Type

The firewall the class will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall and the .

The following fields are available:

Fields

AutoDetect
boolean
Default Value: False

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

FirewallType
FirewallTypes
Default Value: 0

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. is set to 80.
fwSOCKS4 (2)	Connect through a SOCKS4 Proxy. is set to 1080.
fwSOCKS5 (3)	Connect through a SOCKS5 Proxy. is set to 1080.
fwSOCKS4A (10)	Connect through a SOCKS4A Proxy. is set to 1080.

Host
string
Default Value: ""

The name or IP address of the firewall (optional). If a 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 .

Password
string
Default Value: ""

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

Port
number
Default Value: 0

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

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

User
string
Default Value: ""

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

Constructors

public Firewall();

Header Type

This is an HTTP header as it is received from the server.

Remarks

When a header is received through a Header event, it is parsed into a Header type. This type contains a , and its corresponding .

The following fields are available:

Field

Value

Fields

Field
string
Default Value: ""

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

Value
string
Default Value: ""

This property contains the Header contents.

Constructors

public Header();

public Header(String field, String value);

HTTPCookie Type

An HTTP cookie can be either sent to or received from the server.

Remarks

An HTTP cookie can store the cookies that are to be sent to the server. It also may store the cookies sent by the server.

Cookies that are to be sent to the server must have the and fields supplied before submitting the URL. When the SetCookie event is fired, however, all of the fields of an HTTPCookie are filled out accordingly.

The following fields are available:

Fields

Domain
string (read-only)
Default Value: ""

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 URLServer as the cookie domain.

Expiration
string (read-only)
Default Value: ""

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.

Name
string
Default Value: ""

The name of the cookie.

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

Path
string (read-only)
Default Value: ""

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 URLPath as the cookie path.

Secure
boolean (read-only)
Default Value: False

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.

Value
string
Default Value: ""

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

The SetCookie event provides the cookies set by the server.

Constructors

public HTTPCookie();

public HTTPCookie(String name, String value);

Proxy Type

The proxy the class will connect to.

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the and the .

The following fields are available:

Fields

AuthScheme
ProxyAuthSchemes
Default Value: 0

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

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

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

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

If 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 is set to authNtlm (4), NTLM authentication will be used.

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

AutoDetect
boolean
Default Value: False

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

Password
string
Default Value: ""

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

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

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

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

Port
number
Default Value: 80

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

Server
string
Default Value: ""

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

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

SSL
ProxySSLTypes
Default Value: 0

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.

User
string
Default Value: ""

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

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

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

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

Constructors

public Proxy();

public Proxy(String server, int port);

public Proxy(String server, int port, String user, String password);

Config Settings (class ipworks.carddav)

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

AddressbookHomeSet: URI of address book collections owned by the principal.

This property specifies the URL of address book collections that have child or descendant address book collections owned by the principal.

AddressLabels: Delivery address of the contact.

This setting is used to specify the formatted text corresponding to delivery address of the contact. It can contain more than one delivery address.

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

Agent: Information about another person who will act on behalf of the individual or resource associated with the contact.

This setting is used to specify information about another person who will act on behalf of the individual or resource associated with the contact. This can be a text value, which can be used to specify textual information, a URI to specify information outside of this MIME entity or a single VCard value.

AuthScheme: The authentication scheme to use for server authorization.

This setting is used to support non-standard CardDAV server authentication. The following values are supported:


0	Basic
1	Digest
2	Proprietary
3	None
4	NTLM

Use the AuthScheme setting to tell the class which type of authorization to perform when the User and Password properties are set. By default, CardDav servers use Basic authentication, and if the User and Password properties are set, the class will attempt basic authentication. Digest, NTLM, and Negotiate authentication are also available to support custom CardDAV server implementations.

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.

Categories: One or more comma separated categories or groups to which the contact belongs.

This setting is used to specify application category information about the contact, also known as "tags". It can be one or more comma separated text values.

Classification: The sensitivity level or access classification of the contact.

This setting is used to specify the sensitivity level or access classification for a contact. It can have different values to indicate varying levels of sensitivity, such as "PUBLIC", "PRIVATE" or "CONFIDENTIAL".

ContactURL: The URL associated with a contact.

This setting is used to specify the URL associated with a contact. Examples for individuals include personal web sites, blogs, and social networking site identifiers.

Depth: The depth associated with the current operation.

This setting defines how deep to operate within a collection. When performing certain operations on resource collections, the class will use Depth to instruct the server on how deep to operate within the collection. Possible values are:


`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: MoveEvent, CopyEvent, and GetAddressbookReport

GeoLocation: Information related to the global positioning of a contact.

This setting is used to specify information related to the global positioning of the object the vCard represents. It should be a single structured value consisting of two decimal values separated by the semi-colon character. The value specifies latitude and longitude, in that order.

IMPPs: The URI for instant messaging and presence protocol communications with a contact.

This setting is to specify the URI for instant messaging and presence protocol communications with a contact. Multiple values are possible.

Logo: A graphic image of a logo associated with a contact.

This setting is used to specify a graphic image of a logo associated with the object the contact represents. The encoding MUST be reset to "b" using the ENCODING parameter in order to specify inline, encoded binary data. If the value is referenced by a URI value, then the default encoding of 8 bit is used and no explicit ENCODING parameter is needed.

Mailer: The type of electronic mail software that is used by the individual associated with the contact.

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.

This setting is used to specify a URI that points to a directory entry linked to a contact. This link typically denotes membership in a group or organization. Multiple values are possible.

ProductId: Specifies the identifier for the product that created the vCard object.

The vendor of the implementation should assure that this is a globally unique identifier.

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 CreateContact method. For all others it is optional.

PublicKey: Public key or authentication certificate associated with a contact.

This setting is used to specify a public key or authentication certificate associated with a contact. The encoding MUST be reset to "b" using the ENCODING parameter in order to specify inline, encoded binary data, for example it can be set to PublicKey=;ENCODING=b;TYPE=JPEG:MIICajCCAdOgAwIBAgICBEUwDQYJKoZIhvcN ... AQEEBQAwdzELMAkGA1UEB. If the value is referenced by a URI value, then the default encoding of 8bit is used and no explicit ENCODING parameter is needed.

Related: A relationship between another entity and the entity represented by this contact.

This setting is used to specify a relationship between another entity and the entity represented by this contact. Multiple values are possible.

RevisionTime: The revision date and time of a contact information.

This setting is used to specify revision information about a contact. The default is a single date-time value, but can also be reset to a single date value.

SortString: A name to be used for national-language-specific sorting.

This setting is used to specify the family name or given name text to be used for national-language-specific sorting of the FN and N types. When this type is present in a contact, then this family name or given name value is used for sorting the contact.

Sound: A sound clip associated with a contact.

This setting is used to specify a digital sound content information that annotates some aspect of a contact. This property is often used to specify the proper pronunciation of the name property value of the vCard. It typically contains a URL or a binary representation of the sound data.

Timezone: Information related to the time zone of a contact.

This setting is used to specify information related to the time zone of a contact.

XML: XML-encoded vCard data in a plain vCard.

This setting is used to include extended XML-encoded vCard data in a plain vCard. It allows for the embedding of structured data represented in XML format directly within the vCard.

WebDAV Config Settings

EncodeURL: If set to true the URL will be encoded by the class.

The default value of this configuration setting is False. If set to True, the URL passed to the class will be URL encoded.

IsDir[i]: Whether or not the resource at the specified index is a directory.

After calling ListDirectory, this configuration setting can be queried to determine whether or not the resource at index i is a directory (collection): webdav.ListDirectory("https://localhost/DAV/"); bool isDir = Convert.ToBoolean(webdav.Config("IsDir[0]"));

An exception will be thrown if an invalid index is specified.

TransferredData: Contains the contents of the last response from the server.

This setting contains the contents of the last response from the server. If the LocalFile is empty, the data is accumulated in TransferredData and also can be received in the Transfer event. Otherwise, this setting returns an empty string.

TransferredDataLimit: The maximum amount of data to be transferred.

This setting contains the maximum amount of data to be transferred. The default value is 0, which will not impose any limits on the amount of data accumulated in the TransferredData setting.

XChildCount: The number of child elements of the current element.

This configuration settings specifies the number of child attributes of the current element. The XChild configuration settings will be indexed from 0 to (XChildCount - 1).

The current element is specified through the XPath configuration setting. This configuration setting is read-only.

XChildName[i]: The name of the child element.

This configuration setting provides the name of the i-th child element of the current element.

The current element is specified through the XPath configuration setting. This configuration setting is read-only.

XChildXText[i]: The inner text of the child element.

This configuration setting provides the inner text of the i-th child element of the current element.

The current element is specified through the XPath configuration setting. This configuration setting is read-only.

XElement: The name of the current element.

This configuration setting provides the name of the current element.

The current element is specified through the XPath configuration setting. This configuration setting is read-only.

XParent: The parent of the current element.

This configuration setting provides the parent of the current element.

The current element is specified through the XPath configuration setting. This configuration setting is read-only.

XPath: Provides a way to point to a specific element in the returned XML or JSON response.

The XPath setting allows you to point to specific elements in the XML or JSON response.

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.

Note: XPath indices are 1-based.

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.

XSubTree: A snapshot of the current element in the document.

This configuration setting provides the entirety of the current element (including its subelements).

The current element is specified through the XPath configuration setting. This configuration setting is read-only.

XText: The text of the current element.

This configuration setting provides the inner text of the current element.

The current element is specified in the XPath configuration setting. This configuration setting is read-only.

HTTP Config Settings

AcceptEncoding: Used to tell the server which types of content encodings the client supports.

When AllowHTTPCompression is True, the class adds an Accept-Encoding header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the Accept-Encoding header. Note: The class only supports gzip and deflate decompression algorithms.

AllowHTTPCompression: This property enables HTTP compression for receiving data.

This configuration setting enables HTTP compression for receiving data. When set to True (default), the class will accept compressed data. It then will uncompress the data it has received. The class will handle data compressed by both gzip and deflate compression algorithms.

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.

AllowHTTPFallback: Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.

This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when HTTPVersion is set to "2.0".

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 if the server does not support HTTP/2.

The default value is True.

Append: Whether to append data to LocalFile.

This configuration setting determines whether data will be appended when writing to LocalFile. When set to True, downloaded data will be appended to LocalFile. This may be used in conjunction with Range to resume a failed download. This is applicable only when LocalFile is set. The default value is False.

Authorization: The Authorization string to be sent to the server.

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.

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.

BytesTransferred: Contains the number of bytes transferred in the response data.

This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the Transfer event, by BytesTransferred.

ChunkSize: Specifies the chunk size in bytes when using chunked encoding.

This is applicable only when UseChunkedEncoding is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384.

CompressHTTPRequest: Set to true to compress the body of a PUT or POST request.

If set to True, the body of a PUT or POST request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request.

The default value is False.

EncodeURL: If set to True the URL will be encoded by the class.

If set to True, the URL passed to the class will be URL encoded. The default value is False.

FollowRedirects: Determines what happens when the server issues a redirect.

This option 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 1 (always), the new URL for the object is retrieved automatically every time.

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 .

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.

The default value is 0 (Never). In this case, redirects are never followed, and the class instead.

Following are the valid options:

0 - Never
1 - Always
2 - Same Scheme

GetOn302Redirect: If set to True the class will perform a GET on the new location.

The default value is False. If set to True, the class will perform a GET on the new location. Otherwise, it will use the same HTTP method again.

HTTP2HeadersWithoutIndexing: HTTP2 headers that should not update the dynamic header table with incremental indexing.

HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names.

HTTPVersion: The version of HTTP used by the class.

This property specifies the HTTP version used by the class. Possible values are as follows:

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

IfModifiedSince: A date determining the maximum age of the desired document.

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

The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example: Sat, 29 Oct 2017 19:43:31 GMT.

KeepAlive: Determines whether the HTTP connection is closed after completion of the request.

If true, the component will not send the Connection: Close header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. Note: Not all servers support persistent connections. If false, the connection will be closed immediately after the server response is received.

The default value for KeepAlive is false.

KerberosSPN: The Service Principal Name for the Kerberos Domain Controller.

If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here.

LogLevel: The level of detail that is logged.

This configuration setting controls the level of detail that is logged through the Log event. 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).

MaxRedirectAttempts: Limits the number of redirects that are followed in a request.

When FollowRedirects is set to any value other than frNever, the class will follow redirects until this maximum number of redirect attempts are made. The default value is 20.

NegotiatedHTTPVersion: The negotiated HTTP version.

This configuration setting may be queried after the request is complete to indicate the HTTP version used. When HTTPVersion is set to "2.0" (if the server does not support "2.0"), then the class will fall back to using "1.1" automatically. This setting will indicate which version was used.

OtherHeaders: Other headers as determined by the user (optional).

This configuration setting can be set to a string of headers to be appended to the HTTP request headers.

The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by .

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.

ProxyAuthorization: The authorization string to be sent to the proxy server.

This is similar to the Authorization configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a Proxy-Authorization HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If ProxyUser and ProxyPassword are specified, this value is calculated using the algorithm specified by ProxyAuthScheme.

ProxyAuthScheme: The authorization scheme to be used for the proxy.

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

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

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyPort: Port for the proxy server (default 80).

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyServer: Name or IP address of a proxy server (optional).

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyUser: A user name if authentication is to be used for the proxy.

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

SentHeaders: The full set of headers as sent by the client.

This configuration setting returns the complete set of raw headers as sent by the client.

StatusCode: The status code of the last response from the server.

This configuration setting contains the result code of the last response from the server.

StatusLine: The first line of the last response from the server.

This setting contains the first line of the last response from the server. The format of the line will be [HTTP version] [Result Code] [Description].

TransferredData: The contents of the last response from the server.

This configuration setting contains the contents of the last response from the server.

TransferredDataLimit: The maximum number of incoming bytes to be stored by the class.

If TransferredDataLimit is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the class.

TransferredHeaders: The full set of headers as received from the server.

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

TransferredRequest: The full request as sent by the client.

This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request:

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

UseChunkedEncoding: Enables or Disables HTTP chunked encoding for transfers.

If UseChunkedEncoding is set to True, the class will use HTTP-chunked encoding when posting, if possible. HTTP-chunked encoding allows large files to be sent in chunks instead of all at once. If set to False, the class will not use HTTP-chunked encoding. The default value is False.

Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.

UseIDNs: Whether to encode hostnames to internationalized domain names.

This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name).

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.

UseProxyAutoConfigURL: Whether to use a Proxy auto-config file when attempting a connection.

This configuration specifies whether the class will attempt to use the Proxy auto-config URL when establishing a connection and ProxyAutoDetect is set to True.

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.

UserAgent: Information about the user agent (browser).

This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com".

Override the default with the name and version of your software.

TCPClient Config Settings

ConnectionTimeout: Sets a separate timeout value for establishing a connection.

When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use Timeout for establishing a connection and transmitting/receiving data.

FirewallAutoDetect: Tells the class whether or not to automatically detect and use firewall system settings, if available.

This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallHost: Name or IP address of firewall (optional).

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

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.

FirewallPassword: Password to be used if authentication is to be used when connecting through the firewall.

If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the class .

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPort: The TCP port for the FirewallHost;.

The FirewallPort is set automatically when FirewallType is set to a valid value.

Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallType: Determines the type of firewall to connect through.

Possible values are as follows:


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.

FirewallUser: A user name if authentication is to be used connecting through a firewall.

If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the class .

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

KeepAliveInterval: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.

When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

Note: This value is not applicable in macOS.

KeepAliveTime: The inactivity time in milliseconds before a TCP keep-alive packet is sent.

When set, TCPKeepAlive will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.

Linger: When set to True, connections are terminated gracefully.

This property controls how a connection is closed. The default is True.

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.

LingerTime: Time in seconds to have the connection linger.

LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.

LocalHost: The name of the local host through which connections are initiated or accepted.

The LocalHost setting 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 LocalHost 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).

LocalPort: The port in the local host where the class binds.

This configuration setting must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.

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

MaxLineLength: The maximum amount of data to accumulate when no EOL is found.

MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL string.

If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn 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 DataIn 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.

MaxTransferRate: The transfer rate limit in bytes per second.

This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.

ProxyExceptionsList: A semicolon separated list of hosts and IPs to bypass when using a proxy.

This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:

www.google.com;www.nsoftware.com

TCPKeepAlive: Determines whether or not the keep alive socket option is enabled.

If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets.

Note: This value is not applicable in Java.

TcpNoDelay: Whether or not to delay when sending packets.

When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this configuration setting is set to False.

UseIPv6: Whether to use IPv6.

When set to 0 (default), the class will use IPv4 exclusively. When set to 1, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0. Possible values are as follows:


0	IPv4 only
1	IPv6 only
2	IPv6 with IPv4 fallback

SSL Config Settings

LogSSLPackets: Controls whether SSL packets are logged when using the internal security API.

When SSLProvider is set to Internal, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is False, as it is useful only for debugging purposes.

When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.

Enabling this configuration setting has no effect if SSLProvider is set to Platform.

OpenSSLCADir: The path to a directory containing CA certificates.

This functionality is available only when the provider is OpenSSL.

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.

OpenSSLCAFile: Name of the file containing the list of CA's trusted by your application.

This functionality is available only when the provider is OpenSSL.

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.

OpenSSLCipherList: A string that controls the ciphers to be used by SSL.

This functionality is available only when the provider is OpenSSL.

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

OpenSSLPrngSeedData: The data to seed the pseudo random number generator (PRNG).

This functionality is available only when the provider is OpenSSL.

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.

ReuseSSLSession: Determines if the SSL session is reused.

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.

SSLAcceptAnyServerCert: Whether to trust any certificate presented by the server.

This configuration setting disables all certificate verification when set to True. This configuration setting must be enabled to trust a self-signed certificate. It is not recommended to enable this configuration setting in a production environment. The default value is False.

SSLCACerts: A newline separated list of CA certificates to be included when performing an SSL handshake.

When SSLProvider is set to Internal, this configuration setting specifies one or more CA certificates to be included with the SSLCert property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

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

SSLCipherStrength: The minimum cipher strength used for bulk encryption.

This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

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

SSLClientCACerts: A newline separated list of CA certificates to use during SSL client certificate validation.

This configuration setting is only applicable to server components (e.g., TCPServer) see SSLServerCACerts for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when SSLAuthenticateClients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

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

SSLEnabledCipherSuites: The cipher suite to be used in an SSL negotiation.

This configuration setting enables the cipher suites to be used in SSL negotiation.

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

Example values when SSLProvider is set to Internalinclude the following:

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

SSLEnabledProtocols: Used to enable/disable the supported security protocols.

This configuration setting is used to enable or disable the supported security protocols.

Not all supported protocols are enabled by default. The default value is 4032 for client components, and 3072 for server components. To specify a combination of enabled protocol versions set this config to the binary OR of one or more of the following values:


TLS1.3	12288 (Hex 3000)
TLS1.2	3072 (Hex C00) (Default - Client and Server)
TLS1.1	768 (Hex 300) (Default - Client)
TLS1	192 (Hex C0) (Default - Client)
SSL3	48 (Hex 30)
SSL2	12 (Hex 0C)

Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.

SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:

In the JavaScript edition, the platform implementation is used when TLS 1.3 is enabled and SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.

SSLEnabledProtocols: SSL2 and SSL3 Notes:

SSL 2.0 and 3.0 are not supported by the class when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.

SSLEnableRenegotiation: Whether the renegotiation_info SSL extension is supported.

This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is false by default, but it can be set to true to enable the extension.

This configuration setting is applicable only when SSLProvider is set to Internal.

SSLIncludeCertChain: Whether the entire certificate chain is included in the SSLServerAuthentication event.

This configuration setting specifies whether the Encoded parameter of the SSLServerAuthentication event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the SSLServerAuthentication event.

If set to True, all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

SSLKeyLogFile: The location of a file where per-session secrets are written for debugging purposes.

This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

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 SSLProvider is set to Internal.

SSLNegotiatedCipher: Returns the negotiated cipher suite.

This configuration setting returns the cipher suite negotiated during the SSL handshake.

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]");

SSLNegotiatedCipherStrength: Returns the negotiated cipher suite strength.

This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake.

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]");

SSLNegotiatedCipherSuite: Returns the negotiated cipher suite.

This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string.

SSLNegotiatedKeyExchange: Returns the negotiated key exchange algorithm.

This configuration setting returns the key exchange algorithm negotiated during the SSL handshake.

SSLNegotiatedKeyExchangeStrength: Returns the negotiated key exchange algorithm strength.

This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake.

SSLNegotiatedVersion: Returns the negotiated protocol version.

This configuration setting returns the protocol version negotiated during the SSL handshake.

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]");

SSLSecurityFlags: Flags that control certificate verification.

The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions:


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.

SSLServerCACerts: A newline separated list of CA certificates to use during SSL server certificate validation.

This configuration setting is only used by client components (e.g., TCPClient) see SSLClientCACerts for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

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

TLS12SignatureAlgorithms: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.

This configuration setting specifies the allowed server certificate signature algorithms when SSLProvider is set to Internal and SSLEnabledProtocols is set to allow TLS 1.2.

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 .

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.

TLS12SupportedGroups: The supported groups for ECC.

This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC.

The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.

When using TLS 1.2 and SSLProvider 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)

TLS13KeyShareGroups: The groups for which to pregenerate key shares.

This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server.

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"

TLS13SignatureAlgorithms: The allowed certificate signature algorithms.

This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following:

"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 rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448. This configuration setting is applicable only when SSLEnabledProtocols includes TLS 1.3.

TLS13SupportedGroups: The supported groups for (EC)DHE key exchange.

This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so.

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

AbsoluteTimeout: Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method that does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

Note: This option is not valid for User Datagram Protocol (UDP) ports.

FirewallData: Used to send extra data to the firewall.

When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes).

InBufferSize: The size in bytes of the incoming queue of the socket.

This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the InBufferSize setting can provide significant improvements in performance.

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.

OutBufferSize: The size in bytes of the outgoing queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the OutBufferSize setting can provide significant improvements in performance.

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

BuildInfo: Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage: The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

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

The following is a list of valid code page identifiers for Mac OS only:


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

LicenseInfo: Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

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.

MaskSensitiveData: Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.

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.

UseInternalSecurityAPI: Whether or not to use the system security libraries or an internal implementation.

When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.

This setting is set to false by default on all platforms.

Trappable Errors (class ipworks.carddav)

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

HTTP Errors

118	Firewall error. The error description contains the 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 URLScheme is invalid.
155	Range operation is not supported by server.
156	Invalid cookie index (out of range).
301	Interrupted.
302	Cannot open AttachedFile.

TCPClient Errors

100	You cannot change the RemotePort at this time. A connection is in progress.
101	You cannot change the RemoteHost (Server) at this time. A connection is in progress.
102	The RemoteHost 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 LocalPort at this time. A connection is in progress.
107	You cannot change the LocalHost at this time. A connection is in progress.
112	You cannot change MaxLineLength at this time. A connection is in progress.
116	RemotePort 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).