Metadata-Version: 2.1
Name: imapmon
Version: 0.2.53
Summary: Tool for monitoring IMAP mailboxes and retransmitting received emails via alternative channels
Home-page: https://soar.name
Author: soar
Author-email: i@soar.name
License: MIT
Description: # 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 \
                ...
            ```
        
Keywords: imap,telegram
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Description-Content-Type: text/markdown
