JMAP (JSON Meta Application Protocol) for Mail
draft-ietf-jmap-mail-16

Document Type Active Internet-Draft (jmap WG)
Last updated 2019-06-17 (latest revision 2019-03-07)
Replaces draft-jenkins-jmapmail
Stream IETF
Intended RFC status Proposed Standard
Formats plain text xml pdf html 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 Ed Queue
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
RFC Editor RFC Editor state AUTH48
JMAP                                                          N. Jenkins
Internet-Draft                                                  FastMail
Updates: 5788 (if approved)                                    C. Newman
Intended status: Standards Track                                  Oracle
Expires: September 9, 2019                                 March 8, 2019

             JMAP (JSON Meta Application Protocol) for Mail
                        draft-ietf-jmap-mail-16

Abstract

   This document specifies a data model for synchronising email data
   with a server using JMAP (the JSON Meta Application Protocol).
   Clients can use this to efficiently search, access, organise and send
   messages, and get pushed notifications for fast resynchronisation
   when new messages are delivered or a change is made in another
   client.

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 September 9, 2019.

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

Jenkins & Newman        Expires September 9, 2019               [Page 1]
Internet-Draft                  JMAP Mail                     March 2019

   the Trust Legal Provisions and are provided without warranty as
   described in the Simplified BSD License.

Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   4
     1.1.  Notational conventions  . . . . . . . . . . . . . . . . .   4
     1.2.  Terminology . . . . . . . . . . . . . . . . . . . . . . .   5
     1.3.  Additions to the capabilities object  . . . . . . . . . .   5
       1.3.1.  urn:ietf:params:jmap:mail . . . . . . . . . . . . . .   5
       1.3.2.  urn:ietf:params:jmap:submission . . . . . . . . . . .   6
       1.3.3.  urn:ietf:params:jmap:vacationresponse . . . . . . . .   7
     1.4.  Data type support in different accounts . . . . . . . . .   7
     1.5.  Push  . . . . . . . . . . . . . . . . . . . . . . . . . .   8
       1.5.1.  Example . . . . . . . . . . . . . . . . . . . . . . .   8
     1.6.  Ids . . . . . . . . . . . . . . . . . . . . . . . . . . .   8
   2.  Mailboxes . . . . . . . . . . . . . . . . . . . . . . . . . .   8
     2.1.  Mailbox/get . . . . . . . . . . . . . . . . . . . . . . .  12
     2.2.  Mailbox/changes . . . . . . . . . . . . . . . . . . . . .  12
     2.3.  Mailbox/query . . . . . . . . . . . . . . . . . . . . . .  13
     2.4.  Mailbox/queryChanges  . . . . . . . . . . . . . . . . . .  14
     2.5.  Mailbox/set . . . . . . . . . . . . . . . . . . . . . . .  14
     2.6.  Example . . . . . . . . . . . . . . . . . . . . . . . . .  14
   3.  Threads . . . . . . . . . . . . . . . . . . . . . . . . . . .  18
     3.1.  Thread/get  . . . . . . . . . . . . . . . . . . . . . . .  19
       3.1.1.  Example . . . . . . . . . . . . . . . . . . . . . . .  19
     3.2.  Thread/changes  . . . . . . . . . . . . . . . . . . . . .  19
   4.  Emails  . . . . . . . . . . . . . . . . . . . . . . . . . . .  20
     4.1.  Properties of the Email object  . . . . . . . . . . . . .  20
       4.1.1.  Metadata  . . . . . . . . . . . . . . . . . . . . . .  21
       4.1.2.  Header fields parsed forms  . . . . . . . . . . . . .  23
       4.1.3.  Header fields properties  . . . . . . . . . . . . . .  28
       4.1.4.  Body parts  . . . . . . . . . . . . . . . . . . . . .  30
     4.2.  Email/get . . . . . . . . . . . . . . . . . . . . . . . .  36
       4.2.1.  Example . . . . . . . . . . . . . . . . . . . . . . .  38
     4.3.  Email/changes . . . . . . . . . . . . . . . . . . . . . .  39
     4.4.  Email/query . . . . . . . . . . . . . . . . . . . . . . .  40
       4.4.1.  Filtering . . . . . . . . . . . . . . . . . . . . . .  40
       4.4.2.  Sorting . . . . . . . . . . . . . . . . . . . . . . .  42
       4.4.3.  Thread collapsing . . . . . . . . . . . . . . . . . .  44
     4.5.  Email/queryChanges  . . . . . . . . . . . . . . . . . . .  44
Show full document text