RFC 9554 | vCard JSContact Extensions | May 2024 |
Stepanek & Loffredo | Standards Track | [Page] |
This document defines a set of new properties for vCard and extends the use of existing ones. Their primary purpose is to align the same set of features between the JSContact and vCard formats, but the new definitions also aim to be useful within just the vCard format. This document updates RFC 6350 ("vCard Format Specification").¶
This is an Internet Standards Track document.¶
This document is a product of the Internet Engineering Task Force (IETF). It represents the consensus of the IETF community. It has received public review and has been approved for publication by the Internet Engineering Steering Group (IESG). Further information on Internet Standards is available in Section 2 of RFC 7841.¶
Information about the current status of this document, any errata, and how to provide feedback on it may be obtained at https://www.rfc-editor.org/info/rfc9554.¶
Copyright (c) 2024 IETF Trust and the persons identified as the document authors. All rights reserved.¶
This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Revised BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Revised BSD License.¶
This document may contain material from IETF Documents or IETF Contributions published or made publicly available before November 10, 2008. The person(s) controlling the copyright in some of this material may not have granted the IETF Trust the right to allow modifications of such material outside the IETF Standards Process. Without obtaining an adequate license from the person(s) controlling the copyright in such materials, this document may not be modified outside the IETF Standards Process, and derivative works of it may not be created outside the IETF Standards Process, except to format it for publication as an RFC or to translate it into languages other than English.¶
The JSContact [RFC9553] format aims to be an alternative to the vCard [RFC6350] format for representation of contact and address book data. As such, it introduces new semantics that are not covered in the current definition of vCard and its various extensions. Converting contact data between the two formats is defined in [RFC9555] with the goal of not losing any semantics during conversion. To achieve this, this document defines a new set of properties for vCard and extends existing definitions.¶
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.¶
This specification modifies the definition of the ADR property. It extends its structured value with additional address components to better support the variety of international addresses. It separates the address parts, which currently are typically combined in street address component values, into distinct components.¶
Implementations SHOULD write a combined value of these components in the street address component for backwards compatibility, but they SHOULD ignore the street component during reads if the ADR property value contains any of the new components.¶
The following change is made to the first paragraph under "Special note", as originally specified in Section 6.3.1 of [RFC6350]. The remaining paragraphs of that section in the original specification still apply.¶
Special note: The structured type value consists of a sequence of address components. The component values MUST be specified in their corresponding position. The structured type value corresponds, in sequence, to the¶
The following change is made to the definition of "ADR-value" under "ABNF", as originally specified in Section 6.3.1 of [RFC6350].¶
ABNF¶
ADR-value = ; defined in RFC 6350, Section 6.3.1.: ADR-component-pobox ";" ADR-component-ext ";" ADR-component-street ";" ADR-component-locality ";" ADR-component-region ";" ADR-component-code ";" ADR-component-country ";" ; defined in this document: ADR-component-room ";" ADR-component-apartment ";" ADR-component-floor ";" ADR-component-streetnumber ";" ADR-component-streetname ";" ADR-component-building ";" ADR-component-block ";" ADR-component-subdistrict ";" ADR-component-district ";" ADR-component-landmark ";" ADR-component-direction ADR-component-pobox = list-component ADR-component-ext = list-component ADR-component-street = list-component ADR-component-locality = list-component ADR-component-region = list-component ADR-component-code = list-component ADR-component-country = list-component ADR-component-room = list-component ADR-component-apartment = list-component ADR-component-floor = list-component ADR-component-streetnumber = list-component ADR-component-streetname = list-component ADR-component-building = list-component ADR-component-block = list-component ADR-component-subdistrict = list-component ADR-component-district = list-component ADR-component-landmark = list-component ADR-component-direction = list-component¶
The following change is made under "Example", as originally specified in Section 6.3.1 of [RFC6350].¶
Example: In this example, the post office box and the extended address components are absent. The street number and name are both added as separate components and are combined in the street component for backwards compatibility.¶
ADR;GEO="geo:12.3457,78.910": ;;123 Main Street;Any Town;CA;91921-1234;U.S.A ;;;;123;Main Street;;;;;;¶
This specification modifies the definition of the N property. It extends its structured value with additional name components to better support international names and generation markers. In doing so, this also facilitates formatting N property values using the Unicode Common Locale Data Repository (CLDR) Person Name [CLDRPersonName] formatting standard.¶
One new component is for secondary surnames, because in some cultures, such secondary surname kinds are used to indicate the paternal and maternal family names or generational names indicating father or grandfather. Another new component indicates a generation ("II", "XVI") or parental relation ("Jr.", "Sr.").¶
Currently, implementations typically place secondary surnames in the family name component and generational markers in the honorific suffixes component. For backwards compatibility, implementations SHOULD add such values to both the newly defined components and their backwards-compatible counterpart. Reading N property values, implementations SHOULD ignore any value in the backwards-compatible component if an equal value is set in the new component accordingly. For example, a "Jr." that occurs in both honorific suffixes and generation should only be handled as a generational marker.¶
The following change is made to the first paragraph under "Special note", as originally specified in Section 6.2.2 of [RFC6350]. The remaining paragraphs of that section in the original specification still apply.¶
Special note: The structured property value corresponds, in sequence, to the¶
The following change is made under "ABNF", as originally specified in Section 6.2.2 of [RFC6350].¶
ABNF¶
N-param = "VALUE=text" / sort-as-param / language-param / altid-param / any-param N-value = list-component 6(";" list-component)¶
The following change is made under "Examples", as originally specified in Section 6.2.2 of [RFC6350].¶
Examples¶
N:Public;John;Quinlan;Mr.;Esq. N:Stevenson;John;Philip,Paul;Dr.;Jr.,M.D.,A.C.P.;;Jr.¶
No change is required for the definition of the SORT-AS parameter, but the new components also apply for use with this parameter.¶
created = "CREATED" createdparam ":" timestamp createdparam = *( ; ; The following are OPTIONAL ; but MUST NOT occur more than once. ; (";" "VALUE" "=" "timestamp") / ; ; The following are OPTIONAL ; and MAY occur more than once. ; (";" any-param) ; )¶
CREATED:20220705T093412Z CREATED;VALUE=TIMESTAMP:20211022T140000-05¶
This property defines the grammatical gender that the contact prefers to be addressed by or referred to as in written or spoken form. For example, the German language distinguishes by grammatical gender in salutations such as "Sehr geehrte" (feminine) and "Sehr geehrter" (masculine). Multiple occurrences of this property MUST be distinguished by the LANGUAGE parameter.¶
gramgender = "GRAMGENDER" gramgender-param ":" gramgender-value gramgender-param = *( ; ; The following are OPTIONAL ; but MUST NOT occur more than once. ; (";" language-param) / ; ; The following are OPTIONAL ; and MAY occur more than once. ; (";" any-param) ; ) gramgender-value = "animate" / "common" / "feminine" / "inanimate" / "masculine" / "neuter" / iana-token / x-name¶
GRAMGENDER;LANGUAGE=de:feminine¶
language-prop = "LANGUAGE" any-param ":" Language-Tag ; Language-Tag is defined in RFC 6350, Section 4.¶
LANGUAGE:de-AT¶
pronouns = "PRONOUNS" pronouns-param ":" text pronouns-param = *( ; ; The following are OPTIONAL ; but MUST NOT occur more than once. ; (";" language-param) / (";" pref-param) / (";" type-param) / (";" altid-param) / ; ; The following are OPTIONAL ; and MAY occur more than once. ; (";" any-param) ; )¶
PRONOUNS;LANGUAGE=en;PREF=1:xe/xir PRONOUNS;LANGUAGE=en;PREF=2:they/them¶
This parameter MAY be set on any property to define the point in time when the property was created. The value MUST be a valid TIMESTAMP value as defined in Section 4.3.5 of [RFC6350]. Generally, updating a property value SHOULD NOT change the creation timestamp.¶
created-param = "CREATED" "=" param-value ; a valid TIMESTAMP of Section 4.3.5 of RFC 6350¶
NOTE;CREATED=20221122T151823Z:This is some note.¶
This property parameter SHOULD be specified on a property if the property value is derived from some other properties in the same vCard. When present with a value of "true", clients MUST NOT update the property.¶
As an example, an implementation may derive the value of the FN property from the name components of the N property. It indicates this fact by setting the DERIVED parameter on the FN property to "true".¶
derived-param = "DERIVED" "=" ("true" / "false") ; Default is false¶
N:;John;Quinlan;Mr.; FN;DERIVED=TRUE:Mr. John Quinlan¶
Section 6.3.1 of [RFC6350] defines the ADR property, noting that the property can also include a LABEL parameter to present a delivery address label for the address. But this parameter was not included in the IANA "vCard Parameters" registry (Section 10.3.2 of [RFC6350]) and, accordingly, is not a registered standard vCard element. This specification defines and registers the LABEL parameter for use with the ADR property as originally intended.¶
label-param = "LABEL" "=" param-value¶
The LABEL parameter as illustrated in the ADR property example in Section 6.3.1 of [RFC6350].¶
ADR;LABEL="Mr. John Q. Public, Esq.\nMail Drop: TNE QB\n123 Main Street\nAny Town, CA 91921-1234\nU.S.A.": ;;123 Main Street;Any Town;CA;91921-1234;U.S.A.¶
This property parameter indicates that the value of its property contains the phonetic representation of another same-named property in the same vCard. Exemplary uses are defining how to pronounce Japanese names and romanizing Mandarin or Cantonese names and address components.¶
The parameter value indicates the phonetic system and MUST be one of the values enumerated in the IANA "vCard Parameter Values" registry (Section 7.4). This specification defines the following values:¶
The value type of the property on which the PHONETIC parameter is set MUST be of the same type as its related property. If a component value is set in the property on which the PHONETIC parameter is set, then a component value also MUST be set at that same position in the related property. On the other hand, not every component value in the related property needs to have a phonetic representation.¶
The ALTID (Section 5.4 of [RFC6350]) parameter MUST be set with equal values on both the related property and the property having the PHONETIC parameter set. If more than one same-named property has both the PHONETIC parameter set and an equal ALTID parameter value, then at most, one of these properties MAY not have the LANGUAGE parameter set, and all others MUST have the LANGUAGE parameter set. The LANGUAGE parameters MUST NOT have equal values. The LANGUAGE parameter value SHOULD NOT contain a script subtag in its Language-Tag value, and any such subtag MUST be ignored in favor of the SCRIPT (Section 4.8) parameter value.¶
This specification defines the PHONETIC parameter for use with the ADR and N properties.¶
phonetic-param = "PHONETIC=" phonetic-value phonetic-value = "ipa" / "piny" / "jyut" / "script" / iana-token / x-name¶
N;ALTID=1;LANGUAGE=zh-Hant:孫;中山;文,逸仙;;;; N;ALTID=1;PHONETIC=jyut; SCRIPT=Latn;LANGUAGE=yue:syun1;zung1saan1;man4,jat6sin1;;;;¶
This parameter uniquely identifies a property among all of its siblings with the same name within a vCard. A valid PROP-ID value must be of 1 and a maximum of 255 octets in size, and it MUST only contain the ASCII alphanumeric characters ("A-Za-z0-9"), hyphen (-), and underscore ("_"). The identifier's only purpose is to uniquely identify siblings; its value has no other meaning. If an application makes use of PROP-ID, it SHOULD assign a unique identifier to each sibling property of the same name within their embedding component. The same identifier MAY be used for properties of a different name, and it MAY also be assigned to a same-named property that is not a sibling.¶
Resolving duplicate identifier conflicts is specific to the application. Similarly, handling properties where some but not all siblings have a PROP-ID assigned is application-specific.¶
prop-id-param = "PROP-ID" "=" 1*255(ALPHA / DIGIT / "-"/ "_")¶
PHOTO;PROP-ID=p827:data:image/jpeg;base64,MIICajCCAdOgAwIBAg <...remainder of base64-encoded data...>¶
This parameter allows defining a script for a property value without also defining a language as the LANGUAGE parameter would. The value MUST be a script subtag as defined in Section 2.2.3 of [RFC5646]. This specification makes use of the SCRIPT parameter in combination with the PHONETIC (Section 4.6) parameter.¶
script-param = 4ALPHA¶
SCRIPT=Latn¶
This parameter MAY be specified on an Instant Messaging and Presence Protocol (IMPP) or a SOCIALPROFILE property to name the online service associated with that property value. Its value is case-sensitive; its letter cases MUST be preserved.¶
Several vCard address book implementations currently use an experimental X-SERVICE-TYPE parameter. This specification provides an IANA-registered parameter for the same purpose.¶
service-type-param = "SERVICE-TYPE" "=" param-value¶
SOCIALPROFILE;SERVICE-TYPE=Mastodon:https://example.com/@foo¶
This parameter MAY be specified on an IMPP or a SOCIALPROFILE property to name the user with that property value. Its value is case-sensitive; its letter cases MUST be preserved. The IMPP or SOCIALPROFILE value type MUST be URI.¶
username-param = "USERNAME" "=" param-value¶
SOCIALPROFILE;USERNAME="The Foo":https://example.com/@foo¶
This specification extends "vCard Format Specification" [RFC6350]. The same security considerations as outlined in Section 9 of [RFC6350] apply.¶
IANA has added the following entries to the "vCard Properties" registry, as defined in Section 10.3.1 of [RFC6350].¶
Namespace | Property | Reference |
---|---|---|
CREATED | RFC 9554, Section 3.1 | |
GRAMGENDER | RFC 9554, Section 3.2 | |
LANGUAGE | RFC 9554, Section 3.3 | |
PRONOUNS | RFC 9554, Section 3.4 | |
SOCIALPROFILE | RFC 9554, Section 3.5 |
IANA has added Section 2.1 of this document as a reference for the ADR property and Section 2.2 of this document as a reference for the N property in the "vCard Properties" registry.¶
IANA has added the following entries to the "vCard Parameters" registry, as defined in Section 10.3.2 of [RFC6350].¶
Namespace | Parameter | Reference |
---|---|---|
AUTHOR | RFC 9554, Section 4.1 | |
AUTHOR-NAME | RFC 9554, Section 4.2 | |
CREATED | RFC 9554, Section 4.3 | |
DERIVED | RFC 9554, Section 4.4 | |
LABEL | [RFC6350], Section 6.3.1 and RFC 9554, Section 4.5 | |
PHONETIC | RFC 9554, Section 4.6 | |
PROP-ID | RFC 9554, Section 4.7 | |
SCRIPT | RFC 9554, Section 4.8 | |
SERVICE-TYPE | RFC 9554, Section 4.9 | |
USERNAME | RFC 9554, Section 4.10 |
IANA has added the following entries to the "vCard Property Values" registry, as defined in Section 10.3.4 of [RFC6350].¶
Property | Value | Reference |
---|---|---|
GRAMGENDER | animate | RFC 9554, Section 3.2 |
GRAMGENDER | common | RFC 9554, Section 3.2 |
GRAMGENDER | feminine | RFC 9554, Section 3.2 |
GRAMGENDER | inanimate | RFC 9554, Section 3.2 |
GRAMGENDER | masculine | RFC 9554, Section 3.2 |
GRAMGENDER | neuter | RFC 9554, Section 3.2 |
IANA has added the following entries to the "vCard Parameter Values" registry, as defined in Section 10.3.4 of [RFC6350].¶
Property | Parameter | Value | Reference |
---|---|---|---|
ADR | TYPE | billing | RFC 9554, Section 5.1 |
ADR | TYPE | delivery | RFC 9554, Section 5.2 |
ADR, N | PHONETIC | ipa | RFC 9554, Section 4.6 |
ADR, N | PHONETIC | jyut | RFC 9554, Section 4.6 |
ADR, N | PHONETIC | piny | RFC 9554, Section 4.6 |
ADR, N | PHONETIC | script | RFC 9554, Section 4.6 |
The definition and examples of the PHONETIC (Section 4.6) and SCRIPT (Section 4.8) parameters are based on the early draft version of [CALCONNECT-VOBJECT].¶