email-forwarder/README.md
Jeena fad2727ae8 Update default FOLDERS to include Sent
Change default from INBOX to INBOX,Sent for better out-of-the-box
experience, as Sent is commonly forwarded alongside inbox.

Changes:
- Update FOLDERS in .env.example
- Update README to reflect new default
2026-01-04 17:55:19 +09:00

42 lines
No EOL
1.6 KiB
Markdown

# Email Forwarder
This script forwards new emails from a source IMAP account (e.g., GMX) to a destination IMAP account (e.g., MXRoute), avoiding duplicates by tracking Message-IDs.
## Setup
Run the install script: `./install.sh`
This will set up the virtual environment, systemd services, and provide post-install instructions.
## Configuration (.env)
- `SOURCE_HOST`: Source IMAP server (e.g., imap.gmx.com)
- `SOURCE_PORT`: Port (default 993)
- `SOURCE_USER`: Source email/username
- `SOURCE_PASS`: Source password
- `DEST_HOST`: Destination IMAP server (e.g., yourserver.mxrouting.net)
- `DEST_PORT`: Port (default 993)
- `DEST_USER`: Destination email/username
- `DEST_PASS`: Destination password
- `FOLDERS`: Folders to sync (default "INBOX,Sent"; use "all" for all folders or comma-separated list)
- `DRY_RUN`: Set to `true` for testing without forwarding (default false)
- `UPTIME_SUCCESS_URL`: URL for success ping
- `UPTIME_FAIL_URL`: URL for failure ping
## How It Works
- Uses time-based search (`SINCE`) with `last_run.txt` to find emails since last run.
- Extracts Message-ID, checks against local file and destination IMAP for duplicates.
- Forwards via IMAP APPEND; updates `last_run.txt` on success.
- Logs activity; systemd handles Uptime Kuma pings.
## Monitoring with Uptime Kuma
- Success: Pings `${UPTIME_SUCCESS_URL}` after forwarding.
- Failure: `OnFailure` pings `${UPTIME_FAIL_URL}`.
## Troubleshooting
- Logs: `journalctl --user -u email_forwarder.service`
- Test: `source venv/bin/activate && python main.py`
- Timezone issues: Adjust UTC offset in script if needed.