From 64e7b2746076e1823505a0b930daedf0ce303d4f Mon Sep 17 00:00:00 2001
From: Andrew McMillan
Date: Wed, 30 May 2007 20:51:39 +1200
Subject: [PATCH] Remove all of the externally source docs from the repository.
---
docs/.gitignore | 10 +-
docs/IETF-CAP-RFC4324.txt | 7342 -------------
docs/draft-dawson-ical-xml-dtd-01.txt | 1368 ---
docs/draft-desruisseaux-caldav-sched-02.html | 716 --
docs/draft-ietf-calsch-many-xcal-02.txt | 2971 ------
docs/dusseault-caldav-15.txt.html | 6502 ------------
docs/dusseault2005CalDAV.pdf | Bin 313171 -> 0 bytes
docs/rfc2445.html | 8342 ---------------
docs/rfc2518.html | 5109 ---------
docs/rfc2616.html | 9901 ------------------
10 files changed, 9 insertions(+), 42252 deletions(-)
delete mode 100644 docs/IETF-CAP-RFC4324.txt
delete mode 100644 docs/draft-dawson-ical-xml-dtd-01.txt
delete mode 100644 docs/draft-desruisseaux-caldav-sched-02.html
delete mode 100644 docs/draft-ietf-calsch-many-xcal-02.txt
delete mode 100644 docs/dusseault-caldav-15.txt.html
delete mode 100644 docs/dusseault2005CalDAV.pdf
delete mode 100644 docs/rfc2445.html
delete mode 100644 docs/rfc2518.html
delete mode 100644 docs/rfc2616.html
diff --git a/docs/.gitignore b/docs/.gitignore
index ededfe99..1f6b788e 100644
--- a/docs/.gitignore
+++ b/docs/.gitignore
@@ -1,3 +1,11 @@
+IETF-CAP-RFC4324.txt
+draft-dawson-ical-xml-dtd-01.txt
+draft-desruisseaux-caldav-sched-02.html
+draft-ietf-calsch-many-xcal-02.txt
+dusseault-caldav-15.txt.html
+dusseault2005CalDAV.pdf
rfc2068.html
+rfc2445.html
+rfc2518.html
+rfc2616.html
rfc3744.html
-rfc3744.txt
diff --git a/docs/IETF-CAP-RFC4324.txt b/docs/IETF-CAP-RFC4324.txt
deleted file mode 100644
index ba0a2884..00000000
--- a/docs/IETF-CAP-RFC4324.txt
+++ /dev/null
@@ -1,7342 +0,0 @@
-From: http://www.ietf.org/rfc4324.txt
-Title: Calendar Access Protocol (CAP)
-Reference: IETF Network Working Group, Experimental Request for Comments #4324
-Date: December 2005
-
-See also: http://xml.coverpages.org/ni2003-12-31-a.html (CalDAV)
-
-========================================================================
-
-Network Working Group D. Royer
-Request for Comments: 4324 IntelliCal, LLC
-Category: Experimental G. Babics
- Oracle
- S. Mansour
- eBay
- December 2005
-
-
- Calendar Access Protocol (CAP)
-
-Status of This Memo
-
- This memo defines an Experimental Protocol for the Internet
- community. It does not specify an Internet standard of any kind.
- Discussion and suggestions for improvement are requested.
- Distribution of this memo is unlimited.
-
-Copyright Notice
-
- Copyright (C) The Internet Society (2005).
-
-Abstract
-
- The Calendar Access Protocol (CAP) described in this memo permits a
- Calendar User (CU) to utilize a Calendar User Agent (CUA) to access
- an iCAL-based Calendar Store (CS). At the time of this writing,
- three vendors are implementing CAP, but it has already been
- determined that some changes are needed. In order to get
- implementation experience, the participants felt that a CAP
- specification is needed to preserve many years of work. Many
- properties in CAP which have had many years of debate, can be used by
- other iCalendar protocols.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Royer, et al. Experimental [Page 1]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
-Table of Contents
-
- 1. Introduction ....................................................5
- 1.1. Formatting Conventions .....................................5
- 1.2. Related Documents ..........................................6
- 1.3. Definitions ................................................7
- 2. Additions to iCalendar .........................................11
- 2.1. New Value Types (Summary) ................................14
- 2.1.1. New Parameters (summary) .............................14
- 2.1.2. New or Updated Properties (summary) ..................14
- 2.1.3. New Components (summary) .............................17
- 2.2. Relationship of RFC-2446 (ITIP) to CAP ...................18
- 3. CAP Design .....................................................20
- 3.1. System Model ..............................................20
- 3.2. Calendar Store Object Model ...............................20
- 3.3. Protocol Model ............................................21
- 3.3.1. Use of BEEP, MIME, and iCalendar .....................22
- 4. Security Model .................................................23
- 4.1. Calendar User and UPNs ....................................23
- 4.1.1. UPNs and Certificates ................................24
- 4.1.2. Anonymous Users and Authentication ...................25
- 4.1.3. User Groups ..........................................25
- 4.2. Access Rights .............................................26
- 4.2.1. Access Control and NOCONFLICT ........................26
- 4.2.2. Predefined VCARs .....................................26
- 4.2.3. Decreed VCARs ........................................28
- 4.3. CAP Session Identity ......................................28
- 5. CAP URL and Calendar Address ...................................29
- 6. New Value Types ................................................30
- 6.1. Property Value Data Types .................................30
- 6.1.1. CAL-QUERY Value Type .................................30
- 6.1.1.1. [NOT] CAL-OWNERS() ..............................36
- 6.1.1.2. CURRENT-TARGET() ................................37
- 6.1.1.3. PARAM() .........................................37
- 6.1.1.4. SELF() ..........................................38
- 6.1.1.5. STATE() .........................................38
- 6.1.1.6. Use of Single Quote .............................38
- 6.1.1.7. Comparing DATE and DATE-TIME Values .............39
- 6.1.1.8. DTEND and DURATION ..............................40
- 6.1.1.9. [NOT] LIKE ......................................40
- 6.1.1.10. Empty vs. NULL .................................41
- 6.1.1.11. [NOT] IN .......................................41
- 6.1.1.12. DATE-TIME and TIME Values in a WHERE Clause ....42
- 6.1.1.13. Multiple Contained Components ..................43
- 6.1.1.14. Example, Query by UID ..........................43
- 6.1.1.15. Query by Date-Time Range .......................43
- 6.1.1.16. Query for All Unprocessed Entries ..............44
- 6.1.1.17. Query with Subset of Properties by Date/Time ...44
-
-
-
-Royer, et al. Experimental [Page 2]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- 6.1.1.18. Query with Components and Alarms in A Range ....45
- 6.1.2. UPN Value Type .......................................45
- 6.1.3. UPN-FILTER Value .....................................46
- 7. New Parameters .................................................48
- 7.1. ACTION Parameter ..........................................48
- 7.2. ENABLE Parameter ..........................................48
- 7.3. ID Parameter ..............................................49
- 7.4. LATENCY Parameter .........................................50
- 7.5. LOCAL Parameter ...........................................50
- 7.6. LOCALIZE Parameter ........................................51
- 7.7. OPTIONS Parameter .........................................52
- 8. New Properties .................................................52
- 8.1. ALLOW-CONFLICT Property ...................................52
- 8.2. ATT-COUNTER Property ......................................53
- 8.3. CALID Property ............................................54
- 8.4. CALMASTER Property ........................................54
- 8.5. CAP-VERSION Property ......................................55
- 8.6. CARID Property ............................................55
- 8.7. CAR-LEVEL Property ........................................56
- 8.8. COMPONENTS Property .......................................56
- 8.9. CSID Property .............................................58
- 8.10. DECREED Property .........................................58
- 8.11. DEFAULT-CHARSET Property .................................59
- 8.12. DEFAULT-LOCALE Property ..................................60
- 8.13. DEFAULT-TZID Property ....................................61
- 8.14. DEFAULT-VCARS Property ...................................62
- 8.15. DENY Property ............................................62
- 8.16. EXPAND property ..........................................63
- 8.17. GRANT Property ...........................................64
- 8.18. ITIP-VERSION Property ....................................64
- 8.19. MAX-COMP-SIZE Property ...................................65
- 8.20. MAXDATE Property .........................................65
- 8.21. MINDATE Property .........................................66
- 8.22. MULTIPART Property .......................................66
- 8.23. NAME Property ............................................67
- 8.24. OWNER Property ...........................................68
- 8.25. PERMISSION Property ......................................68
- 8.26. QUERY property ...........................................69
- 8.27. QUERYID property .........................................70
- 8.28. QUERY-LEVEL Property .....................................70
- 8.29. RECUR-ACCEPTED Property ..................................71
- 8.30. RECUR-LIMIT Property .....................................71
- 8.31. RECUR-EXPAND Property ....................................72
- 8.32. RESTRICTION Property .....................................72
- 8.33. SCOPE Property ...........................................73
- 8.34. STORES-EXPANDED Property .................................74
- 8.35. TARGET Property ..........................................74
- 8.36. TRANSP Property ..........................................75
-
-
-
-Royer, et al. Experimental [Page 3]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- 9. New Components .................................................76
- 9.1. VAGENDA Component .........................................76
- 9.2. VCALSTORE Component .......................................78
- 9.3. VCAR Component ............................................80
- 9.4. VRIGHT Component ..........................................82
- 9.5. VREPLY Component ..........................................83
- 9.6. VQUERY Component ..........................................83
- 10. Commands and Responses ........................................85
- 10.1. CAP Commands (CMD) .......................................85
- 10.2. ABORT Command ............................................88
- 10.3. CONTINUE Command .........................................89
- 10.4. CREATE Command ...........................................90
- 10.5. DELETE Command ...........................................96
- 10.6. GENERATE-UID Command .....................................98
- 10.7. GET-CAPABILITY Command ..................................100
- 10.8. IDENTIFY Command ........................................103
- 10.9. MODIFY Command ..........................................105
- 10.10. MOVE Command ...........................................110
- 10.11. REPLY Response to a Command ............................112
- 10.12. SEARCH Command .........................................113
- 10.13. SET-LOCALE Command .....................................116
- 10.14. TIMEOUT Command ........................................118
- 10.15. Response Codes .........................................118
- 11. Object Registration ..........................................120
- 11.1. Registration of New and Modified Entities ...............120
- 11.2. Post the Item Definition ................................120
- 11.3. Allow a Comment Period ..................................120
- 11.4. Release a New RFC .......................................120
- 12. BEEP and CAP .................................................120
- 12.1. BEEP Profile Registration ...............................120
- 12.2. BEEP Exchange Styles ....................................123
- 12.3. BEEP Connection Details .................................123
- 13. IANA Considerations ..........................................125
- 14. Security Considerations ......................................125
- Appendix A. Acknowledgements ....................................127
- Appendix B. References ..........................................127
- Appendix B.1. Normative References ..........................127
- Appendix B.2. Informative References ........................128
-
-
-
-
-
-
-
-
-
-
-
-
-
-Royer, et al. Experimental [Page 4]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
-1. Introduction
-
- This document specifies the Calendar Access Protocol (CAP). CAP
- permits a Calendar User (CU) to utilize a Calendar User Agent (CUA)
- to access an iCAL-based Calendar Store (CS) and manage calendar
- information. In particular, the document specifies how to query,
- create, modify, and delete iCalendar components (e.g., events, to-
- dos, or daily journal entries). It further specifies how to search
- for available busy time information. Synchronization with CUAs is
- not covered, but it is believed to be possible using CAP.
-
- At the time of this writing, three vendors are implementing CAP. It
- has already been determined that some changes are needed. In order
- to get implementation experience, the participants felt that a CAP
- specification is needed to preserve many years of work. Many
- properties in CAP can be used by other iCalendar protocols and have
- had many years of debate.
-
- CAP is specified as a BEEP (Block Extensible Exchange Protocol)
- "profile" [BEEP] [BEEPGUIDE]. Many aspects of the protocol (e.g.,
- authentication and privacy) are provided within BEEP. The protocol
- data units of CAP leverage the standard iCalendar format iCAL [iCAL]
- to convey calendar-related information.
-
- CAP can also be used to store and fetch iCalendar Transport-
- Independent Interoperability Protocol (iTIP) objects [iTIP]. iTIP
- objects used are exactly as defined in [iTIP]. When iCalendar
- objects are transferred between the CUA and a CS, some additional
- properties and parameters may be added; the CUA is responsible for
- correctly generating iCalendar objects to non-CAP processes.
-
- The definition of new components, properties, parameters, and value
- types are broken into two parts. The first part summarizes and
- defines the new objects. The second part provides detail and ABNF
- for those objects. The ABNF rules for CAP, as for other iCalendar
- specifications, are order-independent. That is, properties in a
- component may occur in any order, and parameters in any property may
- occur in any order.
-
-1.1. Formatting 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].
-
- 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" (CU)
-
-
-
-Royer, et al. Experimental [Page 5]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- within the protocol defined by [iTIP]. Calendar components defined
- by [iCAL] are referred to with capitalized, quoted-strings of text.
- All iCalendar components should start with the letter "V". For
- example, "VEVENT" refers to the event calendar component, "VTODO"
- refers to the to-do component, and "VJOURNAL" refers to the daily
- journal component.
-
- Scheduling methods defined by [iTIP] are referred to with
- capitalized, quoted-strings of text. For example, "REPLY" refers to
- the method for replying to a "REQUEST".
-
- CAP commands are referred to by upper-case, quoted-strings of text,
- followed by the word "command". For example, '"CREATE" command'
- refers to the command for creating a calendar entry, '"SEARCH"
- command' refers to the command for reading calendar components. CAP
- commands are named using the "CMD" property.
-
- Properties defined by this memo 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 that has been invited to a "VEVENT" or
- "VTODO" component.
-
- Property parameters defined by this memo are referred to with
- capitalized, quoted-strings of text, followed by the word
- "parameter". For example, "PARTSTAT" parameter refers to the
- iCalendar property parameter used to specify the participation status
- of an attendee. Enumerated values defined by this memo are referred
- to with capitalized text, either alone or followed by the word
- "value".
-
- Object states defined by this memo are referred to with capitalized,
- quoted-strings of text, followed by the word "state". For example,
- '"BOOKED" state' refers to an object in the booked state.
-
- Within a query, the different parts are referred to as a "clause" and
- its value as "clause value" and the clause name will be in uppercase
- enclosed in quotes, for example, 'The "SELECT" claus' or 'if the
- "SELECT" clause value contains ...'.
-
- In tables, the quoted-string text is specified without quotes in
- order to minimize the table length.
-
-1.2. Related Documents
-
- Implementers will need to be familiar with several other memos that,
- along with this one, describe the Internet calendaring and scheduling
- standards. These documents are as follows.
-
-
-
-Royer, et al. Experimental [Page 6]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- [iCAL] (RFC2445) specifies the objects, data types, properties and
- property parameters used in the protocols, along with the
- methods for representing and encoding them.
-
- [iTIP] (RFC2446) specifies an interoperability protocol for
- scheduling between different installations.
-
- [iMIP] (RFC2447) specifies the Internet email binding for [iTIP].
-
- [GUIDE] (RFC3283) is a guide to implementers and describes the
- elements of a calendaring system, how they interact with each
- other, how they interact with end users, and how the standards
- and protocols are used.
-
- This memo does not attempt to repeat the specification of concepts
- and definitions from these earlier memos. Where possible, references
- are made to the memo that provides the specification of these
- concepts and definitions.
-
-1.3 Definitions
-
- UNPROCESSED, BOOKED, DELETED - A conceptual state of an object in
- the calendar store. There are three conceptual states:
- "UNPROCESSED" state, "BOOKED" state, and marked for deletion,
- which is the "DELETED" state. How the implementation stores the
- state of any object is not a protocol issue and is not discussed.
- An object can be said to be booked, unprocessed, or marked for
- deletion.
-
- 1. An "UNPROCESSED" state scheduling object has been stored in
- the calendar store but has not been acted on by a CU or CUA.
- All scheduled entries are [iTIP] objects. No [iTIP] objects
- in the store are in the "BOOKED" state. To retrieve any
- [iTIP] object, simply do a query asking for any objects that
- are stored in the "UNPROCESSED" state.
-
- 2. A "BOOKED" state entry is stored with the "CREATE" command.
- It is an object that has been acted on by a CU or CUA and
- there has been a decision to store an object. To retrieve any
- booked object, simply do a query asking for any objects that
- were stored in the "BOOKED" state.
-
- 3. A "DELETED" state entry is created by sending a "DELETE"
- command with the "OPTION" parameter value set to "MARK". To
- retrieve any deleted object, simply do a query asking for any
- objects that were stored in the "DELETED" state. By default
- objects marked for delete are not returned. The CUA must
- specifically ask for marked-for-deletion objects. You cannot
-
-
-
-Royer, et al. Experimental [Page 7]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- ask for components in the "DELETED" state and in other states
- in the same "VQUERY" component, as there would be no way to
- distinguish between them in the reply.
-
- Calendar - A collection of logically related objects or entities
- each of which may be associated with a calendar date and possibly
- time of day. These entities can include calendar properties or
- components. In addition, a calendar might be related to other
- calendars with the "RELATED-TO" property. A calendar is
- identified by its unique calendar identifier. The [iCAL] defines
- the initial calendar properties, calendar components and
- properties that make up the contents of a calendar.
-
- Calendar Access Protocol (CAP) - The Internet protocol that permits
- a CUA to access and manipulate calendars residing on a Calendar
- Store. (This memo.)
-
- Calendar Access Rights (VCAR) - The mechanism for specifying the CAP
- operations ("PERMISSION") that a particular calendar user ("UPN",
- defined below) is granted or denied permission to perform on a
- given calendar object ("SCOPE"). The calendar access rights are
- specified with a "VCAR" component. (Section 9.3)
-
- Calendar Address - Also see Calendar URL, which is the same as a CAP
- address. The calendar address can also be the value to the
- "ATTENDEE" and "ORGANIZER" properties, as defined in [iCAL].
- Calendar URL - A calendar URL is a URL, defined in this memo,
- that specifies the address of a CS or Calendar.
-
- Component - Any object that conforms to the iCalendar object format
- and that is either defined in an Internet Draft, registered with
- IANA, or is an experimental object that is prefixed with "x-".
- Some types of components include calendars, events, to-dos,
- journals, alarms, and time zones. A component consists of
- properties and possibly other contained components. For example,
- an event may contain an alarm component.
-
- Container - This is a generic name for VCALSTORE or VAGENDA.
-
- Properties - An attribute of a particular component. Some
- properties are applicable to different types of components. For
- example, the "DTSTART" property is applicable to the "VEVENT",
- "VTODO", and "VJOURNAL" components. Other components are
- applicable only to an individual type of calendar component. For
- example, the "TZURL" property may only be applicable to the
- "VTIMEZONE" components.
-
-
-
-
-
-Royer, et al. Experimental [Page 8]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- Calendar Identifier (CALID) - A globally unique identifier
- associated with a calendar. Calendars reside within a CS. See
- Qualified Calendar Identifier and Relative Calendar Identifier.
- All CALIDs start with "cap:".
-
- Calendar Policy - A CAP operational restriction on the access or
- manipulation of a calendar. These may be outside the scope of the
- CAP protocol. An example of an implementation or site policy is,
- "events MUST be scheduled in unit intervals of one hour".
-
- Calendar Property - An attribute of a calendar ("VAGENDA"). The
- attribute applies to the calendar, as a whole. For example, the
- "CALSCALE" property specifies the calendar scale (e.g., the
- "GREGORIAN" value) for the all entries within the calendar.
-
- Calendar Store (CS) - The data and service model definitions for a
- Calendar Store as defined in this memo. This memo does not
- specify how the CS is implemented.
-
- Calendar Server - An implementation of a Calendar Store (CS) that
- manages one or more calendars.
-
- Calendar Store Identifier (CSID) - The globally unique identifier
- for an individual CS. A CSID consists of the host and port
- portions of a "Common Internet Scheme Syntax" part of a URL, as
- defined by [URL]. The CSID excludes any reference to a specific
- calendar. (Section 8.9)
-
- Calendar Store Components - Components maintained in a CS specify a
- grouping of calendar store-wide information.
-
- Calendar Store Properties - Properties maintained in a Calendar
- Store represent store-wide information.
-
- Calendar User (CU) - An entity (often biological) that uses a
- calendaring system.
-
- Calendar User Agent (CUA) - The client application that a CU
- utilizes to access and manipulate a calendar.
-
- CAP Session - An open communication channel between a CUA and a CS.
- If the CAP session is authenticated, the CU is "authenticated" and
- it is an "authenticated CAP session".
-
- Contained Component / Contained Properties - A component or property
- that is contained inside of another component. For example, a
- "VALARM" component may be contained inside a "VEVENT" component,
-
-
-
-
-Royer, et al. Experimental [Page 9]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- and a "TRIGGER" property could be a contained property of a
- "VALARM" component.
-
- Delegate - A CU (sometimes called the delegatee) who has been
- assigned participation in a scheduled component (e.g., VEVENT) by
- one of the attendees in the scheduled component (sometimes called
- the delegator). An example of a delegate is a team member told to
- go to a particular meeting in place of another invitee who is
- unable to attend.
-
- Designate - A CU who is authorized to act on behalf of another CU.
- An example of a designate is an assistant.
-
- Experimental - The CUA and CS may implement experimental extensions
- to the protocol. They might also have experimental components,
- properties, and parameters. These extensions MUST start with "x-"
- (or "X-") and should include a vendor prefix (such as "x-
- myvendor-"). There is no guarantee that these experimental
- extensions will interoperate with other implementations. There is
- no guarantee that they will not interact in unpredictable ways
- with other vendor experimental extensions. There is no guarantee
- that the same specific experimental extension is not used by
- multiple vendors in incompatible ways. Implementations should
- limit sending those extensions to other implementations.
-
- Object - A generic name for any component, property, parameter, or
- value type to be used in iCalendar.
-
- Overlapped Booking - A policy that indicates whether or not
- components with a "TRANSP" property not set to "TRANSPARENT-
- NOCONFLICT" or "OPAQUE-NOCONFLICT" value can overlap one another.
- When the policy is applied to a calendar it indicates whether or
- not the time span of any component (VEVENT, VTODO, ...) in the
- calendar can overlap the time span of any other component in the
- same calendar. When applied to an individual object, it indicates
- whether or not any other component's time span can overlap that
- individual component. If the CS does not allow overlapped
- booking, then the CS is unwilling to allow any overlapped bookings
- within any calendar or entry in the CS.
-
- Owner - One or more CUs or UGs that are listed in the "OWNER"
- property in a calendar. There can be more than one owner.
-
- Qualified Calendar Identifier (Qualified CALID) - A CALID in which
- both the scheme and CSID of the CAP URI are present.
-
- Realm - A collection of calendar user accounts, identified by a
- string. The name of the Realm is only used in UPNs. In order to
-
-
-
-Royer, et al. Experimental [Page 10]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- avoid namespace conflict, the Realm SHOULD be postfixed with an
- appropriate DNS domain name (e.g., the foobar Realm could be
- called foobar.example.com).
-
- Relative Calendar Identifier (Relative CALID) - An identifier for an
- individual calendar in a calendar store. It MUST be unique within
- a calendar store. A Relative CALID consists of the "URL path" of
- the "Common Internet Scheme Syntax" portion of a URL, as defined
- by [URI] and [URLGUIDE].
-
- Session Identity - A UPN associated with a CAP session. A session
- gains an identity after successful authentication. The identity
- is used in combination with VCAR to determine access to data in
- the CS.
-
- User Group (UG) - A collection of Calendar Users and/or User Groups.
- These groups are expanded by the CS and may reside either locally
- or in an external database or directory. The group membership may
- be fixed or dynamic over time.
-
- Username - A name that denotes a Calendar User within a Realm. This
- is part of a UPN.
-
- User Principal Name (UPN) - A unique identifier that denotes a CU or
- a group of CUs. (Section 6.1.2)
-
-2. Additions to iCalendar
-
- Several new components, properties, parameters, and value types are
- added in CAP. This section summarizes those new objects.
-
- This memo extends the properties that can go into 'calprops' as
- defined in [iCAL] section 4.6 page 51, to allow [iTIP] objects
- transmitted between a CAP aware CUA and the CS to contain the
- "TARGET" and "CMD" properties. This memo also adds to the [iCAL]
- ABNF to allow IANA and experimental extensions. This memo does not
- address how a CUA transmits [iTIP] or [iMIP] objects to non-CAP
- programs. What follows is ABNF, as described in [ABNF].
-
- calprops= 2*(
-
- ; 'prodid' and 'version' are both REQUIRED,
- ; but MUST NOT occur more than once.
- ;
- prodid /version /
- ;
- ; These are optional, but MUST NOT occur
- ; more than once.
-
-
-
-Royer, et al. Experimental [Page 11]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- ;
- calscale /
- method /
- cmd /
- ;
- ; Target is optional, and may occur more
- ; than once.
- ;
- target / other-props )
- ;
- other-props = *(x-prop) *(iana-prop) *(other-props)
- ;
- iana-prop = ; Any property registered by IANA directly or
- ; included in an RFC that may be applied to
- ; the component and within the rules published.
- ;
- x-prop = ; As defined in [iCAL].
- ;
- methodp = ; As defined in [iCAL].
- ;
- prodid = ; As defined in [iCAL].
- ;
- calscale = ; As defined in [iCAL].
- ;
-
- Another change is that the 'component' part of the 'icalbody' ABNF as
- described in [iCAL] section 4.6 is optional when sending a command,
- as shown in the following updated ABNF:
-
- icalbody = calprops component
-
- ; If the "VCALENDAR" component contains the "CMD"
- ; property then the 'component' is optional:
- ;
- / calprops ; Which MUST include a "CMD" property
- ;
- component = ; As defined in [iCAL].
-
- In addition, a problem exists with the control of "VALARM" components
- and their "TRIGGER" properties. A CU may wish to set its own alarms
- (local alarms) on components. These local alarms are not to be
- forwarded to other CUs, CUAs, or CSs. Similarly, the "SEQUENCE"
- property and the "ENABLE" parameter in local alarms are not to be
- forwarded to other CUs, CUAs, or CSs. Therefore, for the protocol
- between a CUA and a CS, the following changes from [iCAL] section
- 4.6.6 page 67 apply to the CAP protocol:
-
- alarmc = "BEGIN" ":" "VALARM" CRLF
-
-
-
-Royer, et al. Experimental [Page 12]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- alarm-seq
- other-props
- (audioprop / dispprop / emailprop / procprop)
- "END" ":" "VALARM" CRLF
- ;
- emailprop = ; As defined in [iCAL]
- ;
- procprop = ; As defined in [iCAL]
- ;
- dispprop = ; As defined in [iCAL]
- ;
- audioprop = ; As defined in [iCAL]
- ;
- alarm-seq = "SEQUENCE" alarmseqparams ":" posint0 CRLF
- ;
- alarmseqparams = other-params [";" local-param] other-params
- ;
- ; Where DIGIT is defined in [iCAL]
- ;
- posint0 = 1*DIGIT
- posint1 = posintfirst 1*DIGIT
- ;
- ; A number starting with 1 through 9.
- ;
- posintfirst = %x31-39
- ;
- other-params = *(";" xparam) *(";" iana-params)
- *(";" other-params)
- ;
- iana-params = ; Any parameter registered by IANA directly or
- ; included in an RFC that may be applied to
- ; the property and within the rules published.
- ;
- xparam ; As defined in [iCAL].
- ;
-
- The CUA adds a "SEQUENCE" property to each "VALARM" component as it
- books the component. This property, along with the "LOCAL" and
- "ENABLE" parameters, allows the CUA to uniquely identify any VALARM
- in any component. The CUA should remove those before forwarding to
- non-CAP-aware CUAs.
-
- In addition, if a CUA wished to ignore a "TRIGGER" property in a
- "VALARM" component that was supplied to it by the "Organizer", the
- CUA needs a common way to tag that trigger as disabled. So the
- following is a modification to [iCAL] section 4.8.6.3 page 127:
-
- trigger = "TRIGGER" 1*(";" enable-param) (trigrel / trigabs)
-
-
-
-Royer, et al. Experimental [Page 13]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- ;
- trigrel = ; As defined in [iCAL].
- ;
- trigabs = ; As defined in [iCAL].
-
- See Section 7.2 and Section 7.5.
-
-2.1. New Value Types (Summary)
-
- UPN: The UPN value type is a text value type restricted to only UPN
- values (see Section 6.1.2).
-
- UPN-FILTER: Like the UPN value type, but also includes filter rules
- that allow wildcards (see Section 6.1.3).
-
- CALQUERY: The "CAL-QUERY" value type is a query syntax that is used
- by the CUA to specify the rules that apply to a CAP command (see
- Section 6.1.1).
-
-2.1.1. New Parameters (summary)
-
- ACTION - The "ACTION" parameter informs the endpoint if it should
- abort or ask to continue on timeout. (Section 7.1)
-
- ENABLE - The "ENABLE" parameter in CAP is used to tag a property in
- a component as disabled or enabled. (Section 7.2)
-
- ID - The "ID" parameter specifies a unique identifier to be used for
- any outstanding commands.
-
- LATENCY - The "LATENCY" parameter supplies the timeout value for
- command completion to the other endpoint. (Section 7.4)
-
- LOCAL - The "LOCAL" parameter in CAP is used to tag a property in a
- component to signify that the component is local or to be
- distributed. (Section 7.5)
-
- LOCALIZE - The "LOCALIZE" parameter specifies the locale to be used
- in error and warning messages.
-
- OPTIONS - The "OPTIONS" parameter passes optional information for
- the command being sent.
-
-2.1.2. New or Updated Properties (summary)
-
- ALLOW-CONFLICT - Some entries in a calendar might not be valid if
- other entries were allowed to overlap the same time span.
- (Section 8.1)
-
-
-
-Royer, et al. Experimental [Page 14]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- ATT-COUNTER - When storing a "METHOD" property with the "COUNTER"
- method, there needs to be a way to remember the "ATTENDEE" value
- that sent the COUNTER. (Section 8.2)
-
- CAP-VERSION - The version of CAP that the implementation supports.
- (Section 8.5)
-
- CAR-LEVEL - The level of calendar access supported. (Section 8.7)
-
- COMPONENTS - The list of components supported. (Section 8.8)
-
- CSID - The Calendar Store IDentifier (CSID) uniquely identifies a
- CAP server. (Section 8.9)
-
- CALID - Each calendar within a CS needs to be uniquely identifiable.
- The "CALID" property identifies a unique calendar within a CS. It
- can be a full CALID or a relative CALID. (Section 8.3)
-
- CALMASTER - The "CALMASTER" property specifies the contact
- information for the CS. (Section 8.4)
-
- CARID - Access rights can be saved and fetched by unique ID - the
- "CARID" property. (Section 8.6)
-
- CMD - The CAP commands, as well as replies are transmitted using the
- "CMD" property. (Section 10.1)
-
- DECREED - Some access rights are not changeable by the CUA. When
- that is the case, the "DECREED" property value in the "VCAR"
- component will be "TRUE". (Section 8.10)
-
- DEFAULT-CHARSET - The list of charsets supported by the CS. The
- first entry is the default for the CS. (Section 8.11)
-
- DEFAULT-LOCALE - The list of locales supported by the CS. The first
- entry in the list is the default locale. (Section 8.12)
-
- DEFAULT-TZID - This is the list of known timezones supported. The
- first entry is the default. (Section 8.13)
-
- DEFAULT-VCARS - A list of the "CARID" properties that will be used
- to create new calendars. (Section 8.14)
-
- DENY - The UPNs listed in the "DENY" property of a "VCAR" component
- will be denied access, as described in the "VRIGHT" component.
- (Section 8.15)
-
-
-
-
-
-Royer, et al. Experimental [Page 15]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- EXPAND - This property tells the CS if the query reply should expand
- components into multiple instances. The default is "FALSE" and is
- ignored for CSs that cannot expand recurrence rules. (Section
- 8.16)
-
- GRANT - The UPNs listed in the "GRANT" property of a "VCAR"
- component will be allowed access as described in the "VRIGHT"
- component. (Section 8.17)
-
- ITIP-VERSION - The version of [iTIP] supported. (Section 8.18)
-
- MAXDATE - The maximum date supported by the CS. (Section 8.20)
-
- MAX-COMP-SIZE - The largest component size allowed in the
- implementation including attachments in octets. (Section 8.19)
-
- MINDATE - The minimum date supported by the CS. (Section 8.21)
-
- MULTIPART - Passed in the capability messages to indicate which MIME
- multipart types the sender supports. (Section 8.22)
-
- NAME - The "NAME" property is used to add locale-specific
- descriptions into components. (Section 8.23)
-
- OWNER - Each calendar has at least one "OWNER" property. (xref
- target="OWNER"/>) Related to the "CAL-OWNERS()" query clause.
- (Section 6.1.1.1)
-
- PERMISSION - This property specifies the permission being granted or
- denied. Examples are the "SEARCH" and "MODIFY" values. (Section
- 8.25)
-
- QUERY - Used to hold the CAL-QUERY (Section 8.26) for the component.
-
- QUERYID - A unique id for a stored query. (Section 8.27)
-
- QUERY-LEVEL - The level of the query language supported. (Section
- 8.28)
-
- RECUR-ACCEPTED - If the implementation support recurrence rules.
- (Section 8.29)
-
- RECUR-EXPAND - If the implementation support expanding recurrence
- rules. (Section 8.31)
-
- RECUR-LIMIT - Any maximum limit on the number of instances the
- implementation will expand recurring objects. (Section 8.30)
-
-
-
-
-Royer, et al. Experimental [Page 16]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- REQUEST-STATUS - The [iCAL] "REQUEST-STATUS" property is extended to
- include new error numbers.
-
- RESTRICTION - In the final check when granting calendar access
- requests, the CS test the results of a command for the value of
- the "RESTRICTION" property in the corresponding "VRIGHT"
- component, to determine if the access meets that restriction.
- (Section 8.32)
-
- SCOPE - The "SCOPE" property is used in "VRIGHT"s component to
- select the subset of data that may be acted upon when checking
- access rights. (Section 8.33)
-
- SEQUENCE - When the "SEQUENCE" property is used in a "VALARM"
- component, it uniquely identifies the instances of the "VALARM"
- within that component.
-
- STORES-EXPANDED - Specifies if the implementation stores recurring
- objects expanded or not. (Section 8.34)
-
- TARGET - The new "VCALENDAR" component property "TARGET" (Section
- 8.35) is used to specify which calendar(s) will be the subject of
- the CAP command.
-
- TRANSP - This is a modification of the [iCAL] "TRANSP" property and
- it allows more values. The new values are related to conflict
- control. (Section 8.36)
-
-2.1.3. New Components (summary)
-
- VAGENDA - CAP allows the fetching and storing of the entire contents
- of a calendar. The "VCALENDAR" component is not sufficient to
- encapsulate all of the needed data that describes a calendar. The
- "VAGENDA" component is the encapsulating object for an entire
- calendar. (Section 9.1)
-
- VCALSTORE - Each CS contains one or more calendars (VAGENDAs), the
- "VCALSTORE" component is the encapsulating object that can hold
- all of the "VAGENDA" components along with any components and
- properties that are unique to the store level. (Section 9.2)
-
- VCAR - Calendar Access Rights are specified and encapsulated in the
- new iCalendar "VCAR" component. The "VCAR" component holds some
- new properties and at least one "VRIGHT" component. (Section 9.3)
-
- VRIGHT - This component encapsulates a set of instructions to the
- CS to define the rights or restrictions needed. (Section 9.4)
-
-
-
-
-Royer, et al. Experimental [Page 17]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- VREPLY - This component encapsulates a set of data that can consist
- of an arbitrary number of properties and components. Its contents
- are dependent on the command that was issued. (Section 9.5)
-
- VQUERY - The search operation makes use of a new component, called
- "VQUERY" and a new value type "CAL-QUERY" (Section 6.1.1). The
- "VQUERY" component is used to fetch objects from the CS. (Section
- 9.6)
-
-2.2. Relationship of RFC-2446 (ITIP) to CAP
-
- [iTIP] describes scheduling methods that result in indirect
- manipulation of components. In CAP, the "CREATE" command is used to
- deposit entities into the store. Other CAP commands, such as
- "DELETE", "MODIFY", and "MOVE" command values, provide direct
- manipulation of components. In the CAP calendar store model,
- scheduling messages are conceptually kept separate from other
- components by their state.
-
- All scheduling operations are as defined in [iTIP]. This memo makes
- no changes to any of the methods or procedures described in [iTIP].
- In this memo, referring to the presence of the "METHOD" property in
- an object is the same as saying an [iTIP] object.
-
- A CUA may create a "BOOKED" state object by depositing an iCalendar
- object into the store. This is done by depositing an object that
- does not have a "METHOD" property. The CS then knows to set the
- state of the object to the "BOOKED" state. If the object has a
- "METHOD" property, then the object is stored in the "UNPROCESSED"
- state.
-
- If existing "UNPROCESSED" state objects exist in the CS for the same
- UID (UID is defined in [iCAL]), then a CUA may wish to consolidate
- the objects into one "BOOKED" state object. The CUA would fetch the
- "UNPROCESSED" state objects for that UID and process them in the CUA
- as described in [iTIP]. Then, if the CUA wished to book the UID, the
- CUA would issue a "CREATE" command to create the new "BOOKED" state
- object in the CS, followed by a "DELETE" command to remove any
- related old [iTIP] objects from the CS. It might also involve the
- CUA sending some [iMIP] objects or contacting other CSs and
- performing CAP operations on those CSs.
-
- The CUA could also decide not to book the object. In this case, the
- "UNPROCESSED" state objects could be removed from the CS, or the CUA
- could set those objects to the marked-for-delete state. The CUA
- could also ignore objects for later processing.
-
-
-
-
-
-Royer, et al. Experimental [Page 18]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- The marked-for-delete state is used to keep the object around so that
- the CUA can process duplicate requests automatically. If a duplicate
- [iTIP] object is deposited into the CS and there exists identical
- marked-for-delete objects, then a CUA acting on behalf of the "OWNER"
- can silently drop those duplicate entries.
-
- Another purpose for the marked-for-delete state is so that, when a CU
- decides they do not wish to have the object show in their calendar,
- the CUA can book the object by changing the "PARTSTAT" parameter to
- "DECLINED" in the "ATTENDEE" property that corresponds to their UPN.
- Then the CUA can perform [iTIP] processing such as sending back a
- decline, and then mark that object as marked-fo-delete. The CUA
- might be configurable to automatically drop any updates for that
- object, knowing the CU has already declined.
-
- When synchronizing with multiple CUAs, the marked-for-delete state
- could be used to inform the synchronization process that an object is
- to be deleted. How synchronization is done is not specified in this
- memo.
-
- Several "UNPROCESSED" state entries can be in the CS for the same
- UID. However, once consolidated, only one object exists in the CS
- and that is the booked object. The other objects MUST be removed or
- have their state changed to "DELETED".
-
- There MUST NOT be more than one "BOOKED" state object in a calendar
- for the same "UID". The "ADD" method value may create multiple
- objects in the "BOOKED" state for the same UID; however, for the
- purpose of this memo, they are the same object and simply have
- multiple "VCALENDAR" components.
-
- For example, if you were on vacation, you could have received a
- "REQUEST" method to attend a meeting and several updates to that
- meeting. Your CUA would have to issue "SEARCH" commands to find them
- in the CS using CAP, process them, and determine the final state of
- the object from a possible combination of user input and programmed
- logic. Then the CUA would instruct the CS to create a new booked
- object from the consolidated results. Finally, the CUA could do a
- "DELETE" command to remove the related "UNPROCESSED" state objects.
- See [iTIP] for details on resolving multiple [iTIP] scheduling
- entries.
-
-
-
-
-
-
-
-
-
-
-Royer, et al. Experimental [Page 19]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
-3. CAP Design
-
-3.1. System Model
-
- The system model describes the high level components of a calendar
- system and how they interact with each other.
-
- CAP is used by a CUA to send commands to, and receive responses from,
- a CS.
-
- The CUA prepares a [MIME] encapsulated message, sends it to the CS,
- and receives a [MIME] encapsulated response. The calendaring-related
- information within these messages are represented by iCalendar
- objects. In addition, the "GET-CAPABILITY" command can be sent from
- the CS to the CUA.
-
- There are two distinct protocols in operation to accomplish this
- exchange. [BEEP] is the transport protocol used to move these
- encapsulations between a CUA and a CS. CAP's [BEEP] profile defines
- the application protocol that specifies the content and semantics of
- the messages sent between the CUA and the CS.
-
-3.2. Calendar Store Object Model
-
- [iCAL] describes components such as events, todos, alarms, and
- timezones. CAP requires additional object infrastructure, in
- particular, detailed definitions of the containers for events and
- todos (calendars), access control objects, and a query language.
-
- The conceptual model for a calendar store is shown below. The
- calendar store (VCALSTORE - Section 9.2) contains "VCAR"s, "VQUERY"s,
- "VTIMEZONE"s, "VAGENDA"s and calendar store properties.
-
- Calendars (VAGENDAs) contain "VEVENT"s, "VTODO"s, "VJOURNAL"s,
- "VCAR"s, "VTIMEZONE"s, "VFREEBUSY", "VQUERY"s, and calendar
- properties.
-
- The component "VCALSTORE" is used to denote the root of the calendar
- store and contains all of the calendars.
-
-
-
-
-
-
-
-
-
-
-
-
-Royer, et al. Experimental [Page 20]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- Calendar Store
-
- VCALSTORE
- |
- +-- properties
- +-- VCARs
- +-- VQUERYs
- +-- VTIMEZONEs
- +-- VAGENDA
- | |
- | +--properties
- | +--VEVENTs
- | | |
- | | +--VALARMs
- | +--VTODOs
- | | |
- | | +--VALARMs
- | +--VJOURNALs
- | +--VCARs
- | +--VTIMEZONEs
- | +--VQUERYs
- | +--VFREEBUSYs
- | |
- | | ...
- .
- .
- +-- VAGENDA
- . .
- . .
- . .
-
- Calendars within a Calendar Store are identified by their unique
- Relative CALID.
-
-3.3. Protocol Model
-
- CAP uses [BEEP] as the transport and authentication protocol.
-
- The initial charset MUST be UTF-8 for a session in an unknown locale.
- If the CS supplied the [BEEP] 'localize' attribute in the [BEEP]
- 'greeting', then the CUA may tell the CS to switch locales for the
- session by issuing the "SET-LOCALE" CAP command and supplying one of
- the locales supplied by the [BEEP] 'localize' attribute. If a locale
- is supplied, the first locale in the [BEEP] 'localize' attribute is
- the default locale of the CS. The locale is switched only after a
- successful reply.
-
-
-
-
-
-Royer, et al. Experimental [Page 21]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- The "DEFAULT-CHARSET" property of the CS contains the list of
- charsets supported by the CS with the first value being the default
- for new calendars. If the CUA wishes to switch to one of those
- charsets for the session, the CUA issues the "SET-LOCALE" command.
- The CUA would have to first perform a "GET-CAPABILITY" command on the
- CS to get the list of charsets supported by the CS. The charset is
- switched only after a successful reply.
-
- The CUA may switch locales and charsets as needed. There is no
- requirement that a CS support multiple locales or charsets.
-
-3.3.1. Use of BEEP, MIME, and iCalendar
-
- CAP uses the [BEEP] application protocol over TCP. Refer to [BEEP]
- and [BEEPTCP] for more information. The default port on which the CS
- listens for connections is user port 1026.
-
- The [BEEP] data exchanged in CAP is a iCalendar MIME content that
- fully conforms to [iCAL] iCalendar format.
-
- This example tells the CS to generate and return 10 UIDs to be used
- by the CUA. Note that throughout this memo, 'C:' refers to what the
- CUA sends, 'S:' refers to what the CS sends, 'I:' refers to what the
- initiator sends, and 'L:' refers to what the listener sends. Here
- initiator and listener are used as defined in [BEEP].
-
- C: MSG 1 2 . 432 62
- C: Content-Type: text/calendar
- C:
- C: BEGIN:VCALENDAR
- C: VERSION:2.0
- C: PRODID:-//someone's prodid
- C: CMD;ID=unique-per-cua-123;OPTIONS=10:GENERATE-UID
- C: END:VCALENDAR
-
- NOTE: The following examples will not include the [BEEP] header and
- footer information. Only the iCalendar objects that are sent between
- the CUA and CS will be shown because the [BEEP] payload boundaries
- are independent of CAP.
-
- The commands listed below are used to manipulate or access the data
- on the calendar store:
-
- ABORT - Sent to halt the processing of some of the commands.
- (Section 10.2)
-
- CONTINUE - Sent to continue processing a command that has reached
- its specified timeout time. (Section 10.3)
-
-
-
-Royer, et al. Experimental [Page 22]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- CREATE - Create a new object on the CS. Initiated only by the CUA.
- (Section 10.4)
-
- SET-LOCALE - Tell the CS to use any named locale and charset
- supplied. Initiated by the CUA only. (Section 10.13)
-
- DELETE - Delete objects from the CS. Initiated only by the CUA.
- Can also be used to mark an object for deletion. (Section 10.5)
-
- GENERATE-UID - Generate one or more unique ids. Initiated only by
- the CUA. (Section 10.6)
-
- GET-CAPABILITY - Query the capabilities of the other end point of the
- session. (Section 10.7)
-
- IDENTIFY - Set a new identity for the session. Initiated only by
- the CUA. (Section 10.8)
-
- MODIFY - Modify components. Initiated by the CUA only. (Section
- 10.9)
-
- MOVE - Move components to another container. Initiated only by the
- CUA. (Section 10.10)
-
- REPLY - When replying to a command, the "CMD" value will be set to
- "REPLY" so that it will not be confused with a new command.
- (Section 10.11)
-
- SEARCH - Search for components. Initiated only by the CUA.
- (Section 10.12)
-
- TIMEOUT - Sent when a specified amount of time has lapsed and a
- command has not finished. (Section 10.14)
-
-4. Security Model
-
- BEEP transport performs all session authentication.
-
-4.1. Calendar User and UPNs
-
- A CU is an entity that can be authenticated. It is represented in
- CAP as a UPN, which is a key part of access rights. The UPN
- representation is independent of the authentication mechanism used
- during a particular CUA/CS interaction. This is because UPNs are
- used within VCARs. If the UPN were dependent on the authentication
- mechanism, a VCAR could not be consistently evaluated. A CU may use
- one mechanism while using one CUA, but the same CU may use a
-
-
-
-
-Royer, et al. Experimental [Page 23]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- different authentication mechanism when using a different CUA, or
- while connecting from a different location.
-
- The user may also have multiple UPNs for various purposes.
-
- Note that the immutability of the user's UPN may be achieved by using
- SASL's authorization identity feature. The transmitted authorization
- identity may be different than the identity in the client's
- authentication credentials [SASL, section 3]. This also permits a CU
- to authenticate using their own credentials, yet request the access
- privileges of the identity for which they are proxying SASL. Also,
- the form of authentication identity supplied by a service like TLS
- may not correspond to the UPNs used to express a server's access
- rights, requiring a server-specific mapping to be done. The method
- by which a server determines a UPN, based on the authentication
- credentials supplied by a client, is implementation-specific. See
- [BEEP] for authentication details; [BEEP] relies on SASL.
-
-4.1.1. UPNs and Certificates
-
- When using X.509 certificates for purposes of CAP authentication, the
- UPN should appear in the certificate. Unfortunately, there is no
- single correct guideline for which field should contain the UPN.
-
- Quoted from RFC-2459, section 4.1.2.6 (Subject):
-
- If subject naming information is present only in the
- subjectAlt-Name extension (e.g., a key bound only to an email
- address or URI), then the subject name MUST be an empty
- sequence and the subjectAltName extension MUST be critical.
-
- Implementations of this specification MAY use these comparison
- rules to process unfamiliar attribute types (i.e., for name
- chaining). This allows implementations to process certificates
- with unfamiliar attributes in the subject name.
-
- In addition, legacy implementations exist where an RFC 2822
- name [RFC2822] is embedded in the subject distinguished name as
- an EmailAddress attribute. The attribute value for
- EmailAddress is of type IA5String to permit inclusion of the
- character '@', which is not part of the PrintableString
- character set. EmailAddress attribute values are not case
- sensitive (e.g., "fanfeedback@redsox.example.com" is the same
- as "FANFEEDBACK@REDSOX.EXAMPLE.COM").
-
- Conforming implementations generating new certificates with
- electronic mail addresses MUST use the rfc822Name in the
- subject alternative name field (see sec. 4.2.1.7 of [X509CRL])
-
-
-
-Royer, et al. Experimental [Page 24]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- to describe such identities. Simultaneous inclusion of the
- EmailAddress attribute in the subject distinguished name to
- support legacy implementations is deprecated but permitted.
-
- Since no single method of including the UPN in the certificate will
- work in all cases, CAP implementations MUST support the ability to
- configure what the mapping will be by the CS administrator.
- Implementations MAY support multiple mapping definitions, for
- example, the UPN may be found in either the subject alternative name
- field, or the UPN may be embedded in the subject distinguished name
- as an EmailAddress attribute.
-
- Note: If a CS or CUA is validating data received via [iMIP], if the
- "ORGANIZER" or "ATTENDEE" properties said, for example,
- "ATTENDEE;CN=Joe Random User:MAILTO:juser@example.com", then the
- email address should be checked against the UPN. This is so the
- "ATTENDEE" property cannot be changed to something misleading like
- "ATTENDEE;CN=Joe Rictus User:MAILTO:jrictus@example.com" and have it
- pass validation. Note that it is the email addresses that
- miscompare, the CN miscompare is irrelevant.
-
-4.1.2. Anonymous Users and Authentication
-
- Anonymous access is often desirable. For example, an organization
- may publish calendar information that does not require any access
- control for viewing or login. Conversely, a user may wish to view
- unrestricted calendar information without revealing their identity.
-
-4.1.3. User Groups
-
- A User Group is used to represent a collection of CUs or other UGs
- that can be referenced in VCARs. A UG is represented in CAP as a
- UPN. The CUA cannot distinguish between a UPN that represents a CU
- or a UG.
-
- UGs are expanded as necessary by the CS. The CS MAY expand a UG
- (including nested UGs) to obtain a list of unique CUs. Duplicate
- UPNs are filtered during expansion.
-
- How the UG expansion is maintained across commands is
- implementation-specific. A UG may reference a static list of
- members, or it may represent a dynamic list. Operations SHOULD
- recognize changes to UG membership.
-
- CAP does not define commands or methods for managing UGs.
-
-
-
-
-
-
-Royer, et al. Experimental [Page 25]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
-4.2. Access Rights
-
- Access rights are used to grant or deny access to calendars,
- components, properties, and parameters in a CS to a CU. CAP defines
- a new component type called a Calendar Access Right (VCAR).
- Specifically, a "VCAR" component grants, or denies, UPNs the right to
- search and write components, properties, and parameters on calendars
- within a CS.
-
- The "VCAR" component model does not put any restriction on the
- sequence in which the object and access rights are created. That is,
- an object associated with a particular "VCAR" component might be
- created before or after the actual "VCAR" component is defined. In
- addition, the "VCAR" and "VEVENT" components might be created in the
- same iCalendar object and passed together in a single object.
-
- All rights MUST be denied unless specifically granted.
-
- If two rights specified in "VCAR" components are in conflict, the
- right that denies access always takes precedence over the right that
- grants access. Any attempt to create a "VCAR" component that
- conflicts with a "VCAR" components with a "DECREED" property set to
- the "TRUE" value must fail.
-
-4.2.1. Access Control and NOCONFLICT
-
- The "TRANSP" property can take on values -- "TRANSPARENT-NOCONFLICT"
- and "OPAQUE-NOCONFLICT" -- that prohibit other components from
- overlapping it. This setting overrides access. The "ALLOW-CONFLICT"
- CS, Calendar or component setting may also prevent overlap, returning
- an error code "6.3".
-
-4.2.2. Predefined VCARs
-
- The predefined calendar access CARIDs that MUST be implemented are:
-
- CARID:READBUSYTIMEINFO - Specifies the "GRANT" and "DENY" rules
- that allow UPNs to search "VFREEBUSY" components. An example
- definition for this VCAR is:
-
- BEGIN:VCAR
- CARID:READBUSYTIMEINFO
- BEGIN:VRIGHT
- GRANT:*
- PERMISSION:SEARCH
- SCOPE:SELECT * FROM VFREEBUSY WHERE STATE() = 'BOOKED'
- END:VRIGHT
- END:VCAR
-
-
-
-Royer, et al. Experimental [Page 26]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- CARID:REQUESTONLY - Specifies the "GRANT" and "DENY" rules to
- UPNs other than the owner of the calendar and specifies the
- ability to write new objects with the "METHOD" property set to
- the "REQUEST" value. This CARID allows the owner to specify
- which UPNs are allowed to make scheduling requests. An example
- definition for this VCAR is:
-
- BEGIN:VCAR
- CARID:REQUESTONLY
- BEGIN:VRIGHT
- GRANT:NON CAL-OWNERS()
- PERMISSION:CREATE
- RESTRICTION:SELECT VEVENT FROM VAGENDA
- WHERE METHOD = 'REQUEST'
- RESTRICTION:SELECT VTODO FROM VAGEND
- WHERE METHOD = 'REQUEST'
- RESTRICTION:SELECT VJOURNAL FROM VAGEND
- WHERE METHOD = 'REQUEST'
- END:VRIGHT
- END:VCAR
-
- CARID:UPDATEPARTSTATUS - Grants authenticated users the right to
- modify the instances of the "ATTENDEE" property set to one of
- their calendar addresses in any components for any booked
- component containing an "ATTENDEE" property. This allows (or
- denies) a CU the ability to update their own participation
- status in a calendar where they might not otherwise have
- "MODIFY" command access. They are not allowed to change the
- "ATTENDEE" property value. An example definition for this VCAR
- (only affecting the "VEVENT" components) is:
-
- BEGIN:VCAR
- CARID:UPDATEPARTSTATUS
- BEGIN:VRIGHT
- GRANT:*
- PERMISSION:MODIFY
- SCOPE:SELECT ATTENDEE FROM VEVENT
- WHERE ATTENDEE = SELF()
- AND ORGANIZER = CURRENT-TARGET()
- AND STATE() = 'BOOKED'
- RESTRICTION:SELECT * FROM VEVENT
- WHERE ATTENDEE = SELF()
- END:VRIGHT
- END:VCAR
-
- CARID:DEFAULTOWNER - Grants to any owner the permission they have
- for the target. An example definition for this VCAR is:
-
-
-
-
-Royer, et al. Experimental [Page 27]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- BEGIN:VCAR
- CARID:DEFAULTOWNER
- BEGIN:VRIGHT
- GRANT:CAL-OWNERS()
- PERMISSION:*
- SCOPE:SELECT * FROM VAGENDA
- END:VRIGHT
- END:VCAR
-
-4.2.3. Decreed VCARs
-
- A CS MAY choose to implement and allow persistent immutable VCARs
- that may be configured by the CS administrator. A reply from the CS
- may dynamically create "VCAR" components that are decreed depending
- on the implementation. To the CUA, any "VCAR" component with the
- "DECREED" property set to "TRUE" cannot be changed by the currently
- authenticated UPN, and, depending on the implementation and other
- "VCAR" components, might not be able to be changed by any UPN using
- CAP (never when the CUA gets a "DECREED:TRUE" VCAR).
-
- When a user attempts to modify or override a decreed "VCAR" component
- rules, an error will be returned indicating that the user has
- insufficient authorization to perform the operation. The reply to
- the CUA MUST be the same as if a non-decreed VCAR caused the failure.
-
- The CAP protocol does not define the semantics used to initially
- create a decreed VCAR. This administrative task is outside the scope
- of the CAP protocol.
-
- For example, an implementation or a CS administrator may wish to
- define a VCAR that will always allow the calendar owners to have full
- access to their own calendars.
-
- Decreed "VCAR" components MUST be readable by the calendar owner in
- standard "VCAR" component format.
-
-4.3. CAP Session Identity
-
- A [BEEP] session has an associated set of authentication credentials,
- from which is derived a UPN. This UPN is the identity of the CAP
- session, and is used to determine access rights for the session.
-
- The CUA may change the identity of a CAP session by calling the
- "IDENTIFY" command. The CS only permits the operation if the
- session's authentication credentials are good for the requested
- identity. The method of checking this permission is implementation-
- dependent, but it may be thought of as a mapping from authentication
- credentials to UPNs. The "IDENTIFY" command allows a single set of
-
-
-
-Royer, et al. Experimental [Page 28]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- authentication credentials to choose from multiple identities, and
- allows multiple sets of authentication credentials to assume the same
- identity.
-
- For anonymous access, the identity of the session is "@". A UPN with
- a null Username and null Realm is anonymous. A UPN with a null
- Username but non-null Realm (e.g.,"@example.com") may be used to mean
- any identity from that Realm. This is useful to grant access rights
- to all users in a given Realm. A UPN with a non-null Username and
- null Realm (e.g., "bob@") could be a security risk and MUST NOT be
- used.
-
- Because the UPN includes Realm information, it may be used to govern
- calendar store access rights across Realms. However, governing
- access rights across Realms is only useful if login access is
- available. This could be done through a trusted server relationship
- or a temporary account. Note that trusted server relationships are
- outside the scope of CAP.
-
- The "IDENTIFY" command also provides for a weak group implementation.
- By allowing multiple sets of authentication credentials belonging to
- different users to identify as the same UPN, that UPN essentially
- identifies a group of people, and may be used for group calendar
- ownership, or the granting of access rights to a group.
-
-5. CAP URL and Calendar Address
-
- The CAP URL scheme is used to designate both calendar stores and
- calendars accessible using the CAP protocol.
-
- The CAP URL scheme conforms to the generic URL syntax defined in RFC
- 2396 and follows the Guidelines for URL Schemes set forth in RFC
- 2718.
-
- A CAP URL begins with the protocol prefix "cap" and is defined by the
- following grammar.
-
- capurl = "cap://" csidpart [ "/" relcalid ]
- ;
- csidpart = hostport ; As defined in Section 3.2.2 of RFC 2396
- ;
- relcalid = *uric ; As defined in Section 2 of RFC 2396
-
- A 'relcalid' is an identifier that uniquely identifies a calendar on
- a particular calendar store. There is no implied structure in a
- Relative CALID (relcalid). It may refer to the calendar of a user or
- of a resource such as a conference room. It MUST be unique within
- the calendar store.
-
-
-
-Royer, et al. Experimental [Page 29]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- Here are some examples:
-
- cap://cal.example.com
- cap://cal.example.com/Company/Holidays
- cap://cal.example.com/abcd1234Usr
-
- A 'relcalid' is permitted and is resolved according to the rules
- defined in Section 5 of RFC 2396.
-
- Examples of valid relative CAP URLs:
-
- opqaueXzz123String
- UserName/Personal
-
- Calendar addresses can be described as qualified or relative CAP
- URLs.
-
- For a user currently authenticated to the CS on cal.example.com,
- these two example calendar addresses refer to the same calendar:
-
- cap://cal.example.com/abcd1234USR
- abcd1234USR
-
-6. New Value Types
-
- The following sections contains new components, properties,
- parameters, and value definitions.
-
- The purpose of these is to extend the iCalendar objects in a
- compatible way so that existing iCalendar "VERSION" property "2.0"
- value parsers can still parse the objects without modification.
-
-6.1. Property Value Data Types
-
-6.1.1. CAL-QUERY Value Type
-
- Subject: Registration of text/calendar MIME value type CAL-QUERY
-
- Value Name: CAL-QUERY
-
- Value Type Purpose: This value type is used to identify values and
- contains query statements targeted at locating those values. This
- is based on [SQL92] and [SQLCOM].
-
- 1. For the purpose of a query, all components should be handled
- as tables, and the properties of those components should be
- handled as columns.
-
-
-
-
-Royer, et al. Experimental [Page 30]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- 2. All VAGENDAs and CSs look like tables for the purpose of a
- QUERY, and all of their properties look like columns in those
- tables.
-
- 3. You MUST NOT do any cross-component-type joins. That means
- you can ONLY have one component OR one "VAGENDA" component OR
- one "VCALSTORE" component in the "FROM" clause.
-
- 4. Everything in the "SELECT" clause and "WHERE" clauses MUST be
- from the same component type or "VAGENDA" component OR
- "VCALSTORE" component in the "FROM" clause.
-
- 5. When multiple "QUERY" properties are supplied in a single
- "VQUERY" component, the results returned are the same as the
- results returned for multiple "VQUERY" components that each
- have a single "QUERY" property.
-
- 6. The '.' is used to separate the table name (component) and
- column name (property or component) when selecting a property
- that is contained inside a component that is targeted in the
- TARGET property.
-
- 7. A contained component without a '.' is not the same as
- "component-name.*". If given as "component-name" (no dot),
- the encapsulating BEGIN/END statement will be supplied for
- "component-name".
-
- In the following example, '.' is used to separate the "TRIGGER"
- property from its contained component (VALARM), which is contained in
- any "VEVENT" component in the selected "TARGET" property value (a
- relcalid). All "TRIGGER" properties in any "VEVENT" component in
- relcalid would be returned.
-
- TARGET:relcalid
- QUERY:SELECT VALARM.TRIGGER FROM VEVENT
- SELECT VALARM FROM VEVENT WHERE UID = "123"
-
- This returns one BEGIN/END "VALARM" component for each "VALARM"
- component in the matching "VEVENT" component. As there is no '.'
- (dot) in the VALARM after the SELECT above, it returns:
-
-
-
-
-
-
-
-
-
-
-
-Royer, et al. Experimental [Page 31]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- BEGIN:VALARM
- TRIGGER;RELATED=END:PT5M
- REPEAT:4
- ...
- END:VALARM
- BEGIN:VALARM
- TRIGGER;RELATED=START:PT5M
- DURATION:PT10M
- ...
- END:VALARM
- ...
- ...
-
- If the SELECT parameter is provided as "component-name.*", then only
- the properties and any contained components will be returned. The
- example:
-
- SELECT VALARM.* FROM VEVENT WHERE UID = "123"
-
- will return all of the properties in each "VALARM" component in the
- matching "VEVENT" component:
-
- TRIGGER;RELATED=END:PT5M
- REPEAT:4
- ...
- TRIGGER;RELATED=START:PT5M
- DURATION:PT10M
- ...
- ...
-
- In the following SELECT clauses:
-
- (a) SELECT FROM VEVENT
-
- (b) SELECT VALARM FROM VEVENT
-
- (c) SELECT VALARM.* FROM VEVENT
-
- (d) SELECT * FROM VEVENT
-
- (e) SELECT * FROM VEVENT WHERE
- VALARM.TRIGGER < '20020201T000000Z'
- AND VALARM.TRIGGER > '20020101T000000Z'
-
- Clause (a) elects all instances of from all "VEVENT"
- components.
-
-
-
-
-
-Royer, et al. Experimental [Page 32]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- Clauses (b) and (c) select all "VALARM" components from all "VEVENT"
- components. (b) would return them in BEGIN/END VALARM tags. (c) would
- return all of the properties without BEGIN/END VALARM tags.
-
- Clause (d) selects every property and every component that is in any
- "VEVENT" component, with each "VEVENT" component wrapped in a
- BEGIN/END VEVENT tags.
-
- Clause (e) selects all properties and all contained components in all
- "VEVENT" components that have a "VALARM" component with a "TRIGGER"
- property value between the provided dates and times, with each
- "VEVENT" component wrapped in BEGIN/END VEVENT tags.
-
- Here are two invalid SELECT clauses:
-
- (f) SELECT VEVENT.VALARM.TRIGGER FROM VEVENT
-
- (g) SELECT DTSTART,UID FROM VEVENT
- WHERE VTODO.SUMMERY = "Fix typo in CAP"
-
- Clause (f) is invalid because it contains two '.' characters.
-
- Clause (g) Is invalid because it mixes VEVENT
- and VTODO properties in the same VQUERY.
-
- Formal Definition: The value type is defined by the following
- notation:
-
- cal-query = "SELECT" SP cap-val SP
- "FROM" SP comp-name SP
- "WHERE" SP cap-expr
-
- / "SELECT" SP cap-cols SP
- "FROM" SP comp-name
- ;
- cap-val = cap-cols / param
- / ( cap-val "," cap-val )
-
- ; NOTE: there is NO space around the "," on
- ; the next line
- cap-cols = cap-col / ( cap-cols "," cap-col)
- / "*"
- / "*.*" ; only valid when the target is a "VAGENDA"
- ;
- ; A 'cap-col' is:
- ;
- ; Any property name ('cap-prop') found in the
- ; component named in the 'comp-name' used in the
-
-
-
-Royer, et al. Experimental [Page 33]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- ; "FROM" clause.
- ;
- ; SELECT ORGANIZER FROM VEVENT ...
- ;
- ; OR
- ;
- ; A component name ('comp-name') of an existing
- ; component contained inside of the 'comp-name'
- ; used in the "FROM" clause.
- ;
- ; SELECT VALARM FROM VEVENT ...
- ;
- ; OR
- ;
- ; A component name ('comp-name') of an existing
- ; component contained inside of the 'comp-name' used
- ; in the "FROM" clause followed by a property
- ; name ('cap-prop') to be selected from that
- ; component.
- ; (comp-name "." cap-prop)
-
- ; SELECT VALARM.TRIGGER FROM VEVENT ...
-
- cap-col = comp-name
- / comp-name "." cap-prop
- / cap-prop
-
- comp-name = "VEVENT" / "VTODO" / "VJOURNAL" / "VFREEBUSY"
- / "VALARM" / "DAYLIGHT" / "STANDARD" / "VAGENDA"
- / "VCAR" / "VCALSTORE" / "VQUERY" / "VTIMEZONE"
- / "VRIGHT" / x-comp / iana-comp
-
- cap-prop = ; A property that may be in the 'cap-comp' named
- ; in the "SELECT" clause.
-
- cap-expr = "(" cap-expr ")"
- / cap-term
-
- cap-term = cap-expr SP cap-logical SP cap-expr
- / cap-factor
-
- cap-logical= "AND" / "OR"
-
- cap-factor = cap-colval SP cap-oper SP col-value
- / cap-colval SP "LIKE" SP col-value
- / cap-colval SP "NOT LIKE" SP col-value
- / cap-colval SP "IS NULL"
- / cap-colval SP "IS NOT NULL"
-
-
-
-Royer, et al. Experimental [Page 34]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- / col-value SP "IN" cap-colval
- / col-value SP "NOT IN" cap-colval
- / "STATE()" "=" ( "BOOKED"
- / "UNPROCESSED"
- / "DELETED"
- / iana-state
- / x-state )
- ;
- iana-state = ; Any state registered by IANA directly or
- ; included in an RFC that may be applied to
- ; the component and within the rules published.
- ;
- x-state = ; Any experimental state that starts with
- ; "x-" or "X-".
-
- cap-colval = cap-col / param
- ;
- param = "PARAM(" cap-col "," cap-param ")"
- ;
- cap-param = ; Any parameter that may be contained in the cap-col
- ; in the supplied PARAM() function
-
- col-value = col-literal
- / "SELF()"
- / "CAL-OWNERS()"
- / "CAL-OWNERS(" cal-address ")"
- / "CURRENT-TARGET()"
- ;
- cal-address = ; A CALID as define by CAP
- ;
- col-literal = "'" literal-data "'"
- ;
- literal-data = ; Any data that matches the value type of the
- ; column that is being compared. That is, you
- ; cannot compare PRIORITY to "some string" because
- ; PRIORITY has a value type of integer. If it is
- ; not preceded by the LIKE element, any '%' and '_'
- ; characters in the literal data are not treated as
- ; wildcard characters and do not have to be
- ; backslash-escaped.
- ;
- ; OR
- ;
- ; If the literal-data is preceded by the LIKE
- ; element it may also contain the '%' and '_'
- ; wildcard characters. And, if the literal data
- ; that is comparing contains any '%' or '_'
- ; characters, they MUST be backslash-escaped as
-
-
-
-Royer, et al. Experimental [Page 35]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- ; described in the notes below, in order for them
- ; not to be treated as wildcard characters.
- ;
- ; And, if the literal data contains any characters
- ; that would have to be backslash-escaped if
- ; a property or parameter value, then they must
- ; be backslash-escaped in the literal-data.
- ; Also, the quote character (') must be backslash
- ; escaped. Example:
- ;
- ; ... WHERE SUBJECT = 'It\'s time to ski'
- ;
- cap-oper = "="
- / "!="
- / "<"
- / ">"
- / "<="
- / ">="
- ;
- SP = ; A single white space ASCII character
- ; (value in HEX %x20).
- ;
- x-comp = ; As defined in [iCAL] section 4.6.
- ;
- iana-comp = ; As defined in [iCAL] section 4.6.
-
-6.1.1.1. [NOT] CAL-OWNERS()
-
- This function returns the list of "OWNER" properties for the named
- calendar when used in the "SELECT" clause.
-
- If called as 'CAL-OWNERS()', it is equivalent to the comma-separated
- list of all of the owners of the calendar that match the provided
- "TARGET" property value. If the target is a "VCALSTORE", it returns
- the "CALMASTER" property.
-
- If called as 'CAL-OWNERS(cal-address)', then it is the equivalent to
- the comma-separated list of owners for the named calendar id. If
- 'cal-address' is a CS, it returns the "CALMASTER" property.
-
- If used in the "WHERE" clause, it returns true if the currently
- authenticated UPN is an owner of the currently selected object
- matched in the provided "TARGET" property. Used in a CAL-QUERY
- "WHERE" clause and in the UPN-FILTER.
-
-
-
-
-
-
-
-Royer, et al. Experimental [Page 36]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
-6.1.1.2. CURRENT-TARGET()
-
- This is equivalent to the value of the "TARGET" property in the
- current command. It is used in a CAL-QUERY "WHERE" clause.
-
-6.1.1.3. PARAM()
-
- This is used in a CAL-QUERY. It returns or tests for the value of
- the named parameter from the named property.
-
-6.1.1.3.1. PARAM() in SELECT
-
- When used in a "SELECT" clause, it returns the entire property and
- all of that property's parameters; the result is not limited to the
- supplied parameter. If the property does not contain the named
- parameter, then the property is not returned. However, it could be
- returned as a result of another "SELECT" clause value. If multiple
- properties of the supplied name have the named parameter, all
- properties with that named parameter are returned. If multiple
- PARAM() clauses in a single "SELECT" CLAUSE match the same property,
- then the single matching property is returned only once.
-
- Also, note that many parameters have default values defined in [iCAL]
- that must be treated as existing with their default value in the
- properties, as defined in [iCAL], even when not explicitly present.
- For example, if a query were performed with PARAM(ATTENDEE,ROLE) then
- ALL "ATTENDEE" properties would match because, even when they do not
- explicitly contain the "ROLE" parameter, it has a default value and
- therefore must match.
-
- Therefore, when PARAM() is used in a "SELECT" clause, it is more
- accurate to say that it means return the property, if it contains the
- named parameter explicitly in the property or simply because the
- parameter has a default for that property.
-
-6.1.1.3.2. PARAM() in WHERE
-
- When PARAM() is used in the "WHERE" clause, a match is true when the
- parameter value matches the compare clause (according to the supplied
- WHERE values). If multiple named properties contain the named
- parameter, then each parameter value is compared in turn to the
- condition; if any match, the results would be true for that condition
- the same as if only one had existed. Each matching property or
- component is returned only once.
-
- Because a parameter may be multi-valued, the comparison might need to
- be done with an "IN" or "NOT IN" comparator.
-
-
-
-
-Royer, et al. Experimental [Page 37]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- Given the following query:
-
- ATTENDEE;PARTSTAT=ACCEPTED:cap://host.com/joe
-
- SELECT VEVENT FROM VAGENDA
- WHERE PARAM(ATTENDEE,PARTSTAT) = 'ACCEPTED'
-
- Thus, all "VEVENT" components that contain one or more "ATTENDEE"
- properties that have a "PARTSTAT" parameter with a "ACCEPTED" value
- would be returned. Also, each uniquely matching VEVENT would be
- returned only once, no matter how many "ATTENDEE" properties had
- matching roles, in each unique "VEVENT" component.
-
- Also note that many parameters have default values defined in [iCAL].
- Therefore, if the following query were performed on the "ATTENDEE"
- property in the above example:
-
- SELECT VEVENT FROM VAGENDA
- WHERE PARAM(ATTENDEE,ROLE) = 'REQ-PARTICIPANT'
-
- It would return the "ATTENDEE" property shown above because the
- default value for the "ROLE" parameter is "REQ-PARTICIPANT".
-
-6.1.1.4. SELF()
-
- Used in a CAL-QUERY "WHERE" clause. Returns the UPN of the currently
- authenticated UPN or their current UPN as a result of an IDENTIFY
- command.
-
-6.1.1.5. STATE()
-
- Returns one of three values, "BOOKED", "UNPROCESSED", or "DELETED"
- depending on the state of the object. "DELETED" is a component in
- the marked-for-delete state. Components that have been removed from
- the store are never returned.
-
- If not specified in a query then both "BOOKED" and "UNPROCESSED" data
- is returned. Each unique "METHOD" property must be in a separate
- MIME object, per the [iCAL] section 3.2 restriction.
-
-6.1.1.6. Use of Single Quote
-
- All literal values are surrounded by single quotes ('), not double
- quotes ("), and not without any quotes. If the value contains quotes
- or any other ESCAPED-CHAR, they MUST be backslash-escaped as
- described in section 4.3.11 "Text" of [iCAL]. Any "LIKE" clause
- wildcard characters that are part of any literal data that is
- preceded by a "LIKE" clause or "NOT LIKE" clause and is not intended
-
-
-
-Royer, et al. Experimental [Page 38]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- to mean wildcard search MUST be escaped as described in note (7)
- below.
-
-6.1.1.7. Comparing DATE and DATE-TIME Values
-
- When comparing "DATE-TIME" values to "DATE" values and when comparing
- "DATE" values to "DATE-TIME" values, the result will be true if the
- "DATE" value is on the same day as the "DATE-TIME" value. They are
- compared in UTC no matter what time zone the data may have been
- stored in.
-
- Local time event, as described in section 4.2.19 of [iCAL], must be
- considered to be in the CUA default timezone that was supplied by the
- CUA in the "CAPABILITY" exchange.
-
- VALUE-1 VALUE-2 Compare Results
-
- 20020304 20020304T123456 TRUE
- (in UTC-3) (in UTC-3)
-
- 20020304 20020304T003456 FALSE
- (in UTC) (in UTC-4)
-
- 20020304T003456Z 20020205T003456 FALSE
- (in UTC-0) (in UTC-7)
-
- When "DATE" values and "DATE-TIME" values are compared with the
- "LIKE" clause, the comparison will be done as if the value is a
- [iCAL] DATE or DATE-TIME string value.
-
- LIKE '2002%' will match anything in the year 2002.
-
- LIKE '200201%' will match anything in January 2002.
-
- LIKE '%T000000' will match anything at midnight.
-
- LIKE '____01__T%' will match anything for any year or
- time that is in January.
- (Four '_', '01', two '_' 'T%').
-
- Using a "LIKE" clause value of "%00%", would return any value that
- contained two consecutive zeros.
-
- All comparisons will be done in UTC.
-
-
-
-
-
-
-
-Royer, et al. Experimental [Page 39]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
-6.1.1.8. DTEND and DURATION
-
- The "DTEND" property value is not included in the time occupied by
- the component. That is, a "DTEND" property value of 20030614T12000
- includes all of the time up to, but not including, noon on that day.
-
- The "DURATION" property value end time is also not inclusive. So an
- object with a "DTSTART" property value of 20030514T110000 and a
- "DURATION" property value of "1H" does not include noon on that day.
-
- When a "QUERY" property value contains a "DTEND" value, then the CS
- MUST also evaluate any existing "DURATION" property value and
- determine if it has an effective end time that matches the "QUERY"
- property supplied "DTEND" value or any range of values supplied by
- the "QUERY" property.
-
- When a "QUERY" property contains a "DURATION" value, then the CS MUST
- also evaluate any existing "DTEND" property values and determine if
- they have an effective duration that matches the value, or any range
- of values, supplied by the "QUERY" property.
-
-6.1.1.9. [NOT] LIKE
-
- The pattern matching characters are the '%' that matches zero or more
- characters, and '_' that matches exactly one character (where
- character does not always mean octet).
-
- "LIKE" clause pattern matches always cover the entire string. To
- match a pattern anywhere within a string, the pattern must start and
- end with a percent sign.
-
- To match a '%' or '_' in the data and not have it interpreted as a
- wildcard character, they MUST be backslash-escaped. Thus, to search
- for a '%' or '_' in the string:
-
- LIKE '%\%%' Matches any string with a '%' in it.
- LIKE '%\_%' Matches any string with a '_' in it.
-
- Strings compared using the "LIKE" clause MUST be performed using case
- insensitive comparisoison assumes 'a' = 'A').
-
- If the "LIKE" clause is preceded by 'NOT' then there is a match when
- the string compare fails.
-
- Some property values (such as the 'recur' value type), contain commas
- and are not multi-valued. The CS must understand the objects being
- compared and understand how to determine how any multi-valued or
- multi-instances properties or parameter values are separated, quoted,
-
-
-
-Royer, et al. Experimental [Page 40]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- and backslash-escaped. THE CS must perform the comparisons as if
- each value existed by itself and was not quoted or backslash-escaped,
- when comparing using the LIKE element.
-
- See related examples in Section 6.1.1.11.
-
-6.1.1.10. Empty vs. NULL
-
- When used in a CAL-QUERY value, "NULL" means that the property or
- parameter is not present in the object. Paramaters that are not
- provided and have a default value in the property are considered to
- exist with their default value and will not be "NULL".
-
- If the property exists but has no value, then "NULL" MUST NOT
- match.
-
- If the parameter exists but has no value, then "NULL" MUST NOT
- match.
-
- If the parameter not present and has a default value, then "NULL"
- MUST NOT match.
-
- If the property (or parameter) exists but has no value, then it
- matches the empty string '' (quote quote).
-
-6.1.1.11. [NOT] IN
-
- This is similar to the "LIKE" clause, except it does value matching
- and not string comparison matches.
-
- Some iCalendar objects can be multi-instance and multi-valued. The
- "IN" clause will return a match if the literal value supplied as part
- of the "IN" clause is contained in the value of any instance of the
- named property or parameter, or is in any of the multiple values in
- the named property or parameter. Unlike the "LIKE" clause, the '%'
- and '_' matching characters are not used with the "IN" clause and
- have no special meaning.
-
- BEGIN:A-COMPONENT
- (a) property:value1,value2 One property, two values.
- (b) property:"value1,value2" One property, one value.
- (c) property:parameter=1,2:x One parameter, two values.
- (d) property:parameter="1,2",3:y One parameter, one value.
- (e) property:parameter=",":z One parameter, one value.
- (f) property:x,y,z One property, three values
- END:A-COMPONENT
-
-
-
-
-
-Royer, et al. Experimental [Page 41]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- In this example:
-
- 'value1' IN property would match (a) only.
- 'value1,value2' IN property would match (b) only.
- 'value%' IN property would NOT match any.
- ',' IN property would NOT match any.
- '%,%' IN property would NOT match any.
- 'x' IN property would match (f) and (c).
- '2' IN parameter would match (c) only.
- '1,2' IN parameter would match (d) only.
- ',' IN parameter would match (e) only.
- '%,%' IN parameter would NOT match any.
-
- property LIKE 'value1%' would match (a) and (b).
- property LIKE 'value%' would match (a) and (b).
- property LIKE 'x' would match (f) and (c).
- parameter LIKE '1%' would match (c) and (d).
- parameter LIKE '%2%' would match (c) and (d).
- parameter LIKE ',' would match (e) only.
-
- Some property values (such as the "RECUR" value type), contain commas
- and are not multi-valued. The CS must understand the objects being
- compared and understand how to determine how any multi-valued or
- multi-instance properties or parameter values are separated, quoted,
- and backslash-escaped and perform the comparisons as if each value
- existed by itself and not quoted or backslash-escaped when comparing
- using the IN element.
-
- If the "IN" clause is preceded by 'NOT', then there is a match when
- the value does not exist in the property or parameter value.
-
-6.1.1.12. DATE-TIME and TIME Values in a WHERE Clause
-
- All "DATE-TIME" and "TIME" literal values supplied in a "WHERE"
- clause MUST be terminated with 'Z'. That means that the CUA MUST
- supply the values in UTC.
-
- Valid:
-
- WHERE alarm.TRIGGER < '20020201T000000Z'
- AND alarm.TRIGGER > '20020101T000000Z'
-
- Not valid; it is a syntax error and the CS MUST reject the QUERY:
-
- WHERE alarm.TRIGGER < '20020201T000000'
- AND alarm.TRIGGER > '20020101T000000'
-
-
-
-
-
-Royer, et al. Experimental [Page 42]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
-6.1.1.13. Multiple Contained Components
-
- If a query references a component and a component or property
- contained in the component, any clauses referring to the contained
- component or property must be evaluated on all of the contained
- components or properties. If any of the contained components or
- properties match the query, and the conditions on the containing
- component are also true, the component matches the query.
-
- For example, in the query below, if a BOOKED VEVENT contains multiple
- VALARMs, and the VALARM.TRIGGER clause is true for any of the VALARMs
- in the VEVENT, then the UID, SUMMARY, and DESCRIPTION of this VEVENT
- would be included in the QUERY results.
-
- BEGIN:VQUERY
- EXPAND:TRUE
- QUERY:SELECT UID,SUMMARY,DESCRIPTION FROM VEVENT
- WHERE VALARM.TRIGGER >= '20000101T030405Z'
- AND VALARM.TRIGGER <= '20001231T235959Z'
- AND STATE() = 'BOOKED'
- END:VQUERY
-
-6.1.1.14. Example, Query by UID
-
- The following example would match the entire content of a "VEVENT" or
- "VTODO" component with the "UID" property equal to "uid123" , and it
- would not expand any multiple instances of the component. If the CUA
- does not know if "uid123" was a "VEVENT", "VTODO", "VJOURNAL", or
- any other component, then all components that the CUA supports MUST
- be supplied in a QUERY property. This example assumes the CUA is
- only interested in "VTODO" and "VEVENT" components.
-
- If the results were empty it could also mean that "uid123" was a
- property in a component other than a VTODO or VEVENT.
-
- BEGIN:VQUERY
- QUERY:SELECT * FROM VTODO WHERE UID = 'uid123'
- QUERY:SELECT * FROM VEVENT WHERE UID = 'uid123'
- END:VQUERY
-
-6.1.1.15. Query by Date-Time Range
-
- This query selects the entire content of every booked "VEVENT"
- component that has an instance greater than or equal to July 1,
- 2000 00:00:00 UTC and less than or equal to July 30, 2000 23:59:59
- UTC. This includes single instance "VEVENT" components that do
- not explicitly contain any recurrence properties or "RECURRENCE-
- ID" properties. This works only for CSs that have the "RECUR-
-
-
-
-Royer, et al. Experimental [Page 43]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- EXPAND" property value set to "TRUE" in the "GET-CAPABILITY"
- exchange.
-
- BEGIN:VQUERY
- EXPAND:TRUE
- QUERY:SELECT * FROM VEVENT
- WHERE RECURRENCE-ID >= '20000701T000000Z'
- AND RECURRENCE-ID <= '20000730T235959Z'
- AND STATE() = 'BOOKED'
- END:VQUERY
-
-6.1.1.16. Query for All Unprocessed Entries
-
- The following example selects the entire contents of all non-booked
- "VTODO" and "VEVENT" components in the "UNPROCESSED" state. The
- default for the "EXPAND" property is "FALSE", so the recurrence rules
- will not be expanded.
-
- BEGIN:VQUERY
- QUERYID:Fetch VEVENT and VTODO iTIP components
- QUERY:SELECT * FROM VEVENT WHERE STATE() = 'UNPROCESSED'
- QUERY:SELECT * FROM VTODO WHERE STATE() = 'UNPROCESSED'
- END:VQUERY
-
- The following example fetches all "VEVENT" and "VTODO" components in
- the "BOOKED" state.
-
- BEGIN:VQUERY
- QUERYID:Fetch All Booked VEVENT and VTODO components
- QUERY:SELECT * FROM VEVENT WHERE STATE() = 'BOOKED'
- QUERY:SELECT * FROM VTODO WHERE STATE() = 'BOOKED'
- END:VQUERY
-
- The following fetches the "UID" property for all "VEVENT" and "VTODO"
- components that have been marked for delete.
-
- BEGIN:VQUERY
- QUERYID:Fetch UIDs of marked-for-delete VEVENTs and VTODOs
- QUERY:SELECT UID FROM VEVENT WHERE STATE() = 'DELETED'
- QUERY:SELECT UID FROM VTODO WHERE STATE() = 'DELETED'
- END:VQUERY
-
-6.1.1.17. Query with Subset of Properties by Date/Time
-
- In this example, only the named properties will be selected, and all
- booked and non-booked components have a "DTSTART" value from February
- 1st to February 10th 2000 (in UTC) will also be selected.
-
-
-
-
-Royer, et al. Experimental [Page 44]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- BEGIN:VQUERY
- QUERY:SELECT UID,DTSTART,DESCRIPTION,SUMMARY FROM VEVENT
- WHERE DTSTART >= '20000201T000000Z'
- AND DTSTART <= '20000210T235959Z'
- END:VQUERY
-
-6.1.1.18. Query with Components and Alarms in A Range
-
- This example fetches all booked "VEVENT" components with an alarm
- that triggers within the specified time range. In this case only the
- "UID", "SUMMARY", and "DESCRIPTION" properties will be selected for
- all booked "VEVENTS" components that have an alarm between the two
- date-times supplied.
-
- BEGIN:VQUERY
- EXPAND:TRUE
- QUERY:SELECT UID,SUMMARY,DESCRIPTION FROM VEVENT
- WHERE VALARM.TRIGGER >= '20000101T030405Z'
- AND VALARM.TRIGGER <= '20001231T235959Z'
- AND STATE() = 'BOOKED'
- END:VQUERY
-
-6.1.2. UPN Value Type
-
- Value Name: UPN
-
- Purpose: This value type is used to identify values that contain user
- principal name of a CU or a group of CUs.
-
- Formal Definition: The value type is defined by the following
- notation:
-
- ;
- upn = "@"
- / [ dot-atom-text ] "@" dot-atom-text
- ;
- ; dot-atom-text is defined in RFC 2822 [RFC2822]
- ;
- ;
- dot-atom-text = ; As defined in [iCAL].
-
- Description: This data type is an identifier that denotes a CU or a
- group of CU. A UPN is an RFC 2822-compliant email address
- [RFC2822], with exceptions listed below, and in most cases it is
- deliverable to the CU. In some cases it is identical to the CU's
- well known email address. A CU's UPN MUST never be an e-mail
- address that is deliverable to a different person. And there is
- no requirement that a person's UPN MUST be their e-mail address.
-
-
-
-Royer, et al. Experimental [Page 45]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- A UPN is formatted as a user name followed by "@", followed by a
- Realm in the form of a valid and unique DNS domain name. The user
- name MUST be unique within the Realm. In its simplest form it
- looks like "user@example.com".
-
- In certain cases a UPN will not be RFC 2822-compliant. When
- anonymous authentication is used, or anonymous authorization is
- being defined, the special UPN "@" will be used. When
- authentication MUST be used, but unique identity MUST be obscured,
- a UPN of the form @DNS-domain-name may be used. For example,
- "@example.com".
-
- Example:
-
- The following is a UPN for a CU:
-
- jdoe@example.com
-
- The following is an example of a UPN that could be for a group of
- CU:
-
- staff@example.com
-
- The following is a UPN for an anonymous CU that belongs to a
- specific realm. When used as a UPN-FILTER, it applies to all UPNs
- in a specific realm:
-
- @example.com
-
- The following is a UPN for an anonymous CU:
-
- @
-
-6.1.3. UPN-FILTER Value
-
- Value Name: UPN-FILTER
-
- Purpose: This value type is used to identify values that contain a
- user principal name filter.
-
- Formal Definition: The value type is defined by the following
- notation:
-
- ;
- ; NOTE: "CAL-OWNERS(cal-address)"
- ; and "NOT CAL-OWNERS(cal-address)"
- ; are both NOT allowed below.
- ;
-
-
-
-Royer, et al. Experimental [Page 46]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- upn-filter = "CAL-OWNERS()" /
- "NOT CAL-OWNERS()" /
- "*" /
- [ "*" / dot-atom-text ] "@" ( "*" / dot-atom-text )
- ;
- ; dot-atom-text is defined in RFC 2822
-
- Description: The value is used to match user principal names (UPNs).
- For "CAL-OWNERS()" and "NOT CAL-OWNERS()", see Section 8.24.
-
- * Matches all UPNs.
-
- @ Matches the UPN of anonymous CUs
- belonging to the null realm
-
- @* Matches the UPN of anonymous CUs
- belonging to any non-null realm
-
- @realm Matches the UPN of anonymous CUs
- belonging to the specified realm.
-
- *@* Matches the UPN of non-anonymous CUs
- belonging to any non-null realm
-
- *@realm Matches the UPN of non-anonymous CUs
- belonging to the specified realm
-
- user@realm Matches the UPN of the specified CU
- belonging to the specified realm
-
- user@* Not allowed.
-
- user@ Not allowed.
-
- Example: The following are examples of this value type:
-
- DENY:NON CAL-OWNERS()
- DENY:@hackers.example.com
- DENY:*@hackers.example.com
- GRANT:sam@example.com
-
-
-
-
-
-
-
-
-
-
-
-Royer, et al. Experimental [Page 47]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
-7. New Parameters
-
-7.1. ACTION Parameter
-
- Parameter Name: ACTION
-
- Purpose: This parameter indicates the action to be taken when a
- timeout occurs.
-
- Value Type: TEXT
-
- Conformance: This property can be specified in the "CMD" property.
-
- When present in a "CMD" property, the "ACTION" parameter specifies
- the action to be taken when the command timeout expires.
-
- Formal Definition: The parameter is defined by the following
- notation:
-
- action-param = ";" "ACTION" "=" ( "ASK" / "ABORT" )
- ; If 'action-param' is supplied then
- ; 'latency-param' MUST be supplied.
-
- Example:
-
- CMD;LATENCY=10;ACTION=ASK:CREATE
-
-7.2. ENABLE Parameter
-
- Parameter Name: ENABLE
-
- Purpose: This parameter indicates whether or not the property should
- be ignored. For example, it can indicate that a "TRIGGER"
- property in a "VALARM" component should be ignored.
-
- Value Type: BOOLEAN
-
- Conformance: This property can be specified in the "TRIGGER"
- properties.
-
- Description: When a non owner sends an [iTIP] "REQUEST" to a calendar
- that object might contain a "VALARM" component. The owner may
- wish to have local control over their own CUA and when or how
- alarms are triggered.
-
- A CUA may add the "ENABLE" parameter to any "TRIGGER" property
- before booking the component. If the "ENABLE" parameter is set to
- "FALSE", then the alarm will be ignored by the CUA. If set to
-
-
-
-Royer, et al. Experimental [Page 48]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- "TRUE", or if the "ENABLE" property is not in the "TRIGGER"
- property, the alarm is enabled. This parameter may not be known
- by pre-CAP implementations, but this should not be an issue as it
- conforms to an 'ianaparam' [iCAL].
-
- Formal Definition: The property is defined by the following notation:
-
- enable-param = "ENABLE" "=" boolean
- ;
- boolean = ; As defined in [iCAL].
-
- Example: The following is an example of this property for a "VAGENDA"
- component:
-
- TRIGGER;ENABLE=FALSE;RELATED=END:PT5M
-
-7.3. ID Parameter
-
- Parameter Name: ID
-
- Purpose: When used in a "CMD" component, it provides a unique
- identifier.
-
- Value Type: TEXT
-
- Conformance: This parameter can be specified in the "CMD" property.
-
- Description: If more than one command is sent, then the "ID"
- parameter is used to uniquely identify the command.
-
- A CUA may add the "ID" parameter to any "CMD" property before
- sending the command. There must not be more than one outstanding
- command tagged with the same "ID" parameter value.
-
- Formal Definition: The property is defined by the following notation:
-
- id-param = ";" "ID" "=" unique-id
- ; The text value supplied is a unique value
- ; shared between the CUA and CS to uniquely
- ; identify the instance of command in the
- ; the current CUA session. The value has
- ; no meaning to other CUAs or other sessions.
- ;
- unique-id = ; text
- ;
- text = ; As defined in [iCAL].
-
- Example: The following is an example of this parameter component:
-
-
-
-Royer, et al. Experimental [Page 49]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- CMD;UD=some-unique-value:CREATE
-
-7.4. LATENCY Parameter
-
- Parameter Name: LATENCY
-
- Purpose: This parameter indicates time in seconds for when a timeout
- occurs.
-
- Value Type: TEXT
-
- Conformance: This property can be specified in the "CMD" property.
-
- When present in a "CMD" property, the "LATENCY" parameter specifies
- the time in seconds when the command timeout expires.
-
- Formal Definition: The parameter is defined by the following
- notation:
-
- latency-param = ";" "LATENCY" "=" latency-sec
- ; The value supplied in the time in seconds.
- ; If 'latency-param' is supplied then
- ; 'action-param' MUST be supplied.
- ;
- latency-sec = posint1
-
- ; Default is zero (0) meaning no timeout.
-
- Example: The following is an example of this parameter:
-
- CMD;LATENCY=10;ACTION=ASK:CREATE
-
-7.5. LOCAL Parameter
-
- Parameter Name: LOCAL
-
- Purpose: Indicates if the named component should be exported to any
- non-organizer calendar.
-
- Value Type: BOOLEAN
-
- Conformance: This parameter can be specified in the "SEQUENCE"
- properties in a "VALARM" component.
-
- Description: When a non-owner sends an [iTIP] "REQUEST" to a calendar
- that object might contain a "VALARM" component. The owner may
- wish to have local control over their own CUA and when or how
- alarms are triggered.
-
-
-
-Royer, et al. Experimental [Page 50]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- A CUA may add the "LOCAL" parameter to the "SEQUENCE" property
- before booking the component. If the "LOCAL" parameter is set to
- "TRUE", then the alarm MUST NOT be forwarded to any other
- calendar. If set to "FALSE", or if the "LOCAL" parameter is not
- in the "SEQUENCE" property, the alarm is global.
-
- Formal Definition: The property is defined by the following notation:
-
- local-param = "LOCAL" "=" boolean
-
- Example: The following is an example of this parameter:
-
- SEQUENCE;LOCAL=TRUE:4
-
-7.6. LOCALIZE Parameter
-
- Parameter Name: LOCALIZE
-
- Purpose: If provided, specifies the desired language for error and
- warning messages.
-
- Value Type: TEXT
-
- Conformance: This parameter can be specified in the "CMD" properties.
-
- When the "LOCALIZE" parameter is supplied, its value MUST be one
- of the values listed in the initial [BEEP] greeting 'localize'
- attribute.
-
- A CUA may add the "LOCALIZE" parameter to the "CMD" property to
- specify the language of any error or warning messages.
-
- Formal Definition: The property is defined by the following notation:
-
- localize-param = ";" "LOCALIZE" "=" beep-localize
- ;
- beep-localize = text ; As defined in [BEEP]
- ; The value supplied MUST be one value from
- ; the initial [BEEP] greeting 'localize'
- ; attribute, specifying the locale to use
- ; for error messages during
- ; this instance of the command.
-
- Example: The following is an example of this parameter:
-
- CMD;LOCALIZE=fr_CA:CREATE
-
-
-
-
-
-Royer, et al. Experimental [Page 51]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
-7.7. OPTIONS Parameter
-
- Parameter Name: OPTIONS
-
- Purpose: If provided the "OPTIONS" parameter specifies some "CMD"
- property-specific options.
-
- Value Type: TEXT
-
- Conformance: This parameter can be specified in the "CMD" properties.
-
- A CUA adds the "OPTIONS" parameter to the "CMD" property when the
- command needs extra values.
-
- Formal Definition: The property is defined by the following notation:
-
- option-param = ";" "OPTIONS" "=" cmd-specific
- ;
- cmd-specific = ; The value supplied is dependent on the
- ; CMD value. See the specific CMDs for the
- ; correct values to use for each CMD.
-
- Example: The following is an example of this parameter:
-
- CMD;OPTIONS=10:GENERATE-UID
-
-8. New Properties
-
-8.1. ALLOW-CONFLICT Property
-
- Property Name: ALLOW-CONFLICT
-
- Purpose: This property indicates whether or not the calendar and CS
- supports component conflicts. That is, whether or not any of the
- components in the calendar can overlap.
-
- Value Type: BOOLEAN
-
- Property Parameters: Non-standard property parameters can be
- specified on this property.
-
- Conformance: This property can be specified in "VAGENDA" and
- "VCALSTORE" component.
-
- Description: This property is used to indicate whether components may
- conflict, that is, whether their expanded instances may share the
- same time or overlap the same time periods. If it has a value of
-
-
-
-
-Royer, et al. Experimental [Page 52]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- "TRUE", then conflicts are allowed. If "FALSE", the no two
- components may conflict.
-
- If "FALSE" in the "VCALSTORE" component, then all "VAGENDA"
- component "ALLOW-CONFLICT" property values MUST be "FALSE" in the
- CS.
-
- Formal Definition: The property is defined by the following notation:
-
- allow-conflict = "ALLOW-CONFLICT" other-params ":" boolean
- CRLF
-
- Example: The following is an example of this property for a "VAGENDA"
- component:
-
- ALLOW-CONFLICT:FALSE
-
-8.2. ATT-COUNTER Property
-
- Property Name: ATT-COUNTER
-
- Property Parameters: Non-standard property parameters can be
- specified on this property.
-
- Conformance: This property MUST be specified in an iCalendar object
- that specifies a counter proposal to a group-scheduled calendar
- entity. When storing a "METHOD" property with the "COUNTER"
- method, there needs to be a way to remember who sent the COUNTER.
- The ATT-COUNTER property MUST be added to all "COUNTER" [iTIP]
- components by the CUA before storing in a CS.
-
- Description: This property is used to identify the CAL-ADDRESS of the
- entity that sent the "COUNTER" [iTIP] object.
-
- Formal Definition: The property is defined by the following notation:
-
- attcounter = "ATT-COUNTER" other-params ":" cal-address CRLF
-
- Examples:
-
- ATT-COUNTER:cap:example.com/Doug
- ATT-COUNTER:mailto:Doug@Example.com
-
-
-
-
-
-
-
-
-
-Royer, et al. Experimental [Page 53]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
-8.3. CALID Property
-
- Property Name: CALID
-
- Property Parameters: Non-standard property parameters can be
- specified on this property.
-
- Conformance: This property can be specified in the "VAGENDA"
- component.
-
- Description: This property is used to specify a fully-qualified
- CALID.
-
- Formal Definition: The property is defined by the following notation:
-
- calid = "CALID" other-params ":" relcalid CRLF
-
- Example:
-
- CALID:cap://cal.example.com/sdfifgty4321
-
-8.4. CALMASTER Property
-
- Property Name: CALMASTER
-
- Purpose: The property specifies an e-mail address of a person
- responsible for the calendar store.
-
- Value Type: URI
-
- Property Parameters: Non-standard property parameters can be
- specified on this property.
-
- Conformance: The property can be specified in a "VCALSTORE"
- component.
-
- Description: The parameter value SHOULD be a MAILTO URI as defined in
- [URL]. It MUST be a contact URI such as a MAILTO URI and not a home
- page or file URI that describes how to contact the calmasters.
-
- Formal Definition: The property is defined by the following notation:
-
- calmaster = "CALMASTER" other-params ":" uri CRLF
- ;
- uri = ; IANA registered uri as defined in [iCAL].
-
- Example: The following is an example of this property:
-
-
-
-
-Royer, et al. Experimental [Page 54]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- CALMASTER:mailto:administrator@example.com
-
-8.5. CAP-VERSION Property
-
- Property Name: CAP-VERSION
-
- Purpose: This property specifies the version of CAP supported.
-
- Value Type: TEXT
-
- Property Parameters: Non-standard property parameters can be
- specified on this property.
-
- Conformance: This property is specified in the "VREPLY" component
- that is sent in response to a "GET-CAPABILITY" command.
-
- Description: This specifies the version of CAP that the endpoint
- supports. The list is a comma-separated list of supported RFC
- numbers. The list MUST contain at least 4324.
-
- Formal Definition: The property is defined by the following notation:
-
- cap-version = "CAP-VERSION" other-params ":" text CRLF
-
- Example: The following are examples of this property:
-
- CAP-VERSION:4324
-
-8.6. CARID Property
-
- Property Name: CARID
-
- Purpose: This property specifies the identifier for an access right
- component.
-
- Value Type: TEXT
-
- Property Parameters: Non-standard property parameters can be
- specified on this property.
-
- Conformance: This property MUST be specified once in a "VCAR"
- component.
-
- Description: This property is used in the "VCAR" component to specify
- an identifier. A "CARID" property value is unique per container.
-
- Formal Definition: The property is defined by the following notation:
-
-
-
-
-Royer, et al. Experimental [Page 55]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- carid = "CARID" other-params ":" text CRLF
-
- Example: The following are examples of this property:
-
- CARID:xyzzy-007
- CARID:User Rights
-
-8.7. CAR-LEVEL Property
-
- Property Name: CAR-LEVEL
-
- Purpose: The property specifies the level of VCAR supported.
-
- Value Type: TEXT
-
- Property Parameters: Non-standard property parameters can be
- specified on this property.
-
- Conformance: The property can be specified in a "VREPLY" component
- that is sent in response to a "GET-CAPABILITY" command.
-
- Description: The value is one from a list of "CAR-NONE", "CAR-MIN",
- or "CAR-FULL-1". If "CAR-FULL-1" is supplied, then "CAR-MIN" is
- also available. A "CAR-MIN" implementation only supported the
- "DEFAULT-VCARS" property values listed in the "VCALSTORE"
- component, and a "CAR-MIN" implementation does not support the
- creation or modification of "VCAR" components from the CUA.
-
- Formal Definition: The property is defined by the following notation:
-
- car-level = "CAR-LEVEL" ":" other-params ":"
- car-level-values
-
- car-level-values = ( "CAR-NONE" / "CAR-MIN" / "CAR-FULL-1"
- / other-levels )
-
- other-levels = ; Any name published in an RFC for a
- ; "CAR-LEVEL" property value.
-
- Example: The following is an example of this property:
-
- CAR-LEVEL:CAR-FULL-1
-
-8.8. COMPONENTS Property
-
- Property Name: COMPONENTS
-
-
-
-
-
-Royer, et al. Experimental [Page 56]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- Purpose: The property specifies a the list of components supported by
- the endpoint.
-
- Value Type: TEXT
-
- Property Parameters: Non-standard property parameters can be
- specified on this property.
-
- Conformance: The property can be specified in a "VREPLY" component in
- response to a "GET-CAPABILITY" command.
-
- Description: A comma-separated list of components that are supported
- by the endpoint. A component that is not in the list sent from
- the endpoint is not supported by that endpoint. Sending an
- unsupported component results in unpredictable results. This
- includes any components inside of other components (VALARM for
- example). The recommended list is
- "VCALSTORE,VCALENDAR,VREPLY,VAGENDA,
- VEVENT,VALARM,VTIMEZONE,VJOURNAL,VTODO,VALARM,
- DAYLIGHT,STANDARD,VCAR,VRIGHT,VQUERY".
-
- Formal Definition: The property is defined by the following notation:
-
- components = "COMPONENTS" other-params ":" comp-list CRLF
- ;
- ; All of these MUST be supplied only once.
- ;
- comp-list-req = "VCALSTORE" "," "VCALENDAR" "," "VTIMEZONE" ","
- "VREPLY" "," "VAGENDA" "," "STANDARD" ","
- "DAYLIGHT"
- ; At least one MUST be supplied. The same value
- ; MUST NOT occur more than once.
- ;
- comp-list-min = ( "," "VEVENT")
- / ( "," "VTODO")
- / ( "," "VJOURNAL" )
- ; The same value MUST NOT occur
- ; more than once. If "VCAR" is supplied then
- ; "VRIGHT" must be supplied.
- ;
- comp-list-opt = ( "," "VFREEBUSY" ) / ( "," "VALARM" )
- / ( "," "VCAR" ) / ( "," "VRIGHT" )
- / ( "," "VQUERY") / ( "," x-comp )
- / ( "," iana-comp )
- ;
- comp-list = comp-list-req 1*3comp-list-min *(comp-list-opt)
-
- Example: The following is an example of this property:
-
-
-
-Royer, et al. Experimental [Page 57]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- COMPONENTS:VCALSTORE,VCALENDAR,VREPLY,VAGENDA,
- VEVENT,VALARM,VTIMEZONE,VJOURNAL,VTODO,
- DAYLIGHT,STANDARD,VFREEBUSY,VCAR,VRIGHT,VQUERY
-
-8.9. CSID Property
-
- Property Name: CSID
-
- Purpose: The property specifies a globally unique identifier for the
- calendar store.
-
- Value Type: URI
-
- Property Parameters: Non-standard property parameters can be
- specified on this property.
-
- Conformance: The property can be specified in a "VCALSTORE"
- component.
-
- Description: The identifier MUST be globally unique. Each CS needs
- its own unique identifier. The "CSID" property is the official
- unique identifier for the CS. If the BEEP 'serverName' attribute
- was supplied in the BEEP 'start' message, then the CSID will be
- mapped to the virtual host name supplied, and the host name part
- of the CSID MUST be the same as the 'serverName' value. This
- allows one CS implementation to service multiple virtual hosts.
- CS's are not required to support virtual hosting. If a CS does
- not support virtual hosting, then it must ignore the BEEP
- 'serverName' attribute.
-
- Formal Definition: The property is defined by the following notation:
-
- csid = "CSID" other-params ":" capurl CRLF
-
- Example: The following is an example of this property:
-
- CSID:cap://calendar.example.com
-
-8.10. DECREED Property
-
- Property Name: DECREED
-
- Purpose: This property specifies if an access right calendar
- component is decreed or not.
-
- Value Type: BOOLEAN
-
-
-
-
-
-Royer, et al. Experimental [Page 58]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- Property Parameters: Non-standard property parameters can be
- specified on this property.
-
- Conformance: This property MAY be specified once in a "VCAR"
- component.
-
- Description: This property is used in the "VCAR" component to specify
- whether the component is decreed or not. If the "DECREED"
- property value is "TRUE" then the CUA will be unable to change the
- contents of the "VCAR" component and any attempt will fail with an
- error.
-
- Formal Definition: The property is defined by the following notation:
-
- decreed = "DECREED" other-params ":" boolean CRLF
-
- Example: The following is an example of this property:
-
- DECREED:TRUE
-
-8.11. DEFAULT-CHARSET Property
-
- Property Name: DEFAULT-CHARSET
-
- Purpose: This property indicates the default charset.
-
- Value Type: TEXT
-
- Property Parameters: Non-standard property parameters can be
- specified on this property.
-
- Conformance: This property can be specified in "VAGENDA" and
- "VCALSTORE" calendar component.
-
- Description: In a "VAGENDA" component this property is used to
- indicate the charset of calendar. If not specified, the default
- is the first value in the "VCALSTORE" components "DEFAULT-CHARSET"
- property value list. The value MUST be an IANA registered
- character set as defined in [CHARREG].
-
- In a "VCALSTORE" component it is a comma-separated list of charsets
- supported by the CS. The first entry is the default entry for all
- newly created "VAGENDA" components. The "UTF-8" value MUST be in
- the "VCALSTORE" component "DEFAULT-CHARSET" property list. All
- compliant
-
- CAP implementations (CS and CUA) MUST support at least the "UTF-8"
- charset.
-
-
-
-Royer, et al. Experimental [Page 59]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- If a charset name contains a comma (,), that comma must be
- backslash-escaped in the value.
-
- Formal Definition: The property is defined by the following notation:
-
- default-charset = "DEFAULT-CHARSET" other-params ":" text
- *( "," text) CRLF
-
- Example: The following is an example of this property for a "VAGENDA"
- component:
-
- DEFAULT-CHARSET:Shift_JIS,UTF-8
-
-8.12. DEFAULT-LOCALE Property
-
- Property Name: DEFAULT-LOCALE
-
- Purpose: This property specifies the default language for text
- values.
-
- Value Type: TEXT
-
- Property Parameters: Non-standard property parameters can be
- specified on this property.
-
- Conformance: This property can be specified in "VAGENDA" and
- "VCALSTORE" components.
-
- Description: In a "VAGENDA" component, the "DEFAULT-LOCALE" property
- is used to indicate the locale of the calendar. The full locale
- SHOULD be used. The default and minimum locale is POSIX (aka the
- 'C' locale).
-
- In a "VCALSTORE" component, it is a comma-separated list of
- locales supported by the CS. The first value in the list is the
- default for all newly created VAGENDAs. "POSIX" MUST be in the
- list.
-
- Formal Definition: The property is defined by the following notation:
-
- default-locale = "DEFAULT-LOCALE" other-params ":" language
- *( "," language) CRLF
- ;
- language = ; Text identifying a locale, as defined in [CHARPOL]
-
- Example: The following is an example of this property:
-
- DEFAULT-LOCALE:en-US.iso-8859-1,POSIX
-
-
-
-Royer, et al. Experimental [Page 60]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
-8.13. DEFAULT-TZID Property
-
- Property Name: DEFAULT-TZID
-
- Purpose: This property specifies the text value that specifies the
- time zones.
-
- Value Type: TEXT
-
- Property Parameters: Non-standard property parameters can be
- specified on this property.
-
- Conformance: This property may be specified once in a "VAGENDA" and
- "VCALSTORE" components.
-
- Description: A multi-valued property that lists the known time zones.
- The first is the default. Here "TZID" property values are the
- same as the "TZID" property defined in [iCAL].
-
- If used in a "VCALSTORE" component, it is a comma-separated list
- of TZIDs known to the CS. The entry is used as the default TZID
- list for all newly created calendars. The list MUST contain at
- least "UTC". A "VCALSTORE" components MUST contain one
- "VTIMEZONE" component for each value in the "DEFAULT-TZID"
- property value.
-
- If used in a "VAGENDA" component, it is a comma-separated list of
- "TZID" property values naming the time zones known to the
- calendar. The first time zone in the list is the default and is
- used as the localtime for objects that contain a date or date-time
- value without a time zone. All "VAGENDA" components MUST have one
- "VTIMEZONE" component contained for each value in the "DEFAULT-
- TZID" property value.
-
- If a "TZID" property value contains a comma (,), the comma must be
- backslash-escaped.
-
- Formal Definition: This property is defined by the following
- notation:
-
- default-tzid = "DEFAULT-TZID" other-params
- ":" [tzidprefix] text
- *("," [tzidprefix] text) CRLF
- ;
- txidprefix = ; As defined in [iCAL].
-
- Example: The following is an example of this property:
-
-
-
-
-Royer, et al. Experimental [Page 61]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- DEFAULT-TZID:US/Mountain,UTC
-
-8.14. DEFAULT-VCARS Property
-
- Property Name: DEFAULT-VCARS
-
- Purpose: This property is used to specify the "CARID" property ids of
- the default "VCAR" components for newly created "VAGENDA"
- components.
-
- Value Type: TEXT
-
- Property Parameters: Non-standard property parameters can be
- specified on this property.
-
- Conformance: This property MUST be specified in "VCALSTORE" calendar
- component and MUST at least specify the following values:
- "READBUSYTIMEINFO", "REQUESTONLY", "UPDATEPARTSTATUS", and
- "DEFAULTOWNER".
-
- Description: This property is used in the "VCALSTORE" component to
- specify the "CARID" value of the "VCAR" components that MUST be
- copied into now "VAGENDA" components at creation time by the CS.
- All "DEFAULT-VCAR" values must have "VCARS" components stored in
- the "VCALSTORE".
-
- Formal Definition: The property is defined by the following notation:
-
- defautl-vcars = "DEFAULT-VCARS" other-params ":" text
- *( "," text ) CRLF
-
- Example: The following is an example of this property:
-
- DEFAULT-VCARS:READBUSYTIMEINFO,REQUESTONLY,
- UPDATEPARTSTATUS,DEFAULTOWNER
-
-8.15. DENY Property
-
- Property Name: DENY
-
- Purpose: This property identifies the UPN(s) being denied access in
- the "VRIGHT" component.
-
- Value Type: UPN-FILTER
-
- Property Parameters: Non-standard property parameters can be
- specified on this property.
-
-
-
-
-Royer, et al. Experimental [Page 62]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- Conformance: This property can be specified in "VRIGHT" components.
-
- Description: This property is used in the "VRIGHT" component to
- define the CU or UG being denied access.
-
- Formal Definition: The property is defined by the following notation:
-
- deny = "DENY" other-params ":" upn-filter CRLF
-
- Example: The following are examples of this property:
-
- DENY:*
-
- DENY:bob@example.com
-
-8.16. EXPAND property
-
- Property Name: EXPAND
-
- Purpose: This property is used to notify the CS whether to expand any
- component with recurrence rules into multiple instances, in a
- query reply.
-
- Value Type: BOOLEAN
-
- Property Parameters: Non-standard property parameters can be
- specified on this property.
-
- Conformance: This property can be specified in "VQUERY" components.
-
- Description: If a CUA wishes to see all of the instances of a
- recurring component, the CUA sets EXPAND=TRUE in the "VQUERY"
- component. If not specified, the default is "FALSE". Note that
- if the CS has its "RECUR-EXPAND" CS property value set to "FALSE",
- then the "EXPAND" property will be ignored and the result will be
- as if the "EXPAND" value was set to "FALSE". The results will be
- bounded by any date range or other limits in the query.
-
- Formal Definition: The property is defined by the following notation:
-
- expand = "EXPAND" other-params ":" ("TRUE" / "FALSE") CRLF
-
- Example: The following are examples of this property:
-
- EXPAND:FALSE
- EXPAND:TRUE
-
-
-
-
-
-Royer, et al. Experimental [Page 63]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
-8.17. GRANT Property
-
- Property Name: GRANT
-
- Purpose: This property identifies the UPN(s) being granted access in
- the "VRIGHT" component.
-
- Value Type: UPN-FILTER
-
- Property Parameters: Non-standard property parameters can be
- specified on this property.
-
- Conformance: This property can be specified in "VRIGHT" calendar
- components.
-
- Description: This property is used in the "VRIGHT" component to
- specify the CU or UG being granted access.
-
- Formal Definition: The property is defined by the following notation:
-
- grant = "GRANT" other-params ":" upn-filter CRLF
-
- Example: The following are examples of this property:
-
- GRANT:*
-
- GRANT:bob@example.com
-
-8.18. ITIP-VERSION Property
-
- Property Name: ITIP-VERSION
-
- Purpose: This property specifies the version of ITIP supported.
-
- Value Type: TEXT
-
- Property Parameters: Non-standard property parameters can be
- specified on this property.
-
- Conformance: This property is specified in the "VREPLY" component
- that is sent in response to a "GET-CAPABILITY" command.
-
- Description: This specifies the version of ITIP that the endpoint
- supports. The list is a comma-separated list of supported RFC
- numbers. The list MUST contain at least 2446, which is [iTIP]
-
- Formal Definition: The property is defined by the following notation:
-
-
-
-
-Royer, et al. Experimental [Page 64]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- itip-version = "ITIP-VERSION" other-params ":" text CRLF
-
- Example: The following are examples of this property:
-
- ITIP-VERSION:2446
-
-8.19. MAX-COMP-SIZE Property
-
- Property Name: MAX-COMP-SIZE
-
- Purpose: This property specifies the largest size of any object
- accepted.
-
- Value Type: TEXT
-
- Property Parameters: Non-standard property parameters can be
- specified on this property.
-
- Conformance: This property is specified in the "VREPLY" component
- that is sent in response to a "GET-CAPABILITY" command.
-
- Description: A positive integer value that specifies the size of the
- largest iCalendar object that can be accepted in octets. Objects
- larger than this will be rejected. A value of zero (0) means no
- limit. This is also the maximum value of any [BEEP] payload that
- will be accepted or sent.
-
- Formal Definition: The property is defined by the following notation:
-
- max-comp-size = "MAX-COMP-SIZE" other-params ":" posint0 CRLF
-
- Example: The following are examples of this property:
-
- MAX-COMP-SIZE:1024
-
-8.20. MAXDATE Property
-
- Property Name: MAXDATE
-
- Purpose: This property specifies the date/time in the future, beyond
- which the CS or CUA cannot represent.
-
- Value Type: DATE-TIME
-
- Property Parameters: Non-standard property parameters can be
- specified on this property.
-
-
-
-
-
-Royer, et al. Experimental [Page 65]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- Conformance: The property can be specified in the "VCALSTORE"
- component.
-
- Description: The date and time MUST be a UTC value and end with 'Z'.
-
- Formal Definition: The property is defined by the following notation:
-
- maxdate = "MAXDATE" other-params ":" date-time CRLF
-
- Example: The following is an example of this property:
-
- MAXDATE:20990101T000000Z
-
-8.21. MINDATE Property
-
- Property Name: MINDATE
-
- Purpose: This property specifies the date/time in the past, prior to
- which the server cannot represent.
-
- Value Type: DATE-TIME
-
- Property Parameters: Non-standard property parameters can be
- specified on this property.
-
- Conformance: The property can be specified in the "VCALSTORE"
- component.
-
- Description: The date and time MUST be a UTC value and end with 'Z'.
-
- Formal Definition: The property is defined by the following notation:
-
- mindate = "MINDATE" other-params ":" date-time CRLF
-
- date-time = ; As defined in [iCAL].
-
- Example: The following is an example of this property:
-
- MINDATE:19710101T000000Z
-
-8.22. MULTIPART Property
-
- Property Name: MULTIPART
-
- Purpose: This property provides a comma-separated list of supported
- MIME multipart types supported by the sender.
-
-
-
-
-
-Royer, et al. Experimental [Page 66]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- Value Type: TEXT
-
- Property Parameters: Non-standard property parameters can be
- specified on this property.
-
- Conformance: This property is specified in the "VREPLY" component
- that is sent in response to a "GET-CAPABILITY" command.
-
- Description: This property is used in the in the "GET-CAPABILITY"
- command reply to indicate the MIME multipart types supported. A
- CS and CUA SHOULD support all registered MIME multipart types.
-
- Formal Definition: The property is defined by the following notation:
-
- multipart = "MULTIPART" other-params ":" text *( "," text) CRLF
-
- Example: The following is an example of this property:
-
- MULTIPART:related,alternate,mixed
-
-8.23. NAME Property
-
- Property Name: NAME
-
- Purpose: This property provides a localizable display name for a
- component.
-
- Value Type: TEXT
-
- Property Parameters: Non-standard property parameters can be
- specified on this property.
-
- Conformance: This property can be specified in a component.
-
- Description: This property is used in the component to specify a
- localizable display name. If more than one "NAME" properties are
- in a component, then they MUST have unique "LANG" parameters. If
- the "LANG" parameter is not supplied, then it defaults to the
- "VAGENDA" component's "DEFAULT-LOCALE" first value. If the
- component is a "VAGENDA", then the default value is the "VAGENDA"s
- component's "DEFAULT-LOCALE" first value. A "VCALSTORE"
- component's "DEFAULT-LOCALE" first value is the default if the
- component is stored at the "VCALSTORE" level.
-
- Formal Definition: The property is defined by the following notation:
-
-
-
-
-
-
-Royer, et al. Experimental [Page 67]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- name = "NAME" nameparam ":" text CRLF
- ;
- nameparam = other-params [ ";" languageparam ] other-params
- ;
- languageparam = ; As defined in [iCAL].
-
- Example: The following is an example of this property:
-
- NAME:Restrict Guests From Creating VALARMs On VEVENTs
-
-8.24. OWNER Property
-
- Property Name: OWNER
-
- Purpose: The property specifies an owner of the component.
-
- Value Type: UPN
-
- Property Parameters: Non-standard, alternate text representation and
- language property parameters can be specified on this property.
-
- Conformance: The property MUST be specified in a "VAGENDA" component.
-
- Description: A multi-instanced property indicating the calendar
- owner.
-
- Formal Definition: The property is defined by the following notation:
-
- owner = "OWNER" other-params ":" upn CRLF
-
- Example: The following is an example of this property:
-
- OWNER:jsmith@example.com
- OWNER:jdough@example.com
-
-8.25. PERMISSION Property
-
- Property Name: PERMISSION
-
- Purpose: This property defines a permission that is granted or denied
- in a "VRIGHT" component.
-
- Value Type: TEXT
-
- Property Parameters: Non-standard property parameters can be
- specified on this property.
-
- Conformance: This property can be specified in "VRIGHT" components.
-
-
-
-Royer, et al. Experimental [Page 68]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- Description: This property is used in the "VRIGHT" component to
- define a permission that is granted or denied.
-
- Formal Definition: The property is defined by the following notation:
-
- permission = "PERMISSION" other-params ":" permvalue CRLF
- ;
- permvalue = ( "SEARCH" / "CREATE" / "DELETE"
- / "MODIFY" / "MOVE" / all
- / iana-cmd / x-cmd )
- ;
- all = "*"
- ;
- iana-cmd = ; Any command registered by IANA directly or
- ; included in an RFC that may be applied as
- ; a command.
- ;
- x-cmd = ; Any experimental command that starts with
- ; "x-" or "X-".
-
- Example: The following is an example of this property:
-
- PERMISSION:SEARCH
-
-8.26. QUERY property
-
- Property Name: QUERY
-
- Purpose: Specifies the query for the component.
-
- Value Type: CAL-QUERY
-
- Property Parameters: Non-standard property parameters can be
- specified on this property.
-
- Conformance: This property can be specified in "VQUERY" components.
-
- Description: A "QUERY" is used to specify the "CAL-QUERY" (Section
- 6.1.1 for the query.
-
- Formal Definition: The property is defined by the following notation:
-
- query = "QUERY" other-params ":" cal-query CRLF
-
- Example: The following is an example of this property:
-
- QUERY:SELECT * FROM VEVENT
-
-
-
-
-Royer, et al. Experimental [Page 69]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
-8.27. QUERYID property
-
- Property Name: QUERYID
-
- Purpose: Specifies a unique ID for a query in the targeted container.
-
- Value Type: TEXT
-
- Property Parameters: Non-standard property parameters are specified
- on this property.
-
- Conformance: This property can be specified in "VQUERY" components.
-
- Description: A "QUERYID" property is used to specify the unique id
- for a query. A "QUERYID" property value is unique per container.
-
- Formal Definition: The property is defined by the following notation:
-
- queryid = "QUERYID" other-params ":" text CRLF
-
- Example: The following are examples of this property:
-
- QUERYID:Any Text String
- QUERYID:fetchUnProcessed
-
-8.28. QUERY-LEVEL Property
-
- Property Name: QUERY-LEVEL
-
- Purpose: This property specifies the level of query supported.
-
- Value Type: TEXT
-
- Property Parameters: Non-standard property parameters can be
- specified on this property.
-
- Conformance: The property can be specified in the "VREPLY" component
- in response to a "GET-CAPABILITY" command.
-
- Description: Indicates level of query support. CAL-QL-NONE is for
- CS's that allow ITIP methods only to be deposited and nothing
- else.
-
- Formal Definition: The property is defined by the following notation:
-
- query-level = "QUERY-LEVEL" other-params
- ":" ( "CAL-QL-1" / "CAL-QL-NONE") CRLF
-
-
-
-
-Royer, et al. Experimental [Page 70]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- Example: The following is an example of this property:
-
- QUERY-LEVEL:CAL-QL-1
-
-8.29. RECUR-ACCEPTED Property
-
- Property Name: RECUR-ACCEPTED
-
- Purpose: This property specifies if the endpoint supports recurring
- instances.
-
- Value Type: BOOLEAN
-
- Property Parameters: Non-standard property parameters can be
- specified on this property.
-
- Conformance: The property can be specified in the "VREPLY" component
- in response to a "GET-CAPABILITY" command.
-
- Description: Indicates if recurrence rules are supported. If "FALSE"
- then the endpoint cannot process any kind of recurring rules.
-
- Formal Definition: The property is defined by the following notation:
-
- recur-accepted = "RECUR-ACCEPTED" other-params ":" boolean CRLF
-
- Example: The following is an example of this property:
-
- RECUR-ACCEPTED:TRUE
- RECUR-ACCEPTED:FALSE
-
-8.30. RECUR-LIMIT Property
-
- Property Name: RECUR-LIMIT
-
- Purpose: This property specifies the maximum number of instances the
- endpoint will expand instances at query or storage time.
-
- Value Type: INTEGER
-
- Property Parameters: Non-standard property parameters can be
- specified on this property.
-
- Conformance: The property can be specified in the "VREPLY" component
- in response to a "GET-CAPABILITY" command.
-
- Description: For implementations that have the "STORES-EXPANDED"
- value set to "TRUE", this value specifies the maximum number of
-
-
-
-Royer, et al. Experimental [Page 71]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- instances that will be stored and fetched. For all
- implementations, this is the maximum number of instances that will
- be returned when the "EXPAND" parameter is specified as "TRUE" and
- the results contain an infinite or large number of recurring
- instances.
-
- Formal Definition: The property is defined by the following notation:
-
- recur-limit = "RECUR-LIMIT" other-params ":" posint1 CRLF
-
- Example: The following is an example of this property:
-
- RECUR-LIMIT:1000
-
-8.31. RECUR-EXPAND Property
-
- Property Name: RECUR-EXPAND
-
- Purpose: This property specifies if the endpoint can expand
- recurrences into multiple objects.
-
- Value Type: BOOLEAN
-
- Property Parameters: Non-standard property parameters can be
- specified on this property.
-
- Conformance: The property can be specified in the "VREPLY" component
- in response to a "GET-CAPABILITY" command.
-
- Description: If "TRUE", then the endpoint can expand an object into
- multiple instances as defined by its recurrence rules when the
- "EXPAND" property is supplied. If "FALSE", then the endpoint
- ignores the "EXPAND" property.
-
- Formal Definition: The property is defined by the following notation:
-
- recur-expand = "RECUR-EXPAND" other-params ":" boolean CRLF
-
- Example: The following is an example of this property:
-
- RECUR-EXPAND:TRUE
- RECUR-EXPAND:FALSE
-
-8.32. RESTRICTION Property
-
- Property Name: RESTRICTION
-
-
-
-
-
-Royer, et al. Experimental [Page 72]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- Purpose: This property defines restrictions on the result value of
- new or existing components.
-
- Value Type: CAL-QUERY
-
- Property Parameters: Non-standard property parameters can be
- specified on this property.
-
- Conformance: This property can be specified in "VRIGHT" components,
- but only when the "PERMISSION" property is set to "CREATE",
- "MODIFY", or "*" property value.
-
- Description: This property is used in the "VRIGHT" component to
- define restrictions on the components that can be written (i.e.,
- by using the "CREATE" or "MOVE" commands) as well as on the values
- that may take existent calendar store properties, calendar
- properties, components, and properties (i.e., by using the
- "MODIFY" command). Accepted values MUST match any specified
- "RESTRICTION" property values.
-
- Formal Definition: The property is defined by the following notation:
-
- restriction = "RESTRICTION" other-params ":" cal-query CRLF
-
- Example: The following are examples of this property:
-
- RESTRICTION:SELECT * FROM VCALENDAR WHERE METHOD = 'REQUEST'
-
- RESTRICTION:SELECT * FROM VEVENT WHERE
- SELF() IN ORGANIZER
-
- RESTRICTION:SELECT * FROM VEVENT WHERE 'BUSINESS' IN
- CATEGORIES
-
-8.33. SCOPE Property
-
- Property Name: SCOPE
-
- Purpose: This property identifies the objects in the CS to which the
- access rights apply.
-
- Value Type: CAL-QUERY
-
- Property Parameters: Non-standard property parameters can be
- specified on this property.
-
- Conformance: This property can be specified in "VRIGHT" components.
-
-
-
-
-Royer, et al. Experimental [Page 73]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- Description: This property is used in the "VRIGHT" component to
- define the set of objects, subject to the access right being
- defined.
-
- Formal Definition: The property is defined by the following notation:
-
- scope = "SCOPE" other-params ":" cal-query CRLF
-
- Example: The following is an example of this property:
-
- SCOPE:SELECT DTSTART,DTEND FROM VEVENT WHERE CLASS = 'PUBLIC'
-
-8.34. STORES-EXPANDED Property
-
- Property Name: STORES-EXPANDED
-
- Purpose: This property specifies if the sending endpoint expands
- recurrence rules prior to storing them into the CS.
-
- Value Type: BOOLEAN
-
- Property Parameters: Non-standard property parameters can be
- specified on this property.
-
- Conformance: This property can be specified in a "VREPLY" component
- in response to a "GET-CAPABILITY" command.
-
- Description: If the value is "TRUE", then the endpoint expands
- recurrence rules and stores the results into the CS. If this is
- "TRUE", then the "RECUR-LIMIT" property is significant because an
- infinitely-recurring appointment will store no more than "RECUR-
- LIMIT" property values into the CS and all other instances will be
- lost.
-
- Formal Definition: The property is specified by the following
- notation:
-
- stores-expanded = "STORES-EXPANDED" other-params ":" boolean
- CRLF
-
- The following is an example of this property:
-
- STORES-EXPANDED:TRUE
- STORES-EXPANDED:FALSE
-
-8.35. TARGET Property
-
- Property Name: TARGET
-
-
-
-Royer, et al. Experimental [Page 74]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- Purpose: This property defines the container that the issued command
- will act upon. Its value is a capurl, as defined in Section 5.
-
- Value Type: URI
-
- Property Parameters: Non-standard property parameters can be
- specified on this property.
-
- Conformance: This property can be specified in a command component.
-
- Description: This property value is used to specify the container
- that the command will effect. When used in a command, the command
- will be performed on the container that has a capurl matching the
- value.
-
- Formal Definition: The property is specified by the following
- notation:
-
- target = "TARGET" other-params ":" ( capurl / relcalid ) CRLF
-
- Example: The following is an example of this property:
-
- TARGET:cap://mycal.example.com
- TARGET:SomeRelCalid
-
-8.36. TRANSP Property
-
- Property Name: TRANSP
-
- Purpose: This property defines whether a component is transparent or
- not to busy-time searches. This is a modification to [iCAL]
- "TRANSP" property, in that it adds some values.
-
- Value Type: TEXT
-
- Property Parameters: Non-standard property parameters can be
- specified on this property.
-
- Conformance: This property can be specified in a component.
-
- Description: Time Transparency is the characteristic of an object
- that determines whether it appears to consume time on a calendar.
- Objects that consume actual time for the individual or resource
- associated with the calendar SHOULD be recorded as "OPAQUE",
- allowing them to be detected by free-busy time searches. Other
- objects, which do not take up the individual's (or resource's)
- time SHOULD be recorded as "TRANSPARENT", making them invisible to
- free/busy time searches.
-
-
-
-Royer, et al. Experimental [Page 75]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- Formal Definition: The property is specified by the following
- notation:
-
- transp = "TRANSP" other-params ":" transvalue CRLF
- ;
- transvalue = "OPAQUE" ;Blocks or opaque on busy time searches.
-
- / "TRANSPARENT"
- ; Transparent on busy time searches.
-
- / "TRANSPARENT-NOCONFLICT"
- ; Transparent on busy time searches,
- ; and no other OPAQUE or OPAQUE-
- ; NOCONFLICT objects can overlap it.
- ;
- / "OPAQUE-NOCONFLICT"
- ; Opaque on busy time searches, and
- ; no other OPAQUE or OPAQUE-NOCONFLICT
- ; objects can overlap it.
- ;
- ; Default value is OPAQUE
-
- The following is an example of this property for an object that is
- opaque or blocks on free/busy time searches, and no other object
- can overlap it:
-
- TRANSP:OPAQUE-NOCONFLICT
-
-9. New Components
-
-9.1. VAGENDA Component
-
- Component Name: VAGENDA
-
- Purpose: Provide a grouping of properties that defines an agenda.
-
- Formal Definition: There are two formats of the "VAGENDA" component.
- (1) When it is being created, and (2) how it exists in the
- "VCALSTORE" component.
-
- A "VAGENDA" component in a "VCALSTORE" component is defined by the
- following notes and ABNF notation:
-
- CALSCALE - The value MUST be from the "VCALSTORE" "CALSCALE"
- property list. The default is the first entry in the
- VCALSTORE CALSCALE list.
-
- CREATED - The timestamp of the calendar's create date. This
-
-
-
-Royer, et al. Experimental [Page 76]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- is a READ ONLY property in a "VAGENDA".
-
- LAST-MODIFIED - The timestamp of any change to the "VAGENDA"
- properties or when any component was last created, modified,
- or deleted.
-
- agenda = "BEGIN" ":" "VAGENDA" CRLF
- agendaprop
- *(icalobject) ; as defined in [iCAL]
- "END" ":" "VAGENDA" CRLF
-
- agendaprop = *(
- ; The following MUST occur exactly once.
- ;
- allow-conflict / relcalid / calscale / created
- / default-charset / default-locale
- / default-tzid / last-mod
- ;
- ; The following MUST occur at least once.
- ; and the value MUST NOT be empty.
- ;
- / owner
- ;
- ; The following are optional,
- ; and MAY occur more than once.
- ;
- / name / related-to / other-props / x-comp
- )
-
- icalobject = ; As defined in [iCAL].
- ;
- created = ; As defined in [iCAL].
- ;
- related-to = ; As defined in [iCAL].
-
- When creating a VAGENDA, use the following notation:
-
- agendac = "BEGIN" ":" "VAGENDA" CRLF
- agendacprop
- *(icalobject) ; as defined in [iCAL].
- "END" ":" "VAGENDA" CRLF
-
- agendacprop = *(
- ; The following MUST occur exactly once.
- ;
- allow-conflict / relcalid / calscale
- / default-charset / default-locale
- / default-tzid
-
-
-
-Royer, et al. Experimental [Page 77]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- ;
- ; The following MUST occur at least once.
- ; and the value MUST NOT be empty.
- ;
- / owner
- ;
- ; The following are optional,
- ; and MAY occur more than once.
- ;
- / name / related-to / other-props / x-comp
- )
-
- To fetch all of the properties from the targeted "VAGENDA" component
- but do not fetch any components, use:
-
- SELECT * FROM VAGENDA
-
- To fetch all of the properties from the targeted VAGENDA and all of
- the contained components, use the special '*.*' value:
-
- SELECT *.* FROM VAGENDA
-
-9.2. VCALSTORE Component
-
- Component Name: VCALSTORE
-
- Purpose: Provide a grouping of properties that defines a calendar
- store.
-
- Formal Definition: A "VCALSTORE" component is defined by the
- following table and ABNF notation. The creation of a "VCALSTORE"
- component is an administrative task and not part of the CAP
- protocol.
-
- The following are notes to some of the properties in the
- "VCALSTORE" component.
-
- CALSCALE - A comma-separated list of CALSCALEs supported by
- this CS. All "VAGENDA" component calendar CALSCALE
- properties MUST be from this list. This list MUST contain
- at least "GREGORIAN". The default for newly created
- "VAGENDA" components is the first entry.
-
- RELATED-TO - This is a multiple-instance property. There MUST
- be a "RELATED-TO" property for each of the "VAGENDA"
- components contained in the "VCALSTORE" component, each with
- the "RELTYPE" parameter value set to "CHILD". Other
- "RELATED-TO" properties may be included.
-
-
-
-Royer, et al. Experimental [Page 78]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- CREATED - The timestamp of the CS creation time. This is a
- READ ONLY property.
-
- CSID - The CSID of this calendar store. This MUST NOT be
- empty. How this property is set in the VCALSTORE is an
- administrative or implementation-specific issue and is not
- covered in CAP. This is a READ ONLY property. A suggested
- value is the fully-qualified host name or a fully-qualified
- virtual host name supported by the system.
-
- LAST-MODIFIED - The timestamp when the Properties of the
- "VCALSTORE" component were last updated or calendars were
- created or deleted. This is a READ ONLY PROPERTY.
-
- calstorec = "BEGIN" ":" "VCALSTORE" CRLF
- calstoreprop
- *(vagendac)
- "END" ":" "VCALSTORE" CRLF
- ;
- calstoreprop = *(
- ; the following MUST occur exactly once
- ;
- allow-conflict / calscale / calmaster
- / created / csid / default-charset
- / default-locale / default-vcars
- / default-tzid / last-mod / maxdate / mindate
- ;
- ; the following are optional,
- ; and MAY occur more than once
- ;
- / name / related-to / other-props / x-comp
- )
- ;
-
- vagendac = ; As defined in [iCAL].
- ;
- last-mod = ; As defined in [iCAL].
-
- To fetch all of the properties from the targeted VCALSTORE and not
- fetch the calendars that it contains, use:
-
- SELECT * FROM VCALSTORE
-
- To fetch all of the properties from the targeted "VCALSTORE"
- component and all of the contained calendars and all of those
- calendars' contained properties and components, use the special '*.*'
- value:
-
-
-
-
-Royer, et al. Experimental [Page 79]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- SELECT *.* FROM VCALSTORE
-
-9.3. VCAR Component
-
- Component Name: VCAR
-
- Purpose: Provide a grouping of calendar access rights.
-
- Formal Definition: A "VCAR" component is defined by the following
- notation:
-
- carc = "BEGIN" ":" "VCAR" CRLF
- carprop 1*rightc
- "END" ":" "VCAR" CRLF
- ;
- carprop = 1*(
- ;
- ; 'carid' is REQUIRED,
- ; but MUST NOT occur more than once
- ;
- carid /
- ;
- ; the following are OPTIONAL,
- ; and MAY occur more than once
- ;
- name / decreed / other-props
- )
-
- Description: A "VCAR" component is a grouping of properties, and
- "VRIGHT" components, that represents access rights granted or
- denied to UPNs.
-
- The "CARID" property specifies the local identifier for the "VCAR"
- component. The "NAME" property specifies a localizable display
- name.
-
- Example: In the following example, the UPN "foo@example.com" is given
- search access to the "DTSTART" and "DTEND" VEVENT properties. No
- other access is specified:
-
-
-
-
-
-
-
-
-
-
-
-
-Royer, et al. Experimental [Page 80]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- BEGIN:VCAR
- CARID:View Start and End Times
- NAME:View Start and End Times
- BEGIN:VRIGHT
- GRANT:foo@example.com
- PERMISSION:SEARCH
- SCOPE:SELECT DTSTART,DTEND FROM VEVENT
- END:VRIGHT
- END:VCAR
-
- In this example, all UPNs are given search access to "DTSTART" and
- "DTEND" properties of VEVENT components. "All CUs and UGs" are
- specified by the UPN value "*". Note that this enumerated UPN
- value is not in quotes:
-
- BEGIN:VCAR
- CARID:ViewStartEnd2
- NAME:View Start and End Times 2
- BEGIN:VRIGHT
- GRANT:*
- PERMISSION:SEARCH
- SCOPE:SELECT DTSTART,DTEND FROM VEVENT
- END:VRIGHT
- END:VCAR
-
- In these examples, full calendar access rights are given to the
- CAL-OWNERS(), and a hypothetical administrator is given access
- rights to specify calendar access rights. If no other rights are
- specified, only these two UPNs can specify calendar access rights:
-
- BEGIN:VCAR
- CARID:some-id-3
- NAME:Only OWNER or ADMIN Settable VCARs
- BEGIN:VRIGHT
- GRANT:CAL-OWNERS()
- PERMISSION:*
- SCOPE:SELECT * FROM VAGENDA
- END:VRIGHT
- BEGIN:VRIGHT
- GRANT:cal-admin@example.com
- PERMISSION:*
- SCOPE:SELECT * FROM VCAR
- RESTRICTION:SELECT * FROM VCAR
- END:VRIGHT
- END:VCAR
-
- In this example, rights to write, search, modify or delete
- calendar access are denied to all UPNs. This example would
-
-
-
-Royer, et al. Experimental [Page 81]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- disable providing different access rights to the calendar store or
- calendar. This calendar access right should be specified with
- great care, as it removes the ability to change calendar access;
- even for the owner or administrator. It could be used by small
- devices that do not support changing any VCAR:
-
- BEGIN:VCAR
- CARID:VeryRestrictiveVCAR-2
- NAME:No CAR At All
- BEGIN:VRIGHT
- DENY:*
- PERMISSION:*
- SCOPE:SELECT * FROM VCAR
- END:VRIGHT
- END:VCAR
-
-9.4. VRIGHT Component
-
- Component Name: "VRIGHT"
-
- Purpose: Provide a grouping of properties that describe an access
- right (granted or denied).
-
- Formal Definition: A "VRIGHT" component is defined by the following
- notation:
-
- rightc = "BEGIN" ":" "VRIGHT" CRLF
- rightprop
- "END" ":" "VRIGHT" CRLF
- ;
- rightprop = 2*(
- ;
- ; either 'grant' or 'deny' MUST
- ; occur at least once
- ; and MAY occur more than once
- ;
- grant / deny /
- ;
- ; 'permission' MUST occur at least once
- ; and MAY occur more than once
- ;
- permission /
- ;
- ; the following are optional,
- ; and MAY occur more than once
- ;
- scope / restriction / other-props
- )
-
-
-
-Royer, et al. Experimental [Page 82]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- Description: A "VRIGHT" component is a grouping of calendar access
- right properties.
-
- The "GRANT" property specifies the UPN that is being granted
- access. The "DENY" property specifies the UPN that is being
- denied access. The "PERMISSION" property specifies the actual
- permission being set. The "SCOPE" property identifies the
- calendar store properties, calendar properties, components, or
- properties to which the access right applies. The "RESTRICTION"
- property specifies restrictions on commands and results. If the
- command does not match the restrictions, or if the results of the
- command do not match the restrictions, then it is an access
- violation.
-
-9.5. VREPLY Component
-
- Component Name: "VREPLY"
-
- Purpose: Provide a grouping of arbitrary properties and components
- that are the data set result from an issued command.
-
- Formal Definition: A "VREPLY" component is defined by the following
- notation:
-
- replyc = "BEGIN" ":" "VREPLY" CRLF
- any-prop-or-comp
- "END" ":" "VREPLY" CRLF
- ;
- any-prop-or-comp = ; Zero or more iana or experimental
- ; properties and components, in any order.
-
-
- Description: Provide a grouping of arbitrary properties and
- components that are the data set result from an issued command.
-
- A query can return a predictable set of arbitrary properties and
- components. This component is used by query and other commands to
- return data that does not fit into any other component. It may
- contain any valid property or component, even if they are not
- registered.
-
-9.6. VQUERY Component
-
- Component Name: VQUERY
-
- Purpose: A component describes a set of objects to be acted upon.
-
-
-
-
-
-Royer, et al. Experimental [Page 83]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- Formal Definition: A "VQUERY" component is defined by the following
- notation:
-
- queryc = "BEGIN" ":" "VQUERY" CRLF
- queryprop
- "END" ":" "VCAR" CRLF
- ;
- queryprop = 1*(
- ;
- ; 'queryid' is OPTIONAL but MUST NOT occur
- ; more than once. If the "TARGET" property
- ; is supplied then the "QUERYID" property
- ; MUST be supplied.
- ;
- queryid / target
- ;
- ; 'expand' is OPTIONAL but MUST NOT occur
- ; more than once.
- ;
- expand
- ;
- ; the following are OPTIONAL, and MAY occur
- ; more than once
- ;
- / name / other-props
- ;
- ; the following MUST occur at least once if
- ; queryid is not supplied.
- ;
- / query
- )
-
- Description: A "VQUERY" contains properties that describe which
- properties and components the CS is requested to act upon.
-
- The "QUERYID" property specifies the local identifier for a
- "VQUERY" component.
-
- For a search, if the "TARGET" property is supplied in a "VQUERY"
- component, then the CS is to search for the query in the CALID
- supplied by the "TARGET" property value.
-
- For a create, the "TARGET" property MUST NOT be supplied because
- the destination container is already supplied in the "TARGET"
- property of the "VCALENDAR" component.
-
- Examples: see Section 6.1.1.
-
-
-
-
-Royer, et al. Experimental [Page 84]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
-10. Commands and Responses
-
- CAP commands and responses are described in this section.
-
-10.1. CAP Commands (CMD)
-
- All commands are sent using the CMD property.
-
- Property Name: CMD
-
- Purpose: This property defines the command to be sent.
-
- Value Type: TEXT
-
- Property Parameters: Non-standard, id, localize, latency, action or
- options.
-
- Conformance: This property is the method used to specify the commands
- to a CS; it can exist in any object sent to the CS.
-
- Description: All of the commands to the CS are supplied in this
- property. The "OPTIONS" parameter is overloaded and its meaning
- is dependent on the CMD value supplied.
-
- Formal Definition: The property is defined by the following
- notation:
-
- cmd = "CMD" (
- abort-cmd
- / continue-cmd
- / create-cmd
- / delete-cmd
- / generate-uid-cmd
- / get-capability-cmd
- / identify-cmd
- / modify-cmd
- / move-cmd
- / reply-cmd
- / search-cmd
- / set-locale-cmd
- / iana-cmd
- / x-cmd
- ) CRLF
- ;
- option-value = "OPTION" "=" paramtext
- ;
- paramtext ; As defined in [iCAL].
-
-
-
-
-Royer, et al. Experimental [Page 85]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- Calendaring commands allow a CUA to directly manipulate a calendar.
-
- Calendar access rights can be granted or denied for any commands.
-
-10.1.1. Bounded Latency
-
- A CAP command can have an associated maximum latency time by
- specifying the "LATENCY" parameter. If the command is unable to be
- completed in the specified amount of time (as specified by the
- "LATENCY" parameter value with an "ACTION" parameter set to the "ASK"
- value), then a "TIMEOUT" command MUST be sent on the same channel".
- The reply MUST be a an "ABORT" or a "CONTINUE" command. If the CUA
- initiated the original command, then the CS would issue the "TIMEOUT"
- command and the CUA would then have to issue an "ABORT" or "CONTINUE"
- command. If the CS initiated the original command then the CUA would
- have to issue the "TIMEOUT" and the CS would send the "ABORT" or
- "CONTINUE".
-
- Upon receiving an "ABORT" command, the command must then be
- terminated. Only the "ABORT", "TIMEOUT", "REPLY, and "CONTINUE"
- commands cannot be aborted. The "ABORT", "TIMEOUT", and "REPLY"
- commands MUST NOT have latency set.
-
- Upon receiving a "CONTINUE" command the work continues as if it had
- not been delayed or stopped. Note that a new latency time MAY be
- included in a "CONTINUE" command indicating to continue the original
- command until the "LATENCY" parameter value expires or the results of
- the original command can be returned.
-
- Both the "LATENCY" parameter and the "ACTION" parameter MUST be
- supplied to any "CMD" property, or nether can be added to the "CMD"
- property. The "LATENCY" parameter MUST be set to the maximum latency
- time in seconds. The "ACTION" parameter accepts the following
- values: "ASK" and "ABORT" parameters.
-
- If the maximum latency time is exceeded and the "ACTION" parameter is
- set to the "ASK" value, then "TIMEOUT" command MUST be sent.
- Otherwise, if the "ACTION" parameter is set to the "ABORT" value,
- then the command MUST be terminated and return a REQUEST-STATUS code
- of 2.0.3 for the original command.
-
- If a CS can both start sending the reply to a command and guarantee
- that all of the results can be sent from a command (short of
- something like network or power failure) prior to the "LATENCY"
- timeout value, then the "LATENCY" time has not expired.
-
- Example:
-
-
-
-
-Royer, et al. Experimental [Page 86]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- In this example the initiator asks for the listeners capabilities.
-
- I: Content-Type: text/calendar
- I:
- I: BEGIN:VCALENDAR
- I: VERSION:2.0
- I: PRODID:The CUA's PRODID
- I: CMD;ID=xyz12346;LATENCY=3;ACTION=ask:GET-CAPABILITY
- I: END:VCALENDAR
-
- # After 3 seconds
-
- L: Content-Type: text/calendar
- L:
- L: BEGIN:VCALENDAR
- L: PRODID:-//someone's prodid
- L: VERSION:2.0
- L: CMD;ID=xyz12346:TIMEOUT
- L: END:VCALENDAR
-
- In order to continue and give the CS more time, the CUA would issue a
- "CONTINUE" command:
-
- I: Content-Type: text/calendar
- I:
- I: BEGIN:VCALENDAR
- I: VERSION:2.0
- I: PRODID:-//someone's prodid
- I: CMD;ID=xyz12346;LATENCY=3;ACTION=ask:CONTINUE
- I: END:VCALENDAR
-
- L: Content-Type: text/calendar
- L:
- L: BEGIN:VCALENDAR
- L: VERSION:2.0
- L: PRODID:-//someone's prodid
- L: CMD;ID=xyz12346:REPLY
- L: BEGIN:VREPLY
- L: REQUEST-STATUS:2.0.3;Continued for 3 more seconds
- L: END:VREPLY
- L: END:VCALENDAR
-
- Here the "2.0.3" status is returned because it is not an error, it is
- a progress status sent in reply to the "CONTINUE" command.
-
- To abort the command and not wait any further, issue an "ABORT"
- command:
-
-
-
-
-Royer, et al. Experimental [Page 87]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- I: Content-Type: text/calendar
- I:
- I: BEGIN:VCALENDAR
- I: VERSION:2.0
- I: PRODID:-//someone's prodid
- I: CMD;ID=xyz12346:ABORT
- I: END:VCALENDAR
-
- # Which would result in a 2.0.3 reply.
-
- L: Content-Type: text/calendar
- L:
- L: BEGIN:VCALENDAR
- L: VERSION:2.0
- L: PRODID:-//someone's prodid
- L: CMD;ID=xyz12346:REPLY
- L: BEGIN:VREPLY
- L: REQUEST-STATUS:2.0.3;Aborted As Requested.
- L: END:VREPLY
- L: END:VCALENDAR
-
- If the "ACTION" value had been set to "ABORT", then the listner would
- send a "7.0" error on timeout in the reply to the command that
- initiated the command that timed out.
-
-10.2. ABORT Command
-
- CMD: ABORT
-
- Purpose: The "ABORT" command is sent to request that the named or the
- only in-process command be aborted. Latency MUST not be supplied
- with the "ABORT" command.
-
- Formal Definition: An "ABORT" command is defined by the following
- notation:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Royer, et al. Experimental [Page 88]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- abort-cmd = abortparam ":" "ABORT"
- ;
- abortparam = *(
- ;
- ; the following are optional,
- ; but MUST NOT occur more than once
- ;
- id-param
- / localize-param
- ;
- ; the following is optional,
- ; and MAY occur more than once
- ;
- / other-params
- )
-
- The REPLY of any "ABORT" command is:
-
- abort-reply = "BEGIN" ":" "VCALENDAR" CRLF
- calprops
- abort-vreply
- "END" ":" "VCALENDAR" CRLF
- ;
- abort-vreply = "BEGIN" ":" "VREPLY" CRLF
- rstatus
- other-props
- "END" ":" "VREPLY" CRLF
-
-10.3. CONTINUE Command
-
- CMD: CONTINUE
-
- Purpose: The "CONTINUE" command is only sent after a "TIMEOUT"
- command has been received to inform the other end of the session
- to resume working on a command.
-
- Formal Definition: A "CONTINUE" command is defined by the following
- notation:
-
- continue-cmd = continueparam ":" "CONTINUE"
- ;
- continueparam = *(
- ;
- ; the following are optional,
- ; but MUST NOT occur more than once
- ;
- id-param
- / localize-param
-
-
-
-Royer, et al. Experimental [Page 89]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- / latency-param
- ;
- ; the following MUST occur exactly once and only
- ; when the latency-param has been supplied and
- ; MUST NOT be supplied if the latency-param is
- ; not supplied.
- ;
- / action-param
- ;
- ; the following are optional,
- ; and MAY occur more than once
- ;
- / other-params
- )
-
- The REPLY of any "CONTINUE" command is:
-
- continue-reply = "BEGIN" ":" "VCALENDAR" CRLF
- calprops
- continue-vreply
- "END" ":" "VCALENDAR" CRLF
- ;
- continue-vreply = "BEGIN" ":" "VREPLY" CRLF
- rstatus
- other-props
- "END" ":" "VREPLY" CRLF
-
-10.4. CREATE Command
-
- CMD: CREATE
-
- Purpose: The "CREATE" command is used to create one or more
- iCalendar objects in the store in the "BOOKED" or "UNPROCESSED"
- state.
-
- A CUA MAY send a "CREATE" command to a CS. The "CREATE" command
- MUST be implemented by all CSs.
-
- The CS MUST NOT send a "CREATE" command to any CUA.
-
- Formal Definition: A "CREATE" command is defined by the following
- notation and the hierarchy restrictions, as defined in Section
- 3.2:
-
- create-cmd = createparam ":" "CREATE"
- ;
- createparam = *(
- ;
-
-
-
-Royer, et al. Experimental [Page 90]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- ; the following are optional,
- ; but MUST NOT occur more than once
- ;
- id-param
- / localize-param
- / latency-param
- ;
- ; the following MUST occur exactly once and only
- ; when the latency-param has been supplied and
- ; MUST NOT be supplied if the latency-param is
- ; not supplied.
- ;
- / action-param
- ;
- ; the following is optional,
- ; and MAY occur more than once
- ;
- / other-params
- )
-
- Response:
-
- One iCalendar object per TARGET property MUST be returned.
-
- The REPLY of any "CREATE" command is limited to the restriction
- tables defined in [iTIP] for iTIP objects, in addition to this
- ABNF:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Royer, et al. Experimental [Page 91]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- create-reply = "BEGIN" ":" "VCALENDAR" CRLF
- creply-props
- 1*(create-vreply)
- "END" ":" "VCALENDAR" CRLF
-
- ;
- create-vreply = "BEGIN" ":" "VREPLY" CRLF
- created-id
- rstatus
- other-props
- "END" ":" "VREPLY" CRLF
- ;
- ; Where the id is appropriate for the
- ; type of object created:
- ;
- ; VAGENDA = relcalid
- ; VALARM = sequence
- ; VCAR = carid
- ; VEVENT, VFREEBUSY, VJOURNAL, VTODO = uid
- ; VQUERY = queryid
- ; VTIMEZONE = tzid
- ; x-comp = x-id
- ;
- created-id = ( relcalid / carid / uid / queryid /
- tzid / sequence / x-id)
- ;
- tzid = ; As defined in [iCAL].
- ;
- sequence = ; As defined in [iCAL].
- ;
- uid = ; As defined in [iCAL].
- ;
- x-id = ; An ID for an x-component.
- ;
- creply-props = 4*(
- ; These are REQUIRED and MUST NOT occur
- ; more than once.
- ;
- prodid /version / target / reply-cmd
- ;
- ; These are optional, and may occur more
- ; than once.
- ;
- other-props )
-
- For a "CREATE" command, the "TARGET" property specifies the
- containers where the components will be created.
-
-
-
-
-Royer, et al. Experimental [Page 92]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- If the iCalendar object being created does not have a "METHOD"
- property, then its state is "BOOKED" and it is not an [iTIP]
- scheduling object. Use the "DELETE" command to set the state of
- an object to the "DELETED" state (tagged for deletion). A CUA
- cannot use the "CREATE" command to create an object in the
- "DELETED" state.
-
- If the intention is to book an [iTIP] object, then the "METHOD"
- property MUST NOT be supplied. Otherwise, any [iTIP] object MUST
- have a valid [iTIP] "METHOD" property value and it is a scheduling
- request being deposited into the CS with its state set to
- "UNPROCESSED".
-
- Format Definition: ABNF for a "CREATE" object is:
-
- create-object = "BEGIN" ":" "VCALENDAR" CRLF
- ; If 'calprops' contain the "METHOD" property
- ; then this 'create-object' component MUST
- ; conform to [iTIP] restrictions.
- ;
- ; calprops MUST include 'create-cmd'
- ;
- calprops
- other-props
- 1*(create-comp)
- "END" ":" "VCALENDAR" CRLF
-
- ; NOTE: The 'VCALSTORE' component is not included in
- ; 'create-comp' as it is out of scope for CAP to create
- ; a new CS.
- ;
- create-comp = agendac / carc / queryc
- / timezonec / freebusyc
- / eventc / todoc / journalc
- / iana-comp / x-comp
- ;
- freebusyc = ; As defined in [iCAL].
- ;
- eventc = ; As defined in [iCAL].
- ;
- journalc = ; As defined in [iCAL].
- ;
- timezonec = ; As defined in [iCAL].
- ;
- todoc = ; As defined in [iCAL].
-
- In the following example, two new top level "VAGENDA" components are
- created. Note that the "CSID" value of the server is
-
-
-
-Royer, et al. Experimental [Page 93]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- cal.example.com, which is where the new "VAGENDA" components are
- going to be created.
-
- C: Content-Type: text/calendar
- C:
- C: BEGIN:VCALENDAR
- C: PRODID:-//someone's prodid
- C: VERSION:2.0
- C: CMD;ID=creation01:CREATE
- C: TARGET:cal.example.com
- C: BEGIN:VAGENDA <- data for 1st new calendar
- C: CALID:relcalz1
- C: NAME;LANGUAGE=en_US:Bill's Soccer Team
- C: OWNER:bill
- C: CALMASTER:mailto:bill@example.com
- C: TZID:US/Pacific
- C: END:VAGENDA
- C: BEGIN:VAGENDA <- data for 2nd new calendar
- C: CALID:relcalz2
- C: NAME;LANGUAGE=EN-us:Mary's personal calendar
- C: OWNER:mary
- C: CALMASTER:mailto:mary@example.com
- C: TZID:US/Pacific
- C: END:VAGENDA
- C: END:VCALENDAR
-
- S: Content-Type: text/calendar
- S:
- S: BEGIN:VCALENDAR
- S: VERSION:2.0
- S: PRODID:-//someone's prodid
- S: CMD;ID=creation01:REPLY
- S: TARGET:cal.example.com
- S: BEGIN:VREPLY <- Reply for 1st calendar create
- S: CALID:relcalz1
- S: REQUEST-STATUS:2.0
- S: END:REPLY
- S: BEGIN:VREPLY <- Reply for 2nd calendar create
- S: CALID:relcalz2
- S: REQUEST-STATUS:2.0
- S: END:VREPLY
- S: END:VCALENDAR
-
- To create a new component in multiple containers, simply name all
- of the containers in the "TARGET" in the create command. A new
- "VEVENT" component is created in two TARGET components. In this
- example, the "VEVENT" component is one new [iTIP] "REQUEST" to be
-
-
-
-
-Royer, et al. Experimental [Page 94]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- stored in two calendars. The results would be iCalendar objects
- that conform to the [iTIP] replies as defined in [iTIP].
-
- This example shows two [iTIP] "VEVENT" components being created in
- each of the two supplied "TARGET" properties. As it contains the
- "METHOD" property, they will be stored in the "UNPROCESSED" state:
-
- C: Content-Type: text/calendar
- C:
- C: BEGIN:VCALENDAR
- C: VERSION:2.0
- C: PRODID:-//someone's prodid
- C: CMD;ID=creation02:CREATE
- C: METHOD:REQUEST
- C: TARGET:relcalz1
- C: TARGET:relcalz2
- C: BEGIN:VEVENT
- C: DTSTART:20030307T180000Z
- C: UID:FirstInThisExample-1
- C: DTEND:20030307T190000Z
- C: SUMMARY:Important Meeting
- C: END:VEVENT
- C: BEGIN:VEVENT
- C: DTSTART:20040307T180000Z
- C: UID:SecondInThisExample-2
- C: DTEND:20040307T190000Z
- C: SUMMARY:Important Meeting
- C: END:VEVENT
- C: END:VCALENDAR
-
- The CS sends the "VREPLY" commands in separate MIME objects, one
- per supplied "TARGET" property value.
-
- S: Content-Type: text/calendar
- S:
- S: BEGIN:VCALENDAR
- S: VERSION:2.0
- S: PRODID:-//someone's prodid
- S: CMD;ID=creation02:REPLY
- S: TARGET:relcalz1 <- 1st TARGET listed.
- S: BEGIN:REPLY <- Reply for 1st VEVENT create in 1st TARGET.
- S: UID:FirstInThisExample-1
- S: REQUEST-STATUS:2.0
- S: END:VREPLY
- S: BEGIN:REPLY <- Reply for 2nd VEVENT crate in 1st TARGET.
- S: UID:SecondInThisExample-2
- S: REQUEST-STATUS:2.0
- S: END:VREPLY
-
-
-
-Royer, et al. Experimental [Page 95]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- S: END:VCALENDAR
-
- And the second reply for the 2nd TARGET:
-
- S: Content-Type: text/calendar
- S:
- S: BEGIN:VCALENDAR
- S: VERSION:2.0
- S: PRODID:-//someone's prodid
- S: CMD;ID=creation02:REPLY
- S: TARGET:relcalz2 <- 2nd TARGET listed
- S: BEGIN:REPLY <- Reply for 1st VEVENT create in 2nd TARGET.
- S: UID:FirstInThisExample-1
- S: REQUEST-STATUS:2.0
- S: END:VREPLY
- S: BEGIN:REPLY <- Reply for 2nd VEVENT crate in 2nd TARGET.
- S: UID:SecondInThisExample-2
- S: REQUEST-STATUS:2.0
- S: END:VREPLY
- S: END:VCALENDAR
-
-10.5. DELETE Command
-
- CMD: DELETE
-
- Purpose: The "DELETE" command physically removes the QUERY result
- from the store or marks it for deletion.
-
- A CUA MAY send a "DELETE" command to a CS. The "DELETE" command
- MUST be implemented by all CSs.
-
- The CS MUST NOT send a "DELETE" command to any CUA.
-
- Formal Definition: A "DELETE" command is defined by the following
- notation:
-
- delete-cmd = deleteparam ":" "DELETE"
- ;
- deleteparam = *(
- ;
- ; the following are optional,
- ; but MUST NOT occur more than once
- ;
- id-param
- / localize-param
- / latency-param
- / option-param "MARK"
- ;
-
-
-
-Royer, et al. Experimental [Page 96]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- ; The following MUST occur exactly once and
- ; only when the latency-param has been supplied.
- ; It MUST NOT be supplied if the latency-param
- ; is not supplied.
- ;
- / action-param
- ;
- ; the following is optional,
- ; and MAY occur more than once
- ;
- / other-params
- )
-
- The "DELETE" command is used to delete calendars or components.
- The included "VQUERY" component(s) specifies the container(s) to
- delete.
-
- To mark a component for delete without physically removing it,
- include the "OPTIONS" parameter with its value set to the "MARK"
- value in order to alter its state to "DELETED".
-
- When components are deleted, only the top-most component
- "REQUEST-STATUS" properties are returned. No "REQUEST-STATUS"
- properties are returned for components inside of the selected
- components. There MUST be one "VREPLY" component returned for
- each object that is deleted or marked for delete. Note that if no
- "VREPLY" components are returned, then nothing matched and nothing
- was deleted.
-
- Restriction Table for the "REPLY" command for any "DELETE"
- command.
-
- delete-reply = "BEGIN" ":" "VCALENDAR" CRLF
- calprops ; MUST include 'reply-cmd'
- *(delete-vreply)
- "END" ":" "VCALENDAR" CRLF
- ;
- delete-vreply = "BEGIN" ":" "VREPLY" CRLF
- deleted-id
- rstatus
- "END" ":" "VREPLY" CRLF
- ;
- ; Where the id is appropriate for the
- ; type of object deleted:
- ;
- ; VAGENDA = relcalid
- ; VCAR = carid
- ; VEVENT, VFREEBUSY, VJOURNAL, VTODO = uid
-
-
-
-Royer, et al. Experimental [Page 97]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- ; VQUERY = queryid
- ; ALARM = sequence
- ; VTIMEZONE = tzid
- ; x-comp = x-id
- ; An instance = uid recurid
- ;
- deleted-id = ( relcalid / carid / uid / uid recurid
- / queryid / tzid / sequence / x-id )
-
- Example: to delete a "VEVENT" component with "UID" value of
- "abcd12345" from the calendar "relcalid-22" from the current CS:
-
- C: Content-Type: text/calendar
- C:
- C: BEGIN:VCALENDAR
- C: TARGET:relcalid-22
- C: CMD;ID:"random but unique per CUA":DELETE
- C: BEGIN:VQUERY
- C: QUERY:SELECT VEVENT FROM VAGENDA WHERE UID = 'abcd12345'
- C: END:VQUERY
- C: END:VCALENDAR
-
- S: BEGIN:VCALENDAR
- S: TARGET:relcalid-22
- S: CMD;ID:"random but unique per CUA":REPLY
- S: BEGIN:VREPLY
- S: UID:abcd12345
-
- S: REQUEST-STATUS:3.0
- S: END:VREPLY
- S: END:VCALENDAR
-
- One or more iCalendar objects will be returned that contain
- "REQUEST-STATUS" properties for the deleted components. More than
- one component could have been deleted. Any booked component and
- any number of unprocessed [iTIP] scheduling components that
- matched the QUERY value in the above example will be returned.
- Each unique "METHOD" property value that was deleted from the
- store MUST be in a separate iCalendar object. This is because
- only one "METHOD" property is allowed in a single "VCALENDAR"
- BEGIN/END block.
-
-10.6. GENERATE-UID Command
-
- CMD: GENERATE-UID
-
- Purpose: The "GENERATE-UID" command returns one or more unique
- identifiers that MUST be globally unique.
-
-
-
-Royer, et al. Experimental [Page 98]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- The "GENERATE-UID" command MAY be sent to any CS. The "GENERATE-
- UID" command MUST be implemented by all CSs.
-
- The "GENERATE-UID" command MUST NOT be sent to a CUA.
-
- Formal Definition: A "GENERATE-UID" command is defined by the
- following notation:
-
- generate-uid-cmd = genuidparam ":" "GENERATE-UID"
- ;
- genuidparam = *(
- ;
- ; The following are optional,
- ; but MUST NOT occur more than once.
- ;
- id-param
- / localize-param
- / latency-param
- ;
- ; The following MUST occur exactly once and
- ; only when the latency-param has been supplied.
- ; It MUST NOT be supplied if the latency-param
- ; is not supplied.
- ;
- / action-param
- ;
- ; The following is optional,
- ; and MAY occur more than once.
- ;
- / other-params
- ;
- ; The following MUST be supplied exactly once.
- ; The value specifies the number of UIDs to
- ; be returned.
- ;
- / option-param posint1
- )
-
- Response:
-
- gen-reply = "BEGIN" ":" "VCALENDAR" CRLF
- calprops ; Which MUST include 'reply-cmd'
- 1*(gen-vreply)
- "END" ":" "VCALENDAR" CRLF
-
- gen-vreply = "BEGIN" ":" "VREPLY" CRLF
- 1*(uid)
- rstatus
-
-
-
-Royer, et al. Experimental [Page 99]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- "END" ":" "VREPLY" CRLF
- {%%%IS THIS RIGHT%%%?]
-
- Example:
-
- C: BEGIN:VCALENDAR
- C: VERSION:2.0
- C: PRODID:-//someone's prodid
- C: CMD;ID=unique-per-cua-124;OPTIONS=5:GENERATE-UID
- C: END:VCALENDAR
-
- S: Content-Type: text/calendar
- S:
- S: BEGIN:VCALENDAR
- S: VERSION:2.0
- S: PRODID:-//someone's prodid
- S: CMD;ID=unique-per-cua-124:REPLY
- S: BEGIN:VREPLY
- S: UID:20011121T120000Z-12340@cal.example.com
- S: UID:20011121T120000Z-12341@cal.example.com
- S: UID:20011121T120000Z-12342@cal.example.com
- S: UID:20011121T120000Z-12343@cal.example.com
- S: UID:20011121T120000Z-12344@cal.example.com
- S: REQUEST-STATUS:2.0
- S: END:VREPLY
- S: END:VCALENDAR
-
-10.7. GET-CAPABILITY Command
-
- CMD: GET-CAPABILITY
-
- Purpose: The "GET-CAPABILITY" command returns the capabilities of the
- other end point of the session.
-
- A CUA MUST send a "GET-CAPABILITY" command to a CS after the
- initial connection. A CS MUST send a "GET-CAPABILITY" command to
- a CUA after the initial connection. The "GET-CAPABILITY" command
- and reply MUST be implemented by all CSs and CUAs.
-
- Formal Definition: A "GET-CAPABILITY" command is defined by the
- following notation:
-
- get-capability-cmd = capabilityparam ":" "GET-CAPABILITY"
-
- capabilityparam = *(
-
- ; the following are optional,
- ; but MUST NOT occur more than once
-
-
-
-Royer, et al. Experimental [Page 100]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- ;
- id-param / localize-param / latency-param
- ;
- ; the following MUST occur exactly once and only
- ; when the latency-param has been supplied and
- ; MUST NOT be supplied if the latency-param is
- ; not supplied.
- ;
- / action-param
- ;
- ; the following is optional,
- ; and MAY occur more than once
- ;
- / other-params
- )
-
- Response:
-
- The "GET-CAPABILITY" command returns information about the
- implementation at the other end of the session. The values
- returned may differ depending on current user identify and the
- security level of the connection.
-
- Client implementations SHOULD NOT require any capability element
- beyond those defined in this specification or future RFC
- publications. They MAY ignore any nonstandard, experimental
- capability elements. The "GET-CAPABILITY" reply may return
- different results, depending on the UPN and if the UPN is
- authenticated.
-
- When sending a reply to a "GET-CAPABILITY" command, all of these
- MUST be supplied. The following properties are returned in
- response to a "GET-CAPABILITY" command:
-
- cap-vreply = "BEGIN" ":" "VCALENDAR" CRLF
- ; The following properties may be in any order.
- ;
- rodid
- version
- reply-cmd
- other-props
-
- "BEGIN" ":" "VREPLY" CRLF
- ; The following properties may be in any order.
- ;
- cap-version
- car-level
- components
-
-
-
-Royer, et al. Experimental [Page 101]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- stores-expanded
- maxdate
- mindate
- itip-version
- max-comp-size
- multipart
- query-level
- recur-accepted
- recur-expand
- recur-limit
- other-props
- "END" ":" "VREPLY" CRLF
- "END" ":" "VCALENDAR" CRLF
-
- Example:
-
- I: Content-Type: text/calendar
- I:
- I: BEGIN:VCALENDAR
- I: VERSION:2.0
- I: PRODID:-//someone's prodid
- I: CMD;ID=unique-per-cua-125:GET-CAPABILITY
- I: END:VCALENDAR
-
- L: Content-Type: text/calendar
- L:
- L: BEGIN:VCALENDAR
- L: VERSION:2.0
- L: PRODID:-//someone's prodid
- L: CMD;ID=unique-per-cua-125:REPLY
- L: BEGIN:VREPLY
- L: CAP-VERSION:1.0
- L: PRODID:The CS prodid
- L: QUERY-LEVEL:CAL-QL-1
- L: CAR-LEVEL:CAR-FULL-1
- L: MAXDATE:99991231T235959Z
- L: MINDATE:00000101T000000Z
- L: MAX-COMPONENT-SIZE:0
- L: COMPONENTS:VCALENDAR,VTODO,VJOURNAL,VEVENT,VCAR,
- L: VALARM,VFREEBUSY,VTIMEZONE,STANDARD,DAYLIGHT,VREPLY
- L: ITIP-VERSION:2446
- L: RECUR-ACCEPTED:TRUE
-
-
-
-
-
-
-
-
-
-Royer, et al. Experimental [Page 102]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- L: RECUR-EXPAND:TRUE
- L: RECUR-LIMIT:0
- L: STORES-EXPANDED:FALSE
- L: X-INET-PRIVATE-COMMANDS:1.0
- L: END:VREPLY
- L: END:VCALENDAR
-
-10.8. IDENTIFY Command
-
- CMD: IDENTIFY
-
- Purpose: The "IDENTIFY" command allows the CUA to set a new identity
- to be used for calendar access.
-
- A CUA MAY send an "IDENTIFY" command to a CS. The "IDENTIFY"
- command MUST be implemented by all CSs. A CS implementation MAY
- reject all "IDENTIFY" commands.
-
- The CS MUST NOT send an "IDENTIFY" command to any CUA.
-
- Formal Definition: An "IDENTIFY" command is defined by the following
- notation:
-
- identify-cmd = identifyparam ":" "IDENTIFY"
- ;
- identifyparam = *(
- ;
- ; the following are optional,
- ; but MUST NOT occur more than once
- ;
- id-param
- / localize-param
- / latency-param
- ;
- ; the following MUST occur exactly once and only
- ; when the latency-param has been supplied and
- ; MUST NOT be supplied if the latency-param is
- ; not supplied.
- ;
- / action-param
- ;
- ; the following is optional,
- ; and MAY occur more than once
- ;
- / other-params
- ;
- ; The value is the UPN of the requested
- ; identity. If option is not supplied it is
-
-
-
-Royer, et al. Experimental [Page 103]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- ; a request to return to the original
- ; authenticated identity.
- ;
- / option-param upn
- )
-
- Response:
-
- A "REQUEST-STATUS" property wrapped in a "VREPLY" component with
- only one of the following request-status codes:
-
- 2.0 Successful.
-
- 6.4 Identity not permitted. VCAR restriction.
-
- The CS determines, through an internal mechanism, if the credentials
- supplied at authentication permit the operation as the selected
- identity. If they do, the session assumes the new identity;
- otherwise, a security error is returned.
-
- Example:
-
- C: Content-Type: text/calendar
- C:
- C: BEGIN:VCALENDAR
- C: VERSION:2.0
- C: PRODID:-//someone's prodid
- C: CMD;ID=unique-per-cua-999;OPTIONS=newUserId:IDENTIFY
- C: END:VCALENDAR
-
- S: Content-Type: text/calendar
- S:
- S: BEGIN:VCALENDAR
- S: VERSION:2.0
- S: PRODID:-//someone's prodid
- S: BEGIN:VREPLY
- S: REQUEST-STATUS:2.0;Request Approved
- S: END:VREPLY
- S: END:VCALENDAR
-
- Or if denied:
-
-
-
-
-
-
-
-
-
-
-Royer, et al. Experimental [Page 104]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- S: Content-Type: text/calendar
- S:
- S: BEGIN:VCALENDAR
- S: PRODID:-//someone's prodid
- S: VERSION:2.0
- S: BEGIN:VREPLY
- S: REQUEST-STATUS:6.4;Request Denied
- S: END:VREPLY
- S: END:VCALENDAR
-
- For the CUA to return to its original authenticated identity, the
- OPTIONS parameter is omitted:
-
- C: Content-Type: text/calendar
- C:
- C: BEGIN:VCALENDAR
- C: VERSION:2.0
- C: PRODID:-//someone's prodid
- C: CMD;ID=unique-per-cua-995:IDENTIFY
- C: END:VCALENDAR
-
- The CS may accept (2.0) or deny (6.4) the request to return to the
- original identity.
-
- If a CS considers the "IDENTIFY" command an attempt to violate
- security, the CS MAY terminate the [BEEP] session without any further
- notice to the CUA after sending the "REQUEST-STATUS" 6.4 reply.
-
-10.9. MODIFY Command
-
- CMD: MODIFY
-
- Purpose: The "MODIFY" command is used to modify existing components.
-
- A CUA MAY send a "MODIFY" command to a CS. The "MODIFY" command
- MUST be implemented by all CSs.
-
- The CS MUST NOT send a "MODIFY" command to any CUA.
-
- Formal Definition: A "MODIFY" command is defined by the following
- notation:
-
- modify-cmd = modifyparam ":" "MODIFY"
- ;
- modifyparam = *(
- ;
- ; the following are optional,
- ; but MUST NOT occur more than once
-
-
-
-Royer, et al. Experimental [Page 105]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- ;
- id-param
- / localize-param
- / latency-param
- ;
- ; the following MUST occur exactly once and only
- ; when the latency-param has been supplied and
- ; MUST NOT be supplied if the latency-param is
- ; not supplied.
- ;
- / action-param
- ;
- ; the following is optional,
- ; and MAY occur more than once
- ;
- / other-params
- )
-
- The "MODIFY" command is used to modify existing components. The
- TARGET property specifies the calendars that contain the
- components that are going to be modified.
-
- The format of the request is three components inside of
- "VCALENDAR" component:
-
- BEGIN:VCALENDAR
- BEGIN:VQUERY
- END:VQUERY
- BEGIN:XXX
- END:XXX
- BEGIN:XXX
- END:XXX
- END:VCALENDAR
-
- The "VQUERY" component selects the components that are to be
- modified.
-
- The "XXX" above is a named component type (VEVENT, VTODO, ...).
- Both the old and new components MUST be of the same type.
-
- The old-values is a component and the contents of that component
- are going to change and may contain information that helps
- uniquely identify the original component (SEQUENCE in the example
- below). If the CS cannot find a component that matches the QUERY
- and does not have at least all of the OLD-VALUES, then a 6.1 error
- is returned.
-
-
-
-
-
-Royer, et al. Experimental [Page 106]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- The new-values is a component of the same type as old-values and
- new-values contains the new data for each selected component. Any
- data that is in old-values and not in new-values is deleted from
- the selected component. Any values in new-values that was not in
- old-values is added to the component.
-
- In this example, the "VEVENT" component with a "UID" property
- value of 'unique-58' has the "LOCATION" property and "LAST-
- MODIFIED" properties changed, the "VALARM" component with the
- "SEQUENCE" property with a value of "3" has its "TRIGGER" property
- disabled, the "X-LOCAL" property is removed from the "VEVENT"
- component, and a "COMMENT" property is added.
-
- Because "SEQUENCE" property is used to locate the "VALARM"
- component in this example, both the old-values and the new-values
- contain the "SEQUENCE" property with a value of "3". If the
- "SEQUENCE" property were to be left out of new-values, it would
- have been deleted.
-
- Example:
-
- C: Content-Type: text/calendar
- C:
- C: BEGIN:VCALENDAR
- C: VERSION:2.0
- C: PRODID:-//someone's prodid
- C: TARGET:my-cal
- C: CMD:ID=unique-mod:MODIFY
- C: BEGIN:VQUERY <- Query to select data set.
- C: QUERY:SELECT * FROM VEVENT WHERE UID = 'unique-58'
- C: END:VQUERY
- C: BEGIN:VEVENT <- Start of old data.
- C: LOCATION:building 3
- C: LAST-MODIFIED:20020101T123456Z
- C: X-LOCAL:some private stuff
- C: BEGIN:VALARM
- C: SEQUENCE:3
- C: TRIGGER;RELATED=END:PT5M
- C: END:VALARM
- C: END:VEVENT <- End of old data.
- C: BEGIN:VEVENT <- Start of new data.
- C: LOCATION:building 4
- C: LAST-MODIFIED:20020202T010203Z
- C: COMMENT:Ignore global trigger.
- C: BEGIN:VALARM
- C: SEQUENCE:3
- C: TRIGGER;ENABLE=FALSE:RELATED=END:PT5M
- C: END:VALARM
-
-
-
-Royer, et al. Experimental [Page 107]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- C: END:VEVENT <- End of new data.
- C: END:VCALENDAR
-
- The "X-LOCAL" property was not supplied in the new-values, so it
- was deleted. The "LOCATION" property value was altered, as was
- the "LAST-MODIFIED" value. The "VALARM" component with a
- "SEQUENCE" property value of "3" had its "TRIGGER" property
- disabled, and the "SEQUENCE" property value did not change so it
- was not effected. The "COMMENT" property was added.
-
- When it comes to inline ATTACHMENTs, the CUA only needs to
- uniquely identify the contents of the ATTACHMENT value in the
- old-values in order to delete them. When the CS compares the
- attachment data, it is compared in its binary form. The
- ATTACHMENT value supplied by the CUA MUST be valid encoded
- information.
-
- For example, to delete the same huge inline attachment from every
- VEVENT in 'my-cal' that has an "ATTACH" property value with the
-
- old-values:
-
- BEGIN:VCALENDAR
- VERSION:2.0
- PRODID:-//someone's prodid
- TARGET:my-cal
- CMD:MODIFY
- BEGIN:VQUERY
- QUERY:SELECT ATTACH FROM VEVENT
- END:VQUERY
- BEGIN:VEVENT
- ATTACH;FMTTYPE=image/basic;ENCODING=BASE64;VALUE=BINARY:
- MIICajCCAdOgAwIBAgICbeUwDQYJKoZIhvcNAQEEBQAwdzELMAkGA1U
- EBhMCVVMxLDAqBgNVBAoTI05ldHNjYXBlIENvbW11bmljYXRpb25zIE
- ...< remainder of attachment data NOT supplied >....
- END:VEVENT
- BEGIN:VEVENT
- END:VEVENT
- END:VCALENDAR
-
- Here the new-values is empty, so everything in the old-values is
- deleted.
-
- Furthermore, the following additional restrictions apply:
-
- 1. One cannot change the "UID" property of a component.
-
-
-
-
-
-Royer, et al. Experimental [Page 108]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- 2. If a contained component is changed inside of a selected
- component, and that contained component has multiple instances,
- then old-values MUST contain information that uniquely
- identifies the instance or instances that are changing. It is
- valid to change more than one. All contained components that
- match old-values will be modified. In the first modify example
- above, if "SEQUENCE" properties were to be deleted from both the
- old-values and new-values, then all "TRIGGER" properties that
- matched the old-values in all "VALARM" components in the
- selected "VEVENT" components would be disabled.
-
- 3. The result of the modify MUST be a valid iCalendar object.
-
- Response:
-
- A "VCALENDAR" component is returned with one ore more "REQUEST-
- STATUS" property values.
-
- If any error occurred:
-
- No component will be changed at all. That is, it will appear just
- as it was prior to the modify and the CAP server SHOULD return a
- "REQUEST-STATUS" property for each error that occurred. There
- MUST be at least one error reported.
-
- If multiple components are selected, then what uniquely identified
- the component MUST be returned (UID, QUERYID, ...) if the component
- contains a unique identifier. If it does not, sufficient information
- to uniquely identify the modified components MUST be returned in the
- reply.
-
- S: Content-Type: text/calendar
- S:
- S: BEGIN:VCALENDAR
- S: TARGET:relcalid
- S: CMD;ID=delete#1:REPLY
- S: BEGIN:VREPLY
- S: BEGIN:VEVENT
- S: UID:123
- S: REQUEST-STATUS:2.0
- S: END:VEVENT
- S: END:VREPLY
- S: END:VCALENDAR
-
-
-
-
-
-
-
-
-Royer, et al. Experimental [Page 109]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
-10.10. MOVE Command
-
- CMD: MOVE
-
- Purpose: The "MOVE" command is used to move components within the CS.
-
- A CUA MAY send a "MOVE" command to a CS. The "MOVE" command MUST
- be implemented by all CSs.
-
- The CS MUST NOT send a "MOVE" command to any CUA.
-
- Formal Definition: A "MOVE" command is defined by the following
- notation:
-
- move-cmd = moveparam ":" "MOVE"
- ;
- moveparam = *(
- ;
- ; the following are optional,
- ; but MUST NOT occur more than once
- ;
- id-param
- / localize-param
- / latency-param
- ;
- ; the following MUST occur exactly once and only
- ; when the latency-param has been supplied and
- ; MUST NOT be supplied if the latency-param is
- ; not supplied.
- ;
- / action-param
- ;
- ; the following is optional,
- ; and MAY occur more than once
- ;
- / other-params
- ;
- )
-
- Response:
-
- The REQUEST-STATUS in a VCALENDAR object.
-
- The content of each "result" is subject to the result restriction
- table defined below.
-
- The access control on the "VAGENDA" component, after it has been
- moved to its new location in the calstore, MUST be at least as
-
-
-
-Royer, et al. Experimental [Page 110]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- secure as it was prior to the move. If the CS is not able to
- ensure the same level of security, a permission-denied "REQUEST-
- STATUS" property value MUST be returned, and the "MOVE" command
- MUST NOT be performed.
-
- The "TARGET" property value specifies the new location, and the
- "VQUERY" component specifies the old location.
-
- Restriction Table for the "REPLY" command of any "MOVE" command.
-
- move-reply = "BEGIN" ":" "VCALENDAR" CRLF
- calprops
- 1*(move-vreply)
- "END" ":" "VCALENDAR" CRLF
-
- move-vreply = "BEGIN" ":" "VREPLY" CRLF
- move-id
- rstatus
- "END" ":" "VREPLY" CRLF
-
- ; Where the id is appropriate for the
- ; type of object moved:
- ;
- ; VAGENDA = relcalid
- ; VCAR = carid
- ; VEVENT, VFREEBUSY, VJOURNAL, VTODO = uid
- ; VQUERY = queryid
- ; ALARM = sequence
- ; An instance = uid recurid
- ; x-comp = x-id
- ;
- move-id = ( relcalid / carid / uid / uid recurid
- / queryid / tzid / sequence / x-id)
-
- Example: moving the VAGENDA Nellis to Area-51
-
- C: Content-Type: text/calendar
- C:
- C: BEGIN:VCALENDAR
- C: VERSION:2.0
- C: PRODID:-//someone's prodid
- C: CMD:MOVE
- C: TARGET:Area-51
- C: BEGIN:VQUERY
- C: QUERY: SELECT *.* FROM VAGENDA WHERE CALID='Nellis'
- C: END:VQUERY
- C: END:VCALENDAR
-
-
-
-
-Royer, et al. Experimental [Page 111]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- S: Content-Type: text/calendar
- S:
- S: BEGIN:VCALENDAR
- S: VERSION:2.0
- S: PRODID:-//someone's prodid
- S: TARGET:Area-51
- S: BEGIN:VREPLY
- S: CALID:Nellis
- S: REQUEST-STATUS: 2.0
- S: END:VREPLY
- S: END:VCALENDAR
-
-10.11. REPLY Response to a Command
-
- CMD: REPLY
-
- Purpose: The "REPLY" value to the "CMD" property is used to return
- the results of all other commands to the CUA.
-
- A CUA MUST send a "REPLY" command to a CS for any command a CS MAY
- send to the CUA. The "REPLY" command MUST be implemented by all
- CUAs that support getting the "GET-CAPABILITY" command.
-
- A CS MUST send a "REPLY" command to a CUA for any command a CUA
- MAY send to the CS. The "REPLY" command MUST be implemented by
- all CSs.
-
- Formal Definition: A "REPLY" command is defined by the following
- notation:
-
- reply-cmd = replyparam ":" "REPLY"
- ;
- replyparam = *(
- ;
- ; The 'id' parameter value MUST be exactly the
- ; same as the value sent in the original
- ; CMD property. If the original CMD did
- ; not have an 'id' parameter, then the 'id'
- ; MUST NOT be supplied in the REPLY.
- ;
- id-param
- ;
- ; the following is optional,
- ; and MAY occur more than once
- ;
- / other-params
- )
-
-
-
-
-Royer, et al. Experimental [Page 112]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
-10.12. SEARCH Command
-
- CMD: SEARCH
-
- Purpose: The "SEARCH" command is used to return selected components
- to the CUA.
-
- A CUA MAY send a "SEARCH" command to a CS. The "SEARCH" command
- MUST be implemented by all CSs.
-
- The CS MUST NOT send a "SEARCH" command to any CUA.
-
- Formal Definition: A "SEARCH" command is defined by the following
- notation:
-
- search-cmd = searchparam ":" "SEARCH"
- ;
- searchparam = *(
- ;
- ; the following are optional,
- ; but MUST NOT occur more than once
- ;
- id-param
- / localize-param
- / latency-param
- ;
- ; the following MUST occur exactly once and only
- ; when the latency-param has been supplied and
- ; MUST NOT be supplied if the latency-param is
- ; not supplied.
- ;
- / action-param
- ;
- ; the following is optional,
- ; and MAY occur more than once
- ;
- / other-params
- )
-
- The format of the request is the search command (search-cmd)
- followed by one or more (query) "VQUERY" components
-
- Response:
-
- The data in each result set contains one or more iCalendar
- components composed of all the selected results enclosed in a
- single "VREPLY" component per "QUERY".
-
-
-
-
-Royer, et al. Experimental [Page 113]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- Only "REQUEST-STATUS" property and the properties mentioned in the
- "SELECT" clause of the QUERY are included in the components. Each
- "VCALENDAR" component is tagged with the "TARGET" property.
-
- Searching for objects
-
- In the example below, objects on March 10,1999 between 080000Z and
- 190000Z are read. In this case only four properties for each
- object are returned. Two calendars are specified. Only booked
- (vs. scheduled) entries are to be returned (this example only
- selected VEVENT objects are to be returned):
-
- C: Content-Type: text/calendar
- C:
- C: BEGIN:VCALENDAR
- C: VERSION:2.0
- C: PRODID:-//someone's prodid
- C: CMD:SEARCH
- C: TARGET:relcal2
- C: TARGET:relcal3
- C: BEGIN:VQUERY
- C: QUERY:SELECT DTSTART,DTEND,SUMMARY,UID
- C: FROM VEVENT
- C: WHERE DTEND >= '19990310T080000Z'
- C: AND DTSTART <= '19990310T190000Z'
- C: AND STATE() = 'BOOKED'
- C: END:VQUERY
- C: END:VCALENDAR
-
- The return values are subject to VCAR filtering. That is, if the
- request contains properties to which the UPN does not have access,
- those properties will not appear in the return values. If the UPN
- has access to at least one property of the component, but has been
- denied access to all properties called out in the request, the
- response will contain a single "REQUEST-STATUS" property
- indicating the error.
-
- Here the request was successful, however one of the "VEVENT"
- components contents were not accessible (4.1).
-
-
-
-
-
-
-
-
-
-
-
-
-Royer, et al. Experimental [Page 114]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- S: Content-Type: text/calendar
- S:
- S: BEGIN:VCALENDAR
- S: TARGET:relcalid
- S: CMD:REPLY
- S: VERSION:2.0
- S: PRODID:-//someone's prodid
- S: BEGIN:VREPLY
- S: BEGIN:VEVENT
- S: REQUEST-STATUS:4.1
- S: END:VEVENT
- S: BEGIN:VEVENT
- S: REQUEST-STATUS:2.0
- S: UID:123
- S: DTEND:19990310T080000Z
- S: DSTART:19990310T190000Z
- S: SUMMARY: Big meeting
- S: END:VEVENT
-
- S: END:VREPLY
- S: END:VCALENDAR
-
- If the UPN has no access to any components at all, the response
- will simply be an empty data set. The response will look the same
- if the particular components do not exist.
-
- S: Content-Type: text/calendar
- S:
- S: BEGIN:VCALENDAR
- S: VERSION:2.0
- S: PRODID:-//someone's prodid
- S: CMD:REPLY
- S: TARGET:ralcalid
- S: BEGIN:VREPLY
- S: REQUEST-STATUS:2.0
- S: END:VREPLY
- S: END:VCALENDAR
-
- If there are multiple targets, each iCalendar reply is contained
- within its own iCalendar object.
-
-10.12.1. Searching for VFREEBUSY
-
- If a CS sets the "RECUR-EXPAND" property to "TRUE" and contains the
- "VFREEBUSY" component in the "COMPONENTS" value in a reply to the
- "GET-CAPABILITY" command, then it is the CS's responsibility (and not
- the CUA's responsibility) to provide the correct "VFREEBUSY"
- information for a calendar.
-
-
-
-Royer, et al. Experimental [Page 115]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- If a CUA issues a "CREATE" "VFREEBUSY", such a CS MUST return success
- and not store the "VFREEBUSY" component as the results would never be
- used.
-
- Such a CS MUST dynamically create the results of a search for
- "VFREEBUSY" components at search time when searching for STATE() =
- 'BOOKED' items.
-
- If a CUA searches for "VFREEBUSY" components with STATE() =
- 'UNPROCESSED', such a CS MUST return a "VREPLY" with no components.
-
- If a CUA searches for "VFREEBUSY" components without specifying the
- STATE, such a CS MUST return the same result as if STATE()='BOOKED'
- had been specified.
-
- For CSs that set the "CAPABILITY" "RECUR-EXPAND" property to "FALSE"
- and have the "VFREEBUSY" component in the "COMPONENTS" value in the
- "CAPABILITY" reply, a CUA MAY store the "VFREEBUSY" information on
- the CS. These CSs then MUST return a "VFREEBUSY" component
- calculated from the stored components. If no "VFREEBUSY" information
- is available for the "TARGET" calendar, then a "VFREEBUSY" with no
- blocked out time will be returned with a success code. A CUA sets
- the "VFREEBUSY" time on a/those calendars by creating a "VFREEBUSY"
- component without a "METHOD" creating a "BOOKED" entry.
-
- If a CS does not set the "VFREEBUSY" value in the "COMPONENTS"
- "CAPABILITY" value, the CS does not support the "VFREEBUSY" component
- and all creation and searching for a "VFREEBUSY" component MUST fail.
- Examples of calendars that may be in this category are public event
- calendars that will never require scheduling with other UPNs.
-
-10.13. SET-LOCALE Command
-
- CMD: SET-LOCALE
-
- Purpose: The "SET-LOCALE" command is used to select the locale that
- will be used in error codes that are used in the "REQUEST-STATUS"
- property.
-
- A CUA MAY send a "SET-LOCALE" command to a CS. The SET-LOCALE
- command MUST be implemented by all CSs.
-
- The CS MUST NOT send a "SET-LOCALE" command to any CUA.
-
- Formal Definition: A "SET-LOCALE" command is defined by the following
- notation:
-
- setlocale-cmd = setlocaleparam ":" "SET-LOCALE"
-
-
-
-Royer, et al. Experimental [Page 116]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- ;
- setlocaleparam = *(
- ;
- ; the following are optional,
- ; but MUST NOT occur more than once
- ;
- id-param
- / localize-param
- / latency-param
- / setlocale-option
- ;
- ; the following MUST occur exactly once and only
- ; only when the latency-param has been supplied.
- ; It MUST NOT be supplied if the latency-param
- ; is not supplied.
- ;
- / action-param
- ;
- ; the following is optional,
- ; and MAY occur more than once
- ;
- / other-params )
-
- setlocale-option = option-param newlocale
- ;
- newlocale = ; Any locale supplied in the initial [BEEP]
- ; "greeting" "localize" parameter and
- ; and any charset supported by the CS
- ; and listed in the DEFAULT-CHARSET property
- ; of the VCALSTORE
-
- Examples:
-
- CMD:OPTIONS=en_US.UTF-8:SET-LOCALE
- CMD:OPTIONS=th_TH.ISO8859-11:SET-LOCALE
- CMD:OPTIONS=es_MX.ISO8859-1:SET-LOCALE
-
- Restriction Table for the "REPLY" command of any "SET-LOCALE"
- command.
-
- setlocale-reply = "BEGIN" ":" "VCALENDAR" CRLF
- calprops
- 1*(setlocale-vreply)
- "END" ":" "VCALENDAR" CRLF
-
- setlocale-vreply = "BEGIN" ":" "VREPLY" CRLF
- rstatus
- "END" ":" "VREPLY" CRLF
-
-
-
-Royer, et al. Experimental [Page 117]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
-10.14. TIMEOUT Command
-
- CMD: TIMEOUT
-
- Purpose: The "TIMEOUT" command is only sent after a command has been
- sent with a latency value set. When received, it means the
- command could not be completed in the time allowed.
-
- Formal Definition: A "TIMEOUT" command is defined by the following
- notation:
-
- timeout-cmd = timeoutparam ":" "TIMEOUT"
-
- timeoutparam = *(
- ; the following are optional,
- ; but MUST NOT occur more than once
- id-param
- / localize-param
- / other-params
- )
-
-10.15. Response Codes
-
- Numeric response codes are returned using the "REQUEST-STATUS"
- property.
-
- The format of these codes is described in [iCAL] and extended in
- [iTIP] and [iMIP]. The following describes new codes added to this
- set and how existing codes apply to CAP.
-
- At the application layer, response codes are returned as the value of
- a "REQUEST-STATUS" property. The value type of this property is
- modified from that defined in [iCAL], in order to make the
- accompanying "REQUEST-STATUS" property text optional.
-
- Code Description
- --------------------------------------------------------------
- 2.0 Success. The parameters vary with the
- operation and are specified.
-
- 2.0.3 In response to the client issuing an
- "abort" reply, this reply code indicates
- that any command currently underway was
- successfully aborted.
-
- 3.1.4 Capability not supported.
-
- 4.1 Calendar store access denied.
-
-
-
-Royer, et al. Experimental [Page 118]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- 6.1 Container not found.
-
- 6.2 Attempt to create or modify an object
- that would overlap another object
- in either of the following two circumstances:
-
- (a) One of the objects has a TRANSP
- property set to OPAQUE-NOCONFLICT or
- TRANSPARENT-NOCONFLICT.
-
- (b) The calendar's ALLOW-CONFLICT
- property is set to FALSE.
-
- 6.3 Bad args.
-
- 6.4 Permission denied - VCAR restriction.
- A VCAR exists and the CS will not perform
- the operation.
-
- 7.0 A timeout has occurred. The server was
- unable to complete the operation in the
- requested time.
-
- 8.0 A failure has occurred in the CS
- that prevents the operation from
- succeeding.
-
- 8.1 A query was performed and the query is
- too complex for the CS. The operation
- was not performed.
-
- 8.2 Used to signal that an iCalendar object has
- exceeded the server's size limit
-
- 8.3 A DATETIME value was too far in the future
- to be represented on this Calendar.
-
- 8.4 A DATETIME value was too far in the past
- to be represented on this Calendar.
-
- 8.5 An attempt was made to create a new
- object, but the unique UID specified is
- already in use.
-
- 9.0 An unrecognized command was received.
- Or an unsupported command was received.
-
-
-
-
-
-Royer, et al. Experimental [Page 119]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- 10.4 The operation has not been performed
- because it would cause the resources
- (memory, disk, CPU, etc) to exceed the
- allocated quota.
- --------------------------------------------------------------
-
-11. Object Registration
-
- This section provides the process for registration of new or modified
- properties, parameters, commands, or other modifications, additions,
- or deletions to objects.
-
-11.1. Registration of New and Modified Entities
-
- New objects are registered by the publication of an IETF Request for
- Comment (RFC). Changes to objects are registered by the publication
- of a revision to the RFC in a new RFC.
-
-11.2. Post the Item Definition
-
- The object description MUST be posted to the new object discussion
- list: ietf-calendar@imc.org.
-
-11.3. Allow a Comment Period
-
- Discussion on a new object MUST be allowed to take place on the list
- for a minimum of two weeks. Consensus MUST be reached on the object
- before proceeding to the next step.
-
-11.4. Release a New RFC
-
- The new object will be submitted for publication like any other
- Internet Draft requesting RFC status.
-
-12. BEEP and CAP
-
-12.1. BEEP Profile Registration
-
- BEEP replies will be one-to-one (1:1 MSG/RPY) if possible, and one-
- to-many (1:many MSG/ANS) when the "TARGET" property value changes.
- No more than one "TARGET" property value is allowed per reply.
-
- Profile Identification: specify a [URI] that authoritatively
- identifies this profile.
-
- http://iana.org/beep/cap/1.0
-
- Message Exchanged during Channel Creation:
-
-
-
-Royer, et al. Experimental [Page 120]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- CUAs SHOULD supply the BEEP "localize" attributes in the BEEP
- "greeting" messages.
-
- CSs SHOULD supply the BEEP "localize" attributes in the BEEP
- "greeting" messages.
-
- CUAs SHOULD supply the BEEP "serverName" attribute at channel
- creation time to the CS, so that, if the CS is performing virtual
- hosting, the CS can determine the intended virtual host. CSs that
- do not support virtual hosting may ignore the BEEP "serverName"
- attribute.
-
- Messages starting one-to-one exchanges:
-
- The initial message, after authentication in each direction, MUST
- be a single "text/calendar" object containing a CAP "CAPABILITY"
- CMD. It must not be part of a MIME multipart message.
-
- After the initial message, a BEEP "MSG" may contain one or more
- MIME objects (at least one of which MUST be "text/calendar"), and
- each "text/calendar" MIME object MUST contain a CAP "CMD"
- property.
-
- Multiple iCalendar objects may be sent in a single BEEP message
- either by representing them as separate MIME text/calendar parts
- contained within a MIME multipart/mixed part or by simple
- concatenation within a single text/calendar MIME object.
-
- In either case, all iCalendar objects that are transmitted
- together must have the same TARGET property.
-
- The sending of multipart MIME entities over BEEP is not permitted
- for CAP unless the other endpoint has indicated its ability to
- accept them via the appropriate CAPABILITY.
-
- Messages in positive replies:
-
- After the initial message, a BEEP "RPY" may contain one or more
- MIME objects (at least one of which MUST be "text/calendar"), and
- each "text/calendar" MIME object MUST contain a CAP "CMD"
- property. All "text/calendar" MIME objects in a single BEEP "RPY"
- messages MUST have the same "TARGET" property value.
-
- Multiple iCalendar objects may be sent in a single BEEP message by
- either representing them as separate MIME text/calendar parts
- contained within a MIME multipart/mixed part or by simple
- concatenation within a single text/calendar MIME object.
-
-
-
-
-Royer, et al. Experimental [Page 121]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- In either case, all iCalendar objects transmitted together must
- have the same TARGET property.
-
- Sending multipart MIME entities over BEEP is not permitted for CAP
- unless the other endpoint has indicated its ability to accept them
- via the appropriate CAPABILITY.
-
- Messages in negative replies:
-
- Will contain any valid "text/calendar" MIME object that contains
- CAP "REQUEST-STATUS" property and a CAP "CMD" property with a
- property value of "REPLY". And where the CS has determined the
- requested operation to be a fatal error. And when the CS has
- performed NO operation that effected the contents of any part of
- the CS or any calendar controlled by the CS.
-
- Messages in one-to-many exchanges:
-
- After the initial message then a BEEP "MSG" may contain one or
- more MIME objects at least one of which MUST be "text/calendar"
- and each "text/calendar" MIME object MUST contain a CAP "CMD"
- property.
-
- The BEEP "MSG" messages can only contain MIME "multipart" MIME
- objects if the other endpoint has received a CAP "CAPABILITY"
- indicating the other endpoint supports multipart MIME objects.
- This does not prevent the endpoint from sending multiple [iCAL]
- 'icalobject' objects in a single BEEP "MSG" so long as all of them
- have the same "TARGET" property value.
-
- Multiple iCalendar objects may be sent in a single BEEP message by
- either representing them as separate MIME text/calendar parts
- contained within a MIME multipart/mixed part or by simple
- concatenation within a single text/calendar MIME object.
-
- In either case, all iCalendar objects transmitted together must
- have the same TARGET property.
-
- The sending of multipart MIME entities over BEEP is not permitted
- for CAP unless the other endpoint has indicated its ability to
- accept them via the appropriate CAPABILITY.
-
- Message Syntax:
-
- They are CAP "text/calendar" MIME objects as specified in this
- memo.
-
-
-
-
-
-Royer, et al. Experimental [Page 122]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- Message Semantics:
-
- As defined in this memo.
-
-12.2. BEEP Exchange Styles
-
- [BEEP] defines three styles of message exchange:
-
- MSG/ANS,ANS,...,NUL - For one to many exchanges.
-
- MSG/RPY - For one to one exchanges.
-
- MSG/ERR - For requests the cannot be processed due to an error.
-
- A CAP request targeted at more than one container MAY use a one- to-
- many exchange with a distinct answer associated with each target. A
- CAP request targeted at a single container MAY use a one-to-one
- exchange or a one-to-many exchange. "MSG/ERR" MAY only be used when
- an error condition prevents the execution of the request on all the
- targeted calendars.
-
-12.3. BEEP Connection Details
-
- All CAP communications must be done securely, so the initial greeting
- includes the TLS profile.
-
- L:
-
- I:
-
- L: RPY 0 0 . 0 110
- L: Content-Type: application/beep+xml
- L:
- L:
- L:
- L:
- L: END
-
- I: RPY 0 0 . 0 52
- I: Content-Type: application/beep+xml
- I:
- I:
- I: END
-
- At this point, the connection is secure. The TLS profile 'resets'
- the connection, so it resends the greetings, advertises the CAP
- profiles that are supported, and replies with the profile selected
- (only one profile exists at this time):
-
-
-
-Royer, et al. Experimental [Page 123]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- L:
-
- I:
-
- L: RPY 0 0 . 0 110
- L: Content-Type: application/beep+xml
- L:
- L:
- L:
- L:
- L: END
-
- I: RPY 0 0 . 0 110
- I: Content-Type: application/beep+xml
- I:
- I:
- I:
- I:
- I: END
-
- Each channel must be authenticated before work can start, but
- starting a channel involves authentication. Any SASL profile may be
- included, for example:
-
-
-
-
-
- Example of anonymous channel:
-
- C:
- C:
- C:
-
- S: RPY 0 1 . 221 87
- S: Content-Type: application/beep+xml
- S:
- S:
- S: END
-
- Example of DIGEST-MD5 channel:
-
- C:
- C:
- C:
-
- S: RPY 0 1 . 221 87
- S: Content-Type: application/beep+xml
-
-
-
-Royer, et al. Experimental [Page 124]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- S:
- S:
- S: END
-
- Piggybacking the "CAPABILITY" command.
-
- The "CAPABILITY" reply may be included during channel start (see
- RFC3080, section 2.3.1.2), as BEEP allows the start command to
- include the initial data transfer. This reduces the number of round
- trips to initiate a CAP session.
-
-13. IANA Considerations
-
- This memo defines IANA-registered extensions to the attributes
- defined by iCalendar, as defined in [iCAL], and [iTIP].
-
- IANA registration proposals for iCalendar and [iTIP] are to be mailed
- to the registration agent for the "text/calendar" [MIME] content-
- type, using the format defined in
- section 7 of [iCAL].
-
- The the IANA has registered the profile specified in Section 12.1,
- and has selected an IANA-specific URI: http://iana.org/beep/cap/1.0.
-
-14. Security Considerations
-
- Access rights should be granted cautiously. Without careful
- planning, it is possible to open up access to a greater degree than
- desired.
-
- The "IDENTIFY" command should be carefully implemented. If it is
- done incorrectly, UPNs may gain access as other, unintended, UPNs.
- The "IDENTIFY" command may not chain; that is, the identity is always
- validated against the original UPN and not the new UPN.
-
- Since CAP is a profile of [BEEP], consult [BEEP]'s Section 9 for a
- discussion of BEEP-specific security issues.
-
- There are risks of allowing anonymous UPNs to deposit REQUEST and
- REFRESH objects (calendar spam and denial-of-service, for example).
- Implementations should consider methods to restrict anonymous
- requests to within acceptable usages.
-
- CS implementations might consider automatically creating VCARs that
- allow CAP ATTENDEEs in booked objects to deposit REFRESH and REPLY
- objects for those UIDs if they otherwise do not have access rather
- then opening up world access. And they may also consider allowing
- COUNTER objects for those ATTENDEEs.
-
-
-
-Royer, et al. Experimental [Page 125]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- When an object is booked by a CUA ,the CS reply may wish to include
- warning messages to the CUA for ATTENDEEs that have CAP urls that do
- not have local UPNs as those ATTENDEES may be unable to REPLY or
- REFRESH. Some CSs may wish this to be an error.
-
- Although service provisioning is a policy matter, at a minimum, all
- implementations must provide the following tuning profiles:
-
- o for authentication: http://iana.org/beep/SASL/DIGEST-MD5
-
- o for confidentiality: http://iana.org/beep/TLS (using the
- TLS_RSA_WITH_3DES_EDE_CBC_SHA cipher)
-
- o for both: http://iana.org/beep/TLS (using the
- TLS_RSA_WITH_3DES_EDE_CBC_SHA cipher supporting client-side
- certificates)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Royer, et al. Experimental [Page 126]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
-Appendix A. Acknowledgements
-
- The following individuals were major contributors to the drafting and
- discussion of this memo, and they are greatly appreciated:
-
- Alan Davies, Andrea Campi, Andre Courtemanche, Andrew Davison, Anil
- Srivastava, ArentJan Banck, Arnaud Quillaud, Benjamin Sonntag,
- Bernard Desruisseaux, Bertrand Guiheneuf, Bob Mahoney, Bob Morgan,
- Bruce Kahn, Chris Dudding, Chris Olds, Christopher Apple, Cortlandt
- Winters, Craig Johnson, Cyrus Daboo, Damon Chaplin, Dan Hickman, Dan
- Kohn, Dan Winship, Darryl Champagne, David C. Thewlis, David Nicol,
- David Nusbaum, David West, Derik Stenerson, Eric R. Plamondon, Frank
- Dawson, Frank Nitsch, Gary Frederick, Gary McGath, Gilles Fortin,
- Graham Gilmore, Greg Barnes, Greg FitzPatrick, Harald Alvestrand,
- Harrie Hazewinkel, Helge Hess, Jagan Garimella, Jay Parker, Jim Ray,
- Jim Smith, Joerg Reichelt, John Berthels, John Smith, John Stracke,
- Jonathan Lennox, JP Rosevear, Karen Chu, Katie Capps Parlante, Kees
- Cook, Ken Crawford, Ki Wong, Lars Eggert, Lata Kannan, Lawrence
- Greenfield, Libby Miller, Lisa Dusseault, Lyndon Nerenberg, Mark
- Davidson, Mark Paterson, Mark Smith, Mark Swanson, Mark Tearle,
- Marshall Rose, Martijn van Beers, Martin Jackson, Matthias Laabs, Max
- Froumentin, Micah Gorrell, Michael Fair, Mike Higginbottom, Mike
- Hixson, Murata Makoto, Natalia Syracuse, Nathaniel Borenstein, Ned
- Freed, Olivier Gutknecht, Patrice Lapierre, Patrice Scattolin, Paul
- Hoffman, Paul Sharpe, Payod Deshpande, Pekka Pessi, Peter Thompson,
- Preston Stephenson, Prometeo Sandino Roman Corral, Ralph Patterson,
- Robert Lusardi, Robert Ransdell, Rob Siemborski, Satyanarayana
- Vempati, Satya Vempati, Scott Hollenbeck, Seamus Garvey, Shannon
- Clark, Shriram Vishwanathan, Steve Coya, Steve Mansour, Steve Miller,
- Steve Vinter, Stuart Guthrie, Suchet Singh Khalsa, Ted Hardie, Tim
- Hare, Timo Sirainen, Vicky Oliver, Paul Hill, and Yael Shaham-Gafni.
-
-Appendix B. References
-
-Appendix B.1. Normative References
-
- [ABNF] Crocker, D., Ed. and P. Overell, "Augmented BNF for
- Syntax Specifications: ABNF", RFC 4234, October 2005.
-
- [BEEP] Rose, M., "The Blocks Extensible Exchange Protocol Core",
- RFC 3080, March 2001.
-
- [BEEPTCP] Rose, M., "Mapping the BEEP Core onto TCP", RFC 3081,
- March 2001.
-
- [BEEPGUIDE] Rose, M., "BEEP, The Definitive Guide", ISBN 0-596-
- 00244-0, O'Reilly & Associates, Inc.
-
-
-
-
-Royer, et al. Experimental [Page 127]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- [GUIDE] Mahoney, B., Babics, G., and A. Taler, "Guide to Internet
- Calendaring", RFC 3283, June 2002.
-
- [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, BusyTime, To-dos and
- Journal Entries", RFC 2446, November 1998.
-
- [iMIP] Dawson, F., Mansour, S., and S. Silverberg, "iCalendar
- Message-Based Interoperability Protocol (iMIP)", RFC
- 2447, November 1998.
-
- [MIME] Freed, N. and N. Borenstein, "Multipurpose Internet Mail
- Extensions (MIME) Part One: Format of Internet Message
- Bodies", RFC 2045, November 1996.
-
- [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
- Requirement Levels", RFC 2119, BCP 14, March 1997.
-
-Appendix B.2. Informative References
-
- [CHARREG] Freed, N. and J. Postel, "IANA Charset Registration
- Procedures", RFC 2278, January 1998.
-
- [CHARPOL] Alvestrand, H., "IETF Policy on Character Sets and
- Languages", RFC 2277, January 1998.
-
- [RFC2822] Resnick, P., Ed., "Internet Message Format", RFC 2822,
- April 2001.
-
- [SASL] Myers, J., "Simple Authentication and Security Layer
- (SASL)", RFC 2222, October 1997.
-
- [SQL92] "Database Language SQL", ANSI/ISO/IEC 9075: 1992, aka
- ANSI X3.135-1992, aka FIPS PUB 127-2
-
- [SQLCOM] ANSI/ISO/IEC 9075:1992/TC-1-1995, Technical corrigendum 1
- to ISO/IEC 9075: 1992, also adopted as Amendment 1 to
- ANSI X3.135.1992
-
- [URLGUIDE] Masinter, L., Alvestrand, H., Zigmond, D., and R. Petke,
- "Guidelines for new URL Schemes", RFC 2718, November
- 1999.
-
-
-
-
-Royer, et al. Experimental [Page 128]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
- [URI] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform
- Resource Identifiers (URI): Generic Syntax", RFC 3986,
- January 2005.
-
- [URL] Berners-Lee, T, Masinter, L., and M. McCahil, "Uniform
- Resource Locators (URL)", RFC 1738, December 1994.
-
- [X509CRL] Housley, R., Polk, W., Ford, W., and D. Solo, "Internet
- X.509 Public Key Infrastructure Certificate and
- Certificate Revocation List (CRL) Profile", RFC 3280,
- April 2002.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Royer, et al. Experimental [Page 129]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
-Authors' Addresses
-
- Doug Royer
- IntelliCal, LLC
- 267 Kentlands Blvd. #3041
- Gaithersburg, MD 20878
- US
-
- Phone: +1-866-594-8574
- Fax: +1-866-594-8574
- EMail: Doug@IntelliCal.com
- URI: http://Royer.com
-
-
- George Babics
- Oracle
- 600 Blvd. de Maisonneuve West
- Suite 1900
- Montreal, Quebec H3A 3J2
- CA
-
- Phone: +1-514-905-8694
- EMail: george.babics@oracle.com
-
-
- Steve Mansour
- eBay
- 2145 Hamilton Avenue
- San Jose, CA 95125
- USA
-
- Phone: +1-408-376-8817
- EMail: smansour@ebay.com
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Royer, et al. Experimental [Page 130]
-
-RFC 4324 Calendar Access Protocol December 2005
-
-
-Full Copyright Statement
-
- Copyright (C) The Internet Society (2005).
-
- 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 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@ietf.org.
-
-Acknowledgement
-
- Funding for the RFC Editor function is currently provided by the
- Internet Society.
-
-
-
-
-
-
-
-Royer, et al. Experimental [Page 131]
-
diff --git a/docs/draft-dawson-ical-xml-dtd-01.txt b/docs/draft-dawson-ical-xml-dtd-01.txt
deleted file mode 100644
index 57ec7b84..00000000
--- a/docs/draft-dawson-ical-xml-dtd-01.txt
+++ /dev/null
@@ -1,1368 +0,0 @@
-The iCalendar XML DTD
-From: http://www.ietf.org/internet-drafts/draft-dawson-ical-xml-dtd-01.txt
-Date: 1999-01-20
-
----------------------------------------------------------------------------
-
-Network Working Group Frank Dawson, Lotus
-Internet Draft
-
-
-
-Dawson 3 Expires June 1999
-
-
-Internet Draft iCalendar XML DTD December 4, 1998
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Dawson 6 Expires June 1999
-
-
-Internet Draft iCalendar XML DTD December 4, 1998
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Dawson 7 Expires June 1999
-
-
-Internet Draft iCalendar XML DTD December 4, 1998
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Dawson 9 Expires June 1999
-
-
-Internet Draft iCalendar XML DTD December 4, 1998
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Dawson 10 Expires June 1999
-
-
-Internet Draft iCalendar XML DTD December 4, 1998
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Dawson 12 Expires June 1999
-
-
-Internet Draft iCalendar XML DTD December 4, 1998
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <-- Alarm component property element declarations -->
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-3 iCalendar Notation
-
- The formal public identifier (FPI) for the DTD described in this
- specification is "-//IETF//DTD iCalendar//EN".
-
- A XML document can reference an external non-XML entity containing an
- iCalendar object, as specified by [RFC2445]. The iCalendar object,
-
-
-Dawson 15 Expires June 1999
-
-
-Internet Draft iCalendar XML DTD December 4, 1998
-
-
- while encoded in the standard, non-XML format can be referenced in an
- external entity reference that identifies the [RFC2445] format in a
- notation declaration. The [RFC2445] format is identified by the
- formal public identifier "-//IETF//NONSGML iCalendar//EN", as defined
- in [FPI].
-
-4 Example Usage
-
-4.1 Simple iCalendar Object
-
- The following is a simple example of a XML document using this DTD.
-
-
-
-
-
-
-
- 19981116T163000Z
- 19981116T190000Z
- Project XYZ Review
- Conference Room 23A
-
-
-
-
-4.2 iCalendar with non-standard extension
-
- The following is an example of an iCalendar object that also includes
- a non-standard extension.
-
-
-
-
-
-
- ]>
-
-
-
-
- 19981105T133000Z
- 19981106T133000Z
- Draft a test plan
- 1998-ABC Corp-1234
-
-
-Dawson 16 Expires June 1999
-
-
-Internet Draft iCalendar XML DTD December 4, 1998
-
-
- 1
-
-
-
-
-4.3 iCalendar with ATTACH property
-
- The following is an example of an iCalendar object that also includes
- an external reference to an attachment.
-
-
-
-
- ]>
-
-
-
-
- 19981212T150000Z
- 19981212T160000Z
- Department Holiday Party
- Conference Room 23A
-
-
-
-
-
- The following is an example of an iCalendar object that includes an
- attachment as inline binary content.
-
-
-
-
-
-
- method="PUBLISH">
-
- 19981212T150000Z
- 19981212T160000Z
- Department Holiday Party
- Conference Room 23A
- MIICajCCAdOgAwIBAgICBEUwDQ
- EEBQAwdzELMAkGA1UEBhMCVVMxLDAqBgNVBAoTI05ldHNjYXBlIENvbW
- 11bmljYXRpb25z...and so on...IENvcnBvc==
-
-
-Dawson 17 Expires June 1999
-
-
-Internet Draft iCalendar XML DTD December 4, 1998
-
-
-
-
-
-
-4.4 Document with multiple iCalendar objects
-
- The following is an example of a document that includes more than one
- iCalendar object.
-
-
-
-
-
-
- method="PUBLISH">
-
- 19981010T000000Z
- 19981010T235959Z
- Register for conference
- 2
-
-
-
- method="PUBLISH">
-
- 19981120T133000Z
- 19981122T183000Z
- IT Conference
- Downtowner Hotel
-
-
-
-
-4.5 Document utilizing iCalendar namespace
-
- The following is an example of a well-formed but invalid XML document
- that declares the iCalendar namespace as it's default namespace.
-
-
-
-
-
-
- The following is an example of a well-formed but invalid XML document
- that includes elements from the iCalendar namespace.
-
-
-
-
- 19981123T133000Z
- 19981123T203000Z
- 1234567
- 999.99
-
-
-4.6 XML document reference to a non-XML iCalendar object
-
- The following is an example of a XML document with a proper reference
- to a non-XML entity containing an iCalendar object in the format
- defined by [RFC2445]. This example shows how existing iCalendar
- objects can be integrated into XML documents using the XML structure
- defined in this document.
-
-
-
-
-
-
- ]>
-
-
-
-
-
-
-
-5 Namespace
-
- [NSPACE] defines "XML namespaces" to be a collection of names,
- identified by a URI, which are used in XML documents as element types
- and attribute names. XML namespaces allow multiple markup vocabulary
- in a single document. Considering the utility of the iCalendar
- properties in other applications, it is important for the iCalendar
- XML DTD to define a namespace for the iCalendar element types.
-
- This memo includes the definition of both a qualified name for the
- iCalendar namespace and also a default namespace. The namespace
- declaration is specified by attributes on the "iCal" element. The
- default namespace is specified with the "xmlns" attribute and the
- qualified name for the iCalendar namespace is specified with the
- "xmlns:iCal" attribute.
-
- The default namespace attribute is useful in XML documents that are
- based on the iCalendar document types. The qualified name for the
- iCalendar namespace is useful in XML documents that partially consist
- of iCalendar elements types but also consist of element types from
- other schemas.
-
-
-
-Dawson 19 Expires June 1999
-
-
-Internet Draft iCalendar XML DTD December 4, 1998
-
-
- The following is an example of the iCalendar namespace declaration
- using the qualified namespace:
-
-
-
-
-
-
-
-
-
- The following is an example of an iCalendar namespace declaration
- using the default namespace:
-
-
-
-
-
-
-
-
-
-6 Acknowledgments
-
- The following have participated in the drafting and discussion of
- this memo:
-
- Greg FitzPatrick, Charles Goldfarb, Paul Hoffman, Thomas Rowe, Doug
- Royer
-
-7 Security Considerations
-
- Security issues are not currently discussed in this memo.
-
-8 Bibliography
-
- [FPI] F. Dawson, "iCalendar Formal Public Identifier", Internet
- Draft, http://www.internic.net/internet-drafts/draft-calsch-icalfpi-
- 00.txt, September 1998.
-
- [ISO9070] "Information Technology_SGML Support Facilities_
- Registration Procedures for Public Text Owner Identifiers", ISO/IEC
- 9070, Second Edition, International Organization for Standardization,
- April, 1991.
-
- [RFC 2045] N. Freed, N. Borenstein, "Multipurpose Internet Mail
- Extensions (MIME) - Part One: Format of Internet Message Bodies", RFC
- 2045, November 1996.
-
- [RFC 2119] S. Bradner, "Key words for use in RFCs to Indicate
- Requirement Levels", RFC 2119, ftp://ftp.isi.edu/in-notes/
- rfc2119.txt, March 1997.
-
-
-Dawson 20 Expires June 1999
-
-
-Internet Draft iCalendar XML DTD December 4, 1998
-
-
- [NSPACE] T. Bray, D. Hollander, A. Layman, "Namespaces in XML", WD-
- xml-names-19980916, http://www.w3.org/TR/1998/WD-xml-names-19980916,
- Septebmer 1998.
-
- [RFC2445] F. Dawson and T. Howes, "Internet Calendaring and
- Scheduling Core Object Specification (iCalendar)", RFC 2445,
- ftp://ftp.isi.edu/in-notes/rfc2445.txt, November 1998.
-
- [XML] "Extensible Markup Language (XML)", Worldwid Web Consortium,
- http://www.w3.org/TR/PR-xml-971208, December 1997.
-
-9 Author's Address
-
- The following address information is provided in a vCard XML DTD
- electronic business card, format.
-
-
-
- Frank Dawson
- Dawson
- Frank
- Lotus Development Corporation
-
- 6544 Battleford Drive
- Raleigh
- NC
- 27613-3502
-
- +1-617-693-8728
- +1-919-676-9515
- Frank_Dawson@Lotus.com
- fdawson@earthlink.net
-
-
-
-10 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 implmentation 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.
-
-
-Dawson 21 Expires June 1999
-
-
-Internet Draft iCalendar XML DTD December 4, 1998
-
-
- 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 22 Expires June 1999
diff --git a/docs/draft-desruisseaux-caldav-sched-02.html b/docs/draft-desruisseaux-caldav-sched-02.html
deleted file mode 100644
index 8285f63d..00000000
--- a/docs/draft-desruisseaux-caldav-sched-02.html
+++ /dev/null
@@ -1,716 +0,0 @@
-
-
-
-
- Scheduling Extensions to CalDAV
Network Working Group
C. Daboo
Internet Draft
- <draft-desruisseaux-caldav-sched-02>
-
B. Desruisseaux
Intended status: Informational
Oracle
Expires: December 2006
L.M. Dusseault
OSAF
June 2006
Scheduling Extensions to CalDAV draft-desruisseaux-caldav-sched-02
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”.
This document specifies a set of methods, headers and resource types that define the scheduling extension to the CalDAV protocol. CalDAV itself extends WebDAV, which extends HTTP. The new protocol elements defined here allow interoperable scheduling operations on a CalDAV repository.
This document specifies a set of methods, headers, properties and privileges that define the CalDAV [I-D.dusseault-caldav] scheduling extensions to the WebDAV [I-D.ietf-webdav-rfc2518bis] protocol. This document also provides the transport specific information necessary to convey iCalendar [RFC2445] Transport-independent Interoperability Protocol iTIP [RFC2446] over WebDAV which enables transactions such as publish, schedule, reschedule, respond to scheduling requests, negotiation of changes or cancel iCalendar-based calendar components, as well as search for available busy time information.
Discussion of this Internet-Draft is taking place on the mailing list <http://lists.osafoundation.org/mailman/listinfo/ietf-caldav>.
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-20040204].
The namespace "urn:ietf:params:xml:ns:caldav" is reserved for the XML elements defined in this specification, or in other Standards Track IETF RFCs written to extend CalDAV. It MUST NOT be used for proprietary extensions.
Note that the XML declarations used in this document are incomplete, in that they do not include namespace information. Thus, the reader MUST NOT use these declarations as the only way to create valid CalDAV properties or to validate CalDAV XML element types. Some of the declarations refer to XML elements defined by WebDAV which use the "DAV:" namespace. Wherever such elements appear, they are explicitly given the "DAV:" prefix to help avoid confusion. Additionally, some of the elements used here are defined in CalDAV [I-D.dusseault-caldav].
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.
The augmented BNF used by this document to describe protocol elements is described in Section 2.1 of [RFC2616]. Because this augmented BNF uses the basic production rules provided in Section 2.2 of [RFC2616], those rules apply to this document as well.
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 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.
A message that describes a transaction such as publish, schedule, reschedule, respond to scheduling requests, negotiation of changes or cancel calendar components.
Free busy message:
A message that describes a transaction such as publish unsolicited busy time information, request busy time information, or respond to a busy time request.
If the server supports the calendar scheduling features described in this document it MUST include "calendar-schedule" as a field in the DAV response header from an OPTIONS request on any resource that supports any scheduling properties, privileges or methods.
In this example, the OPTIONS response indicates that the server supports both the calendar-access and calendar-schedule features and that /lisa/calendar/outbox/ can be specified as a Request-URI to the POST method.
The process of scheduling a meeting between different parties often involves a series of steps with different "actors" playing particular roles during the whole process. Typically there is a meeting "Organizer" whose role is to setup a meeting between one or more meeting "Attendees", and this is done by sending out invitations and handling responses from each Attendee.
This process can typically be broken down into two phases.
In the first phase the "Organizer" tries to determine a time for the meeting that ought to be the most acceptable to each Attendee. This involves finding out when each Attendee is available during the period of time in which the meeting needs to occur, and determining when the most appropriate time is for which each Attendee is free. This process is called a "free-busy" lookup.
In the second phase the "Organizer" sends out invitations to each Attendee using the time determined from the free-busy lookup - or a suitable guess as to an appropriate time based on other factors if free-busy lookup is not feasible. There then follows a process of negotiation between "Organizer" and "Attendees" regarding the invitation. Some Attendees may choose to attend at the original time provided by the Organizer, others may decline to attend at that time, but suggest another time, others may decline to attend at any time. The "Organizer" needs to process each of the replies from the Attendees and take appropriate action to confirm the meeting, reschedule it or perhaps cancel it depending on those replies.
The user "expectation" as to how a calendaring and scheduling system should respond in each of these two phases is somewhat different. In the case of a free-busy lookup, users expect to get back results immediately so that they can then move on to the invitation phase as quickly as possible. In the case of invitations, its expected that each Attendee will reply in his or her 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.
It is useful for each participant in a scheduling transaction to maintain their own "history" of invitations sent and received during the process and after to keep track of what was done, and to properly handle updates to invitations as they may change over time. This history is usually kept separate from the actual "booked" event, to-do, or daily journal entry, which would normally be placed in a user's calendar collection.
In addition, it is useful to keep outgoing invitations separate from incoming ones for organizational purposes.
Also, a calendar user may have multiple calendars representing different spheres of activity, but scheduling requests are targeted at calendar user addresses, and there is no formal way to have those indicate which sphere of activity they might apply to. By storing all incoming scheduling requests in a separate collection, clients can process the requests in that collection and choose what calendar the request belongs to and make its own arrangements to place the relevant calendar object in that calendar to "book" it.
This specification introduces two new collection resource types that are used for keeping incoming and outgoing scheduling messages separate from other calendar object resources. These can also be used to control who is able to send scheduling messages on behalf of a user, and who is allowed to send scheduling messages to other users by the use of new WebDAV ACL [RFC3744] privileges. Note that these collections only contains scheduling messages that pertains to the scheduling of events, to-dos and daily journal entries. Scheduling messages that describes requests for available busy time information, or replies to such request, are not contained in these collections.
The scheduling "Inbox" collection contains received scheduling messages. Scheduling messages are contained in calendar object resources. Each calendar object resource has a WebDAV property that indicates whether the scheduling message has already been processed or not so that multiple clients do not repeat the processing actions already done.
The scheduling "Outbox" collection contains scheduling message that have been sent, which need to be tracked both to help synchronize between multiple clients and to support delegation use cases. A single user with multiple clients can use this collection to synchronize the outbound request history. Two users coordinating scheduling with one calendar (e.g., a calendar user and her assistant) can see what scheduling messages the other user has sent. The calendar owner would then typically have permission to DELETE the scheduling messages but the assistant might not.
The iCalendar Transport-independent Interoperability Protocol (iTIP) [RFC2446] outlines a model for scheduling and free-busy message exchanges to perform scheduling transactions. This specification makes use of scheduling free-busy messages to handle scheduling transactions on the server by having such messages passed between different users on the server depending on their role in the scheduling process.
To that end each scheduling message is modeled as a calendar object resource which contains the iCalendar object that conforms to the iTIP requirements for the type of transaction being requested.
This specification defines the POST method, acting on an Organizer's scheduling Outbox, to trigger schedule processing by the server. This can take one of two forms: for free-busy messages the POST request returns immediately with free busy results; for scheduling messages, a copy of the scheduling message specified in the request body is deposited into each recipient's scheduling Inbox.
The server may support delivery of scheduling messages to other CalDAV servers, and the client may attempt to get the server to do this by specifying remote addresses for the recipients, but the server is not bound to support or complete remote delivery operations even if it advertises support for the "calendar-schedule" feature. Note that remote delivery mechanisms are not defined in this specification. This specification does not define a server-to-server or server-to-client protocol to deliver scheduling messages. Implementations may do this in a proprietary way, with iMIP [RFC2447], or with iTIP bindings as yet unspecified.
After the delivery is completed, CalDAV clients will see the scheduling message the next time they synchronize or query a scheduling Inbox collection. To reply to a scheduling REQUEST, the client uses the POST method to send another scheduling message (this time, a REPLY) back to the Organizer. If the user has decided to accept the REQUEST, the client can create a suitable calendar object resource in the appropriate calendar collection for the recipient. The step of putting the calendar object resource in the calendar is left up to the client, so that the client can make appropriate choices about where to put the calendar object resource, and with what alarms, etc. However, the server MAY be configured to automatically accept or reject invitations, and if the server auto-accepts invitations then the server is responsible for creating calendar object resources in a calendar collection specified by the user.
A scheduling Inbox collection contains incoming scheduling messages. These may be requests sent by an Organizer, or replies sent by an Attendee in response to a request.
A scheduling Inbox collection MUST report the DAV:collection and CALDAV:schedule-inbox XML elements in the value of the DAV:resourcetype property. The element type declaration for CALDAV:schedule-inbox is:
Every non-collection resource in the scheduling Inbox collection MUST be a valid calendar object resource that defines a scheduling message (e.g., an iCalendar object that follows the iTIP semantic). Note, that unlike calendar collections defined by the calendar-access feature, there are no restrictions on the nature of the resources stored (e.g., there is no need to verify that the UIDs in each resource are unique) beyond the restrictions of iTIP itself. The removal of the UID restriction, in particular, is needed because multiple scheduling messages may be sent for one particular calendar component, and each of those will have the same UID property in the calendar object resource.
A new access control privilege can be defined on the scheduling Inbox collection and can be used to control who is allowed to send scheduling messages to the owner of the scheduling Inbox. See Section 8.1 for more details.
A scheduling Outbox collection contains outgoing scheduling messages. These may be requests initiated by or on behalf of the owner of the scheduling Outbox, or responses to requests received by the owner of the scheduling Outbox.
A scheduling Outbox collection MUST report the DAV:collection and CALDAV:schedule-outbox XML elements in the value of the DAV:resourcetype property. The element type declaration for CALDAV:schedule-outbox is:
Every non-collection resource in the scheduling Outbox collection MUST be a valid calendar object resource that defines a scheduling message (e.g., an iCalendar object that follows the iTIP semantic). When a client targets the POST method at a scheduling Outbox, the server MUST create a copy of the scheduling message in that scheduling Outbox, unless the POST method corresponds to a free-busy message, in which case the server MUST NOT store a copy of the free-busy message. Copies that are created serve as a record of outgoing scheduling messages.
The server MAY auto-delete calendar object resources in the scheduling Outbox (e.g., after a period of time or to keep within a quota). The server SHOULD allow deletion of calendar object resources in the scheduling Outbox.
A new access control privilege can be defined on the scheduling Outbox collection and can be used to control who is allowed to send scheduling messages on behalf of the owner of the scheduling Outbox. See Section 8.1 for more details.
Identify the calendars that contribute to the free-busy information for the owner of the scheduling 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 [I-D.ietf-webdav-rfc2518bis]). Support for this property is REQUIRED.
Description:
This property is required to allow a POST request to automatically determine the free busy information for each specified Recipient for immediate return in the response. A server with a fixed set of calendars per user can make this property protected. A server that allows users to create their own calendars SHOULD allow users to change their own property value.
Indicates the Originator of the scheduling message contained in a scheduling Inbox or Outbox collection.
Conformance:
This property MUST be protected and SHOULD NOT be returned by a PROPFIND DAV:allprop request (as defined in Section 14.2 of [I-D.ietf-webdav-rfc2518bis]).
Description:
The CALDAV:originator property MUST be defined on calendar object resources stored in an Inbox or Outbox collection as the result of a POST request. The value of the property MUST be the value of the Originator request header in the POST request that caused the resource to be created in the collection.
Definition:
- <!ELEMENT originator (DAV:href)>
- DAV:href value: a CAL-ADDRESS (see Section 4.3.3 in [RFC 2445])
-
On a calendar object resource contained in a scheduling Outbox collection, this indicates the list of Recipients to whom the scheduling message was sent. On a calendar object resource in a scheduling Inbox collection, this indicates the recipient calendar user address that caused the scheduling message to be delivered into the scheduling Inbox.
Conformance:
This property MUST be protected and SHOULD NOT be returned by a PROPFIND DAV:allprop request (as defined in Section 14.2 of [I-D.ietf-webdav-rfc2518bis]).
Description:
The CALDAV:recipient property MUST be defined on calendar object resources stored in a scheduling Outbox or Inbox collection as the result of a POST request. For calendar object resources in a scheduling Outbox, the value of the property MUST be a list of calendar user addresses formed from all the addresses in any Recipient request headers in the POST request that caused the resource to be created in the collection. For calendar object resources in a scheduling Inbox, the value of the property MUST be the calendar user address from the Recipient request header in the POST request that caused the resource to be created in the collection. Typically this address will be one of those listed in the CALDAV:calendar-user-address-set (see Section 8.2.3) property for the principal that owns the scheduling Inbox. However, it could, for example, be a calendar user address of a group that includes the owner of the scheduling Inbox.
Definition:
-
- <!ELEMENT recipient (DAV:href+)>
- DAV:href value: a CAL-ADDRESS (see Section 4.3.3 in [RFC 2445])
-
-
Indicates the state of a scheduling message in a scheduling Inbox.
Conformance:
This property MAY be protected and SHOULD NOT be returned by a PROPFIND DAV:allprop request (as defined in Section 14.2 of [I-D.ietf-webdav-rfc2518bis]).
Description:
The CALDAV:schedule-state property MUST be defined on any calendar object resource in a scheduling Inbox collection. If present, the property indicates whether the scheduling message has been processed or not. Processing might have occurred as a result of some form of automatic processing by the server or through a client action. Clients MUST ensure that they set this property value to indicate a processed state when they have processed the scheduling message. This ensures that other clients with access to the same resource don't attempt to repeat the actions required to reply. Clients MUST NOT process a scheduling message that has this property indicates the scheduling message has been processed. When the scheduling message is delivered into the scheduling Inbox the server MUST set this property value to indicate that the scheduling message has not been processed.
The POST method submits a scheduling or free-busy message to one or more recipients by targeting the request at the URI of a scheduling Outbox collection. The request body of a POST method MUST contain a scheduling message or free-busy message (e.g., an iCalendar object that follows the iTIP semantic). The resource identified by the Request-URI MUST be a resource collection of type CALDAV:schedule-outbox (Section 5.2).
A submitted scheduling message will be delivered to the calendar user addresses specified in the Recipient request header. A submitted free-busy message will be immediately executed and a free-busy response returned.
Preconditions:
(CALDAV:supported-collection): The Request-URI MUST identify the location of a scheduling Outbox collection;
(CALDAV:supported-calendar-data): The resource submitted in the POST request MUST be a supported media type (i.e., text/calendar) for scheduling or free-busy messages;
(CALDAV:valid-calendar-data): The resource submitted in the POST request MUST be valid data for the media type being specified (i.e., valid iCalendar object);
(CALDAV:valid-scheduling-message): The resource submitted in the POST request MUST obey all restrictions specified for the POST request (e.g., scheduling message follows the restriction of iTIP);
(CALDAV:originator-specified): The POST request MUST include a valid Originator request header specifying a calendar user address of the currently authenticated user;
(CALDAV:originator-allowed): The calendar user identified by the Originator request header in the POST request MUST be granted the CALDAV:schedule privilege or a suitable sub-privilege on the scheduling Outbox collection being targeted by the request;
(CALDAV:organizer-allowed): The calendar user identified by the ORGANIZER property in the POST request's scheduling message MUST be the owner (or one of the owners) of the scheduling Outbox being targeted by the request;
(CALDAV:recipient-specified): The POST request MUST include one or more valid Recipient request headers specifying the calendar user address of users to whom the scheduling message will be delivered.
Every POST request MUST include an Originator request header that specifies the calendar user address of the originator of a given scheduling message. The value specified in this request header MUST be a calendar user address specified in the CALDAV:calendar-user-address-set property defined on the principal resource of the currently authenticated user. Also, the currently authenticated user MUST have the CALDAV:schedule privilege or a suitable sub-privilege granted on the targeted scheduling Outbox collection.
Typically the Originator request header's value will correspond to the Organizer of the calendar component and to the owner of the Outbox being targeted by the request. However, the Organizer may choose to allow another user to act on his behalf to send scheduling messages. To allow for this a new privilege has been defined to allow the owner of a scheduling Outbox to grant to other users the right to execute POST requests on that Outbox.
The value of the Originator request header is kept in the CALDAV:originator property on any resources saved as a result of the schedule request. This includes the copy of the scheduling message saved in the scheduling Outbox, and scheduling messages delivered to any scheduling Inbox.
iTIP requires that every scheduling message contains an ORGANIZER property identifying the calendar user address of the Organizer of the calendar object. To prevent 'spoofing' (forgeries) of scheduling messages, CalDAV servers MUST verify that the calendar user address identified by the ORGANIZER property in the scheduling message data corresponds to the principal owning the scheduling Outbox targeted by the POST request. This MUST be done during the processing of the POST request.
Every POST request MUST include one or more Recipient request headers in the headers. The value of this header is a list of one or more calendar user addresses and corresponds to the set of calendar users who will be delivered the scheduling message. The owner of the scheduling Outbox being targeted by the POST method MUST have the CALDAV:schedule privilege or a suitable sub-privilege granted on the scheduling Inbox collection of each recipient.
Typically the list of recipients would correspond to any ATTENDEE property values listed in the scheduling message data. However, there are cases when an ATTENDEE is not listed as a Recipient, or when a Recipient is not one of the ATTENDEE's.
For example, if the Organizer of an event wishes to attend the event themselves, they must list themselves as one of the ATTENDEE's, as the ORGANIZER of an event does not implicitly attend. However, the Organizer does not need to receive an invitation as they know their own participation status, so there is no need to be listed as a Recipient of the scheduling message.
Alternatively, a client may have determined participation status of some ATTENDEE's out-of-band and has no need to send another request via CalDAV.
In some cases it is handy to be able to send information about a meeting to someone who is not an ATTENDEE. In that case, there would be a Recipient in the request without a corresponding ATTENDEE property in the scheduling message data.
Note that the recipient of a CalDAV scheduling message has no knowledge of who the other recipients were - they only get to see the ATTENDEE information listed in the scheduling message data. So listing a calendar user as a Recipient and not an ATTENDEE is the equivalent of a 'Bcc' (blind-carbon-copy) operation in email.
A POST request may deliver a scheduling message to one or more calendar users specified in the Recipient request header. 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.
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 of the request for that recipient, any error codes and an optional description. See Section 10.1.
In the case of a free-busy request, the CALDAV:response elements can also contain CALDAV:calendar-data elements which contain free busy information (e.g., an iCalendar VFREEBUSY component) indicating the busy state of the corresponding recipient, assuming that the free-busy request for that recipient succeeded.
The following are examples of response codes one would expect to be used for this method. Note, however, that unless explicitly prohibited any 2/3/4/5xx series response code may be used in a response.
200 (OK) - The command succeeded.
400 (Bad Request) - The client has provided an invalid scheduling message.
403 (Forbidden) - The client, for reasons the server chooses not to specify, cannot submit a scheduling message to the specified Request-URI.
404 (Not Found) - The URL in the Request-URI, the Originator, or the Recipient request headers were not present.
423 (Locked) - The specified resource is locked and the client either is not a lock owner or the lock type requires a lock token to be submitted and the client did not submit it.
502 (Bad Gateway) - The Recipient request header contained a URL which the server considers to be in another domain, which it cannot forward scheduling messages to.
507 (Insufficient Storage) - The server did not have sufficient space to record the scheduling message in a recipient's scheduling inbox.
In this example, the client requests the server to deliver a meeting invitation (scheduling REQUEST) to the calendar users mailto:bernard@example.com and mailto:cyrus@example.com. The response indicates that delivery to the relevant scheduling Inboxes of each recipient was accomplished successfully.
Note that the Originator and Organizer calendar user addresses were both set to mailto:lisa@example.com. In order to indicate that she is also attending the meeting, mailto:lisa@example.com also included an ATTENDEE property in the iCalendar data corresponding to her calendar user address, however she did not include a Recipient request header for that calendar user address since she already has here own copy of the meeting stored in a calendar collection.
In this example, the client requests the server to determine the busy information of the calendar users mailto:bernard@example.com and mailto:cyrus@example.com, over the time range specified by the scheduling message sent in the request. The response includes VFREEBUSY components for each of those calendar users with their busy time indicated.
Incoming scheduling messages will be stored in a scheduling Inbox collection. The same reports work on scheduling collections, so the client can use REPORT to get partial information on scheduling messages in the scheduling inbox.
TODO: Need to explain here how to handle incoming scheduling messages. If the client wants to accept a message, it needs to create an event and mark the calendar object resource as "processed". If the client wants to reject it, it simply changes a property. Need to define that property. Also recommend locking the Inbox resource to avoid race conditions with other clients -- or use ETags to verify.
The Originator request header value is a URI which specifies the calendar user address of the originator of the scheduling message. Note that the absoluteURI production is defined in RFC2396 [RFC2396].
The Recipient request header value is a URI which specifies the calendar user address of the recipients to which the POST method should deliver the submitted scheduling message. Note that the absoluteURI production is defined in RFC2396 [RFC2396]
A CalDAV server MUST support the WebDAV ACLs standard [RFC3744]. That standard provides a framework for an extensible list of privileges on WebDAV collections and ordinary resources. A CalDAV server MUST also support the set of calendar-specific privileges defined in this section.
The CALDAV:schedule-request privilege controls who can initiate scheduling requests, and who will accept such requests.
The CALDAV:schedule-request privilege can be applied to either a scheduling Outbox or Inbox. Its effect depends on the type of collection it is applied to.
When used on a scheduling Outbox, the CALDAV:schedule-request privilege controls the use of the POST method to submit a scheduling message via a scheduling Outbox collection. When granted to a principal, that principal is allowed to use the POST method on the schedule Outbox with the following restrictions:
the iCalendar component in the request body MUST NOT be a VFREEBUSY component and the METHOD property MUST NOT be REQUEST.
the METHOD property in the iCalendar component in the request body MUST be either PUBLISH or REQUEST.
When used on a scheduling Inbox, the CALDAV:schedule-request privilege controls whether a scheduling message can be deposited in the scheduling Inbox collection. When granted to a principal, that principal is allowed to use the POST method to deposit scheduling messages with the following restrictions:
the iCalendar component in the request body MUST NOT be a VFREEBUSY component and the METHOD property MUST NOT be REQUEST.
the METHOD property in the iCalendar component in the request body MUST be either PUBLISH or REQUEST.
<!ELEMENT schedule-request EMPTY >
For example, the following ACE, on Bernard's scheduling Outbox, would only grant the privilege to Bernard to send schedule request messages on behalf of himself:
Whereas, the following ACE's, on Cyrus's scheduling Outbox, would grant the privilege to Cyrus and his assistant Kim to send schedule request messages on behalf of Cyrus:
The CALDAV:schedule-reply privilege controls who can respond to scheduling requests, and who will accept such responses.
The CALDAV:schedule-reply privilege can be applied to either a scheduling Outbox or Inbox. Its effect depends on the type of collection it is applied to.
When used on a scheduling Outbox, the CALDAV:schedule-reply privilege controls the use of the POST method to submit a scheduling message via a scheduling Outbox collection. When granted to a principal, that principal is allowed to use the POST method on the schedule Outbox with the following restrictions:
the iCalendar component in the request body MUST NOT be a VFREEBUSY component and the METHOD property MUST NOT be REQUEST.
the METHOD property in the iCalendar component in the request body MUST NOT be either PUBLISH or REQUEST.
When used on a scheduling Inbox, the CALDAV:schedule-reply privilege controls whether a scheduling message can be deposited in the scheduling Inbox collection. When granted to a principal, that principal is allowed to use the POST method to deposit scheduling messages with the following restrictions:
the iCalendar component in the request body MUST NOT be a VFREEBUSY component and the METHOD property MUST NOT be REQUEST.
the METHOD property in the iCalendar component in the request body MUST NOT be either PUBLISH or REQUEST.
<!ELEMENT schedule-reply EMPTY >
For example, the following ACE, on Bernard's scheduling Outbox, would only grant the privilege to Bernard to respond to schedule messages on behalf of himself:
Whereas, the following ACE's, on Cyrus's scheduling Outbox, would grant the privilege to Cyrus and his assistant Kim to respond to schedule messages on behalf of Cyrus:
The CALDAV:schedule-free-busy privilege controls who can initiate free-busy requests, and who will accept such requests.
The CALDAV:schedule-free-busy privilege can be applied to either a scheduling Outbox or Inbox. Its effect depends on the type of collection it is applied to.
When used on a scheduling Outbox, the CALDAV:schedule-reply privilege controls the use of the POST method to submit a scheduling message via a scheduling Outbox collection. When granted to a principal, that principal is allowed to use the POST method on the schedule Outbox with the following restrictions:
the iCalendar component in the request body MUST be a VFREEBUSY component.
the METHOD property in the iCalendar component in the request body MUST be REQUEST.
When used on a scheduling Inbox, the CALDAV:schedule-free-busy privilege controls whether a scheduling message can be deposited in the scheduling Inbox collection. When granted to a principal, that principal is allowed to use the POST method to deposit scheduling messages with the following restrictions:
the iCalendar component in the request body MUST be a VFREEBUSY component.
the METHOD property in the iCalendar component in the request body MUST be REQUEST.
<!ELEMENT schedule-free-busy EMPTY >
For example, the following ACE, on Bernard's scheduling Outbox, would only grant the privilege to Bernard to request free-busy information on behalf of himself:
Whereas, the following ACE's, on Cyrus's scheduling Outbox, would grant the privilege to Cyrus and his assistant Kim to free-busy information on behalf of Cyrus:
The CALDAV:schedule privilege can be applied to either a scheduling Outbox or Inbox. Its effect depends on the type of collection it is applied to. This privilege is actually an aggregate of the CALDAV:schedule-request, CALDAV:schedule-reply and CALDAV:schedule-free-busy privileges.
<!ELEMENT schedule EMPTY >
For example, the following ACE, on Bernard's scheduling Outbox, would only grant the privilege to Bernard to carry out any schedule operation on behalf of himself:
Whereas, the following ACE's, on Cyrus's scheduling Outbox, would grant the privilege to Cyrus and his assistant Kim to carry out any schedule operation on behalf of Cyrus:
8.1.5 Privilege aggregation and the DAV:supported-privilege-set property
The CALDAV:schedule privilege MUST be non-abstract, and MUST be aggregated under the DAV:bind privilege. The CALDAV:schedule privilege MUST appear in the DAV:supported-privilege-set property of scheduling Inbox and Outbox collections.
The CALDAV:schedule-request, CALDAV:schedule-reply and CALDAV:schedule-free-busy privileges MUST be non-abstract, and MUST be aggregated under the CALDAV:schedule privilege. These privileges MUST appear in the DAV:supported-privilege-set property of scheduling Inbox and Outbox collections.
This section defines new properties for WebDAV principal resources as defined in RFC3744 [RFC3744]. These properties are likely to be protected but the server MAY allow them to be written by appropriate users.
Identify the URL of the scheduling Inbox collection owned by the associated principal resource.
Conformance:
This property MAY be protected and SHOULD NOT be returned by a PROPFIND allprop request (as defined in Section 12.14.1 of [I-D.ietf-webdav-rfc2518bis]).
Description:
This property is needed for a client to determine where the scheduling Inbox of the current user is located so that processing of scheduling messages can occur.
Identify the URL of the scheduling Outbox collection owned by the associated principal resource.
Conformance:
This property MAY be protected and SHOULD NOT be returned by a PROPFIND allprop request (as defined in Section 12.14.1 of [I-D.ietf-webdav-rfc2518bis]).
Description:
This property is needed for a client to determine where the scheduling Outbox of the current user is located so that sending of scheduling messages can occur.
Identify the calendar addresses of the associated principal resource.
Conformance:
This property MAY be protected and SHOULD NOT be returned by a PROPFIND allprop request (as defined in Section 12.14.1 of [I-D.ietf-webdav-rfc2518bis] ). Support for this property is REQUIRED. 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.
Description:
This property is needed to map Originator and Recipient values in a POST request to principal resources and their associated scheduling Inbox and Outbox. In the event that a user has no well defined identifier for their calendar user address, the URI of their principal resource can be used.
8.2.4 Example: Searching for calendars belonging to a user based on a calendar user address
In this example, the client requests the CALDAV:calendar-home-URL of the principal resources whose CALDAV:calendar-user-address-set property contains the substring "mailto:bernard@example.com". In addition, the client requests the DAV:displayname of each principal to also be returned for the matching principals.
The response shows that only one principal resource meets the search specification, "mailto:bernard@example.com".
When the calendar-access feature is supported in addition to calendar-schedule, this specification extends the CALDAV:calendar-query and CALDAV:calendar-multiget reports to return results for calendar object resources in scheduling Inbox and Outbox collections when the report directly targets such a collection. i.e. the Request-URI for a REPORT MUST be the URI of the scheduling Inbox or Outbox or of a child resource within a scheduling Inbox or Outbox collection. A report run on a regular collection that includes a scheduling Inbox or Outbox as a child resource at any depth MUST NOT examine or return any calendar object resources from within any scheduling Inbox or Outbox collections.
Note that the CALDAV:free-busy-query report is NOT supported on scheduling Inbox or Outbox collections when the calendar-access feature is also present.
The process of scheduling involves the sending and receiving of scheduling messages. As a result, the security problems related to messaging in general are relevant here. In particular the authenticity of the scheduling messages needs to be verified absolutely. Servers and clients MUST use an HTTP connection protected with TLS as defined in [RFC2818] for all scheduling transactions.
When handling a POST request on a scheduling Outbox:
Servers MUST verify that the principal associated with the calendar user address specified in the Originator request header in the request matches the currently authenticated user.
Servers MUST verify that the currently authenticated user has the CALDAV:schedule privilege or a suitable sub-privilege on the scheduling Outbox targeted by the request.
Servers MUST verify that the principal associated with the calendar user address specified in the ORGANIZER property of the scheduling message data in the request contains a CALDAV:schedule-outbox-URL property value that matches the scheduling Outbox targeted by the request.
Servers MUST verify that the principal associated with the calendar user address specified in the ORGANIZER property of the scheduling message data in the request has the CALDAV:schedule privilege or a suitable sub-privilege on all of the scheduling Inbox collections for the principals associated with all of the calendar user addresses specified in any Recipient request headers in the request.
The CALDAV:calendar-free-busy-set property on principal resources SHOULD only be accessible when that principal is authenticated (i.e., the property SHOULD be hidden from other principals).
The authors would like to thank the following individuals for contributing their ideas and support for writing this specification: Julian F. Reschke and Jim Whitehead.
The authors would also like to thank the Calendaring and Scheduling Consortium for advice with this specification, and for organizing interoperability testing events to help refine it.
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 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.
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@ietf.org.
Acknowledgement
Funding for the RFC Editor function is provided by the IETF Administrative Support Activity (IASA).
\ No newline at end of file
diff --git a/docs/draft-ietf-calsch-many-xcal-02.txt b/docs/draft-ietf-calsch-many-xcal-02.txt
deleted file mode 100644
index 9f7acd3e..00000000
--- a/docs/draft-ietf-calsch-many-xcal-02.txt
+++ /dev/null
@@ -1,2971 +0,0 @@
-From: http://www.ietf.org/internet-drafts/draft-ietf-calsch-many-xcal-01.txt
-Title: iCalendar DTD Document (xCal)
-Reference: draft-ietf-calsch-many-xcal-02
-
-------------------------------------------------------------------------
-
-Network Working Group F. Dawson
-Internet-Draft Nokia
-Expires: January 23, 2003 S. Reddy
- Oracle
- D. Royer
- INET-Consulting
- E. Plamondon
- Oracle
- July 25, 2002
-
-
- iCalendar DTD Document (xCal)
- draft-ietf-calsch-many-xcal-02
-
-Status of this Memo
-
- This document is an Internet-Draft and is in full conformance with
- all provisions of Section 10 of RFC2026.
-
- 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 January 23, 2003.
-
-Copyright Notice
-
- Copyright (C) The Internet Society (2002). All Rights Reserved.
-
-Abstract
-
- This memo defines a [XML] Document Type Definition (DTD) that
- corresponds to the iCalendar, Internet Calendaring and Scheduling
- Core Object Specification defined by [RFC 2445]. This DTD provides
- equivalent functionality to the standard format defined by [RFC
- 2445]. Documents structured in accordance with this DTD may also be
- known as "XML iCalendar" documents or "xCal".
-
-
-
-Dawson, Reddy, Royer, Plamondon Expires January 23, 2003 [Page 1]
-
-Internet-Draft iCalendar DTD Document (xCal) July 2002
-
-
- The mailing list for discussion of this memo is "ietf-
- calendar@imc.org". Send an email to "ietf-calendar-request@imc.org"
- with the message "SUBSCRIBE" to add your email address to this
- mailing list. Send an email to "ietf-calendar-request@imc.org" with
- the message "UNSUBSCRIBE" to remove your email address from this
- mailing list.
-
- 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].
-
-Table of Contents
-
- 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 4
- 2. Using XML For Representating iCalendar . . . . . . . . . . . 6
- 2.1 XML Dependencies . . . . . . . . . . . . . . . . . . . . . . 6
- 2.2 Document Type Definition . . . . . . . . . . . . . . . . . . 6
- 2.3 Working With Standard and XML iCalendar Representations . . 6
- 2.3.1 Conversion . . . . . . . . . . . . . . . . . . . . . . . . . 6
- 2.3.2 Mixed Use of Both Representations . . . . . . . . . . . . . 7
- 2.4 Using Data Types . . . . . . . . . . . . . . . . . . . . . . 7
- 2.5 Including Binary Content . . . . . . . . . . . . . . . . . . 8
- 2.6 Including Multiple iCalendar Objects . . . . . . . . . . . . 9
- 2.7 Mapping Property Parameters to XML . . . . . . . . . . . . . 10
- 2.8 Mapping Calendar Properties to XML . . . . . . . . . . . . . 11
- 2.9 Mapping Component Properties to XML . . . . . . . . . . . . 13
- 2.10 Parameter Entities . . . . . . . . . . . . . . . . . . . . . 16
- 2.11 Namespace . . . . . . . . . . . . . . . . . . . . . . . . . 17
- 2.12 Emailing the iCalendar XML Representation . . . . . . . . . 17
- 2.13 iCalendar XML Representation and File Systems . . . . . . . 18
- 3. Example Usage . . . . . . . . . . . . . . . . . . . . . . . 20
- 3.1 A well-formed and valid iCalendar XML document . . . . . . . 20
- 3.2 Adding non-standard, experimental extensions . . . . . . . . 20
- 3.3 Including binary content in attachments . . . . . . . . . . 21
- 3.4 iCalendar XML document with multiple iCalendar objects . . . 23
- 3.5 Using the iCalendar namespace . . . . . . . . . . . . . . . 24
- 3.6 Publish meeting information . . . . . . . . . . . . . . . . 25
- 3.7 Publish transparent annual event . . . . . . . . . . . . . . 25
- 3.8 Meeting invitation . . . . . . . . . . . . . . . . . . . . . 26
- 3.9 Assign a to-do . . . . . . . . . . . . . . . . . . . . . . . 27
- 3.10 Publish a journal entry . . . . . . . . . . . . . . . . . . 28
- 3.11 Publish busy time . . . . . . . . . . . . . . . . . . . . . 29
- 3.12 Request busy time . . . . . . . . . . . . . . . . . . . . . 29
- 3.13 Response to a busy time request . . . . . . . . . . . . . . 30
- 3.14 Published event that references time zone information . . . 30
- 3.15 An event with an alarm . . . . . . . . . . . . . . . . . . . 31
- 4. iCalendar XML Document Type Definition . . . . . . . . . . . 34
- 5. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . 48
-
-
-
-Dawson, Reddy, Royer, Plamondon Expires January 23, 2003 [Page 2]
-
-Internet-Draft iCalendar DTD Document (xCal) July 2002
-
-
- 6. IANA Considerations . . . . . . . . . . . . . . . . . . . . 49
- 7. Security Considerations . . . . . . . . . . . . . . . . . . 50
- 8. Bibliography . . . . . . . . . . . . . . . . . . . . . . . . 51
- Authors' Addresses . . . . . . . . . . . . . . . . . . . . . 51
- Full Copyright Statement . . . . . . . . . . . . . . . . . . 53
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Dawson, Reddy, Royer, Plamondon Expires January 23, 2003 [Page 3]
-
-Internet-Draft iCalendar DTD Document (xCal) July 2002
-
-
-1. Introduction
-
- The Extended Markup Language (XML) as defined in [XML] is gaining
- widespread attention as a "web friendly" syntax for representing and
- exchanging documents and data on the Internet. This interest
- includes requests for and discussion of possible document type
- definitions (DTD) and name-space for IETF standard formats such as
- that defined by [RFC 2445].
-
- This memo defines how XML can be used to represent iCalendar objects.
- This memo includes the definition of the XML DTD for a XML document
- representation of an iCalendar object.
-
- NOTE: The [RFC 2445] is the definitive reference for the definition
- of iCalendar semantics. This memo only provides an alternative, XML
- representation for the standard syntax defined in [RFC 2445]. This
- memo does not introduce any semantics not already defined by [RFC
- 2445].
-
- An attempt has been made to leverage the standard features of the XML
- syntax in order to represent the component iCalendar semantics. For
- example, strong data typing is specified using the XML notation
- declaration. The element type attributes are used to represent many
- of the calendar properties that provide a "global attribute"
- capability in an iCalendar object. Binary content in the ATTACH
- component property may either be specified through an external entity
- reference to a non-XML binary content or may be included in the XML
- document's content information, after first being encoding using the
- BASE64 scheme of [RFC 2146]. Parameter entities are used to
- logically group content particles in the XML DTD in order to
- facilitate reading and comprehension of the structure specified by
- the iCalendar XML DTD.
-
- The publication of XML version 1.0 was followed by the publication of
- a World-wide Web Consortium (W3C) recommendation on "Namespaces in
- XML". A XML name-space is a collection of names, identified by a
- URI. In anticipation of the broader use of XML namespaces, this memo
- includes the definition of the URI to be used to identify the
- namespace associated with the iCalendar DTD element types in other
- XML documents. XML applications that conform to this memo and also
- use namespaces MUST NOT include other non-iCalendar namespaces in an
- iCalendar XML document.
-
- It is expected that the DTD defined in this memo will not normally be
- included with iCalendar XML documents that are distributed. Instead,
- the DTD will be referenced in the document type declaration in the
- document entity. Such iCalendar XML documents will be well-formed
- and valid, as defined in [XML]. In addition, other iCalendar XML
-
-
-
-Dawson, Reddy, Royer, Plamondon Expires January 23, 2003 [Page 4]
-
-Internet-Draft iCalendar DTD Document (xCal) July 2002
-
-
- documents will be specified that do not include the XML prolog. Such
- iCalendar XML documents will be well-formed but not valid.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Dawson, Reddy, Royer, Plamondon Expires January 23, 2003 [Page 5]
-
-Internet-Draft iCalendar DTD Document (xCal) July 2002
-
-
-2. Using XML For Representating iCalendar
-
- XML is a simplified version of the text markup syntax defined by ISO
- 8879, Standard Generalized Markup Language (SGML). XML was published
- as a proposed recommendation [XML] by the World-wide Web Consortium
- (W3C) on February 10, 1998.
-
-2.1 XML Dependencies
-
- This memo specifies the XML representation for the standard iCalendar
- format defined by [RFC 2445]. There are no XML dependencies other
- than the [XML] and the [XMLNS] recommendations.
-
-2.2 Document Type Definition
-
- A XML DTD for iCalendar is defined by the DTD specified in section 3.
-
- The formal public identifier (FPI) for the DTD is:
-
- -//IETF//DTD XCAL//iCalendar XML//EN
-
- NOTE: The "DTD XCAL" text in the FPI value will be replaced with the
- text "RFC xxxx", where "xxxx" is the RFC number, when the memo is
- published as a RFC.
-
- This FPI MUST be used on the DOCTYPE statement within a XML document
- referencing the DTD defined by this memo.
-
- This FPI SHOULD also be used to identify iCalendar XML documents
- within operating system registries of file, clipboard and interactive
- rendering (e.g., memory clipboard or drag/drop) formats.
-
-2.3 Working With Standard and XML iCalendar Representations
-
- This memo defines an alternative, XML representation for the standard
- iCalendar format defined in [RFC 2445]. This alternative
- representation provides the same semantics as that defined in the
- standard format.
-
-2.3.1 Conversion
-
- The standard format can be converted to and from this XML format
- without loss of any calendaring information. When the XML
- representation was defined, every attempt was made to use existing
- component, property and parameter naming conventions. This greatly
- facilitates transformations between the two representations.
-
-
-
-
-
-Dawson, Reddy, Royer, Plamondon Expires January 23, 2003 [Page 6]
-
-Internet-Draft iCalendar DTD Document (xCal) July 2002
-
-
-2.3.2 Mixed Use of Both Representations
-
- As previously indicated, conversion between the standard and XML
- representations of iCalendar is a straightforward process. In
- addition, mixed use of both representations is also possible.
-
- With the use of the MIME multipart content-types, compound MIME
- entities containing a mix of the standard and XML representations can
- be specified. This capability is useful in applications where both
- representations might be encountered. In addition, this capability
- demonstrates the isomeric nature of the two representations. XML
- applications conforming to this specification MUST be able to
- properly parse and process a MIME multipart entity containing the
- MIME type associated with this iCalendar XML document type.
-
- Internet applications conforming to this memo MUST only send the
- iCalendar XML document in a "multipart/alternative" MIME entity that
- also contains an equivalent iCalendar object in the standard format
- defined by [RFC2445]. This restriction will guarantee that the
- iCalendar object can also be processed by Internet applications that
- only support the standard iCalendar representation.
-
-2.4 Using Data Types
-
- Strong "data typing" is an integral design principle to the iCalendar
- format. Strong data typing in iCalendar means that the format type
- for each property value is well known. Within [RFC 2445], the data
- type is called the "value type". The standard format defined by [RFC
- 2445] specifies a default value type for each calendar and component
- property. In addition, many of the property definitions allow for
- the specification of alternate value types. This XML representation
- continues this design principle.
-
- Explicit value/data typing in the XML representation is specified
- with the "value" attribute on each element type. In addition, the
- XML DTD specifies a default value/data type for each element type.
- XML documents conforming to this memo need only specify the "value"
- attribute on element types when the value needs to override the
- default value/data type. The standard value types defined in
- [RFC2445] are specified in the XML DTD by individual NOTATION
- declarations. The formal public identifier for standard value types
- all have the common string format of:
-
- -//IETF//NOTATION XCAL/Value Type/xxx//EN
-
- NOTE: The "XCAL" text in the FPI value will be replaced with the text
- "RFC xxxx", where "xxxx" is the RFC number, when the memo is
- published as a RFC.
-
-
-
-Dawson, Reddy, Royer, Plamondon Expires January 23, 2003 [Page 7]
-
-Internet-Draft iCalendar DTD Document (xCal) July 2002
-
-
- Where "xxx" is replaced with the text specified in the table below.
-
- The following table specifies the XML value/data type that
- corresponds to each of the standard value types defined in [RFC
- 2445].
-
- +--------------+------------+-------------------------+
- | RFC 2445 | XML Value | Notation FPI Text |
- | Value Type | Type | |
- +--------------+------------+-------------------------+
- | BINARY | BINARY | Binary |
- | BOOLEAN | BOOLEAN | Boolean |
- | CALADR | CALADR | Calendar User Address |
- | DATE | DATE | Date |
- | DATE-TIME | DATE-TIME | Date-Time |
- | DURATION | DURATION | Duration |
- | FLOAT | FLOAT | Float |
- | INTEGER | INTEGER | Integer |
- | PERIOD | PERIOD | Period of Time |
- | RECUR | RECUR | Recurrence Rule |
- | TEXT | TEXT | Text |
- | TIME | TIME | Time |
- | URI | URI | URI |
- | UTC-OFFSET | UTC-OFFSET | UTC-Offset |
- | Non-standard | X-NAME | X-Name |
- +--------------+------------+-------------------------+
-
- Other standard XML data types can be specified by including a
- NOTATION declaration that specifies the formal public identifier
- associated with the other standard format. In addition, the name of
- the format specified in the NOTATION declaration is specified in the
- "value" attribute of any element type that caste to the other
- standard format.
-
-2.5 Including Binary Content
-
- Binary content can be included in an iCalendar object with the
- "ATTACH" component property. In the standard iCalendar format this
- content may either be specified through an external entity reference,
- using a URI value type, or maybe specified within the iCalendar
- object, after first BASE64 encoding the content.
-
- The XML representation for iCalendar also supports including binary
- content in an iCalendar object with the "attach" element type. It
- also supports either an external reference to the non-XML binary
- content or inclusion of the binary content after first encoding the
- binary information using the BASE64 encoding of [RFC 2045].
-
-
-
-
-Dawson, Reddy, Royer, Plamondon Expires January 23, 2003 [Page 8]
-
-Internet-Draft iCalendar DTD Document (xCal) July 2002
-
-
- Any iCalendar properties defined in [RFC 2445] that can be used to
- include binary content are defined in the XML representation as an
- element type with a content model that consists of either the
- "extref" or the "b64bin" element type. The "extref" element type is
- used to reference an external entity containing the binary content.
- An external reference to the binary content is specified by the "uri"
- attribute on the "extref" element type. For every external
- reference, an ENTITY declaration and a corresponding NOTATION
- declaration MUST also be specified in an internal DTD to identify the
- location and format of the external entity. For example, the
- following XML snippets would be needed to include a reference to the
- executable "foo.exe" in the "attach" element type; which corresponds
- to the "ATTACH" iCalendar component property:
-
-
-
-
-
-
-
-
-
-
- The "b64bin" element type is used to include the binary content
- within the XML document, after first character encoding the binary
- information using the BASE64 encoding method of [RFC 2045]. For
- example, the following XML snippets would be needed to include the
- executable "foo.exe" in the "attach" element type; after first BASE64
- encoding the binary information:
-
-
-
- MIICajCC
- AdOgAwIBAgICBEUwDQEEBQAwdzELMAkGA1UEBhMCVVMxLDAqBgNVBAoTI05l
- dHNjYXBlIENvbW11bmljYXR5z...and so on...IENvcnBvc==
-
-
-
-2.6 Including Multiple iCalendar Objects
-
- The iCalendar format has the capability for including multiple,
- individual iCalendar objects in a single data stream. The XML
- representation can support this also. Individual iCalendar objects
- are specified by the "vcalendar" element type. One or more
- "vcalendar" element types are permitted within the parent element
- type, called "iCalendar". For example:
-
-
-
-
-
-Dawson, Reddy, Royer, Plamondon Expires January 23, 2003 [Page 9]
-
-Internet-Draft iCalendar DTD Document (xCal) July 2002
-
-
-
-
-
-
-
-
-
-
-
-
-
-2.7 Mapping Property Parameters to XML
-
- The property parameters defined in the standard iCalendar format are
- represented in the XML representation as an attribute on element
- types. The following table specifies the attribute name
- corresponding to each property parameter.
-
- +----------------+----------------+-----------+-----------------+
- | Property | Attribute | Attribute | Default |
- | Parameter Name | Name | Type | Value |
- +----------------+----------------+-----------+-----------------+
- | ALTREP | altrep | ENTITY | IMPLIED |
- | CN | cn | CDATA | Null String |
- | CUTYPE | cutype | NMTOKEN | INDIVIDUAL |
- | DELEGATED-FROM | delegated-from | CDATA | IMPLIED |
- | DELEGATED-TO | delegated-to | CDATA | IMPLIED |
- | DIR | dir | ENTITY | IMPLIED |
- | ENCODING | Not Used | n/a | n/a |
- | FMTTYPE | fmttype | CDATA | REQUIRED |
- | FBTYPE | fbtype | NMTOKEN | BUSY |
- | LANGUAGE | language | CDATA | IMPLIED |
- | MEMBER | member | CDATA | IMPLIED |
- | PARTSTAT | partstat | NMTOKEN | NEEDS-ACTION |
- | RANGE | range | NMTOKEN | THISONLY |
- | RELATED | related | NMTOKEN | START |
- | RELTYPE | reltype | NMTOKEN | PARENT |
- | ROLE | role | NMTOKEN | REQ-PARTICIPANT |
- | RSVP | rsvp | NMTOKEN | FALSE |
- | SENT-BY | sent-by | CDATA | IMPLIED |
- | TZID | tzid | CDATA | IMPLIED |
- | VALUE | value | NOTATION | See elements |
- +----------------+----------------+-----------+-----------------+
-
- The inline "ENCODING" property parameter is not needed in the XML
- representation. Inline binary information is always included as
- parsable character data, after first being encoded using the BASE64
- encoding of [RFC 2045].
-
-
-
-Dawson, Reddy, Royer, Plamondon Expires January 23, 2003 [Page 10]
-
-Internet-Draft iCalendar DTD Document (xCal) July 2002
-
-
- The "RANGE" property parameter defined by [RFC 2445] does not include
- the "THISONLY" enumeration. This is the implicit default, if the
- parameter is not specified on the "RECURRENCE-ID" property. However,
- the value is needed in the XML representation because all attributes
- need to explicitly specify a default value in the attribute's
- declaration in the DTD. This enumeration has been added to the XML
- representation.
-
- A non-standard, experimental parameter can be added to the XML
- representation by declaring it in an ATTLIST declaration and
- assigning it a XML attribute type and corresponding default value.
-
-2.8 Mapping Calendar Properties to XML
-
- Calendar properties defined in the standard iCalendar format provide
- information about an iCalendar object, as a whole. The calendar
- properties are represented in the XML representation as an attribute
- on the "iCalendar" and the "vcalendar" element type. The following
- table specifies the attribute name permitted on the "iCalendar"
- element type.
-
- +---------------+-----------+-----------+-----------------+
- | Calendar | Attribute | Attribute | Default |
- | Property Name | Name | Type | Value |
- +---------------+-----------+-----------+-----------------+
- | CALSCALE | calscale | CDATA | IMPLIED |
- | METHOD | method | NMTOKEN | PUBLISH |
- | VERSION | version | CDATA | REQUIRED |
- | PRODID | prodid | CDATA | IMPLIED |
- +---------------+-----------+-----------+-----------------+
-
- In addition to these attributes, the "vcalendar" element type can
- also have the following attributes:
-
- +-----------+-----------+---------+----------------------------+
- | Attribute | Attribute | Default | Description |
- | Name | Type | Value | |
- +-----------+-----------+---------+----------------------------+
- | xmlns | CDATA | FIXED | Used to specify the default|
- | | | | iCalendar XML name space. |
- | xmlns: + | CDATA | FIXED | Used to specify the |
- | | | | |
- +-----------+-----------+---------+----------------------------+
-
- The semantics of the "xmlns" attribute, and any attribute with
- "xmlns:" as a prefix, is as specified in [XMLNS]. It is used to
- declare a namespace in XML. It can be used to declare the iCalendar
-
-
-
-Dawson, Reddy, Royer, Plamondon Expires January 23, 2003 [Page 11]
-
-Internet-Draft iCalendar DTD Document (xCal) July 2002
-
-
- XML namespace in a XML document with a document type other than the
- iCalendar XML document type. The iCalendar XML document type MUST
- only use element types from the iCalendar namespace. Non-standard,
- experimental element types and attributes lists MUST only be
- specified by declarations in an internal DTD within the iCalendar XML
- document. To specify the iCalendar namespace, the attribute value
- for the "xmlns" and any attribute with the prefix "xmlns:" MUST be:
-
- 'http://www.ietf.org/internet-drafts/draft-ietf-calsch-many-xcal-01.txt'
-
- NOTE: This attribute value will be replaced with the URL "http://
- www.ietf.org/rfc/rfcxxxx.txt", where "xxxx" is the RFC number, when
- this memo is published as a RFC.
-
- For example:
-
-
-
-
-
- The following table specifies the attribute name corresponding to
- each calendar property. These attributes are only permitted on the
- "vcalendar" element type.
-
- +---------------+-----------+-----------+-----------------+
- | Calendar | Attribute | Attribute | Default |
- | Property Name | Name | Type | Value |
- +---------------+-----------+-----------+-----------------+
- | CALSCALE | calscale | CDATA | IMPLIED |
- | METHOD | method | NMTOKEN | PUBLISH |
- | VERSION | version | CDATA | REQUIRED |
- | PRODID | prodid | CDATA | IMPLIED |
- +---------------+-----------+-----------+-----------------+
-
- The semantics for these attributes is as specified for the
- corresponding calendar property in [RFC 2445].
-
- The following table specifies additional attributes that are
- permitted on the "vcalendar" element type.
-
-
-
-
-
-
-
-
-
-Dawson, Reddy, Royer, Plamondon Expires January 23, 2003 [Page 12]
-
-Internet-Draft iCalendar DTD Document (xCal) July 2002
-
-
- +-----------+-----------+---------+----------------------------+
- | Attribute | Attribute | Default | Description |
- | Name | Type | Value | |
- +-----------+-----------+---------+----------------------------+
- | language | CDATA | IMPLIED | Used to specify the default|
- +-----------+-----------+---------+----------------------------+
-
- The "language" attribute permits the default language to be specified
- for the whole iCalendar object. If the "language" attribute is
- specified on the XML document, then if the XML representation is
- converted into the standard format the "LANGUAGE" property parameter
- MUST be specified on each TEXT valued property to prevent information
- loss; when translating into the standard format.
-
-2.9 Mapping Component Properties to XML
-
- Component properties in the standard iCalendar format provide
- calendar information about the calendar component. The component
- properties defined in the standard iCalendar format are represented
- in the XML representation as element types. The following tables
- specify the element types corresponding to each of the properties in
- the specified property category.
-
- Descriptive Component Properties
- +----------------+-------------+-----------------------------+
- | Component | Element | Element Content Model |
- | Property Name | Name | |
- +----------------+-------------+-----------------------------+
- | ATTACH | attach | extref or b64bin |
- | | extref | EMPTY |
- | | b64bin | PCDATA |
- | CATEGORIES | categories | Any number of item elements |
- | | item | PCDATA |
- | CLASS | class | PCDATA |
- | COMMENT | comment | PCDATA |
- | DESCRIPTION | description | PCDATA |
- | GEO | geo | lat followed by lon element |
- | | lat | PCDATA |
- | | lon | PCDATA |
- | LOCATION | location | PCDATA |
- | PERCENT | percent | PCDATA |
- | PRIORITY | priority | PCDATA |
- | RESOURCES | resources | Any number of item elements |
- | STATUS | status | PCDATA |
- | SUMMARY | summary | PCDATA |
- +----------------+-------------+-----------------------------+
-
-
-
-
-
-Dawson, Reddy, Royer, Plamondon Expires January 23, 2003 [Page 13]
-
-Internet-Draft iCalendar DTD Document (xCal) July 2002
-
-
- Date and Time Component Properties
- +----------------+------------+-----------------------------+
- | Component | Element | Element Content Model |
- | Property Name | Name | |
- +----------------+------------+-----------------------------+
- | COMPLETED | completed | PCDATA |
- | DTEND | dtend | PCDATA |
- | DUE | due | PCDATA |
- | DTSTART | dtstart | PCDATA |
- | DURATION | duration | PCDATA |
- | FREEBUSY | freebusy | PCDATA |
- | TRANSP | transp | PCDATA |
- +----------------+------------+-----------------------------+
-
-
- Time Zone Component Properties
- +----------------+-------------+-----------------------------+
- | Component | Element | Element Content Model |
- | Property Name | Name | |
- +----------------+-------------+-----------------------------+
- | TZID | tzid | PCDATA |
- | TZNAME | tzname | PCDATA |
- | TZOFFSETFROM | tzoffsetfrom| PCDATA |
- | TZOFFSETTO | tzoffsetto | PCDATA |
- | TZURL | tzurl | EMPTY |
- +----------------+-------------+-----------------------------+
-
-
- Relationship Component Properties
- +----------------+---------------+--------------------------+
- | Component | Element | Element Content Model |
- | Property Name | Name | |
- +----------------+---------------+--------------------------+
- | ATTENDEE | attendee | PCDATA |
- | CONTACT | contact | PCDATA |
- | ORGANIZER | organizer | PCDATA |
- | RECURRENCE-ID | recurrence-id | PCDATA |
- | RELATED-TO | related-to | PCDATA |
- | URL | url | EMPTY |
- | UID | uid | PCDATA |
- +----------------+---------------+--------------------------+
-
-
- Recurrence Component Properties
- +----------------+------------+-----------------------------+
- | Component | Element | Element Content Model |
- | Property Name | Name | |
- +----------------+------------+-----------------------------+
-
-
-
-Dawson, Reddy, Royer, Plamondon Expires January 23, 2003 [Page 14]
-
-Internet-Draft iCalendar DTD Document (xCal) July 2002
-
-
- | EXDATE | exdate | PCDATA |
- | EXRULE | exrule | PCDATA |
- | RDATE | rdate | PCDATA |
- | RRULE | rrule | PCDATA |
- +----------------+------------+-----------------------------+
-
-
- Alarm Component Properties
- +----------------+------------+-----------------------------+
- | Component | Element | Element Content Model |
- | Property Name | Name | |
- +----------------+------------+-----------------------------+
- | ACTION | action | PCDATA |
- | REPEAT | repeat | PCDATA |
- | TRIGGER | trigger | PCDATA |
- +----------------+------------+-----------------------------+
-
-
- Change Management Component Properties
- +----------------+---------------+--------------------------+
- | Component | Element | Element Content Model |
- | Property Name | Name | |
- +----------------+---------------+--------------------------+
- | CREATED | created | PCDATA |
- | DTSTAMP | dtstamp | PCDATA |
- | LAST-MODIFIED | last-modified | PCDATA |
- | SEQUENCE | sequence | PCDATA |
- +----------------+---------------+--------------------------+
-
-
- Miscellaneous Component Properties
- +----------------+----------------+-------------------------+
- | Component | Element | Element Content Model |
- | Property Name | Name | |
- +----------------+----------------+-------------------------+
- | REQUEST-STATUS | request-status | PCDATA |
- +----------------+----------------+-------------------------+
-
- The following table specifies the element types that represent each
- of the calendar components.
-
-
-
-
-
-
-
-
-
-
-
-Dawson, Reddy, Royer, Plamondon Expires January 23, 2003 [Page 15]
-
-Internet-Draft iCalendar DTD Document (xCal) July 2002
-
-
- Component Structuring Properties
- +----------------+------------+-------------------------------+
- | Component | Element | Element Content Model |
- | Property Name | Name | |
- +----------------+------------+-------------------------------+
- | Multiple iCal- | iCalendar | One or more iCal elements |
- | endar objects | | |
- | VCALENDAR | vcalendar | calcomp parameter entity |
- | VEVENT | vevent | vevent.opt1 and vevent.optm |
- | | | parameter entity and valarm |
- | | | element |
- | VTODO | vtodo | vtodo.opt1 and vtodo.optm |
- | | | parameter entity and valarm |
- | | | element |
- | VJOURNAL | vjournal | vjournal.opt1 and |
- | | | vjournal.optm parameter |
- | | | entity |
- | VFREEBUSY | vfreebusy | vfreebusy.opt1 and |
- | | | vfreebusy.optm parameter |
- | | | entity |
- | VTIMEZONE | vtimezone | vtimezone.man, |
- | | | vtimezone.opt1, |
- | | | vtimezone.mann parameter |
- | | | entity |
- | STANDARD | standard | standard.man or standard.optm |
- | | | entity |
- | DAYLIGHT | daylight | daylight.man or daylight.optm |
- | | | entity |
- | VALARM | valarm | valarm.audio, valarm.display, |
- | | | valarm.email and |
- | | | valarm.procedure entity |
- +----------------+------------+-------------------------------+
-
- The [RFC 2445] specification specifies that the equivalent component
- properties to the "comment", "description", "location", "summary" and
- "contact" element types can contain formatted content, such as is
- specified by multiple lines of text. In such cases, the formatted
- text should be specified in as CDATA Section content. The CDATA
- section specifies arbitrary character data that is not meant to be
- interpretted. It is not scanned for markup by the XML parser. The
- CDATA Section in these element types MUST NOT contain markup or other
- such alternate representation of the property value. The "altrep"
- attribute is used to reference any such alternate representation for
- the textual content of these element types.
-
-2.10 Parameter Entities
-
- The external, iCalendar XML DTD specified in section 3 makes use of
-
-
-
-Dawson, Reddy, Royer, Plamondon Expires January 23, 2003 [Page 16]
-
-Internet-Draft iCalendar DTD Document (xCal) July 2002
-
-
- parameter entity declarations. This XML feature is used to group
- declarations within the DTD. This technique has been used in DTD
- design in order to facilitate the reading and comprehension of the
- structure specified by the DTD.
-
-2.11 Namespace
-
- [XMLNS] defines "Namespaces in XML" to be a collection of names,
- identified by a URI, which are used in XML documents as element types
- and attribute names. The [XML] specification does not include a
- definition for namespaces, but does set down some guidelines for
- experimental naming of namespaces.
-
- XML namespaces allow multiple markup vocabulary in a single document.
- Considering the utility of the iCalendar properties in other
- applications, it is important for the iCalendar XML DTD to define a
- namespace for the iCalendar element types.
-
- This memo defines the value that MUST be used in non-iCalendar XML
- documents that reference element types or attribute lists from the
- iCalendar namespace.
-
- The following is an example of a well-formed but invalid "xdoc"
- document type that includes elements and attribute lists from the
- iCalendar namespace:
-
-
-
-
-
-
-
-
-
-
-
-
-2.12 Emailing the iCalendar XML Representation
-
- It is expected that iCalendar XML documents will need to be sent over
- SMTP/MIME email. The "text/xml" and "application/xml" content-types
- have been registered for XML documents. However, use of these
- content-type definitions present some problems for XML applications
- such as calendaring and scheduling.
-
- The "text/xml" and "application/xml" content-type definitions do not
- provide for any header field parameters to identify the type of XML
-
-
-
-Dawson, Reddy, Royer, Plamondon Expires January 23, 2003 [Page 17]
-
-Internet-Draft iCalendar DTD Document (xCal) July 2002
-
-
- document contained in the MIME entity. This means that a recipient
- mail user agent must (MUA) open up each "text/xml" or "application/
- xml" content in order to determine what object handler is needed to
- process the information. To a MUA, all XML documents look like just
- plain "text/xml" or "application/xml" content.
-
- Additionally, it is accepted practice for a MUA to provide iconic
- feedback to the user for individual content-types that are supported
- by the MUA. For example, not only would feedback be provided for a
- calendaring and scheduling content. Some further unique
- identification would also be provided for each different scheduling
- message; such as a meeting invitation, response to an invitation,
- reschedule notice, cancellation notice, etc. In such cases,
- acceptable performance by the MUA is dependent on the existence of
- header field information, such as it provided in the definition of
- the "text/calendar" content-type by [RFC 2445].
-
- Internet application conforming to this memo MUST identify iCalendar
- XML documents with the experimental content-type "application/
- calendar+xml". The content-type header field SHOULD also contain a
- "component" and "method" parameter to clearly identify a comma-
- separated list of components and the singular method used in the
- iCalendar XML document. For example, an iCalendar XML document
- specifying a REQUEST for a VEVENT and VTODO would be specified with
- the following content-type header field:
-
- content-type:application/calendar+xml;method=REQUEST;component=VEVENT,VTODO
-
- The content-type can also include the "optinfo" parameter to specify
- any other optional iCalendar information. The semantics of these
- content-type parameters is as defined in [RFC 2445].
-
- Internet applications conforming to this memo MUST only send the
- iCalendar XML document in a "multipart/alternative" MIME entity that
- also contains an equivalent iCalendar object in the standard format
- defined by [RFC 2445]. This restrict will guarantee that the
- iCalendar object can also be processed by internet applications that
- only support the standard iCalendar format.
-
- An XML application supporting the iCalendar XML document type MUST be
- able to receive and properly process the "application/calendar+xml"
- document contained within a "multipart" message content-type.
-
-2.13 iCalendar XML Representation and File Systems
-
- The iCalendar XML documents will be stored in file systems. The
- accepted practice for file extensions for XML documents is the text
- "XML". However, in order to uniquely identify iCalendar XML
-
-
-
-Dawson, Reddy, Royer, Plamondon Expires January 23, 2003 [Page 18]
-
-Internet-Draft iCalendar DTD Document (xCal) July 2002
-
-
- documents for file association with applications that can directly
- process this document type, it is RECOMMENDED that the file extension
- be the text "XCS".
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Dawson, Reddy, Royer, Plamondon Expires January 23, 2003 [Page 19]
-
-Internet-Draft iCalendar DTD Document (xCal) July 2002
-
-
-3. Example Usage
-
- The following sections provide various examples of iCalendar XML
- documents.
-
-3.1 A well-formed and valid iCalendar XML document
-
- The following is a simple example of a iCalendar XML document. This
- document is both a well-formed and valid XML document. The iCalendar
- object specifies an appointment.
-
-
-
-
-
-
-
- 19981116T150000@cal10.host.com
- 19981116T145958Z
- Project XYZ Review
- Conference Room 23A
- 19981116T163000Z
- 19981116T190000Z
-
- Appointment
-
-
-
-
-
-
-3.2 Adding non-standard, experimental extensions
-
- The following is an example of a valid iCalendar XML document that
- also includes a non-standard, experimental extension, as provided for
- by [RFC 2445]. The iCalendar object specifies the publication of a
- to-do with a non-standard experimental property for a customer charge
- code.
-
- The non-standard experimental property is identified by the "X-"
- prefix to the element name. All non-standard properties MUST be
- specified with element types with an "X-" type element name. In
- addition, a text identifier for the vendor specifying the extension
- SHOULD be appended to the "X-" text prefix. In this case, the
- example specifies a "foo" for the name of the vendor specifying the
-
-
-
-Dawson, Reddy, Royer, Plamondon Expires January 23, 2003 [Page 20]
-
-Internet-Draft iCalendar DTD Document (xCal) July 2002
-
-
- non- standard property.
-
-
-
-
-
-
- ]>
-
-
-
-
- 19981104T130000@cal1.host.com
- 19981104T125957Z
- 19981105T133000Z
- 19981106T133000Z
- Draft a test plan
- 1998-ABC Corp-1234
- 1
-
-
-
-
-
-3.3 Including binary content in attachments
-
- The following is an example of a valid iCalendar XML document that
- also includes an external reference to an attachment. The iCalendar
- object specifies a meeting invitation with an attachment.
-
-
-
-
-
-
-
-
-
-
-
-
-Dawson, Reddy, Royer, Plamondon Expires January 23, 2003 [Page 21]
-
-Internet-Draft iCalendar DTD Document (xCal) July 2002
-
-
-
-
-
-
- ]>
-
-
-
-
- 19981211T133000@cal1.host.com
- 19981211T132928Z
- jim@host.com
- 19981212T150000Z
- 19981212T160000Z
- Department Meeting
- Conference Room 23A
- jim@host.com
- MAILTO:joe@host.com
- MAILTO:steve@host.com
-
-
-
-
-
- The following is an example of a well-formed and valid iCalendar XML
- document that includes an attachment as inline binary content. The
- iCalendar object specifies a meeting invitation with an attachment.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Dawson, Reddy, Royer, Plamondon Expires January 23, 2003 [Page 22]
-
-Internet-Draft iCalendar DTD Document (xCal) July 2002
-
-
-
-
-
-
-
-
- 19981211T133000@cal1.host.com
- 19981211T132928Z
- MAILTO:jim@host.com
- 19981212T150000Z
- 19981212T160000Z
- Department Meeting
- Conference Room 23A
- MAILTO:jim@host.com
- MAILTO:joe@host.com
- MAILTO:steve@host.com
- MIICajCCAdOgAwIBAgI
- CBEUwDQEEBQAwdzELMAkGA1UEBhMCVVMxLDAqBgNVBAoTI05ldHNjYXB
- lIEjYXRpb25z...and so on...IENvcnBvc==
-
-
-
-
-
-3.4 iCalendar XML document with multiple iCalendar objects
-
- The following is an example of a well-formed and valid iCalendar XML
- document that includes more than one iCalendar object.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Dawson, Reddy, Royer, Plamondon Expires January 23, 2003 [Page 23]
-
-Internet-Draft iCalendar DTD Document (xCal) July 2002
-
-
-
-
-
-
-
-
- 19981009T233000@cal1.host.com
- 19981009T232928Z
- 19981010T000000Z
- 19981010T235959Z
- Register for conference
- 2
-
-
-
-
- 19981009T233010@cal1.host.com
- 19981009T233000Z
- 19981120T133000Z
- 19981122T183000Z
- IT Conference
- Downtowner Hotel
-
-
-
-
-
-3.5 Using the iCalendar namespace
-
- The following is an example of a snippet of a XML document that
- includes elements from the iCalendar name-space.
-
-
- 19981123T133000Z
- 19981123T203000Z
- 1234567
- 999.99
-
-
-
-
-
-
-
-Dawson, Reddy, Royer, Plamondon Expires January 23, 2003 [Page 24]
-
-Internet-Draft iCalendar DTD Document (xCal) July 2002
-
-
-3.6 Publish meeting information
-
- The following is a snippet of an iCalendar XML document that
- publishes information about a meeting. The "method" attribute isn't
- specified since it is the default value.
-
-
-
-
- 19970901T130000Z-123401@host.com
- 19970901T130000Z
- 19970903T163000Z
- 19970903T190000Z
- Annual Employee Review
- PRIVATE
-
- Business
- Human Resources
-
-
-
-
-
-
-3.7 Publish transparent annual event
-
- The following is a snippet of an iCalendar XML document that
- publishes information about an annually repeating event that is
- transparent to busy time searches.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Dawson, Reddy, Royer, Plamondon Expires January 23, 2003 [Page 25]
-
-Internet-Draft iCalendar DTD Document (xCal) July 2002
-
-
-
-
-
- 19990101T125957Z-123403@host.com
- 19990101T130000Z
- 19991102
- 19991102
- Our Blissful Anniversary
- CONFIDENTIAL
- TRANSPARENT
-
- Anniversary
- Personal
- Special Occasion
-
- FREQ=YEARLY
-
-
-
-
-
-3.8 Meeting invitation
-
- The following is a snippet of an iCalendar XML document that
- specifies an invitation for a meeting. The meeting occurs on the
- first Monday of each year for five years.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Dawson, Reddy, Royer, Plamondon Expires January 23, 2003 [Page 26]
-
-Internet-Draft iCalendar DTD Document (xCal) July 2002
-
-
-
-
-
- 19981220T130000Z-123403@host.com
- 19981220T130050Z
- MAILTO:corprel@host.com
- 19990104T140000Z
- 19990104T220000Z
- Annual Stockholders Meeting
- One Corporate Drive, Wilmington, DL
- MAILTO:mrbig@host.com
- MAILTO:stockholders@host.com
-
- Business
- Meeting
- Special Occasion
-
- FREQ=YEARLY;COUNT=5;BYDAY=1MO
-
-
-
-
-
-3.9 Assign a to-do
-
- The following is a snippet of an iCalendar XML document that assigns
- a to-do.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Dawson, Reddy, Royer, Plamondon Expires January 23, 2003 [Page 27]
-
-Internet-Draft iCalendar DTD Document (xCal) July 2002
-
-
-
-
-
- 19990104T133402@ical1.host.com
- 19990104T133410Z
- 19990104
- 19990129
- MAILTO:dboss@host.com
- Periodic Self Review
- Complete your self review.
- Contact me if you questions.
- 1
- CONFIDENTIAL
- MAILTO:dilbert@host.com
-
-
-
-
-
-3.10 Publish a journal entry
-
- The following is a snippet of an iCalendar XML document that
- publishes a journal entry.
-
-
-
-
- 19990104T170003@ical1.host.com
- 19990104T170001Z
- 19990104
- MAILTO:corprel@host.com
- PUBLIC
- Year end report for Worldwide Calendar Company
- The complete report can be found at the Corporate website.
- http://www.host.com/annualreport
-
- Annual Report
- Business
-
-
-
-
-
-
-
-
-
-Dawson, Reddy, Royer, Plamondon Expires January 23, 2003 [Page 28]
-
-Internet-Draft iCalendar DTD Document (xCal) July 2002
-
-
-3.11 Publish busy time
-
- The following is an iCalendar XML document that publishes busy time
- information. The default value for the "method" attribute is
- "PUBLISH" and does not need to be specified in this example.
-
-
-
- ]>
-
-
-
-
- 19980313T133000@ical1.host.com
- 19990104T133010Z
- MAILTO:jsmith@host.com
- 19980313T141711Z
- 19980410T141711Z
-
- 19980314T233000Z/19980315T003000Z
- 19980316T153000Z/19980316T163000Z
- 19980318T030000Z/19980318T040000Z
-
-
-
-
-
-3.12 Request busy time
-
- The following is a snippet of an iCalendar XML document that requests
- a calendar user's busy time information.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Dawson, Reddy, Royer, Plamondon Expires January 23, 2003 [Page 29]
-
-Internet-Draft iCalendar DTD Document (xCal) July 2002
-
-
-
-
-
- 19970901T083000@ical1.host.com
- 19970901T083000Z
- MAILTO:jane_doe@host1.com
- 19971015T050000Z
- 19971016T050000Z
- MAILTO:john_public@host2.com
-
-
-
-
-
-3.13 Response to a busy time request
-
- The following is an iCalendar XML document that responds to request
- for busy time information.
-
-
-
- ]>
-
-
-
-
- 19970901T083000@ical1.host.com
- 19970901T100000Z
- MAILTO:jane_doe@host1.com
-
- MAILTO:john_public@host2.com
- 19971015T050000Z/PT8H30M,
- 19971015T160000Z/PT5H30M,19971015T223000Z/PT6H30M
-
-
-
-
-
-3.14 Published event that references time zone information
-
- The following is a snippet of an iCalendar XML document that
- publishes calendar information about an event that includes date/time
-
-
-
-Dawson, Reddy, Royer, Plamondon Expires January 23, 2003 [Page 30]
-
-Internet-Draft iCalendar DTD Document (xCal) July 2002
-
-
- values that reference a time zone definition.
-
-
-
-
- US-Eastern
-
- 19981025T020000
- -0400
- 0500
- 19981025T020000
- EST
-
-
- 19990404T020000
- -0500
- -0400
- 19990404T020000
- EDT
-
-
-
- 19980309T231000Z
- guid-1.host1.com
- 19980312T083000
- 19980312T093000
- MAILTO:mrbig@host.com
- Project XYZ Review Meeting
- PUBLIC
- XYZ Project Review
- 1CP Conference Room 4350
-
- Meeting
-
- MAILTO:employee-@host.com
-
-
-
-
-
-
-3.15 An event with an alarm
-
- The following is an iCalendar XML with associated alarms. The event
- specifies alarm definitions for a "display", "audio", "email" and
-
-
-
-Dawson, Reddy, Royer, Plamondon Expires January 23, 2003 [Page 31]
-
-Internet-Draft iCalendar DTD Document (xCal) July 2002
-
-
- "procedure" type of alarms. The "method" attribute isn't specified
- since it is the default value.
-
-
-
-
-
-
- ]>
-
-
-
- 19990104T130000@host.com
- 19990104T130100Z
- 19990704T230000Z
- 19970705T040000Z
- Firework Celebration
-
- Holiday
- Special Occasion
-
-
- DISPLAY
- Firework Celebration Tonight at
- 6 PM !!!
- 19990704T224500Z
- 2
- PT15M
-
-
- AUDIO
- 19990704T224500Z
- 2
- PT15M
-
-
-
- EMAIL
- Firework Celebration Tonight
- at 6 PM on Channel 6!!!
- *** Firework Celebration On TV ***
- 19990704T224500Z
- MAILTO:PIN1234@pager.host.com
-
-
-
-Dawson, Reddy, Royer, Plamondon Expires January 23, 2003 [Page 32]
-
-Internet-Draft iCalendar DTD Document (xCal) July 2002
-
-
-
-
- PROCEDURE
-
- 19990704T230000Z
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Dawson, Reddy, Royer, Plamondon Expires January 23, 2003 [Page 33]
-
-Internet-Draft iCalendar DTD Document (xCal) July 2002
-
-
-4. iCalendar XML Document Type Definition
-
- The following DTD conforms to XML version 1.0, as specified by [XML].
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Dawson, Reddy, Royer, Plamondon Expires January 23, 2003 [Page 34]
-
-Internet-Draft iCalendar DTD Document (xCal) July 2002
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Dawson, Reddy, Royer, Plamondon Expires January 23, 2003 [Page 37]
-
-Internet-Draft iCalendar DTD Document (xCal) July 2002
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Dawson, Reddy, Royer, Plamondon Expires January 23, 2003 [Page 40]
-
-Internet-Draft iCalendar DTD Document (xCal) July 2002
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Dawson, Reddy, Royer, Plamondon Expires January 23, 2003 [Page 41]
-
-Internet-Draft iCalendar DTD Document (xCal) July 2002
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Dawson, Reddy, Royer, Plamondon Expires January 23, 2003 [Page 42]
-
-Internet-Draft iCalendar DTD Document (xCal) July 2002
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Dawson, Reddy, Royer, Plamondon Expires January 23, 2003 [Page 43]
-
-Internet-Draft iCalendar DTD Document (xCal) July 2002
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Dawson, Reddy, Royer, Plamondon Expires January 23, 2003 [Page 44]
-
-Internet-Draft iCalendar DTD Document (xCal) July 2002
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Dawson, Reddy, Royer, Plamondon Expires January 23, 2003 [Page 45]
-
-Internet-Draft iCalendar DTD Document (xCal) July 2002
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Dawson, Reddy, Royer, Plamondon Expires January 23, 2003 [Page 46]
-
-Internet-Draft iCalendar DTD Document (xCal) July 2002
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Dawson, Reddy, Royer, Plamondon Expires January 23, 2003 [Page 47]
-
-Internet-Draft iCalendar DTD Document (xCal) July 2002
-
-
-5. Acknowledgments
-
- The following have participated in the drafting and discussion of
- this memo:
-
- Greg FitzPatrick, Charles Goldfarb, Paul Hoffman, Lisa Lippert,
- Thomas Rowe.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Dawson, Reddy, Royer, Plamondon Expires January 23, 2003 [Page 48]
-
-Internet-Draft iCalendar DTD Document (xCal) July 2002
-
-
-6. IANA Considerations
-
- This document defines a XML Formal Public Identifier (FPI), based on
- a format defined in [ISO 9070], that identifies a XML document type
- corresponding to this memo. Publication of this memo constitutes
- registration of this identifier.
-
- In addition, this memo defines the XML FPIs corresponding to each of
- the value types specified in [RFC 2445].
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Dawson, Reddy, Royer, Plamondon Expires January 23, 2003 [Page 49]
-
-Internet-Draft iCalendar DTD Document (xCal) July 2002
-
-
-7. Security Considerations
-
- CDATA Sections - - A XML iCalendar document may contain CDATA
- sections to represent content for specific element types. The CDATA
- section specifies arbitrary character data that is not meant to be
- interpretted. It is not scanned by the XML parser for markup. While
- this memo restricts that any CDATA section MUST NOT contain markup or
- other such alternate representation for the property value, in
- general, CDATA section from a non-conformant implementation can
- contain content such as HTML markup. HTML text can be used to invoke
- programs. Implementors should be aware that this may leave an
- implementation open to malicious attack that might occur as a result
- of executing the markup in the CDATA section.
-
- PROCEDURAL ALARMS - - A XML iCalendar document can be created that
- contains a "VEVENT" and "VTODO" calendar component with "VALARM"
- calendar components. The "VALARM" calendar component can be of type
- PROCEDURE and can have an attachment containing some sort of
- executable program. Implementations that incorporate these types of
- alarms are subject to any virus or malicious attack that might occur
- as a result of executing the attachment.
-
- ATTACHMENTS - - A XML iCalendar document can include references to
- Uniform Resource Locators that can be programmed resources.
- Implementers and users of this memo should be aware of the network
- security implications of accepting and parsing such information.
-
- In addition, the security considerations observed by implementations
- of electronic mail systems should be followed for this memo.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Dawson, Reddy, Royer, Plamondon Expires January 23, 2003 [Page 50]
-
-Internet-Draft iCalendar DTD Document (xCal) July 2002
-
-
-8. Bibliography
-
- [FPI] F. Dawson, "iCalendar Formal Public Identifier", Internet
- Draft, http://www.internic.net/internet-drafts/draft-calsch-icalfpi-
- 00.txt, September 1998.
-
- [ISO9070] "Information Technology_SGML Support Facilities_
- Registration Procedures for Public Text Owner Identifiers", ISO/IEC
- 9070, Second Edition, International Organization for Standardization,
- April 1991.
-
- [RFC 2045] N. Freed, N. Borenstein, "Multipurpose Internet Mail
- Extensions (MIME) - Part One: Format of Internet Message Bodies", RFC
- 2045, November 1996.
-
- [RFC 2119] S. Bradner, "Key words for use in RFCs to Indicate
- Requirement Levels", RFC 2119, http://www.ietf.org/rfc/rfc2119.txt,
- March 1997.
-
- [RFC 2445] F. Dawson and D. Stenerson, "Internet Calendaring and
- Scheduling Core Object Specification (iCalendar)", RFC 2445, http://
- www.ietf.org/rfc/rfc2445.txt, November 1998.
-
- [XML] "Extensible Markup Language (XML)", Worldwide Web Consortium,
- http://www.w3.org/TR/1998/REC-xml-19980210, February 1998.
-
- [XML] "Extensible Markup Language (XML)", Worldwide Web Consortium,
- http://www.w3.org/TR/1998/REC-xml-19980210, February 1998.
-
-
-Authors' Addresses
-
- Frank Dawson
- Nokia Corporation
-
- Phone: +1 (972) 894 4083
- EMail: frank.dawson@nokia.com
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Dawson, Reddy, Royer, Plamondon Expires January 23, 2003 [Page 51]
-
-Internet-Draft iCalendar DTD Document (xCal) July 2002
-
-
- Surendra K. Reddy
- Oracle
- M/S 6op3
- 500 Oracle Parkway
- Redwoodshores, CA 94065
- US
-
- Phone: +1 (650) 506 5441
- Fax: +1 (650) 654 6205
- EMail: skreddy@us.oracle.com
-
-
- Doug Royer
- INET-Consulting LLC
- 1795 W. Broadway #266
- Idaho Falls, ID 83402
- US
-
- Phone: +1 (208) 520 4044
- Fax: +1 (208) 552 1179
- EMail: doug@royer.com
-
-
- Eric R. Plamondon
- Oracle
- 2000 Peel Street, 4th Floor
- Montreal, QC H3A 2W5
- Canada
-
- Phone: +1 (514) 733 8500
- Fax: +1 (514) 733 8878
- EMail: ericp@steltor.com
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Dawson, Reddy, Royer, Plamondon Expires January 23, 2003 [Page 52]
-
-Internet-Draft iCalendar DTD Document (xCal) July 2002
-
-
-Full Copyright Statement
-
- Copyright (C) The Internet Society (2002). 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.
-
-Acknowledgement
-
- Funding for the RFC Editor function is currently provided by the
- Internet Society.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Dawson, Reddy, Royer, Plamondon Expires January 23, 2003 [Page 53]
diff --git a/docs/dusseault-caldav-15.txt.html b/docs/dusseault-caldav-15.txt.html
deleted file mode 100644
index 65596637..00000000
--- a/docs/dusseault-caldav-15.txt.html
+++ /dev/null
@@ -1,6502 +0,0 @@
-
-
-
-
-
-dusseault-caldav-15.txt
-
-
-
-Internet DRAFT - draft-dusseault-caldav
-
-
-
-
-Network Working Group C. Daboo
-Internet-Draft Apple Computer
-Expires: March 17, 2007 B. Desruisseaux
- Oracle
- L. Dusseault
- OSAF
- September 13, 2006
-
-
- Calendaring Extensions to WebDAV (CalDAV)
- draft-dusseault-caldav-15
-
-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 March 17, 2007.
-
-Copyright Notice
-
- Copyright (C) The Internet Society (2006).
-
-Abstract
-
- This document specifies a set of methods, headers, message bodies,
- properties, and reports that define calendar access extensions to the
- WebDAV protocol. The new protocol elements are intended to make
- WebDAV-based calendaring and scheduling an interoperable standard
- that supports calendar access, calendar management, calendar sharing,
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 1]
-
-Internet-Draft CalDAV September 2006
-
-
- and calendar publishing.
-
-
-Table of Contents
-
- 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 5
- 1.1. Notational Conventions . . . . . . . . . . . . . . . . . 5
- 1.2. XML Namespaces and Processing . . . . . . . . . . . . . . 5
- 1.3. Method Preconditions and Postconditions . . . . . . . . . 6
- 2. Requirements Overview . . . . . . . . . . . . . . . . . . . . 6
- 3. Calendaring Data Model . . . . . . . . . . . . . . . . . . . 7
- 3.1. Calendar Server . . . . . . . . . . . . . . . . . . . . . 7
- 3.2. Recurrence and the Data Model . . . . . . . . . . . . . . 8
- 4. Calendar Resources . . . . . . . . . . . . . . . . . . . . . 9
- 4.1. Calendar Object Resources . . . . . . . . . . . . . . . . 9
- 4.2. Calendar Collection . . . . . . . . . . . . . . . . . . . 10
- 5. Calendar Access Feature . . . . . . . . . . . . . . . . . . . 11
- 5.1. Calendar Access Support . . . . . . . . . . . . . . . . . 11
- 5.1.1. Example: Using OPTIONS for the Discovery of
- Calendar Access Support . . . . . . . . . . . . . . . 12
- 5.2. Calendar Collection Properties . . . . . . . . . . . . . 12
- 5.2.1. CALDAV:calendar-description Property . . . . . . . . 12
- 5.2.2. CALDAV:calendar-timezone Property . . . . . . . . . . 13
- 5.2.3. CALDAV:supported-calendar-component-set Property . . 14
- 5.2.4. CALDAV:supported-calendar-data Property . . . . . . . 15
- 5.2.5. CALDAV:max-resource-size Property . . . . . . . . . . 16
- 5.2.6. CALDAV:min-date-time Property . . . . . . . . . . . . 17
- 5.2.7. CALDAV:max-date-time Property . . . . . . . . . . . . 18
- 5.2.8. CALDAV:max-instances Property . . . . . . . . . . . . 18
- 5.2.9. CALDAV:max-attendees-per-instance Property . . . . . 19
- 5.2.10. Additional Precondition for PROPPATCH . . . . . . . . 20
- 5.3. Creating Resources . . . . . . . . . . . . . . . . . . . 20
- 5.3.1. MKCALENDAR Method . . . . . . . . . . . . . . . . . . 20
- 5.3.1.1. Status Codes . . . . . . . . . . . . . . . . . . 22
- 5.3.1.2. Example: Successful MKCALENDAR request . . . . . 23
- 5.3.2. Creating Calendar Object Resources . . . . . . . . . 25
- 5.3.2.1. Additional Preconditions for PUT, COPY and MOVE . 26
- 5.3.3. Non-standard components, properties and parameters . 28
- 5.3.4. Calendar Object Resource Entity Tag . . . . . . . . . 28
- 6. Calendaring Access Control . . . . . . . . . . . . . . . . . 29
- 6.1. Calendaring Privilege . . . . . . . . . . . . . . . . . . 29
- 6.1.1. CALDAV:read-free-busy Privilege . . . . . . . . . . . 29
- 6.2. Additional Principal Property . . . . . . . . . . . . . . 30
- 6.2.1. CALDAV:calendar-home-set Property . . . . . . . . . . 30
- 7. Calendaring Reports . . . . . . . . . . . . . . . . . . . . . 31
- 7.1. REPORT Method . . . . . . . . . . . . . . . . . . . . . . 31
- 7.2. Ordinary collections . . . . . . . . . . . . . . . . . . 31
- 7.3. Date and floating time . . . . . . . . . . . . . . . . . 32
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 2]
-
-Internet-Draft CalDAV September 2006
-
-
- 7.4. Time range filtering . . . . . . . . . . . . . . . . . . 32
- 7.5. Searching Text: Collations . . . . . . . . . . . . . . . 33
- 7.5.1. CALDAV:supported-collation-set Property . . . . . . . 34
- 7.6. Partial Retrieval . . . . . . . . . . . . . . . . . . . . 34
- 7.7. Non-standard components, properties and parameters . . . 35
- 7.8. CALDAV:calendar-query Report . . . . . . . . . . . . . . 35
- 7.8.1. Example: Partial retrieval of events by time range . 38
- 7.8.2. Example: Partial retrieval of recurring events . . . 42
- 7.8.3. Example: Expanded retrieval of recurring events . . . 45
- 7.8.4. Example: Partial retrieval of stored free busy
- components . . . . . . . . . . . . . . . . . . . . . 47
- 7.8.5. Example: Retrieval of to-dos by alarm time range . . 49
- 7.8.6. Example: Retrieval of event by UID . . . . . . . . . 51
- 7.8.7. Example: Retrieval of events by PARTSTAT . . . . . . 53
- 7.8.8. Example: Retrieval of events only . . . . . . . . . . 55
- 7.8.9. Example: Retrieval of all pending to-dos . . . . . . 59
- 7.8.10. Example: Attempt to query unsupported property . . . 62
- 7.9. CALDAV:calendar-multiget Report . . . . . . . . . . . . . 63
- 7.9.1. Example: Successful CALDAV:calendar-multiget Report . 64
- 7.10. CALDAV:free-busy-query Report . . . . . . . . . . . . . . 66
- 7.10.1. Example: Successful CALDAV:free-busy-query Report . . 68
- 8. Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . 68
- 8.1. Client-to-client Interoperability . . . . . . . . . . . . 69
- 8.2. Synchronization Operations . . . . . . . . . . . . . . . 69
- 8.2.1. Use of Reports . . . . . . . . . . . . . . . . . . . 69
- 8.2.1.1. Restrict the Time Range . . . . . . . . . . . . . 69
- 8.2.1.2. Synchronize by Time Range . . . . . . . . . . . . 69
- 8.2.1.3. Synchronization Process . . . . . . . . . . . . . 70
- 8.2.2. Restrict the Properties Returned . . . . . . . . . . 72
- 8.3. Use of Locking . . . . . . . . . . . . . . . . . . . . . 72
- 8.4. Finding calendars . . . . . . . . . . . . . . . . . . . . 72
- 8.5. Storing and Using Attachments . . . . . . . . . . . . . . 74
- 8.5.1. Inline attachments . . . . . . . . . . . . . . . . . 74
- 8.5.2. External attachments . . . . . . . . . . . . . . . . 75
- 8.6. Storing and Using Alarms . . . . . . . . . . . . . . . . 76
- 9. XML Element Definitions . . . . . . . . . . . . . . . . . . . 77
- 9.1. CALDAV:calendar XML Element . . . . . . . . . . . . . . . 77
- 9.2. CALDAV:mkcalendar XML Element . . . . . . . . . . . . . . 77
- 9.3. CALDAV:mkcalendar-response XML Element . . . . . . . . . 77
- 9.4. CALDAV:supported-collation XML Element . . . . . . . . . 78
- 9.5. CALDAV:calendar-query XML Element . . . . . . . . . . . . 78
- 9.6. CALDAV:calendar-data XML Element . . . . . . . . . . . . 79
- 9.6.1. CALDAV:comp XML Element . . . . . . . . . . . . . . . 80
- 9.6.2. CALDAV:allcomp XML Element . . . . . . . . . . . . . 80
- 9.6.3. CALDAV:allprop XML Element . . . . . . . . . . . . . 81
- 9.6.4. CALDAV:prop XML Element . . . . . . . . . . . . . . . 81
- 9.6.5. CALDAV:expand XML Element . . . . . . . . . . . . . . 82
- 9.6.6. CALDAV:limit-recurrence-set XML Element . . . . . . . 83
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 3]
-
-Internet-Draft CalDAV September 2006
-
-
- 9.6.7. CALDAV:limit-freebusy-set XML Element . . . . . . . . 84
- 9.7. CALDAV:filter XML Element . . . . . . . . . . . . . . . . 84
- 9.7.1. CALDAV:comp-filter XML Element . . . . . . . . . . . 85
- 9.7.2. CALDAV:prop-filter XML Element . . . . . . . . . . . 85
- 9.7.3. CALDAV:param-filter XML Element . . . . . . . . . . . 86
- 9.7.4. CALDAV:is-not-defined XML Element . . . . . . . . . . 87
- 9.7.5. CALDAV:text-match XML Element . . . . . . . . . . . . 87
- 9.8. CALDAV:timezone XML Element . . . . . . . . . . . . . . . 88
- 9.9. CALDAV:time-range XML Element . . . . . . . . . . . . . . 88
- 9.10. CALDAV:calendar-multiget XML Element . . . . . . . . . . 93
- 9.11. CALDAV:free-busy-query XML Element . . . . . . . . . . . 94
- 10. Internationalization Considerations . . . . . . . . . . . . . 94
- 11. Security Considerations . . . . . . . . . . . . . . . . . . . 94
- 12. IANA Consideration . . . . . . . . . . . . . . . . . . . . . 95
- 12.1. Namespace Registration . . . . . . . . . . . . . . . . . 95
- 13. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 96
- 14. References . . . . . . . . . . . . . . . . . . . . . . . . . 96
- 14.1. Normative References . . . . . . . . . . . . . . . . . . 96
- 14.2. Informative References . . . . . . . . . . . . . . . . . 97
- Appendix A. CalDAV Method Privilege Table (Normative) . . . . . 97
- Appendix B. Calendar collections used in the examples . . . . . 98
- Appendix C. Changes (to be removed prior to publication as an
- RFC) . . . . . . . . . . . . . . . . . . . . . . . . 104
- C.1. Changes in -15 . . . . . . . . . . . . . . . . . . . . . 104
- C.2. Changes in -14 . . . . . . . . . . . . . . . . . . . . . 105
- C.3. Changes in -13 . . . . . . . . . . . . . . . . . . . . . 105
- C.4. Changes in -12 . . . . . . . . . . . . . . . . . . . . . 106
- C.5. Changes in -11 . . . . . . . . . . . . . . . . . . . . . 106
- C.6. Changes in -10 . . . . . . . . . . . . . . . . . . . . . 107
- C.7. Changes in -09 . . . . . . . . . . . . . . . . . . . . . 108
- C.8. Changes in -08 . . . . . . . . . . . . . . . . . . . . . 109
- C.9. Changes in -07 . . . . . . . . . . . . . . . . . . . . . 110
- C.10. Changes in -06 . . . . . . . . . . . . . . . . . . . . . 111
- C.11. Changes in -05 . . . . . . . . . . . . . . . . . . . . . 111
- C.12. Changes in -04 . . . . . . . . . . . . . . . . . . . . . 112
- C.13. Changes in -03 . . . . . . . . . . . . . . . . . . . . . 113
- C.14. Changes in -02 . . . . . . . . . . . . . . . . . . . . . 113
- C.15. Changes in -01 . . . . . . . . . . . . . . . . . . . . . 113
- Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 114
- Intellectual Property and Copyright Statements . . . . . . . . . 115
-
-
-
-
-
-
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 4]
-
-Internet-Draft CalDAV September 2006
-
-
-1. Introduction
-
- The concept of using HTTP [RFC2616] and WebDAV [RFC2518] as a basis
- for a calendar access protocol is by no means a new concept: it was
- discussed in the IETF CALSCH working group as early as 1997 or 1998.
- Several companies have implemented calendar access protocols using
- HTTP to upload and download iCalendar [RFC2445] objects, and using
- WebDAV to get listings of resources. However, those implementations
- do not interoperate because there are many small and big decisions to
- be made in how to model calendaring data as WebDAV resources, as well
- as how to implement required features that aren't already part of
- WebDAV. This document proposes a way to model calendar data in
- WebDAV, with additional features to make an interoperable calendar
- access protocol.
-
-1.1. Notational 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 1.4.2 of [RFC3253].
-
- 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 type names respectively.
-
-1.2. 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-20060816].
-
- The namespace "urn:ietf:params:xml:ns:caldav" is reserved for the XML
- elements defined in this specification, its revisions, and related
- CalDAV specifications. XML elements defined by individual
- implementations MUST NOT use the "urn:ietf:params:xml:ns:caldav"
- namespace, and instead should use a namespace that they control.
-
- 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 [RFC2518] which use the "DAV:" namespace. Wherever
- such XML elements appear, they are explicitly prefixed with "DAV:" to
- avoid confusion.
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 5]
-
-Internet-Draft CalDAV September 2006
-
-
- 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.
-
- Processing of XML by CalDAV clients and servers MUST follow the rules
- described in [RFC2518], in particular Section 14, and Appendices 3
- and 4 of that specification.
-
-1.3. Method Preconditions and Postconditions
-
- A "precondition" of a method describes the state of the server that
- must be true for that method to be performed. A "postcondition" of a
- method describes the state of the server that must be true after that
- method has been completed. If a method precondition or postcondition
- for a request is not satisfied, the response status of the request
- MUST be either 403 (Forbidden) if the request should not be repeated
- because it will always fail, or 409 (Conflict) if it is expected that
- the user might be able to resolve the conflict and resubmit the
- request.
-
- In order to allow better client handling of 403 and 409 responses, a
- distinct XML element type is associated with each method precondition
- and postcondition of a request. When a particular precondition is
- not satisfied or a particular postcondition cannot be achieved, the
- appropriate XML element MUST be returned as the child of a top-level
- DAV:error element in the response body, unless otherwise negotiated
- by the request.
-
-
-2. Requirements Overview
-
- This section lists what functionality is required of a CalDAV server.
- To advertise support for CalDAV, a server:
-
- o MUST support iCalendar [RFC2445] as a media type for calendar
- object resource format;
-
- o MUST support WebDAV Class 1 [RFC2518] (note that [I-D.ietf-webdav-
- rfc2518bis] describes clarifications to [RFC2518] that aid
- interoperability);
-
- o MUST support WebDAV ACL [RFC3744] with the additional privilege
- defined in Section 6.1 of this document;
-
- o MUST support transport over TLS [RFC2246] as defined in [RFC2818]
- (note that [RFC2246] has been obsoleted by [RFC4346]);
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 6]
-
-Internet-Draft CalDAV September 2006
-
-
- o MUST support ETags [RFC2616] with additional requirements
- specified in Section 5.3.4 of this document;
-
- o MUST support all calendaring REPORTs defined in Section 7 of this
- document; and
-
- o MUST advertise support on all calendar collections and calendar
- object resources for the calendaring REPORTs in the DAV:supported-
- report-set property as defined in Versioning Extensions to WebDAV
- [RFC3253].
-
- In addition, a server:
-
- o SHOULD support the MKCALENDAR method defined in Section 5.3.1 of
- this document.
-
-
-3. Calendaring Data Model
-
- One of the features which has made WebDAV a successful protocol is
- its firm data model. This makes it a useful framework for other
- applications such as calendaring. This specification follows the
- same pattern by developing all features based on a well-described
- data model.
-
- As a brief overview, a CalDAV calendar is modeled as a WebDAV
- collection with a defined structure; each calendar collection
- contains a number of resources representing calendar objects as its
- direct child resource. Each resource representing a calendar object
- (event or to-do, or journal entry, or other calendar components) is
- called a "calendar object resource". Each calendar object resource
- and each calendar collection can be individually locked and have
- individual WebDAV properties. Requirements derived from this model
- are provided in Section 4.1 and Section 4.2.
-
-3.1. Calendar Server
-
- A CalDAV server is a calendaring-aware engine combined with a WebDAV
- repository. A WebDAV repository is a set of WebDAV collections,
- containing other WebDAV resources, within a unified URL namespace.
- For example, the repository "http://www.example.com/webdav/" may
- contain WebDAV collections and resources, all of which have URLs
- beginning with "http://www.example.com/webdav/". Note that the root
- URL "http://www.example.com/" may not itself be a WebDAV repository
- (for example, if the WebDAV support is implemented through a servlet
- or other Web server extension).
-
- A WebDAV repository MAY include calendar data in some parts of its
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 7]
-
-Internet-Draft CalDAV September 2006
-
-
- URL namespace, and non-calendaring data in other parts.
-
- A WebDAV repository can advertise itself as a CalDAV server if it
- supports the functionality defined in this specification at any point
- within the root of the repository. That might mean that calendaring
- data is spread throughout the repository and mixed with non-calendar
- data in nearby collections (e.g., calendar data may be found in
- /home/lisa/calendars/ as well as in /home/bernard/calendars/, and
- non-calendar data in /home/lisa/contacts/). Or, it might mean that
- calendar data can be found only in certain sections of the repository
- (e.g., /calendar/). Calendaring features are only required in the
- repository sections that are or contain calendar object resources.
- So a repository confining calendar data to the /calendar/ collection
- would only need to support the CalDAV required features within that
- collection.
-
- The CalDAV server or repository is the canonical location for
- calendar data and state information. Clients may submit requests to
- change data or download data. Clients may store calendar objects
- offline and attempt to synchronize at a later time. However, clients
- MUST be prepared for calendar data on the server to change between
- the time of last synchronization and when attempting an update, as
- calendar collections may be shared and accessible via multiple
- clients. Entity tags and other features make this possible.
-
-3.2. Recurrence and the Data Model
-
- Recurrence is an important part of the data model because it governs
- how many resources are expected to exist. This specification models
- a recurring calendar component and its recurrence exceptions as a
- single resource. In this model, recurrence rules, recurrence dates,
- exception rules, and exception dates are all part of the data in a
- single calendar object resource. This model avoids problems of
- limiting how many recurrence instances to store in the repository,
- how to keep recurrence instances in sync with the recurring calendar
- component, and how to link recurrence exceptions with the recurring
- calendar component. It also results in less data to synchronize
- between client and server, and makes it easier to make changes to all
- recurrence instances or to a recurrence rule. It makes it easier to
- create a recurring calendar component, and easier to delete all
- recurrence instances.
-
- Clients are not forced to retrieve information about all recurrence
- instances of a recurring component. The CALDAV:calendar-query and
- CALDAV:calendar-multiget REPORTs defined in this document allow
- clients to retrieve only recurrence instances that overlap a given
- time range.
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 8]
-
-Internet-Draft CalDAV September 2006
-
-
-4. Calendar Resources
-
-4.1. Calendar Object Resources
-
- Calendar object resources contained in calendar collections MUST NOT
- contain more than one type of calendar component (e.g., VEVENT,
- VTODO, VJOURNAL, VFREEBUSY, etc.) with the exception of VTIMEZONE
- components which MUST be specified for each unique TZID parameter
- value specified in the iCalendar object. For instance, a calendar
- object resource can contain two VEVENT components and one VTIMEZONE
- component, but it cannot contain one VEVENT component and one VTODO
- component. Instead the VEVENT and VTODO components would have to be
- stored in separate calendar object resources in the same collection.
-
- Calendar object resources contained in calendar collections MUST NOT
- specify the iCalendar METHOD property.
-
- The UID property value of the calendar components contained in a
- calendar object resource MUST be unique in the scope of the calendar
- collection in which they are stored.
-
- Calendar components in a calendar collection that have different UID
- property values MUST be stored in separate calendar object resources.
-
- Calendar components with the same UID property value, in a given
- calendar collection, MUST be contained in the same calendar object
- resource. This ensures that all components in a recurrence "set" are
- contained in the same calendar object resource. It is possible for a
- calendar object resource to just contain components that represent
- "overridden" instances (ones which modify the behavior of a regular
- instance, and thus include a RECURRENCE-ID property), without also
- including the "master" recurring component (the one that defines the
- recurrence "set" and does not contain any "RECURRENCE-ID" property).
-
- For example, given the following iCalendar object:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 9]
-
-Internet-Draft CalDAV September 2006
-
-
- BEGIN:VCALENDAR
- PRODID:-//Example Corp.//CalDAV Client//EN
- VERSION:2.0
- BEGIN:VEVENT
- UID:1@example.com
- SUMMARY:One-off Meeting
- DTSTAMP:20041210T183904Z
- DTSTART:20041207T120000Z
- DTEND:20041207T130000Z
- END:VEVENT
- BEGIN:VEVENT
- UID:2@example.com
- SUMMARY:Weekly Meeting
- DTSTAMP:20041210T183838Z
- DTSTART:20041206T120000Z
- DTEND:20041206T130000Z
- RRULE:FREQ=WEEKLY
- END:VEVENT
- BEGIN:VEVENT
- UID:2@example.com
- SUMMARY:Weekly Meeting
- RECURRENCE-ID:20041213T120000Z
- DTSTAMP:20041210T183838Z
- DTSTART:20041213T130000Z
- DTEND:20041213T140000Z
- END:VEVENT
- END:VCALENDAR
-
- The VEVENT component with the UID value "1@example.com", would be
- stored in its own calendar object resource. The two VEVENT
- components with the UID value "2@example.com", which represent a
- recurring event where one recurrence instance has been overridden,
- would be stored in the same calendar object resource.
-
-4.2. Calendar Collection
-
- A calendar collection contains calendar object resources that
- represent calendar components within a calendar. A calendar
- collection is manifested to clients as a WebDAV resource collection
- identified by a URL. A calendar collection MUST report the DAV:
- collection and CALDAV:calendar XML elements in the value of the DAV:
- resourcetype property. The element type declaration for CALDAV:
- calendar is:
-
- <!ELEMENT calendar EMPTY>
-
- A calendar collection can be created through provisioning (e.g.,
- automatically created when a user's account is provisioned), or it
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 10]
-
-Internet-Draft CalDAV September 2006
-
-
- can be created with the MKCALENDAR method (see Section 5.3.1). This
- method can be useful for a user to create additional calendars (e.g.,
- soccer schedule) or for users to share a calendar (e.g., team events
- or conference room). Note however that this document doesn't define
- what extra calendar collections are for. Users must rely on non-
- standard cues to find out what a calendar collection is for, or use
- the CALDAV:calendar-description property defined in Section 5.2.1 to
- provide such a cue.
-
- The following restrictions are applied to the resources within a
- calendar collection:
-
- a. Calendar collections MUST only contain calendar object resources
- and collections that are not calendar collections. i.e., the only
- "top-level" non-collection resources allowed in a calendar
- collection are calendar object resources. This ensures that
- calendar clients do not have to deal with non-calendar data in a
- calendar collection, though they do have to distinguish between
- calendar object resources and collections when using standard
- WebDAV techniques to examine the contents of a collection.
-
- b. Collections contained in calendar collections MUST NOT contain
- calendar collections at any depth. i.e., "nesting" of calendar
- collections within other calendar collections at any depth is not
- allowed. This specification does not define how collections
- contained in a calendar collection are used or how they relate to
- any calendar object resources contained in the calendar
- collection.
-
- Multiple calendar collections MAY be children of the same collection.
-
-
-5. Calendar Access Feature
-
-5.1. Calendar Access Support
-
- A server supporting the features described in this document MUST
- include "calendar-access" as a field in the DAV response header from
- an OPTIONS request on any resource that supports any calendar
- properties, reports, method, or privilege. A value of "calendar-
- access" in the DAV response header MUST indicate that the server
- supports all MUST level requirements specified in this document.
-
-
-
-
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 11]
-
-Internet-Draft CalDAV September 2006
-
-
-5.1.1. Example: Using OPTIONS for the Discovery of Calendar Access
- Support
-
- >> Request <<
-
- OPTIONS /home/bernard/calendars/ HTTP/1.1
- Host: cal.example.com
-
- >> Response <<
-
- HTTP/1.1 200 OK
- Allow: OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, COPY, MOVE
- Allow: PROPFIND, PROPPATCH, LOCK, UNLOCK, REPORT, ACL
- DAV: 1, 2, 3, access-control, calendar-access
- Date: Fri, 11 Nov 2005 09:32:12 GMT
- Content-Length: 0
-
- In this example, the OPTIONS method returns the value "calendar-
- access" in the DAV response header to indicate that the collection
- "/home/bernard/calendars/" supports the properties, reports, methods,
- or privileges defined in this specification.
-
-5.2. Calendar Collection Properties
-
- This section defines properties that MAY be defined on calendar
- collections.
-
-5.2.1. CALDAV:calendar-description Property
-
- Name: calendar-description
-
- Namespace: urn:ietf:params:xml:ns:caldav
-
- Purpose: Provides a human-readable description of the calendar
- collection.
-
- Conformance: This property MAY be defined on any calendar collection.
- If defined, it MAY be protected and SHOULD NOT be returned by a
- PROPFIND DAV:allprop request (as defined in Section 12.14.1 of
- [RFC2518]). An xml:lang attribute indicating the human language
- of the description SHOULD be set for this property by clients or
- through server provisioning. Servers MUST return any xml:lang
- attribute if set for the property.
-
- Description: If present, the property contains a description of the
- calendar collection that is suitable for presentation to a user.
- If not present, the client should assume no description for the
- calendar collection.
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 12]
-
-Internet-Draft CalDAV September 2006
-
-
- Definition:
-
- <!ELEMENT calendar-description (#PCDATA)>
- PCDATA value: string
-
- Example:
-
- <C:calendar-description xml:lang="fr-CA"
- xmlns:C="urn:ietf:params:xml:ns:caldav"
- >Calendrier de Mathilde Desruisseaux</C:calendar-description>
-
-5.2.2. CALDAV:calendar-timezone Property
-
- Name: calendar-timezone
-
- Namespace: urn:ietf:params:xml:ns:caldav
-
- Purpose: Specifies a time zone on a calendar collection.
-
- Conformance: This property SHOULD be defined on all calendar
- collections. If defined, it SHOULD NOT be returned by a PROPFIND
- DAV:allprop request (as defined in Section 12.14.1 of [RFC2518]).
-
- Description: The CALDAV:calendar-timezone property is used to specify
- the time zone the server should rely on to resolve "date" values
- and "date with local time" values (i.e., floating time) to "date
- with UTC time" values. The server will require this information
- to determine if a calendar component scheduled with "date" values
- or "date with local time" values overlaps a CALDAV:time-range
- specified in a CALDAV:calendar-query REPORT. The server will also
- require this information to compute the proper FREEBUSY time
- period as "date with UTC time" in the VFREEBUSY component returned
- in a response to a CALDAV:free-busy-query REPORT request that
- takes into account calendar components scheduled with "date"
- values or "date with local time" values. In the absence of this
- property the server MAY rely on the time zone of their choice.
-
- Note: The iCalendar data embedded within the CALDAV:calendar-timezone
- 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
- iCalendar data cannot contain the character sequence "]]>" which
- is the end delimiter for the CDATA section.
-
- Definition:
-
- <!ELEMENT calendar-timezone (#PCDATA)>
- PCDATA value: an iCalendar object with exactly one VTIMEZONE
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 13]
-
-Internet-Draft CalDAV September 2006
-
-
- component.
-
- Example:
-
- <C:calendar-timezone
- xmlns:C="urn:ietf:params:xml:ns:caldav">BEGIN:VCALENDAR
- PRODID:-//Example Corp.//CalDAV Client//EN
- VERSION:2.0
- BEGIN:VTIMEZONE
- TZID:US-Eastern
- LAST-MODIFIED:19870101T000000Z
- BEGIN:STANDARD
- DTSTART:19671029T020000
- RRULE:FREQ=YEARLY;BYDAY=-1SU;BYMONTH=10
- TZOFFSETFROM:-0400
- TZOFFSETTO:-0500
- TZNAME:Eastern Standard Time (US & Canada)
- END:STANDARD
- BEGIN:DAYLIGHT
- DTSTART:19870405T020000
- RRULE:FREQ=YEARLY;BYDAY=1SU;BYMONTH=4
- TZOFFSETFROM:-0500
- TZOFFSETTO:-0400
- TZNAME:Eastern Daylight Time (US & Canada)
- END:DAYLIGHT
- END:VTIMEZONE
- END:VCALENDAR
- </C:calendar-timezone>
-
-5.2.3. CALDAV:supported-calendar-component-set Property
-
- Name: supported-calendar-component-set
-
- Namespace: urn:ietf:params:xml:ns:caldav
-
- Purpose: Specifies the calendar component types (e.g., VEVENT, VTODO,
- etc.) that calendar object resources can contain in the calendar
- collection.
-
- Conformance: This property MAY be defined on any calendar collection.
- If defined, it MUST be protected and SHOULD NOT be returned by a
- PROPFIND DAV:allprop request (as defined in Section 12.14.1 of
- [RFC2518]).
-
- Description: The CALDAV:supported-calendar-component-set property is
- used to specify restrictions on the calendar component types that
- calendar object resources may contain in a calendar collection.
- Any attempt by the client to store calendar object resources with
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 14]
-
-Internet-Draft CalDAV September 2006
-
-
- component types not listed in this property, if it exists, MUST
- result in an error, with the CALDAV:supported-calendar-component
- precondition (Section 5.3.2.1) being violated. Since this
- property is protected it cannot be changed by clients using a
- PROPPATCH request. However, clients can initialize the value of
- this property when creating a new calendar collection with
- MKCALENDAR. The empty-element tag <C:comp name="VTIMEZONE"/> MUST
- only be specified if support for calendar object resources that
- only contain VTIMEZONE components is provided or desired. Support
- for VTIMEZONE components in calendar object resources that contain
- VEVENT or VTODO components is always assumed. In the absence of
- this property the server MUST accept all component types, and the
- client can assume that.
-
- Definition:
-
- <!ELEMENT supported-calendar-component-set (comp*)>
-
- Example:
-
- <C:supported-calendar-component-set
- xmlns:C="urn:ietf:params:xml:ns:caldav">
- <C:comp name="VEVENT"/>
- <C:comp name="VTODO"/>
- </C:supported-calendar-component-set>
-
-5.2.4. CALDAV:supported-calendar-data Property
-
- Name: supported-calendar-data
-
- Namespace: urn:ietf:params:xml:ns:caldav
-
- Purpose: Specifies what media types are allowed for calendar object
- resources in a calendar collection.
-
- Conformance: This property MAY be defined on any calendar collection.
- If defined, it MUST be protected and SHOULD NOT be returned by a
- PROPFIND DAV:allprop request (as defined in Section 12.14.1 of
- [RFC2518]).
-
- Description: The CALDAV:supported-calendar-data property is used to
- specify the media type supported for the calendar object resources
- contained in a given calendar collection (e.g., iCalendar version
- 2.0). Any attempt by the client to store calendar object
- resources with a media type not listed in this property MUST
- result in an error, with the CALDAV:supported-calendar-data
- precondition (Section 5.3.2.1) being violated. In the absence of
- this property the server MUST only accept data with the media type
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 15]
-
-Internet-Draft CalDAV September 2006
-
-
- "text/calendar" and iCalendar version 2.0, and clients can assume
- that.
-
- Definition:
-
- <!ELEMENT supported-calendar-data (calendar-data*)>
-
- Example:
-
- <C:supported-calendar-data
- xmlns:C="urn:ietf:params:xml:ns:caldav">
- <C:calendar-data content-type="text/calendar" version="2.0"/>
- </C:supported-calendar-data>
-
-5.2.5. CALDAV:max-resource-size Property
-
- Name: max-resource-size
-
- Namespace: urn:ietf:params:xml:ns:caldav
-
- Purpose: Provides a numeric value indicating the maximum size of
- resource in octets that the server is willing to accept when a
- calendar object resource is stored in a calendar collection.
-
- Conformance: This property MAY be defined on any calendar collection.
- If defined, it MUST be protected and SHOULD NOT be returned by a
- PROPFIND DAV:allprop request (as defined in Section 12.14.1 of
- [RFC2518]).
-
- Description: The CALDAV: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 a calendar object resource is
- stored in a calendar collection. Any attempt to store a calendar
- object resource exceeding this size MUST result in an error, with
- the CALDAV:max-resource-size precondition (Section 5.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 integer)
-
-
-
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 16]
-
-Internet-Draft CalDAV September 2006
-
-
- Example:
-
- <C:max-resource-size xmlns:C="urn:ietf:params:xml:ns:caldav"
- >102400</C:max-resource-size>
-
-5.2.6. CALDAV:min-date-time Property
-
- Name: min-date-time
-
- Namespace: urn:ietf:params:xml:ns:caldav
-
- Purpose: Provides a date-time value indicating the earliest date and
- time (in UTC) that the server is willing to accept for any date or
- time value in a calendar object resource stored in a calendar
- collection.
-
- Conformance: This property MAY be defined on any calendar collection.
- If defined, it MUST be protected and SHOULD NOT be returned by a
- PROPFIND DAV:allprop request (as defined in Section 12.14.1 of
- [RFC2518]).
-
- Description: The CALDAV:min-date-time is used to specify an iCalendar
- DATE-TIME value in UTC that indicates the earliest inclusive date
- that the server is willing to accept for any explicit date or time
- value in a calendar object resource stored in a calendar
- collection. Any attempt to store a calendar object resource using
- a date or time value earlier than this value MUST result in an
- error, with the CALDAV:min-date-time precondition
- (Section 5.3.2.1) being violated. Note that servers MUST accept
- recurring components that specify instances beyond this limit,
- provided none of those instances have been overridden. In that
- case the server MAY simply ignore those instances outside of the
- acceptable range when processing reports on the calendar object
- resource. In the absence of this property the client can assume
- any valid iCalendar date may be used at least up to the CALDAV:
- max-date-time value if that is defined.
-
- Definition:
-
- <!ELEMENT min-date-time (#PCDATA)>
- PCDATA value: an iCalendar format DATE-TIME value in UTC
-
- Example:
-
- <C:min-date-time xmlns:C="urn:ietf:params:xml:ns:caldav"
- >19000101T000000Z</C:min-date-time>
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 17]
-
-Internet-Draft CalDAV September 2006
-
-
-5.2.7. CALDAV:max-date-time Property
-
- Name: max-date-time
-
- Namespace: urn:ietf:params:xml:ns:caldav
-
- Purpose: Provides a date-time value indicating the latest date and
- time (in UTC) that the server is willing to accept for any date or
- time value in a calendar object resource stored in a calendar
- collection.
-
- Conformance: This property MAY be defined on any calendar collection.
- If defined, it MUST be protected and SHOULD NOT be returned by a
- PROPFIND DAV:allprop request (as defined in Section 12.14.1 of
- [RFC2518]).
-
- Description: The CALDAV:max-date-time is used to specify an iCalendar
- DATE-TIME value in UTC that indicates the inclusive latest date
- that the server is willing to accept for any date or time value in
- a calendar object resource stored in a calendar collection. Any
- attempt to store a calendar object resource using a date or time
- value later than this value MUST result in an error, with the
- CALDAV:max-date-time precondition (Section 5.3.2.1) being
- violated. Note that servers MUST accept recurring components that
- specify instances beyond this limit, provided none of those
- instances have been overridden. In that case the server MAY
- simply ignore those instances outside of the acceptable range when
- processing reports on the calendar object resource. In the
- absence of this property the client can assume any valid iCalendar
- date may be used at least down to the CALDAV:min-date-time value
- if that is defined.
-
- Definition:
-
- <!ELEMENT max-date-time (#PCDATA)>
- PCDATA value: an iCalendar format DATE-TIME value in UTC
-
- Example:
-
- <C:max-date-time xmlns:C="urn:ietf:params:xml:ns:caldav"
- >20491231T235959Z</C:max-date-time>
-
-5.2.8. CALDAV:max-instances Property
-
-
-
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 18]
-
-Internet-Draft CalDAV September 2006
-
-
- Name: max-instances
-
- Namespace: urn:ietf:params:xml:ns:caldav
-
- Purpose: Provides a numeric value indicating the maximum number of
- recurrence instances that a calendar object resource stored in a
- calendar collection can generate.
-
- Conformance: This property MAY be defined on any calendar collection.
- If defined, it MUST be protected and SHOULD NOT be returned by a
- PROPFIND DAV:allprop request (as defined in Section 12.14.1 of
- [RFC2518]).
-
- Description: The CALDAV:max-instances is used to specify a numeric
- value that indicates the maximum number of recurrence instances
- that a calendar object resource stored in a calendar collection
- can generate. Any attempt to store a calendar object resource
- with a recurrence pattern that generates more instances than this
- value MUST result in an error, with the CALDAV:max-instances
- precondition (Section 5.3.2.1) being violated. In the absence of
- this property the client can assume that the server has no limits
- on the number of recurrence instances it can handle or expand.
-
- Definition:
-
- <!ELEMENT max-instances (#PCDATA)>
- PCDATA value: a numeric value (integer greater than zero)
-
- Example:
-
- <C:max-instances xmlns:C="urn:ietf:params:xml:ns:caldav"
- >100</C:max-instances>
-
-5.2.9. CALDAV:max-attendees-per-instance Property
-
- Name: max-attendees-per-instance
-
- Namespace: urn:ietf:params:xml:ns:caldav
-
- Purpose: Provides a numeric value indicating the maximum number of
- ATTENDEE properties in any instance of a calendar object resource
- stored in a calendar collection.
-
- Conformance: This property MAY be defined on any calendar collection.
- If defined, it MUST be protected and SHOULD NOT be returned by a
- PROPFIND DAV:allprop request (as defined in Section 12.14.1 of
- [RFC2518]).
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 19]
-
-Internet-Draft CalDAV September 2006
-
-
- Description: The CALDAV:max-attendees-per-instance is used to specify
- a numeric value that indicates the maximum number of iCalendar
- ATTENDEE properties on any one instance of a calendar object
- resource stored in a calendar collection. Any attempt to store a
- calendar object resource with more ATTENDEE properties per
- instance than this value MUST result in an error, with the CALDAV:
- max-attendees-per-instance precondition (Section 5.3.2.1) being
- violated. In the absence of this property the client can assume
- that the server can handle any number of ATTENDEE properties in a
- calendar component.
-
- Definition:
-
- <!ELEMENT max-attendees-per-instance (#PCDATA)>
- PCDATA value: a numeric value (integer greater than zero)
-
- Example:
-
- <C:max-attendees-per-instance
- xmlns:C="urn:ietf:params:xml:ns:caldav"
- >25</C:max-attendees-per-instance>
-
-5.2.10. Additional Precondition for PROPPATCH
-
- This specification requires an additional Precondition for the
- PROPPATCH method. The precondition is:
-
- (CALDAV:valid-calendar-data): The time zone specified in CALDAV:
- calendar-timezone property MUST be a valid iCalendar object
- containing a single valid VTIMEZONE component.
-
-5.3. Creating Resources
-
- The creation of calendar collections and calendar object resources
- may be initiated by either a CalDAV client or by the CalDAV server.
- For example, a server might come pre-configured with a user's
- calendar collection, or the CalDAV client might request the server to
- create a new calendar collection for a given user. Servers might
- populate events as calendar objects inside a calendar collection, or
- clients might request the server to create events. Either way, both
- client and server MUST comply with the requirements in this document,
- and MUST understand objects appearing in calendar collections or
- according to the data model defined here.
-
-5.3.1. MKCALENDAR Method
-
- An HTTP request using the MKCALENDAR method creates a new calendar
- collection resource. A server MAY restrict calendar collection
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 20]
-
-Internet-Draft CalDAV September 2006
-
-
- creation to particular collections.
-
- Support for MKCALENDAR on the server is only RECOMMENDED and not
- REQUIRED because some calendar stores only support one calendar per
- user (or principal) and those are typically pre-created for each
- account. However, servers and clients are strongly encouraged to
- support MKCALENDAR whenever possible to allow users to create
- multiple calendar collections to better help organize their data.
-
- Clients SHOULD use the DAV:displayname property for a human-readable
- name of the calendar. Clients can either specify the value of the
- DAV:displayname property in the request body of the MKCALENDAR
- request, or alternatively issue a PROPPATCH request to change the
- DAV:displayname property to the appropriate value immediately after
- issuing the MKCALENDAR request. Clients SHOULD NOT set the DAV:
- displayname property to be the same as any other calendar collection
- at the same URI "level". When displaying calendar collections to
- users, clients SHOULD check the DAV:displayname property and use that
- value as the name of the calendar. In the event that the DAV:
- displayname property is empty, the client MAY use the last part of
- the calendar collection URI as the name, however that path segment
- may be "opaque" and not represent any meaningful human-readable text.
-
- If a MKCALENDAR request fails, the server state preceding the request
- MUST be restored.
-
- Marshalling:
-
- If a request body is included, it MUST be a CALDAV:mkcalendar XML
- element. Instruction processing MUST occur in the order
- instructions are received (i.e., from top to bottom).
- Instructions MUST either all be executed or none executed. Thus
- if any error occurs during processing, all executed instructions
- MUST be undone and a proper error result returned. Instruction
- processing details can be found in the definition of the DAV:set
- instruction in Section 12.13.2 of [RFC2518].
-
- <!ELEMENT mkcalendar (DAV:set)>
-
- If a response body for a successful request is included, it MUST
- be a CALDAV:mkcalendar-response XML element.
-
- <!ELEMENT mkcalendar-response ANY>
-
- The response MUST include a Cache-Control:no-cache header.
-
- Preconditions:
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 21]
-
-Internet-Draft CalDAV September 2006
-
-
- (DAV:resource-must-be-null): A resource MUST NOT exist at the
- Request-URI;
-
- (CALDAV:calendar-collection-location-ok): The Request-URI MUST
- identify a location where a calendar collection can be created;
-
- (CALDAV:valid-calendar-data): The time zone specified in the
- CALDAV:calendar-timezone property MUST be a valid iCalendar object
- containing a single valid VTIMEZONE component;
-
- (DAV:needs-privilege): The DAV:bind privilege MUST be granted to
- the current user on the parent collection of the Request-URI.
-
- Postconditions:
-
- (CALDAV:initialize-calendar-collection): A new calendar collection
- exists at the Request-URI. The DAV:resourcetype of the calendar
- collection MUST contain both DAV:collection and CALDAV:calendar
- XML elements.
-
-5.3.1.1. Status Codes
-
- The following are examples of response codes one would expect to get
- in a response to a MKCALENDAR request. Note that this list is by no
- means exhaustive.
-
- 201 (Created) - The calendar collection resource was created in
- its entirety;
-
- 207 (Multi-Status) - The calendar collection resource was not
- created since one or more DAV:set instructions specified in the
- request body could not be processed successfully. The following
- are examples of response codes one would expect to be used in a
- 207 (Multi-Status) response in this situation:
-
- 403 (Forbidden) - The client, for reasons the server chooses
- not to specify, cannot alter one of the properties;
-
- 409 (Conflict) - The client has provided a value whose
- semantics are not appropriate for the property. This includes
- trying to set read-only properties;
-
- 424 (Failed Dependency) - The DAV:set instruction on the
- specified resource would have succeeded if it were not for the
- failure of another DAV:set instruction specified in the request
- body;
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 22]
-
-Internet-Draft CalDAV September 2006
-
-
- 423 (Locked) - The specified resource is locked and the client
- either is not a lock owner or the lock type requires a lock
- token to be submitted and the client did not submit it; and
-
- 507 (Insufficient Storage) - The server did not have sufficient
- space to record the property;
-
- 403 (Forbidden) - This indicates at least one of two conditions:
- 1) the server does not allow the creation of calendar collections
- at the given location in its namespace, or 2) the parent
- collection of the Request-URI exists but cannot accept members;
-
- 409 (Conflict) - A collection cannot be made at the Request-URI
- until one or more intermediate collections have been created;
-
- 415 (Unsupported Media Type) - The server does not support the
- request type of the body; and
-
- 507 (Insufficient Storage) - The resource does not have sufficient
- space to record the state of the resource after the execution of
- this method.
-
-5.3.1.2. Example: Successful MKCALENDAR request
-
- This example creates a calendar collection called /home/lisa/
- calendars/events/ on the server cal.example.com with specific values
- for the properties DAV:displayname, CALDAV:calendar-description,
- CALDAV:supported-calendar-component-set, and CALDAV:calendar-
- timezone.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 23]
-
-Internet-Draft CalDAV September 2006
-
-
- >> Request <<
-
- MKCALENDAR /home/lisa/calendars/events/ HTTP/1.1
- Host: cal.example.com
- Content-Type: application/xml; charset="utf-8"
- Content-Length: xxxx
-
- <?xml version="1.0" encoding="utf-8" ?>
- <C:mkcalendar xmlns:D="DAV:"
- xmlns:C="urn:ietf:params:xml:ns:caldav">
- <D:set>
- <D:prop>
- <D:displayname>Lisa's Events</D:displayname>
- <C:calendar-description xml:lang="en"
- >Calendar restricted to events.</C:calendar-description>
- <C:supported-calendar-component-set>
- <C:comp name="VEVENT"/>
- </C:supported-calendar-component-set>
- <C:calendar-timezone><![CDATA[BEGIN:VCALENDAR
- PRODID:-//Example Corp.//CalDAV Client//EN
- VERSION:2.0
- BEGIN:VTIMEZONE
- TZID:US-Eastern
- LAST-MODIFIED:19870101T000000Z
- BEGIN:STANDARD
- DTSTART:19671029T020000
- RRULE:FREQ=YEARLY;BYDAY=-1SU;BYMONTH=10
- TZOFFSETFROM:-0400
- TZOFFSETTO:-0500
- TZNAME:Eastern Standard Time (US & Canada)
- END:STANDARD
- BEGIN:DAYLIGHT
- DTSTART:19870405T020000
- RRULE:FREQ=YEARLY;BYDAY=1SU;BYMONTH=4
- TZOFFSETFROM:-0500
- TZOFFSETTO:-0400
- TZNAME:Eastern Daylight Time (US & Canada)
- END:DAYLIGHT
- END:VTIMEZONE
- END:VCALENDAR
- ]]></C:calendar-timezone>
- </D:prop>
- </D:set>
- </C:mkcalendar>
-
-
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 24]
-
-Internet-Draft CalDAV September 2006
-
-
- >> Response <<
-
- HTTP/1.1 201 Created
- Cache-Control: no-cache
- Date: Fri, 11 Nov 2005 09:32:12 GMT
- Content-Length: 0
-
-5.3.2. Creating Calendar Object Resources
-
- Clients populate calendar collections with calendar object resources.
- The URL for each calendar object resource is entirely arbitrary, and
- does not need to bear a specific relationship to the calendar object
- resource's iCalendar properties or other metadata. New calendar
- 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 calendar object resource.
-
- 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. However, there is an
- HTTP feature to mitigate this. If the client intends to create a new
- non-collection resource, such as a new VEVENT, the client SHOULD use
- the HTTP request 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: *" request header ensures
- that the client will not inadvertently overwrite an existing
- resource, if the last path segment turned out to already be used.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 25]
-
-Internet-Draft CalDAV September 2006
-
-
- >> Request <<
-
- PUT /home/lisa/calendars/events/qwue23489.ics HTTP/1.1
- If-None-Match: *
- Host: cal.example.com
- Content-Type: text/calendar
- Content-Length: xxxx
-
- BEGIN:VCALENDAR
- VERSION:2.0
- PRODID:-//Example Corp.//CalDAV Client//EN
- BEGIN:VEVENT
- UID:20010712T182145Z-123401@example.com
- DTSTAMP:20060712T182145Z
- DTSTART:20060714T170000Z
- DTEND:20060715T040000Z
- SUMMARY:Bastille Day Party
- END:VEVENT
- END:VCALENDAR
-
- >> Response <<
-
- HTTP/1.1 201 Created
- Content-Length: 0
- Date: Fri, 11 Nov 2005 09:32:12 GMT
- ETag: "123456789-000-111"
-
- The request to change an existing event is the same, but with a
- specific ETag in the "If-Match" header, rather than the "If-None-
- Match" header.
-
- As indicated in Section 3.10 of [RFC2445], the URL of calendar object
- resources containing (an arbitrary set of) calendaring and scheduling
- information may be suffixed by ".ics", and the URL of calendar object
- resources containing free or busy time information may be suffixed by
- ".ifb".
-
-5.3.2.1. Additional Preconditions for PUT, COPY and MOVE
-
- This specification creates additional Preconditions for PUT, COPY and
- MOVE methods. These preconditions apply:
-
- When a PUT operation of a calendar object resource into a calendar
- collection occurs.
-
- When a COPY or MOVE operation of a calendar object resource into a
- calendar collection occurs.
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 26]
-
-Internet-Draft CalDAV September 2006
-
-
- The new preconditions are:
-
- (CALDAV:supported-calendar-data): The resource submitted in the
- PUT request, or targeted by a COPY or MOVE request MUST be a
- supported media type (i.e., iCalendar) for calendar object
- resources;
-
- (CALDAV:valid-calendar-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
- iCalendar data);
-
- (CALDAV:valid-calendar-object-resource): The resource submitted in
- the PUT request, or targeted by a COPY or MOVE request MUST obey
- all restrictions specified in Section 4.1 (e.g., calendar object
- resources MUST NOT contain more than one type of calendar
- component, calendar object resources MUST NOT specify the
- iCalendar METHOD property, etc.);
-
- (CALDAV:supported-calendar-component): The resource submitted in
- the PUT request, or targeted by a COPY or MOVE request MUST
- contain a type of calendar component that is supported in the
- targeted calendar collection;
-
- (CALDAV:no-uid-conflict): The resource submitted in the PUT
- request, or targeted by a COPY or MOVE request MUST NOT specify an
- iCalendar UID property value already in use in the targeted
- calendar collection or overwrite an existing calendar 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)>
-
- (CALDAV:calendar-collection-location-ok): In a COPY or MOVE
- request, when the Request-URI is a calendar collection, the
- Destination-URI MUST identify a location where a calendar
- collection can be created;
-
- (CALDAV:max-resource-size): The resource submitted in the PUT
- request, or targeted by a COPY or MOVE request MUST have an octet
- size less than or equal to the value of the CALDAV:max-resource-
- size property value (Section 5.2.5) on the calendar collection
- where the resource will be stored;
-
- (CALDAV:min-date-time): The resource submitted in the PUT request,
- or targeted by a COPY or MOVE request MUST have all of its
- iCalendar date or time property values (for each recurring
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 27]
-
-Internet-Draft CalDAV September 2006
-
-
- instance) greater than or equal to the value of the CALDAV:min-
- date-time property value (Section 5.2.6) on the calendar
- collection where the resource will be stored;
-
- (CALDAV:max-date-time): The resource submitted in the PUT request,
- or targeted by a COPY or MOVE request MUST have all of its
- iCalendar date or time property values (for each recurring
- instance) less than the value of the CALDAV:max-date-time property
- value (Section 5.2.7) on the calendar collection where the
- resource will be stored;
-
- (CALDAV:max-instances): The resource submitted in the PUT request,
- or targeted by a COPY or MOVE request MUST generate a number of
- recurring instances less than or equal to the value of the CALDAV:
- max-instances property value (Section 5.2.8) on the calendar
- collection where the resource will be stored;
-
- (CALDAV:max-attendees-per-instance): The resource submitted in the
- PUT request, or targeted by a COPY or MOVE request MUST have a
- number of ATTENDEE properties on any one instance less than or
- equal to the value of the CALDAV:max-attendees-per-instance
- property value (Section 5.2.9) on the calendar collection where
- the resource will be stored;
-
-5.3.3. Non-standard components, properties and parameters
-
- iCalendar provides a "standard mechanism for doing non-standard
- things". This extension support allows implementers to make use of
- non-standard components, properties and parameters whose names are
- prefixed with the text "X-".
-
- Servers MUST support the use of non-standard components, properties
- and parameters in calendar object resources stored via the PUT
- method.
-
- Servers may need to enforce rules for their own "private" components,
- 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" components, properties or parameters it uses follow the
- convention of including a vendor id in the "X-" name as described in
- Section 4.2 of [RFC2445], e.g., "X-ABC-Private".
-
-5.3.4. Calendar Object Resource Entity Tag
-
- The DAV:getetag property MUST be defined and set to a strong entity
- tag on all calendar object resources.
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 28]
-
-Internet-Draft CalDAV September 2006
-
-
- A response to a GET request targeted at a calendar object resource
- MUST contain an ETag response header field indicating the current
- value of the strong entity tag of the calendar object resource.
-
- Servers SHOULD return a strong entity tag (ETag header) in a PUT
- response when the stored calendar object resource is equivalent by
- octet equality to the calendar 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 calendar 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 calendar 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 calendar
- 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 calendar object resource (and ETag) as a basis
- for further changes, rather than use the calendar object resource it
- had sent with the PUT request.
-
-
-6. Calendaring Access Control
-
-6.1. Calendaring Privilege
-
- CalDAV 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. CalDAV servers MUST also support the calendaring
- privilege defined in this section.
-
-6.1.1. CALDAV:read-free-busy Privilege
-
- Calendar users often wish to allow other users to see their busy time
- information, without viewing the other details of the calendar
- components (e.g., location, summary, attendees). This allows a
- significant amount of privacy while still allowing other users to
- schedule meetings at times when the user is likely to be free.
-
- The CALDAV:read-free-busy privilege controls which calendar
- collections, regular collections and calendar object resources are
- examined when a CALDAV:free-busy-query REPORT request is processed
- (see Section 7.10). This privilege can be granted on calendar
- collections, regular collections or calendar object resources.
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 29]
-
-Internet-Draft CalDAV September 2006
-
-
- Servers MUST support this privilege on all calendar collections,
- regular collections and calendar object resources.
-
-
- <!ELEMENT read-free-busy EMPTY>
-
- The CALDAV:read-free-busy privilege MUST be aggregated in the DAV:
- read privilege. Servers MUST allow the CALDAV:read-free-busy to be
- granted without the DAV:read privilege being granted.
-
- Clients should note that when only the CALDAV:read-free-busy
- privilege has been granted on a resource, this does not imply access
- to GET, HEAD, OPTIONS and PROPFIND on the resource -- those
- operations are governed by the DAV:read privilege.
-
-6.2. Additional Principal Property
-
- This section defines an additional property for WebDAV principal
- resources as defined in [RFC3744].
-
-6.2.1. CALDAV:calendar-home-set Property
-
- Name: calendar-home-set
-
- Namespace: urn:ietf:params:xml:ns:caldav
-
- Purpose: Identifies the URL of any WebDAV collections that contain
- calendar collections owned by the associated principal resource.
-
- Conformance: This property SHOULD be defined on a principal resource.
- If defined, it MAY be protected and SHOULD NOT be returned by a
- PROPFIND DAV:allprop request (as defined in Section 12.14.1 of
- [RFC2518]).
-
- Description: The CALDAV:calendar-home-set property is meant to allow
- users to easily find the calendar collections owned by the
- principal. Typically, users will group all the calendar
- collections that they own under a common collection. This
- property specifies the URL of collections that either are calendar
- collections or ordinary collections that have child or descendant
- calendar collections owned by the principal.
-
- Definition:
-
- <!ELEMENT calendar-home-set (DAV:href*)>
-
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 30]
-
-Internet-Draft CalDAV September 2006
-
-
- Example:
-
- <C:calendar-home-set xmlns:D="DAV:"
- xmlns:C="urn:ietf:params:xml:ns:caldav">
- <D:href>http://cal.example.com/home/bernard/calendars/</D:href>
- </C:calendar-home-set>
-
-
-7. Calendaring Reports
-
- This section defines the REPORTs that CalDAV servers MUST support on
- calendar collections and calendar object resources.
-
- CalDAV servers MUST advertise support for these REPORTs on all
- calendar collections and calendar object resources with the DAV:
- supported-report-set property defined in Section 3.1.5 of [RFC3253].
- CalDAV servers MAY also advertise support for these REPORTs on
- ordinary collections.
-
- Some of these REPORTs allow calendar data (from possibly multiple
- resources) to be returned.
-
-7.1. REPORT Method
-
- The REPORT method (defined in Section 3.6 of [RFC3253]) provides an
- extensible mechanism for obtaining information about one or more
- resources. 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.
-
- CalDAV servers MUST support the DAV:expand-property REPORT defined in
- Section 3.8 of [RFC3253].
-
-7.2. Ordinary collections
-
- Servers MAY support the REPORTs defined in this document on ordinary
- collections (collections that are not calendar collections) in
- addition to calendar collections or calendar object resources. In
- computing responses to the REPORTs on ordinary collections, servers
- MUST only consider calendar object resources contained in calendar
- collections that are targeted by the REPORT based on the value of the
- Depth request header.
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 31]
-
-Internet-Draft CalDAV September 2006
-
-
-7.3. Date and floating time
-
- iCalendar provides a way to specify DATE and DATE-TIME values that
- are not bound to any time zone in particular, hereafter called
- "floating date" and "floating time" respectively. These values are
- used to represent the same day, hour, minute and second value
- regardless of which time zone is being observed. For instance, the
- DATE value "20051111", represents November 11th, 2005 in no specific
- time zone, while the DATE-TIME value "20051111T111100" represents
- November 11th, 2005 at 11:11 AM in no specific time zone.
-
- CalDAV servers may need to convert "floating date" and "floating
- time" values in date with UTC time values in the processing of
- calendaring REPORT requests.
-
- For the CALDAV:calendar-query REPORT, CalDAV servers MUST rely on the
- value of the CALDAV:timezone XML element, if specified as part of the
- request body, to perform the proper conversion of "floating date" and
- "floating time" values to date with UTC time values. If the CALDAV:
- timezone XML element is not specified in the request body, CalDAV
- servers MUST rely on the value of the CALDAV:calendar-timezone
- property, if defined, else the CalDAV servers MAY rely on the time
- zone of their choice.
-
- For the CALDAV:free-busy-query REPORT, CalDAV servers MUST rely on
- the value of the CALDAV:calendar-timezone property, if defined, to
- compute the proper FREEBUSY time period value as date with UTC time,
- for calendar components scheduled with "floating date" or "floating
- time". If the CALDAV:calendar-timezone property is not defined,
- CalDAV servers MAY rely on the time zone of their choice.
-
-7.4. Time range filtering
-
- Some of the reports defined in this section can include a time range
- filter that is used to restrict the set of calendar object resources
- returned to just those that overlap the specified time range. The
- time range filter can be applied to a calendar component as a whole,
- or to specific calendar component properties with date or date-time
- value types.
-
- To determine whether a calendar object resource matches the time
- range filter element, the start and end times for the targeted
- component or property are determined and then compared to the
- requested time range. If there is an overlap with the requested time
- range, then the calendar object resource matches the filter element.
- The rules defined in [RFC2445] for determining the actual start and
- end times of calendar components MUST be used, and these are fully
- enumerated in Section 9.9 of this document.
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 32]
-
-Internet-Draft CalDAV September 2006
-
-
- When such time range filtering is used, special consideration must be
- given to recurring calendar components such as VEVENT and VTODO
- components. The server MUST expand recurring components to determine
- whether any recurrence instances overlap the specified time range.
- If one or more recurrence instances overlap the time range, then the
- calendar object resource matches the filter element.
-
-7.5. 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
- calendar data. Since iCalendar 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 [I-D.newman-i18n-comparator] to specify
- collations that may be used to carry out the text comparison
- operations with a well-defined rule.
-
- The comparisons used in CalDAV are all "substring" matches as per
- [I-D.newman-i18n-comparator] Section 4.2. Collations supported by
- the server MUST support "substring" match operations.
-
- CalDAV servers are REQUIRED to support the "i;ascii-casemap" and
- "i;octet" collations as described in [I-D.newman-i18n-comparator],
- and MAY support other collations.
-
- Servers MUST advertise the set of collations that they support via
- the CALDAV:supported-collation-set property defined on any resource
- that supports reports that use collations.
-
- Clients MUST only use collations from the list advertised by the
- server.
-
- In the absence of a collation explicitly specified by the client, or
- if the client specifies the "default" collation identifier (as
- defined in [I-D.newman-i18n-comparator] Section 3.1), the server MUST
- default to using "i;ascii-casemap" as the collation.
-
- Wildcards (as defined in [I-D.newman-i18n-comparator] 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 CALDAV:supported-collation precondition
- error response.
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 33]
-
-Internet-Draft CalDAV September 2006
-
-
-7.5.1. CALDAV:supported-collation-set Property
-
- Name: supported-collation-set
-
- Namespace: urn:ietf:params:xml:ns:caldav
-
- Purpose: Identifies the set of collations supported by the server for
- text matching operations.
-
- Conformance: This property MUST be defined on any resource that
- supports a REPORT that does text matching. If defined, it MUST be
- protected and SHOULD NOT be returned by a PROPFIND DAV:allprop
- request (as defined in Section 12.14.1 of [RFC2518]).
-
- Description: The CALDAV:supported-collation-set property contains
- zero or more CALDAV:supported-collation elements which specify the
- collection identifiers of the collations supported by the server.
-
- Definition:
-
- <!ELEMENT supported-collation-set (supported-collation*)>
- <!ELEMENT supported-collation (#PCDATA)>
-
- Example:
-
- <C:supported-collation-set
- xmlns:C="urn:ietf:params:xml:ns:caldav">
- <C:supported-collation>i;ascii-casemap</C:supported-collation>
- <C:supported-collation>i;octet</C:supported-collation>
- </C:supported-collation-set>
-
-7.6. Partial Retrieval
-
- Some calendaring REPORTs defined in this document allow partial
- retrieval of calendar object resources. A CalDAV client can specify
- what information to return in the body of a calendaring REPORT
- request.
-
- A CalDAV client can request particular WebDAV property values, all
- WebDAV property values, or a list of the names of the resource's
- WebDAV properties. A CalDAV client can also request calendar data to
- be returned and whether all calendar components and properties should
- be returned or only particular ones. See CALDAV:calendar-data in
- Section 9.6.
-
- By default, the returned calendar data will include the component
- that defines the recurrence set, referred to as the "master
- component", as well as the components that define exceptions to the
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 34]
-
-Internet-Draft CalDAV September 2006
-
-
- recurrence set, referred to as the "overridden components".
-
- A CalDAV client only interested in the recurrence instances that
- overlap a specified time range can request to receive only the
- "master component" along with the "overridden components" that impact
- the specified time range and thus limit the data returned by the
- server. See CALDAV:limit-recurrence-set in Section 9.6.6. An
- overridden component impacts a time range if its current start and
- end times overlap the time range, or if the original start and end
- times - the ones that would have been used if the instance were not
- overridden - overlap the time range.
-
- A CalDAV client with no support for recurrence properties (i.e.,
- EXDATE, EXRULE, RDATE and RRULE) and possibly VTIMEZONE components,
- or a client not willing to perform recurrence expansion because of
- limited processing capability can request to receive only the
- recurrence instances that overlap a specified time range as separate
- calendar components that each define exactly one recurrence instance.
- See CALDAV:expand in Section 9.6.5.
-
- Finally, in the case of VFREEBUSY components, a CalDAV client can
- request to receive only the FREEBUSY property values that overlap a
- specified time range. See CALDAV:limit-freebusy-set in
- Section 9.6.7.
-
-7.7. Non-standard components, properties and parameters
-
- Servers MUST support the use of non-standard component, property or
- parameter names in the CALDAV:calendar-data XML element in
- calendaring REPORT requests to allow clients to request that non-
- standard components, properties and parameters be returned in the
- calendar data provided in the response.
-
- Servers MAY support the use of non-standard component, property or
- parameter names in the CALDAV:comp-filter, CALDAV:prop-filter and
- CALDAV:param-filter XML elements specified in the CALDAV:filter XML
- element of calendaring REPORT requests.
-
- Servers MUST fail with the CALDAV:supported-filter precondition if a
- calendaring REPORT request uses a CALDAV:comp-filter, CALDAV:prop-
- filter or CALDAV:param-filter XML element that makes reference to a
- non-standard component, property or parameter name which the server
- does not support queries on.
-
-7.8. CALDAV:calendar-query Report
-
- The CALDAV:calendar-query REPORT performs a search for all calendar
- object resources that match a specified filter. The response of this
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 35]
-
-Internet-Draft CalDAV September 2006
-
-
- REPORT will contain all the WebDAV properties and calendar object
- resource data specified in the request. In the case of the CALDAV:
- calendar-data XML element, one can explicitly specify the calendar
- components and properties that should be returned in the calendar
- 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 CALDAV:calendar-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 property results. For instance, a
- request to retrieve the value of a 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 CALDAV:calendar-query REPORT is REQUIRED.
-
- Marshalling:
-
- The request body MUST be a CALDAV:calendar-query XML element as
- defined in Section 9.5.
-
- The request MAY include a Depth header. If no Depth header is
- included, Depth:0 is assumed.
-
- 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 CALDAV:calendar-query REPORT
- request MUST contain a DAV:response element for each iCalendar
- object that matched the search filter. Calendar data is being
- returned in the CALDAV:calendar-data XML element inside the DAV:
- propstat XML element.
-
- Preconditions:
-
- (CALDAV:supported-calendar-data): The attributes "content-type"
- and "version" of the CALDAV:calendar-data XML element (see
- Section 9.6) specify a media type supported by the server for
- calendar object resources.
-
- (CALDAV:valid-filter): The CALDAV:filter XML element (see
- Section 9.7) specified in the REPORT request MUST be valid. For
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 36]
-
-Internet-Draft CalDAV September 2006
-
-
- instance, a CALDAV:filter cannot nest a <C:comp name="VEVENT">
- element in a <C:comp name="VTODO"> element, or a CALDAV:filter
- cannot nest a <C:time-range start="..." end="..."> element in a
- <C:prop name="SUMMARY"> element.
-
- (CALDAV:supported-filter): The CALDAV:comp-filter (see
- Section 9.7.1), CALDAV:prop-filter (see Section 9.7.2) and CALDAV:
- param-filter (see Section 9.7.3) XML elements used in the CALDAV:
- filter XML element (see Section 9.7) in the REPORT request only
- make reference to components, properties and parameters for which
- queries are supported by the server. i.e., if the CALDAV:filter
- element attempts to reference an unsupported component, property
- or parameter, this precondition is violated. Servers SHOULD
- report the CALDAV:comp-filter, CALDAV:prop-filter or CALDAV:param-
- filter for which it does not provide support.
-
- <!ELEMENT supported-filter (comp-filter*,
- prop-filter*,
- param-filter*)>
-
- (CALDAV:valid-calendar-data): The time zone specified in the
- REPORT request MUST be a valid iCalendar object containing a
- single valid VTIMEZONE component.
-
- (CALDAV:min-date-time): Any XML element specifying a range of time
- MUST have its start or end date or time values greater than or
- equal to the value of the CALDAV:min-date-time property value
- (Section 5.2.6) on the calendar collections being targeted by the
- REPORT;
-
- (CALDAV:max-date-time): Any XML element specifying a range of time
- MUST have its start or end date or time values less than or equal
- to the value of the CALDAV:max-date-time property value
- (Section 5.2.7) on the calendar collections being targeted by the
- REPORT;
-
- (CALDAV:supported-collation): Any XML attribute specifying a
- collation MUST specify a collation supported by the server as
- described in Section 7.5.
-
- Postconditions:
-
- (DAV:number-of-matches-within-limits): The number of matching
- calendar 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.
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 37]
-
-Internet-Draft CalDAV September 2006
-
-
-7.8.1. Example: Partial retrieval of events by time range
-
- In this example, the client requests the server to return specific
- components and properties of the VEVENT components that overlap the
- time range from January 4th, 2006 at 00:00:00 AM UTC to January 5th,
- 2006 at 00:00:00 AM UTC. In addition the DAV:getetag property is
- also requested and returned as part of the response. Note that the
- first calendar object returned is a recurring event whose first
- instance lies outside of the requested time range, but whose third
- instance does overlap the time range. Note that due to the CALDAV:
- calendar-data element restrictions, the DTSTAMP property in VEVENT
- components has not been returned, and the only property returned in
- the VCALENDAR object is VERSION.
-
- See Appendix B for the calendar data being targeted by this example.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 38]
-
-Internet-Draft CalDAV September 2006
-
-
- >> Request <<
-
- REPORT /bernard/work/ HTTP/1.1
- Host: cal.example.com
- Depth: 1
- Content-Type: application/xml; charset="utf-8"
- Content-Length: xxxx
-
- <?xml version="1.0" encoding="utf-8" ?>
- <C:calendar-query xmlns:D="DAV:"
- xmlns:C="urn:ietf:params:xml:ns:caldav">
- <D:prop>
- <D:getetag/>
- <C:calendar-data>
- <C:comp name="VCALENDAR">
- <C:prop name="VERSION"/>
- <C:comp name="VEVENT">
- <C:prop name="SUMMARY"/>
- <C:prop name="UID"/>
- <C:prop name="DTSTART"/>
- <C:prop name="DTEND"/>
- <C:prop name="DURATION"/>
- <C:prop name="RRULE"/>
- <C:prop name="RDATE"/>
- <C:prop name="EXRULE"/>
- <C:prop name="EXDATE"/>
- <C:prop name="RECURRENCE-ID"/>
- </C:comp>
- <C:comp name="VTIMEZONE"/>
- </C:comp>
- </C:calendar-data>
- </D:prop>
- <C:filter>
- <C:comp-filter name="VCALENDAR">
- <C:comp-filter name="VEVENT">
- <C:time-range start="20060104T000000Z"
- end="20060105T000000Z"/>
- </C:comp-filter>
- </C:comp-filter>
- </C:filter>
- </C:calendar-query>
-
- >> Response <<
-
- HTTP/1.1 207 Multi-Status
- Date: Fri, 11 Nov 2005 09:32:12 GMT
- Content-Type: application/xml; charset="utf-8"
- Content-Length: xxxx
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 39]
-
-Internet-Draft CalDAV September 2006
-
-
- <?xml version="1.0" encoding="utf-8" ?>
- <D:multistatus xmlns:D="DAV:"
- xmlns:C="urn:ietf:params:xml:ns:caldav">
- <D:response>
- <D:href>http://cal.example.com/bernard/work/abcd2.ics</D:href>
- <D:propstat>
- <D:prop>
- <D:getetag>"fffff-abcd2"</D:getetag>
- <C:calendar-data>BEGIN:VCALENDAR
- VERSION:2.0
- 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
- DTSTART;TZID=US/Eastern:20060102T120000
- DURATION:PT1H
- RRULE:FREQ=DAILY;COUNT=5
- SUMMARY:Event #2
- UID:00959BC664CA650E933C892C@example.com
- END:VEVENT
- BEGIN:VEVENT
- DTSTART;TZID=US/Eastern:20060104T140000
- DURATION:PT1H
- RECURRENCE-ID;TZID=US/Eastern:20060104T120000
- SUMMARY:Event #2 bis
- UID:00959BC664CA650E933C892C@example.com
- END:VEVENT
- BEGIN:VEVENT
- DTSTART;TZID=US/Eastern:20060106T140000
- DURATION:PT1H
- RECURRENCE-ID;TZID=US/Eastern:20060106T120000
- SUMMARY:Event #2 bis bis
- UID:00959BC664CA650E933C892C@example.com
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 40]
-
-Internet-Draft CalDAV September 2006
-
-
- END:VEVENT
- END:VCALENDAR
- </C:calendar-data>
- </D:prop>
- <D:status>HTTP/1.1 200 OK</D:status>
- </D:propstat>
- </D:response>
- <D:response>
- <D:href>http://cal.example.com/bernard/work/abcd3.ics</D:href>
- <D:propstat>
- <D:prop>
- <D:getetag>"fffff-abcd3"</D:getetag>
- <C:calendar-data>BEGIN:VCALENDAR
- VERSION:2.0
- PRODID:-//Example Corp.//CalDAV 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
- DTSTART;TZID=US/Eastern:20060104T100000
- DURATION:PT1H
- SUMMARY:Event #3
- UID:DC6C50A017428C5216A2F1CD@example.com
- END:VEVENT
- END:VCALENDAR
- </C:calendar-data>
- </D:prop>
- <D:status>HTTP/1.1 200 OK</D:status>
- </D:propstat>
- </D:response>
- </D:multistatus>
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 41]
-
-Internet-Draft CalDAV September 2006
-
-
-7.8.2. Example: Partial retrieval of recurring events
-
- In this example, the client requests the server to return VEVENT
- components that overlap the time range from January 3rd, 2006 at 00:
- 00:00 AM UTC to January 5th, 2006 at 00:00:00 AM UTC. Use of the
- CALDAV:limit-recurrence-set element causes the server to only return
- overridden recurrence components that overlap the time range
- specified in that element, or that affect other instances that
- overlap the time range (e.g., in the case of a "THISANDFUTURE"
- behavior). In this example the first overridden component in the
- matching resource is returned but the second one is not.
-
- See Appendix B for the calendar data being targeted by this example.
-
- >> Request <<
-
- REPORT /bernard/work/ HTTP/1.1
- Host: cal.example.com
- Depth: 1
- Content-Type: application/xml; charset="utf-8"
- Content-Length: xxxx
-
- <?xml version="1.0" encoding="utf-8" ?>
- <C:calendar-query xmlns:D="DAV:"
- xmlns:C="urn:ietf:params:xml:ns:caldav">
- <D:prop>
- <C:calendar-data>
- <C:limit-recurrence-set start="20060103T000000Z"
- end="20060105T000000Z"/>
- </C:calendar-data>
- </D:prop>
- <C:filter>
- <C:comp-filter name="VCALENDAR">
- <C:comp-filter name="VEVENT">
- <C:time-range start="20060103T000000Z"
- end="20060105T000000Z"/>
- </C:comp-filter>
- </C:comp-filter>
- </C:filter>
- </C:calendar-query>
-
- >> Response <<
-
- HTTP/1.1 207 Multi-Status
- Date: Fri, 11 Nov 2006 09:32:12 GMT
- Content-Type: application/xml; charset="utf-8"
- Content-Length: xxxx
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 42]
-
-Internet-Draft CalDAV September 2006
-
-
- <?xml version="1.0" encoding="utf-8" ?>
- <D:multistatus xmlns:D="DAV:"
- xmlns:C="urn:ietf:params:xml:ns:caldav">
- <D:response>
- <D:href>http://cal.example.com/bernard/work/abcd2.ics</D:href>
- <D:propstat>
- <D:prop>
- <D:getetag>"fffff-abcd2"</D:getetag>
- <C:calendar-data>BEGIN:VCALENDAR
- VERSION:2.0
- PRODID:-//Example Corp.//CalDAV 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
- SUMMARY:Event #2
- UID:00959BC664CA650E933C892C@example.com
- END:VEVENT
- BEGIN:VEVENT
- DTSTAMP:20060206T001121Z
- DTSTART;TZID=US/Eastern:20060104T140000
- DURATION:PT1H
- RECURRENCE-ID;TZID=US/Eastern:20060104T120000
- SUMMARY:Event #2 bis
- UID:00959BC664CA650E933C892C@example.com
- END:VEVENT
- END:VCALENDAR
- </C:calendar-data>
- </D:prop>
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 43]
-
-Internet-Draft CalDAV September 2006
-
-
- <D:status>HTTP/1.1 200 OK</D:status>
- </D:propstat>
- </D:response>
- <D:response>
- <D:href>http://cal.example.com/bernard/work/abcd3.ics</D:href>
- <D:propstat>
- <D:prop>
- <D:getetag>"fffff-abcd3"</D:getetag>
- <C:calendar-data>BEGIN:VCALENDAR
- VERSION:2.0
- PRODID:-//Example Corp.//CalDAV 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
- ATTENDEE;PARTSTAT=ACCEPTED;ROLE=CHAIR:mailto:cyrus@example.com
- ATTENDEE;PARTSTAT=NEEDS-ACTION:mailto:lisa@example.com
- DTSTAMP:20060206T001220Z
- DTSTART;TZID=US/Eastern:20060104T100000
- DURATION:PT1H
- LAST-MODIFIED:20060206T001330Z
- ORGANIZER:mailto:cyrus@example.com
- SEQUENCE:1
- STATUS:TENTATIVE
- SUMMARY:Event #3
- UID:DC6C50A017428C5216A2F1CD@example.com
- X-ABC-GUID:E1CX5Dr-0007ym-Hz@example.com
- END:VEVENT
- END:VCALENDAR
- </C:calendar-data>
- </D:prop>
- <D:status>HTTP/1.1 200 OK</D:status>
- </D:propstat>
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 44]
-
-Internet-Draft CalDAV September 2006
-
-
- </D:response>
- </D:multistatus>
-
-7.8.3. Example: Expanded retrieval of recurring events
-
- In this example, the client requests the server to return VEVENT
- components that overlap the time range from January 2nd, 2006 at 00:
- 00:00 AM UTC to January 5th, 2006 at 00:00:00 AM UTC and to return
- recurring calendar components expanded into individual recurrence
- instance calendar components. Use of the CALDAV:expand element
- causes the server to only return overridden recurrence instances that
- overlap the time range specified in that element.
-
- See Appendix B for the calendar data being targeted by this example.
-
- >> Request <<
-
- REPORT /bernard/work/ HTTP/1.1
- Host: cal.example.com
- Depth: 1
- Content-Type: application/xml; charset="utf-8"
- Content-Length: xxxx
-
- <?xml version="1.0" encoding="utf-8" ?>
- <C:calendar-query xmlns:D="DAV:"
- xmlns:C="urn:ietf:params:xml:ns:caldav">
- <D:prop>
- <C:calendar-data>
- <C:expand start="20060103T000000Z"
- end="20060105T000000Z"/>
- </C:calendar-data>
- </D:prop>
- <C:filter>
- <C:comp-filter name="VCALENDAR">
- <C:comp-filter name="VEVENT">
- <C:time-range start="20060103T000000Z"
- end="20060105T000000Z"/>
- </C:comp-filter>
- </C:comp-filter>
- </C:filter>
- </C:calendar-query>
-
- >> Response <<
-
- HTTP/1.1 207 Multi-Status
- Date: Fri, 11 Nov 2006 09:32:12 GMT
- Content-Type: application/xml; charset="utf-8"
- Content-Length: xxxx
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 45]
-
-Internet-Draft CalDAV September 2006
-
-
- <?xml version="1.0" encoding="utf-8" ?>
- <D:multistatus xmlns:D="DAV:"
- xmlns:C="urn:ietf:params:xml:ns:caldav">
- <D:response>
- <D:href>http://cal.example.com/bernard/work/abcd2.ics</D:href>
- <D:propstat>
- <D:prop>
- <D:getetag>"fffff-abcd2"</D:getetag>
- <C:calendar-data>BEGIN:VCALENDAR
- VERSION:2.0
- PRODID:-//Example Corp.//CalDAV Client//EN
- BEGIN:VEVENT
- DTSTAMP:20060206T001121Z
- DTSTART:20060103T170000
- DURATION:PT1H
- RECURRENCE-ID:20060103T170000
- SUMMARY:Event #2
- UID:00959BC664CA650E933C892C@example.com
- END:VEVENT
- BEGIN:VEVENT
- DTSTAMP:20060206T001121Z
- DTSTART:20060104T190000
- DURATION:PT1H
- RECURRENCE-ID:20060104T170000
- SUMMARY:Event #2 bis
- UID:00959BC664CA650E933C892C@example.com
- END:VEVENT
- END:VCALENDAR
- </C:calendar-data>
- </D:prop>
- <D:status>HTTP/1.1 200 OK</D:status>
- </D:propstat>
- </D:response>
- <D:response>
- <D:href>http://cal.example.com/bernard/work/abcd3.ics</D:href>
- <D:propstat>
- <D:prop>
- <D:getetag>"fffff-abcd3"</D:getetag>
- <C:calendar-data>BEGIN:VCALENDAR
- VERSION:2.0
- PRODID:-//Example Corp.//CalDAV Client//EN
- BEGIN:VEVENT
- ATTENDEE;PARTSTAT=ACCEPTED;ROLE=CHAIR:mailto:cyrus@example.com
- ATTENDEE;PARTSTAT=NEEDS-ACTION:mailto:lisa@example.com
- DTSTAMP:20060206T001220Z
- DTSTART:20060104T150000
- DURATION:PT1H
- LAST-MODIFIED:20060206T001330Z
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 46]
-
-Internet-Draft CalDAV September 2006
-
-
- ORGANIZER:mailto:cyrus@example.com
- SEQUENCE:1
- STATUS:TENTATIVE
- SUMMARY:Event #3
- UID:DC6C50A017428C5216A2F1CD@example.com
- X-ABC-GUID:E1CX5Dr-0007ym-Hz@example.com
- END:VEVENT
- END:VCALENDAR
- </C:calendar-data>
- </D:prop>
- <D:status>HTTP/1.1 200 OK</D:status>
- </D:propstat>
- </D:response>
- </D:multistatus>
-
-7.8.4. Example: Partial retrieval of stored free busy components
-
- In this example, the client requests the server to return the
- VFREEBUSY components that have free busy information that overlap the
- time range from January 2nd, 2006 at 00:00:00 AM UTC (inclusively) to
- January 3rd, 2006 at 00:00:00 AM UTC (exclusively). Use of the
- CALDAV:limit-freebusy-set element causes the server to only return
- the FREEBUSY property values that overlap the time range specified in
- that element. Note that this is not an example of discovering when
- the calendar owner is busy.
-
- See Appendix B for the calendar data being targeted by this example.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 47]
-
-Internet-Draft CalDAV September 2006
-
-
- >> Request <<
-
- REPORT /bernard/work/ HTTP/1.1
- Host: cal.example.com
- Depth: 1
- Content-Type: application/xml; charset="utf-8"
- Content-Length: xxxx
-
- <?xml version="1.0" encoding="utf-8" ?>
- <C:calendar-query xmlns:D="DAV:"
- xmlns:C="urn:ietf:params:xml:ns:caldav">
- <D:prop>
- <C:calendar-data>
- <C:limit-freebusy-set start="20060102T000000Z"
- end="20060103T000000Z"/>
- </C:calendar-data>
- </D:prop>
- <C:filter>
- <C:comp-filter name="VCALENDAR">
- <C:comp-filter name="VFREEBUSY">
- <C:time-range start="20060102T000000Z"
- end="20060103T000000Z"/>
- </C:comp-filter>
- </C:comp-filter>
- </C:filter>
- </C:calendar-query>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 48]
-
-Internet-Draft CalDAV September 2006
-
-
- >> Response <<
-
- HTTP/1.1 207 Multi-Status
- Date: Fri, 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:multistatus xmlns:D="DAV:"
- xmlns:C="urn:ietf:params:xml:ns:caldav">
- <D:response>
- <D:href>http://cal.example.com/bernard/work/abcd8.ics</D:href>
- <D:propstat>
- <D:prop>
- <D:getetag>"fffff-abcd8"</D:getetag>
- <C:calendar-data>BEGIN:VCALENDAR
- VERSION:2.0
- PRODID:-//Example Corp.//CalDAV Client//EN
- BEGIN:VFREEBUSY
- ORGANIZER;CN="Bernard Desruisseaux":mailto:bernard@example.com
- UID:76ef34-54a3d2@example.com
- DTSTAMP:20050530T123421Z
- DTSTART:20060101T100000Z
- DTEND:20060108T100000Z
- FREEBUSY;FBTYPE=BUSY-TENTATIVE:20060102T100000Z/20060102T120000Z
- END:VFREEBUSY
- END:VCALENDAR
- </C:calendar-data>
- </D:prop>
- <D:status>HTTP/1.1 200 OK</D:status>
- </D:propstat>
- </D:response>
- </D:multistatus>
-
-7.8.5. Example: Retrieval of to-dos by alarm time range
-
- In this example, the client requests the server to return the VTODO
- components that have an alarm trigger scheduled in the specified time
- range.
-
- See Appendix B for the calendar data being targeted by this example.
-
-
-
-
-
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 49]
-
-Internet-Draft CalDAV September 2006
-
-
- >> Request <<
-
- REPORT /bernard/work/ HTTP/1.1
- Host: cal.example.com
- Depth: 1
- Content-Type: application/xml; charset="utf-8"
- Content-Length: xxxx
-
- <?xml version="1.0" encoding="utf-8" ?>
- <C:calendar-query xmlns:C="urn:ietf:params:xml:ns:caldav">
- <D:prop xmlns:D="DAV:">
- <D:getetag/>
- <C:calendar-data/>
- </D:prop>
- <C:filter>
- <C:comp-filter name="VCALENDAR">
- <C:comp-filter name="VTODO">
- <C:comp-filter name="VALARM">
- <C:time-range start="20060106T100000Z"
- end="20060107T100000Z"/>
- </C:comp-filter>
- </C:comp-filter>
- </C:comp-filter>
- </C:filter>
- </C:calendar-query>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 50]
-
-Internet-Draft CalDAV September 2006
-
-
- >> Response <<
-
- HTTP/1.1 207 Multi-Status
- Date: Fri, 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:multistatus xmlns:D="DAV:"
- xmlns:C="urn:ietf:params:xml:ns:caldav">
- <D:response>
- <D:href>http://cal.example.com/bernard/work/abcd4.ics</D:href>
- <D:propstat>
- <D:prop>
- <D:getetag>"fffff-abcd4"</D:getetag>
- <C:calendar-data>BEGIN:VCALENDAR
- VERSION:2.0
- PRODID:-//Example Corp.//CalDAV Client//EN
- BEGIN:VTODO
- DTSTAMP:20060205T235300Z
- DUE;TZID=US/Eastern:20060106T120000
- LAST-MODIFIED:20060205T235308Z
- SEQUENCE:1
- STATUS:NEEDS-ACTION
- SUMMARY:Task #2
- UID:E10BA47467C5C69BB74E8720@example.com
- BEGIN:VALARM
- ACTION:AUDIO
- TRIGGER;RELATED=START:-PT10M
- END:VALARM
- END:VTODO
- END:VCALENDAR
- </C:calendar-data>
- </D:prop>
- <D:status>HTTP/1.1 200 OK</D:status>
- </D:propstat>
- </D:response>
- </D:multistatus>
-
-7.8.6. Example: Retrieval of event by UID
-
- In this example, the client requests the server to return the VEVENT
- component that has the UID property set to
- "DC6C50A017428C5216A2F1CD@example.com".
-
- See Appendix B for the calendar data being targeted by this example.
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 51]
-
-Internet-Draft CalDAV September 2006
-
-
- >> Request <<
-
- REPORT /bernard/work/ HTTP/1.1
- Host: cal.example.com
- Depth: 1
- Content-Type: application/xml; charset="utf-8"
- Content-Length: xxxx
-
- <?xml version="1.0" encoding="utf-8" ?>
- <C:calendar-query xmlns:C="urn:ietf:params:xml:ns:caldav">
- <D:prop xmlns:D="DAV:">
- <D:getetag/>
- <C:calendar-data/>
- </D:prop>
- <C:filter>
- <C:comp-filter name="VCALENDAR">
- <C:comp-filter name="VEVENT">
- <C:prop-filter name="UID">
- <C:text-match collation="i;octet"
- >DC6C50A017428C5216A2F1CD@example.com</C:text-match>
- </C:prop-filter>
- </C:comp-filter>
- </C:comp-filter>
- </C:filter>
- </C:calendar-query>
-
- >> Response <<
-
- HTTP/1.1 207 Multi-Status
- Date: Fri, 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:multistatus xmlns:D="DAV:"
- xmlns:C="urn:ietf:params:xml:ns:caldav">
- <D:response>
- <D:href>http://cal.example.com/bernard/work/abcd3.ics</D:href>
- <D:propstat>
- <D:prop>
- <D:getetag>"fffff-abcd3"</D:getetag>
- <C:calendar-data>BEGIN:VCALENDAR
- VERSION:2.0
- PRODID:-//Example Corp.//CalDAV Client//EN
- BEGIN:VTIMEZONE
- LAST-MODIFIED:20040110T032845Z
- TZID:US/Eastern
- BEGIN:DAYLIGHT
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 52]
-
-Internet-Draft CalDAV September 2006
-
-
- 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
- ATTENDEE;PARTSTAT=ACCEPTED;ROLE=CHAIR:mailto:cyrus@example.com
- ATTENDEE;PARTSTAT=NEEDS-ACTION:mailto:lisa@example.com
- DTSTAMP:20060206T001220Z
- DTSTART;TZID=US/Eastern:20060104T100000
- DURATION:PT1H
- LAST-MODIFIED:20060206T001330Z
- ORGANIZER:mailto:cyrus@example.com
- SEQUENCE:1
- STATUS:TENTATIVE
- SUMMARY:Event #3
- UID:DC6C50A017428C5216A2F1CD@example.com
- X-ABC-GUID:E1CX5Dr-0007ym-Hz@example.com
- END:VEVENT
- END:VCALENDAR
- </C:calendar-data>
- </D:prop>
- <D:status>HTTP/1.1 200 OK</D:status>
- </D:propstat>
- </D:response>
- </D:multistatus>
-
-7.8.7. Example: Retrieval of events by PARTSTAT
-
- In this example, the client requests the server to return the VEVENT
- components that have the ATTENDEE property with the value
- "mailto:lisa@example.com" and for which the PARTSTAT parameter is set
- to "NEEDS-ACTION".
-
- See Appendix B for the calendar data being targeted by this example.
-
-
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 53]
-
-Internet-Draft CalDAV September 2006
-
-
- >> Request <<
-
- REPORT /bernard/work/ HTTP/1.1
- Host: cal.example.com
- Depth: 1
- Content-Type: application/xml; charset="utf-8"
- Content-Length: xxxx
-
- <?xml version="1.0" encoding="utf-8" ?>
- <C:calendar-query xmlns:C="urn:ietf:params:xml:ns:caldav">
- <D:prop xmlns:D="DAV:">
- <D:getetag/>
- <C:calendar-data/>
- </D:prop>
- <C:filter>
- <C:comp-filter name="VCALENDAR">
- <C:comp-filter name="VEVENT">
- <C:prop-filter name="ATTENDEE">
- <C:text-match collation="i;ascii-casemap"
- >mailto:lisa@example.com</C:text-match>
- <C:param-filter name="PARTSTAT">
- <C:text-match collation="i;ascii-casemap"
- >NEEDS-ACTION</C:text-match>
- </C:param-filter>
- </C:prop-filter>
- </C:comp-filter>
- </C:comp-filter>
- </C:filter>
- </C:calendar-query>
-
- >> Response <<
-
- HTTP/1.1 207 Multi-Status
- Date: Fri, 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:multistatus xmlns:D="DAV:"
- xmlns:C="urn:ietf:params:xml:ns:caldav">
- <D:response>
- <D:href>http://cal.example.com/bernard/work/abcd3.ics</D:href>
- <D:propstat>
- <D:prop>
- <D:getetag>"fffff-abcd3"</D:getetag>
- <C:calendar-data>BEGIN:VCALENDAR
- VERSION:2.0
- PRODID:-//Example Corp.//CalDAV Client//EN
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 54]
-
-Internet-Draft CalDAV September 2006
-
-
- 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
- ATTENDEE;PARTSTAT=ACCEPTED;ROLE=CHAIR:mailto:cyrus@example.com
- ATTENDEE;PARTSTAT=NEEDS-ACTION:mailto:lisa@example.com
- DTSTAMP:20060206T001220Z
- DTSTART;TZID=US/Eastern:20060104T100000
- DURATION:PT1H
- LAST-MODIFIED:20060206T001330Z
- ORGANIZER:mailto:cyrus@example.com
- SEQUENCE:1
- STATUS:TENTATIVE
- SUMMARY:Event #3
- UID:DC6C50A017428C5216A2F1CD@example.com
- X-ABC-GUID:E1CX5Dr-0007ym-Hz@example.com
- END:VEVENT
- END:VCALENDAR
- </C:calendar-data>
- </D:prop>
- <D:status>HTTP/1.1 200 OK</D:status>
- </D:propstat>
- </D:response>
- </D:multistatus>
-
-7.8.8. Example: Retrieval of events only
-
- In this example, the client requests the server to return all VEVENT
- components.
-
- See Appendix B for the calendar data being targeted by this example.
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 55]
-
-Internet-Draft CalDAV September 2006
-
-
- >> Request <<
-
- REPORT /bernard/work/ HTTP/1.1
- Host: cal.example.com
- Depth: 1
- Content-Type: application/xml; charset="utf-8"
- Content-Length: xxxx
-
- <?xml version="1.0" encoding="utf-8" ?>
- <C:calendar-query xmlns:C="urn:ietf:params:xml:ns:caldav">
- <D:prop xmlns:D="DAV:">
- <D:getetag/>
- <C:calendar-data/>
- </D:prop>
- <C:filter>
- <C:comp-filter name="VCALENDAR">
- <C:comp-filter name="VEVENT"/>
- </C:comp-filter>
- </C:filter>
- </C:calendar-query>
-
- >> Response <<
-
- HTTP/1.1 207 Multi-Status
- Date: Fri, 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:multistatus xmlns:D="DAV:"
- xmlns:C="urn:ietf:params:xml:ns:caldav">
- <D:response>
- <D:href>http://cal.example.com/bernard/work/abcd1.ics</D:href>
- <D:propstat>
- <D:prop>
- <D:getetag>"fffff-abcd1"</D:getetag>
- <C:calendar-data>BEGIN:VCALENDAR
- VERSION:2.0
- PRODID:-//Example Corp.//CalDAV 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
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 56]
-
-Internet-Draft CalDAV September 2006
-
-
- 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:20060206T001102Z
- DTSTART;TZID=US/Eastern:20060102T100000
- DURATION:PT1H
- SUMMARY:Event #1
- Description:Go Steelers!
- UID:74855313FA803DA593CD579A@example.com
- END:VEVENT
- END:VCALENDAR
- </C:calendar-data>
- </D:prop>
- <D:status>HTTP/1.1 200 OK</D:status>
- </D:propstat>
- </D:response>
- <D:response>
- <D:href>http://cal.example.com/bernard/work/abcd2.ics</D:href>
- <D:propstat>
- <D:prop>
- <D:getetag>"fffff-abcd2"</D:getetag>
- <C:calendar-data>BEGIN:VCALENDAR
- VERSION:2.0
- PRODID:-//Example Corp.//CalDAV 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
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 57]
-
-Internet-Draft CalDAV September 2006
-
-
- END:VTIMEZONE
- BEGIN:VEVENT
- DTSTAMP:20060206T001121Z
- DTSTART;TZID=US/Eastern:20060102T120000
- DURATION:PT1H
- RRULE:FREQ=DAILY;COUNT=5
- SUMMARY:Event #2
- UID:00959BC664CA650E933C892C@example.com
- END:VEVENT
- BEGIN:VEVENT
- DTSTAMP:20060206T001121Z
- DTSTART;TZID=US/Eastern:20060104T140000
- DURATION:PT1H
- RECURRENCE-ID;TZID=US/Eastern:20060104T120000
- SUMMARY:Event #2 bis
- UID:00959BC664CA650E933C892C@example.com
- END:VEVENT
- BEGIN:VEVENT
- DTSTAMP:20060206T001121Z
- DTSTART;TZID=US/Eastern:20060106T140000
- DURATION:PT1H
- RECURRENCE-ID;TZID=US/Eastern:20060106T120000
- SUMMARY:Event #2 bis bis
- UID:00959BC664CA650E933C892C@example.com
- END:VEVENT
- END:VCALENDAR
- </C:calendar-data>
- </D:prop>
- <D:status>HTTP/1.1 200 OK</D:status>
- </D:propstat>
- </D:response>
- <D:response>
- <D:href>http://cal.example.com/bernard/work/abcd3.ics</D:href>
- <D:propstat>
- <D:prop>
- <D:getetag>"fffff-abcd3"</D:getetag>
- <C:calendar-data>BEGIN:VCALENDAR
- VERSION:2.0
- PRODID:-//Example Corp.//CalDAV 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
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 58]
-
-Internet-Draft CalDAV September 2006
-
-
- 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
- ATTENDEE;PARTSTAT=ACCEPTED;ROLE=CHAIR:mailto:cyrus@example.com
- ATTENDEE;PARTSTAT=NEEDS-ACTION:mailto:lisa@example.com
- DTSTAMP:20060206T001220Z
- DTSTART;TZID=US/Eastern:20060104T100000
- DURATION:PT1H
- LAST-MODIFIED:20060206T001330Z
- ORGANIZER:mailto:cyrus@example.com
- SEQUENCE:1
- STATUS:TENTATIVE
- SUMMARY:Event #3
- UID:DC6C50A017428C5216A2F1CD@example.com
- X-ABC-GUID:E1CX5Dr-0007ym-Hz@example.com
- END:VEVENT
- END:VCALENDAR
- </C:calendar-data>
- </D:prop>
- <D:status>HTTP/1.1 200 OK</D:status>
- </D:propstat>
- </D:response>
- </D:multistatus>
-
-7.8.9. Example: Retrieval of all pending to-dos
-
- In this example, the client requests the server to return all VTODO
- components that do not include a "COMPLETED" property and do not have
- a "STATUS" property value matching "CANCELLED". i.e., VTODOs that
- still need to be worked on.
-
- See Appendix B for the calendar data being targeted by this example.
-
-
-
-
-
-
-
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 59]
-
-Internet-Draft CalDAV September 2006
-
-
- >> Request <<
-
- REPORT /bernard/work/ HTTP/1.1
- Host: cal.example.com
- Depth: 1
- Content-Type: application/xml; charset="utf-8"
- Content-Length: xxxx
-
- <?xml version="1.0" encoding="utf-8" ?>
- <C:calendar-query xmlns:C="urn:ietf:params:xml:ns:caldav">
- <D:prop xmlns:D="DAV:">
- <D:getetag/>
- <C:calendar-data/>
- </D:prop>
- <C:filter>
- <C:comp-filter name="VCALENDAR">
- <C:comp-filter name="VTODO">
- <C:prop-filter name="COMPLETED">
- <C:is-not-defined/>
- </C:prop-filter>
- <C:prop-filter name="STATUS">
- <C:text-match
- negate-condition="yes">CANCELLED</c:text-match>
- </C:prop-filter>
- </C:comp-filter>
- </C:comp-filter>
- </C:filter>
- </C:calendar-query>
-
- >> Response <<
-
- HTTP/1.1 207 Multi-Status
- Date: Fri, 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:multistatus xmlns:D="DAV:"
- xmlns:C="urn:ietf:params:xml:ns:caldav">
- <D:response>
- <D:href>http://cal.example.com/bernard/work/abcd4.ics</D:href>
- <D:propstat>
- <D:prop>
- <D:getetag>"fffff-abcd4"</D:getetag>
- <C:calendar-data>BEGIN:VCALENDAR
- VERSION:2.0
- PRODID:-//Example Corp.//CalDAV Client//EN
- BEGIN:VTODO
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 60]
-
-Internet-Draft CalDAV September 2006
-
-
- DTSTAMP:20060205T235335Z
- DUE;VALUE=DATE:20060104
- STATUS:NEEDS-ACTION
- SUMMARY:Task #1
- UID:DDDEEB7915FA61233B861457@example.com
- BEGIN:VALARM
- ACTION:AUDIO
- TRIGGER;RELATED=START:-PT10M
- END:VALARM
- END:VTODO
- END:VCALENDAR
- </C:calendar-data>
- </D:prop>
- <D:status>HTTP/1.1 200 OK</D:status>
- </D:propstat>
- </D:response>
-
- <D:response>
- <D:href>http://cal.example.com/bernard/work/abcd5.ics</D:href>
- <D:propstat>
- <D:prop>
- <D:getetag>"fffff-abcd5"</D:getetag>
- <C:calendar-data>BEGIN:VCALENDAR
- VERSION:2.0
- PRODID:-//Example Corp.//CalDAV Client//EN
- BEGIN:VTODO
- DTSTAMP:20060205T235300Z
- DUE;VALUE=DATE:20060106
- LAST-MODIFIED:20060205T235308Z
- SEQUENCE:1
- STATUS:NEEDS-ACTION
- SUMMARY:Task #2
- UID:E10BA47467C5C69BB74E8720@example.com
- BEGIN:VALARM
- ACTION:AUDIO
- TRIGGER;RELATED=START:-PT10M
- END:VALARM
- END:VTODO
- END:VCALENDAR
- </C:calendar-data>
- </D:prop>
- <D:status>HTTP/1.1 200 OK</D:status>
- </D:propstat>
- </D:response>
- </D:multistatus>
-
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 61]
-
-Internet-Draft CalDAV September 2006
-
-
-7.8.10. Example: Attempt to query unsupported property
-
- In this example, the client requests the server to return all VEVENT
- components that include an "X-ABC-GUID" property with a value
- matching "ABC". However, the server does not support querying that
- non-standard property and instead returns and error response.
-
- See Appendix B for the calendar data being targeted by this example.
-
- >> Request <<
-
- REPORT /bernard/work/ HTTP/1.1
- Host: cal.example.com
- Depth: 1
- Content-Type: application/xml; charset="utf-8"
- Content-Length: xxxx
-
- <?xml version="1.0" encoding="utf-8" ?>
- <C:calendar-query xmlns:C="urn:ietf:params:xml:ns:caldav">
- <D:prop xmlns:D="DAV:">
- <D:getetag/>
- <C:calendar-data/>
- </D:prop>
- <C:filter>
- <C:comp-filter name="VCALENDAR">
- <C:comp-filter name="VEVENT">
- <C:prop-filter name="X-ABC-GUID">
- <C:text-match>ABC</C:text-match>
- </C:prop-filter>
- </C:comp-filter>
- </C:comp-filter>
- </C:filter>
- </C:calendar-query>
-
- >> Response <<
-
- HTTP/1.1 403 Forbidden
- Date: Fri, 11 Nov 2005 09:32:12 GMT
- Content-Type: application/xml; charset="utf-8"
- Content-Length: xxxx
-
- <?xml version="1.0" encoding="utf-8" ?>
- <D:error>
- <C:supported-filter>
- <C:prop-filter name="X-ABC-GUID"/>
- </C:supported-filter>
- </D:error>
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 62]
-
-Internet-Draft CalDAV September 2006
-
-
-7.9. CALDAV:calendar-multiget Report
-
- The CALDAV:calendar-multiget REPORT is used to retrieve specific
- calendar object resources from within a collection, if the Request-
- URI is a collection, or to retrieve a specific calendar object
- resource, if the Request-URI is a calendar object resource. This
- REPORT is similar to the CALDAV:calendar-query REPORT (see
- Section 7.8), except that it takes a list of DAV:href elements
- instead of a CALDAV:filter element to determine which calendar object
- resources to return.
-
- Support for the calendar-multiget REPORT is REQUIRED.
-
- Marshalling:
-
- The request body MUST be a CALDAV:calendar-multiget XML element
- (see Section 9.10). If the Request-URI is a collection resource,
- then the DAV:href elements MUST refer to calendar object resources
- within that collection, and they MAY refer to calendar object
- resources at any depth within the collection. As a result the
- "Depth" header MUST be ignored by the server and SHOULD NOT be
- sent by the client. If the Request-URI refers to a non-collection
- resource, then there MUST be a single DAV:href element that is
- equivalent to the Request-URI.
-
- The response body for a successful request MUST be a DAV:
- multistatus XML element.
-
- The response body for a successful CALDAV:calendar-multiget REPORT
- request MUST contain a DAV:response element for each calendar
- object resource referenced by the provided set of DAV:href
- elements. Calendar data is being returned in the CALDAV:calendar-
- 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:
-
- (CALDAV:supported-calendar-data): The attributes "content-type"
- and "version" of the CALDAV:calendar-data XML elements (see
- Section 9.6) specify a media type supported by the server for
- calendar object resources.
-
- (CALDAV:min-date-time): Any XML element specifying a range of time
- MUST have its start or end date or time values greater than or
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 63]
-
-Internet-Draft CalDAV September 2006
-
-
- equal to the value of the CALDAV:min-date-time property value
- (Section 5.2.6) on the calendar collections being targeted by the
- REPORT;
-
- (CALDAV:max-date-time): Any XML element specifying a range of time
- MUST have its start or end date or time values less than or equal
- to the value of the CALDAV:max-date-time property value
- (Section 5.2.7) on the calendar collections being targeted by the
- REPORT;
-
- Postconditions:
-
- None.
-
-7.9.1. Example: Successful CALDAV:calendar-multiget Report
-
- In this example, the client requests the server to return specific
- properties of the VEVENT 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://cal.example.com/bernard/work/mtg1.ics does not exist,
- resulting in an error status response.
-
- See Appendix B for the calendar data being targeted by this example.
-
- >> Request <<
-
- REPORT /bernard/work/ HTTP/1.1
- Host: cal.example.com
- Content-Type: application/xml; charset="utf-8"
- Content-Length: xxxx
-
- <?xml version="1.0" encoding="utf-8" ?>
- <C:calendar-multiget xmlns:D="DAV:"
- xmlns:C="urn:ietf:params:xml:ns:caldav">
- <D:prop>
- <D:getetag/>
- <C:calendar-data/>
- </D:prop>
- <D:href>/bernard/work/abcd1.ics</D:href>
- <D:href>/bernard/work/mtg1.ics</D:href>
- </C:calendar-multiget>
-
- >> Response <<
-
- HTTP/1.1 207 Multi-Status
- Date: Fri, 11 Nov 2006 09:32:12 GMT
- Content-Type: application/xml; charset="utf-8"
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 64]
-
-Internet-Draft CalDAV September 2006
-
-
- Content-Length: xxxx
-
- <?xml version="1.0" encoding="utf-8" ?>
- <D:multistatus xmlns:D="DAV:"
- xmlns:C="urn:ietf:params:xml:ns:caldav">
- <D:response>
- <D:href>http://cal.example.com/bernard/work/abcd1.ics</D:href>
- <D:propstat>
- <D:prop>
- <D:getetag>"fffff-abcd1"</D:getetag>
- <C:calendar-data>BEGIN:VCALENDAR
- VERSION:2.0
- PRODID:-//Example Corp.//CalDAV 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:20060206T001102Z
- DTSTART;TZID=US/Eastern:20060102T100000
- DURATION:PT1H
- SUMMARY:Event #1
- Description:Go Steelers!
- UID:74855313FA803DA593CD579A@example.com
- END:VEVENT
- END:VCALENDAR
- </C:calendar-data>
- </D:prop>
- <D:status>HTTP/1.1 200 OK</D:status>
- </D:propstat>
- </D:response>
- <D:response>
- <D:href>http://cal.example.com/bernard/work/mtg1.ics</D:href>
- <D:status>HTTP/1.1 404 Not Found</D:status>
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 65]
-
-Internet-Draft CalDAV September 2006
-
-
- </D:response>
- </D:multistatus>
-
-7.10. CALDAV:free-busy-query Report
-
- The CALDAV:free-busy-query REPORT generates a VFREEBUSY component
- containing free busy information for all the calendar object
- resources targeted by the request and which have the CALDAV:read-
- free-busy or DAV:read privilege granted to the current user.
-
- Only VEVENT components without a TRANSP property or with the TRANSP
- property set to "OPAQUE", and VFREEBUSY components SHOULD be
- considered to generate the free busy time information.
-
- In the case of VEVENT components, the free or busy time type (FBTYPE)
- of the FREEBUSY properties in the returned VFREEBUSY component SHOULD
- be derived from the value of the TRANSP and STATUS properties as
- outlined in the table below:
-
- +---------------------------++------------------+
- | VEVENT || VFREEBUSY |
- +-------------+-------------++------------------+
- | TRANSP | STATUS || FBTYPE |
- +=============+=============++==================+
- | | CONFIRMED || BUSY |
- | | (default) || |
- | OPAQUE +-------------++------------------+
- | (default) | CANCELLED || FREE |
- | +-------------++------------------+
- | | TENTATIVE || BUSY-TENTATIVE |
- | +-------------++------------------+
- | | x-name || BUSY or |
- | | || x-name |
- +-------------+-------------++------------------+
- | | CONFIRMED || |
- | TRANSPARENT | CANCELLED || FREE |
- | | TENTATIVE || |
- | | x-name || |
- +-------------+-------------++------------------+
-
- Duplicate busy time periods with the same FBTYPE parameter value
- SHOULD NOT be specified in the returned VFREEBUSY component. Servers
- SHOULD coalesce consecutive or overlapping busy time period of the
- same type. Busy time periods with different FBTYPE parameter values
- MAY overlap.
-
- Support for the CALDAV:free-busy-query REPORT is REQUIRED.
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 66]
-
-Internet-Draft CalDAV September 2006
-
-
- Marshalling:
-
- The request body MUST be a CALDAV:free-busy-query XML element (see
- Section 9.11, which MUST contain exactly one CALDAV:time-range XML
- element, as defined in Section 9.9.
-
- The request MAY include a Depth header. If no Depth header is
- included, Depth:0 is assumed.
-
- The response body for a successful request MUST be an iCalendar
- object that contains exactly one VFREEBUSY component that
- describes the busy time intervals for the calendar object
- resources containing VEVENT or VFREEBUSY components that satisfy
- the Depth value and for which the current user is at least granted
- the CALDAV:read-free-busy privilege. If no calendar object
- resources are found to satisfy these conditions a VFREEBUSY
- component with no FREEBUSY property MUST be returned. This REPORT
- only returns busy time information. Free time information can be
- inferred from the returned busy time information.
-
- If the current user is not granted the CALDAV:read-free-busy or
- DAV:read privileges on the Request-URI, the CALDAV:free-busy-query
- REPORT request MUST fail and return a 404 (Not Found) status
- value. This restriction will prevent users from discovering URLs
- of resources for which they are only granted the CALDAV:read-free-
- busy privilege.
-
- The CALDAV:free-busy-query REPORT request can only be run against
- a collection (either a regular collection or a calendar
- collection). An attempt to run the report on a calendar object
- resource MUST fail and return a 403 (Forbidden) status value.
-
- Preconditions:
-
- None.
-
- Postconditions:
-
- (DAV:number-of-matches-within-limits): The number of matching
- calendar object resources must fall within server-specific,
- predefined limits. For example, this postcondition might fail if
- the specified CALDAV:time-range would cause an extremely large
- number calendar object resources to be considered to compute the
- response.
-
-
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 67]
-
-Internet-Draft CalDAV September 2006
-
-
-7.10.1. Example: Successful CALDAV:free-busy-query Report
-
- In this example, the client requests the server to return free busy
- information on the calendar collection /bernard/work/, between 9:00
- AM and 5:00 PM EST (2:00 PM and 10:00 PM UTC) on the 4th January
- 2006. The server responds indicating two busy time intervals of one
- hour, one of which is tentative.
-
- See Appendix B for the calendar data being targeted by this example.
-
- >> Request <<
-
- REPORT /bernard/work/ HTTP/1.1
- Host: cal.example.com
- Depth: 1
- Content-Type: application/xml; charset="utf-8"
- Content-Length: xxxx
-
- <?xml version="1.0" encoding="utf-8" ?>
- <C:free-busy-query xmlns:C="urn:ietf:params:xml:ns:caldav">
- <C:time-range start="20060104T140000Z"
- end="20060105T220000Z"/>
- </C:free-busy-query>
-
- >> Response <<
-
- HTTP/1.1 200 OK
- Date: Fri, 11 Nov 2006 09:32:12 GMT
- Content-Type: text/calendar
- Content-Length: xxxx
-
- BEGIN:VCALENDAR
- VERSION:2.0
- PRODID:-//Example Corp.//CalDAV Server//EN
- BEGIN:VFREEBUSY
- DTSTAMP:20050125T090000Z
- DTSTART:20060104T140000Z
- DTEND:20060105T220000Z
- FREEBUSY;FBTYPE=BUSY-TENTATIVE:20060104T150000Z/PT1H
- FREEBUSY:20060104T190000Z/PT1H
- END:VFREEBUSY
- END:VCALENDAR
-
-
-8. Guidelines
-
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 68]
-
-Internet-Draft CalDAV September 2006
-
-
-8.1. Client-to-client Interoperability
-
- There are a number of actions clients can take which will be legal
- (the server will not return errors) but which can degrade
- interoperability with other client implementations accessing the same
- data. For example, a recurrence rule could be replaced with a set of
- recurrence dates, a single recurring event could be replaced with a
- set of independent resources to represent each recurrence, or the
- start/end time values can be translated from the original time zone
- to another time zone. Although this advice amounts to iCalendar
- interoperability best practices and is not limited only to CalDAV
- usage, interoperability problems are likely to be more evident in
- CalDAV use cases.
-
-8.2. Synchronization Operations
-
- WebDAV already provides functionality required to synchronize a
- collection or set of collections, make changes offline, and a simple
- way to resolve conflicts when reconnected. ETags are the key to
- making this work, but these are not required of all WebDAV servers.
- Since offline functionality is more important to calendar
- applications than to some other WebDAV applications, CalDAV servers
- MUST support ETags as specified in Section 5.3.4.
-
-8.2.1. Use of Reports
-
-8.2.1.1. Restrict the Time Range
-
- The REPORTs provided in CalDAV can be used by clients to optimize
- their performance in terms of network bandwidth usage, and resource
- consumption on the local client machine. Both are certainly major
- considerations for mobile or handheld devices with limited capacity,
- but they are also relevant to desktop client applications in cases
- where the calendar collections contain large amounts of data.
-
- Typically clients present calendar data to users in views that span a
- finite time interval, so whenever possible clients should only
- retrieve calendar components from the server using CALDAV:calendar-
- query REPORT combined with a CALDAV:time-range element to limit the
- set of returned components to just those needed to populate the
- current view.
-
-8.2.1.2. Synchronize by Time Range
-
- Typically in a calendar, historical data (events, to-dos etc. that
- have completed prior to the current date) do not change, though they
- may be deleted. As a result, a client can speed up the
- synchronization process by only considering data for the present time
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 69]
-
-Internet-Draft CalDAV September 2006
-
-
- and the future up to a reasonable limit (e.g., one week, one month).
- If the user then tries to examine a portion of the calendar outside
- of the range that has been synchronized, the client can perform
- another synchronization operation on the new time interval being
- examined. This "just-in-time" synchronization can minimize bandwidth
- for common user interaction behaviors.
-
-8.2.1.3. Synchronization Process
-
- If a client wants to support calendar data synchronization, as
- opposed to downloading calendar data each time it is needed, it needs
- to cache the calendar object resource's URI and ETag along with the
- actual calendar data. While the URI remains static for the lifetime
- of the calendar object resource, the ETag will change with each
- successive change to the calendar object resource. Thus to
- synchronize a local data cache with the server, the client can first
- fetch the URI/ETag pairs for the time interval being considered, and
- compare those results with the cached data. Any cached component
- whose ETag differs from that on the server needs to be refreshed.
-
- In order to properly detect the changes between the server and client
- data, the client will need to keep a record of which calendar object
- resources have been created, changed or deleted since the last
- synchronization operation so that it can reconcile those changes with
- the data on the server.
-
- Here's an example of how to do that:
-
- The client issues a CALDAV:calendar-query REPORT request for a
- specific time range, and asks for only the DAV:getetag property to be
- returned:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 70]
-
-Internet-Draft CalDAV September 2006
-
-
- REPORT /bernard/work/ HTTP/1.1
- Host: cal.example.com
- Depth: 1
- Content-Type: application/xml; charset="utf-8"
- Content-Length: xxxx
-
- <?xml version="1.0" encoding="utf-8" ?>
- <C:calendar-query xmlns:D="DAV:"
- xmlns:C="urn:ietf:params:xml:ns:caldav">
- <D:prop>
- <D:getetag/>
- </D:prop>
- <C:filter>
- <C:comp-filter name="VCALENDAR">
- <C:comp-filter name="VEVENT">
- <C:time-range start="20040902T000000Z"
- end="20040903T000000Z"/>
- </C:comp-filter>
- </C:comp-filter>
- </C:filter>
- </C:calendar-query>
-
- The client then uses the results to determine which calendar object
- resources have changed, been created or deleted on the server and how
- those relate to locally cached calendar object resources that may
- have changed, been created or deleted. If the client determines that
- there are calendar object resources on the server that need to be
- fetched, the client issues a CALDAV:calendar-multiget REPORT request
- to fetch their calendar data:
-
- REPORT /bernard/work/ HTTP/1.1
- Host: cal.example.com
- Content-Type: application/xml; charset="utf-8"
- Content-Length: xxxx
-
- <?xml version="1.0" encoding="utf-8" ?>
- <C:calendar-multiget xmlns:D="DAV:"
- xmlns:C="urn:ietf:params:xml:ns:caldav">
- <D:prop>
- <D:getetag/>
- <C:calendar-data/>
- </D:prop>
- <D:href>/bernard/work/abcd1.ics</D:href>
- <D:href>/bernard/work/mtg1.ics</D:href>
- </C:calendar-multiget>
-
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 71]
-
-Internet-Draft CalDAV September 2006
-
-
-8.2.2. Restrict the Properties Returned
-
- Clients may not need all the calendar properties of a calendar object
- resource when presenting information to the user. Since some
- calendar property values can be large (e.g., ATTACH or ATTENDEE)
- clients can choose to restrict the calendar properties to be returned
- in a calendaring REPORT request to those it knows it will use.
-
- However, if a client needs to make a change to a calendar object
- resource, it can only change the entire calendar object resource via
- a PUT request. There is currently no way to incrementally make a
- change to a set of calendar properties of a calendar object resource.
- As a result the client will have to get the entire calendar object
- resource that is being changed.
-
-8.3. Use of Locking
-
- WebDAV locks can be used to prevent two clients modifying the same
- resource from either overwriting each others' changes (though that
- problem can also be solved by using ETags) or wasting time making
- changes that will conflict with another set of changes. In a multi-
- user calendar system, an interactive calendar client could lock an
- event while the user is editing the event, and unlock the event when
- the user finishes or cancels. Locks can also be used to prevent
- changes while data is being reorganized. For example, a calendar
- client might lock two calendar collections prior to moving a bunch of
- calendar resources from one to another.
-
- Clients are responsible for requesting a lock timeout period that is
- appropriate to the use case. When the user explicitly decides to
- reserve a resource and prevent other changes, a long timeout might be
- appropriate, but in cases when the client automatically decides to
- lock the resource the timeout should be short (and the client can
- always refresh the lock should it need to). A short lock timeout
- means that if the client is unable to remove the lock, the other
- calendar users aren't prevented from making changes.
-
-8.4. Finding calendars
-
- Much of the time a calendar client (or agent) will discover a new
- calendar's location by being provided directly with the URL. E.g., a
- user will type his or her own calendar location into client
- configuration information, or copy and paste a URL from email into
- the calendar application. The client need only confirm that the URL
- points to a resource which is a calendar collection. The client may
- also be able to browse WebDAV collections to find calendar
- collections.
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 72]
-
-Internet-Draft CalDAV September 2006
-
-
- The choice of HTTP URLs means that calendar object resources are
- backward compatible with existing software, but does have the
- disadvantage that existing software does not usually know to look at
- the OPTIONS response to that URL to determine what can be done with
- it. This is somewhat of a barrier for WebDAV usage as well as with
- CalDAV usage. This specification does not offer a way through this
- other than making the information available in the OPTIONS response
- should this be requested.
-
- For calendar sharing and scheduling use cases, one might wish to find
- the calendar belonging to another user. If the other user has a
- calendar in the same repository, that calendar can be found by using
- the principal namespace required by WebDAV ACL support. For other
- cases, the authors have no universal solution but implementers can
- consider whether to use vCard [RFC2426] or LDAP [RFC4511] standards
- together with calendar attributes [RFC2739].
-
- Because CalDAV requires servers to support WebDAV ACL [RFC3744]
- including principal namespaces, and with the addition of the CALDAV:
- calendar-home-set property, there are a couple options for CalDAV
- clients to find one's own calendar or another user's calendar.
-
- In this case, a DAV:principal-match REPORT is used to find a named
- property (the CALDAV:calendar-home-set) on the Principal-URL of the
- current user. Using this, a WebDAV client can learn "who am I" and
- "where are my calendars". The REPORT request body looks like this:
-
- <?xml version="1.0" encoding="utf-8" ?>
- <D:principal-match xmlns:D="DAV:">
- <D:self/>
- <D:prop>
- <C:calendar-home-set
- xmlns:C="urn:ietf:params:xml:ns:caldav"/>
- </D:prop>
- </D:principal-match>
-
- To find other users calendars, the DAV:principal-property-search
- REPORT can be used to filter on some properties and return others.
- To search for a calendar owned by a user named "Laurie", the REPORT
- request body would look like this:
-
-
-
-
-
-
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 73]
-
-Internet-Draft CalDAV September 2006
-
-
- <?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:calendar-home-set
- xmlns:C="urn:ietf:params:xml:ns:caldav"/>
- <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 calendars for each of these.
-
-8.5. Storing and Using Attachments
-
- CalDAV clients MAY create attachments in calendar components either
- as inline or external. This section contains some guidelines on
- creating and managing attachments.
-
-8.5.1. Inline attachments
-
- CalDAV clients MUST support inline attachments as specified in
- iCalendar [RFC2445]. CalDAV servers MUST support inline attachments,
- so clients can rely on being able to create attachments this way. On
- the other hand, inline attachments have some drawbacks:
-
- o Servers MAY impose limitations on the size of calendar object
- resources (i.e., refusing PUT requests of very large iCalendar
- objects). Servers that do that MUST use the CALDAV:max-resource-
- size property on a calendar collection to inform the client as to
- what the limitation is (see Section 5.2.5).
-
- o Servers MAY impose storage quota limitations on calendar
- collections (See [RFC4331]).
-
- o Any change to a calendar object resource containing an attachment
- requires the entire attachment to be re-uploaded.
-
- o Clients synchronizing a changed calendar object resource have to
- download the entire calendar object resource even if the
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 74]
-
-Internet-Draft CalDAV September 2006
-
-
- attachment is unchanged.
-
-8.5.2. External attachments
-
- CalDAV clients SHOULD support downloading of external attachments
- referenced by arbitrary URI schemes, by either processing them
- directly, or by passing the attachment URI to a suitable "helper
- application" for processing, if such an application exists. CalDAV
- clients MUST support downloading of external attachments referenced
- by the "http" or "https" URI schemes. An external attachment could
- be:
-
- o In a collection in the calendar collection containing the calendar
- object resource;
-
- o Somewhere else in the same repository that hosts the calendar
- collection; or
-
- o On an HTTP or FTP server elsewhere.
-
- CalDAV servers MAY provide support for child collections in calendar
- collections. CalDAV servers MAY allow the MKCOL method to create
- child collections in calendar collections. Child collections of
- calendar collections MAY contain any type of resource except calendar
- collections which they MUST NOT contain. Some CalDAV servers won't
- allow child collections in calendar collections, and it may be
- possible on such a server to discover other locations where
- attachments can be stored.
-
- Clients are entirely responsible for maintaining reference
- consistency with calendar components that link to external
- attachments. A client deleting a calendar component with an external
- attachment might therefore also delete the attachment if that's
- appropriate, however appropriateness can be very hard to determine.
- A new component might easily reference some pre-existing Web resource
- which is intended to have independent existence from the calendar
- component (the "attachment" could be a major proposal to be discussed
- in a meeting, for instance). Best practices will probably emerge and
- should probably be documented but for now clients should be wary of
- engaging in aggressive "cleanup" of external attachments. A client
- could involve the user in making decisions about removing
- unreferenced documents, or a client could be conservative in only
- deleting attachments it had created.
-
- Also, clients are responsible for consistency of permissions when
- using external attachments. One reason for servers to support the
- storage of attachments within child collections of calendar
- collections is that ACL inheritance might make it easier to grant the
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 75]
-
-Internet-Draft CalDAV September 2006
-
-
- same permissions to attachments that are granted on the calendar
- collection. Otherwise, it can be very difficult to keep permissions
- synchronized. With attachments stored on separate repositories, it
- can be impossible to keep permissions consistent -- the two
- repositories may not support the same permissions or have the same
- set of principals. Some systems have used tickets or other anonymous
- access control mechanisms to provide partially satisfactory solutions
- to these kinds of problems.
-
-8.6. Storing and Using Alarms
-
- Note that all CalDAV calendar collections (including those which the
- user might treat as public or group calendars) can contain alarm
- information on events and to-dos. Users can synchronize a calendar
- between multiple devices and decide to have alarms execute on a
- different device than the device that created the alarm. Not all
- alarm action types are completely interoperable (e.g., those which
- name a sound file to play).
-
- When the action is "AUDIO", and the client is configured to
- execute the alarm, the client SHOULD play the suggested sound if
- it's available or play another sound, but SHOULD NOT rewrite the
- alarm just to replace the suggested sound with a sound that's
- locally available.
-
- When the action is "DISPLAY", and the client is configured to
- execute the alarm, the client SHOULD execute a display alarm by
- displaying either according to the suggested description or some
- reasonable replacement, but SHOULD NOT rewrite the alarm for its
- own convenience.
-
- When the action is "EMAIL", and the client is incapable of sending
- email, it SHOULD ignore the alarm but MUST continue to synchronize
- the alarm itself.
-
- This specification makes no recommendations about executing alarms
- of type PROCEDURE except to note that clients are advised to take
- care to avoid creating security holes by executing these.
-
- Non-interoperable alarm information (e.g., should somebody define a
- color to be used in a display alarm) should be put in non-standard
- properties inside the VALARM component in order to keep the basic
- alarm usable on all devices.
-
- Clients that allow changes to calendar object resources MUST
- synchronize the alarm data that already exists in the resources.
- Clients MAY execute alarms that are downloaded in this fashion,
- possibly based on user preference. If a client is only doing read
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 76]
-
-Internet-Draft CalDAV September 2006
-
-
- operations on a calendar and there is no risk of losing alarm
- information, then the client MAY discard alarm information.
-
- This specification makes no attempt to provide multi-user alarms on
- group calendars or to find out who an alarm is intended for.
- Addressing those issues might require extensions to iCalendar, for
- example to store alarms per-user or indicate which user a VALARM was
- intended for. In the meantime, clients might maximize
- interoperability by generally not uploading alarm information to
- public, group or resource calendars.
-
-
-9. XML Element Definitions
-
-9.1. CALDAV:calendar XML Element
-
- Name: calendar
-
- Namespace: urn:ietf:params:xml:ns:caldav
-
- Purpose: Specifies the resource type of a calendar collection.
-
- Description: See Section 4.2.
-
- Definition:
-
- <!ELEMENT calendar EMPTY>
-
-9.2. CALDAV:mkcalendar XML Element
-
- Name: mkcalendar
-
- Namespace: urn:ietf:params:xml:ns:caldav
-
- Purpose: Specifies a request that includes the WebDAV property values
- to be set for a calendar collection resource when it is created.
-
- Description: See Section 5.3.1.
-
- Definition:
-
- <!ELEMENT mkcalendar (DAV:set)>
-
-9.3. CALDAV:mkcalendar-response XML Element
-
-
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 77]
-
-Internet-Draft CalDAV September 2006
-
-
- Name: mkcalendar-response
-
- Namespace: urn:ietf:params:xml:ns:caldav
-
- Purpose: Specifies a response body for a successful MKCALENDAR
- request.
-
- Description: See Section 5.3.1.
-
- Definition:
-
- <!ELEMENT mkcalendar-response ANY>
-
-9.4. CALDAV:supported-collation XML Element
-
- Name: supported-collation
-
- Namespace: urn:ietf:params:xml:ns:caldav
-
- Purpose: Identifies a single collation via its collation identifier
- as defined by [I-D.newman-i18n-comparator].
-
- Description: The CALDAV:supported-collation contains the text of a
- collation identifier as described in Section 7.5.1.
-
- Definition:
-
- <!ELEMENT supported-collation (#PCDATA)>
- PCDATA value: collation identifier
-
-9.5. CALDAV:calendar-query XML Element
-
- Name: calendar-query
-
- Namespace: urn:ietf:params:xml:ns:caldav
-
- Purpose: Defines a REPORT for querying calendar object resources.
-
- Description: See Section 7.8.
-
- Definition:
-
- <!ELEMENT calendar-query ((DAV:allprop |
- DAV:propname |
- DAV:prop)?, filter, timezone?)>
-
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 78]
-
-Internet-Draft CalDAV September 2006
-
-
-9.6. CALDAV:calendar-data XML Element
-
- Name: calendar-data
-
- Namespace: urn:ietf:params:xml:ns:caldav
-
- Purpose: Used to (1) specify a supported media type for calendar
- object resources when nested in the CALDAV:supported-calendar-data
- property; (2) specify which parts of a calendar object resource
- should be returned by a given calendaring REPORT; and (3) specify
- the content of a calendar object resource in a response to a
- calendaring REPORT.
-
- Description: When nested in the CALDAV:supported-calendar-data
- property, the CALDAV:calendar-data XML element specifies a media
- type supported by the CalDAV server for calendar object resources.
-
- When used in a calendaring REPORT request, the CALDAV:calendar-
- data XML element specifies which parts of calendar object
- resources need to be returned in the response. If the CALDAV:
- calendar-data XML element doesn't contain any CALDAV:comp element,
- calendar object resources will be returned in their entirety.
-
- Finally, when used in a calendaring REPORT response, the CALDAV:
- calendar-data XML element specifies the content of a calendar
- 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 calendar object
- resources specified in the CALDAV:calendar-data XML element.
- Furthermore, calendar object resources specified in the CALDAV:
- calendar-data XML element MAY be invalid per their media type
- specification if the CALDAV:calendar-data XML element part of the
- calendaring REPORT request did not specify required properties
- (e.g., UID, DTSTAMP, etc.) or specified a CALDAV:prop XML element
- with the "novalue" attribute set to "yes".
-
- Note: The CALDAV:calendar-data XML element is specified in requests
- and responses inside the DAV:prop XML element as if it were a
- WebDAV property. However, the CALDAV:calendar-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 iCalendar data embedded within the CALDAV:calendar-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
- iCalendar data cannot contain the character sequence "]]>" which
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 79]
-
-Internet-Draft CalDAV September 2006
-
-
- is the end delimiter for the CDATA section.
-
- Definition:
-
- <!ELEMENT calendar-data ((comp?, (expand |
- limit-recurrence-set)?,
- limit-freebusy-set?) |
- #PCDATA)?>
- PCDATA value: iCalendar object
-
- <!ATTLIST calendar-data content-type CDATA "text/calendar">
- version CDATA "2.0">
- content-type value: a MIME media type
- version value: a version string
-
-9.6.1. CALDAV:comp XML Element
-
- Name: comp
-
- Namespace: urn:ietf:params:xml:ns:caldav
-
- Purpose: Defines which component types to return.
-
- Description: The name value is a calendar component name (e.g.,
- "VEVENT").
-
- Definition:
-
- <!ELEMENT comp ((allprop | prop*), (allcomp | comp*))>
-
- <!ATTLIST comp name CDATA #REQUIRED>
- name value: a calendar component name
-
- Note: The CALDAV:prop and CALDAV:allprop elements have the same name
- as the DAV:prop and DAV:allprop elements defined in [RFC2518].
- However, the CALDAV:prop and CALDAV:allprop element are defined in
- the "urn:ietf:params:xml:ns:caldav" namespace instead of the
- "DAV:" namespace.
-
-9.6.2. CALDAV:allcomp XML Element
-
- Name: allcomp
-
- Namespace: urn:ietf:params:xml:ns:caldav
-
-
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 80]
-
-Internet-Draft CalDAV September 2006
-
-
- Purpose: Specifies that all components shall be returned.
-
- Description: The CALDAV:allcomp XML element can be used when the
- client wants all types of components returned by a calendaring
- REPORT request.
-
- Definition:
-
- <!ELEMENT allcomp EMPTY>
-
-9.6.3. CALDAV:allprop XML Element
-
- Name: allprop
-
- Namespace: urn:ietf:params:xml:ns:caldav
-
- Purpose: Specifies that all properties shall be returned.
-
- Description: The CALDAV:allprop XML element can be used when the
- client wants all properties of components returned by a
- calendaring REPORT request.
-
- Definition:
-
- <!ELEMENT allprop EMPTY>
-
- Note: The CALDAV:allprop element has the same name as the DAV:allprop
- element defined in [RFC2518]. However, the CALDAV:allprop element
- is defined in the "urn:ietf:params:xml:ns:caldav" namespace
- instead of the "DAV:" namespace.
-
-9.6.4. CALDAV:prop XML Element
-
- Name: prop
-
- Namespace: urn:ietf:params:xml:ns:caldav
-
- Purpose: Defines which properties to return in the response.
-
- Description: The "name" attribute specifies the name of the calendar
- property to return (e.g., "ATTENDEE"). 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 iCalendar
- property name and any iCalendar parameters and a trailing ":"
- without the subsequent value data.
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 81]
-
-Internet-Draft CalDAV September 2006
-
-
- Definition:
-
- <!ELEMENT prop EMPTY>
-
- <!ATTLIST prop name CDATA #REQUIRED
- novalue (yes | no) "no">
- name value: a calendar property name
- novalue value: "yes" or "no"
-
- Note: The CALDAV:prop element has the same name as the DAV:prop
- element defined in [RFC2518]. However, the CALDAV:prop element is
- defined in the "urn:ietf:params:xml:ns:caldav" namespace instead
- of the "DAV:" namespace.
-
-9.6.5. CALDAV:expand XML Element
-
- Name: expand
-
- Namespace: urn:ietf:params:xml:ns:caldav
-
- Purpose: Forces the server to expand recurring components into
- individual recurrence instances.
-
- Description: The CALDAV:expand XML element specifies that for a given
- calendaring REPORT request the server MUST expand the recurrence
- set into calendar components that define exactly one recurrence
- instance and MUST return only those whose scheduled time intersect
- a specified time range. The "start" attribute specifies the
- inclusive start of the time range, and the "end" attribute
- specifies the non-inclusive end of the time range. Both
- attributes are specified as date with UTC time value. The value
- of the "end" attribute MUST be greater than the value of the
- "start" attribute. The server MUST use the same logic as defined
- for CALDAV:time-range to determine if a recurrence instance
- intersects the specified time range. Recurring components, other
- than the initial instance, MUST include a RECURRENCE-ID property
- indicating which instance they refer to. The returned calendar
- components MUST NOT use recurrence properties (i.e., EXDATE,
- EXRULE, RDATE and RRULE) and MUST NOT have reference to or include
- VTIMEZONE components. Date and local time with reference to time
- zone information MUST be converted into date with UTC time.
-
- Definition:
-
-
-
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 82]
-
-Internet-Draft CalDAV September 2006
-
-
- <!ELEMENT expand EMPTY>
-
- <!ATTLIST expand start CDATA #REQUIRED
- end CDATA #REQUIRED>
- start value: an iCalendar "date with UTC time"
- end value: an iCalendar "date with UTC time"
-
-9.6.6. CALDAV:limit-recurrence-set XML Element
-
- Name: limit-recurrence-set
-
- Namespace: urn:ietf:params:xml:ns:caldav
-
- Purpose: Specifies a time range to limit the set of "overridden
- components" returned by the server.
-
- Description: The CALDAV:limit-recurrence-set XML element specifies
- that for a given calendaring REPORT request the server MUST
- return, in addition to the "master component", only the
- "overridden components" that impact a specified time range. An
- overridden component impacts a time range if its current start and
- end times overlap the time range, or if the original start and end
- times - the ones that would have been used if the instance were
- not overridden - overlap the time range. The "start" attribute
- specifies the inclusive start of the time range, and the "end"
- attribute specifies the non-inclusive end of the time range. Both
- attributes are specified as date with UTC time value. The value
- of the "end" attribute MUST be greater than the value of the
- "start" attribute. The server MUST use the same logic as defined
- for CALDAV:time-range to determine if the current or original
- scheduled time of an "overridden" recurrence instance intersect
- the specified time range. Overridden components that have a RANGE
- parameter on their RECURRENCE-ID property may specify one or more
- instances in the recurrence set, and some of those instances may
- fall within the specified time range, or may have originally
- fallen within the specified time range prior to being overridden.
- If that is the case, the overridden component MUST be included in
- the results as it has a direct impact on the interpretation of
- instances within the specified time range.
-
- Definition:
-
- <!ELEMENT limit-recurrence-set EMPTY>
-
- <!ATTLIST limit-recurrence-set start CDATA #REQUIRED
- end CDATA #REQUIRED>
- start value: an iCalendar "date with UTC time"
- end value: an iCalendar "date with UTC time"
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 83]
-
-Internet-Draft CalDAV September 2006
-
-
-9.6.7. CALDAV:limit-freebusy-set XML Element
-
- Name: limit-freebusy-set
-
- Namespace: urn:ietf:params:xml:ns:caldav
-
- Purpose: Specifies a time range to limit the set of FREEBUSY values
- returned by the server.
-
- Description: The CALDAV:limit-freebusy-set XML element specifies that
- for a given calendaring REPORT request the server MUST only return
- the FREEBUSY property values of a VFREEBUSY component that
- intersect a specified time range. The "start" attribute specifies
- the inclusive start of the time range, and the "end" attribute
- specifies the non-inclusive end of the time range. Both
- attributes are specified as "date with UTC time" value. The value
- of the "end" attribute MUST be greater than the value of the
- "start" attribute. The server MUST use the same logic as defined
- for CALDAV:time-range to determine if a FREEBUSY property value
- intersect the specified time range.
-
- Definition:
-
- <!ELEMENT limit-freebusy-set EMPTY>
-
- <!ATTLIST limit-freebusy-set start CDATA #REQUIRED
- end CDATA #REQUIRED>
- start value: an iCalendar "date with UTC time"
- end value: an iCalendar "date with UTC time"
-
-9.7. CALDAV:filter XML Element
-
- Name: filter
-
- Namespace: urn:ietf:params:xml:ns:caldav
-
- Purpose: Specifies a filter to limit the set of calendar components
- returned by the server.
-
- Description: The CALDAV:filter XML element specifies the search
- filter used to limit the calendar components returned by a
- calendaring REPORT request.
-
- Definition:
-
- <!ELEMENT filter (comp-filter)>
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 84]
-
-Internet-Draft CalDAV September 2006
-
-
-9.7.1. CALDAV:comp-filter XML Element
-
- Name: comp-filter
-
- Namespace: urn:ietf:params:xml:ns:caldav
-
- Purpose: Specifies search criteria on calendar components.
-
- Description: The CALDAV:comp-filter XML element specifies the queried
- calendar component type (e.g., "VEVENT"). A calendar object
- resource is said to match a CALDAV:comp-filter if:
-
- * A component of the type specified by the "name" attribute
- exists, and the CALDAV:comp-filter is empty, or it contains at
- least one recurrence instance scheduled to overlap a given time
- range if a CALDAV:time-range XML element is specified, and that
- any CALDAV:prop-filter and CALDAV:comp-filter child elements
- also match.
-
- or:
-
- * A component of the type specified by the "name" attribute does
- not exist, and the CALDAV:is-not-defined element is specified.
-
- Definition:
-
- <!ELEMENT comp-filter (is-not-defined | (time-range?,
- prop-filter*, comp-filter*))>
-
- <!ATTLIST comp-filter name CDATA #REQUIRED>
- name value: a calendar component name (e.g., "VEVENT")
-
-9.7.2. CALDAV:prop-filter XML Element
-
- Name: prop-filter
-
- Namespace: urn:ietf:params:xml:ns:caldav
-
- Purpose: Specifies search criteria on calendar properties.
-
- Description: The CALDAV:prop-filter XML element specifies a search
- criteria on a specific calendar property (e.g., CATEGORIES) in the
- scope of a given CALDAV:comp-filter. A calendar component is said
- to match a CALDAV:prop-filter if:
-
- * A property of the type specified by the "name" attribute
- exists, and the CALDAV:prop-filter is empty, or it matches the
- CALDAV:time-range XML element or CALDAV:text-match conditions
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 85]
-
-Internet-Draft CalDAV September 2006
-
-
- if specified, and that any CALDAV:param-filter child elements
- also match.
-
- or:
-
- * A property of the type specified by the "name" attribute does
- not exist, and the CALDAV:is-not-defined element is specified.
-
- Definition:
-
- <!ELEMENT prop-filter ((is-not-defined |
- ((time-range | text-match)?,
- param-filter*))>
-
- <!ATTLIST prop-filter name CDATA #REQUIRED>
- name value: a calendar property name (e.g., "ATTENDEE")
-
-9.7.3. CALDAV:param-filter XML Element
-
- Name: param-filter
-
- Namespace: urn:ietf:params:xml:ns:caldav
-
- Purpose: Limits the search to specific parameter values.
-
- Description: The CALDAV:param-filter XML element specifies a search
- criteria on a specific calendar property parameter (e.g.,
- PARTSTAT) in the scope of a given CALDAV:prop-filter. A calendar
- property is said to match a CALDAV:param-filter if:
-
- * A parameter of the type specified by the "name" attribute
- exists, and the CALDAV:param-filter is empty, or it matches the
- CALDAV:text-match conditions if specified.
-
- or:
-
- * A parameter of the type specified by the "name" attribute does
- not exist, and the CALDAV: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., "PARTSTAT")
-
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 86]
-
-Internet-Draft CalDAV September 2006
-
-
-9.7.4. CALDAV:is-not-defined XML Element
-
- Name: is-not-defined
-
- Namespace: urn:ietf:params:xml:ns:caldav
-
- Purpose: Specifies that a match should occur if the enclosing
- component, property or parameter does not exist.
-
- Description: The CALDAV:is-not-defined XML element specifies that a
- match occurs if the enclosing component, property or parameter
- value specified in a calendaring REPORT request does not exist in
- the calendar data being tested.
-
- Definition:
-
- <!ELEMENT is-not-defined EMPTY>
-
-9.7.5. CALDAV:text-match XML Element
-
- Name: text-match
-
- Namespace: urn:ietf:params:xml:ns:caldav
-
- Purpose: Specifies a substring match on a property or parameter
- value.
-
- Description: The CALDAV:text-match XML element specifies text used
- for a substring match against the property or parameter value
- specified in a calendaring 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;ascii-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 STATUS property not set to
- CANCELLED.
-
- Definition:
-
-
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 87]
-
-Internet-Draft CalDAV September 2006
-
-
- <!ELEMENT text-match (#PCDATA)>
- PCDATA value: string
-
- <!ATTLIST text-match collation CDATA "i;ascii-casemap"
- negate-condition (yes | no) "no">
-
-9.8. CALDAV:timezone XML Element
-
- Name: timezone
-
- Namespace: urn:ietf:params:xml:ns:caldav
-
- Purpose: Specifies the time zone component to use when determining
- the results of a report.
-
- Description: The CALDAV:timezone XML element specifies that for a
- given calendaring REPORT request the server MUST rely on the
- specified VTIMEZONE component instead of the CALDAV:calendar-
- timezone property of the calendar collection in which the calendar
- object resource is contained to resolve "date" values and "date
- with local time" values (i.e., floating time) to "date with UTC
- time" values. The server will require this information to
- determine if a calendar component scheduled with "date" values or
- "date with local time" values intersect a CALDAV:time-range
- specified in a CALDAV:calendar-query REPORT.
-
- Note: The iCalendar data embedded within the CALDAV:timezone 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
- iCalendar data cannot contain the character sequence "]]>" which
- is the end delimiter for the CDATA section.
-
- Definition:
-
- <!ELEMENT timezone (#PCDATA)>
- PCDATA value: an iCalendar object with exactly one VTIMEZONE
-
-9.9. CALDAV:time-range XML Element
-
- Name: time-range
-
- Namespace: urn:ietf:params:xml:ns:caldav
-
- Purpose: Specifies a time range to limit the set of calendar
- components returned by the server.
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 88]
-
-Internet-Draft CalDAV September 2006
-
-
- Description: The CALDAV:time-range XML element specifies that for a
- given calendaring REPORT request the server MUST only return the
- calendar object resources that, depending on the context, have a
- component or property whose value intersect a specified time
- range. The "start" attribute specifies the inclusive start of the
- time range, and the "end" attribute specifies the non-inclusive
- end of the time range. Both attributes MUST be specified as "date
- with UTC time" value. Time ranges open at one end can be
- specified by including only one attribute, however at least one
- attribute MUST always be present in the CALDAV:time-range element.
- If either the "start" or "end" attribute is not specified in the
- CALDAV:time-range XML element, assume "-infinity" and "+infinity"
- as their value respectively. If both "start" and "end" are
- present, the value of the "end" attribute MUST be greater than the
- value of the "start" attribute.
-
- Time range tests MUST consider every recurrence instance when
- testing the time range condition - if any one instance matches,
- then the test returns true. Testing recurrence instances requires
- the server to infer an effective value for DTSTART, DTEND,
- DURATION and DUE properties for an instance based on the
- recurrence patterns and any overrides.
-
- A VEVENT component overlaps a given time range if the condition
- for the corresponding component state specified in the table below
- is satisfied. Note that as specified in [RFC2445] the DTSTART
- property is REQUIRED in the VEVENT component. The conditions
- depend on the presence of the DTEND and DURATION properties in the
- VEVENT component. Furthermore, the value of the DTEND property
- MUST be later in time than the value of the DTSTART property. The
- duration of a VEVENT component with no DTEND and DURATION
- properties is 1 day (+P1D) when the DTSTART is a DATE value, and 0
- seconds when the DTSTART is a DATE-TIME value.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 89]
-
-Internet-Draft CalDAV September 2006
-
-
- +---------------------------------------------------------------+
- | VEVENT has the DTEND property? |
- | +-----------------------------------------------------------+
- | | VEVENT has the DURATION property? |
- | | +-------------------------------------------------------+
- | | | DURATION property value is greater than 0 seconds? |
- | | | +---------------------------------------------------+
- | | | | DTSTART property is a DATE-TIME value |
- | | | | +-----------------------------------------------+
- | | | | | Condition to evaluate |
- +---+---+---+---+-----------------------------------------------+
- | Y | N | N | * | (start < DTEND AND end > DTSTART) |
- +---+---+---+---+-----------------------------------------------+
- | N | Y | Y | * | (start < DTSTART+DURATION AND end > DTSTART) |
- | | +---+---+-----------------------------------------------+
- | | | N | * | (start <= DTSTART AND end > DTSTART) |
- +---+---+---+---+-----------------------------------------------+
- | N | N | N | Y | (start <= DTSTART AND end > DTSTART) |
- +---+---+---+---+-----------------------------------------------+
- | N | N | N | N | (start < DTSTART+P1D AND end > DTSTART) |
- +---+---+---+---+-----------------------------------------------+
-
- A VTODO component is said to overlap a given time range if the
- condition for the corresponding component state specified in the
- table below is satisfied. The conditions depend on the presence
- of the DTSTART, DURATION, DUE, COMPLETED and CREATED properties in
- the VTODO component. Note that as specified in [RFC2445] the DUE
- value MUST be a DATE-TIME value equal to or after the DTSTART
- value, if specified.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 90]
-
-Internet-Draft CalDAV September 2006
-
-
- +-------------------------------------------------------------------+
- | VTODO has the DTSTART property? |
- | +---------------------------------------------------------------+
- | | VTODO has the DURATION property? |
- | | +-----------------------------------------------------------+
- | | | VTODO has the DUE property? |
- | | | +-------------------------------------------------------+
- | | | | VTODO has the COMPLETED property? |
- | | | | +---------------------------------------------------+
- | | | | | VTODO has the CREATED property? |
- | | | | | +-----------------------------------------------+
- | | | | | | Condition to evaluate |
- +---+---+---+---+---+-----------------------------------------------+
- | Y | Y | N | * | * | (start <= DTSTART+DURATION) AND |
- | | | | | | ((end > DTSTART) OR |
- | | | | | | (end >= DTSTART+DURATION)) |
- +---+---+---+---+---+-----------------------------------------------+
- | Y | N | Y | * | * | ((start < DUE) OR (start <= DTSTART)) |
- | | | | | | AND |
- | | | | | | ((end > DTSTART) OR (end >= DUE)) |
- +---+---+---+---+---+-----------------------------------------------+
- | Y | N | N | * | * | (start <= DTSTART) AND (end > DTSTART) |
- +---+---+---+---+---+-----------------------------------------------+
- | N | N | Y | * | * | (start < DUE) AND (end >= DUE) |
- +---+---+---+---+---+-----------------------------------------------+
- | N | N | N | Y | Y | ((start <= CREATED) OR (start <= COMPLETED))|
- | | | | | | AND |
- | | | | | | ((end >= CREATED) OR (end >= COMPLETED))|
- +---+---+---+---+---+-----------------------------------------------+
- | N | N | N | Y | N | (start <= COMPLETED) AND (end >= COMPLETED) |
- +---+---+---+---+---+-----------------------------------------------+
- | N | N | N | N | Y | (end > CREATED) |
- +---+---+---+---+---+-----------------------------------------------+
- | N | N | N | N | N | TRUE |
- +---+---+---+---+---+-----------------------------------------------+
-
- A VJOURNAL component overlaps a given time range if the condition
- for the corresponding component state specified in the table below
- is satisfied. The conditions depend on the presence of the
- DTSTART property in the VJOURNAL component and on whether the
- DTSTART is a DATE-TIME or DATE value. The effective "duration" of
- a VJOURNAL component is 1 day (+P1D) when the DTSTART is a DATE
- value, and 0 seconds when the DTSTART is a DATE-TIME value.
-
-
-
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 91]
-
-Internet-Draft CalDAV September 2006
-
-
- +----------------------------------------------------+
- | VJOURNAL has the DTSTART property? |
- | +------------------------------------------------+
- | | DTSTART property is a DATE-TIME value |
- | | +--------------------------------------------+
- | | | Condition to evaluate |
- +---+---+--------------------------------------------+
- | Y | Y | (start <= DTSTART) AND (end > DTSTART) |
- +---+---+--------------------------------------------+
- | Y | N | (start < DTSTART+P1D) AND (end > DTSTART) |
- +---+---+--------------------------------------------+
- | N | * | FALSE |
- +---+---+--------------------------------------------+
-
- A VFREEBUSY component overlaps a given time range if the condition
- for the corresponding component state specified in the table below
- is satisfied. The conditions depend on the presence in the
- VFREEBUSY component of the DTSTART and DTEND properties and any
- FREEBUSY properties in the absence of DTSTART and DTEND. Any
- DURATION property is ignored as it has a special meaning when used
- in a VFREEBUSY component.
-
- When only FREEBUSY properties are used, each period in each
- FREEBUSY property is compared against the time range, irrespective
- of the type of free busy information (free, busy, busy-tentative,
- busy-unavailable) represented by the property.
-
-
-
- +------------------------------------------------------+
- | VFREEBUSY has both the DTSTART and DTEND properties? |
- | +--------------------------------------------------+
- | | VFREEBUSY has the FREEBUSY property? |
- | | +----------------------------------------------+
- | | | Condition to evaluate |
- +---+---+----------------------------------------------+
- | Y | * | (start <= DTEND) AND (end > DTSTART) |
- +---+---+----------------------------------------------+
- | N | Y | (start < freebusy-period-end) AND |
- | | | (end > freebusy-period-start) |
- +---+---+----------------------------------------------+
- | N | N | FALSE |
- +---+---+----------------------------------------------+
-
-
-
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 92]
-
-Internet-Draft CalDAV September 2006
-
-
- A VALARM component is said to overlap a given time range if the
- following condition holds:
-
- (start <= trigger-time) AND (end > trigger-time)
-
- A VALARM component can be defined such that it triggers
- repeatedly. Such a VALARM component is said to overlap a given
- time range if at least one of its triggers overlaps the time
- range.
-
- The calendar properties COMPLETED, CREATED, DTEND, DTSTAMP,
- DTSTART, DUE and LAST-MODIFIED overlap a given time range if the
- following condition holds:
-
- (start <= date-time) AND (end > date-time)
-
- Note that if DTEND is not present in a VEVENT, but DURATION is,
- then the test should instead operate on the 'effective' DTEND,
- i.e. DTSTART+DURATION. Similarly, if DUE is not present in a
- VTODO, but DTSTART and DURATION are, then the test should instead
- operate on the 'effective' DUE, i.e. DTSTART+DURATION.
-
- The semantic of CALDAV:time-range is not defined for any other
- calendar properties.
-
- Definition:
-
- <!ELEMENT time-range EMPTY>
-
- <!ATTLIST time-range start CDATA #IMPLIED
- end CDATA #IMPLIED>
- start value: an iCalendar "date with UTC time"
- end value: an iCalendar "date with UTC time"
-
-9.10. CALDAV:calendar-multiget XML Element
-
- Name: calendar-multiget
-
- Namespace: urn:ietf:params:xml:ns:caldav
-
- Purpose: CalDAV REPORT used to retrieve specific calendar object
- resources.
-
- Description: See Section 7.9.
-
-
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 93]
-
-Internet-Draft CalDAV September 2006
-
-
- Definition:
-
- <!ELEMENT calendar-multiget ((DAV:allprop |
- DAV:propname |
- DAV:prop)?, DAV:href+)>
-
-9.11. CALDAV:free-busy-query XML Element
-
- Name: free-busy-query
-
- Namespace: urn:ietf:params:xml:ns:caldav
-
- Purpose: CalDAV REPORT used to generate a VFREEBUSY to determine busy
- time over a specific time range.
-
- Description: See Section 7.10.
-
- Definition:
-
- <!ELEMENT free-busy-query (time-range)>
-
-
-10. Internationalization Considerations
-
- CalDAV allows internationalized strings to be stored and retrieved
- for the description of calendar collections (see Section 5.2.1).
-
- The CALDAV:calendar-query report (Section 7.8) includes a text
- searching option controlled by the CALDAV:text-match element and
- details of character handling are covered in the description of that
- element (see Section 9.7.5).
-
-
-11. 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,
- HTTP Basic authentication MUST NOT be used unless TLS is in effect.
-
- Servers MUST take adequate precautions to ensure malicious clients
- cannot consume excessive server resources (CPU, memory, disk, etc.)
- through carefully crafted reports. For example, a client could
- upload an event with a recurrence rule that specifies a recurring
- event occurring every second for the next 100 years which would
- result in approximately 3 x 10^9 instances! A REPORT that asks for
- recurrences to be expanded over that range would likely constitute a
- denial-of-service attack on the server.
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 94]
-
-Internet-Draft CalDAV September 2006
-
-
- When creating new resources (including calendar collections), clients
- MUST ensure that the resource name (the last path segment of the
- resource URI) assigned to the new resource does not expose any data
- from within the iCalendar resource itself and information about the
- nature of a calendar collection. This is required to ensure that the
- presence of a specific iCalendar component or nature of components in
- a collection cannot be inferred based on the name of a resource.
-
- When rolling up free-busy information, more information about a
- user's events is exposed if busy periods overlap or are adjacent
- (this tells the client requesting the free-busy information that the
- calendar owner has at least two events, rather than knowing only that
- the calendar owner has one or more events during the busy period).
- Thus, a conservative approach to calendar data privacy would have
- servers always coalesce such busy periods when they are the same
- type.
-
- Procedure alarms are a known security risk for either clients or
- servers to handle, particularly when the alarm was created by another
- agent. Clients and servers are not required to execute such
- procedure alarms.
-
- Security considerations described in iCalendar [RFC2445] and iTIP
- [RFC2446] are also applicable to CalDAV.
-
- Beyond these, CalDAV does not raise any security considerations that
- are not present in HTTP [RFC2616] and WebDAV [RFC2518], [RFC3253],
- [RFC3744], as discussed in those documents.
-
-
-12. IANA Consideration
-
- This document uses one new URN to identify a new XML namespace. The
- URN conforms to a registry mechanism described in [RFC3688].
-
-12.1. Namespace Registration
-
- Registration request for the CalDAV namespace:
-
- URI: urn:ietf:params:xml:ns:caldav
-
- Registrant Contact: See the "Author's Address" section of this
- document.
-
- XML: None. Namespace URIs do not represent an XML specification.
-
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 95]
-
-Internet-Draft CalDAV September 2006
-
-
-13. Acknowledgements
-
- The authors would like to thank the following individuals for
- contributing their ideas and support for writing this specification:
- Michael Arick, Mario Bonin, Chris Bryant, Scott Carr, Mike Douglass,
- Ted Hardie, Sam Hartman, Helge Hess, Jeff McCullough, Alexey
- Melnikov, Dan Mosedale, Brian Moseley, Kervin L. Pierre, Julian F.
- Reschke, Wilfredo Sanchez Vega, Mike Shaver, Jari Urpalainen, Simon
- Vaillancourt, Jim Whitehead.
-
- The authors would also like to thank the Calendaring and Scheduling
- Consortium for advice with this specification, and for organizing
- interoperability testing events to help refine it.
-
-
-14. References
-
-14.1. Normative References
-
- [I-D.newman-i18n-comparator]
- Newman, C., "Internet Application Protocol Collation
- Registry", draft-newman-i18n-comparator-13 (work in
- progress), August 2006.
-
- [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
- Requirement Levels", BCP 14, RFC 2119, March 1997.
-
- [RFC2246] Dierks, T. and C. Allen, "The TLS Protocol Version 1.0",
- RFC 2246, January 1999.
-
- [RFC2445] Dawson, F. and Stenerson, D., "Internet Calendaring and
- Scheduling Core Object Specification (iCalendar)",
- RFC 2445, November 1998.
-
- [RFC2446] Silverberg, S., Mansour, S., Dawson, F., and R. Hopson,
- "iCalendar Transport-Independent Interoperability Protocol
- (iTIP) Scheduling Events, BusyTime, To-dos and Journal
- Entries", RFC 2446, November 1998.
-
- [RFC2518] Goland, Y., Whitehead, E., Faizi, A., Carter, S., and D.
- Jensen, "HTTP Extensions for Distributed Authoring --
- WEBDAV", RFC 2518, February 1999.
-
- [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.
-
- [RFC2818] Rescorla, E., "HTTP Over TLS", RFC 2818, May 2000.
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 96]
-
-Internet-Draft CalDAV September 2006
-
-
- [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.
-
- [RFC4346] Dierks, T. and E. Rescorla, "The Transport Layer Security
- (TLS) Protocol Version 1.1", RFC 4346, April 2006.
-
- [W3C.REC-xml-20060816]
- Yergeau, F., Paoli, J., Bray, T., Sperberg-McQueen, C.,
- and E. Maler, "Extensible Markup Language (XML) 1.0
- (Fourth Edition)", World Wide Web Consortium
- Recommendation REC-xml-20060816, August 2006,
- <http://www.w3.org/TR/2006/REC-xml-20060816>.
-
-14.2. Informative References
-
- [I-D.ietf-webdav-rfc2518bis]
- Dusseault, L., "HTTP Extensions for Distributed Authoring
- - WebDAV", draft-ietf-webdav-rfc2518bis-15 (work in
- progress), May 2006.
-
- [RFC2426] Dawson, F. and T. Howes, "vCard MIME Directory Profile",
- RFC 2426, September 1998.
-
- [RFC2739] Small, T., Hennessy, D., and F. Dawson, "Calendar
- Attributes for vCard and LDAP", RFC 2739, January 2000.
-
- [RFC4331] Korver, B. and L. Dusseault, "Quota and Size Properties
- for Distributed Authoring and Versioning (DAV)
- Collections", RFC 4331, February 2006.
-
- [RFC4511] Sermersheim, J., "Lightweight Directory Access Protocol
- (LDAP): The Protocol", RFC 4511, June 2006.
-
-
-Appendix A. CalDAV Method Privilege Table (Normative)
-
- The following table extends the WebDAV Method Privilege Table
- specified in Appendix B of [RFC3744].
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 97]
-
-Internet-Draft CalDAV September 2006
-
-
- +------------+------------------------------------------------------+
- | METHOD | PRIVILEGES |
- +------------+------------------------------------------------------+
- | MKCALENDAR | DAV:bind |
- | REPORT | DAV:read or CALDAV:read-free-busy (on all referenced |
- | | resources) |
- +------------+------------------------------------------------------+
-
-
-Appendix B. Calendar collections used in the examples
-
- This appendix shows the calendar object resources contained in the
- calendar collection queried in the examples throughout this document.
-
- The content of the calendar collection is being shown as it would be
- returned by a CALDAV:calendar-query REPORT request designed to return
- all the calendar data in the collection:
-
- >> Request <<
-
- REPORT /bernard/work/ HTTP/1.1
- Host: cal.example.com
- Depth: 1
- Content-Type: application/xml; charset="utf-8"
- Content-Length: xxxx
-
- <?xml version="1.0" encoding="utf-8" ?>
- <C:calendar-query xmlns:D="DAV:"
- xmlns:C="urn:ietf:params:xml:ns:caldav">
- <D:prop>
- <D:getetag/>
- <C:calendar-data/>
- </D:prop>
- <C:filter>
- <C:comp-filter name="VCALENDAR">
- <C:allprop/>
- <C:allcomp/>
- </C:comp-filter>
- </C:filter>
- </C:calendar-query>
-
- >> Response <<
-
- HTTP/1.1 207 Multi-Status
- Content-Type: application/xml; charset="utf-8"
- Content-Length: xxxx
-
- <?xml version="1.0" encoding="utf-8" ?>
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 98]
-
-Internet-Draft CalDAV September 2006
-
-
- <D:multistatus xmlns:D="DAV:"
- xmlns:C="urn:ietf:params:xml:ns:caldav">
-
- <D:response>
- <D:href>http://cal.example.com/bernard/work/abcd1.ics</D:href>
- <D:propstat>
- <D:prop>
- <D:getetag>"fffff-abcd1"</D:getetag>
- <C:calendar-data>BEGIN:VCALENDAR
- VERSION:2.0
- PRODID:-//Example Corp.//CalDAV 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:20060206T001102Z
- DTSTART;TZID=US/Eastern:20060102T100000
- DURATION:PT1H
- SUMMARY:Event #1
- Description:Go Steelers!
- UID:74855313FA803DA593CD579A@example.com
- END:VEVENT
- END:VCALENDAR
- </C:calendar-data>
- </D:prop>
- <D:status>HTTP/1.1 200 OK</D:status>
- </D:propstat>
- </D:response>
-
- <D:response>
- <D:href>http://cal.example.com/bernard/work/abcd2.ics</D:href>
- <D:propstat>
- <D:prop>
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 99]
-
-Internet-Draft CalDAV September 2006
-
-
- <D:getetag>"fffff-abcd2"</D:getetag>
- <C:calendar-data>BEGIN:VCALENDAR
- VERSION:2.0
- PRODID:-//Example Corp.//CalDAV 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
- SUMMARY:Event #2
- UID:00959BC664CA650E933C892C@example.com
- END:VEVENT
- BEGIN:VEVENT
- DTSTAMP:20060206T001121Z
- DTSTART;TZID=US/Eastern:20060104T140000
- DURATION:PT1H
- RECURRENCE-ID;TZID=US/Eastern:20060104T120000
- SUMMARY:Event #2 bis
- UID:00959BC664CA650E933C892C@example.com
- END:VEVENT
- END:VCALENDAR
- </C:calendar-data>
- </D:prop>
- <D:status>HTTP/1.1 200 OK</D:status>
- </D:propstat>
- </D:response>
-
- <D:response>
- <D:href>http://cal.example.com/bernard/work/abcd3.ics</D:href>
- <D:propstat>
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 100]
-
-Internet-Draft CalDAV September 2006
-
-
- <D:prop>
- <D:getetag>"fffff-abcd3"</D:getetag>
- <C:calendar-data>BEGIN:VCALENDAR
- VERSION:2.0
- PRODID:-//Example Corp.//CalDAV 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
- ATTENDEE;PARTSTAT=ACCEPTED;ROLE=CHAIR:mailto:cyrus@example.com
- ATTENDEE;PARTSTAT=NEEDS-ACTION:mailto:lisa@example.com
- DTSTAMP:20060206T001220Z
- DTSTART;TZID=US/Eastern:20060104T100000
- DURATION:PT1H
- LAST-MODIFIED:20060206T001330Z
- ORGANIZER:mailto:cyrus@example.com
- SEQUENCE:1
- STATUS:TENTATIVE
- SUMMARY:Event #3
- UID:DC6C50A017428C5216A2F1CD@example.com
- END:VEVENT
- END:VCALENDAR
- </C:calendar-data>
- </D:prop>
- <D:status>HTTP/1.1 200 OK</D:status>
- </D:propstat>
- </D:response>
-
- <D:response>
- <D:href>http://cal.example.com/bernard/work/abcd4.ics</D:href>
- <D:propstat>
- <D:prop>
- <D:getetag>"fffff-abcd4"</D:getetag>
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 101]
-
-Internet-Draft CalDAV September 2006
-
-
- <C:calendar-data>BEGIN:VCALENDAR
- VERSION:2.0
- PRODID:-//Example Corp.//CalDAV Client//EN
- BEGIN:VTODO
- DTSTAMP:20060205T235335Z
- DUE;VALUE=DATE:20060104
- STATUS:NEEDS-ACTION
- SUMMARY:Task #1
- UID:DDDEEB7915FA61233B861457@example.com
- BEGIN:VALARM
- ACTION:AUDIO
- TRIGGER;RELATED=START:-PT10M
- END:VALARM
- END:VTODO
- END:VCALENDAR
- </C:calendar-data>
- </D:prop>
- <D:status>HTTP/1.1 200 OK</D:status>
- </D:propstat>
- </D:response>
-
- <D:response>
- <D:href>http://cal.example.com/bernard/work/abcd5.ics</D:href>
- <D:propstat>
- <D:prop>
- <D:getetag>"fffff-abcd5"</D:getetag>
- <C:calendar-data>BEGIN:VCALENDAR
- VERSION:2.0
- PRODID:-//Example Corp.//CalDAV Client//EN
- BEGIN:VTODO
- DTSTAMP:20060205T235300Z
- DUE;VALUE=DATE:20060106
- LAST-MODIFIED:20060205T235308Z
- SEQUENCE:1
- STATUS:NEEDS-ACTION
- SUMMARY:Task #2
- UID:E10BA47467C5C69BB74E8720@example.com
- BEGIN:VALARM
- ACTION:AUDIO
- TRIGGER;RELATED=START:-PT10M
- END:VALARM
- END:VTODO
- END:VCALENDAR
- </C:calendar-data>
- </D:prop>
- <D:status>HTTP/1.1 200 OK</D:status>
- </D:propstat>
- </D:response>
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 102]
-
-Internet-Draft CalDAV September 2006
-
-
- <D:response>
- <D:href>http://cal.example.com/bernard/work/abcd6.ics</D:href>
- <D:propstat>
- <D:prop>
- <D:getetag>"fffff-abcd6"</D:getetag>
- <C:calendar-data>BEGIN:VCALENDAR
- VERSION:2.0
- PRODID:-//Example Corp.//CalDAV Client//EN
- BEGIN:VTODO
- COMPLETED:20051223T122322Z
- DTSTAMP:20060205T235400Z
- DUE;VALUE=DATE:20051225
- LAST-MODIFIED:20060205T235308Z
- SEQUENCE:1
- STATUS:COMPLETED
- SUMMARY:Task #3
- UID:E10BA47467C5C69BB74E8722@example.com
- END:VTODO
- END:VCALENDAR
- </C:calendar-data>
- </D:prop>
- <D:status>HTTP/1.1 200 OK</D:status>
- </D:propstat>
- </D:response>
-
- <D:response>
- <D:href>http://cal.example.com/bernard/work/abcd7.ics</D:href>
- <D:propstat>
- <D:prop>
- <D:getetag>"fffff-abcd7"</D:getetag>
- <C:calendar-data>BEGIN:VCALENDAR
- VERSION:2.0
- PRODID:-//Example Corp.//CalDAV Client//EN
- BEGIN:VTODO
- DTSTAMP:20060205T235600Z
- DUE;VALUE=DATE:20060101
- LAST-MODIFIED:20060205T235308Z
- SEQUENCE:1
- STATUS:CANCELLED
- SUMMARY:Task #4
- UID:E10BA47467C5C69BB74E8725@example.com
- END:VTODO
- END:VCALENDAR
- </C:calendar-data>
- </D:prop>
- <D:status>HTTP/1.1 200 OK</D:status>
- </D:propstat>
- </D:response>
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 103]
-
-Internet-Draft CalDAV September 2006
-
-
- <D:response>
- <D:href>http://cal.example.com/bernard/work/abcd8.ics</D:href>
- <D:propstat>
- <D:prop>
- <D:getetag>"fffff-abcd8"</D:getetag>
- <C:calendar-data>BEGIN:VCALENDAR
- VERSION:2.0
- PRODID:-//Example Corp.//CalDAV Client//EN
- BEGIN:VFREEBUSY
- ORGANIZER;CN="Bernard Desruisseaux":mailto:bernard@example.com
- UID:76ef34-54a3d2@example.com
- DTSTAMP:20050530T123421Z
- DTSTART:20060101T000000Z
- DTEND:20060108T000000Z
- FREEBUSY:20050531T230000Z/20050601T010000Z
- FREEBUSY;FBTYPE=BUSY-TENTATIVE:20060102T100000Z/20060102T120000Z
- FREEBUSY:20060103T100000Z/20060103T120000Z
- FREEBUSY:20060104T100000Z/20060104T120000Z
- FREEBUSY;FBTYPE=BUSY-UNAVAILABLE:20060105T100000Z/20060105T120000Z
- FREEBUSY:20060106T100000Z/20060106T120000Z
- END:VFREEBUSY
- END:VCALENDAR
- </C:calendar-data>
- </D:prop>
- <D:status>HTTP/1.1 200 OK</D:status>
- </D:propstat>
- </D:response>
-
- </D:multistatus>
-
-
-Appendix C. Changes (to be removed prior to publication as an RFC)
-
-C.1. Changes in -15
-
- a. Switched to using collations for text-match element in calendar-
- query report.
-
- b. Removed caseless attribute from text-match element.
-
- c. Removed UNICODE4 reference.
-
- d. Removed mailing list comment.
-
- e. Made calendar-home-set property a SHOULD as it was in previous
- drafts.
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 104]
-
-Internet-Draft CalDAV September 2006
-
-
- f. Now require https download of external attachments.
-
- g. Changed some improper uses of 2119 terms to lowercase.
-
- h. Updated some references to latest specs.
-
-C.2. Changes in -14
-
- a. Reverted to normative reference to 2518 and added informative
- reference to 2518bis.
-
- b. Reinserted section describing preconditions/postconditions.
-
- c. Removed redundant compliance statement in last paragraph of
- Section 3.
-
- d. Clarify that only text/calendar is allowed if supported-calendar-
- data property is not present.
-
- e. Removed redundant compliance statement in Conformance paragraph
- of Section 6.2.1.
-
- f. Removed redundant compliance statement in first paragraph of
- Section 7.5.
-
- g. Fixed incorrect whitespace in elements in example in Section
- 7.7.6.
-
- h. Fixed incorrect CDATA descriptions in various places.
-
-C.3. Changes in -13
-
- a. Changed mailing list draft description.
-
- b. Added security review suggested text to Security Considerations.
-
- c. Changed external attachment support to require http URI
- downloads, and optionally others.
-
- d. Added reference to text-match element in Internationalization
- Considerations section.
-
- e. Changed 'undefined' to 'not specified here' in ETag behavior
- section.
-
- f. Added reference to RFC4346 with note that it obsoletes RFC2246
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 105]
-
-Internet-Draft CalDAV September 2006
-
-
-C.4. Changes in -12
-
- a. Changed requirements for ETags on PUT to better reflect the needs
- of CalDAV clients wrt synchronization and reflect what other
- standards define or do not define.
-
- b. Changed CALDAV:read-free-busy privilege so that it is also
- defined on regular collections.
-
-C.5. Changes in -11
-
- a. Added statement that calendar-query Depth defaults to zero if
- header is not present. Fixed one multiget example's Depth
- header.
-
- b. Fixed reference to WebDAV Quota RFC.
-
- c. Changed DAV:resource to DAV:href in CALDAV:no-uid-conflict
- element.
-
- d. Added CALDAV:calendar-collection-location-ok pre-condition for
- COPY and MOVE.
-
- e. Added CALDAV:max-resource-size, CALDAV:min-date-time, CALDAV:max-
- date-time, CALDAV:max-instances, CALDAV:max-attendees-per-
- instance properties and preconditions.
-
- f. Changed to 2518bis reference.
-
- g. Now require 2518bis Class 3 behaviour.
-
- h. Fixed indentation in examples and removed bogus whitespace before
- </C:calendar-data> tags.
-
- i. Fixed </C:calendar-data/> typo.
-
- j. Added text to <C:calendar-data> element definition as a reminder
- about the need to do XML character data encoding on any iCalendar
- data within that element.
-
- k. Major reworking of CALDAV:time-range element description to
- better cover all possibilities for each type of component based
- on which properties are present.
-
- l. Added is-not-defined and negate-condition options to reports and
- a new example to illustrate use of those.
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 106]
-
-Internet-Draft CalDAV September 2006
-
-
- m. Fixed descriptions of some calendar collection properties.
-
- n. Removed section describing preconditions/postconditions as this
- is incorporated into 2518bis.
-
- o. Clarified issue about separate component types in separate
- resources.
-
- p. Reworded section on servers being allowed to reject changes to
- their own private use iCal values.
-
- q. Clarified overridden component 'current' and 'original' time
- range overlap.
-
- r. Added more section references for XML element definitions.
-
- s. Reworded limit-recurrence-set definition to try and make it clear
- that mast component is always returned, but only some overridden
- one are returned.
-
- t. Clarified dependence on UNICODE reference for caseless matching.
-
-C.6. Changes in -10
-
- a. Added new section about support for X- items when storing data.
-
- b. Added new precondition to allow servers to reject queries on
- unsupported X- items, and a new example.
-
- c. Added new text about always supporting X- in calendar-data.
-
- d. Created new section for PUT, COPY and MOVE preconditions.
-
- e. Report examples re-done with full listing of calendar data in
- Appendix.
-
- f. Removed description of using UID, SUMMARY etc as resource name.
-
- g. Indicate that calendar object resource may contain only
- overridden components.
-
- h. Add security consideration about not expose details in resource
- names.
-
- i. Add constraint that free-busy-query can only be run on a
- collection.
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 107]
-
-Internet-Draft CalDAV September 2006
-
-
- j. Add preconditions for calendar-timezone property/elements in
- MKCALENDAR, PROPPATCH and calendar-query REPORT.
-
- k. Fix principal-match example.
-
-C.7. Changes in -09
-
- a. Numerous editorial changes.
-
- b. Removed the CALDAV:is-defined XML element.
-
- c. Removed section on privilege aggregation.
-
- d. Renamed the CALDAV:expand-recurrence-set XML element to CALDAV:
- expand and clarified the server behavior.
-
- e. Renamed the CALDAV:calendar-component-restriction-set XML
- element to CALDAV:supported-calendar-component-set.
-
- f. Renamed the CALDAV:calendar-restrictions XML element to CALDAV:
- supported-calendar-data.
-
- g. Renamed some preconditions as "success conditions" instead of
- "failure causes". For instance, the precondition CALDAV:
- calendar-collection-location-bad has been renamed to CALDAV:
- calendar-collection-location-ok.
-
- h. Reordered some sections.
-
- i. Clarified the definition of CALDAV:time-range to specify that a
- repeating VALARM component is said to intersect a given time
- range if at least one of its trigger intersect the time range.
-
- j. Clarified that calendar object resources stored in calendar
- collections MUST NOT specify the iCalendar METHOD property.
-
- k. Clarified that CALDAV:calendar-data XML element is not a WebDAV
- property even though it is specified in the DAV:prop XML element
- in both calendaring REPORT requests and responses.
-
- l. Clarified CALDAV:limit-recurrence-set with respect to the RANGE
- parameter on the RECURRENCE-ID property.
-
- m. Changed the CALDAV:free-busy-query XML element to contain
- exactly one CALDAV:time-range XML element.
-
- n. Changed many ELEMENT and ATTLIST declarations to comply with DTD
- syntax.
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 108]
-
-Internet-Draft CalDAV September 2006
-
-
- o. Changed XML element CALDAV:calendar-query to allow new XML
- element CALDAV:timezone.
-
- p. Changed the XML elements CALDAV:time-range, CALDAV:expand and
- CALDAV:limit-recurrence-set to only allow DATE-TIME with UTC
- time values for the "start" and "end" attributes.
-
- q. Changed description of CALDAV:limit-recurrence-set to specify
- that re-scheduled "overridden" recurrence instances whose
- original scheduled time used to overlap the time range specified
- by the "start" and "end" attribute should always be returned in
- a REPORT response.
-
- r. Changed the description of the value of CALDAV:calendar-data XML
- element to specify that the CR character (US-ASCII decimal 13)
- MAY be omitted in the iCalendar object specified in this XML
- element.
-
- s. Added specific requirements for entity tags support.
-
- t. Added more preconditions.
-
- u. Added further guidelines about finding calendars.
-
- v. Added XML element CALDAV:limit-freebusy-set to limit the set of
- FREEBUSY property values returned in VFREEBUSY components.
-
- w. Added property CALDAV:calendar-timezone on calendar collections.
-
- x. Added XML element CALDAV:timezone to override the CALDAV:
- calendar-timezone property for a given CALDAV:calendar-query
- REPORT request.
-
- y. Added text on the conversion of "floating date" and "floating
- time" values to date with UTC time values.
-
- z. Completed internationalization considerations section.
-
- aa. Completed security considerations section.
-
-C.8. Changes in -08
-
- a. Removed statement that said that client SHOULD always request
- DAV:getetag in calendar REPORTs.
-
- b. Removed redefiniton of DAV:response.
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 109]
-
-Internet-Draft CalDAV September 2006
-
-
- c. Removed XML elements CALDAV:calendar-data-only.
-
- d. Removed resource type CALDAV:calendar-home.
-
- e. Moved the CALDAV:calendar-data element in the DAV:prop element in
- requests, and in the DAV:propstat element in responses.
-
- f. Further defined the request body of MKCALENDAR to allow clients
- to set properties at calendar collection creation time.
-
- g. Renamed CALDAV:calendar-home-URL to CALDAV:calendar-home-set
-
- h. Clarified the fact that calendar collections may only contain
- calendar object resources and ordinary collections.
-
- i. Clarified that calendar REPORTs should only be applied to
- calendar object resources contained in calendar collections.
-
- j. Changed the CALDAV:calendar-component-restriction-set and CALDAV:
- calendar-restriction properties to always be protected.
-
- k. Changed to use existing postcondition DAV:needs-privileges
- instead of a new CALDAV:insufficient-privilege postcondition.
-
- l. Added example for limit-recurrence-set.
-
- m. Added example for expand-recurrence-set.
-
- n. Moved CALDAV:calendar-address-set in the calendar-schedule draft
- and renamed it to CALDAV:calendar-user-address-set.
-
- o. Added guidelines on attachments and alarms.
-
-C.9. Changes in -07
-
- a. Various editorial changes.
-
- b. Added properties calendar-restrictions and calendar-component-
- restriction-set on calendar collections.
-
- c. Added properties calendar-home-URL and calendar-address-set on
- principal resources.
-
- d. Removed property calendar-URL on principal resources.
-
- e. Added pre- and postconditions to reports.
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 110]
-
-Internet-Draft CalDAV September 2006
-
-
- f. Added new XML elements calendar-data-only and limit-recurrent-
- set.
-
- g. Modified calendar-data XML element to support the attributes
- content-type and version.
-
- h. Reorganised sections 3, 4, 5 & 6 into two sections and re-ordered
- sub-sections.
-
- i. Added comment about client not setting a duplicate displayname.
-
- j. Removed three CalDAV OPTIONS requests.
-
- k. Changed "authenticated user" to "user" in various places.
-
- l. Rewrote section on calendar object resource restrictions for
- better clarity.
-
-C.10. Changes in -06
-
- a. Reworded section "Recurrence and the Data Model".
-
- b. Removed timezone collection feature.
-
- c. Removed ability for a server to return the Location header on a
- successful PUT request.
-
- d. Clarified restrictions on calendar object resources contained in
- calendar collections.
-
- e. Added preconditions on PUT in calendar collections.
-
- f. Added informative "Guidelines" section, with information on
- locking and how to find calendar collections.
-
- g. Moved "Sychronization Operations" section in the "Guidelines"
- section.
-
-C.11. Changes in -05
-
- a. Removed a lot of non-normative text.
-
- b. Removed property promotion/demotion requirements.
-
- c. Removed calendar-owner and cal-scale properties.
-
- d. Removed 'ical' prefix/text from element names.
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 111]
-
-Internet-Draft CalDAV September 2006
-
-
- e. Relaxed WebDAV Class 2 (locking) requirement to a MAY.
-
- f. Relaxed MKCALENDAR requirement to a SHOULD.
-
- g. Moved the XML Namespace section in the Introduction.
-
- h. Added CALDAV: prefix to CalDAV XML elements in the text.
-
- i. Added CALDAV:calendar-multiget report.
-
- j. Added CALDAV:free-busy-query report.
-
- k. Added CALDAV:calendar-description property.
-
- l. Changed CALDAV:calendar-query-result element name to CALDAV:
- calendar-data
-
- m. Added description and examples of handling timezones.
-
- n. Added mandatory "start" and "end" attributes to the CALDAV:
- expand-recurrence-set element.
-
- o. Added three CalDAV OPTIONS requests.
-
- p. Grouped XML Element declarations in a separate section.
-
-C.12. Changes in -04
-
- a. Added a note about the HTTP Location response header.
-
- b. Added report calendar-query.
-
- c. Removed reports calendar-property-search and calendar-time-range.
-
- d. Removed section on CalDAV and timezones.
-
- e. Added requirement to return ETag on creation.
-
- f. Revised data model to remove sub-collections from calendar
- collection.
-
- g. Added informative references section.
-
- h. Removed dependencies on DASL.
-
-
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 112]
-
-Internet-Draft CalDAV September 2006
-
-
-C.13. Changes in -03
-
- a. Removed Calendar Containers (simplification that doesn't seem to
- remove much functionality)
-
- b. Added MKCALENDAR to create calendars and all sub-collections
-
- c. Added cal-scale property to calendars
-
-C.14. Changes in -02
-
- Basically still adding major sections of content:
-
- a. Defined new field values to the OPTIONS "DAV:" response header
-
- b. Added new resource properties
-
- c. Added new principal properties
-
- d. Added new SCHEDULE method and related headers
-
- e. Added new privileges for scheduling
-
-C.15. Changes in -01
-
- a. Added section on privileges for calendaring, extending WebDAV ACL
- privilege set
-
- b. Defined what to do with unrecognized properties in the bodies of
- iCalendar events, with respect to property promotion/demotion
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 113]
-
-Internet-Draft CalDAV September 2006
-
-
-Authors' Addresses
-
- Cyrus Daboo
- Apple Computer, Inc.
- 1 Infinite Loop
- Cupertino, CA 95014
- USA
-
- Email: cyrus@daboo.name
- URI: http://www.apple.com/
-
-
- Bernard Desruisseaux
- Oracle Corporation
- 600 Blvd. de Maisonneuve West
- Suite 1900
- Montreal, QC H3A 3J2
- CA
-
- Email: bernard.desruisseaux@oracle.com
- URI: http://www.oracle.com/
-
-
- Lisa Dusseault
- Open Source Application Foundation
- 2064 Edgewood Dr.
- Palo Alto, CA 94303
- US
-
- Email: lisa@osafoundation.org
- URI: http://www.osafoundation.org/
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 114]
-
-Internet-Draft CalDAV September 2006
-
-
-Intellectual Property Statement
-
- 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@ietf.org.
-
-
-Disclaimer of Validity
-
- 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 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.
-
-
-Copyright Statement
-
- Copyright (C) The Internet Society (2006). 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.
-
-
-Acknowledgment
-
- Funding for the RFC Editor function is currently provided by the
- Internet Society.
-
-
-
-
-Daboo, et al. Expires March 17, 2007 [Page 115]
-
-
-