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.

Class Name

IPWorks_CardDAV

Procedural Interface

 ipworks_carddav_open();
 ipworks_carddav_close($res);
 ipworks_carddav_register_callback($res, $id, $function);
 ipworks_carddav_get_last_error($res);
 ipworks_carddav_get_last_error_code($res);
 ipworks_carddav_set($res, $id, $index, $value);
 ipworks_carddav_get($res, $id, $index);
 ipworks_carddav_do_addcookie($res, $cookiename, $cookievalue);
 ipworks_carddav_do_addcustomproperty($res, $varname, $varvalue);
 ipworks_carddav_do_config($res, $configurationstring);
 ipworks_carddav_do_copycontact($res, $sourceresourceuri, $destinationresourceuri);
 ipworks_carddav_do_createaddressbook($res, $resourceuri, $displayname, $description);
 ipworks_carddav_do_createcontact($res, $resourceuri);
 ipworks_carddav_do_deleteaddressbook($res, $resourceuri);
 ipworks_carddav_do_deletecontact($res, $resourceuri);
 ipworks_carddav_do_doevents($res);
 ipworks_carddav_do_exportvcf($res);
 ipworks_carddav_do_getaddressbookoptions($res, $resourceuri);
 ipworks_carddav_do_getaddressbookreport($res, $resourceuri);
 ipworks_carddav_do_getcontact($res, $resourceuri);
 ipworks_carddav_do_importvcf($res, $contactdata);
 ipworks_carddav_do_interrupt($res);
 ipworks_carddav_do_listaddressbooks($res, $baseurl);
 ipworks_carddav_do_movecontact($res, $sourceresourceuri, $destinationresourceuri);
 ipworks_carddav_do_reset($res);
 ipworks_carddav_do_sendcustomrequest($res, $httpmethod, $url, $requestbody);
 ipworks_carddav_do_updateaddressbook($res, $resourceuri, $abindex);
 ipworks_carddav_do_updatecontact($res, $resourceuri);

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 Addressbook* properties. For example:

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

Managing Address Books

To create an address book use the 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.

Method List

---

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

Event List

---

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

Config Settings

---

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

AddressbookCount Property (IPWorks_CardDAV Class)

The number of records in the Addressbook arrays.

Object Oriented Interface

public function getAddressbookCount();
public function setAddressbookCount($value);

Procedural Interface

ipworks_carddav_get($res, 1 );
ipworks_carddav_set($res, 1, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• AddressbookCTag
• AddressbookDescription
• AddressbookDisplayName
• AddressbookPropertyCount
• AddressbookPropertyIndex
• AddressbookPropertyName
• AddressbookPropertyValue
• AddressbookURL

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

This property is not available at design time.

Data Type

Integer

AddressbookCTag Property (IPWorks_CardDAV Class)

This property holds the current ctag of the address book.

Object Oriented Interface

public function getAddressbookCTag($addressbookindex);
public function setAddressbookCTag($addressbookindex, $value);

Procedural Interface

ipworks_carddav_get($res, 2 , $addressbookindex);
ipworks_carddav_set($res, 2, $value , $addressbookindex);

Default Value

''

Remarks

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

The $addressbookindex parameter specifies the index of the item in the array. The size of the array is controlled by the AddressbookCount property.

This property is not available at design time.

Data Type

String

AddressbookDescription Property (IPWorks_CardDAV Class)

This property holds the description of the address book.

Object Oriented Interface

public function getAddressbookDescription($addressbookindex);
public function setAddressbookDescription($addressbookindex, $value);

Procedural Interface

ipworks_carddav_get($res, 3 , $addressbookindex);
ipworks_carddav_set($res, 3, $value , $addressbookindex);

Default Value

''

Remarks

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

The $addressbookindex parameter specifies the index of the item in the array. The size of the array is controlled by the AddressbookCount property.

This property is not available at design time.

Data Type

String

AddressbookDisplayName Property (IPWorks_CardDAV Class)

This property holds the display name of the address book.

Object Oriented Interface

public function getAddressbookDisplayName($addressbookindex);
public function setAddressbookDisplayName($addressbookindex, $value);

Procedural Interface

ipworks_carddav_get($res, 4 , $addressbookindex);
ipworks_carddav_set($res, 4, $value , $addressbookindex);

Default Value

''

Remarks

This property holds the display name of the address book.

The $addressbookindex parameter specifies the index of the item in the array. The size of the array is controlled by the AddressbookCount property.

This property is not available at design time.

Data Type

String

AddressbookPropertyCount Property (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function getAddressbookPropertyCount($addressbookindex);

Procedural Interface

ipworks_carddav_get($res, 5 , $addressbookindex);

Default Value

0

Remarks

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

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

The $addressbookindex parameter specifies the index of the item in the array. The size of the array is controlled by the AddressbookCount property.

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

Data Type

Integer

AddressbookPropertyIndex Property (IPWorks_CardDAV Class)

This property specifies the currently selected property.

Object Oriented Interface

public function getAddressbookPropertyIndex($addressbookindex);
public function setAddressbookPropertyIndex($addressbookindex, $value);

Procedural Interface

ipworks_carddav_get($res, 6 , $addressbookindex);
ipworks_carddav_set($res, 6, $value , $addressbookindex);

Default Value

0

Remarks

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

The $addressbookindex parameter specifies the index of the item in the array. The size of the array is controlled by the AddressbookCount property.

This property is not available at design time.

Data Type

Integer

AddressbookPropertyName Property (IPWorks_CardDAV Class)

This property holds the name of the currently selected property.

Object Oriented Interface

public function getAddressbookPropertyName($addressbookindex);

Procedural Interface

ipworks_carddav_get($res, 7 , $addressbookindex);

Default Value

'0'

Remarks

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

The $addressbookindex parameter specifies the index of the item in the array. The size of the array is controlled by the AddressbookCount property.

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

Data Type

String

AddressbookPropertyValue Property (IPWorks_CardDAV Class)

This property holds the value of the currently selected property.

Object Oriented Interface

public function getAddressbookPropertyValue($addressbookindex);

Procedural Interface

ipworks_carddav_get($res, 8 , $addressbookindex);

Default Value

''

Remarks

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

The $addressbookindex parameter specifies the index of the item in the array. The size of the array is controlled by the AddressbookCount property.

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

Data Type

String

AddressbookURL Property (IPWorks_CardDAV Class)

This property provides the URL of the address book.

Object Oriented Interface

public function getAddressbookURL($addressbookindex);
public function setAddressbookURL($addressbookindex, $value);

Procedural Interface

ipworks_carddav_get($res, 9 , $addressbookindex);
ipworks_carddav_set($res, 9, $value , $addressbookindex);

Default Value

''

Remarks

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

The $addressbookindex parameter specifies the index of the item in the array. The size of the array is controlled by the AddressbookCount property.

This property is not available at design time.

Data Type

String

AddressCount Property (IPWorks_CardDAV Class)

The number of records in the Address arrays.

Object Oriented Interface

public function getAddressCount();
public function setAddressCount($value);

Procedural Interface

ipworks_carddav_get($res, 10 );
ipworks_carddav_set($res, 10, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• AddressAttribute
• AddressbookCTag
• AddressbookDescription
• AddressbookDisplayName
• AddressbookPropertyCount
• AddressbookPropertyIndex
• AddressbookPropertyName
• AddressbookPropertyValue
• AddressbookURL
• AddressName
• AddressValue

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

This property is not available at design time.

Data Type

Integer

AddressAttribute Property (IPWorks_CardDAV Class)

This property contains an optional attribute of the custom property.

Object Oriented Interface

public function getAddressAttribute($addressindex);
public function setAddressAttribute($addressindex, $value);

Procedural Interface

ipworks_carddav_get($res, 11 , $addressindex);
ipworks_carddav_set($res, 11, $value , $addressindex);

Default Value

''

Remarks

This property contains an optional attribute of the custom property.

The $addressindex parameter specifies the index of the item in the array. The size of the array is controlled by the AddressCount property.

This property is not available at design time.

Data Type

String

AddressName Property (IPWorks_CardDAV Class)

This property contains the textual name of the custom property.

Object Oriented Interface

public function getAddressName($addressindex);
public function setAddressName($addressindex, $value);

Procedural Interface

ipworks_carddav_get($res, 12 , $addressindex);
ipworks_carddav_set($res, 12, $value , $addressindex);

Default Value

''

Remarks

This property contains the textual name of the custom property.

The $addressindex parameter specifies the index of the item in the array. The size of the array is controlled by the AddressCount property.

This property is not available at design time.

Data Type

String

AddressValue Property (IPWorks_CardDAV Class)

This property contains the value of the custom property.

Object Oriented Interface

public function getAddressValue($addressindex);
public function setAddressValue($addressindex, $value);

Procedural Interface

ipworks_carddav_get($res, 13 , $addressindex);
ipworks_carddav_set($res, 13, $value , $addressindex);

Default Value

''

Remarks

This property contains the value of the custom property.

The $addressindex parameter specifies the index of the item in the array. The size of the array is controlled by the AddressCount property.

This property is not available at design time.

Data Type

String

AnniversaryAttribute Property (IPWorks_CardDAV Class)

This property contains an optional attribute of the custom property.

Object Oriented Interface

public function getAnniversaryAttribute();
public function setAnniversaryAttribute($value);

Procedural Interface

ipworks_carddav_get($res, 14 );
ipworks_carddav_set($res, 14, $value );

Default Value

''

Remarks

This property contains an optional attribute of the custom property.

This property is not available at design time.

Data Type

String

AnniversaryName Property (IPWorks_CardDAV Class)

This property contains the textual name of the custom property.

Object Oriented Interface

public function getAnniversaryName();
public function setAnniversaryName($value);

Procedural Interface

ipworks_carddav_get($res, 15 );
ipworks_carddav_set($res, 15, $value );

Default Value

''

Remarks

This property contains the textual name of the custom property.

This property is not available at design time.

Data Type

String

AnniversaryValue Property (IPWorks_CardDAV Class)

This property contains the value of the custom property.

Object Oriented Interface

public function getAnniversaryValue();
public function setAnniversaryValue($value);

Procedural Interface

ipworks_carddav_get($res, 16 );
ipworks_carddav_set($res, 16, $value );

Default Value

''

Remarks

This property contains the value of the custom property.

This property is not available at design time.

Data Type

String

Authorization Property (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function getAuthorization();
public function setAuthorization($value);

Procedural Interface

ipworks_carddav_get($res, 17 );
ipworks_carddav_set($res, 17, $value );

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

Data Type

String

AuthScheme Property (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function getAuthScheme();
public function setAuthScheme($value);

Procedural Interface

ipworks_carddav_get($res, 18 );
ipworks_carddav_set($res, 18, $value );

Default Value

0

Remarks

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

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

By default, this property is authBasic (0), and if the User and Password properties are set, the class will attempt HTTP Basic Authentication. If 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.

Data Type

Integer

BirthDayAttribute Property (IPWorks_CardDAV Class)

This property contains an optional attribute of the custom property.

Object Oriented Interface

public function getBirthDayAttribute();
public function setBirthDayAttribute($value);

Procedural Interface

ipworks_carddav_get($res, 19 );
ipworks_carddav_set($res, 19, $value );

Default Value

''

Remarks

This property contains an optional attribute of the custom property.

This property is not available at design time.

Data Type

String

BirthDayName Property (IPWorks_CardDAV Class)

This property contains the textual name of the custom property.

Object Oriented Interface

public function getBirthDayName();
public function setBirthDayName($value);

Procedural Interface

ipworks_carddav_get($res, 20 );
ipworks_carddav_set($res, 20, $value );

Default Value

''

Remarks

This property contains the textual name of the custom property.

This property is not available at design time.

Data Type

String

BirthDayValue Property (IPWorks_CardDAV Class)

This property contains the value of the custom property.

Object Oriented Interface

public function getBirthDayValue();
public function setBirthDayValue($value);

Procedural Interface

ipworks_carddav_get($res, 21 );
ipworks_carddav_set($res, 21, $value );

Default Value

''

Remarks

This property contains the value of the custom property.

This property is not available at design time.

Data Type

String

Connected Property (IPWorks_CardDAV Class)

Whether the class is connected.

Object Oriented Interface

public function getConnected();

Procedural Interface

ipworks_carddav_get($res, 22 );

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.

Data Type

Boolean

CookieCount Property (IPWorks_CardDAV Class)

The number of records in the Cookie arrays.

Object Oriented Interface

public function getCookieCount();
public function setCookieCount($value);

Procedural Interface

ipworks_carddav_get($res, 23 );
ipworks_carddav_set($res, 23, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• CookieDomain
• CookieExpiration
• CookieName
• CookiePath
• CookieSecure
• CookieValue

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

This property is not available at design time.

Data Type

Integer

CookieDomain Property (IPWorks_CardDAV Class)

The domain of a received cookie.

Object Oriented Interface

public function getCookieDomain($cookieindex);

Procedural Interface

ipworks_carddav_get($res, 24 , $cookieindex);

Default Value

''

Remarks

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

The $cookieindex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

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

Data Type

String

CookieExpiration Property (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function getCookieExpiration($cookieindex);

Procedural Interface

ipworks_carddav_get($res, 25 , $cookieindex);

Default Value

''

Remarks

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

The $cookieindex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

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

Data Type

String

CookieName Property (IPWorks_CardDAV Class)

The name of the cookie.

Object Oriented Interface

public function getCookieName($cookieindex);
public function setCookieName($cookieindex, $value);

Procedural Interface

ipworks_carddav_get($res, 26 , $cookieindex);
ipworks_carddav_set($res, 26, $value , $cookieindex);

Default Value

''

Remarks

The name of the cookie.

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

The $cookieindex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is not available at design time.

Data Type

String

CookiePath Property (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function getCookiePath($cookieindex);

Procedural Interface

ipworks_carddav_get($res, 27 , $cookieindex);

Default Value

''

Remarks

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

The $cookieindex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

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

Data Type

String

CookieSecure Property (IPWorks_CardDAV Class)

The security flag of the received cookie.

Object Oriented Interface

public function getCookieSecure($cookieindex);

Procedural Interface

ipworks_carddav_get($res, 28 , $cookieindex);

Default Value

false

Remarks

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

The $cookieindex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

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

Data Type

Boolean

CookieValue Property (IPWorks_CardDAV Class)

The value of the cookie.

Object Oriented Interface

public function getCookieValue($cookieindex);
public function setCookieValue($cookieindex, $value);

Procedural Interface

ipworks_carddav_get($res, 29 , $cookieindex);
ipworks_carddav_set($res, 29, $value , $cookieindex);

Default Value

''

Remarks

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

The SetCookie event provides the cookies set by the server.

The $cookieindex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is not available at design time.

Data Type

String

CustomPropertyCount Property (IPWorks_CardDAV Class)

The number of records in the CustomProperty arrays.

Object Oriented Interface

public function getCustomPropertyCount();
public function setCustomPropertyCount($value);

Procedural Interface

ipworks_carddav_get($res, 30 );
ipworks_carddav_set($res, 30, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• CustomPropertyAttribute
• CustomPropertyName
• CustomPropertyValue

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

This property is not available at design time.

Data Type

Integer

CustomPropertyAttribute Property (IPWorks_CardDAV Class)

This property contains an optional attribute of the custom property.

Object Oriented Interface

public function getCustomPropertyAttribute($custompropertyindex);
public function setCustomPropertyAttribute($custompropertyindex, $value);

Procedural Interface

ipworks_carddav_get($res, 31 , $custompropertyindex);
ipworks_carddav_set($res, 31, $value , $custompropertyindex);

Default Value

''

Remarks

This property contains an optional attribute of the custom property.

The $custompropertyindex parameter specifies the index of the item in the array. The size of the array is controlled by the CustomPropertyCount property.

This property is not available at design time.

Data Type

String

CustomPropertyName Property (IPWorks_CardDAV Class)

This property contains the textual name of the custom property.

Object Oriented Interface

public function getCustomPropertyName($custompropertyindex);
public function setCustomPropertyName($custompropertyindex, $value);

Procedural Interface

ipworks_carddav_get($res, 32 , $custompropertyindex);
ipworks_carddav_set($res, 32, $value , $custompropertyindex);

Default Value

''

Remarks

This property contains the textual name of the custom property.

The $custompropertyindex parameter specifies the index of the item in the array. The size of the array is controlled by the CustomPropertyCount property.

This property is not available at design time.

Data Type

String

CustomPropertyValue Property (IPWorks_CardDAV Class)

This property contains the value of the custom property.

Object Oriented Interface

public function getCustomPropertyValue($custompropertyindex);
public function setCustomPropertyValue($custompropertyindex, $value);

Procedural Interface

ipworks_carddav_get($res, 33 , $custompropertyindex);
ipworks_carddav_set($res, 33, $value , $custompropertyindex);

Default Value

''

Remarks

This property contains the value of the custom property.

The $custompropertyindex parameter specifies the index of the item in the array. The size of the array is controlled by the CustomPropertyCount property.

This property is not available at design time.

Data Type

String

EMailCount Property (IPWorks_CardDAV Class)

The number of records in the EMail arrays.

Object Oriented Interface

public function getEMailCount();
public function setEMailCount($value);

Procedural Interface

ipworks_carddav_get($res, 34 );
ipworks_carddav_set($res, 34, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• EMailAttribute
• EMailName
• EMailValue

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

This property is not available at design time.

Data Type

Integer

EMailAttribute Property (IPWorks_CardDAV Class)

This property contains an optional attribute of the custom property.

Object Oriented Interface

public function getEMailAttribute($emailindex);
public function setEMailAttribute($emailindex, $value);

Procedural Interface

ipworks_carddav_get($res, 35 , $emailindex);
ipworks_carddav_set($res, 35, $value , $emailindex);

Default Value

''

Remarks

This property contains an optional attribute of the custom property.

The $emailindex parameter specifies the index of the item in the array. The size of the array is controlled by the EMailCount property.

This property is not available at design time.

Data Type

String

EMailName Property (IPWorks_CardDAV Class)

This property contains the textual name of the custom property.

Object Oriented Interface

public function getEMailName($emailindex);
public function setEMailName($emailindex, $value);

Procedural Interface

ipworks_carddav_get($res, 36 , $emailindex);
ipworks_carddav_set($res, 36, $value , $emailindex);

Default Value

''

Remarks

This property contains the textual name of the custom property.

The $emailindex parameter specifies the index of the item in the array. The size of the array is controlled by the EMailCount property.

This property is not available at design time.

Data Type

String

EMailValue Property (IPWorks_CardDAV Class)

This property contains the value of the custom property.

Object Oriented Interface

public function getEMailValue($emailindex);
public function setEMailValue($emailindex, $value);

Procedural Interface

ipworks_carddav_get($res, 37 , $emailindex);
ipworks_carddav_set($res, 37, $value , $emailindex);

Default Value

''

Remarks

This property contains the value of the custom property.

The $emailindex parameter specifies the index of the item in the array. The size of the array is controlled by the EMailCount property.

This property is not available at design time.

Data Type

String

ETag Property (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function getETag();
public function setETag($value);

Procedural Interface

ipworks_carddav_get($res, 38 );
ipworks_carddav_set($res, 38, $value );

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.

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.

Data Type

String

FirewallAutoDetect Property (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function getFirewallAutoDetect();
public function setFirewallAutoDetect($value);

Procedural Interface

ipworks_carddav_get($res, 39 );
ipworks_carddav_set($res, 39, $value );

Default Value

false

Remarks

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

Data Type

Boolean

FirewallType Property (IPWorks_CardDAV Class)

The type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();
public function setFirewallType($value);

Procedural Interface

ipworks_carddav_get($res, 40 );
ipworks_carddav_set($res, 40, $value );

Default Value

0

Remarks

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

Data Type

Integer

FirewallHost Property (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function getFirewallHost();
public function setFirewallHost($value);

Procedural Interface

ipworks_carddav_get($res, 41 );
ipworks_carddav_set($res, 41, $value );

Default Value

''

Remarks

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

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

Data Type

String

FirewallPassword Property (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function getFirewallPassword();
public function setFirewallPassword($value);

Procedural Interface

ipworks_carddav_get($res, 42 );
ipworks_carddav_set($res, 42, $value );

Default Value

''

Remarks

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

Data Type

String

FirewallPort Property (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function getFirewallPort();
public function setFirewallPort($value);

Procedural Interface

ipworks_carddav_get($res, 43 );
ipworks_carddav_set($res, 43, $value );

Default Value

0

Remarks

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

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

Data Type

Integer

FirewallUser Property (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function getFirewallUser();
public function setFirewallUser($value);

Procedural Interface

ipworks_carddav_get($res, 44 );
ipworks_carddav_set($res, 44, $value );

Default Value

''

Remarks

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

Data Type

String

FollowRedirects Property (IPWorks_CardDAV Class)

Determines what happens when the server issues a redirect.

Object Oriented Interface

public function getFollowRedirects();
public function setFollowRedirects($value);

Procedural Interface

ipworks_carddav_get($res, 45 );
ipworks_carddav_set($res, 45, $value );

Default Value

0

Remarks

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

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

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

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

A 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 fails with an error instead.

Data Type

Integer

FormattedName Property (IPWorks_CardDAV Class)

The formatted name of the contact.

Object Oriented Interface

public function getFormattedName();
public function setFormattedName($value);

Procedural Interface

ipworks_carddav_get($res, 46 );
ipworks_carddav_set($res, 46, $value );

Default Value

''

Remarks

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

This property is filled from the response to a 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.

Data Type

String

Gender Property (IPWorks_CardDAV Class)

The sex and gender identity of a contact.

Object Oriented Interface

public function getGender();
public function setGender($value);

Procedural Interface

ipworks_carddav_get($res, 47 );
ipworks_carddav_set($res, 47, $value );

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

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.

Data Type

String

Idle Property (IPWorks_CardDAV Class)

The current status of the class.

Object Oriented Interface

public function getIdle();

Procedural Interface

ipworks_carddav_get($res, 48 );

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.

Data Type

Boolean

Kind Property (IPWorks_CardDAV Class)

The kind of object the vCard represents.

Object Oriented Interface

public function getKind();
public function setKind($value);

Procedural Interface

ipworks_carddav_get($res, 49 );
ipworks_carddav_set($res, 49, $value );

Default Value

''

Remarks

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

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

This property is filled from the response to a 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.

Data Type

String

LanguageCount Property (IPWorks_CardDAV Class)

The number of records in the Language arrays.

Object Oriented Interface

public function getLanguageCount();
public function setLanguageCount($value);

Procedural Interface

ipworks_carddav_get($res, 50 );
ipworks_carddav_set($res, 50, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• LanguageAttribute
• LanguageName
• LanguageValue

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

This property is not available at design time.

Data Type

Integer

LanguageAttribute Property (IPWorks_CardDAV Class)

This property contains an optional attribute of the custom property.

Object Oriented Interface

public function getLanguageAttribute($languageindex);
public function setLanguageAttribute($languageindex, $value);

Procedural Interface

ipworks_carddav_get($res, 51 , $languageindex);
ipworks_carddav_set($res, 51, $value , $languageindex);

Default Value

''

Remarks

This property contains an optional attribute of the custom property.

The $languageindex parameter specifies the index of the item in the array. The size of the array is controlled by the LanguageCount property.

This property is not available at design time.

Data Type

String

LanguageName Property (IPWorks_CardDAV Class)

This property contains the textual name of the custom property.

Object Oriented Interface

public function getLanguageName($languageindex);
public function setLanguageName($languageindex, $value);

Procedural Interface

ipworks_carddav_get($res, 52 , $languageindex);
ipworks_carddav_set($res, 52, $value , $languageindex);

Default Value

''

Remarks

This property contains the textual name of the custom property.

The $languageindex parameter specifies the index of the item in the array. The size of the array is controlled by the LanguageCount property.

This property is not available at design time.

Data Type

String

LanguageValue Property (IPWorks_CardDAV Class)

This property contains the value of the custom property.

Object Oriented Interface

public function getLanguageValue($languageindex);
public function setLanguageValue($languageindex, $value);

Procedural Interface

ipworks_carddav_get($res, 53 , $languageindex);
ipworks_carddav_set($res, 53, $value , $languageindex);

Default Value

''

Remarks

This property contains the value of the custom property.

The $languageindex parameter specifies the index of the item in the array. The size of the array is controlled by the LanguageCount property.

This property is not available at design time.

Data Type

String

LocalHost Property (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function getLocalHost();
public function setLocalHost($value);

Procedural Interface

ipworks_carddav_get($res, 54 );
ipworks_carddav_set($res, 54, $value );

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.

Data Type

String

Names Property (IPWorks_CardDAV Class)

The name of a contact.

Object Oriented Interface

public function getNames();
public function setNames($value);

Procedural Interface

ipworks_carddav_get($res, 55 );
ipworks_carddav_set($res, 55, $value );

Default Value

''

Remarks

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

This property is filled from the response to a 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.

Data Type

String

NickName Property (IPWorks_CardDAV Class)

The nickname of the object the vCard represents.

Object Oriented Interface

public function getNickName();
public function setNickName($value);

Procedural Interface

ipworks_carddav_get($res, 56 );
ipworks_carddav_set($res, 56, $value );

Default Value

''

Remarks

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

This property is filled from the response to a 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.

Data Type

String

Note Property (IPWorks_CardDAV Class)

Provides additional information or comments about a contact.

Object Oriented Interface

public function getNote();
public function setNote($value);

Procedural Interface

ipworks_carddav_get($res, 57 );
ipworks_carddav_set($res, 57, $value );

Default Value

''

Remarks

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

This property is filled from the response to a 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.

Data Type

String

Organization Property (IPWorks_CardDAV Class)

The organizational name and units associated with a contact.

Object Oriented Interface

public function getOrganization();
public function setOrganization($value);

Procedural Interface

ipworks_carddav_get($res, 58 );
ipworks_carddav_set($res, 58, $value );

Default Value

''

Remarks

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

This property is filled from the response to a 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.

Data Type

String

OtherHeaders Property (IPWorks_CardDAV Class)

Other headers as determined by the user (optional).

Object Oriented Interface

public function getOtherHeaders();
public function setOtherHeaders($value);

Procedural Interface

ipworks_carddav_get($res, 59 );
ipworks_carddav_set($res, 59, $value );

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 CRLF ("\r\n") .

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

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

For CardDAV, the "If-Match" header is extremely useful. After adding a contact with 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.

Data Type

String

ParsedHeaderCount Property (IPWorks_CardDAV Class)

The number of records in the ParsedHeader arrays.

Object Oriented Interface

public function getParsedHeaderCount();

Procedural Interface

ipworks_carddav_get($res, 60 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ParsedHeaderField
• ParsedHeaderValue

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

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

Data Type

Integer

ParsedHeaderField Property (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function getParsedHeaderField($parsedheaderindex);

Procedural Interface

ipworks_carddav_get($res, 61 , $parsedheaderindex);

Default Value

''

Remarks

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

The $parsedheaderindex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

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

Data Type

String

ParsedHeaderValue Property (IPWorks_CardDAV Class)

This property contains the header contents.

Object Oriented Interface

public function getParsedHeaderValue($parsedheaderindex);

Procedural Interface

ipworks_carddav_get($res, 62 , $parsedheaderindex);

Default Value

''

Remarks

This property contains the Header contents.

The $parsedheaderindex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

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

Data Type

String

Password Property (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function getPassword();
public function setPassword($value);

Procedural Interface

ipworks_carddav_get($res, 63 );
ipworks_carddav_set($res, 63, $value );

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.

Data Type

String

PhoneNumberCount Property (IPWorks_CardDAV Class)

The number of records in the PhoneNumber arrays.

Object Oriented Interface

public function getPhoneNumberCount();
public function setPhoneNumberCount($value);

Procedural Interface

ipworks_carddav_get($res, 64 );
ipworks_carddav_set($res, 64, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• PhoneNumberAttribute
• PhoneNumberName
• PhoneNumberValue

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

This property is not available at design time.

Data Type

Integer

PhoneNumberAttribute Property (IPWorks_CardDAV Class)

This property contains an optional attribute of the custom property.

Object Oriented Interface

public function getPhoneNumberAttribute($phonenumberindex);
public function setPhoneNumberAttribute($phonenumberindex, $value);

Procedural Interface

ipworks_carddav_get($res, 65 , $phonenumberindex);
ipworks_carddav_set($res, 65, $value , $phonenumberindex);

Default Value

''

Remarks

This property contains an optional attribute of the custom property.

The $phonenumberindex parameter specifies the index of the item in the array. The size of the array is controlled by the PhoneNumberCount property.

This property is not available at design time.

Data Type

String

PhoneNumberName Property (IPWorks_CardDAV Class)

This property contains the textual name of the custom property.

Object Oriented Interface

public function getPhoneNumberName($phonenumberindex);
public function setPhoneNumberName($phonenumberindex, $value);

Procedural Interface

ipworks_carddav_get($res, 66 , $phonenumberindex);
ipworks_carddav_set($res, 66, $value , $phonenumberindex);

Default Value

''

Remarks

This property contains the textual name of the custom property.

The $phonenumberindex parameter specifies the index of the item in the array. The size of the array is controlled by the PhoneNumberCount property.

This property is not available at design time.

Data Type

String

PhoneNumberValue Property (IPWorks_CardDAV Class)

This property contains the value of the custom property.

Object Oriented Interface

public function getPhoneNumberValue($phonenumberindex);
public function setPhoneNumberValue($phonenumberindex, $value);

Procedural Interface

ipworks_carddav_get($res, 67 , $phonenumberindex);
ipworks_carddav_set($res, 67, $value , $phonenumberindex);

Default Value

''

Remarks

This property contains the value of the custom property.

The $phonenumberindex parameter specifies the index of the item in the array. The size of the array is controlled by the PhoneNumberCount property.

This property is not available at design time.

Data Type

String

PhotoAttribute Property (IPWorks_CardDAV Class)

This property contains an optional attribute of the custom property.

Object Oriented Interface

public function getPhotoAttribute();
public function setPhotoAttribute($value);

Procedural Interface

ipworks_carddav_get($res, 68 );
ipworks_carddav_set($res, 68, $value );

Default Value

''

Remarks

This property contains an optional attribute of the custom property.

This property is not available at design time.

Data Type

String

PhotoName Property (IPWorks_CardDAV Class)

This property contains the textual name of the custom property.

Object Oriented Interface

public function getPhotoName();
public function setPhotoName($value);

Procedural Interface

ipworks_carddav_get($res, 69 );
ipworks_carddav_set($res, 69, $value );

Default Value

''

Remarks

This property contains the textual name of the custom property.

This property is not available at design time.

Data Type

String

PhotoValue Property (IPWorks_CardDAV Class)

This property contains the value of the custom property.

Object Oriented Interface

public function getPhotoValue();
public function setPhotoValue($value);

Procedural Interface

ipworks_carddav_get($res, 70 );
ipworks_carddav_set($res, 70, $value );

Default Value

''

Remarks

This property contains the value of the custom property.

This property is not available at design time.

Data Type

String

ProxyAuthScheme Property (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function getProxyAuthScheme();
public function setProxyAuthScheme($value);

Procedural Interface

ipworks_carddav_get($res, 71 );
ipworks_carddav_set($res, 71, $value );

Default Value

0

Remarks

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

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

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

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

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

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

Data Type

Integer

ProxyAutoDetect Property (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function getProxyAutoDetect();
public function setProxyAutoDetect($value);

Procedural Interface

ipworks_carddav_get($res, 72 );
ipworks_carddav_set($res, 72, $value );

Default Value

false

Remarks

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

Data Type

Boolean

ProxyPassword Property (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function getProxyPassword();
public function setProxyPassword($value);

Procedural Interface

ipworks_carddav_get($res, 73 );
ipworks_carddav_set($res, 73, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

ProxyPort Property (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function getProxyPort();
public function setProxyPort($value);

Procedural Interface

ipworks_carddav_get($res, 74 );
ipworks_carddav_set($res, 74, $value );

Default Value

80

Remarks

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

Data Type

Integer

ProxyServer Property (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function getProxyServer();
public function setProxyServer($value);

Procedural Interface

ipworks_carddav_get($res, 75 );
ipworks_carddav_set($res, 75, $value );

Default Value

''

Remarks

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

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

Data Type

String

ProxySSL Property (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function getProxySSL();
public function setProxySSL($value);

Procedural Interface

ipworks_carddav_get($res, 76 );
ipworks_carddav_set($res, 76, $value );

Default Value

0

Remarks

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

Data Type

Integer

ProxyUser Property (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function getProxyUser();
public function setProxyUser($value);

Procedural Interface

ipworks_carddav_get($res, 77 );
ipworks_carddav_set($res, 77, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

ReportFilterCustomFilter Property (IPWorks_CardDAV Class)

Allows the user to specify his own filter XML.

Object Oriented Interface

public function getReportFilterCustomFilter();
public function setReportFilterCustomFilter($value);

Procedural Interface

ipworks_carddav_get($res, 78 );
ipworks_carddav_set($res, 78, $value );

Default Value

''

Remarks

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

Data Type

String

ReportFilterProperty Property (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function getReportFilterProperty();
public function setReportFilterProperty($value);

Procedural Interface

ipworks_carddav_get($res, 79 );
ipworks_carddav_set($res, 79, $value );

Default Value

''

Remarks

Limits the contacts returned in a Report to only those which contain a matching property name and value. For instance, setting the ReportFilterProperty filter to "NickName" will return only contacts that have a nick name specified. Setting the ReportFilterProperty 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 ReportFilterProperty filter with the UID of the needed resource. For example: ReportFilterProperty = "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 ReportFilterCustomFilter.

Data Type

String

ReportFilterReturnContactData Property (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function getReportFilterReturnContactData();
public function setReportFilterReturnContactData($value);

Procedural Interface

ipworks_carddav_get($res, 80 );
ipworks_carddav_set($res, 80, $value );

Default Value

true

Remarks

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

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

Data Type

Boolean

ReportFilterUID Property (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function getReportFilterUID();
public function setReportFilterUID($value);

Procedural Interface

ipworks_carddav_get($res, 81 );
ipworks_carddav_set($res, 81, $value );

Default Value

''

Remarks

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

Data Type

String

Role Property (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function getRole();
public function setRole($value);

Procedural Interface

ipworks_carddav_get($res, 82 );
ipworks_carddav_set($res, 82, $value );

Default Value

''

Remarks

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

This property is filled from the response to a 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.

Data Type

String

SSLAcceptServerCertEffectiveDate Property (IPWorks_CardDAV Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLAcceptServerCertEffectiveDate();

Procedural Interface

ipworks_carddav_get($res, 83 );

Default Value

''

Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (IPWorks_CardDAV Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLAcceptServerCertExpirationDate();

Procedural Interface

ipworks_carddav_get($res, 84 );

Default Value

''

Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (IPWorks_CardDAV Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLAcceptServerCertExtendedKeyUsage();

Procedural Interface

ipworks_carddav_get($res, 85 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprint();

Procedural Interface

ipworks_carddav_get($res, 86 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA1();

Procedural Interface

ipworks_carddav_get($res, 87 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA256();

Procedural Interface

ipworks_carddav_get($res, 88 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (IPWorks_CardDAV Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertIssuer();

Procedural Interface

ipworks_carddav_get($res, 89 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (IPWorks_CardDAV Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKey();

Procedural Interface

ipworks_carddav_get($res, 90 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (IPWorks_CardDAV Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyAvailable();

Procedural Interface

ipworks_carddav_get($res, 91 );

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyContainer();

Procedural Interface

ipworks_carddav_get($res, 92 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (IPWorks_CardDAV Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKey();

Procedural Interface

ipworks_carddav_get($res, 93 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyAlgorithm();

Procedural Interface

ipworks_carddav_get($res, 94 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyLength();

Procedural Interface

ipworks_carddav_get($res, 95 );

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (IPWorks_CardDAV Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLAcceptServerCertSerialNumber();

Procedural Interface

ipworks_carddav_get($res, 96 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (IPWorks_CardDAV Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertSignatureAlgorithm();

Procedural Interface

ipworks_carddav_get($res, 97 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (IPWorks_CardDAV Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStore();
public function setSSLAcceptServerCertStore($value);

Procedural Interface

ipworks_carddav_get($res, 98 );
ipworks_carddav_set($res, 98, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertStorePassword();
public function setSSLAcceptServerCertStorePassword($value);

Procedural Interface

ipworks_carddav_get($res, 99 );
ipworks_carddav_set($res, 99, $value );

Default Value

''

Remarks

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

Data Type

String

SSLAcceptServerCertStoreType Property (IPWorks_CardDAV Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStoreType();
public function setSSLAcceptServerCertStoreType($value);

Procedural Interface

ipworks_carddav_get($res, 100 );
ipworks_carddav_set($res, 100, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertSubjectAltNames();

Procedural Interface

ipworks_carddav_get($res, 101 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (IPWorks_CardDAV Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintMD5();

Procedural Interface

ipworks_carddav_get($res, 102 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (IPWorks_CardDAV Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA1();

Procedural Interface

ipworks_carddav_get($res, 103 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (IPWorks_CardDAV Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA256();

Procedural Interface

ipworks_carddav_get($res, 104 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (IPWorks_CardDAV Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLAcceptServerCertUsage();

Procedural Interface

ipworks_carddav_get($res, 105 );

Default Value

''

Remarks

The text description of SSLAcceptServerCertUsageFlags.

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

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

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

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (IPWorks_CardDAV Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertUsageFlags();

Procedural Interface

ipworks_carddav_get($res, 106 );

Default Value

0

Remarks

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

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (IPWorks_CardDAV Class)

The certificate's version number.

Object Oriented Interface

public function getSSLAcceptServerCertVersion();

Procedural Interface

ipworks_carddav_get($res, 107 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (IPWorks_CardDAV Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLAcceptServerCertSubject();
public function setSSLAcceptServerCertSubject($value);

Procedural Interface

ipworks_carddav_get($res, 108 );
ipworks_carddav_set($res, 108, $value );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

Data Type

String

SSLAcceptServerCertEncoded Property (IPWorks_CardDAV Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();
public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

ipworks_carddav_get($res, 109 );
ipworks_carddav_set($res, 109, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertEffectiveDate Property (IPWorks_CardDAV Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

ipworks_carddav_get($res, 110 );

Default Value

''

Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (IPWorks_CardDAV Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

ipworks_carddav_get($res, 111 );

Default Value

''

Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (IPWorks_CardDAV Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

ipworks_carddav_get($res, 112 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertFingerprint Property (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

ipworks_carddav_get($res, 113 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

ipworks_carddav_get($res, 114 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

ipworks_carddav_get($res, 115 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLCertIssuer Property (IPWorks_CardDAV Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

ipworks_carddav_get($res, 116 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (IPWorks_CardDAV Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

ipworks_carddav_get($res, 117 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (IPWorks_CardDAV Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

ipworks_carddav_get($res, 118 );

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

ipworks_carddav_get($res, 119 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertPublicKey Property (IPWorks_CardDAV Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

ipworks_carddav_get($res, 120 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

ipworks_carddav_get($res, 121 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

ipworks_carddav_get($res, 122 );

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (IPWorks_CardDAV Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

ipworks_carddav_get($res, 123 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (IPWorks_CardDAV Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

ipworks_carddav_get($res, 124 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertStore Property (IPWorks_CardDAV Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();
public function setSSLCertStore($value);

Procedural Interface

ipworks_carddav_get($res, 125 );
ipworks_carddav_set($res, 125, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Binary String

SSLCertStorePassword Property (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function getSSLCertStorePassword();
public function setSSLCertStorePassword($value);

Procedural Interface

ipworks_carddav_get($res, 126 );
ipworks_carddav_set($res, 126, $value );

Default Value

''

Remarks

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

Data Type

String

SSLCertStoreType Property (IPWorks_CardDAV Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();
public function setSSLCertStoreType($value);

Procedural Interface

ipworks_carddav_get($res, 127 );
ipworks_carddav_set($res, 127, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubjectAltNames Property (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

ipworks_carddav_get($res, 128 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (IPWorks_CardDAV Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

ipworks_carddav_get($res, 129 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (IPWorks_CardDAV Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

ipworks_carddav_get($res, 130 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (IPWorks_CardDAV Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

ipworks_carddav_get($res, 131 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertUsage Property (IPWorks_CardDAV Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

ipworks_carddav_get($res, 132 );

Default Value

''

Remarks

The text description of SSLCertUsageFlags.

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

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

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

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (IPWorks_CardDAV Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

ipworks_carddav_get($res, 133 );

Default Value

0

Remarks

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

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SSLCertVersion Property (IPWorks_CardDAV Class)

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

ipworks_carddav_get($res, 134 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertSubject Property (IPWorks_CardDAV Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();
public function setSSLCertSubject($value);

Procedural Interface

ipworks_carddav_get($res, 135 );
ipworks_carddav_set($res, 135, $value );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

Data Type

String

SSLCertEncoded Property (IPWorks_CardDAV Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();
public function setSSLCertEncoded($value);

Procedural Interface

ipworks_carddav_get($res, 136 );
ipworks_carddav_set($res, 136, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLProvider Property (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function getSSLProvider();
public function setSSLProvider($value);

Procedural Interface

ipworks_carddav_get($res, 137 );
ipworks_carddav_set($res, 137, $value );

Default Value

0

Remarks

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

Possible values are as follows:

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, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCertEffectiveDate Property (IPWorks_CardDAV Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLServerCertEffectiveDate();

Procedural Interface

ipworks_carddav_get($res, 138 );

Default Value

''

Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (IPWorks_CardDAV Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLServerCertExpirationDate();

Procedural Interface

ipworks_carddav_get($res, 139 );

Default Value

''

Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (IPWorks_CardDAV Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLServerCertExtendedKeyUsage();

Procedural Interface

ipworks_carddav_get($res, 140 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function getSSLServerCertFingerprint();

Procedural Interface

ipworks_carddav_get($res, 141 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function getSSLServerCertFingerprintSHA1();

Procedural Interface

ipworks_carddav_get($res, 142 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function getSSLServerCertFingerprintSHA256();

Procedural Interface

ipworks_carddav_get($res, 143 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (IPWorks_CardDAV Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLServerCertIssuer();

Procedural Interface

ipworks_carddav_get($res, 144 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (IPWorks_CardDAV Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKey();

Procedural Interface

ipworks_carddav_get($res, 145 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (IPWorks_CardDAV Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLServerCertPrivateKeyAvailable();

Procedural Interface

ipworks_carddav_get($res, 146 );

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function getSSLServerCertPrivateKeyContainer();

Procedural Interface

ipworks_carddav_get($res, 147 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (IPWorks_CardDAV Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLServerCertPublicKey();

Procedural Interface

ipworks_carddav_get($res, 148 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function getSSLServerCertPublicKeyAlgorithm();

Procedural Interface

ipworks_carddav_get($res, 149 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function getSSLServerCertPublicKeyLength();

Procedural Interface

ipworks_carddav_get($res, 150 );

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (IPWorks_CardDAV Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLServerCertSerialNumber();

Procedural Interface

ipworks_carddav_get($res, 151 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (IPWorks_CardDAV Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLServerCertSignatureAlgorithm();

Procedural Interface

ipworks_carddav_get($res, 152 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertStore Property (IPWorks_CardDAV Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLServerCertStore();

Procedural Interface

ipworks_carddav_get($res, 153 );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

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

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword Property (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function getSSLServerCertStorePassword();

Procedural Interface

ipworks_carddav_get($res, 154 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (IPWorks_CardDAV Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLServerCertStoreType();

Procedural Interface

ipworks_carddav_get($res, 155 );

Default Value

0

Remarks

The type of certificate store for this certificate.

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

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function getSSLServerCertSubjectAltNames();

Procedural Interface

ipworks_carddav_get($res, 156 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (IPWorks_CardDAV Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintMD5();

Procedural Interface

ipworks_carddav_get($res, 157 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (IPWorks_CardDAV Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA1();

Procedural Interface

ipworks_carddav_get($res, 158 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (IPWorks_CardDAV Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA256();

Procedural Interface

ipworks_carddav_get($res, 159 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertUsage Property (IPWorks_CardDAV Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLServerCertUsage();

Procedural Interface

ipworks_carddav_get($res, 160 );

Default Value

''

Remarks

The text description of SSLServerCertUsageFlags.

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

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

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

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (IPWorks_CardDAV Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLServerCertUsageFlags();

Procedural Interface

ipworks_carddav_get($res, 161 );

Default Value

0

Remarks

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

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (IPWorks_CardDAV Class)

The certificate's version number.

Object Oriented Interface

public function getSSLServerCertVersion();

Procedural Interface

ipworks_carddav_get($res, 162 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertSubject Property (IPWorks_CardDAV Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLServerCertSubject();

Procedural Interface

ipworks_carddav_get($res, 163 );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (IPWorks_CardDAV Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

ipworks_carddav_get($res, 164 );

Default Value

''

Remarks

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

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

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

Data Type

Binary String

Timeout Property (IPWorks_CardDAV Class)

The timeout for the class.

Object Oriented Interface

public function getTimeout();
public function setTimeout($value);

Procedural Interface

ipworks_carddav_get($res, 165 );
ipworks_carddav_set($res, 165, $value );

Default Value

60

Remarks

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

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

The class will use 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 fails with an error.

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

The default value for the Timeout property is 60 seconds.

Data Type

Integer

Title Property (IPWorks_CardDAV Class)

The position or job of the object the vCard represents.

Object Oriented Interface

public function getTitle();
public function setTitle($value);

Procedural Interface

ipworks_carddav_get($res, 166 );
ipworks_carddav_set($res, 166, $value );

Default Value

''

Remarks

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

This property is filled from the response to a 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.

Data Type

String

UID Property (IPWorks_CardDAV Class)

A persistent, globally unique identifier for the contact.

Object Oriented Interface

public function getUID();
public function setUID($value);

Procedural Interface

ipworks_carddav_get($res, 167 );
ipworks_carddav_set($res, 167, $value );

Default Value

''

Remarks

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

This property is filled from the response to a 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.

Data Type

String

URL Property (IPWorks_CardDAV Class)

Location of the contact resource on the CardDAV server.

Object Oriented Interface

public function getURL();

Procedural Interface

ipworks_carddav_get($res, 168 );

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

This property is read-only.

Data Type

String

User Property (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function getUser();
public function setUser($value);

Procedural Interface

ipworks_carddav_get($res, 169 );
ipworks_carddav_set($res, 169, $value );

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.

Data Type

String

VCardVersion Property (IPWorks_CardDAV Class)

The vCard version format.

Object Oriented Interface

public function getVCardVersion();
public function setVCardVersion($value);

Procedural Interface

ipworks_carddav_get($res, 170 );
ipworks_carddav_set($res, 170, $value );

Default Value

''

Remarks

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

This property is filled from the response to a 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.

Data Type

String

AddCookie Method (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function doAddCookie($cookiename, $cookievalue);

Procedural Interface

ipworks_carddav_do_addcookie($res, $cookiename, $cookievalue);

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.

AddCustomProperty Method (IPWorks_CardDAV Class)

Adds a form variable and the corresponding value.

Object Oriented Interface

public function doAddCustomProperty($varname, $varvalue);

Procedural Interface

ipworks_carddav_do_addcustomproperty($res, $varname, $varvalue);

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"

Config Method (IPWorks_CardDAV Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworks_carddav_do_config($res, $configurationstring);

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.

CopyContact Method (IPWorks_CardDAV Class)

Copy contact to a new location.

Object Oriented Interface

public function doCopyContact($sourceresourceuri, $destinationresourceuri);

Procedural Interface

ipworks_carddav_do_copycontact($res, $sourceresourceuri, $destinationresourceuri);

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.

CreateAddressbook Method (IPWorks_CardDAV Class)

Creates a new address book collection resource.

Object Oriented Interface

public function doCreateAddressbook($resourceuri, $displayname, $description);

Procedural Interface

ipworks_carddav_do_createaddressbook($res, $resourceuri, $displayname, $description);

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.

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.

CreateContact Method (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function doCreateContact($resourceuri);

Procedural Interface

ipworks_carddav_do_createcontact($res, $resourceuri);

Remarks

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

The following properties are used when calling 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

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.

DeleteAddressbook Method (IPWorks_CardDAV Class)

Deletes an address book collection resource.

Object Oriented Interface

public function doDeleteAddressbook($resourceuri);

Procedural Interface

ipworks_carddav_do_deleteaddressbook($res, $resourceuri);

Remarks

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

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

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

There is no standard format for a resource URI. Google for instance, uses "https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default" address to access the default address book. Here is an example of using the 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.

DeleteContact Method (IPWorks_CardDAV Class)

Deletes a resource.

Object Oriented Interface

public function doDeleteContact($resourceuri);

Procedural Interface

ipworks_carddav_do_deletecontact($res, $resourceuri);

Remarks

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

There is no standard format for a resource URI. Google for instance, uses "https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default" address to access the default address book. Here is an example of using the 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.

DoEvents Method (IPWorks_CardDAV Class)

This method processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

ipworks_carddav_do_doevents($res);

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.

ExportVCF Method (IPWorks_CardDAV Class)

Generates a contact from the properties in the vCard format.

Object Oriented Interface

public function doExportVCF();

Procedural Interface

ipworks_carddav_do_exportvcf($res);

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.

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

GetAddressbookOptions Method (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function doGetAddressbookOptions($resourceuri);

Procedural Interface

ipworks_carddav_do_getaddressbookoptions($res, $resourceuri);

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:

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

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.

GetAddressbookReport Method (IPWorks_CardDAV Class)

Generates a report on the indicated address book.

Object Oriented Interface

public function doGetAddressbookReport($resourceuri);

Procedural Interface

ipworks_carddav_do_getaddressbookreport($res, $resourceuri);

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.

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 

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.

GetContact Method (IPWorks_CardDAV Class)

Retrieves a single contact from the CardDAV server.

Object Oriented Interface

public function doGetContact($resourceuri);

Procedural Interface

ipworks_carddav_do_getcontact($res, $resourceuri);

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.

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

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.

ImportVCF Method (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function doImportVCF($contactdata);

Procedural Interface

ipworks_carddav_do_importvcf($res, $contactdata);

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.

Interrupt Method (IPWorks_CardDAV Class)

This method interrupts the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

ipworks_carddav_do_interrupt($res);

Remarks

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

ListAddressbooks Method (IPWorks_CardDAV Class)

Lists all address books that the current user can access.

Object Oriented Interface

public function doListAddressbooks($baseurl);

Procedural Interface

ipworks_carddav_do_listaddressbooks($res, $baseurl);

Remarks

This method lists all address books the user can access.

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

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

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

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

MoveContact Method (IPWorks_CardDAV Class)

Moves one contact resource to a new location.

Object Oriented Interface

public function doMoveContact($sourceresourceuri, $destinationresourceuri);

Procedural Interface

ipworks_carddav_do_movecontact($res, $sourceresourceuri, $destinationresourceuri);

Remarks

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

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

There is no standard format for a resource URI. Google for instance, uses "https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default" address to access the default address book. Here is an example of using the 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.

Reset Method (IPWorks_CardDAV Class)

Reset the class.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworks_carddav_do_reset($res);

Remarks

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

SendCustomRequest Method (IPWorks_CardDAV Class)

Sends a custom request to the server.

Object Oriented Interface

public function doSendCustomRequest($httpmethod, $url, $requestbody);

Procedural Interface

ipworks_carddav_do_sendcustomrequest($res, $httpmethod, $url, $requestbody);

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

UpdateAddressbook Method (IPWorks_CardDAV Class)

Updates an address book collection resource.

Object Oriented Interface

public function doUpdateAddressbook($resourceuri, $abindex);

Procedural Interface

ipworks_carddav_do_updateaddressbook($res, $resourceuri, $abindex);

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.

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.

UpdateContact Method (IPWorks_CardDAV Class)

Updates a contact at the specified ResourceURI.

Object Oriented Interface

public function doUpdateContact($resourceuri);

Procedural Interface

ipworks_carddav_do_updatecontact($res, $resourceuri);

Remarks

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

The following properties are used when calling 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

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.

Connected Event (IPWorks_CardDAV Class)

Fired immediately after a connection completes (or fails).

Object Oriented Interface

public function fireConnected($param);

Procedural Interface

ipworks_carddav_register_callback($res, 1, array($this, 'fireConnected'));

Parameter List

 'statuscode'
 'description'

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.

ConnectionStatus Event (IPWorks_CardDAV Class)

Fired to indicate changes in the connection state.

Object Oriented Interface

public function fireConnectionStatus($param);

Procedural Interface

ipworks_carddav_register_callback($res, 2, array($this, 'fireConnectionStatus'));

Parameter List

 'connectionevent'
 'statuscode'
 'description'

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:

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.

ContactDetails Event (IPWorks_CardDAV Class)

Fires for each contact received.

Object Oriented Interface

public function fireContactDetails($param);

Procedural Interface

ipworks_carddav_register_callback($res, 3, array($this, 'fireContactDetails'));

Parameter List

 'resourceuri'
 'responsestatus'
 'etag'
 'contactdata'

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.

Disconnected Event (IPWorks_CardDAV Class)

Fired when a connection is closed.

Object Oriented Interface

public function fireDisconnected($param);

Procedural Interface

ipworks_carddav_register_callback($res, 4, array($this, 'fireDisconnected'));

Parameter List

 'statuscode'
 'description'

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.

EndTransfer Event (IPWorks_CardDAV Class)

This event is fired when a document finishes transferring.

Object Oriented Interface

public function fireEndTransfer($param);

Procedural Interface

ipworks_carddav_register_callback($res, 5, array($this, 'fireEndTransfer'));

Parameter List

 'direction'

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.

Error Event (IPWorks_CardDAV Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworks_carddav_register_callback($res, 6, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

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

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

Header Event (IPWorks_CardDAV Class)

Fired every time a header line comes in.

Object Oriented Interface

public function fireHeader($param);

Procedural Interface

ipworks_carddav_register_callback($res, 7, array($this, 'fireHeader'));

Parameter List

 'field'
 'value'

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

Log Event (IPWorks_CardDAV Class)

Fired once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

ipworks_carddav_register_callback($res, 8, array($this, 'fireLog'));

Parameter List

 'loglevel'
 'message'
 'logtype'

Remarks

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

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

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

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

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

Message is the log entry.

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

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

Redirect Event (IPWorks_CardDAV Class)

Fired when a redirection is received from the server.

Object Oriented Interface

public function fireRedirect($param);

Procedural Interface

ipworks_carddav_register_callback($res, 9, array($this, 'fireRedirect'));

Parameter List

 'location'
 'accept'

Remarks

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

SetCookie Event (IPWorks_CardDAV Class)

Fired for every cookie set by the server.

Object Oriented Interface

public function fireSetCookie($param);

Procedural Interface

ipworks_carddav_register_callback($res, 10, array($this, 'fireSetCookie'));

Parameter List

 'name'
 'value'
 'expires'
 'domain'
 'path'
 'secure'

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.

SSLServerAuthentication Event (IPWorks_CardDAV Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

ipworks_carddav_register_callback($res, 11, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

Remarks

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

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

SSLStatus Event (IPWorks_CardDAV Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

ipworks_carddav_register_callback($res, 12, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

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

StartTransfer Event (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function fireStartTransfer($param);

Procedural Interface

ipworks_carddav_register_callback($res, 13, array($this, 'fireStartTransfer'));

Parameter List

 'direction'

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.

Status Event (IPWorks_CardDAV Class)

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

Object Oriented Interface

public function fireStatus($param);

Procedural Interface

ipworks_carddav_register_callback($res, 14, array($this, 'fireStatus'));

Parameter List

 'httpversion'
 'statuscode'
 'description'

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

Transfer Event (IPWorks_CardDAV Class)

Fired while a document transfers (delivers document).

Object Oriented Interface

public function fireTransfer($param);

Procedural Interface

ipworks_carddav_register_callback($res, 15, array($this, 'fireTransfer'));

Parameter List

 'direction'
 'bytestransferred'
 'percentdone'
 'text'

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.

Config Settings (CardDAV Class)

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

WebDAV Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (CardDAV Class)

CardDAV Errors

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

HTTP Errors

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

TCPClient Errors

SSL Errors

TCP/IP Errors