Calendaring Extensions R. Stepanek Internet-Draft FastMail Intended status: Standards Track M. Loffredo Expires: 27 April 2023 IIT-CNR 24 October 2022 vCard Format Extension for JSContact draft-ietf-calext-vcard-jscontact-extensions-01 Abstract 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. Status of This Memo 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 27 April 2023. Copyright Notice Copyright (c) 2022 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. Stepanek & Loffredo Expires 27 April 2023 [Page 1] Internet-Draft vCard JSContact Extensions October 2022 Table of Contents 1. Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 2. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 2.1. Requirements Language . . . . . . . . . . . . . . . . . . 2 3. New Properties . . . . . . . . . . . . . . . . . . . . . . . 2 3.1. CONTACT-CHANNEL-PREF Property . . . . . . . . . . . . . . 3 3.2. CREATED Property . . . . . . . . . . . . . . . . . . . . 3 3.3. GRAMMATICAL-GENDER Property . . . . . . . . . . . . . . . 4 3.4. LOCALE Property . . . . . . . . . . . . . . . . . . . . . 5 3.5. PRONOUNS Property . . . . . . . . . . . . . . . . . . . . 6 4. New Parameters . . . . . . . . . . . . . . . . . . . . . . . 7 4.1. DERIVED Parameter . . . . . . . . . . . . . . . . . . . . 7 4.2. PROP-ID Parameter . . . . . . . . . . . . . . . . . . . . 8 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 8 6. Security Considerations . . . . . . . . . . . . . . . . . . . 10 7. References . . . . . . . . . . . . . . . . . . . . . . . . . 10 7.1. Normative References . . . . . . . . . . . . . . . . . . 10 7.2. Informative References . . . . . . . . . . . . . . . . . 10 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 10 1. Preface This document is a work in progress. The list of new or updated properties and parameters is likely to be incomplete. This section is removed from the document before publication. 2. Introduction The JSContact [ref-jscontact] format aims to be an alternative to the vCard [RFC6350] format for representation of contact and addressbook 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 [ref-jscontact-vcard] with the goal of not loosing any semantics during conversion. In order to do so, this document defines a new set of properties for vCard and extends existing definitions. 2.1. Requirements Language 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. 3. New Properties Stepanek & Loffredo Expires 27 April 2023 [Page 2] Internet-Draft vCard JSContact Extensions October 2022 3.1. CONTACT-CHANNEL-PREF Property Property name: CONTACT-CHANNEL-PREF Purpose: This property defines which channels the entity associated with this vCard prefers to be contacted with. Value type: A single text value, restricted to an enumerated list of allowed values. Cardinality: * Property parameters: The PREF parameter defines the preference of this contact channel in relation to other contact channels. The TYPE parameter defines when to use this preference. Description: This defines an order of preferences for contact channels. The contact channels supported in this specification are phone numbers, email, instant messaging and postal delivery. They are identified by the name of the respective vCard property. Format definition: This property is defined by the following notation: contact-channel-pref = "CONTACT-CHANNEL-PREF *(";" contact-channel-pref-param ) ":" contact-channel-pref-value CRLF contact-channel-pref-param = type-param / pref-param / any-param contact-channel-pref-value = "ADR" / "EMAIL" / "IMPP" / "TEL" / x-value Example(s): CONTACT-CHANNEL-PREF;PREF=1:EMAIL CONTACT-CHANNEL-PREF;PREF=2:TEL 3.2. CREATED Property Property name: CREATED Purpose: This property defines the date and time when the vCard was created Value type: A single timestamp value. Cardinality: *1 Property parameters: VALUE Stepanek & Loffredo Expires 27 April 2023 [Page 3] Internet-Draft vCard JSContact Extensions October 2022 Description: This is the time stamp when the vCard was created. Copying the vCard across systems does not count as a new creation, nor does a new revision. Instead, the time stamp value typically stays unchanged for the existence of the vCard. Format definition: This property is defined by the following notation: created = "CREATED" createdparam ":" timestamp CRLF createdparam = *( ; ; The following is OPTIONAL, ; but MUST NOT occur more than once. ; (";" "VALUE" "=" "TIMESTAMP") / ; ; The following is OPTIONAL, ; and MAY occur more than once. ; (";" any-param) ; ) Example(s): CREATED:20220705093412Z CREATED;VALUE=TIMESTAMP:20211022T140000-05 3.3. GRAMMATICAL-GENDER Property Property name: GRAMMATICAL-GENDER Purpose: This property defines the grammatical gender that shall be used to address the entity represented by this vCard. Value type: A single text value, restricted to an enumerated list of allowed values. Cardinality: * Property parameters: LANG Description: This property defines the grammatical gender that the contact prefers to be addressed by or referred at. Multiple occurrences of this property are allowed, but SHOULD be distinguished by the LANG parameter. Stepanek & Loffredo Expires 27 April 2023 [Page 4] Internet-Draft vCard JSContact Extensions October 2022 Many human languages use grammatical genders in salutations and other language constructs. For example, the German language typically distinguishes between the grammatical gender of the recipient in salutations. The allowed values for this property aim to cover grammatical genders for the majority of human languages. Future RFCs MAY define additional values if the current selection is found to be inadequate. Format definition: This property is defined by the following notation: gram-gender = "GRAMMATICAL-GENDER" gram-gender-param ":" gram-gender-value CRLF gram-gender-param = *( ; ; The following is OPTIONAL, ; but MUST NOT occur more than once. ; (";" language-param) / ; ; The following is OPTIONAL, ; and MAY occur more than once. ; (";" any-param) ; ) gram-gender-value = "animate" / "female" / "inanimate" / "male" / "neuter" / x-value Example(s): GRAMMATICAL-GENDER:neuter 3.4. LOCALE Property Property name: LOCALE Purpose: This property defines the default locale that human- readable text values in this vCard should be assumed written in. Value type: A single Language-Tag value as defined in Section 4 of [RFC6350]. Stepanek & Loffredo Expires 27 April 2023 [Page 5] Internet-Draft vCard JSContact Extensions October 2022 Cardinality: *1 Property parameters: The LANG parameter MUST NOT be assigned to this property. Description: This property defines the locale in which property values of type TEXT shall be assumed to be written for this vCard. If a vCard property includes the LANG parameter, then the parameter value has higher precendence than the LOCALE property value. Format definition: This property is defined by the following notation: locale = "LOCALE" any-param ":" Language-Tag CRLF ; defined in RFC6350, Section 4. Example(s): LOCALE:de-AT 3.5. PRONOUNS Property Property name: PRONOUNS Purpose: This property defines the pronouns that shall be used to refer to the entity represented by this vCard. Value type: A single text value. Cardinality: * Property parameters: LANG, PREF, TYPE Description: This property contains the pronouns that the contact chooses to use for themselves. The value is free-form text. These pronouns shall be used when addressing or referring to the contact. Multiple occurrences of this property MAY define pronouns for multiple languages, preferences and contexts. Format definition: This property is defined by the following notation: Stepanek & Loffredo Expires 27 April 2023 [Page 6] Internet-Draft vCard JSContact Extensions October 2022 pronouns = "PRONOUNS" pronouns-param ":" text CRLF pronouns-param = *( ; ; The following is OPTIONAL, ; but MUST NOT occur more than once. ; (";" language-param / pref-param / type-param) / ; ; The following is OPTIONAL, ; and MAY occur more than once. ; (";" any-param) ; ) Example(s): PRONOUNS;LANG=en:they/them 4. New Parameters 4.1. DERIVED Parameter Parameter name: DERIVED Purpose: This parameter specifies that the value of the associated property is derived from some other property value or values. Description: This property parameter MAY be specified on any property when the value is derived from some other property or properties. 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. It indicates this by setting the DERIVED parameter on the FN property to true. Format definition: derived-param = "DERIVED" "=" ("true" / "false") ; Default is false Example(s): N:;John;Quinlan;Mr.; FN;DERIVED=TRUE:Mr. John Quinlan Stepanek & Loffredo Expires 27 April 2023 [Page 7] Internet-Draft vCard JSContact Extensions October 2022 4.2. PROP-ID Parameter Parameter name: PROP-ID Purpose: This parameter identifies a property among all its siblings of the same type. Description: This parameter uniquely identifies a property among all of its siblings with the same name within a calendar component. 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. Format definition: prop-id-param = "PROP-ID" "=" 1*255(ALPHA / DIGIT / "-"/ "_") Example(s): PHOTO;PROP-ID=p827:data:image/jpeg;base64,MIICajCCAdOgAwIBAg <...remainder of base64-encoded data...> 5. IANA Considerations IANA is requested to add the following entries to the "vCard Properties" registry, defined in Section 10.3.1. of [RFC6350]. Stepanek & Loffredo Expires 27 April 2023 [Page 8] Internet-Draft vCard JSContact Extensions October 2022 +===========+======================+============================+ | Namespace | Property | Reference | +===========+======================+============================+ | | CONTACT-CHANNEL-PREF | This document, Section 3.1 | +-----------+----------------------+----------------------------+ | | CREATED | This document, Section 3.2 | +-----------+----------------------+----------------------------+ | | GRAMMATICAL-GENDER | This document, Section 3.3 | +-----------+----------------------+----------------------------+ | | LOCALE | This document, Section 3.4 | +-----------+----------------------+----------------------------+ | | PRONOUNS | This document, Section 3.5 | +-----------+----------------------+----------------------------+ Table 1: New VCARD Properties IANA is requested to add the following entries to the "vCard Parameters" registry, defined in Section 10.3.2. of [RFC6350]. +===========+===========+============================+ | Namespace | Parameter | Reference | +===========+===========+============================+ | | PROP-ID | This document, Section 4.2 | +-----------+-----------+----------------------------+ | | DERIVED | This document, Section 4.1 | +-----------+-----------+----------------------------+ Table 2: New VCARD Parameters 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 | +====================+===========+============================+ | GRAMMATICAL-GENDER | animate | This document, Section 3.3 | +--------------------+-----------+----------------------------+ | GRAMMATICAL-GENDER | female | This document, Section 3.3 | +--------------------+-----------+----------------------------+ | GRAMMATICAL-GENDER | inanimate | This document, Section 3.3 | +--------------------+-----------+----------------------------+ | GRAMMATICAL-GENDER | male | This document, Section 3.3 | +--------------------+-----------+----------------------------+ | GRAMMATICAL-GENDER | neuter | This document, Section 3.3 | +--------------------+-----------+----------------------------+ Table 3: New VCARD Property Values Stepanek & Loffredo Expires 27 April 2023 [Page 9] Internet-Draft vCard JSContact Extensions October 2022 6. Security Considerations This section will be completed before IESG Last Call. 7. References 7.1. Normative References [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, March 1997, . [RFC6350] Perreault, S., "vCard Format Specification", RFC 6350, DOI 10.17487/RFC6350, August 2011, . [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, May 2017, . 7.2. Informative References [ref-jscontact] "JSContact: A JSON representation of contact data", . [ref-jscontact-vcard] "JSContact: Converting from and to vCard", . Authors' Addresses Robert Stepanek FastMail PO Box 234, Collins St West Melbourne VIC 8007 Australia Email: rsto@fastmailteam.com Mario Loffredo IIT-CNR Via Moruzzi,1 56124 Pisa Italy Stepanek & Loffredo Expires 27 April 2023 [Page 10] Internet-Draft vCard JSContact Extensions October 2022 Email: mario.loffredo@iit.cnr.it Stepanek & Loffredo Expires 27 April 2023 [Page 11]