CardDAV

CardDAV Server Support

{{KBZCS 8.7 Article ZCS 8.7 }}

RFCs supported by Zimbra's CardDAV Server implementation

Standard ID URL Description
RFC 2426 https://tools.ietf.org/html/rfc2426 vCard MIME Directory Profile (VCARD Version 3.0)
RFC 2616 https://tools.ietf.org/html/rfc2616 Hypertext Transfer Protocol -- HTTP/1.1
RFC 2617 https://tools.ietf.org/html/rfc2617 HTTP Authentication: Basic and Digest Access Authentication
RFC 4918 https://tools.ietf.org/html/rfc4918 HTTP Extensions for Web Distributed Authoring and Versioning (WebDAV)
RFC 6352 https://tools.ietf.org/html/rfc6352 CardDAV: vCard Extensions to Web Distributed Authoring and Versioning (WebDAV)
RFC 5995 https://tools.ietf.org/html/rfc5995 Using POST to Add Members to Web Distributed Authoring and Versioning (WebDAV) Collections
 This is the preferred mechanism for creating new entries in an addressbook collection.
RFC 6764 https://tools.ietf.org/html/rfc6764 Locating Services for Calendaring Extensions to WebDAV (CalDAV) and vCard Extensions to WebDAV (CardDAV)
 The Zimbra server implements the well-known URI for CardDAV.  See section 9.1.2.
 This specification can also be useful as a reference for how to configure DNS to make
 client configuration easier.
RFC 5397 https://tools.ietf.org/html/rfc5397 WebDAV Current Principal Extension
RFC 5689 https://tools.ietf.org/html/rfc5689 Extended MKCOL for Web Distributed Authoring and Versioning (WebDAV)
 This is the preferred way to create new addressbook collections
RFC 3253 (partial) https://tools.ietf.org/html/rfc3253 Versioning Extensions to WebDAV (Web Distributed Authoring and Versioning)
 See Section 3.6 (Report method) and 3.8 (DAV:expand-property Report)
RFC 3744 https://tools.ietf.org/html/rfc3744 Web Distributed Authoring and Versioning (WebDAV) Access Control Protocol

Known Issues

  • Some addressbook clients only support 1 addressbook collection.

Introduction

Zimbra 8.7 supports the CardDAV standard. Supported clients are Apple Address Book, Sunbird, and others. Connectivity is supported with or without a ZCS reverse proxy server.

Configuring Addressbook clients to access the Zimbra CardDAV server

Apple Address Book for OS X 10.6 (Snow Leopard)

  1. Address Book -> Preferences -> Accounts
  2. Click the "+" to add a new account.
  3. Configure account details
    • Account type: CardDAV
    • User name: your_zcs_useraccount@domain.tld
    • Password: zcsUserAccountPassword
    • Server address: zcsserver.domain.tld:port
      Be sure to include the port specification when configuring Apple AB to ensure the account is setup correctly. Use 443 if your ZCS server supports the default HTTPS port. Otherwise, specify 80 if your server does not support HTTPS and listens for HTTP on the default port 80.
  4. Click Create.
    An error may display after configuring account details that states:
    Address Book couldn't discover the account settings for the CardDAV server "zcsserver.domain.tld:port". Make sure the user name and server address are correct, then click Create.
    If you receive this error, check the settings with your ZCS server administrator and try again.
  5. Close AB preferences.

Apple Address Book is now setup for CardDAV to your Zimbra server.

Apple iOS 4 for iPhone/iPad/iPod Touch

  1. Settings -> Mail, Contacts, Calendars -> Add Account... -> Other
  2. Add CardDAV Account
  3. Configure account details
    • Server: zcsserver.domain.tld:port
      Be sure to include the port specification when configuring CardDAV for iOS 4 to ensure the account is setup correctly. Use 443 if your ZCS server supports the default HTTPS port. Otherwise, specify 80 if your server does not support HTTPS and listens for HTTP on the default port 80.
    • User Name: your_zcs_useraccount@domain.tld
    • Password: zcsUserAccountPassword
    • Description: Zimbra
  4. Tap Next.
  5. Accept the SSL certificate warning if applicable.

iOS 4 is now setup for CardDAV to your Zimbra server. To use, navigate to the Contacts app and locate the group with the description provided during setup. Then, search for contacts.

Android

  1. Install CardDAV-Sync (http://dmfs.org/carddav/)
  2. Settings -> Accounts & sync
  3. Tap Add account
  4. Configure account details
    • Server name: zcsserver.domain.tld:port
      Be sure to include the port specification if you do not use standard ports (i.e. 80 for http and 443 for https)
    • Use SSL: leave checked if you want to connect using SSL, un-check otherwise
    • Username: your_zcs_useraccount@domain.tld
    • Password: zcsUserAccountPassword
  5. Tap Next
  6. Confirm SSL warning if you use a self signed certificate (and the fingerprint matches your certificate)
  7. Tap the address book you want to sync
  8. Enter account name (i.e. the description)
  9. Un-check sync from server to phone only if you want two-way-sync
  10. Tap Finish and confirm warning about two-way-sync if necessary

CardDAV-Sync starts immediately to sync your contacts. To edit settings for this account tap your new account and select Edit account settings

References and Resources

Please update this page if you have information on configuring other clients.

Verified Against: Zimbra Collaboration 8.7 Date Created: 04/13/2017
Article ID: https://wiki.zimbra.com/index.php?title=CardDAV Date Modified: 04/13/2017



Try Zimbra

Try Zimbra Collaboration with a 60-day free trial.
Get it now »

Want to get involved?

You can contribute in the Community, Wiki, Code, or development of Zimlets.
Find out more. »

Looking for a Video?

Visit our YouTube channel to get the latest webinars, technology news, product overviews, and so much more.
Go to the YouTube channel »


Jump to: navigation, search