imap-archiver/README.md

1.1 KiB

imap-archiver

Archive the content on your email account.

A very simple way to sync your email account with the goal of backing up all your emails.

Saves attachments to disk and stores the emails in an SQLite database.

A very simple web viewer is provided to view your raw emails.

Does not support different accounts.

Install

Archiver

  1. Create a venv
  2. pip install -r requirements.txt
  3. cp config.yml.sample config.yml
  4. Edit config.yml and configure your login info.
  5. python3 archiver.py

Viewer

  1. sudo mkdir /etc/secrets
  2. sudo chown -R root:root /etc/secrets
  3. Generate your password:
    echo -n "<your password>" | base64
    
  4. Edit /etc/secrets/imapviewer with this content:
    HTTP_AUTH_PASS=<your encoded password>
    EMAIL_ARCHIVE_ROOT=<archive root path>
    
  5. sudo chmod 600 /etc/secrets/imapviewer
  6. Reload and start the service.

Sample systemd services file is included.

To Do

  • Fix subject decoding. Some character sets aren't detected correctly.
  • In the viewer, format the raw email to something viewable.