XEP-xxxx: Portable Import/Export Format for XMPP Components

Abstract
This document specifies a file format for importing and exporting component data to and from XMPP software
Author
Stephen Paul Weber
Copyright
© 2026 – 2026 XMPP Standards Foundation. SEE LEGAL NOTICES.
Status

ProtoXEP

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 <https://xmpp.org/extensions/> and announced on the <standards@xmpp.org> mailing list.
Type
Standards Track
Version
0.0.1 (2026-10-06)
Document Lifecycle
  1. Experimental
  2. Proposed
  3. Stable
  4. Final

1. Introduction

Portable Import/Export Format for XMPP-IM Servers (XEP-0227) [1] introduced a format for the import/export of XMPP data. That specification specifically says "the contents of MUC, Pubsub, and other services are out of scope for this specification". This specification exists to cover that gap.

2. File format

Inside the root element from Portable Import/Export Format for XMPP-IM Servers (XEP-0227) [1] of <server-data/> qualified by the urn:xmpp:pie:0 namespace, may occur zero or more <component/> elements qualified by the urn:xmpp:pie:0#component namespace. Each <component/> element describes a component, and has a jid attribute that contains its JID and a type attribute that describes the type of component.

Example 1. The component element
<?xml version='1.0' encoding='UTF-8'?>
<server-data xmlns='urn:xmpp:pie:0'>
  <component xmlns='urn:xmpp:pie:0#component' jid='groups.capulet.com' type='muc'>
    [ ... ]
  </component>
</server-data>

Components may contain children to describe any data relevant to the type of component. For example, a pubsub type component may have a <pubsub xmlns="http://jabber.org/protocol/pubsub#owner"/> child.

A component may contain elements qualified by a namespace not mentioned in this specification or in Portable Import/Export Format for XMPP-IM Servers (XEP-0227) [1]. The exported data SHOULD be meaningful without the extensions. An importing entity that encounters a namespace that it doesn't understand, or otherwise is unable to import all given data, SHOULD ignore the unknown data, SHOULD notify the operator, and MAY offer to terminate the process.

2.1 Items

A component may have associated items, represented by a <item/> element under the <component/> element. The <item/> element MUST have a name attribute, which contains a type-specific identifier for this item.

Example 2. The item element
<?xml version='1.0' encoding='UTF-8'?>
<server-data xmlns='urn:xmpp:pie:0'>
  <component xmlns='urn:xmpp:pie:0#component' jid='groups.capulet.com' type='muc'>
    <item name='discuss'>
      [ ... ]
    </item>
  </component>
</server-data>

Items may contain children to describe any data from items in the relevant type of component. For example a muc type component may have items with a <archive xmlns="urn:xmpp:pie:0#mam"/> child.

An item may contain elements qualified by a namespace not mentioned in this specification or in Portable Import/Export Format for XMPP-IM Servers (XEP-0227) [1]. The exported data SHOULD be meaningful without the extensions. An importing entity that encounters a namespace that it doesn't understand, or otherwise is unable to import all given data, SHOULD ignore the unknown data, SHOULD notify the operator, and MAY offer to terminate the process.

3. Security Considerations

Exported data files are to be handled with care, since they contain data that users expect to be protected. An exporting entity SHOULD make sure that the generated file is not accessible to unauthorized persons, e.g. by encrypting the file with OpenPGP.

4. IANA Considerations

This document requires no interaction with the Internet Assigned Numbers Authority (IANA) [2].

5. XMPP Registrar Considerations

5.1 Protocol Namespaces

This specification defines the following XML namespace:

The XMPP Registrar [3] includes the foregoing namespace in its registry at <https://xmpp.org/registrar/namespaces.html>, as described in Section 4 of XMPP Registrar Function (XEP-0053) [4].

5.2 Component Types

This specification creates a new registry for the component type attribute, with the following initial contents:


Appendices

Appendix A: Document Information

Series
XEP
Number
xxxx
Publisher
XMPP Standards Foundation
Status
ProtoXEP
Type
Standards Track
Version
0.0.1
Last Updated
2026-10-06
Approving Body
XMPP Council
Dependencies
XMPP IM
Supersedes
None
Superseded By
None
Short Name
pie-components

This document in other formats: XML  PDF

Appendix B: Author Information

Stephen Paul Weber
Email
singpolyma@singpolyma.net
JabberID
singpolyma@singpolyma.net

Copyright

This XMPP Extension Protocol is copyright © 1999 – 2024 by the XMPP Standards Foundation (XSF).

Permissions

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 <https://xmpp.org/about/xsf/ipr-policy> or obtained by writing to XMPP Standards Foundation, P.O. Box 787, Parker, CO 80134 USA).

Visual Presentation

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.

Appendix D: Relation to XMPP

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.

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 <https://xmpp.org/community/> for a complete list.

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

Appendix F: Requirements Conformance

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.

Appendix G: Notes

1. XEP-0227: Portable Import/Export Format for XMPP-IM Servers <https://xmpp.org/extensions/xep-0227.html>.

2. 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/>.

3. 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/>.

4. XEP-0053: XMPP Registrar Function <https://xmpp.org/extensions/xep-0053.html>.

Appendix H: Revision History

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

  1. Version 0.0.1 (2026-10-06)

    Initial version.

    spw

Appendix I: Bib(La)TeX Entry

@report{weber2026pie-components,
  title = {Portable Import/Export Format for XMPP Components},
  author = {Weber, Stephen Paul},
  type = {XEP},
  number = {xxxx},
  version = {0.0.1},
  institution = {XMPP Standards Foundation},
  url = {https://xmpp.org/extensions/xep-xxxx.html},
  date = {2026-10-06/2026-10-06},
}

END