While &xep0079; provides message acknowledgements at the server level, it does not extend that model all the way to the client. Naturally, message receipts can be combined with the rules specified in Advanced Message Processing for more complete reporting. However, sometimes client-level acknowledgements are needed, for example to provide "receipts". This document defines a mechanism for XMPP message receipts, which are functionally equivalent to the "delivered" or "displayed" event in &xep0022;, which this specification in part obsoletes. This specification does not distinguish between delivery and presentation, as was done in the message events protocol, in part because no existing clients make the distinction.

Note: This extension is functionally equivalent to an Advanced Message Processing rule of "receipt" but uses a dedicated namespace to simplify processing by end user clients and intermediate routers.

This document addresses the following requirements:

1. Enable a sender to request notification that an XMPP message stanza has been received.
2. Enable a recipient to provide message receipts if desired.

The term "content message" refers to the stanza for which the original sender would like to receive a receipt.

The term "ack message" refers to the stanza by which the recipient acknowledges receipt of the content message.

This document defines a protocol that enables a sender to ask the recipient to acknowledge receipt of a content message by returning an ack message. Although the return of an ack message lets the sender know that the content message has been delivered, there are many reasons why the sender might not receive an ack message immediately or at all, including but not limited to the following:

• The sender addressed the content message to the recipient's bare JID &LOCALBARE; and therefore does not know if the recipient even supports the Message Receipts protocol.
• The sender has not bothered to determine whether the recipient supports the Message Receipts protocol.
• The recipient (or the particular intended resource to which the sender addressed the content message) does not in fact support the Message Receipts protocol.
• The intended resource supports the Message Receipts protocol but the recipient's server delivers the content message to another resource that does not support the Message Receipts protocol.
• The recipient's client receives the content message but experiences a malfunction before generating an ack message.
• The recipient returns an ack message but the ack message is lost on the way back from the recipient to the sender (e.g., because of connectivity issues or software failures at any hop).
• The recipient simply does not wish to return a receipt for the content message.

Because of these significant limitations, this protocol does not provide complete or even partial reliability or guaranteed delivery. Therefore, the sender SHOULD NOT impute any meaning to the fact that it has not received an ack message, unless it has established with the recipient that receipt requests will be honored; however, methods for doing so are out of scope for this specification and it is NOT RECOMMENDED to take any particular action (such as resending the content message) without such methods. This protocol merely provides a building block that could be used in conjunction with other protocols to asymptotically approach the eventual goal of messaging reliability and guaranteed delivery.

Because it is possible for a given content message to be delivered to multiple XMPP resources controlled by the recipient, the sender of the content message needs to be prepared to receive multiple ack messages.

A sender could request receipts on any non-error content message (chat, groupchat, headline, or normal) no matter if the recipient's address is a bare JID &LOCALBARE; or a full JID &LOCALFULL;. Whether it is appropriate or advisable to do so it another question. This section provides recommendations about when and when not to request receipts, and what results to expect in each scenario.

If an entity supports message receipts, it MUST report that by including a &xep0030; feature of "urn:xmpp:receipts" in response to disco#info requests:

Support can also be determined via &xep0115;, a.k.a. "caps".

In order to make it possible for senders to request and for recipients to generate message receipts, we define a dedicated protocol extension qualified by the 'urn:xmpp:receipts' namespace.

There are two allowable elements in this namespace:

• <request/> -- included in a content message by a sending entity that wishes to know if the content message has been received.
• <received/> -- included in an ack message by a receiving entity that wishes to inform the sending entity that the content message has been received.

Specifically, the receiving entity shall return an ack message containing the <received/> extensino if it has received and processed the content message. The term "processed" is to be understood as including presentation to a human user if appropriate or any other application-specific client-side processing, including generation of an error response if the application determines that the content message cannot be handled.

The following is an example of a content message that includes a request for return receipt.

Note: A sender MUST include an 'id' attribute on every content message that requests a receipt, so that the sender can properly track ack messages.

The recipient shall generate an ack message if and only if it supports the protocol defined herein and it is configured to return receipts, either globally or for this recipient (otherwise it MUST NOT return a receipt and SHOULD NOT return an error).

When the recipient sends an ack message, it SHOULD ensure that the message stanza contains only one child element, namely the <received/> element qualified by the 'urn:xmpp:receipts' namespace. In addition, it SHOULD include an 'id' attribute that echoes the 'id' attribute of the content message. Naturally, intermediate entities might add other extension elements to the message when routing or delivering the receipt message, e.g., a <delay/> element as specified in &xep0203;.

It is possible for a recipient to leak its presence when returning message receipts; therefore, a recipient SHOULD NOT return message receipts to senders who are not otherwise authorized to view its presence.

No interaction with &IANA; is necessary as a result of this document.

Thanks to Steven te Brinke, Bruce Campbell, Joe Kemp, Kevin Smith, Remko Tronçon, Matthew Wild, and Kurt Zeilenga for their input.