23 KiB
| obj | wiki | rfc | mime | extension | aliases | rev | |
|---|---|---|---|---|---|---|---|
| format | https://en.wikipedia.org/wiki/ICalendar | https://datatracker.ietf.org/doc/html/rfc5545 | text/calendar | ics |
|
2024-03-07 |
iCalendar
The Internet Calendaring and Scheduling Core Object Specification (iCalendar) is a media type which allows users to store and exchange calendaring and scheduling information such as events, to-dos, journal entries, and free/busy information, and together with its associated standards has been a cornerstone of the standardization and interoperability of digital calendars across different vendors. Files formatted according to the specification usually have an extension of .ics. With supporting software, such as an email reader or calendar application, recipients of an iCalendar data file can respond to the sender easily or counter-propose another meeting date/time. The file format is specified in a proposed Internet standard (RFC 5545) for calendar data exchange. The standard and file type are sometimes referred to as "iCal", which was the name of the Apple Inc. calendar program until 2012 (see iCal), which provides one of the implementations of the standard.
Format
iCalendar data have the MIME content type text/calendar. The filename extension of ics is to be used for files containing calendaring and scheduling information, ifb for files with free or busy time information consistent with this MIME content type. There are also variations of this format in JSON (jCal) or XML (xCal).
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: 0D0A). 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 5C 6E or 5C 4E 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 PUBLISH, REQUEST, REPLY, ADD, CANCEL, REFRESH, COUNTER (to negotiate a change in the entry), and DECLINE-COUNTER (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 BEGIN:VCALENDAR, and the last line must be END:VCALENDAR; the contents between these lines is called the "icalbody". The body must include the PRODID and VERSION calendar properties. In addition, it must include at least one calendar component.
VERSION:1.0 is used to specify that data is in the old vCalendar format. VERSION 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
DTSTAMP:19970714T170000Z
ORGANIZER;CN=John Doe:MAILTO:john.doe@example.com
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 such as 20010911T124640Z with the format <year (4 digits)><month (2)><day (2)>T<hour (2)><minute (2)><second (2)>Z for a total fixed length of 16 characters. Z indicates the use of UTC (referring to its Zulu time zone). When used in DTSTART and DTEND 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:
VEVENTdescribes 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 beTRANSPARENTto change this interpretation. AVEVENTmay include aVALARMwhich allows an alarm. Such events have aDTSTARTwhich sets a starting time, and aDTENDwhich sets an ending time. If the calendar event is recurring,DTSTARTsets up the start of the first event.VTODOexplains a to-do item, i.e., an action-item or assignment. Not all calendar applications recognizeVTODOitems. In particular, Outlook does not export Tasks asVTODOitems, and ignoresVTODOitems in imported calendars.VJOURNALis 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. AVJOURNALcalendar component does not take up time on a calendar, so it has no effect on free or busy time (just likeTRANSPARENTentries). In practice, few programs supportVJOURNALentries.VFREEBUSYis a request for free/busy time, is a response to a request, or is a published set of busy time. Other component types includeVAVAILABILITY,VTIMEZONE(time zones) andVALARM(alarms). Some components can include other components (VALARMis often included in other components). Some components are often defined to support other components defined after them (VTIMEZONEis 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 (VJOURNAL). VTODOs 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 CALSCALE 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.
List of components, properties and parameters
| Name | Kind | RFC section (RFC 5545) |
|---|---|---|
VCALENDAR |
Component | 3.4. iCalendar Object |
VEVENT |
Component | 3.6.1. Event Component |
VTODO |
Component | 3.6.2. To-Do Component |
VJOURNAL |
Component | 3.6.3. Journal Component |
VFREEBUSY |
Component | 3.6.4. Free/Busy Component |
VTIMEZONE |
Component | 3.6.5. Time Zone Component |
STANDARD |
Component | 3.6.5. Time Zone Component |
DAYLIGHT |
Component | 3.6.5. Time Zone Component |
VALARM |
Component | 3.6.6. Alarm Component |
VAVAILABILITY |
Component | RFC 7953 section 3.1. VAVAILABILITY Component |
AVAILABLE |
Component | RFC 7953 section 3.1. VAVAILABILITY Component |
PARTICIPANT |
Component | RFC 9073 section 7.1. Participant |
VLOCATION |
Component | RFC 9073 section 7.2. Location |
VRESOURCE |
Component | RFC 9073 section 7.3. Resource |
CALSCALE |
Property | 3.7.1. Calendar Scale |
METHOD |
Property | 3.7.2. Method |
PRODID |
Property | 3.7.3. Product Identifier |
VERSION |
Property | 3.7.4. Version |
ATTACH |
Property | 3.8.1.1. Attachment |
CATEGORIES |
Property | 3.8.1.2. Categories, RFC 7986 section 5.6. CATEGORIES Property |
CLASS |
Property | 3.8.1.3. Classification |
COMMENT |
Property | 3.8.1.4. Comment |
DESCRIPTION |
Property | 3.8.1.5. Description, RFC 7986 section 5.2. DESCRIPTION Property |
GEO |
Property | 3.8.1.6. Geographic Position |
LOCATION |
Property | 3.8.1.7. Location |
PERCENT-COMPLETE |
Property | 3.8.1.8. Percent Complete |
PRIORITY |
Property | 3.8.1.9. Priority |
RESOURCES |
Property | 3.8.1.10. Resources |
STATUS |
Property | 3.8.1.11. Status |
SUMMARY |
Property | 3.8.1.12. Summary |
COMPLETED |
Property | 3.8.2.1. Date-Time Completed |
DTEND |
Property | 3.8.2.2. Date-Time End |
DUE |
Property | 3.8.2.3. Date-Time Due |
DTSTART |
Property | 3.8.2.4. Date-Time Start |
DURATION |
Property | 3.8.2.5. Duration |
FREEBUSY |
Property | 3.8.2.6. Free/Busy Time |
TRANSP |
Property | 3.8.2.7. Time Transparency |
TZID |
Property | 3.8.3.1. Time Zone Identifier |
TZNAME |
Property | 3.8.3.2. Time Zone Name |
TZOFFSETFROM |
Property | 3.8.3.3. Time Zone Offset From |
TZOFFSETTO |
Property | 3.8.3.4. Time Zone Offset To |
TZURL |
Property | 3.8.3.5. Time Zone URL |
ATTENDEE |
Property | 3.8.4.1. Attendee |
CONTACT |
Property | 3.8.4.2. Contact |
ORGANIZER |
Property | 3.8.4.3. Organizer |
RECURRENCE-ID |
Property | 3.8.4.4. Recurrence ID |
RELATED-TO |
Property | 3.8.4.5. Related To, RFC 9253 section 9.1. RELATED-TO |
URL |
Property | 3.8.4.6. Uniform Resource Locator, RFC 7986 section 5.5. URL Property |
UID |
Property | 3.8.4.7. Unique Identifier, RFC 7986 section 5.3. UID Property |
EXDATE |
Property | 3.8.5.1. Exception Date-Times |
RDATE |
Property | 3.8.5.2. Recurrence Date-Times |
RRULE |
Property | 3.8.5.3. Recurrence Rule |
ACTION |
Property | 3.8.6.1. Action |
REPEAT |
Property | 3.8.6.2. Repeat Count |
TRIGGER |
Property | 3.8.6.3. Trigger |
CREATED |
Property | 3.8.7.1. Date-Time Created |
DTSTAMP |
Property | 3.8.7.2. Date-Time Stamp |
LAST-MODIFIED |
Property | 3.8.7.3. Last Modified, RFC 7986 section 5.4. LAST-MODIFIED Property |
SEQUENCE |
Property | 3.8.7.4. Sequence Number |
REQUEST-STATUS |
Property | 3.8.8.3. Request Status |
BUSYTYPE |
Property | RFC 7953 section 3.2. Busy Time Type |
NAME |
Property | RFC 7986 section 5.1. NAME Property |
REFRESH-INTERVAL |
Property | RFC 7986 section 5.7. REFRESH-INTERVAL Property |
SOURCE |
Property | RFC 7986 section 5.8. SOURCE Property |
COLOR |
Property | RFC 7986 section 5.9. COLOR Property |
IMAGE |
Property | RFC 7986 section 5.10. IMAGE Property |
CONFERENCE |
Property | RFC 7986 section 5.11. CONFERENCE Property |
CALENDAR-ADDRESS |
Property | RFC 9073 section 6.4. Calendar Address |
LOCATION-TYPE |
Property | RFC 9073 section 6.1. Location Type |
PARTICIPANT-TYPE |
Property | RFC 9073 section 6.2. Participant Type |
RESOURCE-TYPE |
Property | RFC 9073 section 6.3. Resource Type |
STRUCTURED-DATA |
Property | RFC 9073 section 6.6. Structured-Data |
STYLED-DESCRIPTION |
Property | RFC 9073 section 6.5. Styled-Description |
ACKNOWLEDGED |
Property | RFC 9074 section 6.1. Acknowledged Property |
PROXIMITY |
Property | RFC 9074 section 8.1. Proximity Property |
CONCEPT |
Property | RFC 9253 section 8.1. Concept |
LINK |
Property | RFC 9253 section 8.2. Link |
REFID |
Property | RFC 9253 section 8.3. Refid |
ALTREP |
Parameter | 3.2.1. Alternate Text Representation |
CN |
Parameter | 3.2.2. Common Name |
CUTYPE |
Parameter | 3.2.3. Calendar User Type |
DELEGATED-FROM |
Parameter | 3.2.4. Delegators |
DELEGATED-TO |
Parameter | 3.2.5. Delegatees |
DIR |
Parameter | 3.2.6. Directory Entry Reference |
ENCODING |
Parameter | 3.2.7. Inline Encoding |
FMTTYPE |
Parameter | 3.2.8. Format Type |
FBTYPE |
Parameter | 3.2.9. Free/Busy Time Type |
LANGUAGE |
Parameter | 3.2.10. Language |
MEMBER |
Parameter | 3.2.11. Group or List Membership |
PARTSTAT |
Parameter | 3.2.12. Participation Status |
RANGE |
Parameter | 3.2.13. Recurrence Identifier Range |
RELATED |
Parameter | 3.2.14. Alarm Trigger Relationship |
RELTYPE |
Parameter | 3.2.15. Relationship Type, RFC 9074 7.1. Relationship Type Property Parameter, RFC 9253 4 and 5 |
ROLE |
Parameter | 3.2.16. Participation Role |
RSVP |
Parameter | 3.2.17. RSVP Expectation |
SENT-BY |
Parameter | 3.2.18. Sent By |
TZID |
Parameter | 3.2.19. Time Zone Identifier |
VALUE |
Parameter | 3.2.20. Value Data Types |
DISPLAY |
Parameter | RFC 7986 section 6.1. DISPLAY Property Parameter |
EMAIL |
Parameter | RFC 7986 section 6.2. EMAIL Property Parameter |
FEATURE |
Parameter | RFC 7986 section 6.3. FEATURE Property Parameter |
LABEL |
Parameter | RFC 7986 section 6.4. LABEL Property Parameter |
ORDER |
Parameter | RFC 9073 section 5.1. Order |
SCHEMA |
Parameter | RFC 9073 section 5.2. Schema |
DERIVED |
Parameter | RFC 9073 section 5.3. Derived |
GAP |
Parameter | RFC 9253 section 6.2. Gap |
LINKREL |
Parameter | RFC 9253 section 6.1. Link Relation |