JSON Meta Application Protocol
draft-ietf-jmap-core-10
| The information below is for an old version of the document |
| Document |
Type |
|
Active Internet-Draft (jmap WG)
|
|
Authors |
|
Neil Jenkins
,
Chris Newman
|
|
Last updated |
|
2018-11-16
(latest revision 2018-11-06)
|
|
Replaces |
|
draft-jenkins-jmap
|
|
Stream |
|
Internet Engineering Task Force (IETF)
|
|
Formats |
|
pdf
htmlized (tools)
htmlized
bibtex
|
|
Reviews |
|
|
| Stream |
WG state
|
|
In WG Last Call
|
|
Document shepherd |
|
No shepherd assigned
|
| IESG |
IESG state |
|
AD is watching
|
|
Consensus Boilerplate |
|
Unknown
|
|
Telechat date |
|
|
|
Responsible AD |
|
Alexey Melnikov
|
|
Send notices to |
|
(None)
|
JMAP N. Jenkins
Internet-Draft FastMail
Intended status: Standards Track C. Newman
Expires: May 10, 2019 Oracle
November 6, 2018
JSON Meta Application Protocol
draft-ietf-jmap-core-10
Abstract
This document specifies a protocol for clients to access JSON-based
data objects efficiently, with support for push and out-of-band
binary data upload/download.
Status of This Memo
This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet-
Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."
This Internet-Draft will expire on May 10, 2019.
Copyright Notice
Copyright (c) 2018 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 Expires May 10, 2019 [Page 1]
Internet-Draft JMAP November 2018
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1. Notational conventions . . . . . . . . . . . . . . . . . 4
1.2. The Int and PositiveInt data types . . . . . . . . . . . 5
1.3. The Date and UTCDate data types . . . . . . . . . . . . . 5
1.4. JSON as the data encoding format . . . . . . . . . . . . 5
1.5. Terminology . . . . . . . . . . . . . . . . . . . . . . . 6
1.5.1. User . . . . . . . . . . . . . . . . . . . . . . . . 6
1.5.2. Accounts . . . . . . . . . . . . . . . . . . . . . . 6
1.5.3. Data types and records . . . . . . . . . . . . . . . 6
1.6. Ids . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
1.7. The JMAP API model . . . . . . . . . . . . . . . . . . . 7
1.8. Vendor-specific extensions . . . . . . . . . . . . . . . 8
2. The JMAP Session resource . . . . . . . . . . . . . . . . . . 8
2.1. Example . . . . . . . . . . . . . . . . . . . . . . . . . 11
2.2. Service Autodiscovery . . . . . . . . . . . . . . . . . . 13
3. Structured data exchange . . . . . . . . . . . . . . . . . . 13
3.1. Making an API request . . . . . . . . . . . . . . . . . . 13
3.2. The Request object . . . . . . . . . . . . . . . . . . . 13
3.2.1. Example request . . . . . . . . . . . . . . . . . . . 15
3.3. The Response object . . . . . . . . . . . . . . . . . . . 15
3.3.1. Example response: . . . . . . . . . . . . . . . . . . 15
3.4. Omitting arguments . . . . . . . . . . . . . . . . . . . 16
3.5. Errors . . . . . . . . . . . . . . . . . . . . . . . . . 16
3.5.1. Request-level errors . . . . . . . . . . . . . . . . 17
3.5.2. Method-level errors . . . . . . . . . . . . . . . . . 17
3.6. References to previous method results . . . . . . . . . . 19
3.7. Security . . . . . . . . . . . . . . . . . . . . . . . . 24
3.8. Concurrency . . . . . . . . . . . . . . . . . . . . . . . 24
4. The Core/echo method . . . . . . . . . . . . . . . . . . . . 24
4.1. Example . . . . . . . . . . . . . . . . . . . . . . . . . 24
5. Standard methods and naming convention . . . . . . . . . . . 25
5.1. /get . . . . . . . . . . . . . . . . . . . . . . . . . . 25
5.2. /changes . . . . . . . . . . . . . . . . . . . . . . . . 26
5.3. /set . . . . . . . . . . . . . . . . . . . . . . . . . . 29
5.4. /copy . . . . . . . . . . . . . . . . . . . . . . . . . . 34
5.5. /query . . . . . . . . . . . . . . . . . . . . . . . . . 36
5.6. /queryChanges . . . . . . . . . . . . . . . . . . . . . . 40
5.7. Examples . . . . . . . . . . . . . . . . . . . . . . . . 42
Show full document text