idnits 2.17.1 draft-ietf-jmap-jscontact-10.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- == There is 1 instance of lines with non-ascii characters in the document. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- No issues found here. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year == The document seems to lack the recommended RFC 2119 boilerplate, even if it appears to use RFC 2119 keywords. (The document does seem to have the reference to RFC 2119 which the ID-Checklist requires). -- The document date (13 January 2022) is 833 days in the past. Is this intentional? Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) == Missing Reference: 'B' is mentioned on line 199, but not defined == Missing Reference: 'Relation' is mentioned on line 400, but not defined == Missing Reference: 'Boolean' is mentioned on line 986, but not defined == Missing Reference: 'Organization' is mentioned on line 516, but not defined == Missing Reference: 'Title' is mentioned on line 531, but not defined == Missing Reference: 'EmailAddress' is mentioned on line 586, but not defined == Missing Reference: 'Phone' is mentioned on line 609, but not defined == Missing Reference: 'Resource' is mentioned on line 654, but not defined == Missing Reference: 'File' is mentioned on line 698, but not defined == Missing Reference: 'Address' is mentioned on line 760, but not defined == Missing Reference: 'PatchObject' is mentioned on line 858, but not defined == Missing Reference: 'Anniversary' is mentioned on line 889, but not defined == Missing Reference: 'PersonalInformation' is mentioned on line 917, but not defined == Missing Reference: 'TimeZone' is mentioned on line 960, but not defined Summary: 0 errors (**), 0 flaws (~~), 17 warnings (==), 1 comment (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 JMAP R. Stepanek 3 Internet-Draft FastMail 4 Intended status: Standards Track M. Loffredo 5 Expires: 17 July 2022 IIT-CNR 6 13 January 2022 8 JSContact: A JSON representation of contact data 9 draft-ietf-jmap-jscontact-10 11 Abstract 13 This specification defines a data model and JSON representation of 14 contact card information that can be used for data storage and 15 exchange in address book or directory applications. It aims to be an 16 alternative to the vCard data format and to be unambiguous, 17 extendable and simple to process. In contrast to the JSON-based 18 jCard format, it is not a direct mapping from the vCard data model 19 and expands semantics where appropriate. 21 Status of This Memo 23 This Internet-Draft is submitted in full conformance with the 24 provisions of BCP 78 and BCP 79. 26 Internet-Drafts are working documents of the Internet Engineering 27 Task Force (IETF). Note that other groups may also distribute 28 working documents as Internet-Drafts. The list of current Internet- 29 Drafts is at https://datatracker.ietf.org/drafts/current/. 31 Internet-Drafts are draft documents valid for a maximum of six months 32 and may be updated, replaced, or obsoleted by other documents at any 33 time. It is inappropriate to use Internet-Drafts as reference 34 material or to cite them other than as "work in progress." 36 This Internet-Draft will expire on 17 July 2022. 38 Copyright Notice 40 Copyright (c) 2022 IETF Trust and the persons identified as the 41 document authors. All rights reserved. 43 This document is subject to BCP 78 and the IETF Trust's Legal 44 Provisions Relating to IETF Documents (https://trustee.ietf.org/ 45 license-info) in effect on the date of publication of this document. 46 Please review these documents carefully, as they describe your rights 47 and restrictions with respect to this document. Code Components 48 extracted from this document must include Revised BSD License text as 49 described in Section 4.e of the Trust Legal Provisions and are 50 provided without warranty as described in the Revised BSD License. 52 Table of Contents 54 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 55 1.1. Relation to the xCard and jCard formats . . . . . . . . . 4 56 1.2. Terminology . . . . . . . . . . . . . . . . . . . . . . . 4 57 1.3. Vendor-specific Property Extensions and Values . . . . . 4 58 1.4. Type Signatures . . . . . . . . . . . . . . . . . . . . . 5 59 1.5. Data types . . . . . . . . . . . . . . . . . . . . . . . 5 60 1.5.1. Context . . . . . . . . . . . . . . . . . . . . . . . 5 61 1.5.2. Id . . . . . . . . . . . . . . . . . . . . . . . . . 6 62 1.5.3. PatchObject . . . . . . . . . . . . . . . . . . . . . 6 63 1.5.4. Preference . . . . . . . . . . . . . . . . . . . . . 7 64 1.5.5. UnsignedInt . . . . . . . . . . . . . . . . . . . . . 7 65 1.5.6. UTCDateTime . . . . . . . . . . . . . . . . . . . . . 8 66 2. Card . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 67 2.1. Metadata properties . . . . . . . . . . . . . . . . . . . 8 68 2.1.1. @type . . . . . . . . . . . . . . . . . . . . . . . . 8 69 2.1.2. uid . . . . . . . . . . . . . . . . . . . . . . . . . 8 70 2.1.3. prodId . . . . . . . . . . . . . . . . . . . . . . . 8 71 2.1.4. created . . . . . . . . . . . . . . . . . . . . . . . 8 72 2.1.5. updated . . . . . . . . . . . . . . . . . . . . . . . 9 73 2.1.6. kind . . . . . . . . . . . . . . . . . . . . . . . . 9 74 2.1.7. relatedTo . . . . . . . . . . . . . . . . . . . . . . 9 75 2.1.8. language . . . . . . . . . . . . . . . . . . . . . . 10 76 2.2. Name and Organization properties . . . . . . . . . . . . 10 77 2.2.1. name . . . . . . . . . . . . . . . . . . . . . . . . 10 78 2.2.2. fullName . . . . . . . . . . . . . . . . . . . . . . 11 79 2.2.3. nickNames . . . . . . . . . . . . . . . . . . . . . . 11 80 2.2.4. organizations . . . . . . . . . . . . . . . . . . . . 12 81 2.2.5. titles . . . . . . . . . . . . . . . . . . . . . . . 12 82 2.2.6. speakToAs . . . . . . . . . . . . . . . . . . . . . . 12 83 2.3. Contact and Resource properties . . . . . . . . . . . . . 13 84 2.3.1. emails . . . . . . . . . . . . . . . . . . . . . . . 13 85 2.3.2. phones . . . . . . . . . . . . . . . . . . . . . . . 14 86 2.3.3. online . . . . . . . . . . . . . . . . . . . . . . . 15 87 2.3.4. photos . . . . . . . . . . . . . . . . . . . . . . . 15 88 2.3.5. preferredContactMethod . . . . . . . . . . . . . . . 16 89 2.3.6. preferredContactLanguages . . . . . . . . . . . . . . 16 90 2.4. Address and Location properties . . . . . . . . . . . . . 17 91 2.4.1. addresses . . . . . . . . . . . . . . . . . . . . . . 17 92 2.5. Multilingual properties . . . . . . . . . . . . . . . . . 19 93 2.5.1. localizations . . . . . . . . . . . . . . . . . . . . 19 94 2.6. Additional properties . . . . . . . . . . . . . . . . . . 19 95 2.6.1. anniversaries . . . . . . . . . . . . . . . . . . . . 19 96 2.6.2. personalInfo . . . . . . . . . . . . . . . . . . . . 20 97 2.6.3. notes . . . . . . . . . . . . . . . . . . . . . . . . 21 98 2.6.4. categories . . . . . . . . . . . . . . . . . . . . . 21 99 2.6.5. timeZones . . . . . . . . . . . . . . . . . . . . . . 21 100 3. CardGroup . . . . . . . . . . . . . . . . . . . . . . . . . . 21 101 3.1. Group properties . . . . . . . . . . . . . . . . . . . . 21 102 3.1.1. @type . . . . . . . . . . . . . . . . . . . . . . . . 21 103 3.1.2. uid . . . . . . . . . . . . . . . . . . . . . . . . . 21 104 3.1.3. members . . . . . . . . . . . . . . . . . . . . . . . 22 105 3.1.4. name . . . . . . . . . . . . . . . . . . . . . . . . 22 106 3.1.5. card . . . . . . . . . . . . . . . . . . . . . . . . 22 107 4. Implementation Status . . . . . . . . . . . . . . . . . . . . 22 108 4.1. IIT-CNR/Registro.it . . . . . . . . . . . . . . . . . . . 22 109 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 23 110 6. Security Considerations . . . . . . . . . . . . . . . . . . . 23 111 7. References . . . . . . . . . . . . . . . . . . . . . . . . . 23 112 7.1. Normative References . . . . . . . . . . . . . . . . . . 23 113 7.2. Informative References . . . . . . . . . . . . . . . . . 24 114 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 25 116 1. Introduction 118 This document defines a data model for contact card data normally 119 used in address book or directory applications and services. It aims 120 to be an alternative to the vCard data format [RFC6350] and to 121 provide a JSON-based standard representation of contact card data. 123 The key design considerations for this data model are as follows: 125 * Most of the initial set of attributes should be taken from the 126 vCard data format [RFC6350] and extensions ([RFC6473], [RFC6474], 127 [RFC6715], [RFC6869], [RFC8605]). The specification should add 128 new attributes or value types, or not support existing ones, where 129 appropriate. Conversion between the data formats need not fully 130 preserve semantic meaning. 132 * The attributes of the cards data represented must be described as 133 a simple key-value pair, reducing complexity of its 134 representation. 136 * The data model should avoid all ambiguities and make it difficult 137 to make mistakes during implementation. 139 * Extensions, such as new properties and components, MUST NOT lead 140 to requiring an update to this document. 142 The representation of this data model is defined in the I-JSON format 143 [RFC7493], which is a strict subset of the JavaScript Object Notation 144 (JSON) Data Interchange Format [RFC8259]. Using JSON is mostly a 145 pragmatic choice: its widespread use makes Card easier to adopt, and 146 the availability of production-ready JSON implementations eliminates 147 a whole category of parser-related interoperability issues. 149 1.1. Relation to the xCard and jCard formats 151 The xCard [RFC6351] and jCard [RFC7095] specifications define 152 alternative representations for vCard data, in XML and JSON format 153 respectively. Both explicitly aim to not change the underlying data 154 model. Accordingly, they are regarded as equal to vCard in the 155 context of this document. 157 1.2. Terminology 159 The key words MUST, MUST NOT, REQUIRED, SHALL, SHALL NOT, SHOULD, 160 SHOULD NOT, RECOMMENDED, NOT RECOMMENDED, MAY, and OPTIONAL in this 161 document are to be interpreted as described in BCP 14 [RFC2119] 162 [RFC8174] when, and only when, they appear in all capitals, as shown 163 here. 165 1.3. Vendor-specific Property Extensions and Values 167 Vendors MAY add additional properties to the contact object to 168 support their custom features. To avoid conflict, the names of these 169 properties MUST be prefixed by a domain name controlled by the vendor 170 followed by a colon, e.g., "example.com:customprop". If the value is 171 a new JSContact object, it either MUST include an "@type" property, 172 or it MUST explicitly be specified to not require a type designator. 173 The type name MUST be prefixed with a domain name controlled by the 174 vendor. 176 Some JSContact properties allow vendor-specific value extensions. 177 Such vendor-specific values MUST be prefixed by a domain name 178 controlled by the vendor followed by a colon, e.g., 179 "example.com:customrel". 181 Vendors are strongly encouraged to register any new property values 182 or extensions that are useful to other systems as well, rather than 183 use a vendor-specific prefix. 185 1.4. Type Signatures 187 Type signatures are given for all JSON values in this document. The 188 following conventions are used: 190 * * - The type is undefined (the value could be any type, although 191 permitted values may be constrained by the context of this value). 193 * String - The JSON string type. 195 * Number - The JSON number type. 197 * Boolean - The JSON boolean type. 199 * A[B] - A JSON object where the keys are all of type A, and the 200 values are all of type B. 202 * A[] - An array of values of type A. 204 * A|B - The value is either of type A or of type B. 206 1.5. Data types 208 In addition to the standard JSON data types, a couple of additional 209 data types are common to the definitions of JSContact objects and 210 properties. 212 1.5.1. Context 214 Contact information typically is associated with a context in which 215 it should be used. For example, someone might have distinct phone 216 numbers for work and private contexts. The Context data type 217 enumerates common contexts. 219 Common context values are: 221 * private: The contact information may be used to contact the card 222 holder in a private context. 224 * work: The contact information may be used to contact the card 225 holder in a professional context. 227 Additional allowed values may be defined in the properties or data 228 types that make use of the Context data type, registered in a future 229 RFC, or a vendor-specific value. 231 1.5.2. Id 233 Where Id is given as a data type, it means a String of at least 1 and 234 a maximum of 255 octets in size, and it MUST only contain characters 235 from the URL and Filename Safe base64url alphabet, as defined in 236 Section 5 of [RFC4648], excluding the pad character (=). This means 237 the allowed characters are the ASCII alphanumeric characters (A-Za- 238 z0-9), hyphen (-), and underscore (_). 240 In many places in JSContact a JSON map is used where the map keys are 241 of type Id and the map values are all the same type of object. This 242 construction represents an unordered set of objects, with the added 243 advantage that each entry has a name (the corresponding map key). 244 This allows for more concise patching of objects, and, when 245 applicable, for the objects in question to be referenced from other 246 objects within the JSContact object. 248 Unless otherwise specified for a particular property, there are no 249 uniqueness constraints on an Id value (other than, of course, the 250 requirement that you cannot have two values with the same key within 251 a single JSON map). For example, two Card objects might use the same 252 Ids in their respective photos properties. Or within the same Card 253 object the same Id could appear in the emails and phones properties. 254 These situations do not imply any semantic connections among the 255 objects. 257 1.5.3. PatchObject 259 A PatchObject is of type String[*], and represents an unordered set 260 of patches on a JSON object. Each key is a path represented in a 261 subset of JSON pointer format [RFC6901]. The paths have an implicit 262 leading /, so each key is prefixed with / before applying the JSON 263 pointer evaluation algorithm. 265 A patch within a PatchObject is only valid if all of the following 266 conditions apply: 268 1. The pointer MUST NOT reference inside an array (i.e., you MUST 269 NOT insert/delete from an array; the array MUST be replaced in 270 its entirety instead). 272 2. All parts prior to the last (i.e., the value after the final 273 slash) MUST already exist on the object being patched. 275 3. There MUST NOT be two patches in the PatchObject where the 276 pointer of one is the prefix of the pointer of the other, e.g., 277 addresses/1/city and addresses. 279 4. The value for the patch MUST be valid for the property being set 280 (of the correct type and obeying any other applicable 281 restrictions), or if null the property MUST be optional. 283 The value associated with each pointer determines how to apply that 284 patch: 286 * If null, remove the property from the patched object. If the key 287 is not present in the parent, this a no-op. 289 * If non-null, set the value given as the value for this property 290 (this may be a replacement or addition to the object being 291 patched). 293 A PatchObject does not define its own @type property. Instead, a 294 @type property in a patch MUST be handled as any other patched 295 property value. 297 Implementations MUST reject in its entirety a PatchObject if any of 298 its patches is invalid. Implementations MUST NOT apply partial 299 patches. 301 1.5.4. Preference 303 This data type allows to define a preference order on same-typed 304 contact information. For example, a card holder may have two email 305 addresses and prefer to be contacted with one of them. 307 A preference value MUST be an integer number in the range 1 and 100. 308 Lower values correspond to a higher level of preference, with 1 being 309 most preferred. If no preference is set, then the contact 310 information MUST be interpreted as being least preferred. 312 Note that the preference only is defined in relation to contact 313 information of the same type. For example, the preference orders 314 within emails and phone numbers are indendepent of each other. Also 315 note that the _preferredContactMethod_ property allows to define a 316 preferred contact method across method types. 318 1.5.5. UnsignedInt 320 Where UnsignedInt is given as a data type, it means an integer in the 321 range 0 <= value <= 2^53-1, represented as a JSON Number. 323 1.5.6. UTCDateTime 325 This is a string in [RFC3339] date-time format, with the further 326 restrictions that any letters MUST be in uppercase, and the time 327 offset MUST be the character Z. Fractional second values MUST NOT be 328 included unless non-zero and MUST NOT have trailing zeros, to ensure 329 there is only a single representation for each date-time. 331 For example, 2010-10-10T10:10:10.003Z is conformant, but 332 2010-10-10T10:10:10.000Z is invalid and is correctly encoded as 333 2010-10-10T10:10:10Z. 335 2. Card 337 MIME type: application/jscontact+json;type=card 339 A Card object stores information about a person, organization or 340 company. 342 2.1. Metadata properties 344 2.1.1. @type 346 Type: String (mandatory). 348 Specifies the type of this object. This MUST be Card. 350 2.1.2. uid 352 Type: String (mandatory). 354 An identifier, used to associate the object as the same across 355 different systems, addressbooks and views. [RFC4122] describes a 356 range of established algorithms to generate universally unique 357 identifiers (UUID), and the random or pseudo-random version is 358 recommended. For compatibility with [RFC6350] UIDs, implementations 359 MUST accept both URI and free-form text. 361 2.1.3. prodId 363 Type: String (optional). 365 The identifier for the product that created the Card object. 367 2.1.4. created 369 Type: UTCDateTime (optional). 371 The date and time when this Card object was created. 373 2.1.5. updated 375 Type: UTCDateTime (optional). 377 The date and time when the data in this Card object was last 378 modified. 380 2.1.6. kind 382 Type: String (optional). The kind of the entity the Card represents. 384 The value MUST be either one of the following values, registered in a 385 future RFC, or a vendor-specific value: 387 * individual: a single person 389 * org: an organization 391 * location: a named location 393 * device: a device, such as appliances, computers, or network 394 elements 396 * application: a software application 398 2.1.7. relatedTo 400 Type: String[Relation] (optional). 402 Relates the object to other Card and CardGroup objects. This is 403 represented as a map, where each key is the uid of the related Card 404 or CardGroup and the value defines the relation. The Relation object 405 has the following properties: 407 * @type: String (mandatory). Specifies the type of this object. 408 This MUST be Relation. 410 * relation: String[Boolean] (optional, default: empty Object) 411 Describes how the linked object is related to the linking object. 412 The relation is defined as a set of relation types. If empty, the 413 relationship between the two objects is unspecified. Keys in the 414 set MUST be one of the RELATED property [RFC6350] type parameter 415 values, or an IANA-registered value, or a vendor-specific value. 416 The value for each key in the set MUST be true. 418 2.1.8. language 420 Type: String (optional). 422 This defines the locale in which free-text property values can be 423 assumed to be written in. The value MUST be a language tag as 424 defined in [RFC5646]. Note that such values MAY be localized in the 425 localizations Section 2.5.1 property. 427 2.2. Name and Organization properties 429 2.2.1. name 431 Type: Name (optional). 433 The name of the entity represented by this Card. 435 A Name object has the following properties 437 * @type: Name (mandatory). Specifies the type of this object. This 438 MUST be Name. 440 * components: NameComponent[] (mandatory). The components making up 441 the name. The component list MUST have at least one entry. Name 442 components SHOULD be ordered such that their values joined by 443 whitespace produce a valid full name of this entity. Doing so, 444 implementations MAY ignore any components of type separator. 446 * locale: String (optional). The locale of the name. The value 447 MUST be a language tag as defined [RFC5646]. 449 A NameComponent object has the following properties: 451 * @type: String (mandatory). Specifies the type of this object. 452 This MUST be NameComponent. 454 * value: String (mandatory). The value of this name component. 456 * type: String (mandatory). The type of this name component. The 457 value MUST be either one of the following values, registered in a 458 future RFC, or a vendor-specific value: 460 - prefix. The value is a honorific title(s), e.g. "Mr", "Ms", 461 "Dr". 463 - given. The value is a given name, also known as "first name", 464 "personal name". 466 - surname. The value is a surname, also known as "last name", 467 "family name". 469 - middle. The value is a middle name, also known as "additional 470 name". 472 - suffix. The value is a honorific suffix, e.g. "B.A.", "Esq.". 474 - separator. A formatting separator for two name components. 475 The value property of the component includes the verbatim 476 separator, for example a newline character. 478 * nth: UnsignedInt (optional, default: 1). Defines the rank of this 479 name component to other name components of the same type. If set, 480 the property value MUST be higher than or equal to 1. 482 For example, two name components of type surname may have their 483 nth property value set to 1 and 2, respectively. In this case, 484 the first name component defines the surname, and the second name 485 component the secondary surname. 487 Note that this property value does not indicate the order in which 488 to print name components of the same type. Some cultures print 489 the secondary surname before the first surname, others the first 490 before the second. Implementations SHOULD inspect the locale 491 property of the Name object to determine the appropriate 492 formatting. They MAY print name components in order of appearance 493 in the components property of the Name object. 495 2.2.2. fullName 497 Type: String (optional). 499 The full name (e.g. the personal name and surname of an individual, 500 the name of an organization) of the entity represented by this card. 501 The purpose of this property is to define a name, even if the 502 individual name components are not known. In addition, it is meant 503 to provide alternative versions of the name for internationalisation. 504 Implementations SHOULD prefer using the _name_ property over this one 505 and SHOULD NOT store the concatenated name component values in this 506 property. 508 2.2.3. nickNames 510 Type: String[] (optional). 512 The nick names of the entity represented by this card. 514 2.2.4. organizations 516 Type: Id[Organization] (optional). 518 The companies or organization names and units associated with this 519 card. An Organization object has the following properties: 521 * @type: String (mandatory). Specifies the type of this object. 522 This MUST be Organization. 524 * name: String (mandatory). The name of this organization. 526 * units: String[] (optional). Additional levels of organizational 527 unit names. 529 2.2.5. titles 531 Type : Id[Title] (optional). 533 The job titles or functional positions of the entity represented by 534 this card. A Title has object the following properties: 536 * @type: String (mandatory). Specifies the type of this object. 537 This MUST be Title. 539 * title: String (mandatory). The title of the entity represented by 540 this card. 542 * organization: Id (optional). The id of the organization in which 543 this title is held. 545 2.2.6. speakToAs 547 Type: SpeakToAs (optional). 549 Provides information how to address, speak to or refer to the entity 550 that is represented by this card. A SpeakToAs object has the 551 following properties, of which at least one property other than @type 552 MUST be set: 554 * @type: String (mandatory). Specifies the type of this object. 555 This MUST be SpeakToAs. 557 * grammaticalGender: String (optional). Defines which grammatical 558 gender to use in salutations and other grammatical constructs. 559 Allowed values are: 561 - animate 562 - female 564 - inanimate 566 - male 568 - neuter 570 Note that the grammatical gender does not allow to infer the 571 gender identities or biological sex of the contact. 573 * pronouns: String (optional). Defines the gender pronouns that the 574 contact chooses to use for themselves. Any value or form is 575 allowed. Examples in English include she/her and they/them/ 576 theirs. 578 The property values SHOULD be localized in the language defined in 579 the language property. They MAY be overridden in the localizations 580 property (Section 2.5.1). 582 2.3. Contact and Resource properties 584 2.3.1. emails 586 Type: Id[EmailAddress] (optional). 588 The email addresses to contact the entity represented by this card. 589 An EmailAddress object has the following properties: 591 * @type: String (mandatory). Specifies the type of this object. 592 This MUST be EmailAddress. 594 * email: String (mandatory). The email address. This MUST be an 595 _addr-spec_ value as defined in Section 3.4.1 of [RFC5322]. 597 * contexts: Context[Boolean] (optional) The contexts in which to use 598 this email address. The value for each key in the object MUST be 599 true. 601 * pref: Preference (optional) The preference of this email address 602 in relation to other email addresses. 604 * label: String (optional). A label describing the value in more 605 detail. 607 2.3.2. phones 609 Type: Id[Phone] (optional). 611 The phone numbers to contact the entity represented by this card. A 612 Phone object has the following properties: 614 * @type: String (mandatory). Specifies the type of this object. 615 This MUST be Phone. 617 * phone: String (mandatory). The phone value, as either a URI or a 618 free-text phone number. Typical URI schemes are the [RFC3966] tel 619 or [RFC3261] sip schemes, but any URI scheme is allowed. 621 * features: String[Boolean] (optional). The set of contact features 622 that this phone number may be used for. The set is represented as 623 an object, with each key being a method type. The value for each 624 key in the object MUST be true. The method type MUST be either 625 one of the following values, registered in a future RFC, or a 626 vendor-specific value: 628 - voice The number is for calling by voice. 630 - fax The number is for sending faxes. 632 - pager The number is for a pager or beeper. 634 - text The number supports text messages (SMS). 636 - cell The number is for a cell phone. 638 - textphone The number is for a device for people with hearing or 639 speech difficulties. 641 - video The number supports video conferencing. 643 * contexts: Context[Boolean] (optional) The contexts in which to use 644 this number. The value for each key in the object MUST be true. 646 * pref: Preference (optional) The preference of this number in 647 relation to other numbers. 649 * label: String (optional). A label describing the value in more 650 detail. 652 2.3.3. online 654 Type: Id[Resource] (optional). 656 The online resources and services that are associated with the entity 657 represented by this card. A Resource object has the following 658 properties: 660 * @type: String (mandatory). Specifies the type of this object. 661 This MUST be Resource. 663 * resource: String (mandatory). The resource value, where the 664 allowed value form is defined by the the _type_ property. In any 665 case the value MUST NOT be empty. 667 * type: String (optional). The type of the resource value. Allowed 668 values are: 670 - uri The resource value is a URI, e.g. a website link. This 671 MUST be a valid _URI_ as defined in Section 3 of [RFC3986] and 672 updates. 674 - username The resource value is a username associated with the 675 entity represented by this card (e.g. for social media, or an 676 IM client). The _label_ property SHOULD be included to 677 identify what service this is for. For compatibility between 678 clients, this label SHOULD be the canonical service name, 679 including capitalisation. e.g. Twitter, Facebook, Skype, 680 GitHub, XMPP. The resource value may be any non-empty free 681 text. 683 * mediaType: String (optional). Used for URI resource values. 684 Provides the media type [RFC2046] of the resource identified by 685 the URI. 687 * contexts: Context[Boolean] (optional) The contexts in which to use 688 this resource. The value for each key in the object MUST be true. 690 * pref: Preference (optional) The preference of this resource in 691 relation to other resources. 693 * label: String (optional). A label describing the value in more 694 detail. 696 2.3.4. photos 698 Type: Id[File] (optional). 700 A map of photo ids to File objects that contain photographs or images 701 associated with this card. A typical use case is to include an 702 avatar for display along the contact name. 704 A File object has the following properties: 706 * @type: String (mandatory). Specifies the type of this object. 707 This MUST be File. 709 * href: String (mandatory). A URI where to fetch the data of this 710 file. 712 * mediaType: String (optional). The content-type of the file, if 713 known. 715 * size: UnsignedInt (optional). The size, in octets, of the file 716 when fully decoded (i.e., the number of octets in the file the 717 user would download), if known. 719 * pref: Preference (optional) The preference of this photo in 720 relation to other photos. 722 * label: String (optional). A label describing the value in more 723 detail. 725 2.3.5. preferredContactMethod 727 Type : String (optional) 729 Defines the preferred method to contact the holder of this card. The 730 value MUST be the property names: emails, phones, online. 732 2.3.6. preferredContactLanguages 734 Type : String[ContactLanguage[]] (optional) 736 Defines the preferred languages for contacting the entity associated 737 with this card. The keys in the object MUST be [RFC5646] language 738 tags. The values are a (possibly empty) list of contact language 739 preferences for this language. A valid ContactLanguage object MUST 740 have at least one of its properties set. 742 A ContactLanguage object has the following properties: 744 * @type: String (mandatory). Specifies the type of this object. 745 This MUST be ContactLanguage. 747 * context: Context (optional). Defines the context in which to use 748 this language. 750 * pref: Preference (optional). Defines the preference of this 751 language in relation to other languages of the same context. 753 Also see the definition of the VCARD LANG property (Section 6.4.4., 754 [RFC6350]). 756 2.4. Address and Location properties 758 2.4.1. addresses 760 Type: Id[Address] (optional). 762 A map of address ids to Address objects, containing physical 763 locations. An Address object has the following properties: 765 * @type: String (mandatory). Specifies the type of this object. 766 This MUST be Address. 768 * fullAddress: String (optional). The complete address, excluding 769 type and label. This property is mainly useful to represent 770 addresses of which the individual address components are unknown, 771 or to provide localized representations. 773 * street: StreetComponent[] (optional). The street address. The 774 concatenation of the component values, separated by whitespace, 775 SHOULD result in a valid street address for the address locale. 776 Doing so, implementations MAY ignore any separator components. 777 The StreetComponent object type is defined in the paragraph below. 779 * locality: String (optional). The city, town, village, post town, 780 or other locality within which the street address may be found. 782 * region: String (optional). The province, such as a state, county, 783 or canton within which the locality may be found. 785 * country: String (optional). The country name. 787 * postcode: String (optional). The postal code, post code, ZIP code 788 or other short code associated with the address by the relevant 789 country's postal system. 791 * countryCode: String (optional). The ISO-3166-1 country code. 793 * coordinates: String (optional) A [RFC5870] "geo:" URI for the 794 address. 796 * timeZone: String (optional) Identifies the time zone this address 797 is located in. This either MUST be a time zone name registered in 798 the IANA Time Zone Database (https://www.iana.org/time-zones), or 799 it MUST be a valid TimeZoneId as defined in [RFC8984]. For the 800 latter, a corresponding time zone MUST be defined in the timeZones 801 property. 803 * contexts: Context[Boolean] (optional). The contexts of the 804 address information. In addition to the common contexts, allowed 805 values are: 807 - billing An address to be used for billing. 809 - postal An address to be used for delivering physical items. 810 The value for each key in the object MUST be true. 812 * pref: Preference (optional) The preference of this address in 813 relation to other addresses. 815 * label: String (optional). A label describing the value in more 816 detail. 818 A StreetComponent object has the following properties: 820 * @type: String (mandatory). Specifies the type of this object. 821 This MUST be StreetComponent. 823 * type: String (mandatory). The type of this street component. The 824 value MUST be either one of the following values, registered in a 825 future RFC, or a vendor-specific value: 827 - name. The street name. 829 - number. The street number. 831 - apartment. The apartment number or identifier. 833 - room. The room number or identifier. 835 - extension. The extension designation or box number. 837 - direction. The cardinal direction, e.g. "North". 839 - building. The building or building part this address is 840 located in. 842 - floor. The floor this address is located on. 844 - postOfficeBox. The post office box number or identifier. 846 - separator. A separator for two street components. The value 847 property of the component includes the verbatim separator, for 848 example a newline character. 850 - unknown. A name component value for which no type is known. 852 * value: String (mandatory). The value of this street component. 854 2.5. Multilingual properties 856 2.5.1. localizations 858 Type: String[PatchObject] (optional). 860 A map of language tags [RFC5646] to patches, which localize a 861 property value into the locale of the respective language tag. The 862 paths in the PatchObject keys are relative to the Card object that 863 includes the localizations property. A patch MUST NOT target the 864 localizations property. 866 The following example shows a Card object, where one of its addresses 867 Tokyo is localized for the jp locale. 869 "@type": "Card", 870 ... 871 "addresses": { 872 "addr1": { 873 "@type": "Address", 874 "locality": "Tokyo", 875 } 876 }, 877 "localizations": { 878 "jp": { 879 "addresses/addr1/locality":"東京" 880 } 881 } 883 Figure 1 885 2.6. Additional properties 887 2.6.1. anniversaries 889 Type : Id[Anniversary] (optional). 891 These are memorable dates and events for the entity represented by 892 this card. An Anniversary object has the following properties: 894 * @type: String (mandatory). Specifies the type of this object. 895 This MUST be Anniversary. 897 * type: String (optional). Specifies the type of the anniversary. 898 This RFC predefines the following types, but implementations MAY 899 use additional values: 901 - birth: a birth day anniversary 903 - death: a death day anniversary 905 * date: String (mandatory). The date of this anniversary, in the 906 form "YYYY-MM-DD" (any part may be all 0s for unknown) or a 907 [RFC3339] timestamp. 909 * place: Address (optional). An address associated with this 910 anniversary, e.g. the place of birth or death. 912 * label: String (optional). A label describing the value in more 913 detail. 915 2.6.2. personalInfo 917 Type: Id[PersonalInformation] (optional). 919 Defines personal information about the entity represented by this 920 card. A PersonalInformation object has the following properties: 922 * @type: String (mandatory). Specifies the type of this object. 923 This MUST be PersonalInformation. 925 * type: String (mandatory). Specifies the type for this personal 926 information. Allowed values are: 928 - expertise: a field of expertise or credential 930 - hobby: a hobby 932 - interest: an interest 934 * value: String (mandatory). The actual information. This 935 generally is free-text, but future specifications MAY restrict 936 allowed values depending on the type of this PersonalInformation. 938 * level: String (optional) Indicates the level of expertise, or 939 engagement in hobby or interest. Allowed values are: high, medium 940 and low. 942 * label: String (optional). A label describing the value in more 943 detail. 945 2.6.3. notes 947 Type: String (optional). 949 Arbitrary notes about the entity represented by this card. 951 2.6.4. categories 953 Type: String[Boolean] (optional). The set of free-text or URI 954 categories that relate to the card. The set is represented as an 955 object, with each key being a category. The value for each key in 956 the object MUST be true. 958 2.6.5. timeZones 960 Type: String[TimeZone] (optional). Maps identifiers of custom time 961 zones to their time zone definitions. For a description of this 962 property see the timeZones property definition in [RFC8984]. 964 3. CardGroup 966 MIME type: application/jscontact+json;type=cardgroup 968 A CardGroup object represents a group of cards. Its members may be 969 Cards or CardGroups. 971 3.1. Group properties 973 3.1.1. @type 975 Type: String (mandatory). 977 Specifies the type of this object. This MUST be CardGroup. 979 3.1.2. uid 981 Type: String (mandatory). The uid of this group. Both CardGroup and 982 Card share the same namespace for the uid property. 984 3.1.3. members 986 Type: String[Boolean] (mandatory). The members of this group. 988 The set is represented as an object, with each key being the uid of 989 another Card or CardGroup. The value for each key in the object MUST 990 be true. 992 3.1.4. name 994 Type: String (optional). The user-visible name for the group, e.g. 995 "Friends". This may be any UTF-8 string of at least 1 character in 996 length and maximum 255 octets in size. The same name may be used by 997 two different groups. 999 3.1.5. card 1001 Type: Card (optional). The card that represents this group. 1003 4. Implementation Status 1005 NOTE: Please remove this section and the reference to [RFC7942] prior 1006 to publication as an RFC. This section records the status of known 1007 implementations of the protocol defined by this specification at the 1008 time of posting of this Internet-Draft, and is based on a proposal 1009 described in [RFC7942]. The description of implementations in this 1010 section is intended to assist the IETF in its decision processes in 1011 progressing drafts to RFCs. Please note that the listing of any 1012 individual implementation here does not imply endorsement by the 1013 IETF. Furthermore, no effort has been spent to verify the 1014 information presented here that was supplied by IETF contributors. 1015 This is not intended as, and must not be construed to be, a catalog 1016 of available implementations or their features. Readers are advised 1017 to note that other implementations may exist. According to 1018 [RFC7942], "this will allow reviewers and working groups to assign 1019 due consideration to documents that have the benefit of running code, 1020 which may serve as evidence of valuable experimentation and feedback 1021 that have made the implemented protocols more mature. It is up to 1022 the individual working groups to use this information as they see 1023 fit". 1025 4.1. IIT-CNR/Registro.it 1027 * Responsible Organization: Institute of Informatics and Telematics 1028 of National Research Council (IIT-CNR)/Registro.it 1030 * Location: https://rdap.pubtest.nic.it/ 1031 (https://rdap.pubtest.nic.it/) 1033 * Description: This implementation includes support for RDAP queries 1034 using data from the public test environment of .it ccTLD. The 1035 RDAP server returns responses including Card in place of jCard 1036 when queries contain the parameter jscard=1. 1038 * Level of Maturity: This is an "alpha" test implementation. 1040 * Coverage: This implementation includes all of the features 1041 described in this specification. 1043 * Contact Information: Mario Loffredo, mario.loffredo@iit.cnr.it 1045 5. IANA Considerations 1047 TBD 1049 6. Security Considerations 1051 TBD 1053 7. References 1055 7.1. Normative References 1057 [RFC2046] Freed, N. and N. Borenstein, "Multipurpose Internet Mail 1058 Extensions (MIME) Part Two: Media Types", RFC 2046, 1059 DOI 10.17487/RFC2046, November 1996, 1060 . 1062 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 1063 Requirement Levels", BCP 14, RFC 2119, 1064 DOI 10.17487/RFC2119, March 1997, 1065 . 1067 [RFC4122] Leach, P., Mealling, M., and R. Salz, "A Universally 1068 Unique IDentifier (UUID) URN Namespace", RFC 4122, 1069 DOI 10.17487/RFC4122, July 2005, 1070 . 1072 [RFC5646] Phillips, A., Ed. and M. Davis, Ed., "Tags for Identifying 1073 Languages", BCP 47, RFC 5646, DOI 10.17487/RFC5646, 1074 September 2009, . 1076 [RFC5870] Mayrhofer, A. and C. Spanring, "A Uniform Resource 1077 Identifier for Geographic Locations ('geo' URI)", 1078 RFC 5870, DOI 10.17487/RFC5870, June 2010, 1079 . 1081 [RFC6350] Perreault, S., "vCard Format Specification", RFC 6350, 1082 DOI 10.17487/RFC6350, August 2011, 1083 . 1085 [RFC6351] Perreault, S., "xCard: vCard XML Representation", 1086 RFC 6351, DOI 10.17487/RFC6351, August 2011, 1087 . 1089 [RFC6901] Bryan, P., Ed., Zyp, K., and M. Nottingham, Ed., 1090 "JavaScript Object Notation (JSON) Pointer", RFC 6901, 1091 DOI 10.17487/RFC6901, April 2013, 1092 . 1094 [RFC7095] Kewisch, P., "jCard: The JSON Format for vCard", RFC 7095, 1095 DOI 10.17487/RFC7095, January 2014, 1096 . 1098 [RFC7493] Bray, T., Ed., "The I-JSON Message Format", RFC 7493, 1099 DOI 10.17487/RFC7493, March 2015, 1100 . 1102 [RFC7942] Sheffer, Y. and A. Farrel, "Improving Awareness of Running 1103 Code: The Implementation Status Section", BCP 205, 1104 RFC 7942, DOI 10.17487/RFC7942, July 2016, 1105 . 1107 [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 1108 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 1109 May 2017, . 1111 [RFC8259] Bray, T., Ed., "The JavaScript Object Notation (JSON) Data 1112 Interchange Format", STD 90, RFC 8259, 1113 DOI 10.17487/RFC8259, December 2017, 1114 . 1116 [RFC8984] Jenkins, N. and R. Stepanek, "JSCalendar: A JSON 1117 Representation of Calendar Data", RFC 8984, 1118 DOI 10.17487/RFC8984, July 2021, 1119 . 1121 7.2. Informative References 1123 [RFC3261] Rosenberg, J., Schulzrinne, H., Camarillo, G., Johnston, 1124 A., Peterson, J., Sparks, R., Handley, M., and E. 1125 Schooler, "SIP: Session Initiation Protocol", RFC 3261, 1126 DOI 10.17487/RFC3261, June 2002, 1127 . 1129 [RFC3339] Klyne, G. and C. Newman, "Date and Time on the Internet: 1130 Timestamps", RFC 3339, DOI 10.17487/RFC3339, July 2002, 1131 . 1133 [RFC3966] Schulzrinne, H., "The tel URI for Telephone Numbers", 1134 RFC 3966, DOI 10.17487/RFC3966, December 2004, 1135 . 1137 [RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform 1138 Resource Identifier (URI): Generic Syntax", STD 66, 1139 RFC 3986, DOI 10.17487/RFC3986, January 2005, 1140 . 1142 [RFC4648] Josefsson, S., "The Base16, Base32, and Base64 Data 1143 Encodings", RFC 4648, DOI 10.17487/RFC4648, October 2006, 1144 . 1146 [RFC5322] Resnick, P., Ed., "Internet Message Format", RFC 5322, 1147 DOI 10.17487/RFC5322, October 2008, 1148 . 1150 [RFC6473] Saint-Andre, P., "vCard KIND:application", RFC 6473, 1151 DOI 10.17487/RFC6473, December 2011, 1152 . 1154 [RFC6474] Li, K. and B. Leiba, "vCard Format Extensions: Place of 1155 Birth, Place and Date of Death", RFC 6474, 1156 DOI 10.17487/RFC6474, December 2011, 1157 . 1159 [RFC6715] Cauchie, D., Leiba, B., and K. Li, "vCard Format 1160 Extensions: Representing vCard Extensions Defined by the 1161 Open Mobile Alliance (OMA) Converged Address Book (CAB) 1162 Group", RFC 6715, DOI 10.17487/RFC6715, August 2012, 1163 . 1165 [RFC6869] Salgueiro, G., Clarke, J., and P. Saint-Andre, "vCard 1166 KIND:device", RFC 6869, DOI 10.17487/RFC6869, February 1167 2013, . 1169 [RFC8605] Hollenbeck, S. and R. Carney, "vCard Format Extensions: 1170 ICANN Extensions for the Registration Data Access Protocol 1171 (RDAP)", RFC 8605, DOI 10.17487/RFC8605, May 2019, 1172 . 1174 Authors' Addresses 1175 Robert Stepanek 1176 FastMail 1177 PO Box 234, Collins St West 1178 Melbourne VIC 8007 1179 Australia 1181 Email: rsto@fastmailteam.com 1183 Mario Loffredo 1184 IIT-CNR 1185 Via Moruzzi,1 1186 56124 Pisa 1187 Italy 1189 Email: mario.loffredo@iit.cnr.it