Message types ('normal', 'chat', 'headline', etc.) provide an existing framework for determining how an entity should deliver or handle a message. For example XMPP IM [1] defines that messages of type 'headline' should not be stored offline by the server, and that messages of type 'groupchat' must not be directed to other resources.
However this framework of rules is quite inflexible, and new extensions are being developed that push at the boundaries of what is capable of. This specification defines a more flexible approach that allows the sender to add finer-grained 'hints' to messages, which can be used as a generic mechanism for XMPP entities to handle messages.
This specification aims to solve the following common problems, and allow a sender to hint to the recipient:
Previous work has been done to make XMPP's routing rules extensible, most notably in Advanced Message Processing (XEP-0079) [2]. However, this specification failed to gain widespread adoption, likely due to its complexity. This specification aims to be much simpler for both senders and routing entities to incorporate into their existing stanza handling.
Some other differences include:
Implementations are free to support both XEP-0079 and hints simultaneously - they are not mutually exclusive.
Suppose that Romeo and Juliet are avoiding the surveillance of Prince Escalus and communicating using a session-based encryption protocol between their laptops. In order to prevent Juliet's tablet computer that uses Message Carbons (XEP-0280) [3] from receiving copies of the encrypted messages (and not being able to decrypt them), Romeo inserts the <no-copy/> hint into the messages he sends. Since it is also useless for these messages to be archived, he additionally adds the <no-store/> hint:
<message
from='romeo@montague.lit/laptop'
to='juliet@capulet.lit/laptop'>
<body>V unir avtug'f pybnx gb uvqr zr sebz gurve fvtug</body>
<no-copy xmlns="urn:xmpp:hints"/>
<no-store xmlns="urn:xmpp:hints"/>
</message>
Some automated notifications may be transient, and there would be no purpose in delaying their delivery. Such messages may be marked with the <no-store/> hint.
A sender may want to indicate their preference to have no permanent record of a message (also known as "off the record" messages), but may be happy for it to be stored temporarily as a normal part of delivery (e.g. if the recipient is offline at the time of sending). Such a message can be marked with the <no-permanent-store/> hint.
Offline storage and Message Archive Management (XEP-0313) [4] can define their own rules on what messages to store and usually only store messages that contain a body element. However a sender may want to indicate that a message is worth storing even though it might not match those rules (e.g. an encrypted message that carries the payload outside the body element). Such a message can be marked with a <store/> hint.
The <no-permanent-store/> hint informs entities that they shouldn't store the message in any permanent or semi-permanent public or private archive (such as described in Message Archiving (XEP-0136) [5] and Message Archive Management (XEP-0313) [4]) or in logs (such as chatroom logs).
A message containing a <no-store/> hint should not be stored by a server either permanently (as above) or temporarily, e.g. for later delivery to an offline client, or to users not currently present in a chatroom.
Messages with the <no-copy/> hint should not be copied to addresses other than the one to which it is addressed, for example through Message Carbons (XEP-0280) [3].
This hint MUST only be included on messages addressed to full JIDs and explicitly does not override the behaviour defined in XMPP IM [1] for handling messages to bare JIDs, which may involve copying to multiple resources, or multiple occupants in a Multi-User Chat (XEP-0045) [6] room.
A message containing the <store/> hint that is not of type 'error' SHOULD be stored by the entity.
It is important to note that message hints are, as the name implies, just hints. Implementations MUST NOT rely on other entities interpretation of the hints for any particular purpose.
In particular, if an entity supports both this protocol and the protocol defined in XEP-0079, the directives in the latter SHOULD take precedence over any hints present in a stanza.
Hints contained within a stanza of type 'error' SHOULD be ignored. This is because error stanzas often include the unmodified payload of an original stanza that caused the error, while an implementation may want to apply different logic to an error response for such a stanza.
This specification introduces no known security considerations.
This document requires no interaction with the Internet Assigned Numbers Authority (IANA) [7].
This document requires no interaction with XMPP Registrar [8].
<?xml version='1.0' encoding='UTF-8'?>
<xs:schema
xmlns:xs='http://www.w3.org/2001/XMLSchema'
targetNamespace='urn:xmpp:hints'
xmlns='urn:xmpp:hints'
elementFormDefault='qualified'>
<xs:element name='no-permanent-store' type='empty'/>
<xs:element name='no-store' type='empty'/>
<xs:element name='no-copy' type='empty'/>
<xs:element name='store' type='empty'/>
<xs:simpleType name='empty'>
<xs:restriction base='xs:string'>
<xs:enumeration value=''/>
</xs:restriction>
</xs:simpleType>
</xs:schema>
This document in other formats: XML PDF
This XMPP Extension Protocol is copyright © 1999 – 2024 by the XMPP Standards Foundation (XSF).
Permission is hereby granted, free of charge, to any person obtaining a copy of this specification (the "Specification"), to make use of the Specification without restriction, including without limitation the rights to implement the Specification in a software program, deploy the Specification in a network service, and copy, modify, merge, publish, translate, distribute, sublicense, or sell copies of the Specification, and to permit persons to whom the Specification is furnished to do so, subject to the condition that the foregoing copyright notice and this permission notice shall be included in all copies or substantial portions of the Specification. Unless separate permission is granted, modified works that are redistributed shall not contain misleading information regarding the authors, title, number, or publisher of the Specification, and shall not claim endorsement of the modified works by the authors, any organization or project to which the authors belong, or the XMPP Standards Foundation.
## NOTE WELL: This Specification is provided on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. ##
In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall the XMPP Standards Foundation or any author of this Specification be liable for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising from, out of, or in connection with the Specification or the implementation, deployment, or other use of the Specification (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if the XMPP Standards Foundation or such author has been advised of the possibility of such damages.
This XMPP Extension Protocol has been contributed in full conformance with the XSF's Intellectual Property Rights Policy (a copy of which can be found at <https://xmpp.org/about/xsf/ipr-policy> or obtained by writing to XMPP Standards Foundation, P.O. Box 787, Parker, CO 80134 USA).
The HTML representation (you are looking at) is maintained by the XSF. It is based on the YAML CSS Framework, which is licensed under the terms of the CC-BY-SA 2.0 license.
The Extensible Messaging and Presence Protocol (XMPP) is defined in the XMPP Core (RFC 6120) and XMPP IM (RFC 6121) specifications contributed by the XMPP Standards Foundation to the Internet Standards Process, which is managed by the Internet Engineering Task Force in accordance with RFC 2026. Any protocol defined in this document has been developed outside the Internet Standards Process and is to be understood as an extension to XMPP rather than as an evolution, development, or modification of XMPP itself.
The primary venue for discussion of XMPP Extension Protocols is the <standards@xmpp.org> discussion list.
Discussion on other xmpp.org discussion lists might also be appropriate; see <https://xmpp.org/community/> for a complete list.
Errata can be sent to <editor@xmpp.org>.
The following requirements keywords as used in this document are to be interpreted as described in RFC 2119: "MUST", "SHALL", "REQUIRED"; "MUST NOT", "SHALL NOT"; "SHOULD", "RECOMMENDED"; "SHOULD NOT", "NOT RECOMMENDED"; "MAY", "OPTIONAL".
1. RFC 6121: Extensible Messaging and Presence Protocol (XMPP): Instant Messaging and Presence <http://tools.ietf.org/html/rfc6121>.
2. XEP-0079: Advanced Message Processing <https://xmpp.org/extensions/xep-0079.html>.
3. XEP-0280: Message Carbons <https://xmpp.org/extensions/xep-0280.html>.
4. XEP-0313: Message Archive Management <https://xmpp.org/extensions/xep-0313.html>.
5. XEP-0136: Message Archiving <https://xmpp.org/extensions/xep-0136.html>.
6. XEP-0045: Multi-User Chat <https://xmpp.org/extensions/xep-0045.html>.
7. The Internet Assigned Numbers Authority (IANA) is the central coordinator for the assignment of unique parameter values for Internet protocols, such as port numbers and URI schemes. For further information, see <http://www.iana.org/>.
8. The XMPP Registrar maintains a list of reserved protocol namespaces as well as registries of parameters used in the context of XMPP extension protocols approved by the XMPP Standards Foundation. For further information, see <https://xmpp.org/registrar/>.
Note: Older versions of this specification might be available at https://xmpp.org/extensions/attic/
Incorporate last call feedback from 2017.
Differences between this specification and XEP-0079 have been clarified.
A note about handling of hints found in error stanzas has been added.
Fixed the wrong use of no-storage instead of no-store
Added a message hint <store/>
Initial published version approved by the XMPP Council.
First draft.
@report{wild2013hints,
title = {Message Processing Hints},
author = {Wild, Matthew},
type = {XEP},
number = {0334},
version = {1.0.0},
institution = {XMPP Standards Foundation},
url = {https://xmpp.org/extensions/xep-0334.html},
date = {2013-06-18/2024-04-17},
}END