<pre>Internet Engineering Task Force (IETF)                          C. Daboo
Request for Comments: 6352                                         Apple
Category: Standards Track                                    August 2011
ISSN: 2070-1721


                      <span class="h1">CardDAV: vCard Extensions to</span>
           <span class="h1">Web Distributed Authoring and Versioning (WebDAV)</span>

Abstract

   This document defines extensions to the Web Distributed Authoring and
   Versioning (WebDAV) protocol to specify a standard way of accessing,
   managing, and sharing contact information based on the vCard format.

Status of This Memo

   This is an Internet Standards Track document.

   This document is a product of the Internet Engineering Task Force
   (IETF).  It represents the consensus of the IETF community.  It has
   received public review and has been approved for publication by the
   Internet Engineering Steering Group (IESG).  Further information on
   Internet Standards is available in <a href="./rfc5741#section-2">Section&nbsp;2 of RFC 5741</a>.

   Information about the current status of this document, any errata,
   and how to provide feedback on it may be obtained at
   <a href="http://www.rfc-editor.org/info/rfc6352">http://www.rfc-editor.org/info/rfc6352</a>.

Copyright Notice

   Copyright (c) 2011 IETF Trust and the persons identified as the
   document authors.  All rights reserved.

   This document is subject to <a href="https://www.rfc-editor.org/bcp/bcp78">BCP 78</a> and the IETF Trust's Legal
   Provisions Relating to IETF Documents
   (<a href="http://trustee.ietf.org/license-info">http://trustee.ietf.org/license-info</a>) in effect on the date of
   publication of this document.  Please review these documents
   carefully, as they describe your rights and restrictions with respect
   to this document.  Code Components extracted from this document must
   include Simplified BSD License text as described in Section 4.e of
   the Trust Legal Provisions and are provided without warranty as
   described in the Simplified BSD License.

   This document may contain material from IETF Documents or IETF
   Contributions published or made publicly available before November
   10, 2008.  The person(s) controlling the copyright in some of this
   material may not have granted the IETF Trust the right to allow



<span class="grey">Daboo                        Standards Track                    [Page 1]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-2" ></span>
<span class="grey"><a href="./rfc6352">RFC 6352</a>                         CardDAV                     August 2011</span>


   modifications of such material outside the IETF Standards Process.
   Without obtaining an adequate license from the person(s) controlling
   the copyright in such materials, this document may not be modified
   outside the IETF Standards Process, and derivative works of it may
   not be created outside the IETF Standards Process, except to format
   it for publication as an RFC or to translate it into languages other
   than English.

Table of Contents

   <a href="#section-1">1</a>.  Introduction and Overview  . . . . . . . . . . . . . . . . . .  <a href="#page-4">4</a>
   <a href="#section-2">2</a>.  Conventions  . . . . . . . . . . . . . . . . . . . . . . . . .  <a href="#page-5">5</a>
   <a href="#section-3">3</a>.  Requirements Overview  . . . . . . . . . . . . . . . . . . . .  <a href="#page-6">6</a>
   <a href="#section-4">4</a>.  Address Book Data Model  . . . . . . . . . . . . . . . . . . .  <a href="#page-7">7</a>
     <a href="#section-4.1">4.1</a>.  Address Book Server  . . . . . . . . . . . . . . . . . . .  <a href="#page-7">7</a>
   <a href="#section-5">5</a>.  Address Book Resources . . . . . . . . . . . . . . . . . . . .  <a href="#page-7">7</a>
     <a href="#section-5.1">5.1</a>.  Address Object Resources . . . . . . . . . . . . . . . . .  <a href="#page-7">7</a>
       <a href="#section-5.1.1">5.1.1</a>.  Data Type Conversion . . . . . . . . . . . . . . . . .  <a href="#page-8">8</a>
         <a href="#section-5.1.1.1">5.1.1.1</a>.  Additional Precondition for GET  . . . . . . . . .  <a href="#page-8">8</a>
     <a href="#section-5.2">5.2</a>.  Address Book Collections . . . . . . . . . . . . . . . . .  <a href="#page-9">9</a>
   <a href="#section-6">6</a>.  Address Book Feature . . . . . . . . . . . . . . . . . . . . . <a href="#page-10">10</a>
     <a href="#section-6.1">6.1</a>.  Address Book Support . . . . . . . . . . . . . . . . . . . <a href="#page-10">10</a>
       6.1.1.  Example: Using OPTIONS for the Discovery of
               Support for CardDAV  . . . . . . . . . . . . . . . . . <a href="#page-10">10</a>
     <a href="#section-6.2">6.2</a>.  Address Book Properties  . . . . . . . . . . . . . . . . . <a href="#page-10">10</a>
       <a href="#section-6.2.1">6.2.1</a>.  CARDDAV:addressbook-description Property . . . . . . . <a href="#page-10">10</a>
       <a href="#section-6.2.2">6.2.2</a>.  CARDDAV:supported-address-data Property  . . . . . . . <a href="#page-11">11</a>
       <a href="#section-6.2.3">6.2.3</a>.  CARDDAV:max-resource-size Property . . . . . . . . . . <a href="#page-12">12</a>
     <a href="#section-6.3">6.3</a>.  Creating Resources . . . . . . . . . . . . . . . . . . . . <a href="#page-13">13</a>
       <a href="#section-6.3.1">6.3.1</a>.  Extended MKCOL Method  . . . . . . . . . . . . . . . . <a href="#page-13">13</a>
         <a href="#section-6.3.1.1">6.3.1.1</a>.  Example - Successful MKCOL Request . . . . . . . . <a href="#page-14">14</a>
       <a href="#section-6.3.2">6.3.2</a>.  Creating Address Object Resources  . . . . . . . . . . <a href="#page-15">15</a>
         6.3.2.1.  Additional Preconditions for PUT, COPY, and
                   MOVE . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-16">16</a>
         <a href="#section-6.3.2.2">6.3.2.2</a>.  Non-Standard vCard Properties and Parameters . . . <a href="#page-17">17</a>
         <a href="#section-6.3.2.3">6.3.2.3</a>.  Address Object Resource Entity Tag . . . . . . . . <a href="#page-18">18</a>
   <a href="#section-7">7</a>.  Address Book Access Control  . . . . . . . . . . . . . . . . . <a href="#page-18">18</a>
     <a href="#section-7.1">7.1</a>.  Additional Principal Properties  . . . . . . . . . . . . . <a href="#page-18">18</a>
       <a href="#section-7.1.1">7.1.1</a>.  CARDDAV:addressbook-home-set Property  . . . . . . . . <a href="#page-19">19</a>
       <a href="#section-7.1.2">7.1.2</a>.  CARDDAV:principal-address Property . . . . . . . . . . <a href="#page-19">19</a>
   <a href="#section-8">8</a>.  Address Book Reports . . . . . . . . . . . . . . . . . . . . . <a href="#page-20">20</a>
     <a href="#section-8.1">8.1</a>.  REPORT Method  . . . . . . . . . . . . . . . . . . . . . . <a href="#page-20">20</a>
     <a href="#section-8.2">8.2</a>.  Ordinary Collections . . . . . . . . . . . . . . . . . . . <a href="#page-21">21</a>
     <a href="#section-8.3">8.3</a>.  Searching Text: Collations . . . . . . . . . . . . . . . . <a href="#page-21">21</a>
       <a href="#section-8.3.1">8.3.1</a>.  CARDDAV:supported-collation-set Property . . . . . . . <a href="#page-22">22</a>
     <a href="#section-8.4">8.4</a>.  Partial Retrieval  . . . . . . . . . . . . . . . . . . . . <a href="#page-23">23</a>
     <a href="#section-8.5">8.5</a>.  Non-Standard Properties and Parameters . . . . . . . . . . <a href="#page-23">23</a>




<span class="grey">Daboo                        Standards Track                    [Page 2]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-3" ></span>
<span class="grey"><a href="./rfc6352">RFC 6352</a>                         CardDAV                     August 2011</span>


     <a href="#section-8.6">8.6</a>.  CARDDAV:addressbook-query Report . . . . . . . . . . . . . <a href="#page-23">23</a>
       <a href="#section-8.6.1">8.6.1</a>.  Limiting Results . . . . . . . . . . . . . . . . . . . <a href="#page-25">25</a>
       <a href="#section-8.6.2">8.6.2</a>.  Truncation of Results  . . . . . . . . . . . . . . . . <a href="#page-25">25</a>
       8.6.3.  Example: Partial Retrieval of vCards Matching
               NICKNAME . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-26">26</a>
       8.6.4.  Example: Partial Retrieval of vCards Matching a
               Full Name or Email Address . . . . . . . . . . . . . . <a href="#page-27">27</a>
       <a href="#section-8.6.5">8.6.5</a>.  Example: Truncated Results . . . . . . . . . . . . . . <a href="#page-29">29</a>
     <a href="#section-8.7">8.7</a>.  CARDDAV:addressbook-multiget Report  . . . . . . . . . . . <a href="#page-31">31</a>
       <a href="#section-8.7.1">8.7.1</a>.  Example: CARDDAV:addressbook-multiget Report . . . . . <a href="#page-32">32</a>
       <a href="#section-8.7.2">8.7.2</a>.  Example: CARDDAV:addressbook-multiget Report . . . . . <a href="#page-33">33</a>
   <a href="#section-9">9</a>.  Client Guidelines  . . . . . . . . . . . . . . . . . . . . . . <a href="#page-34">34</a>
     <a href="#section-9.1">9.1</a>.  Restrict the Properties Returned . . . . . . . . . . . . . <a href="#page-34">34</a>
     <a href="#section-9.2">9.2</a>.  Avoiding Lost Updates  . . . . . . . . . . . . . . . . . . <a href="#page-35">35</a>
     <a href="#section-9.3">9.3</a>.  Client Configuration . . . . . . . . . . . . . . . . . . . <a href="#page-35">35</a>
     <a href="#section-9.4">9.4</a>.  Finding Other Users' Address Books . . . . . . . . . . . . <a href="#page-35">35</a>
   <a href="#section-10">10</a>. XML Element Definitions  . . . . . . . . . . . . . . . . . . . <a href="#page-36">36</a>
     <a href="#section-10.1">10.1</a>. CARDDAV:addressbook XML Element  . . . . . . . . . . . . . <a href="#page-36">36</a>
     <a href="#section-10.2">10.2</a>. CARDDAV:supported-collation XML Element  . . . . . . . . . <a href="#page-36">36</a>
     <a href="#section-10.3">10.3</a>. CARDDAV:addressbook-query XML Element  . . . . . . . . . . <a href="#page-37">37</a>
     <a href="#section-10.4">10.4</a>. CARDDAV:address-data XML Element . . . . . . . . . . . . . <a href="#page-37">37</a>
       <a href="#section-10.4.1">10.4.1</a>. CARDDAV:allprop XML Element  . . . . . . . . . . . . . <a href="#page-39">39</a>
       <a href="#section-10.4.2">10.4.2</a>. CARDDAV:prop XML Element . . . . . . . . . . . . . . . <a href="#page-39">39</a>
     <a href="#section-10.5">10.5</a>. CARDDAV:filter XML Element . . . . . . . . . . . . . . . . <a href="#page-40">40</a>
       <a href="#section-10.5.1">10.5.1</a>. CARDDAV:prop-filter XML Element  . . . . . . . . . . . <a href="#page-40">40</a>
       <a href="#section-10.5.2">10.5.2</a>. CARDDAV:param-filter XML Element . . . . . . . . . . . <a href="#page-41">41</a>
       <a href="#section-10.5.3">10.5.3</a>. CARDDAV:is-not-defined XML Element . . . . . . . . . . <a href="#page-42">42</a>
       <a href="#section-10.5.4">10.5.4</a>. CARDDAV:text-match XML Element . . . . . . . . . . . . <a href="#page-42">42</a>
     <a href="#section-10.6">10.6</a>. CARDDAV:limit XML Element  . . . . . . . . . . . . . . . . <a href="#page-43">43</a>
       <a href="#section-10.6.1">10.6.1</a>. CARDDAV:nresults XML Element . . . . . . . . . . . . . <a href="#page-44">44</a>
     <a href="#section-10.7">10.7</a>. CARDDAV:addressbook-multiget XML Element . . . . . . . . . <a href="#page-44">44</a>
   <a href="#section-11">11</a>. Service Discovery via SRV Records  . . . . . . . . . . . . . . <a href="#page-45">45</a>
   <a href="#section-12">12</a>. Internationalization Considerations  . . . . . . . . . . . . . <a href="#page-45">45</a>
   <a href="#section-13">13</a>. Security Considerations  . . . . . . . . . . . . . . . . . . . <a href="#page-45">45</a>
   <a href="#section-14">14</a>. IANA Consideration . . . . . . . . . . . . . . . . . . . . . . <a href="#page-46">46</a>
     <a href="#section-14.1">14.1</a>. Namespace Registration . . . . . . . . . . . . . . . . . . <a href="#page-46">46</a>
   <a href="#section-15">15</a>. Acknowledgments  . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-46">46</a>
   <a href="#section-16">16</a>. References . . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-47">47</a>
     <a href="#section-16.1">16.1</a>. Normative References . . . . . . . . . . . . . . . . . . . <a href="#page-47">47</a>
     <a href="#section-16.2">16.2</a>. Informative References . . . . . . . . . . . . . . . . . . <a href="#page-48">48</a>











<span class="grey">Daboo                        Standards Track                    [Page 3]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-4" ></span>
<span class="grey"><a href="./rfc6352">RFC 6352</a>                         CardDAV                     August 2011</span>


<span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>.  Introduction and Overview</span>

   Address books containing contact information are a key component of
   personal information management tools, such as email, calendaring and
   scheduling, and instant messaging clients.  To date several protocols
   have been used for remote access to contact data, including the
   Lightweight Directory Access Protocol (LDAP) [<a href="./rfc4510" title="&quot;Lightweight Directory Access Protocol (LDAP): Technical Specification Road Map&quot;">RFC4510</a>], Internet
   Message Support Protocol [<a href="#ref-IMSP" title="&quot;IMSP - Internet Message Support Protocol&quot;">IMSP</a>], and Application Configuration Access
   Protocol (ACAP) [<a href="./rfc2244" title="&quot;ACAP -- Application Configuration Access Protocol&quot;">RFC2244</a>], together with SyncML used for
   synchronization of such data.

   WebDAV [<a href="./rfc4918" title="&quot;HTTP Extensions for Web Distributed Authoring and Versioning (WebDAV)&quot;">RFC4918</a>] offers a number of advantages as a framework or
   basis for address book access and management.  Most of these
   advantages boil down to a significant reduction in the costs of
   design, implementation, interoperability testing, and deployment.

   The key features of address book support with WebDAV are:

   1.  Ability to use multiple address books with hierarchical layout.

   2.  Ability to control access to individual address books and address
       entries as per WebDAV Access Control List (ACL) [<a href="./rfc3744" title="&quot;Web Distributed Authoring and Versioning (WebDAV) Access Control Protocol&quot;">RFC3744</a>].

   3.  Principal collections can be used to enumerate and query other
       users on the system as per WebDAV ACL [<a href="./rfc3744" title="&quot;Web Distributed Authoring and Versioning (WebDAV) Access Control Protocol&quot;">RFC3744</a>].

   4.  Server-side searching of address data, avoiding the need for
       clients to download an entire address book in order to do a quick
       address 'expansion' operation.

   5.  Well-defined internationalization support through WebDAV's use of
       XML.

   6.  Use of vCards [<a href="./rfc2426" title="&quot;vCard MIME Directory Profile&quot;">RFC2426</a>] for well-defined address schema to
       enhance client interoperability.

   7.  Many limited clients (e.g., mobile devices) contain an HTTP stack
       that makes implementing WebDAV much easier than other protocols.

   The key disadvantage of address book support in WebDAV is:

   1.  Lack of change notification.  Many of the alternative protocols
       also lack this ability.  However, an extension for push
       notifications could easily be developed.

   vCard is a MIME directory profile aimed at encapsulating personal
   addressing and contact information about people.  The specification
   of vCard was originally done by the Versit consortium, with a



<span class="grey">Daboo                        Standards Track                    [Page 4]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-5" ></span>
<span class="grey"><a href="./rfc6352">RFC 6352</a>                         CardDAV                     August 2011</span>


   subsequent 3.0 version standardized by the IETF [<a href="./rfc2426" title="&quot;vCard MIME Directory Profile&quot;">RFC2426</a>]. vCard is
   in widespread use in email clients and mobile devices as a means of
   encapsulating address information for transport via email or for
   import/export and synchronization operations.

   An update to vCard -- vCard v4 -- is currently being developed
   [<a href="./rfc6350" title="&quot;vCard Format Specification&quot;">RFC6350</a>] and is compatible with this specification.

<span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>.  Conventions</span>

   The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
   "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
   document are to be interpreted as described in [<a href="./rfc2119" title="&quot;Key words for use in RFCs to Indicate Requirement Levels&quot;">RFC2119</a>].

   The term "protected" is used in the Conformance field of property
   definitions as defined in <a href="./rfc4918#section-15">Section&nbsp;15 of [RFC4918]</a>.

   This document uses XML DTD fragments ([<a href="#ref-W3C.REC-xml-20081126">W3C.REC-xml-20081126</a>], <a href="#section-3.2">Section</a>
   <a href="#section-3.2">3.2</a>) as a purely notational convention.  WebDAV request and response
   bodies cannot be validated by a DTD due to the specific extensibility
   rules defined in <a href="./rfc4918#section-17">Section&nbsp;17 of [RFC4918]</a> and due to the fact that all
   XML elements defined by that specification use the XML namespace name
   "DAV:".  In particular:

   1.  Element names use the "DAV:" namespace.

   2.  Element ordering is irrelevant unless explicitly stated.

   3.  Extension elements (elements not already defined as valid child
       elements) may be added anywhere, except when explicitly stated
       otherwise.

   4.  Extension attributes (attributes not already defined as valid for
       this element) may be added anywhere, except when explicitly
       stated otherwise.

   The namespace "urn:ietf:params:xml:ns:carddav" is reserved for the
   XML elements defined in this specification, its revisions, and
   related CardDAV specifications.  XML elements defined by individual
   implementations MUST NOT use the "urn:ietf:params:xml:ns:carddav"
   namespace, and instead should use a namespace that they control.

   When XML element types in the namespaces "DAV:" and
   "urn:ietf:params:xml:ns:carddav" are referenced in this document
   outside of the context of an XML fragment, the strings "DAV:" and
   "CARDDAV:" will be prefixed to the element types, respectively.





<span class="grey">Daboo                        Standards Track                    [Page 5]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-6" ></span>
<span class="grey"><a href="./rfc6352">RFC 6352</a>                         CardDAV                     August 2011</span>


   This document inherits, and sometimes extends, DTD productions from
   <a href="./rfc4918#section-14">Section&nbsp;14 of [RFC4918]</a>.

   Also, note that some CardDAV XML element names are identical to
   WebDAV XML element names, though their namespace differs.  Care must
   be taken not to confuse the two sets of names.

<span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>.  Requirements Overview</span>

   This section lists what functionality is required of a CardDAV
   server.  To advertise support for CardDAV, a server:

   o  MUST support vCard v3 [<a href="./rfc2426" title="&quot;vCard MIME Directory Profile&quot;">RFC2426</a>] as a media type for the address
      object resource format;

   o  MUST support WebDAV Class 3 [<a href="./rfc4918" title="&quot;HTTP Extensions for Web Distributed Authoring and Versioning (WebDAV)&quot;">RFC4918</a>];

   o  MUST support WebDAV ACL [<a href="./rfc3744" title="&quot;Web Distributed Authoring and Versioning (WebDAV) Access Control Protocol&quot;">RFC3744</a>];

   o  MUST support secure transport as defined in [<a href="./rfc2818" title="&quot;HTTP Over TLS&quot;">RFC2818</a>] using
      Transport Layer Security (TLS) [<a href="./rfc5246" title="&quot;The Transport Layer Security (TLS) Protocol Version 1.2&quot;">RFC5246</a>] and using the certificate
      validation procedures described in [<a href="./rfc5280" title="&quot;Internet X.509 Public Key Infrastructure Certificate and Certificate Revocation List (CRL) Profile&quot;">RFC5280</a>];

   o  MUST support ETags [<a href="./rfc2616" title="&quot;Hypertext Transfer Protocol -- HTTP/1.1&quot;">RFC2616</a>] with additional requirements
      specified in <a href="#section-6.3.2.3">Section 6.3.2.3</a> of this document;

   o  MUST support all address book reports defined in <a href="#section-8">Section 8</a> of this
      document; and

   o  MUST advertise support on all address book collections and address
      object resources for the address book reports in the
      DAV:supported-report-set property, as defined in Versioning
      Extensions to WebDAV [<a href="./rfc3253" title="&quot;Versioning Extensions to WebDAV (Web Distributed Authoring and Versioning)&quot;">RFC3253</a>].

   In addition, a server:

   o  SHOULD support vCard v4 [<a href="./rfc6350" title="&quot;vCard Format Specification&quot;">RFC6350</a>] as a media type for the address
      object resource format;

   o  SHOULD support the extended MKCOL method [<a href="./rfc5689" title="&quot;Extended MKCOL for Web Distributed Authoring and Versioning (WebDAV)&quot;">RFC5689</a>] to create
      address book collections as defined in <a href="#section-6.3.1">Section 6.3.1</a> of this
      document.

   o  SHOULD support the DAV:current-user-principal-URL property as
      defined in [<a href="./rfc5397" title="&quot;WebDAV Current Principal Extension&quot;">RFC5397</a>] to give clients a fast way to locate user
      principals.





<span class="grey">Daboo                        Standards Track                    [Page 6]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-7" ></span>
<span class="grey"><a href="./rfc6352">RFC 6352</a>                         CardDAV                     August 2011</span>


<span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a>.  Address Book Data Model</span>

   As a brief overview, a CardDAV address book is modeled as a WebDAV
   collection with a well-defined structure; each of these address book
   collections contains a number of resources representing address
   objects as their direct child resources.  Each resource representing
   an address object is called an "address object resource".  Each
   address object resource and each address book collection can be
   individually locked and have individual WebDAV properties.
   Requirements derived from this model are provided in Sections <a href="#section-5.1">5.1</a> and
   5.2.

<span class="h3"><a class="selflink" id="section-4.1" href="#section-4.1">4.1</a>.  Address Book Server</span>

   A CardDAV server is an address-aware engine combined with a WebDAV
   server.  The server may include address data in some parts of its URL
   namespace and non-address data in other parts.

   A WebDAV server can advertise itself as a CardDAV server if it
   supports the functionality defined in this specification at any point
   within the root of its repository.  That might mean that address data
   is spread throughout the repository and mixed with non-address data
   in nearby collections (e.g., address data may be found in /lisa/
   addressbook/ as well as in /bernard/addressbook/, and non-address
   data in /lisa/calendars/).  Or, it might mean that address data can
   be found only in certain sections of the repository (e.g.,
   /addressbooks/user/).  Address book features are only required in the
   repository sections that are or contain address objects.  So, a
   repository confining address data to the /carddav/ collection would
   only need to support the CardDAV required features within that
   collection.

   The CardDAV server is the canonical location for address data and
   state information.  Clients may submit requests to change data or
   download data.  Clients may store address objects offline and attempt
   to synchronize at a later time.  Address data on the server can
   change between the time of last synchronization and when attempting
   an update, as address book collections may be shared and accessible
   via multiple clients.  Entity tags and locking help this work.

<span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a>.  Address Book Resources</span>

<span class="h3"><a class="selflink" id="section-5.1" href="#section-5.1">5.1</a>.  Address Object Resources</span>

   This specification uses vCard as the default format for address or
   contact information being stored on the server.  However, this
   specification does allow other formats for address data provided that
   the server advertises support for those additional formats as



<span class="grey">Daboo                        Standards Track                    [Page 7]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-8" ></span>
<span class="grey"><a href="./rfc6352">RFC 6352</a>                         CardDAV                     August 2011</span>


   described below.  The requirements in this section pertain to vCard
   address data or formats that follow the semantics of vCard data.

   Address object resources contained in address book collections MUST
   contain a single vCard component only.

   vCard components in an address book collection MUST have a UID
   property value that MUST be unique in the scope of the address book
   collection in which it is contained.

<span class="h4"><a class="selflink" id="section-5.1.1" href="#section-5.1.1">5.1.1</a>.  Data Type Conversion</span>

   Servers might support more than one primary media type for address
   object resources, for example, vCard v3.0 and vCard v4.0.  In such
   cases, servers have to accept all media types that they advertise via
   the CARDDAV:supported-address-data WebDAV property (see
   <a href="#section-6.2.2">Section 6.2.2</a>).

   However, clients can use standard HTTP content negotiation behavior
   (the Accept request header defined in <a href="./rfc2616#section-14.1">Section&nbsp;14.1 of [RFC2616]</a>) to
   request that an address object resource's data be returned in a
   specific media type format.  For example, a client merely capable of
   handling vCard v3.0 would only want to have address object resources
   returned in v3.0 format.

   Additionally, REPORT requests, defined later in this specification,
   allow for the return of address object resource data within an XML
   response body.  Again, the client can use content negotiation to
   request that data be returned in a specific media type by specifying
   appropriate attributes on the CARDDAV:address-data XML element used
   in the request body (see <a href="#section-10.4">Section 10.4</a>).

   In some cases, it might not be possible for a server to convert from
   one media type to another.  When that happens, the server MUST return
   the CARDDAV:supported-address-data-conversion precondition (see
   below) in the response body (when the failure to convert applies to
   the entire response) or use that same precondition code in the
   DAV:response XML element in the response for the targeted address
   object resource when one of the REPORTs defined below is used.  See
   <a href="#section-8.7.2">Section 8.7.2</a> for an example of this.

<span class="h5"><a class="selflink" id="section-5.1.1.1" href="#section-5.1.1.1">5.1.1.1</a>.  Additional Precondition for GET</span>

   This specification creates additional preconditions for the GET
   method.






<span class="grey">Daboo                        Standards Track                    [Page 8]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-9" ></span>
<span class="grey"><a href="./rfc6352">RFC 6352</a>                         CardDAV                     August 2011</span>


   The new precondition is:

      (CARDDAV:supported-address-data-conversion): The resource targeted
      by the GET request can be converted to the media type specified in
      the Accept request header included with the request.

<span class="h3"><a class="selflink" id="section-5.2" href="#section-5.2">5.2</a>.  Address Book Collections</span>

   Address book collections appear to clients as a WebDAV collection
   resource, identified by a URL.  An address book collection MUST
   report the DAV:collection and CARDDAV:addressbook XML elements in the
   value of the DAV:resourcetype property.  The element type declaration
   for CARDDAV:addressbook is:

       &lt;!ELEMENT addressbook EMPTY&gt;

   An address book collection can be created through provisioning (e.g.,
   automatically created when a user's account is provisioned), or it
   can be created with the extended MKCOL method (see <a href="#section-6.3.1">Section 6.3.1</a>).
   This can be used by a user to create additional address books (e.g.,
   "soccer team members") or for users to share an address book (e.g.,
   "sales team contacts").  However, note that this document doesn't
   define what extra address book collections are for.  Users must rely
   on non-standard cues to find out what an address book collection is
   for, or use the CARDDAV:addressbook-description property defined in
   <a href="#section-6.2.1">Section 6.2.1</a> to provide such a cue.

   The following restrictions are applied to the resources within an
   address book collection:

   a.  Address book collections MUST only contain address object
       resources and collections that are not address book collections.
       That is, the only "top-level" non-collection resources allowed in
       an address book collection are address object resources.  This
       ensures that address book clients do not have to deal with non-
       address data in an address book collection, though they do have
       to distinguish between address object resources and collections
       when using standard WebDAV techniques to examine the contents of
       a collection.

   b.  Collections contained in address book collections MUST NOT
       contain address book collections at any depth.  That is,
       "nesting" of address book collections within other address book
       collections at any depth is not allowed.  This specification does
       not define how collections contained in an address book
       collection are used or how they relate to any address object
       resources contained in the address book collection.




<span class="grey">Daboo                        Standards Track                    [Page 9]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-10" ></span>
<span class="grey"><a href="./rfc6352">RFC 6352</a>                         CardDAV                     August 2011</span>


   Multiple address book collections MAY be children of the same
   collection.

<span class="h2"><a class="selflink" id="section-6" href="#section-6">6</a>.  Address Book Feature</span>

<span class="h3"><a class="selflink" id="section-6.1" href="#section-6.1">6.1</a>.  Address Book Support</span>

   A server supporting the features described in this document MUST
   include "addressbook" as a field in the DAV response header from an
   OPTIONS request on any resource that supports any address book
   properties, reports, or methods.  A value of "addressbook" in the DAV
   response header MUST indicate that the server supports all MUST level
   requirements and REQUIRED features specified in this document.

<span class="h4"><a class="selflink" id="section-6.1.1" href="#section-6.1.1">6.1.1</a>.  Example: Using OPTIONS for the Discovery of Support for CardDAV</span>

   &gt;&gt; Request &lt;&lt;

   OPTIONS /addressbooks/users/ HTTP/1.1
   Host: addressbook.example.com

   &gt;&gt; Response &lt;&lt;

   HTTP/1.1 200 OK
   Allow: OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, COPY, MOVE
   Allow: MKCOL, PROPFIND, PROPPATCH, LOCK, UNLOCK, REPORT, ACL
   DAV: 1, 2, 3, access-control, addressbook
   DAV: extended-mkcol
   Date: Sat, 11 Nov 2006 09:32:12 GMT
   Content-Length: 0

   In this example, the OPTIONS response indicates that the server
   supports CardDAV in this namespace; therefore, the '/addressbooks/
   users/' collection may be used as a parent for address book
   collections as the extended MKCOL method is available and as a
   possible target for REPORT requests for address book reports.

<span class="h3"><a class="selflink" id="section-6.2" href="#section-6.2">6.2</a>.  Address Book Properties</span>

<span class="h4"><a class="selflink" id="section-6.2.1" href="#section-6.2.1">6.2.1</a>.  CARDDAV:addressbook-description Property</span>

   Name:  addressbook-description

   Namespace:  urn:ietf:params:xml:ns:carddav

   Purpose:  Provides a human-readable description of the address book
      collection.




<span class="grey">Daboo                        Standards Track                   [Page 10]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-11" ></span>
<span class="grey"><a href="./rfc6352">RFC 6352</a>                         CardDAV                     August 2011</span>


   Value:  Any text.

   Protected:  SHOULD NOT be protected so that users can specify a
      description.

   COPY/MOVE behavior:  This property value SHOULD be preserved in COPY
      and MOVE operations.

   allprop behavior:  SHOULD NOT be returned by a PROPFIND DAV:allprop
      request.

   Description:  This property contains a description of the address
      book collection that is suitable for presentation to a user.  The
      xml:lang attribute can be used to add a language tag for the value
      of this property.

   Definition:

       &lt;!ELEMENT addressbook-description (#PCDATA)&gt;
       &lt;!-- PCDATA value: string --&gt;

   Example:

       &lt;C:addressbook-description xml:lang="fr-CA"
          xmlns:C="urn:ietf:params:xml:ns:carddav"
       &gt;Adresses de Oliver Daboo&lt;/C:addressbook-description&gt;

<span class="h4"><a class="selflink" id="section-6.2.2" href="#section-6.2.2">6.2.2</a>.  CARDDAV:supported-address-data Property</span>

   Name:  supported-address-data

   Namespace:  urn:ietf:params:xml:ns:carddav

   Purpose:  Specifies what media types are allowed for address object
      resources in an address book collection.

   Protected:  MUST be protected as it indicates the level of support
      provided by the server.

   COPY/MOVE behavior:  This property value MUST be preserved in COPY
      and MOVE operations.

   allprop behavior:  SHOULD NOT be returned by a PROPFIND DAV:allprop
      request.

   Description:  The CARDDAV:supported-address-data property is used to
      specify the media type supported for the address object resources
      contained in a given address book collection (e.g., vCard version



<span class="grey">Daboo                        Standards Track                   [Page 11]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-12" ></span>
<span class="grey"><a href="./rfc6352">RFC 6352</a>                         CardDAV                     August 2011</span>


      3.0).  Any attempt by the client to store address object resources
      with a media type not listed in this property MUST result in an
      error, with the CARDDAV:supported-address-data precondition
      (<a href="#section-6.3.2.1">Section 6.3.2.1</a>) being violated.  In the absence of this
      property, the server MUST only accept data with the media type
      "text/vcard" and vCard version 3.0, and clients can assume that is
      all the server will accept.

   Definition:

       &lt;!ELEMENT supported-address-data (address-data-type+)&gt;

       &lt;!ELEMENT address-data-type EMPTY&gt;
       &lt;!ATTLIST address-data-type content-type CDATA "text/vcard"
                             version CDATA "3.0"&gt;
       &lt;!-- content-type value: a MIME media type --&gt;
       &lt;!-- version value: a version string --&gt;

   Example:

       &lt;C:supported-address-data
          xmlns:C="urn:ietf:params:xml:ns:carddav"&gt;
         &lt;C:address-data-type content-type="text/vcard" version="3.0"/&gt;
       &lt;/C:supported-address-data&gt;

<span class="h4"><a class="selflink" id="section-6.2.3" href="#section-6.2.3">6.2.3</a>.  CARDDAV:max-resource-size Property</span>

   Name:  max-resource-size

   Namespace:  urn:ietf:params:xml:ns:carddav

   Purpose:  Provides a numeric value indicating the maximum size in
      octets of a resource that the server is willing to accept when an
      address object resource is stored in an address book collection.

   Value:  Any text representing a numeric value.

   Protected:  MUST be protected as it indicates limits provided by the
      server.

   COPY/MOVE behavior:  This property value MUST be preserved in COPY
      and MOVE operations.

   allprop behavior:  SHOULD NOT be returned by a PROPFIND DAV:allprop
      request.






<span class="grey">Daboo                        Standards Track                   [Page 12]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-13" ></span>
<span class="grey"><a href="./rfc6352">RFC 6352</a>                         CardDAV                     August 2011</span>


   Description:  The CARDDAV:max-resource-size is used to specify a
      numeric value that represents the maximum size in octets that the
      server is willing to accept when an address object resource is
      stored in an address book collection.  Any attempt to store an
      address book object resource exceeding this size MUST result in an
      error, with the CARDDAV:max-resource-size precondition
      (<a href="#section-6.3.2.1">Section 6.3.2.1</a>) being violated.  In the absence of this
      property, the client can assume that the server will allow storing
      a resource of any reasonable size.

   Definition:

       &lt;!ELEMENT max-resource-size (#PCDATA)&gt;
       &lt;!-- PCDATA value: a numeric value (positive decimal integer) --&gt;

   Example:

       &lt;C:max-resource-size xmlns:C="urn:ietf:params:xml:ns:carddav"
       &gt;102400&lt;/C:max-resource-size&gt;

<span class="h3"><a class="selflink" id="section-6.3" href="#section-6.3">6.3</a>.  Creating Resources</span>

   Address book collections and address object resources may be created
   by either a CardDAV client or the CardDAV server.  This specification
   defines restrictions and a data model that both clients and servers
   MUST adhere to when manipulating such address data.

<span class="h4"><a class="selflink" id="section-6.3.1" href="#section-6.3.1">6.3.1</a>.  Extended MKCOL Method</span>

   An HTTP request using the extended MKCOL method [<a href="./rfc5689" title="&quot;Extended MKCOL for Web Distributed Authoring and Versioning (WebDAV)&quot;">RFC5689</a>] can be used
   to create a new address book collection resource.  A server MAY
   restrict address book collection creation to particular collections.

   To create an address book, the client sends an extended MKCOL request
   to the server and in the body of the request sets the
   DAV:resourcetype property to the resource type for an address book
   collection as defined in <a href="#section-5.2">Section 5.2</a>.

   Support for creating address books on the server is only RECOMMENDED
   and not REQUIRED because some address book stores only support one
   address book per user (or principal), and those are typically pre-
   created for each account.  However, servers and clients are strongly
   encouraged to support address book creation whenever possible to
   allow users to create multiple address book collections to help
   organize their data better.






<span class="grey">Daboo                        Standards Track                   [Page 13]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-14" ></span>
<span class="grey"><a href="./rfc6352">RFC 6352</a>                         CardDAV                     August 2011</span>


   The DAV:displayname property can be used for a human-readable name of
   the address book.  Clients can either specify the value of the
   DAV:displayname property in the request body of the extended MKCOL
   request or, alternatively, issue a PROPPATCH request to change the
   DAV:displayname property to the appropriate value immediately after
   using the extended MKCOL request.  When displaying address book
   collections to users, clients SHOULD check the DAV:displayname
   property and use that value as the name of the address book.  In the
   event that the DAV:displayname property is not set, the client MAY
   use the last part of the address book collection URI as the name;
   however, that path segment may be "opaque" and not represent any
   meaningful human-readable text.

<span class="h5"><a class="selflink" id="section-6.3.1.1" href="#section-6.3.1.1">6.3.1.1</a>.  Example - Successful MKCOL Request</span>

   This example creates an address book collection called /home/lisa/
   addressbook/ on the server addressbook.example.com with specific
   values for the properties DAV:resourcetype, DAV:displayname, and
   CARDDAV:addressbook-description.

   &gt;&gt; Request &lt;&lt;

   MKCOL /home/lisa/addressbook/ HTTP/1.1
   Host: addressbook.example.com
   Content-Type: text/xml; charset="utf-8"
   Content-Length: xxx

   &lt;?xml version="1.0" encoding="utf-8" ?&gt;
   &lt;D:mkcol xmlns:D="DAV:"
                 xmlns:C="urn:ietf:params:xml:ns:carddav"&gt;
     &lt;D:set&gt;
       &lt;D:prop&gt;
         &lt;D:resourcetype&gt;
           &lt;D:collection/&gt;
           &lt;C:addressbook/&gt;
         &lt;/D:resourcetype&gt;
         &lt;D:displayname&gt;Lisa's Contacts&lt;/D:displayname&gt;
         &lt;C:addressbook-description xml:lang="en"
   &gt;My primary address book.&lt;/C:addressbook-description&gt;
       &lt;/D:prop&gt;
     &lt;/D:set&gt;
   &lt;/D:mkcol&gt;









<span class="grey">Daboo                        Standards Track                   [Page 14]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-15" ></span>
<span class="grey"><a href="./rfc6352">RFC 6352</a>                         CardDAV                     August 2011</span>


   &gt;&gt; Response &lt;&lt;

   HTTP/1.1 201 Created
   Cache-Control: no-cache
   Date: Sat, 11 Nov 2006 09:32:12 GMT
   Content-Type: application/xml; charset="utf-8"
   Content-Length: xxxx

   &lt;?xml version="1.0" encoding="utf-8" ?&gt;
   &lt;D:mkcol-response xmlns:D="DAV:"
                 xmlns:C="urn:ietf:params:xml:ns:carddav"&gt;
     &lt;D:propstat&gt;
       &lt;D:prop&gt;
         &lt;D:resourcetype/&gt;
         &lt;D:displayname/&gt;
         &lt;C:addressbook-description/&gt;
       &lt;/D:prop&gt;
       &lt;D:status&gt;HTTP/1.1 200 OK&lt;/D:status&gt;
     &lt;/D:propstat&gt;
   &lt;/D:mkcol-response&gt;

<span class="h4"><a class="selflink" id="section-6.3.2" href="#section-6.3.2">6.3.2</a>.  Creating Address Object Resources</span>

   Clients populate address book collections with address object
   resources.  The URL for each address object resource is entirely
   arbitrary and does not need to bear a specific relationship (but
   might) to the address object resource's vCard properties or other
   metadata.  New address object resources MUST be created with a PUT
   request targeted at an unmapped URI.  A PUT request targeted at a
   mapped URI updates an existing address object resource.

   When servers create new resources, it's not hard for the server to
   choose a unique URL.  It's slightly tougher for clients, because a
   client might not want to examine all resources in the collection and
   might not want to lock the entire collection to ensure that a new one
   isn't created with a name collision.  However, there is an HTTP
   feature to mitigate this.  If the client intends to create a new
   address resource, the client SHOULD use the HTTP header "If-None-
   Match: *" on the PUT request.  The Request-URI on the PUT request
   MUST include the target collection, where the resource is to be
   created, plus the name of the resource in the last path segment.  The
   "If-None-Match" header ensures that the client will not inadvertently
   overwrite an existing resource even if the last path segment turned
   out to already be used.







<span class="grey">Daboo                        Standards Track                   [Page 15]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-16" ></span>
<span class="grey"><a href="./rfc6352">RFC 6352</a>                         CardDAV                     August 2011</span>


   &gt;&gt; Request &lt;&lt;

   PUT /lisa/addressbook/newvcard.vcf HTTP/1.1
   If-None-Match: *
   Host: addressbook.example.com
   Content-Type: text/vcard
   Content-Length: xxx

   BEGIN:VCARD
   VERSION:3.0
   FN:Cyrus Daboo
   N:Daboo;Cyrus
   ADR;TYPE=POSTAL:;2822 Email HQ;Suite 2821;RFCVille;PA;15213;USA
   EMAIL;TYPE=INTERNET,PREF:cyrus@example.com
   NICKNAME:me
   NOTE:Example VCard.
   ORG:Self Employed
   TEL;TYPE=WORK,VOICE:412 605 0499
   TEL;TYPE=FAX:412 605 0705
   URL:http://www.example.com
   UID:1234-5678-9000-1
   END:VCARD

   &gt;&gt; Response &lt;&lt;

   HTTP/1.1 201 Created
   Date: Thu, 02 Sep 2004 16:53:32 GMT
   Content-Length: 0
   ETag: "123456789-000-111"

   The request to change an existing address object resource without
   overwriting a change made on the server uses a specific ETag in an
   "If-Match" header, rather than the "If-None-Match" header.

   File names for vCards are commonly suffixed by ".vcf", and clients
   may choose to use the same convention for URLs.

<span class="h5"><a class="selflink" id="section-6.3.2.1" href="#section-6.3.2.1">6.3.2.1</a>.  Additional Preconditions for PUT, COPY, and MOVE</span>

   This specification creates additional preconditions for the PUT,
   COPY, and MOVE methods.  These preconditions apply:

   o  When a PUT operation of an address object resource into an address
      book collection occurs.

   o  When a COPY or MOVE operation of an address object resource into
      an address book collection occurs.




<span class="grey">Daboo                        Standards Track                   [Page 16]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-17" ></span>
<span class="grey"><a href="./rfc6352">RFC 6352</a>                         CardDAV                     August 2011</span>


   The new preconditions are:

      (CARDDAV:supported-address-data): The resource submitted in the
      PUT request, or targeted by a COPY or MOVE request, MUST be a
      supported media type (i.e., vCard) for address object resources.

      (CARDDAV:valid-address-data): The resource submitted in the PUT
      request, or targeted by a COPY or MOVE request, MUST be valid data
      for the media type being specified (i.e., MUST contain valid vCard
      data).

      (CARDDAV:no-uid-conflict): The resource submitted in the PUT
      request, or targeted by a COPY or MOVE request, MUST NOT specify a
      vCard UID property value already in use in the targeted address
      book collection or overwrite an existing address object resource
      with one that has a different UID property value.  Servers SHOULD
      report the URL of the resource that is already making use of the
      same UID property value in the DAV:href element.

          &lt;!ELEMENT no-uid-conflict (DAV:href)&gt;

      (CARDDAV:addressbook-collection-location-ok): In a COPY or MOVE
      request, when the Request-URI is an address book collection, the
      URI targeted by the Destination HTTP Request header MUST identify
      a location where an address book collection can be created.

      (CARDDAV:max-resource-size): The resource submitted in the PUT
      request, or targeted by a COPY or MOVE request, MUST have a size
      in octets less than or equal to the value of the
      CARDDAV:max-resource-size property value (<a href="#section-6.2.3">Section 6.2.3</a>) on the
      address book collection where the resource will be stored.

<span class="h5"><a class="selflink" id="section-6.3.2.2" href="#section-6.3.2.2">6.3.2.2</a>.  Non-Standard vCard Properties and Parameters</span>

   vCard provides a "standard mechanism for doing non-standard things".
   This extension support allows implementers to make use of non-
   standard vCard properties and parameters whose names are prefixed
   with the text "X-".

   Servers MUST support the use of non-standard properties and
   parameters in address object resources stored via the PUT method.

   Servers may need to enforce rules for their own "private" properties
   or parameters, so servers MAY reject any attempt by the client to
   change those or use values for those outside of any restrictions the
   server may have.  A server SHOULD ensure that any "private"





<span class="grey">Daboo                        Standards Track                   [Page 17]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-18" ></span>
<span class="grey"><a href="./rfc6352">RFC 6352</a>                         CardDAV                     August 2011</span>


   properties or parameters it uses follow the convention of including a
   vendor ID in the "X-" name, as described in <a href="./rfc2426#section-3.8">Section&nbsp;3.8 of [RFC2426]</a>,
   e.g., "X-ABC-PRIVATE".

<span class="h5"><a class="selflink" id="section-6.3.2.3" href="#section-6.3.2.3">6.3.2.3</a>.  Address Object Resource Entity Tag</span>

   The DAV:getetag property MUST be defined and set to a strong entity
   tag on all address object resources.

   A response to a GET request targeted at an address object resource
   MUST contain an ETag response header field indicating the current
   value of the strong entity tag of the address object resource.

   Servers SHOULD return a strong entity tag (ETag header) in a PUT
   response when the stored address object resource is equivalent by
   octet equality to the address object resource submitted in the body
   of the PUT request.  This allows clients to reliably use the returned
   strong entity tag for data synchronization purposes.  For instance,
   the client can do a PROPFIND request on the stored address object
   resource, have the DAV:getetag property returned, compare that value
   with the strong entity tag it received on the PUT response, and know
   that if they are equal, then the address object resource on the
   server has not been changed.

   In the case where the data stored by a server as a result of a PUT
   request is not equivalent by octet equality to the submitted address
   object resource, the behavior of the ETag response header is not
   specified here, with the exception that a strong entity tag MUST NOT
   be returned in the response.  As a result, a client may need to
   retrieve the modified address object resource (and ETag) as a basis
   for further changes, rather than use the address object resource it
   had sent with the PUT request.

<span class="h2"><a class="selflink" id="section-7" href="#section-7">7</a>.  Address Book Access Control</span>

   CardDAV servers MUST support and adhere to the requirements of WebDAV
   ACL [<a href="./rfc3744" title="&quot;Web Distributed Authoring and Versioning (WebDAV) Access Control Protocol&quot;">RFC3744</a>].  WebDAV ACL provides a framework for an extensible set
   of privileges that can be applied to WebDAV collections and ordinary
   resources.

<span class="h3"><a class="selflink" id="section-7.1" href="#section-7.1">7.1</a>.  Additional Principal Properties</span>

   This section defines additional properties for WebDAV principal
   resources as defined in [<a href="./rfc3744" title="&quot;Web Distributed Authoring and Versioning (WebDAV) Access Control Protocol&quot;">RFC3744</a>].







<span class="grey">Daboo                        Standards Track                   [Page 18]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-19" ></span>
<span class="grey"><a href="./rfc6352">RFC 6352</a>                         CardDAV                     August 2011</span>


<span class="h4"><a class="selflink" id="section-7.1.1" href="#section-7.1.1">7.1.1</a>.  CARDDAV:addressbook-home-set Property</span>

   Name:  addressbook-home-set

   Namespace:  urn:ietf:params:xml:ns:carddav

   Purpose:  Identifies the URL of any WebDAV collections that contain
      address book collections owned by the associated principal
      resource.

   Protected:  MAY be protected if the server has fixed locations in
      which address books are created.

   COPY/MOVE behavior:  This property value MUST be preserved in COPY
      and MOVE operations.

   allprop behavior:  SHOULD NOT be returned by a PROPFIND DAV:allprop
      request.

   Description:  The CARDDAV:addressbook-home-set property is meant to
      allow users to easily find the address book collections owned by
      the principal.  Typically, users will group all the address book
      collections that they own under a common collection.  This
      property specifies the URL of collections that are either address
      book collections or ordinary collections that have child or
      descendant address book collections owned by the principal.

   Definition:

       &lt;!ELEMENT addressbook-home-set (DAV:href*)&gt;

   Example:

       &lt;C:addressbook-home-set xmlns:D="DAV:"
          xmlns:C="urn:ietf:params:xml:ns:carddav"&gt;
         &lt;D:href&gt;/bernard/addresses/&lt;/D:href&gt;
       &lt;/C:addressbook-home-set&gt;

<span class="h4"><a class="selflink" id="section-7.1.2" href="#section-7.1.2">7.1.2</a>.  CARDDAV:principal-address Property</span>

   Name:  principal-address

   Namespace:  urn:ietf:params:xml:ns:carddav

   Purpose:  Identifies the URL of an address object resource that
      corresponds to the user represented by the principal.





<span class="grey">Daboo                        Standards Track                   [Page 19]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-20" ></span>
<span class="grey"><a href="./rfc6352">RFC 6352</a>                         CardDAV                     August 2011</span>


   Protected:  MAY be protected if the server provides a fixed location
      for principal addresses.

   COPY/MOVE behavior:  This property value MUST be preserved in COPY
      and MOVE operations.

   allprop behavior:  SHOULD NOT be returned by a PROPFIND DAV:allprop
      request.

   Description:  The CARDDAV:principal-address property is meant to
      allow users to easily find contact information for users
      represented by principals on the system.  This property specifies
      the URL of the resource containing the corresponding contact
      information.  The resource could be an address object resource in
      an address book collection, or it could be a resource in a
      "regular" collection.

   Definition:

       &lt;!ELEMENT principal-address (DAV:href)&gt;

   Example:

       &lt;C:principal-address xmlns:D="DAV:"
          xmlns:C="urn:ietf:params:xml:ns:carddav"&gt;
          &lt;D:href&gt;/system/cyrus.vcf&lt;/D:href&gt;
       &lt;/C:principal-address&gt;

<span class="h2"><a class="selflink" id="section-8" href="#section-8">8</a>.  Address Book Reports</span>

   This section defines the reports that CardDAV servers MUST support on
   address book collections and address object resources.

   CardDAV servers MUST advertise support for these reports on all
   address book collections and address object resources with the
   DAV:supported-report-set property defined in <a href="./rfc3253#section-3.1.5">Section&nbsp;3.1.5 of
   [RFC3253]</a>.  CardDAV servers MAY also advertise support for these
   reports on ordinary collections.

   Some of these reports allow address data (from possibly multiple
   resources) to be returned.

<span class="h3"><a class="selflink" id="section-8.1" href="#section-8.1">8.1</a>.  REPORT Method</span>

   The REPORT method (defined in <a href="./rfc3253#section-3.6">Section&nbsp;3.6 of [RFC3253]</a>) provides an
   extensible mechanism for obtaining information about a resource.
   Unlike the PROPFIND method, which returns the value of one or more
   named properties, the REPORT method can involve more complex



<span class="grey">Daboo                        Standards Track                   [Page 20]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-21" ></span>
<span class="grey"><a href="./rfc6352">RFC 6352</a>                         CardDAV                     August 2011</span>


   processing.  REPORT is valuable in cases where the server has access
   to all of the information needed to perform the complex request (such
   as a query), and where it would require multiple requests for the
   client to retrieve the information needed to perform the same
   request.

   A server that supports this specification MUST support the
   DAV:expand-property report (defined in <a href="./rfc3253#section-3.8">Section&nbsp;3.8 of [RFC3253]</a>).

<span class="h3"><a class="selflink" id="section-8.2" href="#section-8.2">8.2</a>.  Ordinary Collections</span>

   Servers MAY support the reports defined in this document on ordinary
   collections (collections that are not address book collections) in
   addition to address book collections or address object resources.  In
   computing responses to the reports on ordinary collections, servers
   MUST only consider address object resources contained in address book
   collections that are targeted by the REPORT based on the value of the
   Depth request header.

<span class="h3"><a class="selflink" id="section-8.3" href="#section-8.3">8.3</a>.  Searching Text: Collations</span>

   Some of the reports defined in this section do text matches of
   character strings provided by the client and compared to stored
   address data.  Since vCard data is by default encoded in the UTF-8
   charset and may include characters outside of the US-ASCII charset
   range in some property and parameter values, there is a need to
   ensure that text matching follows well-defined rules.

   To deal with this, this specification makes use of the IANA Collation
   Registry defined in [<a href="./rfc4790" title="&quot;Internet Application Protocol Collation Registry&quot;">RFC4790</a>] to specify collations that may be used
   to carry out the text comparison operations with a well-defined rule.

   Collations supported by the server MUST support "equality" and
   "substring" match operations as per <a href="./rfc4790#section-4.2">[RFC4790], Section&nbsp;4.2</a>, including
   the "prefix" and "suffix" options for "substring" matching.  CardDAV
   uses these match options for "equals", "contains", "starts-with", and
   "ends-with" match operations.

   CardDAV servers are REQUIRED to support the "i;ascii-casemap"
   [<a href="./rfc4790" title="&quot;Internet Application Protocol Collation Registry&quot;">RFC4790</a>] and "i;unicode-casemap" [<a href="./rfc5051" title="&quot;i;unicode-casemap - Simple Unicode Collation Algorithm&quot;">RFC5051</a>] collations and MAY
   support other collations.

   Servers MUST advertise the set of collations that they support via
   the CARDDAV:supported-collation-set property defined on any resource
   that supports reports that use collations.






<span class="grey">Daboo                        Standards Track                   [Page 21]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-22" ></span>
<span class="grey"><a href="./rfc6352">RFC 6352</a>                         CardDAV                     August 2011</span>


   In the absence of a collation explicitly specified by the client, or
   if the client specifies the "default" collation identifier (as
   defined in <a href="./rfc4790#section-3.1">[RFC4790], Section&nbsp;3.1</a>), the server MUST default to using
   "i;unicode-casemap" as the collation.

   Wildcards (as defined in <a href="./rfc4790#section-3.2">[RFC4790], Section&nbsp;3.2</a>) MUST NOT be used in
   the collation identifier.

   If the client chooses a collation not supported by the server, the
   server MUST respond with a CARDDAV:supported-collation precondition
   error response.

<span class="h4"><a class="selflink" id="section-8.3.1" href="#section-8.3.1">8.3.1</a>.  CARDDAV:supported-collation-set Property</span>

   Name:  supported-collation-set

   Namespace:  urn:ietf:params:xml:ns:carddav

   Purpose:  Identifies the set of collations supported by the server
      for text matching operations.

   Protected:  MUST be protected as it indicates support provided by the
      server.

   COPY/MOVE behavior:  This property value MUST be preserved in COPY
      and MOVE operations.

   allprop behavior:  SHOULD NOT be returned by a PROPFIND DAV:allprop
      request.

   Description:  The CARDDAV:supported-collation-set property contains
      two or more CARDDAV:supported-collation elements that specify the
      identifiers of the collations supported by the server.

   Definition:

         &lt;!ELEMENT supported-collation-set (
               supported-collation
               supported-collation
               supported-collation*)&gt;
         &lt;!-- Both "i;ascii-casemap" and "i;unicode-casemap"
              will be present --&gt;

         &lt;!ELEMENT supported-collation (#PCDATA)&gt;







<span class="grey">Daboo                        Standards Track                   [Page 22]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-23" ></span>
<span class="grey"><a href="./rfc6352">RFC 6352</a>                         CardDAV                     August 2011</span>


   Example:

      &lt;C:supported-collation-set
        xmlns:C="urn:ietf:params:xml:ns:carddav"&gt;
        &lt;C:supported-collation&gt;i;ascii-casemap&lt;/C:supported-collation&gt;
        &lt;C:supported-collation&gt;i;octet&lt;/C:supported-collation&gt;
        &lt;C:supported-collation&gt;i;unicode-casemap&lt;/C:supported-collation&gt;
      &lt;/C:supported-collation-set&gt;

<span class="h3"><a class="selflink" id="section-8.4" href="#section-8.4">8.4</a>.  Partial Retrieval</span>

   Some address book reports defined in this document allow partial
   retrieval of address object resources.  A CardDAV client can specify
   what information to return in the body of an address book REPORT
   request.

   A CardDAV client can request particular WebDAV property values, all
   WebDAV property values, or a list of the names of the resource's
   WebDAV properties.  A CardDAV client can also request address data to
   be returned and whether all vCard properties should be returned or
   only particular ones.  See CARDDAV:address-data in <a href="#section-10.4">Section 10.4</a>.

<span class="h3"><a class="selflink" id="section-8.5" href="#section-8.5">8.5</a>.  Non-Standard Properties and Parameters</span>

   Servers MUST support the use of non-standard vCard property or
   parameter names in the CARDDAV:address-data XML element in address
   book REPORT requests to allow clients to request that non-standard
   properties and parameters be returned in the address data provided in
   the response.

   Servers MAY support the use of non-standard vCard property or
   parameter names in the CARDDAV:prop-filter and CARDDAV:param-filter
   XML elements specified in the CARDDAV:filter XML element of address
   book REPORT requests.

   Servers MUST fail with the CARDDAV:supported-filter precondition if
   an address book REPORT request uses a CARDDAV:prop-filter or
   CARDDAV:param-filter XML element that makes reference to a non-
   standard vCard property or parameter name on which the server does
   not support queries.

<span class="h3"><a class="selflink" id="section-8.6" href="#section-8.6">8.6</a>.  CARDDAV:addressbook-query Report</span>

   The CARDDAV:addressbook-query REPORT performs a search for all
   address object resources that match a specified filter.  The response
   of this report will contain all the WebDAV properties and address
   object resource data specified in the request.  In the case of the




<span class="grey">Daboo                        Standards Track                   [Page 23]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-24" ></span>
<span class="grey"><a href="./rfc6352">RFC 6352</a>                         CardDAV                     August 2011</span>


   CARDDAV:address-data XML element, one can explicitly specify the
   vCard properties that should be returned in the address object
   resource data that matches the filter.

   The format of this report is modeled on the PROPFIND method.  The
   request and response bodies of the CARDDAV:addressbook-query report
   use XML elements that are also used by PROPFIND.  In particular, the
   request can include XML elements to request WebDAV properties to be
   returned.  When that occurs, the response should follow the same
   behavior as PROPFIND with respect to the DAV:multistatus response
   elements used to return specific WebDAV property results.  For
   instance, a request to retrieve the value of a WebDAV property that
   does not exist is an error and MUST be noted with a response XML
   element that contains a 404 (Not Found) status value.

   Support for the CARDDAV:addressbook-query REPORT is REQUIRED.

   Marshalling:

      The request body MUST be a CARDDAV:addressbook-query XML element
      as defined in <a href="#section-10.3">Section 10.3</a>.

      The request MUST include a Depth header.  The scope of the query
      is determined by the value of the Depth header.  For example, to
      query all address object resources in an address book collection,
      the REPORT would use the address book collection as the Request-
      URI and specify a Depth of 1 or infinity.

      The response body for a successful request MUST be a
      DAV:multistatus XML element (i.e., the response uses the same
      format as the response for PROPFIND).  In the case where there are
      no response elements, the returned DAV:multistatus XML element is
      empty.

      The response body for a successful CARDDAV:addressbook-query
      REPORT request MUST contain a DAV:response element for each
      address object that matched the search filter.  Address data is
      returned in the CARDDAV:address-data XML element inside the
      DAV:propstat XML element.

   Preconditions:

      (CARDDAV:supported-address-data): The attributes "content-type"
      and "version" of the CARDDAV:address-data XML element (see
      <a href="#section-10.4">Section 10.4</a>) specify a media type supported by the server for
      address object resources.





<span class="grey">Daboo                        Standards Track                   [Page 24]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-25" ></span>
<span class="grey"><a href="./rfc6352">RFC 6352</a>                         CardDAV                     August 2011</span>


      (CARDDAV:supported-filter): The CARDDAV:prop-filter (see
      <a href="#section-10.5.1">Section 10.5.1</a>) and CARDDAV:param-filter (see <a href="#section-10.5.2">Section 10.5.2</a>) XML
      elements used in the CARDDAV:filter XML element (see <a href="#section-10.5">Section 10.5</a>)
      in the REPORT request only make reference to vCard properties and
      parameters for which queries are supported by the server.  That
      is, if the CARDDAV:filter element attempts to reference an
      unsupported vCard property or parameter, this precondition is
      violated.  A server SHOULD report the CARDDAV:prop-filter or
      CARDDAV:param-filter for which it does not provide support.

          &lt;!ELEMENT supported-filter (prop-filter*,
                                      param-filter*)&gt;

      (CARDDAV:supported-collation): Any XML attribute specifying a
      collation MUST specify a collation supported by the server as
      described in <a href="#section-8.3">Section 8.3</a>.

   Postconditions:

      (DAV:number-of-matches-within-limits): The number of matching
      address object resources must fall within server-specific,
      predefined limits.  For example, this condition might be triggered
      if a search specification would cause the return of an extremely
      large number of responses.

<span class="h4"><a class="selflink" id="section-8.6.1" href="#section-8.6.1">8.6.1</a>.  Limiting Results</span>

   A client can limit the number of results returned by the server
   through use of the CARDDAV:limit element in the request body.  This
   is useful when clients are only interested in a few matches or only
   have limited space to display results to users and thus don't need
   the overhead of receiving more than that.  When the results are
   truncated by the server, the server MUST follow the rules below for
   indicating a result set truncation to the client.

<span class="h4"><a class="selflink" id="section-8.6.2" href="#section-8.6.2">8.6.2</a>.  Truncation of Results</span>

   A server MAY limit the number of resources in a response, for
   example, to limit the amount of work expended in processing a query,
   or as the result of an explicit limit set by the client.  If the
   result set is truncated because of such a limit, the response MUST
   use status code 207 (Multi-Status), return a DAV:multistatus response
   body, and indicate a status of 507 (Insufficient Storage) for the
   Request-URI.  That DAV:response element SHOULD include a DAV:error
   element with the DAV:number-of-matches-within-limits precondition, as
   defined in <a href="./rfc3744#section-9.2">[RFC3744], Section&nbsp;9.2</a>.





<span class="grey">Daboo                        Standards Track                   [Page 25]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-26" ></span>
<span class="grey"><a href="./rfc6352">RFC 6352</a>                         CardDAV                     August 2011</span>


   The server SHOULD also include the partial results in additional
   DAV:response elements.  If a client-requested limit is being applied,
   the 507 response for the Request-URI MUST NOT be included in
   calculating the limit (e.g., if the client requests that only a
   single result be returned, and multiple matches are present, then the
   DAV:multistatus response will include one DAV:response for the
   matching resource and one DAV:response for the 507 status on the
   Request-URI).

<span class="h4"><a class="selflink" id="section-8.6.3" href="#section-8.6.3">8.6.3</a>.  Example: Partial Retrieval of vCards Matching NICKNAME</span>

   In this example, the client requests that the server search for
   address object resources that contain a NICKNAME property whose value
   equals some specific text and return specific vCard properties for
   those vCards found.  In addition, the DAV:getetag property is also
   requested and returned as part of the response.

   &gt;&gt; Request &lt;&lt;

   REPORT /home/bernard/addressbook/ HTTP/1.1
   Host: addressbook.example.com
   Depth: 1
   Content-Type: text/xml; charset="utf-8"
   Content-Length: xxxx

   &lt;?xml version="1.0" encoding="utf-8" ?&gt;
   &lt;C:addressbook-query xmlns:D="DAV:"
                     xmlns:C="urn:ietf:params:xml:ns:carddav"&gt;
     &lt;D:prop&gt;
       &lt;D:getetag/&gt;
       &lt;C:address-data&gt;
         &lt;C:prop name="VERSION"/&gt;
         &lt;C:prop name="UID"/&gt;
         &lt;C:prop name="NICKNAME"/&gt;
         &lt;C:prop name="EMAIL"/&gt;
         &lt;C:prop name="FN"/&gt;
       &lt;/C:address-data&gt;
     &lt;/D:prop&gt;
     &lt;C:filter&gt;
       &lt;C:prop-filter name="NICKNAME"&gt;
         &lt;C:text-match collation="i;unicode-casemap"
                       match-type="equals"
         &gt;me&lt;/C:text-match&gt;
       &lt;/C:prop-filter&gt;
     &lt;/C:filter&gt;
   &lt;/C:addressbook-query&gt;





<span class="grey">Daboo                        Standards Track                   [Page 26]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-27" ></span>
<span class="grey"><a href="./rfc6352">RFC 6352</a>                         CardDAV                     August 2011</span>


   &gt;&gt; Response &lt;&lt;

   HTTP/1.1 207 Multi-Status
   Date: Sat, 11 Nov 2006 09:32:12 GMT
   Content-Type: text/xml; charset="utf-8"
   Content-Length: xxxx

   &lt;?xml version="1.0" encoding="utf-8" ?&gt;
   &lt;D:multistatus xmlns:D="DAV:"
                  xmlns:C="urn:ietf:params:xml:ns:carddav"&gt;
     &lt;D:response&gt;
       &lt;D:href&gt;/home/bernard/addressbook/v102.vcf&lt;/D:href&gt;
       &lt;D:propstat&gt;
         &lt;D:prop&gt;
           &lt;D:getetag&gt;"23ba4d-ff11fb"&lt;/D:getetag&gt;
           &lt;C:address-data&gt;BEGIN:VCARD
   VERSION:3.0
   NICKNAME:me
   UID:34222-232@example.com
   FN:Cyrus Daboo
   EMAIL:daboo@example.com
   END:VCARD
   &lt;/C:address-data&gt;
         &lt;/D:prop&gt;
         &lt;D:status&gt;HTTP/1.1 200 OK&lt;/D:status&gt;
       &lt;/D:propstat&gt;
     &lt;/D:response&gt;
   &lt;/D:multistatus&gt;

<span class="h4"><a class="selflink" id="section-8.6.4" href="#section-8.6.4">8.6.4</a>.  Example: Partial Retrieval of vCards Matching a Full Name or</span>
<span class="h4">        Email Address</span>

   In this example, the client requests that the server search for
   address object resources that contain a FN property whose value
   contains some specific text or that contain an EMAIL property whose
   value contains other text and return specific vCard properties for
   those vCards found.  In addition, the DAV:getetag property is also
   requested and returned as part of the response.

   &gt;&gt; Request &lt;&lt;

   REPORT /home/bernard/addressbook/ HTTP/1.1
   Host: addressbook.example.com
   Depth: 1
   Content-Type: text/xml; charset="utf-8"
   Content-Length: xxxx





<span class="grey">Daboo                        Standards Track                   [Page 27]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-28" ></span>
<span class="grey"><a href="./rfc6352">RFC 6352</a>                         CardDAV                     August 2011</span>


   &lt;?xml version="1.0" encoding="utf-8" ?&gt;
   &lt;C:addressbook-query xmlns:D="DAV:"
                     xmlns:C="urn:ietf:params:xml:ns:carddav"&gt;
     &lt;D:prop&gt;
       &lt;D:getetag/&gt;
       &lt;C:address-data&gt;
         &lt;C:prop name="VERSION"/&gt;
         &lt;C:prop name="UID"/&gt;
         &lt;C:prop name="NICKNAME"/&gt;
         &lt;C:prop name="EMAIL"/&gt;
         &lt;C:prop name="FN"/&gt;
       &lt;/C:address-data&gt;
     &lt;/D:prop&gt;
     &lt;C:filter test="anyof"&gt;
       &lt;C:prop-filter name="FN"&gt;
         &lt;C:text-match collation="i;unicode-casemap"
                       match-type="contains"
         &gt;daboo&lt;/C:text-match&gt;
       &lt;/C:prop-filter&gt;
       &lt;C:prop-filter name="EMAIL"&gt;
         &lt;C:text-match collation="i;unicode-casemap"
                       match-type="contains"
         &gt;daboo&lt;/C:text-match&gt;
       &lt;/C:prop-filter&gt;
     &lt;/C:filter&gt;
   &lt;/C:addressbook-query&gt;

   &gt;&gt; Response &lt;&lt;

   HTTP/1.1 207 Multi-Status
   Date: Sat, 11 Nov 2006 09:32:12 GMT
   Content-Type: text/xml; charset="utf-8"
   Content-Length: xxxx

   &lt;?xml version="1.0" encoding="utf-8" ?&gt;
   &lt;D:multistatus xmlns:D="DAV:"
                  xmlns:C="urn:ietf:params:xml:ns:carddav"&gt;
     &lt;D:response&gt;
       &lt;D:href&gt;/home/bernard/addressbook/v102.vcf&lt;/D:href&gt;
       &lt;D:propstat&gt;
         &lt;D:prop&gt;
           &lt;D:getetag&gt;"23ba4d-ff11fb"&lt;/D:getetag&gt;
           &lt;C:address-data&gt;BEGIN:VCARD
   VERSION:3.0
   NICKNAME:me
   UID:34222-232@example.com
   FN:David Boo
   EMAIL:daboo@example.com



<span class="grey">Daboo                        Standards Track                   [Page 28]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-29" ></span>
<span class="grey"><a href="./rfc6352">RFC 6352</a>                         CardDAV                     August 2011</span>


   END:VCARD
   &lt;/C:address-data&gt;
         &lt;/D:prop&gt;
         &lt;D:status&gt;HTTP/1.1 200 OK&lt;/D:status&gt;
       &lt;/D:propstat&gt;
     &lt;/D:response&gt;
     &lt;D:response&gt;
       &lt;D:href&gt;/home/bernard/addressbook/v104.vcf&lt;/D:href&gt;
       &lt;D:propstat&gt;
         &lt;D:prop&gt;
           &lt;D:getetag&gt;"23ba4d-ff11fc"&lt;/D:getetag&gt;
           &lt;C:address-data&gt;BEGIN:VCARD
   VERSION:3.0
   NICKNAME:oliver
   UID:34222-23222@example.com
   FN:Oliver Daboo
   EMAIL:oliver@example.com
   END:VCARD
   &lt;/C:address-data&gt;
         &lt;/D:prop&gt;
         &lt;D:status&gt;HTTP/1.1 200 OK&lt;/D:status&gt;
       &lt;/D:propstat&gt;
     &lt;/D:response&gt;
   &lt;/D:multistatus&gt;

<span class="h4"><a class="selflink" id="section-8.6.5" href="#section-8.6.5">8.6.5</a>.  Example: Truncated Results</span>

   In this example, the client requests that the server search for
   address object resources that contain a FN property whose value
   contains some specific text and return the DAV:getetag property for
   two results only.  The server response includes a 507 status for the
   Request-URI indicating that there were more than two resources that
   matched the query, but that the server truncated the result set as
   requested by the client.

   &gt;&gt; Request &lt;&lt;

   REPORT /home/bernard/addressbook/ HTTP/1.1
   Host: addressbook.example.com
   Depth: 1
   Content-Type: text/xml; charset="utf-8"
   Content-Length: xxxx

   &lt;?xml version="1.0" encoding="utf-8" ?&gt;
   &lt;C:addressbook-query xmlns:D="DAV:"
                     xmlns:C="urn:ietf:params:xml:ns:carddav"&gt;





<span class="grey">Daboo                        Standards Track                   [Page 29]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-30" ></span>
<span class="grey"><a href="./rfc6352">RFC 6352</a>                         CardDAV                     August 2011</span>


     &lt;D:prop&gt;
       &lt;D:getetag/&gt;
     &lt;/D:prop&gt;
     &lt;C:filter test="anyof"&gt;
       &lt;C:prop-filter name="FN"&gt;
         &lt;C:text-match collation="i;unicode-casemap"
                       match-type="contains"
         &gt;daboo&lt;/C:text-match&gt;
       &lt;/C:prop-filter&gt;
     &lt;/C:filter&gt;
     &lt;C:limit&gt;
       &lt;C:nresults&gt;2&lt;/C:nresults&gt;
     &lt;/C:limit&gt;
   &lt;/C:addressbook-query&gt;

   &gt;&gt; Response &lt;&lt;

   HTTP/1.1 207 Multi-Status
   Date: Sat, 11 Nov 2006 09:32:12 GMT
   Content-Type: text/xml; charset="utf-8"
   Content-Length: xxxx

   &lt;?xml version="1.0" encoding="utf-8" ?&gt;
   &lt;D:multistatus xmlns:D="DAV:"
                  xmlns:C="urn:ietf:params:xml:ns:carddav"&gt;
     &lt;D:response&gt;
       &lt;D:href&gt;/home/bernard/addressbook/&lt;/D:href&gt;
       &lt;D:status&gt;HTTP/1.1 507 Insufficient Storage&lt;/D:status&gt;
       &lt;D:error&gt;&lt;D:number-of-matches-within-limits/&gt;&lt;/D:error&gt;
       &lt;D:responsedescription xml:lang="en"&gt;
         Only two matching records were returned
       &lt;/D:responsedescription&gt;
     &lt;/D:response&gt;
     &lt;D:response&gt;
       &lt;D:href&gt;/home/bernard/addressbook/v102.vcf&lt;/D:href&gt;
       &lt;D:propstat&gt;
         &lt;D:prop&gt;
           &lt;D:getetag&gt;"23ba4d-ff11fb"&lt;/D:getetag&gt;
         &lt;/D:prop&gt;
         &lt;D:status&gt;HTTP/1.1 200 OK&lt;/D:status&gt;
       &lt;/D:propstat&gt;
     &lt;/D:response&gt;
     &lt;D:response&gt;
       &lt;D:href&gt;/home/bernard/addressbook/v104.vcf&lt;/D:href&gt;
       &lt;D:propstat&gt;
         &lt;D:prop&gt;
           &lt;D:getetag&gt;"23ba4d-ff11fc"&lt;/D:getetag&gt;
         &lt;/D:prop&gt;



<span class="grey">Daboo                        Standards Track                   [Page 30]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-31" ></span>
<span class="grey"><a href="./rfc6352">RFC 6352</a>                         CardDAV                     August 2011</span>


         &lt;D:status&gt;HTTP/1.1 200 OK&lt;/D:status&gt;
       &lt;/D:propstat&gt;
     &lt;/D:response&gt;
   &lt;/D:multistatus&gt;

<span class="h3"><a class="selflink" id="section-8.7" href="#section-8.7">8.7</a>.  CARDDAV:addressbook-multiget Report</span>

   The CARDDAV:addressbook-multiget REPORT is used to retrieve specific
   address object resources from within a collection, if the Request-URI
   is a collection, or to retrieve a specific address object resource,
   if the Request-URI is an address object resource.  This report is
   similar to the CARDDAV:addressbook-query REPORT (see <a href="#section-8.6">Section 8.6</a>),
   except that it takes a list of DAV:href elements instead of a
   CARDDAV:filter element to determine which address object resources to
   return.

   Support for the addressbook-multiget REPORT is REQUIRED.

   Marshalling:

      The request body MUST be a CARDDAV:addressbook-multiget XML
      element (see <a href="#section-10.7">Section 10.7</a>), which MUST contain at least one
      DAV:href XML element and one optional CARDDAV:address-data element
      as defined in <a href="#section-10.4">Section 10.4</a>.  If DAV:href elements are present, the
      scope of the request is the set of resources identified by these
      elements, which all need to be members (not necessarily internal
      members) of the resource identified by the Request-URI.
      Otherwise, the scope is the resource identified by the Request-URI
      itself.

      The request MUST include a Depth: 0 header; however, the actual
      scope of the REPORT is determined as described above.

      The response body for a successful request MUST be a
      DAV:multistatus XML element.

      The response body for a successful CARDDAV:addressbook-multiget
      REPORT request MUST contain a DAV:response element for each
      address object resource referenced by the provided set of DAV:href
      elements.  Address data is returned in the CARDDAV:address-data
      element inside the DAV:prop element.

      In the case of an error accessing any of the provided DAV:href
      resources, the server MUST return the appropriate error status
      code in the DAV:status element of the corresponding DAV:response
      element.





<span class="grey">Daboo                        Standards Track                   [Page 31]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-32" ></span>
<span class="grey"><a href="./rfc6352">RFC 6352</a>                         CardDAV                     August 2011</span>


   Preconditions:

      (CARDDAV:supported-address-data): The attributes "content-type"
      and "version" of the CARDDAV:address-data XML elements (see
      <a href="#section-10.4">Section 10.4</a>) specify a media type supported by the server for
      address object resources.

   Postconditions:

      None.

<span class="h4"><a class="selflink" id="section-8.7.1" href="#section-8.7.1">8.7.1</a>.  Example: CARDDAV:addressbook-multiget Report</span>

   In this example, the client requests the server to return specific
   vCard properties of the address components referenced by specific
   URIs.  In addition, the DAV:getetag property is also requested and
   returned as part of the response.  Note that, in this example, the
   resource at
   http://addressbook.example.com/home/bernard/addressbook/vcf1.vcf does
   not exist, resulting in an error status response.

   &gt;&gt; Request &lt;&lt;

   REPORT /home/bernard/addressbook/ HTTP/1.1
   Host: addressbook.example.com
   Depth: 1
   Content-Type: text/xml; charset="utf-8"
   Content-Length: xxxx

   &lt;?xml version="1.0" encoding="utf-8" ?&gt;
   &lt;C:addressbook-multiget xmlns:D="DAV:"
                        xmlns:C="urn:ietf:params:xml:ns:carddav"&gt;
     &lt;D:prop&gt;
       &lt;D:getetag/&gt;
       &lt;C:address-data&gt;
         &lt;C:prop name="VERSION"/&gt;
         &lt;C:prop name="UID"/&gt;
         &lt;C:prop name="NICKNAME"/&gt;
         &lt;C:prop name="EMAIL"/&gt;
         &lt;C:prop name="FN"/&gt;
       &lt;/C:address-data&gt;
     &lt;/D:prop&gt;
     &lt;D:href&gt;/home/bernard/addressbook/vcf102.vcf&lt;/D:href&gt;
     &lt;D:href&gt;/home/bernard/addressbook/vcf1.vcf&lt;/D:href&gt;
   &lt;/C:addressbook-multiget&gt;






<span class="grey">Daboo                        Standards Track                   [Page 32]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-33" ></span>
<span class="grey"><a href="./rfc6352">RFC 6352</a>                         CardDAV                     August 2011</span>


   &gt;&gt; Response &lt;&lt;

   HTTP/1.1 207 Multi-Status
   Date: Sat, 11 Nov 2006 09:32:12 GMT
   Content-Type: text/xml; charset="utf-8"
   Content-Length: xxxx

   &lt;?xml version="1.0" encoding="utf-8" ?&gt;
   &lt;D:multistatus xmlns:D="DAV:"
                  xmlns:C="urn:ietf:params:xml:ns:carddav"&gt;
     &lt;D:response&gt;
       &lt;D:href&gt;/home/bernard/addressbook/vcf102.vcf&lt;/D:href&gt;
       &lt;D:propstat&gt;
         &lt;D:prop&gt;
           &lt;D:getetag&gt;"23ba4d-ff11fb"&lt;/D:getetag&gt;
           &lt;C:address-data&gt;BEGIN:VCARD
   VERSION:3.0
   NICKNAME:me
   UID:34222-232@example.com
   FN:Cyrus Daboo
   EMAIL:daboo@example.com
   END:VCARD
   &lt;/C:address-data&gt;
         &lt;/D:prop&gt;
         &lt;D:status&gt;HTTP/1.1 200 OK&lt;/D:status&gt;
       &lt;/D:propstat&gt;
     &lt;/D:response&gt;
     &lt;D:response&gt;
       &lt;D:href&gt;/home/bernard/addressbook/vcf1.vcf&lt;/D:href&gt;
       &lt;D:status&gt;HTTP/1.1 404 Resource not found&lt;/D:status&gt;
     &lt;/D:response&gt;
   &lt;/D:multistatus&gt;

<span class="h4"><a class="selflink" id="section-8.7.2" href="#section-8.7.2">8.7.2</a>.  Example: CARDDAV:addressbook-multiget Report</span>

   In this example, the client requests the server to return vCard v4.0
   data of the address components referenced by specific URIs.  In
   addition, the DAV:getetag property is also requested and returned as
   part of the response.  Note that, in this example, the resource at
   http://addressbook.example.com/home/bernard/addressbook/vcf3.vcf
   exists but in a media type format that the server is unable to
   convert, resulting in an error status response.









<span class="grey">Daboo                        Standards Track                   [Page 33]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-34" ></span>
<span class="grey"><a href="./rfc6352">RFC 6352</a>                         CardDAV                     August 2011</span>


   &gt;&gt; Request &lt;&lt;

   REPORT /home/bernard/addressbook/ HTTP/1.1
   Host: addressbook.example.com
   Depth: 1
   Content-Type: text/xml; charset="utf-8"
   Content-Length: xxxx

   &lt;?xml version="1.0" encoding="utf-8" ?&gt;
   &lt;C:addressbook-multiget xmlns:D="DAV:"
                        xmlns:C="urn:ietf:params:xml:ns:carddav"&gt;
     &lt;D:prop&gt;
       &lt;D:getetag/&gt;
       &lt;C:address-data content-type='text/vcard' version='4.0'/&gt;
     &lt;/D:prop&gt;
     &lt;D:href&gt;/home/bernard/addressbook/vcf3.vcf&lt;/D:href&gt;
   &lt;/C:addressbook-multiget&gt;

   &gt;&gt; Response &lt;&lt;

   HTTP/1.1 207 Multi-Status
   Date: Sat, 11 Nov 2006 09:32:12 GMT
   Content-Type: text/xml; charset="utf-8"
   Content-Length: xxxx

   &lt;?xml version="1.0" encoding="utf-8" ?&gt;
   &lt;D:multistatus xmlns:D="DAV:"
                  xmlns:C="urn:ietf:params:xml:ns:carddav"&gt;
     &lt;D:response&gt;
       &lt;D:href&gt;/home/bernard/addressbook/vcf3.vcf&lt;/D:href&gt;
       &lt;D:status&gt;HTTP/1.1 415 Unsupported Media Type&lt;/D:status&gt;
       &lt;D:error&gt;&lt;C:supported-address-data-conversion/&gt;&lt;/D:error&gt;
       &lt;D:responsedescription&gt;Unable to convert from vCard v3.0
       to vCard v4.0&lt;/D:responsedescription&gt;
     &lt;/D:response&gt;
   &lt;/D:multistatus&gt;

<span class="h2"><a class="selflink" id="section-9" href="#section-9">9</a>.  Client Guidelines</span>

<span class="h3"><a class="selflink" id="section-9.1" href="#section-9.1">9.1</a>.  Restrict the Properties Returned</span>

   Clients may not need all the properties in a vCard object when
   presenting information to the user, or looking up specific items for
   their email address, for example.  Since some property data can be
   large (e.g., PHOTO or SOUND with in-line content) clients can choose
   to ignore those by only requesting the specific items it knows it
   will use, through use of the CARDDAV:address-data XML element in the
   relevant reports.



<span class="grey">Daboo                        Standards Track                   [Page 34]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-35" ></span>
<span class="grey"><a href="./rfc6352">RFC 6352</a>                         CardDAV                     August 2011</span>


   However, if a client needs to make a change to a vCard, it can only
   change the entire vCard data via a PUT request.  There is no way to
   incrementally make a change to a set of properties within a vCard
   object resource.  As a result, the client will have to cache the
   entire set of properties on a resource that is being changed.

<span class="h3"><a class="selflink" id="section-9.2" href="#section-9.2">9.2</a>.  Avoiding Lost Updates</span>

   When resources are accessed by multiple clients, the possibility of
   clients overwriting each other's changes exists.  To alleviate this,
   clients SHOULD use the If-Match request header on PUT requests with
   the ETag of the previously retrieved resource data to check whether
   the resource was modified since it was previously retrieved.  If a
   precondition failure occurs, clients need to reload the resource and
   go through their own merge or conflict resolution process before
   writing back the data (again using the If-Match check).

<span class="h3"><a class="selflink" id="section-9.3" href="#section-9.3">9.3</a>.  Client Configuration</span>

   When CardDAV clients need to be configured, the key piece of
   information that they require is the principal-URL of the user whose
   address book information is desired.  Servers SHOULD support the
   DAV:current-user-principal-URL property as defined in [<a href="./rfc5397" title="&quot;WebDAV Current Principal Extension&quot;">RFC5397</a>] to
   give clients a fast way to locate user principals.

   Given support for SRV records (<a href="#section-11">Section 11</a>) and DAV:current-user-
   principal-URL [<a href="./rfc5397" title="&quot;WebDAV Current Principal Extension&quot;">RFC5397</a>], users only need enter a user identifier,
   host name, and password to configure their client.  The client would
   take the host name and do an SRV lookup to locate the CardDAV server,
   then execute an authenticated PROPFIND on the root/resource looking
   for the DAV:current-user-principal-URL property.  The value returned
   gives the client direct access to the user's principal-URL and from
   there all the related CardDAV properties needed to locate address
   books.

<span class="h3"><a class="selflink" id="section-9.4" href="#section-9.4">9.4</a>.  Finding Other Users' Address Books</span>

   For use cases of address book sharing, one might wish to find the
   address book belonging to another user.  To find other users' address
   books on the same server, the DAV:principal-property-search REPORT
   [<a href="./rfc3744" title="&quot;Web Distributed Authoring and Versioning (WebDAV) Access Control Protocol&quot;">RFC3744</a>] can be used to search principals for matching properties
   and return specified properties for the matching principal resources.
   To search for an address book owned by a user named "Laurie", the
   REPORT request body would look like this:







<span class="grey">Daboo                        Standards Track                   [Page 35]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-36" ></span>
<span class="grey"><a href="./rfc6352">RFC 6352</a>                         CardDAV                     August 2011</span>


   &lt;?xml version="1.0" encoding="utf-8" ?&gt;
   &lt;D:principal-property-search xmlns:D="DAV:"&gt;
     &lt;D:property-search&gt;
       &lt;D:prop&gt;
         &lt;D:displayname/&gt;
       &lt;/D:prop&gt;
       &lt;D:match&gt;Laurie&lt;/D:match&gt;
     &lt;/D:property-search&gt;
     &lt;D:prop&gt;
       &lt;C:addressbook-home-set
          xmlns:C="urn:ietf:params:xml:ns:carddav"/&gt;
       &lt;D:displayname/&gt;
     &lt;/D:prop&gt;
   &lt;/D:principal-property-search&gt;

   The server performs a case-sensitive or caseless search for a
   matching string subset of "Laurie" within the DAV:displayname
   property.  Thus, the server might return "Laurie Dusseault", "Laurier
   Desruisseaux", or "Wilfrid Laurier" all as matching DAV:displayname
   values, and the address books for each of these.

<span class="h2"><a class="selflink" id="section-10" href="#section-10">10</a>.  XML Element Definitions</span>

<span class="h3"><a class="selflink" id="section-10.1" href="#section-10.1">10.1</a>.  CARDDAV:addressbook XML Element</span>

   Name:  addressbook

   Namespace:  urn:ietf:params:xml:ns:carddav

   Purpose:  Specifies the resource type of an address book collection.

   Description:  See <a href="#section-5.2">Section 5.2</a>.

   Definition:

       &lt;!ELEMENT addressbook EMPTY&gt;

<span class="h3"><a class="selflink" id="section-10.2" href="#section-10.2">10.2</a>.  CARDDAV:supported-collation XML Element</span>

   Name:  supported-collation

   Namespace:  urn:ietf:params:xml:ns:carddav

   Purpose:  Identifies a single collation via its collation identifier
      as defined by [<a href="./rfc4790" title="&quot;Internet Application Protocol Collation Registry&quot;">RFC4790</a>].

   Description:  The CARDDAV:supported-collation contains the text of a
      collation identifier as described in <a href="#section-8.3.1">Section 8.3.1</a>.



<span class="grey">Daboo                        Standards Track                   [Page 36]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-37" ></span>
<span class="grey"><a href="./rfc6352">RFC 6352</a>                         CardDAV                     August 2011</span>


   Definition:

       &lt;!ELEMENT supported-collation (#PCDATA)&gt;
       &lt;!-- PCDATA value: collation identifier --&gt;

<span class="h3"><a class="selflink" id="section-10.3" href="#section-10.3">10.3</a>.  CARDDAV:addressbook-query XML Element</span>

   Name:  addressbook-query

   Namespace:  urn:ietf:params:xml:ns:carddav

   Purpose:  Defines a report for querying address book data

   Description:  See <a href="#section-8.6">Section 8.6</a>.

   Definition:

       &lt;!ELEMENT addressbook-query ((DAV:allprop |
                                     DAV:propname |
                                     DAV:prop)?, filter, limit?)&gt;

<span class="h3"><a class="selflink" id="section-10.4" href="#section-10.4">10.4</a>.  CARDDAV:address-data XML Element</span>

   Name:  address-data

   Namespace:  urn:ietf:params:xml:ns:carddav

   Purpose:  Specifies one of the following:

      1.  The parts of an address object resource that should be
          returned by a given address book REPORT request, and the media
          type and version for the returned data; or

      2.  The content of an address object resource in a response to an
          address book REPORT request.

   Description:  When used in an address book REPORT request, the
      CARDDAV:address-data XML element specifies which parts of address
      object resources need to be returned in the response.  If the
      CARDDAV:address-data XML element doesn't contain any CARDDAV:prop
      elements, address object resources will be returned in their
      entirety.  Additionally, a media type and version can be specified
      to request that the server return the data in that format if
      possible.

      Finally, when used in an address book REPORT response, the
      CARDDAV:address-data XML element specifies the content of an
      address object resource.  Given that XML parsers normalize the



<span class="grey">Daboo                        Standards Track                   [Page 37]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-38" ></span>
<span class="grey"><a href="./rfc6352">RFC 6352</a>                         CardDAV                     August 2011</span>


      two-character sequence CRLF (US-ASCII decimal 13 and US-ASCII
      decimal 10) to a single LF character (US-ASCII decimal 10), the CR
      character (US-ASCII decimal 13) MAY be omitted in address object
      resources specified in the CARDDAV:address-data XML element.
      Furthermore, address object resources specified in the
      CARDDAV:address-data XML element MAY be invalid per their media
      type specification if the CARDDAV:address-data XML element part of
      the address book REPORT request did not specify required vCard
      properties (e.g., UID, etc.) or specified a CARDDAV:prop XML
      element with the "novalue" attribute set to "yes".

   Note:  The CARDDAV:address-data XML element is specified in requests
      and responses inside the DAV:prop XML element as if it were a
      WebDAV property.  However, the CARDDAV:address-data XML element is
      not a WebDAV property and as such it is not returned in PROPFIND
      responses nor used in PROPPATCH requests.

   Note:  The address data embedded within the CARDDAV:address-data XML
      element MUST follow the standard XML character data encoding
      rules, including use of &amp;lt;, &amp;gt;, &amp;amp; etc., entity encoding or
      the use of a &lt;![CDATA[ ... ]]&gt; construct.  In the latter case, the
      vCard data cannot contain the character sequence "]]&gt;", which is
      the end delimiter for the CDATA section.

   Definition:

       &lt;!ELEMENT address-data (allprop | prop*)&gt;

       when nested in the DAV:prop XML element in an address book
       REPORT request to specify which parts of address object
       resources should be returned in the response;

       &lt;!ELEMENT address-data (#PCDATA)&gt;
       &lt;!-- PCDATA value: address data --&gt;

       when nested in the DAV:prop XML element in an address book
       REPORT response to specify the content of a returned
       address object resource.

       &lt;!ATTLIST address-data content-type CDATA "text/vcard"
                             version CDATA "3.0"&gt;
       &lt;!-- content-type value: a MIME media type --&gt;
       &lt;!-- version value: a version string --&gt;

       attributes can be used on each variant of the
       CALDAV:address-data XML element.





<span class="grey">Daboo                        Standards Track                   [Page 38]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-39" ></span>
<span class="grey"><a href="./rfc6352">RFC 6352</a>                         CardDAV                     August 2011</span>


<span class="h4"><a class="selflink" id="section-10.4.1" href="#section-10.4.1">10.4.1</a>.  CARDDAV:allprop XML Element</span>

   Name:  allprop

   Namespace:  urn:ietf:params:xml:ns:carddav

   Purpose:  Specifies that all vCard properties shall be returned.

   Description:  This element can be used when the client wants all
      vCard properties of components returned by a report.

   Definition:

       &lt;!ELEMENT allprop EMPTY&gt;

   Note: The CARDDAV:allprop element defined here has the same name as
   the DAV:allprop element defined in WebDAV.  However, the
   CARDDAV:allprop element defined here uses the
   "urn:ietf:params:xml:ns:carddav" namespace, as opposed to the "DAV:"
   namespace used for the DAV:allprop element defined in WebDAV.

<span class="h4"><a class="selflink" id="section-10.4.2" href="#section-10.4.2">10.4.2</a>.  CARDDAV:prop XML Element</span>

   Name:  prop

   Namespace:  urn:ietf:params:xml:ns:carddav

   Purpose:  Defines which vCard properties to return in the response.

   Description:  The "name" attribute specifies the name of the vCard
      property to return (e.g., "NICKNAME").  The "novalue" attribute
      can be used by clients to request that the actual value of the
      property not be returned (if the "novalue" attribute is set to
      "yes").  In that case, the server will return just the vCard
      property name and any vCard parameters and a trailing ":" without
      the subsequent value data.

      vCard allows a "group" prefix to appear before a property name in
      the vCard data.  When the "name" attribute does not specify a
      group prefix, it MUST match properties in the vCard data without a
      group prefix or with any group prefix.  When the "name" attribute
      includes a group prefix, it MUST match properties that have
      exactly the same group prefix and name.  For example, a "name" set
      to "TEL" will match "TEL", "X-ABC.TEL", and "X-ABC-1.TEL" vCard
      properties.  A "name" set to "X-ABC.TEL" will match an "X-ABC.TEL"
      vCard property only; it will not match "TEL" or "X-ABC-1.TEL".





<span class="grey">Daboo                        Standards Track                   [Page 39]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-40" ></span>
<span class="grey"><a href="./rfc6352">RFC 6352</a>                         CardDAV                     August 2011</span>


   Definition:

       &lt;!ELEMENT prop EMPTY&gt;

       &lt;!ATTLIST prop name CDATA #REQUIRED
                  novalue (yes | no) "no"&gt;
       &lt;!-- name value: a vCard property name --&gt;
       &lt;!-- novalue value: "yes" or "no" --&gt;

   Note: The CARDDAV:prop element defined here has the same name as the
   DAV:prop element defined in WebDAV.  However, the CARDDAV:prop
   element defined here uses the "urn:ietf:params:xml:ns:carddav"
   namespace, as opposed to the "DAV:" namespace used for the DAV:prop
   element defined in WebDAV.

<span class="h3"><a class="selflink" id="section-10.5" href="#section-10.5">10.5</a>.  CARDDAV:filter XML Element</span>

   Name:  filter

   Namespace:  urn:ietf:params:xml:ns:carddav

   Purpose:  Determines which matching objects are returned.

   Description:  The "filter" element specifies the search filter used
      to match address objects that should be returned by a report.  The
      "test" attribute specifies whether any (logical OR) or all
      (logical AND) of the prop-filter tests need to match in order for
      the overall filter to match.

   Definition:

       &lt;!ELEMENT filter (prop-filter*)&gt;

       &lt;!ATTLIST filter test (anyof | allof) "anyof"&gt;
       &lt;!-- test value:
                 anyof logical OR for prop-filter matches
                 allof logical AND for prop-filter matches --&gt;

<span class="h4"><a class="selflink" id="section-10.5.1" href="#section-10.5.1">10.5.1</a>.  CARDDAV:prop-filter XML Element</span>

   Name:  prop-filter

   Namespace:  urn:ietf:params:xml:ns:carddav

   Purpose:  Limits the search to specific vCard properties.






<span class="grey">Daboo                        Standards Track                   [Page 40]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-41" ></span>
<span class="grey"><a href="./rfc6352">RFC 6352</a>                         CardDAV                     August 2011</span>


   Description:  The CARDDAV:prop-filter XML element specifies search
      criteria on a specific vCard property (e.g., "NICKNAME").  An
      address object is said to match a CARDDAV:prop-filter if:

      *  A vCard property of the type specified by the "name" attribute
         exists, and the CARDDAV:prop-filter is empty, or it matches any
         specified CARDDAV:text-match or CARDDAV:param-filter
         conditions.  The "test" attribute specifies whether any
         (logical OR) or all (logical AND) of the text-filter and param-
         filter tests need to match in order for the overall filter to
         match.

      or:

      *  A vCard property of the type specified by the "name" attribute
         does not exist, and the CARDDAV:is-not-defined element is
         specified.

      vCard allows a "group" prefix to appear before a property name in
      the vCard data.  When the "name" attribute does not specify a
      group prefix, it MUST match properties in the vCard data without a
      group prefix or with any group prefix.  When the "name" attribute
      includes a group prefix, it MUST match properties that have
      exactly the same group prefix and name.  For example, a "name" set
      to "TEL" will match "TEL", "X-ABC.TEL", "X-ABC-1.TEL" vCard
      properties.  A "name" set to "X-ABC.TEL" will match an "X-ABC.TEL"
      vCard property only, it will not match "TEL" or "X-ABC-1.TEL".

   Definition:

       &lt;!ELEMENT prop-filter (is-not-defined |
                              (text-match*, param-filter*))&gt;

       &lt;!ATTLIST prop-filter name CDATA #REQUIRED
                             test (anyof | allof) "anyof"&gt;
       &lt;!-- name value: a vCard property name (e.g., "NICKNAME")
         test value:
             anyof logical OR for text-match/param-filter matches
             allof logical AND for text-match/param-filter matches --&gt;

<span class="h4"><a class="selflink" id="section-10.5.2" href="#section-10.5.2">10.5.2</a>.  CARDDAV:param-filter XML Element</span>

   Name:  param-filter

   Namespace:  urn:ietf:params:xml:ns:carddav

   Purpose:  Limits the search to specific parameter values.




<span class="grey">Daboo                        Standards Track                   [Page 41]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-42" ></span>
<span class="grey"><a href="./rfc6352">RFC 6352</a>                         CardDAV                     August 2011</span>


   Description:  The CARDDAV:param-filter XML element specifies search
      criteria on a specific vCard property parameter (e.g., TYPE) in
      the scope of a given CARDDAV:prop-filter.  A vCard property is
      said to match a CARDDAV:param-filter if:

      *  A parameter of the type specified by the "name" attribute
         exists, and the CARDDAV:param-filter is empty, or it matches
         the CARDDAV:text-match conditions if specified.

      or:

      *  A parameter of the type specified by the "name" attribute does
         not exist, and the CARDDAV:is-not-defined element is specified.

   Definition:

       &lt;!ELEMENT param-filter (is-not-defined | text-match)?&gt;

       &lt;!ATTLIST param-filter name CDATA #REQUIRED&gt;
       &lt;!-- name value: a property parameter name (e.g., "TYPE") --&gt;

<span class="h4"><a class="selflink" id="section-10.5.3" href="#section-10.5.3">10.5.3</a>.  CARDDAV:is-not-defined XML Element</span>

   Name:  is-not-defined

   Namespace:  urn:ietf:params:xml:ns:carddav

   Purpose:  Specifies that a match should occur if the enclosing vCard
      property or parameter does not exist.

   Description:  The CARDDAV:is-not-defined XML element specifies that a
      match occurs if the enclosing vCard property or parameter value
      specified in an address book REPORT request does not exist in the
      address data being tested.

   Definition:

       &lt;!ELEMENT is-not-defined EMPTY&gt;

<span class="h4"><a class="selflink" id="section-10.5.4" href="#section-10.5.4">10.5.4</a>.  CARDDAV:text-match XML Element</span>

   Name:  text-match

   Namespace:  urn:ietf:params:xml:ns:carddav

   Purpose:  Specifies a substring match on a vCard property or
      parameter value.




<span class="grey">Daboo                        Standards Track                   [Page 42]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-43" ></span>
<span class="grey"><a href="./rfc6352">RFC 6352</a>                         CardDAV                     August 2011</span>


   Description:  The CARDDAV:text-match XML element specifies text used
      for a substring match against the vCard property or parameter
      value specified in an address book REPORT request.

      The "collation" attribute is used to select the collation that the
      server MUST use for character string matching.  In the absence of
      this attribute, the server MUST use the "i;unicode-casemap"
      collation.

      The "negate-condition" attribute is used to indicate that this
      test returns a match if the text matches, when the attribute value
      is set to "no", or return a match if the text does not match, if
      the attribute value is set to "yes".  For example, this can be
      used to match components with a CATEGORIES property not set to
      PERSON.

      The "match-type" attribute is used to indicate the type of match
      operation to use.  Possible choices are:

         "equals" - an exact match to the target string

         "contains" - a substring match, matching anywhere within the
         target string

         "starts-with" - a substring match, matching only at the start
         of the target string

         "ends-with" - a substring match, matching only at the end of
         the target string

   Definition:

       &lt;!ELEMENT text-match (#PCDATA)&gt;
       &lt;!-- PCDATA value: string --&gt;

       &lt;!ATTLIST text-match
          collation        CDATA "i;unicode-casemap"
          negate-condition (yes | no) "no"
          match-type (equals|contains|starts-with|ends-with) "contains"&gt;

<span class="h3"><a class="selflink" id="section-10.6" href="#section-10.6">10.6</a>.  CARDDAV:limit XML Element</span>

   Name:  limit

   Namespace:  urn:ietf:params:xml:ns:carddav

   Purpose:  Specifies different types of limits that can be applied to
      the results returned by the server.



<span class="grey">Daboo                        Standards Track                   [Page 43]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-44" ></span>
<span class="grey"><a href="./rfc6352">RFC 6352</a>                         CardDAV                     August 2011</span>


   Description:  The CARDDAV:limit XML element can be used to specify
      different types of limits that the client can request the server
      to apply to the results returned by the server.  Currently, only
      the CARDDAV:nresults limit can be used; other types of limit could
      be defined in the future.

   Definition:

       &lt;!ELEMENT limit (nresults)&gt;

<span class="h4"><a class="selflink" id="section-10.6.1" href="#section-10.6.1">10.6.1</a>.  CARDDAV:nresults XML Element</span>

   Name:  nresults

   Namespace:  urn:ietf:params:xml:ns:carddav

   Purpose:  Specifies a limit on the number of results returned by the
      server.

   Description:  The CARDDAV:nresults XML element contains a requested
      maximum number of DAV:response elements to be returned in the
      response body of a query.  The server MAY disregard this limit.
      The value of this element is an unsigned integer.

   Definition:

       &lt;!ELEMENT nresults (#PCDATA)&gt;
       &lt;!-- nresults value: unsigned integer, must be digits --&gt;

<span class="h3"><a class="selflink" id="section-10.7" href="#section-10.7">10.7</a>.  CARDDAV:addressbook-multiget XML Element</span>

   Name:  addressbook-multiget

   Namespace:  urn:ietf:params:xml:ns:carddav

   Purpose:  CardDAV report used to retrieve specific address objects
      via their URIs.

   Description:  See <a href="#section-8.7">Section 8.7</a>.

   Definition:

       &lt;!ELEMENT addressbook-multiget ((DAV:allprop |
                                        DAV:propname |
                                        DAV:prop)?,
                                        DAV:href+)&gt;





<span class="grey">Daboo                        Standards Track                   [Page 44]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-45" ></span>
<span class="grey"><a href="./rfc6352">RFC 6352</a>                         CardDAV                     August 2011</span>


<span class="h2"><a class="selflink" id="section-11" href="#section-11">11</a>.  Service Discovery via SRV Records</span>

   [<a id="ref-RFC2782">RFC2782</a>] defines a DNS-based service discovery protocol that has
   been widely adopted as a means of locating particular services within
   a local area network and beyond, using SRV RRs.

   This specification adds two service types for use with SRV records:

   carddav:  Identifies a CardDAV server that uses HTTP without TLS
      [<a href="./rfc2818" title="&quot;HTTP Over TLS&quot;">RFC2818</a>].

   carddavs:  Identifies a CardDAV server that uses HTTP with TLS
      [<a href="./rfc2818" title="&quot;HTTP Over TLS&quot;">RFC2818</a>].

   Example: non-TLS service record

       _carddav._tcp     SRV 0 1 80 addressbook.example.com.

   Example: TLS service

       _carddavs._tcp    SRV 0 1 443 addressbook.example.com.

<span class="h2"><a class="selflink" id="section-12" href="#section-12">12</a>.  Internationalization Considerations</span>

   CardDAV allows internationalized strings to be stored and retrieved
   for the description of address book collections (see <a href="#section-6.2.1">Section 6.2.1</a>).

   The CARDDAV:addressbook-query REPORT (<a href="#section-8.6">Section 8.6</a>) includes a text
   searching option controlled by the CARDDAV:text-match element and
   details of character handling are covered in the description of that
   element (see <a href="#section-10.5.4">Section 10.5.4</a>).

<span class="h2"><a class="selflink" id="section-13" href="#section-13">13</a>.  Security Considerations</span>

   HTTP protocol transactions are sent in the clear over the network
   unless protection from snooping is negotiated.  This can be
   accomplished by use of TLS as defined in [<a href="./rfc2818" title="&quot;HTTP Over TLS&quot;">RFC2818</a>].  In particular,
   if HTTP Basic authentication [<a href="./rfc2617" title="&quot;HTTP Authentication: Basic and Digest Access Authentication&quot;">RFC2617</a>] is available, the server MUST
   allow TLS to be used at the same time, and it SHOULD prevent use of
   Basic authentication when TLS is not in use.  Clients SHOULD use TLS
   whenever possible.

   With the ACL extension [<a href="./rfc3744" title="&quot;Web Distributed Authoring and Versioning (WebDAV) Access Control Protocol&quot;">RFC3744</a>] present, WebDAV allows control over
   who can access (read or write) any resource on the WebDAV server.  In
   addition, WebDAV ACL provides for an "inheritance" mechanism, whereby
   resources may inherit access privileges from other resources.  Often,
   the "other" resource is a parent collection of the resource itself.
   Servers are able to support address books that are "private"



<span class="grey">Daboo                        Standards Track                   [Page 45]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-46" ></span>
<span class="grey"><a href="./rfc6352">RFC 6352</a>                         CardDAV                     August 2011</span>


   (accessible only to the "owner"), "shared" (accessible to the owner
   and other specified authenticated users), and "public" (accessible to
   any authenticated or unauthenticated users).  When provisioning
   address books of a particular type, servers MUST ensure that the
   correct privileges are applied on creation.  In particular, private
   and shared address books MUST NOT be accessible by unauthenticated
   users (to prevent data from being automatically searched or indexed
   by web "crawlers").

   Clients SHOULD warn users in an appropriate fashion when they copy or
   move address data from a private address book to a shared address
   book or public address book.  Clients SHOULD provide a clear
   indication as to which address books are private, shared, or public.
   Clients SHOULD provide an appropriate warning when changing access
   privileges for a private or shared address book with data so as to
   allow unauthenticated users access.

   This specification currently relies on standard HTTP authentication
   mechanisms for identifying users.  These comprise Basic and Digest
   authentication [<a href="./rfc2617" title="&quot;HTTP Authentication: Basic and Digest Access Authentication&quot;">RFC2617</a>] as well as TLS [<a href="./rfc2818" title="&quot;HTTP Over TLS&quot;">RFC2818</a>] using client-side
   certificates.

<span class="h2"><a class="selflink" id="section-14" href="#section-14">14</a>.  IANA Consideration</span>

   This document uses a URN to describe a new XML namespace conforming
   to the registry mechanism described in [<a href="./rfc3688" title="&quot;The IETF XML Registry&quot;">RFC3688</a>].

<span class="h3"><a class="selflink" id="section-14.1" href="#section-14.1">14.1</a>.  Namespace Registration</span>

   Registration request for the carddav namespace:

   URI: urn:ietf:params:xml:ns:carddav

   Registrant Contact: The IESG &lt;iesg@ietf.org&gt;

   XML: None - not applicable for namespace registrations.

<span class="h2"><a class="selflink" id="section-15" href="#section-15">15</a>.  Acknowledgments</span>

   Thanks go to Lisa Dusseault and Bernard Desruisseaux for their work
   on CalDAV, on which CardDAV is heavily based.  The following
   individuals contributed their ideas and support for writing this
   specification: Mike Douglass, Stefan Eissing, Helge Hess, Arnaud
   Quillaud, Julian Reschke, Elias Sinderson, Greg Stein, Wilfredo
   Sanchez, and Simon Vaillancourt.






<span class="grey">Daboo                        Standards Track                   [Page 46]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-47" ></span>
<span class="grey"><a href="./rfc6352">RFC 6352</a>                         CardDAV                     August 2011</span>


<span class="h2"><a class="selflink" id="section-16" href="#section-16">16</a>.  References</span>

<span class="h3"><a class="selflink" id="section-16.1" href="#section-16.1">16.1</a>.  Normative References</span>

   [<a id="ref-RFC2119">RFC2119</a>]  Bradner, S., "Key words for use in RFCs to Indicate
              Requirement Levels", <a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a>, <a href="./rfc2119">RFC 2119</a>, March 1997.

   [<a id="ref-RFC2426">RFC2426</a>]  Dawson, F. and T. Howes, "vCard MIME Directory Profile",
              <a href="./rfc2426">RFC 2426</a>, September 1998.

   [<a id="ref-RFC2616">RFC2616</a>]  Fielding, R., Gettys, J., Mogul, J., Frystyk, H.,
              Masinter, L., Leach, P., and T. Berners-Lee, "Hypertext
              Transfer Protocol -- HTTP/1.1", <a href="./rfc2616">RFC 2616</a>, June 1999.

   [<a id="ref-RFC2617">RFC2617</a>]  Franks, J., Hallam-Baker, P., Hostetler, J., Lawrence, S.,
              Leach, P., Luotonen, A., and L. Stewart, "HTTP
              Authentication: Basic and Digest Access Authentication",
              <a href="./rfc2617">RFC 2617</a>, June 1999.

   [<a id="ref-RFC2782">RFC2782</a>]  Gulbrandsen, A., Vixie, P., and L. Esibov, "A DNS RR for
              specifying the location of services (DNS SRV)", <a href="./rfc2782">RFC 2782</a>,
              February 2000.

   [<a id="ref-RFC2818">RFC2818</a>]  Rescorla, E., "HTTP Over TLS", <a href="./rfc2818">RFC 2818</a>, May 2000.

   [<a id="ref-RFC3253">RFC3253</a>]  Clemm, G., Amsden, J., Ellison, T., Kaler, C., and J.
              Whitehead, "Versioning Extensions to WebDAV
              (Web Distributed Authoring and Versioning)", <a href="./rfc3253">RFC 3253</a>,
              March 2002.

   [<a id="ref-RFC3688">RFC3688</a>]  Mealling, M., "The IETF XML Registry", <a href="https://www.rfc-editor.org/bcp/bcp81">BCP 81</a>, <a href="./rfc3688">RFC 3688</a>,
              January 2004.

   [<a id="ref-RFC3744">RFC3744</a>]  Clemm, G., Reschke, J., Sedlar, E., and J. Whitehead, "Web
              Distributed Authoring and Versioning (WebDAV)
              Access Control Protocol", <a href="./rfc3744">RFC 3744</a>, May 2004.

   [<a id="ref-RFC4790">RFC4790</a>]  Newman, C., Duerst, M., and A. Gulbrandsen, "Internet
              Application Protocol Collation Registry", <a href="./rfc4790">RFC 4790</a>,
              March 2007.

   [<a id="ref-RFC4918">RFC4918</a>]  Dusseault, L., "HTTP Extensions for Web Distributed
              Authoring and Versioning (WebDAV)", <a href="./rfc4918">RFC 4918</a>, June 2007.

   [<a id="ref-RFC5051">RFC5051</a>]  Crispin, M., "i;unicode-casemap - Simple Unicode Collation
              Algorithm", <a href="./rfc5051">RFC 5051</a>, October 2007.





<span class="grey">Daboo                        Standards Track                   [Page 47]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-48" ></span>
<span class="grey"><a href="./rfc6352">RFC 6352</a>                         CardDAV                     August 2011</span>


   [<a id="ref-RFC5246">RFC5246</a>]  Dierks, T. and E. Rescorla, "The Transport Layer Security
              (TLS) Protocol Version 1.2", <a href="./rfc5246">RFC 5246</a>, August 2008.

   [<a id="ref-RFC5280">RFC5280</a>]  Cooper, D., Santesson, S., Farrell, S., Boeyen, S.,
              Housley, R., and W. Polk, "Internet X.509 Public Key
              Infrastructure Certificate and Certificate Revocation List
              (CRL) Profile", <a href="./rfc5280">RFC 5280</a>, May 2008.

   [<a id="ref-RFC5397">RFC5397</a>]  Sanchez, W. and C. Daboo, "WebDAV Current Principal
              Extension", <a href="./rfc5397">RFC 5397</a>, December 2008.

   [<a id="ref-RFC5689">RFC5689</a>]  Daboo, C., "Extended MKCOL for Web Distributed Authoring
              and Versioning (WebDAV)", <a href="./rfc5689">RFC 5689</a>, September 2009.

   [<a id="ref-RFC6350">RFC6350</a>]  Perreault, S., "vCard Format Specification", <a href="./rfc6350">RFC 6350</a>,
              August 2011.

   [<a id="ref-W3C.REC-xml-20081126">W3C.REC-xml-20081126</a>]
              Bray, T., Paoli, J., Sperberg-McQueen, C., Maler, E., and
              F. Yergeau, "Extensible Markup Language (XML) 1.0 (Fifth
              Edition)", World Wide Web Consortium Recommendation REC-
              xml-20081126, November 2008,
              &lt;<a href="http://www.w3.org/TR/2008/REC-xml-20081126">http://www.w3.org/TR/2008/REC-xml-20081126</a>&gt;.

<span class="h3"><a class="selflink" id="section-16.2" href="#section-16.2">16.2</a>.  Informative References</span>

   [<a id="ref-IMSP">IMSP</a>]     Myers, J., <a style="text-decoration: none" href='https://www.google.com/search?sitesearch=datatracker.ietf.org%2Fdoc%2Fhtml%2F&amp;q=inurl:draft-+%22IMSP+-+Internet+Message+Support+Protocol%22'>"IMSP - Internet Message Support Protocol"</a>,
              Work in Progress, June 1995.

   [<a id="ref-RFC2244">RFC2244</a>]  Newman, C. and J. Myers, "ACAP -- Application
              Configuration Access Protocol", <a href="./rfc2244">RFC 2244</a>, November 1997.

   [<a id="ref-RFC4510">RFC4510</a>]  Zeilenga, K., "Lightweight Directory Access Protocol
              (LDAP): Technical Specification Road Map", <a href="./rfc4510">RFC 4510</a>,
              June 2006.

Author's Address

   Cyrus Daboo
   Apple, Inc.
   1 Infinite Loop
   Cupertino, CA  95014
   USA

   EMail: cyrus@daboo.name
   URI:   <a href="http://www.apple.com/">http://www.apple.com/</a>





Daboo                        Standards Track                   [Page 48]
</pre>