JSON Meta Application Protocol
draft-ietf-jmap-core-02

The information below is for an old version of the document
Document Type Active Internet-Draft (jmap WG)
Last updated 2017-10-29
Replaces draft-jenkins-jmap
Stream IETF
Intended RFC status (None)
Formats plain text pdf html 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                        October 30, 2017
Expires: May 3, 2018

                     JSON Meta Application Protocol
                        draft-ietf-jmap-core-02

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 May 3, 2018.

Copyright Notice

   Copyright (c) 2017 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 May 3, 2018                  [Page 1]
Internet-Draft                    JMAP                      October 2017

Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   3
     1.1.  Notational conventions  . . . . . . . . . . . . . . . . .   3
     1.2.  The Number datatype . . . . . . . . . . . . . . . . . . .   4
     1.3.  The Date datatypes  . . . . . . . . . . . . . . . . . . .   4
     1.4.  JSON as the data encoding format  . . . . . . . . . . . .   4
     1.5.  Terminology . . . . . . . . . . . . . . . . . . . . . . .   4
       1.5.1.  User  . . . . . . . . . . . . . . . . . . . . . . . .   5
       1.5.2.  Accounts  . . . . . . . . . . . . . . . . . . . . . .   5
       1.5.3.  Data types and records  . . . . . . . . . . . . . . .   5
     1.6.  Ids . . . . . . . . . . . . . . . . . . . . . . . . . . .   5
     1.7.  The JMAP API model  . . . . . . . . . . . . . . . . . . .   5
   2.  The JMAP session resource . . . . . . . . . . . . . . . . . .   6
     2.1.  Service Autodiscovery . . . . . . . . . . . . . . . . . .   8
   3.  Structured data exchange  . . . . . . . . . . . . . . . . . .   9
     3.1.  Making an API request . . . . . . . . . . . . . . . . . .   9
     3.2.  The structure of an API request . . . . . . . . . . . . .   9
     3.3.  Omitting arguments  . . . . . . . . . . . . . . . . . . .  10
     3.4.  Errors  . . . . . . . . . . . . . . . . . . . . . . . . .  11
     3.5.  References to previous method results . . . . . . . . . .  11
     3.6.  Vendor-specific extensions  . . . . . . . . . . . . . . .  16
     3.7.  Security  . . . . . . . . . . . . . . . . . . . . . . . .  16
     3.8.  Concurrency . . . . . . . . . . . . . . . . . . . . . . .  16
   4.  Standard methods and naming convention  . . . . . . . . . . .  17
     4.1.  getFoos . . . . . . . . . . . . . . . . . . . . . . . . .  17
     4.2.  getFooUpdates . . . . . . . . . . . . . . . . . . . . . .  18
     4.3.  setFoos . . . . . . . . . . . . . . . . . . . . . . . . .  20
       4.3.1.  Example . . . . . . . . . . . . . . . . . . . . . . .  25
     4.4.  getFooList  . . . . . . . . . . . . . . . . . . . . . . .  27
     4.5.  getFooListUpdates . . . . . . . . . . . . . . . . . . . .  30
   5.  Binary data . . . . . . . . . . . . . . . . . . . . . . . . .  33
     5.1.  Uploading binary data . . . . . . . . . . . . . . . . . .  34
     5.2.  Downloading binary data . . . . . . . . . . . . . . . . .  34
   6.  Push  . . . . . . . . . . . . . . . . . . . . . . . . . . . .  35
     6.1.  The StateChange object  . . . . . . . . . . . . . . . . .  35
     6.2.  PushSubscription  . . . . . . . . . . . . . . . . . . . .  36
       6.2.1.  setPushSubscription . . . . . . . . . . . . . . . . .  37
       6.2.2.  getPushSubscription . . . . . . . . . . . . . . . . .  38
     6.3.  Event Source  . . . . . . . . . . . . . . . . . . . . . .  38
   7.  Security considerations . . . . . . . . . . . . . . . . . . .  39
     7.1.  Transport confidentiality . . . . . . . . . . . . . . . .  39
Show full document text