September 9th, 2024

Jmap-backup: Back up Fastmail mailboxes to standard EML format files

jmap-backup is a Python program for backing up Fastmail JMAP mailboxes, requiring a Fastmail API key and either Docker or Python 3. It offers customizable configuration and message verification.

Read original articleLink Icon
Jmap-backup: Back up Fastmail mailboxes to standard EML format files

The jmap-backup is a Python program aimed at backing up messages from Fastmail's JMAP mailbox, based on the work of Nathan Grigg. To use the program, users need a Fastmail API key, which can be obtained from Fastmail settings, and either Docker or Python 3 with the `requests` module installed. For local setup, users should download the latest release or clone the repository, copy the `jmap-backup.py` script to a directory in their `$PATH`, and create a JSON configuration file that includes at least the `dest_dir` and `token` keys. The backup can be initiated with a specific command. For Docker users, the process involves cloning the repository, creating necessary directories, setting up a configuration file, building the Docker image, and running the container. Additional configuration options are available in the config file, allowing users to customize parameters like `delay_hours` and `not_before`. The program includes a verification feature to ensure that all messages in the mailbox are backed up correctly. It is designed for efficiency and can be scheduled for regular backups, such as through cron jobs.

- jmap-backup is designed for backing up Fastmail JMAP mailboxes.

- Users need a Fastmail API key and either Docker or Python 3.

- The program can be run locally or within a Docker container.

- Configuration options allow for customization of backup parameters.

- The program includes a verification feature to ensure message integrity.

Link Icon 3 comments
By @luckman212 - 5 months
This is a Python program to back up messages from a Fastmail mailbox via JMAP API to a local or network-attached directory.

Standing on the shoulders of the great work of Nathan Grigg[0], I've updated and extended it with a few new features. The README contains instructions for running it locally, or via Docker if you prefer.

Hope it's useful to someone, let me know if you encounter issues.

[0]: https://nathangrigg.com/2021/08/fastmail-backup/

By @toomuchtodo - 5 months
Thank you for this!
By @jakemauer - 5 months
I've been looking for a backup solution for Fastmail for a while, thank you!