The JSON Meta Application Protocol (JMAP) for Mail
RFC 8621

Document Type RFC - Proposed Standard (August 2019; No errata)
Updates RFC 5788
Last updated 2019-08-08
Replaces draft-jenkins-jmapmail
Stream IETF
Formats plain text 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 8621 (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: 8621                                      Fastmail
Updates: 5788                                                  C. Newman
Category: Standards Track                                         Oracle
ISSN: 2070-1721                                              August 2019

           The JSON Meta Application Protocol (JMAP) for Mail

Abstract

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

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/rfc8621.

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 8621                        JMAP Mail                    August 2019

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 . . . . . . . . . . .   7
       1.3.3.  urn:ietf:params:jmap:vacationresponse . . . . . . . .   8
     1.4.  Data Type Support in Different Accounts . . . . . . . . .   8
     1.5.  Push  . . . . . . . . . . . . . . . . . . . . . . . . . .   8
       1.5.1.  Example . . . . . . . . . . . . . . . . . . . . . . .   9
     1.6.  Ids . . . . . . . . . . . . . . . . . . . . . . . . . . .   9
   2.  Mailboxes . . . . . . . . . . . . . . . . . . . . . . . . . .   9
     2.1.  Mailbox/get . . . . . . . . . . . . . . . . . . . . . . .  14
     2.2.  Mailbox/changes . . . . . . . . . . . . . . . . . . . . .  14
     2.3.  Mailbox/query . . . . . . . . . . . . . . . . . . . . . .  14
     2.4.  Mailbox/queryChanges  . . . . . . . . . . . . . . . . . .  15
     2.5.  Mailbox/set . . . . . . . . . . . . . . . . . . . . . . .  16
     2.6.  Example . . . . . . . . . . . . . . . . . . . . . . . . .  17
   3.  Threads . . . . . . . . . . . . . . . . . . . . . . . . . . .  20
     3.1.  Thread/get  . . . . . . . . . . . . . . . . . . . . . . .  22
       3.1.1.  Example . . . . . . . . . . . . . . . . . . . . . . .  22
     3.2.  Thread/changes  . . . . . . . . . . . . . . . . . . . . .  22
   4.  Emails  . . . . . . . . . . . . . . . . . . . . . . . . . . .  22
     4.1.  Properties of the Email Object  . . . . . . . . . . . . .  23
       4.1.1.  Metadata  . . . . . . . . . . . . . . . . . . . . . .  24
       4.1.2.  Header Fields Parsed Forms  . . . . . . . . . . . . .  26
       4.1.3.  Header Fields Properties  . . . . . . . . . . . . . .  32
       4.1.4.  Body Parts  . . . . . . . . . . . . . . . . . . . . .  35
     4.2.  Email/get . . . . . . . . . . . . . . . . . . . . . . . .  42
       4.2.1.  Example . . . . . . . . . . . . . . . . . . . . . . .  44
     4.3.  Email/changes . . . . . . . . . . . . . . . . . . . . . .  45
     4.4.  Email/query . . . . . . . . . . . . . . . . . . . . . . .  45
       4.4.1.  Filtering . . . . . . . . . . . . . . . . . . . . . .  46
       4.4.2.  Sorting . . . . . . . . . . . . . . . . . . . . . . .  49
       4.4.3.  Thread Collapsing . . . . . . . . . . . . . . . . . .  50
     4.5.  Email/queryChanges  . . . . . . . . . . . . . . . . . . .  51
     4.6.  Email/set . . . . . . . . . . . . . . . . . . . . . . . .  51
     4.7.  Email/copy  . . . . . . . . . . . . . . . . . . . . . . .  53
Show full document text