ProPeler
Home
Console
Upload
information
Create File
Create Folder
About
Tools
:
/
opt
/
cpanel-ccs
/
doc
/
Extensions
/
Filename :
caldav-privatecomments.xml
back
Copy
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE rfc SYSTEM 'rfc2629.dtd' [ <!ENTITY rfc2119 PUBLIC '' 'bibxml/reference.RFC.2119.xml'> <!ENTITY rfc2445 PUBLIC '' 'bibxml/reference.RFC.2445.xml'> <!ENTITY rfc2446 PUBLIC '' 'bibxml/reference.RFC.2446.xml'> <!ENTITY rfc4791 PUBLIC '' 'bibxml/reference.RFC.4791.xml'> <!ENTITY I-D.desruisseaux-caldav-sched PUBLIC '' 'bibxml3/reference.I-D.desruisseaux-caldav-sched.xml'> ]> <?rfc toc="yes"?> <?rfc tocdepth="4"?> <?rfc strict="yes"?> <?rfc comments="yes"?> <?rfc inline="yes"?> <?rfc symrefs="yes"?> <?rfc sortrefs="yes"?> <?rfc compact="yes"?> <?rfc subcompact="no"?> <?rfc private="Calendar Server Extension"?> <rfc ipr="none" docName='caldav-privatecomments-00'> <front> <title abbrev="CalDAV Private Attendee Comments">Private Attendee Comments in CalDAV Scheduling</title> <author initials="C." surname="Daboo" fullname="Cyrus Daboo"> <organization abbrev="Apple"> Apple Inc. </organization> <address> <postal> <street>1 Infinite Loop</street> <city>Cupertino</city> <region>CA</region> <code>95014</code> <country>USA</country> </postal> <email>cyrus@daboo.name</email> <uri>http://www.apple.com/</uri> </address> </author> <date year='2008'/> <abstract> <t> This document defines an extension to CalDAV Scheduling that enables Attendees to communicate private comments back to an Organizer, and for the Organizer to see each Attendees' comments. </t> </abstract> </front> <middle> <section title='Introduction'> <t> Internet calendaring and scheduling standards are defined by <xref target="RFC2445">iCalendar</xref> and <xref target="RFC2446">iTIP</xref>. The <xref target="RFC4791">CalDAV Access</xref> standard defines a way to access calendar data stored on a server, and the <xref target="I-D.desruisseaux-caldav-sched">CalDAV Scheduling</xref> draft defines how scheduling occurs between users of a CalDAV server. </t> <t> It is often the case that an Attendee of an event wants to communicate information back to an Organizer when they respond to a meeting invitation. Sometimes this is to tell the Organizer the reason why an invite was declined, sometimes to add addition information to an acceptance. Typically these communications are expected to be private as they may contain comments about other Attendees. </t> <t> This specification defines new iCalendar properties and parameters that are used by clients to pass private comments between Attendees and Organizers of events being scheduling via CalDAV scheduling. It also defines an extension to CalDAV scheduling that defines how a server automatically processes the comments to ensure they are communicated properly between the Attendee and Organizer. </t> </section> <section title='Conventions Used in This Document'> <t> 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 <xref target='RFC2119' />. </t> <t> 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. </t> <t> The namespace "http://calendarserver.org/ns/" is used for XML elements defined in this specification. When XML element types in this namespace are referenced in this document outside of the context of an XML fragment, the string "CS:" will be prefixed to the element type names respectively. </t> <t> The prefix X-CALENDARSERVER- is used for all iCalendar properties and parameters defined in this extension. </t> </section> <!-- <section title="Open Issues"> <t> <list style="numbers"> <t> None right now. </t> </list> </t> </section> --> <section title="New behavior"> <section anchor="attendee" title="Attendee"> <t>When an Attendee wants to send a private comment to an Organizer, the Attendee's calendar user agent adds or updates an "X-CALENDARSERVER-PRIVATE-COMMENT" property in each calendar component of a scheduling object resource to which the comment applies. The value of the comment is the actual message the Attendee is sending.</t> <t>The addition or update of any "X-CALENDARSERVER-PRIVATE-COMMENT" property causes the server to send a scheduling message to the Organizer as an iTIP "REPLY", and that MUST include the "X-CALENDARSERVER-PRIVATE-COMMENT" properties in addition to the normal properties sent as part of that scheduling message.</t> </section> <section anchor="organizer" title="Organizer"> <t>When a scheduling message from an Attendee is processed by the server, the server will check for the presence of a "X-CALENDARSERVER-PRIVATE-COMMENT" property in each component of the scheduling message and compare this with the scheduling object resource corresponding to the scheduling message currently stored on a live calendar belonging to the Organizer. For each component in the scheduling message, the server will identify the corresponding component in the scheduling object resource (possibly creating a new overridden component instance if needed) and do the following:</t> <texttable> <ttcol>State</ttcol> <ttcol>Description</ttcol> <c>State 1</c> <c>Does the scheduling message contain a "X-CALENDARSERVER-PRIVATE-COMMENT" property</c> <c> </c> <c> </c> <c>State 2</c> <c>Does the scheduling object resource contain a "X-CALENDARSERVER-ATTENDEE-COMMENT" property with an "X-CALENDARSERVER-ATTENDEE-REF" parameter value that matches the "ATTENDEE" value in the scheduling message</c> </texttable> <texttable> <ttcol>State 1</ttcol> <ttcol>State 2</ttcol> <ttcol>Server Action</ttcol> <c>No</c> <c>No</c> <c>No additional processing required.</c> <c> </c> <c> </c> <c> </c> <c>No</c> <c>Yes</c> <c>Note 1.</c> <c> </c> <c> </c> <c> </c> <c>Yes</c> <c>No</c> <c>Note 2.</c> <c> </c> <c> </c> <c> </c> <c>Yes</c> <c>Yes</c> <c>Note 3.</c> </texttable> <t> <list style="hanging"> <t hangText="Note 1:">The server MUST update the "X-CALENDARSERVER-DTSTAMP" parameter value on the "X-CALENDARSERVER-ATTENDEE-COMMENT" property, and it MUST set the value of that property to an empty string. It MUST remove all property parameters other than "X-CALENDARSERVER-DTSTAMP" and "X-CALENDARSERVER-ATTENDEE-REF".</t> <t hangText="Note 2:">The server MUST create an "X-CALENDARSERVER-ATTENDEE-COMMENT" and MUST set the "X-CALENDARSERVER-DTSTAMP" and "X-CALENDARSERVER-ATTENDEE-REF" parameter values, and MUST set the value of the new property to the value of the "X-CALENDARSERVER-PRIVATE-COMMENT" property. Other parameter values on the "X-CALENDARSERVER-PRIVATE-COMMENT" property MAY be copied to the "X-CALENDARSERVER-ATTENDEE-COMMENT" property if supported.</t> <t hangText="Note 3:">The server MUST update the "X-CALENDARSERVER-DTSTAMP" parameter value on the "X-CALENDARSERVER-ATTENDEE-COMMENT" property, and MUST set the value of the new property to the value of the "X-CALENDARSERVER-PRIVATE-COMMENT" property. It MUST remove all property parameters other than "X-CALENDARSERVER-DTSTAMP" and "X-CALENDARSERVER-ATTENDEE-REF", and other parameter values on the "X-CALENDARSERVER-PRIVATE-COMMENT" property MAY be copied to the "X-CALENDARSERVER-ATTENDEE-COMMENT" property if supported.</t> </list> </t> <t>When creating or updating the "X-CALENDARSERVER-DTSTAMP" property parameter value, the server MUST set it to the date-time UTC value when the processing of the scheduling message took place.</t> <t>When creating the "X-CALENDARSERVER-ATTENDEE-REF" property parameter value, the server MUST set it to the "ATTENDEE" property value in the scheduling message being processed. As the scheduling message is an iTIP "REPLY" only one "ATTENDEE" property will be present in each component, and the value corresponds to the Attendee sending the reply.</t> <t>Servers MUST remove an "X-CALENDARSERVER-ATTENDEE-COMMENT" property if the corresponding "ATTENDEE" property is removed by the Organizer.</t> <t>Servers MUST NOT include "X-CALENDARSERVER-ATTENDEE-COMMENT" properties in scheduling messages sent to Attendees triggered by changes to an Organizer's scheduling object resource. Clients SHOULD ensure that "X-CALENDARSERVER-ATTENDEE-COMMENT" properties are not included in any iCalendar data "exported" to other calendar systems or sent as scheduling messages by the client.</t> </section> </section> <section title='New features'> <section title='iCalendar Changes'> <t>This specification introduces a new iCalendar properties "X-CALENDARSERVER-PRIVATE-COMMENT" and "X-CALENDARSERVER-ATTENDEE-COMMENT" for use in iCalendar components.</t> <section title="Changes to VEVENT Component"> <t>The definition of the properties allowed in a "VEVENT" component is extended as follows: <figure> <artwork><![CDATA[ eventprop /= ; 'privatecomment' is optional, ; but MUST NOT occur more than once privatecomment / ; 'attendeecomment' is optional, ; and MAY occur more than once attendeecomment ]]></artwork> </figure> </t> </section> <section title="Changes to VTODO Component"> <t>The definition of the properties allowed in a "VTODO" component is extended as follows: <figure> <artwork><![CDATA[ todoprop /= ; 'privatecomment' is optional, ; but MUST NOT occur more than once privatecomment / ; 'attendeecomment' is optional, ; and MAY occur more than once attendeecomment ]]></artwork> </figure> </t> </section> <section title="Changes to VJOURNAL Component"> <t>The definition of the properties allowed in a "VJOURNAL" component is extended as follows: <figure> <artwork><![CDATA[ jourprop /= ; 'privatecomment' is optional, ; but MUST NOT occur more than once privatecomment / ; 'attendeecomment' is optional, ; and MAY occur more than once attendeecomment ]]></artwork> </figure> </t> </section> <section title="Private Comment Property"> <t> <list style="hanging"> <t hangText="Property Name:">X-CALENDARSERVER-PRIVATE-COMMENT</t> <t hangText="Purpose:">A private comment that an Attendee adds to their copy of an event and that gets communicated to the Organizer by the server.</t> <t hangText="Value Type:">TEXT</t> <t hangText="Property Parameters:">IANA, non-standard, alternate text representation and language property parameters can be specified on this property.</t> <t hangText="Conformance:">This property can be specified once in "VEVENT", "VTODO", and "VJOURNAL" calendar components.</t> <t hangText="Description:">This property can be added by an Attendee to their copy of a calendar component in a scheduling object resource. See <xref target="attendee"/>.</t> <t hangText="Format Definition:">This property is defined by the following notation: <figure><artwork><![CDATA[ privatecomment = "X-CALENDARSERVER-PRIVATE-COMMENT" privatecommentparam ":" text CRLF privatecommentparam = *( ; the following are OPTIONAL, ; but MUST NOT occur more than once (";" altrepparam) / (";" languageparam) / ; the following is OPTIONAL, ; and MAY occur more than once (";" other-param) ) ]]></artwork></figure></t> <t hangText="Example:"> <figure> <artwork><![CDATA[ X-CALENDARSERVER-PRIVATE-COMMENT:Sorry I cannot attend the mee ting at the specified time. I am free one hour later though. ]]></artwork> </figure> </t> </list> </t> </section> <section title="Attendee Comment Property"> <t> <list style="hanging"> <t hangText="Property Name:">X-CALENDARSERVER-ATTENDEE-COMMENT</t> <t hangText="Purpose:">A private Attendee comment from an Attendee to the Organizer, as recorded by the server.</t> <t hangText="Value Type:">TEXT</t> <t hangText="Property Parameters:">IANA, non-standard, alternate text representation, language, timestamp and attendee property parameters can be specified on this property.</t> <t hangText="Conformance:">This property can be specified multiple times in "VEVENT", "VTODO", and "VJOURNAL" calendar components. However, it MUST only occur once in each component with the same "X-CALENDARSERVER-ATTENDEE-REF" parameter value.</t> <t hangText="Description:">This property is added or updated by the server as a result of receiving a scheduling message from an Attendee. See <xref target="organizer"/>.</t> <t hangText="Format Definition:">This property is defined by the following notation: <figure><artwork><![CDATA[ attendeecomment = "X-CALENDARSERVER-ATTENDEE-COMMENT" attendeecommentparam ":" text CRLF attendeecommentparam = *( ; the following are REQUIRED, ; but MUST occur only once (";" dtstampparam) / (";" attendeerefparam) / ; the following are OPTIONAL, ; but MUST NOT occur more than once (";" altrepparam) / (";" languageparam) / ; the following is OPTIONAL, ; and MAY occur more than once (";" other-param) ) ]]></artwork></figure></t> <t hangText="Example:"> <figure> <artwork><![CDATA[ X-CALENDARSERVER-ATTENDEE-COMMENT;X-CALENDARSERVER-DTSTAMP=20080814T 114816Z;X-CALENDARSERVER-ATTENDEE-REF="mailto:cyrus@example.com":So rry I cannot attend the meeting at the specified time. I am free on e hour later though. ]]></artwork> </figure> </t> </list> </t> </section> <section title="Date-time Stamp Property Parameter"> <t> <list style="hanging"> <t hangText="Parameter Name:">X-CALENDARSERVER-DTSTAMP</t> <t hangText="Purpose:">Indicates when an iCalendar property was updated by the server.</t> <t hangText="Format Definition:">This property parameter is defined by the following notation: <figure> <artwork><![CDATA[ dtstampparam = "X-CALENDARSERVER-DTSTAMP" "=" date-time ; MUST be a date-time in UTC ]]></artwork> </figure> </t> <t hangText="Description:">This parameter indicates when specific iCalendar properties were added or changed as the result of the server automatically updating a scheduling object resource.</t> <t hangText="Example:"> <figure> <artwork><![CDATA[ X-CALENDARSERVER-ATTENDEE-COMMENT;X-CALENDARSERVER-DTSTAMP=20080814T 114816Z;X-CALENDARSERVER-ATTENDEE-REF="mailto:cyrus@example.com":So rry I cannot attend the meeting at the specified time. I am free on e hour later though. ]]></artwork> </figure> </t> </list> </t> </section> <section title="Attendee Reference Property Parameter"> <t> <list style="hanging"> <t hangText="Parameter Name:">X-CALENDARSERVER-ATTENDEE-REF</t> <t hangText="Purpose:">Relates an iCalendar property to a particular "ATTENDEE" property in the same calendar component.</t> <t hangText="Format Definition:">This property parameter is defined by the following notation: <figure> <artwork><![CDATA[ attendeerefparam = "X-CALENDARSERVER-ATTENDEE-REF" "=" DQUOTE cal-address DQUOTE ]]></artwork> </figure> </t> <t hangText="Description:">This parameter relates a particular property to a specific "ATTENDEE" property in the same calendar component. It is used to tie Attendee comments back to the actual Attendee who made them.</t> <t hangText="Example:"> <figure> <artwork><![CDATA[ X-CALENDARSERVER-ATTENDEE-COMMENT;X-CALENDARSERVER-DTSTAMP=20080814T 114816Z;X-CALENDARSERVER-ATTENDEE-REF="mailto:cyrus@example.com":So rry I cannot attend the meeting at the specified time. I am free on e hour later though. ]]></artwork> </figure> </t> </list> </t> </section> </section> <section title="CalDAV Changes"> <section title="OPTIONS Request"> <t>A server supporting the features described in this document MUST include "calendarserver-private-comments" as a field in the DAV response header from an OPTIONS request on all calendar resources. A value of "calendarserver-private-comments" in the DAV response header MUST indicate that the server supports all MUST level requirements specified in this document.</t> <section title="Example: Using OPTIONS for the Discovery of Private Attendee Comments Support"> <figure> <artwork><![CDATA[ >> Request << OPTIONS /home/cyrus/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, access-control, calendar-access DAV: calendarserver-private-comments Date: Sat, 11 Nov 2006 09:32:12 GMT Content-Length: 0 ]]></artwork> </figure> <t>In this example, the OPTIONS method returns the value "calendarserver-private-comments" in the DAV response header to indicate that the collection "/home/cyrus/calendars/" supports the behavior defined in this specification.</t> </section> </section> <section anchor="x-compatability" title="Handling clients that do not preserve X- properties"> <t>TODO:</t> </section> <section title="New pre-conditions for PUT"> <t>The following pre-conditions for a PUT request against a calendar resource are defined: <list> <t>(CS:valid-attendee-comment-change):Only the server is allowed to the value and parameters on an "X-CALENDARSERVER-ATTENDEE-COMMENT" property.</t> </list> </t> <t> If these pre-conditions are violated the server MUST return a DAV:error response with the appropriate XML element indicating the pre-condition being violated in the response to the PUT request. </t> </section> </section> </section> <section title='Security Considerations'> <t>TODO:</t> </section> <section title='IANA Considerations'> <t> This document does not require any actions on the part of IANA. </t> </section> </middle> <back> <references title='Normative References'> &rfc2119; &rfc2445; &rfc2446; &rfc4791; &I-D.desruisseaux-caldav-sched; </references> <!-- <references title='Informative References'> </references> --> <section title='Acknowledgments'> <t> This specification is the result of discussions between the Apple calendar server and client teams. </t> </section> <!-- <section title='Change History'> <t>Changes since -00 <list style='numbers'> <t></t> </list> </t> </section> --> </back> </rfc>