From 51cec55f440a4d1128160c955fdcd69a9049bfa9 Mon Sep 17 00:00:00 2001 From: Tyler <68524461+TySP-Dev@users.noreply.github.com> Date: Tue, 24 Mar 2026 17:03:03 -0400 Subject: [PATCH] Updated readme --- README.md | 25 +++++++++++++++---------- 1 file changed, 15 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index bd99e58..2e75b0b 100644 --- a/README.md +++ b/README.md @@ -21,18 +21,23 @@ A self-hosted email forwarding tool that monitors a Proton Mail account on a set ``` mailrelay/ ├── main.py Entry point — CLI flags, scheduler startup -├── config.py Encrypted config read/write (age + TOML) -├── exporter.py pexpect automation of proton-mail-export-cli -├── processor.py EML + metadata merging, dedup check -├── forwarder.py IMAP push to iCloud (Mode 1) -├── packager.py MBOX generation and local download server (Mode 2) -├── scheduler.py APScheduler interval logic -├── database.py SQLite dedup tracking -├── otp.py pyotp TOTP generation -├── logger.py Rotating log setup -├── tools.py Proton Export CLI download + install manager ├── requirements.txt Python dependencies ├── setup.sh One-shot venv + dependency installer +├── modules/ +│ ├── __init__.py +│ ├── config.py Encrypted config read/write (age + TOML) +│ ├── database.py SQLite dedup tracking +│ ├── exporter.py pexpect automation of proton-mail-export-cli +│ ├── forwarder.py IMAP push to iCloud (Mode 1) +│ ├── logger.py Rotating log setup +│ ├── otp.py pyotp TOTP generation +│ ├── packager.py MBOX generation and local download server (Mode 2) +│ ├── processor.py EML + metadata merging, dedup check +│ ├── scheduler.py APScheduler interval logic +│ └── tools.py Proton Export CLI download + install manager +├── tools/ +│ └── proton-export/ +│ └── proton-mail-export-cli (downloaded on first run) └── data/ ├── config.age Encrypted config (created on first run) ├── mailrelay.db SQLite database (created on first run)