imap-archiver/README.md

28 lines
737 B
Markdown
Raw Normal View History

2024-03-05 19:54:06 -07:00
# imap-archiver
2024-03-05 23:57:38 -07:00
_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.
2024-03-06 14:34:34 -07:00
A very simple web viewer is provided to view your raw emails.
Does not support different accounts.
2024-03-05 23:57:38 -07:00
## Install
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 run.py`
2024-03-06 00:04:11 -07:00
A sample systemd service file is included.
2024-03-05 23:57:38 -07:00
## To Do
- [ ] Fix subject decoding. Some character sets aren't detected correctly.
2024-03-06 14:34:34 -07:00
- [ ] Sync Gmail categories as folders.
2024-03-06 17:22:42 -07:00
- [ ] In the viewer, format the raw email to something viewable.