[Docs] [txt|pdf|xml|html] [Tracker] [WG] [Email] [Diff1] [Diff2] [Nits]
Versions: 00 01 02 03 04 05 06 07 08
JMAP R. Ouazana, Ed.
Internet-Draft Linagora
Intended status: Standards Track February 28, 2020
Expires: August 31, 2020
Handling Message Disposition Notification with JMAP
draft-ietf-jmap-mdn-06
Abstract
This document specifies a data model for handling [RFC8098] MDN
messages with a server using JMAP.
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 August 31, 2020.
Copyright Notice
Copyright (c) 2020 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.
Ouazana Expires August 31, 2020 [Page 1]
Internet-Draft JMAP MDN handling February 2020
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
1.1. Notational conventions . . . . . . . . . . . . . . . . . 3
1.2. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3
1.3. Addition to the capabilities object . . . . . . . . . . . 3
2. MDN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
2.1. MDN/send . . . . . . . . . . . . . . . . . . . . . . . . 5
2.2. MDN/parse . . . . . . . . . . . . . . . . . . . . . . . . 6
3. Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
3.1. Sending an MDN for a received email . . . . . . . . . . . 7
3.2. Asking for MDN when sending an email . . . . . . . . . . 8
3.3. Parsing a received MDN . . . . . . . . . . . . . . . . . 9
4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 10
4.1. JMAP Capability Registration for "mdn" . . . . . . . . . 10
4.2. JMAP Error Codes Registry . . . . . . . . . . . . . . . . 11
4.2.1. mdnAlreadySent . . . . . . . . . . . . . . . . . . . 11
5. Security considerations . . . . . . . . . . . . . . . . . . . 11
6. References . . . . . . . . . . . . . . . . . . . . . . . . . 11
6.1. Normative References . . . . . . . . . . . . . . . . . . 11
6.2. Informative References . . . . . . . . . . . . . . . . . 12
Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 12
1. Introduction
JMAP ([RFC8620] - JSON Meta Application Protocol) is a generic
protocol for synchronising data, such as mail, calendars or contacts,
between a client and a server. It is optimised for mobile and web
environments, and aims to provide a consistent interface to different
data types.
MDN are defined in [RFC8098] and are used as "read receipts",
"acknowledgements", or "receipt notifications".
A client can have to deal with MDN in different ways:
1. When receiving an email, an MDN can be sent to the sender. This
specification defines an MDN/send method to cover this case.
2. When sending an email, an MDN can be requested. This must be
done with the help of a header, and is already specified by
[RFC8098] and can already be handled by [RFC8621] this way.
3. When receiving an MDN, the MDN could be related to an existing
sent mail. This is already covered by [RFC8621] in the
EmailSubmission object. Client could want to display detailed
information about a received MDN. This specification defines an
MDN/parse method to cover this case.
Ouazana Expires August 31, 2020 [Page 2]
Internet-Draft JMAP MDN handling February 2020
1.1. Notational conventions
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
"OPTIONAL" in this document are to be interpreted as described in BCP
14 [RFC2119] [RFC8174] when, and only when, they appear in all
capitals, as shown here.
Type signatures, examples and property descriptions in this document
follow the conventions established in section 1.1 of [RFC8620]. Data
types defined in the core specification are also used in this
document.
Servers MUST support all properties specified for the new data types
defined in this document.
1.2. Terminology
The same terminology is used in this document as in the core JMAP
specification.
1.3. Addition to the capabilities object
Capabilities are announced as part of the standard JMAP Session
resource; see [RFC8620], section 2.
Support for the "MDN" data type and the "MDN/parse" method are
represented by the capability "urn:ietf:params:jmap:mdn" being
present in the "capabilities" property. The capability
"urn:ietf:params:jmap:mdn" being present in the "accountCapabilities"
property of an account represents support for creating and sending
MDN messages via the "MDN/send" method. Servers that include the
capability in one or more "accountCapabilities" properties MUST also
include the property in the "capabilities" property.
The value of this "urn:ietf:params:jmap:mdn" property is an empty
object in both the JMAP session "capabilities" property and an
account's "accountCapabilities" property.
2. MDN
An *MDN* object has the following properties:
o forEmailId: "Id|null" Email Id of the received email this MDN is
relative to.
o subject: "String|null" Subject used as "Subject" header for this
MDN.
Ouazana Expires August 31, 2020 [Page 3]
Internet-Draft JMAP MDN handling February 2020
o textBody: "String|null" Human readable part of the MDN, as plain
text.
o includeOriginalMessage: "Boolean" (default: false). If "true",
the content of the original message will appear in the third
component of the multipart/report generated for the MDN. See
[RFC8098] for details and security considerations.
o reportingUA: "String|null" Name of the MUA creating this MDN. It
is used to build the MDN Report part of the MDN.
o disposition: "Disposition" Object containing the diverse MDN
disposition options.
o mdnGateway: "String|null" (server-set) Name of the gateway or MTA
that translated a foreign (non-Internet) message disposition
notification into this MDN.
o originalRecipient: "String|null" (server-set) Original recipient
address as specified by the sender of the message for which the
MDN is being issued.
o finalRecipient: "String" (server-set) Recipient for which the MDN
is being issued.
o originalMessageId: "String|null" (server-set) Message-ID (the
[RFC5322] header field, not the JMAP Id) of the message for which
the MDN is being issued.
o error: "String[]|null" (server-set) Additional information in the
form of text messages when the "error" disposition modifier
appears.
o extensionFields: "String[String]|null" (server-set) Object where
keys are extension-field names and values are extension-field
values.
A *Disposition* object has the following properties:
o actionMode: "String" This MUST be one of the following strings:
"manual-action" / "automatic-action"
o sendingMode: "String" This MUST be one of the following strings:
"MDN-sent-manually" / "MDN-sent-automatically"
o type: "String" This MUST be one of the following strings:
"deleted" / "dispatched" / "displayed" / "processed"
Ouazana Expires August 31, 2020 [Page 4]
Internet-Draft JMAP MDN handling February 2020
See [RFC8098] for the exact meaning of these different fields.
2.1. MDN/send
The MDN/send method sends an [RFC5322] message from an MDN object.
When calling this method the "using" property of the Request object
MUST contain the capabilities "urn:ietf:params:jmap:mdn" and
"urn:ietf:params:jmap:mail". The latter because of the implicit call
to Email/set, described below. The method takes the following
arguments:
o accountId: "Id" The id of the account to use.
o send: "Id[MDN]" A map of creation id (client specified) to MDN
objects.
The response has the following arguments:
o accountId: "Id" The id of the account used for the call.
o sent: "Id[MDN]|null" A map of creation id to MDN containing any
properties that were not set by the client. This includes any
properties that were omitted by the client and thus set to a
default by the server. This argument is null if no MDN objects
were successfully sent.
o notSent: "Id[MDNError]|null" A map of the creation id to an
MDNError object for each record that failed to be sent, or null if
all successful.
The following MDNError types are defined:
o mdnAlreadySent: The message has the "$MDNSent" keyword already
set.
o forbidden: MDN/send would violate an ACL or other permissions
policy.
o overQuota: MDN/send would exceed a server-defined limit on the
number or total size of sent MDN. It could include limitations on
sent emails.
o tooLarge: MDN/send would result in an MDN that exceeds a server-
defined limit for the maximum size of an MDN, or more generally on
emails.
Ouazana Expires August 31, 2020 [Page 5]
Internet-Draft JMAP MDN handling February 2020
o rateLimit: Too many MDN or emails have been created recently, and
a server-defined rate limit has been reached. It may work if
tried again later.
o invalidProperties: The record given is invalid in some way.
The client SHOULD NOT issue an MDN/send request if the message has
the "$MDNSent" keyword set.
When sending the MDN, the server is in charge of generating the
"originalRecipient", "finalRecipient" and "originalMessageId" fields
accordingly to the [RFC8098] specification.
After all items in the "MDN/send" invocation have been processed, a
single implicit "Email/set" call MUST be made to set the "$MDNSent"
keyword on "Email" objects referenced by "MDN" objects that have been
successfully created (see [RFC3503] for more details). The response
to this MUST be returned after the "MDN/send" response.
2.2. MDN/parse
This method allows a client to parse blobs as [RFC5322] messages to
get MDN objects. This can be used to parse and get detailed
information about blobs referenced in the "mdnBlobIds" of the
EmailSubmission object, or any email the client could expect to be an
MDN.
The "forEmailId" property can be null or missing if the
"originalMessageId" property is missing or not referencing an
existing email.
The MDN/parse method takes the following arguments:
o accountId: "Id" The id of the account to use.
o blobIds: "Id[]" The ids of the blobs to parse.
The response has the following arguments:
o accountId: "Id" The id of the account used for the call.
o parsed: "Id[MDN]|null" A map of blob id to parsed MDN
representation for each successfully parsed blob, or null if none.
o notParsable: "Id[]|null" A list of ids given that corresponded to
blobs that could not be parsed as MDNs, or null if none.
Ouazana Expires August 31, 2020 [Page 6]
Internet-Draft JMAP MDN handling February 2020
o notFound: "Id[]|null" A list of blob ids given that could not be
found, or null if none.
The following additional error may be returned instead of the MDN/
parse response:
o requestTooLarge: The number of ids requested by the client exceeds
the maximum number the server is willing to process in a single
method call.
3. Samples
3.1. Sending an MDN for a received email
A client can use the following request to send an MDN back to the
sender:
[[ "MDN/send", {
"accountId": "ue150411c",
"send": {
"k1546": {
"forEmailId": "Md45b47b4877521042cec0938",
"subject": "Read receipt for: World domination",
"textBody": "This receipt shows that the email has been
displayed on your recipient's computer. There is no
guaranty it has been read or understood.",
"reportingUA": "linagora.com; OpenPaaS",
"disposition": {
"actionMode": "manual-action",
"sendingMode": "MDN-sent-manually",
"type": "displayed"
}
}
}
}, "0" ]]
If the email id matches an existing email without the "$MDNSent"
keyword, the server can answer:
Ouazana Expires August 31, 2020 [Page 7]
Internet-Draft JMAP MDN handling February 2020
[[ "MDN/send", {
"accountId": "ue150411c",
"sent": {
"k1546": {
"finalRecipient": "rfc822; john@example.com",
"originalMessageId": "<1521557867.2614.0.camel@apache.org>"
}
}
}, "0" ],
[ "Email/set", {
"accountId": "ue150411c",
"oldState": "23",
"newState": "42",
"updated": {
"Md45b47b4877521042cec0938": {
"keywords": {
"$MDNSent": true
}
}
}
}, "0" ]]
If the "$MDNSent" keyword has already been set, the server can answer
an error:
[[ "MDN/send", {
"accountId": "ue150411c",
"notSent": {
"k1546": {
"type": "mdnAlreadySent",
"description" : "$MDNSent keyword is already present"
}
}
}, "0" ]]
3.2. Asking for MDN when sending an email
This is done with the [RFC8621] "Email/set" "create" method.
Ouazana Expires August 31, 2020 [Page 8]
Internet-Draft JMAP MDN handling February 2020
[[ "Email/set", {
"accountId": "ue150411c",
"create": {
"k1546": {
"mailboxIds": {
"2ea1ca41b38e": true
},
"keywords": {
"$seen": true,
"$draft": true
},
"from": [{
"name": "Joe Bloggs",
"email": "joe@example.com"
}],
"to": [{
"name": "John",
"email": "john@example.com"
}],
"header:Disposition-Notification-To:asText": "joe@example.com",
"subject": "World domination",
...
}
}
}, "0" ]]
Note the specified "Disposition-Notification-To" header indicating
where to send MDN back (usually the sender of the email).
3.3. Parsing a received MDN
The client issues a parse request:
[[ "MDN/parse", {
"accountId": "ue150411c",
"blobIds: [ "0f9f65ab-dc7b-4146-850f-6e4881093965" ]
}, "0" ]]
The server responds:
Ouazana Expires August 31, 2020 [Page 9]
Internet-Draft JMAP MDN handling February 2020
[[ "MDN/parse", {
"accountId": "ue150411c",
"parsed": {
"0f9f65ab-dc7b-4146-850f-6e4881093965": {
"forEmailId": "Md45b47b4877521042cec0938",
"subject": "Read receipt for: World domination",
"textBody": "This receipt shows that the email has been
displayed on your recipient's computer. There is no
guaranty it has been read or understood.",
"reportingUA": "linagora.com; OpenPaaS",
"disposition": {
"actionMode": "manual-action",
"sendingMode": "MDN-sent-manually",
"type": "displayed"
}
"finalRecipient": "rfc822; john@example.com",
"originalMessageId": "<1521557867.2614.0.camel@apache.org>"
}
}
}, "0" ]]
In case of a not found blobId, the server would respond:
[[ "MDN/parse", {
"accountId": "ue150411c",
"notFound": [ "0f9f65ab-dc7b-4146-850f-6e4881093965" ]
}, "0" ]]
If the blobId has been found but is not parsable, the server would
respond:
[[ "MDN/parse", {
"accountId": "ue150411c",
"notParsable": [ "0f9f65ab-dc7b-4146-850f-6e4881093965" ]
}, "0" ]]
4. IANA Considerations
4.1. JMAP Capability Registration for "mdn"
IANA will register the "mdn" JMAP Capability as follows:
Capability Name: "urn:ietf:params:jmap:mdn"
Specification document: this document
Intended use: common
Ouazana Expires August 31, 2020 [Page 10]
Internet-Draft JMAP MDN handling February 2020
Change Controller: IETF
Security and privacy considerations: this document, section 5.
4.2. JMAP Error Codes Registry
The following subsection register one new error code in the "JMAP
Error Codes" registry, as defined in [RFC8620].
4.2.1. mdnAlreadySent
JMAP Error Code: mdnAlreadySent
Intended use: common
Change controller: IETF
Reference: This document, Section 2.1
Description: The message has the "$MDNSent" keyword already set. The
client MUST NOT try again to send an MDN for this message.
5. Security considerations
The same considerations regarding MDN (see [RFC8098] and [RFC3503])
apply to this document.
6. References
6.1. Normative References
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997,
<https://www.rfc-editor.org/info/rfc2119>.
[RFC3503] Melnikov, A., "Message Disposition Notification (MDN)
profile for Internet Message Access Protocol (IMAP)",
RFC 3503, DOI 10.17487/RFC3503, March 2003,
<https://www.rfc-editor.org/info/rfc3503>.
[RFC5322] Resnick, P., Ed., "Internet Message Format", RFC 5322,
DOI 10.17487/RFC5322, October 2008,
<https://www.rfc-editor.org/info/rfc5322>.
[RFC8098] Hansen, T., Ed. and A. Melnikov, Ed., "Message Disposition
Notification", STD 85, RFC 8098, DOI 10.17487/RFC8098,
February 2017, <https://www.rfc-editor.org/info/rfc8098>.
Ouazana Expires August 31, 2020 [Page 11]
Internet-Draft JMAP MDN handling February 2020
[RFC8620] Jenkins, N. and C. Newman, "The JSON Meta Application
Protocol (JMAP)", RFC 8620, DOI 10.17487/RFC8620, July
2019, <https://www.rfc-editor.org/info/rfc8620>.
[RFC8621] Jenkins, N. and C. Newman, "The JSON Meta Application
Protocol (JMAP) for Mail", RFC 8621, DOI 10.17487/RFC8621,
August 2019, <https://www.rfc-editor.org/info/rfc8621>.
6.2. Informative References
[RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
May 2017, <https://www.rfc-editor.org/info/rfc8174>.
Author's Address
Raphael Ouazana (editor)
Linagora
100 Terrasse Boieldieu - Tour Franklin
Paris - La Defense CEDEX 92042
France
Email: rouazana@linagora.com
URI: https://www.linagora.com
Ouazana Expires August 31, 2020 [Page 12]
Html markup produced by rfcmarkup 1.129d, available from
https://tools.ietf.org/tools/rfcmarkup/