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

iCalendar (RFC 5545)

Abstract

This document defines the iCalendar data format for representing and exchanging calendaring and scheduling information such as events, to-dos, journal entries, and free/busy information, independent of any particular calendar service or protocol.

RFC 5545 supercedes the original iCalendar specification , RFC 2445.

Author

B. Desruisseaux, Ed., Oracle, September 2009

 

3.2.14. 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

This property parameter is defined by the following notation:

 trigrelparam       = "RELATED" "="
                     ("START"       ; Trigger off of start
                    / "END")        ; Trigger off of end

Description

This 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

3.2.12. Participation Status

Parameter Name

PARTSTAT

Purpose

To specify the participation status for the calendar user specified by the property.

Format Definition

This property parameter is defined by the following notation:

 partstatparam    = "PARTSTAT" "="
                   (partstat-event
                  / partstat-todo
                  / partstat-jour)

 partstat-event   = ("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.

 partstat-todo    = ("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
                  / "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.

 partstat-jour    = ("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.

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. Applications MUST treat x-name and iana-token values they don't recognize the same way as they would the NEEDS-ACTION value.

Example

 ATTENDEE;PARTSTAT=DECLINED:mailto:jsmith@example.com

3.2.15. Relationship Type

Parameter Name

RELTYPE

Purpose

To specify the type of hierarchical relationship associated with the calendar component specified by the property.

Format Definition

This 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; or SIBLING to indicate that the referenced calendar component is a peer of the calendar component. If this parameter is not specified on an allowable property, the default relationship type is PARENT. Applications MUST treat x-name and iana-token values they don't recognize the same way as they would the PARENT value.

Example

 RELATED-TO;RELTYPE=SIBLING:19960401-080045-4000F192713@
  example.com

3.2.16. Participation Role

Parameter Name

ROLE

Purpose

To specify the participation role for the calendar user specified by the property.

Format Definition

This 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. Applications MUST treat x-name and iana-token values they don't recognize the same way as they would the REQ-PARTICIPANT value.

Example

 ATTENDEE;ROLE=CHAIR:mailto:mrbig@example.com

Page 13 of 38

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.