idnits 2.17.1 draft-ietf-jmap-jscontact-08.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 (20 October 2021) is 911 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 197, but not defined == Missing Reference: 'Relation' is mentioned on line 397, but not defined == Missing Reference: 'Boolean' is mentioned on line 921, but not defined == Missing Reference: 'Organization' is mentioned on line 485, but not defined == Missing Reference: 'Title' is mentioned on line 500, but not defined == Missing Reference: 'EmailAddress' is mentioned on line 518, but not defined == Missing Reference: 'Phone' is mentioned on line 538, but not defined == Missing Reference: 'Resource' is mentioned on line 588, but not defined == Missing Reference: 'File' is mentioned on line 638, but not defined == Missing Reference: 'Address' is mentioned on line 697, but not defined == Missing Reference: 'PatchObject' is mentioned on line 795, but not defined == Missing Reference: 'Anniversary' is mentioned on line 822, but not defined == Missing Reference: 'PersonalInformation' is mentioned on line 853, but not defined == Missing Reference: 'TimeZone' is mentioned on line 895, 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: 23 April 2022 IIT-CNR 6 20 October 2021 8 JSContact: A JSON representation of contact data 9 draft-ietf-jmap-jscontact-08 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 23 April 2022. 38 Copyright Notice 40 Copyright (c) 2021 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 Simplified BSD License text 49 as described in Section 4.e of the Trust Legal Provisions and are 50 provided without warranty as described in the Simplified 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 . . . . . . . . . . . . . . . . . . . . . 4 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. UTCDateTime . . . . . . . . . . . . . . . . . . . . . 7 65 2. Card . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 66 2.1. Metadata properties . . . . . . . . . . . . . . . . . . . 8 67 2.1.1. @type . . . . . . . . . . . . . . . . . . . . . . . . 8 68 2.1.2. uid . . . . . . . . . . . . . . . . . . . . . . . . . 8 69 2.1.3. prodId . . . . . . . . . . . . . . . . . . . . . . . 8 70 2.1.4. created . . . . . . . . . . . . . . . . . . . . . . . 8 71 2.1.5. updated . . . . . . . . . . . . . . . . . . . . . . . 8 72 2.1.6. kind . . . . . . . . . . . . . . . . . . . . . . . . 9 73 2.1.7. relatedTo . . . . . . . . . . . . . . . . . . . . . . 9 74 2.1.8. language . . . . . . . . . . . . . . . . . . . . . . 9 75 2.2. Name and Organization properties . . . . . . . . . . . . 10 76 2.2.1. name . . . . . . . . . . . . . . . . . . . . . . . . 10 77 2.2.2. fullName . . . . . . . . . . . . . . . . . . . . . . 10 78 2.2.3. nickNames . . . . . . . . . . . . . . . . . . . . . . 11 79 2.2.4. organizations . . . . . . . . . . . . . . . . . . . . 11 80 2.2.5. titles . . . . . . . . . . . . . . . . . . . . . . . 11 81 2.3. Contact and Resource properties . . . . . . . . . . . . . 11 82 2.3.1. emails . . . . . . . . . . . . . . . . . . . . . . . 11 83 2.3.2. phones . . . . . . . . . . . . . . . . . . . . . . . 12 84 2.3.3. online . . . . . . . . . . . . . . . . . . . . . . . 13 85 2.3.4. photos . . . . . . . . . . . . . . . . . . . . . . . 14 86 2.3.5. preferredContactMethod . . . . . . . . . . . . . . . 15 87 2.3.6. preferredContactLanguages . . . . . . . . . . . . . . 15 88 2.4. Address and Location properties . . . . . . . . . . . . . 15 89 2.4.1. addresses . . . . . . . . . . . . . . . . . . . . . . 15 90 2.5. Multilingual properties . . . . . . . . . . . . . . . . . 17 91 2.5.1. localizations . . . . . . . . . . . . . . . . . . . . 17 92 2.6. Additional properties . . . . . . . . . . . . . . . . . . 18 93 2.6.1. anniversaries . . . . . . . . . . . . . . . . . . . . 18 94 2.6.2. personalInfo . . . . . . . . . . . . . . . . . . . . 19 95 2.6.3. notes . . . . . . . . . . . . . . . . . . . . . . . . 19 96 2.6.4. categories . . . . . . . . . . . . . . . . . . . . . 19 97 2.6.5. timeZones . . . . . . . . . . . . . . . . . . . . . . 20 98 3. CardGroup . . . . . . . . . . . . . . . . . . . . . . . . . . 20 99 3.1. Group properties . . . . . . . . . . . . . . . . . . . . 20 100 3.1.1. @type . . . . . . . . . . . . . . . . . . . . . . . . 20 101 3.1.2. uid . . . . . . . . . . . . . . . . . . . . . . . . . 20 102 3.1.3. members . . . . . . . . . . . . . . . . . . . . . . . 20 103 3.1.4. name . . . . . . . . . . . . . . . . . . . . . . . . 20 104 3.1.5. card . . . . . . . . . . . . . . . . . . . . . . . . 20 105 4. Implementation Status . . . . . . . . . . . . . . . . . . . . 21 106 4.1. IIT-CNR/Registro.it . . . . . . . . . . . . . . . . . . . 21 107 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 22 108 6. Security Considerations . . . . . . . . . . . . . . . . . . . 22 109 7. References . . . . . . . . . . . . . . . . . . . . . . . . . 22 110 7.1. Normative References . . . . . . . . . . . . . . . . . . 22 111 7.2. Informative References . . . . . . . . . . . . . . . . . 23 112 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 24 114 1. Introduction 116 This document defines a data model for contact card data normally 117 used in address book or directory applications and services. It aims 118 to be an alternative to the vCard data format [RFC6350] and to 119 provide a JSON-based standard representation of contact card data. 121 The key design considerations for this data model are as follows: 123 * Most of the initial set of attributes should be taken from the 124 vCard data format [RFC6350] and extensions ([RFC6473], [RFC6474], 125 [RFC6715], [RFC6869], [RFC8605]). The specification should add 126 new attributes or value types, or not support existing ones, where 127 appropriate. Conversion between the data formats need not fully 128 preserve semantic meaning. 130 * The attributes of the cards data represented must be described as 131 a simple key-value pair, reducing complexity of its 132 representation. 134 * The data model should avoid all ambiguities and make it difficult 135 to make mistakes during implementation. 137 * Extensions, such as new properties and components, MUST NOT lead 138 to requiring an update to this document. 140 The representation of this data model is defined in the I-JSON format 141 [RFC7493], which is a strict subset of the JavaScript Object Notation 142 (JSON) Data Interchange Format [RFC8259]. Using JSON is mostly a 143 pragmatic choice: its widespread use makes Card easier to adopt, and 144 the availability of production-ready JSON implementations eliminates 145 a whole category of parser-related interoperability issues. 147 1.1. Relation to the xCard and jCard formats 149 The xCard [RFC6351] and jCard [RFC7095] specifications define 150 alternative representations for vCard data, in XML and JSON format 151 respectively. Both explicitly aim to not change the underlying data 152 model. Accordingly, they are regarded as equal to vCard in the 153 context of this document. 155 1.2. Terminology 157 The key words MUST, MUST NOT, REQUIRED, SHALL, SHALL NOT, SHOULD, 158 SHOULD NOT, RECOMMENDED, NOT RECOMMENDED, MAY, and OPTIONAL in this 159 document are to be interpreted as described in BCP 14 [RFC2119] 160 [RFC8174] when, and only when, they appear in all capitals, as shown 161 here. 163 1.3. Vendor-specific Property Extensions and Values 165 Vendors MAY add additional properties to the contact object to 166 support their custom features. To avoid conflict, the names of these 167 properties MUST be prefixed by a domain name controlled by the vendor 168 followed by a colon, e.g., "example.com:customprop". If the value is 169 a new JSContact object, it either MUST include an "@type" property, 170 or it MUST explicitly be specified to not require a type designator. 171 The type name MUST be prefixed with a domain name controlled by the 172 vendor. 174 Some JSContact properties allow vendor-specific value extensions. 175 Such vendor-specific values MUST be prefixed by a domain name 176 controlled by the vendor followed by a colon, e.g., 177 "example.com:customrel". 179 Vendors are strongly encouraged to register any new property values 180 or extensions that are useful to other systems as well, rather than 181 use a vendor-specific prefix. 183 1.4. Type Signatures 185 Type signatures are given for all JSON values in this document. The 186 following conventions are used: 188 * * - The type is undefined (the value could be any type, although 189 permitted values may be constrained by the context of this value). 191 * String - The JSON string type. 193 * Number - The JSON number type. 195 * Boolean - The JSON boolean type. 197 * A[B] - A JSON object where the keys are all of type A, and the 198 values are all of type B. 200 * A[] - An array of values of type A. 202 * A|B - The value is either of type A or of type B. 204 1.5. Data types 206 In addition to the standard JSON data types, a couple of additional 207 data types are common to the definitions of JSContact objects and 208 properties. 210 1.5.1. Context 212 Contact information typically is associated with a context in which 213 it should be used. For example, someone might have distinct phone 214 numbers for work and private contexts. The Context data type 215 enumerates common contexts. 217 Common context values are: 219 * private: The contact information may be used to contact the card 220 holder in a private context. 222 * work: The contact information may be used to contact the card 223 holder in a professional context. 225 * other: The contact information may be used to contact the card 226 holder in some other context. A label property MAY be defined to 227 identify its purpose. 229 Additional allowed values may be defined in the properties or data 230 types that make use of the Context data type, registered in a future 231 RFC, or a vendor-specific value. 233 1.5.2. Id 235 Where Id is given as a data type, it means a String of at least 1 and 236 a maximum of 255 octets in size, and it MUST only contain characters 237 from the URL and Filename Safe base64url alphabet, as defined in 238 Section 5 of [RFC4648], excluding the pad character (=). This means 239 the allowed characters are the ASCII alphanumeric characters (A-Za- 240 z0-9), hyphen (-), and underscore (_). 242 In many places in JSContact a JSON map is used where the map keys are 243 of type Id and the map values are all the same type of object. This 244 construction represents an unordered set of objects, with the added 245 advantage that each entry has a name (the corresponding map key). 246 This allows for more concise patching of objects, and, when 247 applicable, for the objects in question to be referenced from other 248 objects within the JSContact object. 250 Unless otherwise specified for a particular property, there are no 251 uniqueness constraints on an Id value (other than, of course, the 252 requirement that you cannot have two values with the same key within 253 a single JSON map). For example, two Card objects might use the same 254 Ids in their respective photos properties. Or within the same Card 255 object the same Id could appear in the emails and phones properties. 256 These situations do not imply any semantic connections among the 257 objects. 259 1.5.3. PatchObject 261 A PatchObject is of type String[*], and represents an unordered set 262 of patches on a JSON object. Each key is a path represented in a 263 subset of JSON pointer format [RFC6901]. The paths have an implicit 264 leading /, so each key is prefixed with / before applying the JSON 265 pointer evaluation algorithm. 267 A patch within a PatchObject is only valid if all of the following 268 conditions apply: 270 1. The pointer MUST NOT reference inside an array (i.e., you MUST 271 NOT insert/delete from an array; the array MUST be replaced in 272 its entirety instead). 274 2. All parts prior to the last (i.e., the value after the final 275 slash) MUST already exist on the object being patched. 277 3. There MUST NOT be two patches in the PatchObject where the 278 pointer of one is the prefix of the pointer of the other, e.g., 279 addresses/1/city and addresses. 281 4. The value for the patch MUST be valid for the property being set 282 (of the correct type and obeying any other applicable 283 restrictions), or if null the property MUST be optional. 285 The value associated with each pointer determines how to apply that 286 patch: 288 * If null, remove the property from the patched object. If the key 289 is not present in the parent, this a no-op. 291 * If non-null, set the value given as the value for this property 292 (this may be a replacement or addition to the object being 293 patched). 295 A PatchObject does not define its own @type property. Instead, a 296 @type property in a patch MUST be handled as any other patched 297 property value. 299 Implementations MUST reject in its entirety a PatchObject if any of 300 its patches is invalid. Implementations MUST NOT apply partial 301 patches. 303 1.5.4. Preference 305 This data type allows to define a preference order on same-typed 306 contact information. For example, a card holder may have two email 307 addresses and prefer to be contacted with one of them. 309 A preference value MUST be an integer number in the range 1 and 100. 310 Lower values correspond to a higher level of preference, with 1 being 311 most preferred. If no preference is set, then the contact 312 information MUST be interpreted as being least preferred. 314 Note that the preference only is defined in relation to contact 315 information of the same type. For example, the preference orders 316 within emails and phone numbers are indendepent of each other. Also 317 note that the _preferredContactMethod_ property allows to define a 318 preferred contact method across method types. 320 1.5.5. UTCDateTime 322 This is a string in [RFC3339] date-time format, with the further 323 restrictions that any letters MUST be in uppercase, and the time 324 offset MUST be the character Z. Fractional second values MUST NOT be 325 included unless non-zero and MUST NOT have trailing zeros, to ensure 326 there is only a single representation for each date-time. 328 For example, 2010-10-10T10:10:10.003Z is conformant, but 329 2010-10-10T10:10:10.000Z is invalid and is correctly encoded as 330 2010-10-10T10:10:10Z. 332 2. Card 334 MIME type: application/jscontact+json;type=card 336 A Card object stores information about a person, organization or 337 company. 339 2.1. Metadata properties 341 2.1.1. @type 343 Type: String (mandatory). 345 Specifies the type of this object. This MUST be Card. 347 2.1.2. uid 349 Type: String (mandatory). 351 An identifier, used to associate the object as the same across 352 different systems, addressbooks and views. [RFC4122] describes a 353 range of established algorithms to generate universally unique 354 identifiers (UUID), and the random or pseudo-random version is 355 recommended. For compatibility with [RFC6350] UIDs, implementations 356 MUST accept both URI and free-form text. 358 2.1.3. prodId 360 Type: String (optional). 362 The identifier for the product that created the Card object. 364 2.1.4. created 366 Type: UTCDateTime (optional). 368 The date and time when this Card object was created. 370 2.1.5. updated 372 Type: UTCDateTime (optional). 374 The date and time when the data in this Card object was last 375 modified. 377 2.1.6. kind 379 Type: String (optional). The kind of the entity the Card represents. 381 The value MUST be either one of the following values, registered in a 382 future RFC, or a vendor-specific value: 384 * individual: a single person 386 * org: an organization 388 * location: a named location 390 * device: a device, such as appliances, computers, or network 391 elements 393 * application: a software application 395 2.1.7. relatedTo 397 Type: String[Relation] (optional). 399 Relates the object to other Card and CardGroup objects. This is 400 represented as a map, where each key is the uid of the related Card 401 or CardGroup and the value defines the relation. The Relation object 402 has the following properties: 404 * @type: String (mandatory). Specifies the type of this object. 405 This MUST be Relation. 407 * relation: String[Boolean] (optional, default: empty Object) 408 Describes how the linked object is related to the linking object. 409 The relation is defined as a set of relation types. If empty, the 410 relationship between the two objects is unspecified. Keys in the 411 set MUST be one of the RELATED property [RFC6350] type parameter 412 values, or an IANA-registered value, or a vendor-specific value. 413 The value for each key in the set MUST be true. 415 2.1.8. language 417 Type: String (optional). 419 This defines the locale in which free-text property values can be 420 assumed to be written in. The value MUST be a language tag as 421 defined in [RFC5646]. Note that such values MAY be localized in the 422 localizations Section 2.5.1 property. 424 2.2. Name and Organization properties 426 2.2.1. name 428 Type: NameComponent[] (optional). 430 The name components of the name of the entity represented by this 431 Card. Name components SHOULD be ordered such that their values 432 joined by whitespace produce a valid full name of this entity. Doing 433 so, implementations MAY ignore any separator components. 435 A NameComponent has the following properties: 437 * @type: String (mandatory). Specifies the type of this object. 438 This MUST be NameComponent. 440 * value: String (mandatory). The value of this name component. 442 * type: String (mandatory). The type of this name component. The 443 value MUST be either one of the following values, registered in a 444 future RFC, or a vendor-specific value: 446 - prefix. The value is a honorific title(s), e.g. "Mr", "Ms", 447 "Dr". 449 - personal. The value is a personal name(s), also known as 450 "first name", "given name". 452 - surname. The value is a surname, also known as "last name", 453 "family name". 455 - additional. The value is an additional name, also known as 456 "middle name". 458 - suffix. The value is a honorific suffix, e.g. "B.A.", "Esq.". 460 - separator. A separator for two name components. The value 461 property of the component includes the verbatim separator, for 462 example a newline character. 464 2.2.2. fullName 466 Type: String (optional). 468 The full name (e.g. the personal name and surname of an individual, 469 the name of an organization) of the entity represented by this card. 470 The purpose of this property is to define a name, even if the 471 individual name components are not known. In addition, it is meant 472 to provide alternative versions of the name for internationalisation. 473 Implementations SHOULD prefer using the _name_ property over this one 474 and SHOULD NOT store the concatenated name component values in this 475 property. 477 2.2.3. nickNames 479 Type: String[] (optional). 481 The nick names of the entity represented by this card. 483 2.2.4. organizations 485 Type: Id[Organization] (optional). 487 The companies or organization names and units associated with this 488 card. An Organization object has the following properties: 490 * @type: String (mandatory). Specifies the type of this object. 491 This MUST be Organization. 493 * name: String (mandatory). The name of this organization. 495 * units: String[] (optional). Additional levels of organizational 496 unit names. 498 2.2.5. titles 500 Type : Id[Title] (optional). 502 The job titles or functional positions of the entity represented by 503 this card. A Title has object the following properties: 505 * @type: String (mandatory). Specifies the type of this object. 506 This MUST be Title. 508 * title: String (mandatory). The title of the entity represented by 509 this card. 511 * organization: Id (optional). The id of the organization in which 512 this title is held. 514 2.3. Contact and Resource properties 516 2.3.1. emails 518 Type: Id[EmailAddress] (optional). 520 The email addresses to contact the entity represented by this card. 521 An EmailAddress object has the following properties: 523 * @type: String (mandatory). Specifies the type of this object. 524 This MUST be EmailAddress. 526 * email: String (mandatory). The email address. This MUST be an 527 _addr-spec_ value as defined in Section 3.4.1 of [RFC5322]. 529 * contexts: Context[Boolean] (optional) The contexts in which to use 530 this email address. The value for each key in the object MUST be 531 true. 533 * pref: Preference (optional) The preference of this email address 534 in relation to other email addresses. 536 2.3.2. phones 538 Type: Id[Phone] (optional). 540 The phone numbers to contact the entity represented by this card. A 541 Phone object has the following properties: 543 * @type: String (mandatory). Specifies the type of this object. 544 This MUST be Phone. 546 * phone: String (mandatory). The phone value, as either a URI or a 547 free-text phone number. Typical URI schemes are the [RFC3966] tel 548 or [RFC3261] sip schemes, but any URI scheme is allowed. 550 * features: String[Boolean] (optional). The set of contact features 551 that this phone number may be used for. The set is represented as 552 an object, with each key being a method type. The value for each 553 key in the object MUST be true. The method type MUST be either 554 one of the following values, registered in a future RFC, or a 555 vendor-specific value: 557 - voice The number is for calling by voice. 559 - fax The number is for sending faxes. 561 - pager The number is for a pager or beeper. 563 - text The number supports text messages (SMS). 565 - cell The number is for a cell phone. 567 - textphone The number is for a device for people with hearing or 568 speech difficulties. 570 - video The number supports video conferencing. 572 - other The number is for some other purpose. The label property 573 MAY be included to display next to the number to help the user 574 identify its purpose. 576 * contexts: Context[Boolean] (optional) The contexts in which to use 577 this number. The value for each key in the object MUST be true. 579 * label: String (optional). A label describing the value in more 580 detail, especially if the type property has value other (but MAY 581 be included with any type). 583 * pref: Preference (optional) The preference of this number in 584 relation to other numbers. 586 2.3.3. online 588 Type: Id[Resource] (optional). 590 The online resources and services that are associated with the entity 591 represented by this card. A Resource object has the following 592 properties: 594 * @type: String (mandatory). Specifies the type of this object. 595 This MUST be Resource. 597 * resource: String (mandatory). The resource value, where the 598 allowed value form is defined by the the _type_ property. In any 599 case the value MUST NOT be empty. 601 * type: String (optional, default: other). The type of the resource 602 value. Allowed values are: 604 - uri The resource value is a URI, e.g. a website link. This 605 MUST be a valid _URI_ as defined in Section 3 of [RFC3986] and 606 updates. 608 - username The resource value is a username associated with the 609 entity represented by this card (e.g. for social media, or an 610 IM client). The _label_ property SHOULD be included to 611 identify what service this is for. For compatibility between 612 clients, this label SHOULD be the canonical service name, 613 including capitalisation. e.g. Twitter, Facebook, Skype, 614 GitHub, XMPP. The resource value may be any non-empty free 615 text. 617 - other The resource value is something else not covered by the 618 above categories. A label property MAY be included to display 619 next to the number to help the user identify its purpose. The 620 resource value may be any non-empty free text. 622 * mediaType: String (optional). Used for URI resource values. 623 Provides the media type [RFC2046] of the resource identified by 624 the URI. 626 * contexts: Context[Boolean] (optional) The contexts in which to use 627 this resource. The value for each key in the object MUST be true. 629 * label: String (optional). A label describing the value in more 630 detail, especially if the type property has value other (but MAY 631 be included with any type). 633 * pref: Preference (optional) The preference of this resource in 634 relation to other resources. 636 2.3.4. photos 638 Type: Id[File] (optional). 640 A map of photo ids to File objects that contain photographs or images 641 associated with this card. A typical use case is to include an 642 avatar for display along the contact name. 644 A File object has the following properties: 646 * @type: String (mandatory). Specifies the type of this object. 647 This MUST be File. 649 * href: String (mandatory). A URI where to fetch the data of this 650 file. 652 * mediaType: String (optional). The content-type of the file, if 653 known. 655 * size: UnsignedInt (optional). The size, in octets, of the file 656 when fully decoded (i.e., the number of octets in the file the 657 user would download), if known. 659 * pref: Preference (optional) The preference of this photo in 660 relation to other photos. 662 2.3.5. preferredContactMethod 664 Type : String (optional) 666 Defines the preferred method to contact the holder of this card. The 667 value MUST be the property names: emails, phones, online. 669 2.3.6. preferredContactLanguages 671 Type : String[ContactLanguage[]] (optional) 673 Defines the preferred languages for contacting the entity associated 674 with this card. The keys in the object MUST be [RFC5646] language 675 tags. The values are a (possibly empty) list of contact language 676 preferences for this language. A valid ContactLanguage object MUST 677 have at least one of its properties set. 679 A ContactLanguage object has the following properties: 681 * @type: String (mandatory). Specifies the type of this object. 682 This MUST be ContactLanguage. 684 * context: Context (optional). Defines the context in which to use 685 this language. 687 * pref: Preference (optional). Defines the preference of this 688 language in relation to other languages of the same context. 690 Also see the definition of the VCARD LANG property (Section 6.4.4., 691 [RFC6350]). 693 2.4. Address and Location properties 695 2.4.1. addresses 697 Type: Id[Address] (optional). 699 A map of address ids to Address objects, containing physical 700 locations. An Address object has the following properties: 702 * @type: String (mandatory). Specifies the type of this object. 703 This MUST be Address. 705 * fullAddress: String (optional). The complete address, excluding 706 type and label. This property is mainly useful to represent 707 addresses of which the individual address components are unknown, 708 or to provide localized representations. 710 * street: StreetComponent[] (optional). The street address. The 711 concatenation of the component values, separated by whitespace, 712 SHOULD result in a valid street address for the address locale. 713 Doing so, implementations MAY ignore any separator components. 714 The StreetComponent object type is defined in the paragraph below. 716 * locality: String (optional). The city, town, village, post town, 717 or other locality within which the street address may be found. 719 * region: String (optional). The province, such as a state, county, 720 or canton within which the locality may be found. 722 * country: String (optional). The country name. 724 * postcode: String (optional). The postal code, post code, ZIP code 725 or other short code associated with the address by the relevant 726 country's postal system. 728 * countryCode: String (optional). The ISO-3166-1 country code. 730 * coordinates: String (optional) A [RFC5870] "geo:" URI for the 731 address. 733 * timeZone: String (optional) Identifies the time zone this address 734 is located in. This either MUST be a time zone name registered in 735 the IANA Time Zone Database (https://www.iana.org/time-zones), or 736 it MUST be a valid TimeZoneId as defined in [RFC8984]. For the 737 latter, a corresponding time zone MUST be defined in the timeZones 738 property. 740 * contexts: Context[Boolean] (optional). The contexts of the 741 address information. In addition to the common contexts, allowed 742 values are: 744 - billing An address to be used for billing. 746 - postal An address to be used for delivering physical items. 747 The value for each key in the object MUST be true. 749 * label: String (optional). A label describing the value in more 750 detail. 752 * pref: Preference (optional) The preference of this address in 753 relation to other addresses. 755 A StreetComponent object has the following properties: 757 * @type: String (mandatory). Specifies the type of this object. 758 This MUST be StreetComponent. 760 * type: String (mandatory). The type of this street component. The 761 value MUST be either one of the following values, registered in a 762 future RFC, or a vendor-specific value: 764 - name. The street name. 766 - number. The street number. 768 - apartment. The apartment number or identifier. 770 - room. The room number or identifier. 772 - extension. The extension designation or box number. 774 - direction. The cardinal direction, e.g. "North". 776 - building. The building or building part this address is 777 located in. 779 - floor. The floor this address is located on. 781 - postOfficeBox. The post office box number or identifier. 783 - separator. A separator for two street components. The value 784 property of the component includes the verbatim separator, for 785 example a newline character. 787 - unknown. A name component value for which no type is known. 789 * value: String (mandatory). The value of this street component. 791 2.5. Multilingual properties 793 2.5.1. localizations 795 Type: String[PatchObject] (optional). 797 A map of language tags [RFC5646] to patches, which localize a 798 property value into the locale of the respective language tag. The 799 following example shows an Address object where the value Tokyo is 800 localized for the jp locale 802 "addresses": { 803 "addr1": { 804 "@type": "Address", 805 "locality": "Tokyo", 806 } 807 }, 808 "localizations": { 809 "jp": { 810 "addresses/addr1/locality":"東京" 811 } 812 } 814 Figure 1 816 A patch MUST NOT target the localizations property. 818 2.6. Additional properties 820 2.6.1. anniversaries 822 Type : Id[Anniversary] (optional). 824 These are memorable dates and events for the entity represented by 825 this card. An Anniversary object has the following properties: 827 * @type: String (mandatory). Specifies the type of this object. 828 This MUST be Anniversary. 830 * type: String (mandatory). Specifies the type of the anniversary. 831 This RFC predefines the following types, but implementations MAY 832 use additional values: 834 - birth: a birth day anniversary 836 - death: a death day anniversary 838 - other: an anniversary not covered by any of the known types. 840 * label: String (optional). A label describing the value in more 841 detail, especially if the type property has value other (but MAY 842 be included with any type). 844 * date: String (mandatory). The date of this anniversary, in the 845 form "YYYY-MM-DD" (any part may be all 0s for unknown) or a 846 [RFC3339] timestamp. 848 * place: Address (optional). An address associated with this 849 anniversary, e.g. the place of birth or death. 851 2.6.2. personalInfo 853 Type: Id[PersonalInformation] (optional). 855 Defines personal information about the entity represented by this 856 card. A PersonalInformation object has the following properties: 858 * @type: String (mandatory). Specifies the type of this object. 859 This MUST be PersonalInformation. 861 * type: String (mandatory). Specifies the type for this personal 862 information. Allowed values are: 864 - expertise: a field of expertise or credential 866 - hobby: a hobby 868 - interest: an interest 870 - other: an information not covered by the above categories 872 * value: String (mandatory). The actual information. This 873 generally is free-text, but future specifications MAY restrict 874 allowed values depending on the type of this PersonalInformation. 876 * level: String (optional) Indicates the level of expertise, or 877 engagement in hobby or interest. Allowed values are: high, medium 878 and low. 880 2.6.3. notes 882 Type: String (optional). 884 Arbitrary notes about the entity represented by this card. 886 2.6.4. categories 888 Type: String[Boolean] (optional). The set of free-text or URI 889 categories that relate to the card. The set is represented as an 890 object, with each key being a category. The value for each key in 891 the object MUST be true. 893 2.6.5. timeZones 895 Type: String[TimeZone] (optional). Maps identifiers of custom time 896 zones to their time zone definitions. For a description of this 897 property see the timeZones property definition in [RFC8984]. 899 3. CardGroup 901 MIME type: application/jscontact+json;type=cardgroup 903 A CardGroup object represents a group of cards. Its members may be 904 Cards or CardGroups. 906 3.1. Group properties 908 3.1.1. @type 910 Type: String (mandatory). 912 Specifies the type of this object. This MUST be CardGroup. 914 3.1.2. uid 916 Type: String (mandatory). The uid of this group. Both CardGroup and 917 Card share the same namespace for the uid property. 919 3.1.3. members 921 Type: String[Boolean] (mandatory). The members of this group. 923 The set is represented as an object, with each key being the uid of 924 another Card or CardGroup. The value for each key in the object MUST 925 be true. 927 3.1.4. name 929 Type: String (optional). The user-visible name for the group, e.g. 930 "Friends". This may be any UTF-8 string of at least 1 character in 931 length and maximum 255 octets in size. The same name may be used by 932 two different groups. 934 3.1.5. card 936 Type: Card (optional). The card that represents this group. 938 4. Implementation Status 940 NOTE: Please remove this section and the reference to [RFC7942] prior 941 to publication as an RFC. This section records the status of known 942 implementations of the protocol defined by this specification at the 943 time of posting of this Internet-Draft, and is based on a proposal 944 described in [RFC7942]. The description of implementations in this 945 section is intended to assist the IETF in its decision processes in 946 progressing drafts to RFCs. Please note that the listing of any 947 individual implementation here does not imply endorsement by the 948 IETF. Furthermore, no effort has been spent to verify the 949 information presented here that was supplied by IETF contributors. 950 This is not intended as, and must not be construed to be, a catalog 951 of available implementations or their features. Readers are advised 952 to note that other implementations may exist. According to 953 [RFC7942], "this will allow reviewers and working groups to assign 954 due consideration to documents that have the benefit of running code, 955 which may serve as evidence of valuable experimentation and feedback 956 that have made the implemented protocols more mature. It is up to 957 the individual working groups to use this information as they see 958 fit". 960 4.1. IIT-CNR/Registro.it 962 * Responsible Organization: Institute of Informatics and Telematics 963 of National Research Council (IIT-CNR)/Registro.it 965 * Location: https://rdap.pubtest.nic.it/ 966 (https://rdap.pubtest.nic.it/) 968 * Description: This implementation includes support for RDAP queries 969 using data from the public test environment of .it ccTLD. The 970 RDAP server does not implement any security policy because data 971 returned by this server are only for experimental testing 972 purposes. The RDAP server returns responses including Card in 973 place of jCard when queries contain the parameter jscard=1. 975 * Level of Maturity: This is a "proof of concept" research 976 implementation. 978 * Coverage: This implementation includes all of the features 979 described in this specification. 981 * Contact Information: Mario Loffredo, mario.loffredo@iit.cnr.it 983 5. IANA Considerations 985 TBD 987 6. Security Considerations 989 TBD 991 7. References 993 7.1. Normative References 995 [RFC2046] Freed, N. and N. Borenstein, "Multipurpose Internet Mail 996 Extensions (MIME) Part Two: Media Types", RFC 2046, 997 DOI 10.17487/RFC2046, November 1996, 998 . 1000 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 1001 Requirement Levels", BCP 14, RFC 2119, 1002 DOI 10.17487/RFC2119, March 1997, 1003 . 1005 [RFC4122] Leach, P., Mealling, M., and R. Salz, "A Universally 1006 Unique IDentifier (UUID) URN Namespace", RFC 4122, 1007 DOI 10.17487/RFC4122, July 2005, 1008 . 1010 [RFC5646] Phillips, A., Ed. and M. Davis, Ed., "Tags for Identifying 1011 Languages", BCP 47, RFC 5646, DOI 10.17487/RFC5646, 1012 September 2009, . 1014 [RFC5870] Mayrhofer, A. and C. Spanring, "A Uniform Resource 1015 Identifier for Geographic Locations ('geo' URI)", 1016 RFC 5870, DOI 10.17487/RFC5870, June 2010, 1017 . 1019 [RFC6350] Perreault, S., "vCard Format Specification", RFC 6350, 1020 DOI 10.17487/RFC6350, August 2011, 1021 . 1023 [RFC6351] Perreault, S., "xCard: vCard XML Representation", 1024 RFC 6351, DOI 10.17487/RFC6351, August 2011, 1025 . 1027 [RFC6901] Bryan, P., Ed., Zyp, K., and M. Nottingham, Ed., 1028 "JavaScript Object Notation (JSON) Pointer", RFC 6901, 1029 DOI 10.17487/RFC6901, April 2013, 1030 . 1032 [RFC7095] Kewisch, P., "jCard: The JSON Format for vCard", RFC 7095, 1033 DOI 10.17487/RFC7095, January 2014, 1034 . 1036 [RFC7493] Bray, T., Ed., "The I-JSON Message Format", RFC 7493, 1037 DOI 10.17487/RFC7493, March 2015, 1038 . 1040 [RFC7942] Sheffer, Y. and A. Farrel, "Improving Awareness of Running 1041 Code: The Implementation Status Section", BCP 205, 1042 RFC 7942, DOI 10.17487/RFC7942, July 2016, 1043 . 1045 [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 1046 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 1047 May 2017, . 1049 [RFC8259] Bray, T., Ed., "The JavaScript Object Notation (JSON) Data 1050 Interchange Format", STD 90, RFC 8259, 1051 DOI 10.17487/RFC8259, December 2017, 1052 . 1054 [RFC8984] Jenkins, N. and R. Stepanek, "JSCalendar: A JSON 1055 Representation of Calendar Data", RFC 8984, 1056 DOI 10.17487/RFC8984, July 2021, 1057 . 1059 7.2. Informative References 1061 [RFC3261] Rosenberg, J., Schulzrinne, H., Camarillo, G., Johnston, 1062 A., Peterson, J., Sparks, R., Handley, M., and E. 1063 Schooler, "SIP: Session Initiation Protocol", RFC 3261, 1064 DOI 10.17487/RFC3261, June 2002, 1065 . 1067 [RFC3339] Klyne, G. and C. Newman, "Date and Time on the Internet: 1068 Timestamps", RFC 3339, DOI 10.17487/RFC3339, July 2002, 1069 . 1071 [RFC3966] Schulzrinne, H., "The tel URI for Telephone Numbers", 1072 RFC 3966, DOI 10.17487/RFC3966, December 2004, 1073 . 1075 [RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform 1076 Resource Identifier (URI): Generic Syntax", STD 66, 1077 RFC 3986, DOI 10.17487/RFC3986, January 2005, 1078 . 1080 [RFC4648] Josefsson, S., "The Base16, Base32, and Base64 Data 1081 Encodings", RFC 4648, DOI 10.17487/RFC4648, October 2006, 1082 . 1084 [RFC5322] Resnick, P., Ed., "Internet Message Format", RFC 5322, 1085 DOI 10.17487/RFC5322, October 2008, 1086 . 1088 [RFC6473] Saint-Andre, P., "vCard KIND:application", RFC 6473, 1089 DOI 10.17487/RFC6473, December 2011, 1090 . 1092 [RFC6474] Li, K. and B. Leiba, "vCard Format Extensions: Place of 1093 Birth, Place and Date of Death", RFC 6474, 1094 DOI 10.17487/RFC6474, December 2011, 1095 . 1097 [RFC6715] Cauchie, D., Leiba, B., and K. Li, "vCard Format 1098 Extensions: Representing vCard Extensions Defined by the 1099 Open Mobile Alliance (OMA) Converged Address Book (CAB) 1100 Group", RFC 6715, DOI 10.17487/RFC6715, August 2012, 1101 . 1103 [RFC6869] Salgueiro, G., Clarke, J., and P. Saint-Andre, "vCard 1104 KIND:device", RFC 6869, DOI 10.17487/RFC6869, February 1105 2013, . 1107 [RFC8605] Hollenbeck, S. and R. Carney, "vCard Format Extensions: 1108 ICANN Extensions for the Registration Data Access Protocol 1109 (RDAP)", RFC 8605, DOI 10.17487/RFC8605, May 2019, 1110 . 1112 Authors' Addresses 1114 Robert Stepanek 1115 FastMail 1116 PO Box 234, Collins St West 1117 Melbourne VIC 8007 1118 Australia 1120 Email: rsto@fastmailteam.com 1121 Mario Loffredo 1122 IIT-CNR 1123 Via Moruzzi,1 1124 56124 Pisa 1125 Italy 1127 Email: mario.loffredo@iit.cnr.it