]> audriga

hans-joerg@audriga.com

Data Transfer Initiative

lisa@dtinit.org

Isode Ltd

Alexey.Melnikov@isode.com

Applications and Real-Time mailmaint email calendaring archive personal portability This document proposes the Personal Data Portability Archive format (PDPA), suitable for import/export, backup/restore, and data transfer scenarios for personal data. About This Document The latest revision of this draft can be found at . Status information for this document may be found at . Discussion of this document takes place on the mailmaint Working Group mailing list (), which is archived at . Subscribe at . Source for this draft and an issue tracker can be found at .

Introduction As part of communication protocols, the IETF has standardized a number of data formats such as the Internet Message Format , , , or, more recently, and . While mainly designed for interoperability, many of these data formats have also become popular for data portability, i.e., the import/export of data across different services. The growing importance of data portability however demands an open standard archive format which can deal with different types of personal data in a homogeneous fashion. To this end, this document proposes the Personal Data Portability Archive format (PDPArchive), suitable for import/export, backup/restore, and data transfer scenarios for personal data. It is compatible with both IMAP and JMAP and should be suitable as an interchange format between related software and services such as for email, contacts, calendaring, tasks, or files. The approach is to define JSON formats, folder structure, and a common compression format. Additional specifications will likely define a protocol how these files can be requested from, imported into, or transferred between servers, but this specification can be used as-is with user-directed imports or exports.

Conventions and Definitions The term "personal data" refers to persistent data which users created and managed within applications or services. Classic examples are emails, contacts, calendars, tasks, notes, or files. Other examples might be fitness tracking records, energy bills, or location history. The term "data portability" refers to the right or technical procedure to use or transfer personal data across different applications or services. The terms "message" and "email message" refer to "electronic mail messages" or "emails" as specified in . The term "Message User Agent" (MUA) denotes an email client application as per . 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 when, and only when, they appear in all capitals, as shown here.

Goals The core goal is to provide an open and extensible archive and transfer format for personal data. This includes data types that are subject of existing IETF protocols, such as email and groupware data (e.g., contacts, calendars, tasks) but may also include further types of personal data. Goals will be refined by use cases and cross-cutting technical goals in the following sub-sections. JSON is used as a widely interoperable base format that systems can easily translate their internal data representation into. Wherever possible, fields, values and data structures are derived from existing IMAP/JMAP specifications to remain compatible with both.

Use cases Many of these use cases benefit greatly from a simple, read-only export format, compared to having IMAP and CalDAV access to personal data. While these use cases may suggest interesting niche features, adding those may be left to future specs. For example, legal and forensics use cases might benefit from signing features, but nevertheless this specification would advance those use cases even without signing features.

Data portability A main use case for the novel format is to allow exporting the full user data managed by services or software products into a simple file (or set of files) which is under full control of the user. The user might use such an export for backup, archiving, or for importing when switching to another service or software (i.e., migration). Depending on the type of data, exporting/importing can be a time-consuming process. Particularly for the case of switching services, PDPA should allow to minimize the time period during which a user cannot use the origin system but also the destination system is not yet ready.

Read-only data access General access to data powers all kinds of analysis and applications. Exporting content and metadata in a structure suitable for ease of use in data pipelines or analysis tools would make these much easier.

Incremental data access Beyond snapshot backups/exports, the format should optionally allow for incremental data access - knowing what new data has been added.

• Automated maintenance of a permanent, incremental mirror of user data, e.g. for instant restore
• Compliance or audit logs
• Spam tracking and analysis
• CRM or productivity integration scenarios that are read-only

Synchronization Data portability does not just allow users to switch from one service to another one, but to let users benefit from 3rd party services with ongoing access to their data (authorized by the user). Simple synchronization features could make this much better. For example, current online systems that allow importing contacts are not often suited to maintaining one's address book on two systems. Re-importing a contact into a system that already has that contact often results in duplicating the exact same contact, whether or not there have been edits, making repeated synchronization practically infeasible. It should be easy to do a significantly better job of this with some attention to object IDs and modification timestamps. We however do not attempt to solve two-way synchronization via export files. It would require significant additional work to allow two systems, neither of which is agreed-upon to be the source of truth, to reliably synchronize changes from both. In comparison, solving one-way synchronization only requires agreed-upon usage of existing fields and values.

Dataset exchange PDPArchive should be usable to exchange and share larger data sets than just one user, or to share a single user's data outside the context where the user knows what it is and where it came from. Potential applications of this are:

• The ability to exchange test data and known mailstore state, e.g. for conformance testing or internal functional tests
• Legal discovery and forensics use cases may benefit from a standard export format, such that investigators can expect a great deal of consistency when collecting data from different systems.
• Researchers may be able to collect archive files through data donations and use as input to research.

Data persistence The format MAY be used as a development-time active persistence layer for user data in, e.g., email clients or applications. It is not intended as, or suitable for, a production-level persistence layer.

Technical Goals Besides actual use cases, there are a number of side requirements and goals for PDPA.

Email standards compatibility Data definitions have to be compatible with widespread calendar and email standards, although need not be limited to only what is in those standards. Data serialization formats should aim for compatibility with JMAP data formats for the sake of interoperability and synergies in software libraries. Dedicated JMAP API methods or client/server protocol messages for exporting and importing the format described here are out of scope of this document. Server-to-server transfer protocols for sending or requesting this format are out of the scope of this document. Due to its specifics and ubiquitous usage, the Internet Message Format ; latest revision of / should be the core of representing individual email data. This specification should ideally describe mappings between PDPA and existing mailbox persistence schemes such as Maildir or .

Interoperability It should be mostly possible to use personal data exports from one system with different software or services. When a source exports personal data it can include all the information it would need for a fully-functional import, however destination systems running different software may not be able to import all of that information (especially if it includes non-standard features) and use it exactly the same way. This specification does not attempt to achieve perfect interoperability between diverse systems, but instead to make reasonable trade-offs.

Extensibility This format should be extensible to accommodate types of personal data not explicitly mentioned or foreseen when writing these specs.

Flexible granularity This format should allow flexible granularity in two ways: 1) It should enable easy access to separate types of data (e.g., emails vs. contacts), e.g. to allow for partial imports or exports 2) While ideally representable as a single file, archives may also span several files due to reasons such as file size restrictions or incremental generation logic. (The ability for a user to export and/or backup an entire email account requires some accommodation of large amounts of data and risks of interruptions in downloads. Splitting exports into multiple files during export is one possible solution.)

Accessible for local tooling PDPA should allow easy access for local tools (e.g., CLIs). While this may sound obvious, it is a key factor for the intended versatility of the format.

Efficiency Since certain kinds of personal data might involve large quantities of data, major use cases for PDPA should be realizable in an efficient manner. For now, this is stated as an abstract guiding principle. Its actual dimensions and trade-offs need to be refined while evolving this specification.

Related work Many email server implementors have found it desirable to have one or more file formats for storing email in a file system even when the primary active email storage is more commonly a database. Examples include files (Outlook), NSF (Notes), , Maildir, MBOX. File formats are already used for interoperability in many cases even when not standardized. This specification follows that pattern in order to build on these partial successes. By standardizing one format, we expect to be able to satisfy use cases that are harder to satisfy with a plurality of formats, such as use cases for server-to-server transfer of email account data during account migrations. Specifications that explain how to create these archives in different situations can refer to this specification.

Approach

Using JSON (mostly) JSON is used in this spec for new metadata and for objects including contacts, tasks, events and notes. However, the Email Message Format is used for email message content. Individual items are stored in individual files, which are referenced in collection metadata. Finally these JSON and other file formats are packaged and compressed together in a standard but flexible way. Our rationale for using JSON to the extent reasonable:

• We envision an export format being used not just by developers of full IMAP servers but also by developers building task management systems, calendar systems that don't include email, etc.
• We should minimize requiring multiple libraries to parse different formats. If the Metadata is going to be in JSON, it would really help to have the item data in JSON.
• Personal data formats must be extensible and extensibility for JSON is well-understood.

Using JSON for all the data except EML files was carefully considered. EML files are rather specialized and more challenging to replace. Much of email is not structured data but content and involves MIME. EML is more likely to be a system's native data store, unlike VCARD and VTODO which are most commonly transformed for use in a relational data store for active use. Finally, email signature implementations like S/MIME and OpenPGP would be less disrupted by keeping EML. Information not covered by these existing file formats, but still necessary for migration or backup/restore of an email account, is packaged into JSON files. JSON structure and values are defined with CDDL . The JSON files for email folders and other collections contain references to individual resources by unique ID and filename.

Approach to partial updates Our use case requirements above included some very common personal use cases that motivate exporting only a time-limited set of items, but retaining the ability to use that subset export to update a previously acquired or maintained snapshot. These are partial updates - partial exports able to update a full copy. Our approach is to define a version of the archive format that includes a subset of a repository's content, and additionally some change markers necessary to maintain consistency. A partial-update export

• Contains new items just like a full export.
• Omits unchanged items from before the time cutoff.
• Does NOT list unchanged items in folder listings either.
• Allows updated items to be identified so they can replace previous versions
• Allows deleted items to be identified so they could be removed in the updated snapshot

The existing definitions for UIDs and 'updated' in JMAP and IMAP should make this quite possible. Also IMAP MODSEQs can be used for flag changes.

Approach to synchronization Email and calendaring services appear to already do synchronization just fine, but this is via a client-server model. The client drives the read and write requests until content is synchronized, using mostly UIDs and timestamps. Archive and export formats aren't part of this client-server model, and the work to make server-to-server or peer-to-peer synchronization work perfectly is substantial (involving features such as version numbers or change logs -- features that aren't commonly standardized for the objects handled in this spec). Still, there are some things possible with archive formats and the current object definitions that are sensible. Our approach is to describe what is possible with the fields that exist, and mandate those fields be used, so that users aren't left with multiple locations for their data and no way to repeatedly synchronize them. As an illustrative use case, let the user have contacts stored in one email service and also in one mobile device platform doing online backups. The email platform creates contacts when the user emails new recipients, or receives contact information over email. The mobile device platform synchronizes contact information from a phone. The email service is not a client of the mobile device platform, nor is the mobile device platform a client of the email service, so client-to-server protocols cannot directly synchronize the data between these two services. A user attempting to solve this by repeatedly importing contacts into one system from the other may find this works poorly - for example, it might create new contact objects over and over for the same contact data even if it is unchanged, and deleted objects may re-animate after being re-copied. Both servers ought to allow exporting of contact data (along with any other data covered in this specification), including especially the UID and updated (timestamp) fields. This would allow at least some sensible personal workflows or for 3rd party tools to make synchronization work better. When importing contact data (along with any other data covered in this specification), a service needs to take note of the UID in the import, and use it as the UID for creating a new object, so that it may be later avoid being recreated. If the service importing already has the said UID, the service should compare 'updated' timestamps and use that to decide how to update the object with new values. An object that hasn't changed since last imported should remain unchanged and not updated. This approach to synchronization is imperfect. Let the user have performed one synchronization by exporting from the email service and importing to the mobile device platform. If the user updates a contact on the email service (e.g adding a street address) and the mobile platform also updates the contact (e.g. adding an avatar link), then the user attempts to repeat the synchronization, both services will have a new 'updated' timestamp on the same object UID, and the earlier of the two changes will get wiped out. Nevertheless, a disciplined user can remember to only make changes on the email service and always copy them over to the mobile platform, and avoid many such lost updates. Based on the approach described here, this specification standardizes some behavior for both exporters and importers, to maximize potential success.

Solution Requirements These technical requirements on the solution are intended to meet the goals above, and to add more specifics about how those goals are intended to be met with the architecture chosen. This section does not attempt to translate the solution requirements into implementor requirements. Folder format requirements

• can include partial results, showing only a subset of objects within the folder
• can include a human-readable representation of the meaning of that subset (e.g. a date filter, or recipient filter)

Email object format requirements

• can maintain full fidelity including preserving character sets, content transfer encoding of body parts and exact MIME structure

Compression and packaging of resources

• Servers can bundle resources together in different ways to be flexible in handling size and network limitations. Servers must be able to choose optimal file size and organization of information within files.

Synchronization requirements

• Can see which items are identical in two systems, e.g. one system previously imported an item exported by the other.
• Can detect changes made since the last time an item was imported, in a way that supports replacing an older version previously synchronized with a newer version that has edits.

File format This section describes the internal "raw" file format of a personal data portability archive. For discussion about a surrounding container format, see section "open issues". PDPArchive in general consists of:

• A main metadata file ("archive.json")
• Top-level folders for each data type ("/mail")
• Subfolders representing actual collections of individual data items plus additional metadata files

Archive metadata file The archive.json file consists of three main sections with metadata about the archive as exported, the dataset used, and the source of the data.

• archive: general information about the archive
• dataset: characteristics of the dataset itself
• datasource: meta-information about the dataset

Key	Description and requirements
archive/id	Archive identifier, generated by archive generator, MUST be unique
archive/name	Human readable label
archive/note	Note for human use and display (optional)
archive/legal	Legal desclaimer (optional)
archive/timestamp	Archive timestamp
archive/version	PDPA spec version
archive/generator	Archive generator
dataset/extent	Extent of the archive (full, partial)
dataset/description	Human readable description, containing e.g. date, folder, size (optional)
dataset/datatypes	List of data types
dataset/languagetag	BCP 47 language tag for the dominant language in the dataset
dataset/timezone	IANA tz identifier for the dataset
datasource/service	Information about the source service (id, url, ..)
datasource/account	Information about the source account (id, type, ...)

More formally:

General JSON Schema for archive.json

Example of archive.json (full export):

A basic archive.json example

Folder structure Rather than have deeply nested JSON with folder information inside folder information inside archive index JSON files, this approach uses file system directory structure with separate files for archive metadata and folder metadata as well as item data.

• Folders can be nested. Any kind of content here can be within nested folders -- this is a necessary feature for email, but extends to content like contacts that aren't always represented in nested folders. (TODO: elsewhere, describe the requirements for an importing system to preserve folders or not.)
• Names of files do not have to be globally unique. Indexes and folder contents listings can name files relatively to their location in the archive structure, which means that references may not be resolvable if that context is lost.
• Individual content items are individual files. This may not always be the easiest choice for exporters who must generate a large number of files for individually small items (contrast to a JSON stream including all objects) but as an archive format, the individual files allow more clarity in individual handling, transactions and errors.

File and folder names Because filenames can be generated by the exporting server, it is always possible to generate non-colliding filenames. Display names are NOT intended to be determined by file names, but instead by fields within each file. Similarly, filenames are NOT intended to be globally unique IDs. Mail folder names are defined in (IMAP v4 rev2) with great freedom for servers. Servers may or may not treat mailbox names as case sensitive. Folder names may even include non-graphic characters, "%" and "*". Hierarchy separators may even differ among IMAP servers although "/" is probably most common. Since this specification is new, it is possible to be more constrained. This specification only supports "/" as a folder separator.

Data formats

Email Each IMAP/JMAP folder is represented as subdirectory under "mail" directory. For example, the folder INBOX would be represented as "mail/INBOX", and the folder "Archive/2024/2024-12" would be represented as "mail/Archive/2024/2024-12". Folder names are encoded in UTF-8. Each folder metatadata is described by "folder.json" (this name is REQUIRED), which has the following fields:

Attribute Name	Type	Mandatory?	Comment
allowed_keywords	array of strings (IMAP keywords)	No	PERMANENTFLAGS minus "\*"
uid	string	SHOULD*	Use OBJECTID from
last_uid	unsigned 32 bit integer	Yes	Last UID assigned in the folder. It is UIDNEXT value minus 1
recent_uid	unsigned 32 bit integer	No	Lowest UID of a message with the \Recent flag
uidvalidity	unsigned 32 bit integer	Yes	UIDVALIDITY value
is_subscribed	boolean	Yes	Is the folder returned by IMAP LSUB?
deleted_at	string (timestamp) or null	No	Folder has been DELETED - this is a tombstone
myrights	string	No	See Section 3.5 of . For example "rwiptsldaex"
highest_modseq	unsigned 64 bit integer	No	HIGHESTMODSEQ value
special_use	string	No	SPECIAL-USE value. E.g. "inbox", "sent", "drafts", "junk", etc.
sort_order		No	See Section 2, ]
items	array of content item names and flags	Yes	Mapping from UIDs to corresponding message files included in the archive
original_name	string	No	Original folder name (relative to its parent, if any) if the name can't be represented in filesystem, e.g. if it includes special characters
comment	string	No	Can include information about partial export or filter used in human readable UTF-8 text
removed	array of unsigned 32 bit integers	No	List of messages (UIDs) removed since the last export

The uid for a folder SHOULD be present. For IMAP folders, this SHOULD be the OBJECTID defined by . In an incremental update, a folder can both have items added/removed and be deleted in the time period elapsed, so it could have removed messages and flags as well as be a tombstone. A full archive or snapshot SHOULD NOT include deleted folders with the deleted_at value. The folder.json format can be defined generally as follows. Note that this covers folders containing tasks, notes, contacts or emails, so the fields that are specific to IMAP folders are not required.

General JSON Schema for folder.json

Example of folder.json (full export):

A basic folder.json example

UIDs SHOULD always be strings. This allows systems with UIDs that are not integers to export and synchronize data reliably. IMAP UIDs can always be converted back to integers. Example of folder.json that shows incremental changes from the previous export shown above. In this example 2 messages with UIDs 3 and 15 were removed. Message with UID 1 has updated flags. Several new messages were added, some of them are with flags set.

A folder.json example with incremental changes

Finally, to show an example containing no IMAP content but also meets schema requirements:

A folder.json example with incremental changes

Contacts has long been the basis for address book and contact data representation in structured data files. The specifications for and JMAP for Contacts do a bunch of the work to explain how to do this in JSON, and in particular RFC9610 explains how to express references between objects (e.g. an address book and a contact in that address book) which is useful for a full export that can have its references reconstructed. This section explains how to use the fields and structures of those specifications within a PDP Archive export.

Individual Contact Items Individual contact items build on and which build on .

• The globally unique uid property is mandatory in JSContact and MUST be included in PDP archive.
• The updated property is optional in JSContact but MUST be included in PDP archive.
• The rev property defined in , which is not included in , may already be available in implementations. It MAY also be included as a field on a contact, in which case it is a simple value field holding a timestamp.
• The @type property should be "Card" because uses a value of "Card" for @type and registers that in https://www.iana.org/assignments/jscontact/jscontact.xhtml. JMAP for Contacts uses "ContactCard" and registers that in https://www.iana.org/assignments/jmap/jmap.xhtml but does not use that as a @type value directly.

Schema for contacts

We make some specific requirements on the updated value so that it can be useful for synchronization. See the section on updated and uid specifically . Cards can also have an id value; nevertheless uid is required by this specification for consistency of identifying different kinds of objects. See also how contrasts id with uid. When the structured data is prepared, a contact can be exported in a file with an arbitrary name using a limited set of characters suitable for interoperability across filesystems. For example, a file called 'contact1.json' could contain:

A contact example called contact1.json in the export

For clarity, this example includes: * How a card can reference address books which are exported as separate files in the overall export * How a card can reference other cards using relatedTo * A card can contain arbitrary notes - those are not necessarily exported as separate files even though notes are also an object that can be included as individual files in a PDPArchive export. Because a ContactCard item can reference an AddressBook item, if a system exports contacts belonging to address books it SHOULD also export the referenced AddressBook objects. Likewise, it SHOULD export the other ContactCard objects that are referenced in the 'relatedTo' field. A permission or scope inconsistency would be one reason why the exporting system would not do so. For example, if the user chose to export only a public address book containing the "John Doe" contact, and not the private "Wedding guests" address book that John Doe also belonged to, then the private address book would either appear as an unresolvable ID or be cleaned up so that it didn't appear (implementor's choice). Likewise, when "John Doe" is exported as part of a single address book export, but the friend relation in relatedTo is not exported because they're not in the same address book, the relatedTo value may be included in the export even if not resolvable by some users of the export file.

Group Contact Items Group contact items also refer to other contact items. A file with an arbitrary name like "contact2.json" could include:

A group contact file example in the export as contact2.json

As with individual ContactCard items referencing objects that are not exported at the same time, a group contact can contain references that are not resolvable within the export. If the user chooses to export all address books then presumably the "The Doe family" group members can all be found somewhere in the export, but if they export only the address book containing "The Doe family" group and not the address books containing individual members, those IDs would not be found in the export.

Using RFC9610 address book objects The specifications never defined a representation for address books. Nor did . JMAP for Contacts does. Its model is clearly that of non-exclusive collection membership: a Contact item may appear with the same UID in multiple Address Books, and if the Contact item with that UID is updated in one it is updated in the other also. Individual address book objects are returned in JMAP protocol messages with protocol wrappers. It is the items inside the "list" element inside "AddressBook/get" that are nearly ready to be represented as individual files in a PDPArchive. However, some things are missing: * uid is called 'id' in JMAP for Contacts but this specification REQUIRES uid. * updated is required * The @type of AddressBook should be included within the data In the schema below, myRights (camelCase) is a JSON object with named boolean fields, unlike the IMAP myrights property which is a compact string of right-characters (e.g. "rwiptsld").

Schema for address book objects

This example copies the examples in so that interoperability between this spec and that one is clear. A file with an arbitrary name like address-book1.json would contain:

An address book file example

address-book2.json would contain:

Another address book file example

Note that the first example includes a shareWith value, showing that the user's AddressBook has been shared with in this case one other principal with the id "3f1502e0-63fe-4335-9ff3-e739c188f5dd". This information can be exported and may be quite useful in case of backup/restore use cases. However, it may not be useful in other administrative domains where the same concept of principals does not allow the Principal ID to be resolved against the correct account. In any case, the object referred to by this Principal ID is not itself given representation in the PDP Archive export.

Calendar events, tasks and groups is the basis for representing events, tasks and groups in JSON. This section explains how to export individual events and tasks within an archive. JMAP for Calendars (https://datatracker.ietf.org/doc/draft-ietf-jmap-calendars/) does provide some additional considerations when producing calendar data from a JMAP system or to be consumed by a JMAP system, so it is also a normative reference. Note on compatibility: Although CalDAV servers are fairly common, they support the older VEVENT and VTODO syntax. This specification requires the JSCalendar syntax instead. Either way, a server building a personal data archive is likely transforming an internal implementation-specific relational data format to an export format. Note on ETag: CalDAV servers use the event's UID to identify the same object, and use ETags to identify changed events, so that a CalDAV client may make sure it has the version a server has before it updates an item, solving the lost-update problem. Since this specification doesn't attempt to solve the lost-update problem as well as client-server protocols can, and since JSCalendar does not include the ETag of a calendar event in any way, this specification does not include any requirements for ETags. Notes on specific fields:

• The globally unique uid property is mandatory in JSCalendar and MUST be included. See JMAP Calendars draft-ietf-jmap-calendars-26 section 1.4.1 for when the uid property can appear the same for multiple recurrences of the same underlying event.
• The updated property is mandatory in JSCalendar and MUST be included.
• The sequence value is optional in JSCalendar but SHOULD be included if available.
• The @type property for one of these items MUST be "Event", "Task" or "Group".
• Recurrence rules SHOULD be fully exported, unless it's clear from the use case or user request that the destination for the data wants expanded recurrences within a specific time period.
• The calendarIds field defined in JMAP Calendars is REQUIRED in order to match up events to the calendar they are supposed to appear in.

Schema for events

For example, a file called event1.json could contain:

Event example

The event object includes a calendarIds property, which links it to the calendar collection it belongs to.

Calendar Collection Items Calendar collection items are built using JMAP for Calendars (draft-ietf-jmap-calendars-26). If a system exports events belonging to calendars, it SHOULD also export the referenced Calendar objects. myRights uses the same JSON object structure as in the Address Book schema, but the set of rights is defined by JMAP Calendars rather than JMAP Contacts, so the property names differ.

Schema for calendar collections

A file with an arbitrary name, such as calendar1.json, in a directory (e.g., \calendars\calendar2) would contain the calendar's metadata:

Calendar example

The uid value here corresponds to the ID used in the calendarIds property of the individual event item. TODO: fix the relationship between folder.json and calendar metadata

Tasks Tasks are also defined by using the "Task" object type. As with events, tasks MUST include the uid and updated fields to support synchronization.

Schema for tasks

For example, a file called task1.json could contain:

Task example

Notes

• VJournal is first defined in .
• VJournal also used in .
• However, they are NOT used in https://jmap.io/spec-calendars.html

Do we even have a JSON format for notes defined?

Files TODO

Other (LMD Note: I think this might better fit in an out of scope section - I think out of scope sections are useful for statements that explain why scope is limited. that's assuming we all agree that groups, freebusy and timezones are left out.) Groups as defined in JSCalendar are NOT part of this archive format. Groups in JSCalendar can combine events and tasks in a container. This specification, for consistency and simplicity, uses folders and requires individual objects to be in separate files. VFREEBUSY objects are not part of this archive format. Calendar software can calculate freebusy time from event data. Use cases that are not satisfied by this limitation could extend this archive format but understanding what it means to backup, restore, export or import freebusy data would need to be fleshed out. VTIMEZONE objects are not part of this archive format. Timezones are more likely to be system objects referred to by calendar objects in modern calendar systems, than personal data. If there are use cases for timezones as personal data, this specification can be extended to explain how that would work.

Synchronization requirements This section describes the requirements to achieve repeated one-way synchronization via export/import operations between software by different vendors. While limited, this still provides better functionality than what many end-users experience with their groupware software and services today. Supporting repeated synchronization means that the export from system A and import to system B can happen over and over again without needlessly duplicating items. Supporting one-way synchronization means that changes in the system with the exporter role propagate reliably to the system with the importer role, but not in the reverse direction. Some of the constraints here arise from the fact that the two systems may not directly connect, and the import may be time-delayed from the export. This limited solution for export/import sync may also be used for more direct system-to-system transfers such as service-to-service data transfers, repeated data access requests or data migrations, although some of those use cases could be solved much better with direct negotiation of features.

Always include 'uid' and 'updated' These requirements apply to , JSTask and objects when exported or imported using the formats in this specification, because these all have 'uid' and 'updated' values. Requirements:

• exporters MUST include the UID and updated fields.
• The 'updated' field MUST be exported in UTC and interpreted in UTC. Accurate system time is important.
• importers MUST use the UID in an imported object, if the importer is creating a new object, rather than invent a new UID.
• importers MUST search for existing objects with the same UID, and if the object in storage is similar enough (see Note below) to the import data, the importer SHOULD NOT change the object and MUST NOT update its 'updated' timestamp.

Recommendations:

• Importers SHOULD use caution with fields that are system-updated, especially frequently updated. Such fields SHOULD NOT change the value of 'updated' that is exported or used to decide whether to update an object during an import operation. See note below on 'updated'.
• Importers SHOULD apply common sense in updating internal or implementation-specific fields. This specification does not require the importer to include, omit, handle or disregard values for fields that it believes are internally-generated or implementation-specific. For example, a system in the role of exporter might export an event object with a video-conference room ID in a custom field. It can decide that it is sensible to export that value as a URL for external use. Later, the same system or one with code written for compatibility could import that event with the video-conference URL, and it would be sensible to avoid overwriting its own knowledge of the room ID with the URL.
• When importing a changed or new object with a UID and 'updated' value, the importer SHOULD set the 'updated' value to the one imported. Thus, if a Contact is updated on Jan 1, exported on Jan 2 and imported on Jan 3, the new or updated imported contact would show an 'updated' value of Jan 1.

Note on similar enough: This specification requires nuance in order to allow both reasonably consistent synchronization and reasonable behavior in a wide variety of use cases and implementations. The language above is intended to give implementors both guidance and wiggle room. For example, the importer could convert a DTSTART time from UTC to the user's local time and save it as the displayed start time. Later, re-importing the same object with the same UID, the importing code could be smart enough to realize that the time hasn't actually changed, and avoid changing the 'updated' timestamp or creating a conflicting event. This logic could be implemented by saving separate fields (imported time vs display time), by keeping a log of updates (log entry stating that the system auto-converted start time from X to Y), or by other clever algorithms. Thus, the clever implementation can avoid the appearance of an object that changes every time the calendar is synchronized. Note on updated: The definition of 'updated' in is not rigorous or nuanced. "when the data in the Card was last modified" could refer to several instances of the card -- its internal implementation, its representation in an email share, its representation in an HTTP GET response (). It's not specified whether 'updated' is the same as REV in , which is defined differently. Neither definition explicitly covers vendor-specific fields. Thus, this specification makes additional recommendations for handling 'updated':

• The value of 'updated' SHOULD only change when two conditions hold: the end-user makes a decision to change a value of a user-visible field, AND the export of the JSContact shows a different value.
• Thus, non-user-visible fields like 'version' could be changed without causing the 'updated' value to change. A value such as 'language' could be set without changing 'updated' (if an implementation infers the language tag and begins to include 'fr-CA' as the language value in exports instead of no language, nevertheless this doesn't change the user-visible content).
• If implementations need to manage the synchronization of vendor-specific fields, a vendor-specific field like 'example.com:updated' can be used rather than affect the user-visible synchronization made possible by 'updated'. Implementations could possibly also handle 'updated' differently when used for export/import using the formats in this specification, than when the same field is handled in other code paths.

We recognize that this understanding of 'updated' is highly judgement-dependent. The same field can change in one way and cause a change to 'updated' and in another way may not (the example of server inferring the language is 'fr-CA' vs the user explicitly setting it). It is likely to be frustrating to protocol designers and implementors (as it is to the authors of this specification) that the definition is so wobbly. We'd love to know of better solutions that work with the status quo.

Synchronizing from and to CalDAV servers uses URLs, ETags and UIDs for synchronizing changes between two systems reliably, but it relies upon client-server architecture, where the server is the "source of truth" and the client must manage its local history and decide which things to update from the server and which things to tell the server to update. If a user is setting up synchronization or an implementor is building a system that involves synchronization, it may be best to use CalDAV if that is a feasible solution. Nevertheless, we believe some of the use cases in our use case section motivate not only including calendar data in these archives for backup purposes, but also for partial updates. This works the same way it does for JSContact and JSCard objects.

Synchronizing address books Build on

Synchronizing mailbox folders Because servers may differ in which characters they support in folder names, how many levels deep folders may be created, and even in what separator character is used to indicate folder hierarchy, difficulties in synchronizing folder names will definitely arise. Folder names that are not likely to be widely supported in other systems should be translated for export, because if the exporting system has a consistent translation algorithm, then even if the mailbox name looks different in the importing system it will still be imported consistently. Systems that support mailbox IDs MUST include them in exports. Systems that do not (though it's strongly encouraged) SHOULD use the full mailbox name as the unique identifier value.

• TODO: Also it would be good to include a "display name" in case the server has had to translate the mailbox name for compatibility. E.g. a server that has a mailbox named "%L33T%", but knows the "%" should not be exported because many servers forbid the "%", would translate the name consistently to pc_L33T_pc or another set of safe characters and include a display name of "%L33T%" for reference and debugging.

Blobs and files? Reference ?

Open issues

Container format This document leverages existing data formats and adds certain files for representing metadata. While one may work with this raw data, most import/export scenarios will rather require the bundling of individual data items into one or few container files. This document does not strive to invent its own container format, but may refer to existing ones. High level options would be:

• Recommend using a container format without preferring a particular one
• Mandating a specific format
• ...?

Actual container formats likely differ in various dimensions:

• Ease of adding incremental data
• Ease of updating existing data
• Ease of accessing files
• Support for compression
• Support for data streaming
• Availability of library/tool support across platforms
• Internal file references
• Open standard
• ...?

Candidates

• tar/gz
• zip
• 7z
• zpaq
• ...?

See https://github.com/hhappel/draft-happel-mailmaint-pdparchive/issues/13

Encryption Support for encryption of any kind is so far no requirement in the draft. However, an increasing number of services offers forms of data encryption. Implications for this draft may be considered. "Encryption" might refer to various aspects:

• Existing encryption of individual files in the export
• Encrypting the complete export (incl. metadata?)
• ...?

See https://github.com/hhappel/draft-happel-mailmaint-pdparchive/issues/14

Implementation status < RFC Editor: before publication please remove this section and the reference to > This section records the status of known implementations of the protocol defined by this specification at the time of posting of this Internet-Draft, and is based on a proposal described in . The description of implementations in this section is intended to assist the IETF in its decision processes in progressing drafts to RFCs. Please note that the listing of any individual implementation here does not imply endorsement by the IETF. Furthermore, no effort has been spent to verify the information presented here that was supplied by IETF contributors. This is not intended as, and must not be construed to be, a catalog of available implementations or their features. Readers are advised to note that other implementations may exist. According to , "this will allow reviewers and working groups to assign due consideration to documents that have the benefit of running code, which may serve as evidence of valuable experimentation and feedback that have made the implemented protocols more mature. It is up to the individual working groups to use this information as they see fit".

Security Considerations TODO Security

Privacy considerations tbd.

IANA Considerations

File extension Register .pdpa?

References Normative References This document specifies the Internet Message Format (IMF), a syntax for text messages that are sent between computer users, within the framework of "electronic mail" messages. This specification is a revision of Request For Comments (RFC) 2822, which itself superseded Request For Comments (RFC) 822, "Standard for the Format of ARPA Internet Text Messages", updating it to reflect current practice and incorporating incremental changes that were specified in other RFCs. [STANDARDS-TRACK] This document defines extensions to the Web Distributed Authoring and Versioning (WebDAV) protocol to specify a standard way of accessing, managing, and sharing contact information based on the vCard format. [STANDARDS-TRACK] This document updates RFC 3501 (IMAP4rev1) with persistent identifiers on mailboxes and messages to allow clients to more efficiently reuse cached data when resources have changed location on the server. This document specifies a data model for synchronising email data with a server using the JSON Meta Application Protocol (JMAP). Clients can use this to efficiently search, access, organise, and send messages, and to get push notifications for fast resynchronisation when new messages are delivered or a change is made in another client. This specification defines a data model and JSON representation of calendar data that can be used for storage and data exchange in a calendaring and scheduling environment. It aims to be an alternative and, over time, successor to the widely deployed iCalendar data format. It also aims to be unambiguous, extendable, and simple to process. In contrast to the jCal format, which is also based on JSON, JSCalendar is not a direct mapping from iCalendar but defines the data model independently and expands semantics where appropriate. This specification defines a data model and JavaScript Object Notation (JSON) representation of contact card information that can be used for data storage and exchange in address book or directory applications. It aims to be an alternative to the vCard data format and to be unambiguous, extendable, and simple to process. In contrast to the JSON-based jCard format, it is not a direct mapping from the vCard data model and expands semantics where appropriate. Two additional specifications define new vCard elements and how to convert between JSContact and vCard. This document specifies a data model for synchronising contact data with a server using the JSON Meta Application Protocol (JMAP). The Internet Message Access Protocol Version 4rev2 (IMAP4rev2) allows a client to access and manipulate electronic mail messages on a server. IMAP4rev2 permits manipulation of mailboxes (remote message folders) in a way that is functionally equivalent to local folders. IMAP4rev2 also provides the capability for an offline client to resynchronize with the server. IMAP4rev2 includes operations for creating, deleting, and renaming mailboxes; checking for new messages; removing messages permanently; setting and clearing flags; parsing per RFCs 5322, 2045, and 2231; searching; and selective fetching of message attributes, texts, and portions thereof. Messages in IMAP4rev2 are accessed by the use of numbers. These numbers are either message sequence numbers or unique identifiers. IMAP4rev2 does not specify a means of posting mail; this function is handled by a mail submission protocol such as the one specified in RFC 6409. In many standards track documents several words are used to signify the requirements in the specification. These words are often capitalized. This document defines these words as they should be interpreted in IETF documents. This document specifies an Internet Best Current Practices for the Internet Community, and requests discussion and suggestions for improvements. RFC 2119 specifies common key words that may be used in protocol specifications. This document aims to reduce the ambiguity by clarifying that only UPPERCASE usage of the key words have the defined special meanings. Informative References This document revises the specifications in RFC 733, in order to serve the needs of the larger and more complex ARPA Internet. Some of RFC 733's features failed to gain adequate acceptance. In order to simplify the standard and the software that follows it, these features have been removed. A different addressing scheme is used, to handle the case of internetwork mail; and the concept of re-transmission has been introduced. Obsoletes RFC 733, NIC 41952. The Internet Message Access Protocol, Version 4rev1 (IMAP4rev1) allows a client to access and manipulate electronic mail messages on a server. IMAP4rev1 permits manipulation of mailboxes (remote message folders) in a way that is functionally equivalent to local folders. IMAP4rev1 also provides the capability for an offline client to resynchronize with the server. IMAP4rev1 includes operations for creating, deleting, and renaming mailboxes, checking for new messages, permanently removing messages, setting and clearing flags, RFC 2822 and RFC 2045 parsing, searching, and selective fetching of message attributes, texts, and portions thereof. Messages in IMAP4rev1 are accessed by the use of numbers. These numbers are either message sequence numbers or unique identifiers. IMAP4rev1 supports a single server. A mechanism for accessing configuration information to support multiple IMAP4rev1 servers is discussed in RFC 2244. IMAP4rev1 does not specify a means of posting mail; this function is handled by a mail transfer protocol such as RFC 2821. [STANDARDS-TRACK] This document specifies a syntax for text messages that are sent between computer users, within the framework of "electronic mail" messages. [STANDARDS-TRACK] This memo requests that the application/mbox media type be authorized for allocation by the IESG, according to the terms specified in RFC 2048. This memo also defines a default format for the mbox database, which must be supported by all conformant implementations. This memo provides information for the Internet community. The Access Control List (ACL) extension (RFC 2086) of the Internet Message Access Protocol (IMAP) permits mailbox access control lists to be retrieved and manipulated through the IMAP protocol. This document is a revision of RFC 2086. It defines several new access control rights and clarifies which rights are required for different IMAP commands. [STANDARDS-TRACK] This document defines extensions to the Web Distributed Authoring and Versioning (WebDAV) protocol to specify a standard way of accessing, managing, and sharing calendaring and scheduling information based on the iCalendar format. This document defines the "calendar-access" feature of CalDAV. [STANDARDS-TRACK] This document defines the iCalendar data format for representing and exchanging calendaring and scheduling information such as events, to-dos, journal entries, and free/busy information, independent of any particular calendar service or protocol. [STANDARDS-TRACK] Over its thirty-five-year history, Internet Mail has changed significantly in scale and complexity, as it has become a global infrastructure service. These changes have been evolutionary, rather than revolutionary, reflecting a strong desire to preserve both its installed base and its usefulness. To collaborate productively on this large and complex system, all participants need to work from a common view of it and use a common language to describe its components and the interactions among them. But the many differences in perspective currently make it difficult to know exactly what another participant means. To serve as the necessary common frame of reference, this document describes the enhanced Internet Mail architecture, reflecting the current service. This memo provides information for the Internet community. Some IMAP message stores include special-use mailboxes, such as those used to hold draft messages or sent messages. Many mail clients allow users to specify where draft or sent messages should be put, but configuring them requires that the user know which mailboxes the server has set aside for these purposes. This extension adds new optional mailbox attributes that a server may include in IMAP LIST command responses to identify special-use mailboxes to the client, easing configuration. [STANDARDS-TRACK] This document defines the vCard data format for representing and exchanging a variety of information about individuals and other entities (e.g., formatted and structured name and delivery addresses, email address, multiple telephone numbers, photograph, logo, audio clips, etc.). This document obsoletes RFCs 2425, 2426, and 4770, and updates RFC 2739. [STANDARDS-TRACK] Often, multiple IMAP (RFC 3501) clients need to coordinate changes to a common IMAP mailbox. Examples include different clients working on behalf of the same user and multiple users accessing shared mailboxes. These clients need a mechanism to efficiently synchronize state changes for messages within the mailbox. Initially defined in RFC 4551, the Conditional Store facility provides a protected update mechanism for message state information and a mechanism for requesting only changes to the message state. This memo updates that mechanism and obsoletes RFC 4551, based on operational experience. This document additionally updates another IMAP extension, Quick Resynchronization, which builds on the Conditional STORE extension to provide an IMAP client the ability to fully resynchronize a mailbox as part of the SELECT/EXAMINE command, without the need for additional server-side state or client round trips. Hence, this memo obsoletes RFC 5162. Finally, this document also updates the line-length recommendation in Section 3.2.1.5 of RFC 2683. This document describes a simple process that allows authors of Internet-Drafts to record the status of known implementations by including an Implementation Status section. This will allow reviewers and working groups to assign due consideration to documents that have the benefit of running code, which may serve as evidence of valuable experimentation and feedback that have made the implemented protocols more mature. This process is not mandatory. Authors of Internet-Drafts are encouraged to consider using the process for their documents, and working groups are invited to think about applying the process to all of their protocol specifications. This document obsoletes RFC 6982, advancing it to a Best Current Practice. This document proposes a notational convention to express Concise Binary Object Representation (CBOR) data structures (RFC 7049). Its main goal is to provide an easy and unambiguous way to express structures for protocol messages and data formats that use CBOR or JSON. The JSON Meta Application Protocol (JMAP) base protocol (RFC 8620) provides the ability to upload and download arbitrary binary data via HTTP POST and GET on a defined endpoint. This binary data is called a "blob". This extension adds additional ways to create and access blobs by making inline method calls within a standard JMAP request. This extension also adds a reverse lookup mechanism to discover where blobs are referenced within other data types. Microsoft Google

Acknowledgments TODO acknowledge.

Changes

Changes in draft-ietf-mailmaint-pdparchive-01

• Added JSON Schema (draft 2020-12) files for all defined data types: folder, archive, contact, address book, calendar, event, and task.
• Added a folder tombstone mechanism to support incremental exports that delete previously exported folders.