Try out our new RRULE tool for creating RRULE compatible strings.

New Properties for iCalendar (RFC 7986)

Abstract

This document defines a set of new properties for iCalendar data and extends the use of some existing properties to the entire iCalendar object.

Author

C. Daboo, Apple, Inc., October 2016

10. References

4. Modifications to Calendar Components

This section details changes to the syntax defined in iCalendar [RFC5545]. New elements are defined in subsequent sections.

calprops =/ *(
          ;
          ; The following are OPTIONAL,
          ; but MUST NOT occur more than once.
          ;
          uid / last-mod / url /
          refresh / source / color
          ;
          ; The following are OPTIONAL,
          ; and MAY occur more than once.
          ;
          name / description / categories /
          image
          ;
          )

eventprop =/ *(
           ;
           ; The following are OPTIONAL,
           ; but MUST NOT occur more than once.
           ;
           color /
           ;
           ; The following are OPTIONAL,
           ; and MAY occur more than once.
           ;
           conference / image
           ;
           )

todoprop =/ *(
          ;
          ; The following are OPTIONAL,
          ; but MUST NOT occur more than once.
          ;
          color /
          ;
          ; The following are OPTIONAL,
          ; and MAY occur more than once.
          ;
          conference / image
          ;
          )

jourprop =/ *(
          ;
          ; The following are OPTIONAL,
          ; but MUST NOT occur more than once.
          ;
          color /
          ;
          ; The following are OPTIONAL,
          ; and MAY occur more than once.
          ;
          image
          ;
          )

5.1. NAME Property

Property Name

NAME

Purpose

This property specifies the name of the calendar.

Value Type

TEXT

Property Parameters

IANA, non-standard, alternate text representation, and language property parameters can be specified on this property.

Conformance

This property can be specified multiple times in an iCalendar object. However, each property MUST represent the name of the calendar in a different language.

Description

This property is used to specify a name of the iCalendar object that can be used by calendar user agents when presenting the calendar data to a user. Whilst a calendar only has a single name, multiple language variants can be specified by including this property multiple times with different "LANGUAGE" parameter values on each.

Format Definition

This property is defined by the following notation:

 name       = "NAME" nameparam ":" text CRLF

nameparam  = *(
           ;
           ; The following are OPTIONAL,
           ; but MUST NOT occur more than once.
           ;
           (";" altrepparam) / (";" languageparam) /
           ;
           ; The following is OPTIONAL,
           ; and MAY occur more than once.
           ;
           (";" other-param)
           ;
           )

Example

The following is an example of this property

 NAME:Company Vacation Days

5.2. DESCRIPTION Property

This specification modifies the definition of the "DESCRIPTION" property to allow it to be defined in an iCalendar object. The following additions are made to the definition of this property, originally specified in Section 3.8.1.5 of [RFC5545].

Purpose

This property specifies the description of the calendar.

Conformance

This property can be specified multiple times in an iCalendar object. However, each property MUST represent the description of the calendar in a different language.

Description

This property is used to specify a lengthy textual description of the iCalendar object that can be used by calendar user agents when describing the nature of the calendar data to a user. Whilst a calendar only has a single description, multiple language variants can be specified by including this property multiple times with different "LANGUAGE" parameter values on each.

Page 3 of 9

This document was automatically converted to XHTML using an RFC to HTML converter with the original text document at the Internet Engineering Task Force web site at ietf.org .  The original text document should be referred to if there are any errors or discrepancies found in this document.

Need to test your iCalendar feeds?

The iCalendar Validator provides developers and testers a method to validate their iCalendar feeds, which can take data from either a URL, file or text snippet and compare it against the RFC 5545 specification.  We believe we have one of the best iCalendar validation tools available on the internet. More information about the validator can be found here.