[CalendarServer-changes] [8040] CalendarServer/trunk/doc/RFC
source_changes at macosforge.org
source_changes at macosforge.org
Thu Sep 1 08:06:37 PDT 2011
Revision: 8040
http://trac.macosforge.org/projects/calendarserver/changeset/8040
Author: cdaboo at apple.com
Date: 2011-09-01 08:06:35 -0700 (Thu, 01 Sep 2011)
Log Message:
-----------
Update RFC/draft documentation.
Modified Paths:
--------------
CalendarServer/trunk/doc/RFC/draft-daboo-calendar-availability.txt
CalendarServer/trunk/doc/RFC/draft-daboo-webdav-sync.txt
CalendarServer/trunk/doc/RFC/draft-desruisseaux-caldav-sched.txt
Added Paths:
-----------
CalendarServer/trunk/doc/RFC/rfc5995-POST addmember.txt
CalendarServer/trunk/doc/RFC/rfc6047-iMIP.txt
CalendarServer/trunk/doc/RFC/rfc6321-xCal.txt
CalendarServer/trunk/doc/RFC/rfc6350-vCard4.txt
CalendarServer/trunk/doc/RFC/rfc6351-xCard.txt
CalendarServer/trunk/doc/RFC/rfc6352-CardDAV.txt
Removed Paths:
-------------
CalendarServer/trunk/doc/RFC/draft-ietf-vcarddav-carddav.txt
CalendarServer/trunk/doc/RFC/draft-reschke-webdav-post.txt
CalendarServer/trunk/doc/RFC/rfc2447-iMIP.txt
Modified: CalendarServer/trunk/doc/RFC/draft-daboo-calendar-availability.txt
===================================================================
--- CalendarServer/trunk/doc/RFC/draft-daboo-calendar-availability.txt 2011-09-01 14:47:28 UTC (rev 8039)
+++ CalendarServer/trunk/doc/RFC/draft-daboo-calendar-availability.txt 2011-09-01 15:06:35 UTC (rev 8040)
@@ -4,38 +4,13 @@
Network Working Group C. Daboo
Internet-Draft Apple
Intended status: Standards Track B. Desruisseaux
-Expires: May 7, 2009 Oracle
- November 3, 2008
+Expires: October 16, 2011 Oracle
+ April 14, 2011
Calendar Availability
- draft-daboo-calendar-availability-01
+ draft-daboo-calendar-availability-02
-Status of this Memo
-
- By submitting this Internet-Draft, each author represents that any
- applicable patent or other IPR claims of which he or she is aware
- have been or will be disclosed, and any of which he or she becomes
- aware will be disclosed, in accordance with Section 6 of BCP 79.
-
- Internet-Drafts are working documents of the Internet Engineering
- Task Force (IETF), its areas, and its working groups. Note that
- other groups may also distribute working documents as Internet-
- Drafts.
-
- Internet-Drafts are draft documents valid for a maximum of six months
- and may be updated, replaced, or obsoleted by other documents at any
- time. It is inappropriate to use Internet-Drafts as reference
- material or to cite them other than as "work in progress."
-
- The list of current Internet-Drafts can be accessed at
- http://www.ietf.org/ietf/1id-abstracts.txt.
-
- The list of Internet-Draft Shadow Directories can be accessed at
- http://www.ietf.org/shadow.html.
-
- This Internet-Draft will expire on May 7, 2009.
-
Abstract
This document specifies a new iCalendar calendar component that
@@ -47,20 +22,52 @@
This document also defines extensions to CalDAV calendar-access and
calendar-auto-schedule which specify how this new calendar component
- should be used when doing free busy time evaluation in CalDAV.
+ should be used when doing free-busy time evaluation in CalDAV.
+Editorial Note (To be removed by RFC Editor before publication)
+ Discussion of this specification is taking place on the mailing list
+ http://lists.osafoundation.org/mailman/listinfo/ietf-caldav.
+Status of this Memo
-Daboo & Desruisseaux Expires May 7, 2009 [Page 1]
+ This Internet-Draft is submitted in full conformance with the
+ provisions of BCP 78 and BCP 79.
+
+ Internet-Drafts are working documents of the Internet Engineering
+ Task Force (IETF). Note that other groups may also distribute
+ working documents as Internet-Drafts. The list of current Internet-
+ Drafts is at http://datatracker.ietf.org/drafts/current/.
+
+ Internet-Drafts are draft documents valid for a maximum of six months
+ and may be updated, replaced, or obsoleted by other documents at any
+ time. It is inappropriate to use Internet-Drafts as reference
+ material or to cite them other than as "work in progress."
+
+ This Internet-Draft will expire on October 16, 2011.
+
+Copyright Notice
+
+ Copyright (c) 2011 IETF Trust and the persons identified as the
+
+
+
+Daboo & Desruisseaux Expires October 16, 2011 [Page 1]
-Internet-Draft Calendar Availability November 2008
+Internet-Draft Calendar Availability April 2011
-Editorial Note (To be removed by RFC Editor before publication)
+ document authors. All rights reserved.
- Discussion of this specification is taking place on the mailing list
- http://lists.osafoundation.org/mailman/listinfo/ietf-caldav.
+ This document is subject to BCP 78 and the IETF Trust's Legal
+ Provisions Relating to IETF Documents
+ (http://trustee.ietf.org/license-info) 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.
Table of Contents
@@ -79,13 +86,12 @@
7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 15
7.1. Component Registrations . . . . . . . . . . . . . . . . . 15
7.2. Property Registrations . . . . . . . . . . . . . . . . . . 15
- 8. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 16
- 9. Normative References . . . . . . . . . . . . . . . . . . . . . 16
+ 8. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 15
+ 9. Normative References . . . . . . . . . . . . . . . . . . . . . 15
Appendix A. Example Calendar #1 . . . . . . . . . . . . . . . . . 16
Appendix B. Change History (To be removed by RFC Editor
before publication) . . . . . . . . . . . . . . . . . 18
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 18
- Intellectual Property and Copyright Statements . . . . . . . . . . 19
@@ -102,15 +108,9 @@
-
-
-
-
-
-
-Daboo & Desruisseaux Expires May 7, 2009 [Page 2]
+Daboo & Desruisseaux Expires October 16, 2011 [Page 2]
-Internet-Draft Calendar Availability November 2008
+Internet-Draft Calendar Availability April 2011
1. Introduction
@@ -124,22 +124,22 @@
pm through 5 pm during term time only). Ideally users should be able
to specify such periods directly via their calendar user agent, and
have them automatically considered as part of the normal free-busy
- lookup for that user. In addition it should be possible for
- different periods of available time to appear for different users.
+ lookup for that user. In addition it should be possible to present
+ different periods of available time depending on which user is making
+ the request.
- However, iCalendar [I-D.ietf-calsify-rfc2445bis] does not provide a
- way to specify a repeating period of available or unavailable time as
- "VFREEBUSY" components cannot include any form of recurrence
- information, as opposed to "VEVENT" components which can. Since
- repeating patterns are often the case, "VFREEBUSY" components are not
- sufficient to solve this problem.
+ iCalendar [RFC5545] defines a "VFREEBUSY" component that can be used
+ to represent fixed busy time periods, but it does does not provide a
+ way to specify a repeating period of available or unavailable time.
+ Since repeating patterns are often the case, "VFREEBUSY" components
+ are not sufficient to solve this problem.
This specification defines a new type of iCalendar calendar component
that can be used to publish user availability.
CalDAV [RFC4791] provides a way for calendar users to access and
manage calendar data and exchange this data via scheduling
- operations. As part of this the CalDAV calendar-access [RFC4791]
+ operations. As part of this the, CalDAV calendar-access [RFC4791]
feature provides a CALDAV:free-busy-query REPORT that returns free-
busy information for a calendar collection or hierarchy of calendar
collections. Also, the CalDAV calendar-auto-schedule
@@ -164,9 +164,9 @@
-Daboo & Desruisseaux Expires May 7, 2009 [Page 3]
+Daboo & Desruisseaux Expires October 16, 2011 [Page 3]
-Internet-Draft Calendar Availability November 2008
+Internet-Draft Calendar Availability April 2011
When XML element types in the namespaces "DAV:" and
@@ -203,39 +203,39 @@
"END" ":" "VAVAILABILITY" CRLF
availabilityprop = *(
-
+ ;
; the following are REQUIRED,
; but MUST NOT occur more than once
-
+ ;
dtstamp / uid
-
+ ;
; the following are OPTIONAL,
; but MUST NOT occur more than once
+ ;
+ busytype / class / created / description /
+ dtstart / last-mod / organizer / seq /
+ summary / url /
+ ;
+ ; either 'dtend' or 'duration' MAY appear
- busytype / created / dtend /dtstart /
- last-mod / organizer / seq / summary / url /
- ; 'duration' is OPTIONAL in a
- ; 'availabilityprop' but MUST only be
-
-
-Daboo & Desruisseaux Expires May 7, 2009 [Page 4]
+Daboo & Desruisseaux Expires October 16, 2011 [Page 4]
-Internet-Draft Calendar Availability November 2008
+Internet-Draft Calendar Availability April 2011
- ; present if 'dtstart' is also present and
- ; 'dtend' is not present, and it MUST NOT
- ; occur more than once
-
- duration /
-
+ ; once, but 'dtend' and 'duration' MUST
+ ; NOT occur in the same 'availabilityprop'.
+ ;
+ dtend / duration /
+ ;
; the following are OPTIONAL,
; and MAY occur more than once
-
- categories / comment / contact / x-prop
-
+ ;
+ categories / comment / contact /
+ x-prop / iana-prop
+ ;
)
availablec = "BEGIN" ":" "AVAILABLE" CRLF
@@ -243,31 +243,31 @@
"END" ":" "AVAILABLE" CRLF
availableprop = *(
-
+ ;
; the following are REQUIRED,
; but MUST NOT occur more than once
-
+ ;
dtstamp / dtstart / uid /
-
- ; either a 'dtend' or a 'duration' is REQUIRED
- ; in a 'availableprop', but 'dtend' and
- ; 'duration' MUST NOT occur in the same
- ; 'availableprop', and each MUST NOT occur more
- ; than once
-
+ ;
+ ; either 'dtend' or 'duration' MAY appear
+ ; once, but 'dtend' and 'duration' MUST NOT
+ ; occur in the same 'availableprop'.
+ ; 'duration' MUST NOT be present if 'dtstart'
+ ; is not present
+ ;
dtend / duration /
-
+ ;
; the following are OPTIONAL,
; but MUST NOT occur more than once
-
- created / last-mod / recurid / rrule /
- summary /
-
+ ;
+ created / description / geo / last-mod /
+ location / recurid / rrule / summary /
+ ;
; the following are OPTIONAL,
; and MAY occur more than once
-
+ ;
categories / comment / contact / exdate /
- rdate / x-prop
+ rdate / x-prop / iana-prop
)
@@ -276,15 +276,17 @@
-Daboo & Desruisseaux Expires May 7, 2009 [Page 5]
+Daboo & Desruisseaux Expires October 16, 2011 [Page 5]
-Internet-Draft Calendar Availability November 2008
+Internet-Draft Calendar Availability April 2011
Description: A "VAVAILABILITY" component indicates a period of time
within which availability information is provided. A
- "VAVAILABILITY" component MUST specify a start time and optionally
- an end time or duration. Within that time period, availability
+ "VAVAILABILITY" component can specify a start time and an end time
+ or duration. If "DTSTART" is not present, then the start time is
+ unbounded. If "DTEND" or "DURATION" are not present, then the end
+ time is unbounded. Within the specified time period, availability
defaults to a free-busy type of "BUSY-UNAVAILABLE", except for any
time periods corresponding to "AVAILABLE" sub-components.
@@ -312,67 +314,68 @@
available time.
Example: The following is an example of a "VAVAILABILITY" calendar
- component used to represent the availability of a user available
- Monday through Friday, 9:00 AM to 5:00 PM in the America/Montreal
- time zone:
+ component used to represent the availability of a user always
+ available Monday through Friday, 9:00 AM to 5:00 PM in the
+ America/Montreal time zone:
BEGIN:VAVAILABILITY
ORGANIZER:mailto:bernard at example.com
- UID:20061005T133225Z-00001 at example.com
- DTSTAMP:20061005T133225Z
- DTSTART;TZID=America/Montreal:20061002T000000
+ UID:20111005T133225Z-00001 at example.com
+ DTSTAMP:20111005T133225Z
BEGIN:AVAILABLE
- UID:20061005T133225Z-00001-A at example.com
+ UID:20111005T133225Z-00001-A at example.com
SUMMARY:Monday to Friday from 9:00 to 17:00
- DTSTART;TZID=America/Montreal:20061002T090000
- DTEND;TZID=America/Montreal:20061002T170000
+ DTSTART;TZID=America/Montreal:20111002T090000
+ DTEND;TZID=America/Montreal:20111002T170000
RRULE:FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR
END:AVAILABLE
- END:VAVAILABILITY
-Daboo & Desruisseaux Expires May 7, 2009 [Page 6]
+Daboo & Desruisseaux Expires October 16, 2011 [Page 6]
-Internet-Draft Calendar Availability November 2008
+Internet-Draft Calendar Availability April 2011
+ END:VAVAILABILITY
+
The following is an example of a "VAVAILABILITY" calendar
component used to represent the availability of a user available
Monday through Thursday, 9:00 AM to 5:00 PM, and Friday 9:00 AM to
- 12:00 PM in the America/Montreal time zone:
+ 12:00 PM in the America/Montreal time zone between October 2nd and
+ December 2nd 2011:
BEGIN:VAVAILABILITY
ORGANIZER:mailto:bernard at example.com
- UID:20061005T133225Z-00001 at example.com
- DTSTAMP:20061005T133225Z
- DTSTART;TZID=America/Montreal:20061002T000000
- DTEND;TZID=America/Montreal:20061202T000000
+ UID:20111005T133225Z-00001 at example.com
+ DTSTAMP:20111005T133225Z
+ DTSTART;TZID=America/Montreal:20111002T000000
+ DTEND;TZID=America/Montreal:20111202T000000
BEGIN:AVAILABLE
- UID:20061005T133225Z-00001-A at example.com
+ UID:20111005T133225Z-00001-A at example.com
SUMMARY:Monday to Thursday from 9:00 to 17:00
- DTSTART;TZID=America/Montreal:20061002T090000
- DTEND;TZID=America/Montreal:20061002T170000
+ DTSTART;TZID=America/Montreal:20111002T090000
+ DTEND;TZID=America/Montreal:20111002T170000
RRULE:FREQ=WEEKLY;BYDAY=MO,TU,WE,TH
END:AVAILABLE
BEGIN:AVAILABLE
- UID:20061005T133225Z-00001-B at example.com
+ UID:20111005T133225Z-00001-B at example.com
SUMMARY:Friday from 9:00 to 12:00
- DTSTART;TZID=America/Montreal:20061006T090000
- DTEND;TZID=America/Montreal:20061006T120000
- RRULE:FREQ=WEEKLY;BYDAY=FR
+ DTSTART;TZID=America/Montreal:20111006T090000
+ DTEND;TZID=America/Montreal:20111006T120000
+ RRULE:FREQ=WEEKLY
END:AVAILABLE
END:VAVAILABILITY
The following is an example of three "VAVAILABILITY" calendar
- components used to represent the availability of an itinerant
+ components used to represent the availability of a traveling
worker: Monday through Friday, 9:00 AM to 5:00 PM each day.
However, for three weeks the calendar user is working in Montreal,
then one week in Los Angeles, then back to Montreal. Note that
each overall period is covered by separate "VAVAILABILITY"
components. The last of these has no DTEND so continues on "for
- ever". This example shows how "exceptions" to available time can
- be handled.
+ ever". This example shows how "blocks" of available time can be
+ represented.
@@ -385,52 +388,49 @@
-
-
-
-Daboo & Desruisseaux Expires May 7, 2009 [Page 7]
+Daboo & Desruisseaux Expires October 16, 2011 [Page 7]
-Internet-Draft Calendar Availability November 2008
+Internet-Draft Calendar Availability April 2011
BEGIN:VAVAILABILITY
ORGANIZER:mailto:bernard at example.com
- UID:20061005T133225Z-00001 at example.com
- DTSTAMP:20061005T133225Z
- DTSTART;TZID=America/Montreal:20061002T000000
- DTEND;TZID=America/Montreal:20061023T030000
+ UID:20111005T133225Z-00001 at example.com
+ DTSTAMP:20111005T133225Z
+ DTSTART;TZID=America/Montreal:20111002T000000
+ DTEND;TZID=America/Montreal:20111023T030000
BEGIN:AVAILABLE
- UID:20061005T133225Z-00001-A at example.com
+ UID:20111005T133225Z-00001-A at example.com
SUMMARY:Monday to Friday from 9:00 to 17:00
- DTSTART;TZID=America/Montreal:20061002T090000
- DTEND;TZID=America/Montreal:20061002T170000
+ DTSTART;TZID=America/Montreal:20111002T090000
+ DTEND;TZID=America/Montreal:20111002T170000
RRULE:FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR
END:AVAILABLE
END:VAVAILABILITY
BEGIN:VAVAILABILITY
ORGANIZER:mailto:bernard at example.com
- UID:20061005T133225Z-00001 at example.com
- DTSTAMP:20061005T133225Z
- DTSTART;TZID=America/Los_Angeles:20061023T000000
- DTEND;TZID=America/Los_Angeles:20061030T000000
+ UID:20111005T133225Z-00001 at example.com
+ DTSTAMP:20111005T133225Z
+ DTSTART;TZID=America/Los_Angeles:20111023T000000
+ DTEND;TZID=America/Los_Angeles:20111030T000000
BEGIN:AVAILABLE
- UID:20061005T133225Z-00001-A at example.com
+ UID:20111005T133225Z-00001-A at example.com
SUMMARY:Monday to Friday from 9:00 to 17:00
- DTSTART;TZID=America/Los_Angeles:20061023T090000
- DTEND;TZID=America/Los_Angeles:20061023T170000
+ DTSTART;TZID=America/Los_Angeles:20111023T090000
+ DTEND;TZID=America/Los_Angeles:20111023T170000
RRULE:FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR
END:AVAILABLE
END:VAVAILABILITY
BEGIN:VAVAILABILITY
ORGANIZER:mailto:bernard at example.com
- UID:20061005T133225Z-00001 at example.com
- DTSTAMP:20061005T133225Z
- DTSTART;TZID=America/Montreal:20061030T030000
+ UID:20111005T133225Z-00001 at example.com
+ DTSTAMP:20111005T133225Z
+ DTSTART;TZID=America/Montreal:20111030T030000
BEGIN:AVAILABLE
- UID:20061005T133225Z-00001-A at example.com
+ UID:20111005T133225Z-00001-A at example.com
SUMMARY:Monday to Friday from 9:00 to 17:00
- DTSTART;TZID=America/Montreal:20061030T090000
- DTEND;TZID=America/Montreal:20061030T170000
+ DTSTART;TZID=America/Montreal:20111030T090000
+ DTEND;TZID=America/Montreal:20111030T170000
RRULE:FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR
END:AVAILABLE
END:VAVAILABILITY
@@ -444,9 +444,9 @@
-Daboo & Desruisseaux Expires May 7, 2009 [Page 8]
+Daboo & Desruisseaux Expires October 16, 2011 [Page 8]
-Internet-Draft Calendar Availability November 2008
+Internet-Draft Calendar Availability April 2011
Property Name: BUSYTYPE
@@ -455,8 +455,8 @@
Value Type: TEXT
- Property Parameters: Non-standard property parameters can be
- specified on this property.
+ Property Parameters: IANA and non-standard property parameters can
+ be specified on this property.
Conformance: This property can be specified within "VAVAILABILITY"
calendar components.
@@ -466,17 +466,18 @@
busytype = "BUSYTYPE" busytypeparam ":" busytypevalue CRLF
- busytypeparam = *(";" xparam)
+ busytypeparam = *(";" other-param)
busytypevalue = "BUSY" / "BUSY-UNAVAILABLE" /
"BUSY-TENTATIVE" / iana-token / x-name
- ; Default is "BUSY-UNAVAILABLE"
+ ; Default is "BUSY-UNAVAILABLE".
Description: This property is used to specify the default busy time
type. The values correspond to those used by the "FBTYPE"
parameter used on a "FREEBUSY" property, with the exception that
- the "FREE" value is not used. If not specified on a component
- that allows this property, the default is "BUSY-UNAVAILABLE".
+ the "FREE" value is not used in this property. If not specified
+ on a component that allows this property, the default is "BUSY-
+ UNAVAILABLE".
Example: The following is an example of this property:
@@ -491,20 +492,20 @@
An iCalendar "VFREEBUSY" component is used to convey "rolled-up"
free-busy time information for a calendar user. This can be
- generated as the result of an iTIP "VFREEBUSY"
- [I-D.ietf-calsify-2446bis] request or through some other mechanism
- (e.g., a CalDAV calendar-access CALDAV:free-busy-query REPORT).
+ generated as the result of an iTIP free-busy [RFC5546] request or
+ through some other mechanism (e.g., a CalDAV calendar-access CALDAV:
+ free-busy-query REPORT).
When a "VAVAILABILITY" component is present and intersects the time-
- range for the free-busy request, the time covered by the
-Daboo & Desruisseaux Expires May 7, 2009 [Page 9]
+Daboo & Desruisseaux Expires October 16, 2011 [Page 9]
-Internet-Draft Calendar Availability November 2008
+Internet-Draft Calendar Availability April 2011
+ range for the free-busy request, the time covered by the
"VAVAILABILITY" component is set to busy and then portions of it
"carved out" to be free based on the "AVAILABLE" components in the
"VAVAILABILITY" component. Once that is done, regular "VEVENT" and
@@ -526,7 +527,7 @@
the busy time type derived from the "BUSYTYPE" property in
the "VAVAILABILITY" component.
- 3. For each remaining "VAVAILABILITY" component:
+ 3. For each intersecting "VAVAILABILITY" component:
1. For each "AVAILABLE" component in the "VAVAILABILITY"
component:
@@ -552,15 +553,16 @@
Each cell in the rows below the column header contains a single
character that represents the free-busy type for the corresponding
time period at the end of the process step represented by the row.
- The characters in the row are:
-Daboo & Desruisseaux Expires May 7, 2009 [Page 10]
+Daboo & Desruisseaux Expires October 16, 2011 [Page 10]
-Internet-Draft Calendar Availability November 2008
+Internet-Draft Calendar Availability April 2011
+ The characters in the row are:
+
+-----------+--------------------------------------------------+
| Character | Meaning |
+-----------+--------------------------------------------------+
@@ -572,7 +574,7 @@
4.1.1. Simple Example
- A free-busy request for Monday, 6th November 2006, midnight to
+ A free-busy request for Monday, 6th November 2011, midnight to
midnight in the America/Montreal timezone.
The user's calendar is as shown in Appendix A. This includes one
@@ -602,27 +604,31 @@
which supports this extension. A server:
o MUST support "VAVAILABILITY" components in a calendar collection
- resource if the CALDAV calendar-access feature is supported;
+ resource if the CALDAV calendar-access feature is supported, which
+ includes advertising it in CALDAV;supported-calendar-component-set
+ properties on calendars;
- o MUST support CALDAV:free-busy-query REPORTs that aggregate the
- information in any "VAVAILABILITY" components;
- o MUST support "VAVAILABILITY" components stored in a CALDAV:inbox-
- availability WebDAV property on a CALDAV scheduling inbox
-Daboo & Desruisseaux Expires May 7, 2009 [Page 11]
+Daboo & Desruisseaux Expires October 16, 2011 [Page 11]
-Internet-Draft Calendar Availability November 2008
+Internet-Draft Calendar Availability April 2011
+ o MUST support CALDAV:free-busy-query REPORTs that aggregate the
+ information in any "VAVAILABILITY" components in the calendar
+ collections targeted by the request;
+
+ o MUST support "VAVAILABILITY" components stored in a CALDAV:
+ calendar-availability WebDAV property on a CALDAV scheduling inbox
collection if the CALDAV calendar-auto-schedule feature is
supported;
- o MUST support iTIP [I-D.ietf-calsify-2446bis] free busy requests
- that aggregate the information in any "VAVAILABILITY" components
- in calendar collections that contribute to free-busy, or in any
+ o MUST support iTIP [RFC5546] free-busy requests that aggregate the
+ information in any "VAVAILABILITY" components in calendar
+ collections that contribute to free-busy, or in any
"VAVAILABILITY" components stored in the CALDAV:calendar-
availability in the CALDAV scheduling inbox collection of the
calendar user targeted by the iTIP free-busy request, if the
@@ -659,20 +665,18 @@
Content-Length: 0
In this example, the OPTIONS method returns the value "calendar-
- availability" in the DAV response header to indicate that the
- collection "/home/bernard/calendars/" supports the new features
- defined in this specification.
-
-
-
-Daboo & Desruisseaux Expires May 7, 2009 [Page 12]
+Daboo & Desruisseaux Expires October 16, 2011 [Page 12]
-Internet-Draft Calendar Availability November 2008
+Internet-Draft Calendar Availability April 2011
+ availability" in the DAV response header to indicate that the
+ collection "/home/bernard/calendars/" supports the new features
+ defined in this specification.
+
5.2.2. CALDAV:free-busy-query REPORT
A CALDAV:free-busy-query REPORT can be executed on a calendar
@@ -688,27 +692,26 @@
Namespace: urn:ietf:params:xml:ns:caldav
Purpose: Defines a "VAVAILABILITY" component that will be used in
- calculating free-busy time when an iTIP VFREEBUSY request is
- targetted at the calendar user who owns the Inbox.
+ calculating free-busy time when an iTIP free-busy request is
+ targeted at the calendar user who owns the Inbox.
Conformance: This property MAY be protected and SHOULD NOT be
- returned by a PROPFIND allprop request (as defined in Section
- 12.14.1 of [RFC2518]). Support for this property is REQUIRED.
- The value of this property MUST be a valid iCalendar object
- containing a single "VAVAILABILITY" component.
+ returned by a PROPFIND DAV:allprop request. Support for this
+ property is REQUIRED. The value of this property MUST be a valid
+ iCalendar object containing "VAVAILABILITY" components and
+ "VTIMEZONE" components (if required) only.
Description: This property allows a user to specify their
- availability by including a VAVAILABILITY component in the value
- of this property. If present, the server MUST use the
- "VAVAILABILITY" component in the value of this property when
- determining free-busy information as part of an iTIP VFREEBUSY
- requested being handled by the server.
+ availability by including "VAVAILABILITY" components in the value
+ of this property. If present, the server MUST use these
+ "VAVAILABILITY" components when determining free-busy information
+ as part of an iTIP free-busy request being handled by the server.
Definition:
<!ELEMENT calendar-availability (#PCDATA) >
- ; Data value MUST be iCalendar object containing a
- ; "VAVAILABILITY" component.
+ ; Data value MUST be iCalendar object containing
+ ; "VAVAILABILITY" or "VTIMEZONE" components.
Example:
@@ -721,16 +724,13 @@
-
-
-
-Daboo & Desruisseaux Expires May 7, 2009 [Page 13]
+Daboo & Desruisseaux Expires October 16, 2011 [Page 13]
-Internet-Draft Calendar Availability November 2008
+Internet-Draft Calendar Availability April 2011
<C:calendar-availability xmlns:D="DAV:"
- xmlns:C="urn:ietf:params:xml:ns:caldav"
+ xmlns:C="urn:ietf:params:xml:ns:caldav"
>BEGIN:VCALENDAR
CALSCALE:GREGORIAN
PRODID:-//example.com//iCalendar 2.0//EN
@@ -753,49 +753,38 @@
TZOFFSETTO:-0500
END:STANDARD
END:VTIMEZONE
- BEGIN:VEVENT
- DTSTAMP:20061113T044111Z
- DTSTART;TZID=America/Montreal:20061106T120000
- DURATION:PT1H
- SUMMARY:Meeting
- UID:60A48841ECB90F3F215FE3D2 at example.com
- END:VEVENT
BEGIN:VAVAILABILITY
- UID:20061005T133225Z-00001 at example.com
- DTSTAMP:20061005T133225Z
- DTSTART;TZID=America/Montreal:20061002T000000
+ UID:20111005T133225Z-00001 at example.com
+ DTSTAMP:20111005T133225Z
+ DTSTART;TZID=America/Montreal:20111002T000000
BEGIN:AVAILABLE
- UID:20061005T133225Z-00001-A at example.com
+ UID:20111005T133225Z-00001-A at example.com
SUMMARY:Monday to Friday from 9:00 to 18:00
- DTSTART;TZID=America/Montreal:20061002T090000
- DTEND;TZID=America/Montreal:20061002T180000
+ DTSTART;TZID=America/Montreal:20111002T090000
+ DTEND;TZID=America/Montreal:20111002T180000
RRULE:FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR
END:AVAILABLE
END:VAVAILABILITY
END:VCALENDAR
</C:calendar-availability>
+5.2.4. iTIP free-busy requests
-
-
-
-
-Daboo & Desruisseaux Expires May 7, 2009 [Page 14]
-
-Internet-Draft Calendar Availability November 2008
-
-
-5.2.4. iTIP VFREEBUSY requests
-
- The [I-D.desruisseaux-caldav-sched] processing of a "VFREEBUSY"
+ The [I-D.desruisseaux-caldav-sched] processing of an iTIP free-busy
request targeted at the owner of the CALDAV:schedule-inbox will
include free-busy information derived from "VAVAILABILITY" components
in any calendar collection targeted during the request, as described
- in Section 4. In addition, any "VAVAILABILITY" component specified
+ in Section 4. In addition, any "VAVAILABILITY" components specified
in the CALDAV:calendar-availability property on the owner's Inbox,
MUST be included in the free-busy calculation.
+
+Daboo & Desruisseaux Expires October 16, 2011 [Page 14]
+
+Internet-Draft Calendar Availability April 2011
+
+
6. Security Considerations
Free-busy information generated from "VAVAILABILITY" components MUST
@@ -804,8 +793,7 @@
"DESCRIPTION" MUST NOT be copied into the free-busy result data.
Beyond this, this specification does not add any additional security
- issues that are not already present in [I-D.ietf-calsify-rfc2445bis]
- and [I-D.ietf-calsify-2446bis].
+ issues that are not already present in [RFC5545] and [RFC5546].
7. IANA Considerations
@@ -813,8 +801,7 @@
7.1. Component Registrations
This documents defines the following new iCalendar components to be
- added to the registry defined in Section 8.2.2 of
- [I-D.ietf-calsify-rfc2445bis]:
+ added to the registry defined in Section 8.2.2 of [RFC5545]:
+---------------+---------+----------------------+
| Component | Status | Reference |
@@ -826,21 +813,8 @@
7.2. Property Registrations
This documents defines the following new iCalendar properties to be
- added to the registry defined in Section 8.2.3 of
- [I-D.ietf-calsify-rfc2445bis]:
+ added to the registry defined in Section 8.2.3 of [RFC5545]:
-
-
-
-
-
-
-
-Daboo & Desruisseaux Expires May 7, 2009 [Page 15]
-
-Internet-Draft Calendar Availability November 2008
-
-
+----------+---------+----------------------+
| Property | Status | Reference |
+----------+---------+----------------------+
@@ -850,41 +824,42 @@
8. Acknowledgments
- This specification came about via discussions at the Calendaring and
- Scheduling Consortium.
+ Thanks to the following for providing feedback: Toby Considine, Mike
+ Douglass, and Dave Thewlis. This specification came about via
+ discussions at the Calendaring and Scheduling Consortium.
9. Normative References
[I-D.desruisseaux-caldav-sched]
Daboo, C. and B. Desruisseaux, "CalDAV Scheduling
- Extensions to WebDAV", draft-desruisseaux-caldav-sched-06
- (work in progress), November 2008.
- [I-D.ietf-calsify-2446bis]
- Daboo, C., "iCalendar Transport-Independent
- Interoperability Protocol (iTIP)",
- draft-ietf-calsify-2446bis-08 (work in progress),
- November 2008.
- [I-D.ietf-calsify-rfc2445bis]
- Desruisseaux, B., "Internet Calendaring and Scheduling
- Core Object Specification (iCalendar)",
- draft-ietf-calsify-rfc2445bis-09 (work in progress),
- November 2008.
+Daboo & Desruisseaux Expires October 16, 2011 [Page 15]
+
+Internet-Draft Calendar Availability April 2011
+
+
+ Extensions to WebDAV", draft-desruisseaux-caldav-sched-09
+ (work in progress), October 2010.
+
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, March 1997.
- [RFC2518] Goland, Y., Whitehead, E., Faizi, A., Carter, S., and D.
- Jensen, "HTTP Extensions for Distributed Authoring --
- WEBDAV", RFC 2518, February 1999.
-
[RFC4791] Daboo, C., Desruisseaux, B., and L. Dusseault,
"Calendaring Extensions to WebDAV (CalDAV)", RFC 4791,
March 2007.
+ [RFC5545] Desruisseaux, B., "Internet Calendaring and Scheduling
+ Core Object Specification (iCalendar)", RFC 5545,
+ September 2009.
+ [RFC5546] Daboo, C., "iCalendar Transport-Independent
+ Interoperability Protocol (iTIP)", RFC 5546,
+ December 2009.
+
+
Appendix A. Example Calendar #1
@@ -892,9 +867,34 @@
-Daboo & Desruisseaux Expires May 7, 2009 [Page 16]
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Daboo & Desruisseaux Expires October 16, 2011 [Page 16]
-Internet-Draft Calendar Availability November 2008
+Internet-Draft Calendar Availability April 2011
iCalendar object
@@ -922,21 +922,21 @@
END:STANDARD
END:VTIMEZONE
BEGIN:VEVENT
- DTSTAMP:20061113T044111Z
- DTSTART;TZID=America/Montreal:20061106T120000
+ DTSTAMP:20111113T044111Z
+ DTSTART;TZID=America/Montreal:20111106T120000
DURATION:PT1H
SUMMARY:Meeting
UID:60A48841ECB90F3F215FE3D2 at example.com
END:VEVENT
BEGIN:VAVAILABILITY
- UID:20061005T133225Z-00001 at example.com
- DTSTAMP:20061005T133225Z
- DTSTART;TZID=America/Montreal:20061002T000000
+ UID:20111005T133225Z-00001 at example.com
+ DTSTAMP:20111005T133225Z
+ DTSTART;TZID=America/Montreal:20111002T000000
BEGIN:AVAILABLE
- UID:20061005T133225Z-00001-A at example.com
+ UID:20111005T133225Z-00001-A at example.com
SUMMARY:Monday to Friday from 9:00 to 18:00
- DTSTART;TZID=America/Montreal:20061002T090000
- DTEND;TZID=America/Montreal:20061002T180000
+ DTSTART;TZID=America/Montreal:20111002T090000
+ DTEND;TZID=America/Montreal:20111002T180000
RRULE:FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR
END:AVAILABLE
END:VAVAILABILITY
@@ -948,16 +948,26 @@
-Daboo & Desruisseaux Expires May 7, 2009 [Page 17]
+Daboo & Desruisseaux Expires October 16, 2011 [Page 17]
-Internet-Draft Calendar Availability November 2008
+Internet-Draft Calendar Availability April 2011
Appendix B. Change History (To be removed by RFC Editor before
publication)
- Changes from -00:
+ Changes in -02:
+ 1. Updated to 5545/5546 references.
+
+ 2. Fixed some examples.
+
+ 3. Added some more properties to the components
+
+ 4. Fixed text that said dtstart was required in VAVAILABILITY
+
+ Changes in -01:
+
1. Allow property on Inbox for caldav-schedule.
2. Clarify that DURATION can only be present in VAVAILABILITY if
@@ -994,71 +1004,5 @@
-
-
-
-
-
-
-
-
-
-
-Daboo & Desruisseaux Expires May 7, 2009 [Page 18]
+Daboo & Desruisseaux Expires October 16, 2011 [Page 18]
-Internet-Draft Calendar Availability November 2008
-
-
-Full Copyright Statement
-
- Copyright (C) The IETF Trust (2008).
-
- This document is subject to the rights, licenses and restrictions
- contained in BCP 78, and except as set forth therein, the authors
- retain all their rights.
-
- This document and the information contained herein are provided on an
- "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS
- OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE IETF TRUST AND
- THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS
- OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF
- THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
- WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
-
-
-Intellectual Property
-
- The IETF takes no position regarding the validity or scope of any
- Intellectual Property Rights or other rights that might be claimed to
- pertain to the implementation or use of the technology described in
- this document or the extent to which any license under such rights
- might or might not be available; nor does it represent that it has
- made any independent effort to identify any such rights. Information
- on the procedures with respect to rights in RFC documents can be
- found in BCP 78 and BCP 79.
-
- Copies of IPR disclosures made to the IETF Secretariat and any
- assurances of licenses to be made available, or the result of an
- attempt made to obtain a general license or permission for the use of
- such proprietary rights by implementers or users of this
- specification can be obtained from the IETF on-line IPR repository at
- http://www.ietf.org/ipr.
-
- The IETF invites any interested party to bring to its attention any
- copyrights, patents or patent applications, or other proprietary
- rights that may cover technology that may be required to implement
- this standard. Please address the information to the IETF at
- ietf-ipr at ietf.org.
-
-
-
-
-
-
-
-
-
-
-
-Daboo & Desruisseaux Expires May 7, 2009 [Page 19]
-
Modified: CalendarServer/trunk/doc/RFC/draft-daboo-webdav-sync.txt
===================================================================
--- CalendarServer/trunk/doc/RFC/draft-daboo-webdav-sync.txt 2011-09-01 14:47:28 UTC (rev 8039)
+++ CalendarServer/trunk/doc/RFC/draft-daboo-webdav-sync.txt 2011-09-01 15:06:35 UTC (rev 8040)
@@ -4,12 +4,12 @@
Network Working Group C. Daboo
Internet-Draft Apple, Inc.
Intended status: Standards Track A. Quillaud
-Expires: April 8, 2011 Oracle
- October 5, 2010
+Expires: January 12, 2012 Oracle
+ July 11, 2011
Collection Synchronization for WebDAV
- draft-daboo-webdav-sync-04
+ draft-daboo-webdav-sync-06
Abstract
@@ -40,11 +40,11 @@
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."
- This Internet-Draft will expire on April 8, 2011.
+ This Internet-Draft will expire on January 12, 2012.
Copyright Notice
- Copyright (c) 2010 IETF Trust and the persons identified as the
+ Copyright (c) 2011 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal
@@ -52,9 +52,9 @@
-Daboo & Quillaud Expires April 8, 2011 [Page 1]
+Daboo & Quillaud Expires January 12, 2012 [Page 1]
-Internet-Draft WebDAV Sync October 2010
+Internet-Draft WebDAV Sync July 2011
(http://trustee.ietf.org/license-info) in effect on the date of
@@ -108,9 +108,9 @@
-Daboo & Quillaud Expires April 8, 2011 [Page 2]
+Daboo & Quillaud Expires January 12, 2012 [Page 2]
-Internet-Draft WebDAV Sync October 2010
+Internet-Draft WebDAV Sync July 2011
Table of Contents
@@ -120,36 +120,39 @@
3. WebDAV Synchronization . . . . . . . . . . . . . . . . . . . . 5
3.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . 5
3.2. DAV:sync-collection Report . . . . . . . . . . . . . . . . 6
- 3.3. Depth behavior . . . . . . . . . . . . . . . . . . . . . . 7
- 3.4. Types of Changes Reported on Initial Synchronization . . . 8
+ 3.3. Depth behavior . . . . . . . . . . . . . . . . . . . . . . 8
+ 3.4. Types of Changes Reported on Initial Synchronization . . . 9
3.5. Types of Changes Reported on Subsequent
- Synchronizations . . . . . . . . . . . . . . . . . . . . . 8
- 3.5.1. Changed Resource . . . . . . . . . . . . . . . . . . . 8
- 3.5.2. Removed Resource . . . . . . . . . . . . . . . . . . . 9
- 3.6. Truncation of Results . . . . . . . . . . . . . . . . . . 9
- 3.7. Limiting Results . . . . . . . . . . . . . . . . . . . . . 10
+ Synchronizations . . . . . . . . . . . . . . . . . . . . . 9
+ 3.5.1. Changed Member . . . . . . . . . . . . . . . . . . . . 9
+ 3.5.2. Removed Member . . . . . . . . . . . . . . . . . . . . 10
+ 3.6. Truncation of Results . . . . . . . . . . . . . . . . . . 10
+ 3.7. Limiting Results . . . . . . . . . . . . . . . . . . . . . 11
3.8. Example: Initial DAV:sync-collection Report . . . . . . . 11
- 3.9. Example: DAV:sync-collection Report with Token . . . . . . 12
+ 3.9. Example: DAV:sync-collection Report with Token . . . . . . 13
3.10. Example: Initial DAV:sync-collection Report with
- Truncation . . . . . . . . . . . . . . . . . . . . . . . . 15
- 3.11. Example: Initial DAV:sync-collection Report with Limit . . 16
+ Truncation . . . . . . . . . . . . . . . . . . . . . . . . 16
+ 3.11. Example: Initial DAV:sync-collection Report with Limit . . 17
3.12. Example: DAV:sync-collection Report with Unsupported
- Limit . . . . . . . . . . . . . . . . . . . . . . . . . . 18
+ Limit . . . . . . . . . . . . . . . . . . . . . . . . . . 19
3.13. Example: Depth:infinity initial DAV:sync-collection
- Report . . . . . . . . . . . . . . . . . . . . . . . . . . 18
- 4. DAV:sync-token Property . . . . . . . . . . . . . . . . . . . 21
- 5. XML Element Definitions . . . . . . . . . . . . . . . . . . . 21
- 5.1. DAV:sync-collection XML Element . . . . . . . . . . . . . 22
- 5.2. DAV:sync-token XML Element . . . . . . . . . . . . . . . . 22
- 5.3. DAV:multistatus XML Element . . . . . . . . . . . . . . . 22
- 6. Security Considerations . . . . . . . . . . . . . . . . . . . 23
- 7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 23
- 8. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 23
- 9. References . . . . . . . . . . . . . . . . . . . . . . . . . . 23
- 9.1. Normative References . . . . . . . . . . . . . . . . . . . 23
- 9.2. Informative References . . . . . . . . . . . . . . . . . . 24
+ Report . . . . . . . . . . . . . . . . . . . . . . . . . . 19
+ 4. DAV:sync-token Property . . . . . . . . . . . . . . . . . . . 22
+ 5. DAV:sync-token Use with If Header . . . . . . . . . . . . . . 22
+ 5.1. Example: If Pre-Condition with PUT . . . . . . . . . . . . 23
+ 5.2. Example: If Pre-Condition with MKCOL . . . . . . . . . . . 23
+ 6. XML Element Definitions . . . . . . . . . . . . . . . . . . . 24
+ 6.1. DAV:sync-collection XML Element . . . . . . . . . . . . . 24
+ 6.2. DAV:sync-token XML Element . . . . . . . . . . . . . . . . 24
+ 6.3. DAV:multistatus XML Element . . . . . . . . . . . . . . . 25
+ 7. Security Considerations . . . . . . . . . . . . . . . . . . . 25
+ 8. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 26
+ 9. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 26
+ 10. References . . . . . . . . . . . . . . . . . . . . . . . . . . 26
+ 10.1. Normative References . . . . . . . . . . . . . . . . . . . 26
+ 10.2. Informative References . . . . . . . . . . . . . . . . . . 27
Appendix A. Change History (to be removed prior to
- publication as an RFC) . . . . . . . . . . . . . . . 24
+ publication as an RFC) . . . . . . . . . . . . . . . 27
@@ -161,12 +164,9 @@
-
-
-
-Daboo & Quillaud Expires April 8, 2011 [Page 3]
+Daboo & Quillaud Expires January 12, 2012 [Page 3]
-Internet-Draft WebDAV Sync October 2010
+Internet-Draft WebDAV Sync July 2011
1. Introduction
@@ -179,19 +179,20 @@
detect what has changed and update their cache). This can currently
be done using a WebDAV PROPFIND request on a collection to list all
members of a collection along with their DAV:getetag property values,
- which allows the client to determine which resources were changed,
- added or deleted. However, this does not scale well to large
- collections as the XML response to the PROPFIND request will grow
- with the collection size.
+ which allows the client to determine which were changed, added or
+ deleted. However, this does not scale well to large collections as
+ the XML response to the PROPFIND request will grow with the
+ collection size.
This specification defines a new WebDAV report that results in the
- server returning to the client only information about those resources
- which have changed, are new or were deleted since a previous
- execution of the report on the collection.
+ server returning to the client only information about those member
+ URIs that were added or deleted, or whose mapped resources were
+ changed, since a previous execution of the report on the collection.
Additionally, a new property is added to collection resources that is
used to convey a "synchronization token" that is guaranteed to change
- when resources within the collection have changed.
+ when the collection's member URIs or their mapped resources have
+ changed.
2. Conventions Used in This Document
@@ -216,15 +217,16 @@
4. extension attributes (attributes not already defined as valid for
this element) may be added anywhere, except when explicitly
- stated otherwise.
-Daboo & Quillaud Expires April 8, 2011 [Page 4]
+Daboo & Quillaud Expires January 12, 2012 [Page 4]
-Internet-Draft WebDAV Sync October 2010
+Internet-Draft WebDAV Sync July 2011
+ stated otherwise.
+
When an XML element type in the "DAV:" namespace is referenced in
this document outside of the context of an XML fragment, the string
"DAV:" will be prefixed to the element type.
@@ -257,30 +259,30 @@
Typically, the first time a client connects to the server it will
need to be informed of the entire state of the collection (i.e., a
- full list of all resources that are currently contained in the
- collection). That is done by the client sending an empty token value
- to the server. This indicates to the server that a full listing is
+ full list of all member URIs that are currently in the collection).
+ That is done by the client sending an empty token value to the
+ server. This indicates to the server that a full listing is
required.
As an alternative, the client might choose to do its first
synchronization using some other mechanism on the collection (e.g.
some other form of batch resource information retrieval such as
- PROPFIND, SEARCH [RFC5323], or specialized REPORTs such as those
+ PROPFIND, SEARCH [RFC5323] , or specialized REPORTs such as those
defined in CalDAV [RFC4791] and CardDAV [I-D.ietf-vcarddav-carddav])
and ask for the DAV:sync-token property to be returned. This
property (defined in Section 4) contains the same token that can be
used later on to issue a DAV:sync-collection report.
- In some cases a server might only wish to maintain a limited amount
- of history about changes to a collection. In that situation it will
-Daboo & Quillaud Expires April 8, 2011 [Page 5]
+Daboo & Quillaud Expires January 12, 2012 [Page 5]
-Internet-Draft WebDAV Sync October 2010
+Internet-Draft WebDAV Sync July 2011
+ In some cases a server might only wish to maintain a limited amount
+ of history about changes to a collection. In that situation it will
return an error to the client when the client presents a token that
is "out of date". At that point the client has to fall back to
synchronizing the entire collection by re-running the report request
@@ -293,28 +295,32 @@
set" property on any collection supporting synchronization.
To implement the behavior for this report a server needs to keep
- track of changes to any member resources in a collection (as defined
- in Section 3 of [RFC4918]). This includes noting the addition of new
- resources, changes to existing resources and removal of resources.
- The server will track each change and provide a synchronization
- "token" to the client that describes the state of the server at a
- specific point in time. This "token" is returned as part of the
- response to the "sync-collection" report. Clients include the last
- token they got from the server in the next "sync-collection" report
- that they execute and the server provides the changes from the
- previous state, represented by the token, to the current state,
- represented by the new token returned.
+ track of changes to any member URIs and their mapped resources in a
+ collection (as defined in Section 3 of [RFC4918]). This includes
+ noting the addition of new member URIs, changes to the mapped
+ resources of existing member URIs, and removal of member URIs. The
+ server will track each change and provide a synchronization "token"
+ to the client that describes the state of the server at a specific
+ point in time. This "token" is returned as part of the response to
+ the "sync-collection" report. Clients include the last token they
+ got from the server in the next "sync-collection" report that they
+ execute and the server provides the changes from the previous state,
+ represented by the token, to the current state, represented by the
+ new token returned.
The synchronization token itself is an "opaque" string - i.e., the
- actual string data has no specific meaning or syntax. For example, a
- simple implementation of such a token could be a numeric counter that
- counts each change as it occurs and relates that change to the
- specific object that changed.
+ actual string data has no specific meaning or syntax. However, the
+ token MUST be a valid URI to allow its use in an If pre-condition
+ request header (see Section 5). For example, a simple implementation
+ of such a token could be a numeric counter that counts each change as
+ it occurs and relates that change to the specific object that
+ changed. The numeric value could be appended to a "base" URI to form
+ the valid sync-token.
Marshalling:
The request URI MUST identify a collection. The request body MUST
- be a DAV:sync-collection XML element (see Section 5.1), which MUST
+ be a DAV:sync-collection XML element (see Section 6.1), which MUST
contain one DAV:sync-token XML element, and one DAV:prop XML
element, and MAY contain a DAV:limit XML element.
@@ -323,47 +329,53 @@
The response body for a successful request MUST be a DAV:
multistatus XML element, which MUST contain one DAV:sync-token
- element in addition to one DAV:response element for each resource
- that was created, has changed or been deleted since the last
- synchronization operation as specified by the DAV:sync-token
- provided in the request. A given resource MUST appear only once
- in the response.
-
-Daboo & Quillaud Expires April 8, 2011 [Page 6]
+Daboo & Quillaud Expires January 12, 2012 [Page 6]
-Internet-Draft WebDAV Sync October 2010
+Internet-Draft WebDAV Sync July 2011
+ element in addition to one DAV:response element for each member
+ URI that was added, has had its mapped resource changed, or was
+ deleted since the last synchronization operation as specified by
+ the DAV:sync-token provided in the request. A given member URI
+ MUST appear only once in the response. In the case where multiple
+ member URIs of the request-URI are mapped to the same resource, if
+ the resource is changed, each member URI MUST be returned in the
+ response.
+
The content of each DAV:response element differs depending on how
- the resource was altered:
+ the member was altered:
- For resources that have changed (i.e., are new or have been
- modified) the DAV:response MUST contain at least one DAV:
- propstat element and MUST NOT contain any DAV:status element.
+ For members that have changed (i.e., are new or have had their
+ mapped resource modified) the DAV:response MUST contain at
+ least one DAV:propstat element and MUST NOT contain any DAV:
+ status element.
- For resources that have been removed, the DAV:response MUST
+ For members that have been removed, the DAV:response MUST
contain one DAV:status with a value set to '404 Not Found' and
MUST NOT contain any DAV:propstat element.
- For child collection resources that are unable to support the
+ For members that are collections and are unable to support the
DAV:sync-collection report, the DAV:response MUST contain one
- DAV:status with a value set to '405 Method Not Allowed' and
- MUST NOT contain any DAV:propstat element.
+ DAV:status with a value set to '403 Forbidden', a DAV:error
+ containing DAV:supported-report or DAV:sync-traversal-supported
+ (see Section 3.3 for which is appropriate), and MUST NOT
+ contain any DAV:propstat element.
The conditions under which each type of change can occur is
further described in Section 3.5.
Preconditions:
- (DAV:valid-sync-token): The DAV:sync-token element value MUST map
- to a valid token previously returned by the server. A token may
- become invalid as the result of being "out of date" (out of the
- range of change history maintained by the server), or for other
- reasons (e.g. collection deleted, then recreated, access control
- changes, etc...).
+ (DAV:valid-sync-token): The DAV:sync-token element value MUST be a
+ valid token previously returned by the server. A token can become
+ invalid as the result of being "out of date" (out of the range of
+ change history maintained by the server), or for other reasons
+ (e.g. collection deleted, then recreated, access control changes,
+ etc...).
Postconditions:
@@ -374,28 +386,29 @@
server is unable to truncate the result set at or below that
limit.
-3.3. Depth behavior
- The DAV:sync-collection report supports both Depth:1 and Depth:
- infinity request headers.
- o When the client specifies Depth:1, only additions, changes or
- removals of immediate children of the collection specified as the
- request URI are reported.
+Daboo & Quillaud Expires January 12, 2012 [Page 7]
+
+Internet-Draft WebDAV Sync July 2011
- o When the client specifies Depth:infinity, additions, changes or
- removals of any child resource of the collection specified as the
+3.3. Depth behavior
+ Servers MUST support both Depth:1 and Depth:infinity behavior with
+ the DAV:sync-collection report. Clients MUST include either a
+ Depth:1 or Depth:infinity request header with the DAV:sync-collection
+ report.
-Daboo & Quillaud Expires April 8, 2011 [Page 7]
-
-Internet-Draft WebDAV Sync October 2010
+ o When the client specifies a Depth:1 request header, only
+ appropriate internal member URIs (immediate children) of the
+ collection specified as the request URI are reported.
+ o When the client specifies a Depth:infinity request header, all
+ appropriate member URIs of the collection specified as the request
+ URI are reported, provided child collections themselves also
+ support the DAV:sync-collection report.
- request URI are reported, provided child collections themselves
- also support the DAV:sync-collection report.
-
o DAV:sync-token values returned by the server are not specific to
the value of the Depth header used in the request. As such
clients MAY use a DAV:sync-token value from a request with one
@@ -404,107 +417,125 @@
Note that when a server supports Depth:infinity reports, it might not
be possible to synchronize some child collections within the
- collection targeted by the report. In such cases the server is
- REQUIRED to return a DAV:response with status '405 Method Not
- Allowed' to inform the client that alternative methods have to be
- used to synchronize the contents of those collections. The 405
- response MUST be sent once, when the collection is first reported to
- the client.
+ collection targeted by the report. When this occurs, the server MUST
+ include a DAV:response element for the child collection with status
+ '403 Forbidden'. The 403 response MUST be sent once, when the
+ collection is first reported to the client. In addition, the server
+ MUST include a DAV:error element in the DAV:response element,
+ indicating one of two possible causes for this:
+ The DAV:sync-collection report is not supported at all on the
+ child collection. The DAV:error element MUST contain the DAV:
+ supported-report element.
+
+ The server is unwilling to report results for the child collection
+ when a Depth:infinity DAV:sync-collection report is executed on a
+ parent resource. This might happen when, for example, the
+ synchronization state of the collection resource is controlled by
+ another sub-system. In such cases clients can perform the DAV:
+ sync-collection report directly on the child collection instead.
+ The DAV:error element MUST contain the DAV:sync-traversal-
+ supported element.
+
+
+
+
+
+
+
+
+Daboo & Quillaud Expires January 12, 2012 [Page 8]
+
+Internet-Draft WebDAV Sync July 2011
+
+
3.4. Types of Changes Reported on Initial Synchronization
When the DAV:sync-collection request contains an empty DAV:sync-token
- element, the server MUST return all members of the collection (taking
- account of Depth header requirements as per Section 3.3, and optional
- truncation of results set as per Section 3.6) and it MUST NOT return
- any removed resources. All types of resource (collection or non-
- collection) MUST be reported.
+ element, the server MUST return all member URIs of the collection
+ (taking account of Depth header requirements as per Section 3.3, and
+ optional truncation of results set as per Section 3.6) and it MUST
+ NOT return any removed member URIs. All types of member (collection
+ or non-collection) MUST be reported.
3.5. Types of Changes Reported on Subsequent Synchronizations
When the DAV:sync-collection request contains a valid value for the
- DAV:sync-token element, two types of resource state changes can be
+ DAV:sync-token element, two types of member URI state changes can be
returned (changed or removed). This section defines what triggers
each of these to be returned. It also clarifies the case where a
- resource may have undergone multiple changes between two
+ member URI might have undergone multiple changes between two
synchronization report requests. In all cases, the Depth header
requirements as per Section 3.3, and optional truncation of results
set as per Section 3.6, are taken into account by the server.
-3.5.1. Changed Resource
+3.5.1. Changed Member
- A resource MUST be reported as changed if it has been mapped as an
+ A member URI MUST be reported as changed if it has been mapped as a
member of the target collection since the request sync-token was
- generated. This includes resources that have been mapped as the
- result of a COPY, MOVE or BIND [RFC5842] request. All types of
- resource (collection or non-collection) MUST be reported.
+ generated. This includes member URIs that have been mapped as the
+ result of a COPY, MOVE, BIND [RFC5842], or REBIND [RFC5842] request.
+ All types of member URI (collection or non-collection) MUST be
+ reported.
- In the case where a mapping between a resource and the target
+ In the case where a mapping between a member URI and the target
collection was removed, then a new mapping with the same URI created,
+ the member URI MUST be reported as changed and MUST NOT be reported
+ as removed.
+ A member URI MUST be reported as changed if its mapped resource's
+ entity tag value (defined in Section 3.11 of [RFC2616]) has changed
+ since the request sync-token was generated.
+ A member URI MAY be reported as changed if the user issuing the
+ request was granted access to this member URI, due to access control
+ changes.
-Daboo & Quillaud Expires April 8, 2011 [Page 8]
-
-Internet-Draft WebDAV Sync October 2010
+ Collection member URIs MUST be returned as changed if they are mapped
+ to an underlying resource (i.e., entity body) and if the entity tag
+ associated with that resource changes. There is no guarantee that
+ changes to members of a collection will result in a change in any
+ entity tag of that collection, so clients cannot rely on a series of
+ Depth:1 reports at multiple levels to track all changes within a
- the new resource MUST be reported as changed while the old resource
- MUST NOT be reported as removed. For example, if a resource was
- deleted, then recreated using the same URI, it should be reported as
- a changed resource only.
- A resource MUST be reported as changed if its entity tag value
- (defined in Section 3.11 of [RFC2616]) has changed since the request
- sync-token was generated.
+Daboo & Quillaud Expires January 12, 2012 [Page 9]
+
+Internet-Draft WebDAV Sync July 2011
- A resource MAY be reported as changed if the user issuing the request
- was granted access to this resource, due to access control changes.
- Collection resources MUST be returned as changed if they have an
- entity tag associated with them and that entity tag changes. There
- is no guarantee that changes to members of a collection will result
- in a change in any entity tag of that collection, so clients cannot
- rely on a series of Depth:1 reports at multiple levels to track all
- changes within a collection. Instead Depth:infinity has to be used.
+ collection. Instead Depth:infinity has to be used.
-3.5.2. Removed Resource
+3.5.2. Removed Member
- A resource MUST be reported as removed if its mapping under the
- target collection has been removed since the request sync-token was
+ A member MUST be reported as removed if its mapping under the target
+ collection has been removed since the request sync-token was
generated, and it has not been re-mapped since it was removed. This
- includes resources that have been unmapped as the result of a MOVE or
- UNBIND [RFC5842] operation. This also includes collection resources
- that have been removed, including ones that themselves do not support
- the DAV:sync-collection report.
+ includes members that have been unmapped as the result of a MOVE,
+ UNBIND [RFC5842], or REBIND [RFC5842] operation. This also includes
+ collection members that have been removed, including ones that
+ themselves do not support the DAV:sync-collection report.
- If a resource was created (and possibly modified), then removed
- between two synchronization report requests, it MUST be reported as
- removed. This ensures that a client that creates a resource is
- informed of the removal of the resource, if the removal occurs before
- the client has had a chance to request a synchronization report.
+ If a member was added (and its mapped resource possibly modified),
+ then removed between two synchronization report requests, it MUST be
+ reported as removed. This ensures that a client that adds a member
+ is informed of the removal of the member, if the removal occurs
+ before the client has had a chance to execute a synchronization
+ report.
- A resource MAY be reported as removed if the user issuing the request
- no longer has access to this resource, due to access control changes.
+ A member MAY be reported as removed if the user issuing the request
+ no longer has access to this member, due to access control changes.
For a Depth:infinity report where a collection is removed, the server
- MUST NOT report the removal of any resources that are members of the
- removed collection. Clients MUST assume that if a collection is
- reported as being removed, then all internal members of that
- collection have also been removed.
+ MUST NOT report the removal of any members of the removed collection.
+ Clients MUST assume that if a collection is reported as being
+ removed, then all members of that collection have also been removed.
3.6. Truncation of Results
- A server MAY limit the number of resources in a response, for
+ A server MAY limit the number of member URIs in a response, for
example, to limit the amount of work expended in processing a
-
-
-
-Daboo & Quillaud Expires April 8, 2011 [Page 9]
-
-Internet-Draft WebDAV Sync October 2010
-
-
request, or as the result of an explicit limit set by the client. If
the result set is truncated, the response MUST use status code 207,
return a DAV:multistatus response body, and indicate a status of 507
@@ -522,18 +553,28 @@
consistent manner.
Clients MUST handle the 507 status on the request-URI in the response
+
+
+
+Daboo & Quillaud Expires January 12, 2012 [Page 10]
+
+Internet-Draft WebDAV Sync July 2011
+
+
to the report.
For example, consider a server that records changes using a
monotonically increasing integer to represent a "revision number" and
- uses that quantity as the DAV:sync-token value. Assume the last DAV:
- sync-token used by the client was "10", and since then 15 additional
- changes have occurred. If the client executes a DAV:sync-collection
- request with a DAV:sync-token of "10", without a limit the server
- would return 15 DAV:response elements and a DAV:sync-token with value
- "25". But if the server choose to limit responses to at most 10
- changes, then it would return only 10 DAV:response elements and a
- DAV:sync-token with value "20", together with an addition DAV:
+ uses that quantity as the DAV:sync-token value (appropriately encoded
+ as a URI). Assume the last DAV:sync-token used by the client was
+ "http://example.com/sync/10", and since then 15 additional changes
+ have occurred. If the client executes a DAV:sync-collection request
+ with a DAV:sync-token of "http://example.com/sync/10", without a
+ limit the server would return 15 DAV:response elements and a DAV:
+ sync-token with value "http://example.com/sync/25". But if the
+ server choose to limit responses to at most 10 changes, then it would
+ return only 10 DAV:response elements and a DAV:sync-token with value
+ "http://example.com/sync/20", together with an additional DAV:
response element for the request-URI with a status code of 507.
Subsequently, the client can re-issue the request with the DAV:sync-
token value returned from the server and fetch the remaining 5
@@ -551,16 +592,6 @@
server MUST follow the rules above for indicating a result set
truncation to the client.
-
-
-
-
-
-Daboo & Quillaud Expires April 8, 2011 [Page 10]
-
-Internet-Draft WebDAV Sync October 2010
-
-
3.8. Example: Initial DAV:sync-collection Report
In this example, the client is making its first synchronization
@@ -570,6 +601,22 @@
in the targeted collection. The current synchronization token is
also returned.
+
+
+
+
+
+
+
+
+
+
+
+Daboo & Quillaud Expires January 12, 2012 [Page 11]
+
+Internet-Draft WebDAV Sync July 2011
+
+
>> Request <<
@@ -599,59 +646,59 @@
<?xml version="1.0" encoding="utf-8" ?>
<D:multistatus xmlns:D="DAV:">
<D:response>
- <D:href
+ <D:href
>http://webdav.example.com/home/cyrusdaboo/test.doc</D:href>
- <D:propstat>
- <D:prop>
- <D:getetag>"00001-abcd1"</D:getetag>
- <R:bigbox xmlns:R="urn:ns.example.com:boxschema">
- <R:BoxType>Box type A</R:BoxType>
- </R:bigbox>
- </D:prop>
- <D:status>HTTP/1.1 200 OK</D:status>
+ <D:propstat>
+ <D:prop>
+ <D:getetag>"00001-abcd1"</D:getetag>
+ <R:bigbox xmlns:R="urn:ns.example.com:boxschema">
+ <R:BoxType>Box type A</R:BoxType>
+ </R:bigbox>
+ </D:prop>
+ <D:status>HTTP/1.1 200 OK</D:status>
+ </D:propstat>
+ </D:response>
+ <D:response>
+ <D:href
+ >http://webdav.example.com/home/cyrusdaboo/vcard.vcf</D:href>
+ <D:propstat>
+ <D:prop>
+ <D:getetag>"00002-abcd1"</D:getetag>
+ </D:prop>
-Daboo & Quillaud Expires April 8, 2011 [Page 11]
+Daboo & Quillaud Expires January 12, 2012 [Page 12]
-Internet-Draft WebDAV Sync October 2010
+Internet-Draft WebDAV Sync July 2011
- </D:propstat>
+ <D:status>HTTP/1.1 200 OK</D:status>
+ </D:propstat>
+ <D:propstat>
+ <D:prop>
+ <R:bigbox xmlns:R="urn:ns.example.com:boxschema"/>
+ </D:prop>
+ <D:status>HTTP/1.1 404 Not Found</D:status>
+ </D:propstat>
</D:response>
<D:response>
- <D:href
- >http://webdav.example.com/home/cyrusdaboo/vcard.vcf</D:href>
- <D:propstat>
- <D:prop>
- <D:getetag>"00002-abcd1"</D:getetag>
- </D:prop>
- <D:status>HTTP/1.1 200 OK</D:status>
- </D:propstat>
- <D:propstat>
- <D:prop>
- <R:bigbox xmlns:R="urn:ns.example.com:boxschema"/>
- </D:prop>
- <D:status>HTTP/1.1 404 Not Found</D:status>
- </D:propstat>
- </D:response>
- <D:response>
- <D:href
+ <D:href
>http://webdav.example.com/home/cyrusdaboo/calendar.ics</D:href>
- <D:propstat>
- <D:prop>
- <D:getetag>"00003-abcd1"</D:getetag>
- </D:prop>
- <D:status>HTTP/1.1 200 OK</D:status>
- </D:propstat>
- <D:propstat>
- <D:prop>
- <R:bigbox xmlns:R="urn:ns.example.com:boxschema"/>
- </D:prop>
- <D:status>HTTP/1.1 404 Not Found</D:status>
- </D:propstat>
+ <D:propstat>
+ <D:prop>
+ <D:getetag>"00003-abcd1"</D:getetag>
+ </D:prop>
+ <D:status>HTTP/1.1 200 OK</D:status>
+ </D:propstat>
+ <D:propstat>
+ <D:prop>
+ <R:bigbox xmlns:R="urn:ns.example.com:boxschema"/>
+ </D:prop>
+ <D:status>HTTP/1.1 404 Not Found</D:status>
+ </D:propstat>
</D:response>
- <D:sync-token>1234</D:sync-token>
+ <D:sync-token>http://example.com/ns/sync/1234</D:sync-token>
</D:multistatus>
@@ -668,9 +715,18 @@
-Daboo & Quillaud Expires April 8, 2011 [Page 12]
+
+
+
+
+
+
+
+
+
+Daboo & Quillaud Expires January 12, 2012 [Page 13]
-Internet-Draft WebDAV Sync October 2010
+Internet-Draft WebDAV Sync July 2011
>> Request <<
@@ -684,7 +740,7 @@
<?xml version="1.0" encoding="utf-8" ?>
<D:sync-collection xmlns:D="DAV:">
- <D:sync-token>1234</D:sync-token>
+ <D:sync-token>http://example.com/ns/sync/1234</D:sync-token>
<D:prop xmlns:R="urn:ns.example.com:boxschema">
<D:getetag/>
<R:bigbox/>
@@ -724,9 +780,9 @@
-Daboo & Quillaud Expires April 8, 2011 [Page 13]
+Daboo & Quillaud Expires January 12, 2012 [Page 14]
-Internet-Draft WebDAV Sync October 2010
+Internet-Draft WebDAV Sync July 2011
>> Response <<
@@ -739,50 +795,50 @@
<?xml version="1.0" encoding="utf-8" ?>
<D:multistatus xmlns:D="DAV:">
<D:response>
- <D:href
+ <D:href
>http://webdav.example.com/home/cyrusdaboo/file.xml</D:href>
- <D:propstat>
- <D:prop>
- <D:getetag>"00004-abcd1"</D:getetag>
- </D:prop>
- <D:status>HTTP/1.1 200 OK</D:status>
- </D:propstat>
- <D:propstat>
- <D:prop>
- <R:bigbox xmlns:R="urn:ns.example.com:boxschema"/>
- </D:prop>
- <D:status>HTTP/1.1 404 Not Found</D:status>
- </D:propstat>
+ <D:propstat>
+ <D:prop>
+ <D:getetag>"00004-abcd1"</D:getetag>
+ </D:prop>
+ <D:status>HTTP/1.1 200 OK</D:status>
+ </D:propstat>
+ <D:propstat>
+ <D:prop>
+ <R:bigbox xmlns:R="urn:ns.example.com:boxschema"/>
+ </D:prop>
+ <D:status>HTTP/1.1 404 Not Found</D:status>
+ </D:propstat>
</D:response>
<D:response>
- <D:href
+ <D:href
>http://webdav.example.com/home/cyrusdaboo/vcard.vcf</D:href>
- <D:propstat>
- <D:prop>
- <D:getetag>"00002-abcd2"</D:getetag>
- </D:prop>
- <D:status>HTTP/1.1 200 OK</D:status>
- </D:propstat>
- <D:propstat>
- <D:prop>
- <R:bigbox xmlns:R="urn:ns.example.com:boxschema"/>
- </D:prop>
- <D:status>HTTP/1.1 404 Not Found</D:status>
- </D:propstat>
+ <D:propstat>
+ <D:prop>
+ <D:getetag>"00002-abcd2"</D:getetag>
+ </D:prop>
+ <D:status>HTTP/1.1 200 OK</D:status>
+ </D:propstat>
+ <D:propstat>
+ <D:prop>
+ <R:bigbox xmlns:R="urn:ns.example.com:boxschema"/>
+ </D:prop>
+ <D:status>HTTP/1.1 404 Not Found</D:status>
+ </D:propstat>
</D:response>
<D:response>
- <D:href
+ <D:href
>http://webdav.example.com/home/cyrusdaboo/test.doc</D:href>
- <D:status>HTTP/1.1 404 Not Found</D:status>
+ <D:status>HTTP/1.1 404 Not Found</D:status>
</D:response>
- <D:sync-token>1238</D:sync-token>
+ <D:sync-token>http://example.com/ns/sync/1238</D:sync-token>
</D:multistatus>
-Daboo & Quillaud Expires April 8, 2011 [Page 14]
+Daboo & Quillaud Expires January 12, 2012 [Page 15]
-Internet-Draft WebDAV Sync October 2010
+Internet-Draft WebDAV Sync July 2011
3.10. Example: Initial DAV:sync-collection Report with Truncation
@@ -836,9 +892,9 @@
-Daboo & Quillaud Expires April 8, 2011 [Page 15]
+Daboo & Quillaud Expires January 12, 2012 [Page 16]
-Internet-Draft WebDAV Sync October 2010
+Internet-Draft WebDAV Sync July 2011
>> Response <<
@@ -851,24 +907,24 @@
<?xml version="1.0" encoding="utf-8" ?>
<D:multistatus xmlns:D="DAV:">
<D:response>
- <D:href
+ <D:href
>http://webdav.example.com/home/cyrusdaboo/test.doc</D:href>
- <D:propstat>
- <D:prop>
- <D:getetag>"00001-abcd1"</D:getetag>
- </D:prop>
- <D:status>HTTP/1.1 200 OK</D:status>
- </D:propstat>
+ <D:propstat>
+ <D:prop>
+ <D:getetag>"00001-abcd1"</D:getetag>
+ </D:prop>
+ <D:status>HTTP/1.1 200 OK</D:status>
+ </D:propstat>
</D:response>
<D:response>
- <D:href
+ <D:href
>http://webdav.example.com/home/cyrusdaboo/vcard.vcf</D:href>
- <D:propstat>
- <D:prop>
- <D:getetag>"00002-abcd1"</D:getetag>
- </D:prop>
- <D:status>HTTP/1.1 200 OK</D:status>
- </D:propstat>
+ <D:propstat>
+ <D:prop>
+ <D:getetag>"00002-abcd1"</D:getetag>
+ </D:prop>
+ <D:status>HTTP/1.1 200 OK</D:status>
+ </D:propstat>
</D:response>
<D:response>
<D:href
@@ -876,7 +932,7 @@
<D:status>HTTP/1.1 507 Insufficient Storage</D:status>
<D:error><D:number-of-matches-within-limits/></D:error>
</D:response>
- <D:sync-token>1233</D:sync-token>
+ <D:sync-token>http://example.com/ns/sync/1233</D:sync-token>
</D:multistatus>
@@ -892,9 +948,9 @@
-Daboo & Quillaud Expires April 8, 2011 [Page 16]
+Daboo & Quillaud Expires January 12, 2012 [Page 17]
-Internet-Draft WebDAV Sync October 2010
+Internet-Draft WebDAV Sync July 2011
>> Request <<
@@ -928,14 +984,14 @@
<?xml version="1.0" encoding="utf-8" ?>
<D:multistatus xmlns:D="DAV:">
<D:response>
- <D:href
+ <D:href
>http://webdav.example.com/home/cyrusdaboo/test.doc</D:href>
- <D:propstat>
- <D:prop>
- <D:getetag>"00001-abcd1"</D:getetag>
- </D:prop>
- <D:status>HTTP/1.1 200 OK</D:status>
- </D:propstat>
+ <D:propstat>
+ <D:prop>
+ <D:getetag>"00001-abcd1"</D:getetag>
+ </D:prop>
+ <D:status>HTTP/1.1 200 OK</D:status>
+ </D:propstat>
</D:response>
<D:response>
<D:href
@@ -943,14 +999,14 @@
<D:status>HTTP/1.1 507 Insufficient Storage</D:status>
<D:error><D:number-of-matches-within-limits/></D:error>
</D:response>
- <D:sync-token>1232</D:sync-token>
+ <D:sync-token>http://example.com/ns/sync/1232</D:sync-token>
</D:multistatus>
-Daboo & Quillaud Expires April 8, 2011 [Page 17]
+Daboo & Quillaud Expires January 12, 2012 [Page 18]
-Internet-Draft WebDAV Sync October 2010
+Internet-Draft WebDAV Sync July 2011
3.12. Example: DAV:sync-collection Report with Unsupported Limit
@@ -973,7 +1029,7 @@
<?xml version="1.0" encoding="utf-8" ?>
<D:sync-collection xmlns:D="DAV:">
- <D:sync-token>1232</D:sync-token>
+ <D:sync-token>http://example.com/ns/sync/1232</D:sync-token>
<D:limit>
<D:nresults>100</D:nresults>
</D:limit>
@@ -1004,9 +1060,9 @@
-Daboo & Quillaud Expires April 8, 2011 [Page 18]
+Daboo & Quillaud Expires January 12, 2012 [Page 19]
-Internet-Draft WebDAV Sync October 2010
+Internet-Draft WebDAV Sync July 2011
getetag property and for a proprietary property. The server responds
@@ -1016,7 +1072,7 @@
The collection /home/cyrusdaboo/collection1/ exists and has one child
resource which is also reported. The collection /home/cyrusdaboo/
collection2/ exists but has no child resources. The collection
- /home/cyrusdaboo/shared/ is returned with a 405 status indicating
+ /home/cyrusdaboo/shared/ is returned with a 403 status indicating
that a collection exists but it is unable to report on changes within
it in the scope of the current Depth:infinity report. Instead the
client can try a DAV:sync-collection report directly on the
@@ -1051,85 +1107,81 @@
<?xml version="1.0" encoding="utf-8" ?>
<D:multistatus xmlns:D="DAV:">
<D:response>
- <D:href
- >/home/cyrusdaboo/collection1/</D:href>
- <D:propstat>
- <D:prop>
- <D:getetag>"00001-abcd1"</D:getetag>
- <R:bigbox xmlns:R="urn:ns.example.com:boxschema">
+ <D:href>/home/cyrusdaboo/collection1/</D:href>
+ <D:propstat>
+ <D:prop>
+ <D:getetag>"00001-abcd1"</D:getetag>
+ <R:bigbox xmlns:R="urn:ns.example.com:boxschema">
+ <R:BoxType>Box type A</R:BoxType>
-Daboo & Quillaud Expires April 8, 2011 [Page 19]
+Daboo & Quillaud Expires January 12, 2012 [Page 20]
-Internet-Draft WebDAV Sync October 2010
+Internet-Draft WebDAV Sync July 2011
- <R:BoxType>Box type A</R:BoxType>
- </R:bigbox>
- </D:prop>
- <D:status>HTTP/1.1 200 OK</D:status>
- </D:propstat>
+ </R:bigbox>
+ </D:prop>
+ <D:status>HTTP/1.1 200 OK</D:status>
+ </D:propstat>
</D:response>
<D:response>
- <D:href
- >/home/cyrusdaboo/collection1/test.doc</D:href>
- <D:propstat>
- <D:prop>
- <D:getetag>"00001-abcd1"</D:getetag>
- <R:bigbox xmlns:R="urn:ns.example.com:boxschema">
- <R:BoxType>Box type A</R:BoxType>
- </R:bigbox>
- </D:prop>
- <D:status>HTTP/1.1 200 OK</D:status>
- </D:propstat>
+ <D:href>/home/cyrusdaboo/collection1/test.doc</D:href>
+ <D:propstat>
+ <D:prop>
+ <D:getetag>"00001-abcd1"</D:getetag>
+ <R:bigbox xmlns:R="urn:ns.example.com:boxschema">
+ <R:BoxType>Box type A</R:BoxType>
+ </R:bigbox>
+ </D:prop>
+ <D:status>HTTP/1.1 200 OK</D:status>
+ </D:propstat>
</D:response>
<D:response>
- <D:href
- >/home/cyrusdaboo/collection2/</D:href>
- <D:propstat>
- <D:prop>
- <D:getetag>"00002-abcd1"</D:getetag>
- </D:prop>
- <D:status>HTTP/1.1 200 OK</D:status>
- </D:propstat>
- <D:propstat>
- <D:prop>
- <R:bigbox xmlns:R="urn:ns.example.com:boxschema"/>
- </D:prop>
- <D:status>HTTP/1.1 404 Not Found</D:status>
- </D:propstat>
+ <D:href>/home/cyrusdaboo/collection2/</D:href>
+ <D:propstat>
+ <D:prop>
+ <D:getetag/>
+ </D:prop>
+ <D:status>HTTP/1.1 404 Not Found</D:status>
+ </D:propstat>
+ <D:propstat>
+ <D:prop>
+ <R:bigbox xmlns:R="urn:ns.example.com:boxschema"/>
+ </D:prop>
+ <D:status>HTTP/1.1 404 Not Found</D:status>
+ </D:propstat>
</D:response>
<D:response>
- <D:href
- >/home/cyrusdaboo/calendar.ics</D:href>
- <D:propstat>
- <D:prop>
- <D:getetag>"00003-abcd1"</D:getetag>
- </D:prop>
- <D:status>HTTP/1.1 200 OK</D:status>
- </D:propstat>
- <D:propstat>
- <D:prop>
- <R:bigbox xmlns:R="urn:ns.example.com:boxschema"/>
- </D:prop>
+ <D:href>/home/cyrusdaboo/calendar.ics</D:href>
+ <D:propstat>
+ <D:prop>
+ <D:getetag>"00003-abcd1"</D:getetag>
+ </D:prop>
+ <D:status>HTTP/1.1 200 OK</D:status>
+ </D:propstat>
+ <D:propstat>
+ <D:prop>
+ <R:bigbox xmlns:R="urn:ns.example.com:boxschema"/>
+ </D:prop>
+ <D:status>HTTP/1.1 404 Not Found</D:status>
+ </D:propstat>
+ </D:response>
+ <D:response>
-Daboo & Quillaud Expires April 8, 2011 [Page 20]
+Daboo & Quillaud Expires January 12, 2012 [Page 21]
-Internet-Draft WebDAV Sync October 2010
+Internet-Draft WebDAV Sync July 2011
- <D:status>HTTP/1.1 404 Not Found</D:status>
- </D:propstat>
+ <D:href>/home/cyrusdaboo/shared/</D:href>
+ <D:status>HTTP/1.1 403 Forbidden</D:status>
+ <D:error><D:sync-traversal-supported/></D:error>
</D:response>
- <D:response>
- <D:href
- >/home/cyrusdaboo/shared/</D:href>
- <D:status>HTTP/1.1 405 Method Not Allowed</D:status>
- </D:response>
- <D:sync-token>1234</D:sync-token>
+ <D:sync-token>http://example.com/ns/sync/1234</D:sync-token>
</D:multistatus>
@@ -1142,7 +1194,7 @@
Purpose: Contains the value of the synchronization token as it would
be returned by a DAV:sync-collection report.
- Value: Any text.
+ Value: Any valid URI.
Protected: MUST be protected because this value is created and
controlled by the server.
@@ -1162,23 +1214,100 @@
<!ELEMENT sync-token #PCDATA>
+ <!-- Text MUST be a valid URI -->
-5. XML Element Definitions
+5. DAV:sync-token Use with If Header
+ WebDAV provides an If pre-condition header that allows for "state
+ tokens" to be used as pre-conditions on HTTP requests (as defined in
+ Section 10.4 of [RFC4918]). This specification allows the DAV:sync-
+ token value to be used as one such token in an If header. By using
+ this, clients can ensure requests only complete when there have been
+ no changes to the content of a collection, by virtue of an un-changed
+Daboo & Quillaud Expires January 12, 2012 [Page 22]
+
+Internet-Draft WebDAV Sync July 2011
+ DAV:sync-token value. Servers MUST support use of DAV:sync-token
+ values in If request headers.
-Daboo & Quillaud Expires April 8, 2011 [Page 21]
+5.1. Example: If Pre-Condition with PUT
+
+ In this example, the client has already used the DAV:sync-collection
+ report to synchronize the collection /home/cyrusdaboo/collection/.
+ Now it wants to add a new resource to the collection, but only if
+ there have been no other changes since the last synchronization.
+ Note, that because the DAV:sync-token is defined on the collection
+ and not on the resource targeted by the request, the If header value
+ needs to use the "Resource_Tag" construct for the header syntax to
+ correctly identify that the supplied state token refers to the
+ collection resource.
+
+ >> Request <<
+
+
+ PUT /home/cyrusdaboo/collection/newresource.txt HTTP/1.1
+ Host: webdav.example.com
+ If: </home/cyrusdaboo/collection/>
+ (<http://example.com/ns/sync/12345>)
+ Content-Type: text/plain; charset="utf-8"
+ Content-Length: xxxx
+
+ Some content here...
+
+
+ >> Response <<
+
+
+ HTTP/1.1 201 Created
+
+
+5.2. Example: If Pre-Condition with MKCOL
+
+ In this example, the client has already used the DAV:sync-collection
+ report to synchronize the collection /home/cyrusdaboo/collection/.
+ Now it wants to add a new collection to the collection, but only if
+ there have been no other changes since the last synchronization.
+ Note, that because the DAV:sync-token is defined on the collection
+ and not on the resource targeted by the request, the If header value
+ needs to use the "Resource_Tag" construct for the header syntax to
+ correctly identify that the supplied state token refers to the
+ collection resource. In this case the request fails as another
+ change has occurred to the collection corresponding to the supplied
+ DAV:sync-token.
+
+
+
+
+Daboo & Quillaud Expires January 12, 2012 [Page 23]
-Internet-Draft WebDAV Sync October 2010
+Internet-Draft WebDAV Sync July 2011
-5.1. DAV:sync-collection XML Element
+ >> Request <<
+
+ MKCOL /home/cyrusdaboo/collection/child/ HTTP/1.1
+ Host: webdav.example.com
+ If: </home/cyrusdaboo/collection/>
+ (<http://example.com/ns/sync/12346>)
+
+
+ >> Response <<
+
+
+ HTTP/1.1 412 Pre-condition Failed
+
+
+6. XML Element Definitions
+
+6.1. DAV:sync-collection XML Element
+
Name: sync-collection
Namespace: DAV:
@@ -1196,7 +1325,7 @@
<!-- DAV:prop defined in RFC 4918, Section 14.18 -->
-5.2. DAV:sync-token XML Element
+6.2. DAV:sync-token XML Element
Name: sync-token
@@ -1205,14 +1334,26 @@
Purpose: The synchronization token provided by the server and
returned by the client.
+
+
+
+
+
+
+Daboo & Quillaud Expires January 12, 2012 [Page 24]
+
+Internet-Draft WebDAV Sync July 2011
+
+
Description: See Section 3.
<!ELEMENT sync-token CDATA>
+ <!-- Text MUST be a URI -->
-5.3. DAV:multistatus XML Element
+6.3. DAV:multistatus XML Element
Name: multistatus
@@ -1225,14 +1366,6 @@
-
-
-
-Daboo & Quillaud Expires April 8, 2011 [Page 22]
-
-Internet-Draft WebDAV Sync October 2010
-
-
<!ELEMENT multistatus (DAV:response*, DAV:responsedescription?,
sync-token?) >
@@ -1242,27 +1375,48 @@
<!-- DAV:responsedescription defined in RFC 4918, Section 14.25 -->
-6. Security Considerations
+7. Security Considerations
- This extension does not introduce any new security concerns than
- those already described in HTTP and WebDAV.
+ Servers MUST take care to limit the scope of DAV:sync-collection
+ requests so that clients cannot use excessive server resources by
+ executing, for example, a Depth:infinity report on the root URI. For
+ example, CalDAV [RFC4791] servers might only support the DAV:sync-
+ collection report on user calendar home collections, and prevent use
+ of the report on the parent resource of all calendar homes (assuming
+ there is one). That way each individual user's request is scoped to
+ changes only within their own calendar home and not across the entire
+ set of calendar users.
-7. IANA Considerations
+ Beyond the above considerations, this extension does not introduce
+ any new security concerns than those already described in HTTP and
+ WebDAV.
+
+
+
+
+
+Daboo & Quillaud Expires January 12, 2012 [Page 25]
+
+Internet-Draft WebDAV Sync July 2011
+
+
+8. IANA Considerations
+
This document does not require any actions on the part of IANA.
-8. Acknowledgments
+9. Acknowledgments
The following individuals contributed their ideas and support for
- writing this specification: Bernard Desruisseaux, Mike Douglass, Ciny
- Joy, Andrew McMillan, Julian Reschke, and Wilfredo Sanchez. We would
- like to thank the Calendaring and Scheduling Consortium for
- facilitating interoperability testing for early implementations of
- this specification.
+ writing this specification: Bernard Desruisseaux, Werner Donne, Mike
+ Douglass, Ciny Joy, Andrew McMillan, Julian Reschke, and Wilfredo
+ Sanchez. We would like to thank the Calendaring and Scheduling
+ Consortium for facilitating interoperability testing for early
+ implementations of this specification.
-9. References
+10. References
-9.1. Normative References
+10.1. Normative References
[RFC2119] Bradner, S., "Key words for use in RFCs
to Indicate Requirement Levels", BCP 14,
@@ -1281,14 +1435,6 @@
May 2004.
[RFC4918] Dusseault, L., "HTTP Extensions for Web
-
-
-
-Daboo & Quillaud Expires April 8, 2011 [Page 23]
-
-Internet-Draft WebDAV Sync October 2010
-
-
Distributed Authoring and Versioning
(WebDAV)", RFC 4918, June 2007.
@@ -1297,7 +1443,20 @@
and Versioning (WebDAV) SEARCH",
RFC 5323, November 2008.
+ [RFC5842] Clemm, G., Crawford, J., Reschke, J.,
+ and J. Whitehead, "Binding Extensions to
+ Web Distributed Authoring and Versioning
+ (WebDAV)", RFC 5842, April 2010.
+
[W3C.REC-xml-20081126] Paoli, J., Yergeau, F., Bray, T.,
+
+
+
+Daboo & Quillaud Expires January 12, 2012 [Page 26]
+
+Internet-Draft WebDAV Sync July 2011
+
+
Sperberg-McQueen, C., and E. Maler,
"Extensible Markup Language (XML) 1.0
(Fifth Edition)", World Wide Web
@@ -1305,7 +1464,7 @@
20081126, November 2008, <http://
www.w3.org/TR/2008/REC-xml-20081126>.
-9.2. Informative References
+10.2. Informative References
[I-D.ietf-vcarddav-carddav] Daboo, C., "vCard Extensions to WebDAV
(CardDAV)",
@@ -1316,16 +1475,44 @@
Dusseault, "Calendaring Extensions to
WebDAV (CalDAV)", RFC 4791, March 2007.
- [RFC5842] Clemm, G., Crawford, J., Reschke, J.,
- and J. Whitehead, "Binding Extensions to
- Web Distributed Authoring and Versioning
- (WebDAV)", RFC 5842, April 2010.
-
Appendix A. Change History (to be removed prior to publication as an
RFC)
+ Changes in -06:
+
+ 1. Changed the 405 error into a 403 with a DAV:error element.
+
+ 2. Stated more clearly that both depth:1 and depth:infinity must be
+ supported.
+
+ 3. Tied up sync-token as URI changes.
+
+ 4. Made BIND a normative reference.
+
+ 5. Take into account REBIND.
+
+ 6. Reworked text to more accurately make the distinction between
+ member URIs and resources, which should clarify the interaction
+ with extensions like BIND.
+
+ Changes in -05:
+
+ 1. Added option to use DAV:sync-token as an If pre-condition state
+ token.
+
+ 2. DAV:sync-token value now required to be a URI so it can be used
+ in the If header.
+
Changes in -04:
+
+
+
+Daboo & Quillaud Expires January 12, 2012 [Page 27]
+
+Internet-Draft WebDAV Sync July 2011
+
+
1. Depth:infinity support added.
2. Collection resources are now reported as changed if they have a
@@ -1337,14 +1524,6 @@
2. Added request for dead property in examples.
-
-
-
-Daboo & Quillaud Expires April 8, 2011 [Page 24]
-
-Internet-Draft WebDAV Sync October 2010
-
-
3. Made D:prop mandatory in request so that D:response always
contains at least one D:propstat as per WebDAV definition.
@@ -1382,25 +1561,18 @@
1. Updated to 4918 reference.
- 2. Fixed examples to properly include DAV:status in DAV:propstat
- 3. Switch to using XML conventions text from RFC5323.
+Daboo & Quillaud Expires January 12, 2012 [Page 28]
+
+Internet-Draft WebDAV Sync July 2011
+ 2. Fixed examples to properly include DAV:status in DAV:propstat
+ 3. Switch to using XML conventions text from RFC5323.
-
-
-
-
-
-Daboo & Quillaud Expires April 8, 2011 [Page 25]
-
-Internet-Draft WebDAV Sync October 2010
-
-
Authors' Addresses
Cyrus Daboo
@@ -1448,9 +1620,5 @@
-
-
-
-
-Daboo & Quillaud Expires April 8, 2011 [Page 26]
+Daboo & Quillaud Expires January 12, 2012 [Page 29]
Modified: CalendarServer/trunk/doc/RFC/draft-desruisseaux-caldav-sched.txt
===================================================================
--- CalendarServer/trunk/doc/RFC/draft-desruisseaux-caldav-sched.txt 2011-09-01 14:47:28 UTC (rev 8039)
+++ CalendarServer/trunk/doc/RFC/draft-desruisseaux-caldav-sched.txt 2011-09-01 15:06:35 UTC (rev 8040)
@@ -3,148 +3,97 @@
Network Working Group C. Daboo
Internet-Draft Apple Inc.
-Intended status: Standards Track B. Desruisseaux
-Expires: December 21, 2009 Oracle
- June 19, 2009
+Updates: 4791 (if approved) B. Desruisseaux
+Intended status: Standards Track Oracle
+Expires: April 28, 2011 October 25, 2010
CalDAV Scheduling Extensions to WebDAV
- draft-desruisseaux-caldav-sched-07
+ draft-desruisseaux-caldav-sched-09
+Abstract
+
+ This document defines extensions to the CalDAV "calendar-access"
+ feature to specify a standard way of performing scheduling
+ transactions with iCalendar-based calendar components. This document
+ defines the "calendar-auto-schedule" feature of CalDAV.
+
Status of This Memo
- This Internet-Draft is submitted to IETF in full conformance with the
- provisions of BCP 78 and BCP 79. 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 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.
+ This Internet-Draft is submitted in full conformance with the
+ provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering
- Task Force (IETF), its areas, and its working groups. Note that
- other groups may also distribute working documents as Internet-
- Drafts.
+ Task Force (IETF). Note that other groups may also distribute
+ working documents as Internet-Drafts. The list of current Internet-
+ Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."
- The list of current Internet-Drafts can be accessed at
- http://www.ietf.org/ietf/1id-abstracts.txt.
+ This Internet-Draft will expire on April 28, 2011.
- The list of Internet-Draft Shadow Directories can be accessed at
- http://www.ietf.org/shadow.html.
-
- This Internet-Draft will expire on December 21, 2009.
-
Copyright Notice
- Copyright (c) 2009 IETF Trust and the persons identified as the
+ Copyright (c) 2010 IETF Trust and the persons identified as the
document authors. All rights reserved.
-
-
-
-Daboo & Desruisseaux Expires December 21, 2009 [Page 1]
-
-Internet-Draft CalDAV Scheduling Extensions June 2009
-
-
This document is subject to BCP 78 and the IETF Trust's Legal
- Provisions Relating to IETF Documents in effect on the date of
- publication of this document (http://trustee.ietf.org/license-info).
- Please review these documents carefully, as they describe your rights
- and restrictions with respect to this document.
+ Provisions Relating to IETF Documents
+ (http://trustee.ietf.org/license-info) 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.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Daboo & Desruisseaux Expires December 21, 2009 [Page 2]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 1]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
-Abstract
+ 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
+ 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.
- This document defines extensions to the CalDAV "calendar-access"
- feature to specify a standard way of performing scheduling
- transactions with iCalendar-based calendar components. This document
- defines the "calendar-auto-schedule" feature of CalDAV.
-
Table of Contents
- 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 7
- 1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 7
- 1.2. Approach . . . . . . . . . . . . . . . . . . . . . . . . . 8
- 1.3. Limitations . . . . . . . . . . . . . . . . . . . . . . . 8
- 1.4. Notational Conventions . . . . . . . . . . . . . . . . . . 9
- 1.5. XML Namespaces and Processing . . . . . . . . . . . . . . 9
- 2. Scheduling Process . . . . . . . . . . . . . . . . . . . . . . 11
- 3. Scheduling Support . . . . . . . . . . . . . . . . . . . . . . 12
- 4. Scheduling Collections . . . . . . . . . . . . . . . . . . . . 13
- 4.1. Scheduling Outbox Collection . . . . . . . . . . . . . . . 13
- 4.2. Scheduling Inbox Collection . . . . . . . . . . . . . . . 14
- 4.3. Calendaring Reports Extensions . . . . . . . . . . . . . . 16
- 5. Scheduling Transactions . . . . . . . . . . . . . . . . . . . 17
- 5.1. Identifying Scheduling Object Resources . . . . . . . . . 17
- 5.2. Handling Scheduling Object Resources . . . . . . . . . . . 17
- 5.2.1. Organizer Scheduling Object Resources . . . . . . . . 17
- 5.2.1.1. Create . . . . . . . . . . . . . . . . . . . . . . 18
- 5.2.1.2. Modify . . . . . . . . . . . . . . . . . . . . . . 19
- 5.2.1.3. Remove . . . . . . . . . . . . . . . . . . . . . . 20
- 5.2.2. Attendee Scheduling Object Resources . . . . . . . . . 21
- 5.2.2.1. Allowed Attendee Changes . . . . . . . . . . . . . 21
- 5.2.2.2. Create . . . . . . . . . . . . . . . . . . . . . . 22
- 5.2.2.3. Modify . . . . . . . . . . . . . . . . . . . . . . 22
+ 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 6
+ 1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 6
+ 1.2. Approach . . . . . . . . . . . . . . . . . . . . . . . . . 7
+ 1.3. Limitations . . . . . . . . . . . . . . . . . . . . . . . 7
+ 1.4. Notational Conventions . . . . . . . . . . . . . . . . . . 8
+ 1.5. XML Namespaces and Processing . . . . . . . . . . . . . . 8
+ 2. Scheduling Process . . . . . . . . . . . . . . . . . . . . . . 10
+ 3. Scheduling Support . . . . . . . . . . . . . . . . . . . . . . 11
+ 4. Scheduling Collections . . . . . . . . . . . . . . . . . . . . 12
+ 4.1. Scheduling Outbox Collection . . . . . . . . . . . . . . . 12
+ 4.2. Scheduling Inbox Collection . . . . . . . . . . . . . . . 13
+ 4.3. Calendaring Reports Extensions . . . . . . . . . . . . . . 15
+ 5. Scheduling Transactions . . . . . . . . . . . . . . . . . . . 16
+ 5.1. Identifying Scheduling Object Resources . . . . . . . . . 16
+ 5.2. Handling Scheduling Object Resources . . . . . . . . . . . 16
+ 5.2.1. Organizer Scheduling Object Resources . . . . . . . . 16
+ 5.2.1.1. Create . . . . . . . . . . . . . . . . . . . . . . 17
+ 5.2.1.2. Modify . . . . . . . . . . . . . . . . . . . . . . 18
+ 5.2.1.3. Remove . . . . . . . . . . . . . . . . . . . . . . 19
+ 5.2.2. Attendee Scheduling Object Resources . . . . . . . . . 20
+ 5.2.2.1. Allowed Attendee Changes . . . . . . . . . . . . . 20
+ 5.2.2.2. Create . . . . . . . . . . . . . . . . . . . . . . 21
+ 5.2.2.3. Modify . . . . . . . . . . . . . . . . . . . . . . 21
5.2.2.4. Remove . . . . . . . . . . . . . . . . . . . . . . 22
5.2.3. HTTP Methods . . . . . . . . . . . . . . . . . . . . . 23
5.2.3.1. PUT . . . . . . . . . . . . . . . . . . . . . . . 23
@@ -155,21 +104,21 @@
5.2.4.1. CALDAV:unique-scheduling-object-resource
Precondition . . . . . . . . . . . . . . . . . . . 25
5.2.4.2. CALDAV:same-organizer-in-all-components
- Precondition . . . . . . . . . . . . . . . . . . . 25
- 5.2.4.3. CALDAV:allowed-organizer-scheduling-object-chan
Precondition . . . . . . . . . . . . . . . . . . . 26
- 5.2.4.4. CALDAV:allowed-attendee-scheduling-object-chang
- Precondition . . . . . . . . . . . . . . . . . . . 27
- 5.2.5. DTSTAMP and SEQUENCE Properties . . . . . . . . . . . 27
-Daboo & Desruisseaux Expires December 21, 2009 [Page 3]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 2]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
- 5.2.6. Limit Recurrence Instances Sent to Attendees . . . . . 27
+ 5.2.4.3. CALDAV:allowed-organizer-scheduling-object-chan
+ Precondition . . . . . . . . . . . . . . . . . . . 26
+ 5.2.4.4. CALDAV:allowed-attendee-scheduling-object-chang
+ Precondition . . . . . . . . . . . . . . . . . . . 27
+ 5.2.5. DTSTAMP and SEQUENCE Properties . . . . . . . . . . . 27
+ 5.2.6. Limit Recurrence Instances Sent to Attendees . . . . . 28
5.2.7. Forcing the Server to Send a Scheduling Message . . . 28
6. Processing Incoming Scheduling Messages . . . . . . . . . . . 29
6.1. Processing Attendee Replies . . . . . . . . . . . . . . . 29
@@ -193,102 +142,106 @@
7.2.6. CALDAV:organizer-allowed Precondition . . . . . . . . 36
7.2.7. CALDAV:max-resource-size Precondition . . . . . . . . 37
7.3. Response to a POST request . . . . . . . . . . . . . . . . 37
- 8. Conditional Requests on Scheduling Object Resources . . . . . 38
- 8.1. PUT . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
- 8.2. DELETE . . . . . . . . . . . . . . . . . . . . . . . . . . 40
- 8.3. COPY or MOVE . . . . . . . . . . . . . . . . . . . . . . . 41
- 9. Other Scheduling Considerations . . . . . . . . . . . . . . . 42
- 9.1. Attendee Participation Status . . . . . . . . . . . . . . 42
- 9.2. Schedule Status Values . . . . . . . . . . . . . . . . . . 43
- 9.3. Organizer is an Attendee . . . . . . . . . . . . . . . . . 45
- 10. Additional iCalendar Property Parameters . . . . . . . . . . . 46
- 10.1. Schedule Agent Parameter . . . . . . . . . . . . . . . . . 46
- 10.2. Schedule Force Send Parameter . . . . . . . . . . . . . . 47
- 10.3. Schedule Status Parameter . . . . . . . . . . . . . . . . 48
- 11. Additional Message Header Fields . . . . . . . . . . . . . . . 50
- 11.1. Schedule-Reply Request Header . . . . . . . . . . . . . . 50
- 11.2. Schedule-Tag Response Header . . . . . . . . . . . . . . . 50
- 11.3. If-Schedule-Tag-Match Request Header . . . . . . . . . . . 51
- 12. Additional WebDAV Properties . . . . . . . . . . . . . . . . . 52
- 12.1. CALDAV:schedule-calendar-transp Property . . . . . . . . . 52
- 12.2. CALDAV:schedule-default-calendar-URL Property . . . . . . 53
- 12.3. CALDAV:schedule-tag Property . . . . . . . . . . . . . . . 54
- 13. Scheduling Access Control . . . . . . . . . . . . . . . . . . 55
- 13.1. Scheduling Privileges . . . . . . . . . . . . . . . . . . 55
- 13.1.1. Privileges on Scheduling Inbox Collections . . . . . . 55
- 13.1.1.1. CALDAV:schedule-deliver Privilege . . . . . . . . 55
+ 8. Avoiding Conflicts when Updating Scheduling Object
+ Resources . . . . . . . . . . . . . . . . . . . . . . . . . . 39
+ 8.1. PUT . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
+ 8.2. DELETE . . . . . . . . . . . . . . . . . . . . . . . . . . 41
+ 8.3. COPY or MOVE . . . . . . . . . . . . . . . . . . . . . . . 42
+ 9. Other Scheduling Considerations . . . . . . . . . . . . . . . 43
+ 9.1. Attendee Participation Status . . . . . . . . . . . . . . 43
+ 9.2. Schedule Status Values . . . . . . . . . . . . . . . . . . 44
+ 9.3. Organizer is an Attendee . . . . . . . . . . . . . . . . . 47
+ 10. Additional iCalendar Property Parameters . . . . . . . . . . . 48
+ 10.1. Schedule Agent Parameter . . . . . . . . . . . . . . . . . 48
+ 10.2. Schedule Force Send Parameter . . . . . . . . . . . . . . 49
+ 10.3. Schedule Status Parameter . . . . . . . . . . . . . . . . 50
+ 11. Additional Message Header Fields . . . . . . . . . . . . . . . 52
+ 11.1. Schedule-Reply Request Header . . . . . . . . . . . . . . 52
+ 11.2. Schedule-Tag Response Header . . . . . . . . . . . . . . . 52
+ 11.3. If-Schedule-Tag-Match Request Header . . . . . . . . . . . 53
+ 12. Additional WebDAV Properties . . . . . . . . . . . . . . . . . 54
+ 12.1. CALDAV:schedule-calendar-transp Property . . . . . . . . . 54
-Daboo & Desruisseaux Expires December 21, 2009 [Page 4]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 3]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
- 13.1.1.2. CALDAV:schedule-deliver-invite Privilege . . . . . 56
- 13.1.1.3. CALDAV:schedule-deliver-reply Privilege . . . . . 56
- 13.1.1.4. CALDAV:schedule-query-freebusy Privilege . . . . . 56
- 13.1.2. Privileges on Scheduling Outbox Collections . . . . . 56
- 13.1.2.1. CALDAV:schedule-send Privilege . . . . . . . . . . 56
- 13.1.2.2. CALDAV:schedule-send-invite Privilege . . . . . . 57
- 13.1.2.3. CALDAV:schedule-send-reply Privilege . . . . . . . 57
- 13.1.2.4. CALDAV:schedule-send-freebusy Privilege . . . . . 57
- 13.1.3. Aggregation of Scheduling Privileges . . . . . . . . . 57
- 13.2. Additional Principal Properties . . . . . . . . . . . . . 58
- 13.2.1. CALDAV:schedule-inbox-URL Property . . . . . . . . . . 58
- 13.2.2. CALDAV:schedule-outbox-URL Property . . . . . . . . . 59
- 13.2.3. CALDAV:calendar-user-address-set Property . . . . . . 59
- 13.2.4. CALDAV:calendar-user-type Property . . . . . . . . . . 60
- 14. XML Element Definitions . . . . . . . . . . . . . . . . . . . 62
- 14.1. CALDAV:schedule-response XML Element . . . . . . . . . . . 62
- 14.2. CALDAV:response XML Element . . . . . . . . . . . . . . . 62
- 14.3. CALDAV:recipient XML Element . . . . . . . . . . . . . . . 62
- 14.4. CALDAV:request-status XML Element . . . . . . . . . . . . 63
- 15. Security Considerations . . . . . . . . . . . . . . . . . . . 64
- 15.1. Verifying Scheduling Transactions . . . . . . . . . . . . 64
- 15.2. Verifying Busy Time Information Requests . . . . . . . . . 64
- 15.3. Privacy Issues . . . . . . . . . . . . . . . . . . . . . . 65
- 16. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 66
- 16.1. Message Header Field Registrations . . . . . . . . . . . . 66
- 16.1.1. Schedule-Reply . . . . . . . . . . . . . . . . . . . . 66
- 16.1.2. Schedule-Tag . . . . . . . . . . . . . . . . . . . . . 66
- 16.1.3. If-Schedule-Tag-Match . . . . . . . . . . . . . . . . 66
- 16.2. iCalendar Property Parameter Registrations . . . . . . . . 67
- 16.3. Additional iCalendar Elements Registries . . . . . . . . . 67
- 16.3.1. Schedule Agent Values Registry . . . . . . . . . . . . 67
- 16.3.2. Schedule Force Send Values Registry . . . . . . . . . 67
- 17. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . 69
- 18. References . . . . . . . . . . . . . . . . . . . . . . . . . . 70
- 18.1. Normative References . . . . . . . . . . . . . . . . . . . 70
- 18.2. Informative References . . . . . . . . . . . . . . . . . . 71
- Appendix A. Scheduling Privileges Summary . . . . . . . . . . . . 72
- A.1. Scheduling Inbox Privileges . . . . . . . . . . . . . . . 72
- A.2. Scheduling Outbox Privileges . . . . . . . . . . . . . . . 72
- Appendix B. Example Scheduling Transactions . . . . . . . . . . . 74
- B.1. Example: Organizer Inviting Multiple Attendees . . . . . . 74
- B.2. Example: Attendee Receiving an Invitation . . . . . . . . 76
- B.3. Example: Attendee Replying to an Invitation . . . . . . . 78
- B.4. Example: Organizer Receiving a Reply to an Invitation . . 80
- B.5. Example: Organizer Requesting Busy Time Information . . . 82
- B.6. Example: User Attempting to Invite Attendee on behalf
- of Organizer . . . . . . . . . . . . . . . . . . . . . . . 84
- B.7. Example: Attendee Declining an Instance of a Recurring
+ 12.2. CALDAV:schedule-default-calendar-URL Property . . . . . . 55
+ 12.3. CALDAV:schedule-tag Property . . . . . . . . . . . . . . . 56
+ 13. Scheduling Access Control . . . . . . . . . . . . . . . . . . 57
+ 13.1. Scheduling Privileges . . . . . . . . . . . . . . . . . . 57
+ 13.1.1. Privileges on Scheduling Inbox Collections . . . . . . 57
+ 13.1.1.1. CALDAV:schedule-deliver Privilege . . . . . . . . 57
+ 13.1.1.2. CALDAV:schedule-deliver-invite Privilege . . . . . 58
+ 13.1.1.3. CALDAV:schedule-deliver-reply Privilege . . . . . 58
+ 13.1.1.4. CALDAV:schedule-query-freebusy Privilege . . . . . 58
+ 13.1.2. Privileges on Scheduling Outbox Collections . . . . . 58
+ 13.1.2.1. CALDAV:schedule-send Privilege . . . . . . . . . . 58
+ 13.1.2.2. CALDAV:schedule-send-invite Privilege . . . . . . 59
+ 13.1.2.3. CALDAV:schedule-send-reply Privilege . . . . . . . 59
+ 13.1.2.4. CALDAV:schedule-send-freebusy Privilege . . . . . 59
+ 13.1.3. Aggregation of Scheduling Privileges . . . . . . . . . 59
+ 13.2. Additional Principal Properties . . . . . . . . . . . . . 60
+ 13.2.1. CALDAV:schedule-inbox-URL Property . . . . . . . . . . 60
+ 13.2.2. CALDAV:schedule-outbox-URL Property . . . . . . . . . 61
+ 13.2.3. CALDAV:calendar-user-address-set Property . . . . . . 61
+ 13.2.4. CALDAV:calendar-user-type Property . . . . . . . . . . 62
+ 14. XML Element Definitions . . . . . . . . . . . . . . . . . . . 64
+ 14.1. CALDAV:schedule-response XML Element . . . . . . . . . . . 64
+ 14.2. CALDAV:response XML Element . . . . . . . . . . . . . . . 64
+ 14.3. CALDAV:recipient XML Element . . . . . . . . . . . . . . . 64
+ 14.4. CALDAV:request-status XML Element . . . . . . . . . . . . 65
+ 15. Security Considerations . . . . . . . . . . . . . . . . . . . 66
+ 15.1. Verifying Scheduling Transactions . . . . . . . . . . . . 66
+ 15.2. Verifying Busy Time Information Requests . . . . . . . . . 66
+ 15.3. Privacy Issues . . . . . . . . . . . . . . . . . . . . . . 67
+ 16. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 68
+ 16.1. Message Header Field Registrations . . . . . . . . . . . . 68
+ 16.1.1. Schedule-Reply . . . . . . . . . . . . . . . . . . . . 68
+ 16.1.2. Schedule-Tag . . . . . . . . . . . . . . . . . . . . . 68
+ 16.1.3. If-Schedule-Tag-Match . . . . . . . . . . . . . . . . 68
+ 16.2. iCalendar Property Parameter Registrations . . . . . . . . 69
+ 16.3. iCalendar REQUEST-STATUS Value Registrations . . . . . . . 69
+ 16.4. Additional iCalendar Elements Registries . . . . . . . . . 69
+ 16.4.1. Schedule Agent Values Registry . . . . . . . . . . . . 69
+ 16.4.2. Schedule Force Send Values Registry . . . . . . . . . 70
+ 17. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . 71
+ 18. References . . . . . . . . . . . . . . . . . . . . . . . . . . 72
+ 18.1. Normative References . . . . . . . . . . . . . . . . . . . 72
+ 18.2. Informative References . . . . . . . . . . . . . . . . . . 73
+ Appendix A. Scheduling Privileges Summary . . . . . . . . . . . . 74
+ A.1. Scheduling Inbox Privileges . . . . . . . . . . . . . . . 74
+ A.2. Scheduling Outbox Privileges . . . . . . . . . . . . . . . 74
+ Appendix B. Example Scheduling Transactions . . . . . . . . . . . 76
+ B.1. Example: Organizer Inviting Multiple Attendees . . . . . . 76
-Daboo & Desruisseaux Expires December 21, 2009 [Page 5]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 4]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
- Event . . . . . . . . . . . . . . . . . . . . . . . . . . 85
+ B.2. Example: Attendee Receiving an Invitation . . . . . . . . 78
+ B.3. Example: Attendee Replying to an Invitation . . . . . . . 80
+ B.4. Example: Organizer Receiving a Reply to an Invitation . . 82
+ B.5. Example: Organizer Requesting Busy Time Information . . . 84
+ B.6. Example: User Attempting to Invite Attendee on behalf
+ of Organizer . . . . . . . . . . . . . . . . . . . . . . . 86
+ B.7. Example: Attendee Declining an Instance of a Recurring
+ Event . . . . . . . . . . . . . . . . . . . . . . . . . . 87
B.8. Example: Attendee Removing an Instance of a Recurring
- Event . . . . . . . . . . . . . . . . . . . . . . . . . . 89
+ Event . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Appendix C. Changes (to be removed by RFC Editor prior to
- publication) . . . . . . . . . . . . . . . . . . . . 92
- C.1. Changes in -07 . . . . . . . . . . . . . . . . . . . . . . 92
- C.2. Changes in -06 . . . . . . . . . . . . . . . . . . . . . . 92
- C.3. Changes in -05 . . . . . . . . . . . . . . . . . . . . . . 93
+ publication) . . . . . . . . . . . . . . . . . . . . 94
+ C.1. Changes in -09 . . . . . . . . . . . . . . . . . . . . . . 94
+ C.2. Changes in -08 . . . . . . . . . . . . . . . . . . . . . . 95
+ C.3. Changes in -07 . . . . . . . . . . . . . . . . . . . . . . 95
+ C.4. Changes in -06 . . . . . . . . . . . . . . . . . . . . . . 96
+ C.5. Changes in -05 . . . . . . . . . . . . . . . . . . . . . . 96
@@ -323,31 +276,21 @@
-
-
-
-
-
-
-
-
-
-Daboo & Desruisseaux Expires December 21, 2009 [Page 6]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 5]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
1. Introduction
This document specifies extensions to the CalDAV "calendar-access"
- [RFC4791] feature to enable scheduling of iCalendar-based
- [I-D.ietf-calsify-rfc2445bis] calendar components between Calendar
- Users. This extension leverages the scheduling methods defined in
- the iCalendar Transport-independent Interoperability Protocol (iTIP)
- [I-D.ietf-calsify-2446bis] to permit Calendar Users to perform
- scheduling transactions such as schedule, reschedule, respond to
- scheduling request or cancel scheduled calendar components, as well
- as search for busy time information.
+ [RFC4791] feature to enable scheduling of iCalendar-based [RFC5545]
+ calendar components between Calendar Users. This extension leverages
+ the scheduling methods defined in the iCalendar Transport-independent
+ Interoperability Protocol (iTIP) [RFC5546] to permit Calendar Users
+ to perform scheduling transactions such as schedule, reschedule,
+ respond to scheduling request or cancel scheduled calendar
+ components, as well as search for busy time information.
Discussion of this Internet-Draft is taking place on the mailing list
<https://www.ietf.org/mailman/listinfo/caldav>.
@@ -355,9 +298,9 @@
1.1. Terminology
This specification uses much of the same terminology as iCalendar
- [I-D.ietf-calsify-rfc2445bis], iTIP [I-D.ietf-calsify-2446bis],
- WebDAV [RFC4918], and CalDAV [RFC4791]. The following definitions
- are provided to aid the reader in understanding this specification.
+ [RFC5545], iTIP [RFC5546], WebDAV [RFC4918], and CalDAV [RFC4791].
+ The following definitions are provided to aid the reader in
+ understanding this specification.
Calendar User (CU): An entity (often a human) that accesses calendar
information [RFC3283].
@@ -388,9 +331,10 @@
-Daboo & Desruisseaux Expires December 21, 2009 [Page 7]
+
+Daboo & Desruisseaux Expires April 28, 2011 [Page 6]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
Automatic scheduling transaction: Add, change or remove operations
@@ -409,14 +353,14 @@
1.2. Approach
- iTIP [I-D.ietf-calsify-2446bis] outlines a model where Calendar Users
- exchange scheduling messages with one another. Often times, Calendar
- User Agents are made responsible for generating and sending
- scheduling messages as well as processing incoming scheduling
- messages. This approach yields a number of problems, including:
+ iTIP [RFC5546] outlines a model where Calendar Users exchange
+ scheduling messages with one another. Often times, Calendar User
+ Agents are made responsible for generating and sending scheduling
+ messages as well as processing incoming scheduling messages. This
+ approach yields a number of problems, including:
o For most updates to a scheduled calendar component, Calendar User
- Agents need to address a separate scheduling messages to the
+ Agents need to address separate scheduling messages to the
Organizer or the Attendees.
o The handling of incoming scheduling messages and the updates to
@@ -438,21 +382,20 @@
1.3. Limitations
While the scheduling features described in this specification are
- based on iTIP [I-D.ietf-calsify-2446bis], some of its more complex
- features have deliberately been left out in order to keep this
- specification simple. In particular, the following iTIP
+ based on iTIP [RFC5546], some of its more complex features have
+ deliberately been left out in order to keep this specification
+ simple. In particular, the following iTIP [RFC5546] features are not
-Daboo & Desruisseaux Expires December 21, 2009 [Page 8]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 7]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
- [I-D.ietf-calsify-2446bis] features are not covered: publishing,
- countering, delegating, refreshing and forwarding calendar
- components, as well as replacing the Organizer of a calendar
- component.
+ covered: publishing, countering, delegating, refreshing and
+ forwarding calendar components, as well as replacing the Organizer of
+ a calendar component.
The goal of this specification is to provide the essential scheduling
features needed. It is expected that future extensions will be
@@ -473,48 +416,53 @@
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in [RFC2119].
- When XML element types in the namespaces "DAV:" and
- "urn:ietf:params:xml:ns:caldav" are referenced in this document
- outside of the context of an XML fragment, the string "DAV:" and
- "CALDAV:" will be prefixed to the element types respectively.
+ The term "protected" is used in the Conformance field of property
+ definitions as defined in Section 15 of [RFC4918].
1.5. XML Namespaces and Processing
- Definitions of XML elements in this document use XML element type
- declarations (as found in XML Document Type Declarations), described
- in Section 3.2 of [W3C.REC-xml-20081126].
+ This document uses XML DTD fragments ([W3C.REC-xml-20081126], Section
+ 3.2) as a purely notational convention. WebDAV request and response
+ bodies cannot be validated by a DTD due to the specific extensibility
+ rules defined in Section 17 of [RFC4918] and due to the fact that all
+ XML elements defined by this specification use the XML namespace name
+ "DAV:". In particular:
- The XML elements specified in this document are defined in the
- "urn:ietf:params:xml:ns:caldav" XML namespace registered by CalDAV
- [RFC4791].
+ 1. element names use the "DAV:" namespace,
- The XML declarations used in this document do not include namespace
- information. Thus, implementers must not use these declarations as
- the only way to create valid CalDAV properties or to validate CalDAV
- XML element type. Some of the declarations refer to XML elements
- defined by WebDAV [RFC4918] which use the "DAV:" namespace. Wherever
- such XML elements appear, they are explicitly prefixed with "DAV:" to
- avoid confusion. Additionally, some of the elements used here are
- defined in CalDAV "calendar-access" [RFC4791].
+ 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 XML elements specified in this document are defined in the
-Daboo & Desruisseaux Expires December 21, 2009 [Page 9]
-
-Internet-Draft CalDAV Scheduling Extensions June 2009
- Also note that some CalDAV 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.
+Daboo & Desruisseaux Expires April 28, 2011 [Page 8]
+
+Internet-Draft CalDAV Scheduling Extensions October 2010
- Processing of XML by CalDAV clients and servers MUST follow the rules
- described in Section 17 of [RFC4918].
+ "urn:ietf:params:xml:ns:caldav" XML namespace registered by CalDAV
+ [RFC4791].
+ When XML element types in the namespaces "DAV:" and
+ "urn:ietf:params:xml:ns:caldav" are referenced in this document
+ outside of the context of an XML fragment, the strings "DAV:" and
+ "CALDAV:" will be prefixed to the element types, respectively.
+ This document inherits, and sometimes extends, DTD productions from
+ Section 14 of [RFC4918].
+ Also note that some CalDAV 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.
@@ -552,13 +500,9 @@
-
-
-
-
-Daboo & Desruisseaux Expires December 21, 2009 [Page 10]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 9]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
2. Scheduling Process
@@ -574,7 +518,7 @@
In the first phase, the Organizer will query the busy time
information of each Attendee to determine the most appropriate time
- for the event. This request is sometimes called a freebusy lookup.
+ for the event. This request is sometimes called a "freebusy" lookup.
In the second phase, the Organizer sends out invitations to each
Attendee using the time previously determined from the freebusy
@@ -593,8 +537,8 @@
each Attendee will reply with their participation status in their own
time, so delays in receiving replies are anticipated. Thus
calendaring and scheduling systems should treat these two operational
- phases in different ways to accommodate the user expectations, and
- this specification does that.
+ phases in different ways to accommodate the user expectations, which
+ is what this specification does.
While the scenario described above only covers the case of scheduling
events between Calendar Users, and requesting busy time information,
@@ -612,9 +556,9 @@
-Daboo & Desruisseaux Expires December 21, 2009 [Page 11]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 10]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
3. Scheduling Support
@@ -668,9 +612,9 @@
-Daboo & Desruisseaux Expires December 21, 2009 [Page 12]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 11]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
4. Scheduling Collections
@@ -724,9 +668,9 @@
-Daboo & Desruisseaux Expires December 21, 2009 [Page 13]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 12]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
collection with the POST method.
@@ -750,9 +694,8 @@
scheduling messages submitted to the scheduling Outbox collection
with the POST method.
- While there is currently no defined use for child resources in a
- scheduling Outbox collection, a scheduling Outbox collection MAY
- contain child resources.
+ The use of child resources in a scheduling Outbox collection is
+ reserved for future revisions or extensions of this specification.
4.2. Scheduling Inbox Collection
@@ -775,29 +718,28 @@
</D:resourcetype>
Scheduling Inbox collections MUST only contain calendar object
- resources that obey the restrictions specified in iTIP
- [I-D.ietf-calsify-2446bis]. Consequently, scheduling Inbox
+ resources that obey the restrictions specified in iTIP [RFC5546].
+ Consequently, scheduling Inbox collections MUST NOT contain any types
+ of collection resources. Restrictions defined in Section 4.1 of
-Daboo & Desruisseaux Expires December 21, 2009 [Page 14]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 13]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
- collections MUST NOT contain any types of collection resources.
- Restrictions defined in Section 4.1 of CalDAV "calendar-access"
- [RFC4791] on calendar object resources contained in calendar
- collections (e.g., "UID" uniqueness) don't apply to calendar object
- resources contained in a scheduling Inbox collection. Multiple
- calendar object resources contained in a scheduling Inbox collection
- MAY have the same "UID" property value (i.e., multiple scheduling
- messages for the same calendar component).
+ CalDAV "calendar-access" [RFC4791] on calendar object resources
+ contained in calendar collections (e.g., "UID" uniqueness) don't
+ apply to calendar object resources contained in a scheduling Inbox
+ collection. Thus, multiple calendar object resources contained in a
+ scheduling Inbox collection can have the same "UID" property value
+ (i.e., multiple scheduling messages for the same calendar component).
New WebDAV ACL [RFC3744] privileges can be set on the scheduling
- Inbox collection to control who the Calendar User associated with the
- scheduling Inbox collection will accept scheduling messages from.
- See Section 13.1 for more details.
+ Inbox collection to control from whom the Calendar User associated
+ with the scheduling Inbox collection will accept scheduling messages
+ from. See Section 13.1 for more details.
A scheduling Inbox collection MUST NOT be a child (at any depth) of a
calendar collection resource.
@@ -833,16 +775,16 @@
DATE or DATE-TIME value in scheduling messages delivered to the
scheduling Inbox collection.
+ CALDAV:max-instances - when present this indicates the maximum
+ number of recurrence instances in scheduling messages delivered to
-Daboo & Desruisseaux Expires December 21, 2009 [Page 15]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 14]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
- CALDAV:max-instances - when present this indicates the maximum
- number of recurrence instances in scheduling messages delivered to
the scheduling Inbox collection.
CALDAV:max-attendees-per-instance - when present this indicates
@@ -864,9 +806,8 @@
When a CALDAV:calendar-query REPORT includes a time-range query and
targets a scheduling Inbox collection, if any calendar object
resources contain "VEVENT" calendar components that do not include a
- "DTSTART" iCalendar property (as allowed by iTIP
- [I-D.ietf-calsify-2446bis]) then such components MUST always match
- the time-range query test.
+ "DTSTART" iCalendar property (as allowed by iTIP [RFC5546]) then such
+ components MUST always match the time-range query test.
Note that the CALDAV:free-busy-query REPORT is not supported on
scheduling Inbox collections.
@@ -892,9 +833,12 @@
-Daboo & Desruisseaux Expires December 21, 2009 [Page 16]
+
+
+
+Daboo & Desruisseaux Expires April 28, 2011 [Page 15]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
5. Scheduling Transactions
@@ -911,9 +855,9 @@
5.1. Identifying Scheduling Object Resources
Calendar object resources on which the server performs automatic
- scheduling transactons are refered to as scheduling object resources.
- There are two types of scheduling object resources: organizer
- scheduling object resources, and attendee scheduling object
+ scheduling transactions are referred to as scheduling object
+ resources. There are two types of scheduling object resources:
+ organizer scheduling object resources, and attendee scheduling object
resources.
A calendar object resource is considered to be a valid organizer
@@ -948,9 +892,9 @@
-Daboo & Desruisseaux Expires December 21, 2009 [Page 17]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 16]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
next, and the way these are invoked via HTTP requests is described in
@@ -980,7 +924,7 @@
iCalendar property in the scheduling object resource being created,
and set its value as described in Section 9.2. This will result in
the created calendar object resource differing from the calendar data
- sent in the HTTP request. As a result clients MAY reload the
+ sent in the HTTP request. As a result clients can reload the
calendar data from the server as soon as it is created on the server
in order to update to the new server generated state information.
Servers MUST NOT set the "SCHEDULE-STATUS" property parameter on the
@@ -1004,9 +948,9 @@
-Daboo & Desruisseaux Expires December 21, 2009 [Page 18]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 17]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
in a scheduling object resource contained in another calendar
@@ -1060,9 +1004,9 @@
-Daboo & Desruisseaux Expires December 21, 2009 [Page 19]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 18]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
The attempt to deliver the scheduling message will either succeed or
@@ -1116,9 +1060,9 @@
-Daboo & Desruisseaux Expires December 21, 2009 [Page 20]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 19]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
Restrictions:
@@ -1172,9 +1116,9 @@
-Daboo & Desruisseaux Expires December 21, 2009 [Page 21]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 20]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
5.2.2.2. Create
@@ -1185,31 +1129,83 @@
Section 6). However, in some cases a scheduling message may get
delivered directly to the client, and the Attendee may wish to store
that on the server. In that case the client creates a scheduling
- object resource in a suitable calendar belonging to the Attendee.
- Once stored, it is then subject to the usual rules for attendee
- scheduling object resources.
+ object resource in a suitable calendar belonging to the Attendee. It
+ can then set the "SCHEDULE-AGENT" iCalendar property parameter on all
+ "ORGANIZER" iCalendar properties in the resource to determine how the
+ server treats the resource. The value of the "SCHEDULE-AGENT"
+ iCalendar property parameter on all "ORGANIZER" iCalendar properties
+ MUST be the same.
+ +----------------+--------------------------------------------------+
+ | SCHEDULE-AGENT | Action |
+ +----------------+--------------------------------------------------+
+ | SERVER | The server will attempt to process changes to |
+ | (default) | the resource using the normal rules for attendee |
+ | | scheduling object resources. |
+ | | |
+ | CLIENT | The server does no special processing of the |
+ | | resource. The client is assumed to be handling |
+ | | Attendee replies etc. |
+ | | |
+ | NONE | The server does no special processing of the |
+ | | resource. |
+ +----------------+--------------------------------------------------+
+
In some cases a server may not be able to process an Attendee
scheduling object resource that originated from another system (i.e.,
where the server is unable to deliver scheduling messages to the
- Organizer). In such cases the server MUST add a "SCHEDULE-AGENT"
+ Organizer). In such cases the server MUST add a "SCHEDULE-STATUS"
iCalendar property parameter to all "ORGANIZER" iCalendar properties
- in the resource and set the value of each to "NONE". The server MAY
- reject any attempt by the client to remove the "SCHEDULE-AGENT"
- property parameter or change its value.
+ in the resource with a value indicating a suitable error.
5.2.2.3. Modify
When a scheduling object resource is modified by an Attendee, the
- server will inspect the changes by comparing it with the existing
- scheduling object resource being replaced.
+ server behavior depends on the value of the "SCHEDULE-AGENT"
+ iCalendar property parameter on the "ORGANIZER" iCalendar properties:
+
+
+
+
+
+
+
+
+Daboo & Desruisseaux Expires April 28, 2011 [Page 21]
+
+Internet-Draft CalDAV Scheduling Extensions October 2010
+
+
+ +----------------+--------------------------------------------------+
+ | SCHEDULE-AGENT | Action |
+ +----------------+--------------------------------------------------+
+ | SERVER | The server will attempt to process the removal |
+ | (default) | using the behavior listed below. |
+ | | |
+ | CLIENT | The server does no special processing of the |
+ | | resource. The client is assumed to be handling |
+ | | any Attendee replies etc. |
+ | | |
+ | NONE | The server does no special processing of the |
+ | | resource. |
+ +----------------+--------------------------------------------------+
+
+ The server will inspect the changes by comparing the new scheduling
+ object resource with the existing scheduling object resource.
+
If the Attendee changes one or more "PARTSTAT" iCalendar property
values on any component, or adds an overridden component with a
changed "PARTSTAT" property, then the server MUST deliver an iTIP
"REPLY" scheduling message to the Organizer to indicate the new
participation status of the Attendee.
+ If the Attendee adds an "EXDATE" property value to, in effect, remove
+ an overridden instance, the server MUST deliver an iTIP "REPLY"
+ scheduling message to the Organizer to indicate that the Attendee has
+ declined to instance (i.e., the Attendee's "PARTSTAT" iCalendar
+ property parameter value is set to "DECLINED").
+
The attempt to deliver the scheduling message will either succeed or
fail. In all cases, the server MUST add a "SCHEDULE-STATUS"
iCalendar property parameter to the "ORGANIZER" iCalendar property in
@@ -1222,17 +1218,35 @@
5.2.2.4. Remove
- When a scheduling object resource is removed by the Attendee, one of
- two possibilities exist:
+ When a scheduling object resource is removed by an Attendee, the
+ server behavior depends on the value of the "SCHEDULE-AGENT"
+ iCalendar property parameter on the "ORGANIZER" iCalendar properties:
-Daboo & Desruisseaux Expires December 21, 2009 [Page 22]
+
+
+
+Daboo & Desruisseaux Expires April 28, 2011 [Page 22]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
+ +----------------+--------------------------------------------------+
+ | SCHEDULE-AGENT | Action |
+ +----------------+--------------------------------------------------+
+ | SERVER | The server will attempt to process the removal |
+ | (default) | using either behaviors (1) or (2) listed below. |
+ | | |
+ | CLIENT | The server does no special processing of the |
+ | | resource. The client is assumed to be handling |
+ | | any Attendee replies etc. |
+ | | |
+ | NONE | The server does no special processing of the |
+ | | resource. |
+ +----------------+--------------------------------------------------+
+
1. If the HTTP request contains a "Schedule-Reply" request header
set to the value "T" or there is no "Schedule-Reply" request
header, then the server MUST attempt to deliver a scheduling
@@ -1263,6 +1277,18 @@
When a PUT method request is received, the server will execute the
following actions, provided all appropriate preconditions are met:
+
+
+
+
+
+
+
+Daboo & Desruisseaux Expires April 28, 2011 [Page 23]
+
+Internet-Draft CalDAV Scheduling Extensions October 2010
+
+
+--------------------------+--------------------------+-------------+
| Existing Destination | Resulting Destination | Server |
| Resource | Resource | Action |
@@ -1280,15 +1306,6 @@
| Scheduling object | Calendar object resource | Remove |
| resource | | |
| | | |
-
-
-
-
-Daboo & Desruisseaux Expires December 21, 2009 [Page 23]
-
-Internet-Draft CalDAV Scheduling Extensions June 2009
-
-
| Scheduling object | Scheduling object | Modify |
| resource | resource | |
+--------------------------+--------------------------+-------------+
@@ -1320,6 +1337,14 @@
following actions based on the source and destination collections in
the request:
+
+
+
+Daboo & Desruisseaux Expires April 28, 2011 [Page 24]
+
+Internet-Draft CalDAV Scheduling Extensions October 2010
+
+
+-------------------------+-------------------------+---------------+
| Source Collection | Destination Collection | Server Action |
+-------------------------+-------------------------+---------------+
@@ -1338,13 +1363,6 @@
Note 2. The same rules as used for DELETE below are applied for the
source of the MOVE request.
-
-
-Daboo & Desruisseaux Expires December 21, 2009 [Page 24]
-
-Internet-Draft CalDAV Scheduling Extensions June 2009
-
-
5.2.3.4. DELETE
When a DELETE method is targeted at a scheduling object resource the
@@ -1375,6 +1393,14 @@
already in use by another scheduling object resource owned by the
same user in other calendar collections. Servers SHOULD report
the URL of the scheduling object resource that is already making
+
+
+
+Daboo & Desruisseaux Expires April 28, 2011 [Page 25]
+
+Internet-Draft CalDAV Scheduling Extensions October 2010
+
+
use of the same "UID" property value in the DAV:href element.
Definition:
@@ -1390,17 +1416,6 @@
5.2.4.2. CALDAV:same-organizer-in-all-components Precondition
-
-
-
-
-
-
-Daboo & Desruisseaux Expires December 21, 2009 [Page 25]
-
-Internet-Draft CalDAV Scheduling Extensions June 2009
-
-
Name: same-organizer-in-all-components
Namespace: urn:ietf:params:xml:ns:caldav
@@ -1432,6 +1447,16 @@
Use with: 409 Conflict
+
+
+
+
+
+Daboo & Desruisseaux Expires April 28, 2011 [Page 26]
+
+Internet-Draft CalDAV Scheduling Extensions October 2010
+
+
Purpose: (precondition) -- Servers MAY impose restrictions on
modifications allowed by an Organizer. For instance, servers MAY
prevent the Organizer setting the "PARTSTAT" property parameter to
@@ -1449,14 +1474,6 @@
<C:allowed-organizer-scheduling-object-change
xmlns:C="urn:ietf:params:xml:ns:caldav"/>
-
-
-
-Daboo & Desruisseaux Expires December 21, 2009 [Page 26]
-
-Internet-Draft CalDAV Scheduling Extensions June 2009
-
-
5.2.4.4. CALDAV:allowed-attendee-scheduling-object-change Precondition
Name: allowed-attendee-scheduling-object-change
@@ -1487,14 +1504,21 @@
present and MUST set the value to the UTC time that the scheduling
message was generated (as required by iCalendar).
- iTIP [I-D.ietf-calsify-2446bis] places certain requirements on how
- the "SEQUENCE" iCalendar property value in scheduling messages
- changes. The server MUST ensure that for each type of scheduling
- operation, the "SEQUENCE" iCalendar property value is appropriately
- updated. If the client does not update the "SEQUENCE" iCalendar
- property itself when that is required, the server MUST update the
- property.
+ iTIP [RFC5546] places certain requirements on how the "SEQUENCE"
+
+
+Daboo & Desruisseaux Expires April 28, 2011 [Page 27]
+
+Internet-Draft CalDAV Scheduling Extensions October 2010
+
+
+ iCalendar property value in scheduling messages changes. The server
+ MUST ensure that for each type of scheduling operation, the
+ "SEQUENCE" iCalendar property value is appropriately updated. If the
+ client does not update the "SEQUENCE" iCalendar property itself when
+ that is required, the server MUST update the property.
+
5.2.6. Limit Recurrence Instances Sent to Attendees
When delivering scheduling messages for recurring calendar components
@@ -1505,14 +1529,6 @@
For example, if an Attendee is invited to a single recurrence
instance of a recurring event, and no others, the scheduling object
resource contained in the Organizer's calendar collection will
-
-
-
-Daboo & Desruisseaux Expires December 21, 2009 [Page 27]
-
-Internet-Draft CalDAV Scheduling Extensions June 2009
-
-
contain an overridden instance in the form of a separate calendar
component. That separate calendar component will include the
"ATTENDEE" property referencing the "one-off" Attendee. That
@@ -1548,25 +1564,9 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Daboo & Desruisseaux Expires December 21, 2009 [Page 28]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 28]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
6. Processing Incoming Scheduling Messages
@@ -1607,7 +1607,7 @@
recurring event).
The server MUST also update or add the "SCHEDULE-STATUS" property
- parameter on each matching "ATTENDEE" iCalendar property and sets its
+ parameter on each matching "ATTENDEE" iCalendar property and set its
value to that of the "REQUEST-STATUS" property in the reply, or to
"2.0" if "REQUEST-STATUS" is not present (also taking into account
recurrence instances). If there are multiple "REQUEST-STATUS"
@@ -1620,16 +1620,15 @@
-Daboo & Desruisseaux Expires December 21, 2009 [Page 29]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 29]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
replying, subject to the recurrence requirements of Section 5.2.6.
- In this case, the scheduling message MUST only appear in the
- Organizer's scheduling Inbox collection once all automatic processing
- has been done.
+ The scheduling message MUST only appear in the Organizer's scheduling
+ Inbox collection once all automatic processing has been done.
6.2. Processing Organizer Requests, Additions, and Cancellations
@@ -1676,9 +1675,10 @@
-Daboo & Desruisseaux Expires December 21, 2009 [Page 30]
+
+Daboo & Desruisseaux Expires April 28, 2011 [Page 30]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
Servers MAY allow clients to change the default calendar collection
@@ -1732,9 +1732,9 @@
-Daboo & Desruisseaux Expires December 21, 2009 [Page 31]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 31]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
Namespace: urn:ietf:params:xml:ns:caldav
@@ -1768,7 +1768,7 @@
message, to serve as a notification that a change has been made to
the corresponding scheduling object resource. Scheduling messages
are typically removed from the scheduling Inbox collection by the
- client once it has acknowledged the change.
+ client once the calendar user has acknowledged the change.
@@ -1788,21 +1788,23 @@
-Daboo & Desruisseaux Expires December 21, 2009 [Page 32]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 32]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
7. Request for Busy Time Information
The POST method is used to request busy time information of one or
- more Calendar Users by targeting the request at a scheduling Outbox
- collection. The request body of a POST method MUST contain a
- "VFREEBUSY" calendar compoment with the "METHOD" iCalendar property
+ more Calendar Users by targeting a freebusy request at the scheduling
+ Outbox collection of the Calendar User requesting the information
+ (the Organizer). The request body of a POST method MUST contain a
+ "VFREEBUSY" calendar component with the "METHOD" iCalendar property
set to the value "REQUEST" as specified in Section 3.3.2 of iTIP
- [I-D.ietf-calsify-2446bis]. The resource identified by the Request-
- URI MUST be a resource collection of type CALDAV:schedule-outbox
- (Section 4.1).
+ [RFC5546]. The resource identified by the Request-URI MUST be a
+ resource collection of type CALDAV:schedule-outbox (Section 4.1).
+ The "ORGANIZER" property in the "VFREEBUSY" component MUST match that
+ of the Calendar User who "owns" the Outbox collection.
7.1. Status Codes
@@ -1836,19 +1838,19 @@
7.2.1. DAV:need-privileges Precondition
- Name: need-privileges
-
-Daboo & Desruisseaux Expires December 21, 2009 [Page 33]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 33]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
+ Name: need-privileges
+
Namespace: DAV:
Apply to: POST
@@ -1892,19 +1894,21 @@
<!ELEMENT supported-collection EMPTY >
- Example:
- <C:supported-collection xmlns:C="urn:ietf:params:xml:ns:caldav"/>
-Daboo & Desruisseaux Expires December 21, 2009 [Page 34]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 34]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
+ Example:
+
+ <C:supported-collection xmlns:C="urn:ietf:params:xml:ns:caldav"/>
+
7.2.3. CALDAV:supported-calendar-data Precondition
Name: supported-calendar-data
@@ -1945,21 +1949,21 @@
<!ELEMENT valid-calendar-data EMPTY>
- Example:
- <C:valid-calendar-data xmlns:C="urn:ietf:params:xml:ns:caldav"/>
+Daboo & Desruisseaux Expires April 28, 2011 [Page 35]
+
+Internet-Draft CalDAV Scheduling Extensions October 2010
-Daboo & Desruisseaux Expires December 21, 2009 [Page 35]
-
-Internet-Draft CalDAV Scheduling Extensions June 2009
+ Example:
+ <C:valid-calendar-data xmlns:C="urn:ietf:params:xml:ns:caldav"/>
7.2.5. CALDAV:valid-scheduling-message Precondition
@@ -2004,18 +2008,18 @@
<!ELEMENT organizer-allowed EMPTY >
- Example:
- <C:organizer-allowed xmlns:C="urn:ietf:params:xml:ns:caldav"/>
+Daboo & Desruisseaux Expires April 28, 2011 [Page 36]
+
+Internet-Draft CalDAV Scheduling Extensions October 2010
-Daboo & Desruisseaux Expires December 21, 2009 [Page 36]
-
-Internet-Draft CalDAV Scheduling Extensions June 2009
+ Example:
+ <C:organizer-allowed xmlns:C="urn:ietf:params:xml:ns:caldav"/>
7.2.7. CALDAV:max-resource-size Precondition
@@ -2028,10 +2032,10 @@
Use with: 403 Forbidden
Purpose: (precondition) -- The resource submitted in the POST
- request MUST have an octet size less than or equal to the value of
- the CALDAV:max-resource-size property (defined in Section 5.2.5 of
- [RFC4791]) specified on the scheduling Outbox collection targeted
- by the request.
+ request MUST have a size in octets less than or equal to the value
+ of the CALDAV:max-resource-size property (defined in Section 5.2.5
+ of [RFC4791]) specified on the scheduling Outbox collection
+ targeted by the request.
Definition:
@@ -2044,22 +2048,31 @@
7.3. Response to a POST request
A POST request may deliver a scheduling message to one or more
- Calendar Users. Since the behavior of each recipient may vary, it is
- useful to get response status information for each recipient in the
- overall POST response. This specification defines a new XML response
- to convey multiple recipient status.
+ Calendar Users. Thus the response needs to contain separate status
+ information for each recipient. This specification defines a new XML
+ response body to convey multiple recipient status.
A response to a POST method that indicates status for one or more
- recipients MUST be a CALDAV:schedule-response XML element. This MUST
- contain one or more CALDAV:response elements for each recipient, with
- each of those containing elements that indicate which recipient they
- correspond to, the scheduling status for that recipient, any error
- codes and an optional description. See Section 14.1.
+ recipients MUST be an XML document with a CALDAV:schedule-response
+ XML element as its root element. This MUST contain one or more
+ CALDAV:response elements for each recipient, with each of those
+ containing elements that indicate which recipient they correspond to,
+ the scheduling status for that recipient, any error codes and an
+ optional description. See Section 14.1 for the detail on the child
+ elements.
In the case of a freebusy request, the CALDAV:response elements can
also contain CALDAV:calendar-data elements which contain freebusy
information (e.g., an iCalendar VFREEBUSY component) indicating the
busy state of the corresponding recipient, assuming that the freebusy
+
+
+
+Daboo & Desruisseaux Expires April 28, 2011 [Page 37]
+
+Internet-Draft CalDAV Scheduling Extensions October 2010
+
+
request for that recipient succeeded. See Appendix B.5 for an
example freebusy request and response.
@@ -2068,12 +2081,55 @@
-Daboo & Desruisseaux Expires December 21, 2009 [Page 37]
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Daboo & Desruisseaux Expires April 28, 2011 [Page 38]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
-8. Conditional Requests on Scheduling Object Resources
+8. Avoiding Conflicts when Updating Scheduling Object Resources
Because replies from Attendees and updates from Organizers are
automatically processed by the server, clients might be in a
@@ -2081,8 +2137,8 @@
the one currently on the server. When an Attendee or Organizer makes
a change to the client's copy of the calendar resource, if the client
writes the data to the server it could overwrite the changes already
- made there. Typically, HTTP clients use the ETag value and If-Match
- request header to avoid the "lost update problem".
+ made there. Typically, clients use the ETag value and If-Match
+ request headers to avoid the "lost update problem".
Calendar user agents can also use ETag and If-Match to avoid this
problem. However, when doing so the client will likely have to
@@ -2124,9 +2180,9 @@
-Daboo & Desruisseaux Expires December 21, 2009 [Page 38]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 39]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
header "Schedule-Tag", and a new "If-Schedule-Tag-Match" request
@@ -2136,20 +2192,20 @@
"inconsequential" scheduling message is one which simply updates the
status information of Attendees due to a reply from an Attendee.
- Servers MUST support conditional requests targeted at scheduling
- object resources using the "If-Schedule-Tag-Match" request header.
- Consequently, the server MUST support the "Schedule-Tag" response
- header and CALDAV:schedule-tag property for scheduling object
- resources. Servers MUST automatically resolve conflicts with
- "inconsequential" changes done to scheduling object resources when
- the "If-Schedule-Tag-Match" request header is specified.
+ Servers MUST support requests targeted at scheduling object resources
+ using the "If-Schedule-Tag-Match" request header. Consequently, the
+ server MUST support the "Schedule-Tag" response header and CALDAV:
+ schedule-tag property for scheduling object resources. Servers MUST
+ automatically resolve conflicts with "inconsequential" changes done
+ to scheduling object resources when the "If-Schedule-Tag-Match"
+ request header is specified.
The If-Schedule-Tag-Match request header applies only to the Request-
URI, and not to the Destination of a COPY or MOVE in the same way as
the If-Match request header.
- Clients SHOULD use conditional requests using the If-Schedule-Tag-
- Match request header.
+ Clients SHOULD use the If-Schedule-Tag-Match header on requests that
+ update scheduling object resources.
A response to any successful GET or PUT request targeting a
scheduling object resource MUST include a Schedule-Tag response
@@ -2180,16 +2236,16 @@
-Daboo & Desruisseaux Expires December 21, 2009 [Page 39]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 40]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
automatically updated by the server with the Attendee's new
participation status.
2. The server MUST change CALDAV:schedule-tag property value when
- the schedulng object resource is changed directly via an HTTP
+ the scheduling object resource is changed directly via an HTTP
request (e.g., PUT, COPY or MOVE).
o For an Attendee's copy of a scheduling object resource:
@@ -2216,48 +2272,48 @@
8.1. PUT
- Clients can use the If-Schedule-Tag-Match request header to do a
- conditional PUT request that ensures that "inconsequential" changes
- on the server do not result in a precondition error. The value of
- the request header is set to the last Schedule-Tag value received for
- the resource being modified. If the value of the If-Schedule-Tag-
- Match header matches the current value of the CALDAV:schedule-tag
- property the server MUST take any "ATTENDEE" property changes for all
- Attendees other than the owner of the scheduling object resource and
- apply those to the new resource being stored. Otherwise, the server
- MUST fail the request with a 412 Precondition Failed status code.
+ Clients can use the If-Schedule-Tag-Match request header to do a PUT
+ request that ensures that "inconsequential" changes on the server do
+ not result in a precondition error. The value of the request header
+ is set to the last Schedule-Tag value received for the resource being
+ modified. If the value of the If-Schedule-Tag-Match header matches
+ the current value of the CALDAV:schedule-tag property the server MUST
+ take any "ATTENDEE" property changes for all Attendees other than the
+ owner of the scheduling object resource and apply those to the new
+ resource being stored. Otherwise, the server MUST fail the request
+ with a 412 Precondition Failed status code.
8.2. DELETE
Clients can use the If-Schedule-Tag-Match request header to do a
- conditional DELETE request that ensures that "inconsequential"
- changes on the server do not result in a precondition error. The
- value of the request header is set to the last Schedule-Tag value
+ DELETE request that ensures that "inconsequential" changes on the
+ server do not result in a precondition error. The value of the
+ request header is set to the last Schedule-Tag value received for the
-Daboo & Desruisseaux Expires December 21, 2009 [Page 40]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 41]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
- received for the resource being deleted. If the value of the If-
- Schedule-Tag-Match header matches the current value of the CALDAV:
- schedule-tag property the server performs the normal DELETE request
- processing for the resource. Otherwise, the server MUST fail the
- request with a 412 Precondition Failed status code.
+ resource being deleted. If the value of the If-Schedule-Tag-Match
+ header matches the current value of the CALDAV:schedule-tag property
+ the server performs the normal DELETE request processing for the
+ resource. Otherwise, the server MUST fail the request with a 412
+ Precondition Failed status code.
8.3. COPY or MOVE
- Clients can use the If-Schedule-Tag-Match request header to do
- conditional COPY or MOVE requests that ensures that "inconsequential"
- changes on the server do not result in a precondition error. The
- value of the request header is set to the last Schedule-Tag value
- received for the resource being copied or moved. If the value of the
- If-Schedule-Tag-Match header matches the current value of the CALDAV:
- schedule-tag property the server performs the normal COPY or MOVE
- request processing for the resource. Otherwise, the server MUST fail
- the request with a 412 Precondition Failed status code.
+ Clients can use the If-Schedule-Tag-Match request header to do COPY
+ or MOVE requests that ensures that "inconsequential" changes on the
+ server do not result in a precondition error. The value of the
+ request header is set to the last Schedule-Tag value received for the
+ resource being copied or moved. If the value of the If-Schedule-Tag-
+ Match header matches the current value of the CALDAV:schedule-tag
+ property the server performs the normal COPY or MOVE request
+ processing for the resource. Otherwise, the server MUST fail the
+ request with a 412 Precondition Failed status code.
@@ -2292,9 +2348,9 @@
-Daboo & Desruisseaux Expires December 21, 2009 [Page 41]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 42]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
9. Other Scheduling Considerations
@@ -2348,9 +2404,9 @@
-Daboo & Desruisseaux Expires December 21, 2009 [Page 42]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 43]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
| EXDATE | A change to or removal of this property that results |
@@ -2404,9 +2460,9 @@
-Daboo & Desruisseaux Expires December 21, 2009 [Page 43]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 44]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
+----------+--------------------------------------------------------+
@@ -2438,12 +2494,15 @@
| | |
| 3.7 | The scheduling message was not delivered because the |
| | server did not recognize the calendar user address as |
- | | a valid calendar user. |
+ | | a valid calendar user. Note that this code applies to |
+ | | both Organizer and Attendee calendar user addresses. |
| | |
| | |
| | |
| 3.8 | The scheduling message was not delivered due to |
- | | insufficient privileges. |
+ | | insufficient privileges. Note that this code applies |
+ | | to both privileges granted by both the Organizer and |
+ | | Attendee calendar users. |
| | |
| | |
| | |
@@ -2454,15 +2513,12 @@
| | later time. |
| | |
| | |
- | | |
-
-
-Daboo & Desruisseaux Expires December 21, 2009 [Page 44]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 45]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
| 5.2 | The scheduling message was not delivered because the |
@@ -2481,8 +2537,56 @@
+----------+--------------------------------------------------------+
The status code for "reply" status can be any of the valid iTIP
- [I-D.ietf-calsify-2446bis] "REQUEST-STATUS" values.
+ [RFC5546] "REQUEST-STATUS" values.
+ The 1.xx "REQUEST-STATUS" codes are new. This specification modifies
+ item (2) of Section 3.6 of [RFC5546] by adding the following
+ restriction:
+
+ For a 1.xx code, all components MUST have exactly the same code.
+
+ Definition of the new 1.xx codes is as follows:
+
+9.2.1. Status Code 1.0
+
+ Status Code: 1.0
+
+ Status Description: Pending.
+
+ Status Exception Data: None.
+
+ Description: Delivery of the iTIP message is pending.
+
+9.2.2. Status Code 1.1
+
+ Status Code: 1.1
+
+ Status Description: Sent.
+
+ Status Exception Data: None.
+
+ Description: The iTIP message has been sent, though no information
+ about successful delivery is known.
+
+
+
+
+
+Daboo & Desruisseaux Expires April 28, 2011 [Page 46]
+
+Internet-Draft CalDAV Scheduling Extensions October 2010
+
+
+9.2.3. Status Code 1.2
+
+ Status Code: 1.2
+
+ Status Description: Delivered.
+
+ Status Exception Data: None.
+
+ Description: The iTIP message has been sent and delivered.
+
9.3. Organizer is an Attendee
The Organizer of a scheduled event may also be an Attendee of that
@@ -2516,9 +2620,17 @@
-Daboo & Desruisseaux Expires December 21, 2009 [Page 45]
+
+
+
+
+
+
+
+
+Daboo & Desruisseaux Expires April 28, 2011 [Page 47]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
10. Additional iCalendar Property Parameters
@@ -2562,8 +2674,8 @@
Servers MUST NOT include this parameter in any scheduling messages
sent as the result of an automatic scheduling transaction.
- Clients SHOULD NOT include this parameter in any scheduling
- messages that they themselves send.
+ Clients MUST NOT include this parameter in any scheduling messages
+ that they themselves send.
Servers and clients MUST treat x-name and iana-token values they
don't recognize the same way as they would the "NONE" value.
@@ -2572,9 +2684,9 @@
-Daboo & Desruisseaux Expires December 21, 2009 [Page 46]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 48]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
Example:
@@ -2616,21 +2728,21 @@
object resources, nor include it in any scheduling messages sent
as the result of an automatic scheduling transaction.
- Clients SHOULD NOT include this parameter in any scheduling
- messages that they themselves send.
+ Clients MUST NOT include this parameter in any scheduling messages
+ that they themselves send.
Servers MUST set the "SCHEDULE-STATUS" parameter of the "ATTENDEE"
or "ORGANIZER" to 2.3 (i.e., "Success, invalid property parameter
- ignored", see Section 3.6 of [I-D.ietf-calsify-2446bis]) when the
- "SCHEDULE-FORCE-SEND" parameter is set to a x-name or iana-token
- value they don't recognize.
+ ignored", see Section 3.6 of [RFC5546]) when the "SCHEDULE-FORCE-
+ SEND" parameter is set to a x-name or iana-token value they don't
+ recognize.
-Daboo & Desruisseaux Expires December 21, 2009 [Page 47]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 49]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
Example:
@@ -2654,7 +2766,7 @@
( statcode
/ DQUOTE statcode *("," statcode) DQUOTE)
; "statcode" is defined in Section 3.8.8.3 of
- ; [I-D.ietf-calsify-rfc2445bis]. Value is a single
+ ; [RFC5545]. Value is a single
; "statcode" or a comma-separated list of "statcode" values.
Description: This property parameter MAY be specified on the
@@ -2684,13 +2796,13 @@
-Daboo & Desruisseaux Expires December 21, 2009 [Page 48]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 50]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
- Clients SHOULD NOT include this parameter in any scheduling
- messages that they themselves send.
+ Clients MUST NOT include this parameter in any scheduling messages
+ that they themselves send.
Suitable values for this property parameter are described in
Section 9.2.
@@ -2740,9 +2852,9 @@
-Daboo & Desruisseaux Expires December 21, 2009 [Page 49]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 51]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
11. Additional Message Header Fields
@@ -2759,12 +2871,12 @@
Schedule-Reply: F
- When an Attendee executes an HTTP DELETE request on a scheduling
- object resource, and the Schedule-Reply header is not present, or
- present and set to the value "T", the server MUST send an appropriate
- reply scheduling message with the Attendee's "PARTSTAT" iCalendar
- property parameter value set to "DECLINED" as part of its normal
- automatic scheduling transaction processing.
+ When an Attendee removes a scheduling object resource, and the
+ Schedule-Reply header is not present, or present and set to the value
+ "T", the server MUST send an appropriate reply scheduling message
+ with the Attendee's "PARTSTAT" iCalendar property parameter value set
+ to "DECLINED" as part of its normal automatic scheduling transaction
+ processing.
When the Schedule-Reply header is set to the value "F", the server
MUST NOT send a scheduling message as part of its normal automatic
@@ -2774,10 +2886,10 @@
a server whether or not an automatic scheduling transaction should
occur when an Attendee deletes a scheduling object resource. In
particular it controls whether a reply scheduling message is sent to
- the Organizer as a result of the deletion. There are situations in
- which unsolicited scheduling messages need to be silently deleted (or
+ the Organizer as a result of the removal. There are situations in
+ which unsolicited scheduling messages need to be silently removed (or
ignored) for security or privacy reasons. This request header allows
- the scheduling object resource to be deleted if such a need arises.
+ the scheduling object resource to be removed if such a need arises.
All scheduling object resources MUST support the Schedule-Reply
request header.
@@ -2796,9 +2908,9 @@
-Daboo & Desruisseaux Expires December 21, 2009 [Page 50]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 52]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
Example:
@@ -2852,9 +2964,9 @@
-Daboo & Desruisseaux Expires December 21, 2009 [Page 51]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 53]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
12. Additional WebDAV Properties
@@ -2876,8 +2988,7 @@
[RFC4918]).
COPY/MOVE behavior: This property value SHOULD be kept during a MOVE
- operation, but is normally re-initialized when a resource is
- created with a COPY. It should not be set in a COPY.
+ operation, and SHOULD be copied and preserved in a COPY.
Description: This property SHOULD be defined on all calendar
collections. If present, it contains one of two XML elements that
@@ -2908,9 +3019,10 @@
-Daboo & Desruisseaux Expires December 21, 2009 [Page 52]
+
+Daboo & Desruisseaux Expires April 28, 2011 [Page 54]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
Example:
@@ -2964,9 +3076,9 @@
-Daboo & Desruisseaux Expires December 21, 2009 [Page 53]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 55]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
12.3. CALDAV:schedule-tag Property
@@ -3020,9 +3132,9 @@
-Daboo & Desruisseaux Expires December 21, 2009 [Page 54]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 56]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
13. Scheduling Access Control
@@ -3076,9 +3188,9 @@
-Daboo & Desruisseaux Expires December 21, 2009 [Page 55]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 57]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
13.1.1.2. CALDAV:schedule-deliver-invite Privilege
@@ -3119,9 +3231,9 @@
CALDAV:schedule-send is an aggregate privilege that contains all the
scheduling privileges that control the use of methods that will cause
- scheduling messages to be delivered to other users, that is, CALDAV-
- schedule-send-invite and CALDAV-schedule-send-reply, as well as
- freebusy requests to be targeted at other users, that is, CALDAV-
+ scheduling messages to be delivered to other users, that is, CALDAV:
+ schedule-send-invite and CALDAV:schedule-send-reply, as well as
+ freebusy requests to be targeted at other users, that is, CALDAV:
schedule-send-freebusy.
<!ELEMENT schedule-send EMPTY >
@@ -3132,9 +3244,9 @@
-Daboo & Desruisseaux Expires December 21, 2009 [Page 56]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 58]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
13.1.2.2. CALDAV:schedule-send-invite Privilege
@@ -3155,7 +3267,7 @@
13.1.2.3. CALDAV:schedule-send-reply Privilege
- The CALDAV:schedule-send-invite privilege controls the sending of
+ The CALDAV:schedule-send-reply privilege controls the sending of
scheduling messages by Attendees.
Users granted the DAV:bind privilege on a calendar collection, or
@@ -3188,9 +3300,9 @@
-Daboo & Desruisseaux Expires December 21, 2009 [Page 57]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 59]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
CALDAV:schedule-send MUST contain CALDAV:schedule-send-invite,
@@ -3244,9 +3356,9 @@
-Daboo & Desruisseaux Expires December 21, 2009 [Page 58]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 60]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
COPY/MOVE behavior: This property value SHOULD be preserved in COPY
@@ -3254,7 +3366,9 @@
Description: This property is needed for a client to determine where
the scheduling Inbox collection of the current user is located so
- that processing of scheduling messages can occur.
+ that processing of scheduling messages can occur. If not present,
+ then the associated calendar user is not enabled for reception of
+ scheduling messages on the server.
Definition:
@@ -3280,7 +3394,9 @@
Description: This property is needed for a client to determine where
the scheduling Outbox collection of the current user is located so
- that sending of scheduling messages can occur.
+ that sending of scheduling messages can occur. If not present,
+ then the associated calendar user is not enabled for the sending
+ of scheduling messages on the server.
Definition:
@@ -3290,21 +3406,22 @@
Name: calendar-user-address-set
- Namespace: urn:ietf:params:xml:ns:caldav
- Purpose: Identify the calendar addresses of the associated principal
- resource.
-
-Daboo & Desruisseaux Expires December 21, 2009 [Page 59]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 61]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
+ Namespace: urn:ietf:params:xml:ns:caldav
+
+ Purpose: Identify the calendar addresses of the associated principal
+ resource.
+
Protected: This property MAY be protected.
PROPFIND behavior: This property SHOULD NOT be returned by a
@@ -3322,7 +3439,8 @@
principal resource can be used. This property SHOULD be
searchable using the DAV:principal-property-search REPORT. The
DAV:principal-search-property-set REPORT SHOULD identify this
- property as such.
+ property as such. If not present, then the associated calendar
+ user is not enabled for scheduling on the server.
Definition:
@@ -3345,21 +3463,20 @@
Purpose: Identifies the calendar user type of the associated
principal resource.
- Value: Same values allowed for the iCalendar "CUTYPE" property
- parameter defined in Section 3.2.3 of
- [I-D.ietf-calsify-rfc2445bis].
- Protected: This property MAY be protected.
+Daboo & Desruisseaux Expires April 28, 2011 [Page 62]
+
+Internet-Draft CalDAV Scheduling Extensions October 2010
-Daboo & Desruisseaux Expires December 21, 2009 [Page 60]
-
-Internet-Draft CalDAV Scheduling Extensions June 2009
+ Value: Same values allowed for the iCalendar "CUTYPE" property
+ parameter defined in Section 3.2.3 of [RFC5545].
+ Protected: This property MAY be protected.
PROPFIND behavior: This property SHOULD NOT be returned by a
PROPFIND allprop request (as defined in Section 14.2 of
@@ -3374,7 +3491,9 @@
property parameter that can be used on "ATTENDEE" properties.
This property SHOULD be searchable using the DAV:principal-
property-search REPORT. The DAV:principal-search-property-set
- REPORT SHOULD identify this property as such.
+ REPORT SHOULD identify this property as such. If not present,
+ then the associated calendar user is not enabled for scheduling on
+ the server.
Definition:
@@ -3405,16 +3524,9 @@
-
-
-
-
-
-
-
-Daboo & Desruisseaux Expires December 21, 2009 [Page 61]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 63]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
14. XML Element Definitions
@@ -3451,6 +3563,10 @@
DAV:error?,
DAV:responsedescription?)>
+ <!-- CALDAV:calendar-data is defined in Section 9.6 of
+ RFC 4791 and when used here uses the definition with
+ content (#PCDATA) only -->
+
14.3. CALDAV:recipient XML Element
Name: recipient
@@ -3460,19 +3576,17 @@
Purpose: The calendar user address that the enclosing response for a
POST method request is for.
- Description: See Section 7.3.
+Daboo & Desruisseaux Expires April 28, 2011 [Page 64]
+
+Internet-Draft CalDAV Scheduling Extensions October 2010
+ Description: See Section 7.3.
-Daboo & Desruisseaux Expires December 21, 2009 [Page 62]
-
-Internet-Draft CalDAV Scheduling Extensions June 2009
-
-
Definition:
<!ELEMENT recipient (DAV:href)>
@@ -3522,11 +3636,9 @@
-
-
-Daboo & Desruisseaux Expires December 21, 2009 [Page 63]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 65]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
15. Security Considerations
@@ -3580,9 +3692,9 @@
-Daboo & Desruisseaux Expires December 21, 2009 [Page 64]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 66]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
Servers MUST verify that the principal associated with the
@@ -3636,9 +3748,9 @@
-Daboo & Desruisseaux Expires December 21, 2009 [Page 65]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 67]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
16. IANA Considerations
@@ -3692,16 +3804,16 @@
-Daboo & Desruisseaux Expires December 21, 2009 [Page 66]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 68]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
16.2. iCalendar Property Parameter Registrations
The following iCalendar property parameters should be added to the
iCalendar Property Parameter Registry defined in Section 8.3.3 of
- [I-D.ietf-calsify-rfc2445bis].
+ [RFC5545].
+---------------------+---------+-----------------------+
| Parameter | Status | Reference |
@@ -3713,17 +3825,46 @@
| SCHEDULE-FORCE-SEND | Current | RFCXXXX, Section 10.2 |
+---------------------+---------+-----------------------+
-16.3. Additional iCalendar Elements Registries
+16.3. iCalendar REQUEST-STATUS Value Registrations
- The IANA should create and maintain the following additional
- registries for iCalendar elements with pointers to appropriate
- reference documents.
+ The following iCalendar "REQUEST-STATUS" values should be added to
+ the iCalendar REQUEST-STATUS Value Registry defined in Section 7.3 of
+ [RFC5546].
-16.3.1. Schedule Agent Values Registry
+ +-------------+---------+-------------------------+
+ | Status Code | Status | Reference |
+ +-------------+---------+-------------------------+
+ | 1.0 | Current | RFC XXXX, Section 9.2.1 |
+ | | | |
+ | 1.1 | Current | RFC XXXX, Section 9.2.2 |
+ | | | |
+ | 1.2 | Current | RFC XXXX, Section 9.2.3 |
+ +-------------+---------+-------------------------+
- The following table should be used to initialize the schedule agent
+16.4. Additional iCalendar Elements Registries
+
+ This specification adds two new IANA registries for iCalendar
+ elements. Additional codes MAY be used, provided the process
+ described in Section 8.2.1 of [RFC5545] is used to register them.
+
+16.4.1. Schedule Agent Values Registry
+
+ The following table has been used to initialize the schedule agent
values registry.
+
+
+
+
+
+
+
+
+Daboo & Desruisseaux Expires April 28, 2011 [Page 69]
+
+Internet-Draft CalDAV Scheduling Extensions October 2010
+
+
+----------------+---------+------------------------+
| Schedule Agent | Status | Reference |
+----------------+---------+------------------------+
@@ -3734,9 +3875,9 @@
| NONE | Current | RFC XXXX, Section 10.1 |
+----------------+---------+------------------------+
-16.3.2. Schedule Force Send Values Registry
+16.4.2. Schedule Force Send Values Registry
- The following table should be used to initialize the schedule send
+ The following table has been used to initialize the schedule send
values registry.
+---------------------+---------+------------------------+
@@ -3744,15 +3885,6 @@
+---------------------+---------+------------------------+
| REQUEST | Current | RFC XXXX, Section 10.2 |
| | | |
-
-
-
-
-Daboo & Desruisseaux Expires December 21, 2009 [Page 67]
-
-Internet-Draft CalDAV Scheduling Extensions June 2009
-
-
| REPLY | Current | RFC XXXX, Section 10.2 |
+---------------------+---------+------------------------+
@@ -3784,29 +3916,9 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Daboo & Desruisseaux Expires December 21, 2009 [Page 68]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 70]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
17. Acknowledgements
@@ -3860,26 +3972,15 @@
-Daboo & Desruisseaux Expires December 21, 2009 [Page 69]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 71]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
18. References
18.1. Normative References
- [I-D.ietf-calsify-2446bis] Daboo, C., "iCalendar Transport-
- Independent Interoperability Protocol
- (iTIP)", draft-ietf-calsify-2446bis-09
- (work in progress), April 2009.
-
- [I-D.ietf-calsify-rfc2445bis] Desruisseaux, B., "Internet
- Calendaring and Scheduling Core Object
- Specification (iCalendar)",
- draft-ietf-calsify-rfc2445bis-10 (work
- in progress), April 2009.
-
[RFC2119] Bradner, S., "Key words for use in
RFCs to Indicate Requirement Levels",
BCP 14, RFC 2119, March 1997.
@@ -3914,19 +4015,29 @@
Versioning (WebDAV)", RFC 4918,
June 2007.
+ [RFC5234] Crocker, D. and P. Overell, "Augmented
+ BNF for Syntax Specifications: ABNF",
+ STD 68, RFC 5234, January 2008.
+ [RFC5545] Desruisseaux, B., "Internet
+ Calendaring and Scheduling Core Object
+ Specification (iCalendar)", RFC 5545,
+ September 2009.
-Daboo & Desruisseaux Expires December 21, 2009 [Page 70]
+ [RFC5546] Daboo, C., "iCalendar Transport-
+
+
+
+Daboo & Desruisseaux Expires April 28, 2011 [Page 72]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
- [RFC5234] Crocker, D. and P. Overell, "Augmented
- BNF for Syntax Specifications: ABNF",
- STD 68, RFC 5234, January 2008.
+ Independent Interoperability Protocol
+ (iTIP)", RFC 5546, December 2009.
- [W3C.REC-xml-20081126] Maler, E., Yergeau, F., Sperberg-
- McQueen, C., Paoli, J., and T. Bray,
+ [W3C.REC-xml-20081126] Paoli, J., Yergeau, F., Bray, T.,
+ Sperberg-McQueen, C., and E. Maler,
"Extensible Markup Language (XML) 1.0
(Fifth Edition)", World Wide Web
Consortium Recommendation REC-xml-
@@ -3937,8 +4048,8 @@
[I-D.ietf-calsify-rfc2447bis] Melnikov, A., "iCalendar Message-Based
Interoperability Protocol (iMIP)",
- draft-ietf-calsify-rfc2447bis-05 (work
- in progress), June 2008.
+ draft-ietf-calsify-rfc2447bis-11 (work
+ in progress), September 2010.
[RFC3283] Mahoney, B., Babics, G., and A. Taler,
"Guide to Internet Calendaring",
@@ -3972,9 +4083,10 @@
-Daboo & Desruisseaux Expires December 21, 2009 [Page 71]
+
+Daboo & Desruisseaux Expires April 28, 2011 [Page 73]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
Appendix A. Scheduling Privileges Summary
@@ -4028,9 +4140,9 @@
-Daboo & Desruisseaux Expires December 21, 2009 [Page 72]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 74]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
+--------------------------------+
@@ -4084,9 +4196,9 @@
-Daboo & Desruisseaux Expires December 21, 2009 [Page 73]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 75]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
Appendix B. Example Scheduling Transactions
@@ -4140,9 +4252,9 @@
-Daboo & Desruisseaux Expires December 21, 2009 [Page 74]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 76]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
>> Request <<
@@ -4151,6 +4263,7 @@
Host: cal.example.com
Content-Type: text/calendar; charset="utf-8"
Content-Length: xxxx
+ If-None-Match: *
BEGIN:VCALENDAR
VERSION:2.0
@@ -4195,10 +4308,9 @@
-
-Daboo & Desruisseaux Expires December 21, 2009 [Page 75]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 77]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
>> Request <<
@@ -4231,14 +4343,13 @@
mailto:cyrus at example.com
ATTENDEE;CN="Wilfredo Sanchez Vega";CUTYPE=INDIVIDUAL;PARTSTAT
=NEEDS-ACTION;ROLE=REQ-PARTICIPANT;RSVP=TRUE;SCHEDULE-STATUS=
- "1.2;Scheduling message has been delivered":mailto:wilfredo at e
+ 1.2:mailto:wilfredo at e
xample.com
ATTENDEE;CN="Bernard Desruisseaux";CUTYPE=INDIVIDUAL;PARTSTAT=
- NEEDS-ACTION;ROLE=REQ-PARTICIPANT;RSVP=TRUE;SCHEDULE-STATUS="
- 1.0;Scheduling message is pending":mailto:bernard at example.net
+ NEEDS-ACTION;ROLE=REQ-PARTICIPANT;RSVP=TRUE;SCHEDULE-STATUS=
+ 1.0:mailto:bernard at example.net
ATTENDEE;CN="Mike Douglass";CUTYPE=INDIVIDUAL;PARTSTAT=NEEDS-A
- CTION;RSVP=TRUE;SCHEDULE-STATUS="3.7;Invalid calendar user":m
- ailto:mike at example.org
+ CTION;RSVP=TRUE;SCHEDULE-STATUS=3.7:mailto:mike at example.org
END:VEVENT
END:VCALENDAR
@@ -4252,9 +4363,10 @@
-Daboo & Desruisseaux Expires December 21, 2009 [Page 76]
+
+Daboo & Desruisseaux Expires April 28, 2011 [Page 78]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
>> Request <<
@@ -4308,9 +4420,9 @@
-Daboo & Desruisseaux Expires December 21, 2009 [Page 77]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 79]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
>> Response <<
@@ -4364,9 +4476,9 @@
-Daboo & Desruisseaux Expires December 21, 2009 [Page 78]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 80]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
>> Response <<
@@ -4384,7 +4496,7 @@
>> Request <<
- PUT /home/wilfredo/calendars/work/BB64861C2228.ics HTTP/1.1
+ GET /home/wilfredo/calendars/work/BB64861C2228.ics HTTP/1.1
Host: cal.example.com
@@ -4420,9 +4532,9 @@
-Daboo & Desruisseaux Expires December 21, 2009 [Page 79]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 81]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
>> Response <<
@@ -4446,8 +4558,8 @@
DTEND:20090602T170000Z
TRANSP:OPAQUE
SUMMARY:Lunch
- ORGANIZER;CN="Cyrus Daboo";SCHEDULE-STATUS="1.2;Scheduling mes
- sage has been delivered":mailto:cyrus at example.com
+ ORGANIZER;CN="Cyrus Daboo";SCHEDULE-STATUS=1.2:mailto:cyrus at ex
+ ample.com
ATTENDEE;CN="Cyrus Daboo";CUTYPE=INDIVIDUAL;PARTSTAT=ACCEPTED:
mailto:cyrus at example.com
ATTENDEE;CN="Wilfredo Sanchez Vega";CUTYPE=INDIVIDUAL;PARTSTAT
@@ -4476,9 +4588,9 @@
-Daboo & Desruisseaux Expires December 21, 2009 [Page 80]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 82]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
deletes this scheduling message in his scheduling Inbox collection.
@@ -4532,9 +4644,9 @@
-Daboo & Desruisseaux Expires December 21, 2009 [Page 81]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 83]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
>> Request <<
@@ -4567,30 +4679,30 @@
ATTENDEE;CN="Cyrus Daboo";CUTYPE=INDIVIDUAL;PARTSTAT=ACCEPTED:
mailto:cyrus at example.com
ATTENDEE;CN="Wilfredo Sanchez Vega";CUTYPE=INDIVIDUAL;PARTSTAT
- =ACCEPTED;ROLE=REQ-PARTICIPANT;RSVP=TRUE;SCHEDULE-STATUS="2.0
- ;Reply has been received":mailto:wilfredo at example.com
+ =ACCEPTED;ROLE=REQ-PARTICIPANT;RSVP=TRUE;SCHEDULE-STATUS=2.0:
+ mailto:wilfredo at example.com
ATTENDEE;CN="Bernard Desruisseaux";CUTYPE=INDIVIDUAL;PARTSTAT=
- NEEDS-ACTION;ROLE=REQ-PARTICIPANT;RSVP=TRUE;SCHEDULE-STATUS="
- 1.0;Scheduling message is pending":mailto:bernard at example.net
+ NEEDS-ACTION;ROLE=REQ-PARTICIPANT;RSVP=TRUE;SCHEDULE-STATUS=1
+ .0:mailto:bernard at example.net
ATTENDEE;CN="Mike Douglass";CUTYPE=INDIVIDUAL;PARTSTAT=NEEDS-A
- CTION;RSVP=TRUE;SCHEDULE-STATUS="3.7;Invalid calendar user":m
- ailto:mike at example.org
+ CTION;RSVP=TRUE;SCHEDULE-STATUS=3.7:mailto:mike at example.org
END:VEVENT
END:VCALENDAR
B.5. Example: Organizer Requesting Busy Time Information
- In this example, Cyrus requests the busy time information of Wilfredo
- and Bernard.
+ In this example, Cyrus requests the busy time information of
+ Wilfredo, Bernard and Mike.
-Daboo & Desruisseaux Expires December 21, 2009 [Page 82]
+
+Daboo & Desruisseaux Expires April 28, 2011 [Page 84]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
>> Request <<
@@ -4612,6 +4724,7 @@
ORGANIZER;CN="Cyrus Daboo":mailto:cyrus at example.com
ATTENDEE;CN="Wilfredo Sanchez Vega":mailto:wilfredo at example.com
ATTENDEE;CN="Bernard Desruisseaux":mailto:bernard at example.net
+ ATTENDEE;CN="Mike Douglass":mailto:mike at example.org
END:VFREEBUSY
END:VCALENDAR
@@ -4640,15 +4753,15 @@
DTSTART:20090602T000000Z
DTEND:20090604T000000Z
ORGANIZER;CN="Cyrus Daboo":mailto:cyrus at example.com
- ATTENDEE;CN="Wilfredo Sanchez Vega":mailto:wilfredo at example.com
-Daboo & Desruisseaux Expires December 21, 2009 [Page 83]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 85]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
+ ATTENDEE;CN="Wilfredo Sanchez Vega":mailto:wilfredo at example.com
FREEBUSY;FBTYPE=BUSY:20090602T110000Z/20090602T120000Z
FREEBUSY;FBTYPE=BUSY:20090603T170000Z/20090603T180000Z
END:VFREEBUSY
@@ -4678,6 +4791,12 @@
END:VCALENDAR
</C:calendar-data>
</C:response>
+ <C:response>
+ <C:recipient>
+ <D:href>mailto:mike at example.org<D:href>
+ </C:recipient>
+ <C:request-status>3.7;Invalid calendar user</C:request-status>
+ </C:response>
</C:schedule-response>
B.6. Example: User Attempting to Invite Attendee on behalf of Organizer
@@ -4693,16 +4812,9 @@
-
-
-
-
-
-
-
-Daboo & Desruisseaux Expires December 21, 2009 [Page 84]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 86]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
>> Request <<
@@ -4711,6 +4823,7 @@
Host: cal.example.com
Content-Type: text/calendar; charset="utf-8"
Content-Length: xxxx
+ If-None-Match: *
BEGIN:VCALENDAR
VERSION:2.0
@@ -4752,19 +4865,21 @@
In the following example, Bernard declines the second recurrence
instance of a daily recurring event he's been invited to by Cyrus.
- >> Request <<
-Daboo & Desruisseaux Expires December 21, 2009 [Page 85]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 87]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
+ >> Request <<
+
PUT /home/bernard/calendars/work/4FD3AD926350.ics HTTP/1.1
Host: cal.example.com
Content-Type: text/calendar; charset="utf-8"
Content-Length: xxxx
+ If-Schedule-Tag-Match: "7775FB30-7534-489E-A79A-0EA147B933EB"
BEGIN:VCALENDAR
VERSION:2.0
@@ -4806,17 +4921,17 @@
UID:9263504FD3AD
SEQUENCE:0
DTSTAMP:20090603T183823Z
- RECURRENCE-ID;TZID=America/Montreal:20090602T150000
- DTSTART;TZID=America/Montreal:20090602T150000
- DTEND;TZID=America/Montreal:20090602T160000
-Daboo & Desruisseaux Expires December 21, 2009 [Page 86]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 88]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
+ RECURRENCE-ID;TZID=America/Montreal:20090602T150000
+ DTSTART;TZID=America/Montreal:20090602T150000
+ DTEND;TZID=America/Montreal:20090602T160000
TRANSP:TRANSPARENT
SUMMARY:Review Internet-Draft
ORGANIZER;CN="Cyrus Daboo":mailto:cyrus at example.com
@@ -4865,12 +4980,9 @@
-
-
-
-Daboo & Desruisseaux Expires December 21, 2009 [Page 87]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 89]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
>> Response <<
@@ -4924,9 +5036,9 @@
-Daboo & Desruisseaux Expires December 21, 2009 [Page 88]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 90]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
B.8. Example: Attendee Removing an Instance of a Recurring Event
@@ -4942,6 +5054,7 @@
Host: cal.example.com
Content-Type: text/calendar; charset="utf-8"
Content-Length: xxxx
+ If-Schedule-Tag-Match: "488177c8-2ea7-4176-a6cb-fab8cfccdea2"
BEGIN:VCALENDAR
VERSION:2.0
@@ -4976,15 +5089,15 @@
ORGANIZER;CN="Cyrus Daboo":mailto:cyrus at example.com
ATTENDEE;CN="Cyrus Daboo";CUTYPE=INDIVIDUAL;PARTSTAT=ACCEPTED:
mailto:cyrus at example.com
- ATTENDEE;CN="Bernard Desruisseaux";CUTYPE=INDIVIDUAL;PARTSTAT=
-Daboo & Desruisseaux Expires December 21, 2009 [Page 89]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 91]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
+ ATTENDEE;CN="Bernard Desruisseaux";CUTYPE=INDIVIDUAL;PARTSTAT=
ACCEPTED;ROLE=REQ-PARTICIPANT;RSVP=TRUE:mailto:bernard at exampl
e.net
END:VEVENT
@@ -5035,10 +5148,9 @@
-
-Daboo & Desruisseaux Expires December 21, 2009 [Page 90]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 92]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
>> Response <<
@@ -5092,15 +5204,87 @@
-Daboo & Desruisseaux Expires December 21, 2009 [Page 91]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 93]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
Appendix C. Changes (to be removed by RFC Editor prior to publication)
-C.1. Changes in -07
+C.1. Changes in -09
+ a. Fixed some examples.
+
+ b. Tweaked XML conventions.
+
+ c. Removed description in SCHEDULE-STATUS example values.
+
+ d. Tweaked 3.7 and 3.8 SCHEDULE-STATUS description to indicate it
+ applies to the Organizer as well as Attendee.
+
+ e. Updated to RFC 5545 reference.
+
+ f. AD Review: clarified text about inbox resource deletion being
+ acknowledgment of change.
+
+ g. AD Review: clarified description of freebusy Outbox POST.
+
+ h. AD Review: registered new 1.xx request-status codes and added new
+ restriction on usage as per iTIP.
+
+ i. AD Review: changes SHOULD NOT to MUST NOT for new property
+ parameters when clients send scheduling messages.
+
+ j. AD Review: CALDAV:schedule-calendar-transp now preserved during
+ COPY.
+
+ k. AD Review: changed CALDAV- to CALDAV: in acl descriptions.
+
+ l. AD Review: fixed various minor typos.
+
+ m. AD Review: Added text to new principal properties to indicate
+ that if they are not present, then the user is not enabled for
+ the various scheduling operations.
+
+ n. AD Review: clarified use of CALDAV:calendar-data element in
+ CALDAV:response element.
+
+ o. AD Review: made reference to 5545 IANA registry procedures for
+ the two new element registries.
+
+ p. AD Review: Fixed description of B5. example.
+
+ q. Fixed SCHEDULE-AGENT/SCHEDULE-STATUS behavior for Attendee
+ replies.
+
+
+
+
+Daboo & Desruisseaux Expires April 28, 2011 [Page 94]
+
+Internet-Draft CalDAV Scheduling Extensions October 2010
+
+
+C.2. Changes in -08
+
+ a. Added "Updates 4791".
+
+ b. XML conventions changed to match that in CardDAV spec.
+
+ c. Reworded child response behavior for Outbox.
+
+ d. Reworded "octet size".
+
+ e. If-Schedule-Match descriptions changed to remove implication that
+ it is purely a conditional operation.
+
+ f. Schedule-Reply header descriptions generalized to resource
+ removal rather than just HTTP DELETE.
+
+ g. Fixed various examples.
+
+C.3. Changes in -07
+
a. Restructured document.
b. Clarified that CALDAV:schedule-calendar-transp only applies to
@@ -5129,13 +5313,21 @@
l. Removed handling of VJOURNAL components.
+
+
+
+Daboo & Desruisseaux Expires April 28, 2011 [Page 95]
+
+Internet-Draft CalDAV Scheduling Extensions October 2010
+
+
m. Completed IANA Considerations section.
n. Added references to RFC3283 and RFC5234.
o. Updated references to iCalendar, iTIP and iMIP.
-C.2. Changes in -06
+C.4. Changes in -06
a. Removed distinction between scheduling calendar collections and
basic calendar collections - now just have calendar collections.
@@ -5144,15 +5336,6 @@
c. Fixed <C:recipient> in examples.
-
-
-
-
-Daboo & Desruisseaux Expires December 21, 2009 [Page 92]
-
-Internet-Draft CalDAV Scheduling Extensions June 2009
-
-
d. Removed CALDAV:attachments-allowed precondition on POST to Outbox
as that is no longer relevant.
@@ -5172,7 +5355,7 @@
j. Minor typos fixed.
-C.3. Changes in -05
+C.5. Changes in -05
This draft has changed substantially since the -04 version. The
primary reason for this change was implementation experience from a
@@ -5186,6 +5369,14 @@
Whilst this adds significant complexity to the server in that it
needs to be a full blown iTIP processing agent, it does remove a lot
of the same complexity from clients, opening up the possibility of
+
+
+
+Daboo & Desruisseaux Expires April 28, 2011 [Page 96]
+
+Internet-Draft CalDAV Scheduling Extensions October 2010
+
+
supporting complex scheduling behaviors even with "thin" clients.
In the judgement of the authors, we consider this new specification
@@ -5204,9 +5395,42 @@
-Daboo & Desruisseaux Expires December 21, 2009 [Page 93]
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Daboo & Desruisseaux Expires April 28, 2011 [Page 97]
-Internet-Draft CalDAV Scheduling Extensions June 2009
+Internet-Draft CalDAV Scheduling Extensions October 2010
Authors' Addresses
@@ -5260,5 +5484,5 @@
-Daboo & Desruisseaux Expires December 21, 2009 [Page 94]
+Daboo & Desruisseaux Expires April 28, 2011 [Page 98]
Deleted: CalendarServer/trunk/doc/RFC/draft-ietf-vcarddav-carddav.txt
===================================================================
--- CalendarServer/trunk/doc/RFC/draft-ietf-vcarddav-carddav.txt 2011-09-01 14:47:28 UTC (rev 8039)
+++ CalendarServer/trunk/doc/RFC/draft-ietf-vcarddav-carddav.txt 2011-09-01 15:06:35 UTC (rev 8040)
@@ -1,3136 +0,0 @@
-
-
-
-Network Working Group C. Daboo
-Internet-Draft Apple
-Intended status: Standards Track November 9, 2009
-Expires: May 13, 2010
-
-
- vCard Extensions to WebDAV (CardDAV)
- draft-ietf-vcarddav-carddav-10
-
-Status of this Memo
-
- This Internet-Draft is submitted to IETF in full conformance with the
- provisions of BCP 78 and BCP 79. 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 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.
-
- Internet-Drafts are working documents of the Internet Engineering
- Task Force (IETF), its areas, and its working groups. Note that
- other groups may also distribute working documents as Internet-
- Drafts.
-
- Internet-Drafts are draft documents valid for a maximum of six months
- and may be updated, replaced, or obsoleted by other documents at any
- time. It is inappropriate to use Internet-Drafts as reference
- material or to cite them other than as "work in progress."
-
- The list of current Internet-Drafts can be accessed at
- http://www.ietf.org/ietf/1id-abstracts.txt.
-
- The list of Internet-Draft Shadow Directories can be accessed at
- http://www.ietf.org/shadow.html.
-
- This Internet-Draft will expire on May 13, 2010.
-
-Copyright Notice
-
- Copyright (c) 2009 IETF Trust and the persons identified as the
- document authors. All rights reserved.
-
- This document is subject to BCP 78 and the IETF Trust's Legal
-
-
-
-Daboo Expires May 13, 2010 [Page 1]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
- Provisions Relating to IETF Documents in effect on the date of
- publication of this document (http://trustee.ietf.org/license-info).
- Please review these documents carefully, as they describe your rights
- and restrictions with respect to this document.
-
-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.
-
-
-Table of Contents
-
- 1. Introduction and Overview . . . . . . . . . . . . . . . . . . 4
- 2. Conventions . . . . . . . . . . . . . . . . . . . . . . . . . 5
- 3. Requirements Overview . . . . . . . . . . . . . . . . . . . . 6
- 4. Address Book Data Model . . . . . . . . . . . . . . . . . . . 7
- 4.1. Address Book Server . . . . . . . . . . . . . . . . . . . 7
- 5. Address Book Resources . . . . . . . . . . . . . . . . . . . . 7
- 5.1. Address Object Resources . . . . . . . . . . . . . . . . . 8
- 5.1.1. Data Type Conversion . . . . . . . . . . . . . . . . . 8
- 5.1.1.1. Additional Precondition for GET . . . . . . . . . 9
- 5.2. Address Book Collections . . . . . . . . . . . . . . . . . 9
- 6. Address Book Feature . . . . . . . . . . . . . . . . . . . . . 10
- 6.1. Address Book Support . . . . . . . . . . . . . . . . . . . 10
- 6.1.1. Example: Using OPTIONS for the Discovery of
- Support for CardDAV . . . . . . . . . . . . . . . . . 10
- 6.2. Address Book Properties . . . . . . . . . . . . . . . . . 10
- 6.2.1. CARDDAV:addressbook-description Property . . . . . . . 11
- 6.2.2. CARDDAV:supported-address-data Property . . . . . . . 11
- 6.2.3. CARDDAV:max-resource-size Property . . . . . . . . . . 12
- 6.3. Creating Resources . . . . . . . . . . . . . . . . . . . . 13
- 6.3.1. Extended MKCOL Method . . . . . . . . . . . . . . . . 13
- 6.3.1.1. Example - Successful MKCOL request . . . . . . . . 14
- 6.3.2. Creating Address Object Resources . . . . . . . . . . 16
- 6.3.2.1. Additional Preconditions for PUT, COPY and MOVE . 17
- 6.3.2.2. Non-Standard vCard Properties, and Parameters . . 18
- 6.3.2.3. Address Object Resource Entity Tag . . . . . . . . 18
- 7. Address Book Access Control . . . . . . . . . . . . . . . . . 19
- 7.1. Additional Principal Properties . . . . . . . . . . . . . 19
- 7.1.1. CARDDAV:addressbook-home-set Property . . . . . . . . 19
- 7.1.2. CARDDAV:principal-address Property . . . . . . . . . . 20
- 8. Address Book Reports . . . . . . . . . . . . . . . . . . . . . 21
- 8.1. REPORT Method . . . . . . . . . . . . . . . . . . . . . . 21
- 8.2. Ordinary Collections . . . . . . . . . . . . . . . . . . . 21
- 8.3. Searching Text: Collations . . . . . . . . . . . . . . . . 21
- 8.3.1. CARDDAV:supported-collation-set Property . . . . . . . 22
-
-
-
-Daboo Expires May 13, 2010 [Page 2]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
- 8.4. Partial Retrieval . . . . . . . . . . . . . . . . . . . . 23
- 8.5. Non-standard Properties and Parameters . . . . . . . . . . 23
- 8.6. CARDDAV:addressbook-query Report . . . . . . . . . . . . . 24
- 8.6.1. Limiting Results . . . . . . . . . . . . . . . . . . . 25
- 8.6.2. Truncation of Results . . . . . . . . . . . . . . . . 26
- 8.6.3. Example: Partial Retrieval of vCards Matching
- NICKNAME . . . . . . . . . . . . . . . . . . . . . . . 26
- 8.6.4. Example: Partial Retrieval of vCards Matching a
- Full Name or Email Address . . . . . . . . . . . . . . 28
- 8.6.5. Example: Truncated Results . . . . . . . . . . . . . . 31
- 8.7. CARDDAV:addressbook-multiget Report . . . . . . . . . . . 32
- 8.7.1. Example: CARDDAV:addressbook-multiget Report . . . . . 34
- 8.7.2. Example: CARDDAV:addressbook-multiget Report . . . . . 35
- 9. Client Guidelines . . . . . . . . . . . . . . . . . . . . . . 36
- 9.1. Restrict the Properties Returned . . . . . . . . . . . . . 36
- 9.2. Avoiding Lost Updates . . . . . . . . . . . . . . . . . . 37
- 9.3. Client Configuration . . . . . . . . . . . . . . . . . . . 37
- 9.4. Finding Other Users' Address Books . . . . . . . . . . . . 37
- 10. XML Element Definitions . . . . . . . . . . . . . . . . . . . 38
- 10.1. CARDDAV:addressbook XML Element . . . . . . . . . . . . . 38
- 10.2. CARDDAV:supported-collation XML Element . . . . . . . . . 38
- 10.3. CARDDAV:addressbook-query XML Element . . . . . . . . . . 39
- 10.4. CARDDAV:address-data XML Element . . . . . . . . . . . . . 39
- 10.4.1. CARDDAV:allprop XML Element . . . . . . . . . . . . . 41
- 10.4.2. CARDDAV:prop XML Element . . . . . . . . . . . . . . . 41
- 10.5. CARDDAV:filter XML Element . . . . . . . . . . . . . . . . 42
- 10.5.1. CARDDAV:prop-filter XML Element . . . . . . . . . . . 43
- 10.5.2. CARDDAV:param-filter XML Element . . . . . . . . . . . 44
- 10.5.3. CARDDAV:is-not-defined XML Element . . . . . . . . . . 45
- 10.5.4. CARDDAV:text-match XML Element . . . . . . . . . . . . 45
- 10.6. CARDDAV:limit XML Element . . . . . . . . . . . . . . . . 46
- 10.6.1. CARDDAV:nresults XML Element . . . . . . . . . . . . . 46
- 10.7. CARDDAV:addressbook-multiget XML Element . . . . . . . . . 47
- 11. Service Discovery via SRV Records . . . . . . . . . . . . . . 47
- 12. Internationalization Considerations . . . . . . . . . . . . . 48
- 13. Security Considerations . . . . . . . . . . . . . . . . . . . 48
- 14. IANA Consideration . . . . . . . . . . . . . . . . . . . . . . 49
- 14.1. Namespace Registration . . . . . . . . . . . . . . . . . . 49
- 15. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 49
- 16. References . . . . . . . . . . . . . . . . . . . . . . . . . . 49
- 16.1. Normative References . . . . . . . . . . . . . . . . . . . 49
- 16.2. Informative References . . . . . . . . . . . . . . . . . . 51
- Appendix A. Change History (to be removed prior to
- publication as an RFC) . . . . . . . . . . . . . . . 51
- Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 56
-
-
-
-
-
-
-Daboo Expires May 13, 2010 [Page 3]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
-1. Introduction and Overview
-
- 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
- Lightweight Directory Access Protocol (LDAP) [RFC4510], Internet
- Message Support Protocol (IMSP) [IMSP] and Application Configuration
- Access Protocol (ACAP) [RFC2244], together with SyncML used for
- synchronization of such data.
-
- WebDAV [RFC4918] 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 design costs,
- implementation costs, interoperability test costs and deployment
- costs.
-
- 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 ACL [RFC3744].
-
- 3. Principal collections can be used to enumerate and query other
- users on the system as per WebDAV ACL [RFC3744].
-
- 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 [RFC2426] for well defined address schema to
- enhance client interoperability.
-
- 7. Many limited clients (e.g. mobile devices) contain an HTTP stack
- which makes implementing WebDAV much easier than other protocols.
-
- The key disadvantages of address book support in WebDAV are:
-
- 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
-
-
-
-Daboo Expires May 13, 2010 [Page 4]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
- of vCard was originally done by the Versit consortium, with a
- subsequent 3.0 version standardized by the IETF [RFC2426]. vCard is
- in wide spread 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
- [I-D.ietf-vcarddav-vcardrev]and is compatible with this
- specification.
-
-
-2. Conventions
-
- 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 [RFC2119].
-
- The term "protected" is used in the Conformance field of property
- definitions as defined in Section 15 of [RFC4918].
-
- This document uses XML DTD fragments ([W3C.REC-xml-20081126], Section
- 3.2) as a purely notational convention. WebDAV request and response
- bodies cannot be validated by a DTD due to the specific extensibility
- rules defined in Section 17 of [RFC4918] and due to the fact that all
- XML elements defined by this 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
-
-
-
-Daboo Expires May 13, 2010 [Page 5]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
- "CARDDAV:" will be prefixed to the element types, respectively.
-
- This document inherits, and sometimes extends, DTD productions from
- Section 14 of [RFC4918].
-
- 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.
-
-
-3. Requirements Overview
-
- This section lists what functionality is required of a CardDAV
- server. To advertise support for CardDAV, a server:
-
- o MUST support vCard v3 [RFC2426] as a media type for the address
- object resource format;
-
- o MUST support WebDAV Class 3 [RFC4918];
-
- o MUST support WebDAV ACL [RFC3744];
-
- o MUST support secure transport as defined in [RFC2818] using TLS
- [RFC5246] and using the certificate validation procedures
- described in [RFC5280];
-
- o MUST support ETags [RFC2616] with additional requirements
- specified in Section 6.3.2.3 of this document;
-
- o MUST support all address book reports defined in Section 8 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 [RFC3253].
-
- In addition, a server:
-
- o SHOULD support vCard v4 [I-D.ietf-vcarddav-vcardrev] as a media
- type for the address object resource format;
-
- o SHOULD support the extended MKCOL method [RFC5689] to create
- address book collections as defined in Section 6.3.1 of this
- document.
-
- o SHOULD support the DAV:current-user-principal-URL property as
- defined in [RFC5397] to give clients a fast way to locate user
-
-
-
-Daboo Expires May 13, 2010 [Page 6]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
- principals.
-
-
-4. Address Book Data Model
-
- 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 contain 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 Section 5.1 and
- Section 5.2.
-
-4.1. Address Book Server
-
- 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.
-
-
-5. Address Book Resources
-
-
-
-
-
-
-Daboo Expires May 13, 2010 [Page 7]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
-5.1. Address Object Resources
-
- 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
- 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.
-
-5.1.1. Data Type Conversion
-
- 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
- Section 6.2.2).
-
- However, clients can use standard HTTP content negotiation behavior
- (the Accept request header defined in Section 14.1 of [RFC2616]) to
- request that an address object resource's data be returned in a
- specific media type format. For example, a client only 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 Section 10.4).
-
- 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
- Section 8.7.2 for an example of this.
-
-
-
-
-
-Daboo Expires May 13, 2010 [Page 8]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
-5.1.1.1. Additional Precondition for GET
-
- This specification creates additional preconditions for the GET
- method.
-
- 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;
-
-5.2. Address Book Collections
-
- 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:
-
- <!ELEMENT addressbook EMPTY>
-
- 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 Section 6.3.1).
- 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"). Note however 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
- Section 6.2.1 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.
- i.e., 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. i.e., "nesting" of
- address book collections within other address book collections at
-
-
-
-Daboo Expires May 13, 2010 [Page 9]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
- 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.
-
- Multiple address book collections MAY be children of the same
- collection.
-
-
-6. Address Book Feature
-
-6.1. Address Book Support
-
- 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.
-
-6.1.1. Example: Using OPTIONS for the Discovery of Support for CardDAV
-
- >> Request <<
-
- OPTIONS /addressbooks/users/ HTTP/1.1
- Host: addressbook.example.com
-
- >> Response <<
-
- 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.
-
-6.2. Address Book Properties
-
-
-
-
-
-
-
-Daboo Expires May 13, 2010 [Page 10]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
-6.2.1. CARDDAV:addressbook-description Property
-
- Name: addressbook-description
-
- Namespace: urn:ietf:params:xml:ns:carddav
-
- Purpose: Provides a human-readable description of the address book
- collection.
-
- 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:
-
- <!ELEMENT addressbook-description (#PCDATA)>
- <!-- PCDATA value: string -->
-
- Example:
-
- <C:addressbook-description xml:lang="fr-CA"
- xmlns:C="urn:ietf:params:xml:ns:carddav"
- >Adresses de Oliver Daboo</C:addressbook-description>
-
-6.2.2. CARDDAV:supported-address-data Property
-
- 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.
-
-
-
-
-
-
-
-Daboo Expires May 13, 2010 [Page 11]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
- 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
- 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
- (Section 6.3.2.1) 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.
-
- Definition:
-
- <!ELEMENT supported-address-data (address-data-type+)>
-
- <!ELEMENT address-data-type EMPTY>
- <!ATTLIST address-data-type content-type CDATA "text/vcard"
- version CDATA "3.0">
- <!-- content-type value: a MIME media type -->
- <!-- version value: a version string -->
-
-
-
- Example:
-
- <C:supported-address-data
- xmlns:C="urn:ietf:params:xml:ns:carddav">
- <C:address-data-type content-type="text/vcard" version="3.0"/>
- </C:supported-address-data>
-
-6.2.3. CARDDAV:max-resource-size Property
-
- 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.
-
-
-
-
-Daboo Expires May 13, 2010 [Page 12]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
- 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.
-
- 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
- (Section 6.3.2.1) 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:
-
- <!ELEMENT max-resource-size (#PCDATA)>
- <!-- PCDATA value: a numeric value (positive decimal integer) -->
-
- Example:
-
- <C:max-resource-size xmlns:C="urn:ietf:params:xml:ns:carddav"
- >102400</C:max-resource-size>
-
-6.3. Creating Resources
-
- Address book collections and address object resources may be created
- by either a CardDAV client or by the CardDAV server. This
- specification defines restrictions and a data model that both clients
- and servers MUST adhere to when manipulating such address data.
-
-6.3.1. Extended MKCOL Method
-
- An HTTP request using the extended MKCOL method [RFC5689] 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 Section 5.2.
-
-
-
-Daboo Expires May 13, 2010 [Page 13]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
- 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.
-
- 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.
-
-6.3.1.1. Example - Successful MKCOL request
-
- 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.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Daboo Expires May 13, 2010 [Page 14]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
- >> Request <<
-
- MKCOL /home/lisa/addressbook/ HTTP/1.1
- Host: addressbook.example.com
- Content-Type: text/xml; charset="utf-8"
- Content-Length: xxx
-
- <?xml version="1.0" encoding="utf-8" ?>
- <D:mkcol xmlns:D="DAV:"
- xmlns:C="urn:ietf:params:xml:ns:carddav">
- <D:set>
- <D:prop>
- <D:resourcetype>
- <D:collection/>
- <C:addressbook/>
- </D:resourcetype>
- <D:displayname>Lisa's Contacts</D:displayname>
- <C:addressbook-description xml:lang="en"
- >My primary address book.</C:addressbook-description>
- </D:prop>
- </D:set>
- </D:mkcol>
-
- >> Response <<
-
- 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
-
- <?xml version="1.0" encoding="utf-8" ?>
- <D:mkcol-response xmlns:D="DAV:"
- xmlns:C="urn:ietf:params:xml:ns:carddav">
- <D:propstat>
- <D:prop>
- <D:resourcetype/>
- <D:displayname/>
- <C:addressbook-description/>
- </D:prop>
- <D:status>HTTP/1.1 200 OK</D:status>
- </D:propstat>
- </D:mkcol-response>
-
-
-
-
-
-
-
-
-Daboo Expires May 13, 2010 [Page 15]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
-6.3.2. Creating Address Object Resources
-
- 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.
-
- >> Request <<
-
- 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 at 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
-
-
-
-
-
-Daboo Expires May 13, 2010 [Page 16]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
- >> Response <<
-
- 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.
-
-6.3.2.1. Additional Preconditions for PUT, COPY and MOVE
-
- This specification creates additional Preconditions for 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.
-
- 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;
-
- <!ELEMENT no-uid-conflict (DAV:href)>
-
-
-
-
-
-
-Daboo Expires May 13, 2010 [Page 17]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
- (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 (Section 6.2.3) on the address book
- collection where the resource will be stored;
-
-6.3.2.2. Non-Standard vCard Properties, and Parameters
-
- 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. Servers SHOULD ensure that any "private" properties
- or parameters it uses follow the convention of including a vendor id
- in the "X-" name, as described in Section 3.8 of [RFC2426], e.g.,
- "X-ABC-PRIVATE".
-
-6.3.2.3. Address Object Resource Entity Tag
-
- 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 and have the DAV:getetag property returned, and 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.
-
-
-
-Daboo Expires May 13, 2010 [Page 18]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
- 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, clients 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.
-
-
-7. Address Book Access Control
-
- CardDAV servers MUST support and adhere to the requirements of WebDAV
- ACL [RFC3744]. WebDAV ACL provides a framework for an extensible set
- of privileges that can be applied to WebDAV collections and ordinary
- resources.
-
-7.1. Additional Principal Properties
-
- This section defines additional properties for WebDAV principal
- resources as defined in [RFC3744].
-
-7.1.1. CARDDAV:addressbook-home-set Property
-
- 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 either are address
- book collections or ordinary collections that have child or
- descendant address book collections owned by the principal.
-
-
-
-Daboo Expires May 13, 2010 [Page 19]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
- Definition:
-
- <!ELEMENT addressbook-home-set (DAV:href*)>
-
- Example:
-
- <C:addressbook-home-set xmlns:D="DAV:"
- xmlns:C="urn:ietf:params:xml:ns:carddav">
- <D:href>/bernard/addresses/</D:href>
- </C:addressbook-home-set>
-
-7.1.2. CARDDAV:principal-address Property
-
- 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.
-
- 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:
-
- <!ELEMENT principal-address (DAV:href)>
-
- Example:
-
- <C:principal-address xmlns:D="DAV:"
- xmlns:C="urn:ietf:params:xml:ns:carddav">
- <D:href>/system/cyrus.vcf</D:href>
- </C:principal-address>
-
-
-
-
-Daboo Expires May 13, 2010 [Page 20]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
-8. Address Book Reports
-
- 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 Section 3.1.5 of [RFC3253].
- 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.
-
-8.1. REPORT Method
-
- The REPORT method (defined in Section 3.6 of [RFC3253]) 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
- 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 Section 3.8 of [RFC3253]).
-
-8.2. Ordinary Collections
-
- 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.
-
-8.3. Searching Text: Collations
-
- 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.
-
-
-
-
-Daboo Expires May 13, 2010 [Page 21]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
- To deal with this, this specification makes use of the IANA Collation
- Registry defined in [RFC4790] 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 [RFC4790] Section 4.2, 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"
- [RFC4790] and "i;unicode-casemap" [RFC5051] 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.
-
- In the absence of a collation explicitly specified by the client, or
- if the client specifies the "default" collation identifier (as
- defined in [RFC4790] Section 3.1), the server MUST default to using
- "i;unicode-casemap" as the collation.
-
- Wildcards (as defined in [RFC4790] Section 3.2) 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.
-
-8.3.1. CARDDAV:supported-collation-set Property
-
- 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.
-
-
-
-
-
-
-
-Daboo Expires May 13, 2010 [Page 22]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
- 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 which specify the
- identifiers of the collations supported by the server.
-
- Definition:
-
- <!ELEMENT supported-collation-set (
- supported-collation
- supported-collation
- supported-collation*)>
- <!-- Both "i;ascii-casemap" and "i;unicode-casemap"
- will be present -->
-
- <!ELEMENT supported-collation (#PCDATA)>
-
- Example:
-
- <C:supported-collation-set
- xmlns:C="urn:ietf:params:xml:ns:carddav">
- <C:supported-collation>i;ascii-casemap</C:supported-collation>
- <C:supported-collation>i;octet</C:supported-collation>
- <C:supported-collation>i;unicode-casemap</C:supported-collation>
- </C:supported-collation-set>
-
-8.4. Partial Retrieval
-
- 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 Section 10.4.
-
-8.5. Non-standard Properties and Parameters
-
- 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.
-
-
-
-
-Daboo Expires May 13, 2010 [Page 23]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
- 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 which the server does not support queries
- on.
-
-8.6. CARDDAV:addressbook-query Report
-
- 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
- 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 which
- does not exist is an error and MUST be noted with a response XML
- element which 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 Section 10.3.
-
- The request MUST include a Depth header. The scope of the query
- is determined by the value of the Depth header. e.g., 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
-
-
-
-Daboo Expires May 13, 2010 [Page 24]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
- 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
- Section 10.4) specify a media type supported by the server for
- address object resources.
-
- (CARDDAV:supported-filter): The CARDDAV:prop-filter (see
- Section 10.5.1) and CARDDAV:param-filter (see Section 10.5.2) XML
- elements used in the CARDDAV:filter XML element (see Section 10.5)
- in the REPORT request only make reference to vCard properties and
- parameters for which queries are supported by the server. i.e., if
- the CARDDAV:filter element attempts to reference an unsupported
- vCard property or parameter, this precondition is violated.
- Servers SHOULD report the CARDDAV:prop-filter or CARDDAV:param-
- filter for which it does not provide support.
-
- <!ELEMENT supported-filter (prop-filter*,
- param-filter*)>
-
- (CARDDAV:supported-collation): Any XML attribute specifying a
- collation MUST specify a collation supported by the server as
- described in Section 8.3.
-
- 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.
-
-8.6.1. Limiting Results
-
- 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
-
-
-
-Daboo Expires May 13, 2010 [Page 25]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
- truncated by the server, the server MUST follow the rules below for
- indicating a result set truncation to the client.
-
-8.6.2. Truncation of Results
-
- 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, 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
- [RFC3744] (Section 9.2).
-
- 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).
-
-8.6.3. Example: Partial Retrieval of vCards Matching NICKNAME
-
- In this example, the client requests the server to search for address
- object resources that contain a NICKNAME property whose value equals
- some specific text, and to return specific vCard properties for those
- vCards found. In addition the DAV:getetag property is also requested
- and returned as part of the response.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Daboo Expires May 13, 2010 [Page 26]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
- >> Request <<
-
-
- REPORT /home/bernard/addressbook/ HTTP/1.1
- Host: addressbook.example.com
- Depth: 1
- Content-Type: text/xml; charset="utf-8"
- Content-Length: xxxx
-
- <?xml version="1.0" encoding="utf-8" ?>
- <C:addressbook-query xmlns:D="DAV:"
- xmlns:C="urn:ietf:params:xml:ns:carddav">
- <D:prop>
- <D:getetag/>
- <C:address-data>
- <C:prop name="VERSION"/>
- <C:prop name="UID"/>
- <C:prop name="NICKNAME"/>
- <C:prop name="EMAIL"/>
- <C:prop name="FN"/>
- </C:address-data>
- </D:prop>
- <C:filter>
- <C:prop-filter name="NICKNAME">
- <C:text-match collation="i;unicode-casemap"
- match-type="equals"
- >me</C:text-match>
- </C:prop-filter>
- </C:filter>
- </C:addressbook-query>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Daboo Expires May 13, 2010 [Page 27]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
- >> Response <<
-
-
- 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
-
- <?xml version="1.0" encoding="utf-8" ?>
- <D:multistatus xmlns:D="DAV:"
- xmlns:C="urn:ietf:params:xml:ns:carddav">
- <D:response>
- <D:href>/home/bernard/addressbook/v102.vcf</D:href>
- <D:propstat>
- <D:prop>
- <D:getetag>"23ba4d-ff11fb"</D:getetag>
- <C:address-data>BEGIN:VCARD
- VERSION:3.0
- NICKNAME:me
- UID:34222-232 at example.com
- FN:Cyrus Daboo
- EMAIL:daboo at example.com
- END:VCARD
- </C:address-data>
- </D:prop>
- <D:status>HTTP/1.1 200 OK</D:status>
- </D:propstat>
- </D:response>
- </D:multistatus>
-
-
-8.6.4. Example: Partial Retrieval of vCards Matching a Full Name or
- Email Address
-
- In this example, the client requests the server to 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 to return specific vCard properties for those vCards
- found. In addition the DAV:getetag property is also requested and
- returned as part of the response.
-
-
-
-
-
-
-
-
-
-
-
-Daboo Expires May 13, 2010 [Page 28]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
- >> Request <<
-
-
- REPORT /home/bernard/addressbook/ HTTP/1.1
- Host: addressbook.example.com
- Depth: 1
- Content-Type: text/xml; charset="utf-8"
- Content-Length: xxxx
-
- <?xml version="1.0" encoding="utf-8" ?>
- <C:addressbook-query xmlns:D="DAV:"
- xmlns:C="urn:ietf:params:xml:ns:carddav">
- <D:prop>
- <D:getetag/>
- <C:address-data>
- <C:prop name="VERSION"/>
- <C:prop name="UID"/>
- <C:prop name="NICKNAME"/>
- <C:prop name="EMAIL"/>
- <C:prop name="FN"/>
- </C:address-data>
- </D:prop>
- <C:filter test="anyof">
- <C:prop-filter name="FN">
- <C:text-match collation="i;unicode-casemap"
- match-type="contains"
- >daboo</C:text-match>
- </C:prop-filter>
- <C:prop-filter name="EMAIL">
- <C:text-match collation="i;unicode-casemap"
- match-type="contains"
- >daboo</C:text-match>
- </C:prop-filter>
- </C:filter>
- </C:addressbook-query>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Daboo Expires May 13, 2010 [Page 29]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
- >> Response <<
-
-
- 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
-
- <?xml version="1.0" encoding="utf-8" ?>
- <D:multistatus xmlns:D="DAV:"
- xmlns:C="urn:ietf:params:xml:ns:carddav">
- <D:response>
- <D:href>/home/bernard/addressbook/v102.vcf</D:href>
- <D:propstat>
- <D:prop>
- <D:getetag>"23ba4d-ff11fb"</D:getetag>
- <C:address-data>BEGIN:VCARD
- VERSION:3.0
- NICKNAME:me
- UID:34222-232 at example.com
- FN:David Boo
- EMAIL:daboo at example.com
- END:VCARD
- </C:address-data>
- </D:prop>
- <D:status>HTTP/1.1 200 OK</D:status>
- </D:propstat>
- </D:response>
- <D:response>
- <D:href>/home/bernard/addressbook/v104.vcf</D:href>
- <D:propstat>
- <D:prop>
- <D:getetag>"23ba4d-ff11fc"</D:getetag>
- <C:address-data>BEGIN:VCARD
- VERSION:3.0
- NICKNAME:oliver
- UID:34222-23222 at example.com
- FN:Oliver Daboo
- EMAIL:oliver at example.com
- END:VCARD
- </C:address-data>
- </D:prop>
- <D:status>HTTP/1.1 200 OK</D:status>
- </D:propstat>
- </D:response>
- </D:multistatus>
-
-
-
-
-
-Daboo Expires May 13, 2010 [Page 30]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
-8.6.5. Example: Truncated Results
-
- In this example, the client requests the server to search for address
- object resources that contain a FN property whose value contains some
- specific text, and to 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.
-
- >> Request <<
-
-
- REPORT /home/bernard/addressbook/ HTTP/1.1
- Host: addressbook.example.com
- Depth: 1
- Content-Type: text/xml; charset="utf-8"
- Content-Length: xxxx
-
- <?xml version="1.0" encoding="utf-8" ?>
- <C:addressbook-query xmlns:D="DAV:"
- xmlns:C="urn:ietf:params:xml:ns:carddav">
- <D:prop>
- <D:getetag/>
- </D:prop>
- <C:filter test="anyof">
- <C:prop-filter name="FN">
- <C:text-match collation="i;unicode-casemap"
- match-type="contains"
- >daboo</C:text-match>
- </C:prop-filter>
- </C:filter>
- <C:limit>
- <C:nresults>2</C:nresults>
- </C:limit>
- </C:addressbook-query>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Daboo Expires May 13, 2010 [Page 31]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
- >> Response <<
-
-
- 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
-
- <?xml version="1.0" encoding="utf-8" ?>
- <D:multistatus xmlns:D="DAV:"
- xmlns:C="urn:ietf:params:xml:ns:carddav">
- <D:response>
- <D:href>/home/bernard/addressbook/</D:href>
- <D:status>HTTP/1.1 507 OK</D:status>
- <D:error><D:number-of-matches-within-limits/></D:error>
- <D:responsedescription xml:lang="en">
- Only two matching records were returned
- </D:responsedescription>
- </D:response>
- <D:response>
- <D:href>/home/bernard/addressbook/v102.vcf</D:href>
- <D:propstat>
- <D:prop>
- <D:getetag>"23ba4d-ff11fb"</D:getetag>
- </D:prop>
- <D:status>HTTP/1.1 200 OK</D:status>
- </D:propstat>
- </D:response>
- <D:response>
- <D:href>/home/bernard/addressbook/v104.vcf</D:href>
- <D:propstat>
- <D:prop>
- <D:getetag>"23ba4d-ff11fc"</D:getetag>
- </D:prop>
- <D:status>HTTP/1.1 200 OK</D:status>
- </D:propstat>
- </D:response>
- </D:multistatus>
-
-
-8.7. CARDDAV:addressbook-multiget Report
-
- 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 a address object resource. This report is
- similar to the CARDDAV:addressbook-query REPORT (see Section 8.6),
- except that it takes a list of DAV:href elements instead of a
-
-
-
-Daboo Expires May 13, 2010 [Page 32]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
- 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 Section 10.7), which MUST contain at least one DAV:
- href XML element, and one optional CARDDAV:address-data element as
- defined in Section 10.4. 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.
-
- Preconditions:
-
- (CARDDAV:supported-address-data): The attributes "content-type"
- and "version" of the CARDDAV:address-data XML elements (see
- Section 10.4) specify a media type supported by the server for
- address object resources.
-
- Postconditions:
-
- None.
-
-
-
-
-
-
-
-Daboo Expires May 13, 2010 [Page 33]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
-8.7.1. Example: CARDDAV:addressbook-multiget Report
-
- 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.
-
- >> Request <<
-
-
- REPORT /home/bernard/addressbook/ HTTP/1.1
- Host: addressbook.example.com
- Depth: 1
- Content-Type: text/xml; charset="utf-8"
- Content-Length: xxxx
-
- <?xml version="1.0" encoding="utf-8" ?>
- <C:addressbook-multiget xmlns:D="DAV:"
- xmlns:C="urn:ietf:params:xml:ns:carddav">
- <D:prop>
- <D:getetag/>
- <C:address-data>
- <C:prop name="VERSION"/>
- <C:prop name="UID"/>
- <C:prop name="NICKNAME"/>
- <C:prop name="EMAIL"/>
- <C:prop name="FN"/>
- </C:address-data>
- </D:prop>
- <D:href>/home/bernard/addressbook/vcf102.vcf</D:href>
- <D:href>/home/bernard/addressbook/vcf1.vcf</D:href>
- </C:addressbook-multiget>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Daboo Expires May 13, 2010 [Page 34]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
- >> Response <<
-
-
- 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
-
- <?xml version="1.0" encoding="utf-8" ?>
- <D:multistatus xmlns:D="DAV:"
- xmlns:C="urn:ietf:params:xml:ns:carddav">
- <D:response>
- <D:href>/home/bernard/addressbook/vcf102.vcf</D:href>
- <D:propstat>
- <D:prop>
- <D:getetag>"23ba4d-ff11fb"</D:getetag>
- <C:address-data>BEGIN:VCARD
- VERSION:3.0
- NICKNAME:me
- UID:34222-232 at example.com
- FN:Cyrus Daboo
- EMAIL:daboo at example.com
- END:VCARD
- </C:address-data>
- </D:prop>
- <D:status>HTTP/1.1 200 OK</D:status>
- </D:propstat>
- </D:response>
- <D:response>
- <D:href>/home/bernard/addressbook/vcf1.vcf</D:href>
- <D:status>HTTP/1.1 404 Resource not found</D:status>
- </D:response>
- </D:multistatus>
-
-
-8.7.2. Example: CARDDAV:addressbook-multiget Report
-
- 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.
-
-
-
-
-
-
-
-Daboo Expires May 13, 2010 [Page 35]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
- >> Request <<
-
-
- REPORT /home/bernard/addressbook/ HTTP/1.1
- Host: addressbook.example.com
- Depth: 1
- Content-Type: text/xml; charset="utf-8"
- Content-Length: xxxx
-
- <?xml version="1.0" encoding="utf-8" ?>
- <C:addressbook-multiget xmlns:D="DAV:"
- xmlns:C="urn:ietf:params:xml:ns:carddav">
- <D:prop>
- <D:getetag/>
- <C:address-data type='text/vcard' version='4.0'/>
- </D:prop>
- <D:href>/home/bernard/addressbook/vcf3.vcf</D:href>
- </C:addressbook-multiget>
-
-
- >> Response <<
-
-
- 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
-
- <?xml version="1.0" encoding="utf-8" ?>
- <D:multistatus xmlns:D="DAV:"
- xmlns:C="urn:ietf:params:xml:ns:carddav">
- <D:response>
- <D:href>/home/bernard/addressbook/vcf3.vcf</D:href>
- <D:status>HTTP/1.1 415 Unsupported Media Type</D:status>
- <D:error><C:supported-address-data-conversion/></D:error>
- <D:responsedescription>Unable to convert from vCard v3.0
- to vCard v4.0</D:responsedescription>
- </D:response>
- </D:multistatus>
-
-
-
-9. Client Guidelines
-
-9.1. Restrict the Properties Returned
-
- Clients may not need all the properties in a vCard object when
- presenting information to the user, or looking up specific items for
-
-
-
-Daboo Expires May 13, 2010 [Page 36]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
- their email address, for example. Since some property data can be
- large (e.g., PHOTO or SOUND with inline 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.
-
- 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.
-
-9.2. Avoiding Lost Updates
-
- When resources are accessed by multiple clients, the possibility of
- clients overwriting each other's changes exists. To alleviate that,
- 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
- pre-condition 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).
-
-9.3. Client Configuration
-
- 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 [RFC5397] to give
- clients a fast way to locate user principals.
-
- Given support for SRV records (Section 11) and DAV:current-user-
- principal-URL [RFC5397], 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.
-
-9.4. Finding Other Users' Address Books
-
- For address book sharing use cases, 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
- [RFC3744] can be used to filter on some properties and return others.
- To search for an address book owned by a user named "Laurie", the
-
-
-
-Daboo Expires May 13, 2010 [Page 37]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
- REPORT request body would look like this:
-
- <?xml version="1.0" encoding="utf-8" ?>
- <D:principal-property-search xmlns:D="DAV:">
- <D:property-search>
- <D:prop>
- <D:displayname/>
- </D:prop>
- <D:match>Laurie</D:match>
- </D:property-search>
- <D:prop>
- <C:addressbook-home-set
- xmlns:C="urn:ietf:params:xml:ns:carddav"/>
- <D:displayname/>
- </D:prop>
- </D:principal-property-search>
-
- 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.
-
-
-10. XML Element Definitions
-
-10.1. CARDDAV:addressbook XML Element
-
- Name: addressbook
-
- Namespace: urn:ietf:params:xml:ns:carddav
-
- Purpose: Specifies the resource type of an address book collection.
-
- Description: See Section 5.2.
-
- Definition:
-
- <!ELEMENT addressbook EMPTY>
-
-10.2. CARDDAV:supported-collation XML Element
-
- Name: supported-collation
-
- Namespace: urn:ietf:params:xml:ns:carddav
-
-
-
-
-
-
-Daboo Expires May 13, 2010 [Page 38]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
- Purpose: Identifies a single collation via its collation identifier
- as defined by [RFC4790].
-
- Description: The CARDDAV:supported-collation contains the text of a
- collation identifier as described in Section 8.3.1.
-
- Definition:
-
- <!ELEMENT supported-collation (#PCDATA)>
- <!-- PCDATA value: collation identifier -->
-
-10.3. CARDDAV:addressbook-query XML Element
-
- Name: addressbook-query
-
- Namespace: urn:ietf:params:xml:ns:carddav
-
- Purpose: Defines a report for querying address book data
-
- Description: See Section 8.6.
-
- Definition:
-
- <!ELEMENT addressbook-query ((DAV:allprop |
- DAV:propname |
- DAV:prop)?, filter, limit?)>
-
-10.4. CARDDAV:address-data XML Element
-
- Name: address-data
-
- Namespace: urn:ietf:params:xml:ns:carddav
-
- Purpose: Specifies one of the following:
-
- 1. The parts of an address object resource which should be
- returned by a given address book REPORT request, and the media
- type and version for the returned data;
-
- 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
-
-
-
-Daboo Expires May 13, 2010 [Page 39]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
- 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 a
- address object resource. Given that XML parsers normalize the
- 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 <, >, & etc entity encoding or
- the use of a <![CDATA[ ... ]]> construct. In the later case the
- vCard data cannot contain the character sequence "]]>" which is
- the end delimiter for the CDATA section.
-
- Definition:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Daboo Expires May 13, 2010 [Page 40]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
- <!ELEMENT address-data (allprop | prop*)>
-
- 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;
-
- <!ELEMENT address-data (#PCDATA)>
- <!-- PCDATA value: address data -->
-
- when nested in the DAV:prop XML element in an address book
- REPORT response to specify the content of a returned
- address object resource.
-
- <!ATTLIST address-data content-type CDATA "text/vcard"
- version CDATA "3.0">
- <!-- content-type value: a MIME media type -->
- <!-- version value: a version string -->
-
- attributes can be used on each variant of the
- CALDAV:address-data XML element.
-
-10.4.1. CARDDAV:allprop XML Element
-
- 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:
-
- <!ELEMENT allprop EMPTY>
-
- 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.
-
-10.4.2. CARDDAV:prop XML Element
-
-
-
-
-
-
-
-
-Daboo Expires May 13, 2010 [Page 41]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
- 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. e.g.: 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:
-
- <!ELEMENT prop EMPTY>
-
- <!ATTLIST prop name CDATA #REQUIRED
- novalue (yes | no) "no">
- <!-- name value: a vCard property name -->
- <!-- novalue value: "yes" or "no" -->
-
- 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.
-
-10.5. CARDDAV:filter XML Element
-
- Name: filter
-
- Namespace: urn:ietf:params:xml:ns:carddav
-
-
-
-
-
-
-
-Daboo Expires May 13, 2010 [Page 42]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
- 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 needs to match in order for
- the overall filter to match.
-
- Definition:
-
- <!ELEMENT filter (prop-filter*)>
-
- <!ATTLIST filter test (anyof | allof) "anyof">
- <!-- test value:
- anyof logical OR for prop-filter matches
- allof logical AND for prop-filter matches -->
-
-10.5.1. CARDDAV:prop-filter XML Element
-
- Name: prop-filter
-
- Namespace: urn:ietf:params:xml:ns:carddav
-
- Purpose: Limits the search to specific vCard properties.
-
- Description: The CARDDAV:prop-filter XML element specifies a 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
-
-
-
-Daboo Expires May 13, 2010 [Page 43]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
- exactly the same group prefix and name. e.g.: 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:
-
- <!ELEMENT prop-filter (is-not-defined |
- (text-match*, param-filter*))>
-
- <!ATTLIST prop-filter name CDATA #REQUIRED
- test (anyof | allof) "anyof">
- <!-- 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 -->
-
-10.5.2. CARDDAV:param-filter XML Element
-
- Name: param-filter
-
- Namespace: urn:ietf:params:xml:ns:carddav
-
- Purpose: Limits the search to specific parameter values.
-
- Description: The CARDDAV:param-filter XML element specifies a 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:
-
- <!ELEMENT param-filter (is-not-defined | text-match)?>
-
- <!ATTLIST param-filter name CDATA #REQUIRED>
- <!-- name value: a property parameter name (e.g., "TYPE") -->
-
-
-
-
-
-
-Daboo Expires May 13, 2010 [Page 44]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
-10.5.3. CARDDAV:is-not-defined XML Element
-
- 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:
-
- <!ELEMENT is-not-defined EMPTY>
-
-10.5.4. CARDDAV:text-match XML Element
-
- Name: text-match
-
- Namespace: urn:ietf:params:xml:ns:carddav
-
- Purpose: Specifies a substring match on a vCard property or
- parameter value.
-
- 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:
-
-
-
-
-
-
-Daboo Expires May 13, 2010 [Page 45]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
- "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:
-
- <!ELEMENT text-match (#PCDATA)>
- <!-- PCDATA value: string -->
-
- <!ATTLIST text-match
- collation CDATA "i;unicode-casemap"
- negate-condition (yes | no) "no"
- match-type (equals|contains|starts-with|ends-with) "contains">
-
-10.6. CARDDAV:limit XML Element
-
- 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.
-
- 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:
-
- <!ELEMENT limit (nresults)>
-
-10.6.1. CARDDAV:nresults XML Element
-
- Name: nresults
-
- Namespace: urn:ietf:params:xml:ns:carddav
-
-
-
-
-
-
-Daboo Expires May 13, 2010 [Page 46]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
- 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:
-
- <!ELEMENT nresults (#PCDATA)>
- <!-- nresults value: unsigned integer, must be digits -->
-
-10.7. CARDDAV:addressbook-multiget XML Element
-
- Name: addressbook-multiget
-
- Namespace: urn:ietf:params:xml:ns:carddav
-
- Purpose: CardDAV report used to retrieve specific address objects
- via their URIs.
-
- Description: See Section 8.7.
-
- Definition:
-
- <!ELEMENT addressbook-multiget ((DAV:allprop |
- DAV:propname |
- DAV:prop)?,
- DAV:href+)>
-
-
-11. Service Discovery via SRV Records
-
- [RFC2782] 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 RR records.
-
- This specification adds two service types for use with SRV records:
-
- carddav: Identifies a CardDAV server that uses HTTP without TLS
- [RFC2818].
-
- carddavs: Identifies a CardDAV server that uses HTTP with TLS
- [RFC2818].
-
-
-
-
-
-
-Daboo Expires May 13, 2010 [Page 47]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
- 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.
-
-
-12. Internationalization Considerations
-
- CardDAV allows internationalized strings to be stored and retrieved
- for the description of address book collections (see Section 6.2.1).
-
- The CARDDAV:addressbook-query REPORT (Section 8.6) 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 Section 10.5.4).
-
-
-13. Security Considerations
-
- 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 [RFC2818]. In particular,
- if HTTP Basic authentication [RFC2617] is available, the server MUST
- allow TLS to be used at the same time, and SHOULD prevent use of
- Basic authentication when TLS is not in use. Clients SHOULD use TLS
- whenever possible.
-
- With the ACL extension [RFC3744] 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"
- (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, and 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
-
-
-
-Daboo Expires May 13, 2010 [Page 48]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
- 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 [RFC2617] as well as TLS [RFC2818] using client-side
- certificates.
-
-
-14. IANA Consideration
-
- This document uses a URN to describe a new XML namespace conforming
- to the registry mechanism described in [RFC3688].
-
-14.1. Namespace Registration
-
- Registration request for the carddav namespace:
-
- URI: urn:ietf:params:xml:ns:carddav
-
- Registrant Contact: See the "Author's Address" section of this
- document.
-
- XML: None - not applicable for namespace registrations.
-
-
-15. Acknowledgments
-
- 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.
-
-
-16. References
-
-16.1. Normative References
-
- [I-D.ietf-vcarddav-vcardrev]
- Perreault, S. and P. Resnick, "vCard Format
- Specification", draft-ietf-vcarddav-vcardrev-08 (work in
- progress), July 2009.
-
- [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
-
-
-
-Daboo Expires May 13, 2010 [Page 49]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
- Requirement Levels", BCP 14, RFC 2119, March 1997.
-
- [RFC2426] Dawson, F. and T. Howes, "vCard MIME Directory Profile",
- RFC 2426, September 1998.
-
- [RFC2616] Fielding, R., Gettys, J., Mogul, J., Frystyk, H.,
- Masinter, L., Leach, P., and T. Berners-Lee, "Hypertext
- Transfer Protocol -- HTTP/1.1", RFC 2616, June 1999.
-
- [RFC2617] Franks, J., Hallam-Baker, P., Hostetler, J., Lawrence, S.,
- Leach, P., Luotonen, A., and L. Stewart, "HTTP
- Authentication: Basic and Digest Access Authentication",
- RFC 2617, June 1999.
-
- [RFC2782] Gulbrandsen, A., Vixie, P., and L. Esibov, "A DNS RR for
- specifying the location of services (DNS SRV)", RFC 2782,
- February 2000.
-
- [RFC2818] Rescorla, E., "HTTP Over TLS", RFC 2818, May 2000.
-
- [RFC3253] Clemm, G., Amsden, J., Ellison, T., Kaler, C., and J.
- Whitehead, "Versioning Extensions to WebDAV
- (Web Distributed Authoring and Versioning)", RFC 3253,
- March 2002.
-
- [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
- January 2004.
-
- [RFC3744] Clemm, G., Reschke, J., Sedlar, E., and J. Whitehead, "Web
- Distributed Authoring and Versioning (WebDAV)
- Access Control Protocol", RFC 3744, May 2004.
-
- [RFC4790] Newman, C., Duerst, M., and A. Gulbrandsen, "Internet
- Application Protocol Collation Registry", RFC 4790,
- March 2007.
-
- [RFC4918] Dusseault, L., "HTTP Extensions for Web Distributed
- Authoring and Versioning (WebDAV)", RFC 4918, June 2007.
-
- [RFC5051] Crispin, M., "i;unicode-casemap - Simple Unicode Collation
- Algorithm", RFC 5051, October 2007.
-
- [RFC5246] Dierks, T. and E. Rescorla, "The Transport Layer Security
- (TLS) Protocol Version 1.2", RFC 5246, August 2008.
-
- [RFC5280] Cooper, D., Santesson, S., Farrell, S., Boeyen, S.,
- Housley, R., and W. Polk, "Internet X.509 Public Key
- Infrastructure Certificate and Certificate Revocation List
-
-
-
-Daboo Expires May 13, 2010 [Page 50]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
- (CRL) Profile", RFC 5280, May 2008.
-
- [RFC5397] Sanchez, W. and C. Daboo, "WebDAV Current Principal
- Extension", RFC 5397, December 2008.
-
- [RFC5689] Daboo, C., "Extended MKCOL for Web Distributed Authoring
- and Versioning (WebDAV)", RFC 5689, September 2009.
-
- [W3C.REC-xml-20081126]
- Paoli, J., Yergeau, F., Bray, T., Sperberg-McQueen, C.,
- and E. Maler, "Extensible Markup Language (XML) 1.0 (Fifth
- Edition)", World Wide Web Consortium Recommendation REC-
- xml-20081126, November 2008,
- <http://www.w3.org/TR/2008/REC-xml-20081126>.
-
-16.2. Informative References
-
- [IMSP] Myers, J., "IMSP - Internet Message Support Protocol",
- June 1995.
-
- [RFC2244] Newman, C. and J. Myers, "ACAP -- Application
- Configuration Access Protocol", RFC 2244, November 1997.
-
- [RFC4510] Zeilenga, K., "Lightweight Directory Access Protocol
- (LDAP): Technical Specification Road Map", RFC 4510,
- June 2006.
-
-
-Appendix A. Change History (to be removed prior to publication as an
- RFC)
-
- Changes in -10
-
- 1. Updated to MKColExt RFC reference.
-
- 2. GenART Review: changed to clients SHOULD support TLS.
-
- 3. GenART Review: changed security considerations in relation to
- clients indicating which address books are private, shared or
- public.
-
- 4. IESG Review: re-wrote section on locking to instead describe how
- to avoid lost updates using ETags.
-
- 5. IESG Review: removed disadvantage describing stateless protocol
- nature.
-
-
-
-
-
-Daboo Expires May 13, 2010 [Page 51]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
- 6. IESG Review: clarified that 507 is only returned when truncation
- of the results set occurs.
-
- 7. IESG Review: added additional text in security considerations
- about the handling private, shared and public address books.
-
- 8. Fixed typos.
-
- 9. Fixed some XML example errors.
-
- Changes in -09
-
- 1. AD Review: support for vCard v4 is now a SHOULD.
-
- 2. As a result of the above, added a sub-section on content
- conversion that defines a new precondition, and added an example
- of a conversion failure when doing a multiget.
-
- Changes in -08
-
- 1. AD Review: added references to list in section 1.
-
- 2. AD Review: added reference to RFC5280 for cert validation
- procedures.
-
- 3. AD Review: added additional comment in addressbook-description
- property relating to use of xml:lang attribute.
-
- 4. AD Review: max-resource-size now explicitly stated to be a
- decimal integer.
-
- 5. AD Review: tweaked text for supported-collation-set to make it
- clear two will always be present.
-
- 6. AD Review: section title change to "Client Guidelines".
-
- 7. AD Review: finding address books section re-worded and reference
- added.
-
- 8. AD Review: re-worded prop-filter description to better explain
- that text-match and param-filter can be specified independently
- of each other.
-
- 9. AD Review: references added to security considerations.
-
- 10. AD Review: changed to RFC4510 reference.
-
- Changes in -07
-
-
-
-Daboo Expires May 13, 2010 [Page 52]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
- 1. WGLC: changed all alprop behaviors to SHOULD NOT return in
- allprop PROPFIND.
-
- 2. WGLC: Reworked XML conventions section to come into line with
- text in extended MKCOL, and also updated W3C reference.
-
- 3. WGLC: Changed a couple of examples to use absolute path DAV:href
- values.
-
- 4. WGLC: Simplified IANA Considerations section.
-
- 5. WGLC: Added new Client Configuration section and removed
- reference to principal-match.
-
- 6. address-data element in supported-address-data changed to
- address-data-type.
-
- 7. REPORTs now require Depth to be present and the scope of matching
- resources is determined by the value of the Depth header.
-
- 8. Removed requirement that DAV:displayname should be unique at each
- level.
-
- Changes in -06
-
- 1. WGLC: addressbook-home-set changed to SHOULD NOT return in
- allprop PROPFIND.
-
- 2. WGLC: principal-address description changed to note that the
- resource pointed to could be in a regular collection too.
-
- 3. Added new section decribing how SRV and current-user-principal
- are used to bootstrap client configuration.
-
- 4. Removed discussion of using principal-match report.
-
- Changes in -05
-
- 1. Removed mailing list discussion note from abstract.
-
- Changes in -04
-
- 1. Tweaked limit element text to not imply any formal ordering of
- results.
-
- 2. Changed prop-filter element to allow zero or more text-match
- elements rather than zero or one.
-
-
-
-
-Daboo Expires May 13, 2010 [Page 53]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
- 3. Updated to RFC5397 reference.
-
- 4. Updated TLS reference to latest version RFC5246.
-
- 5. Boiler plate update.
-
- Changes in -03
-
- 1. Added limit element to addressbook-query.
-
- 2. Specified how a server signals that query results have been
- truncated.
-
- 3. Minor stylistic changes.
-
- Changes in -02
-
- 1. Added text to CARDDAV:prop and CARDDAV:prop-filter elements to
- explain how vCard "group" prefix on property names is handled.
-
- Changes in -01
-
- 1. Added section on SRV records.
-
- Changes in -00
-
- 1. Removed text describing other protocols.
-
- 2. Added comment about a new vcard spec being developed.
-
- 3. Added SHOULD support for the DAV:current-user-principal-URL
- property.
-
- 4. Added "anyof"/"allof" test attribute to query XML elements to
- support simple or/and combinations of tests.
-
- Changes in pre-04
-
- 1. Renamed addressbook-data to address-data for consistency.
-
- 2. Fixed address-data element definition.
-
- Changes in pre-03
-
- 1. Replaced MKADDRESSBOOK with extended MKCOL.
-
- 2. Now require i;uncide-casemap as a supported collation and make it
- the default.
-
-
-
-Daboo Expires May 13, 2010 [Page 54]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
- 3. No longer require i;octet as a supported collation.
-
- 4. Allow different types of match operations via the "match-type"
- attribute on the "text-match" element.
-
- 5. Updated to 4918 reference and removed some text/sections
- duplicating 4918.
-
- 6. WebDAV Level 3 now required.
-
- 7. TLS requirement text tweaked to match latest text approved by
- IESG.
-
- 8. Added principal-address property to principal resources to allow
- a vcard to be associated with a principal.
-
- 9. XML definition clean-up.
-
- Changes in pre-02
-
- 1. Added commentary on SyncML.
-
- 2. Changed 'adbk' to 'addressbook'.
-
- 3. Support for MKADDRESSBOOK is now a SHOULD.
-
- 4. Updated to RFC4790 reference.
-
- 5. Removed synchronization report.
-
- 6. Removed BNF conventions section as we have no BNF.
-
- 7. Reworded and reformatted several items to match the final CalDAV
- spec.
-
- 8. Added section on use of nonstandard properties and parameters
- (as per CalDAV).
-
- 9. Added section of behavior of ETags (as per CalDAV).
-
- 10. Generalized the text so that vCard need not be the only format
- supported by the server (i.e., allow xml version of vCard etc).
-
- 11. Renamed supported-addressbook-data to supported-address-data.
-
- 12. Renamed valid-addressbook-data to valid-address-data.
-
-
-
-
-
-Daboo Expires May 13, 2010 [Page 55]
-
-Internet-Draft vCard Extensions to WebDAV (CardDAV) November 2009
-
-
- 13. Now requires "i;unicasemao" collation.
-
- Changes in pre-01
-
- 1. Fixed various incorrect references and typos.
-
- 2. Major changes to sync with latest CalDAV spec behaviors.
-
-
-Author's Address
-
- Cyrus Daboo
- Apple Inc.
- 1 Infinite Loop
- Cupertino, CA 95014
- USA
-
- Email: cyrus at daboo.name
- URI: http://www.apple.com/
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Daboo Expires May 13, 2010 [Page 56]
-
Deleted: CalendarServer/trunk/doc/RFC/draft-reschke-webdav-post.txt
===================================================================
--- CalendarServer/trunk/doc/RFC/draft-reschke-webdav-post.txt 2011-09-01 14:47:28 UTC (rev 8039)
+++ CalendarServer/trunk/doc/RFC/draft-reschke-webdav-post.txt 2011-09-01 15:06:35 UTC (rev 8040)
@@ -1,784 +0,0 @@
-
-
-
-Network Working Group J. Reschke
-Internet-Draft greenbytes
-Intended status: Standards Track November 22, 2009
-Expires: May 26, 2010
-
-
- Using POST to add Members to Web Distributed Authoring and Versioning
- (WebDAV) Collections
- draft-reschke-webdav-post-05
-
-Abstract
-
- The Hypertext Transfer Protocol (HTTP) Extensions for the Web
- Distributed Authoring and Versioning (WebDAV) do not define the
- behavior for the "POST" method when applied to collections, as the
- base specification (HTTP) leaves implementers lots of freedom for the
- semantics of "POST".
-
- This has led to a situation where many WebDAV servers do not
- implement POST for collections at all, although it is well suited to
- be used for the purpose of adding new members to a collection, where
- the server remains in control of the newly assigned URL. As a matter
- of fact, the Atom Publishing Protocol (AtomPub) uses POST exactly for
- that purpose. On the other hand, WebDAV-based protocols such as the
- Calendar Extensions to WebDAV (CalDAV) frequently require clients to
- pick a unique URL, although the server could easily perform that
- task.
-
- This specification defines a discovery mechanism through which
- servers can advertise support for POST requests with the
- aforementioned "add collection member" semantics.
-
-Editorial Note (To be removed by RFC Editor before publication)
-
- Please send comments to the Distributed Authoring and Versioning
- (WebDAV) working group at <mailto:w3c-dist-auth at w3.org>, which may be
- joined by sending a message with subject "subscribe" to
- <mailto:w3c-dist-auth-request at w3.org>. Discussions of the WEBDAV
- working group are archived at
- <http://lists.w3.org/Archives/Public/w3c-dist-auth/>.
-
- Note that although discussion takes place on the WebDAV working
- group's mailing list, this is not a working group document.
-
- XML versions, latest edits and the issues list for this document are
- available from
- <http://greenbytes.de/tech/webdav/#draft-reschke-webdav-post>.
-
-
-
-
-Reschke Expires May 26, 2010 [Page 1]
-
-Internet-Draft POST to add to WebDAV Collections November 2009
-
-
-Status of this Memo
-
- This Internet-Draft is submitted to IETF in full conformance with the
- provisions of BCP 78 and BCP 79.
-
- Internet-Drafts are working documents of the Internet Engineering
- Task Force (IETF), its areas, and its working groups. Note that
- other groups may also distribute working documents as Internet-
- Drafts.
-
- Internet-Drafts are draft documents valid for a maximum of six months
- and may be updated, replaced, or obsoleted by other documents at any
- time. It is inappropriate to use Internet-Drafts as reference
- material or to cite them other than as "work in progress."
-
- The list of current Internet-Drafts can be accessed at
- http://www.ietf.org/ietf/1id-abstracts.txt.
-
- The list of Internet-Draft Shadow Directories can be accessed at
- http://www.ietf.org/shadow.html.
-
- This Internet-Draft will expire on May 26, 2010.
-
-Copyright Notice
-
- Copyright (c) 2009 IETF Trust and the persons identified as the
- document authors. All rights reserved.
-
- This document is subject to BCP 78 and the IETF Trust's Legal
- Provisions Relating to IETF Documents
- (http://trustee.ietf.org/license-info) 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 BSD License.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Reschke Expires May 26, 2010 [Page 2]
-
-Internet-Draft POST to add to WebDAV Collections November 2009
-
-
-Table of Contents
-
- 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 4
- 2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 5
- 3. Protocol Extension . . . . . . . . . . . . . . . . . . . . . . 6
- 3.1. Definition of 'Add-Member' URI . . . . . . . . . . . . . . 6
- 3.2. Discovery . . . . . . . . . . . . . . . . . . . . . . . . 7
- 3.2.1. DAV:add-member Property (protected) . . . . . . . . . 7
- 3.2.2. Example . . . . . . . . . . . . . . . . . . . . . . . 7
- 3.3. Relation to AtomPub's 'Slug' Header Field . . . . . . . . 8
- 3.4. Example Operation . . . . . . . . . . . . . . . . . . . . 9
- 4. Additional Semantics for existing Methods . . . . . . . . . . 9
- 4.1. Additional Preconditions . . . . . . . . . . . . . . . . . 9
- 4.2. Example: Failed PUT Request . . . . . . . . . . . . . . . 10
- 5. Relationship to WebDAV Access Control Protocol . . . . . . . . 10
- 6. Internationalization Considerations . . . . . . . . . . . . . 10
- 7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 11
- 8. Security Considerations . . . . . . . . . . . . . . . . . . . 11
- 9. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . 11
- 10. References . . . . . . . . . . . . . . . . . . . . . . . . . . 11
- 10.1. Normative References . . . . . . . . . . . . . . . . . . . 11
- 10.2. Informative References . . . . . . . . . . . . . . . . . . 12
- Appendix A. Change Log (to be removed by RFC Editor before
- publication) . . . . . . . . . . . . . . . . . . . . 12
- A.1. since draft-reschke-webdav-post-00 . . . . . . . . . . . . 12
- A.2. since draft-reschke-webdav-post-01 . . . . . . . . . . . . 13
- A.3. since draft-reschke-webdav-post-02 . . . . . . . . . . . . 13
- A.4. since draft-reschke-webdav-post-03 . . . . . . . . . . . . 13
- A.5. since draft-reschke-webdav-post-04 . . . . . . . . . . . . 13
- Appendix B. Open issues (to be removed by RFC Editor prior to
- publication) . . . . . . . . . . . . . . . . . . . . 13
- B.1. edit . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
- B.2. collection . . . . . . . . . . . . . . . . . . . . . . . . 13
- Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
- Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 14
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Reschke Expires May 26, 2010 [Page 3]
-
-Internet-Draft POST to add to WebDAV Collections November 2009
-
-
-1. Introduction
-
- The Hypertext Transfer Protocol (HTTP) Extensions for the Web
- Distributed Authoring and Versioning (WebDAV) ([RFC4918], Section
- 9.5) do not define the behavior for the "POST" method when applied to
- collections, as the base specification (HTTP) leaves implementers
- lots of freedom for the semantics of "POST":
-
- 9.5 POST for Collections
-
- Since by definition the actual function performed by POST is
- determined by the server and often depends on the particular
- resource, the behavior of POST when applied to collections cannot
- be meaningfully modified because it is largely undefined. Thus,
- the semantics of POST are unmodified when applied to a collection.
-
- This has led to a situation where many WebDAV servers do not
- implement POST for collections at all, although it is well suited to
- be used for the purpose of adding new members to a collection, where
- the server remains in control of the newly assigned URL. As a matter
- of fact, the Atom Publishing Protocol (AtomPub) uses POST exactly for
- that purpose ([RFC5023], Section 9.2):
-
- 9.2 Creating Resources with POST
-
- To add members to a Collection, clients send POST requests to the
- URI of the Collection.
-
- On the other hand, WebDAV-based protocols such as Calendaring
- Extensions to WebDAV (CalDAV) frequently require clients to pick a
- unique URL, although the server could easily perform that task
- ([RFC4791], Section 5.3.2):
-
- 5.3.2 Creating Calendar Object Resources
-
- ...
-
- When servers create new resources, it's not hard for the server to
- choose an unmapped URI. 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 resource isn't created with a name collision.
- (...)
-
- As a matter of fact, letting the server choose the member URI not
- only is a simplification for certain types of clients, but can also
- reduce the complexity of the server (in that it doesn't need to
- persist an additional client-supplied identifier where it already has
-
-
-
-Reschke Expires May 26, 2010 [Page 4]
-
-Internet-Draft POST to add to WebDAV Collections November 2009
-
-
- an internal one like a UUID or a primary key).
-
- Note: the vCard Extensions to WebDAV (CardDAV)
- ([draft-ietf-vcarddav-carddav]) suffer from the same issue, and
- may be able to take advantage of this specification.
-
- This specification defines a discovery mechanism through which
- servers can advertise support for POST requests with the
- aforementioned "add collection member" semantics.
-
- Note that this specification deliberately only adresses the use case
- of creating new non-collection resources, and that it was not a goal
- to supply the same functionality for creating collection resources
- (MKCOL), or for other operations that require the client to specify a
- new URL (LOCK, MOVE, or COPY).
-
- Note: the author previously proposed a new HTTP method for exactly
- this purpose ([draft-reschke-http-addmember]), but quite a few
- reviewers pointed out that this would duplicate the original
- semantics of POST. Thus this proposal that avoids adding a new
- HTTP method is made.
-
-
-2. Terminology
-
- The terminology used here follows that in the WebDAV specification
- ([RFC4918]).
-
- 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 [RFC2119].
-
- This document uses XML DTD fragments ([XML]) as a purely notational
- convention. In particular:
-
- o Element ordering is irrelevant.
-
- o Extension elements/attributes (elements/attributes not already
- defined as valid child elements) may be added anywhere, except
- when explicitly stated otherwise.
-
- Note: this specification defines new properties and precondition
- names in the "DAV:" namespace, which the WebDAV specification
- reserves for use by the IETF ([RFC4918], Section 21.1). However,
- there was rough consensus in the WebDAV community that the
- specification is of general applicability to other WebDAV related
- standards efforts, and thus deserves inclusion into the base
- namespace.
-
-
-
-Reschke Expires May 26, 2010 [Page 5]
-
-Internet-Draft POST to add to WebDAV Collections November 2009
-
-
-3. Protocol Extension
-
- Due to the reasons stated in Section 1, clients can not rely on a
- specific server behavior when POST is applied to a collection. This
- problem is addressed by this specification by allowing servers to
- advertise a URI that has the desired "add member" semantics.
-
- Note that servers that already use POST for a different purpose can
- just expose a separate URI. Other servers can just advertise the
- collection's own URI, thus avoiding minting another URI for a limited
- purpose.
-
-3.1. Definition of 'Add-Member' URI
-
- The "Add-Member" URI of a WebDAV collection is a URI that will accept
- HTTP POST requests, and will interpret these as requests to store the
- enclosed entity as a new internal member of the collection (see
- Section 3 of [RFC4918] for the definition of "internal member"). It
- MUST identify a resource on the same server as the WebDAV collection
- (the host and port components ([RFC2616], Section 3.2.2) of the URIs
- must match).
-
- If there are pre-conditions related to creating a resource in the
- collection using a PUT request, then those same pre-conditions apply
- to the new POST request behavior, and the same HTTP response body
- will returned on failure.
-
- The URI of the newly created resource is returned in the HTTP
- Location response header field ([RFC2616], Section 14.30).
-
- Note: the fact that a server advertises an "Add-Member" URI does
- not imply any special semantics of the collection itself. For
- instance, member URIs assigned by the server are not necessarily
- unique over time (a member URI may be assigned again to a new
- resource when it previously was removed).
-
- Note: the "Add-Member" URI can be the identical to the
- collection's URI (in which case the server just advertises the
- fact that POST to the WebDAV collection's URI is supported as
- defined within this specification). But it can also be different
- from it, in which case it doesn't need to have any relation to the
- collection's URI.
-
- Given a collection URI of
-
- /docs/collection/
-
-
-
-
-
-Reschke Expires May 26, 2010 [Page 6]
-
-Internet-Draft POST to add to WebDAV Collections November 2009
-
-
- all of the URIs below might occur as "Add-Member" URIs:
-
- /docs/collection/
- /docs/collection/;post
- /docs/collection;post/
- /docs/collection/&post
- /post-service?path=/collection/
-
- The remainder of the document uses the same format just for
- reasons of consistency; any other HTTP URI on the same server
- would do as well.
-
-3.2. Discovery
-
-3.2.1. DAV:add-member Property (protected)
-
- DAV:add-member is a protected property (see [RFC4918], Section 15)
- defined on WebDAV collections, and contains the "Add-Member" URI for
- that collection (embedded inside a DAV:href element).
-
- <!ELEMENT add-member (href)>
- <!-- href: defined in [RFC4918], Section 14.7 -->
-
- A PROPFIND/allprop request SHOULD NOT return this property (see
- [RFC4918], Section 9.1). Servers MUST implement the DAV:supported-
- live-property-set property defined in Section 3.1.4 of [RFC3253], and
- report the property DAV:add-member as a supported live property.
-
-3.2.2. Example
-
- >>Request
-
- PROPFIND /collection/ HTTP/1.1
- Host: example.com
- Content-Type: application/xml; charset="utf-8"
- Content-Length: 118
-
- <?xml version="1.0" encoding="utf-8" ?>
- <propfind xmlns="DAV:">
- <prop>
- <add-member/>
- </prop>
- </propfind>
-
-
-
-
-
-
-
-
-Reschke Expires May 26, 2010 [Page 7]
-
-Internet-Draft POST to add to WebDAV Collections November 2009
-
-
- >>Response
-
- HTTP/1.1 207 Multi-Status
- Content-Type: application/xml; charset="utf-8"
- Content-Length: 340
-
- <?xml version="1.0" encoding="utf-8" ?>
- <multistatus xmlns="DAV:">
- <response>
- <href>/collection/</href>
- <propstat>
- <prop>
- <add-member>
- <href>/collection;add-member/</href>
- </add-member>
- </prop>
- <status>HTTP/1.1 200 OK</status>
- </propstat>
- </response>
- </multistatus>
-
- Note that in this case, the server has minted a separate URI for the
- purpose of adding new content.
-
-3.3. Relation to AtomPub's 'Slug' Header Field
-
- In the AtomPub protocol, clients can use the entity header field
- "Slug" to suggest parts of the URI to be created (see [RFC5023],
- Section 9.7). Note that servers are free to ignore this suggestion,
- or to use whatever algorithm that makes sense to generate the new
- URI.
-
- The same applies to the extension defined here: clients can use the
- "Slug" header field as by its definition of a generic HTTP header
- field. Servers should process it exactly in the way defined by
- AtomPub.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Reschke Expires May 26, 2010 [Page 8]
-
-Internet-Draft POST to add to WebDAV Collections November 2009
-
-
-3.4. Example Operation
-
- >>Request
-
- POST /collection;add-member/ HTTP/1.1
- Host: example.com
- Content-Type: text/plain
- Slug: Sample Title
- Content-Length: 12
-
- Sample text.
-
- >>Response
-
- HTTP/1.1 201 Created
- Location: http://example.com/collection/sample%20title
-
-
-4. Additional Semantics for existing Methods
-
- One important use case for this specification are collections that
- act as WebDAV collections for the purpose of read access (PROPFIND
- Depth 1/Infinity), but which only support internal member URIs
- assigned by the server. These collections will not allow a client to
- create a new member using methods like PUT, MKCOL, LOCK, COPY or
- MOVE. Therefore, this specification defines a new precondition name
- ([RFC4918], Section 16) that can be used to provide the client with
- additional information about why exactly the request failed.
-
- Note: although the precondition defined below can be used for
- methods other than PUT, the "Add-Member" mechanism defined by this
- specification deliberately is restricted to PUT.
-
-4.1. Additional Preconditions
-
- (DAV:allow-client-defined-URI): the server allows clients to specify
- the last path segment for newly created resources.
-
- The precondition element MAY contain a add-member-uri XML element
- specifying the "Add-Member" URI associated with the collection, on
- which the creation of a new child resource was attempted:
-
- <!ELEMENT allow-client-defined-uri (add-member?)>
-
-
-
-
-
-
-
-
-Reschke Expires May 26, 2010 [Page 9]
-
-Internet-Draft POST to add to WebDAV Collections November 2009
-
-
-4.2. Example: Failed PUT Request
-
- In this example, the client tries to use PUT to create a new internal
- member of /collection/.
-
- >>Request
-
- PUT /collection/new.txt HTTP/1.1
- Host: example.com
- Content-Type: text/plain
- Content-Length: 12
-
- Sample text.
-
- >>Response
-
- HTTP/1.1 405 Method Not Allowed
- Allow: GET, HEAD, TRACE, PROPFIND, COPY, MOVE
- Content-Type: application/xml; charset=UTF-8
- Content-Length: 172
-
- <error xmlns="DAV:">
- <allow-client-defined-uri>
- <add-member>
- <href>/collection;add-member/</href>
- </add-member>
- </allow-client-defined-uri>
- </error>
-
- The request fails with a 405 (Method Not Allowed) status, but also
- provides the reason, and a pointer to the "Add-Member" URI in the
- response body.
-
-
-5. Relationship to WebDAV Access Control Protocol
-
- The WebDAV ACL specification requires the DAV:bind privilege to be
- granted on a collection for the client to be able add new collection
- members ([RFC3744], Section 3.9). Consistent with that, a server
- MUST reject a POST request to the Add-Member URI of a collection
- unless the principal executing the request is granted DAV:bind
- privilege on the associated WebDAV collection resource.
-
-
-6. Internationalization Considerations
-
- This document does not introduce any new internationalization
- considerations beyond those discussed in Section 20 of [RFC4918].
-
-
-
-Reschke Expires May 26, 2010 [Page 10]
-
-Internet-Draft POST to add to WebDAV Collections November 2009
-
-
-7. IANA Considerations
-
- This specification does not require any actions from IANA.
-
-
-8. Security Considerations
-
- All security considerations connected to HTTP/WebDAV and XML apply
- for this specification as well, namely, [RFC4918] (Section 20) and
- [RFC3470] (Section 7).
-
- Furthermore, servers should be aware that deriving the member path
- from the data being stored in the resource could potentially expose
- confidential information. This could even be the case when only a
- hash code of the content is used.
-
- In addition, on servers that do not support this specification, a
- malevolent user could set the DAV:add-member URI as a custom
- property, tricking other users to post content to an entirely
- different URI. Clients can protect themselves against this scenario
- by
-
- o not following DAV:add-member URIs to different servers, and/or
-
- o verifying that the DAV:add-member property is indeed a live
- property (this can be achieved by testing the DAV:supported-live-
- property-set property, or by checking whether DAV:add-member is
- returned upon PROPFIND/allprop)
-
-
-9. Acknowledgements
-
- This document has benefited from thoughtful discussion by Cyrus Daboo
- and Bernard Desruissaux.
-
-
-10. References
-
-10.1. Normative References
-
- [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
- Requirement Levels", BCP 14, RFC 2119, March 1997.
-
- [RFC2616] Fielding, R., Gettys, J., Mogul, J., Frystyk, H.,
- Masinter, L., Leach, P., and T. Berners-Lee, "Hypertext
- Transfer Protocol -- HTTP/1.1", RFC 2616, June 1999.
-
- [RFC3253] Clemm, G., Amsden, J., Ellison, T., Kaler, C., and J.
-
-
-
-Reschke Expires May 26, 2010 [Page 11]
-
-Internet-Draft POST to add to WebDAV Collections November 2009
-
-
- Whitehead, "Versioning Extensions to WebDAV", RFC 3253,
- March 2002.
-
- [RFC3744] Clemm, G., Reschke, J., Sedlar, E., and J. Whitehead, "Web
- Distributed Authoring and Versioning (WebDAV) Access
- Control Protocol", RFC 3744, May 2004.
-
- [RFC4918] Dusseault, L., Ed., "HTTP Extensions for Web Distributed
- Authoring and Versioning (WebDAV)", RFC 4918, June 2007.
-
- [XML] Bray, T., Paoli, J., Sperberg-McQueen, C., Maler, E., and
- F. Yergeau, "Extensible Markup Language (XML) 1.0 (Fifth
- Edition)", W3C REC-xml-20081126, November 2008,
- <http://www.w3.org/TR/2008/REC-xml-20081126/>.
-
-10.2. Informative References
-
- [RFC3470] Hollenbeck, S., Rose, M., and L. Masinter, "Guidelines for
- the Use of Extensible Markup Language (XML) within IETF
- Protocols", RFC 3470, BCP 70, January 2003.
-
- [RFC4791] Daboo, C., Desruisseaux, B., and L. Dusseault,
- "Calendaring Extensions to WebDAV (CalDAV)", RFC 4791,
- March 2007.
-
- [RFC5023] Gregorio, J. and B. de hOra, "The Atom Publishing
- Protocol", RFC 5023, October 2007.
-
- [draft-ietf-vcarddav-carddav]
- Daboo, C., "vCard Extensions to WebDAV (CardDAV)",
- draft-ietf-vcarddav-carddav-10 (work in progress),
- November 2009.
-
- [draft-reschke-http-addmember]
- Reschke, J., "The HTTP ADDMEMBER Method",
- draft-reschke-http-addmember-00 (work in progress),
- February 2005.
-
-
-Appendix A. Change Log (to be removed by RFC Editor before publication)
-
-A.1. since draft-reschke-webdav-post-00
-
- Added Acknowledgements.
-
- Added and resolved issues "acl", "forbidden-put", "member-uri-
- content", "post-error-semantics", "property-trust", "rational-server-
- uri", ""remote-uri", "uri-format" and "uri-uniqueness".
-
-
-
-Reschke Expires May 26, 2010 [Page 12]
-
-Internet-Draft POST to add to WebDAV Collections November 2009
-
-
-A.2. since draft-reschke-webdav-post-01
-
- Add and resolve issue "containment".
-
- Update draft-ietf-vcarddav-carddav reference.
-
-A.3. since draft-reschke-webdav-post-02
-
- Update XML, draft-ietf-vcarddav-carddav and
- draft-nottingham-http-link-header references.
-
- Add and resolve issues "link-header" and "ns".
-
-A.4. since draft-reschke-webdav-post-03
-
- Add and resolve issues "put-only" and "protected".
-
-A.5. since draft-reschke-webdav-post-04
-
- Update vcarddav reference. In the example, do not use the same
- content for Slug header field and request body. Add issue
- "collection".
-
-
-Appendix B. Open issues (to be removed by RFC Editor prior to
- publication)
-
-B.1. edit
-
- Type: edit
-
- julian.reschke at greenbytes.de (2008-09-22): Umbrella issue for
- editorial fixes/enhancements.
-
-B.2. collection
-
- Type: change
-
- cyrus at daboo.name (2009-11-05): I have heard from some implementors
- that they would like collection creation to also be part of this
- draft. In particular, CalDAV and/or CardDAV clients creating
- calendars or address books would prefer to leave specification of the
- resource name to the client.
- Proposal:
- - Add a DAV:add-collection property containing a URI (which must be
- different than DAV:add-member)
- - A POST on that URI creates a collection within the parent
- collection, with a server chosen resource name
-
-
-
-Reschke Expires May 26, 2010 [Page 13]
-
-Internet-Draft POST to add to WebDAV Collections November 2009
-
-
- - If the POST contains an XML body with DAV:mkcol as the root
- element, then that body is interpreted the same way as MKCOL ext.
-
-
-Index
-
- A
- Add-Member URI 6
-
- C
- Condition Names
- DAV:allow-client-defined-URI (pre) 9
- COPY method
- Additional Preconditions 9
-
- D
- DAV:allow-client-defined-URI 9
-
- L
- LOCK method
- Additional Preconditions 9
-
- M
- MKCOL method
- Additional Preconditions 9
- MOVE method
- Additional Preconditions 9
-
- P
- PUT method
- Additional Preconditions 9
-
-
-Author's Address
-
- Julian F. Reschke
- greenbytes GmbH
- Hafenweg 16
- Muenster, NW 48155
- Germany
-
- Phone: +49 251 2807760
- Email: julian.reschke at greenbytes.de
- URI: http://greenbytes.de/tech/webdav/
-
-
-
-
-
-
-
-Reschke Expires May 26, 2010 [Page 14]
-
\ No newline at end of file
Deleted: CalendarServer/trunk/doc/RFC/rfc2447-iMIP.txt
===================================================================
--- CalendarServer/trunk/doc/RFC/rfc2447-iMIP.txt 2011-09-01 14:47:28 UTC (rev 8039)
+++ CalendarServer/trunk/doc/RFC/rfc2447-iMIP.txt 2011-09-01 15:06:35 UTC (rev 8040)
@@ -1,1011 +0,0 @@
-
-
-
-
-
-
-Network Working Group F. Dawson
-Request for Comments: 2447 Lotus
-Category: Standards Track S. Mansour
- Netscape
- S. Silverberg
- Microsoft
- November 1998
-
-
- iCalendar Message-Based Interoperability Protocol
- (iMIP)
-
-Status of this Memo
-
- This document specifies an Internet standards track protocol for the
- Internet community, and requests discussion and suggestions for
- improvements. Please refer to the current edition of the "Internet
- Official Protocol Standards" (STD 1) for the standardization state
- and status of this protocol. Distribution of this memo is unlimited.
-
-Copyright Notice
-
- Copyright (C) The Internet Society (1998). All Rights Reserved.
-
-Abstract
-
- This document, [iMIP], specifies a binding from the iCalendar
- Transport-independent Interoperability Protocol (iTIP) to Internet
- email-based transports. Calendaring entries defined by the iCalendar
- Object Model [iCAL] are composed using constructs from [RFC-822],
- [RFC-2045], [RFC-2046], [RFC-2047], [RFC-2048] and [RFC-2049].
-
- This document is based on discussions within the Internet Engineering
- Task Force (IETF) Calendaring and Scheduling (CALSCH) working group.
- More information about the IETF CALSCH working group activities can
- be found on the IMC web site at http://www.imc.org, the IETF web site
- at http://www.ietf.org/html.charters/calsch-charter.html. Refer to
- the references within this document for further information on how to
- access these various documents.
-
-
-
-
-
-
-
-
-
-
-
-
-Dawson, et. al. Standards Track [Page 1]
-
-RFC 2447 iMIP November 1998
-
-
-Table of Contents
-
- 1 INTRODUCTION........................................................2
- 1.1 RELATED MEMOS ...................................................2
- 1.2 FORMATTING CONVENTIONS ..........................................3
- 1.3 TERMINOLOGY .....................................................4
- 2 MIME MESSAGE FORMAT BINDING.........................................4
- 2.1 MIME MEDIA TYPE .................................................4
- 2.2 SECURITY ........................................................4
- 2.2.1 Authorization ...............................................4
- 2.2.2 Authentication ..............................................5
- 2.2.3 Confidentiality .............................................5
- 2.3 [RFC-822] ADDRESSES .............................................5
- 2.4 CONTENT TYPE ....................................................5
- 2.5 CONTENT-TRANSFER-ENCODING .......................................6
- 2.6 CONTENT-DISPOSITION .............................................6
- 3 SECURITY CONSIDERATIONS.............................................7
- 4 EXAMPLES............................................................8
- 4.1 SINGLE COMPONENT WITH AN ATTACH PROPERTY ........................8
- 4.2 USING MULTIPART ALTERNATIVE FOR LOW FIDELITY CLIENTS ............8
- 4.3 SINGLE COMPONENT WITH AN ATTACH PROPERTY AND INLINE ATTACHMENT ..9
- 4.4 MULTIPLE SIMILAR COMPONENTS ....................................10
- 4.5 MULTIPLE MIXED COMPONENTS ......................................11
- 4.6 DETAILED COMPONENTS WITH AN ATTACH PROPERTY ....................13
- 5 RECOMMENDED PRACTICES..............................................14
- 5.1 USE OF CONTENT AND MESSAGE IDS .................................14
- 6 BIBLIOGRAPHY.......................................................15
- 7 AUTHORS' ADDRESSES.................................................16
- 8 FULL COPYRIGHT STATEMENT...........................................18
-
-1 Introduction
-
- This binding document provides the transport specific information
- necessary convey iCalendar Transport-independent Interoperability
- Protocol (iTIP) over MIME as defined in [RFC-822] and [RFC-2045].
-
-1.1 Related Memos
-
- Implementers will need to be familiar with several other memos that,
- along with this memo, form a framework for Internet calendaring and
- scheduling standards.
-
- This document, [iMIP], specifies an Internet email binding for iTIP.
-
- [iCAL] - specifies a core specification of objects, data types,
- properties and property parameters;
-
-
-
-
-
-Dawson, et. al. Standards Track [Page 2]
-
-RFC 2447 iMIP November 1998
-
-
- [iTIP] - specifies an interoperability protocol for scheduling
- between different implementations;
-
- This memo does not attempt to repeat the specification of concepts or
- definitions from these other memos. Where possible, references are
- made to the memo that provides for the specification of these
- concepts or definitions.
-
-1.2 Formatting Conventions
-
- The mechanisms defined in this memo are defined in prose. In order to
- refer to elements of the calendaring and scheduling model, core
- object or interoperability protocol defined in [iCAL] and [iTIP] some
- formatting conventions have been used.
-
- 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 [RFC-2119].
-
- Calendaring and scheduling roles are referred to in quoted-strings of
- text with the first character of each word in upper case. For
- example, "Organizer" refers to a role of a "Calendar User" within the
- scheduling protocol defined by [iTIP].
-
- Calendar components defined by [iCAL] are referred to with
- capitalized, quoted-strings of text. All calendar components start
- with the letter "V". For example, "VEVENT" refers to the event
- calendar component, "VTODO" refers to the to-do calendar component
- and "VJOURNAL" refers to the daily journal calendar component.
-
- Scheduling methods defined by [iTIP] are referred to with
- capitalized, quoted-strings of text. For example, "REQUEST" refers to
- the method for requesting a scheduling calendar component be created
- or modified, "REPLY" refers to the method a recipient of a request
- uses to update their status with the "Organizer" of the calendar
- component.
-
- Properties defined by [iCAL] are referred to with capitalized,
- quoted-strings of text, followed by the word "property". For example,
- "ATTENDEE" property refers to the iCalendar property used to convey
- the calendar address of a calendar user.
-
- Property parameters defined by [iCAL] are referred to with lower
- case, quoted-strings of text, followed by the word "parameter". For
- example, "value" parameter refers to the iCalendar property parameter
- used to override the default data type for a property value.
-
-
-
-
-
-Dawson, et. al. Standards Track [Page 3]
-
-RFC 2447 iMIP November 1998
-
-
-1.3 Terminology
-
- The email terms used in this memo are defined in [RFC-822] and [RFC-
- 2045]. The calendaring and scheduling terms used in this memo are
- defined in [iCAL] and [iTIP].
-
-2 MIME Message Format Binding
-
- This section defines the message binding to the MIME electronic mail
- transport.
-
- The sections below refer to the "originator" and the "respondent" of
- an iMIP message. Typically, the originator is the "Organizer" of an
- event. The respondent is an "Attendee" of the event.
-
- The [RFC-822] "Reply-To" header typically contains the email address
- of the originator or respondent of an event. However, this cannot be
- guaranteed as Mail User Agents (MUA) are not required to enforce iMIP
- semantics.
-
-2.1 MIME Media Type
-
- A MIME entity containing content information formatted according to
- this document will be referenced as a "text/calendar" content type.
- It is assumed that this content type will be transported through a
- MIME electronic mail transport.
-
-2.2 Security
-
- This section addresses several aspects of security including
- Authentication, Authorization and Confidentiality. Authentication and
- confidentiality can be achieved using [RFC-1847] that specifies the
- Security Multiparts for MIME. This framework defines new content
- types and subtypes of multipart: signed and encrypted. Each contains
- two body parts: one for the protected data and another for the
- control information necessary to remove the protection.
-
-2.2.1 Authorization
-
- In [iTIP] messages, only the "Organizer" is authorized to modify or
- cancel calendar entries they organize. That is, spoof at xyz.com is not
- allowed to modify or cancel a meeting that was organized by
- a at example.com. Furthermore, only the respondent has the authorization
- to indicate their status to the "Organizer". That is, the "Organizer"
- must ignore an [iTIP] message from spoof at xyz.com that declines a
- meeting invitation for b at example.com.
-
-
-
-
-
-Dawson, et. al. Standards Track [Page 4]
-
-RFC 2447 iMIP November 1998
-
-
- Implementations of iMIP SHOULD verify the authenticity of the creator
- of an iCalendar object before taking any action. The methods for
- doing this are presented later in this document.
-
- [RFC-1847] Message flow in iTIP supports someone working on behalf of
- a "Calendar User" through use of the "sent-by" parameter that is
- associated with the "ATTENDEE" and "ORGANIZER" properties. However,
- there is no mechanism to verify whether or not a "Calendar User" has
- authorized someone to work on their behalf. It is left to
- implementations to provide mechanisms for the "Calendar Users" to
- make that decision.
-
-2.2.2 Authentication
-
- Authentication can be performed using an implementation of [RFC-1847]
- "multipart/signed" that supports public/private key certificates.
- Authentication is possible only on messages that have been signed.
- Authenticating an unsigned message may not be reliable.
-
-2.2.3 Confidentiality
-
- To ensure confidentiality using iMIP implementations should utilize
- [RFC-1847]-compliant encryption. The protocol does not restrict a
- "Calendar User Agent" (CUA) from forwarding iCalendar objects to
- other users or agents.
-
-2.3 [RFC-822] Addresses
-
- The calendar address specified within the "ATTENDEE" property in an
- iCalendar object MUST be a fully qualified, [RFC-822] address
- specification for the corresponding "Organizer" or "Attendee" of the
- "VEVENT" or "VTODO".
-
- Because [iTIP] does not preclude "Attendees" from forwarding
- "VEVENTS" or "VTODOS" to others, the [RFC-822] "Sender" value may not
- equal that of the "Organizer". Additionally, the "Organizer" or
- "Attendee" cannot be reliably inferred by the [RFC-822] "Sender" or
- "Reply-to" values of an iMIP message. The relevant address MUST be
- ascertained by opening the "text/calendar" MIME body part and
- examining the "ATTENDEE" and "ORGANIZER" properties.
-
-2.4 Content Type
-
- A MIME body part containing content information that conforms to this
- document MUST have an [RFC-2045] "Content-Type" value of
- "text/calendar". The [RFC-2045] "Content-Type" header field must also
- include the type parameter "method". The value MUST be the same as
- the value of the "METHOD" calendar property within the iCalendar
-
-
-
-Dawson, et. al. Standards Track [Page 5]
-
-RFC 2447 iMIP November 1998
-
-
- object. This means that a MIME message containing multiple iCalendar
- objects with different method values must be further encapsulated
- with a "multipart/mixed" MIME entity. This will allow each of the
- iCalendar objects to be encapsulated within their own "text/calendar"
- MIME entity.
-
- A "charset" parameter MUST be present if the iCalendar object
- contains characters that are not part of the US-ASCII character set.
- [RFC-2046] discusses the selection of an appropriate "charset" value.
-
- The optional "component" parameter defines the iCalendar component
- type contained within the iCalendar object.
-
- The following is an example of this header field with a value that
- indicates an event message.
-
- Content-Type:text/calendar; method=request; charset=UTF-8;
- component=vevent
-
- The "text/calendar" content type allows for the scheduling message
- type to be included in a MIME message with other content information
- (i.e., "multipart/mixed") or included in a MIME message with a
- clear-text, human-readable form of the scheduling message (i.e.,
- "multipart/alternative").
-
- In order to permit the information in the scheduling message to be
- understood by MIME user agents (UA) that do not support the
- "text/calendar" content type, scheduling messages SHOULD be sent with
- an alternative, human-readable form of the information.
-
-2.5 Content-Transfer-Encoding
-
- Note that the default character set for iCalendar objects is UTF-8. A
- transfer encoding SHOULD be used for iCalendar objects containing any
- characters that are not part of the US-ASCII character set.
-
-2.6 Content-Disposition
-
- The handling of a MIME part should be based on its [RFC-2045]
- "Content-Type". However, this is not guaranteed to work in all
- environments. Some environments handle MIME attachments based on
- their file type or extension. To operate correctly in these
- environments, implementations may wish to include a "Content-
- Disposition" property to define a file name.
-
-
-
-
-
-
-
-Dawson, et. al. Standards Track [Page 6]
-
-RFC 2447 iMIP November 1998
-
-
-3 Security Considerations
-
- The security threats that applications must address when implementing
- iTIP are detailed in [iTIP]. Two spoofing threats are identified:
- Spoofing the "Organizer", and Spoofing an "Attendee". To address
- these threats, the originator of an iCalendar object must be
- authenticated by a recipient. Once authenticated, a determination can
- be made as to whether or not the originator is authorized to perform
- the requested operation. Compliant applications MUST support signing
- and encrypting text/calendar attachments using a mechanism based on
- Security Multiparts for MIME [RFC-1847] to facilitate the
- authentication the originator of the iCalendar object.
- Implementations MAY provide a means for users to disable signing and
- encrypting. The steps are described below:
-
- 1. The iCalendar object MUST be signed by the "Organizer" sending an
- update or the "Attendee" sending a reply.
-
- 2. Using the [RFC-1847]-compliant security mechanism, determine who
- signed the iCalendar object. This is the "signer". Note that the
- signer is not necessarily the person sending an e-mail message since
- an e-mail message can be forwarded.
-
- 3. Correlate the signer to an "ATTENDEE" property in the iCalendar
- object. If the signer cannot be correlated to an "ATTENDEE" property,
- ignore the message.
-
- 4. Determine whether or not the "ATTENDEE" is authorized to perform
- the operation as defined by [iTIP]. If the conditions are not met,
- ignore the message.
-
- 5. If all the above conditions are met, the message can be processed.
-
- To address the confidentiality security threats, signed iMIP messages
- SHOULD be encrypted by a mechanism based on Security Multiparts for
- MIME [RFC-1847].
-
- It is possible to receive iMIP messages sent by someone working on
- behalf of another "Calendar User". This is determined by examining
- the "sent-by" parameter in the relevant "ORGANIZER" or "ATTENDEE"
- property. [iCAL] and [iTIP] provide no mechanism to verify that a
- "Calendar User" has authorized someone else to work on their behalf.
- To address this security issue, implementations MUST provide
- mechanisms for the "Calendar Users" to make that decision before
- applying changes from someone working on behalf of a "Calendar User".
-
-
-
-
-
-
-Dawson, et. al. Standards Track [Page 7]
-
-RFC 2447 iMIP November 1998
-
-
-4 Examples
-
-4.1 Single Component With An ATTACH Property
-
- This minimal message shows how an iCalendar object references an
- attachment. The attachment is accessible via its URL.
-
- From: sman at netscape.com
- To: stevesil at microsoft.com
- Subject: Phone Conference
- Mime-Version: 1.0
- Content-Type:text/calendar; method=REQUEST; charset=US-ASCII
- Content-Transfer-Encoding: 7bit
-
- BEGIN:VCALENDAR
- PRODID:-//ACME/DesktopCalendar//EN
- METHOD:REQUEST
- VERSION:2.0
- BEGIN:VEVENT
- ORGANIZER:mailto:sman at netscape.com
- ATTENDEE;ROLE=CHAIR;ATTSTAT=ACCEPTED:mailto:sman at netscape.com
- ATTENDEE;RSVP=YES:mailto:stevesil at microsoft.com
- DTSTAMP:19970611T190000Z
- DTSTART:19970701T210000Z
- DTEND:19970701T230000Z
- SUMMARY:Phone Conference
- DESCRIPTION:Please review the attached document.
- UID:calsvr.example.com-873970198738777
- ATTACH:ftp://ftp.bar.com/pub/docs/foo.doc
- STATUS:CONFIRMED
- END:VEVENT
- END:VCALENDAR
-
-4.2 Using Multipart Alternative for Low Fidelity Clients
-
- This example shows how a client can emit a multipart message that
- includes both a plain text version as well as the full iCalendar
- object. Clients that do not support text/calendar will still be
- capable of rendering the plain text representation.
-
- From: foo1 at example.com
- To: foo2 at example.com
- Subject: Phone Conference
- Mime-Version: 1.0
- Content-Type: multipart/alternative;boundary="01BD3665.3AF0D360"
-
- --01BD3665.3AF0D360
- Content-Type: text/plain;charset=us-ascii
-
-
-
-Dawson, et. al. Standards Track [Page 8]
-
-RFC 2447 iMIP November 1998
-
-
- Content-Transfer-Encoding: 7bit
-
- This is an alternative representation of a TEXT/CALENDAR MIME Object
- When: 7/1/1997 10:00AM PDT - 7/1/97 10:30AM PDT
- Where:
- Organizer: foo1 at example.com
- Summary: Phone Conference
-
- --01BD3665.3AF0D360
- Content-Type:text/calendar; method=REQUEST; charset=US-ASCII
- Content-Transfer-Encoding: 7bit
-
- BEGIN:VCALENDAR
- PRODID:-//ACME/DesktopCalendar//EN
- METHOD:REQUEST
- VERSION:2.0
- BEGIN:VEVENT
- ORGANIZER:mailto:foo1 at example.com
- ATTENDEE;ROLE=CHAIR;ATTSTAT=ACCEPTED:mailto:foo1 at example.com
- ATTENDEE;RSVP=YES;TYPE=INDIVIDUAL:mailto:foo2 at example.com
- DTSTAMP:19970611T190000Z
- DTSTART:19970701T170000Z
- DTEND:19970701T173000Z
- SUMMARY:Phone Conference
- UID:calsvr.example.com-8739701987387771
- SEQUENCE:0
- STATUS:CONFIRMED
- END:VEVENT
- END:VCALENDAR
-
- --01BD3665.3AF0D360
-
-4.3 Single Component With An ATTACH Property and Inline Attachment
-
- This example shows how a message containing an iCalendar object
- references an attached document. The reference is made using a
- Content-id (CID). Thus, the iCalendar object and the document are
- packaged in a multipart/related encapsulation.
-
- From: foo1 at example.com
- To: foo2 at example.com
- Subject: Phone Conference
- Mime-Version: 1.0
- Content-Type: multipart/related; boundary="boundary-example-1";
- type=text/calendar
-
- --boundary-example-1
-
-
-
-
-Dawson, et. al. Standards Track [Page 9]
-
-RFC 2447 iMIP November 1998
-
-
- Content-Type:text/calendar; method=REQUEST; charset=US-ASCII
- Content-Transfer-Encoding: 7bit
- Content-Disposition: attachment; filename="event.vcs"
-
- BEGIN:VCALENDAR
- PRODID:-//ACME/DesktopCalendar//EN
- METHOD:REQUEST
- VERSION:2.0
- BEGIN:VEVENT
- ORGANIZER:mailto:foo1 at example.com
- ATTENDEE;ROLE=CHAIR;ATTSTAT=ACCEPTED:mailto:foo1 at example.com
- ATTENDEE;RSVP=YES;TYPE=INDIVIDUAL:mailto:foo2 at example.com
- DTSTAMP:19970611T190000Z
- DTSTART:19970701T180000Z
- DTEND:19970701T183000Z
- SUMMARY:Phone Conference
- UID:calsvr.example.com-8739701987387771
- ATTACH:cid:123456789 at example.com
- SEQUENCE:0
- STATUS:CONFIRMED
- END:VEVENT
- END:VCALENDAR
-
- --boundary-example-1
- Content-Type: application/msword; name="FieldReport.doc"
- Content-Transfer-Encoding: base64
- Content-Disposition: inline; filename="FieldReport.doc"
- Content-ID: <123456789 at example.com>
-
- 0M8R4KGxGuEAAAAAAAAAAAAAAAAAAAAAPgADAP7/CQAGAAAAAAAAAAABAAAARAAAAAAA
- AAAAEAAAQAAAAAEAAAD+////AAAAAEUAAAD/////////////////////////////////
-
- --boundary-example-1--
-
-4.4 Multiple Similar Components
-
- Multiple iCalendar components of the same type can be included in the
- iCalendar object when the METHOD is the same for each component.
-
- From: foo1 at example.com
- To: foo2 at example.com
- Subject: Summer Company Holidays
- Mime-Version: 1.0
- Content-Type:text/calendar; method=PUBLISH; charset=US-ASCII
- Content-Transfer-Encoding: 7bit
- Content-Disposition: attachment; filename="event.vcs"
-
-
-
-
-
-Dawson, et. al. Standards Track [Page 10]
-
-RFC 2447 iMIP November 1998
-
-
- BEGIN:VCALENDAR
- PRODID:-//ACME/DESKTOPCALENDAR//EN
- METHOD:PUBLISH
- VERSION:2.0
- BEGIN:VEVENT
- ORGANIZER:MAILTO:FOO1 at EXAMPLE.COM
- DTSTAMP:19970611T150000Z
- DTSTART:19970701T150000Z
- DTEND:19970701T230000Z
- SUMMARY:Company Picnic
- DESCRIPTION:Food and drink will be provided
- UID:CALSVR.EXAMPLE.COM-873970198738777-1
- SEQUENCE:0
- STATUS:CONFIRMED
- END:VEVENT
- BEGIN:VEVENT
- ORGANIZER:MAILTO:FOO1 at EXAMPLE.COM
- DTSTAMP:19970611T190000Z
- DTSTART:19970715T150000Z
- DTEND:19970715T230000Z
- SUMMARY:Company Bowling Tournament
- DESCRIPTION:We have 10 lanes reserved
- UID:CALSVR.EXAMPLE.COM-873970198738777-2
- SEQUENCE:0
- STATUS:CONFIRMED
- END:VEVENT
- END:VCALENDAR
-
-4.5 Multiple Mixed Components
-
- Different component types must be encapsulated in separate iCalendar
- objects.
-
- From: foo1 at example.com
- To: foo2 at example.com
- Subject: Phone Conference
- Mime-Version: 1.0
- Content-Type:multipart/mixed;boundary="--FEE3790DC7E35189CA67CE2C"
-
- This is a multi-part message in MIME format.
-
- ----FEE3790DC7E35189CA67CE2C
- Content-Type:text/calendar; method=REQUEST; charset=US-ASCII
- Content-Transfer-Encoding: 7bit
- Content-Disposition: attachment; filename="event1.vcs"
-
-
-
-
-
-
-Dawson, et. al. Standards Track [Page 11]
-
-RFC 2447 iMIP November 1998
-
-
- BEGIN:VCALENDAR
- PRODID:-//ACME/DesktopCalendar//EN
- METHOD:REQUEST
- VERSION:2.0
- BEGIN:VEVENT
- ORGANIZER:mailto:foo1 at example.com
- ATTENDEE;ROLE=CHAIR;ATTSTAT=ACCEPTED:mailto:foo1 at example.com
- ATTENDEE;RSVP=YES;TYPE=INDIVIDUAL:mailto:foo2 at example.com
- DTSTAMP:19970611T190000Z
- DTSTART:19970701T210000Z
- DTEND:19970701T230000Z
- SUMMARY:Phone Conference
- DESCRIPTION:Discuss what happened at the last meeting
- UID:calsvr.example.com-8739701987387772
- SEQUENCE:0
- STATUS:CONFIRMED
- END:VEVENT
- END:VCALENDAR
-
- ----FEE3790DC7E35189CA67CE2C
- Content-Type:text/calendar; method=REQUEST; charset=US-ASCII
- Content-Transfer-Encoding:7bit
- Content-Disposition: attachment; filename="todo1.vcs"
-
- BEGIN:VCALENDAR
- PRODID:-//ACME/DesktopCalendar//EN
- METHOD:REQUEST
- VERSION:2.0
- BEGIN:VTODO
- DUE:19970701T090000-0700
- ORGANIZER:mailto:foo1 at example.com
- ATTENDEE;ROLE=CHAIR;ATTSTAT=ACCEPTED:mailto:foo1 at example.com
- ATTENDEE;RSVP=YES:mailto:foo2 at example.com
- SUMMARY:Phone Conference
- DESCRIPTION:Discuss a new location for the company picnic
- UID:calsvr.example.com-td-8739701987387773
- SEQUENCE:0
- STATUS:NEEDS ACTION
- END:VEVENT
- END:VCALENDAR
-
- ----FEE3790DC7E35189CA67CE2C
-
-
-
-
-
-
-
-
-
-Dawson, et. al. Standards Track [Page 12]
-
-RFC 2447 iMIP November 1998
-
-
-4.6 Detailed Components With An ATTACH Property
-
- This example shows the format of a message containing a group meeting
- between three individuals. The multipart/related encapsulation is
- used because the iCalendar object contains an ATTACH property that
- uses a CID to reference the attachment.
-
- From: foo1 at example.com
- MIME-Version: 1.0
- To: foo2 at example.com,foo3 at example.com
- Subject: REQUEST - Phone Conference
- Content-Type:multipart/related;boundary="--FEE3790DC7E35189CA67CE2C"
-
- ----FEE3790DC7E35189CA67CE2C
- Content-Type: multipart/alternative;
- boundary="--00FEE3790DC7E35189CA67CE2C00"
-
- ----00FEE3790DC7E35189CA67CE2C00
- Content-Type: text/plain; charset=us-ascii
- Content-Transfer-Encoding: 7bit
-
- When: 7/1/1997 10:00PM PDT- 7/1/97 10:30 PM PDT
- Where:
- Organizer: foo1 at example.com
- Summary: Let's discuss the attached document
-
- ----00FEE3790DC7E35189CA67CE2C00
-
- Content-Type:text/calendar; method=REQUEST; charset=US-ASCII;
- Component=vevent
- Content-Transfer-Encoding: 7bit
- Content-Disposition: attachment; filename="event.vcs"
-
- BEGIN:VCALENDAR
- PRODID:-//ACME/DesktopCalendar//EN
- PROFILE:REQUEST
- PROFILE-VERSION:1.0
- VERSION:2.0
- BEGIN:VEVENT
- ORGANIZER:foo1 at example.com
- ATTENDEE;ROLE=CHAIR;ATTSTAT=ACCEPTED:foo1 at example.com
- ATTENDEE;RSVP=YES;TYPE=INDIVIDUAL:mailto:foo2 at example.com
- ATTENDEE;RSVP=YES;TYPE=INDIVIDUAL:mailto:foo3 at example.com
- DTSTAMP:19970611T190000Z
- DTSTART:19970621T170000Z
- DTEND:199706211T173000Z
- SUMMARY:Let's discuss the attached document
- UID:calsvr.example.com-873970198738777-8aa
-
-
-
-Dawson, et. al. Standards Track [Page 13]
-
-RFC 2447 iMIP November 1998
-
-
- ATTACH:cid:calsvr.example.com-12345aaa
- SEQUENCE:0
- STATUS:CONFIRMED
- END:VEVENT
- END:VCALENDAR
-
- ----00FEE3790DC7E35189CA67CE2C00
-
- ----FEE3790DC7E35189CA67CE2C
- Content-Type: application/msword; name="FieldReport.doc"
- Content-Transfer-Encoding: base64
- Content-Disposition: inline; filename="FieldReport.doc"
- Content-ID: <calsvr.example.com-12345aaa>
-
-
- R0lGODdhTAQZAJEAAFVVVd3d3e4AAP///ywAAAAATAQZAAAC/5yPOSLhD6OctNqLs94XqAG
- 4kiW5omm6sq27gvH8kzX9o1y+s73/g8MCofEovGITCoxKMbyCR16cNSq9YrNarfcrvdriIH
- 5LL5jE6rxc3G+v2cguf0uv2Oz+v38L7/DxgoOKjURnjIIbe3yNjo+AgZWYVIWWl5iZnJY6J.
-
- ----FEE3790DC7E35189CA67CE2C
-
-5 Recommended Practices
-
- This section outlines a series of recommended practices when using a
- messaging transport to exchange iCalendar objects.
-
-5.1 Use of Content and Message IDs
-
- The [iCAL] specification makes frequent use of the URI for data types
- in properties such as "DESCRIPTION", "ATTACH", "CONTACT" and others.
- Two forms of URIs are Message ID (MID) and Content ID (CID). These
- are defined in [RFC-2111]. Although [RFC-2111] allows referencing
- messages or MIME body parts in other MIME entities or stores, it is
- strongly recommended that iMIP implementations include all referenced
- messages and body parts in a single MIME entity. Simply put, if an
- iCalendar object contains CID or MID references to other messages or
- body parts, implementations should ensure that these messages and/or
- body parts are transmitted with the iCalendar object. If they are not
- there is no guarantee that the receiving "CU" will have the access or
- the authorization to view those objects.
-
-
-
-
-
-
-
-
-
-
-
-Dawson, et. al. Standards Track [Page 14]
-
-RFC 2447 iMIP November 1998
-
-
-6 Bibliography
-
- [CHST] Character Sets, ftp://ftp.isi.edu/in-
- notes/iana/assignments/character-sets
-
- [iCAL] Dawson, F. and D. Stenerson, "Internet Calendaring and
- Scheduling Core Object Specification - iCalendar", RFC
- 2445, November 1998.
-
- [iTIP] Silverberg, S., Mansour, S., Dawson, F. and R. Hopson,
- "iCalendar Transport-Independent Interoperability Protocol
- (iTIP): Scheduling Events, Busy Time, To-dos and Journal
- Entries", RFC 2446, November 1998.
-
- [RFC-822] Crocker, D., "Standard for the Format of ARPA Internet
- Text Messages", STD 11, RFC 822, August 1982.
-
- [RFC-1847] Galvin, J., Murphy, S., Crocker, S. and N. Freed,
- "Security Multiparts for MIME: Multipart/Signed and
- Multipart/Encrypted", RFC 1847, October 1995.
-
- [RFC-2045] Freed, N. and N. Borenstein, "Multipurpose Internet Mail
- Extensions (MIME) - Part One: Format of Internet Message
- Bodies", RFC 2045, November 1996.
-
- [RFC-2046] Freed, N. and N. Borenstein, "Multipurpose Internet Mail
- Extensions (MIME) - Part Two: Media Types", RFC 2046,
- November 1996.
-
- [RFC-2047] Moore, K., "Multipurpose Internet Mail Extensions (MIME) -
- Part Three: Message Header Extensions for Non-ASCII Text",
- RFC 2047, November 1996.
-
- [RFC-2048] Freed, N., Klensin, J. and J. Postel, "Multipurpose
- Internet Mail Extensions (MIME) - Part Four: Registration
- Procedures", RFC 2048, January 1997.
-
- [RFC-2111] Levinson, E., "Content-ID and Message-ID Uniform Resource
- Locators", RFC 2111, March 1997.
-
- [RFC-2119] Bradner, S., "Key words for use in RFCs to Indicate
- Requirement Levels", BCP 14, RFC 2119, March 1997.
-
-
-
-
-
-
-
-
-
-Dawson, et. al. Standards Track [Page 15]
-
-RFC 2447 iMIP November 1998
-
-
-7 Authors' Addresses
-
- The following address information is provided in a vCard v3.0,
- Electronic Business Card, format.
-
- BEGIN:VCARD
- VERSION:3.0
- N:Dawson;Frank
- FN:Frank Dawson
- ORG:Lotus Development Corporation
- ADR;TYPE=WORK,POSTAL,PARCEL:;;6544 Battleford
- Drive;Raleigh;NC;27613-3502;USA
- TEL;TYPE=WORK,MSG:+1-919-676-9515
- TEL;TYPE=WORK,FAX:+1-919-676-9564
- EMAIL;TYPE=INTERNET:fdawson at earthlink.net
- URL:http://home.earthlink.net/~fdawson
- END:VCARD
-
- BEGIN:VCARD
- VERSION:3.0
- N:Mansour;Steve
- FN:Steve Mansour
- ORG:Netscape Communications Corporation
- ADR;TYPE=WORK,POSTAL,PARCEL:;;501 East Middlefield Road;Mountain
- View;CA;94043;USA
- TEL;TYPE=WORK,MSG:+1-650-937-2378
- TEL;TYPE=WORK,FAX:+1-650-937-2103
- EMAIL;TYPE=INTERNET:sman at netscape.com
- END:VCARD
-
- BEGIN:VCARD
- VERSION:3.0
- N:Silverberg;Steve
- FN:Steve Silverberg
- ORG:Microsoft Corporation
- ADR;TYPE=WORK,POSTAL,PARCEL:;;One Microsoft Way;
- Redmond;WA;98052-6399;USA
- TEL;TYPE=WORK,MSG:+1-425-936-9277
- TEL;TYPE=WORK,FAX:+1-425-936-8019
- EMAIL;TYPE=INTERNET:stevesil at Microsoft.com
- END:VCARD
-
-
-
-
-
-
-
-
-
-
-Dawson, et. al. Standards Track [Page 16]
-
-RFC 2447 iMIP November 1998
-
-
- The iCalendar Object is a result of the work of the Internet
- Engineering Task Force Calendaring and scheduling Working Group. The
- chairmen of that working group are:
-
- BEGIN:VCARD
- VERSION:3.0
- N:Ganguly;Anik
- FN:Anik Ganguly
- ORG:Open Text Inc.
- ADR;TYPE=WORK,POSTAL,PARCEL:;Suite 101;38777 West Six Mile Road;
- Livonia;MI;48152;USA
- TEL;TYPE=WORK,MSG:+1-734-542-5955
- EMAIL;TYPE=INTERNET:ganguly at acm.org
- END:VCARD
-
- BEGIN:VCARD
- VERSION:3.0
- N:Moskowitz;Robert
- FN:Robert Moskowitz
- EMAIL;TYPE=INTERNET:rgm-ietf at htt-consult.com
- END:VCARD
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Dawson, et. al. Standards Track [Page 17]
-
-RFC 2447 iMIP November 1998
-
-
-8. Full Copyright Statement
-
- Copyright (C) The Internet Society (1998). All Rights Reserved.
-
- This document and translations of it may be copied and furnished to
- others, and derivative works that comment on or otherwise explain it
- or assist in its implementation may be prepared, copied, published
- and distributed, in whole or in part, without restriction of any
- kind, provided that the above copyright notice and this paragraph are
- included on all such copies and derivative works. However, this
- document itself may not be modified in any way, such as by removing
- the copyright notice or references to the Internet Society or other
- Internet organizations, except as needed for the purpose of
- developing Internet standards in which case the procedures for
- copyrights defined in the Internet Standards process must be
- followed, or as required to translate it into languages other than
- English.
-
- The limited permissions granted above are perpetual and will not be
- revoked by the Internet Society or its successors or assigns.
-
- This document and the information contained herein is provided on an
- "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
- TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
- BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
- HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
- MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Dawson, et. al. Standards Track [Page 18]
-
Added: CalendarServer/trunk/doc/RFC/rfc5995-POST addmember.txt
===================================================================
--- CalendarServer/trunk/doc/RFC/rfc5995-POST addmember.txt (rev 0)
+++ CalendarServer/trunk/doc/RFC/rfc5995-POST addmember.txt 2011-09-01 15:06:35 UTC (rev 8040)
@@ -0,0 +1,675 @@
+
+
+
+
+
+
+Internet Engineering Task Force (IETF) J. Reschke
+Request for Comments: 5995 greenbytes
+Category: Standards Track September 2010
+ISSN: 2070-1721
+
+
+ Using POST to Add Members to Web Distributed Authoring and Versioning
+ (WebDAV) Collections
+
+Abstract
+
+ The Hypertext Transfer Protocol (HTTP) Extensions for the Web
+ Distributed Authoring and Versioning (WebDAV) do not define the
+ behavior for the "POST" method when applied to collections, as the
+ base specification (HTTP) leaves implementers lots of freedom for the
+ semantics of "POST".
+
+ This has led to a situation where many WebDAV servers do not
+ implement POST for collections at all, although it is well suited to
+ be used for the purpose of adding new members to a collection, where
+ the server remains in control of the newly assigned URL. In fact,
+ the Atom Publishing Protocol (AtomPub) uses POST exactly for that
+ purpose. On the other hand, WebDAV-based protocols, such as the
+ Calendaring Extensions to WebDAV (CalDAV), frequently require clients
+ to pick a unique URL, although the server could easily perform that
+ task.
+
+ This specification defines a discovery mechanism through which
+ servers can advertise support for POST requests with the
+ aforementioned "add collection member" semantics.
+
+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 Section 2 of RFC 5741.
+
+ Information about the current status of this document, any errata,
+ and how to provide feedback on it may be obtained at
+ http://www.rfc-editor.org/info/rfc5995.
+
+
+
+
+
+
+
+Reschke Standards Track [Page 1]
+
+RFC 5995 POST to Add to WebDAV Collections September 2010
+
+
+Copyright Notice
+
+ Copyright (c) 2010 IETF Trust and the persons identified as the
+ document authors. All rights reserved.
+
+ This document is subject to BCP 78 and the IETF Trust's Legal
+ Provisions Relating to IETF Documents
+ (http://trustee.ietf.org/license-info) 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.
+
+Table of Contents
+
+ 1. Introduction ....................................................2
+ 2. Terminology .....................................................4
+ 3. Protocol Extension ..............................................4
+ 3.1. Definition of "Add-Member" URI .............................5
+ 3.2. Discovery ..................................................6
+ 3.2.1. DAV:add-member Property (Protected) .................6
+ 3.2.2. Example .............................................6
+ 3.3. Relation to AtomPub's "Slug" Header Field ..................7
+ 3.4. Example Operation ..........................................7
+ 4. Additional Semantics for Existing Methods .......................8
+ 4.1. Additional Preconditions ...................................8
+ 4.2. Example: Failed PUT Request ................................8
+ 5. Relationship to WebDAV Access Control Protocol ..................9
+ 6. Internationalization Considerations .............................9
+ 7. Security Considerations .........................................9
+ 8. Acknowledgements ...............................................10
+ 9. References .....................................................10
+ 9.1. Normative References ......................................10
+ 9.2. Informative References ....................................11
+ Index .............................................................11
+
+1. Introduction
+
+ The Hypertext Transfer Protocol (HTTP) Extensions for the Web
+ Distributed Authoring and Versioning (WebDAV) ([RFC4918],
+ Section 9.5) do not define the behavior for the "POST" method when
+ applied to collections, as the base specification (HTTP) leaves
+ implementers lots of freedom for the semantics of "POST":
+
+
+
+
+
+
+Reschke Standards Track [Page 2]
+
+RFC 5995 POST to Add to WebDAV Collections September 2010
+
+
+ 9.5 POST for Collections
+
+ Since by definition the actual function performed by POST is
+ determined by the server and often depends on the particular
+ resource, the behavior of POST when applied to collections cannot
+ be meaningfully modified because it is largely undefined. Thus,
+ the semantics of POST are unmodified when applied to a collection.
+
+ This has led to a situation where many WebDAV servers do not
+ implement POST for collections at all, although it is well suited to
+ be used for the purpose of adding new members to a collection, where
+ the server remains in control of the newly assigned URL. In fact,
+ the Atom Publishing Protocol (AtomPub) uses POST exactly for that
+ purpose ([RFC5023], Section 9.2):
+
+ 9.2 Creating Resources with POST
+
+ To add members to a Collection, clients send POST requests to the
+ URI of the Collection.
+
+ On the other hand, WebDAV-based protocols, such as Calendaring
+ Extensions to WebDAV (CalDAV), frequently require clients to pick a
+ unique URL, although the server could easily perform that task
+ ([RFC4791], Section 5.3.2):
+
+ 5.3.2 Creating Calendar Object Resources
+
+ ...
+
+ When servers create new resources, it's not hard for the server to
+ choose an unmapped URI. 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 resource isn't created with a name collision.
+ (...)
+
+ Letting the server choose the member URI not only is a simplification
+ for certain types of clients, but can also reduce the complexity of
+ the server (in that it doesn't need to persist an additional client-
+ supplied identifier where it already has an internal one like a
+ Universally Unique Identifier (UUID) or a primary key).
+
+ Note: The vCard Extensions to WebDAV (CardDAV) ([CARDDAV]) suffer
+ from the same issue, and may be able to take advantage of this
+ specification.
+
+
+
+
+
+
+Reschke Standards Track [Page 3]
+
+RFC 5995 POST to Add to WebDAV Collections September 2010
+
+
+ This specification defines a discovery mechanism through which
+ servers can advertise support for POST requests with the
+ aforementioned "add collection member" semantics.
+
+ This specification deliberately only addresses the use case of
+ creating new non-collection resources. It was not a goal for this
+ specification to supply the same functionality for creating
+ collection resources (MKCOL) or for other operations that require the
+ client to specify a new URL (LOCK, MOVE, or COPY).
+
+ Note: The author previously proposed a new HTTP method for exactly
+ this purpose ([ADDMEMBER]), but quite a few reviewers pointed out
+ that this would duplicate the original semantics of POST. Thus,
+ this proposal, which avoids adding a new HTTP method, is made.
+
+2. Terminology
+
+ The terminology used here follows that in the WebDAV specification
+ ([RFC4918]).
+
+ 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 [RFC2119].
+
+ This document uses XML DTD fragments ([XML]) as a purely notational
+ convention. In particular:
+
+ o Element ordering is irrelevant.
+
+ o Extension elements/attributes (elements/attributes not already
+ defined as valid child elements) may be added anywhere, except
+ when explicitly stated otherwise.
+
+ Note: This specification defines new properties and precondition
+ names in the "DAV:" namespace, which the WebDAV specification
+ reserves for use by the IETF ([RFC4918], Section 21.1). However,
+ there was rough consensus in the WebDAV community that the
+ specification is of general applicability to other WebDAV-related
+ standards efforts, and thus deserves inclusion into the base
+ namespace.
+
+3. Protocol Extension
+
+ Due to the reasons stated in Section 1, clients cannot rely on a
+ specific server behavior when POST is applied to a collection. This
+ problem is addressed by this specification by allowing servers to
+ advertise a URI that has the desired "add member" semantics.
+
+
+
+
+Reschke Standards Track [Page 4]
+
+RFC 5995 POST to Add to WebDAV Collections September 2010
+
+
+ Servers that already use POST for a different purpose can just expose
+ a separate URI. Other servers can just advertise the collection's
+ own URI, thus avoiding minting another URI for a limited purpose.
+
+3.1. Definition of "Add-Member" URI
+
+ The "Add-Member" URI of a WebDAV collection is a URI that will accept
+ HTTP POST requests, and will interpret these as requests to store the
+ enclosed entity as a new internal member of the collection (see
+ Section 3 of [RFC4918] for the definition of "internal member"). It
+ MUST identify a resource on the same server as the WebDAV collection
+ (the host and port components ([RFC2616], Section 3.2.2) of the URIs
+ must match).
+
+ If there are preconditions related to creating a resource in the
+ collection using a PUT request, then those same preconditions apply
+ to the new POST request behavior, and the same HTTP response body
+ will be returned on failure.
+
+ The URI of the newly created resource is returned in the HTTP
+ Location response header field ([RFC2616], Section 14.30).
+
+ Note: The fact that a server advertises an "Add-Member" URI does
+ not imply any special semantics of the collection itself. For
+ instance, member URIs assigned by the server are not necessarily
+ unique over time (a member URI may be assigned again to a new
+ resource when it previously was removed).
+
+ Note: The "Add-Member" URI can be identical to the collection's
+ URI (in which case the server just advertises the fact that POST
+ to the WebDAV collection's URI is supported as defined within this
+ specification). But it can also be different from it, in which
+ case it doesn't need to have any relation to the collection's URI.
+
+ Given a collection URI of
+
+ /docs/collection/
+
+ any of the URIs below might occur as "Add-Member" URIs:
+
+ /docs/collection/
+ /docs/collection/;post
+ /docs/collection;post/
+ /docs/collection/&post
+ /post-service?path=/collection/
+
+
+
+
+
+
+Reschke Standards Track [Page 5]
+
+RFC 5995 POST to Add to WebDAV Collections September 2010
+
+
+ The remainder of the document uses the same format just for
+ reasons of consistency; any other HTTP URI on the same server
+ would do as well.
+
+3.2. Discovery
+
+3.2.1. DAV:add-member Property (Protected)
+
+ DAV:add-member is a protected property (see [RFC4918], Section 15)
+ defined on WebDAV collections, and contains the "Add-Member" URI for
+ that collection (embedded inside a DAV:href element).
+
+ <!ELEMENT add-member (href)>
+ <!-- href: defined in [RFC4918], Section 14.7 -->
+
+ A PROPFIND/allprop request SHOULD NOT return this property (see
+ [RFC4918], Section 9.1). Servers MUST implement the DAV:supported-
+ live-property-set property defined in Section 3.1.4 of [RFC3253], and
+ report the property DAV:add-member as a supported live property.
+
+3.2.2. Example
+
+ >>Request
+
+ PROPFIND /collection/ HTTP/1.1
+ Host: example.com
+ Content-Type: application/xml; charset="utf-8"
+ Content-Length: 118
+
+ <?xml version="1.0" encoding="utf-8" ?>
+ <propfind xmlns="DAV:">
+ <prop>
+ <add-member/>
+ </prop>
+ </propfind>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Reschke Standards Track [Page 6]
+
+RFC 5995 POST to Add to WebDAV Collections September 2010
+
+
+ >>Response
+
+ HTTP/1.1 207 Multi-Status
+ Content-Type: application/xml; charset="utf-8"
+ Content-Length: 340
+
+ <?xml version="1.0" encoding="utf-8" ?>
+ <multistatus xmlns="DAV:">
+ <response>
+ <href>/collection/</href>
+ <propstat>
+ <prop>
+ <add-member>
+ <href>/collection;add-member/</href>
+ </add-member>
+ </prop>
+ <status>HTTP/1.1 200 OK</status>
+ </propstat>
+ </response>
+ </multistatus>
+
+ In this case, the server has minted a separate URI for the purpose of
+ adding new content.
+
+3.3. Relation to AtomPub's "Slug" Header Field
+
+ In the AtomPub protocol, clients can use the entity header field
+ "Slug" to suggest parts of the URI to be created (see [RFC5023],
+ Section 9.7). Note that servers are free to ignore this suggestion,
+ or to use whatever algorithm makes sense to generate the new URI.
+
+ The same applies to the extension defined here: clients can use the
+ "Slug" header field, as by definition it is a generic HTTP header
+ field. Servers should process it exactly in the way defined by
+ AtomPub.
+
+3.4. Example Operation
+
+ >>Request
+
+ POST /collection;add-member/ HTTP/1.1
+ Host: example.com
+ Content-Type: text/plain
+ Slug: Sample Title
+ Content-Length: 12
+
+ Sample text.
+
+
+
+
+Reschke Standards Track [Page 7]
+
+RFC 5995 POST to Add to WebDAV Collections September 2010
+
+
+ >>Response
+
+ HTTP/1.1 201 Created
+ Location: http://example.com/collection/sample%20title
+
+4. Additional Semantics for Existing Methods
+
+ One important use case for this specification is collections that act
+ as WebDAV collections for the purpose of read access (PROPFIND
+ Depth 1/Infinity), but which only support internal member URIs
+ assigned by the server. These collections will not allow a client to
+ create a new member using methods like PUT, MKCOL, LOCK, COPY, or
+ MOVE. Therefore, this specification defines a new precondition name
+ ([RFC4918], Section 16) that can be used to provide the client with
+ additional information regarding exactly why the request failed.
+
+ Note: Although the precondition defined below can be used for
+ methods other than PUT, the "Add-Member" mechanism defined by this
+ specification deliberately is restricted to PUT.
+
+4.1. Additional Preconditions
+
+ (DAV:allow-client-defined-URI): the server allows clients to specify
+ the last path segment for newly created resources.
+
+ The precondition element MAY contain an add-member-uri XML element
+ specifying the "Add-Member" URI associated with the collection, on
+ which the creation of a new child resource was attempted:
+
+ <!ELEMENT allow-client-defined-uri (add-member?)>
+
+4.2. Example: Failed PUT Request
+
+ In this example, the client tries to use PUT to create a new internal
+ member of /collection/.
+
+ >>Request
+
+ PUT /collection/new.txt HTTP/1.1
+ Host: example.com
+ Content-Type: text/plain
+ Content-Length: 12
+
+ Sample text.
+
+
+
+
+
+
+
+Reschke Standards Track [Page 8]
+
+RFC 5995 POST to Add to WebDAV Collections September 2010
+
+
+ >>Response
+
+ HTTP/1.1 405 Method Not Allowed
+ Allow: GET, HEAD, TRACE, PROPFIND, COPY, MOVE
+ Content-Type: application/xml; charset=UTF-8
+ Content-Length: 172
+
+ <error xmlns="DAV:">
+ <allow-client-defined-uri>
+ <add-member>
+ <href>/collection;add-member/</href>
+ </add-member>
+ </allow-client-defined-uri>
+ </error>
+
+ The request fails with a 405 (Method Not Allowed) status, but also
+ provides the reason, and a pointer to the "Add-Member" URI in the
+ response body.
+
+5. Relationship to WebDAV Access Control Protocol
+
+ The WebDAV Access Control Protocol specification requires the DAV:
+ bind privilege to be granted on a collection for the client to be
+ able to add new collection members ([RFC3744], Section 3.9).
+ Consistent with that, a server MUST reject a POST request to the Add-
+ Member URI of a collection, unless the principal executing the
+ request is granted DAV:bind privilege on the associated WebDAV
+ collection resource.
+
+6. Internationalization Considerations
+
+ This document does not introduce any new internationalization
+ considerations beyond those discussed in Section 19 of [RFC4918].
+
+7. Security Considerations
+
+ Security considerations applicable to HTTP [RFC2616], WebDAV
+ [RFC4918], and XML [XML] apply for this specification as well,
+ namely, Section 20 of [RFC4918] and Section 7 of [RFC3470].
+
+ Furthermore, servers should be aware that deriving the member path
+ from the data being stored in the resource could potentially expose
+ confidential information. This could even be the case when only a
+ hash code of the content is used.
+
+
+
+
+
+
+
+Reschke Standards Track [Page 9]
+
+RFC 5995 POST to Add to WebDAV Collections September 2010
+
+
+ In addition, on servers that do not support this specification, a
+ malevolent user could set the DAV:add-member URI as a custom
+ property, tricking other users to post content to an entirely
+ different URI. Clients can protect themselves against this
+ scenario by
+
+ o not following DAV:add-member URIs to different servers, and/or
+
+ o verifying that the DAV:add-member property is indeed a live
+ property (this can be achieved by testing the DAV:supported-live-
+ property-set property, or by checking whether DAV:add-member is
+ returned upon PROPFIND/allprop).
+
+8. Acknowledgements
+
+ This document has benefited from thoughtful discussion by Cyrus Daboo
+ and Bernard Desruisseaux.
+
+9. References
+
+9.1. Normative References
+
+ [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
+ Requirement Levels", BCP 14, RFC 2119, March 1997.
+
+ [RFC2616] Fielding, R., Gettys, J., Mogul, J., Frystyk, H.,
+ Masinter, L., Leach, P., and T. Berners-Lee, "Hypertext
+ Transfer Protocol -- HTTP/1.1", RFC 2616, June 1999.
+
+ [RFC3253] Clemm, G., Amsden, J., Ellison, T., Kaler, C., and J.
+ Whitehead, "Versioning Extensions to WebDAV (Web
+ Distributed Authoring and Versioning)", RFC 3253,
+ March 2002.
+
+ [RFC3744] Clemm, G., Reschke, J., Sedlar, E., and J. Whitehead,
+ "Web Distributed Authoring and Versioning (WebDAV) Access
+ Control Protocol", RFC 3744, May 2004.
+
+ [RFC4918] Dusseault, L., Ed., "HTTP Extensions for Web Distributed
+ Authoring and Versioning (WebDAV)", RFC 4918, June 2007.
+
+ [XML] Bray, T., Paoli, J., Sperberg-McQueen, C., Maler, E., and
+ F. Yergeau, "Extensible Markup Language (XML) 1.0 (Fifth
+ Edition)", W3C REC-xml-20081126, November 2008,
+ <http://www.w3.org/TR/2008/REC-xml-20081126/>.
+
+
+
+
+
+
+Reschke Standards Track [Page 10]
+
+RFC 5995 POST to Add to WebDAV Collections September 2010
+
+
+9.2. Informative References
+
+ [ADDMEMBER] Reschke, J., "The HTTP ADDMEMBER Method", Work
+ in Progress, February 2005.
+
+ [CARDDAV] Daboo, C., "vCard Extensions to WebDAV (CardDAV)", Work
+ in Progress, November 2009.
+
+ [RFC3470] Hollenbeck, S., Rose, M., and L. Masinter, "Guidelines
+ for the Use of Extensible Markup Language (XML) within
+ IETF Protocols", BCP 70, RFC 3470, January 2003.
+
+ [RFC4791] Daboo, C., Desruisseaux, B., and L. Dusseault,
+ "Calendaring Extensions to WebDAV (CalDAV)", RFC 4791,
+ March 2007.
+
+ [RFC5023] Gregorio, J., Ed. and B. de hOra, Ed., "The Atom
+ Publishing Protocol", RFC 5023, October 2007.
+
+Index
+
+ A
+ Add-Member URI 5
+
+ C
+ Condition Names
+ DAV:allow-client-defined-URI (pre) 8
+ COPY method
+ Additional Preconditions 8
+
+ D
+ DAV:allow-client-defined-URI 8
+
+ L
+ LOCK method
+ Additional Preconditions 8
+
+ M
+ MKCOL method
+ Additional Preconditions 8
+ MOVE method
+ Additional Preconditions 8
+
+ P
+ PUT method
+ Additional Preconditions 8
+
+
+
+
+
+Reschke Standards Track [Page 11]
+
+RFC 5995 POST to Add to WebDAV Collections September 2010
+
+
+Author's Address
+
+ Julian F. Reschke
+ greenbytes GmbH
+ Hafenweg 16
+ Muenster, NW 48155
+ Germany
+
+ Phone: +49 251 2807760
+ EMail: julian.reschke at greenbytes.de
+ URI: http://greenbytes.de/tech/webdav/
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Reschke Standards Track [Page 12]
+
Added: CalendarServer/trunk/doc/RFC/rfc6047-iMIP.txt
===================================================================
--- CalendarServer/trunk/doc/RFC/rfc6047-iMIP.txt (rev 0)
+++ CalendarServer/trunk/doc/RFC/rfc6047-iMIP.txt 2011-09-01 15:06:35 UTC (rev 8040)
@@ -0,0 +1,1235 @@
+
+
+
+
+
+
+Internet Engineering Task Force (IETF) A. Melnikov, Ed.
+Request for Comments: 6047 Isode Ltd
+Obsoletes: 2447 December 2010
+Category: Standards Track
+ISSN: 2070-1721
+
+
+ iCalendar Message-Based Interoperability Protocol (iMIP)
+
+Abstract
+
+ This document, "iCalendar Message-Based Interoperability Protocol
+ (iMIP)", specifies a binding from the iCalendar Transport-independent
+ Interoperability Protocol (iTIP) to Internet email-based transports.
+ Calendaring entries defined by the iCalendar Object Model (iCalendar)
+ are wrapped using constructs from RFC 5322 and MIME (RFC 2045, RFC
+ 2046, RFC 2047, and RFC 2049), and then transported over SMTP.
+
+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 Section 2 of RFC 5741.
+
+ Information about the current status of this document, any errata,
+ and how to provide feedback on it may be obtained at
+ http://www.rfc-editor.org/info/rfc6047.
+
+Copyright Notice
+
+ Copyright (c) 2010 IETF Trust and the persons identified as the
+ document authors. All rights reserved.
+
+ This document is subject to BCP 78 and the IETF Trust's Legal
+ Provisions Relating to IETF Documents
+ (http://trustee.ietf.org/license-info) 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.
+
+
+
+
+
+Melnikov Standards Track [Page 1]
+
+RFC 6047 iMIP December 2010
+
+
+ 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
+ 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
+
+ 1. Introduction ....................................................3
+ 1.1. Related Memos ..............................................3
+ 1.2. Formatting Conventions .....................................3
+ 1.3. Terminology ................................................4
+ 2. MIME Message Format Binding .....................................4
+ 2.1. MIME Media Type ............................................4
+ 2.2. Security ...................................................5
+ 2.2.1. Authorization .......................................5
+ 2.2.2. Authentication ......................................5
+ 2.2.3. Confidentiality .....................................5
+ 2.3. Email Addresses ............................................6
+ 2.4. Content-Type Header Field ..................................6
+ 2.5. Content-Transfer-Encoding Header Field .....................7
+ 2.6. Content-Disposition Header Field ...........................8
+ 3. Security Considerations .........................................8
+ 4. Examples .......................................................11
+ 4.1. Single Component with an ATTACH Property ..................11
+ 4.2. Using multipart/alternative for Low-Fidelity Clients ......11
+ 4.3. Single Component with an ATTACH Property and
+ Inline Attachment .........................................12
+ 4.4. Multiple Similar Components ...............................14
+ 4.5. Multiple Mixed Components .................................15
+ 4.6. Detailed Components with an ATTACH Property ...............16
+ 5. Recommended Practices ..........................................18
+ 5.1. Use of Content and Message IDs ............................18
+ 6. IANA Considerations ............................................18
+ 7. References .....................................................19
+ 7.1. Normative References ......................................19
+ 7.2. Informative References ....................................20
+ Appendix A. Changes since RFC 2447 ................................21
+ Appendix B. Acknowledgements ......................................22
+
+
+
+
+
+
+Melnikov Standards Track [Page 2]
+
+RFC 6047 iMIP December 2010
+
+
+1. Introduction
+
+ This document provides the transport-specific information ("binding")
+ necessary to convey iCalendar Transport-independent Interoperability
+ Protocol (iTIP) [iTIP] over Internet email (using MIME) as defined in
+ [RFC5322] and [RFC2045]. Therefore, this document defines the
+ iCalendar Message-Based Interoperability Protocol (iMIP).
+
+1.1. Related Memos
+
+ Implementers will need to be familiar with several other memos that,
+ along with this memo, form a framework for Internet calendaring and
+ scheduling standards.
+
+ This document specifies an Internet email binding for iTIP.
+
+ [iCAL] specifies a core specification of objects, data types,
+ properties, and property parameters.
+
+ [iTIP] specifies an interoperability protocol for scheduling between
+ different implementations.
+
+ This memo does not attempt to repeat the specification of concepts or
+ definitions from these other memos. Where possible, references are
+ made to the memo that provides for the specification of these
+ concepts or definitions.
+
+1.2. Formatting Conventions
+
+ The mechanisms defined in this memo are defined in prose. In order
+ to refer to elements of the calendaring and scheduling model, core
+ object, or interoperability protocol defined in [iCAL] and [iTIP],
+ some formatting conventions have been used.
+
+ 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 RFC 2119 [RFC2119].
+
+ Calendaring and scheduling roles are referred to in quoted strings of
+ text with the first character of each word in uppercase. For
+ example, "Organizer" refers to a role of a "Calendar User" within the
+ scheduling protocol defined by [iTIP].
+
+ Calendar components defined by [iCAL] are referred to with
+ capitalized, quoted strings of text. All calendar components start
+ with the letter "V". For example, "VEVENT" refers to the event
+ calendar component, "VTODO" refers to the to-do calendar component,
+ and "VJOURNAL" refers to the daily journal calendar component.
+
+
+
+Melnikov Standards Track [Page 3]
+
+RFC 6047 iMIP December 2010
+
+
+ Scheduling methods defined by [iTIP] are referred to with
+ capitalized, quoted strings of text. For example, "REQUEST" refers
+ to the method for requesting a scheduling calendar component be
+ created or modified; "REPLY" refers to the method a recipient of a
+ request uses to update their status with the "Organizer" of the
+ calendar component.
+
+ Properties defined by [iCAL] are referred to with capitalized, quoted
+ strings of text, followed by the word "property". For example,
+ "ATTENDEE" property refers to the iCalendar property used to convey
+ the calendar address of a "Calendar User".
+
+ Property parameters defined by [iCAL] are referred to with lowercase,
+ quoted strings of text, followed by the word "parameter". For
+ example, "value" parameter refers to the iCalendar property parameter
+ used to override the default data type for a property value.
+
+1.3. Terminology
+
+ The email terms used in this memo are defined in [RFC5322] and
+ [RFC2045]. The calendaring and scheduling terms used in this memo
+ are defined in [iCAL] and [iTIP].
+
+2. MIME Message Format Binding
+
+ This section defines the message binding to the MIME electronic mail
+ transport.
+
+ The sections below refer to the "originator" and the "recipient" of
+ an iMIP message. In the case of a "request" method, the originator
+ is the "Organizer" and the recipient is an "Attendee" of the event.
+ In the case of a "response" method, the originator is an "Attendee"
+ and the recipient is the "Organizer" of the event.
+
+ The [RFC5322] "Reply-To" header field typically contains the email
+ address of the originator of the scheduling message. However, this
+ cannot be guaranteed because the sender of the iMIP message might not
+ be the originator of the scheduling message and the sender's "Mail
+ User Agent" (MUA) might not enforce iMIP semantics by translating the
+ originator's address into the "Reply-To" email header field.
+
+2.1. MIME Media Type
+
+ A MIME entity containing content information formatted according to
+ this document will be referenced as a "text/calendar" content type
+ [iCAL]. It is assumed that this content type will be transported
+ through a MIME electronic mail transport.
+
+
+
+
+Melnikov Standards Track [Page 4]
+
+RFC 6047 iMIP December 2010
+
+
+2.2. Security
+
+ This section addresses several aspects of security including
+ authentication, authorization, and confidentiality. Authentication
+ and confidentiality can be achieved using Secure/MIME (S/MIME)
+ [RFC5750] [RFC5751], which uses the Security Multiparts framework for
+ MIME [RFC1847].
+
+2.2.1. Authorization
+
+ In iTIP messages [iTIP], only the "Organizer" is authorized to modify
+ or cancel calendar entries she organizes. That is,
+ spoof at xyz.example.net is not allowed to modify or cancel a meeting
+ that was organized by a at example.com. Furthermore, only the
+ respondent has the authorization to indicate their status to the
+ "Organizer". That is, the "Organizer" MUST ignore an iTIP message
+ from spoof at xyz.example.net that declines a meeting invitation for
+ b at example.com.
+
+ Implementations of iMIP SHOULD verify the authenticity of the creator
+ of an iCalendar object before taking any action. Methods for doing
+ this are presented later in this document.
+
+ [RFC1847] message flow in iTIP supports someone working on behalf of
+ a "Calendar User" through use of the "sent-by" parameter that is
+ associated with the "ATTENDEE" and "ORGANIZER" properties. However,
+ there is no mechanism to verify whether or not a "Calendar User" has
+ authorized someone to work on their behalf. It is left to
+ implementations to provide mechanisms for the "Calendar Users" to
+ make that decision.
+
+2.2.2. Authentication
+
+ Authentication MUST be performed using S/MIME [RFC5750] [RFC5751].
+ Authentication is possible only on messages that have been signed.
+ Unauthenticated messages (i.e., unsigned messages) may not be
+ trusted.
+
+2.2.3. Confidentiality
+
+ To ensure confidentiality using iMIP, implementations SHOULD utilize
+ encryption specified in S/MIME [RFC5750] [RFC5751]. iMIP does not
+ restrict a "Calendar User Agent" (CUA) from forwarding iCalendar
+ objects to other users or agents.
+
+
+
+
+
+
+
+Melnikov Standards Track [Page 5]
+
+RFC 6047 iMIP December 2010
+
+
+2.3. Email Addresses
+
+ The calendar address specified within the "ORGANIZER" and "ATTENDEE"
+ properties in an iCalendar object sent using iMIP MUST be a proper
+ "mailto:" [MAILTO] URI specification for the corresponding
+ "Organizer" or "Attendee" of the "VEVENT" or "VTODO".
+
+ Because [iTIP] does not preclude "Attendees" from forwarding
+ "VEVENT"s or "VTODO"s to others, the [RFC5322] "Sender" value may not
+ equal that of the "Organizer". Additionally, the "Organizer" or
+ "Attendee" cannot be reliably inferred by the [RFC5322] "Sender" or
+ "Reply-To" header field values of an iMIP message. The relevant
+ address MUST be ascertained by opening the "text/calendar" MIME body
+ part and examining the "ATTENDEE" and "ORGANIZER" properties.
+
+2.4. Content-Type Header Field
+
+ A MIME body part containing content information that conforms to this
+ document MUST have an [RFC2045] "Content-Type" value of
+ "text/calendar". The [RFC2045] "Content-Type" header field MUST also
+ include the MIME parameter "method". The value MUST be the same
+ (ignoring case) as the value of the "METHOD" property within the
+ iCalendar object.
+
+ Note 1: A MIME message containing multiple iCalendar objects with
+ different "method" values MUST be further encapsulated with a
+ "multipart/mixed" MIME entity [RFC2046]. This will allow each of
+ the iCalendar objects to be encapsulated within their own
+ "text/calendar" MIME entity.
+
+ Note 2: A MIME body part with a "Content-Type" value of
+ "text/calendar" that lacks the "method" parameter is not
+ considered to be an iMIP body part and thus is not subject to the
+ requirements specified in this document.
+
+ Note that according to [iCAL] the default character set for iCalendar
+ objects is UTF-8 [UTF-8]. However, the default character set for a
+ "text/*" MIME entity according to [RFC2046] is US-ASCII. Thus, a
+ "charset" MIME parameter MUST be present if the iCalendar object
+ contains characters that can't be represented in the US-ASCII
+ character set and, as specified in [iCAL], it MUST have the value
+ "UTF-8".
+
+ The optional "component" MIME parameter defines the iCalendar
+ component type contained within the iCalendar object.
+
+
+
+
+
+
+Melnikov Standards Track [Page 6]
+
+RFC 6047 iMIP December 2010
+
+
+ The following is an example of this header field with a value that
+ indicates an event message.
+
+ Content-Type: text/calendar; method=REQUEST; charset=UTF-8;
+ component=vevent
+
+ The "text/calendar" content type allows for the scheduling message
+ type to be included in a MIME message with other content information
+ (i.e., "multipart/mixed") or included in a MIME message with a clear-
+ text, human-readable form of the scheduling message (i.e.,
+ "multipart/alternative" [RFC2046]).
+
+ In order to permit the information in the scheduling message to be
+ understood by MIME User Agents (UAs) that do not support the
+ "text/calendar" content type, scheduling messages SHOULD be sent with
+ an alternative, human-readable form of the information.
+
+ Note that "multipart/alternative" MUST NOT be used to represent two
+ slightly different iCalendar objects, for example, two "VEVENT"s with
+ alternative starting times.
+
+ CUAs can use other MIME parameters of the "Content-Type" header
+ field, as well as a language specified in the Content-Language header
+ field [RFC3282], to pick a "text/calendar" part for processing if a
+ "multipart/alternative" MIME message contains more than one
+ "text/calendar" part.
+
+ Any receiving UA compliant with this specification MUST be able to
+ process "text/calendar" body parts enclosed within "multipart/*".
+ Note that a "multipart/mixed" MIME message can include multiple
+ "text/calendar" components. The receiving UA MUST be able to process
+ all of them.
+
+2.5. Content-Transfer-Encoding Header Field
+
+ Unless an iMIP message is transported over 8-bit clean transport
+ (such as SMTP [8BITMIME]), a transfer encoding such as quoted-
+ printable or base64 [RFC2045] MUST be used for iCalendar objects
+ containing any characters that can't be represented in the US-ASCII
+ character set. For example:
+
+
+
+
+
+
+
+
+
+
+
+Melnikov Standards Track [Page 7]
+
+RFC 6047 iMIP December 2010
+
+
+ From: user1 at example.com
+ To: user2 at example.com
+ Subject: Phone Conference
+ Mime-Version: 1.0
+ Date: Wed, 07 May 2008 21:30:25 +0400
+ Message-ID: <4821E731.5040506 at laptop1.example.com>
+ Content-Type: text/calendar; method=REQUEST; charset=UTF-8
+ Content-Transfer-Encoding: quoted-printable
+
+ BEGIN:VCALENDAR
+ PRODID:-//Example/ExampleCalendarClient//EN
+ METHOD:REQUEST
+ VERSION:2.0
+ BEGIN:VEVENT
+ ORGANIZER:mailto:user1 at example.com
+ ATTENDEE;ROLE=CHAIR;PARTSTAT=ACCEPTED:mailto:user1 at example.com
+ ATTENDEE;RSVP=YES;CUTYPE=INDIVIDUAL:mailto:user2 at example.com
+ DTSTAMP:20080507T170000Z
+ DTSTART:20080701T160000Z
+ DTEND:20080701T163000Z
+ SUMMARY:Phone call to discuss your last visit
+ DESCRIPTION:=D1=82=D1=8B =D0=BA=D0=B0=D0=BA - =D0=B4=D0=BE=D0=
+ =B2=D0=BE=D0=BB=D0=B5=D0=BD =D0=BF=D0=BE=D0=B5=D0=B7=D0=B4=D0=BA=D0
+ =BE=D0=B9?
+ UID:calsvr.example.com-8739701987387998
+ SEQUENCE:0
+ STATUS:TENTATIVE
+ END:VEVENT
+ END:VCALENDAR
+
+2.6. Content-Disposition Header Field
+
+ Implementations MAY include a "Content-Disposition" header field to
+ define a file name for an iCalendar object. However, the handling of
+ a MIME part MUST be based on its [RFC2045] "Content-Type" and not on
+ the extension specified in the "Content-Disposition", as different
+ email malware is known to trick User Agents into misinterpreting
+ content of messages by specifying a file extension in the Content-
+ Disposition header field that doesn't correspond to the value of the
+ "Content-Type" header field.
+
+3. Security Considerations
+
+ The security threats that applications must address when implementing
+ iTIP are detailed in [iTIP]. In particular, two spoofing threats are
+ identified in Section 6.1 of [iTIP]: spoofing the "Organizer", and
+ spoofing an "Attendee". To address these threats, the originator of
+ an iCalendar object must be authenticated by a recipient. Once
+
+
+
+Melnikov Standards Track [Page 8]
+
+RFC 6047 iMIP December 2010
+
+
+ authenticated, a determination can be made as to whether or not the
+ originator is authorized to perform the requested operation.
+ Compliant applications MUST support signing and encrypting
+ "text/calendar" body parts using a mechanism based on S/MIME
+ [RFC5750] [RFC5751] in order to facilitate the authentication of the
+ originator of the iCalendar object (see Sections 2.2.2 and 2.2.3).
+ The steps for processing a signed iMIP message are described below:
+
+ 1. Using S/MIME, determine who signed the "text/calendar" body part
+ containing the iCalendar object. This is the "signer". (Note
+ that the email address of the signer MUST be specified in the
+ rfc822Name field of the "subject alternative name" extension of
+ the signer certificate, as specified in [RFC5280],
+ Section 4.1.2.6.) Note that the signer is not necessarily the
+ person sending an e-mail message, since an e-mail message can be
+ forwarded.
+
+ 2. Correlate the signer to either an "ATTENDEE" property or to the
+ "ORGANIZER" property in the iCalendar object, based on the method
+ and the calendar component specified in the iCalendar object, as
+ defined in Section 1.4 of [iTIP]. If the signer cannot be
+ correlated to an "ATTENDEE"/"ORGANIZER" property, then actively
+ warn the user controlling the "Calendar User Agent" that the
+ iCalendar object is untrusted, and encourage the user to ignore
+ the message, but give advanced users the option to (a) view the
+ certificate of the signer and the entire certificate chain (if
+ any) in order to help decide if the signer should be trusted to
+ send the message, and then (b) allow the CUA to accept and process
+ the iCalendar object.
+
+ 3. Determine whether or not the "ATTENDEE"/"ORGANIZER" is authorized
+ to perform the operation as defined by [iTIP]. If the conditions
+ are not met, ignore the message.
+
+ 4. If all the above conditions are met, the message can be processed.
+
+ S/MIME signing also protects against malicious changes to messages in
+ transit.
+
+ If calendar confidentiality is required by the sender, signed iMIP
+ messages SHOULD be encrypted by a mechanism based on S/MIME [RFC5750]
+ [RFC5751]. If iMIP is used within a single ADministrative Management
+ Domain (ADMD) [RFC5598], SMTP STARTTLS [SMTP-TLS] (together with
+ STARTTLS in IMAP/POP [IMAP-POP-TLS]) MAY alternatively be used to
+ provide calendar confidentiality.
+
+
+
+
+
+
+Melnikov Standards Track [Page 9]
+
+RFC 6047 iMIP December 2010
+
+
+ Once a signed and/or encrypted iMIP message is received and
+ successfully verified (as detailed above) by a CUA, the CUA SHOULD
+ remember whether the sender of the message is using signing and/or
+ encrypting. If an unsigned iMIP message is received from the same
+ sender later on, the receiving CUA SHOULD warn the receiving user
+ about a possible man-in-the-middle attack and SHOULD ignore the
+ message, unless explicitly overridden by the user.
+
+ Implementations MAY provide means for users to disable signing and
+ encrypting.
+
+ It is possible to receive iMIP messages sent by someone working on
+ behalf of another "Calendar User". This is determined by examining
+ the "sent-by" parameter in the relevant "ORGANIZER" or "ATTENDEE"
+ property. [iCAL] and [iTIP] provide no mechanism to verify that a
+ "Calendar User" has authorized someone else to work on their behalf.
+ To address this security issue, implementations MUST provide
+ mechanisms for the "Calendar Users" to make that decision before
+ applying changes from someone working on behalf of a "Calendar User".
+ One way to achieve this is to reject iMIP messages sent by users
+ other than the "ORGANIZER" or the "ATTENDEE"s. Alternatively, the
+ receiver could have a list of trusted <sent-by, organizer> proxies in
+ its local security policy. And yet another way is to prompt the user
+ for confirmation.
+
+ iMIP-based calendaring is frequently deployed within a single ADMD,
+ with boundary filtering employed to restrict email calendaring flows
+ to be inside the ADMD. This can help in minimizing malicious changes
+ to calendaring messages in transit, as well as in making
+ authorization decisions less risky.
+
+ A security consideration associated with the use of the Content-
+ Disposition header field is described in Section 2.6.
+
+ Use of S/MIME makes the security considerations discussed in
+ [RFC5750] [RFC5751] relevant to this document. For additional
+ security considerations regarding certificate and Certificate
+ Revocation List (CRL) verification, please see [RFC5280].
+
+
+
+
+
+
+
+
+
+
+
+
+
+Melnikov Standards Track [Page 10]
+
+RFC 6047 iMIP December 2010
+
+
+4. Examples
+
+4.1. Single Component with an ATTACH Property
+
+ This minimal message shows how an iCalendar object references an
+ attachment. The attachment is accessible via its URL.
+
+ From: sman at netscape.example.com
+ To: stevesil at microsoft.example.com
+ Subject: Phone Conference
+ Mime-Version: 1.0
+ Content-Type: text/calendar; method=REQUEST; charset=US-ASCII
+ Content-Transfer-Encoding: 7bit
+
+ BEGIN:VCALENDAR
+ PRODID:-//Example/ExampleCalendarClient//EN
+ METHOD:REQUEST
+ VERSION:2.0
+ BEGIN:VEVENT
+ ORGANIZER:mailto:man at netscape.example.com
+ ATTENDEE;ROLE=CHAIR;PARTSTAT=ACCEPTED:mailto:man at netscape.example.com
+ ATTENDEE;RSVP=YES:mailto:stevesil at microsoft.example.com
+ DTSTAMP:19970611T190000Z
+ DTSTART:19970701T210000Z
+ DTEND:19970701T230000Z
+ SUMMARY:Phone Conference
+ DESCRIPTION:Please review the attached document.
+ UID:calsvr.example.com-873970198738777
+ ATTACH:ftp://ftp.bar.example.com/pub/docs/foo.doc
+ STATUS:CONFIRMED
+ END:VEVENT
+ END:VCALENDAR
+
+4.2. Using multipart/alternative for Low-Fidelity Clients
+
+ This example shows how a client can emit a multipart message that
+ includes both a plain text version and the full iCalendar object.
+ Clients that do not support "text/calendar" will still be capable of
+ rendering the plain text representation.
+
+
+
+
+
+
+
+
+
+
+
+
+Melnikov Standards Track [Page 11]
+
+RFC 6047 iMIP December 2010
+
+
+ From: foo1 at example.com
+ To: foo2 at example.com
+ Subject: Phone Conference
+ Mime-Version: 1.0
+ Content-Type: multipart/alternative; boundary="01BD3665.3AF0D360"
+
+ --01BD3665.3AF0D360
+ Content-Type: text/plain; charset=us-ascii
+ Content-Transfer-Encoding: 7bit
+
+ This is an alternative representation of a "text/calendar"
+ MIME object.
+
+ When: 7/1/1997 10:00AM PDT - 7/1/97 10:30AM PDT
+ Where:
+ Organizer: foo1 at example.com
+ Summary: Phone Conference
+
+ --01BD3665.3AF0D360
+ Content-Type: text/calendar; method=REQUEST; charset=US-ASCII
+ Content-Transfer-Encoding: 7bit
+
+ BEGIN:VCALENDAR
+ PRODID:-//Example/ExampleCalendarClient//EN
+ METHOD:REQUEST
+ VERSION:2.0
+ BEGIN:VEVENT
+ ORGANIZER:mailto:foo1 at example.com
+ ATTENDEE;ROLE=CHAIR;PARTSTAT=ACCEPTED:mailto:foo1 at example.com
+ ATTENDEE;RSVP=YES;CUTYPE=INDIVIDUAL:mailto:foo2 at example.com
+ DTSTAMP:19970611T190000Z
+ DTSTART:19970701T170000Z
+ DTEND:19970701T173000Z
+ SUMMARY:Phone Conference
+ UID:calsvr.example.com-8739701987387771
+ SEQUENCE:0
+ STATUS:CONFIRMED
+ END:VEVENT
+ END:VCALENDAR
+
+ --01BD3665.3AF0D360
+
+4.3. Single Component with an ATTACH Property and Inline Attachment
+
+ This example shows how a message containing an iCalendar object
+ references an attached document. The reference is made using a
+ Content-ID (CID). Thus, the iCalendar object and the document are
+ packaged in a "multipart/related" encapsulation.
+
+
+
+Melnikov Standards Track [Page 12]
+
+RFC 6047 iMIP December 2010
+
+
+ From: foo1 at example.com
+ To: foo2 at example.com
+ Subject: Phone Conference
+ Mime-Version: 1.0
+ Content-Type: multipart/related; boundary="boundary-example-1"
+
+ --boundary-example-1
+
+ Content-Type: text/calendar; method=REQUEST; charset=US-ASCII
+ Content-Transfer-Encoding: 7bit
+ Content-Disposition: attachment; filename="event.ics"
+
+ BEGIN:VCALENDAR
+ PRODID:-//Example/ExampleCalendarClient//EN
+ METHOD:REQUEST
+ VERSION:2.0
+ BEGIN:VEVENT
+ ORGANIZER:mailto:foo1 at example.com
+ ATTENDEE;ROLE=CHAIR;PARTSTAT=ACCEPTED:mailto:foo1 at example.com
+ ATTENDEE;RSVP=YES;CUTYPE=INDIVIDUAL:mailto:foo2 at example.com
+ DTSTAMP:19970611T190000Z
+ DTSTART:19970701T180000Z
+ DTEND:19970701T183000Z
+ SUMMARY:Phone Conference
+ UID:calsvr.example.com-8739701987387771
+ ATTACH:cid:123456789 at example.com
+ SEQUENCE:0
+ STATUS:CONFIRMED
+ END:VEVENT
+ END:VCALENDAR
+
+ --boundary-example-1
+ Content-Type: application/msword; name="FieldReport.doc"
+ Content-Transfer-Encoding: base64
+ Content-Disposition: inline; filename="FieldReport.doc"
+ Content-ID: <123456789 at example.com>
+
+ 0M8R4KGxGuEAAAAAAAAAAAAAAAAAAAAAPgADAP7/CQAGAAAAAAAAAAABAAAARAAAAAAA
+ AAAAEAAAQAAAAAEAAAD+////AAAAAEUAAAD/////////////////////////////////
+ ...
+
+ --boundary-example-1--
+
+
+
+
+
+
+
+
+
+Melnikov Standards Track [Page 13]
+
+RFC 6047 iMIP December 2010
+
+
+4.4. Multiple Similar Components
+
+ Multiple iCalendar components of the same type can be included in the
+ iCalendar object when the "METHOD" is the same for each component.
+
+ From: foo1 at example.com
+ To: foo2 at example.com
+ Subject: Summer Company Holidays
+ Mime-Version: 1.0
+ Content-Type: text/calendar; method=PUBLISH; charset=US-ASCII
+ Content-Transfer-Encoding: 7bit
+ Content-Disposition: attachment; filename="event.ics"
+
+ BEGIN:VCALENDAR
+ PRODID:-//Example/ExampleCalendarClient//EN
+ METHOD:PUBLISH
+ VERSION:2.0
+ BEGIN:VEVENT
+ ORGANIZER:mailto:foo1 at example.com
+ DTSTAMP:19970611T150000Z
+ DTSTART:19970701T150000Z
+ DTEND:19970701T230000Z
+ SUMMARY:Company Picnic
+ DESCRIPTION:Food and drink will be provided
+ UID:calsvr.example.com-873970198738777-1
+ SEQUENCE:0
+ STATUS:CONFIRMED
+ END:VEVENT
+ BEGIN:VEVENT
+ ORGANIZER:mailto:foo1 at example.com
+ DTSTAMP:19970611T190000Z
+ DTSTART:19970715T150000Z
+ DTEND:19970715T230000Z
+ SUMMARY:Company Bowling Tournament
+ DESCRIPTION:We have 10 lanes reserved
+ UID:calsvr.example.com-873970198738777-2
+ SEQUENCE:0
+ STATUS:CONFIRMED
+ END:VEVENT
+ END:VCALENDAR
+
+
+
+
+
+
+
+
+
+
+
+Melnikov Standards Track [Page 14]
+
+RFC 6047 iMIP December 2010
+
+
+4.5. Multiple Mixed Components
+
+ Different component types must be encapsulated in separate iCalendar
+ objects.
+
+ From: foo1 at example.com
+ To: foo2 at example.com
+ Subject: Phone Conference
+ Mime-Version: 1.0
+ Content-Type: multipart/mixed;
+ boundary="--FEE3790DC7E35189CA67CE2C"
+
+ This is a multi-part message in MIME format.
+
+ ----FEE3790DC7E35189CA67CE2C
+ Content-Type: text/calendar; method=REQUEST; charset=US-ASCII
+ Content-Transfer-Encoding: 7bit
+ Content-Disposition: attachment; filename="event1.ics"
+
+ BEGIN:VCALENDAR
+ PRODID:-//Example/ExampleCalendarClient//EN
+ METHOD:REQUEST
+ VERSION:2.0
+ BEGIN:VEVENT
+ ORGANIZER:mailto:foo1 at example.com
+ ATTENDEE;ROLE=CHAIR;PARTSTAT=ACCEPTED:mailto:foo1 at example.com
+ ATTENDEE;RSVP=YES;CUTYPE=INDIVIDUAL:mailto:foo2 at example.com
+ DTSTAMP:19970611T190000Z
+ DTSTART:19970701T210000Z
+ DTEND:19970701T230000Z
+ SUMMARY:Phone Conference
+ DESCRIPTION:Discuss what happened at the last meeting
+ UID:calsvr.example.com-8739701987387772
+ SEQUENCE:0
+ STATUS:CONFIRMED
+ END:VEVENT
+ END:VCALENDAR
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Melnikov Standards Track [Page 15]
+
+RFC 6047 iMIP December 2010
+
+
+ ----FEE3790DC7E35189CA67CE2C
+ Content-Type: text/calendar; method=REQUEST; charset=US-ASCII
+ Content-Transfer-Encoding: 7bit
+ Content-Disposition: attachment; filename="todo1.ics"
+
+ BEGIN:VCALENDAR
+ PRODID:-//Example/ExampleCalendarClient//EN
+ METHOD:REQUEST
+ VERSION:2.0
+ BEGIN:VTODO
+ DUE:19970701T160000Z
+ ORGANIZER:mailto:foo1 at example.com
+ ATTENDEE;ROLE=CHAIR;PARTSTAT=ACCEPTED:mailto:foo1 at example.com
+ ATTENDEE;RSVP=YES:mailto:foo2 at example.com
+ SUMMARY:Phone Conference
+ DESCRIPTION:Discuss a new location for the company picnic
+ UID:calsvr.example.com-td-8739701987387773
+ SEQUENCE:0
+ STATUS:NEEDS-ACTION
+ END:VEVENT
+ END:VCALENDAR
+
+ ----FEE3790DC7E35189CA67CE2C
+
+4.6. Detailed Components with an ATTACH Property
+
+ This example shows the format of a message containing a group meeting
+ between three individuals. The "multipart/related" encapsulation is
+ used because the iCalendar object contains an ATTACH property that
+ uses a CID to reference the attachment.
+
+ From: foo1 at example.com
+ MIME-Version: 1.0
+ To: foo2 at example.com,foo3 at example.com
+ Subject: REQUEST - Phone Conference
+ Content-Type: multipart/related;
+ boundary="--FEE3790DC7E35189CA67CE2C"
+
+ ----FEE3790DC7E35189CA67CE2C
+ Content-Type: multipart/alternative;
+ boundary="--00FEE3790DC7E35189CA67CE2C00"
+
+
+
+
+
+
+
+
+
+
+Melnikov Standards Track [Page 16]
+
+RFC 6047 iMIP December 2010
+
+
+ ----00FEE3790DC7E35189CA67CE2C00
+ Content-Type: text/plain; charset=us-ascii
+ Content-Transfer-Encoding: 7bit
+
+ When: 7/1/1997 10:00PM PDT - 7/1/97 10:30 PM PDT
+ Where:
+ Organizer: foo1 at example.com
+ Summary: Let's discuss the attached document
+
+ ----00FEE3790DC7E35189CA67CE2C00
+
+ Content-Type: text/calendar; method=REQUEST; charset=US-ASCII;
+ Component=vevent
+ Content-Transfer-Encoding: 7bit
+ Content-Disposition: attachment; filename="event.ics"
+
+ BEGIN:VCALENDAR
+ PRODID:-//Example/ExampleCalendarClient//EN
+ METHOD:REQUEST
+ VERSION:2.0
+ BEGIN:VEVENT
+ ORGANIZER:foo1 at example.com
+ ATTENDEE;ROLE=CHAIR;PARTSTAT=ACCEPTED:foo1 at example.com
+ ATTENDEE;RSVP=YES;CUTYPE=INDIVIDUAL:mailto:foo2 at example.com
+ ATTENDEE;RSVP=YES;CUTYPE=INDIVIDUAL:mailto:foo3 at example.com
+ DTSTAMP:19970611T190000Z
+ DTSTART:19970621T170000Z
+ DTEND:199706211T173000Z
+ SUMMARY:Let's discuss the attached document
+ UID:calsvr.example.com-873970198738777-8aa
+ ATTACH:cid:calsvr.example.com-12345aaa
+ SEQUENCE:0
+ STATUS:CONFIRMED
+ END:VEVENT
+ END:VCALENDAR
+
+ ----00FEE3790DC7E35189CA67CE2C00
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Melnikov Standards Track [Page 17]
+
+RFC 6047 iMIP December 2010
+
+
+ ----FEE3790DC7E35189CA67CE2C
+ Content-Type: application/msword; name="FieldReport.doc"
+ Content-Transfer-Encoding: base64
+ Content-Disposition: inline; filename="FieldReport.doc"
+ Content-ID: <calsvr.example.com-12345aaa>
+
+ R0lGODdhTAQZAJEAAFVVVd3d3e4AAP///ywAAAAATAQZAAAC/5yPOSLhD6OctNqLs94Xq
+ AG4kiW5omm6sq27gvH8kzX9o1y+s73/g8MCofEovGITCoxKMbyCR16cNSq9YrNarfcrvd
+ riIH5LL5jE6rxc3G+v2cguf0uv2Oz+v38L7/DxgoOKjURnjIIbe3yNjo+AgZWYVIWWl5i
+ ZnJY6J
+ ...
+
+ ----FEE3790DC7E35189CA67CE2C
+
+5. Recommended Practices
+
+ This section outlines a series of recommended practices when using a
+ messaging transport to exchange iCalendar objects.
+
+5.1. Use of Content and Message IDs
+
+ The [iCAL] specification makes frequent use of the URI for data types
+ in properties such as "DESCRIPTION", "ATTACH", "CONTACT", and others.
+ Two forms of URIs are the Message ID (MID) and the Content-ID (CID).
+ These are defined in [RFC2392]. Although [RFC2392] allows
+ referencing messages or MIME body parts in other MIME entities or
+ stores, it is strongly RECOMMENDED that iMIP implementations include
+ all referenced messages and body parts in a single MIME entity.
+ Simply put, if an iCalendar object contains CID or MID references to
+ other messages or body parts, implementations should ensure that
+ these messages and/or body parts are transmitted with the iCalendar
+ object. If they are not, there is no guarantee that the receiving
+ CUA will have the access or the authorization to view those objects.
+
+6. IANA Considerations
+
+ The "text/calendar" MIME media type was registered in [iCAL].
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Melnikov Standards Track [Page 18]
+
+RFC 6047 iMIP December 2010
+
+
+7. References
+
+7.1. Normative References
+
+ [iCAL] Desruisseaux, B., Ed., "Internet Calendaring and
+ Scheduling Core Object Specification (iCalendar)",
+ RFC 5545, September 2009.
+
+ [iTIP] Daboo, C., Ed., "iCalendar Transport-Independent
+ Interoperability Protocol (iTIP)", RFC 5546, December
+ 2009.
+
+ [RFC5322] Resnick, P., Ed., "Internet Message Format", RFC 5322,
+ October 2008.
+
+ [MAILTO] Duerst, M., Masinter, L., and J. Zawinski, "The 'mailto'
+ URI Scheme", RFC 6068, October 2010.
+
+ [RFC1847] Galvin, J., Murphy, S., Crocker, S., and N. Freed,
+ "Security Multiparts for MIME: Multipart/Signed and
+ Multipart/Encrypted", RFC 1847, October 1995.
+
+ [RFC2045] Freed, N. and N. Borenstein, "Multipurpose Internet Mail
+ Extensions (MIME) Part One: Format of Internet Message
+ Bodies", RFC 2045, November 1996.
+
+ [RFC2046] Freed, N. and N. Borenstein, "Multipurpose Internet Mail
+ Extensions (MIME) Part Two: Media Types", RFC 2046,
+ November 1996.
+
+ [RFC2392] Levinson, E., "Content-ID and Message-ID Uniform Resource
+ Locators", RFC 2392, August 1998.
+
+ [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
+ Requirement Levels", BCP 14, RFC 2119, March 1997.
+
+ [UTF-8] Yergeau, F., "UTF-8, a transformation format of ISO
+ 10646", STD 63, RFC 3629, November 2003.
+
+ [SMTP-TLS] Hoffman, P., "SMTP Service Extension for Secure SMTP over
+ Transport Layer Security", RFC 3207, February 2002.
+
+ [IMAP-POP-TLS]
+ Newman, C., "Using TLS with IMAP, POP3 and ACAP",
+ RFC 2595, June 1999.
+
+
+
+
+
+
+Melnikov Standards Track [Page 19]
+
+RFC 6047 iMIP December 2010
+
+
+ [RFC5750] Ramsdell, B. and S. Turner, "Secure/Multipurpose Internet
+ Mail Extensions (S/MIME) Version 3.2 Certificate
+ Handling", RFC 5750, January 2010.
+
+ [RFC5751] Ramsdell, B. and S. Turner, "Secure/Multipurpose Internet
+ Mail Extensions (S/MIME) Version 3.2 Message
+ Specification", RFC 5751, January 2010.
+
+ [RFC5280] 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", RFC 5280, May 2008.
+
+7.2. Informative References
+
+ [8BITMIME] Klensin, J., Freed, N., Rose, M., Stefferud, E., and D.
+ Crocker, "SMTP Service Extension for 8bit-MIMEtransport",
+ RFC 1652, July 1994.
+
+ [RFC5598] Crocker, D., "Internet Mail Architecture", RFC 5598, July
+ 2009.
+
+ [RFC3282] Alvestrand, H., "Content Language Headers", RFC 3282, May
+ 2002.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Melnikov Standards Track [Page 20]
+
+RFC 6047 iMIP December 2010
+
+
+Appendix A. Changes since RFC 2447
+
+ Updated references. Split them into Normative and Informative.
+
+ Updated examples to use example.com/example.net domains.
+
+ Corrected usage of RFC 2119 language.
+
+ Clarified that charset=UTF-8 is required, unless the calendar can be
+ entirely represented in US-ASCII.
+
+ Clarified that 7-bit content transfer encodings should be used unless
+ the calendar object is known to be transferred over 8-bit clean
+ transport.
+
+ Clarified that file extension specified in the Content-Disposition
+ header field is not to be used to override the "Content-Type" MIME
+ type.
+
+ Disallowed use of "multipart/alternative" for slightly different
+ representations of the same calendar.
+
+ Clarified handling of the "method" MIME parameter of the "Content-
+ Type" header field.
+
+ Clarified that in an iMIP message an ORGANIZER/ATTENDEE property
+ contains a mailto: URI.
+
+ Fixed examples with ATTENDEE property to use "CUTYPE=" instead of
+ "TYPE=".
+
+ Clarified that message integrity/confidentiality should be achieved
+ using S/MIME.
+
+ Provided additional examples.
+
+ Improved the Security Considerations section.
+
+ Made multiple editorial changes to different sections of the
+ document.
+
+
+
+
+
+
+
+
+
+
+
+Melnikov Standards Track [Page 21]
+
+RFC 6047 iMIP December 2010
+
+
+Appendix B. Acknowledgements
+
+ The editor of this document wishes to thank Frank Dawson, Steve
+ Mansour, and Steve Silverberg, the original authors of RFC 2447, as
+ well as the following individuals who have participated in the
+ drafting, review, and discussion of this memo:
+
+ Reinhold Kainhofer, Cyrus Daboo, Bernard Desruisseaux, Eliot Lear,
+ and Peter Saint-Andre.
+
+Author's Address
+
+ Alexey Melnikov (editor)
+ Isode Ltd
+ 5 Castle Business Village
+ 36 Station Road
+ Hampton, Middlesex TW12 2BX
+ UK
+
+ EMail: Alexey.Melnikov at isode.com
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Melnikov Standards Track [Page 22]
+
Added: CalendarServer/trunk/doc/RFC/rfc6321-xCal.txt
===================================================================
--- CalendarServer/trunk/doc/RFC/rfc6321-xCal.txt (rev 0)
+++ CalendarServer/trunk/doc/RFC/rfc6321-xCal.txt 2011-09-01 15:06:35 UTC (rev 8040)
@@ -0,0 +1,3027 @@
+
+
+
+
+
+
+Internet Engineering Task Force (IETF) C. Daboo
+Request for Comments: 6321 Apple, Inc.
+Category: Standards Track M. Douglass
+ISSN: 2070-1721 RPI
+ S. Lees
+ Microsoft
+ August 2011
+
+
+ xCal: The XML Format for iCalendar
+
+Abstract
+
+ This specification defines "xCal", an XML format for iCalendar data.
+
+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 Section 2 of RFC 5741.
+
+ Information about the current status of this document, any errata,
+ and how to provide feedback on it may be obtained at
+ http://www.rfc-editor.org/info/rfc6321.
+
+Copyright Notice
+
+ Copyright (c) 2011 IETF Trust and the persons identified as the
+ document authors. All rights reserved.
+
+ This document is subject to BCP 78 and the IETF Trust's Legal
+ Provisions Relating to IETF Documents
+ (http://trustee.ietf.org/license-info) 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.
+
+
+
+
+
+
+
+
+Daboo, et al. Standards Track [Page 1]
+
+RFC 6321 xCal August 2011
+
+
+Table of Contents
+
+ 1. Introduction ....................................................3
+ 2. Conventions Used in This Document ...............................4
+ 3. Converting from iCalendar to xCal ...............................4
+ 3.1. Pre-Processing .............................................4
+ 3.2. iCalendar Stream (RFC 5545, Section 3.4) ...................5
+ 3.3. Components (RFC 5545, Section 3.6) .........................6
+ 3.4. Properties (RFC 5545, Sections 3.7 and 3.8) ................6
+ 3.4.1. Special Cases for Properties ........................8
+ 3.4.1.1. Multi-Valued Properties ....................8
+ 3.4.1.2. GEO Property ...............................9
+ 3.4.1.3. REQUEST-STATUS Property ....................9
+ 3.5. Parameters (RFC 5545, Section 3.2) ........................10
+ 3.5.1. VALUE Parameter ....................................11
+ 3.6. Values (RFC 5545, Section 3.3) ............................11
+ 3.6.1. Binary (RFC 5545, Section 3.3.1) ...................12
+ 3.6.2. Boolean (RFC 5545, Section 3.3.2) .................12
+ 3.6.3. Calendar User Address (RFC 5545, Section 3.3.3) ....12
+ 3.6.4. Date (RFC 5545, Section 3.3.4) .....................12
+ 3.6.5. Date-Time (RFC 5545, Section 3.3.5) ................13
+ 3.6.6. Duration (RFC 5545, Section 3.3.6) .................13
+ 3.6.7. Float (RFC 5545, Section 3.3.7) ....................13
+ 3.6.8. Integer (RFC 5545, Section 3.3.8) ..................14
+ 3.6.9. Period of Time (RFC 5545, Section 3.3.9) ...........14
+ 3.6.10. Recurrence Rule (RFC 5545, Section 3.3.10) ........14
+ 3.6.11. Text (RFC 5545, Section 3.3.11) ...................15
+ 3.6.12. Time (RFC 5545, Section 3.3.12) ...................15
+ 3.6.13. URI (RFC 5545, Section 3.3.13) ....................15
+ 3.6.14. UTC Offset (RFC 5545, Section 3.3.14) .............16
+ 3.7. Extensions ................................................16
+ 4. Converting from xCal into iCalendar ............................16
+ 4.1. Converting XML Extensions into iCalendar ..................16
+ 4.2. The XML Property for iCalendar ............................17
+ 5. Handling Unrecognized Properties or Parameters .................18
+ 6. Security Considerations ........................................19
+ 7. IANA Considerations ............................................20
+ 7.1. Namespace Registration ....................................20
+ 7.2. Media Type ................................................20
+ 7.3. iCalendar Property Registrations ..........................21
+ 8. Acknowledgments ................................................22
+ 9. References .....................................................22
+ 9.1. Normative References ......................................22
+ 9.2. Informative References ....................................22
+
+
+
+
+
+
+
+Daboo, et al. Standards Track [Page 2]
+
+RFC 6321 xCal August 2011
+
+
+ Appendix A. RELAX NG Schema .......................................23
+ Appendix B. Examples ..............................................49
+ B.1. Example 1 ..................................................49
+ B.1.1. iCalendar Data .........................................49
+ B.1.2. XML Data ...............................................49
+ B.2. Example 2 ..................................................50
+ B.2.1. iCalendar Data .........................................50
+ B.2.2. XML Data ...............................................51
+
+1. Introduction
+
+ The iCalendar data format [RFC5545] is a widely deployed interchange
+ format for calendaring and scheduling data. While many applications
+ and services consume and generate calendar data, iCalendar is a
+ specialized format that requires its own parser/generator. In
+ contrast, XML-based formats are widely used for interoperability
+ between applications, and the many tools that generate, parse, and
+ manipulate XML make it easier to work with than iCalendar.
+
+ The purpose of this specification is to define "xCal", an XML format
+ for iCalendar data. xCal is defined as a straightforward mapping into
+ XML from iCalendar, so that iCalendar data can be converted to XML,
+ and then back to iCalendar, without losing any semantic meaning in
+ the data. Anyone creating xCal calendar data according to this
+ specification will know that their data can be converted to a valid
+ iCalendar representation as well.
+
+ Key design considerations are:
+
+ Round-tripping (converting an iCalendar instance to xCal and back)
+ will give the same semantic result as the starting point. That
+ is, all components, properties, and property parameters are
+ guaranteed to be preserved, with the exception of those that have
+ default values.
+
+ xCal preserves the semantics of the iCalendar data. While a
+ simple consumer can easily browse the calendar data in xCal, a
+ full understanding of iCalendar is still required in order to
+ modify and/or fully comprehend the calendar data.
+
+ xCal has the ability to handle many extensions to the underlying
+ iCalendar specification without requiring an update to this
+ document.
+
+
+
+
+
+
+
+
+Daboo, et al. Standards Track [Page 3]
+
+RFC 6321 xCal August 2011
+
+
+2. Conventions Used in This Document
+
+ 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 [RFC2119].
+
+ When XML element types in the namespace
+ "urn:ietf:params:xml:ns:icalendar-2.0" are referenced in this
+ document outside of the context of an XML fragment, the string "IC:"
+ will be prefixed to the element types.
+
+ Some examples in this document contain "partial" XML documents used
+ for illustrative purposes. In these examples, three periods "..."
+ are used to indicate a portion of the document that has been removed
+ for compactness.
+
+3. Converting from iCalendar to xCal
+
+ This section describes how iCalendar data is converted to xCal using
+ a simple mapping between the iCalendar data model and XML elements.
+
+3.1. Pre-Processing
+
+ iCalendar uses a line folding mechanism to limit lines of data to a
+ maximum line length (typically 72 characters) to ensure maximum
+ likelihood of preserving data integrity as it is transported via
+ various means (e.g., email) -- see Section 3.1 of [RFC5545]. Prior
+ to converting iCalendar data into xCal, all folded lines MUST be
+ unfolded.
+
+ iCalendar data uses an "escape" character sequence for text values
+ and property parameter values. When such text elements are converted
+ into xCal, the escaping MUST be removed.
+
+ iCalendar uses a base64 encoding for binary data. However, it does
+ not restrict the encoding from being applied to non-binary value
+ types. So, the following rules MUST be applied when processing a
+ property with the "ENCODING" property parameter set to "BASE64":
+
+ o If the property value type is "BINARY", the base64 encoding MUST
+ be preserved.
+
+ o If the value type is not "BINARY", the "ENCODING" property
+ parameter MUST be removed, and the value MUST be base64 decoded.
+
+ When base64 encoding and decoding are used, they MUST conform to
+ Section 4 of [RFC4648], which is the base64 method used in [RFC5545].
+
+
+
+
+Daboo, et al. Standards Track [Page 4]
+
+RFC 6321 xCal August 2011
+
+
+ One key difference in the formatting of values used in iCalendar and
+ xCal is that, in xCal, the specification uses date/time and UTC
+ offset values aligned with the syntax of
+ [W3C.REC-xmlschema-2-20041028] to aid with XML processing.
+
+3.2. iCalendar Stream (RFC 5545, Section 3.4)
+
+ At the top level of the iCalendar object model is an "iCalendar
+ stream". This object encompasses multiple "iCalendar objects". In
+ xCal, the entire stream is contained in the root IC:icalendar XML
+ element.
+
+ An iCalendar stream can contain one or more iCalendar objects. Each
+ iCalendar object, delimited by "BEGIN:VCALENDAR" and "END:VCALENDAR",
+ is enclosed by the IC:vcalendar XML element.
+
+ Example:
+
+ <?xml version="1.0" encoding="utf-8"?>
+ <icalendar xmlns="urn:ietf:params:xml:ns:icalendar-2.0">
+ <vcalendar>
+ ...
+ </vcalendar>
+ </icalendar>
+
+ iCalendar objects are comprised of a set of "components",
+ "properties", "parameters", and "values". A "component" can contain
+ other "components" or "properties". A "property" has a value and a
+ set of zero or more "parameters".
+
+ In xCal, component elements, for example, IC:vevent and IC:vtodo, are
+ contained within an IC:components XML element. Within the component
+ element, another IC:components element could appear (representing
+ components nested within components) or the IC:properties XML element
+ could appear. IC:properties is used to encapsulate iCalendar
+ properties.
+
+ Each iCalendar property will be mapped to its own XML element as
+ described below. Within each of these elements, there is zero or one
+ IC:parameters XML element used to encapsulate any iCalendar property
+ parameters. Additionally there will be one or more XML elements
+ representing the value of the iCalendar property.
+
+
+
+
+
+
+
+
+
+Daboo, et al. Standards Track [Page 5]
+
+RFC 6321 xCal August 2011
+
+
+ Example:
+
+ <?xml version="1.0" encoding="utf-8"?>
+ <icalendar xmlns="urn:ietf:params:xml:ns:icalendar-2.0">
+ <vcalendar>
+ <properties>
+ ...
+ </properties>
+ <components>
+ ...
+ </components>
+ </vcalendar>
+ </icalendar>
+
+ +------------------+--------------+------------------+
+ | Item | XML element | XML Definition |
+ +------------------+--------------+------------------+
+ | iCalendar Stream | IC:icalendar | Appendix A # 3.4 |
+ | VCALENDAR | IC:vcalendar | Appendix A # 3.6 |
+ +------------------+--------------+------------------+
+
+3.3. Components (RFC 5545, Section 3.6)
+
+ Each calendar component in the "VCALENDAR" object, delimited by
+ "BEGIN" and "END", will be converted to an enclosing XML element with
+ the same name, but in lowercase. As an example, the table below
+ shows iCalendar-to-xCal mappings for current iCalendar components.
+ Any new iCalendar components added in the future will be converted in
+ the same way.
+
+ +-----------+--------------+--------------------+
+ | Component | XML element | XML Definition |
+ +-----------+--------------+--------------------+
+ | VEVENT | IC:vevent | Appendix A # 3.6.1 |
+ | VTODO | IC:vtodo | Appendix A # 3.6.2 |
+ | VJOURNAL | IC:vjournal | Appendix A # 3.6.3 |
+ | VFREEBUSY | IC:vfreebusy | Appendix A # 3.6.4 |
+ | VTIMEZONE | IC:vtimezone | Appendix A # 3.6.5 |
+ | STANDARD | IC:standard | Appendix A # 3.6.5 |
+ | DAYLIGHT | IC:daylight | Appendix A # 3.6.5 |
+ | VALARM | IC:valarm | Appendix A # 3.6.6 |
+ +-----------+--------------+--------------------+
+
+3.4. Properties (RFC 5545, Sections 3.7 and 3.8)
+
+ iCalendar properties, whether they apply to the "VCALENDAR" object or
+ to a component, are handled in a consistent way in the xCal format.
+
+
+
+
+Daboo, et al. Standards Track [Page 6]
+
+RFC 6321 xCal August 2011
+
+
+ iCalendar properties are enclosed in the XML element IC:properties.
+
+ Each individual iCalendar property is represented in xCal by an
+ element of the same name as the iCalendar property, but in lowercase.
+ For example, the "CALSCALE" property is represented in xCal by the
+ IC:calscale element.
+
+ Example:
+
+ <?xml version="1.0" encoding="utf-8"?>
+ <icalendar xmlns="urn:ietf:params:xml:ns:icalendar-2.0">
+ <vcalendar>
+ <properties>
+ <calscale>...</calscale>
+ <version>...</version>
+ <prodid>...</prodid>
+ </properties>
+ <components>
+ ...
+ </components>
+ </vcalendar>
+ </icalendar>
+
+ Each property can contain an IC:parameters XML element encapsulating
+ any iCalendar property parameters associated with the iCalendar
+ property.
+
+ Each property will contain one or more "value" XML elements as
+ described below representing the value of the iCalendar property.
+
+ As an example, the table below shows iCalendar-to-xCal mappings for
+ current iCalendar properties. Any new iCalendar properties added in
+ the future will be converted in the same way.
+
+ +------------------+---------------------+-----------------------+
+ | Property | XML element | XML Definition |
+ +------------------+---------------------+-----------------------+
+ | CALSCALE | IC:calscale | Appendix A # 3.7.1 |
+ | METHOD | IC:method | Appendix A # 3.7.2 |
+ | PRODID | IC:prodid | Appendix A # 3.7.3 |
+ | VERSION | IC:version | Appendix A # 3.7.4 |
+ | ATTACH | IC:attach | Appendix A # 3.8.1.1 |
+ | CATEGORIES | IC:categories | Appendix A # 3.8.1.2 |
+ | CLASS | IC:class | Appendix A # 3.8.1.3 |
+ | COMMENT | IC:comment | Appendix A # 3.8.1.4 |
+ | DESCRIPTION | IC:description | Appendix A # 3.8.1.5 |
+ | GEO | IC:geo | Appendix A # 3.8.1.6 |
+ | LOCATION | IC:location | Appendix A # 3.8.1.7 |
+
+
+
+Daboo, et al. Standards Track [Page 7]
+
+RFC 6321 xCal August 2011
+
+
+ | PERCENT-COMPLETE | IC:percent-complete | Appendix A # 3.8.1.8 |
+ | PRIORITY | IC:priority | Appendix A # 3.8.1.9 |
+ | RESOURCES | IC:resources | Appendix A # 3.8.1.10 |
+ | STATUS | IC:status | Appendix A # 3.8.1.11 |
+ | SUMMARY | IC:summary | Appendix A # 3.8.1.12 |
+ | COMPLETED | IC:completed | Appendix A # 3.8.2.1 |
+ | DTEND | IC:dtend | Appendix A # 3.8.2.2 |
+ | DUE | IC:due | Appendix A # 3.8.2.3 |
+ | DTSTART | IC:dtstart | Appendix A # 3.8.2.4 |
+ | DURATION | IC:duration | Appendix A # 3.8.2.5 |
+ | FREEBUSY | IC:freebusy | Appendix A # 3.8.2.6 |
+ | TRANSP | IC:transp | Appendix A # 3.8.2.7 |
+ | TZID | IC:tzid | Appendix A # 3.8.3.1 |
+ | TZNAME | IC:tzname | Appendix A # 3.8.3.2 |
+ | TZOFFSETFROM | IC:tzoffsetfrom | Appendix A # 3.8.3.3 |
+ | TZOFFSETTO | IC:tzoffsetto | Appendix A # 3.8.3.4 |
+ | TZURL | IC:tzurl | Appendix A # 3.8.3.5 |
+ | ATTENDEE | IC:attendee | Appendix A # 3.8.4.1 |
+ | CONTACT | IC:contact | Appendix A # 3.8.4.2 |
+ | ORGANIZER | IC:organizer | Appendix A # 3.8.4.3 |
+ | RECURRENCE-ID | IC:recurrence-id | Appendix A # 3.8.4.4 |
+ | RELATED-TO | IC:related-to | Appendix A # 3.8.4.5 |
+ | URL | IC:url | Appendix A # 3.8.4.6 |
+ | UID | IC:uid | Appendix A # 3.8.4.7 |
+ | EXDATE | IC:exdate | Appendix A # 3.8.5.1 |
+ | RDATE | IC:rdate | Appendix A # 3.8.5.2 |
+ | RRULE | IC:rrule | Appendix A # 3.8.5.3 |
+ | ACTION | IC:action | Appendix A # 3.8.6.1 |
+ | REPEAT | IC:repeat | Appendix A # 3.8.6.2 |
+ | TRIGGER | IC:trigger | Appendix A # 3.8.6.3 |
+ | CREATED | IC:created | Appendix A # 3.8.7.1 |
+ | DTSTAMP | IC:dtstamp | Appendix A # 3.8.7.2 |
+ | LAST-MODIFIED | IC:last-modified | Appendix A # 3.8.7.3 |
+ | SEQUENCE | IC:sequence | Appendix A # 3.8.7.4 |
+ | REQUEST-STATUS | IC:request-status | Appendix A # 3.8.8.3 |
+ +------------------+---------------------+-----------------------+
+
+3.4.1. Special Cases for Properties
+
+ This section describes some properties that have special handling
+ when converting to xCal.
+
+3.4.1.1. Multi-Valued Properties
+
+ The following iCalendar properties can have values that consist of a
+ list of "standard" iCalendar values separated by a specific
+ delimiter. In xCal, these properties are represented by an XML
+ element that contains multiple "value" elements (Section 3.6).
+
+
+
+Daboo, et al. Standards Track [Page 8]
+
+RFC 6321 xCal August 2011
+
+
+ +------------+---------------+-----------------------+
+ | Property | XML element | XML Definition |
+ +------------+---------------+-----------------------+
+ | CATEGORIES | IC:categories | Appendix A # 3.8.1.2 |
+ | RESOURCES | IC:resources | Appendix A # 3.8.1.10 |
+ | FREEBUSY | IC:freebusy | Appendix A # 3.8.2.6 |
+ | EXDATE | IC:exdate | Appendix A # 3.8.5.1 |
+ | RDATE | IC:rdate | Appendix A # 3.8.5.2 |
+ +------------+---------------+-----------------------+
+
+3.4.1.2. GEO Property
+
+ In iCalendar, the "GEO" property value is defined as a semicolon-
+ separated list of two "FLOAT" values; the first representing latitude
+ and the second longitude.
+
+ In xCal, the value for the IC:geo element is represented by two XML
+ elements. These are an IC:latitude element and an IC:longitude
+ element, each of which contains float values. See Appendix A #
+ 3.8.1.6.
+
+ Example:
+
+ <?xml version="1.0" encoding="utf-8"?>
+ <icalendar xmlns="urn:ietf:params:xml:ns:icalendar-2.0">
+ ...
+ <geo>
+ <latitude>37.386013</latitude>
+ <longitude>-122.082932</longitude>
+ </geo>
+ ...
+ </icalendar>
+
+3.4.1.3. REQUEST-STATUS Property
+
+ In iCalendar, the "REQUEST-STATUS" property value is defined as a
+ semicolon-separated list of two or three "TEXT" values. The first
+ represents a code, the second a description, and the third any
+ additional data.
+
+ In xCal, the value for the IC:request-status element is represented
+ by two or three XML elements. These are an IC:code element, an IC:
+ description element, and an IC:data element, each of which contains
+ the corresponding "TEXT" values. If there is no additional data in
+ the iCalendar value, the IC:data element (which would be empty)
+ SHOULD NOT be present. See Appendix A # 3.8.8.3.
+
+
+
+
+
+Daboo, et al. Standards Track [Page 9]
+
+RFC 6321 xCal August 2011
+
+
+ Example:
+
+ <?xml version="1.0" encoding="utf-8"?>
+ <icalendar xmlns="urn:ietf:params:xml:ns:icalendar-2.0">
+ ...
+ <request-status>
+ <code>2.0</code>
+ <description>Success</description>
+ </request-status>
+ ...
+ </icalendar>
+
+3.5. Parameters (RFC 5545, Section 3.2)
+
+ iCalendar property parameters are enclosed in the XML element IC:
+ parameters, which occurs in each property XML element. If there are
+ no iCalendar property parameters, the IC:parameters element (which
+ would be empty) SHOULD NOT be present.
+
+ Each individual iCalendar property parameter is represented in xCal
+ by an element of the same name as the iCalendar property parameter,
+ but in lowercase. For example, the "PARTSTAT" property parameter is
+ represented in xCal by the IC:partstat element.
+
+ Example:
+
+ <?xml version="1.0" encoding="utf-8"?>
+ <icalendar xmlns="urn:ietf:params:xml:ns:icalendar-2.0">
+ <vcalendar>
+ ...
+ <components>
+ ...
+ <attendee>
+ <parameters>
+ <partstat><text>NEEDS-ACTION</text></partstat>
+ </parameters>
+ ...
+ </attendee>
+ ...
+ </components>
+ </vcalendar>
+ </icalendar>
+
+ Each XML parameter element contains one or more child XML elements
+ representing iCalendar value types.
+
+
+
+
+
+
+Daboo, et al. Standards Track [Page 10]
+
+RFC 6321 xCal August 2011
+
+
+ As an example, the table below shows iCalendar-to-xCal mappings for
+ current iCalendar parameters. Any new iCalendar parameters added in
+ the future will be converted in the same way.
+
+ +----------------+-------------------+---------------------+
+ | Parameter | XML element | XML Definition |
+ +----------------+-------------------+---------------------+
+ | ALTREP | IC:altrep | Appendix A # 3.2.1 |
+ | CN | IC:cn | Appendix A # 3.2.2 |
+ | CUTYPE | IC:cutype | Appendix A # 3.2.3 |
+ | DELEGATED-FROM | IC:delegated-from | Appendix A # 3.2.4 |
+ | DELEGATED-TO | IC:delegated-to | Appendix A # 3.2.5 |
+ | DIR | IC:dir | Appendix A # 3.2.6 |
+ | ENCODING | IC:encoding | Appendix A # 3.2.7 |
+ | FMTTYPE | IC:fmttype | Appendix A # 3.2.8 |
+ | FBTYPE | IC:fbtype | Appendix A # 3.2.9 |
+ | LANGUAGE | IC:language | Appendix A # 3.2.10 |
+ | MEMBER | IC:member | Appendix A # 3.2.11 |
+ | PARTSTAT | IC:partstat | Appendix A # 3.2.12 |
+ | RANGE | IC:range | Appendix A # 3.2.13 |
+ | RELATED | IC:related | Appendix A # 3.2.14 |
+ | RELTYPE | IC:reltype | Appendix A # 3.2.15 |
+ | ROLE | IC:role | Appendix A # 3.2.16 |
+ | RSVP | IC:rsvp | Appendix A # 3.2.17 |
+ | SENT-BY | IC:sent-by | Appendix A # 3.2.18 |
+ | TZID | IC:tzid | Appendix A # 3.2.19 |
+ +----------------+-------------------+---------------------+
+
+3.5.1. VALUE Parameter
+
+ iCalendar defines a "VALUE" property parameter (Section 3.2.20 of
+ [RFC5545]). This property parameter is not mapped to an xCal XML
+ element. Instead, the value type is handled by having different XML
+ elements for each value, and these appear inside of property
+ elements. Thus, when converting from iCalendar to xCal, any "VALUE"
+ property parameters are skipped. When converting from xCal into
+ iCalendar, the appropriate "VALUE" property parameter MUST be
+ included in the iCalendar property if the value type is not the
+ default value type for that property.
+
+3.6. Values (RFC 5545, Section 3.3)
+
+ In the typical case, iCalendar value types are mapped into XML
+ elements with a matching name in all lowercase. In the case of the
+ value for a recurrence rule (see below), iCalendar defines
+ "structured" values, and these are mapped into separate child
+ elements for each value element.
+
+
+
+
+Daboo, et al. Standards Track [Page 11]
+
+RFC 6321 xCal August 2011
+
+
+3.6.1. Binary (RFC 5545, Section 3.3.1)
+
+ Description: iCalendar "BINARY" property values are represented by
+ the IC:binary XML element. The content of the element is base64
+ encoded data, conforming to Section 4 of [RFC4648], which is the
+ base64 method used in [RFC5545]. Whitespace MAY be inserted into
+ the data at any point to "wrap" the data to reasonable line
+ lengths. When converting back to iCalendar, the whitespace MUST
+ first be removed.
+
+ XML Definition: Appendix A # 3.3.1
+
+ Example:
+
+ <binary>SGVsbG8gV29ybGQh</binary>
+
+3.6.2. Boolean (RFC 5545, Section 3.3.2)
+
+ Description: iCalendar "BOOLEAN" property values are represented by
+ the IC:boolean XML element. The content of the element is a
+ boolean value.
+
+ XML Definition: Appendix A # 3.3.2
+
+ Example:
+
+ <boolean>true</boolean>
+
+3.6.3. Calendar User Address (RFC 5545, Section 3.3.3)
+
+ Description: iCalendar "CAL-ADDRESS" property values are represented
+ by the IC:cal-address XML element. The content of the element is
+ a URI.
+
+ XML Definition: Appendix A # 3.3.3
+
+ Example:
+
+ <cal-address>mailto:cyrus at example.com</cal-address>
+
+3.6.4. Date (RFC 5545, Section 3.3.4)
+
+ Description: iCalendar "DATE" property values are represented by the
+ IC:date XML element. The content of the element is the same date
+ value specified by [RFC5545], with the exception that the date
+ components are separated by "-" characters, for consistency with
+ [W3C.REC-xmlschema-2-20041028].
+
+
+
+
+Daboo, et al. Standards Track [Page 12]
+
+RFC 6321 xCal August 2011
+
+
+ XML Definition: Appendix A # 3.3.4
+
+ Example:
+
+ <date>2011-05-17</date>
+
+3.6.5. Date-Time (RFC 5545, Section 3.3.5)
+
+ Description: iCalendar "DATE-TIME" property values are represented
+ by the IC:date-time XML element. The content of the element is
+ the same date-time value specified by [RFC5545], with the
+ exception that the date components are separated by "-"
+ characters, and the time components are separated by ":"
+ characters, for consistency with [W3C.REC-xmlschema-2-20041028].
+ Note that while [W3C.REC-xmlschema-2-20041028] allows for a UTC
+ offset to be included in date/time values, xCal does not use that,
+ and instead follows the iCalendar behavior of using time zone
+ definitions via the "TZID" property parameter.
+
+ XML Definition: Appendix A # 3.3.5
+
+ Example:
+
+ <date-time>2011-05-17T12:00:00</date-time>
+
+3.6.6. Duration (RFC 5545, Section 3.3.6)
+
+ Description: iCalendar "DURATION" property values are represented by
+ the IC:duration XML element. The content of the element is the
+ same duration value specified by [RFC5545].
+
+ XML Definition: Appendix A # 3.3.6
+
+ Example:
+
+ <duration>P1D</duration>
+
+3.6.7. Float (RFC 5545, Section 3.3.7)
+
+ Description: iCalendar "FLOAT" property values are represented by
+ the IC:float XML element. The content of the element is a text
+ representation of a floating point number.
+
+ XML Definition: Appendix A # 3.3.7
+
+ Example:
+
+ <float>0.5</float>
+
+
+
+Daboo, et al. Standards Track [Page 13]
+
+RFC 6321 xCal August 2011
+
+
+3.6.8. Integer (RFC 5545, Section 3.3.8)
+
+ Description: iCalendar "INTEGER" property values are represented by
+ the IC:integer XML element. The content of the element is a text
+ representation of an integer number.
+
+ XML Definition: Appendix A # 3.3.8
+
+ Examples:
+
+ <integer>50</integer>
+ <integer>-100</integer>
+
+3.6.9. Period of Time (RFC 5545, Section 3.3.9)
+
+ Description: iCalendar "PERIOD" property values are represented by
+ the IC:period XML element. The content of the element is child
+ elements representing the start, end, or duration components of
+ the period.
+
+ XML Definition: Appendix A # 3.3.9
+
+ Example:
+
+ <period>
+ <start>2011-05-17T12:00:00</start>
+ <duration>P1H</duration>
+ </period>
+
+3.6.10. Recurrence Rule (RFC 5545, Section 3.3.10)
+
+ Description: iCalendar "RECUR" property values are represented by
+ the IC:recur XML element. The content of the element is child
+ elements representing the various components of a recurrence rule.
+
+ XML Definition: Appendix A # 3.3.10
+
+ Example:
+
+ <recur>
+ <freq>YEARLY</freq>
+ <count>5</count>
+ <byday>-1SU</byday>
+ <bymonth>10</bymonth>
+ </recur>
+
+
+
+
+
+
+Daboo, et al. Standards Track [Page 14]
+
+RFC 6321 xCal August 2011
+
+
+3.6.11. Text (RFC 5545, Section 3.3.11)
+
+ Description: iCalendar "TEXT" property values are represented by the
+ IC:text XML element. The content of the element is simple text.
+
+ XML Definition: Appendix A # 3.3.11
+
+ Example:
+
+ <text>Hello World!</text>
+
+3.6.12. Time (RFC 5545, Section 3.3.12)
+
+ Description: iCalendar "TIME" property values are represented by the
+ IC:time XML element. The content of the element is the same time
+ value specified by [RFC5545], with the exception that the time
+ components are separated by ":" characters, for consistency with
+ [W3C.REC-xmlschema-2-20041028]. Note that while
+ [W3C.REC-xmlschema-2-20041028] allows for a UTC offset to be
+ included in date/time values, xCal does not use that, and instead
+ follows the iCalendar behavior of using time zone definitions via
+ the "TZID" property parameter.
+
+ XML Definition: Appendix A # 3.3.12
+
+ Example:
+
+ <time>12:00:00</time>
+
+3.6.13. URI (RFC 5545, Section 3.3.13)
+
+ Description: iCalendar "URI" property values are represented by the
+ IC:uri XML element. The content of the element is a URI.
+
+ XML Definition: Appendix A # 3.3.13
+
+ Example:
+
+ <uri>http://calendar.example.com</uri>
+
+
+
+
+
+
+
+
+
+
+
+
+Daboo, et al. Standards Track [Page 15]
+
+RFC 6321 xCal August 2011
+
+
+3.6.14. UTC Offset (RFC 5545, Section 3.3.14)
+
+ Description: iCalendar "UTC-OFFSET" property values are represented
+ by the IC:utc-offset XML element. The content of the element is
+ the same UTC offset value specified by [RFC5545], with the
+ exception that the hour, minute, and second components are
+ separated by a ":" character, for consistency with
+ [W3C.REC-xmlschema-2-20041028].
+
+ XML Definition: Appendix A # 3.3.14
+
+ Example:
+
+ <utc-offset>-05:00</utc-offset>
+
+3.7. Extensions
+
+ iCalendar extension properties and property parameters (those with an
+ "X-" prefix in their name) are handled in the same way as other
+ properties and property parameters: the property or property
+ parameter is represented by an XML element with the same name, but in
+ lowercase, e.g., the "X-FOO" property in iCalendar turns into the IC:
+ x-foo element in xCal. However, see Section 5 for how to deal with
+ default values for unrecognized extension properties or property
+ parameters.
+
+4. Converting from xCal into iCalendar
+
+ When converting component, property, and property parameter values,
+ the names SHOULD be converted to uppercase. Although iCalendar names
+ are case insensitive, common practice is to keep them all uppercase
+ following the actual definitions in [RFC5545].
+
+ BACKSLASH character encoding and line folding MUST be applied to the
+ resulting iCalendar data as required by [RFC5545].
+
+ Non-binary value types MUST NOT be base64 encoded.
+
+4.1. Converting XML Extensions into iCalendar
+
+ XML extensions are converted back to iCalendar in one of two ways,
+ depending on whether the extensions are in the iCalendar XML
+ namespace or in an external namespace.
+
+ Extensions that are part of the iCalendar XML namespace MUST have
+ element names that begin with "x-", and will be converted back to the
+ equivalent extension property in iCalendar. For example, the "x-foo"
+ element will convert to the "X-FOO" iCalendar property.
+
+
+
+Daboo, et al. Standards Track [Page 16]
+
+RFC 6321 xCal August 2011
+
+
+ Extensions that are in a namespace other than the iCalendar XML
+ namespace SHOULD be preserved in the iCalendar representation using
+ the "XML" iCalendar property described in Section 4.2. Only those
+ extension elements that are immediate child elements of the IC:
+ properties element are converted, any others are ignored.
+
+4.2. The XML Property for iCalendar
+
+ This section describes an extension property for iCalendar, as
+ covered in Section 8.2.3 of [RFC5545].
+
+ Property name: XML
+
+ Purpose: To embed extended XML-encoded iCalendar data in the
+ iCalendar format.
+
+ Value type: The default value type is "TEXT". The value type can
+ also be set to "BINARY" to indicate base64 encoded content.
+
+ Property parameters: IANA, non-standard, inline encoding, and value
+ data type property parameters can be specified on this property.
+
+ Conformance: The property can be specified multiple times in any
+ calendar component.
+
+ Description: The value of this property is a single XML 1.0
+ [W3C.REC-xml-20081126] element. The "XML" property MUST NOT be used
+ to contain properties that are already defined in iCalendar. Since
+ all elements in the urn:ietf:params:xml:ns:icalendar-2.0 namespace
+ convert to a well-defined iCalendar object, the elements in this
+ property MUST NOT be in the urn:ietf:params:xml:ns:icalendar-2.0
+ namespace. The XML element that is the value of this property MUST
+ have an XML namespace declaration.
+
+ The default value type for this property is "TEXT", and normal
+ BACKSLASH character encoding rules for that value MUST be applied.
+ Note that the source XML can contain characters not allowed in "TEXT"
+ property values. If this is the case, then the XML data MUST be
+ base64 encoded. As required by [RFC5545], the "ENCODING" property
+ parameter MUST be present and set to "BASE64", and the "VALUE"
+ property parameter MUST be present and set to "BINARY".
+
+ The ordering of "XML" properties is not preserved in the conversion
+ between xCal and iCalendar.
+
+ Format definition: This property is defined by the following
+ notation:
+
+
+
+
+Daboo, et al. Standards Track [Page 17]
+
+RFC 6321 xCal August 2011
+
+
+ xml = "XML" xmlparam ( ":" text ) /
+ (
+ ";" "ENCODING" "=" "BASE64"
+ ";" "VALUE" "=" "BINARY"
+ ":" binary
+ )
+ CRLF
+
+ xmlparam = *(";" other-param)
+
+ Example: The following is an example of a location embedded in KML
+ markup inside the "XML" property.
+
+ XML:<kml xmlns="http://www.opengis.net/kml/2.2">\n
+ <Document>\n
+ <name>KML Sample</name>\n
+ <open>1</open>\n
+ <description>An incomplete example of a KML docum
+ ent - used as an example!</description>\n
+ </Document>\n
+ </kml>
+
+5. Handling Unrecognized Properties or Parameters
+
+ In iCalendar, properties have a default value type specified by their
+ definition, e.g., "SUMMARY"'s value type is "TEXT" and "DURATION"'s
+ is "DURATION". When a property uses its default value type, the
+ "VALUE" property parameter does not need to be specified on the
+ property.
+
+ When new properties are defined or "X-" properties are used, an
+ iCalendar<->xCal converter might not recognize them, and know what
+ the appropriate default value types are, yet they need to be able to
+ preserve the values. A similar issue arises for unrecognized
+ property parameters. As a result, the following rules are applied
+ when dealing with unrecognized properties and property parameters:
+
+ o When converting iCalendar into xCal:
+
+ * Any property that does not include a "VALUE" property parameter
+ and whose default value type is not known MUST be converted
+ using the value type XML element IC:unknown. The content of
+ that element is the unprocessed value text.
+
+ * Any unrecognized property parameter MUST be converted using the
+ value type XML element IC:unknown, with its content set to the
+ property parameter value text, treated as if it were a "TEXT"
+ value or list of "TEXT" values.
+
+
+
+Daboo, et al. Standards Track [Page 18]
+
+RFC 6321 xCal August 2011
+
+
+ o When converting xCal into iCalendar:
+
+ * Any IC:unknown property value XML elements are converted
+ directly into iCalendar values. The containing property MUST
+ NOT have a "VALUE" property parameter.
+
+ * Any IC:unknown parameter value XML elements are converted as if
+ they were IC:text value type XML elements.
+
+ Example: The following is an example of an unrecognized iCalendar
+ property (that uses a "DATE-TIME" value as its default) and the
+ equivalent xCal representation of that property.
+
+ iCalendar:
+
+ X-PROPERTY:20110512T120000Z
+
+ xCal:
+
+ <x-property>
+ <unknown>20110512T120000Z</unknown>
+ </x-property>
+
+ Example: The following is an example of an unrecognized iCalendar
+ property parameter (that uses a "DURATION" value as its default)
+ specified on a recognized iCalendar property, and the equivalent xCal
+ representation of that property and property parameter.
+
+ iCalendar:
+
+ DTSTART;X-PARAM=PT30M:20110512T130000Z
+
+ xCal:
+
+ <dtstart>
+ <parameters>
+ <x-param><unknown>PT30M</unknown></x-param>
+ </parameters>
+ <date-time>2011-05-12T13:00:00Z</date-time>
+ </dtstart>
+
+6. Security Considerations
+
+ For security considerations specific to calendar data, see Section 7
+ of [RFC5545]. Since this specification is a mapping from iCalendar,
+ no new security concerns are introduced related to calendar data.
+
+
+
+
+
+Daboo, et al. Standards Track [Page 19]
+
+RFC 6321 xCal August 2011
+
+
+ The use of XML as a format does have security risks. Section 7 of
+ [RFC3470] discusses these risks. See also the security discussion
+ for the application/xml type in [RFC3023].
+
+7. IANA Considerations
+
+ This document defines a new URN to identify a new XML namespace for
+ iCalendar data. The URN conforms to a registry mechanism described
+ in [RFC3688].
+
+ This document defines a new media type. The registration is in
+ Section 7.2.
+
+ This document defines a new property for iCalendar. The registration
+ is in Section 7.3.
+
+7.1. Namespace Registration
+
+ Registration request for the iCalendar namespace:
+
+ URI: urn:ietf:params:xml:ns:icalendar-2.0
+
+ Registrant Contact: See the "Authors' Addresses" section of this
+ document.
+
+ XML: None. Namespace URIs do not represent an XML specification.
+
+7.2. Media Type
+
+ This section defines the MIME media type for use with iCalendar in
+ XML data.
+
+ Type name: application
+
+ Subtype name: calendar+xml
+
+ Required parameters: None
+
+ Optional parameters: method, component, and optinfo as defined for
+ the text/calendar media type in [RFC5545]; charset as defined for
+ application/xml in [RFC3023]; per [RFC3023], use of the charset
+ property parameter with the value "utf-8" is STRONGLY RECOMMENDED.
+
+ Encoding considerations: Same as encoding considerations of
+ application/xml as specified in [RFC3023].
+
+
+
+
+
+
+Daboo, et al. Standards Track [Page 20]
+
+RFC 6321 xCal August 2011
+
+
+ Security considerations: See Section 6.
+
+ Interoperability considerations: This media type provides an
+ alternative format for iCalendar data based on XML.
+
+ Published specification: This specification.
+
+ Applications that use this media type: Applications that currently
+ make use of the text/calendar media type can use this as an
+ alternative.
+
+ Additional information:
+
+ Magic number(s): None
+
+ File extension(s): xcs
+
+ Macintosh file type code(s): None specified.
+
+ Person & email address to contact for further information:
+ calsify at ietf.org
+
+ Intended usage: COMMON
+
+ Restrictions on usage: There are no restrictions on where this media
+ type can be used.
+
+ Author: See the "Authors' Addresses" section of this document.
+
+ Change controller: IETF
+
+7.3. iCalendar Property Registrations
+
+ This document defines the following new iCalendar property to be
+ added to the registry defined in Section 8.2.3 of [RFC5545]:
+
+ +----------+---------+-----------------------+
+ | Property | Status | Reference |
+ +----------+---------+-----------------------+
+ | XML | Current | RFC 6321, Section 4.2 |
+ +----------+---------+-----------------------+
+
+
+
+
+
+
+
+
+
+
+Daboo, et al. Standards Track [Page 21]
+
+RFC 6321 xCal August 2011
+
+
+8. Acknowledgments
+
+ The authors would like to thank the following for their valuable
+ contributions: Toby Considine, Bernard Desruisseaux, Keith Moore,
+ Filip Navara, Simon Perreault, Arnaud Quillaud, Peter Saint-Andre,
+ and Dave Thewlis. This specification originated from the work of the
+ XML technical committee of the Calendaring and Scheduling Consortium.
+
+9. References
+
+9.1. Normative References
+
+ [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
+ Requirement Levels", BCP 14, RFC 2119, March 1997.
+
+ [RFC3023] Murata, M., St. Laurent, S., and D. Kohn, "XML Media
+ Types", RFC 3023, January 2001.
+
+ [RFC3470] Hollenbeck, S., Rose, M., and L. Masinter, "Guidelines for
+ the Use of Extensible Markup Language (XML)
+ within IETF Protocols", BCP 70, RFC 3470, January 2003.
+
+ [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
+ January 2004.
+
+ [RFC4648] Josefsson, S., "The Base16, Base32, and Base64 Data
+ Encodings", RFC 4648, October 2006.
+
+ [RFC5545] Desruisseaux, B., "Internet Calendaring and Scheduling
+ Core Object Specification (iCalendar)", RFC 5545,
+ September 2009.
+
+ [W3C.REC-xml-20081126]
+ Sperberg-McQueen, C., Yergeau, F., Bray, T., Paoli, J.,
+ and E. Maler, "Extensible Markup Language (XML) 1.0 (Fifth
+ Edition)", World Wide Web Consortium Recommendation REC-
+ xml-20081126, November 2008,
+ <http://www.w3.org/TR/2008/REC-xml-20081126>.
+
+9.2. Informative References
+
+ [W3C.REC-xmlschema-2-20041028]
+ Malhotra, A. and P. Biron, "XML Schema Part 2: Datatypes
+ Second Edition", World Wide Web Consortium
+ Recommendation REC-xmlschema-2-20041028, October 2004,
+ <http://www.w3.org/TR/2004/REC-xmlschema-2-20041028>.
+
+
+
+
+
+Daboo, et al. Standards Track [Page 22]
+
+RFC 6321 xCal August 2011
+
+
+Appendix A. RELAX NG Schema
+
+ Below is a RELAX NG schema for iCalendar in XML. The schema is non-
+ normative and given for reference only.
+
+ This schema uses the compact notation of RELAX NG. The numeric
+ section numbers given in the comments refer to sections in [RFC5545].
+ The ordering of elements follows the section ordering of [RFC5545].
+
+ The RELAX NG compact notation "?" operator is used to indicate an
+ unordered list of items. However, that operator, as defined, allows
+ "mixing" each element that it operates on at any depth within the
+ other elements, rather than just allowing "mixing" of siblings only.
+ As a result, the schema provided allows certain constructs that are
+ not allowed in iCalendar. Given that there is no sibling-only
+ unordered list operator in RELAX NG, this is the best representation
+ that can be given.
+
+ Patterns for date/time, duration, and UTC offset values are given
+ because those differ from the values used in iCalendar. More
+ restrictive schema with patterns and numerical limits could be
+ derived from the example schema here if more comprehensive schema
+ validation is required.
+
+ # RELAX NG Schema for iCalendar in XML
+
+ default namespace = "urn:ietf:params:xml:ns:icalendar-2.0"
+
+ # 3.2 Property Parameters
+
+ # 3.2.1 Alternate Text Representation
+
+ altrepparam = element altrep {
+ value-uri
+ }
+
+ # 3.2.2 Common Name
+
+ cnparam = element cn {
+ value-text
+ }
+
+
+
+
+
+
+
+
+
+
+Daboo, et al. Standards Track [Page 23]
+
+RFC 6321 xCal August 2011
+
+
+ # 3.2.3 Calendar User Type
+
+ cutypeparam = element cutype {
+ element text {
+ "INDIVIDUAL" |
+ "GROUP" |
+ "RESOURCE" |
+ "ROOM" |
+ "UNKNOWN"
+ }
+ }
+
+ # 3.2.4 Delegators
+
+ delfromparam = element delegated-from {
+ value-cal-address+
+ }
+
+ # 3.2.5 Delegatees
+
+ deltoparam = element delegated-to {
+ value-cal-address+
+ }
+
+ # 3.2.6 Directory Entry Reference
+
+ dirparam = element dir {
+ value-uri
+ }
+
+ # 3.2.7 Inline Encoding
+
+ encodingparam = element encoding {
+ element text {
+ "8BIT" |
+ "BASE64"
+ }
+ }
+
+ # 3.2.8 Format Type
+
+ fmttypeparam = element fmttype {
+ value-text
+ }
+
+
+
+
+
+
+
+Daboo, et al. Standards Track [Page 24]
+
+RFC 6321 xCal August 2011
+
+
+ # 3.2.9 Free/Busy Time Type
+
+ fbtypeparam = element fbtype {
+ element text {
+ "FREE" |
+ "BUSY" |
+ "BUSY-UNAVAILABLE" |
+ "BUSY-TENTATIVE"
+ }
+ }
+
+ # 3.2.10 Language
+
+ languageparam = element language {
+ value-text
+ }
+
+ # 3.2.11 Group or List Membership
+
+ memberparam = element member {
+ value-cal-address+
+ }
+
+ # 3.2.12 Participation Status
+
+ partstatparam = element partstat {
+ type-partstat-event |
+ type-partstat-todo |
+ type-partstat-jour
+ }
+
+ type-partstat-event = (
+ element text {
+ "NEEDS-ACTION" |
+ "ACCEPTED" |
+ "DECLINED" |
+ "TENTATIVE" |
+ "DELEGATED"
+ }
+ )
+
+
+
+
+
+
+
+
+
+
+
+Daboo, et al. Standards Track [Page 25]
+
+RFC 6321 xCal August 2011
+
+
+ type-partstat-todo = (
+ element text {
+ "NEEDS-ACTION" |
+ "ACCEPTED" |
+ "DECLINED" |
+ "TENTATIVE" |
+ "DELEGATED" |
+ "COMPLETED" |
+ "IN-PROCESS"
+ }
+ )
+
+ type-partstat-jour = (
+ element text {
+ "NEEDS-ACTION" |
+ "ACCEPTED" |
+ "DECLINED"
+ }
+ )
+
+ # 3.2.13 Recurrence Identifier Range
+
+ rangeparam = element range {
+ element text {
+ "THISANDFUTURE"
+ }
+ }
+
+ # 3.2.14 Alarm Trigger Relationship
+
+ trigrelparam = element related {
+ element text {
+ "START" |
+ "END"
+ }
+ }
+
+ # 3.2.15 Relationship Type
+
+ reltypeparam = element reltype {
+ element text {
+ "PARENT" |
+ "CHILD" |
+ "SIBLING"
+ }
+ }
+
+
+
+
+
+Daboo, et al. Standards Track [Page 26]
+
+RFC 6321 xCal August 2011
+
+
+ # 3.2.16 Participation Role
+
+ roleparam = element role {
+ element text {
+ "CHAIR" |
+ "REQ-PARTICIPANT" |
+ "OPT-PARTICIPANT" |
+ "NON-PARTICIPANT"
+ }
+ }
+
+ # 3.2.17 RSVP Expectation
+
+ rsvpparam = element rsvp {
+ value-boolean
+ }
+
+ # 3.2.18 Sent By
+
+ sentbyparam = element sent-by {
+ value-cal-address
+ }
+
+ # 3.2.19 Time Zone Identifier
+
+ tzidparam = element tzid {
+ value-text
+ }
+
+ # 3.3 Property Value Data Types
+
+ # 3.3.1 BINARY
+
+ value-binary = element binary {
+ xsd:string
+ }
+
+ # 3.3.2 BOOLEAN
+
+ value-boolean = element boolean {
+ xsd:boolean
+ }
+
+ # 3.3.3 CAL-ADDRESS
+
+ value-cal-address = element cal-address {
+ xsd:anyURI
+ }
+
+
+
+Daboo, et al. Standards Track [Page 27]
+
+RFC 6321 xCal August 2011
+
+
+ # 3.3.4 DATE
+
+ pattern-date = xsd:string {
+ pattern = "\d\d\d\d-\d\d-\d\d"
+ }
+
+ value-date = element date {
+ pattern-date
+ }
+
+ # 3.3.5 DATE-TIME
+
+ pattern-date-time = xsd:string {
+ pattern = "\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\dZ?"
+ }
+
+ value-date-time = element date-time {
+ pattern-date-time
+ }
+
+ # 3.3.6 DURATION
+
+ pattern-duration = xsd:string {
+ pattern = "(+|-)?P(\d+W)|(\d+D)?"
+ ~ "(T(\d+H(\d+M)?(\d+S)?)|"
+ ~ "(\d+M(\d+S)?)|"
+ ~ "(\d+S))?"
+ }
+
+ value-duration = element duration {
+ pattern-duration
+ }
+
+ # 3.3.7 FLOAT
+
+ value-float = element float {
+ xsd:float
+ }
+
+ # 3.3.8 INTEGER
+
+ value-integer = element integer {
+ xsd:integer
+ }
+
+
+
+
+
+
+
+Daboo, et al. Standards Track [Page 28]
+
+RFC 6321 xCal August 2011
+
+
+ # 3.3.9 PERIOD
+
+ value-period = element period {
+ element start {
+ pattern-date-time
+ },
+ (
+ element end {
+ pattern-date-time
+ } |
+ element duration {
+ pattern-duration
+ }
+ )
+ }
+
+ # 3.3.10 RECUR
+
+ value-recur = element recur {
+ type-freq,
+ (type-until | type-count)?,
+ element interval {
+ xsd:positiveInteger
+ }?,
+ type-bysecond*,
+ type-byminute*,
+ type-byhour*,
+ type-byday*,
+ type-bymonthday*,
+ type-byyearday*,
+ type-byweekno*,
+ type-bymonth*,
+ type-bysetpos*,
+ element wkst { type-weekday }?
+ }
+
+ type-freq = element freq {
+ "SECONDLY" |
+ "MINUTELY" |
+ "HOURLY" |
+ "DAILY" |
+ "WEEKLY" |
+ "MONTHLY" |
+ "YEARLY"
+ }
+
+
+
+
+
+
+Daboo, et al. Standards Track [Page 29]
+
+RFC 6321 xCal August 2011
+
+
+ type-until = element until {
+ type-date |
+ type-date-time
+ }
+
+ type-count = element count {
+ xsd:positiveInteger
+ }
+
+ type-bysecond = element bysecond {
+ xsd:positiveInteger
+ }
+
+ type-byminute = element byminute {
+ xsd:positiveInteger
+ }
+
+ type-byhour = element byhour {
+ xsd:positiveInteger
+ }
+
+ type-weekday = (
+ "SU" |
+ "MO" |
+ "TU" |
+ "WE" |
+ "TH" |
+ "FR" |
+ "SA"
+ )
+
+ type-byday = element byday {
+ xsd:integer?,
+ type-weekday
+ }
+
+ type-bymonthday = element bymonthday {
+ xsd:integer
+ }
+
+ type-byyearday = element byyearday {
+ xsd:integer
+ }
+
+ type-byweekno = element byweekno {
+ xsd:integer
+ }
+
+
+
+
+Daboo, et al. Standards Track [Page 30]
+
+RFC 6321 xCal August 2011
+
+
+ type-bymonth = element bymonth {
+ xsd:positiveInteger
+ }
+
+ type-bysetpos = element bysetpos {
+ xsd:integer
+ }
+
+ # 3.3.11 TEXT
+
+ value-text = element text {
+ xsd:string
+ }
+
+ # 3.3.12 TIME
+
+ pattern-time = xsd:string {
+ pattern = "\d\d:\d\d:\d\dZ?"
+ }
+
+ value-time = element time {
+ pattern-time
+ }
+
+ # 3.3.13 URI
+
+ value-uri = element uri {
+ xsd:anyURI
+ }
+
+ # 3.3.14 UTC-OFFSET
+
+ value-utc-offset = element utc-offset {
+ xsd:string { pattern = "(+|-)\d\d:\d\d(:\d\d)?" }
+ }
+
+ # UNKNOWN
+
+ value-unknown = element unknown {
+ xsd:string
+ }
+
+ # 3.4 iCalendar Stream
+
+ start = element icalendar {
+ vcalendar+
+ }
+
+
+
+
+Daboo, et al. Standards Track [Page 31]
+
+RFC 6321 xCal August 2011
+
+
+ # 3.6 Calendar Components
+
+ vcalendar = element vcalendar {
+ type-calprops,
+ type-component
+ }
+
+ type-calprops = element properties {
+ property-prodid &
+ property-version &
+ property-calscale? &
+ property-method?
+ }
+
+ type-component = element components {
+ (
+ component-vevent |
+ component-vtodo |
+ component-vjournal |
+ component-vfreebusy |
+ component-vtimezone
+ )*
+ }
+
+ # 3.6.1 Event Component
+
+ component-vevent = element vevent {
+ type-eventprop,
+ element components {
+ component-valarm+
+ }?
+ }
+
+ type-eventprop = element properties {
+ property-dtstamp &
+ property-dtstart &
+ property-uid &
+
+ property-class? &
+ property-created? &
+ property-description? &
+ property-geo? &
+ property-last-mod? &
+ property-location? &
+ property-organizer? &
+ property-priority? &
+ property-seq? &
+ property-status-event? &
+
+
+
+Daboo, et al. Standards Track [Page 32]
+
+RFC 6321 xCal August 2011
+
+
+ property-summary? &
+ property-transp? &
+ property-url? &
+ property-recurid? &
+
+ property-rrule? &
+
+ (property-dtend | property-duration)? &
+
+ property-attach* &
+ property-attendee* &
+ property-categories* &
+ property-comment* &
+ property-contact* &
+ property-exdate* &
+ property-rstatus* &
+ property-related* &
+ property-resources* &
+ property-rdate*
+ }
+
+ # 3.6.2 To-do Component
+
+ component-vtodo = element vtodo {
+ type-todoprop,
+ element components {
+ component-valarm+
+ }?
+ }
+
+ type-todoprop = element properties {
+ property-dtstamp &
+ property-uid &
+
+ property-class? &
+ property-completed? &
+ property-created? &
+ property-description? &
+ property-geo? &
+ property-last-mod? &
+ property-location? &
+ property-organizer? &
+ property-percent? &
+ property-priority? &
+ property-recurid? &
+ property-seq? &
+ property-status-todo? &
+ property-summary? &
+
+
+
+Daboo, et al. Standards Track [Page 33]
+
+RFC 6321 xCal August 2011
+
+
+ property-url? &
+
+ property-rrule? &
+
+ (
+ (property-dtstart?, property-dtend? ) |
+ (property-dtstart, property-duration)?
+ ) &
+
+ property-attach* &
+ property-attendee* &
+ property-categories* &
+ property-comment* &
+ property-contact* &
+ property-exdate* &
+ property-rstatus* &
+ property-related* &
+ property-resources* &
+ property-rdate*
+ }
+
+ # 3.6.3 Journal Component
+
+ component-vjournal = element vjournal {
+ type-jourprop
+ }
+
+ type-jourprop = element properties {
+ property-dtstamp &
+ property-uid &
+
+ property-class? &
+ property-created? &
+ property-dtstart? &
+ property-last-mod? &
+ property-organizer? &
+ property-recurid? &
+ property-seq? &
+ property-status-jour? &
+ property-summary? &
+ property-url? &
+
+ property-rrule? &
+
+ property-attach* &
+ property-attendee* &
+ property-categories* &
+ property-comment* &
+
+
+
+Daboo, et al. Standards Track [Page 34]
+
+RFC 6321 xCal August 2011
+
+
+ property-contact* &
+ property-description? &
+ property-exdate* &
+ property-related* &
+ property-rdate* &
+ property-rstatus*
+ }
+
+ # 3.6.4 Free/Busy Component
+
+ component-vfreebusy = element vfreebusy {
+ type-fbprop
+ }
+
+ type-fbprop = element properties {
+ property-dtstamp &
+ property-uid &
+
+ property-contact? &
+ property-dtstart? &
+ property-dtend? &
+ property-duration? &
+ property-organizer? &
+ property-url? &
+
+ property-attendee* &
+ property-comment* &
+ property-freebusy* &
+ property-rstatus*
+ }
+
+ # 3.6.5 Time Zone Component
+
+ component-vtimezone = element vtimezone {
+ element properties {
+ property-tzid &
+
+ property-last-mod? &
+ property-tzuurl?
+ },
+ element components {
+ (component-standard | component-daylight) &
+ component-standard* &
+ component-daylight*
+ }
+ }
+
+
+
+
+
+Daboo, et al. Standards Track [Page 35]
+
+RFC 6321 xCal August 2011
+
+
+ component-standard = element standard {
+ type-tzprop
+ }
+
+ component-daylight = element daylight {
+ type-tzprop
+ }
+
+ type-tzprop = element properties {
+ property-dtstart &
+ property-tzoffsetto &
+ property-tzoffsetfrom &
+
+ property-rrule? &
+
+ property-comment* &
+ property-rdate* &
+ property-tzname*
+ }
+
+ # 3.6.6 Alarm Component
+
+ component-valarm = element valarm {
+ audioprop | dispprop | emailprop
+ }
+
+ type-audioprop = element properties {
+ property-action &
+
+ property-trigger &
+
+ (property-duration, property-repeat)? &
+
+ property-attach?
+ }
+
+ type-dispprop = element properties {
+ property-action &
+ property-description &
+ property-trigger &
+ property-summary &
+
+ property-attendee+ &
+
+ (property-duration, property-repeat)? &
+
+ property-attach*
+ }
+
+
+
+Daboo, et al. Standards Track [Page 36]
+
+RFC 6321 xCal August 2011
+
+
+ type-emailprop = element properties {
+ property-action &
+ property-description &
+ property-trigger &
+
+ (property-duration, property-repeat)?
+ }
+
+ # 3.7 Calendar Properties
+
+ # 3.7.1 Calendar Scale
+
+ property-calscale = element calscale {
+
+ element parameters { empty }?,
+
+ element text { "GREGORIAN" }
+ }
+
+ # 3.7.2 Method
+
+ property-method = element method {
+
+ element parameters { empty }?,
+
+ value-text
+ }
+
+ # 3.7.3 Product Identifier
+
+ property-prodid = element prodid {
+
+ element parameters { empty }?,
+
+ value-text
+ }
+
+ # 3.7.4 Version
+
+ property-version = element version {
+
+ element parameters { empty }?,
+
+ element text { "2.0" }
+ }
+
+
+
+
+
+
+Daboo, et al. Standards Track [Page 37]
+
+RFC 6321 xCal August 2011
+
+
+ # 3.8 Component Properties
+
+ # 3.8.1 Descriptive Component Properties
+
+ # 3.8.1.1 Attachment
+
+ property-attach = element attach {
+
+ element parameters {
+ fmttypeparam? &
+ encodingparam?
+ }?,
+
+ value-uri | value-binary
+ }
+
+ # 3.8.1.2 Categories
+
+ property-categories = element categories {
+
+ element parameters {
+ languageparam? &
+ }?,
+
+ value-text+
+ }
+
+ # 3.8.1.3 Classification
+
+ property-class = element class {
+
+ element parameters { empty }?,
+
+ element text {
+ "PUBLIC" |
+ "PRIVATE" |
+ "CONFIDENTIAL"
+ }
+ }
+
+ # 3.8.1.4 Comment
+
+ property-comment = element comment {
+
+ element parameters {
+ altrepparam? &
+ languageparam?
+ }?,
+
+
+
+Daboo, et al. Standards Track [Page 38]
+
+RFC 6321 xCal August 2011
+
+
+ value-text
+ }
+
+ # 3.8.1.5 Description
+
+ property-description = element description {
+
+ element parameters {
+ altrepparam? &
+ languageparam?
+ }?,
+
+ value-text
+ }
+
+ # 3.8.1.6 Geographic Position
+
+ property-geo = element geo {
+
+ element parameters { empty }?,
+
+ element latitude { xsd:float },
+ element longitude { xsd:float }
+ }
+
+ # 3.8.1.7 Location
+
+ property-location = element location {
+
+ element parameters {
+
+ altrepparam? &
+ languageparam?
+ }?,
+
+ value-text
+ }
+
+ # 3.8.1.8 Percent Complete
+
+ property-percent = element percent-complete {
+
+ element parameters { empty }?,
+
+ value-integer
+ }
+
+
+
+
+
+Daboo, et al. Standards Track [Page 39]
+
+RFC 6321 xCal August 2011
+
+
+ # 3.8.1.9 Priority
+
+ property-priority = element priority {
+
+ element parameters { empty }?,
+
+ value-integer
+ }
+
+ # 3.8.1.10 Resources
+
+ property-resources = element resources {
+
+ element parameters {
+ altrepparam? &
+ languageparam?
+ }?,
+
+ value-text+
+ }
+
+ # 3.8.1.11 Status
+
+ property-status-event = element status {
+
+ element parameters { empty }?,
+
+ element text {
+ "TENTATIVE" |
+ "CONFIRMED" |
+ "CANCELLED"
+ }
+ }
+
+ property-status-todo = element status {
+
+ element parameters { empty }?,
+
+ element text {
+ "NEEDS-ACTION" |
+ "COMPLETED" |
+ "IN-PROCESS" |
+ "CANCELLED"
+ }
+ }
+
+
+
+
+
+
+Daboo, et al. Standards Track [Page 40]
+
+RFC 6321 xCal August 2011
+
+
+ property-status-jour = element status {
+
+ element parameters { empty }?,
+
+ element text {
+ "DRAFT" |
+ "FINAL" |
+ "CANCELLED"
+ }
+ }
+
+ # 3.8.1.12 Summary
+
+ property-summary = element summary {
+
+ element parameters {
+ altrepparam? &
+ languageparam?
+ }?,
+
+ value-text
+ }
+
+ # 3.8.2 Date and Time Component Properties
+
+ # 3.8.2.1 Date/Time Completed
+
+ property-completed = element completed {
+
+ element parameters { empty }?,
+
+ value-date-time
+ }
+
+ # 3.8.2.2 Date/Time End
+
+ property-dtend = element dtend {
+
+ element parameters {
+ tzidparam?
+ }?,
+
+ value-date-time |
+ value-date
+ }
+
+
+
+
+
+
+Daboo, et al. Standards Track [Page 41]
+
+RFC 6321 xCal August 2011
+
+
+ # 3.8.2.3 Date/Time Due
+
+ property-due = element due {
+
+ element parameters {
+ tzidparam?
+ }?,
+
+ value-date-time |
+ value-date
+ }
+
+ # 3.8.2.4 Date/Time Start
+
+ property-dtstart = element dtstart {
+
+ element parameters {
+ tzidparam?
+ }?,
+
+ value-date-time |
+ value-date
+ }
+
+ # 3.8.2.5 Duration
+
+ property-duration = element duration {
+
+ element parameters { empty }?,
+
+ value-duration
+ }
+
+ # 3.8.2.6 Free/Busy Time
+
+ property-freebusy = element freebusy {
+
+ element parameters {
+ fbtypeparam?
+ }?,
+
+
+ value-period+
+ }
+
+ # 3.8.2.7 Time Transparency
+
+ property-transp = element transp {
+
+
+
+Daboo, et al. Standards Track [Page 42]
+
+RFC 6321 xCal August 2011
+
+
+ element parameters { empty }?,
+
+ element text {
+ "OPAQUE" |
+ "TRANSPARENT"
+ }
+ }
+
+ # 3.8.3 Time Zone Component Properties
+
+ # 3.8.3.1 Time Zone Identifier
+
+ property-tzid = element tzid {
+
+ element parameters { empty }?,
+
+ value-text
+ }
+
+ # 3.8.3.2 Time Zone Name
+
+ property-tzname = element tzname {
+
+ element parameters {
+ languageparam?
+ }?,
+
+ value-text
+ }
+
+ # 3.8.3.3 Time Zone Offset From
+
+ property-tzoffsetfrom = element tzoffsetfrom {
+
+ element parameters { empty }?,
+
+ value-utc-offset
+ }
+
+ # 3.8.3.4 Time Zone Offset To
+
+ property-tzoffsetto = element tzoffsetto {
+
+ element parameters { empty }?,
+
+ value-utc-offset
+ }
+
+
+
+
+Daboo, et al. Standards Track [Page 43]
+
+RFC 6321 xCal August 2011
+
+
+ # 3.8.3.5 Time Zone URL
+
+ property-tzurl = element tzurl {
+
+ element parameters { empty }?,
+
+ value-uri
+ }
+
+ # 3.8.4 Relationship Component Properties
+
+ # 3.8.4.1 Attendee
+
+ property-attendee = element attendee {
+
+ element parameters {
+ cutypeparam? &
+ memberparam? &
+ roleparam? &
+ partstatparam? &
+ rsvpparam? &
+ deltoparam? &
+ delfromparam? &
+ sentbyparam? &
+ cnparam? &
+ dirparam? &
+ languageparam?
+ }?,
+
+ value-cal-address
+ }
+
+ # 3.8.4.2 Contact
+
+ property-contact = element contact {
+
+ element parameters {
+ altrepparam? &
+ languageparam?
+ }?,
+
+ value-text
+ }
+
+ # 3.8.4.3 Organizer
+
+ property-organizer = element organizer {
+
+
+
+
+Daboo, et al. Standards Track [Page 44]
+
+RFC 6321 xCal August 2011
+
+
+ element parameters {
+ cnparam? &
+ dirparam? &
+ sentbyparam? &
+ languageparam?
+ }?,
+
+ value-cal-address
+ }
+
+ # 3.8.4.4 Recurrence ID
+
+ property-recurid = element recurrence-id {
+
+ element parameters {
+ tzidparam? &
+ rangeparam?
+ }?,
+
+ value-date-time |
+ value-date
+ }
+
+ # 3.8.4.5 Related-To
+
+ property-related = element related-to {
+
+ element parameters {
+ reltypeparam?
+ }?,
+
+ value-text
+ }
+
+ # 3.8.4.6 Uniform Resource Locator
+
+ property-url = element url {
+
+ element parameters { empty }?,
+
+ value-uri
+ }
+
+ # 3.8.4.7 Unique Identifier
+
+ property-uid = element uid {
+
+ element parameters { empty }?,
+
+
+
+Daboo, et al. Standards Track [Page 45]
+
+RFC 6321 xCal August 2011
+
+
+ value-text
+ }
+
+ # 3.8.5 Recurrence Component Properties
+
+ # 3.8.5.1 Exception Date/Times
+
+ property-exdate = element exdate {
+
+ element parameters {
+ tzidparam?
+ }?,
+
+ value-date-time+ |
+ value-date+
+ }
+
+ # 3.8.5.2 Recurrence Date/Times
+
+ property-rdate = element rdate {
+
+ element parameters {
+ tzidparam?
+ }?,
+
+ value-date-time+ |
+ value-date+ |
+ value-period+
+ }
+
+ # 3.8.5.3 Recurrence Rule
+
+ property-rrule = element rrule {
+
+ element parameters { empty }?,
+
+ value-recur
+ }
+
+ # 3.8.6 Alarm Component Properties
+
+ # 3.8.6.1 Action
+
+ property-action = element action {
+
+ element parameters { empty }?,
+
+
+
+
+
+Daboo, et al. Standards Track [Page 46]
+
+RFC 6321 xCal August 2011
+
+
+ element text {
+ "AUDIO" |
+ "DISPLAY" |
+ "EMAIL"
+ }
+ }
+
+ # 3.8.6.2 Repeat Count
+
+ property-repeat = element repeat {
+
+ element parameters { empty }?,
+
+ value-integer
+ }
+
+ # 3.8.6.3 Trigger
+
+ property-trigger = element trigger {
+
+ (
+ element parameters {
+ trigrelparam?
+ }?,
+
+ value-duration
+ ) |
+ (
+ element parameters { empty }?,
+
+ value-date-time
+ )
+ }
+
+ # 3.8.7 Change Management Component Properties
+
+ # 3.8.7.1 Date/Time Created
+
+ property-created = element created {
+
+ element parameters { empty }?,
+
+ value-date-time
+ }
+
+ # 3.8.7.2 Date/Time Stamp
+
+ property-dtstamp = element dtstamp {
+
+
+
+Daboo, et al. Standards Track [Page 47]
+
+RFC 6321 xCal August 2011
+
+
+ element parameters { empty }?,
+
+ value-date-time
+ }
+
+ # 3.8.7.3 Last Modified
+
+ property-last-mod = element last-modified {
+
+ element parameters { empty }?,
+
+ value-date-time
+ }
+
+ # 3.8.7.4 Sequence Number
+
+ property-seq = element sequence {
+
+ element parameters { empty }?,
+
+ value-integer
+ }
+
+ # 3.8.8 Miscellaneous Component Properties
+
+ # 3.8.8.3 Request Status
+
+ property-rstatus = element request-status {
+
+ element parameters {
+ languageparam?
+ }?,
+
+ element code { xsd:string },
+ element description { xsd:string },
+ element data { xsd:string }?
+ }
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Daboo, et al. Standards Track [Page 48]
+
+RFC 6321 xCal August 2011
+
+
+Appendix B. Examples
+
+ This section contains two examples of iCalendar objects with their
+ xCal representation.
+
+B.1. Example 1
+
+B.1.1. iCalendar Data
+
+ BEGIN:VCALENDAR
+ CALSCALE:GREGORIAN
+ PRODID:-//Example Inc.//Example Calendar//EN
+ VERSION:2.0
+ BEGIN:VEVENT
+ DTSTAMP:20080205T191224Z
+ DTSTART:20081006
+ SUMMARY:Planning meeting
+ UID:4088E990AD89CB3DBB484909
+ END:VEVENT
+ END:VCALENDAR
+
+B.1.2. XML Data
+
+ <?xml version="1.0" encoding="utf-8"?>
+ <icalendar xmlns="urn:ietf:params:xml:ns:icalendar-2.0">
+ <vcalendar>
+ <properties>
+ <calscale>
+ <text>GREGORIAN</text>
+ </calscale>
+ <prodid>
+ <text>-//Example Inc.//Example Calendar//EN</text>
+ </prodid>
+ <version>
+ <text>2.0</text>
+ </version>
+ </properties>
+ <components>
+ <vevent>
+ <properties>
+ <dtstamp>
+ <date-time>2008-02-05T19:12:24Z</date-time>
+ </dtstamp>
+ <dtstart>
+ <date>2008-10-06</date>
+ </dtstart>
+ <summary>
+ <text>Planning meeting</text>
+
+
+
+Daboo, et al. Standards Track [Page 49]
+
+RFC 6321 xCal August 2011
+
+
+ </summary>
+ <uid>
+ <text>4088E990AD89CB3DBB484909</text>
+ </uid>
+ </properties>
+ </vevent>
+ </components>
+ </vcalendar>
+ </icalendar>
+
+B.2. Example 2
+
+B.2.1. iCalendar Data
+
+ VERSION:2.0
+ PRODID:-//Example Corp.//Example Client//EN
+ BEGIN:VTIMEZONE
+ LAST-MODIFIED:20040110T032845Z
+ TZID:US/Eastern
+ BEGIN:DAYLIGHT
+ DTSTART:20000404T020000
+ RRULE:FREQ=YEARLY;BYDAY=1SU;BYMONTH=4
+ TZNAME:EDT
+ TZOFFSETFROM:-0500
+ TZOFFSETTO:-0400
+ END:DAYLIGHT
+ BEGIN:STANDARD
+ DTSTART:20001026T020000
+ RRULE:FREQ=YEARLY;BYDAY=-1SU;BYMONTH=10
+ TZNAME:EST
+ TZOFFSETFROM:-0400
+ TZOFFSETTO:-0500
+ END:STANDARD
+ END:VTIMEZONE
+ BEGIN:VEVENT
+ DTSTAMP:20060206T001121Z
+ DTSTART;TZID=US/Eastern:20060102T120000
+ DURATION:PT1H
+ RRULE:FREQ=DAILY;COUNT=5
+ RDATE;TZID=US/Eastern;VALUE=PERIOD:20060102T150000/PT2H
+ SUMMARY:Event #2
+ DESCRIPTION:We are having a meeting all this week at 12 pm fo
+ r one hour\, with an additional meeting on the first day 2 h
+ ours long.\nPlease bring your own lunch for the 12 pm meetin
+ gs.
+ UID:00959BC664CA650E933C892C at example.com
+ END:VEVENT
+ BEGIN:VEVENT
+
+
+
+Daboo, et al. Standards Track [Page 50]
+
+RFC 6321 xCal August 2011
+
+
+ DTSTAMP:20060206T001121Z
+ DTSTART;TZID=US/Eastern:20060104T140000
+ DURATION:PT1H
+ RECURRENCE-ID;TZID=US/Eastern:20060104T120000
+ SUMMARY:Event #2 bis
+ UID:00959BC664CA650E933C892C at example.com
+ END:VEVENT
+ END:VCALENDAR
+
+B.2.2. XML Data
+
+ <?xml version="1.0" encoding="utf-8" ?>
+ <icalendar xmlns="urn:ietf:params:xml:ns:icalendar-2.0">
+ <vcalendar>
+ <properties>
+ <prodid>
+ <text>-//Example Inc.//Example Client//EN</text>
+ </prodid>
+ <version>
+ <text>2.0</text>
+ </version>
+ </properties>
+ <components>
+ <vtimezone>
+ <properties>
+ <last-modified>
+ <date-time>2004-01-10T03:28:45Z</date-time>
+ </last-modified>
+ <tzid>US/Eastern</tzid>
+ </properties>
+ <components>
+ <daylight>
+ <properties>
+ <dtstart>
+ <date-time>2000-04-04T02:00:00</date-time>
+ </dtstart>
+ <rrule>
+ <recur>
+ <freq>YEARLY</freq>
+ <byday>1SU</byday>
+ <bymonth>4</bymonth>
+ </recur>
+ </rrule>
+ <tzname>
+ <text>EDT</text>
+ </tzname>
+ <tzoffsetfrom>
+ <utc-offset>-05:00</utc-offset>
+
+
+
+Daboo, et al. Standards Track [Page 51]
+
+RFC 6321 xCal August 2011
+
+
+ </tzoffsetfrom>
+ <tzoffsetto>
+ <utc-offset>-04:00</utc-offset>
+ </tzoffsetto>
+ </properties>
+ </daylight>
+ <standard>
+ <properties>
+ <dtstart>
+ <date-time>2000-10-26T02:00:00</date-time>
+ </dtstart>
+ <rrule>
+ <recur>
+ <freq>YEARLY</freq>
+ <byday>-1SU</byday>
+ <bymonth>10</bymonth>
+ </recur>
+ </rrule>
+ <tzname>
+ <text>EST</text>
+ </tzname>
+ <tzoffsetfrom>
+ <utc-offset>-04:00</utc-offset>
+ </tzoffsetfrom>
+ <tzoffsetto>
+ <utc-offset>-05:00</utc-offset>
+ </tzoffsetto>
+ </properties>
+ </standard>
+ </components>
+ </vtimezone>
+ <vevent>
+ <properties>
+ <dtstamp>
+ <date-time>2006-02-06T00:11:21Z</date-time>
+ </dtstamp>
+ <dtstart>
+ <parameters>
+ <tzid><text>US/Eastern</text></tzid>
+ </parameters>
+ <date-time>2006-01-02T12:00:00</date-time>
+ </dtstart>
+ <duration>
+ <duration>PT1H</duration>
+ </duration>
+ <rrule>
+ <recur>
+ <freq>DAILY</freq>
+
+
+
+Daboo, et al. Standards Track [Page 52]
+
+RFC 6321 xCal August 2011
+
+
+ <count>5</count>
+ </recur>
+ </rrule>
+ <rdate>
+ <parameters>
+ <tzid><text>US/Eastern</text></tzid>
+ </parameters>
+ <period>
+ <start>2006-01-02T15:00:00</start>
+ <duration>PT2H</duration>
+ </period>
+ </rdate>
+ <summary>
+ <text>Event #2</text>
+ </summary>
+ <description>
+ <text>We are having a meeting all this week at 12
+ pm for one hour, with an additional meeting on the first day
+ 2 hours long.
Please bring your own lunch for the 12 pm
+ meetings.</text>
+ </description>
+ <uid>
+ <text>00959BC664CA650E933C892C at example.com</text>
+ </uid>
+ </properties>
+ </vevent>
+ <vevent>
+ <properties>
+ <dtstamp>
+ <date-time>2006-02-06T00:11:21Z</date-time>
+ </dtstamp>
+ <dtstart>
+ <parameters>
+ <tzid><text>US/Eastern</text></tzid>
+ </parameters>
+ <date-time>2006-01-04T14:00:00</date-time>
+ </dtstart>
+ <duration>
+ <duration>PT1H</duration>
+ </duration>
+ <recurrence-id>
+ <parameters>
+ <tzid><text>US/Eastern</text></tzid>
+ </parameters>
+ <date-time>2006-01-04T12:00:00</date-time>
+ </recurrence-id>
+ <summary>
+ <text>Event #2 bis</text>
+
+
+
+Daboo, et al. Standards Track [Page 53]
+
+RFC 6321 xCal August 2011
+
+
+ </summary>
+ <uid>
+ <text>00959BC664CA650E933C892C at example.com</text>
+ </uid>
+ </properties>
+ </vevent>
+ </components>
+ </vcalendar>
+ </icalendar>
+
+Authors' Addresses
+
+ Cyrus Daboo
+ Apple Inc.
+ 1 Infinite Loop
+ Cupertino, CA 95014
+ USA
+
+ EMail: cyrus at daboo.name
+ URI: http://www.apple.com/
+
+
+ Mike Douglass
+ Rensselaer Polytechnic Institute
+ 110 8th Street
+ Troy, NY 12180
+ USA
+
+ EMail: douglm at rpi.edu
+ URI: http://www.rpi.edu/
+
+
+ Steven Lees
+ Microsoft Corporation
+ One Microsoft Way
+ Redmond, WA 98052
+ USA
+
+ EMail: steven.lees at microsoft.com
+ URI: http://www.microsoft.com/
+
+
+
+
+
+
+
+
+
+
+
+Daboo, et al. Standards Track [Page 54]
+
Added: CalendarServer/trunk/doc/RFC/rfc6350-vCard4.txt
===================================================================
--- CalendarServer/trunk/doc/RFC/rfc6350-vCard4.txt (rev 0)
+++ CalendarServer/trunk/doc/RFC/rfc6350-vCard4.txt 2011-09-01 15:06:35 UTC (rev 8040)
@@ -0,0 +1,4147 @@
+
+
+
+
+
+
+Internet Engineering Task Force (IETF) S. Perreault
+Request for Comments: 6350 Viagenie
+Obsoletes: 2425, 2426, 4770 August 2011
+Updates: 2739
+Category: Standards Track
+ISSN: 2070-1721
+
+
+ vCard Format Specification
+
+Abstract
+
+ This document defines the vCard data format for representing and
+ exchanging a variety of information about individuals and other
+ entities (e.g., formatted and structured name and delivery addresses,
+ email address, multiple telephone numbers, photograph, logo, audio
+ clips, etc.). This document obsoletes RFCs 2425, 2426, and 4770, and
+ updates RFC 2739.
+
+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 Section 2 of RFC 5741.
+
+ Information about the current status of this document, any errata,
+ and how to provide feedback on it may be obtained at
+ http://www.rfc-editor.org/info/rfc6350.
+
+Copyright Notice
+
+ Copyright (c) 2011 IETF Trust and the persons identified as the
+ document authors. All rights reserved.
+
+ This document is subject to BCP 78 and the IETF Trust's Legal
+ Provisions Relating to IETF Documents
+ (http://trustee.ietf.org/license-info) 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.
+
+
+
+
+Perreault Standards Track [Page 1]
+
+RFC 6350 vCard August 2011
+
+
+ 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
+ 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
+
+ 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 5
+ 2. Conventions . . . . . . . . . . . . . . . . . . . . . . . . . 5
+ 3. vCard Format Specification . . . . . . . . . . . . . . . . . . 5
+ 3.1. Charset . . . . . . . . . . . . . . . . . . . . . . . . . 5
+ 3.2. Line Delimiting and Folding . . . . . . . . . . . . . . . 5
+ 3.3. ABNF Format Definition . . . . . . . . . . . . . . . . . . 6
+ 3.4. Property Value Escaping . . . . . . . . . . . . . . . . . 9
+ 4. Property Value Data Types . . . . . . . . . . . . . . . . . . 9
+ 4.1. TEXT . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
+ 4.2. URI . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
+ 4.3. DATE, TIME, DATE-TIME, DATE-AND-OR-TIME, and TIMESTAMP . . 12
+ 4.3.1. DATE . . . . . . . . . . . . . . . . . . . . . . . . . 12
+ 4.3.2. TIME . . . . . . . . . . . . . . . . . . . . . . . . . 13
+ 4.3.3. DATE-TIME . . . . . . . . . . . . . . . . . . . . . . 13
+ 4.3.4. DATE-AND-OR-TIME . . . . . . . . . . . . . . . . . . . 14
+ 4.3.5. TIMESTAMP . . . . . . . . . . . . . . . . . . . . . . 14
+ 4.4. BOOLEAN . . . . . . . . . . . . . . . . . . . . . . . . . 14
+ 4.5. INTEGER . . . . . . . . . . . . . . . . . . . . . . . . . 15
+ 4.6. FLOAT . . . . . . . . . . . . . . . . . . . . . . . . . . 15
+ 4.7. UTC-OFFSET . . . . . . . . . . . . . . . . . . . . . . . . 15
+ 4.8. LANGUAGE-TAG . . . . . . . . . . . . . . . . . . . . . . . 16
+ 5. Property Parameters . . . . . . . . . . . . . . . . . . . . . 16
+ 5.1. LANGUAGE . . . . . . . . . . . . . . . . . . . . . . . . . 16
+ 5.2. VALUE . . . . . . . . . . . . . . . . . . . . . . . . . . 16
+ 5.3. PREF . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
+ 5.4. ALTID . . . . . . . . . . . . . . . . . . . . . . . . . . 18
+ 5.5. PID . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
+ 5.6. TYPE . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
+ 5.7. MEDIATYPE . . . . . . . . . . . . . . . . . . . . . . . . 20
+ 5.8. CALSCALE . . . . . . . . . . . . . . . . . . . . . . . . . 20
+ 5.9. SORT-AS . . . . . . . . . . . . . . . . . . . . . . . . . 21
+ 5.10. GEO . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
+ 5.11. TZ . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
+
+
+
+
+Perreault Standards Track [Page 2]
+
+RFC 6350 vCard August 2011
+
+
+ 6. vCard Properties . . . . . . . . . . . . . . . . . . . . . . . 23
+ 6.1. General Properties . . . . . . . . . . . . . . . . . . . . 23
+ 6.1.1. BEGIN . . . . . . . . . . . . . . . . . . . . . . . . 23
+ 6.1.2. END . . . . . . . . . . . . . . . . . . . . . . . . . 23
+ 6.1.3. SOURCE . . . . . . . . . . . . . . . . . . . . . . . . 24
+ 6.1.4. KIND . . . . . . . . . . . . . . . . . . . . . . . . . 25
+ 6.1.5. XML . . . . . . . . . . . . . . . . . . . . . . . . . 27
+ 6.2. Identification Properties . . . . . . . . . . . . . . . . 28
+ 6.2.1. FN . . . . . . . . . . . . . . . . . . . . . . . . . . 28
+ 6.2.2. N . . . . . . . . . . . . . . . . . . . . . . . . . . 29
+ 6.2.3. NICKNAME . . . . . . . . . . . . . . . . . . . . . . . 29
+ 6.2.4. PHOTO . . . . . . . . . . . . . . . . . . . . . . . . 30
+ 6.2.5. BDAY . . . . . . . . . . . . . . . . . . . . . . . . . 30
+ 6.2.6. ANNIVERSARY . . . . . . . . . . . . . . . . . . . . . 31
+ 6.2.7. GENDER . . . . . . . . . . . . . . . . . . . . . . . . 32
+ 6.3. Delivery Addressing Properties . . . . . . . . . . . . . . 32
+ 6.3.1. ADR . . . . . . . . . . . . . . . . . . . . . . . . . 32
+ 6.4. Communications Properties . . . . . . . . . . . . . . . . 34
+ 6.4.1. TEL . . . . . . . . . . . . . . . . . . . . . . . . . 34
+ 6.4.2. EMAIL . . . . . . . . . . . . . . . . . . . . . . . . 36
+ 6.4.3. IMPP . . . . . . . . . . . . . . . . . . . . . . . . . 36
+ 6.4.4. LANG . . . . . . . . . . . . . . . . . . . . . . . . . 37
+ 6.5. Geographical Properties . . . . . . . . . . . . . . . . . 37
+ 6.5.1. TZ . . . . . . . . . . . . . . . . . . . . . . . . . . 37
+ 6.5.2. GEO . . . . . . . . . . . . . . . . . . . . . . . . . 38
+ 6.6. Organizational Properties . . . . . . . . . . . . . . . . 39
+ 6.6.1. TITLE . . . . . . . . . . . . . . . . . . . . . . . . 39
+ 6.6.2. ROLE . . . . . . . . . . . . . . . . . . . . . . . . . 39
+ 6.6.3. LOGO . . . . . . . . . . . . . . . . . . . . . . . . . 40
+ 6.6.4. ORG . . . . . . . . . . . . . . . . . . . . . . . . . 40
+ 6.6.5. MEMBER . . . . . . . . . . . . . . . . . . . . . . . . 41
+ 6.6.6. RELATED . . . . . . . . . . . . . . . . . . . . . . . 42
+ 6.7. Explanatory Properties . . . . . . . . . . . . . . . . . . 43
+ 6.7.1. CATEGORIES . . . . . . . . . . . . . . . . . . . . . . 43
+ 6.7.2. NOTE . . . . . . . . . . . . . . . . . . . . . . . . . 44
+ 6.7.3. PRODID . . . . . . . . . . . . . . . . . . . . . . . . 44
+ 6.7.4. REV . . . . . . . . . . . . . . . . . . . . . . . . . 45
+ 6.7.5. SOUND . . . . . . . . . . . . . . . . . . . . . . . . 45
+ 6.7.6. UID . . . . . . . . . . . . . . . . . . . . . . . . . 46
+ 6.7.7. CLIENTPIDMAP . . . . . . . . . . . . . . . . . . . . . 47
+ 6.7.8. URL . . . . . . . . . . . . . . . . . . . . . . . . . 47
+ 6.7.9. VERSION . . . . . . . . . . . . . . . . . . . . . . . 48
+ 6.8. Security Properties . . . . . . . . . . . . . . . . . . . 48
+ 6.8.1. KEY . . . . . . . . . . . . . . . . . . . . . . . . . 48
+ 6.9. Calendar Properties . . . . . . . . . . . . . . . . . . . 49
+ 6.9.1. FBURL . . . . . . . . . . . . . . . . . . . . . . . . 49
+ 6.9.2. CALADRURI . . . . . . . . . . . . . . . . . . . . . . 50
+ 6.9.3. CALURI . . . . . . . . . . . . . . . . . . . . . . . . 50
+
+
+
+Perreault Standards Track [Page 3]
+
+RFC 6350 vCard August 2011
+
+
+ 6.10. Extended Properties and Parameters . . . . . . . . . . . . 51
+ 7. Synchronization . . . . . . . . . . . . . . . . . . . . . . . 51
+ 7.1. Mechanisms . . . . . . . . . . . . . . . . . . . . . . . . 51
+ 7.1.1. Matching vCard Instances . . . . . . . . . . . . . . . 51
+ 7.1.2. Matching Property Instances . . . . . . . . . . . . . 52
+ 7.1.3. PID Matching . . . . . . . . . . . . . . . . . . . . . 52
+ 7.2. Example . . . . . . . . . . . . . . . . . . . . . . . . . 53
+ 7.2.1. Creation . . . . . . . . . . . . . . . . . . . . . . . 53
+ 7.2.2. Initial Sharing . . . . . . . . . . . . . . . . . . . 53
+ 7.2.3. Adding and Sharing a Property . . . . . . . . . . . . 54
+ 7.2.4. Simultaneous Editing . . . . . . . . . . . . . . . . . 54
+ 7.2.5. Global Context Simplification . . . . . . . . . . . . 56
+ 8. Example: Author's vCard . . . . . . . . . . . . . . . . . . . 56
+ 9. Security Considerations . . . . . . . . . . . . . . . . . . . 57
+ 10. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 58
+ 10.1. Media Type Registration . . . . . . . . . . . . . . . . . 58
+ 10.2. Registering New vCard Elements . . . . . . . . . . . . . . 59
+ 10.2.1. Registration Procedure . . . . . . . . . . . . . . . . 59
+ 10.2.2. Vendor Namespace . . . . . . . . . . . . . . . . . . . 60
+ 10.2.3. Registration Template for Properties . . . . . . . . . 61
+ 10.2.4. Registration Template for Parameters . . . . . . . . . 61
+ 10.2.5. Registration Template for Value Data Types . . . . . . 62
+ 10.2.6. Registration Template for Values . . . . . . . . . . . 62
+ 10.3. Initial vCard Elements Registries . . . . . . . . . . . . 63
+ 10.3.1. Properties Registry . . . . . . . . . . . . . . . . . 64
+ 10.3.2. Parameters Registry . . . . . . . . . . . . . . . . . 65
+ 10.3.3. Value Data Types Registry . . . . . . . . . . . . . . 65
+ 10.3.4. Values Registries . . . . . . . . . . . . . . . . . . 66
+ 11. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 69
+ 12. References . . . . . . . . . . . . . . . . . . . . . . . . . . 69
+ 12.1. Normative References . . . . . . . . . . . . . . . . . . . 69
+ 12.2. Informative References . . . . . . . . . . . . . . . . . . 71
+ Appendix A. Differences from RFCs 2425 and 2426 . . . . . . . . . 73
+ A.1. New Structure . . . . . . . . . . . . . . . . . . . . . . 73
+ A.2. Removed Features . . . . . . . . . . . . . . . . . . . . . 73
+ A.3. New Properties and Parameters . . . . . . . . . . . . . . 73
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Perreault Standards Track [Page 4]
+
+RFC 6350 vCard August 2011
+
+
+1. Introduction
+
+ Electronic address books have become ubiquitous. Their increased
+ presence on portable, connected devices as well as the diversity of
+ platforms that exchange contact data call for a standard. This memo
+ defines the vCard format, which allows the capture and exchange of
+ information normally stored within an address book or directory
+ application.
+
+ A high-level overview of the differences from RFCs 2425 and 2426 can
+ be found in Appendix A.
+
+2. Conventions
+
+ The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
+ "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
+ "OPTIONAL" in this document are to be interpreted as described in
+ [RFC2119].
+
+3. vCard Format Specification
+
+ The text/vcard MIME content type (hereafter known as "vCard"; see
+ Section 10.1) contains contact information, typically pertaining to a
+ single contact or group of contacts. The content consists of one or
+ more lines in the format given below.
+
+3.1. Charset
+
+ The charset (see [RFC3536] for internationalization terminology) for
+ vCard is UTF-8 as defined in [RFC3629]. There is no way to override
+ this. It is invalid to specify a value other than "UTF-8" in the
+ "charset" MIME parameter (see Section 10.1).
+
+3.2. Line Delimiting and Folding
+
+ Individual lines within vCard are delimited by the [RFC5322] line
+ break, which is a CRLF sequence (U+000D followed by U+000A). Long
+ logical lines of text can be split into a multiple-physical-line
+ representation using the following folding technique. Content lines
+ SHOULD be folded to a maximum width of 75 octets, excluding the line
+ break. Multi-octet characters MUST remain contiguous. The rationale
+ for this folding process can be found in [RFC5322], Section 2.1.1.
+
+ A logical line MAY be continued on the next physical line anywhere
+ between two characters by inserting a CRLF immediately followed by a
+ single white space character (space (U+0020) or horizontal tab
+ (U+0009)). The folded line MUST contain at least one character. Any
+ sequence of CRLF followed immediately by a single white space
+
+
+
+Perreault Standards Track [Page 5]
+
+RFC 6350 vCard August 2011
+
+
+ character is ignored (removed) when processing the content type. For
+ example, the line:
+
+ NOTE:This is a long description that exists on a long line.
+
+ can be represented as:
+
+ NOTE:This is a long description
+ that exists on a long line.
+
+ It could also be represented as:
+
+ NOTE:This is a long descrip
+ tion that exists o
+ n a long line.
+
+ The process of moving from this folded multiple-line representation
+ of a property definition to its single-line representation is called
+ unfolding. Unfolding is accomplished by regarding CRLF immediately
+ followed by a white space character (namely, HTAB (U+0009) or SPACE
+ (U+0020)) as equivalent to no characters at all (i.e., the CRLF and
+ single white space character are removed).
+
+ Note: It is possible for very simple implementations to generate
+ improperly folded lines in the middle of a UTF-8 multi-octet
+ sequence. For this reason, implementations SHOULD unfold lines in
+ such a way as to properly restore the original sequence.
+
+ Note: Unfolding is done differently than in [RFC5322]. Unfolding
+ in [RFC5322] only removes the CRLF, not the space following it.
+
+ Folding is done after any content encoding of a type value.
+ Unfolding is done before any decoding of a type value in a content
+ line.
+
+3.3. ABNF Format Definition
+
+ The following ABNF uses the notation of [RFC5234], which also defines
+ CRLF, WSP, DQUOTE, VCHAR, ALPHA, and DIGIT.
+
+ vcard-entity = 1*vcard
+
+ vcard = "BEGIN:VCARD" CRLF
+ "VERSION:4.0" CRLF
+ 1*contentline
+ "END:VCARD" CRLF
+ ; A vCard object MUST include the VERSION and FN properties.
+ ; VERSION MUST come immediately after BEGIN:VCARD.
+
+
+
+Perreault Standards Track [Page 6]
+
+RFC 6350 vCard August 2011
+
+
+ contentline = [group "."] name *(";" param) ":" value CRLF
+ ; When parsing a content line, folded lines must first
+ ; be unfolded according to the unfolding procedure
+ ; described in Section 3.2.
+ ; When generating a content line, lines longer than 75
+ ; characters SHOULD be folded according to the folding
+ ; procedure described in Section 3.2.
+
+ group = 1*(ALPHA / DIGIT / "-")
+ name = "SOURCE" / "KIND" / "FN" / "N" / "NICKNAME"
+ / "PHOTO" / "BDAY" / "ANNIVERSARY" / "GENDER" / "ADR" / "TEL"
+ / "EMAIL" / "IMPP" / "LANG" / "TZ" / "GEO" / "TITLE" / "ROLE"
+ / "LOGO" / "ORG" / "MEMBER" / "RELATED" / "CATEGORIES"
+ / "NOTE" / "PRODID" / "REV" / "SOUND" / "UID" / "CLIENTPIDMAP"
+ / "URL" / "KEY" / "FBURL" / "CALADRURI" / "CALURI" / "XML"
+ / iana-token / x-name
+ ; Parsing of the param and value is based on the "name" as
+ ; defined in ABNF sections below.
+ ; Group and name are case-insensitive.
+
+ iana-token = 1*(ALPHA / DIGIT / "-")
+ ; identifier registered with IANA
+
+ x-name = "x-" 1*(ALPHA / DIGIT / "-")
+ ; Names that begin with "x-" or "X-" are
+ ; reserved for experimental use, not intended for released
+ ; products, or for use in bilateral agreements.
+
+ param = language-param / value-param / pref-param / pid-param
+ / type-param / geo-parameter / tz-parameter / sort-as-param
+ / calscale-param / any-param
+ ; Allowed parameters depend on property name.
+
+ param-value = *SAFE-CHAR / DQUOTE *QSAFE-CHAR DQUOTE
+
+ any-param = (iana-token / x-name) "=" param-value *("," param-value)
+
+ NON-ASCII = UTF8-2 / UTF8-3 / UTF8-4
+ ; UTF8-{2,3,4} are defined in [RFC3629]
+
+ QSAFE-CHAR = WSP / "!" / %x23-7E / NON-ASCII
+ ; Any character except CTLs, DQUOTE
+
+ SAFE-CHAR = WSP / "!" / %x23-39 / %x3C-7E / NON-ASCII
+ ; Any character except CTLs, DQUOTE, ";", ":"
+
+ VALUE-CHAR = WSP / VCHAR / NON-ASCII
+ ; Any textual character
+
+
+
+Perreault Standards Track [Page 7]
+
+RFC 6350 vCard August 2011
+
+
+ A line that begins with a white space character is a continuation of
+ the previous line, as described in Section 3.2. The white space
+ character and immediately preceeding CRLF should be discarded when
+ reconstructing the original line. Note that this line-folding
+ convention differs from that found in [RFC5322], in that the sequence
+ <CRLF><WSP> found anywhere in the content indicates a continued line
+ and should be removed.
+
+ Property names and parameter names are case-insensitive (e.g., the
+ property name "fn" is the same as "FN" and "Fn"). Parameter values
+ MAY be case-sensitive or case-insensitive, depending on their
+ definition. Parameter values that are not explicitly defined as
+ being case-sensitive are case-insensitive. Based on experience with
+ vCard 3 interoperability, it is RECOMMENDED that property and
+ parameter names be upper-case on output.
+
+ The group construct is used to group related properties together.
+ The group name is a syntactic convention used to indicate that all
+ property names prefaced with the same group name SHOULD be grouped
+ together when displayed by an application. It has no other
+ significance. Implementations that do not understand or support
+ grouping MAY simply strip off any text before a "." to the left of
+ the type name and present the types and values as normal.
+
+ Property cardinalities are indicated using the following notation,
+ which is based on ABNF (see [RFC5234], Section 3.6):
+
+ +-------------+--------------------------------------------------+
+ | Cardinality | Meaning |
+ +-------------+--------------------------------------------------+
+ | 1 | Exactly one instance per vCard MUST be present. |
+ | *1 | Exactly one instance per vCard MAY be present. |
+ | 1* | One or more instances per vCard MUST be present. |
+ | * | One or more instances per vCard MAY be present. |
+ +-------------+--------------------------------------------------+
+
+ Properties defined in a vCard instance may have multiple values
+ depending on the property cardinality. The general rule for encoding
+ multi-valued properties is to simply create a new content line for
+ each value (including the property name). However, it should be
+ noted that some value types support encoding multiple values in a
+ single content line by separating the values with a comma ",". This
+ approach has been taken for several of the content types defined
+ below (date, time, integer, float).
+
+
+
+
+
+
+
+Perreault Standards Track [Page 8]
+
+RFC 6350 vCard August 2011
+
+
+3.4. Property Value Escaping
+
+ Some properties may contain one or more values delimited by a COMMA
+ character (U+002C). Therefore, a COMMA character in a value MUST be
+ escaped with a BACKSLASH character (U+005C), even for properties that
+ don't allow multiple instances (for consistency).
+
+ Some properties (e.g., N and ADR) comprise multiple fields delimited
+ by a SEMICOLON character (U+003B). Therefore, a SEMICOLON in a field
+ of such a "compound" property MUST be escaped with a BACKSLASH
+ character. SEMICOLON characters in non-compound properties MAY be
+ escaped. On input, an escaped SEMICOLON character is never a field
+ separator. An unescaped SEMICOLON character may be a field
+ separator, depending on the property in which it appears.
+
+ Furthermore, some fields of compound properties may contain a list of
+ values delimited by a COMMA character. Therefore, a COMMA character
+ in one of a field's values MUST be escaped with a BACKSLASH
+ character, even for fields that don't allow multiple values (for
+ consistency). Compound properties allowing multiple instances MUST
+ NOT be encoded in a single content line.
+
+ Finally, BACKSLASH characters in values MUST be escaped with a
+ BACKSLASH character. NEWLINE (U+000A) characters in values MUST be
+ encoded by two characters: a BACKSLASH followed by either an 'n'
+ (U+006E) or an 'N' (U+004E).
+
+ In all other cases, escaping MUST NOT be used.
+
+4. Property Value Data Types
+
+ Standard value types are defined below.
+
+ value = text
+ / text-list
+ / date-list
+ / time-list
+ / date-time-list
+ / date-and-or-time-list
+ / timestamp-list
+ / boolean
+ / integer-list
+ / float-list
+ / URI ; from Section 3 of [RFC3986]
+ / utc-offset
+ / Language-Tag
+ / iana-valuespec
+ ; Actual value type depends on property name and VALUE parameter.
+
+
+
+Perreault Standards Track [Page 9]
+
+RFC 6350 vCard August 2011
+
+
+ text = *TEXT-CHAR
+
+ TEXT-CHAR = "\\" / "\," / "\n" / WSP / NON-ASCII
+ / %x21-2B / %x2D-5B / %x5D-7E
+ ; Backslashes, commas, and newlines must be encoded.
+
+ component = "\\" / "\," / "\;" / "\n" / WSP / NON-ASCII
+ / %x21-2B / %x2D-3A / %x3C-5B / %x5D-7E
+ list-component = component *("," component)
+
+ text-list = text *("," text)
+ date-list = date *("," date)
+ time-list = time *("," time)
+ date-time-list = date-time *("," date-time)
+ date-and-or-time-list = date-and-or-time *("," date-and-or-time)
+ timestamp-list = timestamp *("," timestamp)
+ integer-list = integer *("," integer)
+ float-list = float *("," float)
+
+ boolean = "TRUE" / "FALSE"
+ integer = [sign] 1*DIGIT
+ float = [sign] 1*DIGIT ["." 1*DIGIT]
+
+ sign = "+" / "-"
+
+ year = 4DIGIT ; 0000-9999
+ month = 2DIGIT ; 01-12
+ day = 2DIGIT ; 01-28/29/30/31 depending on month and leap year
+ hour = 2DIGIT ; 00-23
+ minute = 2DIGIT ; 00-59
+ second = 2DIGIT ; 00-58/59/60 depending on leap second
+ zone = utc-designator / utc-offset
+ utc-designator = %x5A ; uppercase "Z"
+
+ date = year [month day]
+ / year "-" month
+ / "--" month [day]
+ / "--" "-" day
+ date-noreduc = year month day
+ / "--" month day
+ / "--" "-" day
+ date-complete = year month day
+
+ time = hour [minute [second]] [zone]
+ / "-" minute [second] [zone]
+ / "-" "-" second [zone]
+ time-notrunc = hour [minute [second]] [zone]
+ time-complete = hour minute second [zone]
+
+
+
+Perreault Standards Track [Page 10]
+
+RFC 6350 vCard August 2011
+
+
+ time-designator = %x54 ; uppercase "T"
+ date-time = date-noreduc time-designator time-notrunc
+ timestamp = date-complete time-designator time-complete
+
+ date-and-or-time = date-time / date / time-designator time
+
+ utc-offset = sign hour [minute]
+
+ Language-Tag = <Language-Tag, defined in [RFC5646], Section 2.1>
+
+ iana-valuespec = <value-spec, see Section 12>
+ ; a publicly defined valuetype format, registered
+ ; with IANA, as defined in Section 12 of this
+ ; document.
+
+4.1. TEXT
+
+ "text": The "text" value type should be used to identify values that
+ contain human-readable text. As for the language, it is controlled
+ by the LANGUAGE property parameter defined in Section 5.1.
+
+ Examples for "text":
+
+ this is a text value
+ this is one value,this is another
+ this is a single value\, with a comma encoded
+
+ A formatted text line break in a text value type MUST be represented
+ as the character sequence backslash (U+005C) followed by a Latin
+ small letter n (U+006E) or a Latin capital letter N (U+004E), that
+ is, "\n" or "\N".
+
+ For example, a multiple line NOTE value of:
+
+ Mythical Manager
+ Hyjinx Software Division
+ BabsCo, Inc.
+
+ could be represented as:
+
+ NOTE:Mythical Manager\nHyjinx Software Division\n
+ BabsCo\, Inc.\n
+
+ demonstrating the \n literal formatted line break technique, the
+ CRLF-followed-by-space line folding technique, and the backslash
+ escape technique.
+
+
+
+
+
+Perreault Standards Track [Page 11]
+
+RFC 6350 vCard August 2011
+
+
+4.2. URI
+
+ "uri": The "uri" value type should be used to identify values that
+ are referenced by a Uniform Resource Identifier (URI) instead of
+ encoded in-line. These value references might be used if the value
+ is too large, or otherwise undesirable to include directly. The
+ format for the URI is as defined in Section 3 of [RFC3986]. Note
+ that the value of a property of type "uri" is what the URI points to,
+ not the URI itself.
+
+ Examples for "uri":
+
+ http://www.example.com/my/picture.jpg
+ ldap://ldap.example.com/cn=babs%20jensen
+
+4.3. DATE, TIME, DATE-TIME, DATE-AND-OR-TIME, and TIMESTAMP
+
+ "date", "time", "date-time", "date-and-or-time", and "timestamp":
+ Each of these value types is based on the definitions in
+ [ISO.8601.2004]. Multiple such values can be specified using the
+ comma-separated notation.
+
+ Only the basic format is supported.
+
+4.3.1. DATE
+
+ A calendar date as specified in [ISO.8601.2004], Section 4.1.2.
+
+ Reduced accuracy, as specified in [ISO.8601.2004], Sections 4.1.2.3
+ a) and b), but not c), is permitted.
+
+ Expanded representation, as specified in [ISO.8601.2004], Section
+ 4.1.4, is forbidden.
+
+ Truncated representation, as specified in [ISO.8601.2000], Sections
+ 5.2.1.3 d), e), and f), is permitted.
+
+ Examples for "date":
+
+ 19850412
+ 1985-04
+ 1985
+ --0412
+ ---12
+
+
+
+
+
+
+
+Perreault Standards Track [Page 12]
+
+RFC 6350 vCard August 2011
+
+
+ Note the use of YYYY-MM in the second example above. YYYYMM is
+ disallowed to prevent confusion with YYMMDD. Note also that
+ YYYY-MM-DD is disallowed since we are using the basic format instead
+ of the extended format.
+
+4.3.2. TIME
+
+ A time of day as specified in [ISO.8601.2004], Section 4.2.
+
+ Reduced accuracy, as specified in [ISO.8601.2004], Section 4.2.2.3,
+ is permitted.
+
+ Representation with decimal fraction, as specified in
+ [ISO.8601.2004], Section 4.2.2.4, is forbidden.
+
+ The midnight hour is always represented by 00, never 24 (see
+ [ISO.8601.2004], Section 4.2.3).
+
+ Truncated representation, as specified in [ISO.8601.2000], Sections
+ 5.3.1.4 a), b), and c), is permitted.
+
+ Examples for "time":
+
+ 102200
+ 1022
+ 10
+ -2200
+ --00
+ 102200Z
+ 102200-0800
+
+4.3.3. DATE-TIME
+
+ A date and time of day combination as specified in [ISO.8601.2004],
+ Section 4.3.
+
+ Truncation of the date part, as specified in [ISO.8601.2000], Section
+ 5.4.2 c), is permitted.
+
+ Examples for "date-time":
+
+ 19961022T140000
+ --1022T1400
+ ---22T14
+
+
+
+
+
+
+
+Perreault Standards Track [Page 13]
+
+RFC 6350 vCard August 2011
+
+
+4.3.4. DATE-AND-OR-TIME
+
+ Either a DATE-TIME, a DATE, or a TIME value. To allow unambiguous
+ interpretation, a stand-alone TIME value is always preceded by a "T".
+
+ Examples for "date-and-or-time":
+
+ 19961022T140000
+ --1022T1400
+ ---22T14
+ 19850412
+ 1985-04
+ 1985
+ --0412
+ ---12
+ T102200
+ T1022
+ T10
+ T-2200
+ T--00
+ T102200Z
+ T102200-0800
+
+4.3.5. TIMESTAMP
+
+ A complete date and time of day combination as specified in
+ [ISO.8601.2004], Section 4.3.2.
+
+ Examples for "timestamp":
+
+ 19961022T140000
+ 19961022T140000Z
+ 19961022T140000-05
+ 19961022T140000-0500
+
+4.4. BOOLEAN
+
+ "boolean": The "boolean" value type is used to express boolean
+ values. These values are case-insensitive.
+
+ Examples:
+
+ TRUE
+ false
+ True
+
+
+
+
+
+
+Perreault Standards Track [Page 14]
+
+RFC 6350 vCard August 2011
+
+
+4.5. INTEGER
+
+ "integer": The "integer" value type is used to express signed
+ integers in decimal format. If sign is not specified, the value is
+ assumed positive "+". Multiple "integer" values can be specified
+ using the comma-separated notation. The maximum value is
+ 9223372036854775807, and the minimum value is -9223372036854775808.
+ These limits correspond to a signed 64-bit integer using two's-
+ complement arithmetic.
+
+ Examples:
+
+ 1234567890
+ -1234556790
+ +1234556790,432109876
+
+4.6. FLOAT
+
+ "float": The "float" value type is used to express real numbers. If
+ sign is not specified, the value is assumed positive "+". Multiple
+ "float" values can be specified using the comma-separated notation.
+ Implementations MUST support a precision equal or better than that of
+ the IEEE "binary64" format [IEEE.754.2008].
+
+ Note: Scientific notation is disallowed. Implementers wishing to
+ use their favorite language's %f formatting should be careful.
+
+ Examples:
+
+ 20.30
+ 1000000.0000001
+ 1.333,3.14
+
+4.7. UTC-OFFSET
+
+ "utc-offset": The "utc-offset" value type specifies that the property
+ value is a signed offset from UTC. This value type can be specified
+ in the TZ property.
+
+ The value type is an offset from Coordinated Universal Time (UTC).
+ It is specified as a positive or negative difference in units of
+ hours and minutes (e.g., +hhmm). The time is specified as a 24-hour
+ clock. Hour values are from 00 to 23, and minute values are from 00
+ to 59. Hour and minutes are 2 digits with high-order zeroes required
+ to maintain digit count. The basic format for ISO 8601 UTC offsets
+ MUST be used.
+
+
+
+
+
+Perreault Standards Track [Page 15]
+
+RFC 6350 vCard August 2011
+
+
+4.8. LANGUAGE-TAG
+
+ "language-tag": A single language tag, as defined in [RFC5646].
+
+5. Property Parameters
+
+ A property can have attributes associated with it. These "property
+ parameters" contain meta-information about the property or the
+ property value. In some cases, the property parameter can be multi-
+ valued in which case the property parameter value elements are
+ separated by a COMMA (U+002C).
+
+ Property parameter value elements that contain the COLON (U+003A),
+ SEMICOLON (U+003B), or COMMA (U+002C) character separators MUST be
+ specified as quoted-string text values. Property parameter values
+ MUST NOT contain the DQUOTE (U+0022) character. The DQUOTE character
+ is used as a delimiter for parameter values that contain restricted
+ characters or URI text.
+
+ Applications MUST ignore x-param and iana-param values they don't
+ recognize.
+
+5.1. LANGUAGE
+
+ The LANGUAGE property parameter is used to identify data in multiple
+ languages. There is no concept of "default" language, except as
+ specified by any "Content-Language" MIME header parameter that is
+ present [RFC3282]. The value of the LANGUAGE property parameter is a
+ language tag as defined in Section 2 of [RFC5646].
+
+ Examples:
+
+ ROLE;LANGUAGE=tr:hoca
+
+ ABNF:
+
+ language-param = "LANGUAGE=" Language-Tag
+ ; Language-Tag is defined in section 2.1 of RFC 5646
+
+5.2. VALUE
+
+ The VALUE parameter is OPTIONAL, used to identify the value type
+ (data type) and format of the value. The use of these predefined
+ formats is encouraged even if the value parameter is not explicitly
+ used. By defining a standard set of value types and their formats,
+ existing parsing and processing code can be leveraged. The
+
+
+
+
+
+Perreault Standards Track [Page 16]
+
+RFC 6350 vCard August 2011
+
+
+ predefined data type values MUST NOT be repeated in COMMA-separated
+ value lists except within the N, NICKNAME, ADR, and CATEGORIES
+ properties.
+
+ ABNF:
+
+ value-param = "VALUE=" value-type
+
+ value-type = "text"
+ / "uri"
+ / "date"
+ / "time"
+ / "date-time"
+ / "date-and-or-time"
+ / "timestamp"
+ / "boolean"
+ / "integer"
+ / "float"
+ / "utc-offset"
+ / "language-tag"
+ / iana-token ; registered as described in section 12
+ / x-name
+
+5.3. PREF
+
+ The PREF parameter is OPTIONAL and is used to indicate that the
+ corresponding instance of a property is preferred by the vCard
+ author. Its value MUST be an integer between 1 and 100 that
+ quantifies the level of preference. Lower values correspond to a
+ higher level of preference, with 1 being most preferred.
+
+ When the parameter is absent, the default MUST be to interpret the
+ property instance as being least preferred.
+
+ Note that the value of this parameter is to be interpreted only in
+ relation to values assigned to other instances of the same property
+ in the same vCard. A given value, or the absence of a value, MUST
+ NOT be interpreted on its own.
+
+ This parameter MAY be applied to any property that allows multiple
+ instances.
+
+ ABNF:
+
+ pref-param = "PREF=" (1*2DIGIT / "100")
+ ; An integer between 1 and 100.
+
+
+
+
+
+Perreault Standards Track [Page 17]
+
+RFC 6350 vCard August 2011
+
+
+5.4. ALTID
+
+ The ALTID parameter is used to "tag" property instances as being
+ alternative representations of the same logical property. For
+ example, translations of a property in multiple languages generates
+ multiple property instances having different LANGUAGE (Section 5.1)
+ parameter that are tagged with the same ALTID value.
+
+ This parameter's value is treated as an opaque string. Its sole
+ purpose is to be compared for equality against other ALTID parameter
+ values.
+
+ Two property instances are considered alternative representations of
+ the same logical property if and only if their names as well as the
+ value of their ALTID parameters are identical. Property instances
+ without the ALTID parameter MUST NOT be considered an alternative
+ representation of any other property instance. Values for the ALTID
+ parameter are not globally unique: they MAY be reused for different
+ property names.
+
+ Property instances having the same ALTID parameter value count as 1
+ toward cardinality. Therefore, since N (Section 6.2.2) has
+ cardinality *1 and TITLE (Section 6.6.1) has cardinality *, these
+ three examples would be legal:
+
+ N;ALTID=1;LANGUAGE=jp:<U+5C71><U+7530>;<U+592A><U+90CE>;;;
+ N;ALTID=1;LANGUAGE=en:Yamada;Taro;;;
+ (<U+XXXX> denotes a UTF8-encoded Unicode character.)
+
+ TITLE;ALTID=1;LANGUAGE=fr:Patron
+ TITLE;ALTID=1;LANGUAGE=en:Boss
+
+ TITLE;ALTID=1;LANGUAGE=fr:Patron
+ TITLE;ALTID=1;LANGUAGE=en:Boss
+ TITLE;ALTID=2;LANGUAGE=en:Chief vCard Evangelist
+
+ while this one would not:
+
+ N;ALTID=1;LANGUAGE=jp:<U+5C71><U+7530>;<U+592A><U+90CE>;;;
+ N:Yamada;Taro;;;
+ (Two instances of the N property.)
+
+ and these three would be legal but questionable:
+
+ TITLE;ALTID=1;LANGUAGE=fr:Patron
+ TITLE;ALTID=2;LANGUAGE=en:Boss
+ (Should probably have the same ALTID value.)
+
+
+
+
+Perreault Standards Track [Page 18]
+
+RFC 6350 vCard August 2011
+
+
+ TITLE;ALTID=1;LANGUAGE=fr:Patron
+ TITLE:LANGUAGE=en:Boss
+ (Second line should probably have ALTID=1.)
+
+ N;ALTID=1;LANGUAGE=jp:<U+5C71><U+7530>;<U+592A><U+90CE>;;;
+ N;ALTID=1;LANGUAGE=en:Yamada;Taro;;;
+ N;ALTID=1;LANGUAGE=en:Smith;John;;;
+ (The last line should probably have ALTID=2. But that would be
+ illegal because N has cardinality *1.)
+
+ The ALTID property MAY also be used in may contexts other than with
+ the LANGUAGE parameter. Here's an example with two representations
+ of the same photo in different file formats:
+
+ PHOTO;ALTID=1:data:image/jpeg;base64,...
+ PHOTO;ALTID=1;data:image/jp2;base64,...
+
+ ABNF:
+
+ altid-param = "ALTID=" param-value
+
+5.5. PID
+
+ The PID parameter is used to identify a specific property among
+ multiple instances. It plays a role analogous to the UID property
+ (Section 6.7.6) on a per-property instead of per-vCard basis. It MAY
+ appear more than once in a given property. It MUST NOT appear on
+ properties that may have only one instance per vCard. Its value is
+ either a single small positive integer or a pair of small positive
+ integers separated by a dot. Multiple values may be encoded in a
+ single PID parameter by separating the values with a comma ",". See
+ Section 7 for more details on its usage.
+
+ ABNF:
+
+ pid-param = "PID=" pid-value *("," pid-value)
+ pid-value = 1*DIGIT ["." 1*DIGIT]
+
+5.6. TYPE
+
+ The TYPE parameter has multiple, different uses. In general, it is a
+ way of specifying class characteristics of the associated property.
+ Most of the time, its value is a comma-separated subset of a
+ predefined enumeration. In this document, the following properties
+ make use of this parameter: FN, NICKNAME, PHOTO, ADR, TEL, EMAIL,
+ IMPP, LANG, TZ, GEO, TITLE, ROLE, LOGO, ORG, RELATED, CATEGORIES,
+
+
+
+
+
+Perreault Standards Track [Page 19]
+
+RFC 6350 vCard August 2011
+
+
+ NOTE, SOUND, URL, KEY, FBURL, CALADRURI, and CALURI. The TYPE
+ parameter MUST NOT be applied on other properties defined in this
+ document.
+
+ The "work" and "home" values act like tags. The "work" value implies
+ that the property is related to an individual's work place, while the
+ "home" value implies that the property is related to an individual's
+ personal life. When neither "work" nor "home" is present, it is
+ implied that the property is related to both an individual's work
+ place and personal life in the case that the KIND property's value is
+ "individual", or to none in other cases.
+
+ ABNF:
+
+ type-param = "TYPE=" type-value *("," type-value)
+
+ type-value = "work" / "home" / type-param-tel
+ / type-param-related / iana-token / x-name
+ ; This is further defined in individual property sections.
+
+5.7. MEDIATYPE
+
+ The MEDIATYPE parameter is used with properties whose value is a URI.
+ Its use is OPTIONAL. It provides a hint to the vCard consumer
+ application about the media type [RFC2046] of the resource identified
+ by the URI. Some URI schemes do not need this parameter. For
+ example, the "data" scheme allows the media type to be explicitly
+ indicated as part of the URI [RFC2397]. Another scheme, "http",
+ provides the media type as part of the URI resolution process, with
+ the Content-Type HTTP header [RFC2616]. The MEDIATYPE parameter is
+ intended to be used with URI schemes that do not provide such
+ functionality (e.g., "ftp" [RFC1738]).
+
+ ABNF:
+
+ mediatype-param = "MEDIATYPE=" mediatype
+ mediatype = type-name "/" subtype-name *( ";" attribute "=" value )
+ ; "attribute" and "value" are from [RFC2045]
+ ; "type-name" and "subtype-name" are from [RFC4288]
+
+5.8. CALSCALE
+
+ The CALSCALE parameter is identical to the CALSCALE property in
+ iCalendar (see [RFC5545], Section 3.7.1). It is used to define the
+ calendar system in which a date or date-time value is expressed. The
+ only value specified by iCalendar is "gregorian", which stands for
+ the Gregorian system. It is the default when the parameter is
+ absent. Additional values may be defined in extension documents and
+
+
+
+Perreault Standards Track [Page 20]
+
+RFC 6350 vCard August 2011
+
+
+ registered with IANA (see Section 10.3.4). A vCard implementation
+ MUST ignore properties with a CALSCALE parameter value that it does
+ not understand.
+
+ ABNF:
+
+ calscale-param = "CALSCALE=" calscale-value
+
+ calscale-value = "gregorian" / iana-token / x-name
+
+5.9. SORT-AS
+
+ The "sort-as" parameter is used to specify the string to be used for
+ national-language-specific sorting. Without this information,
+ sorting algorithms could incorrectly sort this vCard within a
+ sequence of sorted vCards. When this property is present in a vCard,
+ then the given strings are used for sorting the vCard.
+
+ This parameter's value is a comma-separated list that MUST have as
+ many or fewer elements as the corresponding property value has
+ components. This parameter's value is case-sensitive.
+
+ ABNF:
+
+ sort-as-param = "SORT-AS=" sort-as-value
+
+ sort-as-value = param-value *("," param-value)
+
+ Examples: For the case of surname and given name sorting, the
+ following examples define common sort string usage with the N
+ property.
+
+ FN:Rene van der Harten
+ N;SORT-AS="Harten,Rene":van der Harten;Rene,J.;Sir;R.D.O.N.
+
+ FN:Robert Pau Shou Chang
+ N;SORT-AS="Pau Shou Chang,Robert":Shou Chang;Robert,Pau;;
+
+ FN:Osamu Koura
+ N;SORT-AS="Koura,Osamu":Koura;Osamu;;
+
+ FN:Oscar del Pozo
+ N;SORT-AS="Pozo,Oscar":del Pozo Triscon;Oscar;;
+
+ FN:Chistine d'Aboville
+ N;SORT-AS="Aboville,Christine":d'Aboville;Christine;;
+
+
+
+
+
+Perreault Standards Track [Page 21]
+
+RFC 6350 vCard August 2011
+
+
+ FN:H. James de Mann
+ N;SORT-AS="Mann,James":de Mann;Henry,James;;
+
+ If sorted by surname, the results would be:
+
+ Christine d'Aboville
+ Rene van der Harten
+ Osamu Koura
+ H. James de Mann
+ Robert Pau Shou Chang
+ Oscar del Pozo
+
+ If sorted by given name, the results would be:
+
+ Christine d'Aboville
+ H. James de Mann
+ Osamu Koura
+ Oscar del Pozo
+ Rene van der Harten
+ Robert Pau Shou Chang
+
+5.10. GEO
+
+ The GEO parameter can be used to indicate global positioning
+ information that is specific to an address. Its value is the same as
+ that of the GEO property (see Section 6.5.2).
+
+ ABNF:
+
+ geo-parameter = "GEO=" DQUOTE URI DQUOTE
+
+5.11. TZ
+
+ The TZ parameter can be used to indicate time zone information that
+ is specific to an address. Its value is the same as that of the TZ
+ property.
+
+ ABNF:
+
+ tz-parameter = "TZ=" (param-value / DQUOTE URI DQUOTE)
+
+
+
+
+
+
+
+
+
+
+
+Perreault Standards Track [Page 22]
+
+RFC 6350 vCard August 2011
+
+
+6. vCard Properties
+
+ What follows is an enumeration of the standard vCard properties.
+
+6.1. General Properties
+
+6.1.1. BEGIN
+
+ Purpose: To denote the beginning of a syntactic entity within a
+ text/vcard content-type.
+
+ Value type: text
+
+ Cardinality: 1
+
+ Special notes: The content entity MUST begin with the BEGIN property
+ with a value of "VCARD". The value is case-insensitive.
+
+ The BEGIN property is used in conjunction with the END property to
+ delimit an entity containing a related set of properties within a
+ text/vcard content-type. This construct can be used instead of
+ including multiple vCards as body parts inside of a multipart/
+ alternative MIME message. It is provided for applications that
+ wish to define content that can contain multiple entities within
+ the same text/vcard content-type or to define content that can be
+ identifiable outside of a MIME environment.
+
+ ABNF:
+
+ BEGIN-param = 0" " ; no parameter allowed
+ BEGIN-value = "VCARD"
+
+ Example:
+
+ BEGIN:VCARD
+
+6.1.2. END
+
+ Purpose: To denote the end of a syntactic entity within a text/vcard
+ content-type.
+
+ Value type: text
+
+ Cardinality: 1
+
+ Special notes: The content entity MUST end with the END type with a
+ value of "VCARD". The value is case-insensitive.
+
+
+
+
+Perreault Standards Track [Page 23]
+
+RFC 6350 vCard August 2011
+
+
+ The END property is used in conjunction with the BEGIN property to
+ delimit an entity containing a related set of properties within a
+ text/vcard content-type. This construct can be used instead of or
+ in addition to wrapping separate sets of information inside
+ additional MIME headers. It is provided for applications that
+ wish to define content that can contain multiple entities within
+ the same text/vcard content-type or to define content that can be
+ identifiable outside of a MIME environment.
+
+ ABNF:
+
+ END-param = 0" " ; no parameter allowed
+ END-value = "VCARD"
+
+ Example:
+
+ END:VCARD
+
+6.1.3. SOURCE
+
+ Purpose: To identify the source of directory information contained
+ in the content type.
+
+ Value type: uri
+
+ Cardinality: *
+
+ Special notes: The SOURCE property is used to provide the means by
+ which applications knowledgable in the given directory service
+ protocol can obtain additional or more up-to-date information from
+ the directory service. It contains a URI as defined in [RFC3986]
+ and/or other information referencing the vCard to which the
+ information pertains. When directory information is available
+ from more than one source, the sending entity can pick what it
+ considers to be the best source, or multiple SOURCE properties can
+ be included.
+
+ ABNF:
+
+ SOURCE-param = "VALUE=uri" / pid-param / pref-param / altid-param
+ / mediatype-param / any-param
+ SOURCE-value = URI
+
+ Examples:
+
+ SOURCE:ldap://ldap.example.com/cn=Babs%20Jensen,%20o=Babsco,%20c=US
+
+
+
+
+
+Perreault Standards Track [Page 24]
+
+RFC 6350 vCard August 2011
+
+
+ SOURCE:http://directory.example.com/addressbooks/jdoe/
+ Jean%20Dupont.vcf
+
+6.1.4. KIND
+
+ Purpose: To specify the kind of object the vCard represents.
+
+ Value type: A single text value.
+
+ Cardinality: *1
+
+ Special notes: The value may be one of the following:
+
+ "individual" for a vCard representing a single person or entity.
+ This is the default kind of vCard.
+
+ "group" for a vCard representing a group of persons or entities.
+ The group's member entities can be other vCards or other types
+ of entities, such as email addresses or web sites. A group
+ vCard will usually contain MEMBER properties to specify the
+ members of the group, but it is not required to. A group vCard
+ without MEMBER properties can be considered an abstract
+ grouping, or one whose members are known empirically (perhaps
+ "IETF Participants" or "Republican U.S. Senators").
+
+ All properties in a group vCard apply to the group as a whole,
+ and not to any particular MEMBER. For example, an EMAIL
+ property might specify the address of a mailing list associated
+ with the group, and an IMPP property might refer to a group
+ chat room.
+
+ "org" for a vCard representing an organization. An organization
+ vCard will not (in fact, MUST NOT) contain MEMBER properties,
+ and so these are something of a cross between "individual" and
+ "group". An organization is a single entity, but not a person.
+ It might represent a business or government, a department or
+ division within a business or government, a club, an
+ association, or the like.
+
+ All properties in an organization vCard apply to the
+ organization as a whole, as is the case with a group vCard.
+ For example, an EMAIL property might specify the address of a
+ contact point for the organization.
+
+
+
+
+
+
+
+
+Perreault Standards Track [Page 25]
+
+RFC 6350 vCard August 2011
+
+
+ "location" for a named geographical place. A location vCard will
+ usually contain a GEO property, but it is not required to. A
+ location vCard without a GEO property can be considered an
+ abstract location, or one whose definition is known empirically
+ (perhaps "New England" or "The Seashore").
+
+ All properties in a location vCard apply to the location
+ itself, and not with any entity that might exist at that
+ location. For example, in a vCard for an office building, an
+ ADR property might give the mailing address for the building,
+ and a TEL property might specify the telephone number of the
+ receptionist.
+
+ An x-name. vCards MAY include private or experimental values for
+ KIND. Remember that x-name values are not intended for general
+ use and are unlikely to interoperate.
+
+ An iana-token. Additional values may be registered with IANA (see
+ Section 10.3.4). A new value's specification document MUST
+ specify which properties make sense for that new kind of vCard
+ and which do not.
+
+ Implementations MUST support the specific string values defined
+ above. If this property is absent, "individual" MUST be assumed
+ as the default. If this property is present but the
+ implementation does not understand its value (the value is an
+ x-name or iana-token that the implementation does not support),
+ the implementation SHOULD act in a neutral way, which usually
+ means treating the vCard as though its kind were "individual".
+ The presence of MEMBER properties MAY, however, be taken as an
+ indication that the unknown kind is an extension of "group".
+
+ Clients often need to visually distinguish contacts based on what
+ they represent, and the KIND property provides a direct way for
+ them to do so. For example, when displaying contacts in a list,
+ an icon could be displayed next to each one, using distinctive
+ icons for the different kinds; a client might use an outline of a
+ single person to represent an "individual", an outline of multiple
+ people to represent a "group", and so on. Alternatively, or in
+ addition, a client might choose to segregate different kinds of
+ vCards to different panes, tabs, or selections in the user
+ interface.
+
+ Some clients might also make functional distinctions among the
+ kinds, ignoring "location" vCards for some purposes and
+ considering only "location" vCards for others.
+
+
+
+
+
+Perreault Standards Track [Page 26]
+
+RFC 6350 vCard August 2011
+
+
+ When designing those sorts of visual and functional distinctions,
+ client implementations have to decide how to fit unsupported kinds
+ into the scheme. What icon is used for them? The one for
+ "individual"? A unique one, such as an icon of a question mark?
+ Which tab do they go into? It is beyond the scope of this
+ specification to answer these questions, but these are things
+ implementers need to consider.
+
+ ABNF:
+
+ KIND-param = "VALUE=text" / any-param
+ KIND-value = "individual" / "group" / "org" / "location"
+ / iana-token / x-name
+
+ Example:
+
+ This represents someone named Jane Doe working in the marketing
+ department of the North American division of ABC Inc.
+
+ BEGIN:VCARD
+ VERSION:4.0
+ KIND:individual
+ FN:Jane Doe
+ ORG:ABC\, Inc.;North American Division;Marketing
+ END:VCARD
+
+ This represents the department itself, commonly known as ABC
+ Marketing.
+
+ BEGIN:VCARD
+ VERSION:4.0
+ KIND:org
+ FN:ABC Marketing
+ ORG:ABC\, Inc.;North American Division;Marketing
+ END:VCARD
+
+6.1.5. XML
+
+ Purpose: To include extended XML-encoded vCard data in a plain
+ vCard.
+
+ Value type: A single text value.
+
+ Cardinality: *
+
+ Special notes: The content of this property is a single XML 1.0
+ [W3C.REC-xml-20081126] element whose namespace MUST be explicitly
+ specified using the xmlns attribute and MUST NOT be the vCard 4
+
+
+
+Perreault Standards Track [Page 27]
+
+RFC 6350 vCard August 2011
+
+
+ namespace ("urn:ietf:params:xml:ns:vcard-4.0"). (This implies
+ that it cannot duplicate a standard vCard property.) The element
+ is to be interpreted as if it was contained in a <vcard> element,
+ as defined in [RFC6351].
+
+ The fragment is subject to normal line folding and escaping, i.e.,
+ replace all backslashes with "\\", then replace all newlines with
+ "\n", then fold long lines.
+
+ Support for this property is OPTIONAL, but implementations of this
+ specification MUST preserve instances of this property when
+ propagating vCards.
+
+ See [RFC6351] for more information on the intended use of this
+ property.
+
+ ABNF:
+
+ XML-param = "VALUE=text" / altid-param
+ XML-value = text
+
+6.2. Identification Properties
+
+ These types are used to capture information associated with the
+ identification and naming of the entity associated with the vCard.
+
+6.2.1. FN
+
+ Purpose: To specify the formatted text corresponding to the name of
+ the object the vCard represents.
+
+ Value type: A single text value.
+
+ Cardinality: 1*
+
+ Special notes: This property is based on the semantics of the X.520
+ Common Name attribute [CCITT.X520.1988]. The property MUST be
+ present in the vCard object.
+
+ ABNF:
+
+ FN-param = "VALUE=text" / type-param / language-param / altid-param
+ / pid-param / pref-param / any-param
+ FN-value = text
+
+ Example:
+
+ FN:Mr. John Q. Public\, Esq.
+
+
+
+Perreault Standards Track [Page 28]
+
+RFC 6350 vCard August 2011
+
+
+6.2.2. N
+
+ Purpose: To specify the components of the name of the object the
+ vCard represents.
+
+ Value type: A single structured text value. Each component can have
+ multiple values.
+
+ Cardinality: *1
+
+ Special note: The structured property value corresponds, in
+ sequence, to the Family Names (also known as surnames), Given
+ Names, Additional Names, Honorific Prefixes, and Honorific
+ Suffixes. The text components are separated by the SEMICOLON
+ character (U+003B). Individual text components can include
+ multiple text values separated by the COMMA character (U+002C).
+ This property is based on the semantics of the X.520 individual
+ name attributes [CCITT.X520.1988]. The property SHOULD be present
+ in the vCard object when the name of the object the vCard
+ represents follows the X.520 model.
+
+ The SORT-AS parameter MAY be applied to this property.
+
+ ABNF:
+
+ N-param = "VALUE=text" / sort-as-param / language-param
+ / altid-param / any-param
+ N-value = list-component 4(";" list-component)
+
+ Examples:
+
+ N:Public;John;Quinlan;Mr.;Esq.
+
+ N:Stevenson;John;Philip,Paul;Dr.;Jr.,M.D.,A.C.P.
+
+6.2.3. NICKNAME
+
+ Purpose: To specify the text corresponding to the nickname of the
+ object the vCard represents.
+
+ Value type: One or more text values separated by a COMMA character
+ (U+002C).
+
+ Cardinality: *
+
+
+
+
+
+
+
+Perreault Standards Track [Page 29]
+
+RFC 6350 vCard August 2011
+
+
+ Special note: The nickname is the descriptive name given instead of
+ or in addition to the one belonging to the object the vCard
+ represents. It can also be used to specify a familiar form of a
+ proper name specified by the FN or N properties.
+
+ ABNF:
+
+ NICKNAME-param = "VALUE=text" / type-param / language-param
+ / altid-param / pid-param / pref-param / any-param
+ NICKNAME-value = text-list
+
+ Examples:
+
+ NICKNAME:Robbie
+
+ NICKNAME:Jim,Jimmie
+
+ NICKNAME;TYPE=work:Boss
+
+6.2.4. PHOTO
+
+ Purpose: To specify an image or photograph information that
+ annotates some aspect of the object the vCard represents.
+
+ Value type: A single URI.
+
+ Cardinality: *
+
+ ABNF:
+
+ PHOTO-param = "VALUE=uri" / altid-param / type-param
+ / mediatype-param / pref-param / pid-param / any-param
+ PHOTO-value = URI
+
+ Examples:
+
+ PHOTO:http://www.example.com/pub/photos/jqpublic.gif
+
+ PHOTO:data:image/jpeg;base64,MIICajCCAdOgAwIBAgICBEUwDQYJKoZIhv
+ AQEEBQAwdzELMAkGA1UEBhMCVVMxLDAqBgNVBAoTI05ldHNjYXBlIENvbW11bm
+ ljYXRpb25zIENvcnBvcmF0aW9uMRwwGgYDVQQLExNJbmZvcm1hdGlvbiBTeXN0
+ <...remainder of base64-encoded data...>
+
+6.2.5. BDAY
+
+ Purpose: To specify the birth date of the object the vCard
+ represents.
+
+
+
+
+Perreault Standards Track [Page 30]
+
+RFC 6350 vCard August 2011
+
+
+ Value type: The default is a single date-and-or-time value. It can
+ also be reset to a single text value.
+
+ Cardinality: *1
+
+ ABNF:
+
+ BDAY-param = BDAY-param-date / BDAY-param-text
+ BDAY-value = date-and-or-time / text
+ ; Value and parameter MUST match.
+
+ BDAY-param-date = "VALUE=date-and-or-time"
+ BDAY-param-text = "VALUE=text" / language-param
+
+ BDAY-param =/ altid-param / calscale-param / any-param
+ ; calscale-param can only be present when BDAY-value is
+ ; date-and-or-time and actually contains a date or date-time.
+
+ Examples:
+
+ BDAY:19960415
+ BDAY:--0415
+ BDAY;19531015T231000Z
+ BDAY;VALUE=text:circa 1800
+
+6.2.6. ANNIVERSARY
+
+ Purpose: The date of marriage, or equivalent, of the object the
+ vCard represents.
+
+ Value type: The default is a single date-and-or-time value. It can
+ also be reset to a single text value.
+
+ Cardinality: *1
+
+ ABNF:
+
+ ANNIVERSARY-param = "VALUE=" ("date-and-or-time" / "text")
+ ANNIVERSARY-value = date-and-or-time / text
+ ; Value and parameter MUST match.
+
+ ANNIVERSARY-param =/ altid-param / calscale-param / any-param
+ ; calscale-param can only be present when ANNIVERSARY-value is
+ ; date-and-or-time and actually contains a date or date-time.
+
+ Examples:
+
+ ANNIVERSARY:19960415
+
+
+
+Perreault Standards Track [Page 31]
+
+RFC 6350 vCard August 2011
+
+
+6.2.7. GENDER
+
+ Purpose: To specify the components of the sex and gender identity of
+ the object the vCard represents.
+
+ Value type: A single structured value with two components. Each
+ component has a single text value.
+
+ Cardinality: *1
+
+ Special notes: The components correspond, in sequence, to the sex
+ (biological), and gender identity. Each component is optional.
+
+ Sex component: A single letter. M stands for "male", F stands
+ for "female", O stands for "other", N stands for "none or not
+ applicable", U stands for "unknown".
+
+ Gender identity component: Free-form text.
+
+ ABNF:
+
+ GENDER-param = "VALUE=text" / any-param
+ GENDER-value = sex [";" text]
+
+ sex = "" / "M" / "F" / "O" / "N" / "U"
+
+ Examples:
+
+ GENDER:M
+ GENDER:F
+ GENDER:M;Fellow
+ GENDER:F;grrrl
+ GENDER:O;intersex
+ GENDER:;it's complicated
+
+6.3. Delivery Addressing Properties
+
+ These types are concerned with information related to the delivery
+ addressing or label for the vCard object.
+
+6.3.1. ADR
+
+ Purpose: To specify the components of the delivery address for the
+ vCard object.
+
+ Value type: A single structured text value, separated by the
+ SEMICOLON character (U+003B).
+
+
+
+
+Perreault Standards Track [Page 32]
+
+RFC 6350 vCard August 2011
+
+
+ Cardinality: *
+
+ Special notes: The structured type value consists of a sequence of
+ address components. The component values MUST be specified in
+ their corresponding position. The structured type value
+ corresponds, in sequence, to
+ the post office box;
+ the extended address (e.g., apartment or suite number);
+ the street address;
+ the locality (e.g., city);
+ the region (e.g., state or province);
+ the postal code;
+ the country name (full name in the language specified in
+ Section 5.1).
+
+ When a component value is missing, the associated component
+ separator MUST still be specified.
+
+ Experience with vCard 3 has shown that the first two components
+ (post office box and extended address) are plagued with many
+ interoperability issues. To ensure maximal interoperability,
+ their values SHOULD be empty.
+
+ The text components are separated by the SEMICOLON character
+ (U+003B). Where it makes semantic sense, individual text
+ components can include multiple text values (e.g., a "street"
+ component with multiple lines) separated by the COMMA character
+ (U+002C).
+
+ The property can include the "PREF" parameter to indicate the
+ preferred delivery address when more than one address is
+ specified.
+
+ The GEO and TZ parameters MAY be used with this property.
+
+ The property can also include a "LABEL" parameter to present a
+ delivery address label for the address. Its value is a plain-text
+ string representing the formatted address. Newlines are encoded
+ as \n, as they are for property values.
+
+ ABNF:
+
+ label-param = "LABEL=" param-value
+
+ ADR-param = "VALUE=text" / label-param / language-param
+ / geo-parameter / tz-parameter / altid-param / pid-param
+ / pref-param / type-param / any-param
+
+
+
+
+Perreault Standards Track [Page 33]
+
+RFC 6350 vCard August 2011
+
+
+ ADR-value = ADR-component-pobox ";" ADR-component-ext ";"
+ ADR-component-street ";" ADR-component-locality ";"
+ ADR-component-region ";" ADR-component-code ";"
+ ADR-component-country
+ ADR-component-pobox = list-component
+ ADR-component-ext = list-component
+ ADR-component-street = list-component
+ ADR-component-locality = list-component
+ ADR-component-region = list-component
+ ADR-component-code = list-component
+ ADR-component-country = list-component
+
+ Example: In this example, the post office box and the extended
+ address are absent.
+
+ ADR;GEO="geo:12.3457,78.910";LABEL="Mr. John Q. Public, Esq.\n
+ Mail Drop: TNE QB\n123 Main Street\nAny Town, CA 91921-1234\n
+ U.S.A.":;;123 Main Street;Any Town;CA;91921-1234;U.S.A.
+
+6.4. Communications Properties
+
+ These properties describe information about how to communicate with
+ the object the vCard represents.
+
+6.4.1. TEL
+
+ Purpose: To specify the telephone number for telephony communication
+ with the object the vCard represents.
+
+ Value type: By default, it is a single free-form text value (for
+ backward compatibility with vCard 3), but it SHOULD be reset to a
+ URI value. It is expected that the URI scheme will be "tel", as
+ specified in [RFC3966], but other schemes MAY be used.
+
+ Cardinality: *
+
+ Special notes: This property is based on the X.520 Telephone Number
+ attribute [CCITT.X520.1988].
+
+ The property can include the "PREF" parameter to indicate a
+ preferred-use telephone number.
+
+ The property can include the parameter "TYPE" to specify intended
+ use for the telephone number. The predefined values for the TYPE
+ parameter are:
+
+
+
+
+
+
+Perreault Standards Track [Page 34]
+
+RFC 6350 vCard August 2011
+
+
+ +-----------+-------------------------------------------------------+
+ | Value | Description |
+ +-----------+-------------------------------------------------------+
+ | text | Indicates that the telephone number supports text |
+ | | messages (SMS). |
+ | voice | Indicates a voice telephone number. |
+ | fax | Indicates a facsimile telephone number. |
+ | cell | Indicates a cellular or mobile telephone number. |
+ | video | Indicates a video conferencing telephone number. |
+ | pager | Indicates a paging device telephone number. |
+ | textphone | Indicates a telecommunication device for people with |
+ | | hearing or speech difficulties. |
+ +-----------+-------------------------------------------------------+
+
+ The default type is "voice". These type parameter values can be
+ specified as a parameter list (e.g., TYPE=text;TYPE=voice) or as a
+ value list (e.g., TYPE="text,voice"). The default can be
+ overridden to another set of values by specifying one or more
+ alternate values. For example, the default TYPE of "voice" can be
+ reset to a VOICE and FAX telephone number by the value list
+ TYPE="voice,fax".
+
+ If this property's value is a URI that can also be used for
+ instant messaging, the IMPP (Section 6.4.3) property SHOULD be
+ used in addition to this property.
+
+ ABNF:
+
+ TEL-param = TEL-text-param / TEL-uri-param
+ TEL-value = TEL-text-value / TEL-uri-value
+ ; Value and parameter MUST match.
+
+ TEL-text-param = "VALUE=text"
+ TEL-text-value = text
+
+ TEL-uri-param = "VALUE=uri" / mediatype-param
+ TEL-uri-value = URI
+
+ TEL-param =/ type-param / pid-param / pref-param / altid-param
+ / any-param
+
+ type-param-tel = "text" / "voice" / "fax" / "cell" / "video"
+ / "pager" / "textphone" / iana-token / x-name
+ ; type-param-tel MUST NOT be used with a property other than TEL.
+
+
+
+
+
+
+
+Perreault Standards Track [Page 35]
+
+RFC 6350 vCard August 2011
+
+
+ Example:
+
+ TEL;VALUE=uri;PREF=1;TYPE="voice,home":tel:+1-555-555-5555;ext=5555
+ TEL;VALUE=uri;TYPE=home:tel:+33-01-23-45-67
+
+6.4.2. EMAIL
+
+ Purpose: To specify the electronic mail address for communication
+ with the object the vCard represents.
+
+ Value type: A single text value.
+
+ Cardinality: *
+
+ Special notes: The property can include tye "PREF" parameter to
+ indicate a preferred-use email address when more than one is
+ specified.
+
+ Even though the value is free-form UTF-8 text, it is likely to be
+ interpreted by a Mail User Agent (MUA) as an "addr-spec", as
+ defined in [RFC5322], Section 3.4.1. Readers should also be aware
+ of the current work toward internationalized email addresses
+ [RFC5335bis].
+
+ ABNF:
+
+ EMAIL-param = "VALUE=text" / pid-param / pref-param / type-param
+ / altid-param / any-param
+ EMAIL-value = text
+
+ Example:
+
+ EMAIL;TYPE=work:jqpublic at xyz.example.com
+
+ EMAIL;PREF=1:jane_doe at example.com
+
+6.4.3. IMPP
+
+ Purpose: To specify the URI for instant messaging and presence
+ protocol communications with the object the vCard represents.
+
+ Value type: A single URI.
+
+ Cardinality: *
+
+ Special notes: The property may include the "PREF" parameter to
+ indicate that this is a preferred address and has the same
+ semantics as the "PREF" parameter in a TEL property.
+
+
+
+Perreault Standards Track [Page 36]
+
+RFC 6350 vCard August 2011
+
+
+ If this property's value is a URI that can be used for voice
+ and/or video, the TEL property (Section 6.4.1) SHOULD be used in
+ addition to this property.
+
+ This property is adapted from [RFC4770], which is made obsolete by
+ this document.
+
+ ABNF:
+
+ IMPP-param = "VALUE=uri" / pid-param / pref-param / type-param
+ / mediatype-param / altid-param / any-param
+ IMPP-value = URI
+
+ Example:
+
+ IMPP;PREF=1:xmpp:alice at example.com
+
+6.4.4. LANG
+
+ Purpose: To specify the language(s) that may be used for contacting
+ the entity associated with the vCard.
+
+ Value type: A single language-tag value.
+
+ Cardinality: *
+
+ ABNF:
+
+ LANG-param = "VALUE=language-tag" / pid-param / pref-param
+ / altid-param / type-param / any-param
+ LANG-value = Language-Tag
+
+ Example:
+
+ LANG;TYPE=work;PREF=1:en
+ LANG;TYPE=work;PREF=2:fr
+ LANG;TYPE=home:fr
+
+6.5. Geographical Properties
+
+ These properties are concerned with information associated with
+ geographical positions or regions associated with the object the
+ vCard represents.
+
+6.5.1. TZ
+
+ Purpose: To specify information related to the time zone of the
+ object the vCard represents.
+
+
+
+Perreault Standards Track [Page 37]
+
+RFC 6350 vCard August 2011
+
+
+ Value type: The default is a single text value. It can also be
+ reset to a single URI or utc-offset value.
+
+ Cardinality: *
+
+ Special notes: It is expected that names from the public-domain
+ Olson database [TZ-DB] will be used, but this is not a
+ restriction. See also [IANA-TZ].
+
+ Efforts are currently being directed at creating a standard URI
+ scheme for expressing time zone information. Usage of such a
+ scheme would ensure a high level of interoperability between
+ implementations that support it.
+
+ Note that utc-offset values SHOULD NOT be used because the UTC
+ offset varies with time -- not just because of the usual daylight
+ saving time shifts that occur in may regions, but often entire
+ regions will "re-base" their overall offset. The actual offset
+ may be +/- 1 hour (or perhaps a little more) than the one given.
+
+ ABNF:
+
+ TZ-param = "VALUE=" ("text" / "uri" / "utc-offset")
+ TZ-value = text / URI / utc-offset
+ ; Value and parameter MUST match.
+
+ TZ-param =/ altid-param / pid-param / pref-param / type-param
+ / mediatype-param / any-param
+
+ Examples:
+
+ TZ:Raleigh/North America
+
+ TZ;VALUE=utc-offset:-0500
+ ; Note: utc-offset format is NOT RECOMMENDED.
+
+6.5.2. GEO
+
+ Purpose: To specify information related to the global positioning of
+ the object the vCard represents.
+
+ Value type: A single URI.
+
+ Cardinality: *
+
+ Special notes: The "geo" URI scheme [RFC5870] is particularly well
+ suited for this property, but other schemes MAY be used.
+
+
+
+
+Perreault Standards Track [Page 38]
+
+RFC 6350 vCard August 2011
+
+
+ ABNF:
+
+ GEO-param = "VALUE=uri" / pid-param / pref-param / type-param
+ / mediatype-param / altid-param / any-param
+ GEO-value = URI
+
+ Example:
+
+ GEO:geo:37.386013,-122.082932
+
+6.6. Organizational Properties
+
+ These properties are concerned with information associated with
+ characteristics of the organization or organizational units of the
+ object that the vCard represents.
+
+6.6.1. TITLE
+
+ Purpose: To specify the position or job of the object the vCard
+ represents.
+
+ Value type: A single text value.
+
+ Cardinality: *
+
+ Special notes: This property is based on the X.520 Title attribute
+ [CCITT.X520.1988].
+
+ ABNF:
+
+ TITLE-param = "VALUE=text" / language-param / pid-param
+ / pref-param / altid-param / type-param / any-param
+ TITLE-value = text
+
+ Example:
+
+ TITLE:Research Scientist
+
+6.6.2. ROLE
+
+ Purpose: To specify the function or part played in a particular
+ situation by the object the vCard represents.
+
+ Value type: A single text value.
+
+ Cardinality: *
+
+
+
+
+
+Perreault Standards Track [Page 39]
+
+RFC 6350 vCard August 2011
+
+
+ Special notes: This property is based on the X.520 Business Category
+ explanatory attribute [CCITT.X520.1988]. This property is
+ included as an organizational type to avoid confusion with the
+ semantics of the TITLE property and incorrect usage of that
+ property when the semantics of this property is intended.
+
+ ABNF:
+
+ ROLE-param = "VALUE=text" / language-param / pid-param / pref-param
+ / type-param / altid-param / any-param
+ ROLE-value = text
+
+ Example:
+
+ ROLE:Project Leader
+
+6.6.3. LOGO
+
+ Purpose: To specify a graphic image of a logo associated with the
+ object the vCard represents.
+
+ Value type: A single URI.
+
+ Cardinality: *
+
+ ABNF:
+
+ LOGO-param = "VALUE=uri" / language-param / pid-param / pref-param
+ / type-param / mediatype-param / altid-param / any-param
+ LOGO-value = URI
+
+ Examples:
+
+ LOGO:http://www.example.com/pub/logos/abccorp.jpg
+
+ LOGO:data:image/jpeg;base64,MIICajCCAdOgAwIBAgICBEUwDQYJKoZIhvc
+ AQEEBQAwdzELMAkGA1UEBhMCVVMxLDAqBgNVBAoTI05ldHNjYXBlIENvbW11bm
+ ljYXRpb25zIENvcnBvcmF0aW9uMRwwGgYDVQQLExNJbmZvcm1hdGlvbiBTeXN0
+ <...the remainder of base64-encoded data...>
+
+6.6.4. ORG
+
+ Purpose: To specify the organizational name and units associated
+ with the vCard.
+
+ Value type: A single structured text value consisting of components
+ separated by the SEMICOLON character (U+003B).
+
+
+
+
+Perreault Standards Track [Page 40]
+
+RFC 6350 vCard August 2011
+
+
+ Cardinality: *
+
+ Special notes: The property is based on the X.520 Organization Name
+ and Organization Unit attributes [CCITT.X520.1988]. The property
+ value is a structured type consisting of the organization name,
+ followed by zero or more levels of organizational unit names.
+
+ The SORT-AS parameter MAY be applied to this property.
+
+ ABNF:
+
+ ORG-param = "VALUE=text" / sort-as-param / language-param
+ / pid-param / pref-param / altid-param / type-param
+ / any-param
+ ORG-value = component *(";" component)
+
+ Example: A property value consisting of an organizational name,
+ organizational unit #1 name, and organizational unit #2 name.
+
+ ORG:ABC\, Inc.;North American Division;Marketing
+
+6.6.5. MEMBER
+
+ Purpose: To include a member in the group this vCard represents.
+
+ Value type: A single URI. It MAY refer to something other than a
+ vCard object. For example, an email distribution list could
+ employ the "mailto" URI scheme [RFC6068] for efficiency.
+
+ Cardinality: *
+
+ Special notes: This property MUST NOT be present unless the value of
+ the KIND property is "group".
+
+ ABNF:
+
+ MEMBER-param = "VALUE=uri" / pid-param / pref-param / altid-param
+ / mediatype-param / any-param
+ MEMBER-value = URI
+
+
+
+
+
+
+
+
+
+
+
+
+Perreault Standards Track [Page 41]
+
+RFC 6350 vCard August 2011
+
+
+ Examples:
+
+ BEGIN:VCARD
+ VERSION:4.0
+ KIND:group
+ FN:The Doe family
+ MEMBER:urn:uuid:03a0e51f-d1aa-4385-8a53-e29025acd8af
+ MEMBER:urn:uuid:b8767877-b4a1-4c70-9acc-505d3819e519
+ END:VCARD
+ BEGIN:VCARD
+ VERSION:4.0
+ FN:John Doe
+ UID:urn:uuid:03a0e51f-d1aa-4385-8a53-e29025acd8af
+ END:VCARD
+ BEGIN:VCARD
+ VERSION:4.0
+ FN:Jane Doe
+ UID:urn:uuid:b8767877-b4a1-4c70-9acc-505d3819e519
+ END:VCARD
+
+ BEGIN:VCARD
+ VERSION:4.0
+ KIND:group
+ FN:Funky distribution list
+ MEMBER:mailto:subscriber1 at example.com
+ MEMBER:xmpp:subscriber2 at example.com
+ MEMBER:sip:subscriber3 at example.com
+ MEMBER:tel:+1-418-555-5555
+ END:VCARD
+
+6.6.6. RELATED
+
+ Purpose: To specify a relationship between another entity and the
+ entity represented by this vCard.
+
+ Value type: A single URI. It can also be reset to a single text
+ value. The text value can be used to specify textual information.
+
+ Cardinality: *
+
+ Special notes: The TYPE parameter MAY be used to characterize the
+ related entity. It contains a comma-separated list of values that
+ are registered with IANA as described in Section 10.2. The
+ registry is pre-populated with the values defined in [xfn]. This
+ document also specifies two additional values:
+
+ agent: an entity who may sometimes act on behalf of the entity
+ associated with the vCard.
+
+
+
+Perreault Standards Track [Page 42]
+
+RFC 6350 vCard August 2011
+
+
+ emergency: indicates an emergency contact
+
+ ABNF:
+
+ RELATED-param = RELATED-param-uri / RELATED-param-text
+ RELATED-value = URI / text
+ ; Parameter and value MUST match.
+
+ RELATED-param-uri = "VALUE=uri" / mediatype-param
+ RELATED-param-text = "VALUE=text" / language-param
+
+ RELATED-param =/ pid-param / pref-param / altid-param / type-param
+ / any-param
+
+ type-param-related = related-type-value *("," related-type-value)
+ ; type-param-related MUST NOT be used with a property other than
+ ; RELATED.
+
+ related-type-value = "contact" / "acquaintance" / "friend" / "met"
+ / "co-worker" / "colleague" / "co-resident"
+ / "neighbor" / "child" / "parent"
+ / "sibling" / "spouse" / "kin" / "muse"
+ / "crush" / "date" / "sweetheart" / "me"
+ / "agent" / "emergency"
+
+ Examples:
+
+ RELATED;TYPE=friend:urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6
+ RELATED;TYPE=contact:http://example.com/directory/jdoe.vcf
+ RELATED;TYPE=co-worker;VALUE=text:Please contact my assistant Jane
+ Doe for any inquiries.
+
+6.7. Explanatory Properties
+
+ These properties are concerned with additional explanations, such as
+ that related to informational notes or revisions specific to the
+ vCard.
+
+6.7.1. CATEGORIES
+
+ Purpose: To specify application category information about the
+ vCard, also known as "tags".
+
+ Value type: One or more text values separated by a COMMA character
+ (U+002C).
+
+ Cardinality: *
+
+
+
+
+Perreault Standards Track [Page 43]
+
+RFC 6350 vCard August 2011
+
+
+ ABNF:
+
+ CATEGORIES-param = "VALUE=text" / pid-param / pref-param
+ / type-param / altid-param / any-param
+ CATEGORIES-value = text-list
+
+ Example:
+
+ CATEGORIES:TRAVEL AGENT
+
+ CATEGORIES:INTERNET,IETF,INDUSTRY,INFORMATION TECHNOLOGY
+
+6.7.2. NOTE
+
+ Purpose: To specify supplemental information or a comment that is
+ associated with the vCard.
+
+ Value type: A single text value.
+
+ Cardinality: *
+
+ Special notes: The property is based on the X.520 Description
+ attribute [CCITT.X520.1988].
+
+ ABNF:
+
+ NOTE-param = "VALUE=text" / language-param / pid-param / pref-param
+ / type-param / altid-param / any-param
+ NOTE-value = text
+
+ Example:
+
+ NOTE:This fax number is operational 0800 to 1715
+ EST\, Mon-Fri.
+
+6.7.3. PRODID
+
+ Purpose: To specify the identifier for the product that created the
+ vCard object.
+
+ Type value: A single text value.
+
+ Cardinality: *1
+
+ Special notes: Implementations SHOULD use a method such as that
+ specified for Formal Public Identifiers in [ISO9070] or for
+ Universal Resource Names in [RFC3406] to ensure that the text
+ value is unique.
+
+
+
+Perreault Standards Track [Page 44]
+
+RFC 6350 vCard August 2011
+
+
+ ABNF:
+
+ PRODID-param = "VALUE=text" / any-param
+ PRODID-value = text
+
+ Example:
+
+ PRODID:-//ONLINE DIRECTORY//NONSGML Version 1//EN
+
+6.7.4. REV
+
+ Purpose: To specify revision information about the current vCard.
+
+ Value type: A single timestamp value.
+
+ Cardinality: *1
+
+ Special notes: The value distinguishes the current revision of the
+ information in this vCard for other renditions of the information.
+
+ ABNF:
+
+ REV-param = "VALUE=timestamp" / any-param
+ REV-value = timestamp
+
+ Example:
+
+ REV:19951031T222710Z
+
+6.7.5. SOUND
+
+ Purpose: To specify a digital sound content information that
+ annotates some aspect of the vCard. This property is often used
+ to specify the proper pronunciation of the name property value of
+ the vCard.
+
+ Value type: A single URI.
+
+ Cardinality: *
+
+ ABNF:
+
+ SOUND-param = "VALUE=uri" / language-param / pid-param / pref-param
+ / type-param / mediatype-param / altid-param
+ / any-param
+ SOUND-value = URI
+
+
+
+
+
+Perreault Standards Track [Page 45]
+
+RFC 6350 vCard August 2011
+
+
+ Example:
+
+ SOUND:CID:JOHNQPUBLIC.part8.19960229T080000.xyzMail at example.com
+
+ SOUND:data:audio/basic;base64,MIICajCCAdOgAwIBAgICBEUwDQYJKoZIh
+ AQEEBQAwdzELMAkGA1UEBhMCVVMxLDAqBgNVBAoTI05ldHNjYXBlIENvbW11bm
+ ljYXRpb25zIENvcnBvcmF0aW9uMRwwGgYDVQQLExNJbmZvcm1hdGlvbiBTeXN0
+ <...the remainder of base64-encoded data...>
+
+6.7.6. UID
+
+ Purpose: To specify a value that represents a globally unique
+ identifier corresponding to the entity associated with the vCard.
+
+ Value type: A single URI value. It MAY also be reset to free-form
+ text.
+
+ Cardinality: *1
+
+ Special notes: This property is used to uniquely identify the object
+ that the vCard represents. The "uuid" URN namespace defined in
+ [RFC4122] is particularly well suited to this task, but other URI
+ schemes MAY be used. Free-form text MAY also be used.
+
+ ABNF:
+
+ UID-param = UID-uri-param / UID-text-param
+ UID-value = UID-uri-value / UID-text-value
+ ; Value and parameter MUST match.
+
+ UID-uri-param = "VALUE=uri"
+ UID-uri-value = URI
+
+ UID-text-param = "VALUE=text"
+ UID-text-value = text
+
+ UID-param =/ any-param
+
+ Example:
+
+ UID:urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6
+
+
+
+
+
+
+
+
+
+
+Perreault Standards Track [Page 46]
+
+RFC 6350 vCard August 2011
+
+
+6.7.7. CLIENTPIDMAP
+
+ Purpose: To give a global meaning to a local PID source identifier.
+
+ Value type: A semicolon-separated pair of values. The first field
+ is a small integer corresponding to the second field of a PID
+ parameter instance. The second field is a URI. The "uuid" URN
+ namespace defined in [RFC4122] is particularly well suited to this
+ task, but other URI schemes MAY be used.
+
+ Cardinality: *
+
+ Special notes: PID source identifiers (the source identifier is the
+ second field in a PID parameter instance) are small integers that
+ only have significance within the scope of a single vCard
+ instance. Each distinct source identifier present in a vCard MUST
+ have an associated CLIENTPIDMAP. See Section 7 for more details
+ on the usage of CLIENTPIDMAP.
+
+ PID source identifiers MUST be strictly positive. Zero is not
+ allowed.
+
+ As a special exception, the PID parameter MUST NOT be applied to
+ this property.
+
+ ABNF:
+
+ CLIENTPIDMAP-param = any-param
+ CLIENTPIDMAP-value = 1*DIGIT ";" URI
+
+ Example:
+
+ TEL;PID=3.1,4.2;VALUE=uri:tel:+1-555-555-5555
+ EMAIL;PID=4.1,5.2:jdoe at example.com
+ CLIENTPIDMAP:1;urn:uuid:3df403f4-5924-4bb7-b077-3c711d9eb34b
+ CLIENTPIDMAP:2;urn:uuid:d89c9c7a-2e1b-4832-82de-7e992d95faa5
+
+6.7.8. URL
+
+ Purpose: To specify a uniform resource locator associated with the
+ object to which the vCard refers. Examples for individuals
+ include personal web sites, blogs, and social networking site
+ identifiers.
+
+ Cardinality: *
+
+ Value type: A single uri value.
+
+
+
+
+Perreault Standards Track [Page 47]
+
+RFC 6350 vCard August 2011
+
+
+ ABNF:
+
+ URL-param = "VALUE=uri" / pid-param / pref-param / type-param
+ / mediatype-param / altid-param / any-param
+ URL-value = URI
+
+ Example:
+
+ URL:http://example.org/restaurant.french/~chezchic.html
+
+6.7.9. VERSION
+
+ Purpose: To specify the version of the vCard specification used to
+ format this vCard.
+
+ Value type: A single text value.
+
+ Cardinality: 1
+
+ Special notes: This property MUST be present in the vCard object,
+ and it must appear immediately after BEGIN:VCARD. The value MUST
+ be "4.0" if the vCard corresponds to this specification. Note
+ that earlier versions of vCard allowed this property to be placed
+ anywhere in the vCard object, or even to be absent.
+
+ ABNF:
+
+ VERSION-param = "VALUE=text" / any-param
+ VERSION-value = "4.0"
+
+ Example:
+
+ VERSION:4.0
+
+6.8. Security Properties
+
+ These properties are concerned with the security of communication
+ pathways or access to the vCard.
+
+6.8.1. KEY
+
+ Purpose: To specify a public key or authentication certificate
+ associated with the object that the vCard represents.
+
+ Value type: A single URI. It can also be reset to a text value.
+
+ Cardinality: *
+
+
+
+
+Perreault Standards Track [Page 48]
+
+RFC 6350 vCard August 2011
+
+
+ ABNF:
+
+ KEY-param = KEY-uri-param / KEY-text-param
+ KEY-value = KEY-uri-value / KEY-text-value
+ ; Value and parameter MUST match.
+
+ KEY-uri-param = "VALUE=uri" / mediatype-param
+ KEY-uri-value = URI
+
+ KEY-text-param = "VALUE=text"
+ KEY-text-value = text
+
+ KEY-param =/ altid-param / pid-param / pref-param / type-param
+ / any-param
+
+ Examples:
+
+ KEY:http://www.example.com/keys/jdoe.cer
+
+ KEY;MEDIATYPE=application/pgp-keys:ftp://example.com/keys/jdoe
+
+ KEY:data:application/pgp-keys;base64,MIICajCCAdOgAwIBAgICBE
+ UwDQYJKoZIhvcNAQEEBQAwdzELMAkGA1UEBhMCVVMxLDAqBgNVBAoTI05l
+ <... remainder of base64-encoded data ...>
+
+6.9. Calendar Properties
+
+ These properties are further specified in [RFC2739].
+
+6.9.1. FBURL
+
+ Purpose: To specify the URI for the busy time associated with the
+ object that the vCard represents.
+
+ Value type: A single URI value.
+
+ Cardinality: *
+
+ Special notes: Where multiple FBURL properties are specified, the
+ default FBURL property is indicated with the PREF parameter. The
+ FTP [RFC1738] or HTTP [RFC2616] type of URI points to an iCalendar
+ [RFC5545] object associated with a snapshot of the next few weeks
+ or months of busy time data. If the iCalendar object is
+ represented as a file or document, its file extension should be
+ ".ifb".
+
+
+
+
+
+
+Perreault Standards Track [Page 49]
+
+RFC 6350 vCard August 2011
+
+
+ ABNF:
+
+ FBURL-param = "VALUE=uri" / pid-param / pref-param / type-param
+ / mediatype-param / altid-param / any-param
+ FBURL-value = URI
+
+ Examples:
+
+ FBURL;PREF=1:http://www.example.com/busy/janedoe
+ FBURL;MEDIATYPE=text/calendar:ftp://example.com/busy/project-a.ifb
+
+6.9.2. CALADRURI
+
+ Purpose: To specify the calendar user address [RFC5545] to which a
+ scheduling request [RFC5546] should be sent for the object
+ represented by the vCard.
+
+ Value type: A single URI value.
+
+ Cardinality: *
+
+ Special notes: Where multiple CALADRURI properties are specified,
+ the default CALADRURI property is indicated with the PREF
+ parameter.
+
+ ABNF:
+
+ CALADRURI-param = "VALUE=uri" / pid-param / pref-param / type-param
+ / mediatype-param / altid-param / any-param
+ CALADRURI-value = URI
+
+ Example:
+
+ CALADRURI;PREF=1:mailto:janedoe at example.com
+ CALADRURI:http://example.com/calendar/jdoe
+
+6.9.3. CALURI
+
+ Purpose: To specify the URI for a calendar associated with the
+ object represented by the vCard.
+
+ Value type: A single URI value.
+
+ Cardinality: *
+
+ Special notes: Where multiple CALURI properties are specified, the
+ default CALURI property is indicated with the PREF parameter. The
+ property should contain a URI pointing to an iCalendar [RFC5545]
+
+
+
+Perreault Standards Track [Page 50]
+
+RFC 6350 vCard August 2011
+
+
+ object associated with a snapshot of the user's calendar store.
+ If the iCalendar object is represented as a file or document, its
+ file extension should be ".ics".
+
+ ABNF:
+
+ CALURI-param = "VALUE=uri" / pid-param / pref-param / type-param
+ / mediatype-param / altid-param / any-param
+ CALURI-value = URI
+
+ Examples:
+
+ CALURI;PREF=1:http://cal.example.com/calA
+ CALURI;MEDIATYPE=text/calendar:ftp://ftp.example.com/calA.ics
+
+6.10. Extended Properties and Parameters
+
+ The properties and parameters defined by this document can be
+ extended. Non-standard, private properties and parameters with a
+ name starting with "X-" may be defined bilaterally between two
+ cooperating agents without outside registration or standardization.
+
+7. Synchronization
+
+ vCard data often needs to be synchronized between devices. In this
+ context, synchronization is defined as the intelligent merging of two
+ representations of the same object. vCard 4.0 includes mechanisms to
+ aid this process.
+
+7.1. Mechanisms
+
+ Two mechanisms are available: the UID property is used to match
+ multiple instances of the same vCard, while the PID parameter is used
+ to match multiple instances of the same property.
+
+ The term "matching" is used here to mean recognizing that two
+ instances are in fact representations of the same object. For
+ example, a single vCard that is shared with someone results in two
+ vCard instances. After they have evolved separately, they still
+ represent the same object, and therefore may be matched by a
+ synchronization engine.
+
+7.1.1. Matching vCard Instances
+
+ vCard instances for which the UID properties (Section 6.7.6) are
+ equivalent MUST be matched. Equivalence is determined as specified
+ in [RFC3986], Section 6.
+
+
+
+
+Perreault Standards Track [Page 51]
+
+RFC 6350 vCard August 2011
+
+
+ In all other cases, vCard instances MAY be matched at the discretion
+ of the synchronization engine.
+
+7.1.2. Matching Property Instances
+
+ Property instances belonging to unmatched vCards MUST NOT be matched.
+
+ Property instances whose name (e.g., EMAIL, TEL, etc.) is not the
+ same MUST NOT be matched.
+
+ Property instances whose name is CLIENTPIDMAP are handled separately
+ and MUST NOT be matched. The synchronization MUST ensure that there
+ is consistency of CLIENTPIDMAPs among matched vCard instances.
+
+ Property instances belonging to matched vCards, whose name is the
+ same, and whose maximum cardinality is 1, MUST be matched.
+
+ Property instances belonging to matched vCards, whose name is the
+ same, and whose PID parameters match, MUST be matched. See
+ Section 7.1.3 for details on PID matching.
+
+ In all other cases, property instances MAY be matched at the
+ discretion of the synchronization engine.
+
+7.1.3. PID Matching
+
+ Two PID values for which the first fields are equivalent represent
+ the same local value.
+
+ Two PID values representing the same local value and for which the
+ second fields point to CLIENTPIDMAP properties whose second field
+ URIs are equivalent (as specified in [RFC3986], Section 6) also
+ represent the same global value.
+
+ PID parameters for which at least one pair of their values represent
+ the same global value MUST be matched.
+
+ In all other cases, PID parameters MAY be matched at the discretion
+ of the synchronization engine.
+
+ For example, PID value "5.1", in the first vCard below, and PID value
+ "5.2", in the second vCard below, represent the same global value.
+
+
+
+
+
+
+
+
+
+Perreault Standards Track [Page 52]
+
+RFC 6350 vCard August 2011
+
+
+ BEGIN:VCARD
+ VERSION:4.0
+ EMAIL;PID=4.2,5.1:jdoe at example.com
+ CLIENTPIDMAP:1;urn:uuid:3eef374e-7179-4196-a914-27358c3e6527
+ CLIENTPIDMAP:2;urn:uuid:42bcd5a7-1699-4514-87b4-056edf68e9cc
+ END:VCARD
+
+ BEGIN:VCARD
+ VERSION:4.0
+ EMAIL;PID=5.1,5.2:john at example.com
+ CLIENTPIDMAP:1;urn:uuid:0c75c629-6a8d-4d5e-a07f-1bb35846854d
+ CLIENTPIDMAP:2;urn:uuid:3eef374e-7179-4196-a914-27358c3e6527
+ END:VCARD
+
+7.2. Example
+
+7.2.1. Creation
+
+ The following simple vCard is first created on a given device.
+
+ BEGIN:VCARD
+ VERSION:4.0
+ UID:urn:uuid:4fbe8971-0bc3-424c-9c26-36c3e1eff6b1
+ FN;PID=1.1:J. Doe
+ N:Doe;J.;;;
+ EMAIL;PID=1.1:jdoe at example.com
+ CLIENTPIDMAP:1;urn:uuid:53e374d9-337e-4727-8803-a1e9c14e0556
+ END:VCARD
+
+ This new vCard is assigned the UID
+ "urn:uuid:4fbe8971-0bc3-424c-9c26-36c3e1eff6b1" by the creating
+ device. The FN and EMAIL properties are assigned the same local
+ value of 1, and this value is given global context by associating it
+ with "urn:uuid:53e374d9-337e-4727-8803-a1e9c14e0556", which
+ represents the creating device. We are at liberty to reuse the same
+ local value since instances of different properties will never be
+ matched. The N property has no PID because it is forbidden by its
+ maximum cardinality of 1.
+
+7.2.2. Initial Sharing
+
+ This vCard is shared with a second device. Upon inspecting the UID
+ property, the second device understands that this is a new vCard
+ (i.e., unmatched) and thus the synchronization results in a simple
+ copy.
+
+
+
+
+
+
+Perreault Standards Track [Page 53]
+
+RFC 6350 vCard August 2011
+
+
+7.2.3. Adding and Sharing a Property
+
+ A new phone number is created on the first device, then the vCard is
+ shared with the second device. This is what the second device
+ receives:
+
+ BEGIN:VCARD
+ VERSION:4.0
+ UID:urn:uuid:4fbe8971-0bc3-424c-9c26-36c3e1eff6b1
+ FN;PID=1.1:J. Doe
+ N:Doe;J.;;;
+ EMAIL;PID=1.1:jdoe at example.com
+ TEL;PID=1.1;VALUE=uri:tel:+1-555-555-5555
+ CLIENTPIDMAP:1;urn:uuid:53e374d9-337e-4727-8803-a1e9c14e0556
+ END:VCARD
+
+ Upon inspecting the UID property, the second device matches the vCard
+ it received to the vCard that it already has stored. It then starts
+ comparing the properties of the two vCards in same-named pairs.
+
+ The FN properties are matched because the PID parameters have the
+ same global value. Since the property value is the same, no update
+ takes place.
+
+ The N properties are matched automatically because their maximum
+ cardinality is 1. Since the property value is the same, no update
+ takes place.
+
+ The EMAIL properties are matched because the PID parameters have the
+ same global value. Since the property value is the same, no update
+ takes place.
+
+ The TEL property in the new vCard is not matched to any in the stored
+ vCard because no property in the stored vCard has the same name.
+ Therefore, this property is copied from the new vCard to the stored
+ vCard.
+
+ The CLIENTPIDMAP property is handled separately by the
+ synchronization engine. It ensures that it is consistent with the
+ stored one. If it was not, the results would be up to the
+ synchronization engine, and thus undefined by this document.
+
+7.2.4. Simultaneous Editing
+
+ A new email address and a new phone number are added to the vCard on
+ each of the two devices, and then a new synchronization event
+ happens. Here are the vCards that are communicated to each other:
+
+
+
+
+Perreault Standards Track [Page 54]
+
+RFC 6350 vCard August 2011
+
+
+ BEGIN:VCARD
+ VERSION:4.0
+ UID:urn:uuid:4fbe8971-0bc3-424c-9c26-36c3e1eff6b1
+ FN;PID=1.1:J. Doe
+ N:Doe;J.;;;
+ EMAIL;PID=1.1:jdoe at example.com
+ EMAIL;PID=2.1:boss at example.com
+ TEL;PID=1.1;VALUE=uri:tel:+1-555-555-5555
+ TEL;PID=2.1;VALUE=uri:tel:+1-666-666-6666
+ CLIENTPIDMAP:1;urn:uuid:53e374d9-337e-4727-8803-a1e9c14e0556
+ END:VCARD
+
+ BEGIN:VCARD
+ VERSION:4.0
+ UID:urn:uuid:4fbe8971-0bc3-424c-9c26-36c3e1eff6b1
+ FN;PID=1.1:J. Doe
+ N:Doe;J.;;;
+ EMAIL;PID=1.1:jdoe at example.com
+ EMAIL;PID=2.2:ceo at example.com
+ TEL;PID=1.1;VALUE=uri:tel:+1-555-555-5555
+ TEL;PID=2.2;VALUE=uri:tel:+1-666-666-6666
+ CLIENTPIDMAP:1;urn:uuid:53e374d9-337e-4727-8803-a1e9c14e0556
+ CLIENTPIDMAP:2;urn:uuid:1f762d2b-03c4-4a83-9a03-75ff658a6eee
+ END:VCARD
+
+ On the first device, the same PID source identifier (1) is reused for
+ the new EMAIL and TEL properties. On the second device, a new source
+ identifier (2) is generated, and a corresponding CLIENTPIDMAP
+ property is created. It contains the second device's identifier,
+ "urn:uuid:1f762d2b-03c4-4a83-9a03-75ff658a6eee".
+
+ The new EMAIL properties are unmatched on both sides since the PID
+ global value is new in both cases. The sync thus results in a copy
+ on both sides.
+
+ Although the situation appears to be the same for the TEL properties,
+ in this case, the synchronization engine is particularly smart and
+ matches the two new TEL properties even though their PID global
+ values are different. Note that in this case, the rules of
+ Section 7.1.2 state that two properties MAY be matched at the
+ discretion of the synchronization engine. Therefore, the two
+ properties are merged.
+
+ All this results in the following vCard, which is stored on both
+ devices:
+
+
+
+
+
+
+Perreault Standards Track [Page 55]
+
+RFC 6350 vCard August 2011
+
+
+ BEGIN:VCARD
+ VERSION:4.0
+ UID:urn:uuid:4fbe8971-0bc3-424c-9c26-36c3e1eff6b1
+ FN:J. Doe
+ N:Doe;J.;;;
+ EMAIL;PID=1.1:jdoe at example.com
+ EMAIL;PID=2.1:boss at example.com
+ EMAIL;PID=2.2:ceo at example.com
+ TEL;PID=1.1;VALUE=uri:tel:+1-555-555-5555
+ TEL;PID=2.1,2.2;VALUE=uri:tel:+1-666-666-6666
+ CLIENTPIDMAP:1;urn:uuid:53e374d9-337e-4727-8803-a1e9c14e0556
+ CLIENTPIDMAP:2;urn:uuid:1f762d2b-03c4-4a83-9a03-75ff658a6eee
+ END:VCARD
+
+7.2.5. Global Context Simplification
+
+ The two devices finish their synchronization procedure by simplifying
+ their global contexts. Since they haven't talked to any other
+ device, the following vCard is for all purposes equivalent to the
+ above. It is also shorter.
+
+ BEGIN:VCARD
+ VERSION:4.0
+ UID:urn:uuid:4fbe8971-0bc3-424c-9c26-36c3e1eff6b1
+ FN:J. Doe
+ N:Doe;J.;;;
+ EMAIL;PID=1.1:jdoe at example.com
+ EMAIL;PID=2.1:boss at example.com
+ EMAIL;PID=3.1:ceo at example.com
+ TEL;PID=1.1;VALUE=uri:tel:+1-555-555-5555
+ TEL;PID=2.1;VALUE=uri:tel:+1-666-666-6666
+ CLIENTPIDMAP:1;urn:uuid:53e374d9-337e-4727-8803-a1e9c14e0556
+ END:VCARD
+
+ The details of global context simplification are unspecified by this
+ document. They are left up to the synchronization engine. This
+ example is merely intended to illustrate the possibility, which
+ investigating would be, in the author's opinion, worthwhile.
+
+8. Example: Author's vCard
+
+ BEGIN:VCARD
+ VERSION:4.0
+ FN:Simon Perreault
+ N:Perreault;Simon;;;ing. jr,M.Sc.
+ BDAY:--0203
+ ANNIVERSARY:20090808T1430-0500
+ GENDER:M
+
+
+
+Perreault Standards Track [Page 56]
+
+RFC 6350 vCard August 2011
+
+
+ LANG;PREF=1:fr
+ LANG;PREF=2:en
+ ORG;TYPE=work:Viagenie
+ ADR;TYPE=work:;Suite D2-630;2875 Laurier;
+ Quebec;QC;G1V 2M2;Canada
+ TEL;VALUE=uri;TYPE="work,voice";PREF=1:tel:+1-418-656-9254;ext=102
+ TEL;VALUE=uri;TYPE="work,cell,voice,video,text":tel:+1-418-262-6501
+ EMAIL;TYPE=work:simon.perreault at viagenie.ca
+ GEO;TYPE=work:geo:46.772673,-71.282945
+ KEY;TYPE=work;VALUE=uri:
+ http://www.viagenie.ca/simon.perreault/simon.asc
+ TZ:-0500
+ URL;TYPE=home:http://nomis80.org
+ END:VCARD
+
+9. Security Considerations
+
+ o Internet mail is often used to transport vCards and is subject to
+ many well-known security attacks, including monitoring, replay,
+ and forgery. Care should be taken by any directory service in
+ allowing information to leave the scope of the service itself,
+ where any access controls or confidentiality can no longer be
+ guaranteed. Applications should also take care to display
+ directory data in a "safe" environment.
+
+ o vCards can carry cryptographic keys or certificates, as described
+ in Section 6.8.1.
+
+ o vCards often carry information that can be sensitive (e.g.,
+ birthday, address, and phone information). Although vCards have
+ no inherent authentication or confidentiality provisions, they can
+ easily be carried by any security mechanism that transfers MIME
+ objects to address authentication or confidentiality (e.g., S/MIME
+ [RFC5751], OpenPGP [RFC4880]). In cases where the confidentiality
+ or authenticity of information contained in vCard is a concern,
+ the vCard SHOULD be transported using one of these secure
+ mechanisms. The KEY property (Section 6.8.1) can be used to
+ transport the public key used by these mechanisms.
+
+ o The information in a vCard may become out of date. In cases where
+ the vitality of data is important to an originator of a vCard, the
+ SOURCE property (Section 6.1.3) SHOULD be specified. In addition,
+ the "REV" type described in Section 6.7.4 can be specified to
+ indicate the last time that the vCard data was updated.
+
+ o Many vCard properties may be used to transport URIs. Please refer
+ to [RFC3986], Section 7, for considerations related to URIs.
+
+
+
+
+Perreault Standards Track [Page 57]
+
+RFC 6350 vCard August 2011
+
+
+10. IANA Considerations
+
+10.1. Media Type Registration
+
+ IANA has registered the following Media Type (in
+ <http://www.iana.org/>) and marked the text/directory Media Type as
+ DEPRECATED.
+
+ To: ietf-types at iana.org
+
+ Subject: Registration of media type text/vcard
+
+ Type name: text
+
+ Subtype name: vcard
+
+ Required parameters: none
+
+ Optional parameters: version
+
+ The "version" parameter is to be interpreted identically as the
+ VERSION vCard property. If this parameter is present, all vCards
+ in a text/vcard body part MUST have a VERSION property with value
+ identical to that of this MIME parameter.
+
+ "charset": as defined for text/plain [RFC2046]; encodings other
+ than UTF-8 [RFC3629] MUST NOT be used.
+
+ Encoding considerations: 8bit
+
+ Security considerations: See Section 9.
+
+ Interoperability considerations: The text/vcard media type is
+ intended to identify vCard data of any version. There are older
+ specifications of vCard [RFC2426][vCard21] still in common use.
+ While these formats are similar, they are not strictly compatible.
+ In general, it is necessary to inspect the value of the VERSION
+ property (see Section 6.7.9) for identifying the standard to which
+ a given vCard object conforms.
+
+ In addition, the following media types are known to have been used
+ to refer to vCard data. They should be considered deprecated in
+ favor of text/vcard.
+
+ * text/directory
+ * text/directory; profile=vcard
+ * text/x-vcard
+
+
+
+
+Perreault Standards Track [Page 58]
+
+RFC 6350 vCard August 2011
+
+
+ Published specification: RFC 6350
+
+ Applications that use this media type: They are numerous, diverse,
+ and include mail user agents, instant messaging clients, address
+ book applications, directory servers, and customer relationship
+ management software.
+
+ Additional information:
+
+ Magic number(s):
+
+ File extension(s): .vcf .vcard
+
+ Macintosh file type code(s):
+
+ Person & email address to contact for further information: vCard
+ discussion mailing list <vcarddav at ietf.org>
+
+ Intended usage: COMMON
+
+ Restrictions on usage: none
+
+ Author: Simon Perreault
+
+ Change controller: IETF
+
+10.2. Registering New vCard Elements
+
+ This section defines the process for registering new or modified
+ vCard elements (i.e., properties, parameters, value data types, and
+ values) with IANA.
+
+10.2.1. Registration Procedure
+
+ The IETF has created a mailing list, vcarddav at ietf.org, which can be
+ used for public discussion of vCard element proposals prior to
+ registration. Use of the mailing list is strongly encouraged. The
+ IESG has appointed a designated expert who will monitor the
+ vcarddav at ietf.org mailing list and review registrations.
+
+ Registration of new vCard elements MUST be reviewed by the designated
+ expert and published in an RFC. A Standards Track RFC is REQUIRED
+ for the registration of new value data types that modify existing
+ properties. A Standards Track RFC is also REQUIRED for registration
+ of vCard elements that modify vCard elements previously documented in
+ a Standards Track RFC.
+
+
+
+
+
+Perreault Standards Track [Page 59]
+
+RFC 6350 vCard August 2011
+
+
+ The registration procedure begins when a completed registration
+ template, defined in the sections below, is sent to vcarddav at ietf.org
+ and iana at iana.org. Within two weeks, the designated expert is
+ expected to tell IANA and the submitter of the registration whether
+ the registration is approved, approved with minor changes, or
+ rejected with cause. When a registration is rejected with cause, it
+ can be re-submitted if the concerns listed in the cause are
+ addressed. Decisions made by the designated expert can be appealed
+ to the IESG Applications Area Director, then to the IESG. They
+ follow the normal appeals procedure for IESG decisions.
+
+ Once the registration procedure concludes successfully, IANA creates
+ or modifies the corresponding record in the vCard registry. The
+ completed registration template is discarded.
+
+ An RFC specifying new vCard elements MUST include the completed
+ registration templates, which MAY be expanded with additional
+ information. These completed templates are intended to go in the
+ body of the document, not in the IANA Considerations section.
+
+ Finally, note that there is an XML representation for vCard defined
+ in [RFC6351]. An XML representation SHOULD be defined for new vCard
+ elements.
+
+10.2.2. Vendor Namespace
+
+ The vendor namespace is used for vCard elements associated with
+ commercially available products. "Vendor" or "producer" are
+ construed as equivalent and very broadly in this context.
+
+ A registration may be placed in the vendor namespace by anyone who
+ needs to interchange files associated with the particular product.
+ However, the registration formally belongs to the vendor or
+ organization handling the vCard elements in the namespace being
+ registered. Changes to the specification will be made at their
+ request, as discussed in subsequent sections.
+
+ vCard elements belonging to the vendor namespace will be
+ distinguished by the "VND-" prefix. This is followed by an IANA-
+ registered Private Enterprise Number (PEN), a dash, and a vCard
+ element designation of the vendor's choosing (e.g., "VND-123456-
+ MUDPIE").
+
+ While public exposure and review of vCard elements to be registered
+ in the vendor namespace are not required, using the vcarddav at ietf.org
+ mailing list for review is strongly encouraged to improve the quality
+ of those specifications. Registrations in the vendor namespace may
+ be submitted directly to the IANA.
+
+
+
+Perreault Standards Track [Page 60]
+
+RFC 6350 vCard August 2011
+
+
+10.2.3. Registration Template for Properties
+
+ A property is defined by completing the following template.
+
+ Namespace: Empty for the global namespace, "VND-NNNN-" for a vendor-
+ specific property (where NNNN is replaced by the vendor's PEN).
+
+ Property name: The name of the property.
+
+ Purpose: The purpose of the property. Give a short but clear
+ description.
+
+ Value type: Any of the valid value types for the property value
+ needs to be specified. The default value type also needs to be
+ specified.
+
+ Cardinality: See Section 6.
+
+ Property parameters: Any of the valid property parameters for the
+ property MUST be specified.
+
+ Description: Any special notes about the property, how it is to be
+ used, etc.
+
+ Format definition: The ABNF for the property definition needs to be
+ specified.
+
+ Example(s): One or more examples of instances of the property need
+ to be specified.
+
+10.2.4. Registration Template for Parameters
+
+ A parameter is defined by completing the following template.
+
+ Namespace: Empty for the global namespace, "VND-NNNN-" for a vendor-
+ specific property (where NNNN is replaced by the vendor's PEN).
+
+ Parameter name: The name of the parameter.
+
+ Purpose: The purpose of the parameter. Give a short but clear
+ description.
+
+ Description: Any special notes about the parameter, how it is to be
+ used, etc.
+
+ Format definition: The ABNF for the parameter definition needs to be
+ specified.
+
+
+
+
+Perreault Standards Track [Page 61]
+
+RFC 6350 vCard August 2011
+
+
+ Example(s): One or more examples of instances of the parameter need
+ to be specified.
+
+10.2.5. Registration Template for Value Data Types
+
+ A value data type is defined by completing the following template.
+
+ Value name: The name of the value type.
+
+ Purpose: The purpose of the value type. Give a short but clear
+ description.
+
+ Description: Any special notes about the value type, how it is to be
+ used, etc.
+
+ Format definition: The ABNF for the value type definition needs to
+ be specified.
+
+ Example(s): One or more examples of instances of the value type need
+ to be specified.
+
+10.2.6. Registration Template for Values
+
+ A value is defined by completing the following template.
+
+ Value: The value literal.
+
+ Purpose: The purpose of the value. Give a short but clear
+ description.
+
+ Conformance: The vCard properties and/or parameters that can take
+ this value needs to be specified.
+
+ Example(s): One or more examples of instances of the value need to
+ be specified.
+
+ The following is a fictitious example of a registration of a vCard
+ value:
+
+ Value: supervisor
+
+ Purpose: It means that the related entity is the direct hierarchical
+ superior (i.e., supervisor or manager) of the entity this vCard
+ represents.
+
+ Conformance: This value can be used with the "TYPE" parameter
+ applied on the "RELATED" property.
+
+
+
+
+Perreault Standards Track [Page 62]
+
+RFC 6350 vCard August 2011
+
+
+ Example(s):
+
+ RELATED;TYPE=supervisor:urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6
+
+10.3. Initial vCard Elements Registries
+
+ The IANA has created and will maintain the following registries for
+ vCard elements with pointers to appropriate reference documents. The
+ registries are grouped together under the heading "vCard Elements".
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Perreault Standards Track [Page 63]
+
+RFC 6350 vCard August 2011
+
+
+10.3.1. Properties Registry
+
+ The following table has been used to initialize the properties
+ registry.
+
+ +-----------+--------------+-------------------------+
+ | Namespace | Property | Reference |
+ +-----------+--------------+-------------------------+
+ | | SOURCE | RFC 6350, Section 6.1.3 |
+ | | KIND | RFC 6350, Section 6.1.4 |
+ | | XML | RFC 6350, Section 6.1.5 |
+ | | FN | RFC 6350, Section 6.2.1 |
+ | | N | RFC 6350, Section 6.2.2 |
+ | | NICKNAME | RFC 6350, Section 6.2.3 |
+ | | PHOTO | RFC 6350, Section 6.2.4 |
+ | | BDAY | RFC 6350, Section 6.2.5 |
+ | | ANNIVERSARY | RFC 6350, Section 6.2.6 |
+ | | GENDER | RFC 6350, Section 6.2.7 |
+ | | ADR | RFC 6350, Section 6.3.1 |
+ | | TEL | RFC 6350, Section 6.4.1 |
+ | | EMAIL | RFC 6350, Section 6.4.2 |
+ | | IMPP | RFC 6350, Section 6.4.3 |
+ | | LANG | RFC 6350, Section 6.4.4 |
+ | | TZ | RFC 6350, Section 6.5.1 |
+ | | GEO | RFC 6350, Section 6.5.2 |
+ | | TITLE | RFC 6350, Section 6.6.1 |
+ | | ROLE | RFC 6350, Section 6.6.2 |
+ | | LOGO | RFC 6350, Section 6.6.3 |
+ | | ORG | RFC 6350, Section 6.6.4 |
+ | | MEMBER | RFC 6350, Section 6.6.5 |
+ | | RELATED | RFC 6350, Section 6.6.6 |
+ | | CATEGORIES | RFC 6350, Section 6.7.1 |
+ | | NOTE | RFC 6350, Section 6.7.2 |
+ | | PRODID | RFC 6350, Section 6.7.3 |
+ | | REV | RFC 6350, Section 6.7.4 |
+ | | SOUND | RFC 6350, Section 6.7.5 |
+ | | UID | RFC 6350, Section 6.7.6 |
+ | | CLIENTPIDMAP | RFC 6350, Section 6.7.7 |
+ | | URL | RFC 6350, Section 6.7.8 |
+ | | VERSION | RFC 6350, Section 6.7.9 |
+ | | KEY | RFC 6350, Section 6.8.1 |
+ | | FBURL | RFC 6350, Section 6.9.1 |
+ | | CALADRURI | RFC 6350, Section 6.9.2 |
+ | | CALURI | RFC 6350, Section 6.9.3 |
+ +-----------+--------------+-------------------------+
+
+
+
+
+
+
+Perreault Standards Track [Page 64]
+
+RFC 6350 vCard August 2011
+
+
+10.3.2. Parameters Registry
+
+ The following table has been used to initialize the parameters
+ registry.
+
+ +-----------+-----------+------------------------+
+ | Namespace | Parameter | Reference |
+ +-----------+-----------+------------------------+
+ | | LANGUAGE | RFC 6350, Section 5.1 |
+ | | VALUE | RFC 6350, Section 5.2 |
+ | | PREF | RFC 6350, Section 5.3 |
+ | | ALTID | RFC 6350, Section 5.4 |
+ | | PID | RFC 6350, Section 5.5 |
+ | | TYPE | RFC 6350, Section 5.6 |
+ | | MEDIATYPE | RFC 6350, Section 5.7 |
+ | | CALSCALE | RFC 6350, Section 5.8 |
+ | | SORT-AS | RFC 6350, Section 5.9 |
+ | | GEO | RFC 6350, Section 5.10 |
+ | | TZ | RFC 6350, Section 5.11 |
+ +-----------+-----------+------------------------+
+
+10.3.3. Value Data Types Registry
+
+ The following table has been used to initialize the parameters
+ registry.
+
+ +------------------+-------------------------+
+ | Value Data Type | Reference |
+ +------------------+-------------------------+
+ | BOOLEAN | RFC 6350, Section 4.4 |
+ | DATE | RFC 6350, Section 4.3.1 |
+ | DATE-AND-OR-TIME | RFC 6350, Section 4.3.4 |
+ | DATE-TIME | RFC 6350, Section 4.3.3 |
+ | FLOAT | RFC 6350, Section 4.6 |
+ | INTEGER | RFC 6350, Section 4.5 |
+ | LANGUAGE-TAG | RFC 6350, Section 4.8 |
+ | TEXT | RFC 6350, Section 4.1 |
+ | TIME | RFC 6350, Section 4.3.2 |
+ | TIMESTAMP | RFC 6350, Section 4.3.5 |
+ | URI | RFC 6350, Section 4.2 |
+ | UTC-OFFSET | RFC 6350, Section 4.7 |
+ +------------------+-------------------------+
+
+
+
+
+
+
+
+
+
+Perreault Standards Track [Page 65]
+
+RFC 6350 vCard August 2011
+
+
+10.3.4. Values Registries
+
+ Separate tables are used for property and parameter values.
+
+ The following table is to be used to initialize the property values
+ registry.
+
+ +----------+------------+-------------------------+
+ | Property | Value | Reference |
+ +----------+------------+-------------------------+
+ | BEGIN | VCARD | RFC 6350, Section 6.1.1 |
+ | END | VCARD | RFC 6350, Section 6.1.2 |
+ | KIND | individual | RFC 6350, Section 6.1.4 |
+ | KIND | group | RFC 6350, Section 6.1.4 |
+ | KIND | org | RFC 6350, Section 6.1.4 |
+ | KIND | location | RFC 6350, Section 6.1.4 |
+ +----------+------------+-------------------------+
+
+ The following table has been used to initialize the parameter values
+ registry.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Perreault Standards Track [Page 66]
+
+RFC 6350 vCard August 2011
+
+
+ +------------------------+-----------+--------------+---------------+
+ | Property | Parameter | Value | Reference |
+ +------------------------+-----------+--------------+---------------+
+ | FN, NICKNAME, PHOTO, | TYPE | work | RFC 6350, |
+ | ADR, TEL, EMAIL, IMPP, | | | Section 5.6 |
+ | LANG, TZ, GEO, TITLE, | | | |
+ | ROLE, LOGO, ORG, | | | |
+ | RELATED, CATEGORIES, | | | |
+ | NOTE, SOUND, URL, KEY, | | | |
+ | FBURL, CALADRURI, and | | | |
+ | CALURI | | | |
+ | FN, NICKNAME, PHOTO, | TYPE | home | RFC 6350, |
+ | ADR, TEL, EMAIL, IMPP, | | | Section 5.6 |
+ | LANG, TZ, GEO, TITLE, | | | |
+ | ROLE, LOGO, ORG, | | | |
+ | RELATED, CATEGORIES, | | | |
+ | NOTE, SOUND, URL, KEY, | | | |
+ | FBURL, CALADRURI, and | | | |
+ | CALURI | | | |
+ | TEL | TYPE | text | RFC 6350, |
+ | | | | Section 6.4.1 |
+ | TEL | TYPE | voice | RFC 6350, |
+ | | | | Section 6.4.1 |
+ | TEL | TYPE | fax | RFC 6350, |
+ | | | | Section 6.4.1 |
+ | TEL | TYPE | cell | RFC 6350, |
+ | | | | Section 6.4.1 |
+ | TEL | TYPE | video | RFC 6350, |
+ | | | | Section 6.4.1 |
+ | TEL | TYPE | pager | RFC 6350, |
+ | | | | Section 6.4.1 |
+ | TEL | TYPE | textphone | RFC 6350, |
+ | | | | Section 6.4.1 |
+ | BDAY, ANNIVERSARY | CALSCALE | gregorian | RFC 6350, |
+ | | | | Section 5.8 |
+ | RELATED | TYPE | contact | RFC 6350, |
+ | | | | Section 6.6.6 |
+ | | | | and [xfn] |
+ | RELATED | TYPE | acquaintance | RFC 6350, |
+ | | | | Section 6.6.6 |
+ | | | | and [xfn] |
+ | RELATED | TYPE | friend | RFC 6350, |
+ | | | | Section 6.6.6 |
+ | | | | and [xfn] |
+ | RELATED | TYPE | met | RFC 6350, |
+ | | | | Section 6.6.6 |
+ | | | | and [xfn] |
+
+
+
+
+Perreault Standards Track [Page 67]
+
+RFC 6350 vCard August 2011
+
+
+ | RELATED | TYPE | co-worker | RFC 6350, |
+ | | | | Section 6.6.6 |
+ | | | | and [xfn] |
+ | RELATED | TYPE | colleague | RFC 6350, |
+ | | | | Section 6.6.6 |
+ | | | | and [xfn] |
+ | RELATED | TYPE | co-resident | RFC 6350, |
+ | | | | Section 6.6.6 |
+ | | | | and [xfn] |
+ | RELATED | TYPE | neighbor | RFC 6350, |
+ | | | | Section 6.6.6 |
+ | | | | and [xfn] |
+ | RELATED | TYPE | child | RFC 6350, |
+ | | | | Section 6.6.6 |
+ | | | | and [xfn] |
+ | RELATED | TYPE | parent | RFC 6350, |
+ | | | | Section 6.6.6 |
+ | | | | and [xfn] |
+ | RELATED | TYPE | sibling | RFC 6350, |
+ | | | | Section 6.6.6 |
+ | | | | and [xfn] |
+ | RELATED | TYPE | spouse | RFC 6350, |
+ | | | | Section 6.6.6 |
+ | | | | and [xfn] |
+ | RELATED | TYPE | kin | RFC 6350, |
+ | | | | Section 6.6.6 |
+ | | | | and [xfn] |
+ | RELATED | TYPE | muse | RFC 6350, |
+ | | | | Section 6.6.6 |
+ | | | | and [xfn] |
+ | RELATED | TYPE | crush | RFC 6350, |
+ | | | | Section 6.6.6 |
+ | | | | and [xfn] |
+ | RELATED | TYPE | date | RFC 6350, |
+ | | | | Section 6.6.6 |
+ | | | | and [xfn] |
+ | RELATED | TYPE | sweetheart | RFC 6350, |
+ | | | | Section 6.6.6 |
+ | | | | and [xfn] |
+ | RELATED | TYPE | me | RFC 6350, |
+ | | | | Section 6.6.6 |
+ | | | | and [xfn] |
+ | RELATED | TYPE | agent | RFC 6350, |
+ | | | | Section 6.6.6 |
+ | RELATED | TYPE | emergency | RFC 6350, |
+ | | | | Section 6.6.6 |
+ +------------------------+-----------+--------------+---------------+
+
+
+
+
+Perreault Standards Track [Page 68]
+
+RFC 6350 vCard August 2011
+
+
+11. Acknowledgments
+
+ The authors would like to thank Tim Howes, Mark Smith, and Frank
+ Dawson, the original authors of [RFC2425] and [RFC2426], Pete
+ Resnick, who got this effort started and provided help along the way,
+ as well as the following individuals who have participated in the
+ drafting, review, and discussion of this memo:
+
+ Aki Niemi, Andy Mabbett, Alexander Mayrhofer, Alexey Melnikov, Anil
+ Srivastava, Barry Leiba, Ben Fortuna, Bernard Desruisseaux, Bernie
+ Hoeneisen, Bjoern Hoehrmann, Caleb Richardson, Chris Bryant, Chris
+ Newman, Cyrus Daboo, Daisuke Miyakawa, Dan Brickley, Dan Mosedale,
+ Dany Cauchie, Darryl Champagne, Dave Thewlis, Filip Navara, Florian
+ Zeitz, Helge Hess, Jari Urpalainen, Javier Godoy, Jean-Luc Schellens,
+ Joe Hildebrand, Jose Luis Gayosso, Joseph Smarr, Julian Reschke,
+ Kepeng Li, Kevin Marks, Kevin Wu Won, Kurt Zeilenga, Lisa Dusseault,
+ Marc Blanchet, Mark Paterson, Markus Lorenz, Michael Haardt, Mike
+ Douglass, Nick Levinson, Peter K. Sheerin, Peter Mogensen, Peter
+ Saint-Andre, Renato Iannella, Rohit Khare, Sly Gryphon, Stephane
+ Bortzmeyer, Tantek Celik, and Zoltan Ordogh.
+
+12. References
+
+12.1. Normative References
+
+ [CCITT.X520.1988]
+ International Telephone and Telegraph Consultative
+ Committee, "Information Technology - Open Systems
+ Interconnection - The Directory: Selected Attribute
+ Types", CCITT Recommendation X.520, November 1988.
+
+ [IEEE.754.2008]
+ Institute of Electrical and Electronics Engineers,
+ "Standard for Binary Floating-Point Arithmetic",
+ IEEE Standard 754, August 2008.
+
+ [ISO.8601.2000]
+ International Organization for Standardization, "Data
+ elements and interchange formats - Information interchange
+ - Representation of dates and times", ISO Standard 8601,
+ December 2000.
+
+ [ISO.8601.2004]
+ International Organization for Standardization, "Data
+ elements and interchange formats - Information interchange
+ - Representation of dates and times", ISO Standard 8601,
+ December 2004.
+
+
+
+
+Perreault Standards Track [Page 69]
+
+RFC 6350 vCard August 2011
+
+
+ [RFC2045] Freed, N. and N. Borenstein, "Multipurpose Internet Mail
+ Extensions (MIME) Part One: Format of Internet Message
+ Bodies", RFC 2045, November 1996.
+
+ [RFC2046] Freed, N. and N. Borenstein, "Multipurpose Internet Mail
+ Extensions (MIME) Part Two: Media Types", RFC 2046,
+ November 1996.
+
+ [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
+ Requirement Levels", BCP 14, RFC 2119, March 1997.
+
+ [RFC2739] Small, T., Hennessy, D., and F. Dawson, "Calendar
+ Attributes for vCard and LDAP", RFC 2739, January 2000.
+
+ [RFC3629] Yergeau, F., "UTF-8, a transformation format of ISO
+ 10646", STD 63, RFC 3629, November 2003.
+
+ [RFC3966] Schulzrinne, H., "The tel URI for Telephone Numbers",
+ RFC 3966, December 2004.
+
+ [RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform
+ Resource Identifier (URI): Generic Syntax", STD 66,
+ RFC 3986, January 2005.
+
+ [RFC4122] Leach, P., Mealling, M., and R. Salz, "A Universally
+ Unique IDentifier (UUID) URN Namespace", RFC 4122,
+ July 2005.
+
+ [RFC4288] Freed, N. and J. Klensin, "Media Type Specifications and
+ Registration Procedures", BCP 13, RFC 4288, December 2005.
+
+ [RFC5234] Crocker, D. and P. Overell, "Augmented BNF for Syntax
+ Specifications: ABNF", STD 68, RFC 5234, January 2008.
+
+ [RFC5322] Resnick, P., Ed., "Internet Message Format", RFC 5322,
+ October 2008.
+
+ [RFC5545] Desruisseaux, B., "Internet Calendaring and Scheduling
+ Core Object Specification (iCalendar)", RFC 5545,
+ September 2009.
+
+ [RFC5546] Daboo, C., "iCalendar Transport-Independent
+ Interoperability Protocol (iTIP)", RFC 5546,
+ December 2009.
+
+ [RFC5646] Phillips, A. and M. Davis, "Tags for Identifying
+ Languages", BCP 47, RFC 5646, September 2009.
+
+
+
+
+Perreault Standards Track [Page 70]
+
+RFC 6350 vCard August 2011
+
+
+ [RFC5870] Mayrhofer, A. and C. Spanring, "A Uniform Resource
+ Identifier for Geographic Locations ('geo' URI)",
+ RFC 5870, June 2010.
+
+ [RFC6351] Perreault, S., "xCard: vCard XML Representation",
+ RFC 6351, August 2011.
+
+ [W3C.REC-xml-20081126]
+ Maler, E., Yergeau, F., Sperberg-McQueen, C., Paoli, J.,
+ and T. Bray, "Extensible Markup Language (XML) 1.0 (Fifth
+ Edition)", World Wide Web Consortium Recommendation REC-
+ xml-20081126, November 2008,
+ <http://www.w3.org/TR/2008/REC-xml-20081126>.
+
+ [xfn] Celik, T., Mullenweg, M., and E. Meyer, "XFN 1.1 profile",
+ <http://gmpg.org/xfn/11>.
+
+12.2. Informative References
+
+ [IANA-TZ] Lear, E. and P. Eggert, "IANA Procedures for Maintaining
+ the Timezone Database", Work in Progress, May 2011.
+
+ [ISO9070] International Organization for Standardization,
+ "Information Processing - SGML support facilities -
+ Registration Procedures for Public Text Owner
+ Identifiers", ISO 9070, April 1991.
+
+ [RFC1738] Berners-Lee, T., Masinter, L., and M. McCahill, "Uniform
+ Resource Locators (URL)", RFC 1738, December 1994.
+
+ [RFC2397] Masinter, L., "The "data" URL scheme", RFC 2397,
+ August 1998.
+
+ [RFC2425] Howes, T., Smith, M., and F. Dawson, "A MIME Content-Type
+ for Directory Information", RFC 2425, September 1998.
+
+ [RFC2426] Dawson, F. and T. Howes, "vCard MIME Directory Profile",
+ RFC 2426, September 1998.
+
+ [RFC2616] Fielding, R., Gettys, J., Mogul, J., Frystyk, H.,
+ Masinter, L., Leach, P., and T. Berners-Lee, "Hypertext
+ Transfer Protocol -- HTTP/1.1", RFC 2616, June 1999.
+
+ [RFC3282] Alvestrand, H., "Content Language Headers", RFC 3282,
+ May 2002.
+
+
+
+
+
+
+Perreault Standards Track [Page 71]
+
+RFC 6350 vCard August 2011
+
+
+ [RFC3406] Daigle, L., van Gulik, D., Iannella, R., and P. Faltstrom,
+ "Uniform Resource Names (URN) Namespace Definition
+ Mechanisms", BCP 66, RFC 3406, October 2002.
+
+ [RFC3536] Hoffman, P., "Terminology Used in Internationalization in
+ the IETF", RFC 3536, May 2003.
+
+ [RFC4770] Jennings, C. and J. Reschke, Ed., "vCard Extensions for
+ Instant Messaging (IM)", RFC 4770, January 2007.
+
+ [RFC4880] Callas, J., Donnerhacke, L., Finney, H., Shaw, D., and R.
+ Thayer, "OpenPGP Message Format", RFC 4880, November 2007.
+
+ [RFC5335bis]
+ Yang, A. and S. Steele, "Internationalized Email Headers",
+ Work in Progress, July 2011.
+
+ [RFC5751] Ramsdell, B. and S. Turner, "Secure/Multipurpose Internet
+ Mail Extensions (S/MIME) Version 3.2 Message
+ Specification", RFC 5751, January 2010.
+
+ [RFC6068] Duerst, M., Masinter, L., and J. Zawinski, "The 'mailto'
+ URI Scheme", RFC 6068, October 2010.
+
+ [TZ-DB] Olson, A., "Time zone code and data",
+ <ftp://elsie.nci.nih.gov/pub/>.
+
+ [vCard21] Internet Mail Consortium, "vCard - The Electronic Business
+ Card Version 2.1", September 1996.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Perreault Standards Track [Page 72]
+
+RFC 6350 vCard August 2011
+
+
+Appendix A. Differences from RFCs 2425 and 2426
+
+ This appendix contains a high-level overview of the major changes
+ that have been made in the vCard specification from RFCs 2425 and
+ 2426. It is incomplete, as it only lists the most important changes.
+
+A.1. New Structure
+
+ o [RFC2425] and [RFC2426] have been merged.
+
+ o vCard is now not only a MIME type but a stand-alone format.
+
+ o A proper MIME type registration form has been included.
+
+ o UTF-8 is now the only possible character set.
+
+ o New vCard elements can be registered from IANA.
+
+A.2. Removed Features
+
+ o The CONTEXT and CHARSET parameters are no more.
+
+ o The NAME, MAILER, LABEL, and CLASS properties are no more.
+
+ o The "intl", "dom", "postal", and "parcel" TYPE parameter values
+ for the ADR property have been removed.
+
+ o In-line vCards (such as the value of the AGENT property) are no
+ longer supported.
+
+A.3. New Properties and Parameters
+
+ o The KIND, GENDER, LANG, ANNIVERSARY, XML, and CLIENTPIDMAP
+ properties have been added.
+
+ o [RFC2739], which defines the FBURL, CALADRURI, CAPURI, and CALURI
+ properties, has been merged in.
+
+ o [RFC4770], which defines the IMPP property, has been merged in.
+
+ o The "work" and "home" TYPE parameter values are now applicable to
+ many more properties.
+
+ o The "pref" value of the TYPE parameter is now a parameter of its
+ own, with a positive integer value indicating the level of
+ preference.
+
+ o The ALTID and PID parameters have been added.
+
+
+
+Perreault Standards Track [Page 73]
+
+RFC 6350 vCard August 2011
+
+
+ o The MEDIATYPE parameter has been added and replaces the TYPE
+ parameter when it was used for indicating the media type of the
+ property's content.
+
+Author's Address
+
+ Simon Perreault
+ Viagenie
+ 2875 Laurier, suite D2-630
+ Quebec, QC G1V 2M2
+ Canada
+
+ Phone: +1 418 656 9254
+ EMail: simon.perreault at viagenie.ca
+ URI: http://www.viagenie.ca
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Perreault Standards Track [Page 74]
+
Added: CalendarServer/trunk/doc/RFC/rfc6351-xCard.txt
===================================================================
--- CalendarServer/trunk/doc/RFC/rfc6351-xCard.txt (rev 0)
+++ CalendarServer/trunk/doc/RFC/rfc6351-xCard.txt 2011-09-01 15:06:35 UTC (rev 8040)
@@ -0,0 +1,1235 @@
+
+
+
+
+
+
+Internet Engineering Task Force (IETF) S. Perreault
+Request for Comments: 6351 Viagenie
+Category: Standards Track August 2011
+ISSN: 2070-1721
+
+
+ xCard: vCard XML Representation
+
+Abstract
+
+ This document defines the XML schema of the vCard data 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 Section 2 of RFC 5741.
+
+ Information about the current status of this document, any errata,
+ and how to provide feedback on it may be obtained at
+ http://www.rfc-editor.org/info/rfc6351.
+
+Copyright Notice
+
+ Copyright (c) 2011 IETF Trust and the persons identified as the
+ document authors. All rights reserved.
+
+ This document is subject to BCP 78 and the IETF Trust's Legal
+ Provisions Relating to IETF Documents
+ (http://trustee.ietf.org/license-info) 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.
+
+
+
+
+
+
+
+
+
+
+
+Perreault Standards Track [Page 1]
+
+RFC 6351 xCard August 2011
+
+
+Table of Contents
+
+ 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 2
+ 2. Conventions . . . . . . . . . . . . . . . . . . . . . . . . . 2
+ 3. The Schema . . . . . . . . . . . . . . . . . . . . . . . . . . 2
+ 4. Example: Author's XML vCard . . . . . . . . . . . . . . . . . 3
+ 5. Design Considerations . . . . . . . . . . . . . . . . . . . . 4
+ 5.1. Extensibility . . . . . . . . . . . . . . . . . . . . . . 6
+ 5.2. Limitations . . . . . . . . . . . . . . . . . . . . . . . 7
+ 6. Format Conversions . . . . . . . . . . . . . . . . . . . . . . 8
+ 7. Security Considerations . . . . . . . . . . . . . . . . . . . 10
+ 8. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 11
+ 8.1. Registration of the XML Namespace . . . . . . . . . . . . 11
+ 8.2. Media Type . . . . . . . . . . . . . . . . . . . . . . . . 11
+ 9. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 12
+ 10. References . . . . . . . . . . . . . . . . . . . . . . . . . . 12
+ 10.1. Normative References . . . . . . . . . . . . . . . . . . . 12
+ 10.2. Informative References . . . . . . . . . . . . . . . . . . 13
+ Appendix A. Relax NG Schema . . . . . . . . . . . . . . . . . . . 14
+
+1. Introduction
+
+ vCard [RFC6350] is a data format for representing and exchanging
+ information about individuals and other entities. It is a text-based
+ format (as opposed to a binary format). This document defines xCard,
+ an XML [W3C.REC-xml-20081126] representation for vCard. The
+ underlying data structure is exactly the same, enabling a 1-to-1
+ mapping between the original vCard format and the XML representation.
+ The XML formatting may be preferred in some contexts where an XML
+ engine is readily available and may be reused instead of writing a
+ standalone vCard parser.
+
+ Earlier work on an XML format for vCard was started in 1998 by Frank
+ Dawson [VCARD-DTD]. Sadly, it did not take over the world.
+
+2. Conventions
+
+ 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 [RFC2119].
+
+3. The Schema
+
+ The schema is expressed in the RELAX NG language [ISO.19757-2.2008]
+ and is found in Appendix A.
+
+
+
+
+
+
+Perreault Standards Track [Page 2]
+
+RFC 6351 xCard August 2011
+
+
+4. Example: Author's XML vCard
+
+ <?xml version="1.0" encoding="UTF-8"?>
+ <vcards xmlns="urn:ietf:params:xml:ns:vcard-4.0">
+ <vcard>
+ <fn><text>Simon Perreault</text></fn>
+ <n>
+ <surname>Perreault</surname>
+ <given>Simon</given>
+ <additional/>
+ <prefix/>
+ <suffix>ing. jr</suffix>
+ <suffix>M.Sc.</suffix>
+ </n>
+ <bday><date>--0203</date></bday>
+ <anniversary>
+ <date-time>20090808T1430-0500</date-time>
+ </anniversary>
+ <gender><sex>M</sex></gender>
+ <lang>
+ <parameters><pref><integer>1</integer></pref></parameters>
+ <language-tag>fr</language-tag>
+ </lang>
+ <lang>
+ <parameters><pref><integer>2</integer></pref></parameters>
+ <language-tag>en</language-tag>
+ </lang>
+ <org>
+ <parameters><type><text>work</text></type></parameters>
+ <text>Viagenie</text>
+ </org>
+ <adr>
+ <parameters>
+ <type><text>work</text></type>
+ <label><text>Simon Perreault
+ 2875 boul. Laurier, suite D2-630
+ Quebec, QC, Canada
+ G1V 2M2</text></label>
+ </parameters>
+ <pobox/>
+ <ext/>
+ <street>2875 boul. Laurier, suite D2-630</street>
+ <locality>Quebec</locality>
+ <region>QC</region>
+ <code>G1V 2M2</code>
+ <country>Canada</country>
+ </adr>
+ <tel>
+
+
+
+Perreault Standards Track [Page 3]
+
+RFC 6351 xCard August 2011
+
+
+ <parameters>
+ <type>
+ <text>work</text>
+ <text>voice</text>
+ </type>
+ </parameters>
+ <uri>tel:+1-418-656-9254;ext=102</uri>
+ </tel>
+ <tel>
+ <parameters>
+ <type>
+ <text>work</text>
+ <text>text</text>
+ <text>voice</text>
+ <text>cell</text>
+ <text>video</text>
+ </type>
+ </parameters>
+ <uri>tel:+1-418-262-6501</uri>
+ </tel>
+ <email>
+ <parameters><type><text>work</text></type></parameters>
+ <text>simon.perreault at viagenie.ca</text>
+ </email>
+ <geo>
+ <parameters><type><text>work</text></type></parameters>
+ <uri>geo:46.766336,-71.28955</uri>
+ </geo>
+ <key>
+ <parameters><type><text>work</text></type></parameters>
+ <uri>http://www.viagenie.ca/simon.perreault/simon.asc</uri>
+ </key>
+ <tz><text>America/Montreal</text></tz>
+ <url>
+ <parameters><type><text>home</text></type></parameters>
+ <uri>http://nomis80.org</uri>
+ </url>
+ </vcard>
+ </vcards>
+
+5. Design Considerations
+
+ The general idea is to map vCard parameters, properties, and value
+ types to XML elements. For example, the "FN" property is mapped to
+ the "fn" element. In turn, that element contains a text element
+ whose content corresponds to the vCard property's value.
+
+
+
+
+
+Perreault Standards Track [Page 4]
+
+RFC 6351 xCard August 2011
+
+
+ vCard parameters are also mapped to XML elements. They are contained
+ in the <parameters> element, which is contained in property elements.
+ For example, the "TYPE" parameter applied to the "TEL" property would
+ look like the following in XML:
+
+ <tel>
+ <parameters>
+ <type>
+ <text>voice</text>
+ <text>video</text>
+ </type>
+ </parameters>
+ <uri>tel:+1-555-555-555</uri>
+ </tel>
+
+ Parameters taking a list of values are simply repeated multiple
+ times, once for each value in the list.
+
+ Properties having structured values (e.g., the "N" property) are
+ expressed by XML element trees. Element names in that tree (e.g.,
+ "surname", "given", etc.) do not have a vCard equivalent since they
+ are identified by position in plain vCard.
+
+ Line folding is a non-issue in XML. Therefore, the mapping from
+ vCard to XML is done after the unfolding procedure is carried out.
+ Conversely, the mapping from XML to vCard is done before the folding
+ procedure is carried out.
+
+ A top-level <vcards> element is used as root. It contains one or
+ more <vcard> elements, each representing a complete vCard. The
+ <vcards> element MUST be present even when only a single vCard is
+ present in an XML document.
+
+ The group construct (Section 3.2 in [RFC6350]) is represented with
+ the <group> element. The "name" attribute contains the group's name.
+ For example:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Perreault Standards Track [Page 5]
+
+RFC 6351 xCard August 2011
+
+
+ <vcards>
+ <vcard>
+ <group name="contact">
+ <fn>...</fn>
+ <email>...</email>
+ </group>
+ <group name="media">
+ <photo>...</photo>
+ </group>
+ <categories>...</categories>
+ </vcard>
+ </vcards>
+
+ is equivalent to:
+
+ BEGIN:VCARD
+ VERSION:4.0
+ contact.FN=...
+ contact.EMAIL=...
+ media.PHOTO=...
+ CATEGORIES=...
+ END:VCARD
+
+5.1. Extensibility
+
+ The original vCard format is extensible. New properties, parameters,
+ data types and values (collectively known as vCard elements, not to
+ be confused with XML elements) can be registered with IANA (see
+ [RFC6350], Section 10.2). It is expected that these vCard extensions
+ will also specify extensions to the XML format described in this
+ document.
+
+ New XML vCard property and parameter element names MUST be lower-
+ case. This is necessary to ensure that round-tripping between XML
+ and plain-text vCard works correctly.
+
+ Unregistered extensions (i.e., those starting with "X-" and
+ "VND-...-") are expressed in XML by using elements starting with "x-"
+ and "vnd-...-". Usage of XML namespaces [W3C.REC-xml-names-20091208]
+ for extensibility is RECOMMENDED for extensions that have no
+ equivalent in plain-text vCard. Refer to Section 6 for the
+ implications when converting between plain-text vCard and XML.
+
+
+
+
+
+
+
+
+
+Perreault Standards Track [Page 6]
+
+RFC 6351 xCard August 2011
+
+
+ Examples:
+
+ <x-my-prop>
+ <parameters>
+ <pref><integer>1</integer></pref>
+ </parameters>
+ <text>value goes here</text>
+ </x-my-prop>
+
+ <ext:my-prop
+ ext:xmlns="http://example.com/extensions/my-vcard">
+ <parameters>
+ <pref><integer>1</integer></pref>
+ </parameters> <!-- Core vCard elements -->
+ <text>value goes here</text> <!-- are still accessible -->
+ </ext:my-prop>
+
+ Note that extension elements do not need the "X-" or "VND-" prefix in
+ XML. The XML namespace mechanism is sufficient.
+
+ A vCard XML parser MUST ignore XML elements and attributes for which
+ it doesn't recognize the expanded name. The normal behavior of
+ ignoring XML processing instructions whose target is not recognized
+ MUST also be followed.
+
+ In the original vCard format, the "VERSION" property was mandatory
+ and played a role in extensibility. In XML, this property is absent.
+ Its role is played by the vCard core namespace identifier, which
+ includes the version number. vCard revisions will use a different
+ namespace.
+
+ Parameters containing a list of values are expressed using a list of
+ elements in XML (e.g., the <type> element).
+
+5.2. Limitations
+
+ The schema does not validate the cardinality of properties. This is
+ a limitation of the schema definition language. Cardinalities of the
+ original vCard format [RFC6350] MUST still be respected.
+
+ Some constructs (e.g., value enumerations in type parameters) have
+ additional ordering constraints in XML. This is a result of
+ limitations of the schema definition language, and the order is
+ arbitrary. The order MUST be respected in XML for the vCard to be
+ valid. However, reordering as part of conversion to or from plain
+ vCard MAY happen.
+
+
+
+
+
+Perreault Standards Track [Page 7]
+
+RFC 6351 xCard August 2011
+
+
+6. Format Conversions
+
+ When new properties or "X-" properties are used, a vCard<->xCard
+ converter might not recognize them or know what the appropriate
+ default value types are, yet they need to be able to preserve the
+ values. A similar issue arises for unrecognized property parameters.
+ As a result, the following rules are applied when dealing with
+ unrecognized properties and property parameters:
+
+ o When converting from vCard to xCard:
+
+ * Any property that does not include a "VALUE" parameter and
+ whose default value type is not known MUST be converted using
+ the value type XML element <unknown>. The content of that
+ element is the unprocessed value text.
+
+ * Any unrecognized property parameter MUST be converted using the
+ value type XML element <unknown>, with its content set to the
+ parameter value text, treated as if it were a text value, or
+ list of text values.
+
+ * The content of "XML" properties is copied as is to XML.
+
+ * Property and parameter XML element names are converted to
+ lower-case.
+
+ * Property value escaping is undone. For example, "\n" becomes a
+ NEWLINE character (ASCII decimal 10).
+
+ * Double-quoting of parameter values, as well as backslash
+ escaping in parameter values, is undone. For example,
+ PARAM="\"foo\",\"bar\"" becomes <param>"foo","bar"</param>.
+
+ o When converting xCard to vCard:
+
+ * Properties in the vCard 4 namespace:
+
+ + If the converter knows of a specific plain-text
+ representation for this property, it uses it. For example,
+ the <adr> element corresponds to the "ADR" property, which
+ is encoded using comma-separated lists separated by
+ semicolons.
+
+ + Otherwise, the property name is taken from the element name,
+ property parameters are taken from the <parameters> element,
+ and the content of the property is taken from the content of
+ the value element. If the property element has attributes
+ or contains other XML elements, they are dropped.
+
+
+
+Perreault Standards Track [Page 8]
+
+RFC 6351 xCard August 2011
+
+
+ + If a standard property's XML element contains XML elements
+ and attributes for which the converter doesn't recognize the
+ expanded name, they are dropped. Therefore, it is
+ RECOMMENDED to limit extensions to the property level to
+ ensure that all data is preserved intact in round-trip
+ conversions.
+
+ * Properties in other namespaces are wrapped as is inside an
+ "XML" property.
+
+ * Any <unknown> property value XML elements are converted
+ directly into vCard values. The containing property MUST NOT
+ have a "VALUE" parameter.
+
+ * Any <unknown> parameter value XML elements are converted as if
+ they were <text> value type XML elements.
+
+ * Property and parameter names are converted to upper-case.
+
+ * Property value escaping (Section 3.3 of [RFC6350]) is carried
+ out. For example, a NEWLINE character (ASCII decimal 10)
+ becomes "\n".
+
+ * Double-quoting of parameter values, as well as backslash
+ escaping in parameter values, is carried out. For example,
+ <param>"foo","bar"</param> becomes PARAM="\"foo\",\"bar\"".
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Perreault Standards Track [Page 9]
+
+RFC 6351 xCard August 2011
+
+
+ For example, these two vCards are equivalent:
+
+ <?xml version="1.0"?>
+ <vcards xmlns="urn:ietf:params:xml:ns:vcard-4.0">
+ <vcard>
+ <fn><text>J. Doe</text></fn>
+ <n>
+ <surname>Doe</surname>
+ <given>J.</given>
+ <additional/>
+ <prefix/>
+ <suffix/>
+ </n>
+ <x-file>
+ <parameters>
+ <mediatype><text>image/jpeg</text></mediatype>
+ </parameters>
+ <unknown>alien.jpg</unknown>
+ </x-file>
+ <a xmlns="http://www.w3.org/1999/xhtml"
+ href="http://www.example.com">My web page!</a>
+ </vcard>
+ </vcards>
+
+
+ BEGIN:VCARD
+ VERSION:4.0
+ FN:J. Doe
+ N:Doe;J.;;
+ X-FILE;MEDIATYPE=image/jpeg:alien.jpg
+ XML:<a xmlns="http://www.w3.org/1999/xhtml"\n
+ href="http://www.example.com">My web page!</a>
+ END:VCARD
+
+7. Security Considerations
+
+ All the security considerations applicable to plain vCard [RFC6350]
+ are applicable to this document as well.
+
+ XML Signature [W3C.CR-xmldsig-core1-20110303] and XML Encryption
+ [W3C.CR-xmlenc-core1-20110303] can be used with xCard to provide
+ authentication and confidentiality.
+
+
+
+
+
+
+
+
+
+Perreault Standards Track [Page 10]
+
+RFC 6351 xCard August 2011
+
+
+8. IANA Considerations
+
+8.1. Registration of the XML Namespace
+
+ URI: urn:ietf:params:xml:ns:vcard-4.0
+
+ Registrant Contact: The IESG <iesg at ietf.org>
+
+ XML: None. Namespace URIs do not represent an XML specification.
+
+8.2. Media Type
+
+ This section defines the MIME media type [RFC4288] for use with
+ vCard-in-XML data.
+
+ To: ietf-types at iana.org
+
+ Subject: Registration of media type application/vcard+xml
+
+ Type name: application
+
+ Subtype name: vcard+xml
+
+ Required parameters: none
+
+ Optional parameters: charset as defined for application/xml in
+ [RFC3023]; per [RFC3023], use of the charset parameter with the
+ value "utf-8" is "STRONGLY RECOMMENDED".
+
+ Encoding considerations: Same as encoding considerations of
+ application/xml as specified in [RFC3023].
+
+ Security considerations: This media type has all of the security
+ considerations described in [RFC3023], plus those listed in
+ Section 7.
+
+ Interoperability considerations: This media type provides an
+ alternative syntax to vCard data [RFC6350] based on XML.
+
+ Published specification: This specification.
+
+ Applications that use this media type: Applications that currently
+ make use of the text/vcard media type can use this as an
+ alternative. In general, applications that maintain or process
+ contact information can use this media type.
+
+
+
+
+
+
+Perreault Standards Track [Page 11]
+
+RFC 6351 xCard August 2011
+
+
+ Additional information:
+
+ Magic number(s): none
+
+ File extension(s): XML data should use ".xml" as the file
+ extension.
+
+ Macintosh file type code(s): none
+
+ Person & email address to contact for further information: Simon
+ Perreault <simon.perreault at viagenie.ca>
+
+ Intended usage: COMMON
+
+ Restrictions on usage: none
+
+ Author: Simon Perreault
+
+ Change controller: IETF
+
+9. Acknowledgments
+
+ Thanks to the following people for their input:
+
+ Alexey Melnikov, Barry Leiba, Bjorn Hoehrmann, Cyrus Daboo, Joe
+ Hildebrand, Joseph Smarr, Marc Blanchet, Mike Douglass, Peter Saint-
+ Andre, Robins George, Zahhar Kirillov, Zoltan Ordogh.
+
+
+10. References
+
+10.1. Normative References
+
+ [ISO.19757-2.2008]
+ International Organization for Standardization,
+ "Information technology -- Document Schema Definition
+ Language (DSDL) -- Part 2: Regular-grammar-based
+ validation -- RELAX NG", ISO International
+ Standard 19757-2, October 2008.
+
+ [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
+ Requirement Levels", BCP 14, RFC 2119, March 1997.
+
+ [RFC3023] Murata, M., St. Laurent, S., and D. Kohn, "XML Media
+ Types", RFC 3023, January 2001.
+
+ [RFC6350] Perreault, S., "vCard Format Specification", RFC 6350,
+ August 2011.
+
+
+
+Perreault Standards Track [Page 12]
+
+RFC 6351 xCard August 2011
+
+
+ [W3C.REC-xml-20081126]
+ Paoli, J., Yergeau, F., Maler, E., Bray, T., and C.
+ Sperberg-McQueen, "Extensible Markup Language (XML) 1.0
+ (Fifth Edition)", World Wide Web Consortium
+ Recommendation REC-xml-20081126, November 2008,
+ <http://www.w3.org/TR/2008/REC-xml-20081126>.
+
+ [W3C.REC-xml-names-20091208]
+ Bray, T., Hollander, D., Layman, A., Tobin, R., and H.
+ Thompson, "Namespaces in XML 1.0 (Third Edition)", World
+ Wide Web Consortium Recommendation REC-xml-names-20091208,
+ December 2009,
+ <http://www.w3.org/TR/2009/REC-xml-names-20091208>.
+
+10.2. Informative References
+
+ [RFC4288] Freed, N. and J. Klensin, "Media Type Specifications and
+ Registration Procedures", BCP 13, RFC 4288, December 2005.
+
+ [VCARD-DTD]
+ Dawson, F., "The vCard v3.0 XML DTD", Work in Progress,
+ June 1998.
+
+ [W3C.CR-xmldsig-core1-20110303]
+ Roessler, T., Solo, D., Yiu, K., Reagle, J., Hirsch, F.,
+ Eastlake, D., and M. Nystroem, "XML Signature Syntax and
+ Processing Version 1.1", World Wide Web Consortium CR CR-
+ xmldsig-core1-20110303, March 2011,
+ <http://www.w3.org/TR/2011/CR-xmldsig-core1-20110303>.
+
+ [W3C.CR-xmlenc-core1-20110303]
+ Eastlake, D., Reagle, J., Roessler, T., and F. Hirsch,
+ "XML Encryption Syntax and Processing Version 1.1", World
+ Wide Web Consortium CR CR-xmlenc-core1-20110303,
+ March 2011,
+ <http://www.w3.org/TR/2011/CR-xmlenc-core1-20110303>.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Perreault Standards Track [Page 13]
+
+RFC 6351 xCard August 2011
+
+
+Appendix A. Relax NG Schema
+
+default namespace = "urn:ietf:params:xml:ns:vcard-4.0"
+
+### Section 3.3: vCard Format Specification
+#
+# 3.3
+iana-token = xsd:string { pattern = "[a-zA-Z0-9-]+" }
+x-name = xsd:string { pattern = "x-[a-zA-Z0-9-]+" }
+
+### Section 4: Value types
+#
+# 4.1
+value-text = element text { text }
+value-text-list = value-text+
+
+# 4.2
+value-uri = element uri { xsd:anyURI }
+
+# 4.3.1
+value-date = element date {
+ xsd:string { pattern = "\d{8}|\d{4}-\d\d|--\d\d(\d\d)?|---\d\d" }
+ }
+
+# 4.3.2
+value-time = element time {
+ xsd:string { pattern = "(\d\d(\d\d(\d\d)?)?|-\d\d(\d\d?)|--\d\d)"
+ ~ "(Z|[+\-]\d\d(\d\d)?)?" }
+ }
+
+# 4.3.3
+value-date-time = element date-time {
+ xsd:string { pattern = "(\d{8}|--\d{4}|---\d\d)T\d\d(\d\d(\d\d)?)?"
+ ~ "(Z|[+\-]\d\d(\d\d)?)?" }
+ }
+
+# 4.3.4
+value-date-and-or-time = value-date | value-date-time | value-time
+
+# 4.3.5
+value-timestamp = element timestamp {
+ xsd:string { pattern = "\d{8}T\d{6}(Z|[+\-]\d\d(\d\d)?)?" }
+ }
+
+# 4.4
+value-boolean = element boolean { xsd:boolean }
+
+
+
+
+
+Perreault Standards Track [Page 14]
+
+RFC 6351 xCard August 2011
+
+
+# 4.5
+value-integer = element integer { xsd:integer }
+
+# 4.6
+value-float = element float { xsd:float }
+
+# 4.7
+value-utc-offset = element utc-offset {
+ xsd:string { pattern = "[+\-]\d\d(\d\d)?" }
+ }
+
+# 4.8
+value-language-tag = element language-tag {
+ xsd:string { pattern = "([a-z]{2,3}((-[a-z]{3}){0,3})?|[a-z]{4,8})"
+ ~ "(-[a-z]{4})?(-([a-z]{2}|\d{3}))?"
+ ~ "(-([0-9a-z]{5,8}|\d[0-9a-z]{3}))*"
+ ~ "(-[0-9a-wyz](-[0-9a-z]{2,8})+)*"
+ ~ "(-x(-[0-9a-z]{1,8})+)?|x(-[0-9a-z]{1,8})+|"
+ ~ "[a-z]{1,3}(-[0-9a-z]{2,8}){1,2}" }
+ }
+
+### Section 5: Parameters
+#
+# 5.1
+param-language = element language { value-language-tag }?
+
+# 5.2
+param-pref = element pref {
+ element integer {
+ xsd:integer { minInclusive = "1" maxInclusive = "100" }
+ }
+ }?
+
+# 5.4
+param-altid = element altid { value-text }?
+
+# 5.5
+param-pid = element pid {
+ element text { xsd:string { pattern = "\d+(\.\d+)?" } }+
+ }?
+
+# 5.6
+param-type = element type { element text { "work" | "home" }+ }?
+
+# 5.7
+param-mediatype = element mediatype { value-text }?
+
+
+
+
+
+Perreault Standards Track [Page 15]
+
+RFC 6351 xCard August 2011
+
+
+# 5.8
+param-calscale = element calscale { element text { "gregorian" } }?
+
+# 5.9
+param-sort-as = element sort-as { value-text+ }?
+
+# 5.10
+param-geo = element geo { value-uri }?
+
+# 5.11
+param-tz = element tz { value-text | value-uri }?
+
+### Section 6: Properties
+#
+# 6.1.3
+property-source = element source {
+ element parameters { param-altid, param-pid, param-pref,
+ param-mediatype },
+ value-uri
+ }
+
+# 6.1.4
+property-kind = element kind {
+ element text { "individual" | "group" | "org" | "location" |
+ x-name | iana-token }*
+ }
+
+# 6.2.1
+property-fn = element fn {
+ element parameters { param-language, param-altid, param-pid,
+ param-pref, param-type }?,
+ value-text
+ }
+
+# 6.2.2
+property-n = element n {
+ element parameters { param-language, param-sort-as, param-altid }?,
+ element surname { text }+,
+ element given { text }+,
+ element additional { text }+,
+ element prefix { text }+,
+ element suffix { text }+
+ }
+
+
+
+
+
+
+
+
+Perreault Standards Track [Page 16]
+
+RFC 6351 xCard August 2011
+
+
+# 6.2.3
+property-nickname = element nickname {
+ element parameters { param-language, param-altid, param-pid,
+ param-pref, param-type }?,
+ value-text-list
+ }
+
+# 6.2.4
+property-photo = element photo {
+ element parameters { param-altid, param-pid, param-pref, param-type,
+ param-mediatype }?,
+ value-uri
+ }
+
+# 6.2.5
+property-bday = element bday {
+ element parameters { param-altid, param-calscale }?,
+ (value-date-and-or-time | value-text)
+ }
+
+# 6.2.6
+property-anniversary = element anniversary {
+ element parameters { param-altid, param-calscale }?,
+ (value-date-and-or-time | value-text)
+ }
+
+# 6.2.7
+property-gender = element gender {
+ element sex { "" | "M" | "F" | "O" | "N" | "U" },
+ element identity { text }?
+ }
+
+# 6.3.1
+param-label = element label { value-text }?
+property-adr = element adr {
+ element parameters { param-language, param-altid, param-pid,
+ param-pref, param-type, param-geo, param-tz,
+ param-label }?,
+ element pobox { text }+,
+ element ext { text }+,
+ element street { text }+,
+ element locality { text }+,
+ element region { text }+,
+ element code { text }+,
+ element country { text }+
+ }
+
+
+
+
+
+Perreault Standards Track [Page 17]
+
+RFC 6351 xCard August 2011
+
+
+# 6.4.1
+property-tel = element tel {
+ element parameters {
+ param-altid,
+ param-pid,
+ param-pref,
+ element type {
+ element text { "work" | "home" | "text" | "voice"
+ | "fax" | "cell" | "video" | "pager"
+ | "textphone" }+
+ }?,
+ param-mediatype
+ }?,
+ (value-text | value-uri)
+ }
+
+# 6.4.2
+property-email = element email {
+ element parameters { param-altid, param-pid, param-pref,
+ param-type }?,
+ value-text
+ }
+
+# 6.4.3
+property-impp = element impp {
+ element parameters { param-altid, param-pid, param-pref,
+ param-type, param-mediatype }?,
+ value-uri
+ }
+
+# 6.4.4
+property-lang = element lang {
+ element parameters { param-altid, param-pid, param-pref,
+ param-type }?,
+ value-language-tag
+ }
+
+# 6.5.1
+property-tz = element tz {
+ element parameters { param-altid, param-pid, param-pref,
+ param-type, param-mediatype }?,
+ (value-text | value-uri | value-utc-offset)
+ }
+
+
+
+
+
+
+
+
+Perreault Standards Track [Page 18]
+
+RFC 6351 xCard August 2011
+
+
+# 6.5.2
+property-geo = element geo {
+ element parameters { param-altid, param-pid, param-pref,
+ param-type, param-mediatype }?,
+ value-uri
+ }
+
+# 6.6.1
+property-title = element title {
+ element parameters { param-language, param-altid, param-pid,
+ param-pref, param-type }?,
+ value-text
+ }
+
+# 6.6.2
+property-role = element role {
+ element parameters { param-language, param-altid, param-pid,
+ param-pref, param-type }?,
+ value-text
+ }
+
+# 6.6.3
+property-logo = element logo {
+ element parameters { param-language, param-altid, param-pid,
+ param-pref, param-type, param-mediatype }?,
+ value-uri
+ }
+
+# 6.6.4
+property-org = element org {
+ element parameters { param-language, param-altid, param-pid,
+ param-pref, param-type, param-sort-as }?,
+ value-text-list
+ }
+
+# 6.6.5
+property-member = element member {
+ element parameters { param-altid, param-pid, param-pref,
+ param-mediatype }?,
+ value-uri
+ }
+
+
+
+
+
+
+
+
+
+
+Perreault Standards Track [Page 19]
+
+RFC 6351 xCard August 2011
+
+
+# 6.6.6
+property-related = element related {
+ element parameters {
+ param-altid,
+ param-pid,
+ param-pref,
+ element type {
+ element text {
+ "work" | "home" | "contact" | "acquaintance" |
+ "friend" | "met" | "co-worker" | "colleague" | "co-resident" |
+ "neighbor" | "child" | "parent" | "sibling" | "spouse" |
+ "kin" | "muse" | "crush" | "date" | "sweetheart" | "me" |
+ "agent" | "emergency"
+ }+
+ }?,
+ param-mediatype
+ }?,
+ (value-uri | value-text)
+ }
+
+# 6.7.1
+property-categories = element categories {
+ element parameters { param-altid, param-pid, param-pref,
+ param-type }?,
+ value-text-list
+ }
+
+# 6.7.2
+property-note = element note {
+ element parameters { param-language, param-altid, param-pid,
+ param-pref, param-type }?,
+ value-text
+ }
+
+# 6.7.3
+property-prodid = element prodid { value-text }
+
+# 6.7.4
+property-rev = element rev { value-timestamp }
+
+# 6.7.5
+property-sound = element sound {
+ element parameters { param-language, param-altid, param-pid,
+ param-pref, param-type, param-mediatype }?,
+ value-uri
+ }
+
+
+
+
+
+Perreault Standards Track [Page 20]
+
+RFC 6351 xCard August 2011
+
+
+# 6.7.6
+property-uid = element uid { value-uri }
+
+# 6.7.7
+property-clientpidmap = element clientpidmap {
+ element sourceid { xsd:positiveInteger },
+ value-uri
+ }
+
+# 6.7.8
+property-url = element url {
+ element parameters { param-altid, param-pid, param-pref,
+ param-type, param-mediatype }?,
+ value-uri
+ }
+
+# 6.8.1
+property-key = element key {
+ element parameters { param-altid, param-pid, param-pref,
+ param-type, param-mediatype }?,
+ (value-uri | value-text)
+ }
+
+# 6.9.1
+property-fburl = element fburl {
+ element parameters { param-altid, param-pid, param-pref,
+ param-type, param-mediatype }?,
+ value-uri
+ }
+
+# 6.9.2
+property-caladruri = element caladruri {
+ element parameters { param-altid, param-pid, param-pref,
+ param-type, param-mediatype }?,
+ value-uri
+ }
+
+# 6.9.3
+property-caluri = element caluri {
+ element parameters { param-altid, param-pid, param-pref,
+ param-type, param-mediatype }?,
+ value-uri
+ }
+
+
+
+
+
+
+
+
+Perreault Standards Track [Page 21]
+
+RFC 6351 xCard August 2011
+
+
+# Top-level grammar
+property = property-adr | property-anniversary | property-bday
+ | property-caladruri | property-caluri | property-categories
+ | property-clientpidmap | property-email | property-fburl
+ | property-fn | property-geo | property-impp | property-key
+ | property-kind | property-lang | property-logo
+ | property-member | property-n | property-nickname
+ | property-note | property-org | property-photo
+ | property-prodid | property-related | property-rev
+ | property-role | property-gender | property-sound
+ | property-source | property-tel | property-title
+ | property-tz | property-uid | property-url
+start = element vcards {
+ element vcard {
+ (property
+ | element group {
+ attribute name { text },
+ property*
+ })+
+ }+
+ }
+
+Author's Address
+
+ Simon Perreault
+ Viagenie
+ 2600 boul. Laurier, Suite 625
+ Quebec, QC G1V 4W1
+ Canada
+
+ Phone: +1 418 656 9254
+ EMail: simon.perreault at viagenie.ca
+ URI: http://www.viagenie.ca
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Perreault Standards Track [Page 22]
+
Added: CalendarServer/trunk/doc/RFC/rfc6352-CardDAV.txt
===================================================================
--- CalendarServer/trunk/doc/RFC/rfc6352-CardDAV.txt (rev 0)
+++ CalendarServer/trunk/doc/RFC/rfc6352-CardDAV.txt 2011-09-01 15:06:35 UTC (rev 8040)
@@ -0,0 +1,2691 @@
+
+
+
+
+
+
+Internet Engineering Task Force (IETF) C. Daboo
+Request for Comments: 6352 Apple
+Category: Standards Track August 2011
+ISSN: 2070-1721
+
+
+ CardDAV: vCard Extensions to
+ Web Distributed Authoring and Versioning (WebDAV)
+
+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 Section 2 of RFC 5741.
+
+ Information about the current status of this document, any errata,
+ and how to provide feedback on it may be obtained at
+ http://www.rfc-editor.org/info/rfc6352.
+
+Copyright Notice
+
+ Copyright (c) 2011 IETF Trust and the persons identified as the
+ document authors. All rights reserved.
+
+ This document is subject to BCP 78 and the IETF Trust's Legal
+ Provisions Relating to IETF Documents
+ (http://trustee.ietf.org/license-info) 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
+
+
+
+Daboo Standards Track [Page 1]
+
+RFC 6352 CardDAV August 2011
+
+
+ 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
+
+ 1. Introduction and Overview . . . . . . . . . . . . . . . . . . 4
+ 2. Conventions . . . . . . . . . . . . . . . . . . . . . . . . . 5
+ 3. Requirements Overview . . . . . . . . . . . . . . . . . . . . 6
+ 4. Address Book Data Model . . . . . . . . . . . . . . . . . . . 7
+ 4.1. Address Book Server . . . . . . . . . . . . . . . . . . . 7
+ 5. Address Book Resources . . . . . . . . . . . . . . . . . . . . 7
+ 5.1. Address Object Resources . . . . . . . . . . . . . . . . . 7
+ 5.1.1. Data Type Conversion . . . . . . . . . . . . . . . . . 8
+ 5.1.1.1. Additional Precondition for GET . . . . . . . . . 8
+ 5.2. Address Book Collections . . . . . . . . . . . . . . . . . 9
+ 6. Address Book Feature . . . . . . . . . . . . . . . . . . . . . 10
+ 6.1. Address Book Support . . . . . . . . . . . . . . . . . . . 10
+ 6.1.1. Example: Using OPTIONS for the Discovery of
+ Support for CardDAV . . . . . . . . . . . . . . . . . 10
+ 6.2. Address Book Properties . . . . . . . . . . . . . . . . . 10
+ 6.2.1. CARDDAV:addressbook-description Property . . . . . . . 10
+ 6.2.2. CARDDAV:supported-address-data Property . . . . . . . 11
+ 6.2.3. CARDDAV:max-resource-size Property . . . . . . . . . . 12
+ 6.3. Creating Resources . . . . . . . . . . . . . . . . . . . . 13
+ 6.3.1. Extended MKCOL Method . . . . . . . . . . . . . . . . 13
+ 6.3.1.1. Example - Successful MKCOL Request . . . . . . . . 14
+ 6.3.2. Creating Address Object Resources . . . . . . . . . . 15
+ 6.3.2.1. Additional Preconditions for PUT, COPY, and
+ MOVE . . . . . . . . . . . . . . . . . . . . . . . 16
+ 6.3.2.2. Non-Standard vCard Properties and Parameters . . . 17
+ 6.3.2.3. Address Object Resource Entity Tag . . . . . . . . 18
+ 7. Address Book Access Control . . . . . . . . . . . . . . . . . 18
+ 7.1. Additional Principal Properties . . . . . . . . . . . . . 18
+ 7.1.1. CARDDAV:addressbook-home-set Property . . . . . . . . 19
+ 7.1.2. CARDDAV:principal-address Property . . . . . . . . . . 19
+ 8. Address Book Reports . . . . . . . . . . . . . . . . . . . . . 20
+ 8.1. REPORT Method . . . . . . . . . . . . . . . . . . . . . . 20
+ 8.2. Ordinary Collections . . . . . . . . . . . . . . . . . . . 21
+ 8.3. Searching Text: Collations . . . . . . . . . . . . . . . . 21
+ 8.3.1. CARDDAV:supported-collation-set Property . . . . . . . 22
+ 8.4. Partial Retrieval . . . . . . . . . . . . . . . . . . . . 23
+ 8.5. Non-Standard Properties and Parameters . . . . . . . . . . 23
+
+
+
+
+Daboo Standards Track [Page 2]
+
+RFC 6352 CardDAV August 2011
+
+
+ 8.6. CARDDAV:addressbook-query Report . . . . . . . . . . . . . 23
+ 8.6.1. Limiting Results . . . . . . . . . . . . . . . . . . . 25
+ 8.6.2. Truncation of Results . . . . . . . . . . . . . . . . 25
+ 8.6.3. Example: Partial Retrieval of vCards Matching
+ NICKNAME . . . . . . . . . . . . . . . . . . . . . . . 26
+ 8.6.4. Example: Partial Retrieval of vCards Matching a
+ Full Name or Email Address . . . . . . . . . . . . . . 27
+ 8.6.5. Example: Truncated Results . . . . . . . . . . . . . . 29
+ 8.7. CARDDAV:addressbook-multiget Report . . . . . . . . . . . 31
+ 8.7.1. Example: CARDDAV:addressbook-multiget Report . . . . . 32
+ 8.7.2. Example: CARDDAV:addressbook-multiget Report . . . . . 33
+ 9. Client Guidelines . . . . . . . . . . . . . . . . . . . . . . 34
+ 9.1. Restrict the Properties Returned . . . . . . . . . . . . . 34
+ 9.2. Avoiding Lost Updates . . . . . . . . . . . . . . . . . . 35
+ 9.3. Client Configuration . . . . . . . . . . . . . . . . . . . 35
+ 9.4. Finding Other Users' Address Books . . . . . . . . . . . . 35
+ 10. XML Element Definitions . . . . . . . . . . . . . . . . . . . 36
+ 10.1. CARDDAV:addressbook XML Element . . . . . . . . . . . . . 36
+ 10.2. CARDDAV:supported-collation XML Element . . . . . . . . . 36
+ 10.3. CARDDAV:addressbook-query XML Element . . . . . . . . . . 37
+ 10.4. CARDDAV:address-data XML Element . . . . . . . . . . . . . 37
+ 10.4.1. CARDDAV:allprop XML Element . . . . . . . . . . . . . 39
+ 10.4.2. CARDDAV:prop XML Element . . . . . . . . . . . . . . . 39
+ 10.5. CARDDAV:filter XML Element . . . . . . . . . . . . . . . . 40
+ 10.5.1. CARDDAV:prop-filter XML Element . . . . . . . . . . . 40
+ 10.5.2. CARDDAV:param-filter XML Element . . . . . . . . . . . 41
+ 10.5.3. CARDDAV:is-not-defined XML Element . . . . . . . . . . 42
+ 10.5.4. CARDDAV:text-match XML Element . . . . . . . . . . . . 42
+ 10.6. CARDDAV:limit XML Element . . . . . . . . . . . . . . . . 43
+ 10.6.1. CARDDAV:nresults XML Element . . . . . . . . . . . . . 44
+ 10.7. CARDDAV:addressbook-multiget XML Element . . . . . . . . . 44
+ 11. Service Discovery via SRV Records . . . . . . . . . . . . . . 45
+ 12. Internationalization Considerations . . . . . . . . . . . . . 45
+ 13. Security Considerations . . . . . . . . . . . . . . . . . . . 45
+ 14. IANA Consideration . . . . . . . . . . . . . . . . . . . . . . 46
+ 14.1. Namespace Registration . . . . . . . . . . . . . . . . . . 46
+ 15. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 46
+ 16. References . . . . . . . . . . . . . . . . . . . . . . . . . . 47
+ 16.1. Normative References . . . . . . . . . . . . . . . . . . . 47
+ 16.2. Informative References . . . . . . . . . . . . . . . . . . 48
+
+
+
+
+
+
+
+
+
+
+
+Daboo Standards Track [Page 3]
+
+RFC 6352 CardDAV August 2011
+
+
+1. Introduction and Overview
+
+ 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) [RFC4510], Internet
+ Message Support Protocol [IMSP], and Application Configuration Access
+ Protocol (ACAP) [RFC2244], together with SyncML used for
+ synchronization of such data.
+
+ WebDAV [RFC4918] 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) [RFC3744].
+
+ 3. Principal collections can be used to enumerate and query other
+ users on the system as per WebDAV ACL [RFC3744].
+
+ 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 [RFC2426] 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
+
+
+
+Daboo Standards Track [Page 4]
+
+RFC 6352 CardDAV August 2011
+
+
+ subsequent 3.0 version standardized by the IETF [RFC2426]. 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
+ [RFC6350] and is compatible with this specification.
+
+2. Conventions
+
+ 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 [RFC2119].
+
+ The term "protected" is used in the Conformance field of property
+ definitions as defined in Section 15 of [RFC4918].
+
+ This document uses XML DTD fragments ([W3C.REC-xml-20081126], Section
+ 3.2) as a purely notational convention. WebDAV request and response
+ bodies cannot be validated by a DTD due to the specific extensibility
+ rules defined in Section 17 of [RFC4918] 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.
+
+
+
+
+
+Daboo Standards Track [Page 5]
+
+RFC 6352 CardDAV August 2011
+
+
+ This document inherits, and sometimes extends, DTD productions from
+ Section 14 of [RFC4918].
+
+ 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.
+
+3. Requirements Overview
+
+ This section lists what functionality is required of a CardDAV
+ server. To advertise support for CardDAV, a server:
+
+ o MUST support vCard v3 [RFC2426] as a media type for the address
+ object resource format;
+
+ o MUST support WebDAV Class 3 [RFC4918];
+
+ o MUST support WebDAV ACL [RFC3744];
+
+ o MUST support secure transport as defined in [RFC2818] using
+ Transport Layer Security (TLS) [RFC5246] and using the certificate
+ validation procedures described in [RFC5280];
+
+ o MUST support ETags [RFC2616] with additional requirements
+ specified in Section 6.3.2.3 of this document;
+
+ o MUST support all address book reports defined in Section 8 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 [RFC3253].
+
+ In addition, a server:
+
+ o SHOULD support vCard v4 [RFC6350] as a media type for the address
+ object resource format;
+
+ o SHOULD support the extended MKCOL method [RFC5689] to create
+ address book collections as defined in Section 6.3.1 of this
+ document.
+
+ o SHOULD support the DAV:current-user-principal-URL property as
+ defined in [RFC5397] to give clients a fast way to locate user
+ principals.
+
+
+
+
+
+Daboo Standards Track [Page 6]
+
+RFC 6352 CardDAV August 2011
+
+
+4. Address Book Data Model
+
+ 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 5.1 and
+ 5.2.
+
+4.1. Address Book Server
+
+ 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.
+
+5. Address Book Resources
+
+5.1. Address Object Resources
+
+ 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
+
+
+
+Daboo Standards Track [Page 7]
+
+RFC 6352 CardDAV August 2011
+
+
+ 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.
+
+5.1.1. Data Type Conversion
+
+ 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
+ Section 6.2.2).
+
+ However, clients can use standard HTTP content negotiation behavior
+ (the Accept request header defined in Section 14.1 of [RFC2616]) 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 Section 10.4).
+
+ 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
+ Section 8.7.2 for an example of this.
+
+5.1.1.1. Additional Precondition for GET
+
+ This specification creates additional preconditions for the GET
+ method.
+
+
+
+
+
+
+Daboo Standards Track [Page 8]
+
+RFC 6352 CardDAV August 2011
+
+
+ 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.
+
+5.2. Address Book Collections
+
+ 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:
+
+ <!ELEMENT addressbook EMPTY>
+
+ 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 Section 6.3.1).
+ 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
+ Section 6.2.1 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.
+
+
+
+
+Daboo Standards Track [Page 9]
+
+RFC 6352 CardDAV August 2011
+
+
+ Multiple address book collections MAY be children of the same
+ collection.
+
+6. Address Book Feature
+
+6.1. Address Book Support
+
+ 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.
+
+6.1.1. Example: Using OPTIONS for the Discovery of Support for CardDAV
+
+ >> Request <<
+
+ OPTIONS /addressbooks/users/ HTTP/1.1
+ Host: addressbook.example.com
+
+ >> Response <<
+
+ 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.
+
+6.2. Address Book Properties
+
+6.2.1. CARDDAV:addressbook-description Property
+
+ Name: addressbook-description
+
+ Namespace: urn:ietf:params:xml:ns:carddav
+
+ Purpose: Provides a human-readable description of the address book
+ collection.
+
+
+
+
+Daboo Standards Track [Page 10]
+
+RFC 6352 CardDAV August 2011
+
+
+ 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:
+
+ <!ELEMENT addressbook-description (#PCDATA)>
+ <!-- PCDATA value: string -->
+
+ Example:
+
+ <C:addressbook-description xml:lang="fr-CA"
+ xmlns:C="urn:ietf:params:xml:ns:carddav"
+ >Adresses de Oliver Daboo</C:addressbook-description>
+
+6.2.2. CARDDAV:supported-address-data Property
+
+ 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
+
+
+
+Daboo Standards Track [Page 11]
+
+RFC 6352 CardDAV August 2011
+
+
+ 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
+ (Section 6.3.2.1) 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:
+
+ <!ELEMENT supported-address-data (address-data-type+)>
+
+ <!ELEMENT address-data-type EMPTY>
+ <!ATTLIST address-data-type content-type CDATA "text/vcard"
+ version CDATA "3.0">
+ <!-- content-type value: a MIME media type -->
+ <!-- version value: a version string -->
+
+ Example:
+
+ <C:supported-address-data
+ xmlns:C="urn:ietf:params:xml:ns:carddav">
+ <C:address-data-type content-type="text/vcard" version="3.0"/>
+ </C:supported-address-data>
+
+6.2.3. CARDDAV:max-resource-size Property
+
+ 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.
+
+
+
+
+
+
+Daboo Standards Track [Page 12]
+
+RFC 6352 CardDAV August 2011
+
+
+ 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
+ (Section 6.3.2.1) 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:
+
+ <!ELEMENT max-resource-size (#PCDATA)>
+ <!-- PCDATA value: a numeric value (positive decimal integer) -->
+
+ Example:
+
+ <C:max-resource-size xmlns:C="urn:ietf:params:xml:ns:carddav"
+ >102400</C:max-resource-size>
+
+6.3. Creating Resources
+
+ 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.
+
+6.3.1. Extended MKCOL Method
+
+ An HTTP request using the extended MKCOL method [RFC5689] 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 Section 5.2.
+
+ 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.
+
+
+
+
+
+
+Daboo Standards Track [Page 13]
+
+RFC 6352 CardDAV August 2011
+
+
+ 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.
+
+6.3.1.1. Example - Successful MKCOL Request
+
+ 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.
+
+ >> Request <<
+
+ MKCOL /home/lisa/addressbook/ HTTP/1.1
+ Host: addressbook.example.com
+ Content-Type: text/xml; charset="utf-8"
+ Content-Length: xxx
+
+ <?xml version="1.0" encoding="utf-8" ?>
+ <D:mkcol xmlns:D="DAV:"
+ xmlns:C="urn:ietf:params:xml:ns:carddav">
+ <D:set>
+ <D:prop>
+ <D:resourcetype>
+ <D:collection/>
+ <C:addressbook/>
+ </D:resourcetype>
+ <D:displayname>Lisa's Contacts</D:displayname>
+ <C:addressbook-description xml:lang="en"
+ >My primary address book.</C:addressbook-description>
+ </D:prop>
+ </D:set>
+ </D:mkcol>
+
+
+
+
+
+
+
+
+
+Daboo Standards Track [Page 14]
+
+RFC 6352 CardDAV August 2011
+
+
+ >> Response <<
+
+ 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
+
+ <?xml version="1.0" encoding="utf-8" ?>
+ <D:mkcol-response xmlns:D="DAV:"
+ xmlns:C="urn:ietf:params:xml:ns:carddav">
+ <D:propstat>
+ <D:prop>
+ <D:resourcetype/>
+ <D:displayname/>
+ <C:addressbook-description/>
+ </D:prop>
+ <D:status>HTTP/1.1 200 OK</D:status>
+ </D:propstat>
+ </D:mkcol-response>
+
+6.3.2. Creating Address Object Resources
+
+ 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.
+
+
+
+
+
+
+
+Daboo Standards Track [Page 15]
+
+RFC 6352 CardDAV August 2011
+
+
+ >> Request <<
+
+ 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 at 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
+
+ >> Response <<
+
+ 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.
+
+6.3.2.1. Additional Preconditions for PUT, COPY, and MOVE
+
+ 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.
+
+
+
+
+Daboo Standards Track [Page 16]
+
+RFC 6352 CardDAV August 2011
+
+
+ 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.
+
+ <!ELEMENT no-uid-conflict (DAV:href)>
+
+ (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 (Section 6.2.3) on the
+ address book collection where the resource will be stored.
+
+6.3.2.2. Non-Standard vCard Properties and Parameters
+
+ 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"
+
+
+
+
+
+Daboo Standards Track [Page 17]
+
+RFC 6352 CardDAV August 2011
+
+
+ properties or parameters it uses follow the convention of including a
+ vendor ID in the "X-" name, as described in Section 3.8 of [RFC2426],
+ e.g., "X-ABC-PRIVATE".
+
+6.3.2.3. Address Object Resource Entity Tag
+
+ 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.
+
+7. Address Book Access Control
+
+ CardDAV servers MUST support and adhere to the requirements of WebDAV
+ ACL [RFC3744]. WebDAV ACL provides a framework for an extensible set
+ of privileges that can be applied to WebDAV collections and ordinary
+ resources.
+
+7.1. Additional Principal Properties
+
+ This section defines additional properties for WebDAV principal
+ resources as defined in [RFC3744].
+
+
+
+
+
+
+
+Daboo Standards Track [Page 18]
+
+RFC 6352 CardDAV August 2011
+
+
+7.1.1. CARDDAV:addressbook-home-set Property
+
+ 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:
+
+ <!ELEMENT addressbook-home-set (DAV:href*)>
+
+ Example:
+
+ <C:addressbook-home-set xmlns:D="DAV:"
+ xmlns:C="urn:ietf:params:xml:ns:carddav">
+ <D:href>/bernard/addresses/</D:href>
+ </C:addressbook-home-set>
+
+7.1.2. CARDDAV:principal-address Property
+
+ 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.
+
+
+
+
+
+Daboo Standards Track [Page 19]
+
+RFC 6352 CardDAV August 2011
+
+
+ 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:
+
+ <!ELEMENT principal-address (DAV:href)>
+
+ Example:
+
+ <C:principal-address xmlns:D="DAV:"
+ xmlns:C="urn:ietf:params:xml:ns:carddav">
+ <D:href>/system/cyrus.vcf</D:href>
+ </C:principal-address>
+
+8. Address Book Reports
+
+ 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 Section 3.1.5 of
+ [RFC3253]. 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.
+
+8.1. REPORT Method
+
+ The REPORT method (defined in Section 3.6 of [RFC3253]) 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
+
+
+
+Daboo Standards Track [Page 20]
+
+RFC 6352 CardDAV August 2011
+
+
+ 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 Section 3.8 of [RFC3253]).
+
+8.2. Ordinary Collections
+
+ 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.
+
+8.3. Searching Text: Collations
+
+ 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 [RFC4790] 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 [RFC4790], Section 4.2, 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"
+ [RFC4790] and "i;unicode-casemap" [RFC5051] 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.
+
+
+
+
+
+
+Daboo Standards Track [Page 21]
+
+RFC 6352 CardDAV August 2011
+
+
+ In the absence of a collation explicitly specified by the client, or
+ if the client specifies the "default" collation identifier (as
+ defined in [RFC4790], Section 3.1), the server MUST default to using
+ "i;unicode-casemap" as the collation.
+
+ Wildcards (as defined in [RFC4790], Section 3.2) 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.
+
+8.3.1. CARDDAV:supported-collation-set Property
+
+ 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:
+
+ <!ELEMENT supported-collation-set (
+ supported-collation
+ supported-collation
+ supported-collation*)>
+ <!-- Both "i;ascii-casemap" and "i;unicode-casemap"
+ will be present -->
+
+ <!ELEMENT supported-collation (#PCDATA)>
+
+
+
+
+
+
+
+Daboo Standards Track [Page 22]
+
+RFC 6352 CardDAV August 2011
+
+
+ Example:
+
+ <C:supported-collation-set
+ xmlns:C="urn:ietf:params:xml:ns:carddav">
+ <C:supported-collation>i;ascii-casemap</C:supported-collation>
+ <C:supported-collation>i;octet</C:supported-collation>
+ <C:supported-collation>i;unicode-casemap</C:supported-collation>
+ </C:supported-collation-set>
+
+8.4. Partial Retrieval
+
+ 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 Section 10.4.
+
+8.5. Non-Standard Properties and Parameters
+
+ 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.
+
+8.6. CARDDAV:addressbook-query Report
+
+ 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
+
+
+
+
+Daboo Standards Track [Page 23]
+
+RFC 6352 CardDAV August 2011
+
+
+ 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 Section 10.3.
+
+ 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
+ Section 10.4) specify a media type supported by the server for
+ address object resources.
+
+
+
+
+
+Daboo Standards Track [Page 24]
+
+RFC 6352 CardDAV August 2011
+
+
+ (CARDDAV:supported-filter): The CARDDAV:prop-filter (see
+ Section 10.5.1) and CARDDAV:param-filter (see Section 10.5.2) XML
+ elements used in the CARDDAV:filter XML element (see Section 10.5)
+ 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.
+
+ <!ELEMENT supported-filter (prop-filter*,
+ param-filter*)>
+
+ (CARDDAV:supported-collation): Any XML attribute specifying a
+ collation MUST specify a collation supported by the server as
+ described in Section 8.3.
+
+ 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.
+
+8.6.1. Limiting Results
+
+ 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.
+
+8.6.2. Truncation of Results
+
+ 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 [RFC3744], Section 9.2.
+
+
+
+
+
+Daboo Standards Track [Page 25]
+
+RFC 6352 CardDAV August 2011
+
+
+ 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).
+
+8.6.3. Example: Partial Retrieval of vCards Matching NICKNAME
+
+ 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.
+
+ >> Request <<
+
+ REPORT /home/bernard/addressbook/ HTTP/1.1
+ Host: addressbook.example.com
+ Depth: 1
+ Content-Type: text/xml; charset="utf-8"
+ Content-Length: xxxx
+
+ <?xml version="1.0" encoding="utf-8" ?>
+ <C:addressbook-query xmlns:D="DAV:"
+ xmlns:C="urn:ietf:params:xml:ns:carddav">
+ <D:prop>
+ <D:getetag/>
+ <C:address-data>
+ <C:prop name="VERSION"/>
+ <C:prop name="UID"/>
+ <C:prop name="NICKNAME"/>
+ <C:prop name="EMAIL"/>
+ <C:prop name="FN"/>
+ </C:address-data>
+ </D:prop>
+ <C:filter>
+ <C:prop-filter name="NICKNAME">
+ <C:text-match collation="i;unicode-casemap"
+ match-type="equals"
+ >me</C:text-match>
+ </C:prop-filter>
+ </C:filter>
+ </C:addressbook-query>
+
+
+
+
+
+Daboo Standards Track [Page 26]
+
+RFC 6352 CardDAV August 2011
+
+
+ >> Response <<
+
+ 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
+
+ <?xml version="1.0" encoding="utf-8" ?>
+ <D:multistatus xmlns:D="DAV:"
+ xmlns:C="urn:ietf:params:xml:ns:carddav">
+ <D:response>
+ <D:href>/home/bernard/addressbook/v102.vcf</D:href>
+ <D:propstat>
+ <D:prop>
+ <D:getetag>"23ba4d-ff11fb"</D:getetag>
+ <C:address-data>BEGIN:VCARD
+ VERSION:3.0
+ NICKNAME:me
+ UID:34222-232 at example.com
+ FN:Cyrus Daboo
+ EMAIL:daboo at example.com
+ END:VCARD
+ </C:address-data>
+ </D:prop>
+ <D:status>HTTP/1.1 200 OK</D:status>
+ </D:propstat>
+ </D:response>
+ </D:multistatus>
+
+8.6.4. Example: Partial Retrieval of vCards Matching a Full Name or
+ Email Address
+
+ 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.
+
+ >> Request <<
+
+ REPORT /home/bernard/addressbook/ HTTP/1.1
+ Host: addressbook.example.com
+ Depth: 1
+ Content-Type: text/xml; charset="utf-8"
+ Content-Length: xxxx
+
+
+
+
+
+Daboo Standards Track [Page 27]
+
+RFC 6352 CardDAV August 2011
+
+
+ <?xml version="1.0" encoding="utf-8" ?>
+ <C:addressbook-query xmlns:D="DAV:"
+ xmlns:C="urn:ietf:params:xml:ns:carddav">
+ <D:prop>
+ <D:getetag/>
+ <C:address-data>
+ <C:prop name="VERSION"/>
+ <C:prop name="UID"/>
+ <C:prop name="NICKNAME"/>
+ <C:prop name="EMAIL"/>
+ <C:prop name="FN"/>
+ </C:address-data>
+ </D:prop>
+ <C:filter test="anyof">
+ <C:prop-filter name="FN">
+ <C:text-match collation="i;unicode-casemap"
+ match-type="contains"
+ >daboo</C:text-match>
+ </C:prop-filter>
+ <C:prop-filter name="EMAIL">
+ <C:text-match collation="i;unicode-casemap"
+ match-type="contains"
+ >daboo</C:text-match>
+ </C:prop-filter>
+ </C:filter>
+ </C:addressbook-query>
+
+ >> Response <<
+
+ 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
+
+ <?xml version="1.0" encoding="utf-8" ?>
+ <D:multistatus xmlns:D="DAV:"
+ xmlns:C="urn:ietf:params:xml:ns:carddav">
+ <D:response>
+ <D:href>/home/bernard/addressbook/v102.vcf</D:href>
+ <D:propstat>
+ <D:prop>
+ <D:getetag>"23ba4d-ff11fb"</D:getetag>
+ <C:address-data>BEGIN:VCARD
+ VERSION:3.0
+ NICKNAME:me
+ UID:34222-232 at example.com
+ FN:David Boo
+ EMAIL:daboo at example.com
+
+
+
+Daboo Standards Track [Page 28]
+
+RFC 6352 CardDAV August 2011
+
+
+ END:VCARD
+ </C:address-data>
+ </D:prop>
+ <D:status>HTTP/1.1 200 OK</D:status>
+ </D:propstat>
+ </D:response>
+ <D:response>
+ <D:href>/home/bernard/addressbook/v104.vcf</D:href>
+ <D:propstat>
+ <D:prop>
+ <D:getetag>"23ba4d-ff11fc"</D:getetag>
+ <C:address-data>BEGIN:VCARD
+ VERSION:3.0
+ NICKNAME:oliver
+ UID:34222-23222 at example.com
+ FN:Oliver Daboo
+ EMAIL:oliver at example.com
+ END:VCARD
+ </C:address-data>
+ </D:prop>
+ <D:status>HTTP/1.1 200 OK</D:status>
+ </D:propstat>
+ </D:response>
+ </D:multistatus>
+
+8.6.5. Example: Truncated Results
+
+ 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.
+
+ >> Request <<
+
+ REPORT /home/bernard/addressbook/ HTTP/1.1
+ Host: addressbook.example.com
+ Depth: 1
+ Content-Type: text/xml; charset="utf-8"
+ Content-Length: xxxx
+
+ <?xml version="1.0" encoding="utf-8" ?>
+ <C:addressbook-query xmlns:D="DAV:"
+ xmlns:C="urn:ietf:params:xml:ns:carddav">
+
+
+
+
+
+Daboo Standards Track [Page 29]
+
+RFC 6352 CardDAV August 2011
+
+
+ <D:prop>
+ <D:getetag/>
+ </D:prop>
+ <C:filter test="anyof">
+ <C:prop-filter name="FN">
+ <C:text-match collation="i;unicode-casemap"
+ match-type="contains"
+ >daboo</C:text-match>
+ </C:prop-filter>
+ </C:filter>
+ <C:limit>
+ <C:nresults>2</C:nresults>
+ </C:limit>
+ </C:addressbook-query>
+
+ >> Response <<
+
+ 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
+
+ <?xml version="1.0" encoding="utf-8" ?>
+ <D:multistatus xmlns:D="DAV:"
+ xmlns:C="urn:ietf:params:xml:ns:carddav">
+ <D:response>
+ <D:href>/home/bernard/addressbook/</D:href>
+ <D:status>HTTP/1.1 507 Insufficient Storage</D:status>
+ <D:error><D:number-of-matches-within-limits/></D:error>
+ <D:responsedescription xml:lang="en">
+ Only two matching records were returned
+ </D:responsedescription>
+ </D:response>
+ <D:response>
+ <D:href>/home/bernard/addressbook/v102.vcf</D:href>
+ <D:propstat>
+ <D:prop>
+ <D:getetag>"23ba4d-ff11fb"</D:getetag>
+ </D:prop>
+ <D:status>HTTP/1.1 200 OK</D:status>
+ </D:propstat>
+ </D:response>
+ <D:response>
+ <D:href>/home/bernard/addressbook/v104.vcf</D:href>
+ <D:propstat>
+ <D:prop>
+ <D:getetag>"23ba4d-ff11fc"</D:getetag>
+ </D:prop>
+
+
+
+Daboo Standards Track [Page 30]
+
+RFC 6352 CardDAV August 2011
+
+
+ <D:status>HTTP/1.1 200 OK</D:status>
+ </D:propstat>
+ </D:response>
+ </D:multistatus>
+
+8.7. CARDDAV:addressbook-multiget Report
+
+ 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 Section 8.6),
+ 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 Section 10.7), which MUST contain at least one
+ DAV:href XML element and one optional CARDDAV:address-data element
+ as defined in Section 10.4. 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.
+
+
+
+
+
+Daboo Standards Track [Page 31]
+
+RFC 6352 CardDAV August 2011
+
+
+ Preconditions:
+
+ (CARDDAV:supported-address-data): The attributes "content-type"
+ and "version" of the CARDDAV:address-data XML elements (see
+ Section 10.4) specify a media type supported by the server for
+ address object resources.
+
+ Postconditions:
+
+ None.
+
+8.7.1. Example: CARDDAV:addressbook-multiget Report
+
+ 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.
+
+ >> Request <<
+
+ REPORT /home/bernard/addressbook/ HTTP/1.1
+ Host: addressbook.example.com
+ Depth: 1
+ Content-Type: text/xml; charset="utf-8"
+ Content-Length: xxxx
+
+ <?xml version="1.0" encoding="utf-8" ?>
+ <C:addressbook-multiget xmlns:D="DAV:"
+ xmlns:C="urn:ietf:params:xml:ns:carddav">
+ <D:prop>
+ <D:getetag/>
+ <C:address-data>
+ <C:prop name="VERSION"/>
+ <C:prop name="UID"/>
+ <C:prop name="NICKNAME"/>
+ <C:prop name="EMAIL"/>
+ <C:prop name="FN"/>
+ </C:address-data>
+ </D:prop>
+ <D:href>/home/bernard/addressbook/vcf102.vcf</D:href>
+ <D:href>/home/bernard/addressbook/vcf1.vcf</D:href>
+ </C:addressbook-multiget>
+
+
+
+
+
+
+Daboo Standards Track [Page 32]
+
+RFC 6352 CardDAV August 2011
+
+
+ >> Response <<
+
+ 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
+
+ <?xml version="1.0" encoding="utf-8" ?>
+ <D:multistatus xmlns:D="DAV:"
+ xmlns:C="urn:ietf:params:xml:ns:carddav">
+ <D:response>
+ <D:href>/home/bernard/addressbook/vcf102.vcf</D:href>
+ <D:propstat>
+ <D:prop>
+ <D:getetag>"23ba4d-ff11fb"</D:getetag>
+ <C:address-data>BEGIN:VCARD
+ VERSION:3.0
+ NICKNAME:me
+ UID:34222-232 at example.com
+ FN:Cyrus Daboo
+ EMAIL:daboo at example.com
+ END:VCARD
+ </C:address-data>
+ </D:prop>
+ <D:status>HTTP/1.1 200 OK</D:status>
+ </D:propstat>
+ </D:response>
+ <D:response>
+ <D:href>/home/bernard/addressbook/vcf1.vcf</D:href>
+ <D:status>HTTP/1.1 404 Resource not found</D:status>
+ </D:response>
+ </D:multistatus>
+
+8.7.2. Example: CARDDAV:addressbook-multiget Report
+
+ 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.
+
+
+
+
+
+
+
+
+
+Daboo Standards Track [Page 33]
+
+RFC 6352 CardDAV August 2011
+
+
+ >> Request <<
+
+ REPORT /home/bernard/addressbook/ HTTP/1.1
+ Host: addressbook.example.com
+ Depth: 1
+ Content-Type: text/xml; charset="utf-8"
+ Content-Length: xxxx
+
+ <?xml version="1.0" encoding="utf-8" ?>
+ <C:addressbook-multiget xmlns:D="DAV:"
+ xmlns:C="urn:ietf:params:xml:ns:carddav">
+ <D:prop>
+ <D:getetag/>
+ <C:address-data content-type='text/vcard' version='4.0'/>
+ </D:prop>
+ <D:href>/home/bernard/addressbook/vcf3.vcf</D:href>
+ </C:addressbook-multiget>
+
+ >> Response <<
+
+ 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
+
+ <?xml version="1.0" encoding="utf-8" ?>
+ <D:multistatus xmlns:D="DAV:"
+ xmlns:C="urn:ietf:params:xml:ns:carddav">
+ <D:response>
+ <D:href>/home/bernard/addressbook/vcf3.vcf</D:href>
+ <D:status>HTTP/1.1 415 Unsupported Media Type</D:status>
+ <D:error><C:supported-address-data-conversion/></D:error>
+ <D:responsedescription>Unable to convert from vCard v3.0
+ to vCard v4.0</D:responsedescription>
+ </D:response>
+ </D:multistatus>
+
+9. Client Guidelines
+
+9.1. Restrict the Properties Returned
+
+ 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.
+
+
+
+Daboo Standards Track [Page 34]
+
+RFC 6352 CardDAV August 2011
+
+
+ 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.
+
+9.2. Avoiding Lost Updates
+
+ 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).
+
+9.3. Client Configuration
+
+ 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 [RFC5397] to
+ give clients a fast way to locate user principals.
+
+ Given support for SRV records (Section 11) and DAV:current-user-
+ principal-URL [RFC5397], 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.
+
+9.4. Finding Other Users' Address Books
+
+ 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
+ [RFC3744] 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:
+
+
+
+
+
+
+
+Daboo Standards Track [Page 35]
+
+RFC 6352 CardDAV August 2011
+
+
+ <?xml version="1.0" encoding="utf-8" ?>
+ <D:principal-property-search xmlns:D="DAV:">
+ <D:property-search>
+ <D:prop>
+ <D:displayname/>
+ </D:prop>
+ <D:match>Laurie</D:match>
+ </D:property-search>
+ <D:prop>
+ <C:addressbook-home-set
+ xmlns:C="urn:ietf:params:xml:ns:carddav"/>
+ <D:displayname/>
+ </D:prop>
+ </D:principal-property-search>
+
+ 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.
+
+10. XML Element Definitions
+
+10.1. CARDDAV:addressbook XML Element
+
+ Name: addressbook
+
+ Namespace: urn:ietf:params:xml:ns:carddav
+
+ Purpose: Specifies the resource type of an address book collection.
+
+ Description: See Section 5.2.
+
+ Definition:
+
+ <!ELEMENT addressbook EMPTY>
+
+10.2. CARDDAV:supported-collation XML Element
+
+ Name: supported-collation
+
+ Namespace: urn:ietf:params:xml:ns:carddav
+
+ Purpose: Identifies a single collation via its collation identifier
+ as defined by [RFC4790].
+
+ Description: The CARDDAV:supported-collation contains the text of a
+ collation identifier as described in Section 8.3.1.
+
+
+
+Daboo Standards Track [Page 36]
+
+RFC 6352 CardDAV August 2011
+
+
+ Definition:
+
+ <!ELEMENT supported-collation (#PCDATA)>
+ <!-- PCDATA value: collation identifier -->
+
+10.3. CARDDAV:addressbook-query XML Element
+
+ Name: addressbook-query
+
+ Namespace: urn:ietf:params:xml:ns:carddav
+
+ Purpose: Defines a report for querying address book data
+
+ Description: See Section 8.6.
+
+ Definition:
+
+ <!ELEMENT addressbook-query ((DAV:allprop |
+ DAV:propname |
+ DAV:prop)?, filter, limit?)>
+
+10.4. CARDDAV:address-data XML Element
+
+ 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
+
+
+
+Daboo Standards Track [Page 37]
+
+RFC 6352 CardDAV August 2011
+
+
+ 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 <, >, & etc., entity encoding or
+ the use of a <![CDATA[ ... ]]> construct. In the latter case, the
+ vCard data cannot contain the character sequence "]]>", which is
+ the end delimiter for the CDATA section.
+
+ Definition:
+
+ <!ELEMENT address-data (allprop | prop*)>
+
+ 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;
+
+ <!ELEMENT address-data (#PCDATA)>
+ <!-- PCDATA value: address data -->
+
+ when nested in the DAV:prop XML element in an address book
+ REPORT response to specify the content of a returned
+ address object resource.
+
+ <!ATTLIST address-data content-type CDATA "text/vcard"
+ version CDATA "3.0">
+ <!-- content-type value: a MIME media type -->
+ <!-- version value: a version string -->
+
+ attributes can be used on each variant of the
+ CALDAV:address-data XML element.
+
+
+
+
+
+Daboo Standards Track [Page 38]
+
+RFC 6352 CardDAV August 2011
+
+
+10.4.1. CARDDAV:allprop XML Element
+
+ 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:
+
+ <!ELEMENT allprop EMPTY>
+
+ 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.
+
+10.4.2. CARDDAV:prop XML Element
+
+ 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".
+
+
+
+
+
+Daboo Standards Track [Page 39]
+
+RFC 6352 CardDAV August 2011
+
+
+ Definition:
+
+ <!ELEMENT prop EMPTY>
+
+ <!ATTLIST prop name CDATA #REQUIRED
+ novalue (yes | no) "no">
+ <!-- name value: a vCard property name -->
+ <!-- novalue value: "yes" or "no" -->
+
+ 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.
+
+10.5. CARDDAV:filter XML Element
+
+ 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:
+
+ <!ELEMENT filter (prop-filter*)>
+
+ <!ATTLIST filter test (anyof | allof) "anyof">
+ <!-- test value:
+ anyof logical OR for prop-filter matches
+ allof logical AND for prop-filter matches -->
+
+10.5.1. CARDDAV:prop-filter XML Element
+
+ Name: prop-filter
+
+ Namespace: urn:ietf:params:xml:ns:carddav
+
+ Purpose: Limits the search to specific vCard properties.
+
+
+
+
+
+
+Daboo Standards Track [Page 40]
+
+RFC 6352 CardDAV August 2011
+
+
+ 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:
+
+ <!ELEMENT prop-filter (is-not-defined |
+ (text-match*, param-filter*))>
+
+ <!ATTLIST prop-filter name CDATA #REQUIRED
+ test (anyof | allof) "anyof">
+ <!-- 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 -->
+
+10.5.2. CARDDAV:param-filter XML Element
+
+ Name: param-filter
+
+ Namespace: urn:ietf:params:xml:ns:carddav
+
+ Purpose: Limits the search to specific parameter values.
+
+
+
+
+Daboo Standards Track [Page 41]
+
+RFC 6352 CardDAV August 2011
+
+
+ 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:
+
+ <!ELEMENT param-filter (is-not-defined | text-match)?>
+
+ <!ATTLIST param-filter name CDATA #REQUIRED>
+ <!-- name value: a property parameter name (e.g., "TYPE") -->
+
+10.5.3. CARDDAV:is-not-defined XML Element
+
+ 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:
+
+ <!ELEMENT is-not-defined EMPTY>
+
+10.5.4. CARDDAV:text-match XML Element
+
+ Name: text-match
+
+ Namespace: urn:ietf:params:xml:ns:carddav
+
+ Purpose: Specifies a substring match on a vCard property or
+ parameter value.
+
+
+
+
+Daboo Standards Track [Page 42]
+
+RFC 6352 CardDAV August 2011
+
+
+ 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:
+
+ <!ELEMENT text-match (#PCDATA)>
+ <!-- PCDATA value: string -->
+
+ <!ATTLIST text-match
+ collation CDATA "i;unicode-casemap"
+ negate-condition (yes | no) "no"
+ match-type (equals|contains|starts-with|ends-with) "contains">
+
+10.6. CARDDAV:limit XML Element
+
+ 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.
+
+
+
+Daboo Standards Track [Page 43]
+
+RFC 6352 CardDAV August 2011
+
+
+ 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:
+
+ <!ELEMENT limit (nresults)>
+
+10.6.1. CARDDAV:nresults XML Element
+
+ 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:
+
+ <!ELEMENT nresults (#PCDATA)>
+ <!-- nresults value: unsigned integer, must be digits -->
+
+10.7. CARDDAV:addressbook-multiget XML Element
+
+ Name: addressbook-multiget
+
+ Namespace: urn:ietf:params:xml:ns:carddav
+
+ Purpose: CardDAV report used to retrieve specific address objects
+ via their URIs.
+
+ Description: See Section 8.7.
+
+ Definition:
+
+ <!ELEMENT addressbook-multiget ((DAV:allprop |
+ DAV:propname |
+ DAV:prop)?,
+ DAV:href+)>
+
+
+
+
+
+Daboo Standards Track [Page 44]
+
+RFC 6352 CardDAV August 2011
+
+
+11. Service Discovery via SRV Records
+
+ [RFC2782] 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
+ [RFC2818].
+
+ carddavs: Identifies a CardDAV server that uses HTTP with TLS
+ [RFC2818].
+
+ 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.
+
+12. Internationalization Considerations
+
+ CardDAV allows internationalized strings to be stored and retrieved
+ for the description of address book collections (see Section 6.2.1).
+
+ The CARDDAV:addressbook-query REPORT (Section 8.6) 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 Section 10.5.4).
+
+13. Security Considerations
+
+ 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 [RFC2818]. In particular,
+ if HTTP Basic authentication [RFC2617] 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 [RFC3744] 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"
+
+
+
+Daboo Standards Track [Page 45]
+
+RFC 6352 CardDAV August 2011
+
+
+ (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 [RFC2617] as well as TLS [RFC2818] using client-side
+ certificates.
+
+14. IANA Consideration
+
+ This document uses a URN to describe a new XML namespace conforming
+ to the registry mechanism described in [RFC3688].
+
+14.1. Namespace Registration
+
+ Registration request for the carddav namespace:
+
+ URI: urn:ietf:params:xml:ns:carddav
+
+ Registrant Contact: The IESG <iesg at ietf.org>
+
+ XML: None - not applicable for namespace registrations.
+
+15. Acknowledgments
+
+ 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.
+
+
+
+
+
+
+Daboo Standards Track [Page 46]
+
+RFC 6352 CardDAV August 2011
+
+
+16. References
+
+16.1. Normative References
+
+ [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
+ Requirement Levels", BCP 14, RFC 2119, March 1997.
+
+ [RFC2426] Dawson, F. and T. Howes, "vCard MIME Directory Profile",
+ RFC 2426, September 1998.
+
+ [RFC2616] Fielding, R., Gettys, J., Mogul, J., Frystyk, H.,
+ Masinter, L., Leach, P., and T. Berners-Lee, "Hypertext
+ Transfer Protocol -- HTTP/1.1", RFC 2616, June 1999.
+
+ [RFC2617] Franks, J., Hallam-Baker, P., Hostetler, J., Lawrence, S.,
+ Leach, P., Luotonen, A., and L. Stewart, "HTTP
+ Authentication: Basic and Digest Access Authentication",
+ RFC 2617, June 1999.
+
+ [RFC2782] Gulbrandsen, A., Vixie, P., and L. Esibov, "A DNS RR for
+ specifying the location of services (DNS SRV)", RFC 2782,
+ February 2000.
+
+ [RFC2818] Rescorla, E., "HTTP Over TLS", RFC 2818, May 2000.
+
+ [RFC3253] Clemm, G., Amsden, J., Ellison, T., Kaler, C., and J.
+ Whitehead, "Versioning Extensions to WebDAV
+ (Web Distributed Authoring and Versioning)", RFC 3253,
+ March 2002.
+
+ [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
+ January 2004.
+
+ [RFC3744] Clemm, G., Reschke, J., Sedlar, E., and J. Whitehead, "Web
+ Distributed Authoring and Versioning (WebDAV)
+ Access Control Protocol", RFC 3744, May 2004.
+
+ [RFC4790] Newman, C., Duerst, M., and A. Gulbrandsen, "Internet
+ Application Protocol Collation Registry", RFC 4790,
+ March 2007.
+
+ [RFC4918] Dusseault, L., "HTTP Extensions for Web Distributed
+ Authoring and Versioning (WebDAV)", RFC 4918, June 2007.
+
+ [RFC5051] Crispin, M., "i;unicode-casemap - Simple Unicode Collation
+ Algorithm", RFC 5051, October 2007.
+
+
+
+
+
+Daboo Standards Track [Page 47]
+
+RFC 6352 CardDAV August 2011
+
+
+ [RFC5246] Dierks, T. and E. Rescorla, "The Transport Layer Security
+ (TLS) Protocol Version 1.2", RFC 5246, August 2008.
+
+ [RFC5280] 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", RFC 5280, May 2008.
+
+ [RFC5397] Sanchez, W. and C. Daboo, "WebDAV Current Principal
+ Extension", RFC 5397, December 2008.
+
+ [RFC5689] Daboo, C., "Extended MKCOL for Web Distributed Authoring
+ and Versioning (WebDAV)", RFC 5689, September 2009.
+
+ [RFC6350] Perreault, S., "vCard Format Specification", RFC 6350,
+ August 2011.
+
+ [W3C.REC-xml-20081126]
+ 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,
+ <http://www.w3.org/TR/2008/REC-xml-20081126>.
+
+16.2. Informative References
+
+ [IMSP] Myers, J., "IMSP - Internet Message Support Protocol",
+ Work in Progress, June 1995.
+
+ [RFC2244] Newman, C. and J. Myers, "ACAP -- Application
+ Configuration Access Protocol", RFC 2244, November 1997.
+
+ [RFC4510] Zeilenga, K., "Lightweight Directory Access Protocol
+ (LDAP): Technical Specification Road Map", RFC 4510,
+ June 2006.
+
+Author's Address
+
+ Cyrus Daboo
+ Apple, Inc.
+ 1 Infinite Loop
+ Cupertino, CA 95014
+ USA
+
+ EMail: cyrus at daboo.name
+ URI: http://www.apple.com/
+
+
+
+
+
+Daboo Standards Track [Page 48]
+
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.macosforge.org/pipermail/calendarserver-changes/attachments/20110901/b0b6d66c/attachment-0001.html>
More information about the calendarserver-changes
mailing list