Mailbagit

A tool for creating and managing Mailbags, a package for preserving email in multiple formats. It contains an open specification for mailbags, as well as the mailbagit and mailbagit-gui tools for packaging email exports into mailbags.

Installation

pip install mailbagit

• To install PST dependancies: pip install mailbagit[pst]
• To install mailbagit-gui: pip install mailbagit[gui]

You can also run mailbagit using a Docker image.

Quick start

Examples:

mailbagit path/to/messages -i msg --derivatives eml pdf warc --mailbag_name my_mailbag

mailbagit path/to/inbox.mbox -i mbox -d txt pdf-chrome -m my_mailbag -r

mailbagit path/to/export.pst -i pst -d mbox eml pdf warc -m my_mailbag

See the documentation for more details on:

• mailbagit
• mailbagit-gui
• logging
• plugins

Development setup

git clone git@github.com:UAlbanyArchives/mailbagit.git
cd mailbagit
git switch develop
pip install -e .

Development with docker

Build and run image

docker pull ualbanyarchives/mailbagit:dev
docker run -it ualbanyarchives/mailbagit:dev

License

MIT

Kudos

This project was made possible by funding from the University of Illinois's Email Archives: Building Capacity and Community Project.

We owe a lot to the hard work that goes towards developing and maintaining the libraries mailbagit uses to parse email formats and make bags. We'd like to thank these awesome projects, without which mailbagit wouldn't be possible:

• extractMsg
• libpff
• bagit-python

We'd also like to thank the RATOM project whose documentation was super helpful in guiding us though some roadblocks.