idnits 2.17.1 draft-ietf-jmap-mdn-04.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 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 (December 16, 2019) is 1593 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: 1 error (**), 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 December 16, 2019 5 Expires: June 18, 2020 7 Handling Message Disposition Notification with JMAP 8 draft-ietf-jmap-mdn-04 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 June 18, 2020. 32 Copyright Notice 34 Copyright (c) 2019 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 . . . . . . . . . . . . . . . . . 3 51 1.2. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3 52 1.3. Addition to the capabilities object . . . . . . . . . . . 3 53 2. MDN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 54 2.1. MDN/set . . . . . . . . . . . . . . . . . . . . . . . . . 5 55 2.2. MDN/parse . . . . . . . . . . . . . . . . . . . . . . . . 5 56 3. Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 57 3.1. Sending an MDN for a received email . . . . . . . . . . . 6 58 3.2. Asking for MDN when sending an email . . . . . . . . . . 7 59 3.3. Parsing a received MDN . . . . . . . . . . . . . . . . . 7 60 4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 8 61 4.1. JMAP Capability Registration for "mdn" . . . . . . . . . 8 62 5. Security considerations . . . . . . . . . . . . . . . . . . . 8 63 6. References . . . . . . . . . . . . . . . . . . . . . . . . . 8 64 6.1. Normative References . . . . . . . . . . . . . . . . . . 9 65 6.2. Informative References . . . . . . . . . . . . . . . . . 9 66 Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 9 68 1. Introduction 70 JMAP ([RFC8620] - JSON Meta Application Protocol) is a generic 71 protocol for synchronising data, such as mail, calendars or contacts, 72 between a client and a server. It is optimised for mobile and web 73 environments, and aims to provide a consistent interface to different 74 data types. 76 MDN are defined in [RFC8098] and are used as "read receipts", 77 "acknowledgements", or "receipt notifications". 79 A client can have to deal with MDN in different ways: 81 1. When receiving an email, an MDN can be sent to the sender. This 82 specification defines an MDN/set method to cover this case. 84 2. When sending an email, an MDN can be requested. This must be 85 done with the help of a header, and is already specified by 86 [RFC8098] and can already be handled by [RFC8621] this way. 88 3. When receiving an MDN, the MDN could be related to an existing 89 sent mail. This is already covered by [RFC8621] in the 90 EmailSubmission object. Client could want to display detailed 91 information about a received MDN. This specification defines a 92 MDN/parse method to cover this case. 94 1.1. Notational conventions 96 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 97 "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and 98 "OPTIONAL" in this document are to be interpreted as described in BCP 99 14 [RFC2119] [RFC8174] when, and only when, they appear in all 100 capitals, as shown here. 102 Type signatures, examples and property descriptions in this document 103 follow the conventions established in section 1.1 of [RFC8620]. Data 104 types defined in the core specification are also used in this 105 document. 107 Servers MUST support all properties specified for the new data types 108 defined in this document. 110 1.2. Terminology 112 The same terminology is used in this document as in the core JMAP 113 specification. 115 1.3. Addition to the capabilities object 117 Capabilities are announced as part of the standard JMAP Session 118 resource; see [RFC8620], section 2. 120 Support for the "MDN" data type and the "MDN/parse" method are 121 represented by the capability "urn:ietf:params:jmap:mdn" being 122 present in the "capabilities" property. The capability 123 "urn:ietf:params:jmap:mdn" being present in the "accountCapabilities" 124 property of an account represents support for creating and sending 125 MDN messages via the "MDN/set" method. Servers that include the 126 capability in one or more "accountCapabilities" properties MUST also 127 include the property in the "capabilities" property. 129 The value of this "urn:ietf:params:jmap:mdn" property is an empty 130 object in both the JMAP session "capabilities" property and an 131 account's "accountCapabilities" property. 133 2. MDN 135 An *MDN* object has the following properties: 137 o forEmailId: "Id|null" Email Id of the received email this MDN is 138 relative to. 140 o subject: "String|null" Subject used as "Subject" header for this 141 MDN. 143 o textBody: "String|null" Human readable part of the MDN, as plain 144 text. 146 o reportingUA: "String|null" Name of the MUA creating this MDN. It 147 is used to build the MDN Report part of the MDN. 149 o disposition: "Disposition" Object containing the diverse MDN 150 disposition options. 152 o mdnGateway: "String|null" (server-set) Name of the gateway or MTA 153 that translated a foreign (non-Internet) message disposition 154 notification into this MDN. 156 o originalRecipient: "String|null" (server-set) Original recipient 157 address as specified by the sender of the message for which the 158 MDN is being issued. 160 o finalRecipient: "String" (server-set) Recipient for which the MDN 161 is being issued. 163 o originalMessageId: "String|null" (server-set) Message-ID (the 164 [RFC5322] header field, not the JMAP Id) of the message for which 165 the MDN is being issued. 167 o error: "String[]|null" (server-set) Additional information in the 168 form of text messages when the "error" disposition modifier 169 appears. 171 o extensionFields: "String[String]|null" (server-set) Object where 172 keys are extension-field names and values are extension-field 173 values. 175 A *Disposition* object has the following properties: 177 o actionMode: "String" This MUST be one of the following strings: 178 "manual-action" / "automatic-action" 180 o sendingMode: "String" This MUST be one of the following strings: 181 "MDN-sent-manually" / "MDN-sent-automatically" 183 o type: "String" This MUST be one of the following strings: 184 "deleted" / "dispatched" / "displayed" / "processed" 186 See [RFC8098] for the exact meaning of these different fields. 188 2.1. MDN/set 190 This is a standard "/set" method as described in [RFC8620] where only 191 create is supported; any attempt to update/destroy MUST be rejected 192 with a "forbidden" SetError. 194 The MDN/set method generates and sends an [RFC5322] message from an 195 MDN object. 197 The client SHOULD NOT issue a MDN/set request if the message has the 198 "$MDNSent" keyword set. In this case, the server MUST reject the 199 submission with a standard "alreadyExists" SetError. 201 When sending the MDN, the server is in charge of generating the 202 "originalRecipient", "finalRecipient" and "originalMessageId" fields 203 accordingly to the [RFC8098] specification. 205 After all items in the "MDN/set" invocation have been processed, a 206 single implicit "Email/set" call MUST be made to set the "$MDNSent" 207 keyword on "Email" objects referenced by "MDN" objects that have been 208 successfully created (see [RFC3503] for more details). The response 209 to this MUST be returned after the "MDN/set" response. 211 2.2. MDN/parse 213 This method allows a client to parse blobs as [RFC5322] messages to 214 get MDN objects. This can be used to parse and get detailed 215 information about blobs referenced in the "mdnBlobIds" of the 216 EmailSubmission object, or any email the client could expect to be an 217 MDN. 219 The "forEmailId" property can be null or missing if the 220 "originalMessageId" property is missing or not referencing an 221 existing email. 223 The MDN/parse method takes the following arguments: 225 o accountId: "Id" The id of the account to use. 227 o blobIds: "Id[]" The ids of the blobs to parse. 229 The response has the following arguments: 231 o accountId: "Id" The id of the account used for the call. 233 o parsed: "Id[MDN]|null" A map of blob id to parsed MDN 234 representation for each successfully parsed blob, or null if none. 236 o notParsable: "Id[]|null" A list of ids given that corresponded to 237 blobs that could not be parsed as MDNs, or null if none. 239 o notFound: "Id[]|null" A list of blob ids given that could not be 240 found, or null if none. 242 3. Samples 244 3.1. Sending an MDN for a received email 246 A client can use the following request to send an MDN back to the 247 sender: 249 [[ "MDN/set", { 250 "accountId": "ue150411c", 251 "create": { 252 "k1546": { 253 "forEmailId": "Md45b47b4877521042cec0938", 254 "subject": "Read receipt for: World domination", 255 "textBody": "This receipt shows that the email has been 256 displayed on your recipient's computer. There is no 257 guaranty it has been read or understood.", 258 "reportingUA": "linagora.com; OpenPaaS", 259 "disposition": { 260 "actionMode": "manual-action", 261 "sendingMode": "MDN-sent-manually", 262 "type": "displayed" 263 } 264 } 265 } 266 }, "0" ]] 268 If the email id matches an existing email without the "$MDNSent" 269 keyword, the server can answer: 271 [[ "MDN/set", { 272 "accountId": "ue150411c", 273 "oldState": "012421s6-8nrq-4ps4-n0p4-9330r951ns21", 274 "newState": "355421f6-8aed-4cf4-a0c4-7377e951af36", 275 "created": { 276 "k1546": { 277 "finalRecipient": "rfc822; john@example.com", 278 "originalMessageId": "<1521557867.2614.0.camel@apache.org>" 279 } 280 } 281 }, "0" ], 283 3.2. Asking for MDN when sending an email 285 This is done with the [RFC8621] "Email/set" "create" method. 287 [[ "Email/set", { 288 "accountId": "ue150411c", 289 "create": { 290 "k1546": { 291 "mailboxIds": { 292 "2ea1ca41b38e": true 293 }, 294 "keywords": { 295 "$seen": true, 296 "$draft": true 297 }, 298 "from": [{ 299 "name": "Joe Bloggs", 300 "email": "joe@example.com" 301 }], 302 "to": [{ 303 "name": "John", 304 "email": "john@example.com" 305 }], 306 "header:Disposition-Notification-To": "joe@example.com", 307 "subject": "World domination", 308 ... 309 } 310 } 311 }, "0" ]] 313 Note the specified "Disposition-Notification-To" header indicating 314 where to send MDN back (usually the sender of the email). 316 3.3. Parsing a received MDN 318 The client issues a parse request: 320 [[ "MDN/parse", { 321 "accountId": "ue150411c", 322 "blobIds: [ "0f9f65ab-dc7b-4146-850f-6e4881093965" ] 323 }, "0" ]] 325 The server responds: 327 [[ "MDN/parse", { 328 "accountId": "ue150411c", 329 "parsed": { 330 "0f9f65ab-dc7b-4146-850f-6e4881093965": { 331 "forEmailId": "Md45b47b4877521042cec0938", 332 "subject": "Read receipt for: World domination", 333 "textBody": "This receipt shows that the email has been 334 displayed on your recipient's computer. There is no 335 guaranty it has been read or understood.", 336 "reportingUA": "linagora.com; OpenPaaS", 337 "disposition": { 338 "actionMode": "manual-action", 339 "sendingMode": "MDN-sent-manually", 340 "type": "displayed" 341 } 342 "finalRecipient": "rfc822; john@example.com", 343 "originalMessageId": "<1521557867.2614.0.camel@apache.org>" 344 } 345 } 346 }, "0" ]] 348 4. IANA Considerations 350 4.1. JMAP Capability Registration for "mdn" 352 IANA will register the "mdn" JMAP Capability as follows: 354 Capability Name: "urn:ietf:params:jmap:mdn" 356 Specification document: this document 358 Intended use: common 360 Change Controller: IETF 362 Security and privacy considerations: this document, section 5. 364 5. Security considerations 366 The same considerations regarding MDN (see [RFC8098] and [RFC3503]) 367 apply to this document. 369 6. References 370 6.1. Normative References 372 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 373 Requirement Levels", BCP 14, RFC 2119, 374 DOI 10.17487/RFC2119, March 1997, 375 . 377 [RFC3503] Melnikov, A., "Message Disposition Notification (MDN) 378 profile for Internet Message Access Protocol (IMAP)", 379 RFC 3503, DOI 10.17487/RFC3503, March 2003, 380 . 382 [RFC5322] Resnick, P., Ed., "Internet Message Format", RFC 5322, 383 DOI 10.17487/RFC5322, October 2008, 384 . 386 [RFC8098] Hansen, T., Ed. and A. Melnikov, Ed., "Message Disposition 387 Notification", STD 85, RFC 8098, DOI 10.17487/RFC8098, 388 February 2017, . 390 [RFC8620] Jenkins, N. and C. Newman, "The JSON Meta Application 391 Protocol (JMAP)", RFC 8620, DOI 10.17487/RFC8620, July 392 2019, . 394 [RFC8621] Jenkins, N. and C. Newman, "The JSON Meta Application 395 Protocol (JMAP) for Mail", RFC 8621, DOI 10.17487/RFC8621, 396 August 2019, . 398 6.2. Informative References 400 [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 401 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 402 May 2017, . 404 Author's Address 406 Raphael Ouazana (editor) 407 Linagora 408 100 Terrasse Boieldieu - Tour Franklin 409 Paris - La Defense CEDEX 92042 410 France 412 Email: rouazana@linagora.com 413 URI: https://www.linagora.com