The purpose of this bridge is to send emails back and forth between matrix and an IMAP session. This bridge uses a single room for all emails, and each email thread gets it's own matrix thread. Replying to the email in the thread will send an email to the recipient. Additional emails will be further replies in the thread. Deleting a message in matrix will delete that email. Support for moving and archiving emails does not currently exist, but is planned (eventually).
By far, the easiest way to run this bridge is to use the docker image. I use podman but the commands for docker are interchangeable:
- Create a new room in Matrix using your favorite client
- Copy the room id (instructions vary by client)
- Create a volume directory
mkdir $HOME/matrix-email-bridge - Download and run the bridge
podman run -it --rm -v $HOME/matrix-email-bridge:/app/config:Z --name matrix-email-bridge docker.io/danastasio/matrix-email-bridge:stable - The bridge will run and create the config files the first time it is run. Fill out $HOME/matrix-email-bridge/settings.py and $HOME/matrix-email-bridge/secrets.py
- Run the bridge again (change -it to -dt if you don't want the output). It will stay running this time.
- 100% email -> matrix
- 100% matrix -> email
- 010% Attachments (WIP)
- 020% HTML Formatting (WIP)
- 000% IMAP Idle command
- 000% Archiving emails
- 000% Moving to another folder
- 000% Deleting emails
- Support for an encrypted room (long term goal. will require rebasing entire code base)