JSContact: Converting from and to vCard

JSContact: Converting from and to vCard IIT-CNR/Registro.it

Via Moruzzi, 1 Pisa Italy 56124 mario.loffredo@iit.cnr.it https://www.iit.cnr.it

Fastmail

PO Box 234 Collins St. West Melbourne VIC 8007 Australia rsto@fastmailteam.com https://www.fastmail.com

art calext JSON contacts vCard jCard This document defines how to convert contact information between the JSContact and vCard data formats. It defines conversion rules for every JSContact and vCard element registered at IANA at the time of publication. It also defines new JSContact properties as well as vCard properties and parameters, to support converting arbitrary or unknown JSContact and vCard elements. This document obsoletes RFC 9555 and updates its definitions for JSContact version "2.0". Differences from RFC 9555 are documented in .

Introduction

Notational Conventions 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 when, and only when, they appear in all capitals, as shown here. The ABNF definitions in this document use the notations of . ABNF rules not defined in this document are defined in either (such as the ABNF for CRLF, WSP, DQUOTE, VCHAR, ALPHA, and DIGIT) or .

Scope and Goals This document outlines how to convert between the vCard and JSContact data formats. It describes which elements are common to both, but also highlights where the two formats differ. For each common element, it defines a conversion rule and includes an example of how to convert that element. All vCard and JSContact elements that IANA registers for common use are in scope. Elements that IANA registers for reserved use and obsolete elements are out of scope. For elements that have no counterpart in the other format, it is the goal of this document to define how to preserve them during conversion, but in general it is not the goal to achieve this by defining new standard elements. Instead, this document updates and by defining vCard and JSContact elements to preserve elements that have no equivalent in the other format. These conversion-specific properties are defined in Section for vCard, and for JSContact. This document obsoletes . For contents that remain unchanged, it includes all verified errata for the obsoleted document. The conversion rules are updated for JSContact version "2.0", defined in . replaces the JSContact "vCardProps", "vCardParams" and "vCardName" properties originally defined in with the new "vCard" property. The new property allows for edge cases where the former elements were insufficient. For vCard, replaces the PROP-ID parameter with the new JSID parameter. Both changes align the conversion-specific elements of vCard and JSContact with those defined for iCalendar and JSCalendar in , allowing for code reuse for implementations that support these formats.

How to Read the Examples Later sections contain examples that illustrate how to convert between the vCard and JSContact data formats. The notation of these examples is such that their main points should be clear to the reader, but their contents can also be parsed for automated testing. The following sections define the notation for such examples.

vCard Examples A vCard example contains either an extract or a complete representation of vCard data. The following rules apply:

An example that only contains vCard properties implicitly represents a vCard (e.g. the BEGIN:VCARD and END:VCARD lines are implicit).
The vCard implicitly contains all mandatory properties with some value. If they are not included in the example, then their actual value is irrelevant for the example. The default value for the VERSION property is "4.0".

contains three examples, all of which represent the same vCard data. In the first example, the BEGIN and END lines and the mandatory properties are implicit. In the second example, only the BEGIN and END lines of the vCard are implicit. The third example depicts a complete vCard, nothing is implicit.

Examples for implicit and explicit vCard notation A line containing just the value ... stands for any other properties that might be present in the vCard but are irrelevant for this example. illustrates this as an alternative representation for the examples of .

Example for additional properties represented by ... A line starting with a single space represents the continuation of a folded content line (). illustrates this.

Example for a folded content line

JSContact Examples A JSContact example always represents a Card object, even if the example only depicts other JSContact objects and properties. JSContact objects are depicted either explicitly or implicitly. An explicit JSContact object starts and ends with braces. An implicit JSContact object omits braces, it only consists of JSON name/value pairs, separated by comma. An implicit JSContact object is assumed to be of type Card, unless it contains the @type property with a different value. It is assumed to contain all mandatory properties with some value; if they are not depicted, their actual value is irrelevant for the main point of the example. The default version of the Card is "2.0". illustrates this with multiple examples, all of which represent the same JSContact data. The first example contains an implicit JSContact object of type Card. The second example contains an explicit Name object but the Card object containing it is omitted. The third example contains the full Card object, nothing is omitted.

Examples for implicit and explicit JSContact object notation A property with name "..." and value "" stands for additional properties that might be present in a JSContact object but are irrelevant for this example, including mandatory properties. illustrates this as an alternative representation for the examples of .

Example for additional properties represented by ...

Converting vCard to JSContact This section contains the conversion rules from the vCard to the JSContact Card.

General Rules

The Card uid Property The UID property converts to the Card object's "uid" property, see . In contrast to JSContact version "2.0", the Card object's "uid" property was mandatory in version "1.0". Implementations that convert a vCard without a UID property to a Card of version "2.0" or higher MUST NOT generate a unique identifier as value for the "uid" property. When converting a vCard without UID property to JSContact version "1.0", implementations MUST generate a value for the "uid" property. Generating unique identifiers is implementation-specific. An implementation SHOULD generate the same value when generating the same Card multiple times. describes why this is problematic. Consequently, implementations SHOULD NOT convert to version "1.0" Card objects.

Choosing Identifiers Multivalued properties in JSContact are typically represented as a JSON object where the object keys are of the Id type () and the object values are the converted vCard property. In the absence of the JSID parameter (see ), implementations are free to choose any identifier as key for such entries. Whatever identifier generation scheme implementations use, they MUST generate values that are valid according to the definition of the Id type in . For example, this could be an incrementing number across all identifier keys in the Card object or only unique within one JSON object.

Preserving vCard Elements vCard data may contain elements that do not convert to JSContact. This includes standard vCard elements, such as the ALTID and PID parameters, as well as extended properties and parameters (see ). This document defines the conversion-specific "vCard" property to support preserving these elements.

vCard Parameters This section contains the conversion rules for vCard parameters.

ALTID The ALTID parameter does not convert to JSContact, but several conversion rules make use of this parameter to combine multiple vCard properties into one JSContact object. For an example of this, see .

AUTHOR The AUTHOR parameter on a NOTE property converts to the "uri" property of the Author object. That Author object is set as the value of the "author" property of the Note object.

AUTHOR-NAME The AUTHOR-NAME parameter on a NOTE property converts to the "name" property of the Author object. That Author object is set as the value of the "author" property of the Note object.

CALSCALE The CALSCALE parameter set on a BDAY, DEATHDATE, or ANNIVERSARY property converts to the "calendarScale" property of the PartialDate object.

CC The CC parameter on an ADR property converts to the "countryCode" property of the Address object.

CREATED The CREATED parameter on a NOTE property converts to the "created" property of the Note object.

DERIVED The DERIVED parameter does not convert to JSContact. If the DERIVED parameter is set to "true" on a vCard property, then implementations MUST NOT convert that property to JSContact.

GEO The GEO parameter set on an ADR property converts to the "coordinates" property of the Address object. Also see the conversion of the GEO property in .

GROUP The GROUP parameter does not convert to JSContact. It exclusively is for use in jCard and MUST NOT be set in a vCard. Preserving the exact group name when converting from vCard to JSContact and back to vCard is not necessary. Any group identifiers will do, as long as the resulting vCard groups its properties equally to the original vCard. Implementations MAY preserve the original group name in the VCardProperty object's "parameters" property (). The following examples illustrate how to convert the GROUP parameter:

Example of How to Preserve the Group Name for a Known Property

Example of How to Preserve the Group Name for an Unknown Property

INDEX The INDEX parameter set on the EXPERTISE, HOBBY, INTEREST, and ORG-DIRECTORY properties converts to the PersonalInfo () and Directory () objects' "listAs" property.

LANGUAGE The LANGUAGE parameter converts to an entry in the Card object's "localizations" property () for that vCard property on which this parameter is set. The value of the LANGUAGE parameter defines the language tag key in the "localizations" property. This specification does not define a single standard conversion rule for how to convert the property values. Instead, building the localizations value is implementation-specific. Implementations that convert to a JSContact profile MUST adhere to the profile-specific restrictions, if any. Two options to populate the "localizations" property are:

One Patch per Property: For each vCard property with a LANGUAGE parameter, set the complete path in the PatchObject to the JSContact property that the vCard property converts to. The value of the patch is the converted property value. This is simple to process and adequate if the vCard only contains a few properties with the LANGUAGE parameter.
Bundle Patches by Parent: If a PatchObject contains multiple paths that have the same parent paths, then it might be possible to combine these patches into one patch that patches the parent property. This is possible if the property in the Card is patched in its entirety.

Generally, localizations only localize properties that are present in the non-localized version of this Card. illustrates this. The following examples illustrate how to convert the LANGUAGE parameter:

LANGUAGE Conversion Example: One Dominant Language As a special case, if one or more vCard properties of the same type do not have the LANGUAGE parameter set, add them to the non-localized Card. Convert any with LANGUAGE parameters to the "localizations" property. illustrates this.

LANGUAGE Conversion Example: Property without Language

LABEL The LABEL parameter on an ADR property converts to the "full" property of the Address object.

LEVEL The LEVEL parameter converts to the "level" property of the PersonalInfo object. If this parameter is set on the EXPERTISE property, then its values convert as follows:

"beginner" converts to "low";
"average" converts to "medium"; and
"expert" converts to "high".

In all other cases, the values convert verbatim, but lowercase MUST be used for the JSContact value.

MEDIATYPE The MEDIATYPE parameter converts to the "mediaType" property of the Resource object.

PHONETIC The PHONETIC parameter converts to the Name () and Address () objects' "phoneticSystem" property unless the parameter value is "script", in which case the "phoneticSystem" property is not set. The value of the SCRIPT parameter converts to the "phoneticScript" property (see ). The related N or ADR property is defined by the vCard ALTID parameter. The conversion rules for the N and ADR properties define how the vCard components convert to JSContact. The component values of the property on which the PHONETIC parameter is set, convert to the respective NameComponent or AddressComponent objects' "phonetic" properties. If more than one property has the PHONETIC parameter set and relates to the same property, then they convert to the Card object's "localizations" property according to their LANGUAGE parameter values as outlined in . The following example illustrates how to convert the PHONETIC parameter:

PHONETIC Conversion Example

PID The PID parameter does not convert to JSContact.

PREF The PREF parameter converts to the "pref" property of that JSContact object, to which the vCard property having this parameter converts.

PROP-ID The PROP-ID parameter is deprecated. The JSID parameter replaces it. The PROP-ID parameter MUST be ignored if the JSID parameter is set on the same property. If the JSID parameter is not set, implementations MAY convert the PROP-ID parameter to the key of the JSContact object to which the vCard property converts to. The following example illustrates how to convert the PROP-ID parameter:

PROP-ID Conversion Example

SCRIPT The SCRIPT parameter converts to the Name () or Address () objects' "phoneticScript" property. Also see .

SERVICE-TYPE The SERVICE-TYPE parameter converts to the "service" property of the OnlineService object.

SORT-AS The SORT-AS parameter converts to the Name, Organization, and OrgUnit objects' "sortAs" properties.

TYPE The TYPE parameter either converts to the "contexts" property or the "kind" property, as defined in later sections. If not specified otherwise, the vCard "home" and "work" parameter values convert to the JSContact "private" and "work" contexts, respectively.

TZ The TZ parameter on an ADR property converts to the "timeZone" property of the Address object. Also see the conversion of the TZ property in .

USERNAME The USERNAME parameter converts to the "user" property of the OnlineService object.

VALUE The VALUE parameter does not convert to JSContact.

vCard Properties

ADR The ADR property converts to an Address object. The converted object is set in the "addresses" property of the Card object. The ADR property value converts to the "components" property of the Address object. Each component in the structured value of the ADR property converts to an AddressComponent. The component value converts to the AddressComponent object's "value" property, the component position determines the value of the AddressComponent object's "kind" property as follows: ADR Components Conversion

ADR component	AddressComponent kind	Remarks
post office box	postOfficeBox	recommends that this component not be set.
extended address	apartment	Do not convert if the ADR property value includes extended ADR components defined in .
street address	name	Do not convert if the ADR property value includes extended ADR components defined in .
locality	locality
region	region
postal code	postcode
country	country
apartment	apartment	Defined in .
block	block	Defined in .
building	building	Defined in .
direction	direction	Defined in .
district	district	Defined in .
floor	floor	Defined in .
landmark	landmark	Defined in .
room	room	Defined in .
street number	number	Defined in .
subdistrict	subdistrict	Defined in .

If the JSCOMPS parameter is set and valid, then the Address object's "isOrdered" property value is "true", and the "defaultSeparator" property and any separator name components are set according to the parameter value. The order in the "components" property MUST adhere to the order of the JSCOMPS parameter value. If the JSCOMPS parameter is not set, then the Address object's "isOrdered" property value is "false", and the "defaultSeparator" property MUST NOT be set. The order in the "components" property MUST follow the order of values in the ADR structured value when read from left to right.

The LABEL parameter converts to the Address object's "full" property.
The GEO parameter converts to the Address object's "coordinates" property.
The TZ parameter converts to the Address object's "timeZone" property.
The CC parameter converts to the Address object's "countryCode" property.

The ADR property converts to the same Address object as the GEO property and TZ property if either they are members of the same vCard property group, or if they are part of no group. The PREF and TYPE parameters convert according to the rules defined in . The ADR-specific values of the TYPE parameter defined in Sections and of convert to the corresponding entries of the "contexts" property as defined in . The ALTID and LANGUAGE parameters convert according to the rules defined in . Each possible language-dependent alternative converts to an entry of the PatchObject where the key references the "full" property. The path of the ADR property in the "convertedProperties" property is "addresses/{id}/components", where "{id}" denotes the identifier of the Address object. The following example illustrates how to convert the ADR property:

ADR Conversion Example See for examples of how to use the JSCOMPS parameter for structured property values.

ANNIVERSARY The ANNIVERSARY property converts to an Anniversary object. The converted object is set in the "anniversaries" property of the Card object. The ANNIVERSARY property value converts to the "date" property of the Anniversary object. The Anniversary "kind" is "wedding". See how to convert property values of type TIMESTAMP and DATE. The following example illustrates how to convert the ANNIVERSARY property:

ANNIVERSARY Conversion Example

BDAY The BDAY property converts to an Anniversary object. The converted object is set in the "anniversaries" property of the Card object. The BDAY property value converts to the "date" property of the Anniversary object. The Anniversary "kind" is "birth". If the property value type is DATE and defines at least a year or a month and day, then the value converts to a PartialDate object. If the property value type is TIMESTAMP then the value converts to the Timestamp object's "utc" property. Otherwise it does not convert to JSContact. A BDAY property and the BIRTHPLACE property (see ) convert to the same Anniversary object if their ALTID parameter values match or are not set on either property. The following example illustrates how to convert the BDAY property:

BDAY Conversion Example

BIRTHPLACE The BIRTHPLACE property converts to an Anniversary object. The converted object is set in the "anniversaries" property of the Card object. The BIRTHPLACE property value converts to the "place" property of the Anniversary object. The Anniversary "kind" is "birth". The BIRTHPLACE and the BDAY property can convert to the same Anniversary object, see . The property value converts to an Address object. If the property value is of type TEXT it converts to the "full" property of the Address object. If the property value is of type URI and uses the "geo:" URI scheme then it converts to the "coordinates" property of the Address object. A property having any other value does not convert to an Anniversary object. The path of the BIRTHPLACE property in the "convertedProperties" property is "anniversaries/{id}/place", where "{id}" denotes the identifier of the Anniversary object.

CALADRURI The CALADRURI property converts to a SchedulingAddress object. The converted object is set in the "schedulingAddresses" property of the Card object. The CALADRURI property value converts to the "uri" property of the SchedulingAddress object. The PREF parameter converts according to the rules defined in . The following example illustrates how to convert the CALADRURI property:

CALADRURI Conversion Example

CALURI The CALURI property converts to a Calendar object. The converted object is set in the "calendars" property of the Card object. The "kind" property of the Calendar object is set to "calendar". The CALURI property value converts to the "uri" property of the Calendar object. The PREF and TYPE parameters convert according to the rules defined in . The following example illustrates how to convert the CALURI property:

CALURI Conversion Example

CATEGORIES The CATEGORIES property converts to the "keywords" property of the Card object. Each text value of the CATEGORIES property becomes a key in the "keywords" property. The PREF parameter does not convert to JSContact; implementations MAY insert the keywords by order of preference. The path of the CATEGORIES property in the "convertedProperties" property is "keywords". Because more than one vCard property can convert to the "keywords" property, preserving conversion information for a single CATEGORIES property is implementation-specific. The following example illustrates how to convert the CATEGORIES property:

CATEGORIES Conversion Example

CLIENTPIDMAP The CLIENTPIDMAP property does not convert to JSContact.

CONTACT-URI The CONTACT-URI property converts to a Link object. The converted object is set in the "links" property of the Card object. The "kind" property of the Link object is set to "contact". The CONTACT-URI property value converts to the "uri" property of the Link object. The PREF and TYPE parameters convert according to the rules defined in . The following example illustrates how to convert the CONTACT-URI property:

CONTACT-URI Conversion Example

CREATED The CREATED property converts to the "created" property of the Card object. The following example illustrates how to convert the CREATED property:

CREATED Conversion Example

EMAIL The EMAIL property converts to an EmailAddress object. The converted object is set in the "emails" property of the Card object. The EMAIL property value converts to the "address" property of the EmailAddress object. The PREF and TYPE parameters convert according to the rules defined in . The following example illustrates how to convert the EMAIL property:

EMAIL Conversion Example

DEATHDATE The DEATHDATE property converts to an Anniversary object. The converted object is set in the "anniversaries" property of the Card object. The DEATHDATE property value converts to the "date" property of the Anniversary object. The Anniversary "kind" is "death". See how to convert property values of type TIMESTAMP and DATE. A DEATHDATE property and the DEATHPLACE property (see ) convert to the same Anniversary object if their ALTID parameter values match or are not set on either property. The following example illustrates how to convert the DEATHDATE property:

DEATHDATE Conversion Example

DEATHPLACE The DEATHPLACE property converts to an Anniversary object. The converted object is set in the "anniversaries" property of the Card object. The DEATHPLACE property value converts to the "place" property of the Anniversary object. The Anniversary "kind" is "death". The DEATHPLACE and the DEATHDATE property can convert to the same Anniversary object, see . The property value converts to an Address object. If the property value is of type TEXT it converts to the "full" property of the Address object. If the property value is of type URI and uses the "geo:" URI scheme then it converts to the "coordinates" property of the Address object. A property having any other value does not convert to an Anniversary object. The path of the DEATHPLACE property in the "convertedProperties" property is "anniversaries/{id}/place", where "{id}" denotes the identifier of the Anniversary object.

EXPERTISE The EXPERTISE property converts to a PersonalInfo object. The converted object is set in the "personalInfo" property of the Card object. The "kind" property of the PersonalInfo object is set to "expertise". The EXPERTISE property value converts to the "value" property of the PersonalInfo object. The INDEX and LEVEL parameters convert according to the rules defined in . The following example illustrates how to convert the EXPERTISE property:

EXPERTISE Conversion Example

FBURL The FBURL property converts to a Calendar object. The converted object is set in the "calendars" property of the Card object. The "kind" property of the Calendar object is set to "freeBusy". The FBURL property value converts to the "uri" property of the Calendar object. The PREF and TYPE parameters convert according to the rules defined in . The following example illustrates how to convert the FBURL property:

FBURL Conversion Example

FN The FN property converts to the Name object in the "name" property of the Card object. The FN property value converts to the "full" property of the Name object. If the LANGUAGE parameter is set, then the FN property converts as outlined in . In the unexpected case where the vCard contains more than one FN property without the LANGUAGE parameter, convert the FN property that has the least parameters. If multiple such FN properties are present, choose any of them. All other FN properties do not convert to JSContact. Implementations MAY convert them to the VCard object's "properties" property (). The path of the FN property in the "convertedProperties" property is "name/full". The following example illustrates how to convert the FN property:

FN Conversion Example

GENDER The GENDER property does not convert to JSContact. Note that the Card object's "speakToAs" property defines how to address and refer to an individual represented by the Card, as do the newly defined vCard GRAMGENDER and PRONOUNS properties of .

GEO The GEO property converts to an Address object. The converted object is set in the "addresses" property of the Card object. The GEO property value converts to the "coordinates" property of the Address object. See how to convert the GEO property together with the ADR and TZ property. The path of the GEO property in the "convertedProperties" property is "addresses/{id}/coordinates", where "{id}" denotes the identifier of the Address object.

GRAMGENDER The GRAMGENDER property converts to the SpeakToAs object. The converted object is set in the "speakToAs" property of the Card object. The GRAMGENDER property value converts to the "grammaticalGender" property of the SpeakToAs object. The following example illustrates how to convert the GRAMGENDER property:

GRAMGENDER Conversion Example

HOBBY The HOBBY property converts to a PersonalInfo object. The converted object is set in the "personalInfo" property of the Card object. The "kind" property of the PersonalInfo object is set to "hobby". The HOBBY property value converts to the "value" property of the PersonalInfo object. The INDEX and LEVEL parameters convert according to the rules defined in . The following example illustrates how to convert the HOBBY property:

HOBBY Conversion Example

IMPP The IMPP property converts to an OnlineService object. The converted object is set in the "onlineServices" property of the Card object. The IMPP property value converts to the "uri" property of the OnlineService object. The SERVICE-TYPE, USERNAME, PREF, and TYPE parameters convert according to the rules defined in . Implementations MAY use the "vCard" property to indicate that the OnlineService object was converted from the IMPP property. The following example illustrates how to convert the IMPP property:

IMPP Conversion Example

INTEREST The INTEREST property converts to a PersonalInfo object. The converted object is set in the "personalInfo" property of the Card object. The "kind" property of the PersonalInfo object is set to "interest". The INTEREST property value converts to the "value" property of the PersonalInfo object. The INDEX and LEVEL parameters convert according to the rules defined in . The following example illustrates how to convert the INTEREST property:

INTEREST Conversion Example

KEY The KEY property converts to a CryptoKey object. The converted object is set in the "cryptoKeys" property of the Card object. The KEY property value converts to the "uri" property of the CryptoKey object. The PREF and TYPE parameters convert according to the rules defined in . The following example illustrates how to convert the KEY property:

KEY Conversion Example

KIND The KIND property converts to the "kind" property of the Card object. Allowed values are those described in and extended with the values declared in and . The following example illustrates how to convert the KIND property:

KIND Conversion Example

LANG The LANG property converts to a LanguagePref object. The converted object is set in the "preferredLanguages" property of the Card object. The LANG property value converts to the "language" property of the LanguagePref object. The PREF and TYPE parameters convert according to the rules defined in . The following example illustrates how to convert the LANG property:

LANG Conversion Example

LANGUAGE The LANGUAGE property converts to the "language" property of the Card object. The following example illustrates how to convert the LANGUAGE property:

LANGUAGE Conversion Example

LOGO The LOGO property converts to a Media object. The converted object is set in the "media" property of the Card object. The "kind" property of the Media object is set to "logo". The LOGO property value converts to the "uri" property of the Media object. The PREF and TYPE parameters convert according to the rules defined in . The following example illustrates how to convert the LOGO property:

LOGO Conversion Example

MEMBER The MEMBER property converts to the "members" property of the Card object. The MEMBER property value becomes a key in the "members" property. defines the MEMBER property value type to be URI only, but extends its definition to also allow free-form text. The PREF parameter does not convert to JSContact. Implementations MAY use the "vCard" property to preserve the value type of the MEMBER property. The path of the MEMBER property in the "convertedProperties" property is "members/{value}", where "{value}" denotes the MEMBER property value. The following examples illustrate how to convert the MEMBER property:

Converting the MEMBER Property

Converting the MEMBER Property with text value

N The N property converts to the Name object in the "name" property of the Card object. The N property value converts to the "components" property of the Name object. Each component in the structured value of the N property converts to a NameComponent. The component value converts to the NameComponent object's "value" property, the component position determines the value of the NameComponent object's "kind" property as follows: N Components Conversion

N component	NameComponent kind	Remarks
Family name	surname	Ignore any value that also occurs in the Secondary surname component.
Given name	given
Additional name	given2
Honorific prefix	title
Honorific suffix	credential	Ignore any value that also occurs in the Generation component.
Secondary surname	surname2
Generation	generation

If the JSCOMPS parameter is set, then the Name object's "isOrdered" property value is "true", and the "defaultSeparator" property and any "separator" NameComponent objects are set according to the parameter value. The order in the "components" property MUST adhere to the order of the JSCOMPS parameter value. If the JSCOMPS parameter is not set, then the Name object's "isOrdered" property value is "false", and the "defaultSeparator" property MUST NOT be set. The order in the "components" property MUST follow the order of values in the N structured value when read from left to right. If the SORT-AS parameter is set, then its structured value converts to the Name object's "sortAs" property according to . An empty or non-existent component value indicates that no sort is defined for this kind. The path of the N property in the "convertedProperties" property is "name/components". The following example illustrates how to convert the N property:

N Conversion Example See for examples of how to use the JSCOMPS parameter for structured property values.

NICKNAME The NICKNAME property converts to a Nickname object. The converted object is set in the "nicknames" property of the Card object. The NICKNAME property value converts to the "name" property of the Nickname object. The PREF and TYPE parameters convert according to the rules defined in . The following example illustrates how to convert the NICKNAME property:

NICKNAME Conversion Example

NOTE The NOTE property converts to a Note object. The converted object is set in the "notes" property of the Card object. The NOTE property value converts to the "note" property of the Note object. The ALTID and LANGUAGE parameters convert according to the rules defined in . The following example illustrates how to convert the NOTE property:

NOTE Conversion Example

ORG The ORG property converts to an Organization object. The converted object is set in the "organizations" property of the Card object. The organization name in the ORG property value converts to the "name" property of the Organization object. Any organizational unit names convert to the "units" property. Implementations MAY allow representation of organizational units without the organizational name. In this case, the first component of the ORG value MUST be an empty string (e.g., "ORG:;DepartmentA"). The ALTID and LANGUAGE parameters convert according to the rules defined in . The first item of the comma-separated SORT-AS parameter value converts to the Organization object's "sortAs" property. The subsequent items convert to the "sortAs" property of the corresponding OrgUnit object. The TYPE parameter converts according to the rules defined in . The path of the ORG property in the "convertedProperties" property is "organizations/{id}/name", where "{id}" denotes the identifier of the Organization object. The following example illustrates how to convert the ORG property:

ORG Conversion Example

ORG-DIRECTORY The ORG-DIRECTORY property converts to a Directory object. The converted object is set in the "directories" property of the Card object. The "kind" property of the Directory object is set to "directory". The ORG-DIRECTORY property value converts to the "uri" property of the Directory object. The INDEX, PREF, and TYPE parameters convert according to the rules defined in . The following example illustrates how to convert the ORG-DIRECTORY property:

ORG-DIRECTORY Conversion Example

PHOTO The PHOTO property converts to a Media object. The converted object is set in the "media" property of the Card object. The "kind" property of the Media object is set to "photo". The PHOTO property value converts to the "uri" property of the Media object. The PREF and MEDIATYPE parameters convert according to the rules defined in . The following example illustrates how to convert the PHOTO property:

PHOTO Conversion Example

PRODID The PRODID property converts to the "prodId" property of the Card object. The following example illustrates how to convert the PRODID property:

PRODID Conversion Example

PRONOUNS The PRONOUNS property converts to a Pronouns object (). The converted object is set in the "pronouns" property of the SpeakToAs object, which is set in the "speakToAs" property of the Card object. The PRONOUNS property value converts to the "pronouns" property of the Pronouns object. The following example illustrates how to convert the PRONOUNS property:

PRONOUNS Conversion Example

RELATED The RELATED property converts to the "relatedTo" property of the Card object. The RELATED property value becomes a key in the "relatedTo" property, and the corresponding value is a Relation object. The TYPE parameters convert to the "relation" property of the Relation object. Any other parameters convert as defined in . The path of the RELATED property in the "convertedProperties" property is "relatedTo/{value}", where "{value}" denotes the RELATED property value. The following example illustrates how to convert the RELATED property:

RELATED Conversion Example

REV The REV property converts to the "updated" property of the Card object. The following example illustrates how to convert the REV property:

REV Conversion Example

ROLE The ROLE property converts to a Title object. The converted object is set in the "titles" property of the Card object. The "kind" property of the Title object is set to "role". The ROLE property value converts to the "name" property of the Title object. If the vCard contains an ORG property and either the ROLE and ORG property are not part of a vCard property group, or they are both in the same group, then the "organizationId" property of the Title object is set to the identifier to which the ORG property converts in the "organizations" property of the Card object. The ALTID and LANGUAGE parameters convert according to the rules defined in . The following example illustrates how to convert the ROLE property:

ROLE Conversion Example

SOCIALPROFILE The SOCIALPROFILE property converts to an OnlineService object. The converted object is set in the "onlineServices" property of the Card object. If the SOCIALPROFILE property value is of type URI, then it converts to the "uri" property of the OnlineService object; otherwise it converts to the "user" property. The SERVICE-TYPE, USERNAME, PREF, and TYPE parameters convert according to the rules defined in . Implementations MAY use the "vCard" property to indicate that the OnlineService object was converted from the SOCIALPROFILE property. The following example illustrates how to convert the SOCIALPROFILE property:

SOCIALPROFILE Conversion Example

SOUND The SOUND property converts to a Media object. The converted object is set in the "media" property of the Card object. The "kind" property of the Media object is set to "sound". The SOUND property value converts to the "uri" property of the Media object. The PREF and TYPE parameters convert according to the rules defined in . The following example illustrates how to convert the SOUND property:

SOUND Conversion Example

SOURCE The SOURCE property converts to a Directory object. The converted object is set in the "directories" property of the Card object. The "kind" property of the Directory object is set to "entry". The SOURCE property value converts to the "uri" property of the Directory object. The PREF and MEDIATYPE parameters convert according to the rules defined in . The following example illustrates how to convert the SOURCE property:

SOURCE Conversion Example

TEL The TEL property converts to a Phone object. The converted object is set in the "phones" property of the Card object. The TEL-specific values of the TYPE parameter convert to the "features" property keys as outlined in . Note that defines the default type to be "voice", but the default Phone object's "features" property is absent by default. Accordingly, an implementation SHOULD only set the Phone object's "features" property if the TEL property actually has a TEL-specific TYPE parameter set. TEL TYPE Conversion

TYPE value	Phone feature
cell	mobile
fax	fax
main-number	main-number
pager	pager
text	text
textphone	textphone
video	video
voice	voice

The TEL property value converts to the "number" property of the Phone object. The PREF and TYPE parameters convert according to the rules defined in . The following example illustrates how to convert the TEL property:

TEL Conversion Example

TITLE The TITLE property converts to a Title object. The converted object is set in the "titles" property of the Card object. The TITLE property value converts to the "name" property of the Title object. The same rules as in apply for setting the Title object's "organizationId" property. The ALTID and LANGUAGE parameters convert according to the rules defined in . The following example illustrates how to convert the TITLE property:

TITLE Conversion Example

TZ The TZ property converts to an Address object. The converted object is set in the "addresses" property of the Card object. The TZ property value converts to the "timeZone" property of the Address object. See how to convert the TZ property together with the ADR and GEO property. A value of type TEXT converts verbatim. A value of type UTC-OFFSET converts if the offset has zero minutes and the hour offset is between -12 and +14, both inclusively:

If the hour offset is zero, use the time zone name "Etc/UTC".
Otherwise, construct the time zone name with "Etc/GMT" suffixed with the string representation of the reversed sign hour offset, including the sign but excluding leading zeros and minutes. For example, the UTC offset value "-0500" converts to "Etc/GMT+5".

Any other UTC-OFFSET property value, or any other value type, does not convert to JSContact. The path of the TZ property in the "convertedProperties" property is "addresses/{id}/timeZone", where "{id}" denotes the identifier of the Address object.

UID The UID property converts to the "uid" property of the Card object. Implementations MAY use the "vCard" property to preserve the value type of the UID property. The following examples illustrate how to convert the UID property:

UID Conversion Example

UID Conversion Example with Value Type

URL The URL property converts to a Link object. The converted object is set in the "links" property of the Card object. The URL property value converts to the "uri" property of the Link object. The PREF and TYPE parameters convert according to the rules defined in . The following example illustrates how to convert the URL property:

URL Conversion Example

VERSION The VERSION property does not convert to JSContact.

X-ABLabel The X-ABLabel property is experimental but widely in use in existing vCard data. The X-ABLabel property is preceded by a vCard property group name, and it converts to the JSContact object that was converted from a vCard property of the same group. The X-ABLabel property value converts to the "label" property of that object. The group name is not preserved; implementations are free to choose any unique group name when converting back to vCard. For an example on how to preserve the group name, see . The path of the X-ABLabel property in the "convertedProperties" property is "*/label", where "*" denotes the path of the object on which the label is set. The following example illustrates how to convert the X-ABLabel property:

X-ABLabel Conversion Example

XML The XML property does not convert to JSContact.

Converting JSContact to vCard This section defines the conversion rules for each JSContact object type. Each subsection lists the properties of one object type and the relevant document sections for their conversion to vCard.

Address The Address object converts to the ADR property. Each AddressComponent object in the "components" property converts to a component in the structured value of the ADR property. AddressComponent conversion

AddressComponent kind	ADR component	Remarks
apartment	apartment	, and remarks below
block	block	, and remarks below
building	building	, and remarks below
country	country
direction	direction	, and remarks below
district	district	, and remarks below
floor	floor	, and remarks below
landmark	landmark	, and remarks below
locality	locality
name	street address	, and remarks below
number	street number	, and remarks below
postcode	postal code
postOfficeBox	post office box
region	region
room	room	, and remarks below
subdistrict	subdistrict	, and remarks below

Remarks:

In addition to setting the "block", "direction", "district", "landmark", "name", "number", and "subdistrict" components, implementations MAY combine these values to set the "street address" component in the ADR property value.
In addition to setting the "apartment", "building", "floor" and "room" components, implementations MAY combine these values to set the "extended address" component in the ADR property value.

The other properties convert as follows: Properties of the Address object

Name	Parameter (or other)	See
contexts	TYPE
coordinates	GEO	Sections and , and remarks below
countryCode	CC
defaultSeparator	JSCOMPS
full	LABEL
isOrdered	JSCOMPS
phoneticScript	SCRIPT
phoneticSystem	PHONETIC
pref	PREF
timeZone	TZ	Sections and , and remarks below

Remarks:

The "coordinates" and "timeZone" properties SHOULD convert to the GEO and TZ parameters, but implementations MAY alternatively convert them to the same-named properties e.g. to preserve original vCard data.

Other properties MAY be converted to JSPROP properties.

Anniversary The Anniversary object converts to one of the following properties, determined by the Anniversary object's "kind" property value:

If the "kind" is "wedding" and the Anniversary object's "date" property is set, then it converts to the ANNIVERSARY property. How to convert the "place" property is implementation-specific.
If the "kind" is "birth", then the "date" property value converts to the BDAY property and the "place" property converts to the BIRTHPLACE property.
If the "kind" is "death", then the "date" property value converts to the DEATHDATE property and the "place" property converts to the DEATHPLACE property.

A "date" property value of type PartialDate converts to the DATE property value type. The "calendarScale" property converts to the CALSCALE parameter. A "date" property value of type Timestamp converts to the TIMESTAMP property value type by converting the "utc" property. How to convert a "place" property value having any Address property other than the "full" property set is implementation-specific. Other properties MAY be converted to JSPROP properties.

Calendar The Calendar object converts to one of the following properties, determined by the Calendar object's "kind" property value. If the "kind" is "calendar" then it converts to the CALURI property. If the "kind" is "freeBusy" then it converts to the FBURL property. Its "uri" property converts to the property value. Its other properties convert as follows: Properties of the Calendar object

Name	Reference	Parameter (or other)	See
contexts		TYPE
label		X-ABLabel (Property)
mediaType		MEDIATYPE
pref		PREF

Other properties MAY be converted to JSPROP properties.

Card The Card object converts to a vCard. Its properties other than the "localizations" property convert as follows: Properties of the Card object

Name	Property (or Parameter)	See
addresses	ADR	Address object
anniversaries	ANNIVERSARY	Anniversary object
calendars	CALURI, FBURL	Calendar object
created	CREATED
cryptoKeys	KEY	CryptoKey object
directories	SOURCE, ORG-DIRECTORY	Directory object
emails	EMAIL	EmailAddress object
keywords	CATEGORIES
kind	KIND
language	LANGUAGE
links	CONTACT-URI, URL	Link object
media	PHOTO, LOGO, SOUND	Media object
members	MEMBER
name	N	Name object
nicknames	NICKNAME	Nickname object
notes	NOTE	Note object
onlineServices	IMPP, SOCIALPROFILE	OnlineService object
organizations	ORG	Organization object
personalInfo	EXPERTISE, HOBBY, INTEREST	PersonalInfo object
phones	TEL	Phone object
preferredLanguages	LANG
prodId	PRODID
relatedTo	RELATED
schedulingAddresses	CALADRURI	SchedulingAddress object
speakToAs	GRAMGENDER, PRONOUNS	SpeakToAs object
titles	TITLE	Title object
uid	UID
updated	REV

The Card object's "@type" and "version" properties do not convert to a vCard property; a vCard generated from a Card always has a VERSION property value of "4.0" (see ). The "localizations" property converts by converting the properties in the PatchObject using the same rules as outlined in . The LANGUAGE parameter MUST be set on each resulting property with the parameter value being the language key of the "localizations" property. The ALTID parameter MUST be set and its value be equal for all properties having the same JSON pointer path in the "localizations" property and the non-localized Card. Other properties MAY be converted to JSPROP properties.

CryptoKey The CryptoKey object converts to the KEY property. Its "uri" property converts to the property value. Its other properties convert as follows: Properties of the CryptoKey object

Name	Reference	Parameter (or other)	See
contexts		TYPE
label		X-ABLabel (Property)
mediaType		MEDIATYPE
pref		PREF

Other properties MAY be converted to JSPROP properties.

Directory The Directory object converts to one of the following properties, determined by the Directory object's "kind" property value. If the "kind" is "entry" then it converts to the SOURCE property. If the "kind" is "directory" then it converts to the ORG-DIRECTORY property. Its "uri" property converts to the property value. Its other properties convert as follows: Properties of the Directory object

Name	Reference	Parameter (or other)	See
contexts		TYPE
label		X-ABLabel (Property)
listAs		INDEX
mediaType		MEDIATYPE
pref		PREF

Other properties MAY be converted to JSPROP properties.

EmailAddress The EmailAddress object converts to the EMAIL property. Its "address" property converts to the property value. Its other properties convert as follows: Properties of the EmailAddress object

Name	Reference	Parameter (or other)	See
contexts		TYPE
label		X-ABLabel (Property)
pref		PREF

Other properties MAY be converted to JSPROP properties.

LanguagePref The LanguagePref object converts to the LANG property. Its "language" property converts to the property value. Its other properties convert as follows: Properties of the LanguagePref object

Name	Reference	Parameter (or other)	See
contexts		TYPE
pref		PREF

Other properties MAY be converted to JSPROP properties.

Link The Link object converts to one of the following properties, determined by the Link object's "kind" property value. If the "kind" property is not set then it converts to the URL property. If the "kind" is "contact" then it converts to the CONTACT-URI property. Its "uri" property converts to the property value. Its other properties convert as follows: Properties of the Link object

Name	Reference	Parameter (or other)	See
contexts		TYPE
label		X-ABLabel (Property)
mediaType		MEDIATYPE
pref		PREF

Other properties MAY be converted to JSPROP properties.

Media The Media object converts to one of the following properties, determined by the Media object's "kind" property value. If the "kind" is "photo" then it converts to the PHOTO property. If the "kind" is "logo" then it converts to the LOGO property. If the "kind" is "sound" then it converts to the SOUND property. Its "uri" property converts to the property value. Its other properties convert as follows: Properties of the Media object

Name	Reference	Parameter (or other)	See
contexts		TYPE
label		X-ABLabel (Property)
mediaType		MEDIATYPE
pref		PREF

Other properties MAY be converted to JSPROP properties.

Name The Name object converts to the N property. Each NameComponent object in the "components" property converts to a component in the structured value of the N property. NameComponent conversion

NameComponent kind	N component	Remarks
credential	Honorific suffix
generation	Generation	, and remarks below
given	Given name
given2	Additional name
surname	Family name
surname2	Secondary surname	, and remarks below
title	Honorific prefix

Remarks:

In addition to converting the "generation" kind to the "Generation" component, implementations MAY also append the value to the "Honorific Suffixes" component of the N property value.
In addition to converting the "surname2" kind to the "Secondary surname" component, implementations MAY also append the value to the "Surname" component of the N property value.

The "full" property converts to the FN property. The "full" property is optional, but the FN property is defined to be mandatory in . How to set the FN property if the "full" property is not set is implementation-specific. Implementations MAY derive the full name from the NameComponents objects. If the "isOrdered" property value is "true", then this can be done by concatenating the name component values. Alternatively, an implementation can choose any other heuristic to generate the full name from its components such as . If the FN property value is derived, implementations SHOULD set the DERIVED parameter. The other properties convert as follows: Properties of the Name object

Name	Reference	Parameter (or other)	See
defaultSeparator		JSCOMPS
phoneticScript		SCRIPT
phoneticSystem		PHONETIC
isOrdered		JSCOMPS
sortAs		SORT-AS

Other properties MAY be converted to JSPROP properties.

Nickname The Nickname object converts to NICKNAME property. Its "name" property converts to the property value. Its other properties convert as follows: Properties of the Nickname object

Name	Reference	Parameter (or other)	See
contexts		TYPE
pref		PREF

Other properties MAY be converted to JSPROP properties.

Note The Note object converts to the NOTE property. Its "note" property converts to the property value. The Author object set as the value of its "author" property converts as follows: Properties of the Author object

Name	Reference	Parameter (or other)	See
name		AUTHOR-NAME
uri		AUTHOR

Its other properties convert as follows: Properties of the Note object

Name	Reference	Parameter (or other)	See
created		CREATED

Other properties MAY be converted to JSPROP properties.

OnlineService The OnlineService object converts to the IMPP property or SOCIALPROFILE property. Which property to convert to is implementation-specific. Implementations SHOULD preserve the property name indicated in the vCard property. If its "uri" property is set, but neither the user or "service" properties are set, then implementations SHOULD choose IMPP if the "uri" property value is a URI with scheme "xmpp". Its other properties convert as follows: Properties of the OnlineService object

Name	Reference	Parameter (or other)	See
contexts		TYPE
label		X-ABLabel (Property)
pref		PREF
service		SERVICE-TYPE
user		USERNAME

Other properties MAY be converted to JSPROP properties.

Organization The Organization object converts to the ORG property. Its "name" property converts to the first component in the structured property value. The "name" property of any OrgUnit object in its "units" property converts to additional components in the structured property value, in order of appearance. Its "sortAs" property converts to the first component in the structured value of the SORT-AS parameter. The "sortAs" property of any OrgUnit object in its "units" property converts to additional components in the structured parameter value, in order of appearance. Its other properties convert as follows: Properties of the Organization object

Name	Reference	Parameter (or other)	See
contexts		TYPE

Other properties MAY be converted to JSPROP properties.

PersonalInfo The PersonalInfo object converts to one of the following properties, determined by the PersonalInfo object's "kind" property value. If the "kind" is "expertise" then it converts to the EXPERTISE property. If the "kind" is "hobby" then it converts to the HOBBY property. If the "kind" is "interest" then it converts to the INTEREST property. Its "value" property converts to the property value. Its other properties convert as follows: Properties of the PersonalInfo object

Name	Reference	Parameter (or other)	See
label		X-ABLabel (Property)
listAs		INDEX
level		LEVEL

Other properties MAY be converted to JSPROP properties.

Phone The Phone object converts to the TEL property Its "number" property converts to the property value. Its other properties convert as follows: Properties of the Phone object

Name	Reference	Parameter (or other)	See
contexts		TYPE
features		TYPE
label		X-ABLabel (Property)
pref		PREF

Other properties MAY be converted to JSPROP properties.

SchedulingAddress The SchedulingAddress object converts to the CALADRURI property. Its "uri" property converts to the property value. Its other properties convert as follows: Properties of the SchedulingAddress object

Name	Reference	Parameter (or other)	See
contexts		TYPE
label		X-ABLabel (Property)
pref		PREF

Other properties MAY be converted to JSPROP properties.

SpeakToAs The SpeakToAs object converts to the GRAMGENDER property and PRONOUNS property. Its "grammaticalGender" property converts to the property value of the GRAMGENDER property. Its "pronouns" property converts to PRONOUNS properties, one for each entry. The Pronouns object's "pronouns" property converts to the property value. Its other properties convert as follows: Properties of the Pronouns object

Name	Reference	Parameter (or other)	See
contexts		TYPE
pref		PREF

Other properties MAY be converted to JSPROP properties.

Title The Title object converts to one of the following properties, determined by the Title object's "kind" property value. If the "kind" is "title" or not set then it converts to the TITLE property. If the "kind" is "role" then it converts to the ROLE property. Its "name" property converts to the property value. Its "organizationId" property converts by assigning the TITLE property and the ORG property to the same vCard property group (see ). Other properties MAY be converted to JSPROP properties.

Updates to JSContact

New Properties

vCard

Name:

vCard

Context:

A Card object

Type:

VCard (optional)

Description

This property contains information about vCard data that got converted to a JSContact Card object. It allows for preserving arbitrary vCard elements, such as extension properties and parameters. This specification defines the VCard object type for converting a vCard to a JSContact Card object. Future specifications MAY define additional value types for this property. A VCard object has the following properties:

@type: String: This specifies the type of this object. This MUST be VCard, if set.
convertedProperties: String[VCardProperty] (optional): This contains conversion-related information about the vCard properties that got partially or fully converted to JSContact. Each key defines the path to a JSContact element. The value for each key contains information about the vCard property which converted to the JSContact element located at that key. Unless otherwise defined for a specific vCard property, the path points to the JSContact property that the vCard property value converts to (e.g., see ). A path MUST NOT point to or into the "localizations" property, but a localization MAY contain its own "vCard" property or patch the "vCard" property of the non-localized Card object. The key MUST be a valid key of a PatchObject as defined in . The key MAY point into a nested object.
properties: *[][] (optional): This contains properties of the vCard which did not convert to standard JSContact elements. The value MUST be a list of vCard properties formatted in jCard as defined in .

A VCardProperty object has the following properties:

@type: String: This specifies the type of this object. This MUST be VCardProperty, if set.
name: String (mandatory): This is the name of the vCard property in lowercase.
valueType: String (optional): This is the name of the vCard property value type in lowercase.
parameters: String[String|String[]] (optional): This contains parameters of the vCard property. The value MUST comply with vCard parameters formatted in jCard as defined in .

The example in describes how to convert unknown vCard elements to the "vCard" property. The "X-FOO" parameter set on the FN property illustrates how to preserve an unknown vCard parameter on a property that does convert to a standard JSContact element. The "X-BAR" property and "X-BAZ" component illustrate how to convert entirely unknown vCard properties.

Converting unknown vCard elements to the vCard property

Updates to vCard

New Parameters

JSCOMPS

Parameter name:

JSCOMPS

Purpose:

Defines the order and separators for the elements of a structured property value.

Description:

The JSCOMPS parameter value facilitates converting name and address components between JSContact and vCard. It preserves the order of the components of the JSContact property and contains the verbatim values of separator components. If this parameter is set and its value is valid (see later), then implementations MUST set the "isOrdered" property of the Name or Address object to "true". Otherwise, they MUST set the "isOrdered" property value to "false". The JSCOMPS parameter value is a structured type value. Its value MUST be quoted. The parameter value consists of a sequence of entries, separated by the SEMICOLON character (U+003B). The first entry defines the value of the "defaultSeparator" property. If it is the empty string, then no default separator is defined. Otherwise, the first entry MUST be a separator entry. All following entries processed in order result in an ordered list of JSContact components and MUST be one of the following two kinds:

A positional. This refers to a component value in the vCard structured value. A position consists of the numeric index of a component in the structured value, optionally followed by a COMMA (U+002C) character and the non-zero index of a value within that component. The zero index selects the first component or value, respectively. The second index is zero by default, in which case it MUST be omitted (as well as the leading COMMA). The resulting JSContact component is formed by determining its kind by the position in the vCard structured value. The component value is the verbatim value of the vCard component. Figures and illustrate this by example.
A separator. This contains the verbatim value of a separator component. It starts with the LATIN SMALL LETTER S (U+0073) character, followed by the COMMA (U+002C) character, followed by zero or more "param-value" characters (see ), where the COMMA (U+002C) and SEMICOLON (U+003B) characters MUST be escaped according to the rules defined in . illustrates this by example. The resulting JSContact component is formed by setting its "kind" to "separator" and its value to the verbatim value of the entry.

A JSCOMPS parameter value is valid if and only if:

All indexes in the positional entries refer to an existing component value in the vCard property value.
The count of positional entries equals the count of deduplicated component values. Deduplication is required because some values may occur in both their designated and backwards-compatible components in the vCard property value:
- A value that occurs in both the N property secondary surname component and the family name component only counts once.
- A value that occurs in both the N property generation component and the honorific suffix component only counts once.
- A value in the ADR property street address component does not count if the ADR property value contains a value in one of the new components defined in .
- All other values count once each.

Format definition:

Example(s):

The following example demonstrates the use of positional entries for the name "Jane Doe". The given name is ordered before the surname. No secondary index is required for either positional because both are zero.

Example of a Secondary Positional Index The following example demonstrates a secondary positional index. The "Jr." generation marker only counts once because it occurs in both the designated generation component and the backwards-compatible honorific suffixes component.

Example of Positional Entries The following example demonstrates the use of separator entries for the (shortened for brevity) address "54321 Oak St, Reston". The first entry defines the default separator to be ", ". The second and fourth positional entries are separated with the separator value " ". For backwards compatibility, the street address component of the ADR property contains both the street number and name, but it is not referred to in the JSCOMPS parameter and does not contribute to the count of values.

Example of Separator Entries

JSID

Parameter Name:: JSID
Purpose:: Specifies the JSContact identifier of the associated property.
Description:: This parameter specifies the JSON object key of the JSContact object to which a vCard property converts. For example, this parameter set on an EMAIL property defines the key of the EmailAddress object in the Card object's "emails" property (see below for an example). The value of the JSID parameter MUST be a valid key according to the definition of the JSContact property to which the property that this parameter is set on converts to. Typically, this requires the value to be a valid Id.
Format Definition:
Example(s):: Converting the JSID parameter on an EMAIL property

JSPTR

Parameter name:: JSPTR
Purpose:: To specify a pointer to a JSContact property.
Description:: This parameter is set on a JSPROP property. Its value points to a JSContact property. The parameter has a single value that MUST be a valid PatchObject key as defined in . The parameter value MUST be quoted and is case-sensitive.
Format definition:
Example(s):: For further examples, see .

New vCard Properties

JSPROP

Property name:: JSPROP
Purpose:: Represents a JSContact property in vCard.
Value type:: TEXT; also see "Format definition" below for value restrictions.
Conformance:: Can be specified multiple times in a vCard.
Property parameters:: The JSPTR parameter MUST be set for this property. Other IANA-registered and experimental property parameters can be specified on this property.
Description:: This property converts an arbitrary JSContact property from and to vCard. The vCard property value is the JSON-encoded value of the JSContact property, represented as a TEXT value. The format of the JSON value MUST be compact, e.g., without insignificant whitespace as defined in . The value of the JSPTR parameter points to the JSContact property within the Card. The root of the JSON pointer is always the Card object that this vCard converts to, irrespective if the JSON pointer starts with the SOLIDUS (U+002F) character. The pointer MUST NOT reference into an array. All JSPROP properties in a vCard together form a PatchObject as defined in . The value of its JSPTR parameter corresponds to a key in the PatchObject; the value of the JSPROP property corresponds to the value for that key. When converting from vCard to JSContact, the PatchObject MUST only be applied after all other vCard properties have already been converted. The PatchObject MUST be valid, including the restriction that an invalid PatchObject MUST NOT be applied.
Format definition:: This property is defined by the following notation:
Example(s):: This illustrates how to convert a property at the top level in a Card object that is unknown to the implementation.
Unknown Property Example
This illustrates how to convert a vendor-specific property at the top level of a Card object. Note the required use of quoted string for the JSPTR value, which allows the path to include the COLON (U+003A) character.
Vendor-Specific Property Conversion Example
This illustrates how to convert a vendor-specific property at a nested level in a Card object using a path relative to the Card object. Although not recommended, the property name includes the SOLIDUS (U+002F) character, which requires escaping in the JSON pointer.
Nested Vendor-Specific Property Example with a Path Relative to Card

Security Considerations This specification defines how to convert between the JSContact and vCard formats. The security considerations for parsing and formatting such data apply and are outlined in and .

IANA Considerations This document obsoletes . It registers new elements in the vCard and JSContact registries, updates the reference of entries that originally registered to this document, and obsoletes the JSContact elements that this document replaces.

Changes to the "vCard Element Registries" IANA will add the following entry to the "Parameters" registry:

Parameter: JSID
Reference

IANA will update the Reference to this document for the following entry in the "Properties" registry, which originally registered:

Property: JSPROP
Reference

IANA will update the Reference to this document for the following entries in the "Parameters" registry, which originally registered:

Parameter: JSCOMPS
Reference

Parameter: JSPTR
Reference

Changes to the "JSContact Registries"

"JSContact Properties" Registry IANA will add the following entry to the "JSContact Properties" registry:

Property Name: vCard
Property Type: VCard
Property Context: Card
Reference or Description
Intended Usage: common
Change Controller: IETF

IANA will change the Intended Usage from "common" to "obsolete" for the following entries in the "JSContact Properties" registry, which originally registered. For each entry, the Property Name and its changed fields are listed.

Property Name: vCardProps
Reference or Description
Intended Usage: obsolete

Property Name: vCardParams
Reference or Description
Intended Usage: obsolete

Property Name: vCardName
Reference or Description
Intended Usage: obsolete

"JSContact Types" Registry IANA will add the following entries to the "JSContact Types" registry:

Type Name: VCard
Type Reference
Intended Usage: common
Change Controller: IETF

Type Name: VCardProperty
Type Reference
Intended Usage: common
Change Controller: IETF

IANA will change the Intended Usage from "common" to "obsolete" for the following entry in the "JSContact Types" registry, which originally registered. For each entry, the Type Name and its changed fields are listed.

Type Name: JCardProp
Type Reference
Intended Usage: obsolete

References Normative References JSContact: A JSON Representation of Contact Data vCard Format Extension for JSContact Fastmail IIT-CNR Informative References vObject Internationalization Ribose Ribose Spherical Cow Group Unicode Locale Data Markup Language (LDML) Part 8: Person Names other CLDR committee members

Differences from RFC 9555 This section documents all significant differences from RFC 9555. Insignificant differences, such as formatting, grammar or typos are not documented.

Applied Errata The following errata was applied to this document:

Errata 8555

Changed Conversion Rules

vCard to JSContact

Converting the UID property to the "uid" property is redefined for JSContact version "2.0". See .

Changes to JSContact

Obsoleted Properties The following JSContact properties became obsolete:

vCardProps: This property is deprecated, the "properties" property of the newly defined VCard type replaces it. illustrates this using the same example as.
Example for Representing the Obsolete vCardProps Property

vCardParams: This property is deprecated, the "parameters" property of the newly defined VCardProperty type replaces it. illustrates this using the same example as .
Example for Representing the Obsolete vCardParams Property

vCardName: This property is deprecated, the "name" property of the newly defined VCardProperty type replaces it. illustrates this using the same example as .
Example for Representing the Obsolete vCardName Property

Obsoleted Types The following JSContact type definitions became obsolete:

JCardProp: This type is deprecated because the "vCardProps" property became deprecated. Also see .

Changes to vCard

Obsoleted Parameters The following vCard parameters became obsolete:

PROP-ID: This parameter is deprecated, the newly defined JSID parameter replaces it. defines how to process the PROP-ID in presence and absence of the JSID parameter.

Acknowledgements The definition and examples of the PHONETIC and SCRIPT parameters are based on the initial draft version of .