The JSON Meta Application Protocol (JMAP)
RFC 8620
| Document | Type |
RFC - Proposed Standard
(July 2019; Errata)
Was draft-ietf-jmap-core (jmap WG)
|
|
|---|---|---|---|
| Last updated | 2019-07-24 | ||
| Replaces | draft-jenkins-jmap | ||
| Stream | IETF | ||
| Formats | plain text pdf htmlized with errata bibtex | ||
| Reviews | |||
| Stream | WG state | Submitted to IESG for Publication | |
| Document shepherd | Bron Gondwana | ||
| Shepherd write-up | Show (last changed 2018-12-02) | ||
| IESG | IESG state | RFC 8620 (Proposed Standard) | |
| Consensus Boilerplate | Yes | ||
| Telechat date | |||
| Responsible AD | Alexey Melnikov | ||
| Send notices to | Bron Gondwana <brong@fastmailteam.com> | ||
| IANA | IANA review state | Version Changed - Review Needed | |
| IANA action state | RFC-Ed-Ack | ||
Internet Engineering Task Force (IETF) N. Jenkins
Request for Comments: 8620 Fastmail
Category: Standards Track C. Newman
ISSN: 2070-1721 Oracle
July 2019
The JSON Meta Application Protocol (JMAP)
Abstract
This document specifies a protocol for clients to efficiently query,
fetch, and modify JSON-based data objects, with support for push
notification of changes and fast resynchronisation and for out-of-
band binary data upload/download.
Status of This Memo
This is an Internet Standards Track document.
This document is a product of the Internet Engineering Task Force
(IETF). It represents the consensus of the IETF community. It has
received public review and has been approved for publication by the
Internet Engineering Steering Group (IESG). Further information on
Internet Standards is available in Section 2 of RFC 7841.
Information about the current status of this document, any errata,
and how to provide feedback on it may be obtained at
https://www.rfc-editor.org/info/rfc8620.
Copyright Notice
Copyright (c) 2019 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents
(https://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.
Jenkins & Newman Standards Track [Page 1]
RFC 8620 JMAP July 2019
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 4
1.1. Notational Conventions . . . . . . . . . . . . . . . . . 4
1.2. The Id Data Type . . . . . . . . . . . . . . . . . . . . 6
1.3. The Int and UnsignedInt Data Types . . . . . . . . . . . 6
1.4. The Date and UTCDate Data Types . . . . . . . . . . . . . 7
1.5. JSON as the Data Encoding Format . . . . . . . . . . . . 7
1.6. Terminology . . . . . . . . . . . . . . . . . . . . . . . 7
1.6.1. User . . . . . . . . . . . . . . . . . . . . . . . . 7
1.6.2. Accounts . . . . . . . . . . . . . . . . . . . . . . 7
1.6.3. Data Types and Records . . . . . . . . . . . . . . . 8
1.7. The JMAP API Model . . . . . . . . . . . . . . . . . . . 8
1.8. Vendor-Specific Extensions . . . . . . . . . . . . . . . 9
2. The JMAP Session Resource . . . . . . . . . . . . . . . . . . 9
2.1. Example . . . . . . . . . . . . . . . . . . . . . . . . . 14
2.2. Service Autodiscovery . . . . . . . . . . . . . . . . . . 15
3. Structured Data Exchange . . . . . . . . . . . . . . . . . . 16
3.1. Making an API Request . . . . . . . . . . . . . . . . . . 16
3.2. The Invocation Data Type . . . . . . . . . . . . . . . . 16
3.3. The Request Object . . . . . . . . . . . . . . . . . . . 16
3.3.1. Example Request . . . . . . . . . . . . . . . . . . . 18
3.4. The Response Object . . . . . . . . . . . . . . . . . . . 18
3.4.1. Example Response . . . . . . . . . . . . . . . . . . 19
3.5. Omitting Arguments . . . . . . . . . . . . . . . . . . . 19
3.6. Errors . . . . . . . . . . . . . . . . . . . . . . . . . 19
3.6.1. Request-Level Errors . . . . . . . . . . . . . . . . 20
3.6.2. Method-Level Errors . . . . . . . . . . . . . . . . . 21
3.7. References to Previous Method Results . . . . . . . . . . 22
3.8. Localisation of User-Visible Strings . . . . . . . . . . 27
3.9. Security . . . . . . . . . . . . . . . . . . . . . . . . 28
3.10. Concurrency . . . . . . . . . . . . . . . . . . . . . . . 28
4. The Core/echo Method . . . . . . . . . . . . . . . . . . . . 28
4.1. Example . . . . . . . . . . . . . . . . . . . . . . . . . 28
5. Standard Methods and Naming Convention . . . . . . . . . . . 29
5.1. /get . . . . . . . . . . . . . . . . . . . . . . . . . . 29
5.2. /changes . . . . . . . . . . . . . . . . . . . . . . . . 30
5.3. /set . . . . . . . . . . . . . . . . . . . . . . . . . . 34
5.4. /copy . . . . . . . . . . . . . . . . . . . . . . . . . . 40
5.5. /query . . . . . . . . . . . . . . . . . . . . . . . . . 42
5.6. /queryChanges . . . . . . . . . . . . . . . . . . . . . . 48
5.7. Examples . . . . . . . . . . . . . . . . . . . . . . . . 51
Show full document text