XEP-xxxx: Message Archive Management

Abstract:This document defines a protocol to query an archive of messages stored on a server.
Author:Matthew Wild
Copyright:© 1999 - 2010 XMPP Standards Foundation. SEE LEGAL NOTICES.
Type:Standards Track
Last Updated:2010-07-01

WARNING: This document has not yet been accepted for consideration or approved in any official manner by the XMPP Standards Foundation, and this document is not yet an XMPP Extension Protocol (XEP). If this document is accepted as a XEP by the XMPP Council, it will be published at <http://xmpp.org/extensions/> and announced on the <standards@xmpp.org> mailing list.

Table of Contents

1. Introduction
2. Querying the archive
    2.1. Filtering results
       2.1.1. Filtering by contact
       2.1.2. Filtering by time received
    2.2. Query results
3. Archiving Preferences
    3.1. Default behaviour
    3.2. Always archive
    3.3. Never archive
    3.4. JID matching
       3.4.1. General rules
       3.4.2. Outgoing messages
       3.4.3. Incoming messages

    A: Document Information
    B: Author Information
    C: Legal Notices
    D: Relation to XMPP
    E: Discussion Venue
    F: Requirements Conformance
    G: Notes
    H: Revision History

1. Introduction

Good XEP.

2. Querying the archive

A client is able to query the archive for all messages within a certain timespan, optionally restricting results to those to/from a particular JID.

A query consists of an <iq/> stanza addressed to the account or server entity hosting the archive, with a 'query' payload. On receiving the query, the server pushes to the client a series of messages from the archive that match the client's given criteria, and finally returns an <iq/> result.

Example 1. Querying the archive for messages

<iq type='get' id='juliet1'>
  <query xmlns='urn:xmpp:archive#management'/>

[... server returns matching messages ...]

<iq type='result' id='juliet1'/>

2.1 Filtering results

The query can contain any combination of three filtering attributes - 'with', 'start' and 'end'. By default all messages match a query, the filters are used to request a subset of the archived messages.

2.1.1 Filtering by contact

If a 'with' attribute is present on the query element, it contains a JID against which to match messages. The server MUST only return messages if they match the supplied JID.

If the 'with' attribute is omitted, the server SHOULD return all messages in the selected timespan, regardless of the to/from addresses on each message.

Example 2. Querying for all messages to/from a particular JID

<iq type='get' id='juliet1'>
  <query xmlns='urn:xmpp:archive#management' with='juliet@capulet.com'/>

If (and only if) the supplied JID is a bare JID (of the form "user@domain"), then the server SHOULD return messages if their bare to/from address would match it. For example, if the client supplies with='juliet@capulet.com', this filter would also match messages to or from "juliet@capulet.com/balcony", and "juliet@capulet.com/chamber".

2.1.2 Filtering by time received

The 'start' and 'end' attributes, if provided, MUST contain timestamps formatted according to the DateTime profile defined in XMPP Date and Time Profiles [1]

The 'start' attribute is used to filter out messages before a certain date/time. If specified, a server MUST only return messages whose timestamp is equal to or later than the given timestamp.

If omitted, the server SHOULD assume the value of 'start' to be equal to the date/time of the earliest message stored in the archive.

Conversely, the 'end' attribute is used to exclude from the results messages after a certain point in time. If specified, a server MUST only return messages whose timestamp is equal to or earlier than the timestamp given in the 'end' attribute.

If omitted, the server SHOULD assume the value of 'end' to be equal to the date/time of the most recent message stored in the archive.

Example 3. Querying the archive for all messages in a certain timespan

<iq type='get' id='juliet1'>
  <query xmlns='urn:xmpp:archive#management'

Example 4. Querying the archive for all messages after a certain time

<iq type='get' id='juliet1'>
  <query xmlns='urn:xmpp:archive#management'
      start='2010-08-07T00:00:00Z' />

2.2 Query results

The server responds to the archive query by transmitting to the client all the messages that match the criteria the client requested. The results are sent as individual stanzas, the original message wrapped in a new <message/> stanza.

The <forwarded/> element SHOULD contain the original message as it was received, and SHOULD also contain a <delay/> element qualified by the 'urn:xmpp:delay' namespace specified in Delayed Delivery [2]. The value of the 'stamp' attribute MUST be the time the message was originally received by the forwarding entity.

Example 5. Server returns two matching messages

<message id='aeb213' to='juliet@capulet.com/chamber'>
  <forwarded xmlns='urn:xmpp:forward:tmp'>
    <delay xmlns='urn:xmpp:delay' stamp='2010-07-10T23:08:25Z'/>
    <message to='juliet@capulet.com/balcony'
      <body>Call me but love, and I'll be new baptized; Henceforth I never will be Romeo.</body>

<message id='aeb214' to='juliet@capulet.com/chamber'>
  <forwarded xmlns='urn:xmpp:forward:tmp'>
    <delay xmlns='urn:xmpp:delay' stamp='2010-07-10T23:09:32Z'/>
    <message to='romeo@montague.net/orchard'
       type='chat' id='8a54s'>
      <body>What man art thou that thus bescreen'd in night so stumblest on my counsel?</body>

3. Archiving Preferences

For message archives that support preference management, the user may configure the following preferences:

Example 6. Updating archiving preferences

<iq type='get' id='juliet1'>
  <prefs xmlns='urn:xmpp:archive#preferences' default="roster">

3.1 Default behaviour

If a JID is in neither the 'always archive' nor the 'never archive' list then whether it is archived depends on this setting, the default.

The 'default' attribute of the 'prefs' element MUST be one of the following values:

3.2 Always archive

The <prefs/> element MAY contain an <always/> child element. If present, it contains a list of <jid/> elements, each containing a single JID. The server SHOULD archive any messages to/from this JID (see 'JID matching').

If missing from the preferences, <always/> SHOULD be assumed by the server to be an empty list.

3.3 Never archive

The <prefs/> element MAY contain an <never/> child element. If present, it contains a list of <jid/> elements, each containing a single JID. The server SHOULD NOT archive any messages to/from this JID (see 'JID matching').

If missing from the preferences, <never/> SHOULD be assumed by the server to be an empty list.

3.4 JID matching

3.4.1 General rules

When comparing the message target JID against the user's roster (ie. when the user has set default='roster') the comparison MUST use the bare target JID (that is, stripped of any resource).

For matching against entries in either the 'allow' or 'never' lists, for each listed JID:

3.4.2 Outgoing messages

For outgoing messages, the server MUST use the value of the 'to' attribute as the target JID.

3.4.3 Incoming messages

For incoming messages, the server MUST use the value of the 'from' attribute as the target JID.


Appendix A: Document Information

Series: XEP
Number: xxxx
Publisher: XMPP Standards Foundation
Status: ProtoXEP
Type: Standards Track
Version: 0.1
Last Updated: 2010-07-01
Approving Body: XMPP Council
Dependencies: XMPP Core, XEP-0030
Supersedes: None
Superseded By: None
Short Name: archive
Schema: <http://www.xmpp.org/schemas/archive-management.xsd>
This document in other formats: XML  PDF

Appendix B: Author Information

Matthew Wild

Email: me@matthewwild.co.uk
JabberID: me@matthewwild.co.uk

Appendix C: Legal Notices


This XMPP Extension Protocol is copyright © 1999 - 2010 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.

Disclaimer of Warranty

## 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. ##

Limitation of Liability

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.

IPR Conformance

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 <http://xmpp.org/extensions/ipr-policy.shtml> or obtained by writing to XMPP Standards Foundation, 1899 Wynkoop Street, Suite 600, Denver, CO 80202 USA).

Appendix D: Relation to XMPP

The Extensible Messaging and Presence Protocol (XMPP) is defined in the XMPP Core (RFC 3920) and XMPP IM (RFC 3921) 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.

Appendix E: Discussion Venue

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 <http://xmpp.org/about/discuss.shtml> for a complete list.

Errata can be sent to <editor@xmpp.org>.

Appendix F: Requirements Conformance

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".

Appendix G: Notes

1. XEP-0082: XMPP Date and Time Profiles <http://xmpp.org/extensions/xep-0082.html>.

2. XEP-0203: Delayed Delivery <http://xmpp.org/extensions/xep-0203.html>.

Appendix H: Revision History

Note: Older versions of this specification might be available at http://xmpp.org/extensions/attic/

Version 0.1 (2010-07-01)

Initial version.