ICalendar

History

thumb|iCalendar components and their properties

iCalendar was created in 1998 by the Calendaring and Scheduling Working Group of the Internet Engineering Task Force, chaired by Anik Ganguly of Open Text Corporation, and was authored by Frank Dawson of Lotus Development Corporation and Derik Stenerson of Microsoft Corporation. iCalendar data files are plain text files with the extension or (for files containing availability information only). RFC 5545 replaced RFC 2445 in September 2009 and now defines the standard.

iCalendar is heavily based on the earlier vCalendar by the Internet Mail Consortium (IMC) which has the file extension. After iCalendar was released, the Internet Mail Consortium stated that it "hopes that all vCalendar developers take advantage of these new open standards and make their software compatible with both vCalendar 1.0 and iCalendar."

The memo "Calendar Access Protocol" (RFC 4324) was an initial attempt at a universal system to create real-time calendars, but was eventually abandoned. Instead, iCalendar saw some adoption for such purposes with ad hoc extensions such as GroupDAV and CalDAV emerging as informal standards and seeing some adoption in both client and server software packages.

A first effort to simplify iCalendar standards by the IETF "Calendaring and Scheduling Working Group" (ietf-calsify WG) ended in January 2011 without seeing adoption. The work was then picked up by the "Calendaring Extensions Working Group" (ietf-calext WG).

Design

iCalendar data have the MIME content type . The filename extension of is to be used for files containing calendaring and scheduling information, for files with free or busy time information consistent with this MIME content type. The equivalent file type codes in Apple Macintosh operating system environments are and .

By default, iCalendar uses the UTF-8 character set; a different character set can be specified using the "charset" MIME parameter (if the transport method used supports MIME, such as Email or HTTP). Each line is terminated by CR+LF (in hexadecimal: ). Lines should be limited to 75 octets (not characters) long. Where a data item is too long to fit on a single line it can be continued on following lines by starting the continuation lines with a space character (in hex: 20) or a tab character (in hex: 09). Actual line feeds in data items are encoded as a backslash followed by the letter n or N (the bytes or in UTF-8).

The iCalendar format is designed to transmit calendar-based data, such as events, and intentionally does not describe what to do with that data. Thus, other programming may be needed to negotiate what to do with this data. A companion standard, "iCalendar Transport-Independent Interoperability" (iTIP) (RFC 2446), defines a protocol for exchanging iCalendar objects for collaborative calendaring and scheduling between "Calendar Users" (CUs) facilitated by an "Organizer" initiating the exchange of data. This standard defines methods such as , , , , , , (to negotiate a change in the entry), and (to decline the counter-proposal). Another companion standard, "iCalendar Message-based Interoperability Protocol (iMIP)" (RFC 2447), defines a standard method for implementing iTIP on standard Internet email-based transports. The "Guide to Internet Calendaring" (RFC 3283) explains how iCalendar interacts with other calendar computer language (current and future).

The top-level element in iCalendar is the Calendaring and Scheduling Core Object, a collection of calendar and scheduling information. Typically, this information will consist of a single iCalendar object. However, multiple iCalendar objects can be grouped together. The first line must be , and the last line must be ; the contents between these lines is called the "icalbody". The body must include the "" and "" calendar properties. In addition, it must include at least one calendar component.

is used to specify that data is in the old vCalendar format. is 2.0 for the current iCalendar format as of 2016.

The body of the iCalendar object (the icalbody) contains single-line Calendar Properties that apply to the entire calendar, as well as one or more blocks of multiple lines that each define a Calendar Component such as an event, journal entry, alarm, or one of several other types. Here is a simple example of an iCalendar object with a single calendar containing a single Calendar Component, a "Bastille Day Party" event starting at 5pm on July 14, 1997, and ending at 4am the following morning:

BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//hacksw/handcal//NONSGML v1.0//EN
BEGIN:VEVENT
UID:uid1@example.com
ORGANIZER;CN=John Doe:MAILTO:john.doe@example.com
DTSTAMP:19970701T100000Z
DTSTART:19970714T170000Z
DTEND:19970715T040000Z
SUMMARY:Bastille Day Party
GEO:48.85299;2.36885
END:VEVENT
END:VCALENDAR

The UID field distributes updates when a scheduled event changes. When the event is first generated a globally unique identifier is created. If a later event is distributed with the same UID, it replaces the original one. An example UID might be Y2007S2C131M5@example.edu, for the 5th meeting of class 131 in semester 2 at a hypothetical college. Email-style UIDs are now considered bad practice, with a UUID recommended instead.

The most common representation of date and time is a tz timestamp based on ISO 8601 format, such as , with the format for a total fixed length of 16 characters. Z indicates the use of UTC (referring to its Zulu time zone). When used in and properties, start times are inclusive while end times are not. This allows an event's end time to be the same as a consecutive event's start without those events overlapping and potentially creating (false) scheduling conflicts.

Components include:

• describes an event, which has a scheduled amount of time on a calendar. Normally, when a user accepts the calendar event, this will cause that time to be considered busy, though an event can be set to be to change this interpretation. A may include a which allows an alarm. Such events have a which sets a starting time, and a which sets an ending time. If the calendar event is recurring, sets up the start of the first event.
• explains a to-do item, i.e., an action-item or assignment. Not all calendar applications recognize items. In particular, Outlook does not export Tasks as items, and ignores items in imported calendars.
• is a journal entry. They attach descriptive text to a particular calendar date, may be used to record a daily record of activities or accomplishments, or describe progress with a related to-do entry. A calendar component does not take up time on a calendar, so it has no effect on free or busy time (just like entries). In practice, few programs support entries.
• is a request for free/busy time, is a response to a request, or is a published set of busy time.
• Other component types include , (time zones) and (alarms). Some components can include other components ( is often included in other components). Some components are often defined to support other components defined after them ( is often used this way).

iCalendar is meant to "provide the definition of a common format for openly exchanging calendaring and scheduling information across the Internet". While the features most often used by users are widely supported by iCalendar, some more advanced capabilities have problems. For example, most vendors do not support Journals (). s have had conversion problems as well.

iCalendar's calendar is also not compatible with some non-Gregorian calendars such as the lunar calendars used in Israel and Saudi Arabia. Although there exist one-to-one mappings between Gregorian and many other calendar scales, the lack of defined values for those calendars and limitations in various date fields can make native support impossible. For example the Hebrew calendar year may contain either 12 or 13 months, and the Japanese Emperor-based calendar scale contains many eras.

Extensions

vCalendar and iCalendar support private software extensions, with a "X-" prefix, a number of which are in common usage.

Some of these include:

• X-RECURRENCE-ID: vCalendar 1.0 extension which mimics the iCalendar 2.0 RECURRENCE-ID (Nokia S60 3rd Edition)
• X-EPOCAGENDAENTRYTYPE: defines the client calendar type
• X-FUNAMBOL-AALARMOPTIONS
• X-FUNAMBOL-ALLDAY: All Day event flag
• X-MICROSOFT-CDO-ALLDAYEVENT: Microsoft Outlook all day event flag
• [X-MICROSOFT-CDO-BUSYSTATUS](https://learn.microsoft.com/en-us/openspecs/exchange_server_protocols/ms-oxcical/cd68eae7-ed65-4dd3-8ea7-ad585c76c736): Microsoft Outlook status information
• [X-MICROSOFT-CDO-INTENDEDSTATUS](https://learn.microsoft.com/en-us/openspecs/exchange_server_protocols/ms-oxcical/df1c7988-9908-4ee6-95b0-fcd180b02b44)
• X-WR-CALNAME: The display name of the calendar
• X-WR-CALDESC: A description of the calendar
• X-WR-RELCALID: A globally unique identifier for the calendar
• X-WR-TIMEZONE
• X-PUBLISHED-TTL: Recommended update interval for subscription to the calendar
• X-ALT-DESC: Used to include HTML markup in an event's description. Standard DESCRIPTION tag should contain non-HTML version.
• X-FMTTYPE, X-FILEDATE, X-NAME, X-CN, X-STATUS, X-ROLE, X-SENTBY, X-SYMBIAN-DTSTAMP, X-METHOD, X-RECURRENCE-ID, X-EPOCALARM, X-SYMBIAN-LUID, X-EPOCAGENDAENTRYTYPE

List of components, properties, and parameters

Other representations

xCal is an XML representation of iCalendar data, as defined in .

jCal is a JSON representation of iCalendar data, as defined in .

hCalendar is an (x)HTML representation of a subset of iCalendar data using microformats.

hEvent is an HTML representation of a subset of iCalendar data using microformats addressing some accessibility concerns with the hCalendar format.

References

References

1. (September 2009). "Internet Calendaring and Scheduling Core Object Specification (iCalendar)". [[Internet Engineering Task Force]].
2. "IBM Lotus Notes 8.5 iCalendar: Interoperability, implementation, and application". IBM DeveloperWorks.
3. "iCalendar.org". Z Content.
4. (1996-09-18). "vCalendar: The Electronic Calendaring and Scheduling Exchange Format, Version 1.0". [[Internet Mail Consortium]].
5. (2006-11-26). "vCalendar: The Basis for Cross-Platform Scheduling". [[Internet Mail Consortium]].
6. "Calendaring and Scheduling Standards Simplification (calsify)". [[IETF]].
7. Lear, Eliot. (2010-12-10). "the end of calsify working group– not the end of the mailing list". ietf-calsify mailing list.
8. "Calendaring Extensions (calext)". [[IETF]].
9. "Internet Calendaring and Scheduling Core Object Specification (iCalendar)".
10. From RFC 2445
11. "iCalendar Property Extensions".
12. "Internet Calendaring and Scheduling Core Object Specification (iCalendar)".
13. "Internet Calendaring and Scheduling Core Object Specification (iCalendar)".
14. "[RFC5546] Section 3.4 Methods for VTODO Components".
15. CalConnect, 2004
16. "[MS-OXCICAL]: Property: X-WR-RELCALID".
17. (October 8, 2009). "iCal and vCal Properties".
18. (2020-10-13). "[MS-OXCICAL]: 2.1.3 Processing Rules".