Skip to content

Latest commit

 

History

History
33 lines (24 loc) · 1.39 KB

README.md

File metadata and controls

33 lines (24 loc) · 1.39 KB

Demailer: a simple email-to-telegram proxy

[[TOC]]

Installation and usage

  • First, get yourself a copy of poetry
  • Then, run poetry install
  • Setup environmental variables as follows:
    • DEMAILER_POLL_INTERVAL: how often will Demailer check for new mail in seconds (default: 30)
    • DEMAILER_IMAP_HOST: your mail server hostname
    • DEMAILER_IMAP_PORT: your mail server port (default: 993)
    • DEMAILER_IMAP_LOGIN: your mail server login
    • DEMAILER_IMAP_PASSWORD: your mail server password
    • DEMAILER_TG_BOT_TOKEN: your own TG bot's token
    • DEMAILER_TG_USER_ID: your own TG chat ID (go get one from @userinfobot)
  • Setup stop phrases and addresses in the config file
  • Run with python runner.py
  • Enjoy the show!

FAQ

Q: Will Demailer show all unread messages in my inbox on startup?

A: No! Demailer searches messages with (NEW) IMAP status – this returns only those messages that weren't received by any of the email clients beforehand.

Q: Does Demailer mark my messages as read upon notifying?

A: Again, no chance! Demailer only removes the (NEW) status from the message, they will remain unread until you actually read them in your favourite email client.

Dockerization

coming soon!