| 1 |
.. _carddav: |
| 2 |
|
| 3 |
======= |
| 4 |
CardDAV |
| 5 |
======= |
| 6 |
|
| 7 |
Configuration |
| 8 |
============= |
| 9 |
|
| 10 |
.. sidebar:: addressbookprefix |
| 11 |
|
| 12 |
|change-default-config| |
| 13 |
|
| 14 |
.. include:: /imap/reference/manpages/configs/imapd.conf.rst |
| 15 |
:start-after: startblob addressbookprefix |
| 16 |
:end-before: endblob addressbookprefix |
| 17 |
|
| 18 |
When enabled, the CardDAV module allows Cyrus to function as a contacts server. |
| 19 |
This module uses a subset of the mailbox hierarchy as addressbook collections, |
| 20 |
the toplevel of which is specified by the ``addressbookprefix`` option. The public |
| 21 |
addressbook hierarchy will reside at the toplevel of the shared mailbox |
| 22 |
namespace. A user's personal addressbook hierarchy will be a child of their |
| 23 |
Inbox. |
| 24 |
|
| 25 |
For example, using the default value for addressbookprefix, an |
| 26 |
addressbook named Default for user "murch" would reside in the mailbox named |
| 27 |
``user.murch.#addressbooks.Default``. |
| 28 |
|
| 29 |
.. warning:: |
| 30 |
|
| 31 |
Note that mailboxes in the addressbook hierarchies (those under |
| 32 |
addressbookprefix) **should not** be accessed with an IMAP client as doing so will |
| 33 |
leave a mailbox in a state unsuitable for CardDAV. To this end, addressbook |
| 34 |
mailboxes will not returned by Cyrus imapd in response to an IMAP client's |
| 35 |
request for the available mailbox list, but Cyrus imapd can not otherwise |
| 36 |
prevent an IMAP client from accessing them. |
| 37 |
|
| 38 |
Administration |
| 39 |
============== |
| 40 |
|
| 41 |
The CardDAV module will *automatically* create a default addressbook for a user |
| 42 |
the first time that the user authenticates to the CardDAV server. Note that the |
| 43 |
user MUST have an existing IMAP Inbox in order for the addressbook to be |
| 44 |
created. |
| 45 |
|
| 46 |
.. sidebar:: carddav_allowaddressbookadmin |
| 47 |
|
| 48 |
|change-default-config| |
| 49 |
|
| 50 |
.. include:: /imap/reference/manpages/configs/imapd.conf.rst |
| 51 |
:start-after: startblob carddav_allowaddressbookadmin |
| 52 |
:end-before: endblob carddav_allowaddressbookadmin |
| 53 |
|
| 54 |
There is also a Cyrus web GUI for managing addressbook resources. |
| 55 |
It allows you to: |
| 56 |
|
| 57 |
* Create new collections |
| 58 |
* Delete existing collections |
| 59 |
* Download existing collections via prepared URLs |
| 60 |
* Set to “Public”, which toggles the `lrw9` rights for the `anyone` user. |
| 61 |
|
| 62 |
To delete the value of a property, click on ✎ and then submit empty new value. |
| 63 |
|
| 64 |
The Cyrus web GUI for addressbook management is disabled by default, |
| 65 |
but can be enabled with the "carddav_allowaddressbookadmin" option. |
| 66 |
|
| 67 |
To access the Cyrus web GUI for addressbook management, point |
| 68 |
a web browser at ``https://<servername>/dav/addressbooks/user/<username>`` |
| 69 |
|
| 70 |
Addressbook access controls |
| 71 |
--------------------------- |
| 72 |
|
| 73 |
Cyrus uses the same :ref:`access controls for addressbooks <calendar_ACL>` as it |
| 74 |
does for calendars, except that the scheduling rights (7, 8, 9) have no use with |
| 75 |
addressbooks and are ignored. |