CardDAVClients: Difference between revisions

From Open-Xchange
No edit summary
 
(7 intermediate revisions by 4 users not shown)
Line 1: Line 1:
This article is valid until the version 7.10.2 of the Open Xchange Server. For newer versions please visit https://documentation.open-xchange.com/develop/middleware/miscellaneous/caldav_carddav/carddav_clients.html
= Open-Xchange Contacts synchronization with CardDAV =
= Open-Xchange Contacts synchronization with CardDAV =


This site describes how the Open-Xchange server can be accessed via its CardDAV interface after the server has been configured as described in [[Caldav_carddav_Bundles]]. Depending on the used client software, different steps are necessary. Other clients may be configured similarly, but are not officially supported.
This site describes how the Open-Xchange server can be accessed via its CardDAV interface after the server has been configured as described in [[Caldav_carddav_Bundles]]. Depending on the used client software, different steps are necessary. Other clients may be configured similarly, but are not officially supported.


== Mac OS X Address Book / Contacts ==
== Mac OS X Contacts ==
''Available since Open-Xchange Server v6.20.1''


Depending on the used Mac OS X version, slightly different steps are necessary.
For the Contacts application on Mac OS X 10.9 (Mavericks) and above, a CardDAV account can be configured as follows:


=== Mac OS X Address Book (for version 10.6 Snow Leopard) ===
{|
| [[image:carddav-account2.png|thumb]] || style="width:85%" |
* Click the "+" sign in Address Book -> Preferences -> Accounts.
* In the "Account type" field keep "CardDAV" selected
* In the "User name" field enter your username '''replacing "@" with "*"''' (e.g. enter "peter.fraser*CONTEXTNAME" if you normally log in to OX with the username "peter.fraser@CONTEXTNAME".)
* In the "Password" field enter your password
* In the "Server address" field enter your server address '''with the prefix "dav." and ":443" or ":80" as suffix (e.g. "dav.MYSERVER.TLD:443")'''.<br/> Use '''443''' if you normally type '''https''' in your browser to reach your installation, '''80''' otherwise.
* Click "Create"
|}
=== Mac OS X Address Book (for version 10.7 Lion) / Mac OS X Contacts (for version 10.8 Mountain Lion) ===
{|  
{|  
| [[image:carddav-account5.png|thumb]] || style="width:85%" |
| [[image:carddav-account5.png|thumb]] || style="width:85%" |
Line 26: Line 15:
* In the "User name" field enter your username
* In the "User name" field enter your username
* In the "Password" field enter your password
* In the "Password" field enter your password
* In the "Server address" field enter your server address '''with the prefix "dav." (e.g. "dav.MYSERVER.TLD")'''.
* In the "Server address" field enter your server address '''usually with the prefix "dav." (e.g. "dav.myserver.tls")'''.
* Click "Create"
* Click "Create"
|}
|}
=== Debug Options ===
You can enable a Debug Menu inside the Address Book application which gives you access to advanced debugging and logging options. Please notice that some of these options may increase the size of the log files of your system and/or could also log sensitive data like passwords if enabled. Keep also in mind that any setting changed here will remain active until the setting itself will be reverted or changed again which means that disabling the Debug Menu itself is not sufficient to reset any debug settings to their defaults. All settings are case sensitive.
Open a terminal window (Applications > Utilities > Terminal) and issue the following command for
* enabling the Debug Menu in the AddressBook:
defaults write com.apple.AddressBook ABShowDebugMenu -bool true
* disabling the Debug Menu in the AddressBook:
defaults write com.apple.AddressBook ABShowDebugMenu -bool false
'''PLEASE NOTE:''': The debug menu is not available in Mac OS X 10.8.


== iOS Contacts ==
== iOS Contacts ==
Line 59: Line 36:


=== Unsupported Properties ===
=== Unsupported Properties ===
* Generally, only those contact properties that are also available on the Open-Xchange server are used for synchronization, i.e. all unsupported properties are ignored and not saved.
* Generally, only those contact properties that are also available on the Open-Xchange server are recognized and transferred into attributes of OX contacts
* Starting with v7.8.0, the original vCard is also preserved, so that other extended or not mapped properties are still available there (see [[AppSuite:VCardMapping]] for details)
* Importing or exporting file attachments (property "ATTACH") is not supported via the CardDAV interface.
* Importing or exporting file attachments (property "ATTACH") is not supported via the CardDAV interface.
* Due to various different handlings of representing distribution list members in vCards, distribution lists are excluded from syncrhonization via CardDAV.
* Due to various different handlings of representing distribution list members in vCards, distribution lists are excluded from syncrhonization via CardDAV.


=== Unsupported Special Chars ===
=== Unsupported Special Chars ===
* The special char "/" in contact names is not supported. It will lead to an "HTTP/1.1 404 Not Found" error in webdav.


* The special char "\" in contact names is not supported. It will lead to an "HTTP/1.1 404 Not Found" error.
=== Client Restrictions ===
* The Mac Contacts App does not Support CalDAV Collections. Open-Xchange by default recognizes this and exposes an aggregated collection of the CalDAV Collections. As a consequence new contacts entered in subfolders on OX side will not appear in subfolders (or Contact Groups) on the Mac Contacts App but inside of the aggregated Collection itself. Additionally Contact Groups from the Contacts App are not synced to OX - however the Contacts itself will be synced to the OX Address Book. Creating a new Contacts Group from within the Contacts App using the OX CardDAV Account is not possible - the name will revert to “untitled group” and will not be synced to OX App Suite.

Latest revision as of 12:53, 9 April 2020

This article is valid until the version 7.10.2 of the Open Xchange Server. For newer versions please visit https://documentation.open-xchange.com/develop/middleware/miscellaneous/caldav_carddav/carddav_clients.html

Open-Xchange Contacts synchronization with CardDAV

This site describes how the Open-Xchange server can be accessed via its CardDAV interface after the server has been configured as described in Caldav_carddav_Bundles. Depending on the used client software, different steps are necessary. Other clients may be configured similarly, but are not officially supported.

Mac OS X Contacts

For the Contacts application on Mac OS X 10.9 (Mavericks) and above, a CardDAV account can be configured as follows:

Carddav-account5.png
  • Click the "+" sign in Address Book -> Preferences -> Accounts.
  • In the "Account type" field keep "CardDAV" selected
  • In the "User name" field enter your username
  • In the "Password" field enter your password
  • In the "Server address" field enter your server address usually with the prefix "dav." (e.g. "dav.myserver.tls").
  • Click "Create"

iOS Contacts

Available since Open-Xchange Server v6.22

The iOS Contacts application on the iPhone, iPod or iPad can be configured as follows.

Ios carddav config.png
  • Open "Settings"
  • Select "Mail, Contacts, Calendars" -> "Add Account..." -> "Other" -> "Add CardDAV Account"
  • Enter the server address, username as password as shown in the screenshot
  • Click "Next"

General Limitations

Please consider the following known limitations for the CardDAV interface:

Unsupported Properties

  • Generally, only those contact properties that are also available on the Open-Xchange server are recognized and transferred into attributes of OX contacts
  • Starting with v7.8.0, the original vCard is also preserved, so that other extended or not mapped properties are still available there (see AppSuite:VCardMapping for details)
  • Importing or exporting file attachments (property "ATTACH") is not supported via the CardDAV interface.
  • Due to various different handlings of representing distribution list members in vCards, distribution lists are excluded from syncrhonization via CardDAV.

Unsupported Special Chars

  • The special char "/" in contact names is not supported. It will lead to an "HTTP/1.1 404 Not Found" error in webdav.

Client Restrictions

  • The Mac Contacts App does not Support CalDAV Collections. Open-Xchange by default recognizes this and exposes an aggregated collection of the CalDAV Collections. As a consequence new contacts entered in subfolders on OX side will not appear in subfolders (or Contact Groups) on the Mac Contacts App but inside of the aggregated Collection itself. Additionally Contact Groups from the Contacts App are not synced to OX - however the Contacts itself will be synced to the OX Address Book. Creating a new Contacts Group from within the Contacts App using the OX CardDAV Account is not possible - the name will revert to “untitled group” and will not be synced to OX App Suite.
Retrieved from "https://wiki.open-xchange.com/wiki/index.php?title=CardDAVClients&oldid=25300"