Internet-Draft | vCard JSContact Extensions | July 2023 |
Stepanek & Loffredo | Expires 4 January 2024 | [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).¶
This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.¶
Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at https://datatracker.ietf.org/drafts/current/.¶
Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress."¶
This Internet-Draft will expire on 4 January 2024.¶
Copyright (c) 2023 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 [I-D.ietf-calext-jscontact] 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 [I-D.ietf-calext-jscontact-vcard] with the goal of not losing any semantics during conversion. To do so, 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 that currently typically are combined in street address component values into distinct components, such as street names, street numbers, apartment numbers, floors. Implementations SHOULD write a combined value of these components in the street address component for backwards compatibility, but SHOULD ignore it during read if applicable new component values are available.¶
The following change is made to the first paragraph in the "Special Notes" section, originally specified in Section 6.3.1 of [RFC6350]. All remaining paragraphs of that section in the original specification still apply.¶
The following change is made to the definition of "ADR-value" in the "ABNF" section, originally specified in Section 6.3.1 of [RFC6350].¶
ADR-value = ADR-component-pobox ";" ADR-component-ext ";" ADR-component-street ";" ADR-component-locality ";" ADR-component-region ";" ADR-component-code ";" ADR-component-country ";" ; above components are defined in RFC 6350, section 6.3.1 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-streetname = list-component ADR-component-streetnumber = 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¶
This property is defined by the following notation:¶
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:20220705093412Z CREATED;VALUE=TIMESTAMP:20211022T140000-05¶
TEXT
shall be assumed to be written for this vCard.
If a vCard property includes the LANGUAGE
parameter, then the
parameter value has higher precedence than the DEFLANGUAGE
property value.¶
This property is defined by the following notation:¶
deflanguage = "DEFLANGUAGE" any-param ":" Language-Tag ; Language-Tag is defined in RFC6350, Section 4.¶
DEFLANGUAGE:de-AT¶
This property defines the grammatical gender that the contact prefers to be addressed by or referred at 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 LANG parameter.¶
This property is defined by the following notation:¶
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:neuter¶
This property is defined by the following notation:¶
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;LANG=en;PREF=1:xe/xir PRONOUNS;LANG=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 [RFC6350]¶
NOTE;CREATED=20221122T151823Z:This is some note.¶
This property parameter SHOULD be specified on an 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.¶
For an example, an implementation may derive the value of the FN property from the name components of the N property by use of the FMT (Section 4.5) parameter. 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¶
The N and ADR properties use structured value types to define the constituent components of a name or address. In contrast, the FN property and LABEL parameter contain full names or addresses as a single TEXT value, which might redundantly redefine the information in their structured value counterparts and bears the risk of their values going out of sync. Instead, implementations should be guided how to form a full name or address of a given N or ADR property. This is what the FMT parameter aims to achieve. In addition to the component values, it also allows to define what values implementations SHOULD insert in between components, such that the resulting name or address is formatted appropriately and locale-specific.¶
The FMT parameter value is a structured type value. It consists of a sequence of formatting instructions, where a formatting instruction defines what value to concatenate to the result TEXT value. There are two kinds of formatting instruction:¶
A positional. This instructs to concatenate to the result the value of a structured property component value at a specified position. A position consists of a numeric index of a component in the structured value, optionally followed by a COMMA (U+002C) character and the index of a value within that component. The zero index selects the first component or value, respectively. The second index by default is zero, in which case it MAY be omitted, otherwise it MUST NOT be omitted.¶
If a positional instruction contains a position of a non-existent or empty component value, then the entire FMT parameter MUST be considered invalid and MUST be ignored.¶
The first entry in the sequence of formatting instructions either MUST be the empty string or it MUST be a separator formatting instruction. If the first entry is a separator formatting instruction, then this defines the default separator value to insert in between the values indicated by two consecutive positional formatting instructions. Any separator formatting instruction in later entries has higher precedence than this default separator. If the first entry is the empty string, the default separator is undefined and implementation-specific. The FMT parameter value either includes exactly one separator formatting instruction for the default separator, or an optional default separator followed by at least one formatting instruction (see Format definition).¶
Some implementations might not support the FMT parameter. For backwards compatibility, implementations SHOULD generate the FN property based on the N property and FMT instructions. In this case, they SHOULD set the DERIVED (Section 4.4) parameter on the FN property. They MAY generate a LABEL parameter for the ADR property.¶
fmt-param = "FMT" "=" DQUOTE ( (fmt-inst-sep [";" fmt-instlist]) / (";" fmt-instlist) ) DQUOTE fmt-instlist = fmt-inst *(";" fmt-inst) fmt-inst = fmt-inst-pos / fmt-inst-sep fmt-inst-pos = 1*DIGIT ["," 1*DIGIT] fmt-inst-sep = "s" "," fmt-inst-verb fmt-inst-verb = *QSAFE-CHAR ; note: the ";" character MUST be escaped as "\;"¶
The following examples demonstrates how to generate the same value as the FN property value using the FMT parameter. The first format instruction defines a single SPACE (U+0020) character as default to separate two component values. The next format instructions select the first value of the second component of the N property value (the given name), followed by the first value of the first component in the N property value (the surname).¶
FN;DERIVED=TRUE::Rene van der Harten N;FMT="s, ;1,0;0,0":van der Harten;Rene,J.;Sir;R.D.O.N.¶
where the positions can be reduced to shorter form¶
FN;DERIVED=TRUE::Rene van der Harten N;FMT="s, ;1;0":van der Harten;Rene,J.;Sir;R.D.O.N.¶
An implementation may decide to not explicitly define a default separator. Assuming that the implementation uses space to separate name components, the FMT parameter value would then be for example:¶
FN;DERIVED=TRUE:Rene van der Harten N;FMT=";1;0":van der Harten;Rene,J.;Sir;R.D.O.N.¶
The following example demonstrates how the honorific suffix could be preceded by the SEMICOLON (U+003B) and SPACE (U+0020) characters.¶
FN;DERIVED=TRUE:Rene van der Harten; R.D.O.N. N;FMT=";1;0;s,\; ;3":van der Harten;Rene,J.;Sir;R.D.O.N.¶
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 only has the purpose 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 is 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 MAY be specified on a IMPP or 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 a IMPP or 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 the vCard Format Specification. The same security considerations as outlined in Section 9 of [RFC6350] apply.¶
IANA is requested to add the following entries to the "vCard Properties" registry, defined in Section 10.3.1. of [RFC6350].¶
Namespace | Property | Reference |
---|---|---|
CREATED | This document, Section 3.1 | |
DEFLANGUAGE | This document, Section 3.2 | |
GRAMGENDER | This document, Section 3.3 | |
PRONOUNS | This document, Section 3.4 | |
SOCIALPROFILE | This document, Section 3.5 |
IANA is requested to add Section 2.1 of this document as reference for the ADR property.¶
IANA is requested to add the following entries to the "vCard Parameters" registry, defined in Section 10.3.2. of [RFC6350].¶
Namespace | Parameter | Reference |
---|---|---|
AUTHOR | This document, Section 4.1 | |
AUTHOR-NAME | This document, Section 4.2 | |
CREATED | This document, Section 4.3 | |
FMT | This document, Section 4.5 | |
DERIVED | This document, Section 4.4 | |
PROP-ID | This document, Section 4.6 | |
SERVICE-TYPE | This document, Section 4.7 | |
USERNAME | This document, Section 4.8 |
IANA is requested to add the following entries to the "vCard Property Values" registry, defined in Section 10.3.4. of [RFC6350].¶
Property | Value | Reference |
---|---|---|
GRAMGENDER | animate | This document, Section 3.3 |
GRAMGENDER | common | This document, Section 3.3 |
GRAMGENDER | feminine | This document, Section 3.3 |
GRAMGENDER | inanimate | This document, Section 3.3 |
GRAMGENDER | masculine | This document, Section 3.3 |
GRAMGENDER | neuter | This document, Section 3.3 |
IANA is requested to add the following entries to the "vCard Parameter Values" registry, defined in Section 10.3.4. of [RFC6350].¶
Property | Parameter | Value | Reference |
---|---|---|---|
ADR | TYPE | billing | This document, Section 5.1 |
ADR | TYPE | delivery | This document, Section 5.2 |