5.10. IMAGE Property

Property Name

IMAGE

Purpose

This property specifies an image associated with the calendar or a calendar component.

Value Type

URI or BINARY -- no default. The value MUST be data with a media type of "image" or refer to such data.

Property Parameters

IANA, non-standard, display, inline encoding, and value data type property parameters can be specified on this property. The format type parameter can be specified on this property and is RECOMMENDED for inline binary-encoded content information.

Conformance

This property can be specified multiple times in an iCalendar object or in "VEVENT", "VTODO", or "VJOURNAL" calendar components.

Description

This property specifies an image for an iCalendar object or a calendar component via a URI or directly with inline data that can be used by calendar user agents when presenting the calendar data to a user. Multiple properties MAY be used to specify alternative sets of images with, for example, varying media subtypes, resolutions, or sizes. When multiple properties are present, calendar user agents SHOULD display only one of them, picking one that provides the most appropriate image quality, or display none. The "DISPLAY" parameter is used to indicate the intended display mode for the image. The "ALTREP" parameter, defined in [RFC5545], can be used to provide a "clickable" image where the URI in the parameter value can be "launched" by a click on the image in the calendar user agent.

Format Definition

This property is defined by the following notation:

image      = "IMAGE" imageparam
          (
            (
              ";" "VALUE" "=" "URI"
              ":" uri
            ) /
            (
              ";" "ENCODING" "=" "BASE64"
              ";" "VALUE" "=" "BINARY"
              ":" binary
            )
          )
          CRLF

imageparam = *(
           ;
           ; The following is OPTIONAL for a URI value,
           ; RECOMMENDED for a BINARY value,
           ; and MUST NOT occur more than once.
           ;
           (";" fmttypeparam) /
           ;
           ; The following are OPTIONAL,
           ; and MUST NOT occur more than once.
           ;
           (";" altrepparam) / (";" displayparam) /
           ;
           ; The following is OPTIONAL,
           ; and MAY occur more than once.
           ;
           (";" other-param)
           ;
           )

Example

The following is an example of this property

 IMAGE;VALUE=URI;DISPLAY=BADGE;FMTTYPE=image/png:h
  ttp://example.com/images/party.png