%ents; ]>
Message Expiration This specification documents an historical protocol that was used to specify expiration dates for messages; this protocol has been deprecated in favor of XEP-0079: Advanced Message Processing. &LEGALNOTICE; 0023 Obsolete Historical Standards XMPP Core XEP-0079 x-expire http://www.xmpp.org/schemas/x-expire.xsd &jer; DJ Adams dj.adams@pobox.com dj@gnu.mine.nu Harold Gottschalk heg@imissary.com heg@imissary.com 1.3 2009-06-03 psa

Per a vote of the XMPP Council, changed status to Obsolete.

1.2 2004-10-18 psa

Per a vote of the Jabber Council, changed status to Deprecated since message expiration functionality should be implemented via XEP-0079: Advanced Message Processing.

1.1 2004-01-06 psa

Added XML schema; added security, IANA, and XMPP Registrar considerations.

1.0 2002-07-15 psa

Changed status to Active.

0.9 2002-03-19 dja

Added remarks about client-end expiry.

0.1 2002-03-07 dja

Initial draft.

Note Well: The protocol described herein has been deprecated by the &XSF;. The recommended protocol for implementing message expiration functionality is now &xep0079;.

It is sometimes helpful to indicate that a piece of information has a finite useful life or time-to-live (TTL). In the context of instant messaging, the main use of a TTL is to indicate that a message must or should be used by or read by a certain time, usually because the message has meaning or purpose only within a finite amount of time. In normal usage, such a message should be discarded after the specified time has passed if it has not been used or read by that time.

In Jabber, TTL functionality has been implemented informally using the jabber:x:expire namespace. Support for this namespace was added to the &jabberd; server as well as some clients and components in early 2001. Specifically, that support has involved the following two areas of responsibility:

An Endpoint can specify a TTL for an XML stanza that it wishes to send by attaching an <x/> extension qualified by the jabber:x:expire namespace. The extension contains no children, only a 'seconds' attribute that contains a value representing the stanza's TTL, in seconds.

SEND: <message to='sabine@gnu.mine.nu' id='msg811'> <subject>Eccles cakes!</subject> <body> I've got some freshly made Eccles cakes here, come round for one before they all disappear! </body> <x xmlns='jabber:x:expire' seconds='1800'/> </message>

Any mechanism that is involved in the storage, forwarding, and general handling of XML stanzas must check for the presence of such an extension and act accordingly, expiring (discarding) any stanzas that have exceeded their TTL lifetime. The jabber:x:expire namespace allows for a further attribute inside the <x/> extension: 'stored'. Here, the mechanism can record a value representing when the stanza was committed to storage, so that when the stanza is eventually retrieved for forwarding to the intended recipient, the elapsed time of storage can be calculated. This is to prevent the stanza from being held in 'suspended animation'.

Here we see what the original message looks like after the stanza has been committed to storage and the time of storage recorded:

SEND: <message to='sabine@gnu.mine.nu' id='msg811'> <subject>Eccles cakes!</subject> <body> I've got some freshly made Eccles cakes here, come round for one before they all disappear! </body> <x xmlns='jabber:x:expire' seconds='1800' stored='912830221'/> </message>

When Sabine attempts to retrieve her offline messages, the store-and-forward mechanism (e.g., mod_offline) compares the current time against the stored attribute. If the 1800 seconds have passed, the mechanism should simply drop the message, without notifying either the sender or the intended recipient. No Eccles cakes for Sabine!

Although current usage of jabber:x:expire is most commonly seen in server implementations to address any TTL requirements of stored messages, Jabber clients can also be seen as handlers of messages that may contain expiration extension information. If a message is received by a Jabber client, and not immediately displayed to the user, the client must check for TTL information and expire the message (rather than display it to the user) if appropriate.

There are no security features or concerns related to this proposal.

This document requires no interaction with &IANA;.

No action on the part of the ®ISTRAR; is necessary as a result of this document, since 'jabber:x:expire' is already a registered protocol namespace.

The protocol documented by this schema is defined in XEP-0023: http://www.xmpp.org/extensions/xep-0023.html ]]>
  1. The jabber:x:expire namespace is processed only for delayed messages and only by servers and subsystems which support this informational draft. Therefore it is possible or even likely that a TTL will not be properly handled from the user perspective.
  2. A physical, time-based TTL is not implemented by this document, and would not be possible across systems without synchronized time.