JSON Meta Application Protocol
draft-ietf-jmap-core-05
| The information below is for an old version of the document |
| Document |
Type |
|
Active Internet-Draft (jmap WG)
|
|
Author |
|
Neil Jenkins
|
|
Last updated |
|
2018-05-08
|
|
Replaces |
|
draft-jenkins-jmap
|
|
Stream |
|
Internet Engineering Task Force (IETF)
|
|
Formats |
|
pdf
htmlized (tools)
htmlized
bibtex
|
|
Reviews |
|
|
| Stream |
WG state
|
|
WG Document
|
|
Document shepherd |
|
No shepherd assigned
|
| IESG |
IESG state |
|
I-D Exists
|
|
Consensus Boilerplate |
|
Unknown
|
|
Telechat date |
|
|
|
Responsible AD |
|
(None)
|
|
Send notices to |
|
(None)
|
JMAP N. Jenkins
Internet-Draft FastMail
Intended status: Standards Track May 9, 2018
Expires: November 10, 2018
JSON Meta Application Protocol
draft-ietf-jmap-core-05
Abstract
This document specifies a protocol for synchronising 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 November 10, 2018.
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 Expires November 10, 2018 [Page 1]
Internet-Draft JMAP May 2018
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1. Notational conventions . . . . . . . . . . . . . . . . . 4
1.2. The Number datatype . . . . . . . . . . . . . . . . . . . 4
1.3. The Date datatypes . . . . . . . . . . . . . . . . . . . 4
1.4. JSON as the data encoding format . . . . . . . . . . . . 5
1.5. Terminology . . . . . . . . . . . . . . . . . . . . . . . 5
1.5.1. User . . . . . . . . . . . . . . . . . . . . . . . . 5
1.5.2. Accounts . . . . . . . . . . . . . . . . . . . . . . 5
1.5.3. Data types and records . . . . . . . . . . . . . . . 5
1.6. Ids . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
1.7. The JMAP API model . . . . . . . . . . . . . . . . . . . 6
2. The JMAP Session resource . . . . . . . . . . . . . . . . . . 7
2.1. Example . . . . . . . . . . . . . . . . . . . . . . . . . 9
2.2. Service Autodiscovery . . . . . . . . . . . . . . . . . . 10
3. Structured data exchange . . . . . . . . . . . . . . . . . . 11
3.1. Making an API request . . . . . . . . . . . . . . . . . . 11
3.2. The Request object . . . . . . . . . . . . . . . . . . . 11
3.2.1. Example request . . . . . . . . . . . . . . . . . . . 12
3.3. Vendor-specific extensions . . . . . . . . . . . . . . . 13
3.4. The Response object . . . . . . . . . . . . . . . . . . . 13
3.4.1. Example response: . . . . . . . . . . . . . . . . . . 13
3.5. Omitting arguments . . . . . . . . . . . . . . . . . . . 14
3.6. Errors . . . . . . . . . . . . . . . . . . . . . . . . . 14
3.6.1. Request-level errors . . . . . . . . . . . . . . . . 14
3.6.2. Method-level errors . . . . . . . . . . . . . . . . . 14
3.7. References to previous method results . . . . . . . . . . 16
3.8. Security . . . . . . . . . . . . . . . . . . . . . . . . 20
3.9. Concurrency . . . . . . . . . . . . . . . . . . . . . . . 20
4. Standard methods and naming convention . . . . . . . . . . . 20
4.1. /get . . . . . . . . . . . . . . . . . . . . . . . . . . 20
4.2. /changes . . . . . . . . . . . . . . . . . . . . . . . . 22
4.3. /set . . . . . . . . . . . . . . . . . . . . . . . . . . 23
4.4. /query . . . . . . . . . . . . . . . . . . . . . . . . . 28
4.5. /queryChanges . . . . . . . . . . . . . . . . . . . . . . 32
4.6. Examples . . . . . . . . . . . . . . . . . . . . . . . . 35
5. Binary data . . . . . . . . . . . . . . . . . . . . . . . . . 38
5.1. Uploading binary data . . . . . . . . . . . . . . . . . . 39
5.2. Downloading binary data . . . . . . . . . . . . . . . . . 40
5.3. Blob/copy . . . . . . . . . . . . . . . . . . . . . . . . 41
6. Push . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Show full document text