draft-ietf-jmap-jscontact-09.txt | draft-ietf-jmap-jscontact-10.txt | |||
---|---|---|---|---|
JMAP R. Stepanek | JMAP R. Stepanek | |||
Internet-Draft FastMail | Internet-Draft FastMail | |||
Intended status: Standards Track M. Loffredo | Intended status: Standards Track M. Loffredo | |||
Expires: 4 June 2022 IIT-CNR | Expires: 17 July 2022 IIT-CNR | |||
1 December 2021 | 13 January 2022 | |||
JSContact: A JSON representation of contact data | JSContact: A JSON representation of contact data | |||
draft-ietf-jmap-jscontact-09 | draft-ietf-jmap-jscontact-10 | |||
Abstract | Abstract | |||
This specification defines a data model and JSON representation of | This specification defines a data model and JSON representation of | |||
contact card information that can be used for data storage and | contact card information that can be used for data storage and | |||
exchange in address book or directory applications. It aims to be an | exchange in address book or directory applications. It aims to be an | |||
alternative to the vCard data format and to be unambiguous, | alternative to the vCard data format and to be unambiguous, | |||
extendable and simple to process. In contrast to the JSON-based | extendable and simple to process. In contrast to the JSON-based | |||
jCard format, it is not a direct mapping from the vCard data model | jCard format, it is not a direct mapping from the vCard data model | |||
and expands semantics where appropriate. | and expands semantics where appropriate. | |||
skipping to change at page 1, line 37 ¶ | skipping to change at page 1, line 37 ¶ | |||
Internet-Drafts are working documents of the Internet Engineering | Internet-Drafts are working documents of the Internet Engineering | |||
Task Force (IETF). Note that other groups may also distribute | Task Force (IETF). Note that other groups may also distribute | |||
working documents as Internet-Drafts. The list of current Internet- | working documents as Internet-Drafts. The list of current Internet- | |||
Drafts is at https://datatracker.ietf.org/drafts/current/. | Drafts is at https://datatracker.ietf.org/drafts/current/. | |||
Internet-Drafts are draft documents valid for a maximum of six months | Internet-Drafts are draft documents valid for a maximum of six months | |||
and may be updated, replaced, or obsoleted by other documents at any | and may be updated, replaced, or obsoleted by other documents at any | |||
time. It is inappropriate to use Internet-Drafts as reference | time. It is inappropriate to use Internet-Drafts as reference | |||
material or to cite them other than as "work in progress." | material or to cite them other than as "work in progress." | |||
This Internet-Draft will expire on 4 June 2022. | This Internet-Draft will expire on 17 July 2022. | |||
Copyright Notice | Copyright Notice | |||
Copyright (c) 2021 IETF Trust and the persons identified as the | Copyright (c) 2022 IETF Trust and the persons identified as the | |||
document authors. All rights reserved. | document authors. All rights reserved. | |||
This document is subject to BCP 78 and the IETF Trust's Legal | This document is subject to BCP 78 and the IETF Trust's Legal | |||
Provisions Relating to IETF Documents (https://trustee.ietf.org/ | Provisions Relating to IETF Documents (https://trustee.ietf.org/ | |||
license-info) in effect on the date of publication of this document. | license-info) in effect on the date of publication of this document. | |||
Please review these documents carefully, as they describe your rights | Please review these documents carefully, as they describe your rights | |||
and restrictions with respect to this document. Code Components | and restrictions with respect to this document. Code Components | |||
extracted from this document must include Revised BSD License text as | extracted from this document must include Revised BSD License text as | |||
described in Section 4.e of the Trust Legal Provisions and are | described in Section 4.e of the Trust Legal Provisions and are | |||
provided without warranty as described in the Revised BSD License. | provided without warranty as described in the Revised BSD License. | |||
skipping to change at page 2, line 44 ¶ | skipping to change at page 2, line 44 ¶ | |||
2.1.5. updated . . . . . . . . . . . . . . . . . . . . . . . 9 | 2.1.5. updated . . . . . . . . . . . . . . . . . . . . . . . 9 | |||
2.1.6. kind . . . . . . . . . . . . . . . . . . . . . . . . 9 | 2.1.6. kind . . . . . . . . . . . . . . . . . . . . . . . . 9 | |||
2.1.7. relatedTo . . . . . . . . . . . . . . . . . . . . . . 9 | 2.1.7. relatedTo . . . . . . . . . . . . . . . . . . . . . . 9 | |||
2.1.8. language . . . . . . . . . . . . . . . . . . . . . . 10 | 2.1.8. language . . . . . . . . . . . . . . . . . . . . . . 10 | |||
2.2. Name and Organization properties . . . . . . . . . . . . 10 | 2.2. Name and Organization properties . . . . . . . . . . . . 10 | |||
2.2.1. name . . . . . . . . . . . . . . . . . . . . . . . . 10 | 2.2.1. name . . . . . . . . . . . . . . . . . . . . . . . . 10 | |||
2.2.2. fullName . . . . . . . . . . . . . . . . . . . . . . 11 | 2.2.2. fullName . . . . . . . . . . . . . . . . . . . . . . 11 | |||
2.2.3. nickNames . . . . . . . . . . . . . . . . . . . . . . 11 | 2.2.3. nickNames . . . . . . . . . . . . . . . . . . . . . . 11 | |||
2.2.4. organizations . . . . . . . . . . . . . . . . . . . . 12 | 2.2.4. organizations . . . . . . . . . . . . . . . . . . . . 12 | |||
2.2.5. titles . . . . . . . . . . . . . . . . . . . . . . . 12 | 2.2.5. titles . . . . . . . . . . . . . . . . . . . . . . . 12 | |||
2.3. Contact and Resource properties . . . . . . . . . . . . . 12 | 2.2.6. speakToAs . . . . . . . . . . . . . . . . . . . . . . 12 | |||
2.3.1. emails . . . . . . . . . . . . . . . . . . . . . . . 12 | 2.3. Contact and Resource properties . . . . . . . . . . . . . 13 | |||
2.3.2. phones . . . . . . . . . . . . . . . . . . . . . . . 13 | 2.3.1. emails . . . . . . . . . . . . . . . . . . . . . . . 13 | |||
2.3.3. online . . . . . . . . . . . . . . . . . . . . . . . 14 | 2.3.2. phones . . . . . . . . . . . . . . . . . . . . . . . 14 | |||
2.3.3. online . . . . . . . . . . . . . . . . . . . . . . . 15 | ||||
2.3.4. photos . . . . . . . . . . . . . . . . . . . . . . . 15 | 2.3.4. photos . . . . . . . . . . . . . . . . . . . . . . . 15 | |||
2.3.5. preferredContactMethod . . . . . . . . . . . . . . . 15 | 2.3.5. preferredContactMethod . . . . . . . . . . . . . . . 16 | |||
2.3.6. preferredContactLanguages . . . . . . . . . . . . . . 15 | 2.3.6. preferredContactLanguages . . . . . . . . . . . . . . 16 | |||
2.4. Address and Location properties . . . . . . . . . . . . . 16 | 2.4. Address and Location properties . . . . . . . . . . . . . 17 | |||
2.4.1. addresses . . . . . . . . . . . . . . . . . . . . . . 16 | 2.4.1. addresses . . . . . . . . . . . . . . . . . . . . . . 17 | |||
2.5. Multilingual properties . . . . . . . . . . . . . . . . . 19 | ||||
2.5. Multilingual properties . . . . . . . . . . . . . . . . . 18 | 2.5.1. localizations . . . . . . . . . . . . . . . . . . . . 19 | |||
2.5.1. localizations . . . . . . . . . . . . . . . . . . . . 18 | 2.6. Additional properties . . . . . . . . . . . . . . . . . . 19 | |||
2.6. Additional properties . . . . . . . . . . . . . . . . . . 18 | ||||
2.6.1. anniversaries . . . . . . . . . . . . . . . . . . . . 19 | 2.6.1. anniversaries . . . . . . . . . . . . . . . . . . . . 19 | |||
2.6.2. personalInfo . . . . . . . . . . . . . . . . . . . . 19 | 2.6.2. personalInfo . . . . . . . . . . . . . . . . . . . . 20 | |||
2.6.3. notes . . . . . . . . . . . . . . . . . . . . . . . . 20 | 2.6.3. notes . . . . . . . . . . . . . . . . . . . . . . . . 21 | |||
2.6.4. categories . . . . . . . . . . . . . . . . . . . . . 20 | 2.6.4. categories . . . . . . . . . . . . . . . . . . . . . 21 | |||
2.6.5. timeZones . . . . . . . . . . . . . . . . . . . . . . 20 | 2.6.5. timeZones . . . . . . . . . . . . . . . . . . . . . . 21 | |||
3. CardGroup . . . . . . . . . . . . . . . . . . . . . . . . . . 20 | 3. CardGroup . . . . . . . . . . . . . . . . . . . . . . . . . . 21 | |||
3.1. Group properties . . . . . . . . . . . . . . . . . . . . 20 | 3.1. Group properties . . . . . . . . . . . . . . . . . . . . 21 | |||
3.1.1. @type . . . . . . . . . . . . . . . . . . . . . . . . 20 | 3.1.1. @type . . . . . . . . . . . . . . . . . . . . . . . . 21 | |||
3.1.2. uid . . . . . . . . . . . . . . . . . . . . . . . . . 21 | 3.1.2. uid . . . . . . . . . . . . . . . . . . . . . . . . . 21 | |||
3.1.3. members . . . . . . . . . . . . . . . . . . . . . . . 21 | 3.1.3. members . . . . . . . . . . . . . . . . . . . . . . . 22 | |||
3.1.4. name . . . . . . . . . . . . . . . . . . . . . . . . 21 | 3.1.4. name . . . . . . . . . . . . . . . . . . . . . . . . 22 | |||
3.1.5. card . . . . . . . . . . . . . . . . . . . . . . . . 21 | 3.1.5. card . . . . . . . . . . . . . . . . . . . . . . . . 22 | |||
4. Implementation Status . . . . . . . . . . . . . . . . . . . . 21 | 4. Implementation Status . . . . . . . . . . . . . . . . . . . . 22 | |||
4.1. IIT-CNR/Registro.it . . . . . . . . . . . . . . . . . . . 21 | 4.1. IIT-CNR/Registro.it . . . . . . . . . . . . . . . . . . . 22 | |||
5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 22 | 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 23 | |||
6. Security Considerations . . . . . . . . . . . . . . . . . . . 22 | 6. Security Considerations . . . . . . . . . . . . . . . . . . . 23 | |||
7. References . . . . . . . . . . . . . . . . . . . . . . . . . 22 | 7. References . . . . . . . . . . . . . . . . . . . . . . . . . 23 | |||
7.1. Normative References . . . . . . . . . . . . . . . . . . 22 | 7.1. Normative References . . . . . . . . . . . . . . . . . . 23 | |||
7.2. Informative References . . . . . . . . . . . . . . . . . 23 | 7.2. Informative References . . . . . . . . . . . . . . . . . 24 | |||
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 25 | Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 25 | |||
1. Introduction | 1. Introduction | |||
This document defines a data model for contact card data normally | This document defines a data model for contact card data normally | |||
used in address book or directory applications and services. It aims | used in address book or directory applications and services. It aims | |||
to be an alternative to the vCard data format [RFC6350] and to | to be an alternative to the vCard data format [RFC6350] and to | |||
provide a JSON-based standard representation of contact card data. | provide a JSON-based standard representation of contact card data. | |||
The key design considerations for this data model are as follows: | The key design considerations for this data model are as follows: | |||
skipping to change at page 12, line 36 ¶ | skipping to change at page 12, line 36 ¶ | |||
* @type: String (mandatory). Specifies the type of this object. | * @type: String (mandatory). Specifies the type of this object. | |||
This MUST be Title. | This MUST be Title. | |||
* title: String (mandatory). The title of the entity represented by | * title: String (mandatory). The title of the entity represented by | |||
this card. | this card. | |||
* organization: Id (optional). The id of the organization in which | * organization: Id (optional). The id of the organization in which | |||
this title is held. | this title is held. | |||
2.2.6. speakToAs | ||||
Type: SpeakToAs (optional). | ||||
Provides information how to address, speak to or refer to the entity | ||||
that is represented by this card. A SpeakToAs object has the | ||||
following properties, of which at least one property other than @type | ||||
MUST be set: | ||||
* @type: String (mandatory). Specifies the type of this object. | ||||
This MUST be SpeakToAs. | ||||
* grammaticalGender: String (optional). Defines which grammatical | ||||
gender to use in salutations and other grammatical constructs. | ||||
Allowed values are: | ||||
- animate | ||||
- female | ||||
- inanimate | ||||
- male | ||||
- neuter | ||||
Note that the grammatical gender does not allow to infer the | ||||
gender identities or biological sex of the contact. | ||||
* pronouns: String (optional). Defines the gender pronouns that the | ||||
contact chooses to use for themselves. Any value or form is | ||||
allowed. Examples in English include she/her and they/them/ | ||||
theirs. | ||||
The property values SHOULD be localized in the language defined in | ||||
the language property. They MAY be overridden in the localizations | ||||
property (Section 2.5.1). | ||||
2.3. Contact and Resource properties | 2.3. Contact and Resource properties | |||
2.3.1. emails | 2.3.1. emails | |||
Type: Id[EmailAddress] (optional). | Type: Id[EmailAddress] (optional). | |||
The email addresses to contact the entity represented by this card. | The email addresses to contact the entity represented by this card. | |||
An EmailAddress object has the following properties: | An EmailAddress object has the following properties: | |||
* @type: String (mandatory). Specifies the type of this object. | * @type: String (mandatory). Specifies the type of this object. | |||
End of changes. 9 change blocks. | ||||
34 lines changed or deleted | 71 lines changed or added | |||
This html diff was produced by rfcdiff 1.48. The latest version is available from http://tools.ietf.org/tools/rfcdiff/ |