draft-ietf-calsch-ical-06.txt   draft-ietf-calsch-ical-07.txt 
Network Working Group Frank Dawson, Lotus Network Working Group Frank Dawson, Lotus
Internet Draft Derik Stenerson, Microsoft Internet Draft Derik Stenerson, Microsoft
<ietf-calsch-ical-06.txt> March 13, 1998 <draft-ietf-calsch-ical-07.txt
Expires September 1998 Expires six months after May 11, 1998
Internet Calendaring and Scheduling Core Object Specification Internet Calendaring and Scheduling Core Object Specification
(iCalendar) (iCalendar)
Status of this Memo Status of this Memo
This memo is an Internet-Draft. Internet-Drafts are working documents This memo is an Internet-Draft. Internet-Drafts are working documents
of the Internet Engineering Task Force (IETF), its areas, and its of the Internet Engineering Task Force (IETF), its areas, and its
working groups. Note that other groups MAY also distribute working working groups. Note that other groups can also distribute working
documents as Internet-Drafts. documents as Internet-Drafts.
Internet-Drafts are draft documents valid for a maximum of six Internet-Drafts are draft documents valid for a maximum of six
months. Internet-Drafts MAY be updated, replaced, or made obsolete by months. Internet-Drafts can be updated, replaced, or made obsolete by
other documents at any time. It is not appropriate to use Internet- other documents at any time. It is not appropriate to use Internet-
Drafts as reference material or to cite them other than as a "working Drafts as reference material or to cite them other than as a "working
draft" or "work in progress". draft" or "work in progress".
To learn the current status of any Internet-Draft, please check the To view the entire list of current Internet-Drafts, please check
1id-abstracts.txt listing contained in the Internet-Drafts Shadow the "1id-abstracts.txt" listing contained in the Internet-Drafts
Directories on ds.internic.net (US East Coast), nic.nordu.net Shadow Directories on ftp.is.co.za (Africa), ftp.nordu.net
(Europe), ftp.isi.edu (US West Coast), or munnari.oz.au (Pacific (Northern Europe), ftp.nis.garr.it (Southern Europe), munnari.oz.au
Rim). (Pacific Rim), ftp.ietf.org (US East Coast), or ftp.isi.edu
(US West Coast).
Distribution of this memo is unlimited. Distribution of this memo is unlimited.
Copyright (C) The Internet Society 1997. All Rights Reserved. Copyright (C) The Internet Society 1997. All Rights Reserved.
Abstract Abstract
There is a clear need to provide and deploy interoperable calendaring There is a clear need to provide and deploy interoperable calendaring
and scheduling services for the Internet. Current group scheduling and scheduling services for the Internet. Current group scheduling
and Personal Information Management (PIM) products are being extended and Personal Information Management (PIM) products are being extended
for use across the Internet, today, in proprietary ways. This memo for use across the Internet, today, in proprietary ways. This memo
has been defined to provide the definition of a common format for has been defined to provide the definition of a common format for
openly exchanging calendaring and scheduling information across the openly exchanging calendaring and scheduling information across the
Internet. Internet.
This memo is formatted as a registration for a MIME media type per This memo is formatted as a registration for a MIME media type per
[RFC 2048]. However, the format in this memo is equally applicable [RFC 2048]. However, the format in this memo is equally applicable
for use outside of a MIME message content type. for use outside of a MIME message content type.
The proposed media type value is ''text/calendar''. This string would The proposed media type value is 'text/calendar'. This string would
label a media type containing calendaring and scheduling information label a media type containing calendaring and scheduling information
encoded as text characters formatted in a manner outlined below. encoded as text characters formatted in a manner outlined below.
This MIME media type provides a standard content type for capturing This MIME media type provides a standard content type for capturing
calendar event, to-do and journal entry information. It also can be calendar event, to-do and journal entry information. It also can be
used to convey free/busy time information. The content type is used to convey free/busy time information. The content type is
suitable as a MIME message entity that can be transferred over MIME suitable as a MIME message entity that can be transferred over MIME
based email systems, using HTTP or some other Internet transport. In based email systems, using HTTP or some other Internet transport. In
Dawson/Stenerson 1 Expires September 1998 Dawson/Stenerson 1 Expires November 1998
addition, the content type is useful as an object for interactions addition, the content type is useful as an object for interactions
between desktop applications using the operating system clipboard, between desktop applications using the operating system clipboard,
drag/drop or file systems capabilities. drag/drop or file systems capabilities.
This memo is based on the earlier work of the vCalendar specification This memo is based on the earlier work of the vCalendar specification
for the exchange of personal calendaring and scheduling information. for the exchange of personal calendaring and scheduling information.
In order to avoid confusion with this referenced work, this memo is In order to avoid confusion with this referenced work, this memo is
to be known as the iCalendar specification. to be known as the iCalendar specification.
Readers may also wish to refer to the calendaring and scheduling Readers may also refer to the calendaring and scheduling model
model defined in [] for a description of this Internet application. defined in [ICMS] for a description of this Internet application.
This memo defines the format for specifying iCalendar object methods. This memo defines the format for specifying iCalendar object methods.
An iCalendar object method is a set of usage constraints for the An iCalendar object method is a set of usage constraints for the
iCalendar object. For example, these methods might define scheduling iCalendar object. For example, these methods might define scheduling
messages that request an event be scheduled, reply to an event messages that request an event be scheduled, reply to an event
request, send a cancellation notice for an event, modify or replace request, send a cancellation notice for an event, modify or replace
the definition of an event, provide a counter proposal for an the definition of an event, provide a counter proposal for an
original event request, delegate an event request to another original event request, delegate an event request to another
individual, request free or busy time, reply to a free or busy time individual, request free or busy time, reply to a free or busy time
request, or provide similar scheduling messages for a to-do or request, or provide similar scheduling messages for a to-do or
journal entry calendar component. The iCalendar Transport-indendent journal entry calendar component. The iCalendar Transport-indendent
Interoperability Protocol (iTIP) defined in [ITIP] is one such Interoperability Protocol (iTIP) defined in [ITIP] is one such
scheduling protocol. scheduling protocol.
Dawson/Stenerson 2 Expires September 1998 Dawson/Stenerson 2 Expires November 1998
Table of Contents Table of Contents
1 Introduction.........................................................8 1 Introduction.........................................................6
2 Basic Grammar and Conventions........................................8 2 Basic Grammar and Conventions........................................6
2.1 Formatting Conventions ...........................................9 2.1 Formatting Conventions ...........................................7
2.2 Related Memos ...................................................10 2.2 Related Memos ....................................................8
3 TEXT/CALENDAR Registration Information..............................10 2.3 International Considerations .....................................8
4 iCalendar Object Specification......................................13 3 Registration Information.............................................8
4.1 Content Lines ...................................................13 3.1 Content Type .....................................................9
4.1.1 List and Field Separators ....................................16 3.2 Parameters .......................................................9
4.1.2 Multiple Values ..............................................16 3.3 Content Header Fields ...........................................10
4.1.3 Binary Content ...............................................17 3.4 Encoding Considerations .........................................10
4.1.4 Character Set ................................................17 3.5 Security Considerations .........................................10
4.2 Property Parameters .............................................17 3.6 Interoperability Considerations .................................11
4.2.1 Alternate Text Representation ................................18 3.7 Applications Which Use This Media Type ..........................11
4.2.2 Inline Encoding ..............................................19 3.8 Additional Information ..........................................11
4.2.3 Language .....................................................19 3.9 Magic Numbers ...................................................11
4.2.4 Time Zone Identifier .........................................20 3.10 File Extensions ................................................11
4.2.5 Value Data Types .............................................21 3.11 Contact for Further Information: ...............................12
4.3 Property Value Data Types .......................................21 3.12 Intended Usage .................................................12
4.3.1 Binary .......................................................22 3.13 Authors/Change Controllers .....................................12
4.3.2 Boolean ......................................................22 4 iCalendar Object Specification......................................12
4.3.3 Calendar User Address ........................................23 4.1 Content Lines ...................................................12
4.3.4 Date .........................................................23 4.1.1 List and Field Separators ....................................15
4.3.5 Date-Time ....................................................24 4.1.2 Multiple Values ..............................................15
4.3.6 Duration .....................................................25 4.1.3 Binary Content ...............................................16
4.3.7 Float ........................................................26 4.1.4 Character Set ................................................16
4.3.8 Integer ......................................................27 4.2 Property Parameters .............................................16
4.3.9 Period of Time ...............................................27 4.2.1 Alternate Text Representation ................................17
4.3.10 Recurrence Rule .............................................28 4.2.2 Common Name ..................................................18
4.3.11 Text ........................................................33 4.2.3 Calendar User Type ...........................................19
4.3.12 Time ........................................................34 4.2.4 Delegators ...................................................19
4.3.13 URI .........................................................36 4.2.5 Delegatees ...................................................20
4.3.14 UTC Offset ..................................................36 4.2.6 Directory Entry Reference ....................................20
4.4 iCalendar Object ................................................37 4.2.7 Inline Encoding ..............................................20
4.5 Property ........................................................38 4.2.8 Free/Busy Time Type ..........................................21
4.6 Calendar Components .............................................38 4.2.9 Language .....................................................22
4.6.1 Event Component ..............................................38 4.2.10 Group or List Membership ....................................22
4.6.2 To-do Component ..............................................40 4.2.11 Participation Status ........................................23
4.6.3 Journal Component ............................................41 4.2.12 Recurrence Identifier Range .................................24
4.6.4 Free/Busy Component ..........................................43 4.2.13 Alarm Trigger Relationship ..................................25
4.6.5 Timezone Component ...........................................45 4.2.14 Relationship Type ...........................................25
4.6.6 Alarm Component ..............................................50 4.2.15 Participation Role ..........................................26
4.7 Calendar Properties .............................................53 4.2.16 RSVP Expectation ............................................27
4.7.1 Calendar Scale ...............................................54 4.2.17 Sent By .....................................................27
4.7.2 Method .......................................................54 4.2.18 Time Zone Identifier ........................................27
4.7.3 Product Identifier ...........................................55 4.2.19 Value Data Types ............................................28
4.7.4 Version ......................................................56 4.3 Property Value Data Types .......................................29
4.8 Component Properties ............................................56 4.3.1 Binary .......................................................29
4.8.1 Descriptive Component Properties .............................56 4.3.2 Boolean ......................................................30
4.8.1.1 Attachment ...............................................56 4.3.3 Calendar User Address ........................................30
4.8.1.2 Categories ...............................................57 4.3.4 Date .........................................................31
Dawson/Stenerson 3 Expires September 1998 Dawson/Stenerson 3 Expires November 1998
4.8.1.3 Classification ...........................................58 4.3.5 Date-Time ....................................................31
4.8.1.4 Comment ..................................................59 4.3.6 Duration .....................................................33
4.8.1.5 Description ..............................................59 4.3.7 Float ........................................................34
4.8.1.6 Geographic Position ......................................60 4.3.8 Integer ......................................................34
4.8.1.7 Location .................................................61 4.3.9 Period of Time ...............................................35
4.8.1.8 Percent Complete .........................................61 4.3.10 Recurrence Rule .............................................36
4.8.1.9 Priority .................................................62 4.3.11 Text ........................................................40
4.8.1.10 Resources ...............................................63 4.3.12 Time ........................................................41
4.8.1.11 Status ..................................................64 4.3.13 URI .........................................................43
4.8.1.12 Summary .................................................65 4.3.14 UTC Offset ..................................................44
4.8.2 Date and Time Component Properties ...........................66 4.4 iCalendar Object ................................................45
4.8.2.1 Date/Time Completed ......................................66 4.5 Property ........................................................45
4.8.2.2 Date/Time End ............................................66 4.6 Calendar Components .............................................45
4.8.2.3 Date/Time Due ............................................67 4.6.1 Event Component ..............................................46
4.8.2.4 Date/Time Start ..........................................68 4.6.2 To-do Component ..............................................48
4.8.2.5 Duration .................................................69 4.6.3 Journal Component ............................................49
4.8.2.6 Free/Busy Time ...........................................69 4.6.4 Free/Busy Component ..........................................50
4.8.2.7 Time Transparency ........................................71 4.6.5 Time Zone Component ..........................................52
4.8.3 Time Zone Component Properties ...............................72 4.6.6 Alarm Component ..............................................58
4.8.3.1 Time Zone Identifier .....................................72 4.7 Calendar Properties .............................................61
4.8.3.2 Time Zone Name ...........................................72 4.7.1 Calendar Scale ...............................................61
4.8.3.3 Time Zone Offset From ....................................73 4.7.2 Method .......................................................62
4.8.3.4 Time Zone Offset To ......................................74 4.7.3 Product Identifier ...........................................63
4.8.3.5 Time Zone URL ............................................74 4.7.4 Version ......................................................63
4.8.4 Relationship Component Properties ............................75 4.8 Component Properties ............................................64
4.8.4.1 Attendee .................................................75 4.8.1 Descriptive Component Properties .............................64
4.8.4.2 Contact ..................................................78 4.8.1.1 Attachment ...............................................64
4.8.4.3 Organizer ................................................79 4.8.1.2 Categories ...............................................65
4.8.4.4 Recurrence ID ............................................80 4.8.1.3 Classification ...........................................66
4.8.4.5 Related To ...............................................81 4.8.1.4 Comment ..................................................67
4.8.4.6 Uniform Resource Locator .................................82 4.8.1.5 Description ..............................................67
4.8.4.7 Unique Identifier ........................................83 4.8.1.6 Geographic Position ......................................68
4.8.5 Recurrence Component Properties ..............................84 4.8.1.7 Location .................................................69
4.8.5.1 Exception Date/Times .....................................84 4.8.1.8 Percent Complete .........................................69
4.8.5.2 Exception Rule ...........................................85 4.8.1.9 Priority .................................................70
4.8.5.3 Recurrence Date/Times ....................................86 4.8.1.10 Resources ...............................................72
4.8.5.4 Recurrence Rule ..........................................88 4.8.1.11 Status ..................................................72
4.8.6 Alarm Component Properties ...................................95 4.8.1.12 Summary .................................................73
4.8.6.1 Alarm Type ...............................................96 4.8.2 Date and Time Component Properties ...........................74
4.8.6.2 Repeat Count .............................................96 4.8.2.1 Date/Time Completed ......................................74
4.8.6.3 Trigger ..................................................97 4.8.2.2 Date/Time End ............................................75
4.8.7 Change Management Component Properties .......................98 4.8.2.3 Date/Time Due ............................................75
4.8.7.1 Date/Time Created ........................................98 4.8.2.4 Date/Time Start ..........................................76
4.8.7.2 Date/Time Stamp ..........................................99 4.8.2.5 Duration .................................................77
4.8.7.3 Last Modified ............................................99 4.8.2.6 Free/Busy Time ...........................................78
4.8.7.4 Sequence Number .........................................100 4.8.2.7 Time Transparency ........................................79
4.8.8 Miscellaneous Component Properties ..........................101 4.8.3 Time Zone Component Properties ...............................79
4.8.8.1 Non-standard Properties .................................101 4.8.3.1 Time Zone Identifier .....................................79
4.8.8.2 Request Status ..........................................102 4.8.3.2 Time Zone Name ...........................................80
5 iCalendar Object Examples..........................................103 4.8.3.3 Time Zone Offset From ....................................81
6 Recommended Practices..............................................107 4.8.3.4 Time Zone Offset To ......................................82
7 Registration of Content Type Elements..............................107 4.8.3.5 Time Zone URL ............................................82
7.1 Registration of New and Modified iCalendar Object Methods ......107 4.8.4 Relationship Component Properties ............................83
7.2 Registration of New Properties .................................108 4.8.4.1 Attendee .................................................83
Dawson/Stenerson 4 Expires September 1998 Dawson/Stenerson 4 Expires November 1998
7.2.1 Define the property .........................................108 4.8.4.2 Contact ..................................................85
7.2.2 Post the Property definition ................................109 4.8.4.3 Organizer ................................................86
7.2.3 Allow a comment period ......................................109 4.8.4.4 Recurrence ID ............................................87
7.2.4 Submit the property for approval ............................109 4.8.4.5 Related To ...............................................88
7.3 Property Change Control ........................................109 4.8.4.6 Uniform Resource Locator .................................89
8 References.........................................................109 4.8.4.7 Unique Identifier ........................................90
9 Acknowledgments....................................................111 4.8.5 Recurrence Component Properties ..............................91
10 Author's Address..................................................111 4.8.5.1 Exception Date/Times .....................................91
11 Full Copyright Statement..........................................112 4.8.5.2 Exception Rule ...........................................92
4.8.5.3 Recurrence Date/Times ....................................93
4.8.5.4 Recurrence Rule ..........................................95
4.8.6 Alarm Component Properties ..................................102
4.8.6.1 Action ..................................................103
4.8.6.2 Repeat Count ............................................103
4.8.6.3 Trigger .................................................104
4.8.7 Change Management Component Properties ......................105
4.8.7.1 Date/Time Created .......................................105
4.8.7.2 Date/Time Stamp .........................................106
4.8.7.3 Last Modified ...........................................107
4.8.7.4 Sequence Number .........................................107
4.8.8 Miscellaneous Component Properties ..........................109
4.8.8.1 Non-standard Properties .................................109
4.8.8.2 Request Status ..........................................110
5 iCalendar Object Examples..........................................111
6 Recommended Practices..............................................115
7 Registration of Content Type Elements..............................116
7.1 Registration of New and Modified iCalendar Object Methods ......116
7.2 Registration of New Properties .................................116
7.2.1 Define the property .........................................116
7.2.2 Post the Property definition ................................117
7.2.3 Allow a comment period ......................................117
7.2.4 Submit the property for approval ............................117
7.3 Property Change Control ........................................118
8 References.........................................................118
9 Acknowledgments....................................................120
10 Author's Address..................................................120
11 Full Copyright Statement..........................................121
Dawson/Stenerson 5 Expires September 1998 Dawson/Stenerson 5 Expires November 1998
1 Introduction 1 Introduction
The use of calendaring and scheduling has grown considerably in the The use of calendaring and scheduling has grown considerably in the
last decade. Enterprise and inter-enterprise business has become last decade. Enterprise and inter-enterprise business has become
dependent on rapid scheduling of events and actions using this dependent on rapid scheduling of events and actions using this
information technology. However, the longer term growth of information technology. However, the longer term growth of
calendaring and scheduling, is currently limited by the lack of calendaring and scheduling, is currently limited by the lack of
Internet standards for the message content types that are central to Internet standards for the message content types that are central to
these knowledgeware applications. This memo is intended to progress these knowledgeware applications. This memo is intended to progress
skipping to change at line 256 skipping to change at line 285
The memo also includes a formal grammar for the content type based on The memo also includes a formal grammar for the content type based on
the Internet ABNF defined in [RFC 2234]. This ABNF is required for the Internet ABNF defined in [RFC 2234]. This ABNF is required for
the implementation of parsers and to serve as the definitive the implementation of parsers and to serve as the definitive
reference when ambiguities or questions arise in interpreting the reference when ambiguities or questions arise in interpreting the
descriptive prose definition of the memo. descriptive prose definition of the memo.
2 Basic Grammar and Conventions 2 Basic Grammar and Conventions
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY" and "OPTIONAL" in this "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY" and
document are to be interoperated as described in [RFC 2119].
Dawson/Stenerson 6 Expires November 1998
"OPTIONAL" in this document are to be interoperated as described in
[RFC 2119].
Dawson/Stenerson 6 Expires September 1998
This memo makes use of both a descriptive prose and a more formal This memo makes use of both a descriptive prose and a more formal
notation for defining the calendaring and scheduling format. notation for defining the calendaring and scheduling format.
The notation used in this memo is the ABNF notation of [RFC 2234]. The notation used in this memo is the ABNF notation of [RFC 2234].
Readers intending on implementing this format defined in this memo Readers intending on implementing this format defined in this memo
should be familiar with this notation in order to properly interpret should be familiar with this notation in order to properly interpret
the specifications of this memo. the specifications of this memo.
All numeric and hexadecimal values used in this memo are given in All numeric and hexadecimal values used in this memo are given in
decimal notation. All names of properties, property parameters, decimal notation.
enumerated property values and property parameter values are case-
insensitive. However, all other property values are case-sensitive, All names of properties, property parameters, enumerated property
unless otherwise stated. values and property parameter values are case-insensitive. However,
all other property values are case-sensitive, unless otherwise
stated.
Note: All indented editorial notes, such as this one, are Note: All indented editorial notes, such as this one, are
intended to provide the reader with additional information that intended to provide the reader with additional information. The
is not essential to the building of a conformant implementation information is not essential to the building of an
of the specifications of this memo. The information is provided implementation conformant with this memo. The information is
to highlight a particular feature or characteristic of the provided to highlight a particular feature or characteristic of
specifications. the memo.
The format for the iCalendar object is based on the syntax of the The format for the iCalendar object is based on the syntax of the
[MIME DIR] content type. While the iCalendar object is not a profile [MIME DIR] content type. While the iCalendar object is not a profile
of the [MIME DIR] content type, it does reuse a number of the of the [MIME DIR] content type, it does reuse a number of the
elements from the [MIME DIR] specification. elements from the [MIME DIR] specification.
2.1 Formatting Conventions 2.1 Formatting Conventions
The mechanisms defined in this memo are defined in propose. Many of The mechanisms defined in this memo are defined in prose. Many of the
the terms used to describe these have common usage that is different terms used to describe these have common usage that is different than
than the standards usage of this memo. In order to reference within the standards usage of this memo. In order to reference within this
this memo elements of the calendaring and scheduling model [ICMS], memo elements of the calendaring and scheduling model [ICMS], core
core object (this memo) or interoperability protocol [ITIP] some object (this memo) or interoperability protocol [ITIP] some
formatting conventions have been used. Calendaring and scheduling formatting conventions have been used. Calendaring and scheduling
roles defined by [ICMS] are referred to in quoted-strings of text roles defined by [ICMS] are referred to in quoted-strings of text
with the first character of each word in upper case. For example, with the first character of each word in upper case. For example,
"Organizer" refers to a role of a "Calendar User" within the "Organizer" refers to a role of a "Calendar User" within the
scheduling protocol defined by [ITIP] Calendar components defined by scheduling protocol defined by [ITIP]. Calendar components defined by
this memo are referred to with capitalized, quoted-strings of text. this memo are referred to with capitalized, quoted-strings of text.
All calendar components start with the letter "V". For example, All calendar components start with the letter "V". For example,
"VEVENT" refers to the event calendar component, "VTODO" refers to "VEVENT" refers to the event calendar component, "VTODO" refers to
the to-do calendar component and "VJOURNAL" refers to the daily the to-do calendar component and "VJOURNAL" refers to the daily
journal calendar component. Scheduling methods defined by [ITIP] are journal calendar component. Scheduling methods defined by [ITIP] are
referred to with capitalized, quoted-strings of text. For example, referred to with capitalized, quoted-strings of text. For example,
"REQUEST" refers to the method for requesting a scheduling calendar "REQUEST" refers to the method for requesting a scheduling calendar
component be created or modified, "REPLY" refers to the method a component be created or modified, "REPLY" refers to the method a
recipient of a request uses to update their status with the recipient of a request uses to update their status with the
"Organizer" of the calendar component. "Organizer" of the calendar component.
Dawson/Stenerson 7 Expires November 1998
The properties defined by this memo are referred to with capitalized, The properties defined by this memo are referred to with capitalized,
quoted-strings of text, followed by the word "property". For example, quoted-strings of text, followed by the word "property". For example,
"ATTENDEE" property refers to the iCalendar property used to convey "ATTENDEE" property refers to the iCalendar property used to convey
the calendar address of a calendar user. Property parameters defined the calendar address of a calendar user. Property parameters defined
by this memo are referred to with lower case, quoted-strings of text, by this memo are referred to with lower case, quoted-strings of text,
Dawson/Stenerson 7 Expires September 1998
followed by the word "parameter". For example, "value" parameter followed by the word "parameter". For example, "value" parameter
refers to the iCalendar property parameter used to override the refers to the iCalendar property parameter used to override the
default data type for a property value. Enumerated values defined by default data type for a property value. Enumerated values defined by
this memo are referred to with capitalized text, either alone or this memo are referred to with capitalized text, either alone or
followed by the word "value". For example, the "MINUTELY" value can followed by the word "value". For example, the "MINUTELY" value can
be used with the "FREQ" component of the "RECUR" data type to specify be used with the "FREQ" component of the "RECUR" data type to specify
repeating components based on an interval of one minute or more. repeating components based on an interval of one minute or more.
2.2 Related Memos 2.2 Related Memos
skipping to change at line 337 skipping to change at line 369
along with this memo, form a framework for Internet calendaring and along with this memo, form a framework for Internet calendaring and
scheduling standards. This memo, [ICAL], specifies a core scheduling standards. This memo, [ICAL], specifies a core
specification of objects, data types, properties and property specification of objects, data types, properties and property
parameters. parameters.
[ICMS] - specifies a common terminology and abstract model; [ICMS] - specifies a common terminology and abstract model;
[ITIP] - specifies an interoperability protocol for scheduling [ITIP] - specifies an interoperability protocol for scheduling
between different implementations; between different implementations;
[IMIP] specifies an Internet email binding for [ITIP]; [IMIP] specifies an Internet email binding for [ITIP].
[IRIP] - specifies an Internet real time protocol binding for [ITIP].
This memo does not attempt to repeat the specification of concepts or This memo does not attempt to repeat the specification of concepts or
definitions from these other memos. Where possible, references are definitions from these other memos. Where possible, references are
made to the memo that provides for the specification of these made to the memo that provides for the specification of these
concepts or definitions. concepts or definitions.
3 TEXT/CALENDAR Registration Information 2.3 International Considerations
In the rest of this document, descriptions of characters are of the
form "character name (codepoint)", where "codepoint" is from the US-
ASCII character set. The "character name" is the authoritative
description; (codepoint) is a reference to that character in US-
ASCII or US-ASCII compatible sets (for example the ISO-8859-x family,
UTF-8, ISO-2022-xx, KOI8-R). If a non-US-ASCII compatible character
set is used, appropriate code-point from that character set must be
chosen instead. Use of non-US-ASCII-compatible character sets is NOT
recommended.
3 Registration Information
The Calendaring and Scheduling Core Object Specification is intended The Calendaring and Scheduling Core Object Specification is intended
for use as a MIME content type. However, the implementation of the for use as a MIME content type. However, the implementation of the
memo is in no way limited solely as a MIME content type. memo is in no way limited solely as a MIME content type.
Dawson/Stenerson 8 Expires November 1998
3.1 Content Type
The following text is intended to register this memo as the MIME The following text is intended to register this memo as the MIME
content type "text/calendar". content type "text/calendar".
To: ietf-types@uninett.no To: ietf-types@uninett.no
Subject: Registration of MIME content type text/calendar. Subject: Registration of MIME content type text/calendar.
MIME media type name: text MIME media type name: text
MIME subtype name: calendar MIME subtype name: calendar
3.2 Parameters
Required parameters: none Required parameters: none
Optional parameters: charset, method and component Optional parameters: charset, method, component and optinfo
The "charset" parameter is defined in [RFC 2046] for other body The "charset" parameter is defined in [RFC 2046] for other body
parts. It is used to identify the default character set used within parts. It is used to identify the default character set used within
the body part. the body part.
Dawson/Stenerson 8 Expires September 1998 The "method" parameter is used to convey the iCalendar object method
The "method" parameter is used to convey the iCalendar object or transaction semantics for the calendaring and scheduling
method or transaction semantics for the calendaring and scheduling
information. It also is an identifier for the restricted set of information. It also is an identifier for the restricted set of
properties and values that the iCalendar object consists of. The properties and values that the iCalendar object consists of. The
parameter is to be used as a guide for applications interpreting parameter is to be used as a guide for applications interpreting the
the information contained within the body part. It SHOULD NOT be information contained within the body part. It SHOULD NOT be used to
used to exclude or require particular pieces of information unless exclude or require particular pieces of information unless the
the identified method definition specifically calls for this identified method definition specifically calls for this behavior.
behavior. Unless specifically forbidden by a particular method Unless specifically forbidden by a particular method definition, a
definition, a text/calendar content type MAY contain any set of text/calendar content type can contain any set of properties
properties permitted by the Calendaring and Scheduling Core Object permitted by the Calendaring and Scheduling Core Object
Specification. The "method" parameter MUST be the same value as Specification. The "method" parameter MUST be the same value as that
that specified in the "METHOD" component property in the iCalendar specified in the "METHOD" component property in the iCalendar object.
object. If one is present, the other must also be present. If one is present, the other must also be present.
The value for the "method" parameter is defined as follows: The value for the "method" parameter is defined as follows:
method = 1*(ALPHA / DIGIT / "-") method = 1*(ALPHA / DIGIT / "-")
; IANA registered iCalendar object method ; IANA registered iCalendar object method
The "component" parameter conveys the type of iCalendar calendar The "component" parameter conveys the type of iCalendar calendar
component within the body part. If the iCalendar object contains component within the body part. If the iCalendar object contains more
more than one calendar component, then different components are than one calendar component type, then multiple component parameters
each specified once in a comma-separated list of values. MUST be specified.
The value for the "component" parameter is defined as follows: The value for the "component" parameter is defined as follows:
component = ("VEVENT" / "VTODO" / "VJOURNAL" / "VFREEBUSY" component = ("VEVENT" / "VTODO" / "VJOURNAL" / "VFREEBUSY"
/ "VTIMEZONE" / x-name / iana-token) ["," [WSP] / "VTIMEZONE" / x-name / iana-token)
component]
Dawson/Stenerson 9 Expires November 1998
The "optinfo" parameter conveys optional information about the
iCalendar object within the body part. This parameter can only
specify semantics already specified by the iCalendar object and that
can be otherwise determined by parsing the body part. In addition,
the optional information specified by this parameter MUST be
consistent with that information specified by the iCalendar object.
For example, it can be used to convey the "Attendee" response status
to a meeting request. The parameter value consists of a string value.
The parameter can be specified multiple times.
This parameter MAY only specify semantics already specified by the
iCalendar object and that can be otherwise determined by parsing the
body part.
The value for the "optinfo" parameter is defined as follows:
optinfo = infovalue / qinfovalue
infovalue = iana-token / x-name
qinfovalue = DQUOTE (infovalue) DQUOTE
3.3 Content Header Fields
Optional content header fields: Any header fields defined by [RFC Optional content header fields: Any header fields defined by [RFC
2045]. 2045].
Encoding considerations: This MIME content type can contain 8bit 3.4 Encoding Considerations
characters, so the use of quoted-printable or base64 MIME content-
transfer-encodings MAY be necessary when iCalendar objects are
transferred across protocols restricted to the 7bit repertoire.
Note that a text valued property in the content entity MAY also
have content encoding of special characters using a BACKSLASH
character (ASCII decimal 92) escapement technique. This means that
content values MAY end up encoded twice.
Security considerations: SPOOFING - - In this memo, the "Organizer" This MIME content type can contain 8bit characters, so the use of
is the only person authorized to make changes to an existing quoted-printable or BASE64 MIME content-transfer-encodings might be
"VEVENT", "VTODO", "VJOURNAL" calendar component and redistribute necessary when iCalendar objects are transferred across protocols
the updates to the "Attendees". An iCalendar object that restricted to the 7bit repertoire. Note that a text valued property
maliciously changes or cancels an existing "VEVENT", "VTODO" or in the content entity can also have content encoding of special
"VJOURNAL" or "VFREEBUSY" calendar component MAY be constructed by characters using a BACKSLASH character (US-ASCII decimal 92)
someone other than the "Organizer" and sent to the "Attendees". In escapement technique. This means that content values can end up
addition in this memo, other than the "Organizer", an "Attendee" of encoded twice.
a "VEVENT", "VTODO", "VJOURNAL" calendar component is the only
other person authorized to update any parameter associated with
their "ATTENDEE" property and send it to the "Organizer". An
Dawson/Stenerson 9 Expires September 1998 3.5 Security Considerations
iCalendar object that maliciously changes the "ATTENDEE" parameters
MAY be constructed by someone other than the real "Attendee" and SPOOFING - - In this memo, the "Organizer" is the only person
sent to the "Organizer". authorized to make changes to an existing "VEVENT", "VTODO",
"VJOURNAL" calendar component and redistribute the updates to the
"Attendees". An iCalendar object that maliciously changes or cancels
an existing "VEVENT", "VTODO" or "VJOURNAL" or "VFREEBUSY" calendar
component might be constructed by someone other than the "Organizer"
and sent to the "Attendees". In addition in this memo, other than the
"Organizer", an "Attendee" of a "VEVENT", "VTODO", "VJOURNAL"
calendar component is the only other person authorized to update any
parameter associated with their "ATTENDEE" property and send it to
the "Organizer". An iCalendar object that maliciously changes the
"ATTENDEE" parameters can be constructed by someone other than the
real "Attendee" and sent to the "Organizer".
Dawson/Stenerson 10 Expires November 1998
PROCEDURAL ALARMS - - An iCalendar object can be created that PROCEDURAL ALARMS - - An iCalendar object can be created that
contains a "VEVENT" and "VTODO" calendar component with an "VALARM" contains a "VEVENT" and "VTODO" calendar component with "VALARM"
calendar components. The "VALARM" calendar component MAY be of type calendar components. The "VALARM" calendar component can be of type
PROCEDURE and MAY have an attachment containing some sort of PROCEDURE and can have an attachment containing some sort of
executable program. Implementations that incorporate these types of executable program. Implementations that incorporate these types of
alarms are subject to any virus or malicious attack that MAY occur alarms are subject to any virus or malicious attack that might occur
as a result of executing the attachment. as a result of executing the attachment.
ATTACHMENTS - - An iCalendar object MAY include references to ATTACHMENTS - - An iCalendar object can include references to Uniform
Uniform Resource Locators that MAY be programmed resources. Resource Locators that can be programmed resources.
Implementers and users of this memo should be aware of the network Implementers and users of this memo should be aware of the network
security implications of accepting and parsing such information. In security implications of accepting and parsing such information. In
addition, the security considerations observed by implementations addition, the security considerations observed by implementations of
of electronic mail systems should be followed for this memo. electronic mail systems should be followed for this memo.
Interoperability considerations: This MIME content type is intended 3.6 Interoperability Considerations
to define a common format for conveying calendaring and scheduling
information between different systems. It is heavily based on the
earlier [VCAL] industry specification.
Applications which use this media type: This content-type is This MIME content type is intended to define a common format for
designed for widespread use by Internet calendaring and scheduling conveying calendaring and scheduling information between different
applications. In addition, applications in the workflow and systems. It is heavily based on the earlier [VCAL] industry
document management area may find this content-type applicable. The specification.
[ITIP], [IMIP] and [IRIP] Internet protocols directly use this
content-type also. Future work on an Internet calendar access
protocol will utilize this content-type too.
Additional information: This memo defines this content-type. 3.7 Applications Which Use This Media Type
Magic numbers: None. This content-type is designed for widespread use by Internet
calendaring and scheduling applications. In addition, applications in
the workflow and document management area might find this content-
type applicable. The [ITIP] and [IMIP] Internet protocols directly
use this content-type also. Future work on an Internet calendar
access protocol will utilize this content-type too.
File extensions: The file extension of "ics" is to be used to 3.8 Additional Information
designate a file containing an arbitrary set of calendaring and
scheduling information consistent with this MIME content type. This memo defines this content-type.
3.9 Magic Numbers
None.
3.10 File Extensions
The file extension of "ics" is to be used to designate a file
containing (an arbitrary set of) calendaring and scheduling
information consistent with this MIME content type.
The file extension of "ifb" is to be used to designate a file The file extension of "ifb" is to be used to designate a file
containing free or busy time information consistent with this MIME containing free or busy time information consistent with this MIME
content type. content type.
Macintosh file type codes: The file type code of "ical" is to be Macintosh file type codes: The file type code of "iCal" is to be used
used in Apple MacIntosh operating system environments to designate in Apple MacIntosh operating system environments to designate a file
a file containing calendaring and scheduling information consistent containing calendaring and scheduling information consistent with
with this MIME media type. this MIME media type.
The file type code of "ifb" is to be used in Apple MacIntosh Dawson/Stenerson 11 Expires November 1998
operating system environments to designate a file containing free The file type code of "iFBf" is to be used in Apple MacIntosh
or busy time information consistent with this MIME media type. operating system environments to designate a file containing free or
busy time information consistent with this MIME media type.
Dawson/Stenerson 10 Expires September 1998 3.11 Contact for Further Information:
Person & email address to contact for further information:
Frank Dawson Frank Dawson
6544 Battleford Drive 6544 Battleford Drive
Raleigh, NC 27613-3502 Raleigh, NC 27613-3502
919-676-9515 (Telephone) 919-676-9515 (Telephone)
919-676-9564 (Data/Facsimile) 919-676-9564 (Data/Facsimile)
Frank_Dawson@Lotus.com (Internet Mail) Frank_Dawson@Lotus.com (Internet Mail)
Derik Stenerson Derik Stenerson
One Microsoft Way One Microsoft Way
Redmond, WA 98052-6399 Redmond, WA 98052-6399
425-936-5522 (Telephone) 425-936-5522 (Telephone)
425-936-7329 (Facsimile) 425-936-7329 (Facsimile)
deriks@microsoft.com (Internet Mail) deriks@microsoft.com (Internet Mail)
Intended usage: COMMON 3.12 Intended Usage
Author/change controller: COMMON
3.13 Authors/Change Controllers
Frank Dawson Frank Dawson
6544 Battleford Drive 6544 Battleford Drive
Raleigh, NC 27613-3502 Raleigh, NC 27613-3502
919-676-9515 (Telephone) 919-676-9515 (Telephone)
919-676-9564 (Data/Facsimile) 919-676-9564 (Data/Facsimile)
Frank_Dawson@Lotus.com (Internet Mail) Frank_Dawson@Lotus.com (Internet Mail)
Derik Stenerson Derik Stenerson
One Microsoft Way One Microsoft Way
Redmond, WA 98052-6399 Redmond, WA 98052-6399
425-936-5522 (Telephone) 425-936-5522 (Telephone)
425-936-7329 (Facsimile) 425-936-7329 (Facsimile)
deriks@microsoft.com (Internet Mail) deriks@microsoft.com (Internet Mail)
4 iCalendar Object Specification 4 iCalendar Object Specification
The following sections define the details of a Calendaring and The following sections define the details of a Calendaring and
Scheduling Core Object Specification. This information is intended to Scheduling Core Object Specification. This information is intended to
be an integral part of the MIME content type registration. In be an integral part of the MIME content type registration. In
addition, this information MAY be used independent of such content addition, this information can be used independent of such content
registration. In particular, this memo has direct applicability for registration. In particular, this memo has direct applicability for
use as a calendaring and scheduling exchange format in file-, memory- use as a calendaring and scheduling exchange format in file-, memory-
or network-based transport mechanisms. or network-based transport mechanisms.
4.1 Content Lines 4.1 Content Lines
The iCalendar object is organized into individual lines of text, The iCalendar object is organized into individual lines of text,
called content lines. Content lines are delimited by a line break, called content lines. Content lines are delimited by a line break,
which is a CRLF sequence (ASCII decimal 13, followed by ASCII decimal
10).
Dawson/Stenerson 11 Expires September 1998 Dawson/Stenerson 12 Expires November 1998
Lines of text SHOULD NOT be longer than 75 characters, excluding the which is a CRLF sequence (US-ASCII decimal 13, followed by US-ASCII
line break. Long content lines SHOULD be split into a multiple line decimal 10).
Lines of text SHOULD NOT be longer than 75 octets, excluding the line
break. Long content lines SHOULD be split into a multiple line
representations using a line "folding" technique. That is, a long representations using a line "folding" technique. That is, a long
line MAY be split at any point by inserting a CRLF immediately line can be split between any two characters by inserting a CRLF
followed by a single linear white space character (i.e., SPACE, ASCII immediately followed by a single linear white space character (i.e.,
decimal 32 or HTAB, ASCII decimal 9). Any sequence of CRLF followed SPACE, US-ASCII decimal 32 or HTAB, US-ASCII decimal 9). Any sequence
immediately by a single linear white space character is ignored of CRLF followed immediately by a single linear white space character
(i.e., removed) when processing the content type. is ignored (i.e., removed) when processing the content type.
For example the line: For example the line:
DESCRIPTION:This is a long description that exists on a long line. DESCRIPTION:This is a long description that exists on a long line.
Can be represented as: Can be represented as:
DESCRIPTION:This is a lo DESCRIPTION:This is a lo
ng description ng description
that exists on a long line. that exists on a long line.
The process of moving from this folded multiple line representation The process of moving from this folded multiple line representation
to its single line representation is called "unfolding". Unfolding is to its single line representation is called "unfolding". Unfolding is
accomplished by removing the CRLF character and the linear white accomplished by removing the CRLF character and the linear white
space character that immediately follows. space character that immediately follows.
When parsing a content line, folded lines must first be unfolded When parsing a content line, folded lines must first be unfolded
according to the unfolding procedure described above. When generating according to the unfolding procedure described above. When generating
a content line, lines longer than 75 characters SHOULD be folded a content line, lines longer than 75 octets SHOULD be folded
according to the folding procedure described above. according to the folding procedure described above.
The content information associated with an iCalendar object is The content information associated with an iCalendar object is
formatted using a syntax similar to that defined by [MIME DIR]. That formatted using a syntax similar to that defined by [MIME DIR]. That
is, the content information consists of one or more CRLF-separated is, the content information consists of one or more CRLF-separated
content lines. content lines.
The following notation defines the defines the lines of content in an The following notation defines the defines the lines of content in an
iCalendar object: iCalendar object:
contentline = name *(";" [WSP] param ) ":" value CRLF contentline = name *(";" param ) ":" value CRLF
; This ABNF is just a general definition for an initial parsing ; This ABNF is just a general definition for an initial parsing
; of the content line into its property name, parameter list, ; of the content line into its property name, parameter list,
; and value string ; and value string
; When parsing a content line, folded lines must first ; When parsing a content line, folded lines must first
; be unfolded according to the unfolding procedure ; be unfolded according to the unfolding procedure
; described above. When generating a content line, lines ; described above. When generating a content line, lines
; longer than 75 characters SHOULD be folded according to ; longer than 75 octets SHOULD be folded according to
; the folding procedure described above. ; the folding procedure described above.
name = x-name / iana-token name = x-name / iana-token
Dawson/Stenerson 13 Expires November 1998
iana-token = 1*(ALPHA / DIGIT / "-") iana-token = 1*(ALPHA / DIGIT / "-")
; iCalendar identifier registered with IANA ; iCalendar identifier registered with IANA
Dawson/Stenerson 12 Expires September 1998 x-name = "X-" [vendorid "-"] 1*(ALPHA / DIGIT / "-")
x-name = "X-" 1*(ALPHA / DIGIT / "-")
; Reservered for experimental use. Not intended for use in ; Reservered for experimental use. Not intended for use in
; released products. ; released products.
vendorid = 3*(ALPHA / DIGIT) ;Vendor identification
param = param-name "=" param-value param = param-name "=" param-value
*("," param-value) *("," param-value)
; Each property defines the specific ABNF for the parameters ; Each property defines the specific ABNF for the parameters
; allowed on the property. Refer to specific properties for ; allowed on the property. Refer to specific properties for
; precise parameter ABNF. ; precise parameter ABNF.
param-name = iana-token param-name = iana-token / x-token
param-value = paramtext / quoted-string param-value = paramtext / quoted-string
paramtext = *SAFE-CHAR paramtext = *SAFE-CHAR
value = *VALUE-CHAR value = *VALUE-CHAR
quoted-string = DQUOTE *qtext DQUOTE quoted-string = DQUOTE *QSAFE-CHAR DQUOTE
qtext = QSAFE-CHAR / QUOTED-CHAR
NON-ASCII = %x80-FF NON-US-ASCII = %x80-F8
; Use restricted by charset parameter ; Use restricted by charset parameter
; on outer MIME object (UTF-8 preferred) ; on outer MIME object (UTF-8 preferred)
QSAFE-CHAR = WSP / %x21 / %x23-5B / %x5D-7E / NON-ASCII QSAFE-CHAR = WSP / %x21 / %x23-7E / NON-US-ASCII
; Any character except CTLs, DQUOTE, or "\" ; Any character except CTLs and DQUOTE
QUOTED-CHAR = "\" ("\" / "," / DQUOTE)
; \\ encodes \, \" encodes "
SAFE-CHAR = WSP / %x21 / %x23-2B / %x2D-39 / %x3C-7E SAFE-CHAR = WSP / %x21 / %x23-2B / %x2D-39 / %x3C-7E
/ NON-ASCII / NON-US-ASCII
; Any character except CTLs, DQUOTE, ";", ":", "," ; Any character except CTLs, DQUOTE, ";", ":", ","
VALUE-CHAR = WSP / VCHAR / NON-ASCII VALUE-CHAR = WSP / %x21-7E / NON-US-ASCII
; Any textual character ; Any textual character
VCHAR = %x21-7E
; visible (printing) characters
CR = %x0D CR = %x0D
; carriage return ; carriage return
LF = %x0A LF = %x0A
; line feed
CRLF = CR LF CRLF = CR LF
; Internet standard newline ; Internet standard newline
CTL = %x00-1F / %x7F CTL = %x00-08 / %x0A-1F / %x7F
; Controls ; Controls
ALPHA = %x41-5A / %x61-7A ; A-Z / a-z ALPHA = %x41-5A / %x61-7A ; A-Z / a-z
Dawson/Stenerson 13 Expires September 1998 Dawson/Stenerson 14 Expires November 1998
DIGIT = %x30-39 DIGIT = %x30-39
; 0-9 ; 0-9
DQUOTE = %x22 DQUOTE = %x22
; Quotation Mark ; Quotation Mark
WSP = SPACE / HTAB WSP = SPACE / HTAB
SPACE = %x20 SPACE = %x20
HTAB = %x09 HTAB = %x09
The property value component of a content line has a format that is The property value component of a content line has a format that is
property specific. Refer to the section describing each property for property specific. Refer to the section describing each property for
a definition of this format. a definition of this format.
All names of properties, property parameters, enumerated property
values and property parameter values are case-insensitive. However,
all other property values are case-sensitive, unless otherwise
stated.
4.1.1 List and Field Separators 4.1.1 List and Field Separators
List of values MAY be specified for property values or property Some properties and parameters allow a list of values. Each value in
parameter values. Each value in a list of values MUST be separated by a list of values MUST be separated by a COMMA character (US-ASCII
a COMMA character (ASCII decimal 44). decimal 44). There is no significance to the ordering of values in a
list. For those parameter values (such as those that specify URI
values) that are specified in quoted-strings, the individual quoted-
strings are separated by a COMMA character (US-ASCII decimal 44).
Some property values are defined in terms of multiple components. Some property values are defined in terms of multiple parts. These
These structured property values MUST have their components separated structured property values MUST have their value parts separated by a
by a SEMICOLON character (ASCII decimal 59). SEMICOLON character (US-ASCII decimal 59).
Lists of property parameters MAY be specified for a property. Each Some properties allow a list of parameters. Each property parameter
property parameter in a list of property parameters MUST be separated in a list of property parameters MUST be separated by a SEMICOLON
by a SEMICOLON character (ASCII decimal 59). character (US-ASCII decimal 59).
Property parameters with values containing a COLON, a SEMICOLON or a Property parameters with values containing a COLON, a SEMICOLON or a
COMMA character must be placed in quoted text string. COMMA character MUST be placed in quoted text.
For example, in the following properties a SEMICOLON is used to For example, in the following properties a SEMICOLON is used to
separate property parameters and property value fields. A COMMA is separate property parameters and property value fields. A COMMA is
used to separate values. used to separate values.
ATTENDEE;RSVP=TRUE;ROLE=REQ-PARTICIPANT:MAILTO: ATTENDEE;RSVP=TRUE;ROLE=REQ-PARTICIPANT:MAILTO:
jsmith@host.com jsmith@host.com
RDATE;VALUE=DATE:19970304,19970504,19970704,19970904 RDATE;VALUE=DATE:19970304,19970504,19970704,19970904
4.1.2 Multiple Values 4.1.2 Multiple Values
Some properties defined in the iCalendar object MAY have multiple Some properties defined in the iCalendar object can have multiple
values. The general rule for encoding multi-valued items is to simply values. The general rule for encoding multi-valued items is to simply
create a new content line for each value; including the property
Dawson/Stenerson 15 Expires November 1998
create a new content line for each value, including the property
name. However, it should be noted that some properties support name. However, it should be noted that some properties support
encoding multiple values in a single property by separating the encoding multiple values in a single property by separating the
values with a COMMA character (ASCII decimal 44). values with a COMMA character (US-ASCII decimal 44). Individual
property definitions should be consulted for determining whether a
Dawson/Stenerson 14 Expires September 1998 specific property allows multiple values and in which of these two
forms.
4.1.3 Binary Content 4.1.3 Binary Content
Binary content information in an iCalendar object SHOULD be Binary content information in an iCalendar object SHOULD be
referenced using a URI within a property value. That is the binary referenced using a URI within a property value. That is the binary
content information SHOULD be placed in an external MIME entity that content information SHOULD be placed in an external MIME entity that
can be referenced by a URI from within the iCalendar object. In can be referenced by a URI from within the iCalendar object. In
applications where this is not feasible, binary content information applications where this is not feasible, binary content information
MAY be included within an iCalendar object, but only after first can be included within an iCalendar object, but only after first
encoding it into text using the "B" encoding method defined in [RFC encoding it into text using the "BASE64" encoding method defined in
2047]. Support for inline binary content SHOULD be restricted to [RFC 2045]. Support for inline binary content SHOULD be restricted to
those applications requirements that necessitate conveying the those applications requirements that necessitate conveying the
complete calendaring and scheduling information within a single complete calendaring and scheduling information within a single
iCalendar object. A property containing inline binary content iCalendar object. A property containing inline binary content
information MUST specify the "ENCODING" property parameter. Binary information MUST specify the "ENCODING" property parameter. Binary
content information placed external to the iCalendar object MUST be content information placed external to the iCalendar object MUST be
referenced by a uniform resource identifier (URI). referenced by a uniform resource identifier (URI).
The following example specifies an "ATTACH" property that references The following example specifies an "ATTACH" property that references
an attachment external to the iCalendar object with a URI reference: an attachment external to the iCalendar object with a URI reference:
ATTACH:http://xyz.com/public/quarterly-report.doc ATTACH:http://xyz.com/public/quarterly-report.doc
The following example specifies an "ATTACH" property with inline The following example specifies an "ATTACH" property with inline
binary encoded content information: binary encoded content information:
ATTACH;ENCODING=b;VALUE=binary:MIICajCCAdOgAwIBAgICBEUwDQYJKoZI ATTACH;ENCODING=BASE64;VALUE=BINARY:MIICajCCAdOgAwIBAgICBEUwD
hvcNAQEEBQAwdzELMAkGA1UEBhMCVVMxLDAqBgNVBAoTI05ldHNjYXBlIENv QYJKoZIhvcNAQEEBQAwdzELMAkGA1UEBhMCVVMxLDAqBgNVBAoTI05ldHNjY
bW11bmljYXRpb25zIENvcnBvcmF0aW9uMRwwGgYDVQQLExNJbmZvcm1hdGlv XBlIENvbW11bmljYXRpb25zIENvcnBvcmF0aW9uMRwwGgYDVQQLExNJbmZvc
biBTeXN0 <...remainder of "B" encoded binary data...> <...remainder of "BASE64" encoded binary data...>
4.1.4 Character Set 4.1.4 Character Set
There is not a property parameter to declare the character set used There is not a property parameter to declare the character set used
in a property value. The default character set for an iCalendar in a property value. The default character set for an iCalendar
object is [UTF-8]. object is UTF-8 as defined in [RFC 2279].
The "charset" Content-Type parameter MAY be used in MIME transports The "charset" Content-Type parameter can be used in MIME transports
to specify any other IANA registered character set. to specify any other IANA registered character set.
4.2 Property Parameters 4.2 Property Parameters
A property MAY have additional attributes associated with it. These A property can have attributes associated with it. These "property
"property parameters" contain meta information about the property or parameters" contain meta-information about the property or the
the property value. Property parameters MAY be used to specify the property value. Property parameters are provided to specify such
location of an alternate text representation for a property value, information as the location of an alternate text representation for a
the language of a text property value or the data type of the
property value. In addition, individual properties MAY define
property-specific parameters that apply only to that property.
Property parameter values that contain the COLON, SEMICOLON, COMMA or Dawson/Stenerson 16 Expires November 1998
BACKSLASH character separators MUST be specified as quoted-string property value, the language of a text property value, the data type
text values. For example: of the property value and other attributes.
Property parameter values that contain the COLON (US-ASCII decimal
58), SEMICOLON (US-ASCII decimal 59) or COMMA (US-ASCII decimal 44)
character separators MUST be specified as quoted-string text values.
Property parameter values MUST NOT contain the DOUBLE-QUOTE (US-ASCII
decimal 22) character. The DOUBLE-QUOTE (US-ASCII decimal 22)
character is used as a delimiter for parameter values that contain
restricted characters or URI text. For example:
Dawson/Stenerson 15 Expires September 1998
DESCRIPTION;ALTREP="http://www.wiz.org":The Fall'98 Wild Wizards DESCRIPTION;ALTREP="http://www.wiz.org":The Fall'98 Wild Wizards
Conference - - Las Vegas, NV, USA Conference - - Las Vegas, NV, USA
Property parameter values that are not in quoted strings are case Property parameter values that are not in quoted strings are case
insensitive. insensitive.
The general property parameters defined by this memo are specified The general property parameters defined by this memo are defined by
the following notation: the following notation:
parameter = altrepparm ;Alternate text representation parameter = altrepparam ; Alternate text representation
/ encodingparm ;Inline encoding / cnparam ; Common name
/ languageparm ;National language for text / cutypeparam ; Calendar user type
/ tzidparm ;Reference to time zone object / delfromparam ; Delegator
/ valuetypeparm ;Property value data type / deltoparam ; Delegatee
/ iana-token / dirparam ; Directory entry
;Some other IANA registered iCalendar parameter, such as those / encodingparam ; Inline encoding
;defined by an individual property. / fbtypeparam ; Free/busy time type
/ x-name / languageparam ; Language for text
;A non-standard, experimental parameter / memberparam ; Group or list membership
/ partstatparam ; Participation status
/ rangeparam ; Recurrence identifier range
/ trigrelparam ; Alarm trigger relationship
/ reltypeparam ; Relationship type
/ roleparam ; Participation role
/ rsvpparam ; RSVP expectation
/ sentbyparam ; Sent by
/ tzidparam ; Reference to time zone object
/ valuetypeparam ; Property value data type
/ ianaparam
; Some other IANA registered iCalendar parameter.
/ xparam
; A non-standard, experimental parameter.
ianaparam = iana-token "=" param-value *("," param-value)
xparam =x-name "=" param-value *("," param-value)
4.2.1 Alternate Text Representation 4.2.1 Alternate Text Representation
Parameter Name: ALTREP Parameter Name: ALTREP
Purpose: To specify an alternate text representation for the property Purpose: To specify an alternate text representation for the property
value. value.
Conformance: Optional Dawson/Stenerson 17 Expires November 1998
Format Definition: The property parameter is defined by the following Format Definition: The property parameter is defined by the following
notation: notation:
altrepparm = "altrep" "=" DQUOTE uri DQUOTE altrepparam = "ALTREP" "=" DQUOTE uri DQUOTE
Description: The parameter specifies a URI that points to an Description: The parameter specifies a URI that points to an
alternate representation for a textual property value. A property alternate representation for a textual property value. A property
specifying this parameter MUST also include a value that reflects the specifying this parameter MUST also include a value that reflects the
default representation. default representation of the text value. The individual URI
parameter values MUST be specified in a quoted-string.
This property parameter MAY include multiple values, separated by the
COMMA character (ASCII decimal 44). The property parameter MAY only
be specified in the "COMMENT", "CONTACT", "DESCRIPTION", "LOCATION"
and "SUMMARY" properties.
Example: Example:
DESCRIPTION;ALTREP="CID:<part3.msg.970415T083000@host.com>":Project DESCRIPTION;ALTREP="CID:<part3.msg.970415T083000@host.com>":Project
XYZ Review Meeting will include the following agenda items: (a) XYZ Review Meeting will include the following agenda items: (a)
Market Overview, (b) Finances, (c) Project Management Market Overview, (b) Finances, (c) Project Management
The "ALTREP" property parameter value might point to a "text/html" The "ALTREP" property parameter value might point to a "text/html"
content portion. content portion.
Dawson/Stenerson 16 Expires September 1998
Content-Type:text/html Content-Type:text/html
Content-Id:<part3.msg.970415T083000@host.com> Content-Id:<part3.msg.970415T083000@host.com>
<html><body>
<p><b>Project XYZ Review Meeting</b> will include the following <p><b>Project XYZ Review Meeting</b> will include the following
agenda items:<li>Market agenda items:<li>Market
Overview</li><li>Finances</li><li>Project Management</li></p> Overview</li><li>Finances</li><li>Project Management</li></p>
</html></body>
4.2.2 Inline Encoding 4.2.2 Common Name
Parameter Name: CN
Purpose: To specify the common name to be associated with the
calendar user specified by the property.
Format Definition: The property parameter is defined by the following
notation:
cnparam = "CN" "=" param-value
Description: This parameter can be specified on properties with a
CAL-ADDRESS value type. The parameter specifies the common name to be
associated with the calendar user specified by the property. The
parameter value is text. The parameter value can be used for display
text to be associated with the calendar address specified by the
property.
Example:
ORGANIZER;CN="John Smith":MAILTO:jsmith@host.com
Dawson/Stenerson 18 Expires November 1998
4.2.3 Calendar User Type
Parameter Name: CUTYPE
Purpose: To specify the type of calendar user specified by the
property.
Format Definition: The property parameter is defined by the following
notation:
cutypeparam = "CUTYPE" "="
("INDIVIDUAL" ; An individual
/ "GROUP" ; A group of individuals
/ "RESOURCE" ; A physical resource
/ "ROOM" ; A room resource
/ "UNKNOWN" ; Otherwise not known
/ x-name ; Experimental type
/ iana-token) ; Other IANA registered
; type
; Default is INDIVIDUAL
Description: This parameter can be specified on properties with a
CAL-ADDRESS value type. The parameter identifies the type of calendar
user specified by the property. If not specified on a property that
allows this parameter, the default is INDIVIDUAL.
Example:
ATTENDEE;CUTYPE=GROUP:MAILTO:ietf-calsch@imc.org
4.2.4 Delegators
Parameter Name: DELEGATED-FROM
Purpose: To specify the calendar users that have delegated their
participation to the calendar user specified by the property.
Format Definition: The property parameter is defined by the following
notation:
delfromparam = "DELEGATED-FROM" "=" DQUOTE cal-address DQUOTE
*("," DQUOTE cal-address DQUOTE)
Description: This parameter can be specified on properties with a
CAL-ADDRESS value type. This parameter can be specified on a property
that has a value type of calendar address. This parameter specifies
those calendar uses that have delegated their participation in a
group scheduled event or to-do to the calendar user specified by the
property. The value MUST be a MAILTO URI as defined in [RFC 1738].
The individual URI parameter values MUST be specified in a quoted-
string.
Example:
Dawson/Stenerson 19 Expires November 1998
ATTENDEE;DELEGATED-FROM="MAILTO:jsmith@host.com":MAILTO:
jdoe@host.com
4.2.5 Delegatees
Parameter Name: DELEGATED-TO
Purpose: To specify the calendar users whom the calendar user
specified by the property has delegated participation to.
Format Definition: The property parameter is defined by the following
notation:
deltoparam = "DELEGATED-TO" "=" DQUOTE cal-address DQUOTE
*("," DQUOTE cal-address DQUOTE)
Description: This parameter can be specified on properties with a
CAL-ADDRESS value type. This parameter specifies those calendar users
whom have been delegated participation in a group scheduled event or
to-do by the calendar user specified by the property. The value MUST
be a MAILTO URI as defined in [RFC 1738]. The individual URI
parameter values MUST be specified in a quoted-string.
Example:
ATTENDEE;DELEGATED-TO="MAILTO:jdoe@host.com","MAILTO:jqpublic@
host.com":MAILTO:jsmith@host.com
4.2.6 Directory Entry Reference
Parameter Name: DIR
Purpose: To specify reference to a directory entry associated with
the calendar user specified by the property.
Format Definition: The property parameter is defined by the following
notation:
dirparam = "DIR" "=" DQUOTE uri DQUOTE
Description: This parameter can be specified on properties with a
CAL-ADDRESS value type. The parameter specifies a reference to the
directory entry associated with the calendar user specified by the
property. The parameter value is a URI. The individual URI parameter
values MUST be specified in a quoted-string.
Example:
ORGANIZER;DIR="ldap://host.com:6666/o=eDABC%20Industries,c=3DUS??
(cn=3DBJim%20Dolittle)":MAILTO:jimdo@host1.com
4.2.7 Inline Encoding
Parameter Name: ENCODING Parameter Name: ENCODING
Dawson/Stenerson 20 Expires November 1998
Purpose: To specify an alternate inline encoding for the property Purpose: To specify an alternate inline encoding for the property
value. value.
Conformance: Required, if the inline encoding is not "8bit".
Format Definition: The property parameter is defined by the following Format Definition: The property parameter is defined by the following
notation: notation:
encodingparm = "encoding" "=" "8bit" encodingparam = "ENCODING" "="
("8BIT"
;"8bit" text encoding is defined in [RFC 2045] ;"8bit" text encoding is defined in [RFC 2045]
/ "b" / "BASE64"
;"b" binary encoding format is defined in [RFC 2047] ; "BASE64" binary encoding format is defined in [RFC 2045]
/ iana-token / iana-token
;Some other IANA registered iCalendar encoding type ;Some other IANA registered iCalendar encoding type
/ x-name / x-name)
;A non-standard, experimental encoding type ;A non-standard, experimental encoding type
Description: The "ENCODING property parameter is an OPTIONAL property Description: The property parameter identifies the inline encoding
parameter. It identifies the inline encoding used in a property used in a property value. The default encoding is "8BIT",
value. The default encoding type is "8bit", corresponding to a corresponding to a property value consisting of text. The "BASE64"
property value consisting of text. The "b" encoding type corresponds encoding type corresponds to a property value encoded using the
to a property value encoded using the "B" encoding defined in [RFC "BASE64" encoding defined in [RFC 2045].
2047].
If the value type parameter is ";VALUE=BINARY", then the inline If the value type parameter is ";VALUE=BINARY", then the inline
encoding parameter MUST be specified with the value ";ENCODING=B". encoding parameter MUST be specified with the value
";ENCODING=BASE64".
4.2.3 Language Example:
Parameter Name: LANGUAGE ATTACH;ENCODING=BASE64;VALUE=BINARY:MIICajCCAdOgAwIBAgICBEUwD
QYJKoZIhvcNAQEEBQAwdzELMAkGA1UEBhMCVVMxLDAqBgNVBAoTI05ldHNjY
XBlIENvbW11bmljYXRpb25zIENvcnBvcmF0aW9uMRwwGgYDVQQLExNJbmZvc
<...remainder of "BASE64" encoded binary data...>
Purpose: To specify the national language for text values in a 4.2.8 Free/Busy Time Type
property or property parameter.
Conformance: Optional. There is no default national language for a Parameter Name: FBTYPE
text value.
Purpose: To specify the free or busy time type.
Format Definition: The property parameter is defined by the following Format Definition: The property parameter is defined by the following
notation: notation:
languageparm = "language" "=" language fbtypeparam = "FBTYPE" "=" ("FREE" / "BUSY"
/ "BUSY-UNAVAILABLE" / "BUSY-TENTATIVE"
/ x-name
; Some experimental iCalendar data type.
/ iana-token)
; Some other IANA registered iCalendar data type.
Description: The parameter specifies the free or busy time type. The
value FREE indicates that the time interval is free for scheduling.
The value BUSY indicates that the time interval is busy because one
or more events have been scheduled for that interval. The value BUSY-
UNAVAILABLE indicates that the time interval is busy and that the
Dawson/Stenerson 21 Expires November 1998
interval can not be scheduled. The value BUSY-TENTATIVE indicates
that the time interval is busy because one or more events have been
tentatively scheduled for that interval. If not specified on a
property that allows this parameter, the default is BUSY.
Example: The following is an example of this parameter on a FREEBUSY
property.
FREEBUSY;FBTYPE=BUSY:19980415T133000Z/19980415T170000Z
4.2.9 Language
Parameter Name: LANGUAGE
Purpose: To specify the language for text values in a property or
property parameter.
Format Definition: The property parameter is defined by the following
notation:
languageparam = "LANGUAGE" "=" language
language = <Text identifying a language, as defined in [RFC 1766]> language = <Text identifying a language, as defined in [RFC 1766]>
Dawson/Stenerson 17 Expires September 1998 Description: This parameter can be specified on properties with a
Description: The parameter identifies the national language of the text value type. The parameter identifies the language of the text in
text in the property or property parameter value. The value of the the property or property parameter value. The value of the "language"
"language" property parameter is that defined in [RFC 1766]. property parameter is that defined in [RFC 1766].
Note: For transport in a MIME entity, the Content-Language For transport in a MIME entity, the Content-Language header field can
header field MAY be used to set the default language for the be used to set the default language for the entire body part.
entire body part. Otherwise, no default language is assumed.
Example: Example:
SUMMARY;LANGUAGE=us-EN:Company Holiday Party SUMMARY;LANGUAGE=us-EN:Company Holiday Party
ATTENDEE;CN=Henri Weisz;LANGUAGE=ca-FR:hweisz@host.com LOCATION;LANGUAGE=en:Germany
LOCATION;LANGUAGE=no:Tyskland
4.2.4 Time Zone Identifier The following example makes use of the Quoted-Printable encoding in
order to represent non-ASCII characters.
LOCATION;LANGUAGE=da:K=F8benhavn
LOCATION;LANGUAGE=en:Copenhagen
4.2.10 Group or List Membership
Parameter Name: MEMBER
Purpose: To specify the group or list membership of the calendar user
specified by the property.
Dawson/Stenerson 22 Expires November 1998
Format Definition: The property parameter is defined by the following
notation:
memberparam = "MEMBER" "=" DQUOTE cal-address DQUOTE
*("," DQUOTE cal-address DQUOTE)
Description: This parameter can be specified on properties with a
CAL-ADDRESS value type. The parameter identifies the groups or list
membership for the calendar user specified by the property. The
parameter value either a single calendar address in a quoted-string
or a COMMA character (US-ASCII decimal 44) list of calendar
addresses, each in a quoted-string. The individual calendar address
parameter values MUST be specified in a quoted-string.
Example:
ATTENDEE;MEMBER="MAILTO:ietf-calsch@imc.org":MAILTO:jsmith@host.com
ATTENDEE;MEMBER="MAILTO:projectA@host.com","MAILTO:projectB@host.
com":MAILTO:janedoe@host.com
4.2.11 Participation Status
Parameter Name: PARTSTAT
Purpose: To specify the participation status for the calendar user
specified by the property.
Format Definition: The property parameter is defined by the following
notation:
partstatparam = "PARTSTAT" "="
("NEEDS-ACTION" ; Event needs action
/ "ACCEPTED" ; Event accepted
/ "DECLINED" ; Event declined
/ "TENTATIVE" ; Event tentatively
; accepted
/ "DELEGATED" ; Event delegated
/ x-name ; Experimental status
/ iana-token) ; Other IANA registered
; status
; These are the participation statuses for a "VEVENT". Default is
; NEEDS-ACTION
partstatparam /= "PARTSTAT" "="
("NEEDS-ACTION" ; To-do needs action
/ "ACCEPTED" ; To-do accepted
/ "DECLINED" ; To-do declined
/ "TENTATIVE" ; To-do tentatively
; accepted
/ "DELEGATED" ; To-do delegated
/ "COMPLETED" ; To-do completed.
; COMPLETED property has
;date/time completed.
Dawson/Stenerson 23 Expires November 1998
/ "IN-PROCESS" ; To-do in process of
; being completed
/ x-name ; Experimental status
/ iana-token) ; Other IANA registered
; status
; These are the participation statuses for a "VTODO". Default is
; NEEDS-ACTION
partstatparam /= "PARTSTAT" "="
("NEEDS-ACTION" ; Journal needs action
/ "ACCEPTED" ; Journal accepted
/ "DECLINED" ; Journal declined
/ x-name ; Experimental status
/ iana-token) ; Other IANA registered
; status
; These are the participation statuses for a "VJOURNAL". Default is
; NEEDS-ACTION
4.2.12 Recurrence Identifier Range
Parameter Name: RANGE
Purpose: To specify the effective range of recurrence instances from
the instance specified by the recurrence identifier specified by the
property.
Format Definition: The property parameter is defined by the following
notation:
rangeparam = "RANGE" "=" ("THISANDPRIOR"
; To specify all instances prior to the recurrence identifier
/ "THISANDFUTURE")
; To specify the instance specified by the recurrence identifier
; and all subsequent recurrence instances
Description: The parameter can be specified on a property that
specifies a recurrence identifier. The parameter specifies the
effective range of recurrence instances that is specified by the
property. The effective range is from the recurrence identified
specified by the property. If this parameter is not specified an
allowed property, then the default range is the single instance
specified by the recurrence identifier value of the property. The
parameter value can be "THISANDPRIOR" to indicate a range defined by
the recurrence identified value of the property and all prior
instances. The parameter value can also be "THISANDFUTURE" to
indicate a range defined by the recurrence identifier and all
subsequent instances.
Example:
RECURRENCE-ID;RANGE=THISANDPRIOR:19980401T133000Z
Dawson/Stenerson 24 Expires November 1998
4.2.13 Alarm Trigger Relationship
Parameter Name: RELATED
Purpose: To specify the relationship of the alarm trigger with
respect to the start or end of the calendar component.
Format Definition: The property parameter is defined by the following
notation:
trigrelparam = "RELATED" "="
("START" ; Trigger off of start
/ "END") ; Trigger off of end
Description: The parameter can be specified on properties that
specify an alarm trigger with a DURATION value type. The parameter
specifies whether the alarm will trigger relative to the start or end
of the calendar component. The parameter value START will set the
alarm to trigger off the start of the calendar component; the
parameter value END will set the alarm to trigger off the end of the
calendar component. If the parameter is not specified on an allowable
property, then the default is START.
Example:
TRIGGER;RELATED=END:PT5M
4.2.14 Relationship Type
Parameter Name: RELTYPE
Purpose: To specify the type of hierarchical relationship associated
with the calendar component specified by the property.
Format Definition: The property parameter is defined by the following
notation:
reltypeparam = "RELTYPE" "="
("PARENT" ; Parent relationship. Default.
/ "CHILD" ; Child relationship
/ "SIBLING ; Sibling relationship
/ iana-token ; Some other IANA registered
; iCalendar relationship type
/ x-name) ; A non-standard, experimental
; relationship type
Description: This parameter can be specified on a property that
references another related calendar. The parameter specifies the
hierarchical relationship type of the calendar component referenced
by the property. The parameter value can be PARENT, to indicate that
the referenced calendar component is a superior of calendar
component; CHILD to indicate that the referenced calendar component
is a subordinate of the calendar component; SIBLING to indicate that
the referenced calendar component is a peer of the calendar
Dawson/Stenerson 25 Expires November 1998
component. If this parameter is not specified on an allowable
property, the default relationship type is PARENT.
Example:
RELATED-TO;RELTYPE=SIBLING:<19960401-080045-4000F192713@host.com>
Description: This parameter can be specified on properties with a
CAL-ADDRESS value type. The parameter identifies the participation
status for the calendar user specified by the property value. The
parameter values differ depending on whether they are associated with
a group scheduled "VEVENT", "VTODO" or "VJOURNAL". The values MUST
match one of the values allowed for the given calendar component. If
not specified on a property that allows this parameter, the default
value is NEEDS-ACTION.
Example:
ATTENDEE;PARTSTAT=DECLINED:MAILTO:jsmith@host.com
4.2.15 Participation Role
Parameter Name: ROLE
Purpose: To specify the participation role for the calendar user
specified by the property.
Format Definition: The property parameter is defined by the following
notation:
roleparam = "ROLE" "="
("CHAIR" ; Indicates chair of the
; calendar entity
/ "REQ-PARTICIPANT" ; Indicates a participant whose
; participation is required
/ "OPT-PARTICIPANT" ; Indicates a participant whose
; participation is optional
/ "NON-PARTICIPANT" ; Indicates a participant who is
; copied for information
; purposes only
/ x-name ; Experimental role
/ iana-token) ; Other IANA role
; Default is REQ-PARTICIPANT
Description: This parameter can be specified on properties with a
CAL-ADDRESS value type. The parameter specifies the participation
role for the calendar user specified by the property in the group
schedule calendar component. If not specified on a property that
allows this parameter, the default value is REQ-PARTICIPANT.
Example:
ATTENDEE;ROLE=CHAIR:MAILTO:mrbig@host.com
Dawson/Stenerson 26 Expires November 1998
4.2.16 RSVP Expectation
Parameter Name: RSVP
Purpose: To specify whether there is an expectation of a favor of a
reply from the calendar user specified by the property value.
Format Definition: The property parameter is defined by the following
notation:
rsvpparam = "RSVP" "=" ("TRUE" / "FALSE")
; Default is FALSE
Description: This parameter can be specified on properties with a
CAL-ADDRESS value type. The parameter identifies the expectation of a
reply from the calendar user specified by the property value. This
parameter is used by the "Organizer" to request a participation
status reply from an "Attendee" of a group scheduled event or to-do.
If not specified on a property that allows this parameter, the
default value is FALSE.
Example:
ATTENDEE;RSVP=TRUE:MAILTO:jsmith@host.com
4.2.17 Sent By
Parameter Name: SENT-BY
Purpose: To specify the calendar user that is acting on behalf of the
calendar user specified by the property.
Format Definition: The property parameter is defined by the following
notation:
sentbyparam = "SENT-BY" "=" DQUOTE cal-address DQUOTE
Description: This parameter can be specified on properties with a
CAL-ADDRESS value type. The parameter specifies the calendar user
that is acting on behalf of the calendar user specified by the
property. The parameter value MUST be a MAILTO URI as defined in [RFC
1738]. The individual URI parameter values MUST be specified in a
quoted-string.
Example:
ORGANIZER;SENT-BY:"MAILTO:sray@host.com":MAILTO:jsmith@host.com
4.2.18 Time Zone Identifier
Parameter Name: TZID Parameter Name: TZID
Purpose: To specify the identifier for the time zone definition for a Purpose: To specify the identifier for the time zone definition for a
time value. time component in the property value.
Conformance: Optional
Dawson/Stenerson 27 Expires November 1998
Format Definition: This property parameter is defined by the Format Definition: This property parameter is defined by the
following notation: following notation:
tzidparm = "TZID" "=" [tzidprefix] paramtext CRLF tzidparam = "TZID" "=" [tzidprefix] paramtext CRLF
tzidprefix = "/" tzidprefix = "/"
Description: The parameter MAY only be used on the "DTSTART", Description: The parameter MUST be specify on the "DTSTART", "DTEND",
"DTEND", "DUE", "EXDATE" and "RDATE " properties when either a DATE- "DUE", "EXDATE" and "RDATE" properties when either a DATE-TIME or
TIME or TIME value type is specified. This property parameter TIME value type is specified and when the value is not either a UTC
specifies a text value which uniquely identifies the "VTIMEZONE" or a "floating" time. This property parameter specifies a text value
calendar component to be used when evalating the time portion of the which uniquely identifies the "VTIMEZONE" calendar component to be
property. The value of the TZID property parameter will be equal to used when evaluating the time portion of the property. The value of
the value of the TZID property for the matching "TIMEZONE" object. the TZID property parameter will be equal to the value of the TZID
The presence of the SOLIDUS character (ASCII decimal 47) as a prefix, property for the matching time zone definition. An individual
indicates that this TZID represents a unique ID in a globally defined "VTIMEZONE" calendar component MUST be specified for each unique
time zone registry (when such registry is defined). "TZID" parameter value specified in the iCalendar object.
The parameter MUST be specified on properties with a DATE-TIME value
if the DATE-TIME is not either a UTC or a "floating" time.
The presence of the SOLIDUS character (US-ASCII decimal 47) as a
prefix, indicates that this TZID represents a unique ID in a globally
defined time zone registry (when such registry is defined).
The following are examples of this property parameter: The following are examples of this property parameter:
DTSTART;TZID=America-New_York:19980119T020000 DTSTART;TZID=America-New_York:19980119T020000
DTEND;TZID=America-New_York:19980119T030000 DTEND;TZID=America-New_York:19980119T030000
The TZID property parameter MUST NOT be applied to DATE-TIME nor TIME The TZID property parameter MUST NOT be applied to DATE-TIME or TIME
properties whose time values are specified in UTC. properties whose time values are specified in UTC.
The use of local time in a DATE-TIME or TIME value without the TZID The use of local time in a DATE-TIME or TIME value without the TZID
property parameter is to be interpreted as a local time value, property parameter is to be interpreted as a local time value,
regardless of the existence of "VTIMEZONE" calendar components in the regardless of the existence of "VTIMEZONE" calendar components in the
iCalendar object. iCalendar object.
Dawson/Stenerson 18 Expires September 1998
For more information see the sections on the data types DATE-TIME and For more information see the sections on the data types DATE-TIME and
TIME. TIME.
4.2.5 Value Data Types 4.2.19 Value Data Types
Parameter Name: VALUE Parameter Name: VALUE
Purpose: To explicitly specify the data type format for a property Purpose: To explicitly specify the data type format for a property
value. value.
Conformance: Optional if using the default value type in a property
value. Otherwise, it is required.
Format Definition: The "VALUE" property parameter is defined by the Format Definition: The "VALUE" property parameter is defined by the
following notation: following notation:
valuetypeparm = "value" "=" valuetype valuetypeparam = "VALUE" "=" valuetype
valuetype = "binary" Dawson/Stenerson 28 Expires November 1998
/ "boolean" valuetype = ("BINARY"
/ "cal-address" / "BOOLEAN"
/ "date" / "CAL-ADDRESS"
/ "date-time" / "DATE"
/ "duration" / "DATE-TIME"
/ "float" / "DURATION"
/ "integer" / "FLOAT"
/ "period" / "INTEGER"
/ "recur" / "PERIOD"
/ "text" / "RECUR"
/ "time" / "TEXT"
/ "uri" / "TIME"
/ "utc-offset" / "URI"
/ "UTC-OFFSET"
/ x-name / x-name
;Some experimental iCalendar data type. ;Some experimental iCalendar data type.
/ iana-token / iana-token)
;Some other IANA registered iCalendar data type. ;Some other IANA registered iCalendar data type.
Description: The parameter is used to identify the data type and Description: The parameter specifies the data type and format of the
format of the property value. The property values MUST be of a single property value. The property values MUST be of a single value type.
value type. For example, a "RDATE" property cannot have a combination For example, a "RDATE" property cannot have a combination of DATE-
of DATE-TIME and TIME value types. TIME and TIME value types.
If the property's value is the default value type, then this
parameter need not be specified. However, if the property's default
value type is overridden by some other allowable value type, then
this parameter MUST be specified.
4.3 Property Value Data Types 4.3 Property Value Data Types
The properties in an iCalendar object are strongly typed. The The properties in an iCalendar object are strongly typed. The
definition of each property restricts the value to be one of the definition of each property restricts the value to be one of the
value data types, or simply value types, defined in this section. The value data types, or simply value types, defined in this section. The
value type for a property will either be specified implicitly as the value type for a property will either be specified implicitly as the
default value type or will be explicitly specified with the "VALUE" default value type or will be explicitly specified with the "VALUE"
parameter. If the value type of a property is one of the alternate parameter. If the value type of a property is one of the alternate
valid types, then it MUST be explicitly specified with the "VALUE" valid types, then it MUST be explicitly specified with the "VALUE"
parameter. parameter.
Dawson/Stenerson 19 Expires September 1998
4.3.1 Binary 4.3.1 Binary
Value Name: BINARY Value Name: BINARY
Purpose: This value type is used to identify properties that contain Purpose: This value type is used to identify properties that contain
a character encoding of inline binary data. For example, an inline a character encoding of inline binary data. For example, an inline
attachment of an object code MAY BE included in an iCalendar object. attachment of an object code might be included in an iCalendar
object.
Formal Definition: The value type is defined by the following Formal Definition: The value type is defined by the following
notation: notation:
binary = *(4b-char) [b-end] binary = *(4b-char) [b-end]
; A "B" encoded character string, as defined by [RFC 2047]. ; A "BASE64" encoded character string, as defined by [RFC 2045].
Dawson/Stenerson 29 Expires November 1998
b-end = (2b-char "==") / (3b-char "=") b-end = (2b-char "==") / (3b-char "=")
b-char = ALPHA / DIGIT / "+" / "/" b-char = ALPHA / DIGIT / "+" / "/"
Description: Property values with this value type MUST also include Description: Property values with this value type MUST also include
the inline encoding parameter sequence of ";ENCODING=B". That is, all the inline encoding parameter sequence of ";ENCODING=BASE64". That
inline binary data MUST first be character encoded using the "B" is, all inline binary data MUST first be character encoded using the
encoding method defined in [RFC 2047]. No additional content value "BASE64" encoding method defined in [RFC 2045]. No additional content
encoding (i.e., BACKSLASH character encoding) is defined for this value encoding (i.e., BACKSLASH character encoding) is defined for
value type. this value type.
Example: The following is an abridged example of a "B" encoded binary Example: The following is an abridged example of a "BASE64" encoded
value data. binary value data.
ATTACH;VALUE=BINARY:MIICajCCAdOgAwIBAgICBEUwDQYJKoZIhvcNAQEEBQA ATTACH;VALUE=BINARY;ENCODING=BASE64:MIICajCCAdOgAwIBAgICBEUwDQY
wdzELMAkGA1UEBhMCVVMxLDAqBgNVBAoTI05ldHNjYXBlIENvbW11bmljYXRpb JKoZIhvcNAQEEBQAwdzELMAkGA1UEBhMCVVMxLDAqBgNVBAoTI05ldHNjYXBlI
25zIENvcnBvcmF0aW9uMRwwGgYDVQQLExNJbmZvcm1hdGlvbiBTeXN0 ENvbW11bmljYXRpb25zIENvcnBvcmF0aW9uMRwwGgYDVQQLExNJbmZv
<...remainder of "B" encoded binary data...> <...remainder of "BASE64" encoded binary data...>
4.3.2 Boolean 4.3.2 Boolean
Value Name: BOOLEAN Value Name: BOOLEAN
Purpose: This value type is used to identify properties that contain Purpose: This value type is used to identify properties that contain
either a "true" or "false" boolean value. either a "TRUE" or "FALSE" Boolean value.
Formal Definition: The value type is defind by the following Formal Definition: The value type is defind by the following
notation: notation:
boolean = "TRUE" / "FALSE" boolean = "TRUE" / "FALSE"
Description: These values are case insensitive text. No additional Description: These values are case insensitive text. No additional
content value encoding (i.e., BACKSLASH character encoding) is content value encoding (i.e., BACKSLASH character encoding) is
defined for this value type. defined for this value type.
Example: For example, any of the following are equivalent: Example: The following is an example of a hypothetical property that
has a BOOLEAN value type:
TRANSP;VALUE=BOOLEAN:TRUE
TRANSP;VALUE=BOOLEAN:true
TRANSP;VALUE=BOOLEAN:TrUe
Dawson/Stenerson 20 Expires September 1998 GIBBERISH:TRUE
4.3.3 Calendar User Address 4.3.3 Calendar User Address
Value Name: CAL-ADDRESS Value Name: CAL-ADDRESS
Purpose: This value type is used to identify properties that contain Purpose: This value type is used to identify properties that contain
a calendar user address. a calendar user address.
Formal Definition: The value type is as defined by the following Formal Definition: The value type is as defined by the following
notation: notation:
cal-address = uri cal-address = uri
Description: The value is a URI as defined by [RFC 1738] or any other Description: The value is a URI as defined by [RFC 1738] or any other
IANA registered form for a URI. When used to address an Internet IANA registered form for a URI. When used to address an Internet
Dawson/Stenerson 30 Expires November 1998
email transport address for a calendar user, the value MUST be a email transport address for a calendar user, the value MUST be a
MAILTO URI, as defined by [RFC 1738].No additional content value MAILTO URI, as defined by [RFC 1738].No additional content value
encoding (i.e., BACKSLASH character encoding) is defined for this encoding (i.e., BACKSLASH character encoding) is defined for this
value type. value type.
Example: Example:
ATTENDEE;VALUE=CAL-ADDRESS:MAILTO:jane_doe@host.com ATTENDEE:MAILTO:jane_doe@host.com
4.3.4 Date 4.3.4 Date
Value Name: DATE Value Name: DATE
Purpose: This value type is used to identify values that contain a Purpose: This value type is used to identify values that contain a
calendar date. calendar date.
Formal Definition: The value type is defined by the following Formal Definition: The value type is defined by the following
notation: notation:
date = date-value *("," [WSP] date-value) date = date-value
date-value = date-fullyear date-month date-mday date-value = date-fullyear date-month date-mday
date-fullyear = 4DIGIT date-fullyear = 4DIGIT
date-month = 2DIGIT ;01-12 date-month = 2DIGIT ;01-12
date-mday = 2DIGIT ;01-28, 01-29, 01-30, 01-31 date-mday = 2DIGIT ;01-28, 01-29, 01-30, 01-31
;based on month/year ;based on month/year
Description: If the property permits, multiple "date" values MAY be Description: If the property permits, multiple "date" values can be
specified using a COMMA character (ASCII decimal 44) separator specified using a COMMA character (US-ASCII decimal 44) separator
character.The format for the value type is expressed as the [ISO character.The format for the value type is expressed as the [ISO
8601] complete representation, basic format for a calendar date. The 8601] complete representation, basic format for a calendar date. The
textual format specifies a four-digit year, two-digit month, and two- textual format specifies a four-digit year, two-digit month, and two-
digit day of the month. There are no separator characters between the digit day of the month. There are no separator characters between the
year, month and day component text. year, month and day component text.
No additional content value encoding (i.e., BACKSLASH character No additional content value encoding (i.e., BACKSLASH character
encoding) is defined for this value type. encoding) is defined for this value type.
Example: The following represents July 14, 1997: Example: The following represents July 14, 1997:
Dawson/Stenerson 21 Expires September 1998
19970714 19970714
4.3.5 Date-Time 4.3.5 Date-Time
Value Name: DATE-TIME Value Name: DATE-TIME
Purpose: This value type is used to identify values that specify a Purpose: This value type is used to identify values that specify a
precise calendar data and time of day. precise calendar date and time of day.
Formal Definition: The value type is defined by the following Formal Definition: The value type is defined by the following
notation: notation:
date-time = dt-value *("," [WSP] dt-value) date-time = date "T" time ;As specified in the date and time
;value definitions
dt-value = date "T" time ;As specified above in date and time
Dawson/Stenerson 31 Expires November 1998
Description: If the property permits, multiple "date-time" values MAY Description: If the property permits, multiple "date-time" values MAY
be specified using a COMMA character (ASCII decimal 44) separator be specified using a COMMA character (US-ASCII decimal 44) separator
character. No additional content value encoding (i.e., BACKSLASH character. No additional content value encoding (i.e., BACKSLASH
character encoding) is defined for this value type. character encoding) is defined for this value type.
The "DATE-TIME" data type is used to identify values that contain a The "DATE-TIME" data type is used to identify values that contain a
precise calendar date and time of day. The format is based on the precise calendar date and time of day. The format is based on the
[ISO 8601] complete representation, basic format for a calendar date [ISO 8601] complete representation, basic format for a calendar date
and time of day. The text format is a concatenation of the "date", and time of day. The text format is a concatenation of the "date",
followed by the LATIN CAPITAL LETTER T character (ASCII decimal 84) followed by the LATIN CAPITAL LETTER T character (US-ASCII decimal
time designator, followed by the "time" format. 84) time designator, followed by the "time" format.
The "DATE-TIME" data type expresses time values in three forms: The "DATE-TIME" data type expresses time values in three forms:
The form of date and time with UTC offset MUST NOT be used. For The form of date and time with UTC offset MUST NOT be used. For
example, the following is not valid for a date-time value: example, the following is not valid for a date-time value:
DTSTART:19980119T230000-0800 DTSTART:19980119T230000-0800 ;Invalid time format
FORM #1: DATE WITH LOCAL TIME FORM #1: DATE WITH LOCAL TIME
The date with local time form is simply a date-time value that does The date with local time form is simply a date-time value that does
not contain the UTC designator nor does it reference a time zone. For not contain the UTC designator nor does it reference a time zone. For
example, the following represents Janurary 18, 1998, at 11 PM: example, the following represents Janurary 18, 1998, at 11 PM:
DTSTART:19980118T230000 DTSTART:19980118T230000
Date-time values of this type are said to be "floating" and are not Date-time values of this type are said to be "floating" and are not
bound to any time zone in particular. They are used to represent the bound to any time zone in particular. They are used to represent the
same hour, minute, and second value regardless of which time zone is same hour, minute, and second value regardless of which time zone is
currently being observed. For example, an event MAY be defined that currently being observed. For example, an event can be defined that
indicates that an individual will be busy from 11:00 AM to 1:00 PM indicates that an individual will be busy from 11:00 AM to 1:00 PM
every day, no matter which timezone the person is in. In these cases, every day, no matter which time zone the person is in. In these
a local time MAY be specified. The recipient of an iCalendar object cases, a local time can be specified. The recipient of an iCalendar
with a property value consisting of a local time, without any object with a property value consisting of a local time, without any
relative time zone information, should interpret the value as being relative time zone information, should interpret the value as being
fixed to whatever timezone the ATTENDEE is in at any given moment. fixed to whatever timezone the ATTENDEE is in at any given moment.
This means that two ATTENDEEs may participate in the same event at This means that two ATTENDEEs, in different time zones, receiving the
same event definition as a floating time, may be participating in the
Dawson/Stenerson 22 Expires September 1998 event at different actual times. Floating time should only be used
different UTC times; floating time should only be used where that is where that is the reasonable behavior.
reasonable behavior.
In most cases, a fixed time is desired. To properly communicate a In most cases, a fixed time is desired. To properly communicate a
fixed time in a property value, either UTC time or local time with fixed time in a property value, either UTC time or local time with
time zone reference MUST be specified. time zone reference MUST be specified.
The use of local time in a DATE-TIME value without the TZID property The use of local time in a DATE-TIME value without the TZID property
parameter is to be interpreted as a local time value, regardless of parameter is to be interpreted as floating time, regardless of the
the existence of "VTIMEZONE" calendar components in the iCalendar existence of "VTIMEZONE" calendar components in the iCalendar object.
object.
FORM #2: DATE WITH UTC TIME FORM #2: DATE WITH UTC TIME
The date with UTC time, or absolute time, is identified by a LATIN The date with UTC time, or absolute time, is identified by a LATIN
CAPITAL LETTER Z suffix character (ASCII decimal 90), the UTC CAPITAL LETTER Z suffix character (US-ASCII decimal 90), the UTC
Dawson/Stenerson 32 Expires November 1998
designator, appended to the time value. For example, the following designator, appended to the time value. For example, the following
represents January 19, 1998, at 0700 UTC: represents January 19, 1998, at 0700 UTC:
DTSTART:19980119T070000Z DTSTART:19980119T070000Z
The TZID property parameter MUST NOT be applied to DATE-TIME The TZID property parameter MUST NOT be applied to DATE-TIME
properties whose time values are specified in UTC. properties whose time values are specified in UTC.
FORM #3: DATE WITH LOCAL TIME AND TIME ZONE REFERENCE FORM #3: DATE WITH LOCAL TIME AND TIME ZONE REFERENCE
skipping to change at line 1180 skipping to change at line 1747
section on Time Zone. For example, the following represents 2 AM in section on Time Zone. For example, the following represents 2 AM in
New York on Janurary 19, 1998: New York on Janurary 19, 1998:
DTSTART;TZID=America-New_York:19980119T020000 DTSTART;TZID=America-New_York:19980119T020000
Example: The following represents July 14, 1997, at 1:30 PM in New Example: The following represents July 14, 1997, at 1:30 PM in New
York City in each of the three time formats, using the "DTSTART" York City in each of the three time formats, using the "DTSTART"
property. property.
DTSTART:19970714T133000 ;Local time DTSTART:19970714T133000 ;Local time
DTSTART:19970714T153000Z ;UTC time DTSTART:19970714T173000Z ;UTC time
DTSTART;TZID=America-NYC:19970714T133000 ;Local time and time DTSTART;TZID=America-NYC:19970714T133000 ;Local time and time
; zone reference ; zone reference
A time value MUST ONLY specify 60 seconds when specifying the
periodic "leap second" in the time value. For example:
COMPLETED:19970630T235960Z
4.3.6 Duration 4.3.6 Duration
Value Name: DURATION Value Name: DURATION
Purpose: This value type is used to identify properties that contain Purpose: This value type is used to identify properties that contain
a duration of time. a duration of time.
Formal Definition: The value type is defined by the following Formal Definition: The value type is defined by the following
notation: notation:
duration = dur-value *("," [WSP] dur-value) duration = (["+"] / "-") "P" (dur-date / dur-time / dur-week)
Dawson/Stenerson 23 Expires September 1998
dur-value = (["+"] / "-") "P" (dur-date / dur-time / dur-week)
dur-date = (dur-day) [dur-time] dur-date = dur-day [dur-time]
dur-time = "T" (dur-hour / dur-minute / dur-second) dur-time = "T" (dur-hour / dur-minute / dur-second)
dur-week = 1*DIGIT "W" dur-week = 1*DIGIT "W"
dur-hour = 1*DIGIT "H" [dur-minute] dur-hour = 1*DIGIT "H" [dur-minute]
dur-minute = 1*DIGIT "M" [dur-second] dur-minute = 1*DIGIT "M" [dur-second]
dur-second = 1*DIGIT "S" dur-second = 1*DIGIT "S"
dur-day = 1*DIGIT "D" dur-day = 1*DIGIT "D"
Description: If the property permits, multiple "duration" values MAY Description: If the property permits, multiple "duration" values can
be specified using a COMMA character (ASCII decimal 44) separator be specified using a COMMA character (US-ASCII decimal 44) separator
Dawson/Stenerson 33 Expires November 1998
character.The format is expressed as the [ISO 8601] basic format for character.The format is expressed as the [ISO 8601] basic format for
the duration of time. The format can represent durations in terms of the duration of time. The format can represent durations in terms of
years, months, days, hours, minutes, and seconds. weeks, days, hours, minutes, and seconds.
No additional content value encoding (i.e., BACKSLASH character No additional content value encoding (i.e., BACKSLASH character
encoding) are defined for this value type. encoding) are defined for this value type.
Example: A duration of 15 days, 5 hours, 30 minutes and 20 seconds Example: A duration of 15 days, 5 hours and 20 seconds would be:
would be:
P15DT5H30M20S P15DT5H0M20S
A duration of 7 weeks would be: A duration of 7 weeks would be:
P15DT5H30M20S P7W
4.3.7 Float 4.3.7 Float
Value Name: FLOAT Value Name: FLOAT
Purpose: This value type is used to identify properties that contain Purpose: This value type is used to identify properties that contain
a real value number value. a real value number value.
Formal Definition: The value type is defined by the following Formal Definition: The value type is defined by the following
notation: notation:
float = float-value *("," [WSP] float-value) float = (["+"] / "-") 1*DIGIT ["." 1*DIGIT]
float-value = (["+"] / "-") 1*DIGIT ["." 1*DIGIT]
Description: If the property permits, multiple "float" values MAY be Description: If the property permits, multiple "float" values can be
specified using a COMMA character (ASCII decimal 44) separator specified using a COMMA character (US-ASCII decimal 44) separator
character. character.
No additional content value encoding (i.e., BACKSLASH character No additional content value encoding (i.e., BACKSLASH character
encoding) is defined for this value type. encoding) is defined for this value type.
Example: Example:
Dawson/Stenerson 24 Expires September 1998
1000000.0000001 1000000.0000001
1.333 1.333
-3.14 -3.14
4.3.8 Integer 4.3.8 Integer
Value Name:INTEGER Value Name:INTEGER
Purpose: This value type is used to identify properties that contain Purpose: This value type is used to identify properties that contain
a signed integer value. a signed integer value.
Formal Definition: The value type is defined by the following Formal Definition: The value type is defined by the following
notation: notation:
integer = integer-value *("," [WSP] integer-value) integer = (["+"] / "-") 1*DIGIT
integer-value = (["+"] / "-") *DIGIT Description: If the property permits, multiple "integer" values can
be specified using a COMMA character (US-ASCII decimal 44) separator
Description: If the property permits, multiple "integer" values MAY Dawson/Stenerson 34 Expires November 1998
be specified using a COMMA character (ASCII decimal 44) separator character. The valid range for "integer" is -2147483648 to
character.The valid range for "integer" is -2147483648 to 2147483647. 2147483647. If the sign is not specified, then the value is assumed
If the sign is not specified, then the value is assumed to be to be positive. If the property permits, multiple "integer" values
positive. If the property permits, multiple "integer" values MAY be can be specified using a COMMA character (US-ASCII decimal 44)
specified using a COMMA character (ASCII decimal 44) separator separator character.
character.
No additional content value encoding (i.e., BACKSLASH character No additional content value encoding (i.e., BACKSLASH character
encoding) is defined for this value type. encoding) is defined for this value type.
Example: Example:
1234567890 1234567890
-1234567890 -1234567890
+1234567890 +1234567890
432109876 432109876
skipping to change at line 1296 skipping to change at line 1862
4.3.9 Period of Time 4.3.9 Period of Time
Value Name: PERIOD Value Name: PERIOD
Purpose: This value type is used to identify values that contain a Purpose: This value type is used to identify values that contain a
precise period of time. precise period of time.
Formal Definition: The data type is defined by the following Formal Definition: The data type is defined by the following
notation: notation:
period = period-value *("," [WSP] period-value) period = period-explicit / period-start
period-value = period-explicit / period-start
period-explicit = date-time "/" date-time period-explicit = date-time "/" date-time
;ISO 8601 complete representation basic format for a period of time ; [ISO 8601] complete representation basic format for a period of
;consisting of a start and end. The start MUST be before the end. ; time consisting of a start and end. The start MUST be before the
; end.
Dawson/Stenerson 25 Expires September 1998
period-start = date-time "/" duration period-start = date-time "/" duration
;ISO 8601 complete representation basic format for a period of time ; [ISO 8601] complete representation basic format for a period of
;consisting of a start and duration of time. ; time consisting of a start and positive duration of time.
Description: If the property permits, multiple "period" values MAY be Description: If the property permits, multiple "period" values can be
specified using a COMMA character (ASCII decimal 44) separator specified using a COMMA character (US-ASCII decimal 44) separator
character. There are two forms of a period of time. A period of time character. There are two forms of a period of time. A period of time
MAY be identified by it's start and it's end. This format is is identified by its start and its end. This format is expressed as
expressed as the [ISO 8601] complete representation, basic format for the [ISO 8601] complete representation, basic format for "DATE-TIME"
"DATE-TIME" start of the period, followed by a SOLIDUS character start of the period, followed by a SOLIDUS character (US-ASCII
(ASCII decimal 47), followed by the "DATE-TIME" of the end of the decimal 47), followed by the "DATE-TIME" of the end of the period.
period. A period of time MAY also be defined by a start and a The start of the period MUST be before the end of the period. A
duration of time. The format is expressed as the [ISO 8601] complete period of time can also be defined by a start and a positive duration
of time. The format is expressed as the [ISO 8601] complete
representation, basic format for the "DATE-TIME" start of the period, representation, basic format for the "DATE-TIME" start of the period,
followed by a SOLIDUS character (ASCII decimal 47), followed by the followed by a SOLIDUS character (US-ASCII decimal 47), followed by
[ISO 8601] basic format for "DURATION" of the period. the [ISO 8601] basic format for "DURATION" of the period.
Example: The period starting at 18:00:00 UTC, on January 1, 1997 and Example: The period starting at 18:00:00 UTC, on January 1, 1997 and
ending at 07:00:00 UTC on January 2, 1997 would be: ending at 07:00:00 UTC on January 2, 1997 would be:
Dawson/Stenerson 35 Expires November 1998
19970101T180000Z/19970102T070000Z 19970101T180000Z/19970102T070000Z
The period start at 18:00:00 on January 1, 1997 and lasting 5 hours The period start at 18:00:00 on January 1, 1997 and lasting 5 hours
and 30 minutes would be: and 30 minutes would be:
19970101T180000Z/PT5H30M 19970101T180000Z/PT5H30M
No additional content value encoding (i.e., BACKSLASH character No additional content value encoding (i.e., BACKSLASH character
encoding) is defined for this value type. encoding) is defined for this value type.
4.3.10 Recurrence Rule 4.3.10 Recurrence Rule
Value Name: RECURR Value Name: RECUR
Purpose: This value type is used to identify properties that contain Purpose: This value type is used to identify properties that contain
a recurrence rule specification. a recurrence rule specification.
Formal Definition: The value type is defined by the following Formal Definition: The value type is defined by the following
notation: notation:
recur = recur-value *("," [WSP] recur-value) recur = "FREQ"=freq
[(";" "UNTIL" "=" enddate) / (";" "COUNT" "=" 1*DIGIT)]
recur-value = "FREQ"=freq ";" [";" "INTERVAL" "=" 1*DIGIT]
[("UNTIL" "=" enddate ";") / ("COUNT" "=" 1*DIGIT ";")] [";" "BYSECOND" "=" byseclist]
["INTERVAL" "=" 1*DIGIT ";"] [";" "BYMINUTE" "=" byminlist]
["BYSECOND" "=" byseclist ";"] [";" "BYHOUR" "=" byhrlist]
["BYMINUTE" "=" byminlist ";"] [";" "BYDAY" "=" bywdaylist]
["BYHOUR" "=" byhrlist ";"] [";" "BYMONTHDAY" "=" bymodaylist]
["BYDAY" "=" bywdaylist ";"] [";" "BYYEARDAY" "=" byyrdaylist]
["BYMONTHDAY" "=" bymodaylist ";"] [";" "BYWEEKNO" "=" bywknolist]
["BYYEARDAY" "=" byyrdaylist ";"] [";" "BYMONTH" "=" bymolist]
["BYWEEKNO" "=" bywknolist ";"] [";" "BYSETPOS" "=" bysplist]
["BYMONTH" "=" bymolist ";"] [";" "WKST" "=" weekday)]
["BYSETPOS" "=" bysplist ";"] *(";" x-name "=" text)
;Individual rule parts MUST only be specified once.
Dawson/Stenerson 26 Expires September 1998 ;Rule parts need not be specified in particular any order.
["WKST" "=" weekday ";")]
*(x-name "=" text) ";"
;Individual components MAY only be specified once.
;Rule components need not be specified in particular any order.
freq = "SECONDLY" / "MINUTELY" / "HOURLY" / "DAILY" freq = "SECONDLY" / "MINUTELY" / "HOURLY" / "DAILY"
/ "WEEKLY" / "MONTHLY" / "YEARLY" / "WEEKLY" / "MONTHLY" / "YEARLY"
enddate = date enddate = date
enddate =/ date-time ;A UTC value enddate =/ date-time ;An UTC value
byseclist = seconds / ( seconds *("," seconds) ) byseclist = seconds / ( seconds *("," seconds) )
seconds = 1DIGIT / 2DIGIT ;0 to 59 seconds = 1DIGIT / 2DIGIT ;0 to 59
byminlist = minutes / ( minutes *("," minutes) ) byminlist = minutes / ( minutes *("," minutes) )
minutes = 1DIGIT / 2DIGIT ;0 to 59 minutes = 1DIGIT / 2DIGIT ;0 to 59
byhrlist = hour / ( hour *("," hour) ) byhrlist = hour / ( hour *("," hour) )
hour = 1DIGIT / 2DIGIT ;0 to 23 hour = 1DIGIT / 2DIGIT ;0 to 23
Dawson/Stenerson 36 Expires November 1998
bywdaylist = weekdaynum / ( weekdaynum *("," weekdaynum) ) bywdaylist = weekdaynum / ( weekdaynum *("," weekdaynum) )
weekdaynum = [([plus] ordwk / minus ordwk)] weekday weekdaynum = [([plus] ordwk / minus ordwk)] weekday
plus = "+" plus = "+"
minus = "-" minus = "-"
ordwk = 1DIGIT / 2DIGIT ;1 to 53 ordwk = 1DIGIT / 2DIGIT ;1 to 53
skipping to change at line 1416 skipping to change at line 1979
yeardaynum = ([plus] ordyrday) / (minus ordyrday) yeardaynum = ([plus] ordyrday) / (minus ordyrday)
ordyrday = 1DIGIT / 2DIGIT / 3DIGIT ;1 to 366 ordyrday = 1DIGIT / 2DIGIT / 3DIGIT ;1 to 366
bywknolist = weeknum / ( weeknum *("," weeknum) ) bywknolist = weeknum / ( weeknum *("," weeknum) )
weeknum = ([plus] ordwk) / (minus ordwk) weeknum = ([plus] ordwk) / (minus ordwk)
bymolist = monthnum / ( monthnum *("," monthnum) ) bymolist = monthnum / ( monthnum *("," monthnum) )
Dawson/Stenerson 27 Expires September 1998
monthnum = 1DIGIT / 2DIGIT ;1 to 12 monthnum = 1DIGIT / 2DIGIT ;1 to 12
bysplist = setposday / ( setposday *("," setposday) ) bysplist = setposday / ( setposday *("," setposday) )
setposday = yeardaynum setposday = yeardaynum
Description: If the property permits, multiple "recur" values MAY be Description: If the property permits, multiple "recur" values can be
specified using a COMMA character (ASCII decimal 44) separator specified using a COMMA character (US-ASCII decimal 44) separator
character. The value type is a structured value consisting of a list character. The value type is a structured value consisting of a list
of one or more recurrence grammar components. Each component is of one or more recurrence grammar parts. Each rule part is defined by
defined by a NAME=VALUE pair. The components are separated from each a NAME=VALUE pair. The rule parts are separated from each other by
other by the SEMICOLON character (ASCII decimal 59). The components the SEMICOLON character (US-ASCII decimal 59). The rule parts are not
are not ordered in any particular sequence. Individual components MAY ordered in any particular sequence. Individual rule parts MUST only
only be specified once. be specified once.
The FREQ component identifies the type of recurrence rule. This The FREQ rule part identifies the type of recurrence rule. This rule
component MUST be specified in the recurrence rule. Valid values part MUST be specified in the recurrence rule. Valid values include
include SECONDLY, to specify repeating events based on an interval of SECONDLY, to specify repeating events based on an interval of a
a second or more; MINUTELY, to specify repeating events based on an second or more; MINUTELY, to specify repeating events based on an
interval of a minute or more; HOURLY, to specify repeating events interval of a minute or more; HOURLY, to specify repeating events
based on an interval of an hour or more; DAILY, to specify repeating based on an interval of an hour or more; DAILY, to specify repeating
events based on an interval of a day or more; WEEKLY, to specify events based on an interval of a day or more; WEEKLY, to specify
Dawson/Stenerson 37 Expires November 1998
repeating events based on an interval of a week or more; MONTHLY, to repeating events based on an interval of a week or more; MONTHLY, to
specify repeating events based on an interval of a month or more; and specify repeating events based on an interval of a month or more; and
YEARLY, to specify repeating events based on an interval of a year or YEARLY, to specify repeating events based on an interval of a year or
more. more.
The INTERVAL component contains a positive integer representing how The INTERVAL rule part contains a positive integer representing how
often the recurrence rule repeats. The default value is "1" or every often the recurrence rule repeats. The default value is "1" or every
minute for a MINUTELY rule, every hour for a HOURLY rule, every day second for a SECONDLY rule, or every minute for a MINUTELY rule,
for a DAILY rule, every week for a WEEKLY rule, every month for a every hour for an HOURLY rule, every day for a DAILY rule, every week
MONTHLY rule and every year for a YEARLY rule. for a WEEKLY rule, every month for a MONTHLY rule and every year for
a YEARLY rule.
The UNTIL component defines a date-time value which bounds the The UNTIL rule part defines a date-time value which bounds the
recurrence rule in an inclusive manner. If the value specified by recurrence rule in an inclusive manner. If the value specified by
UNTIL is synchronized with the specified recurrence, this date-time UNTIL is synchronized with the specified recurrence, this date or
becomes the last instance of the recurrence. If not present, and the date-time becomes the last instance of the recurrence. If specified
COUNT component is also not present, the RRULE is considered to as a date-time value, then it MUST be specified in an UTC time
repeat forever. format. If not present, and the COUNT rule part is also not present,
the RRULE is considered to repeat forever.
The COUNT component defines the number of occurrences at which to The COUNT rule part defines the number of occurrences at which to
range-bound the recurrence. This component is ignored if the "UNTIL" range-bound the recurrence. The "DTSTART" property value, if
component is also present. specified, counts as the first occurrence.
The BYSECOND component specifies a COMMA character (ASCII decimal 44) The BYSECOND rule part specifies a COMMA character (US-ASCII decimal
separated list of seconds within a minute. Valid values are 0 to 59. 44) separated list of seconds within a minute. Valid values are 0 to
The BYMINUTE component specifies a COMMA character (ASCII decimal 44) 59. The BYMINUTE rule part specifies a COMMA character (US-ASCII
separated list of minutes within an hour. Valid values are 0 to 59. decimal 44) separated list of minutes within an hour. Valid values
The BYHOUR component specifies a COMMA character (ASCII decimal 44) are 0 to 59. The BYHOUR rule part specifies a COMMA character (US-
separated list of hours of the day. Valid values are 0 to 23. ASCII decimal 44) separated list of hours of the day. Valid values
are 0 to 23.
The BYDAY component specifies a COMMA character (ASCII decimal 44) The BYDAY rule part specifies a COMMA character (US-ASCII decimal 44)
separated list of days of the week; MO, indicates Monday; TU, separated list of days of the week; MO, indicates Monday; TU,
Dawson/Stenerson 28 Expires September 1998
indicates Tuesday; WE, indicates Wednesday; TH, indicates Thursday; indicates Tuesday; WE, indicates Wednesday; TH, indicates Thursday;
FR, indicates Friday; SA, indicates Saturday; SU, indicates Sunday. FR, indicates Friday; SA, indicates Saturday; SU, indicates Sunday.
Each BYDAY value MAY also be preceded by a positive (+n) or negative Each BYDAY value can also be preceded by a positive (+n) or negative
(-n) integer. If present, this indicates the nth occurrence of the (-n) integer. If present, this indicates the nth occurrence of the
specific day within the MONTHLY or YEARLY RRULE. For example, within specific day within the MONTHLY or YEARLY RRULE. For example, within
a MONTHLY rule, +1MO (or simply 1MO) represents the first Monday a MONTHLY rule, +1MO (or simply 1MO) represents the first Monday
within the month, whereas -1MO represents the last Monday of the within the month, whereas -1MO represents the last Monday of the
month. If an integer modifier is not present, it means all days of month. If an integer modifier is not present, it means all days of
this type within the specified frequency. For example, within a this type within the specified frequency. For example, within a
MONTHLY rule, MO represents all Mondays within the month. MONTHLY rule, MO represents all Mondays within the month.
The BYMONTHDAY component specifies a COMMA character (ASCII decimal The BYMONTHDAY rule part specifies a COMMA character (ASCII decimal
44) separated list of days of the month. Valid values are 1 to 31 or 44) separated list of days of the month. Valid values are 1 to 31 or
-31 to -1. -31 to -1. For example, -10 represents the tenth to the last day of
the month.
Each BYMONTHDAY value MAY include a positive (+n) or negative (-n) The BYYEARDAY rule part specifies a COMMA character (US-ASCII
integer. If present, this indicates the nth occurrence of the decimal 44) separated list of days of the year. Valid values are 1 to
specific day of the month within the MONTHLY rule. If an integer 366 or -366 to -1. For example, -1 represents the last day of the
modifier is not present, it means all days of this type within the
specified frequency. For example, within a MONTHLY rule, -10
represents the tenth to the last day of the month.
The BYYEARDAY component specifies a COMMA character (ASCII decimal Dawson/Stenerson 38 Expires November 1998
44) separated list of days of the year. Valid values are 1 to 366 or year (December 31st) and -306 represents the 306th to the last day of
-366 to -1. For example, -1 represents the last day of the year the year (March 1st).
(December 31st).
The BYWEEKNO component specifies a comma-separated list of weeks of The BYWEEKNO rule part specifies a COMMA character (US-ASCII decimal
the year. Valid values are 1 to 53. This corresponds to weeks 44) separated list of ordinals specifying weeks of the year. Valid
according to week numbering as defined in [ISO 8601]. That is, a week values are 1 to 53 or -53 to -1. This corresponds to weeks according
as "A seven day period within a calendar year, starting on a Monday to week numbering as defined in [ISO 8601]. The first calendar week
and identified by its ordinal number within the year; the first of the year is the one that includes the first 4 days of the year. A
calendar week of the year is the one that includes the first Thursday week is defined as a seven day period, starting on the day of the
of that year." This component is only valid for YEARLY rules. week defined to be the week start (see WKST). This rule part is only
valid for YEARLY rules. For example, 3 represents the third week of
the year.
Each BYWEEKNO value MAY include a positive (+n) or negative (-n) Note: Assuming a Monday week start, week 53 can only occur when
integer. If present, this indicates the nth occurrence of the Thursday is January 1 or if it is a leap year and Wednesday is
specific week of the year within the YEARLY rule. If an integer January 1.
modifier is not present, it means all days of this type within the
specified frequency. For example, within a YEARLY rule, 3 represents
the third week of the year.
The BYMONTH component specifies a comma separated list of months of The BYMONTH rule part specifies a COMMA character (US-ASCII decimal
the year. Valid values are 1 to 12. 44) separated list of months of the year. Valid values are 1 to 12.
The WKST component specifies the day on which the workweek starts. The WKST rule part specifies the day on which the workweek starts.
Valid values are MO, TU, WE, TH, FR, SA and SU. This is significant Valid values are MO, TU WE , , TH, FR, SA and SU. This is significant
when a WEEKLY RRULE has an interval greater than 1, and a BYDAY when a WEEKLY RRULE has an interval greater than 1, and a BYDAY rule
component is specified. The default value is MO. part is specified. This is also significant when in a YEARLY RRULE
when a BYWEEKNO rule part is specified. The default value is MO.
The BYSETPOS component specifies a COMMA character (ASCII decimal 44) The BYSETPOS rule part specifies a COMMA character (US-ASCII decimal
separated list of values which corresponds to the nth occurrence 44) separated list of values which corresponds to the nth occurrence
within the set of events specified by the rule. Valid values are 1 to within the set of events specified by the rule. Valid values are 1 to
Dawson/Stenerson 29 Expires September 1998
366 or -366 to -1. It MUST only be used in conjunction with another 366 or -366 to -1. It MUST only be used in conjunction with another
Byxxx component. For example "the last work day of the month" could Byxxx rule part. For example "the last work day of the month" could
be represented as: be represented as:
RRULE:FREQ=MONTHLY;BYDAY=MO,TU,WE,TH,FR;BYSETPOS=-1 RRULE:FREQ=MONTHLY;BYDAY=MO,TU,WE,TH,FR;BYSETPOS=-1
Each BYSETPOS value MAY include a positive (+n) or negative (-n) Each BYSETPOS value can include a positive (+n) or negative (-n)
integer. If present, this indicates the nth occurrence of the integer. If present, this indicates the nth occurrence of the
specific occurrence within the set of events specified by the rule. specific occurrence within the set of events specified by the rule.
If BYxxx component values are found which are beyond the available If BYxxx rule part values are found which are beyond the available
scope (ie, BYMONTHDAY=30 in February), they are simply ignored. scope (ie, BYMONTHDAY=30 in February), they are simply ignored.
Information, not contained in the rule, necessary to determine the Information, not contained in the rule, necessary to determine the
various recurrence instance start time and dates are derived from the various recurrence instance start time and dates are derived from the
Start Time (DTSTART) entry attribute. For example, Start Time (DTSTART) entry attribute. For example,
"FREQ=YEARLY;BYMONTH=1" doesn't specify a specific day within the "FREQ=YEARLY;BYMONTH=1" doesn't specify a specific day within the
month or a time. This information would be the same as what is month or a time. This information would be the same as what is
specified for DTSTART. specified for DTSTART.
BYxxx components modify the recurrence in some manner. BYxxx BYxxx rule parts modify the recurrence in some manner. BYxxx rule
components for a period of time which is the same or greater than the parts for a period of time which is the same or greater than the
frequency generally reduce or limit the number of occurrences of the frequency generally reduce or limit the number of occurrences of the
recurrence generated. For example, "FREQ=DAILY;BYMONTH=1" reduces the recurrence generated. For example, "FREQ=DAILY;BYMONTH=1" reduces the
number of recurrence instances from all days (if BYMONTH tag is not number of recurrence instances from all days (if BYMONTH tag is not
present) to all days in January. BYxxx components for a period of
Dawson/Stenerson 39 Expires November 1998
present) to all days in January. BYxxx rule parts for a period of
time less than the frequency generally increase or expand the number time less than the frequency generally increase or expand the number
of occurrences of the recurrence. For example, of occurrences of the recurrence. For example,
"FREQ=YEARLY;BYMONTH=1,2" increases the number of days within the "FREQ=YEARLY;BYMONTH=1,2" increases the number of days within the
yearly recurrence set from 1 (if BYMONTH tag is not present) to 2. yearly recurrence set from 1 (if BYMONTH tag is not present) to 2.
If only one BYxxx component is specified in the recurrence rule, the If multiple BYxxx rule parts are specified, then after evaluating the
list of "n" unique values would cause "n" occurrences of the specified FREQ and INTERVAL rule parts, the BYxxx rule parts are
recurrence within each specified frequency interval, where each
unique list value is substituted in the appropriate date position
within DTSTART for each such occurrence.
If multiple BYxxx components are specified, then after evaluating the
specified FREQ and INTERVAL components, the BYxxx components are
applied to the current set of evaluated occurrences in the following applied to the current set of evaluated occurrences in the following
order: BYMONTH, BYWEEKNO, BYYEARDAY, BYMONTHDAY, BYDAY, BYHOUR, order: BYMONTH, BYWEEKNO, BYYEARDAY, BYMONTHDAY, BYDAY, BYHOUR,
BYMINUTE, BYSECOND and BYSETPOS. BYMINUTE, BYSECOND and BYSETPOS; then COUNT and UNTIL are evaluated.
Here is an example of evaluating multiple BYxxx components. Here is an example of evaluating multiple BYxxx rule parts.
DTSTART;TZID=EST=19970105T083000 DTSTART;TZID=US-Eastern:19970105T083000
RRULE:FREQ=YEARLY;INTERVAL=2;BYMONTH=1;BYDAY=SU;BYHOUR=8,9; RRULE:FREQ=YEARLY;INTERVAL=2;BYMONTH=1;BYDAY=SU;BYHOUR=8,9;
BYMINUTE=30 BYMINUTE=30
First, the "INTERVAL=2" would be applied to "FREQ=YEARLY" to arrive First, the "INTERVAL=2" would be applied to "FREQ=YEARLY" to arrive
at "every other year". Then, "BYMONTH=1" would be applied to arrive at "every other year". Then, "BYMONTH=1" would be applied to arrive
at "every January, every other year". Then, "BYDAY=SU" would be at "every January, every other year". Then, "BYDAY=SU" would be
applied to arrive at "every Sunday in January, every other year". applied to arrive at "every Sunday in January, every other year".
Then, "BYHOUR=8,9" would be applied to arrive at "every Sunday in Then, "BYHOUR=8,9" would be applied to arrive at "every Sunday in
Dawson/Stenerson 30 Expires September 1998
January at 8 AM and 9 AM, every other year". Then, "BYMINUTE=30" January at 8 AM and 9 AM, every other year". Then, "BYMINUTE=30"
would be applied to arrive at "every Sunday in January at 8:30 AM and would be applied to arrive at "every Sunday in January at 8:30 AM and
9:30 AM, every other year". Similarly, if the BYMINUTE, BYHOUR, 9:30 AM, every other year". Then, lacking information from RRULE, the
BYDAY, BYMONTHDAY or BYMONTH component were missing, the appropriate second is derived from DTSTART, to end up in "every day in January at
minute, hour, day or month would have been retrieved from the 8:30:00 AM and 9:30:00 AM, every other year". Similarly, if the
"DTSTART" property. BYMINUTE, BYHOUR, BYDAY, BYMONTHDAY or BYMONTH rule part were
missing, the appropriate minute, hour, day or month would have been
retrieved from the "DTSTART" property.
No additional content value encoding (i.e., BACKSLASH character No additional content value encoding (i.e., BACKSLASH character
encoding) is defined for this value type. encoding) is defined for this value type.
Example: The following is a rule which specifies 10 meetings which Example: The following is a rule which specifies 10 meetings which
occur every other day: occur every other day:
FREQ=DAILY;COUNT=10;INTERVAL=2 FREQ=DAILY;COUNT=10;INTERVAL=2
There are other examples specified in the "RRULE" specification. There are other examples specified in the "RRULE" specification.
4.3.11 Text 4.3.11 Text
Value Name: TEXT Value Name: TEXT
Purpose This value type is used to identify values that contain human Purpose This value type is used to identify values that contain human
readable text. readable text.
Formal Definition: The value type is defined by the following Formal Definition: If the character set is UTF-8, the value type is
notation: defined by the following notation. This must be modified depending on
character sets. For example, the definition of TSAFE-CHAR includes
ESC for character sets that use ISO 2022 character set switching and
text = text-value *("," text-value) Dawson/Stenerson 40 Expires November 1998
; Folded according to folded-value syntax above or TSAFE-CHAR should not include NON-US-ASCII when the character set is
; encoded according to param-value syntax above. US-ASCII.
text-value = *(SAFE-CHAR / ":" / DQUOTE / ESCAPED-CHAR) text = *(TSAFE-CHAR / ":" / DQUOTE / ESCAPED-CHAR)
; Folded according to description above
ESCAPED-CHAR = "\\" / "\;" / "\," / "\N" / "\n") ESCAPED-CHAR = "\\" / "\;" / "\," / "\N" / "\n")
; \\ encodes \, \N or \n encodes newline ; \\ encodes \, \N or \n encodes newline
; \; encodes ;, \, encodes , ; \; encodes ;, \, encodes ,
NON-ASCII = %x80-FF TSAFE-CHAR = %x20-21 / %x23-2B / %x2D-39 / %x3C-5B
; use restricted by charset parameter %x5D-7E / NON-US-ASCII
; on outer MIME object ; Any character except CTLs not needed by the current
; character set, DQUOTE, ";", ":", "\", ","
SAFE-CHAR = %x20-21 / %x23-2B / %x2D-39 / %x3C-5B Description: If the property permits, multiple "text" values can be
%x5D-7E / NON-ASCII specified using a COMMA character (US-ASCII decimal 44) separator
; Any character except CTLs, DQUOTE, ";", ":", "\", "," character.
Description: If the property permits, multiple "text" values MAY be The language in which the text is represented can be controlled by
specified using a COMMA character (ASCII decimal 44) separator the "LANGUAGE" property parameter.
character. The character set and language in which the text is
represented is controlled by the "LANGUAGE" property parameters.
An intentional formatted text line break MAY only be included in a An intentional formatted text line break MUST only be included in a
"TEXT" property value by representing the line break with the "TEXT" property value by representing the line break with the
character sequence of BACKSLASH (ASCII decimal 92), followed by a character sequence of BACKSLASH (US-ASCII decimal 92), followed by a
LATIN SMALL LETTER N (US-ASCII decimal 110) or a LATIN CAPITAL LETTER
Dawson/Stenerson 31 Expires September 1998 N (US-ASCII decimal 78), that is "\n" or "\N".
LATIN SMALL LETTER N (ASCII decimal 110) or a LATIN CAPITAL LETTER N
(ASCII decimal 78), that is "\n" or "\N".
The "TEXT" property values may also contain special characters that The "TEXT" property values may also contain special characters that
are used to signify delimiters, such as a COMMA character for lists are used to signify delimiters, such as a COMMA character for lists
of values or a SEMICOLON character for structured values. In order to of values or a SEMICOLON character for structured values. In order to
support the inclusion of these special characters in "TEXT" property support the inclusion of these special characters in "TEXT" property
values, they need to be escaped with a BACKSLASH character. A values, they need to be escaped with a BACKSLASH character. A
BACKSLASH character (ASCII decimal 92) in a "TEXT" property value BACKSLASH character (US-ASCII decimal 92) in a "TEXT" property value
MUST be escaped with another BACKSLASH character. A COMMA character MUST be escaped with another BACKSLASH character. A COMMA character
in a "TEXT" property value MUST be escaped with a BACKSLASH character in a "TEXT" property value MUST be escaped with a BACKSLASH character
(ASCII decimal 92). A SEMICOLON character in a "TEXT" property value (US-ASCII decimal 92). A SEMICOLON character in a "TEXT" property
MUST be escaped with a BACKSLASH character (ASCII decimal 92). value MUST be escaped with a BACKSLASH character (US-ASCII decimal
However, a COLON character in a "TEXT" property value SHALL NOT be 92). However, a COLON character in a "TEXT" property value SHALL NOT
escaped with a BACKSLASH character.Example: A multiple line value of: be escaped with a BACKSLASH character.Example: A multiple line value
of:
Project XYZ Final Review Project XYZ Final Review
Conference Room - 3B Conference Room - 3B
Come Prepared. Come Prepared.
would be represented as: would be represented as:
Project XYZ Final Review\n Conference Room - 3B\nCome Prepared. Project XYZ Final Review\n Conference Room - 3B\nCome Prepared.
4.3.12 Time 4.3.12 Time
Value Name: TIME Value Name: TIME
Dawson/Stenerson 41 Expires November 1998
Purpose: This value type is used to identify values that contain a Purpose: This value type is used to identify values that contain a
time of day. time of day.
Formal Definition: The data type is defined by the following Formal Definition: The data type is defined by the following
notation: notation:
time = time-value *("," [WSP] time-value) time = time-hour time-minute time-second [time-utc]
time-value = time-hour time-minute time-second [time-utc]
time-hour = 2DIGIT ;00-23 time-hour = 2DIGIT ;00-23
time-minute = 2DIGIT ;00-59 time-minute = 2DIGIT ;00-59
time-second = 2DIGIT ;00-60 time-second = 2DIGIT ;00-60
;The "60" value is used to account for years with "leap" seconds. ;The "60" value is used to account for "leap" seconds.
time-utc = "Z" time-utc = "Z"
Description: If the property permits, multiple "time" values MAY be Description: If the property permits, multiple "time" values can be
specified using a COMMA character (ASCII decimal 44) separator specified using a COMMA character (US-ASCII decimal 44) separator
character. No additional content value encoding (i.e., BACKSLASH character. No additional content value encoding (i.e., BACKSLASH
character encoding) is defined for this value type. character encoding) is defined for this value type.
The "TIME" data type is used to identify values that contain a time The "TIME" data type is used to identify values that contain a time
of day. The format is based on the [ISO 8601] complete of day. The format is based on the [ISO 8601] complete
Dawson/Stenerson 32 Expires September 1998
representation, basic format for a time of day. The text format representation, basic format for a time of day. The text format
consists of a two-digit 24-hour of the day (i.e., values 0-23), two- consists of a two-digit 24-hour of the day (i.e., values 0-23), two-
digit minute in the hour (i.e., values 0-59), and two-digit seconds digit minute in the hour (i.e., values 0-59), and two-digit seconds
in the minute (i.e., values 0-59). Fractions of a second are not in the minute (i.e., values 0-60). The seconds value of 60 is only to
be used to account for "leap" seconds. Fractions of a second are not
supported by this format. supported by this format.
In parallel to the "DATE-TIME" definition above, the "TIME" data type In parallel to the "DATE-TIME" definition above, the "TIME" data type
expresses time values in three forms: expresses time values in three forms:
Note: The form of time with UTC offset MUST NOT be used. For example, The form of time with UTC offset MUST NOT be used. For example, the
the following is NOT VALID for a time value: following is NOT VALID for a time value:
230000-0800 230000-0800 ;Invalid time format
FORM #1 LOCAL TIME FORM #1 LOCAL TIME
The local time form is simply a time value that does not contain the The local time form is simply a time value that does not contain the
UTC designator nor does it reference a time zone. For example, 11 PM: UTC designator nor does it reference a time zone. For example, 11:00
PM:
230000 230000
Time values of this type are said to be "floating" and are not bound Time values of this type are said to be "floating" and are not bound
to any time zone in particular. They are used to represent the same to any time zone in particular. They are used to represent the same
hour, minute, and second value regardless of which time zone is hour, minute, and second value regardless of which time zone is
currently being observed. For example, an event MAY be defined that currently being observed. For example, an event can be defined that
indicates that an individual will be busy from 11:00 AM to 1:00 PM indicates that an individual will be busy from 11:00 AM to 1:00 PM
every day, no matter which timezone the person is in. In these cases, every day, no matter which time zone the person is in. In these
a local time MAY be specified. The recipient of an iCalendar object cases, a local time can be specified. The recipient of an iCalendar
with a property value consisting of a local time, without any object with a property value consisting of a local time, without any
relative time zone information, should interpret the value as being relative time zone information, should interpret the value as being
Dawson/Stenerson 42 Expires November 1998
fixed to whatever timezone the ATTENDEE is in at any given moment. fixed to whatever timezone the ATTENDEE is in at any given moment.
This means that two ATTENDEEs may participate in the same event at This means that two ATTENDEEs may participate in the same event at
different UTC times; floating time should only be used where that is different UTC times; floating time should only be used where that is
reasonable behavior. reasonable behavior.
In most cases, a fixed time is desired. To properly communicate a In most cases, a fixed time is desired. To properly communicate a
fixed time in a property value, either UTC time or local time with fixed time in a property value, either UTC time or local time with
time zone reference MUST be specified. time zone reference MUST be specified.
The use of local time in a TIME value without the TZID property The use of local time in a TIME value without the TZID property
parameter is to be interpreted as a local time value, regardless of parameter is to be interpreted as a local time value, regardless of
the existence of "VTIMEZONE" calendar components in the iCalendar the existence of "VTIMEZONE" calendar components in the iCalendar
object. object.
FORM #2: DATE WITH UTC TIME FORM #2: UTC TIME
UTC time, or absolute time, is identified by a LATIN CAPITAL LETTER Z UTC time, or absolute time, is identified by a LATIN CAPITAL LETTER Z
suffix character (ASCII decimal 90), the UTC designator, appended to suffix character (US-ASCII decimal 90), the UTC designator, appended
the time value. For example, the following represents 0700 UTC: to the time value. For example, the following represents 07:00 AM
UTC:
070000Z 070000Z
The TZID property parameter MUST NOT be applied to TIME properties The TZID property parameter MUST NOT be applied to TIME properties
whose time values are specified in UTC. whose time values are specified in UTC.
Dawson/Stenerson 33 Expires September 1998 FORM #3: LOCAL TIME AND TIME ZONE REFERENCE
FORM #3: DATE WITH LOCAL TIME AND TIME ZONE REFERENCE
The local time with reference to time zone information form is The local time with reference to time zone information form is
identified by the use the TZID property parameter to reference the identified by the use the TZID property parameter to reference the
appropriate time zone definition. TZID is discussed in detail in the appropriate time zone definition. TZID is discussed in detail in the
section on Time Zone. section on Time Zone.
Example: The following represents 8:30 AM in New York, five hours Example: The following represents 8:30 AM in New York in Winter, five
behind UTC, in each of the three formats using the "DTSTART" hours behind UTC, in each of the three formats using the "X-
property: TIMEOFDAY" non-standard property:
DTSTART:19980312T083000 X-TIMEOFDAY:083000
DTSTART:19980312T133000Z X-TIMEOFDAY:133000Z
DTSTART;TZID=America-New York:19980312T083000 X-TIMEOFDAY;TZID=America-New York:083000
4.3.13 URI 4.3.13 URI
Value Name: URI Value Name: URI
Purpose: This value type is used to identify values that contain a Purpose: This value type is used to identify values that contain a
uniform resource identifier (URI) type of reference to the property uniform resource identifier (URI) type of reference to the property
value. value.
Formal Definition: The data type is defined by the following Formal Definition: The data type is defined by the following
notation: notation:
Dawson/Stenerson 43 Expires November 1998
uri = <As defined by any IETF RFC> uri = <As defined by any IETF RFC>
Description: This data type might be used to reference binary Description: This data type might be used to reference binary
information, for values that are large, or otherwise undesirable to information, for values that are large, or otherwise undesirable to
include directly in the iCalendar object. include directly in the iCalendar object.
The URI value formats in RFC 1738, RFC 2111 and any other IETF The URI value formats in RFC 1738, RFC 2111 and any other IETF
registered value format MAY be specified. registered value format can be specified.
Any IANA registered URI format MAY be used. These include, but are Any IANA registered URI format can be used. These include, but are
not limited to, those defined in RFC 1738 and RFC 2111. not limited to, those defined in RFC 1738 and RFC 2111.
When a property parameter value is a URI value type, the URI must be When a property parameter value is a URI value type, the URI must be
specified as a quoted-string value. specified as a quoted-string value.
No additional content value encoding (i.e., BACKSLASH character No additional content value encoding (i.e., BACKSLASH character
encoding) is defined for this value type. encoding) is defined for this value type.
Example: The following is a URI for a network file: Example: The following is a URI for a network file:
http://host1.com/my-report.txt http://host1.com/my-report.txt
4.3.14 UTC Offset 4.3.14 UTC Offset
Value Name: UTC-OFFSET Value Name: UTC-OFFSET
Dawson/Stenerson 34 Expires September 1998
Purpose: This value type is used to identify properties that contain Purpose: This value type is used to identify properties that contain
an offset from UTC to local time. an offset from UTC to local time.
Formal Definition: The data type is defined by the following Formal Definition: The data type is defined by the following
notation: notation:
utc-offset = time-numzone ;As defined above in time data utc-offset = time-numzone ;As defined above in time data type
type
Description: time-numzone = ("+" / "-") time-hour time-minute
The PLUS SIGN character MUST be specified for positive UTC offsets. Description: The PLUS SIGN character MUST be specified for positive
UTC offsets (i.e., ahead of UTC). The value of "-0000" is not
allowed.
No additional content value encoding (i.e., BACKSLASH character No additional content value encoding (i.e., BACKSLASH character
encoding) is defined for this value type. encoding) is defined for this value type.
Example: The following are UTC offsets are given for standard time Example: The following are UTC offsets are given for standard time
for New York (five hours behind UTC) and Geneva (one hour ahead of for New York (five hours behind UTC) and Geneva (one hour ahead of
UTC): UTC):
-0500 -0500
+0100 +0100
Dawson/Stenerson 44 Expires November 1998
4.4 iCalendar Object 4.4 iCalendar Object
The Calendaring and Scheduling Core Object is a collection of The Calendaring and Scheduling Core Object is a collection of
calendaring and scheduling information. Typically, this information calendaring and scheduling information. Typically, this information
will consist of a single iCalendar object. However, multiple will consist of a single iCalendar object. However, multiple
iCalendar objects MAY be sequentially grouped together. The first iCalendar objects can be sequentially grouped together. The first
line and last line of the iCalendar object MUST contain a pair of line and last line of the iCalendar object MUST contain a pair of
iCalendar object delimiter strings. The syntax for an iCalendar iCalendar object delimiter strings. The syntax for an iCalendar
object is as follows: object is as follows:
icalobject = "BEGIN" ":" [WSP] "VCALENDAR" CRLF icalobject = "BEGIN" ":" "VCALENDAR" CRLF
icalbody icalbody
"END" ":" [WSP] "VCALENDAR" CRLF [icalobject] "END" ":" "VCALENDAR" CRLF [icalobject]
The following is a simple example of an iCalendar object: The following is a simple example of an iCalendar object:
BEGIN:VCALENDAR BEGIN:VCALENDAR
VERSION:2.0 VERSION:2.0
PRODID:-//hacksw/handcal//NONSGML v1.0//EN PRODID:-//hacksw/handcal//NONSGML v1.0//EN
BEGIN:VEVENT BEGIN:VEVENT
DTSTART:19970714T170000Z DTSTART:19970714T170000Z
DTEND:19970715T045959Z DTEND:19970715T035959Z
SUMMARY:Bastille Day Party SUMMARY:Bastille Day Party
END:VEVENT END:VEVENT
END:VCALENDAR END:VCALENDAR
Dawson/Stenerson 35 Expires September 1998
4.5 Property 4.5 Property
A property is the definition of an individual attribute describing a A property is the definition of an individual attribute describing a
calendar property or a calendar component. A property takes the form calendar property or a calendar component. A property takes the form
defined by the "contentline" notation defined in section 4.1.1. defined by the "contentline" notation defined in section 4.1.1.
The following is an example of a property: The following is an example of a property:
DTSTART:19960415T133000Z DTSTART:19960415T133000Z
This memo places no imposed ordering of properties within an This memo places no imposed ordering of properties within an
iCalendar object. iCalendar object.
Property names, parameter names and parameter values (i.e., Property names, parameter names and enumerated parameter values are
everything to the left of the ":" on a line) are case insensitive. case insensitive. For example, the property name "DUE" is the same as
For example, the property name "DUE" is the same as "due" and "Due". "due" and "Due", DTSTART;TZID=Eastern:19980714T120000 is the same as
DtStart;TzID=Eastern:19980714T120000.
4.6 Calendar Components 4.6 Calendar Components
The body of the iCalendar object consists of a sequence of calendar The body of the iCalendar object consists of a sequence of calendar
properties and one or more calendar components. The calendar properties and one or more calendar components. The calendar
properties are attributes that apply to the calendar as a whole. The properties are attributes that apply to the calendar as a whole. The
calendar components are collections of properties that express a calendar components are collections of properties that express a
particular calendar semantic. For example, the calendar component MAY particular calendar semantic. For example, the calendar component can
specify an event, a to-do, a journal entry, time zone information, or specify an event, a to-do, a journal entry, time zone information, or
free/busy time information, or an alarm. free/busy time information, or an alarm.
Dawson/Stenerson 45 Expires November 1998
The body of the iCalenar object is defined by the following notation: The body of the iCalenar object is defined by the following notation:
icalbody = calprops 1*component icalbody = calprops component
calprops = [calscale] [method] prodid version calprops = [calscale] [method] prodid version *x-prop
component = 1*(eventc / todoc / journalc / freebusyc / component = 1*(eventc / todoc / journalc / freebusyc /
/ timezonec / x-name / iana-token) / timezonec / iana-comp / x-comp)
iana-comp = "BEGIN" ":" iana-token CRLF
1*contentline
"END" ":" iana-token CRLF
x-comp = "BEGIN" ":" x-name CRLF
1*contentline
"END" ":" x-name CRLF
An iCalendar object must include the "PRODID" and "VERSION" calendar An iCalendar object must include the "PRODID" and "VERSION" calendar
properties. In addition, it must include at least one calendar properties. In addition, it must include at least one calendar
component. Special forms of iCalendar objects are possible to publish component. Special forms of iCalendar objects are possible to publish
just busy time (i.e., only a "VFREEBUSY" calendar component) or time just busy time (i.e., only a "VFREEBUSY" calendar component) or time
zone (i.e., only a "VTIMEZONE" calendar component) information. In zone (i.e., only a "VTIMEZONE" calendar component) information. In
addition, a complex iCalendar object is possible that is used to addition, a complex iCalendar object is possible that is used to
capture a complete snapshot of the contents of a calendar (e.g., capture a complete snapshot of the contents of a calendar (e.g.,
composite of many different calendar components). More commonly, an composite of many different calendar components). More commonly, an
iCalendar object will consist of just a single "VEVENT", "VTODO" or iCalendar object will consist of just a single "VEVENT", "VTODO" or
"VJOURNAL" calendar component. "VJOURNAL" calendar component.
4.6.1 Event Component 4.6.1 Event Component
Component Name: "VEVENT" Component Name: "VEVENT"
Purpose: Provide a grouping of component properties that describe an Purpose: Provide a grouping of component properties that describe an
event. event.
Dawson/Stenerson 36 Expires September 1998
Format Definition: A "VEVENT" calendar component is defined by the Format Definition: A "VEVENT" calendar component is defined by the
following notation: following notation:
eventc = "BEGIN" ":" [WSP] "VEVENT" CRLF eventc = "BEGIN" ":" "VEVENT" CRLF
eventprop *alarmc eventprop *alarmc
"END" ":" [WSP] "VEVENT" CRLF "END" ":" "VEVENT" CRLF
eventprop = *attach *attendee *categories [class] *comment eventprop = *attach *attendee *categories [class] *comment
*contact [created] [description] [dtend / duration] *contact [created] [description] [dtend / duration]
dtstart *exdate *exrule [geo] [last-mod] [location] [dtstart] *exdate *exrule [geo] [last-mod] [location]
[organizer] [priority] [rstatus] *related *resources [organizer] [priority] *rstatus *related *resources
*rdate *rrule dtstamp [seq] [status] summary *rdate *rrule [dtstamp] [seq] [status] [summary]
[transp] uid [url] [recurid] [transp] [uid] [url] [recurid] *x-prop
Dawson/Stenerson 46 Expires November 1998
Description: A "VEVENT" calendar component is a grouping of component Description: A "VEVENT" calendar component is a grouping of component
properties and an OPTIONAL "VALARM" calendar component that represent properties, and possibly including "VALARM" calendar components, that
a scheduled amount of time on a calendar. For example, it MAY be an represents a scheduled amount of time on a calendar. For example, it
activity; such as a one-hour, department meeting from 8:00 AM to 9:00 can be an activity; such as a one-hour long, department meeting from
AM, tomorrow. Generally, these events will take up time on an 8:00 AM to 9:00 AM, tomorrow. Generally, an event will take up time
individual calendar. Hence, the event will appear as an opaque on an individual calendar. Hence, the event will appear as an opaque
interval in a search for busy time. Alternately, the event MAY have interval in a search for busy time. Alternately, the event can have
its Time Transparency set to "TRANSPARENT" in order to prevent its Time Transparency set to "TRANSPARENT" in order to prevent
blocking of the event in searches for busy time. blocking of the event in searches for busy time.
The "VEVENT" is also the calendar component used to specify an The "VEVENT" is also the calendar component used to specify an
anniversary or daily reminder within a calendar. These events have a anniversary or daily reminder within a calendar. These events have a
DATE value type for the "DTSTART" and "DTEND" properties instead of DATE value type for the "DTSTART" property instead of the default
the default data type of DATE-TIME. If such a "VEVENT" has an end data type of DATE-TIME. If such a "VEVENT" has a "DTEND" property, it
time, it MUST be specified as a DATE value also. The anniversary type MUST be specified as a DATE value also. The anniversary type of
of "VEVENT" MAY span more than one date (i.e, "DTEND" property value "VEVENT" can span more than one date (i.e, "DTEND" property value is
is set to a calendar date after the "DTSTART" property value). set to a calendar date after the "DTSTART" property value).
The "DTSTART" property for a "VEVENT" specifies the inclusive start The "DTSTART" property for a "VEVENT" specifies the inclusive start
of the event. For recurring events, it also specifies the very first of the event. For recurring events, it also specifies the very first
instance in the recurrence set. The "DTEND" property for a "VEVENT" instance in the recurrence set. The "DTEND" property for a "VEVENT"
calendar component specifies the non-inclusive end of the event. For calendar component specifies the non-inclusive end of the event. For
cases where a "VEVENT" calendar component specifies a "DTSTART" cases where a "VEVENT" calendar component specifies a "DTSTART"
property with a DATE data type but no "DTEND" property, the events property with a DATE data type but no "DTEND" property, the events
non-inclusive end is the end of the calendar date specified by the non-inclusive end is the end of the calendar date specified by the
"DTSTART" property. For cases where a "VEVENT" calendar component "DTSTART" property. For cases where a "VEVENT" calendar component
specifies a "DTSTART" property with a DATE-TIME data type but no specifies a "DTSTART" property with a DATE-TIME data type but no
"DTEND" property, the event ends on the same calendar date and time "DTEND" property, the event ends on the same calendar date and time
of day specified by the "DTSTART" property. of day specified by the "DTSTART" property.
The "VEVENT" calendar component MUST include the "DTSTAMP",
"DTSTART", "SUMMARY" and "UID" properties. In addition, it MUST
include the "SEQUENCE" property, if it's value is greater than zero.
The "VEVENT" calendar component cannot be nested within another The "VEVENT" calendar component cannot be nested within another
calendar component. The "VEVENT" calendar components MAY be related calendar component. However, "VEVENT" calendar components can be
to each other or to a "VTODO" or "VJOURNAL" calendar component with related to each other or to a "VTODO" or to a "VJOURNAL" calendar
the "RELATED-TO" property. component with the "RELATED-TO" property.
Dawson/Stenerson 37 Expires September 1998
Example: The following is an example of the "VEVENT" calendar Example: The following is an example of the "VEVENT" calendar
component used to represent a meeting that will also be opaque to component used to represent a meeting that will also be opaque to
searches for busy time: searches for busy time:
BEGIN:VEVENT BEGIN:VEVENT
UID:19970901T130000Z-123401@host.com UID:19970901T130000Z-123401@host.com
DTSTAMP:19970901T1300Z DTSTAMP:19970901T1300Z
DTSTART:19970903T163000Z DTSTART:19970903T163000Z
DTEND:19970903T190000Z DTEND:19970903T190000Z
SUMMARY:Annual Employee Review SUMMARY:Annual Employee Review
CLASS:PRIVATE CLASS:PRIVATE
CATEGORIES:BUSINESS,HUMAN RESOURCES CATEGORIES:BUSINESS,HUMAN RESOURCES
END:VEVENT END:VEVENT
The following is an example of the "VEVENT" calendar component used The following is an example of the "VEVENT" calendar component used
to represent a reminder that will not be opaque, but rather to represent a reminder that will not be opaque, but rather
transparent, to searches for busy time: transparent, to searches for busy time:
Dawson/Stenerson 47 Expires November 1998
BEGIN:VEVENT BEGIN:VEVENT
UID:19970901T130000Z-123402@host.com UID:19970901T130000Z-123402@host.com
DTSTAMP:19970901T1300Z DTSTAMP:19970901T1300Z
DTSTART:19970401T163000Z DTSTART:19970401T163000Z
DTEND:19970402T010000Z DTEND:19970402T010000Z
SUMMARY:Laurel is in sensitivity awareness class. SUMMARY:Laurel is in sensitivity awareness class.
CLASS:PUBLIC CLASS:PUBLIC
CATEGORIES:BUSINESS,HUMAN RESOURCES CATEGORIES:BUSINESS,HUMAN RESOURCES
TRANSP:TRANSPARENT TRANSP:TRANSPARENT
END:VEVENT END:VEVENT
skipping to change at line 2019 skipping to change at line 2588
4.6.2 To-do Component 4.6.2 To-do Component
Component Name: VTODO Component Name: VTODO
Purpose: Provide a grouping of calendar properties that describe a Purpose: Provide a grouping of calendar properties that describe a
to-do. to-do.
Formal Definition: A "VTODO" calendar component is defined by the Formal Definition: A "VTODO" calendar component is defined by the
following notation: following notation:
Dawson/Stenerson 38 Expires September 1998 todoc = "BEGIN" ":" "VTODO" CRLF
todoc = "BEGIN" ":" [WSP] "VTODO" CRLF
todoprop *alarmc todoprop *alarmc
"END" ":" [WSP] "VTODO" CRLF "END" ":" "VTODO" CRLF
todoprop = *attach *attendee *categories [class] *comment todoprop = *attach *attendee *categories [class] *comment
[completed] *contact [created] [description] dtstamp [completed] *contact [created] [description] [dtstamp]
[dtstart] [due / duration] *exdate *exrule [geo] [dtstart] [due / duration] *exdate *exrule [geo]
[last-mod] [location] [organizer] [percent] priority [last-mod] [location] [organizer] [percent] [priority]
[rstatus] *related *resources *rdate *rrule *rstatus *related *resources *rdate *rrule
[recurid] [seq] [status] summary uid [url] [recurid] [seq] [status] [summary] [uid] [url]
*x-prop
Description: A "VTODO" calendar component is a grouping of component Description: A "VTODO" calendar component is a grouping of component
properties and an OPTIONAL "VALARM" calendar component that represent properties and possibly "VALARM" calendar components that represent
an action-item or assignment. For example, it MAY be an item of work an action-item or assignment. For example, it can be used to
assigned to an individual; such as "turn in travel expense today". represent an item of work assigned to an individual; such as "turn in
travel expense today".
The "VTODO" calendar component MUST include the "DTSTAMP",
"PRIORITY", "SUMMARY" and "UID" properties. In addition, it MUST
include the "SEQUENCE" property, if it's value is greater than zero.
Dawson/Stenerson 48 Expires November 1998
The "VTODO" calendar component cannot be nested within another The "VTODO" calendar component cannot be nested within another
calendar component. If "VTODO" calendar components need to be related calendar component. However, "VTODO" calendar components can be
to each other or to a "VTODO" or "VJOURNAL" calendar component, they related to each other or to a "VTODO" or to a "VJOURNAL" calendar
can specify a relationship with the "RELATED-TO" property. component with the "RELATED-TO" property.
A "VTODO" calendar component without the "DTSTART" and "DUE" (or A "VTODO" calendar component without the "DTSTART" and "DUE" (or
"DURATION") properties specifies a to-do that is associated with each "DURATION") properties specifies a to-do that will be associated with
successive calendar dates, until it is completed. each successive calendar date, until it is completed.
Example: The following is an example of a "VTODO" calendar component: Example: The following is an example of a "VTODO" calendar component:
BEGIN:VTODO BEGIN:VTODO
UID:19970901T130000Z-123404@host.com UID:19970901T130000Z-123404@host.com
DTSTAMP:19970901T1300Z DTSTAMP:19970901T1300Z
DTSTART:19970415T133000Z DTSTART:19970415T133000Z
DUE:19970416T045959Z DUE:19970416T045959Z
SUMMARY:1996 Income Tax Preparation SUMMARY:1996 Income Tax Preparation
CLASS:CONFIDENTIAL CLASS:CONFIDENTIAL
skipping to change at line 2073 skipping to change at line 2640
4.6.3 Journal Component 4.6.3 Journal Component
Component Name: VJOURNAL Component Name: VJOURNAL
Purpose: Provide a grouping of component properties that describe a Purpose: Provide a grouping of component properties that describe a
journal entry. journal entry.
Formal Definition: A "VJOURNAL" calendar component is defined by the Formal Definition: A "VJOURNAL" calendar component is defined by the
following notation: following notation:
Dawson/Stenerson 39 Expires September 1998 journalc = "BEGIN" ":" "VJOURNAL" CRLF
journalc = "BEGIN" ":" [WSP] "VJOURNAL" CRLF
jourprop jourprop
"END" ":" [WSP] "VJOURNAL" CRLF "END" ":" "VJOURNAL" CRLF
jourprop = *attach *attendee *categories [class] *comment jourprop = *attach *attendee *categories [class] *comment
*contact [created] description dtstart dtstamp *contact [created] [description] [dtstart] [dtstamp]
*exdate *exrule [last-mod] [organizer] [recurid] *exdate *exrule [last-mod] [organizer] [recurid]
*related *rdate *rrule [rstatus] [seq] summary *related *rdate *rrule *rstatus [seq] [status]
uid [url] [summary] [uid] [url] *x-prop
Description: A "VJOURNAL" calendar component is a grouping of Description: A "VJOURNAL" calendar component is a grouping of
component properties that represent one or more descriptive text component properties that represent one or more descriptive text
notes on a particular calendar date. The "DTSTART" property is used notes associated with a particular calendar date. The "DTSTART"
to specify the calendar date that the journal entry is associated property is used to specify the calendar date that the journal entry
with. Generally, it will have a DATE value data type, but it MAY also is associated with. Generally, it will have a DATE value data type,
be used to specify a DATE-TIME value data type. Examples of a journal but it can also be used to specify a DATE-TIME value data type.
entry include a daily record of a legislative body or a journal entry Examples of a journal entry include a daily record of a legislative
of individual telephone contacts for the day or an ordered list of body or a journal entry of individual telephone contacts for the day
accomplishments for the day. The "VJOURNAL" calendar component can or an ordered list of accomplishments for the day. The "VJOURNAL"
also be used to associate a document with a calendar date. calendar component can also be used to associate a document with a
calendar date.
Dawson/Stenerson 49 Expires November 1998
The "VJOURNAL" calendar component does not take up time on a The "VJOURNAL" calendar component does not take up time on a
calendar. Hence, it does not play a role in free or busy time calendar. Hence, it does not play a role in free or busy time
searches - - it is as though it has a time transparency value of searches - - it is as though it has a time transparency value of
TRANSPARENT. It is transparent to any such searches. TRANSPARENT. It is transparent to any such searches.
The "VJOURNAL" calendar component MUST include the "DTSTAMP",
"DTSTART", "DESCRIPTION", "SUMMARY" an "UID" properties. In addition,
it MUST include the "SEQUENCE" property, if it's value is greater
than zero.
The "VJOURNAL" calendar component cannot be nested within another The "VJOURNAL" calendar component cannot be nested within another
calendar component. If "VJOURNAL" calendar components need to be calendar component. However, "VJOURNAL" calendar components can be
related to each other or to a "VEVENT" or "VTODO" calendar component, related to each other or to a "VEVENT" or to a "VTODO" calendar
they can specify a relationship with the "RELATED-TO" property. component, with the "RELATED-TO" property.
Example: The following is an example of the "VJOURNAL" calendar Example: The following is an example of the "VJOURNAL" calendar
component: component:
BEGIN:VJOURNAL BEGIN:VJOURNAL
UID:19970901T130000Z-123405@host.com UID:19970901T130000Z-123405@host.com
DTSTAMP:19970901T1300Z DTSTAMP:19970901T1300Z
DTSTART;VALUE=DATE:19970317 DTSTART;VALUE=DATE:19970317
SUMMARY:Staff meeting minutes SUMMARY:Staff meeting minutes
DESCRIPTION:1. Staff meeting: Participants include Joe\, Lisa DESCRIPTION:1. Staff meeting: Participants include Joe\, Lisa
and Bob. Aurora project plans were reviewed. There is currently and Bob. Aurora project plans were reviewed. There is currently
no budget reserves for this project. Lisa will escalate to no budget reserves for this project. Lisa will escalate to
management. Next meeting on Tuesday. management. Next meeting on Tuesday.\n
2. Telephone Conference: ABC Corp. sales representative called 2. Telephone Conference: ABC Corp. sales representative called
to discuss new printer. Promised to get us a demo by Friday. to discuss new printer. Promised to get us a demo by Friday.\n
3. Henry Miller (Handsoff Insurance): Car was totaled by tree. 3. Henry Miller (Handsoff Insurance): Car was totaled by tree.
Is looking into a loaner car. 654-2323 (tel). Is looking into a loaner car. 654-2323 (tel).
END:VJOURNAL END:VJOURNAL
Dawson/Stenerson 40 Expires September 1998
4.6.4 Free/Busy Component 4.6.4 Free/Busy Component
Component Name: VFREEBUSY Component Name: VFREEBUSY
Purpose: Provide a grouping of component properties that describe Purpose: Provide a grouping of component properties that describe
either a request for free/busy time, describe a response to a request either a request for free/busy time, describe a response to a request
for free/busy time or describe a published set of busy time. for free/busy time or describe a published set of busy time.
Formal Definition: A "VFREEBUSY" calendar component is defined by the Formal Definition: A "VFREEBUSY" calendar component is defined by the
following notation: following notation:
freebusyc = "BEGIN" ":" [WSP] "VFREEBUSY" CRLF freebusyc = "BEGIN" ":" "VFREEBUSY" CRLF
fbprop fbprop
"END" ":" [WSP] "VFREEBUSY" CRLF "END" ":" "VFREEBUSY" CRLF
fbprop = fbrequest / fbreply / busytime
fbrequest = 1*attendee dtstart dtend [duration] *comment dtstamp
[last-mod] [seq] uid
;This set of properties is used for free/busy time request.
fbreply = 1*attendee [created] *comment [dtstart dtend] dtstamp
1*freebusy [last-mod] [rstatus] [seq] uid
[url]
;This set of properties is used for free/busy time reply.
busytime = attendee dtstamp dtstart dtend *comment 1*freebusy fbprop = *attendee *comment [contact] [dtstart] [dtend]
[url] [duration] [dtstamp] *freebusy [organizer] *rstatus
[uid] [url] *x-prop
Description: A "VFREEBUSY" calendar component is a grouping of Description: A "VFREEBUSY" calendar component is a grouping of
component properties that represents either a request for, a reply to component properties that represents either a request for, a reply to
a request for free or busy time information or a published set of a request for free or busy time information or a published set of
busy time information. busy time information.
When used to request free/busy time information, the "VFREEBUSY" When used to request free/busy time information, the "ATTENDEE"
calendar component MUST include the "ATTENDEE", "DTSTAMP", "DTSTART", property specifies the calendar users whose free/busy time is being
"DTEND", and "UID" properties. In addition, it MUST include the
"SEQUENCE" property, if it's value is greater than zero.
When used to reply to a request for free/busy time, the "VFREEBUSY" Dawson/Stenerson 50 Expires November 1998
calendar component MUST include the "ATTENDEE", "DTSTAMP", requested; the "ORGANIZER" property specifies the calendar user who
"FREEBUSY", and "UID" properties. In addition, it MUST include the is requesting the free/busy time; the "DTSTART" and "DTEND"
"SEQUENCE" property, if it's value is greater than zero. properties specify the window of time that the free/busy time is
being requested; the "UID" and "DTSTAMP" properties are specified to
assist in proper sequencing of multiple free/busy time requests.
When used to publish busy time, the "VFREEBUSY" calendar component When used to reply to a request for free/busy time, the "ATTENDEE"
MUST include the "ATTENDEE", "DTSTAMP", "DTSTART", "DTEND", property specifies the calendar user responding to the free/busy time
"FREEBUSY" properties. request; the "ORGANIZER" property specifies the calendar user that
originally requested the free/busy time; the "FREEBUSY" property
specifies the free/busy time information; and the "UID" and "DTSTAMP"
properties are specified to assist in proper sequencing of multiple
free/busy time replies.
When used to publish busy time, the "ORGANIZER" property specifies
the calendar user associated with the published busy time; the
"DTSTART" and "DTEND" properties specify an inclusive time window
that surrounds the busy time information; the "FREEBUSY" property
specifies the published busy time information; and the "DTSTAMP"
property specifies the date/time that iCalendar object was created.
The "VFREEBUSY" calendar component cannot be nested within another The "VFREEBUSY" calendar component cannot be nested within another
calendar component. Multiple "VFREEBUSY" calendar components MAY be calendar component. Multiple "VFREEBUSY" calendar components can be
specified within an iCalendar object. This permits the grouping of specified within an iCalendar object. This permits the grouping of
Free/Busy information into logical collections, such as monthly Free/Busy information into logical collections, such as monthly
groups of busy time information. groups of busy time information.
Dawson/Stenerson 41 Expires September 1998
The "VFREEBUSY" calendar component is intended for use in iCalendar The "VFREEBUSY" calendar component is intended for use in iCalendar
object methods involving requests for free time, requests for busy object methods involving requests for free time, requests for busy
time, requests for both free and busy, and the associated replies. time, requests for both free and busy, and the associated replies.
Free/Busy information can be expressed using the "FREEBBUSY" Free/Busy information is represented with the "FREEBBUSY" property.
property. This property provides a terse representation of time This property provides a terse representation of time periods. One or
periods. One or more "FREEBUSY" properties MAY be specified in the more "FREEBUSY" properties can be specified in the "VFREEBUSY"
"VFREEBUSY" calendar component to describe the Free/Busy information. calendar component.
When present in a "VFREEBUSY" calendar component, the "DTSTART" and When present in a "VFREEBUSY" calendar component, the "DTSTART" and
"DTEND" properties SHOULD be specified prior to any "FREEBUSY" "DTEND" properties SHOULD be specified prior to any "FREEBUSY"
properties. In a free time request, these properties MAY be used in properties. In a free time request, these properties can be used in
combination with the "DURATION" property to express a request for a combination with the "DURATION" property to represent a request for a
duration of free time within a given window of time. duration of free time within a specified window of time.
The recurrence properties ("RRULE", "EXRULE", "RDATE", "EXDATE") are The recurrence properties ("RRULE", "EXRULE", "RDATE", "EXDATE") are
not permitted within a "VFREEBUSY" calendar component. Any recurring not permitted within a "VFREEBUSY" calendar component. Any recurring
events are resolved into their individual busy time periods using the events are resolved into their individual busy time periods using the
"FREEBUSY" property. "FREEBUSY" property.
Example: The following is an example of a "VFREEBUSY" calendar Example: The following is an example of a "VFREEBUSY" calendar
component used to request free or busy time information: component used to request free or busy time information:
BEGIN:VFREEBUSY BEGIN:VFREEBUSY
ORGANIZER:MAILTO:jane_doe@host1.com ORGANIZER:MAILTO:jane_doe@host1.com
ATTENDEE:MAILTO:john_public@host2.com ATTENDEE:MAILTO:john_public@host2.com
DTSTART:19971015T050000Z DTSTART:19971015T050000Z
Dawson/Stenerson 51 Expires November 1998
DTEND:19971016T050000Z DTEND:19971016T050000Z
DTSTAMP:19970901T083000Z DTSTAMP:19970901T083000Z
SEQUENCE:0
UID:19970901T0830000-uid1@host1.com
END:VFREEBUSY END:VFREEBUSY
The following is an example of a "VFREEBUSY" calendar component used The following is an example of a "VFREEBUSY" calendar component used
to reply to the request with busy time information: to reply to the request with busy time information:
BEGIN:VFREEBUSY BEGIN:VFREEBUSY
ORGANIZER:MAILTO:jane_doe@host1.com
ATTENDEE:MAILTO:john_public@host2.com ATTENDEE:MAILTO:john_public@host2.com
DTSTAMP:19970901T100000Z DTSTAMP:19970901T100000Z
SEQUENCE:0
UID:19970901T0830000-uid1@host1.com
FREEBUSY;VALUE=PERIOD:19971015T050000Z/PT8H30M, FREEBUSY;VALUE=PERIOD:19971015T050000Z/PT8H30M,
19971015T160000Z/PT5H30M,19971015T223000Z/PT6H30M 19971015T160000Z/PT5H30M,19971015T223000Z/PT6H30M
URL:http://host2.com/pub/busy/jpublic-01.vcs URL:http://host2.com/pub/busy/jpublic-01.ifb
COMMENT:This iCalendar file contains busy time information for COMMENT:This iCalendar file contains busy time information for
the next three months. the next three months.
END:VFREEBUSY END:VFREEBUSY
The following is an example of a "VFREEBUSY" calendar component used The following is an example of a "VFREEBUSY" calendar component used
to published busy time information. to published busy time information.
BEGIN:VFREEBUSY BEGIN:VFREEBUSY
ATTENDEE:jsmith@host.com ORGANIZER:jsmith@host.com
DTSTART:19980313T141711Z DTSTART:19980313T141711Z
Dawson/Stenerson 42 Expires September 1998
DTEND:19980410T141711Z DTEND:19980410T141711Z
FREEBUSY:19980314T233000Z/19980315T003000Z FREEBUSY:19980314T233000Z/19980315T003000Z
FREEBUSY:19980316T153000Z/19980316T163000Z FREEBUSY:19980316T153000Z/19980316T163000Z
FREEBUSY:19980318T030000Z/19980318T040000Z FREEBUSY:19980318T030000Z/19980318T040000Z
URL:http://www.host.com/calendar/busytime/jsmith.ifb URL:http://www.host.com/calendar/busytime/jsmith.ifb
END:VFREEBUSY END:VFREEBUSY
4.6.5 Timezone Component 4.6.5 Time Zone Component
Component Name: VTIMEZONE Component Name: VTIMEZONE
Purpose: Provide a grouping of component properties that defines a Purpose: Provide a grouping of component properties that defines a
time zone. time zone.
Formal Definition: A "VTIMEZONE" calendar component is defined by the Formal Definition: A "VTIMEZONE" calendar component is defined by the
following notation: following notation:
timezonec = "BEGIN" ":" [WSP] "VTIMEZONE" CRLF timezonec = "BEGIN" ":" "VTIMEZONE" CRLF
tzid [last-mod] [tzurl] 1*(standardc / daylightc) tzid [last-mod] [tzurl] 1*(standardc / daylightc)
*x-prop
"END" ":" [WSP] "VTIMEZONE" CRLF "END" ":" "VTIMEZONE" CRLF
standardc = "BEGIN" ":" [WSP] "STANDARD" CRLF standardc = "BEGIN" ":" "STANDARD" CRLF
tzprop tzprop
"END" ":" [WSP] "STANDARD" CRLF "END" ":" "STANDARD" CRLF
daylightc = "BEGIN" ":" [WSP] "DAYLIGHT" CRLF Dawson/Stenerson 52 Expires November 1998
daylightc = "BEGIN" ":" "DAYLIGHT" CRLF
tzprop tzprop
"END" ":" [WSP] "DAYLIGHT" CRLF "END" ":" "DAYLIGHT" CRLF
tzprop = *comment dtstart [rdate / rrule]
*tzname tzoffsetto tzoffsetfrom tzprop = *comment dtstart (*rdate / *rrule)
*tzname tzoffsetto tzoffsetfrom *x-prop
Description: A time zone is unambiguously defined by the set of time Description: A time zone is unambiguously defined by the set of time
measurement rules determined by the governing body for a given measurement rules determined by the governing body for a given
geographic area. These rules describe at a minimum the base offset geographic area. These rules describe at a minimum the base offset
from UTC for the time zone, often referred to as the Standard Time from UTC for the time zone, often referred to as the Standard Time
offset. Many locations adjust their Standard Time forward or offset. Many locations adjust their Standard Time forward or backward
backward by one hour, in order to accommodate seasonal changes in by one hour, in order to accommodate seasonal changes in number of
number of daylight hours, often referred to as Daylight Saving Time. daylight hours, often referred to as Daylight Saving Time. Some
Some locations adjust their time by a fraction of an hour. Standard locations adjust their time by a fraction of an hour. Standard Time
Time is also known as Winter Time. Daylight Saving Time is also is also known as Winter Time. Daylight Saving Time is also known as
known as Advanced Time, Summer Time, or Legal Time in certain Advanced Time, Summer Time, or Legal Time in certain countries. The
countries. The following table shows the changes in time zone rules following table shows the changes in time zone rules for the eastern
for the eastern United States starting from 1967. Each line United States starting from 1967. Each line represents a description
represents a description or rule for a particular observance. or rule for a particular observance.
Effective Observance Rule Effective Observance Rule
Dawson/Stenerson 43 Expires September 1998
Date (Date/Time) Offset Abbreviation Date (Date/Time) Offset Abbreviation
1967-* lastSun in Oct, 02:00 -0500 EST 1967-* lastSun in Oct, 02:00 -0500 EST
1967-1973 last Sun in Apr, 02:00 -0400 EDT 1967-1973 last Sun in Apr, 02:00 -0400 EDT
1974-1974 Jan 6, 02:00 -0400 EDT 1974-1974 Jan 6, 02:00 -0400 EDT
1975-1975 Feb 23, 02:00 -0400 EDT 1975-1975 Feb 23, 02:00 -0400 EDT
skipping to change at line 2321 skipping to change at line 2879
Interoperability between two calendaring and scheduling applications, Interoperability between two calendaring and scheduling applications,
especially for recurring events, to-dos or journal entries, is especially for recurring events, to-dos or journal entries, is
dependent on the ability to capture and convey date and time dependent on the ability to capture and convey date and time
information in an unambiguous format. The specification of current information in an unambiguous format. The specification of current
time zone information is integral to this behavior. time zone information is integral to this behavior.
If present, the "VTIMEZONE" calendar component defines the set of If present, the "VTIMEZONE" calendar component defines the set of
Standard Time and Daylight Saving Time observances (or rules) for a Standard Time and Daylight Saving Time observances (or rules) for a
particular time zone for a given interval of time. The "VTIMEZONE" particular time zone for a given interval of time. The "VTIMEZONE"
calendar component cannot be nested within other calendar components. calendar component cannot be nested within other calendar components.
Multiple "VTIMEZONE" calendar components MAY exist in an iCalendar Multiple "VTIMEZONE" calendar components can exist in an iCalendar
object. In this situation, each "VTIMEZONE" MUST represent a unique object. In this situation, each "VTIMEZONE" MUST represent a unique
time zone definition. This is necessary for some classes of events, time zone definition. This is necessary for some classes of events,
such as airline flights, that start in one time zone and end in such as airline flights, that start in one time zone and end in
another. another.
Dawson/Stenerson 53 Expires November 1998
The "VTIMEZONE" calendar component MUST be present if the iCalendar The "VTIMEZONE" calendar component MUST be present if the iCalendar
object contains an RRULE that generates dates on both sides of a time object contains an RRULE that generates dates on both sides of a time
zone shift (e.g. both in Standard Time and Daylight Saving Time) zone shift (e.g. both in Standard Time and Daylight Saving Time)
UNLESS the iCalendar object intends to convey a floating time (See unless the iCalendar object intends to convey a floating time (See
the section "4.1.10.11 Time" for proper interpretation of floating the section "4.1.10.11 Time" for proper interpretation of floating
time). It MAY be present if the iCalendar object does not contain time). It can be present if the iCalendar object does not contain
such a RRULE. In addition, if a RRULE is present, there must be valid such a RRULE. In addition, if a RRULE is present, there must be valid
time zone information for all recurrence instances. time zone information for all recurrence instances.
The "VTIMEZONE" calendar component MUST include the "TZID" property The "VTIMEZONE" calendar component MUST include the "TZID" property
and at least one definition of a standard or daylight component. The and at least one definition of a standard or daylight component. The
standard or daylight component MUST include the "DTSTART", standard or daylight component MUST include the "DTSTART",
"TZOFFSETFROM" and "TZOFFSETTO" properties. "TZOFFSETFROM" and "TZOFFSETTO" properties.
An individual "VTIMEZONE" calendar component MUST be specified for
each unique "TZID" parameter value specified in the iCalendar object.
Each "VTIMEZONE" calendar component consists of a collection of one Each "VTIMEZONE" calendar component consists of a collection of one
or more sub-components that describe the rule for a particular or more sub-components that describe the rule for a particular
observance (either a Standard Time or a Daylight Saving Time observance (either a Standard Time or a Daylight Saving Time
observance). The "STANDARD" sub-component consists of a collection of observance). The "STANDARD" sub-component consists of a collection of
properties that describe Standard Time. The "DAYLIGHT" sub-component properties that describe Standard Time. The "DAYLIGHT" sub-component
consists of a collection of properties that describe Daylight Saving consists of a collection of properties that describe Daylight Saving
Time. In general this collection of properties consists of: Time. In general this collection of properties consists of:
- the first onset date-time for the observance - the first onset date-time for the observance
Dawson/Stenerson 44 Expires September 1998
- the last onset date-time for the observance, if a last onset - the last onset date-time for the observance, if a last onset
is known. is known.
- the offset to be applied for the observance - the offset to be applied for the observance
- a rule that describes the day and time when the observance - a rule that describes the day and time when the observance
takes effect takes effect
- an optional name for the observance - an optional name for the observance
skipping to change at line 2380 skipping to change at line 2941
The top-level properties in a "VTIMEZONE" calendar component are: The top-level properties in a "VTIMEZONE" calendar component are:
The mandatory "TZID" property is a text value that uniquely The mandatory "TZID" property is a text value that uniquely
identifies the VTIMZONE calendar component within the scope of an identifies the VTIMZONE calendar component within the scope of an
iCalendar object. iCalendar object.
The optional "LAST-MODIFIED" property is a UTC value that specifies The optional "LAST-MODIFIED" property is a UTC value that specifies
the date and time that this time zone definition was last updated. the date and time that this time zone definition was last updated.
Dawson/Stenerson 54 Expires November 1998
The optional "TZURL" property is url value that points to a published The optional "TZURL" property is url value that points to a published
VTIMEZONE definition. VTIMEZONE definition.
The collection of properties that are used to define the STANDARD and The collection of properties that are used to define the STANDARD and
DAYLIGHT sub-components include: DAYLIGHT sub-components include:
The mandatory "DTSTART" property gives the effective onset date and The mandatory "DTSTART" property gives the effective onset date and
local time for the time zone sub-component definition. "DTSTART" in local time for the time zone sub-component definition. "DTSTART" in
this usage MUST be specified as a local DATE-TIME value. this usage MUST be specified as a local DATE-TIME value.
The mandatory "TZOFFSETFROM" property gives the UTC offset which is The mandatory "TZOFFSETFROM" property gives the UTC offset which is
in use when the onset of this time zone observance begins. in use when the onset of this time zone observance begins.
"TZOFFSETFROM" is combined with "DTSTART" to define the effective "TZOFFSETFROM" is combined with "DTSTART" to define the effective
onset for the time zone sub-component definition. For example, the onset for the time zone sub-component definition. For example, the
following represents the time at which the observance of Standard following represents the time at which the observance of Standard
Time took effect in 1967 for the eastern United States: Time took effect in Fall 1967 for the eastern United States:
DTSTART:19671029T020000 DTSTART:19671029T020000
TZOFFSETFROM:-0400 TZOFFSETFROM:-0400
The mandatory "TZOFFSETTO " property gives the UTC offset for the The mandatory "TZOFFSETTO " property gives the UTC offset for the
time zone sub-component (Standard Time or Daylight Saving Time) when time zone sub-component (Standard Time or Daylight Saving Time) when
this observance is in use. this observance is in use.
Dawson/Stenerson 45 Expires September 1998
The optional "TZNAME" property is the customary name for the time The optional "TZNAME" property is the customary name for the time
zone. It may be specified multiple times, to allow for specifying zone. It may be specified multiple times, to allow for specifying
multiple language variants of the time zone names. This could be used multiple language variants of the time zone names. This could be used
for displaying dates. for displaying dates.
If specified, the onset for the observance defined by the time zone If specified, the onset for the observance defined by the time zone
sub-component is defined by either the "RRULE" or "RDATE" property. sub-component is defined by either the "RRULE" or "RDATE" property.
If neither are specified, only one sub-component can be specified in If neither are specified, only one sub-component can be specified in
the "VTIMEZONE" calendar component and it is assumed that the single the "VTIMEZONE" calendar component and it is assumed that the single
observance specified is always in effect. observance specified is always in effect.
The "RRULE" property defines the recurrence rule for the onset of the The "RRULE" property defines the recurrence rule for the onset of the
observance defined by this time zone sub-component. Some specific observance defined by this time zone sub-component. Some specific
requirements for the usage of RRULE for this purpose: requirements for the usage of RRULE for this purpose include:
- If observance is known to have an effective end date, the - If observance is known to have an effective end date, the
"UNTIL" recurrence rule parameter MUST be used to specify the "UNTIL" recurrence rule parameter MUST be used to specify the
last valid onset of this observance (i.e., the UNTIL date-time last valid onset of this observance (i.e., the UNTIL date-time
will be equal to the last instance generated by the recurrence will be equal to the last instance generated by the recurrence
pattern). It MUST be specified as a full DATE-TIME value, using pattern). It MUST be specified in UTC time.
local time plus the UTC offset.
- The local time and UTC offset values provided in the "DTSTART" - The "DTSTART" and the "TZOFFSETTO" properties MUST be used
property for the given observance MUST be used when generating when generating the onset date-time values (instances) from the
the onset date-time values (instances) from the RRULE. This RRULE.
interpretation of the "DTSTART" UTC offset value is specific to
"RRULE" usage in the "VTIMEZONE" specification.
Alternatively, the "RDATE" property MAY be used to define the onset Alternatively, the "RDATE" property can be used to define the onset
of the observance by giving the individual onset date and times. of the observance by giving the individual onset date and times.
"RDATE" in this usage MUST be specified as a local DATE-TIME value "RDATE" in this usage MUST be specified as a local DATE-TIME value in
with UTC offset. UTC time.
Dawson/Stenerson 55 Expires November 1998
The optional "COMMENT" property is also allowed for descriptive The optional "COMMENT" property is also allowed for descriptive
explanatory text. explanatory text.
Example: The following are examples of the "VTIMEZONE" calendar Example: The following are examples of the "VTIMEZONE" calendar
component: component:
This is a simple example showing time zone information for the This is an example showing time zone information for the Eastern
Eastern United States using "RDATE" property. Note that this is only United States using "RDATE" property. Note that this is only suitable
suitable for a recurring event that starts on or later than April 6, for a recurring event that starts on or later than April 6, 1997 at
1997 at 02:00:00 EST (i.e., the earliest effective transition date 03:00:00 EDT (i.e., the earliest effective transition date and time)
and time) and ends no later than April 7, 1998 02:00:00 EST (i.e., and ends no later than April 7, 1998 02:00:00 EST (i.e., latest valid
latest valid date and time for EST in this scenario). For example, date and time for EST in this scenario). For example, this can be
this can be used for a recurring event that occurs every Friday, used for a recurring event that occurs every Friday, 8am-9:00 AM,
8am-9am, starting June 1, 1997, ending December 31, 1997. starting June 1, 1997, ending December 31, 1997.
BEGIN:VTIMEZONE BEGIN:VTIMEZONE
TZID:America-New_York TZID:America-New_York
LAST-MODIFIED:19870101T000000Z LAST-MODIFIED:19870101T000000Z
BEGIN:STANDARD BEGIN:STANDARD
DTSTART:19971026T020000 DTSTART:19971026T020000
RDATE:19971026T020000 RDATE:19971026T020000
Dawson/Stenerson 46 Expires September 1998
TZOFFSETFROM:-0400 TZOFFSETFROM:-0400
TZOFFSETTO:-0500 TZOFFSETTO:-0500
TZNAME:EST TZNAME:EST
END:STANDARD END:STANDARD
BEGIN:DAYLIGHT BEGIN:DAYLIGHT
DTSTART:19971026T020000 DTSTART:19971026T020000
RDATE:19970406T020000 RDATE:19970406T020000
TZOFFSETFROM:-0500 TZOFFSETFROM:-0500
TZOFFSETTO:-0400 TZOFFSETTO:-0400
TZNAME:EDT TZNAME:EDT
skipping to change at line 2495 skipping to change at line 3052
BEGIN:STANDARD BEGIN:STANDARD
DTSTART:19671029T020000 DTSTART:19671029T020000
RRULE:FREQ=YEARLY;BYDAY=-1SU;BYMONTH=10 RRULE:FREQ=YEARLY;BYDAY=-1SU;BYMONTH=10
TZOFFSETFROM:-0400 TZOFFSETFROM:-0400
TZOFFSETTO:-0500 TZOFFSETTO:-0500
TZNAME:EST TZNAME:EST
END:STANDARD END:STANDARD
BEGIN:DAYLIGHT BEGIN:DAYLIGHT
DTSTART:19870405T020000 DTSTART:19870405T020000
RRULE: FREQ=YEARLY;BYDAY=1SU;BYMONTH=4 RRULE: FREQ=YEARLY;BYDAY=1SU;BYMONTH=4
Dawson/Stenerson 56 Expires November 1998
TZOFFSETFROM:-0500 TZOFFSETFROM:-0500
TZOFFSETTO:-0400 TZOFFSETTO:-0400
TZNAME:EDT TZNAME:EDT
END:DAYLIGHT END:DAYLIGHT
END:VTIMEZONE END:VTIMEZONE
This is an example showing a fictitious set of rules for the Eastern This is an example showing a fictitious set of rules for the Eastern
United States, where the Daylight Time rule has an effective end date United States, where the Daylight Time rule has an effective end date
(i.e., after that date, Daylight Time is no longer observed). (i.e., after that date, Daylight Time is no longer observed).
skipping to change at line 2516 skipping to change at line 3075
TZID:America-New_York TZID:America-New_York
LAST-MODIFIED:19870101T000000Z LAST-MODIFIED:19870101T000000Z
BEGIN:STANDARD BEGIN:STANDARD
DTSTART:19671029T020000 DTSTART:19671029T020000
RRULE:FREQ=YEARLY;BYDAY=-1SU;BYMONTH=10 RRULE:FREQ=YEARLY;BYDAY=-1SU;BYMONTH=10
TZOFFSETFROM:-0400 TZOFFSETFROM:-0400
TZOFFSETTO:-0500 TZOFFSETTO:-0500
TZNAME:EST TZNAME:EST
END:STANDARD END:STANDARD
BEGIN:DAYLIGHT BEGIN:DAYLIGHT
Dawson/Stenerson 47 Expires September 1998
DTSTART:19870405T020000 DTSTART:19870405T020000
RRULE:FREQ=YEARLY;BYDAY=1SU;BYMONTH=4;UNTIL=19980404T070000 RRULE:FREQ=YEARLY;BYDAY=1SU;BYMONTH=4;UNTIL=19980404T070000Z
TZOFFSETFROM:-0500 TZOFFSETFROM:-0500
TZOFFSETTO:-0400 TZOFFSETTO:-0400
TZNAME:EDT TZNAME:EDT
END:DAYLIGHT END:DAYLIGHT
END:VTIMEZONE END:VTIMEZONE
This is an example showing a fictitious set of rules for the Eastern This is an example showing a fictitious set of rules for the Eastern
United States, where the first Daylight Time rule has an effective United States, where the first Daylight Time rule has an effective
end date. There is a second Daylight Time rule that picks up where end date. There is a second Daylight Time rule that picks up where
the other left off. the other left off.
skipping to change at line 2543 skipping to change at line 3100
LAST-MODIFIED:19870101T000000Z LAST-MODIFIED:19870101T000000Z
BEGIN:STANDARD BEGIN:STANDARD
DTSTART:19671029T020000 DTSTART:19671029T020000
RRULE:FREQ=YEARLY;BYDAY=-1SU;BYMONTH=10 RRULE:FREQ=YEARLY;BYDAY=-1SU;BYMONTH=10
TZOFFSETFROM:-0400 TZOFFSETFROM:-0400
TZOFFSETTO:-0500 TZOFFSETTO:-0500
TZNAME:EST TZNAME:EST
END:STANDARD END:STANDARD
BEGIN:DAYLIGHT BEGIN:DAYLIGHT
DTSTART:19870405T020000 DTSTART:19870405T020000
RRULE:FREQ=YEARLY;BYDAY=1SU;BYMONTH=4;UNTIL=19980404T070000 RRULE:FREQ=YEARLY;BYDAY=1SU;BYMONTH=4;UNTIL=19980404T070000Z
TZOFFSETFROM:-0500 TZOFFSETFROM:-0500
TZOFFSETTO:-0400 TZOFFSETTO:-0400
TZNAME:EDT TZNAME:EDT
END:DAYLIGHT END:DAYLIGHT
BEGIN:DAYLIGHT BEGIN:DAYLIGHT
DTSTART:19990424T020000 DTSTART:19990424T020000
RRULE:FREQ=YEARLY;BYDAY=-1SU;BYMONTH=4 RRULE:FREQ=YEARLY;BYDAY=-1SU;BYMONTH=4
Dawson/Stenerson 57 Expires November 1998
TZOFFSETFROM:-0500 TZOFFSETFROM:-0500
TZOFFSETTO:-0400 TZOFFSETTO:-0400
TZNAME:EDT TZNAME:EDT
END:DAYLIGHT END:DAYLIGHT
END:VTIMEZONE END:VTIMEZONE
4.6.6 Alarm Component 4.6.6 Alarm Component
Component Name: VALARM Component Name: VALARM
Purpose: Provide a grouping of component properties that define an Purpose: Provide a grouping of component properties that define an
alarm. alarm.
Formal Definition: A "VALARM" calendar component is defined by the Formal Definition: A "VALARM" calendar component is defined by the
following notation: following notation:
alarmc = "BEGIN" ":" [WSP] "VALARM" CRLF alarmc = "BEGIN" ":" "VALARM" CRLF
(audioprop / dispprop / emailprop (audioprop / dispprop / emailprop / procprop)
/ procprop) "END" ":" "VALARM" CRLF
"END" ":" [WSP] "VALARM" CRLF
Dawson/Stenerson 48 Expires September 1998 audioprop = action trigger [duration repeat] [attach] *x-prop
audioprop = alarmtype trigger [duration repeat] attach
dispprop = alarmtype description trigger [duration dispprop = action description trigger [duration
repeat] repeat] *x-prop
emailprop = alarmtype 1*attendee *attach description emailprop = action 1*attendee *attach description
trigger [duration repeat] summary trigger [duration repeat] summary *x-prop
procprop = alarmtype attach [description] trigger [duration procprop = action attach [description] trigger [duration
repeat] repeat] *x-prop
Description: A "VALARM" calendar component is a grouping of component Description: A "VALARM" calendar component is a grouping of component
properties that is a reminder or alarm for an event or a to-do. For properties that is a reminder or alarm for an event or a to-do. For
example, it may be used to define a reminder for a pending event or example, it may be used to define a reminder for a pending event or
an overdue to-do. an overdue to-do.
The "VALARM" calendar component MUST include the "ALARM-TYPE" and The "VALARM" calendar component MUST include the "ACTION" and
"TRIGGER" properties. In addition, an AUDIO type of alarm MUST "TRIGGER" properties. The "ACTION" property further constrains the
include the "ATTACH" property to point to a digital sound resource to "VALARM" calendar component in the following ways:
be played. The DISPLAY type of alarm MUST include the "DESCRIPTION"
property. The EMAIL type of alarm MUST include the "ATTENDEE", When the action is "AUDIO", the alarm can also include one and only
"DESCRIPTION" and "SUMMARY" properties. The PROCEDURE type of alarm one "ATTACH" property, which MUST point to a sound resource, which is
MUST include the "ATTACH" property to point to a procedure resource rendered when the alarm is triggered.
to be invoked.
When the action is "DISPLAY", the alarm MUST also include a
"DESCRIPTION" property, which contains the text to be displayed when
the alarm is triggered.
When the action is "EMAIL", the alarm MUST include a "DESCRIPTION"
property, which contains the text to be used as the message body, a
"SUMMARY" property, which contains the text to be used as the message
subject, and one or more "ATTENDEE" properties, which contain the
email address of attendees to receive the message. It can also
include one or more "ATTACH" properties, which are intended to be
Dawson/Stenerson 58 Expires November 1998
sent as message attachments. When the alarm is triggered, the email
message is sent.
When the action is "PROCEDURE", the alarm MUST include one and only
one "ATTACH" property, which MUST point to a procedure resource,
which is invoked when the alarm is triggered.
The "VALARM" calendar component MUST only appear within either a The "VALARM" calendar component MUST only appear within either a
"VEVENT" or "VTODO" calendar component. The "VALARM" calendar "VEVENT" or "VTODO" calendar component. "VALARM" calendar components
components cannot be nested. Multiple "VALARM" calendar components cannot be nested. Multiple mutually independent "VALARM" calendar
MAY be specified. components can be specified for a single "VEVENT" or "VTODO" calendar
component.
The "TRIGGER" property specifies when the alarm will be triggered. The "TRIGGER" property specifies when the alarm will be triggered.
The "TRIGGER" property specifies a duration prior to the start of an The "TRIGGER" property specifies a duration prior to the start of an
event or a to-do. The "TRIGGER" edge may be explicitly set to be event or a to-do. The "TRIGGER" edge may be explicitly set to be
relative to the "START" or "END" of the event or to-do with the relative to the "START" or "END" of the event or to-do with the
"RELATED" parameter of the "TRIGGER" property. The "TRIGGER" property "RELATED" parameter of the "TRIGGER" property. The "TRIGGER" property
value type MAY alternately be set to an absolute calendar date and value type can alternatively be set to an absolute calendar date and
time of day value. time of day value.
In an alarm set to trigger on the "START" of an event or to-do, the In an alarm set to trigger on the "START" of an event or to-do, the
"DTSTART" property MUST be present in the associated event or to-do. "DTSTART" property MUST be present in the associated event or to-do.
In an alarm in a "VEVENT" calendar component set to trigger on the In an alarm in a "VEVENT" calendar component set to trigger on the
"END" of the event, the "DTEND" or "DTSTART" and "DURATION" "END" of the event, either the "DTEND" property MUST be present, or
properties MUST be present. In an alarm in a "VTODO" calendar the "DTSTART" and "DURATION" properties MUST both be present. In an
component set to trigger on the "END" of the to-do, the "DUE" or alarm in a "VTODO" calendar component set to trigger on the "END" of
"DTSTART" and "DURATION" properties MUST be present. the to-do, either the "DUE" property MUST be present, or the
"DTSTART" and "DURATION" properties MUST both be present.
The alarm MAY be defined such that it triggers repetitively. A The alarm can be defined such that it triggers repeatedly. A
definition of an alarm with a repeating trigger MUST include both the definition of an alarm with a repeating trigger MUST include both the
"DURATION" and "REPEAT" properties. The "DURATION" property specifies "DURATION" and "REPEAT" properties. The "DURATION" property specifies
the delay period, after which the alarm will repeat. The "REPEAT" the delay period, after which the alarm will repeat. The "REPEAT"
property specifies the number of additional repetitions that the property specifies the number of additional repetitions that the
alarm will triggered. This count is in addition to the initial alarm will triggered. This repitition count is in addition to the
triggering of the alarm. Both of these properties must be present in initial triggering of the alarm. Both of these properties must be
order to specify a repeating alarm. If one of these two properties present in order to specify a repeating alarm. If one of these two
properties is absent, then the alarm will not repeat beyond the
initial trigger.
Dawson/Stenerson 49 Expires September 1998 The "ACTION" property is used within the "VALARM" calendar component
are absent, then the alarm will not repeat beyond the initial to specify the type of action invoked when the alarm is triggered.
trigger. The "VALARM" properties provide enough information for a specific
action to be invoked. It is typically the responsibility of a
"Calendar User Agent" (CUA) to deliver the alarm in the specified
fashion. An "ACTION" property value of AUDIO specifies an alarm that
causes a sound to be played to alert the user; DISPLAY specifies an
alarm that causes a text message to be displayed to the user; EMAIL
specifies an alarm that causes an electronic email message to be
delivered to one or more email addresses; and PROCEDURE specifies an
alarm that causes a procedure to be executed. The "ACTION" property
MUST specify one and only one of these values.
The "ALARM-TYPE" property is used within the "VALARM" calendar Dawson/Stenerson 59 Expires November 1998
component to specify the type of the alarm. The "ALARM-TYPE" property In an AUDIO alarm, if the optional "ATTACH" property is included, it
value of AUDIO specifies an alarm that triggers with an audio sound; MUST specify an audio sound resource. The intention is that the sound
a value of DISPLAY specifies an alarm that triggers with the will be played as the alarm effect. If an "ATTACH" property is
"Calendar User Agent" displaying text; the value of EMAIL specifies specified that does not refer to a sound resource, or if the
an alarm that triggers the posting of an electronic email message to specified sound resource cannot be rendered (because its format is
one or more email addresses; and the value of PROCEDURE specifies an unsupported, or because it cannot be retrieved), then the CUA or
alarm that triggers the execution of a procedure. The "ALARM-TYPE" other entity responsible for playing the sound may choose a fallback
property MUST specify just one of these valid values. Multiple action, such as playing a built-in default sound, or playing no sound
categories of alarms MAY BE specified by defining more than one, at all.
different categories of "VALARM" calendar components within a
"VEVENT" or "VTODO" calendar component.
In an AUDIO type of alarm, the "ATTACH" property in the "VALARM" In a DISPLAY alarm, the intended alarm effect is for the text value
calendar component MUST specify an audio sound file that is intended of the "DESCRIPTION" property to be displayed to the user.
to be rendered as the alarm effect. If an "ATTACH" property is
specified that does not refer to a digital sound resource, then no
audio alarm will be sounded. If the digital sound resource is in a
format that cannot be rendered, then no audio alarm will be sounded.
In a DISPLAY type of alarm, the "DESCRIPTION" property in the In an EMAIL alarm, the intended alarm effect is for an email message
"VALARM" calendar component is intended to be displayed as the alarm to be composed and delivered to all the addresses specified by the
effect. In an EMAIL category of alarm, the intended alarm effect is "ATTENDEE" properties in the "VALARM" calendar component. The
to use the "DESCRIPTION" property in the "VALARM" calendar component "DESCRIPTION" property of the "VALARM" calendar component MUST be
as the body text of an email message that is to be sent to the used as the body text of the message, and the "SUMMARY" property MUST
addresses specified by any "ATTENDEE" properties present in the be used as the subject text. Any "ATTACH" properties in the "VALARM"
"VALARM" calendar component. The "SUMMARY" property in the "VALARM" calendar component SHOULD be sent as attachments to the message.
calendar component is intended to be used as the subject text for the
email. Any "ATTACH" properties are sent as email attachments.
In a PROCEDURE type of alarm, the "ATTACH" property in the "VALARM" In a PROCEDURE alarm, the "ATTACH" property in the "VALARM" calendar
calendar component MUST specify a procedure or program that is component MUST specify a procedure or program that is intended to be
intended to be invoked as the alarm effect. If the procedure or invoked as the alarm effect. If the procedure or program is in a
program is in a format that cannot be rendered, then no procedure format that cannot be rendered, then no procedure alarm will be
alarm will be invoked. If the "DESCRIPTION" property is present, its invoked. If the "DESCRIPTION" property is present, its value
value specifies the argument string to be passed to the procedure or specifies the argument string to be passed to the procedure or
program. "Calendar User Agents" that receive an iCalendar object with program. "Calendar User Agents" that receive an iCalendar object with
this category of alarm, should allow the "Calendar User" to disable this category of alarm, can disable or allow the "Calendar User" to
or otherwise ignore this type of alarm. While a very useful alarm disable, or otherwise ignore this type of alarm. While a very useful
capability, the PROCEDURE type of alarm should be treated by the alarm capability, the PROCEDURE type of alarm should be treated by
"Calendar User Agent" as a potential security risk. the "Calendar User Agent" as a potential security risk.
Example: The following example is for a "VALARM" calendar component Example: The following example is for a "VALARM" calendar component
that specifies an audio alarm that will sound at a precise time and that specifies an audio alarm that will sound at a precise time and
repeat 4 more times at 15 minute intervals: repeat 4 more times at 15 minute intervals:
BEGIN:VALARM BEGIN:VALARM
TRIGGER;VALUE=DATE-TIME:19970317T133000Z TRIGGER;VALUE=DATE-TIME:19970317T133000Z
REPEAT:4 REPEAT:4
DURATION:PT15M DURATION:PT15M
ALARM-TYPE: AUDIO ACTION:AUDIO
Dawson/Stenerson 50 Expires September 1998
ATTACH:ftp://host.com/pub/sounds/bell-01.wav ATTACH:ftp://host.com/pub/sounds/bell-01.wav
END:VALARM END:VALARM
The following example is for a "VALARM" calendar component that The following example is for a "VALARM" calendar component that
specifies a display alarm that will trigger 15 minutes before the specifies a display alarm that will trigger 30 minutes before the
scheduled start of the event or the due date/time of the to-do it is scheduled start of the event or the due date/time of the to-do it is
associated with and will repeat 2 more times at 15 minute intervals: associated with and will repeat 2 more times at 15 minute intervals:
BEGIN:VALARM BEGIN:VALARM
TRIGGER:PT30M TRIGGER:PT30M
REPEAT:2 REPEAT:2
DURATION:PT15M DURATION:PT15M
ALARM-TYPE:DISPLAY
Dawson/Stenerson 60 Expires November 1998
ACTION:DISPLAY
DESCRIPTION:Breakfast meeting with executive\n DESCRIPTION:Breakfast meeting with executive\n
team at 8:30 AM EST. team at 8:30 AM EST.
END:VALARM END:VALARM
The following example is for a "VALARM" calendar component that The following example is for a "VALARM" calendar component that
specifies an email alarm that will trigger 2 days before the specifies an email alarm that will trigger 2 days before the
scheduled due date/time of a to-do it is associated with. It does not scheduled due date/time of a to-do it is associated with. It does not
repeat. The email has a subject, body and attachment link. repeat. The email has a subject, body and attachment link.
BEGIN:VALARM BEGIN:VALARM
TRIGGER:P2D TRIGGER:P2D
ALARM-TYPE:EMAIL ACTION:EMAIL
ATTENDEE:MAILTO:john_doe@host.com ATTENDEE:MAILTO:john_doe@host.com
SUMMARY:*** REMINDER: SEND AGENDA FOR WEEKLY STAFF MEETING *** SUMMARY:*** REMINDER: SEND AGENDA FOR WEEKLY STAFF MEETING ***
DESCRIPTION:A draft agenda needs to be sent out to the attendees DESCRIPTION:A draft agenda needs to be sent out to the attendees
to the weekly managers meeting (MGR-LIST). Attached is a to the weekly managers meeting (MGR-LIST). Attached is a
pointer the document template for the agenda file. pointer the document template for the agenda file.
ATTACH:http://host.com/templates/agenda.doc ATTACH:http://host.com/templates/agenda.doc
END:VALARM END:VALARM
The following example is for a "VALARM" calendar component that The following example is for a "VALARM" calendar component that
specifies a procedural alarm that will trigger at a precise date/time specifies a procedural alarm that will trigger at a precise date/time
and will repeat 23 more times at one hour intervals. The alarm will and will repeat 23 more times at one hour intervals. The alarm will
invoke a procedure file. invoke a procedure file.
BEGIN:VALARM BEGIN:VALARM
TRIGGER;VALUE=DATE-TIME:19980101T050000Z TRIGGER;VALUE=DATE-TIME:19980101T050000Z
REPEAT:23 REPEAT:23
DURATION:PT1H DURATION:PT1H
ALARM-TYPE:PROCEDURE ACTION:PROCEDURE
ATTACH:ftp://host.com/novo-procs/felizano.exe ATTACH:ftp://host.com/novo-procs/felizano.exe
END:VALARM END:VALARM
4.7 Calendar Properties 4.7 Calendar Properties
The Calendar Properties are attributes that apply to the iCalendar The Calendar Properties are attributes that apply to the iCalendar
object, as a whole. These properties do not appear within a calendar object, as a whole. These properties do not appear within a calendar
component. They should be specified after the "BEGIN:VCALENDAR" component. They should be specified after the "BEGIN:VCALENDAR"
property and prior to any calendar component. property and prior to any calendar component.
Dawson/Stenerson 51 Expires September 1998
4.7.1 Calendar Scale 4.7.1 Calendar Scale
Property Name: CALSCALE Property Name: CALSCALE
Purpose: This property defines the calendar scale used for the Purpose: This property defines the calendar scale used for the
calendar information specified in the iCalendar object. calendar information specified in the iCalendar object.
Value Type: TEXT Value Type: TEXT
Conformance: Property MAY be specified in an iCalendar object. The Property Parameters: Non-standard property parameters can be
specified on this property.
Dawson/Stenerson 61 Expires November 1998
Conformance: Property can be specified in an iCalendar object. The
default value is "GREGORIAN". default value is "GREGORIAN".
Description: This memo is based on the Gregorian calendar scale. The Description: This memo is based on the Gregorian calendar scale. The
Gregorian calendar scale is assumed if this property is not specified Gregorian calendar scale is assumed if this property is not specified
in the iCalendar object. It is expected that other calendar scales in the iCalendar object. It is expected that other calendar scales
will be defined in other specifications or by future versions of this will be defined in other specifications or by future versions of this
memo. memo.
No property parameters MAY be specified on this property.
Format Definition: The property is defined by the following notation: Format Definition: The property is defined by the following notation:
calscale = "CALSCALE" ":" [WSP] calvalue CRLF calscale = "CALSCALE" calparam ":" calvalue CRLF
calparam = *(";" xparam)
calvalue = "GREGORIAN" / iana-token calvalue = "GREGORIAN" / iana-token
Example: The following is an example of this property: Example: The following is an example of this property:
CALSCALE:GREGORIAN CALSCALE:GREGORIAN
4.7.2 Method 4.7.2 Method
Property Name: METHOD Property Name: METHOD
Purpose: This property defines the iCalendar object method associated Purpose: This property defines the iCalendar object method associated
with the calendar object. with the calendar object.
Value Type: TEXT Value Type: TEXT
Conformance: The property MAY be specified in an iCalendar object. Property Parameters: Non-standard property parameters can be
specified on this property.
Conformance: The property can be specified in an iCalendar object.
Description: When used in a MIME message entity, the value of this Description: When used in a MIME message entity, the value of this
property MUST be the same as the Content-Type "method" parameter property MUST be the same as the Content-Type "method" parameter
value. This property can only appear once within the iCalendar value. This property can only appear once within the iCalendar
object. If either the "METHOD" property or the Content-Type "method" object. If either the "METHOD" property or the Content-Type "method"
parameter is specified, then the other must also be specified. parameter is specified, then the other must also be specified.
No methods are defined by this specification. This is the subject of No methods are defined by this specification. This is the subject of
other specifications, such as the iCalendar Transport-independent other specifications, such as the iCalendar Transport-independent
Interoperability Protocol (iTIP) defined by [ITIP]. Interoperability Protocol (iTIP) defined by [ITIP].
Dawson/Stenerson 52 Expires September 1998 If this property is not present in the iCalendar object, then a
If this property is not present in the iCalendar object, then no scheduling transaction MUST NOT be assumed. In such cases, the
scheduling transaction MAY be assumed. In such cases, the iCalendar iCalendar object is merely being used to transport a snapshot of some
object is merely being used to transport a snapshot of some calendar calendar information; without the intention of conveying a scheduling
information; without the intention of conveying a scheduling
semantic. semantic.
No property parameters MAY be specified on this property.
Format Definition: The property is defined by the following notation: Format Definition: The property is defined by the following notation:
method = "METHOD" ":" [WSP] method-value CRLF method = "METHOD" metparam ":" metvalue CRLF
method-value = iana-token Dawson/Stenerson 62 Expires November 1998
metparam = *(";" xparam)
metvalue = iana-token
Example: The following is a hypothetical example of this property to Example: The following is a hypothetical example of this property to
convey that the iCalendar object is a request for a meeting: convey that the iCalendar object is a request for a meeting:
METHOD:REQUEST METHOD:REQUEST
4.7.3 Product Identifier 4.7.3 Product Identifier
Property Name: PRODID Property Name: PRODID
Purpose: This property specifies the identifier for the product that Purpose: This property specifies the identifier for the product that
created the iCalendar object. created the iCalendar object.
Value Type: TEXT Value Type: TEXT
Conformance: The property MUST be specified in an iCalendar object Property Parameters: Non-standard property parameters can be
but can only appear once. specified on this property.
Conformance: The property MUST be specified once in an iCalendar
object.
Description: The vendor of the implementation should assure that this Description: The vendor of the implementation should assure that this
is a globally unique identifier; using some technique such as an ISO is a globally unique identifier; using some technique such as an FPI
9070 FPI value. value, as defined in [ISO 9070].
This property should not be used to alter the interpretation of an This property should not be used to alter the interpretation of an
iCalendar object beyond the semantics specified in this memo. For iCalendar object beyond the semantics specified in this memo. For
example, it is not to be used to further the understanding of non- example, it is not to be used to further the understanding of non-
standard properties. standard properties.
No property parameters MAY be specified on this property.
Format Definition: The property is defined by the following notation: Format Definition: The property is defined by the following notation:
prodid = "PRODID" ":" [WSP] pidvalue CRLF prodid = "PRODID" pidparam ":" pidvalue CRLF
pidparam = *(";" xparam)
pidvalue = text pidvalue = text
;Any text that describes the product and version ;Any text that describes the product and version
;and that is generally assured of being unique. ;and that is generally assured of being unique.
Example: The following is an example of this property: Example: The following is an example of this property. It does not
imply that English is the default language.
PRODID:-//ABC Corporation//NONSGML My Product//EN PRODID:-//ABC Corporation//NONSGML My Product//EN
Dawson/Stenerson 53 Expires September 1998
4.7.4 Version 4.7.4 Version
Property Name: VERSION Property Name: VERSION
Purpose: This property specifies the identifier corresponding to the Purpose: This property specifies the identifier corresponding to the
highest version number or the minimum and maximum range of the highest version number or the minimum and maximum range of the
Dawson/Stenerson 63 Expires November 1998
iCalendar specification that is required in order to interpret the iCalendar specification that is required in order to interpret the
iCalendar object. iCalendar object.
Value Type: TEXT Value Type: TEXT
Conformance: This property MUST be specified by in an iCalendar Property Parameters: Non-standard property parameters can be
object, but MAY only be specified once. specified on this property.
Description: A value of "2.0" corresponds to this memo. Conformance: This property MUST be specified by an iCalendar object,
but MUST only be specified once.
No property parameters MAY be specified on this property. Description: A value of "2.0" corresponds to this memo.
Format Definition: The property is defined by the following notation: Format Definition: The property is defined by the following notation:
version = "VERSION" ":" [WSP] vervalue CRLF version = "VERSION" verparam ":" vervalue CRLF
verparam = *(";" xparam)
vervalue = "2.0" ;This memo vervalue = "2.0" ;This memo
/ maxver / maxver
/ (minver ";" [WSP] maxver) / (minver ";" maxver)
minver = <A IANA registered iCalendar version identifier> minver = <A IANA registered iCalendar version identifier>
;Minimum iCalendar version used to create the iCalendar object ;Minimum iCalendar version needed to parse the iCalendar object
maxver = <A IANA registered iCalendar version identifier> maxver = <A IANA registered iCalendar version identifier>
;Maximum iCalendar version used to create the iCalendar object ;Maximum iCalendar version needed to parse the iCalendar object
Example: The following is an example of this property: Example: The following is an example of this property:
VERSION:2.0 VERSION:2.0
4.8 Component Properties 4.8 Component Properties
The following properties MAY appear within calendar components, as The following properties can appear within calendar components, as
specified by each component property definition. specified by each component property definition.
4.8.1 Descriptive Component Properties 4.8.1 Descriptive Component Properties
The following properties specify descriptive information about The following properties specify descriptive information about
calendar components. calendar components.
4.8.1.1 Attachment 4.8.1.1 Attachment
Property Name: ATTACH Property Name: ATTACH
Purpose: The property provides the capability to associate a document Purpose: The property provides the capability to associate a document
object with a calendar component. object with a calendar component.
Dawson/Stenerson 54 Expires September 1998
Value Type: The default value type for this property is URI. The Value Type: The default value type for this property is URI. The
value type MAY also be reset to BINARY in order to include inline value type can also be reset to BINARY in order to include inline
binary encoded content information. binary encoded content information.
Conformance: The property MAY be specified in an iCalendar object. Dawson/Stenerson 64 Expires November 1998
Property Parameters: Non-standard, inline encoding, value data type
property parameters can be specified on this property.
Description: The property MAY only be specified within "VEVENT", Conformance: The property can be specified in an iCalendar object.
"VTODO", "VJOURNAL", or "VALARM" calendar components. This property
MAY be specified multiple times within an iCalendar object.
Only the "ENCODING" and "VALUE", property parameters MAY be specified Description: The property can be specified within "VEVENT", "VTODO",
on this property. "VJOURNAL", or "VALARM" calendar components. This property can be
specified multiple times within an iCalendar object.
Format Definition: The property is defined by the following notation: Format Definition: The property is defined by the following notation:
attach = ("ATTACH" ":" [WSP] uri CRLF) attach = "ATTACH" attparam ":" uri CRLF
attach =/ ("ATTACH" ";" [WSP] "ENCODING" "=" "b" ";" [WSP] attach =/ "ATTACH" attparam ";" "ENCODING" "=" "BASE64"
"VALUE" "=" "text" ":" [WSP] binary ";" "VALUE" "=" "BINARY" ":" binary
attparam = *(";" xparam)
Example: The following are examples of this property: Example: The following are examples of this property:
ATTACH:CID:jsmith.part3.960817T083000.xyzMail@host1.com ATTACH:CID:jsmith.part3.960817T083000.xyzMail@host1.com
ATTACH:FTP://xyzCorp.com/pub/reports/r-960812.ps ATTACH:FTP://xyzCorp.com/pub/reports/r-960812.ps
4.8.1.2 Categories 4.8.1.2 Categories
Property Name: CATEGORIES Property Name: CATEGORIES
Purpose: This property defines the categories for a calendar Purpose: This property defines the categories for a calendar
component. component.
Value Type: TEXT Value Type: TEXT
Conformance: The property MAY only be specified within "VEVENT", Property Parameters: Non-standard and language property parameters
"VTODO" or "VJOURNAL" calendar components. can be specified on this property.
Conformance: The property can be specified within "VEVENT", "VTODO"
or "VJOURNAL" calendar components.
Description: This property is used to specify categories or subtypes Description: This property is used to specify categories or subtypes
of the calendar component. The categories are useful in searching for of the calendar component. The categories are useful in searching for
a calendar component of a particular type and category. Within the a calendar component of a particular type and category. Within the
"VEVENT", "VTODO" or "VJOURNAL" calendar components, more than one "VEVENT", "VTODO" or "VJOURNAL" calendar components, more than one
category MAY be specified as a list of categories separated by the category can be specified as a list of categories separated by the
COMMA character (ASCII decimal 44). COMMA character (US-ASCII decimal 44).
Only the "LANGUAGE" property parameters MAY be specified on this
property.
Format Definition: The property is defined by the following notation: Format Definition: The property is defined by the following notation:
categories = "CATEGORIES" [catparam] ":" [WSP] catvalue CRLF categories = "CATEGORIES" catparam ":" text *("," text)
CRLF
catparam = ";" [WSP] languageparm
Dawson/Stenerson 55 Expires September 1998 catparam = [";" languageparam]
catvalue = "ANNIVERSARY" / "APPOINTMENT" / "BUSINESS" *(";" xparam)
/ "EDUCATION" / "HOLIDAY" / "MEETING" / "MISCELLANEOUS"
/ "NON-WORKING HOURS" / "NOT IN OFFICE" / "PERSONAL"
/ "PHONE CALL" / "SICK DAY" / "SPECIAL OCCASION"
/ "TRAVEL" / "VACATION" / text
;These are just examples
;Used only in "VEVENT", "VTODO" and "VJOURNAL" calendar components.
Dawson/Stenerson 65 Expires November 1998
Example: The following are examples of this property: Example: The following are examples of this property:
CATEGORIES:APPOINTMENT,EDUCATION CATEGORIES:APPOINTMENT,EDUCATION
CATEGORIES:MEETING CATEGORIES:MEETING
4.8.1.3 Classification 4.8.1.3 Classification
Property Name: CLASS Property Name: CLASS
Purpose: This property defines the access classification for a Purpose: This property defines the access classification for a
calendar component. calendar component.
Value Type: TEXT Value Type: TEXT
Conformance: The property MAY only be specified in a "VEVENT", Property Parameters: Non-standard property parameters can be
"VTODO" or "VJOURNAL" calendar components. The property MAY only be specified on this property.
specified once.
Conformance: The property can be specified once in a "VEVENT",
"VTODO" or "VJOURNAL" calendar components.
Description: An access classification is only one component of the Description: An access classification is only one component of the
general security system within a calendar application. It provides a general security system within a calendar application. It provides a
method of capturing the scope of the access the calendar owner method of capturing the scope of the access the calendar owner
intends for information within an individual calendar entry. The intends for information within an individual calendar entry. The
access classification of an individual iCalendar component is useful access classification of an individual iCalendar component is useful
when measured along with the other security components of a calendar when measured along with the other security components of a calendar
system (e.g., calendar user authentication, authorization, access system (e.g., calendar user authentication, authorization, access
rights, access role, etc.). Hence, the semantics of the individual rights, access role, etc.). Hence, the semantics of the individual
access classifications cannot be completely defined by this memo access classifications cannot be completely defined by this memo
alone. Additionally, due to the "blind" nature of most exchange alone. Additionally, due to the "blind" nature of most exchange
processes using this memo, these access classifications cannot serve processes using this memo, these access classifications cannot serve
as an enforcement statement for a system receiving an iCalendar as an enforcement statement for a system receiving an iCalendar
object. Rather, they provide a method for capturing the intention of object. Rather, they provide a method for capturing the intention of
the calendar owner for the access to the calendar component. The the calendar owner for the access to the calendar component. The
[ICMS] provides a broader description of the security system within a [ICMS] provides a broader description of the security system within a
calendar application. calendar application.
No property parameters MAY be specified on this property.
Format Definition: The property is defined by the following notation: Format Definition: The property is defined by the following notation:
class = "CLASS" ":" [WSP] classvalue CRLF class = "CLASS" classparam ":" classvalue CRLF
classparam = *(";" xparam)
classvalue = "PUBLIC" / "PRIVATE" / "CONFIDENTIAL" / iana-token classvalue = "PUBLIC" / "PRIVATE" / "CONFIDENTIAL" / iana-token
/ x-name / x-name
;Default is PUBLIC ;Default is PUBLIC
Dawson/Stenerson 56 Expires September 1998
Example: The following is an example of this property: Example: The following is an example of this property:
CLASS:PUBLIC CLASS:PUBLIC
Dawson/Stenerson 66 Expires November 1998
4.8.1.4 Comment 4.8.1.4 Comment
Property Name: COMMENT Property Name: COMMENT
Purpose: This property specifies non-processing information intended Purpose: This property specifies non-processing information intended
to provide a comment to the calendar user. to provide a comment to the calendar user.
Value Type: TEXT Value Type: TEXT
Conformance: This property may be specified in an iCalendar object. Property Parameters: Non-standard, alternate text representation and
language property parameters can be specified on this property.
Description: The property MAY be specified multiple times. Conformance: This property can be specified in an iCalendar object.
Only the "ALTREP" or "LANGUAGE" property parameters MAY be specified Description: The property can be specified multiple times.
on this property.
Format Definition: The property is defined by the following notation: Format Definition: The property is defined by the following notation:
The property MAY be specified in any of the calendar components. comment = "COMMENT" commparam ":" text CRLF
comment = "COMMENT" [commparam] ":" [WSP] text CRLF
commparam = [";" [WSP] altrepparm ] [";" [WSP] languageparm] commparam = [";" altrepparam ] [";" languageparam]
*(";" xparam)
Example: The following is an example of this property: Example: The following is an example of this property:
COMMENT:The meeting really needs to include both ourselves COMMENT:The meeting really needs to include both ourselves
and the customer. We can't hold this meeting without them and the customer. We can't hold this meeting without them.
As a matter of fact\, the venue for the meeting ought to be at As a matter of fact\, the venue for the meeting ought to be at
their site. - - John their site. - - John
The data type for this property is TEXT. The data type for this property is TEXT.
4.8.1.5 Description 4.8.1.5 Description
Property Name: DESCRIPTION Property Name: DESCRIPTION
Purpose: This property provides a more complete description of the Purpose: This property provides a more complete description of the
calendar component, than that provided by the "SUMMARY" property. calendar component, than that provided by the "SUMMARY" property.
Value Type: TEXT Value Type: TEXT
Conformance: The property MAY be specified in the "VEVENT", "VTODO" Property Parameters: Non-standard, alternate text representation and
and "VJOURNAL" calendar components. The property MAY be specified language property parameters can be specified on this property.
multiple times only within a "VJOURNAL" calendar component. The
property MAY be specified in "VALARM" calendar component. Conformance: The property can be specified in the "VEVENT", "VTODO",
"VJOURNAL" and "VALARM" calendar components. The property can be
specified multiple times only within a "VJOURNAL" calendar component.
Description: This property is used in the "VEVENT" and "VTODO" to Description: This property is used in the "VEVENT" and "VTODO" to
capture lengthy textual decriptions associated with the activity. capture lengthy textual decriptions associated with the activity.
Dawson/Stenerson 57 Expires September 1998
This property is used in the "VJOURNAL" calendar component to capture This property is used in the "VJOURNAL" calendar component to capture
one more textual journal entries. one more textual journal entries.
Dawson/Stenerson 67 Expires November 1998
This property is used in the "VALARM" calendar component to capture This property is used in the "VALARM" calendar component to capture
the display text for a DISPLAY category of alarm, to capture the body the display text for a DISPLAY category of alarm, to capture the body
text for an EMAIL category of alarm and to capture the arguement text for an EMAIL category of alarm and to capture the arguement
string for a PROCEDURE category of alarm. string for a PROCEDURE category of alarm.
Only the "ALTREP" or "LANGUAGE" property parameters MAY be specified
on this property.
Format Definition: The property is defined by the following notation: Format Definition: The property is defined by the following notation:
description = "DESCRIPTION" [descparam] ":" [WSP] text CRLF description = "DESCRIPTION" descparam ":" text CRLF
descparam = [";" [WSP] altrepparm] [";" [WSP] languageparm] descparam = [";" altrepparam] [";" languageparam]
*(";" xparam)
Example: The following is an example of the property with formatted Example: The following is an example of the property with formatted
line breaks in the property value: line breaks in the property value:
DESCRIPTION:Meeting to provide technical review for "Phoenix" DESCRIPTION:Meeting to provide technical review for "Phoenix"
design.\n Happy Face Conference Room. Phoenix design team design.\n Happy Face Conference Room. Phoenix design team
MUST attend this meeting.\n RSVP to team leader. MUST attend this meeting.\n RSVP to team leader.
The following is an example of the property with folding of long The following is an example of the property with folding of long
lines: lines:
skipping to change at line 3103 skipping to change at line 3694
DESCRIPTION:Last draft of the new novel is to be completed DESCRIPTION:Last draft of the new novel is to be completed
for the editor's proof today. for the editor's proof today.
4.8.1.6 Geographic Position 4.8.1.6 Geographic Position
Property Name: GEO Property Name: GEO
Purpose: This property specifies information related to the global Purpose: This property specifies information related to the global
position for the activity specified by a calendar component. position for the activity specified by a calendar component.
Value Type: Two FLOAT values. Value Type: FLOAT. The value MUST be two SEMICOLON separated FLOAT
values.
Conformance: This property MAY be specified in an iCalendar object. Property Parameters: Non-standard property parameters can be
specified on this property.
Conformance: This property can be specified in an iCalendar object.
Description: The property value specifies latitude and longitude, in Description: The property value specifies latitude and longitude, in
that order (i.e., "LAT LON" ordering). The longitude represents the that order (i.e., "LAT LON" ordering). The longitude represents the
location east and west of the prime meridian as a positive or location east and west of the prime meridian as a positive or
negative real number, respectively. The latitude represents the negative real number, respectively. The latitude represents the
location north and south of the equator as a positive or negative location north and south of the equator as a positive or negative
real number, respectively. The longitude and latitude values MUST be real number, respectively. The longitude and latitude values MUST be
specified as decimal degrees and should be specified to six decimal specified as decimal degrees and should be specified to six decimal
places. This will allow for granularity within a meter of the places. This will allow for granularity within a meter of the
geographical position. The simple formula for converting degrees- geographical position. The simple formula for converting degrees-
minutes-seconds into decimal degrees is: minutes-seconds into decimal degrees is:
decimal = degrees + minutes/60 + seconds/3600. decimal = degrees + minutes/60 + seconds/3600.
Dawson/Stenerson 58 Expires September 1998
No property parameters MAY be specified on this property.
Format Definition: The property is defined by the following notation: Format Definition: The property is defined by the following notation:
geo = "GEO" ":" [WSP] geovalue CRLF Dawson/Stenerson 68 Expires November 1998
geo = "GEO" geoparam ":" geovalue CRLF
geovalue = float ";" [WSP] float geoparam = *(";" xparam)
geovalue = float ";" float
;Latitude and Longitude components ;Latitude and Longitude components
Example: The following is an example of this property: Example: The following is an example of this property:
GEO:37.386013;-122.082932 GEO:37.386013;-122.082932
4.8.1.7 Location 4.8.1.7 Location
Property Name: LOCATION Property Name: LOCATION
Purpose: The property defines the intended venue for the activity Purpose: The property defines the intended venue for the activity
defined by a calendar component. defined by a calendar component.
Value Type: TEXT Value Type: TEXT
Conformance: This property MAY be specified in the "VEVENT" or Property Parameters: Non-standard, alternate text representation and
language property parameters can be specified on this property.
Conformance: This property can be specified in the "VEVENT" or
"VTODO" calendar component. "VTODO" calendar component.
Description: Specific venues such as conference or meeting rooms may Description: Specific venues such as conference or meeting rooms may
be explicitly specified using this property. An alternate be explicitly specified using this property. An alternate
representation may be specified that is a URI that points to representation may be specified that is a URI that points to
directory information with more structured specification of the directory information with more structured specification of the
location. For example, the alternate representation may specify location. For example, the alternate representation may specify
either an LDAP URI pointing to an LDAP server entry or a CID URI either an LDAP URI pointing to an LDAP server entry or a CID URI
pointing to a MIME body part containing a vCard for the location. pointing to a MIME body part containing a vCard for the location.
Only the "ALTREP" or "LANGUAGE" property parameters MAY be specified
on this property.
Format Definition: The property is defined by the following notation: Format Definition: The property is defined by the following notation:
location = "LOCATION [locparam] ":" [WSP] text CRLF location = "LOCATION locparam ":" text CRLF
locparam = [";" [WSP] altrepparm] [";" [WSP] languageparm] locparam = [";" altrepparam] [";" languageparam]
*(";" xparam)
Example: The following are some examples of this property: Example: The following are some examples of this property:
LOCATION:Conference Room - F123, Bldg. 002 LOCATION:Conference Room - F123, Bldg. 002
LOCATION;ALTREP="http://xyzcorp.com/conf-rooms/f123.vcf": LOCATION;ALTREP="http://xyzcorp.com/conf-rooms/f123.vcf":
Conference Room - F123, Bldg. 002 Conference Room - F123, Bldg. 002
4.8.1.8 Percent Complete 4.8.1.8 Percent Complete
Property Name: PERCENT-COMPLETE Property Name: PERCENT-COMPLETE
Dawson/Stenerson 59 Expires September 1998
Purpose: This property is used by an assignee or delegatee of a to-do Purpose: This property is used by an assignee or delegatee of a to-do
to convey the percent completion of a to-do to the Organizer. to convey the percent completion of a to-do to the Organizer.
Dawson/Stenerson 69 Expires November 1998
Value Type: INTEGER Value Type: INTEGER
Conformance: This property MAY only be specified in a "VTODO" Property Parameters: Non-standard property parameters can be
calendar component. specified on this property.
Description: The property value is a postive integer between zero and Conformance: This property can be specified in a "VTODO" calendar
one hundred. A value of "0" indicates the to-do has not yet been component.
Description: The property value is a positive integer between zero
and one hundred. A value of "0" indicates the to-do has not yet been
started. A value of "100" indicates that the to-do has been started. A value of "100" indicates that the to-do has been
completed. Integer values in between indicate the percent partially completed. Integer values in between indicate the percent partially
complete. complete.
When a to-do is assigned to multiple individuals, the property value When a to-do is assigned to multiple individuals, the property value
indicates the percent complete for that portion of the to-do assigned indicates the percent complete for that portion of the to-do assigned
to the assignee or delegatee. For example, if a to-do is assigned to to the assignee or delegatee. For example, if a to-do is assigned to
both individuals "A" and "B". A reply from "A" with a percent both individuals "A" and "B". A reply from "A" with a percent
complete of "70" indicates that "A" has completed 70% of the to-do complete of "70" indicates that "A" has completed 70% of the to-do
assigned to them. A reply from "B" with a percent complete of "50" assigned to them. A reply from "B" with a percent complete of "50"
indicates "B" has completed 50% of the to-do assigned to them. indicates "B" has completed 50% of the to-do assigned to them.
No property parameters MAY be specified on this property.
Format Definition: The property is defined by the following notation: Format Definition: The property is defined by the following notation:
percent = "PERCENT-COMPLETE" ":" [WSP] integer CRLF percent = "PERCENT-COMPLETE" pctparam ":" integer CRLF
pctparam = *(";" xparam)
Example: The following is an example of this property to show 39% Example: The following is an example of this property to show 39%
completion: completion:
PERCENT-COMPLETE:39 PERCENT-COMPLETE:39
4.8.1.9 Priority 4.8.1.9 Priority
Property Name: PRIORITY Property Name: PRIORITY
Purpose: The property defines the relative priority for a calendar Purpose: The property defines the relative priority for a calendar
component. component.
Value Type: INTEGER Value Type: INTEGER
Conformance: The property MAY only be specified in a "VEVENT" or Property Parameters: Non-standard property parameters can be
"VTODO" calendar component. specified on this property.
Conformance: The property can be specified in a "VEVENT" or "VTODO"
calendar component.
Description: The priority is specified as an integer in the range Description: The priority is specified as an integer in the range
zero to nine. A value of zero (ASCII decimal 48) specifies an zero to nine. A value of zero (US-ASCII decimal 48) specifies an
undefined priority. A value of one (ASCII decimal 49) is the highest undefined priority. A value of one (US-ASCII decimal 49) is the
priority. A value of two (ASCII decimal 50) is the second highest highest priority. A value of two (US-ASCII decimal 50) is the second
priority. Subsequent numbers specify a decreasing ordinal priority. A highest priority. Subsequent numbers specify a decreasing ordinal
value of nine (ASCII decimal 58) is the lowest priority.
Dawson/Stenerson 70 Expires November 1998
priority. A value of nine (US-ASCII decimal 58) is the lowest
priority.
A CUA with a three-level priority scheme of "HIGH", "MEDIUM" and A CUA with a three-level priority scheme of "HIGH", "MEDIUM" and
"LOW" is mapped into this property such that a property value in the "LOW" is mapped into this property such that a property value in the
range of one (US-ASCII decimal 49) to four (US-ASCII decimal 52)
Dawson/Stenerson 60 Expires September 1998 specifies "HIGH" priority. A value of five (US-ASCII decimal 53) is
range of one (ASCII decimal 49) to four (ASCII decimal 52) specifies the normal or "MEDIUM" priority. A value in the range of six (US-
"HIGH" priority. A value of five (ASCII decimal 53) is the normal or ASCII decimal 54) to nine (US-ASCII decimal 58) is "LOW" priority.
"MEDIUM" priority. A value in the range of six (ASCII decimal 54) to
nine (ASCII decimal 58) is "LOW" priority.
A CUA with a priority schema of "A1", "A2", "A3", "B1", "B2", ..., A CUA with a priority schema of "A1", "A2", "A3", "B1", "B2", ...,
"C3" is mapped into this property such that a property value of one "C3" is mapped into this property such that a property value of one
(ASCII decimal 49) specifies "A1", a property value of two (ASCII (US-ASCII decimal 49) specifies "A1", a property value of two (US-
decimal 50) specifies "A2", a property value of three (ASCII decimal ASCII decimal 50) specifies "A2", a property value of three (US-ASCII
51) specifies "A3", and so forth up to a property value of 9 (ASCII decimal 51) specifies "A3", and so forth up to a property value of 9
decimal 58) specifies "C3". (US-ASCII decimal 58) specifies "C3".
Other integer values are reserved for future use. Other integer values are reserved for future use.
Within a "VEVENT" calendar component, this property specifies a Within a "VEVENT" calendar component, this property specifies a
priority for the event. This property may be useful when more than priority for the event. This property may be useful when more than
one event is scheduled for a given time period. one event is scheduled for a given time period.
Within a "VTODO" calendar component, this property specified a Within a "VTODO" calendar component, this property specified a
priority for the to-do. This property is useful in prioritizing priority for the to-do. This property is useful in prioritizing
multiple action items for a given time period. multiple action items for a given time period.
No property parameters MAY be specified on this property.
Format Definition: The property is specified by the following Format Definition: The property is specified by the following
notation: notation:
priority = "PRIORITY" ":" [WSP] privalue CRLF priority = "PRIORITY" prioparam ":" privalue CRLF
;Default is zero ;Default is zero
prioparam = *(";" xparam)
privalue = integer ;Must be in the range [0..9] privalue = integer ;Must be in the range [0..9]
; All other values are reserved for future use ; All other values are reserved for future use
The following is an example of a property with the highest priority: The following is an example of a property with the highest priority:
PRIORITY:1 PRIORITY:1
The following is an example of a property with a next highest The following is an example of a property with a next highest
priority: priority:
PRIORITY:2 PRIORITY:2
Example: The following is an example of a property with no priority. Example: The following is an example of a property with no priority.
This is equivalent to not specifying the "PRIORITY" property.: This is equivalent to not specifying the "PRIORITY" property.:
PRIORITY:0 PRIORITY:0
Dawson/Stenerson 71 Expires November 1998
4.8.1.10 Resources 4.8.1.10 Resources
Property Name: RESOURCES Property Name: RESOURCES
Purpose: This property defines the equipment or resources anticipated Purpose: This property defines the equipment or resources anticipated
for an activity specified by a calendar entity.. for an activity specified by a calendar entity..
Dawson/Stenerson 61 Expires September 1998
Value Type: TEXT Value Type: TEXT
Conformance: This property MAY be specified in a "VEVENT" or "VTODO" Property Parameters: Non-standard, alternate text representation and
language property parameters can be specified on this property.
Conformance: This property can be specified in a "VEVENT" or "VTODO"
calendar component. calendar component.
Description: The property value is an arbitrary text. More than one Description: The property value is an arbitrary text. More than one
resource MAY be specified as a list of resources separated by the resource can be specified as a list of resources separated by the
COMMA character (ASCII decimal 44). COMMA character (US-ASCII decimal 44).
Only the "LANGUAGE" property parameter MAY be specified on this
property.
Format Definition: The property is defined by the following notation: Format Definition: The property is defined by the following notation:
resources = "RESOURCES" [resrcparam] ":" [WSP] resvalist CRLF resources = "RESOURCES" resrcparam ":" text *("," text) CRLF
resrcparam = ";" [WSP] languageparm
resvalist = resvalue / resvalue "," [WSP] resvalist
resvalue = "CATERING" / "CHAIRS" / "COMPUTER PROJECTOR" resrcparam = [";" altrepparam] [";" languageparam]
/ "EASEL" / "OVERHEAD PROJECTOR" / "SPEAKER PHONE" *(";" xparam)
/ "TABLE" / "TV" / "VCR" / "VIDEO PHONE" / "VEHICLE"
/ text
;These are just examples.
Example: The following is an example of this property: Example: The following is an example of this property:
RESOURCES:EASEL,PROJECTOR,VCR RESOURCES:EASEL,PROJECTOR,VCR
RESOURCES;LANGUAGE=fr:1 raton-laveur
4.8.1.11 Status 4.8.1.11 Status
Property Name: STATUS Property Name: STATUS
Purpose: This property defines the overall status or confirmation for Purpose: This property defines the overall status or confirmation for
the calendar component. the calendar component.
Value Type: TEXT Value Type: TEXT
Conformance: This property MAY only be specified in the "VEVENT", Property Parameters: Non-standard property parameters can be
"VTODO", "VJOURNAL" calendar components. specified on this property.
Conformance: This property can be specified in the "VEVENT", "VTODO"
and "VJOURNAL" calendar components.
Description: In a group scheduled calendar component, the property is Description: In a group scheduled calendar component, the property is
used by the "Organizer" to provide a confirmation of the event to the used by the "Organizer" to provide a confirmation of the event to the
"Attendees". For example in a "VEVENT" calendar component, the "Attendees". For example in a "VEVENT" calendar component, the
"Organizer" can indicate that a meeting is tentative, confirmed or "Organizer" can indicate that a meeting is tentative, confirmed or
cancelled. In a "VTODO" calendar component, the "Organizer" can cancelled. In a "VTODO" calendar component, the "Organizer" can
indicate that an action item needs action, is completed, is in indicate that an action item needs action, is completed, is in
process or being worked on, or has been cancelled. In a "VJOURNAL" process or being worked on, or has been cancelled. In a "VJOURNAL"
Dawson/Stenerson 72 Expires November 1998
calendar component, the "Organizer" can indicate that a journal entry calendar component, the "Organizer" can indicate that a journal entry
is draft, final or has been cancelled or removed. is draft, final or has been cancelled or removed.
No property parameter MAY be specified on this property.
Dawson/Stenerson 62 Expires September 1998
Format Definition: The property is defined by the following notation: Format Definition: The property is defined by the following notation:
status = "STATUS" ":" [WSP] statvalue CRLF status = "STATUS" statparam] ":" statvalue CRLF
statparam = *(";" xparam)
statvalue = "TENTATIVE" ;Indicates event is statvalue = "TENTATIVE" ;Indicates event is
;tentative. ;tentative.
/ "CONFIRMED" ;Indicates event is / "CONFIRMED" ;Indicates event is
;definite. ;definite.
/ "CANCELLED" ;Indicates event was / "CANCELLED" ;Indicates event was
;cancelled. ;cancelled.
;Status values for a "VEVENT" ;Status values for a "VEVENT"
statvalue =/ "NEEDS-ACTION" ;Indicates to-do needs action. statvalue =/ "NEEDS-ACTION" ;Indicates to-do needs action.
skipping to change at line 3388 skipping to change at line 3991
4.8.1.12 Summary 4.8.1.12 Summary
Property Name: SUMMARY Property Name: SUMMARY
Purpose: This property defines a short summary or subject for the Purpose: This property defines a short summary or subject for the
calendar component. calendar component.
Value Type: TEXT Value Type: TEXT
Conformance: The property MUST be specified in the "VEVENT", "VTODO" Property Parameters: Non-standard, alternate text representation and
and "VJOURNAL" calendar components. In addition, it MAY appear in the language property parameters can be specified on this property.
"VALARM" calendar component.
Dawson/Stenerson 73 Expires November 1998
Conformance: The property can be specified in the "VEVENT", "VTODO",
"VJOURNAL" and "VALARM" calendar components.
Description: This property is used in the "VEVENT", "VTODO" and Description: This property is used in the "VEVENT", "VTODO" and
"VJOURNAL" calendar components to capture a short, one line summary "VJOURNAL" calendar components to capture a short, one line summary
about the activity or journal entry. about the activity or journal entry.
Dawson/Stenerson 63 Expires September 1998
This property is used in the "VALARM" calendar component to capture This property is used in the "VALARM" calendar component to capture
the subject of an EMAIL category of alarm. the subject of an EMAIL category of alarm.
Only the "ALTREP" and "LANGUAGE" property parameters MAY be specified
on this property.
Format Definition: The property is defined by the following notation: Format Definition: The property is defined by the following notation:
summary = "SUMMARY" [summparam] ":" [WSP] text CRLF summary = "SUMMARY" summparam ":" text CRLF
summparam = [";" [WSP] altrepparm] [";" [WSP] languageparm] summparam = [";" altrepparam] [";" languageparam]
*(";" xparam)
Example: The following is an example of this property: Example: The following is an example of this property:
SUMMARY:Department Party SUMMARY:Department Party
4.8.2 Date and Time Component Properties 4.8.2 Date and Time Component Properties
The following properties specify date and time related information in The following properties specify date and time related information in
calendar components. calendar components.
4.8.2.1 Date/Time Completed 4.8.2.1 Date/Time Completed
Property Name: COMPLETED Property Name: COMPLETED
Purpose: This property defines the date and time that a to-do was Purpose: This property defines the date and time that a to-do was
actually completed. actually completed.
Value Type: DATE-TIME Value Type: DATE-TIME
Conformance: The property MAY only be specified in a "VTODO" Property Parameters: Non-standard property parameters can be
component in an iCalendar object. specified on this property.
Description: The date and time must be in a UTC format. Conformance: The property can be specified in a "VTODO" calendar
component.
No property parameters MAY be specified on this property. Description: The date and time must be in a UTC format.
Format Definition: The property is defined by the following notation: Format Definition: The property is defined by the following notation:
completed = "COMPLETED" ":" [WSP] date-time CRLF completed = "COMPLETED" compparam ":" date-time CRLF
compparam = *(";" xparam)
Example: The following is an example of this property: Example: The following is an example of this property:
COMPLETED:19960401T235959Z COMPLETED:19960401T235959Z
Dawson/Stenerson 74 Expires November 1998
4.8.2.2 Date/Time End 4.8.2.2 Date/Time End
Property Name: DTEND Property Name: DTEND
Purpose: This property specifies the date and time that a calendar Purpose: This property specifies the date and time that a calendar
component ends. component ends.
Value Type: The default value type is DATE-TIME. The value type MAY Value Type: The default value type is DATE-TIME. The value type can
BE reset to a DATE value type. be reset to a DATE value type.
Dawson/Stenerson 64 Expires September 1998 Property Parameters: Non-standard, value data type, time zone
Conformance: This property MAY only be specified within the "VEVENT", identifier property parameters can be specified on this property.
"VFREEBUSY", and "VTIMEZONE" calendar components.
Conformance: This property can be specified within the "VEVENT" and
"VFREEBUSY" calendar components.
Description: Within the "VEVENT" calendar component, this property Description: Within the "VEVENT" calendar component, this property
defines the date and time by which the event ends. The value MUST be defines the date and time by which the event ends. The value MUST be
later in time than the value of the "DTSTART" property. later in time than the value of the "DTSTART" property.
Within the "VFREEBUSY" calendar component, this property defines the Within the "VFREEBUSY" calendar component, this property defines the
end date and time for the free or busy time information. The time end date and time for the free or busy time information. The time
MUST be specified as in the UTC time format. The value MUST be later MUST be specified as in the UTC time format. The value MUST be later
in time than the value of the "DTSTART" property. in time than the value of the "DTSTART" property.
Only the "VALUE" and "TZID" property parameters MAY be specified on
this property. The "TZID" property parameter MAY only be specified
when the value type is DATE-TIME.
Format Definition: The property is defined by the following notation: Format Definition: The property is defined by the following notation:
dtend = "DTEND" [dtendparam]":" [WSP] dtendval CRLF dtend = "DTEND" dtendparam":" dtendval CRLF
dtendparam = [";" [WSP] "VALUE" "=" "DATE-TIME"]
[";" [WSP] "TZID" "=" paramtext
dtendparam =/ ";" [WSP] "VALUE" "=" "DATE" dtendparam = [";" "VALUE" "=" ("DATE-TIME" / "DATE")]
[";" tzidparam]
*(";" xparam)
dtendval = date-time / date dtendval = date-time / date
;Value MUST match value type ;Value MUST match value type
Example: The following is an example of this property: Example: The following is an example of this property:
DTEND:19960401T235959Z DTEND:19960401T235959Z
DTEND;VALUE=DATE:19980704 DTEND;VALUE=DATE:19980704
4.8.2.3 Date/Time Due 4.8.2.3 Date/Time Due
Property Name: DUE Property Name: DUE
Purpose: This property defines the date and time that a to-do is Purpose: This property defines the date and time that a to-do is
expected to be completed. expected to be completed.
Value Type: The default value type is DATE-TIME. The value type MAY Value Type: The default value type is DATE-TIME. The value type can
BE reset to a DATE value type. be reset to a DATE value type.
Conformance: The property MAY only be specified in a "VTODO" calendar Property Parameters: Non-standard, value data type, time zone
component and only once. identifier property parameters can be specified on this property.
Dawson/Stenerson 75 Expires November 1998
Conformance: The property can be specified once within a "VTODO"
calendar component.
Description: The value MUST be a date/time equal to or after the Description: The value MUST be a date/time equal to or after the
DTSTART value, if specified. DTSTART value, if specified.
Only the "VALUE" and "TZID" property parameters MAY be specified on
this property. The "TZID" property parameter MAY only be specified
when the value type is DATE-TIME.
Dawson/Stenerson 65 Expires September 1998
Format Definition: The property is defined by the following notation: Format Definition: The property is defined by the following notation:
due = "DUE" [dueparam]":" [WSP] dueval CRLF due = "DUE" dueparam":" dueval CRLF
dueparam = [";" [WSP] "VALUE" "=" "DATE-TIME"]
[";" [WSP] "TZID" "=" paramtext
dueparam =/ ";" [WSP] "VALUE" "=" "DATE" dueparam = [";" "VALUE" "=" ("DATE-TIME" / "DATE")]
[";" tzidparam]
*(";" xparam)
dueval = date-time / date dueval = date-time / date
;Value MUST match value type ;Value MUST match value type
Example: The following is an example of this property: Example: The following is an example of this property:
DUE:19960401T235959Z DUE:19980430T235959Z
4.8.2.4 Date/Time Start 4.8.2.4 Date/Time Start
Property Name: DTSTART Property Name: DTSTART
Purpose: This property specifies when the calendar component begins. Purpose: This property specifies when the calendar component begins.
Value Type: The default value type is DATE-TIME. The DATE-TYPE value Value Type: The default value type is DATE-TIME. The time value MUST
will be one of the forms defined for the DATE-TIME value type. The be one of the forms defined for the DATE-TIME value type. The value
value type MAY BE reset to a DATE value type. type can be reset to a DATE value type.
Conformance: This property MAY be specified within the "VEVENT", Property Parameters: Non-standard, value data type, time zone
identifier property parameters can be specified on this property.
Conformance: This property can be specified within the "VEVENT",
"VTODO", "VFREEBUSY", and "VTIMEZONE" calendar components. "VTODO", "VFREEBUSY", and "VTIMEZONE" calendar components.
Description: Within the "VEVENT" calendar component, this property Description: Within the "VEVENT" calendar component, this property
defines the start date and time for the event. The property is defines the start date and time for the event. The property is
REQUIRED in "VEVENT" calendar components. Events MAY have a start REQUIRED in "VEVENT" calendar components. Events can have a start
date/time but no end date/time. In that case, the event does not take date/time but no end date/time. In that case, the event does not take
up any time. up any time.
Within the "VFREEBUSY" calendar component, this property defines the Within the "VFREEBUSY" calendar component, this property defines the
start date and time for the free or busy time information. The time start date and time for the free or busy time information. The time
MUST be specified in UTC time. MUST be specified in UTC time.
Within the "VTIMEZONE" calendar component, this property defines the Within the "VTIMEZONE" calendar component, this property defines the
effective start date and time for a time zone specification. This effective start date and time for a time zone specification. This
property is REQUIRED within "VTIMEZONE" calendar components. The time property is REQUIRED within each STANDARD and DAYLIGHT part included
MUST be specified in the UTC time format. in "VTIMEZONE" calendar components and MUST be specified as a local
DATE-TIME without the "TZID" property parameter.
Only the "VALUE" and "TZID" property parameters MAY be specified on
this property. The "TZID" property parameter MAY only be specified
when the value type is DATE-TIME.
Format Definition: The property is defined by the following notation: Format Definition: The property is defined by the following notation:
dtstart = "DTSTART" [dtstparam] ":" [WSP] dtstval CRLF Dawson/Stenerson 76 Expires November 1998
dtstart = "DTSTART" dtstparam ":" dtstval CRLF
dtstparam = [";" [WSP] "VALUE" "=" "DATE-TIME"]
[";" [WSP] "TZID" "=" paramtext]
Dawson/Stenerson 66 Expires September 1998 dtstparam = [";" "VALUE" "=" ("DATE-TIME" / "DATE")]
dtstparam =/ ";" [WSP] "VALUE" "=" "DATE" [";" tzidparam]
*(";" xparam)
dtstval = date-time / date dtstval = date-time / date
;Value MUST match value type ;Value MUST match value type
Example: The following is an example of this property: Example: The following is an example of this property:
DTSTART:19980118T073000Z DTSTART:19980118T073000Z
4.8.2.5 Duration 4.8.2.5 Duration
Property Name: DURATION Property Name: DURATION
Purpose: The property specifies a duration of time . Purpose: The property specifies a positive duration of time .
Value Type: DURATION Value Type: DURATION
Conformance: The property MAY be specified in a "VEVENT", "VTODO", Property Parameters: Non-standard property parameters can be
"VFREEBUSY" or "VALARM" calendar components. specified on this property.
Conformance: The property can be specified in a "VEVENT", "VTODO",
"VFREEBUSY" and "VALARM" calendar components.
Description: In a "VEVENT" calendar component the property may be Description: In a "VEVENT" calendar component the property may be
used to specify a duration of the event, instead of an explicit end used to specify a duration of the event, instead of an explicit end
date/time. In a "VTODO" calendar component the property may be used date/time. In a "VTODO" calendar component the property may be used
to specify a duration for the to-do, instead of an explicit due to specify a duration for the to-do, instead of an explicit due