idnits 2.17.1 draft-ietf-jmap-mdn-00.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- ** The document seems to lack a Security Considerations section. ** The abstract seems to contain references ([RFC8098]), which it shouldn't. Please replace those with straight textual mentions of the documents in question. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year -- The document date (July 25, 2018) is 2092 days in the past. Is this intentional? Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) No issues found here. Summary: 2 errors (**), 0 flaws (~~), 1 warning (==), 1 comment (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 JMAP R. Ouazana, Ed. 3 Internet-Draft Linagora 4 Intended status: Standards Track July 25, 2018 5 Expires: January 26, 2019 7 Sending an MDN Response with JMAP 8 draft-ietf-jmap-mdn-00 10 Abstract 12 This document specifies a data model for handling [RFC8098] MDN 13 messages with a server using JMAP. 15 Status of This Memo 17 This Internet-Draft is submitted in full conformance with the 18 provisions of BCP 78 and BCP 79. 20 Internet-Drafts are working documents of the Internet Engineering 21 Task Force (IETF). Note that other groups may also distribute 22 working documents as Internet-Drafts. The list of current Internet- 23 Drafts is at https://datatracker.ietf.org/drafts/current/. 25 Internet-Drafts are draft documents valid for a maximum of six months 26 and may be updated, replaced, or obsoleted by other documents at any 27 time. It is inappropriate to use Internet-Drafts as reference 28 material or to cite them other than as "work in progress." 30 This Internet-Draft will expire on January 26, 2019. 32 Copyright Notice 34 Copyright (c) 2018 IETF Trust and the persons identified as the 35 document authors. All rights reserved. 37 This document is subject to BCP 78 and the IETF Trust's Legal 38 Provisions Relating to IETF Documents 39 (https://trustee.ietf.org/license-info) in effect on the date of 40 publication of this document. Please review these documents 41 carefully, as they describe your rights and restrictions with respect 42 to this document. Code Components extracted from this document must 43 include Simplified BSD License text as described in Section 4.e of 44 the Trust Legal Provisions and are provided without warranty as 45 described in the Simplified BSD License. 47 Table of Contents 49 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 50 1.1. Notational conventions . . . . . . . . . . . . . . . . . 2 51 1.2. Terminology . . . . . . . . . . . . . . . . . . . . . . . 2 52 1.3. Addition to the capabilities object . . . . . . . . . . . 2 53 2. Email/createMDN . . . . . . . . . . . . . . . . . . . . . . . 3 54 3. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 4 55 3.1. JMAP Capability Registration for "mdn" . . . . . . . . . 4 56 4. Normative References . . . . . . . . . . . . . . . . . . . . 4 57 Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 5 59 1. Introduction 61 JMAP is a 62 generic protocol for synchronising data, such as mail, calendars or 63 contacts, between a client and a server. It is optimised for mobile 64 and web environments, and aims to provide a consistent interface to 65 different data types. 67 This specification defines a method helping to send MDN (Message 68 Disposition Nodification) messages. MDN are defined in [RFC8098] and 69 are used as "read receipts", "acknowledgements", or "receipt 70 notifications". 72 1.1. Notational conventions 74 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 75 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 76 document are to be interpreted as described in [RFC2119]. 78 Type signatures, examples and property descriptions in this document 79 follow the conventions established in Section 1.1 of 80 . Email object 81 and methods are defined in . 84 1.2. Terminology 86 The same terminology is used in this document as in the core JMAP 87 specification. 89 1.3. Addition to the capabilities object 91 The capabilities object is returned as part of the standard JMAP 92 Session object; see the JMAP spec. Servers supporting _this_ 93 specification MUST add a property called "urn:ietf:params:jmap:mdn" 94 to the capabilities object. 96 2. Email/createMDN 98 The Email/createMDN method create a [RFC5322] message from MDN 99 properties. 101 It takes the following arguments: 103 o *accountId*: "String|null" The id of the account to use for this 104 call. If "null", defaults to the "urn:ietf:params:jmap:mail" 105 primary account. 107 o *mdns*: "String[MDN]" A map of creation id (client specified) to 108 MDN objects 110 An *MDN* object has the following properties: 112 o *referencedMessageId*: "String" Message Id of the received message 113 the user wants to create an MDN for. 115 o *subject*: "String" Subject that will be used as "Subject" header 116 for this MDN. 118 o *textBody*: "String" Human readable part of the MDN, as plain 119 text. 121 o *reportingUA*: "String" Name of the MUA creating this MDN. It is 122 used to build the MDN Report part of the MDN. 124 o *disposition*: "Disposition" Object containing the diverse MDN 125 disposition options. 127 A *Disposition* object has the following properties: 129 o *actionMode*: "String" This MUST be one of the following strings: 130 "manual-action" / "automatic-action" 132 o *sendingMode*: "String" This MUST be one of the following strings: 133 "MDN-sent-manually" / "MDN-sent-automatically" 135 o *type*: "String" This MUST be one of the following strings: 136 "deleted" / "dispatched" / "displayed" / "processed" 138 See [RFC8098] for the exact meaning of these different fields. 140 If the _referencedMessageId_, _subject_, _textBody_, _reportingUA_, 141 _disposition_ properties are invalid (e.g. missing, wrong type, id 142 not found), the server MUST reject the import with an 143 "invalidProperties" SetError. 145 If the email cannot be created because it would take the account over 146 quota, the creation should be rejected with a "maxQuotaReached" 147 SetError. 149 The response has the following arguments: 151 o *accountId*: "String" The id of the account used for this call. 153 o *created*: "String[Email]" A map of the creation id to an object 154 build from the referenced properties. The _blobId_ field of the 155 Email objects can then be used to effectively send the MDN. 157 o *notCreated*: "String[SetError]" A map of creation id to a 158 SetError object for each Email that failed to be created. The 159 possible errors are defined above. 161 3. IANA Considerations 163 3.1. JMAP Capability Registration for "mdn" 165 IANA will register the "mdn" JMAP Capability as follows: 167 Capability Name: "urn:ietf:params:jmap:mdn" 169 Specification document: this document 171 Intended use: common 173 Change Controller: IETF 175 Security and privacy considerations: this document, section 4. 177 4. Normative References 179 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 180 Requirement Levels", BCP 14, RFC 2119, 181 DOI 10.17487/RFC2119, March 1997, 182 . 184 [RFC5322] Resnick, P., Ed., "Internet Message Format", RFC 5322, 185 DOI 10.17487/RFC5322, October 2008, 186 . 188 [RFC8098] Hansen, T., Ed. and A. Melnikov, Ed., "Message Disposition 189 Notification", STD 85, RFC 8098, DOI 10.17487/RFC8098, 190 February 2017, . 192 Author's Address 194 Raphael Ouazana (editor) 195 Linagora 196 100 Terrasse Boieldieu - Tour Franklin 197 Paris - La Defense CEDEX 92042 198 France 200 Email: rouazana@linagora.com 201 URI: https://www.linagora.com