https://github.com/soar/imapmon

Read your emails in Telegram
https://github.com/soar/imapmon

automation email imap imap-client telegram telegram-bot

Last synced: 5 months ago
JSON representation

Read your emails in Telegram

• Host: GitHub
• URL: https://github.com/soar/imapmon
• Owner: soar
• License: mit
• Created: 2020-05-15T23:18:29.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-31T07:06:12.000Z (over 3 years ago)
• Last Synced: 2025-09-28T06:04:04.704Z (9 months ago)
• Topics: automation, email, imap, imap-client, telegram, telegram-bot
• Language: Python
• Homepage: https://soar.name
• Size: 241 KB
• Stars: 1
• Watchers: 1
• Forks: 2
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# IMAP Mon

![PyPI - License](https://img.shields.io/pypi/l/imapmon)

![🐍 CI](https://github.com/soar/imapmon/workflows/%F0%9F%90%8D%20CI/badge.svg?branch=master)

![PyPI - Implementation](https://img.shields.io/pypi/implementation/imapmon)

![PyPI - Python Version](https://img.shields.io/pypi/pyversions/imapmon)

![PyPI - Wheel](https://img.shields.io/pypi/wheel/imapmon)

![GitHub last commit](https://img.shields.io/github/last-commit/soar/imapmon)

Tool for monitoring IMAP mailboxes and retransmitting received emails via alternative channels

## Quick start

1. Create a file `docker-compose.override.yml` or update `docker-compose.yml` with environment variables defined below.

2. Start the app with:

    ```shell

    docker-compose up

    ```

## Settings

Some options can be set via an environment variable (real or [dotenv](https://github.com/theskumar/python-dotenv)) or a command line flag.

| Environment variable name | Command line flag | Required | Description |

| --- | --- | --- | --- |

| `IMAP_HOSTNAME` | `--hostname`/`-h` | ☑️ | IMAP server hostname |

| `IMAP_USERNAME` | `--username`/`-u` | ☑️ | IMAP username |

| `IMAP_PASSWORD` | `--password`/`-p` | ☑️ | IMAP password/key/token |

| `CHANNELS` | `--channel`/`-c` | ☑️ | Channel to retransmit messages |

| `TELEGRAM_BOT_TOKEN` | `--telegram-bot-token` | ☑️/✖️ | Telegram Bot Token |

| `TELEGRAM_CHAT_ID` | `--telegram-chat-id` | ☑️/✖️ | Telegram Chat ID (channel ID, group ID or @username) |

| `SENTRY_DSN` | `--sentry-dsn` | ✖️ | Sentry DSN |

| `LOG_LEVEL` | `--log-level`/`-l` | ✖️ | Log level for console messages |

## Examples

0. Get help:

    ```bash

    imapmon --help

    ```

1. Passing parameters via a command-line:

    ```bash

    imapmon --hostname imap.example.com -u user@example.com -p qwerty123 -c telegram --telegram-bot-token "1234567890:EtneWwZtnEibpH6WZVsnZimbPXZLRurw" --telegram-chat-id "12345678"

    ```

2. Passing parameters via environment variables:

    ```bash

    export IMAP_HOSTNAME=imap.example.com

    export IMAP_USERNAME=user@example.com

    export IMAP_PASSWORD=qwerty123

    CHANNELS=telegram TELEGRAM_BOT_TOKEN=xxx TELEGRAM_CHAT_ID=123 imapmon

    ```

3. Run using a pre-built Docker image:

    ```bash

    docker run --rm -it \

        docker.pkg.github.com/soar/imapmon/imapmon:latest \

        --hostname imap.example.com \

        -u user@example.com \

        -p qwerty123 \

        ...

    ```