├── .gitignore ├── logo ├── Mail2TelegramForwarder-Bot.png ├── Mail2TelegramForwarder-Bot-small.png ├── CREDIT.md ├── source │ ├── lob-arrow-svgrepo-com.svg │ ├── paper-plane-svgrepo-com.svg │ └── mail-svgrepo-com.svg └── Mail2TelegramForwarder-Bot.svg ├── .github ├── codecov.yml └── workflows │ ├── code_quality.yml │ ├── codeql-analysis.yml │ └── codecov-report.yml ├── systemd └── mail-to-telegram-forwarder@.service ├── SECURITY.md ├── LICENSE-MIT.md ├── conf └── mailToTelegramForwarder.conf ├── README.md ├── LICENSE.md └── mailToTelegramForwarder.py /.gitignore: -------------------------------------------------------------------------------- 1 | /conf/mailToTelegramForwarder-*.conf 2 | -------------------------------------------------------------------------------- /logo/Mail2TelegramForwarder-Bot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/awalon/MailToTelegramForwarder/HEAD/logo/Mail2TelegramForwarder-Bot.png -------------------------------------------------------------------------------- /logo/Mail2TelegramForwarder-Bot-small.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/awalon/MailToTelegramForwarder/HEAD/logo/Mail2TelegramForwarder-Bot-small.png -------------------------------------------------------------------------------- /.github/codecov.yml: -------------------------------------------------------------------------------- 1 | codecov: 2 | require_ci_to_pass: yes 3 | 4 | coverage: 5 | precision: 2 6 | round: down 7 | range: "70...100" 8 | 9 | parsers: 10 | gcov: 11 | branch_detection: 12 | conditional: yes 13 | loop: yes 14 | method: no 15 | macro: no 16 | 17 | comment: 18 | layout: "reach,diff,flags,files,footer" 19 | behavior: default 20 | require_changes: no -------------------------------------------------------------------------------- /systemd/mail-to-telegram-forwarder@.service: -------------------------------------------------------------------------------- 1 | [Unit] 2 | Description=Mail to Telegram Forwarder - Service for: '%i' 3 | After=network-online.target nss-lookup.target 4 | Wants=network-online.target nss-lookup.target 5 | Documentation=https://github.com/awalon/MailToTelegramForwarder/ 6 | 7 | [Service] 8 | ExecStart=/usr/local/bin/mailToTelegramForwarder --config /etc/mail-to-telegram-forwarder/%i.conf 9 | User=mail2telegram 10 | Restart=on-failure 11 | 12 | [Install] 13 | WantedBy=multi-user.target 14 | -------------------------------------------------------------------------------- /logo/CREDIT.md: -------------------------------------------------------------------------------- 1 | # Credits 2 | ## game-icons.net (CC-BY) for `arrow`: 3 | [![lob arrow](source/lob-arrow-svgrepo-com.svg)](https://www.svgrepo.com/svg/321066/lob-arrow) 4 | ## SVG Repo (CC0) for `mail`: 5 | [![mail](source/mail-svgrepo-com.svg)](https://www.svgrepo.com/svg/246368/mail) 6 | ## SVG Repo (CC0) for `paper plane`: 7 | [![paper plane](source/paper-plane-svgrepo-com.svg)](https://www.svgrepo.com/svg/193985/paper-plane) 8 | ## Composition for `Mail2TelegramForwarder` by [Awalon](https://github.com/awalon/): 9 | [![Mail2TelegramForwarder](Mail2TelegramForwarder-Bot.svg)](https://github.com/awalon/MailToTelegramForwarder) -------------------------------------------------------------------------------- /logo/source/lob-arrow-svgrepo-com.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /SECURITY.md: -------------------------------------------------------------------------------- 1 | # Security Policy 2 | 3 | ## Supported Versions 4 | 5 | This is just a spare time project and only most recent version get's fixes and updates. 6 | 7 | | Version | Supported | 8 | |------------------------------------------------------------------------|--------------------| 9 | | [current](https://github.com/awalon/MailToTelegramForwarder/releases/) | :white_check_mark: | 10 | | older | :x: | 11 | 12 | ## Reporting a Vulnerability 13 | 14 | Please create an issue. 15 | -------------------------------------------------------------------------------- /.github/workflows/code_quality.yml: -------------------------------------------------------------------------------- 1 | name: Qodana 2 | on: 3 | workflow_dispatch: 4 | pull_request: 5 | push: 6 | branches: 7 | - main 8 | - 'releases/*' 9 | 10 | jobs: 11 | qodana: 12 | runs-on: ubuntu-latest 13 | permissions: 14 | contents: write 15 | pull-requests: write 16 | checks: write 17 | steps: 18 | - uses: actions/checkout@v3 19 | with: 20 | ref: ${{ github.event.pull_request.head.sha }} # to check out the actual pull request commit, not the merge commit 21 | fetch-depth: 0 # a full history is required for pull request analysis 22 | - name: 'Qodana Scan' 23 | uses: JetBrains/qodana-action@v2023.2 24 | env: 25 | QODANA_TOKEN: ${{ secrets.QODANA_TOKEN }} 26 | -------------------------------------------------------------------------------- /LICENSE-MIT.md: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2016 Luca Weiss 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /logo/source/paper-plane-svgrepo-com.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 5 | 11 | 12 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | -------------------------------------------------------------------------------- /.github/workflows/codeql-analysis.yml: -------------------------------------------------------------------------------- 1 | # For most projects, this workflow file will not need changing; you simply need 2 | # to commit it to your repository. 3 | # 4 | # You may wish to alter this file to override the set of languages analyzed, 5 | # or to provide custom queries or build logic. 6 | # 7 | # ******** NOTE ******** 8 | # We have attempted to detect the languages in your repository. Please check 9 | # the `language` matrix defined below to confirm you have the correct set of 10 | # supported CodeQL languages. 11 | # 12 | name: "CodeQL" 13 | 14 | on: 15 | push: 16 | branches: [ master ] 17 | pull_request: 18 | # The branches below must be a subset of the branches above 19 | branches: [ master ] 20 | schedule: 21 | - cron: '40 22 * * 6' 22 | 23 | jobs: 24 | analyze: 25 | name: Analyze 26 | runs-on: ubuntu-latest 27 | permissions: 28 | actions: read 29 | contents: read 30 | security-events: write 31 | 32 | strategy: 33 | fail-fast: false 34 | matrix: 35 | language: [ 'python' ] 36 | # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ] 37 | # Learn more: 38 | # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed 39 | 40 | steps: 41 | - name: Checkout repository 42 | uses: actions/checkout@v2 43 | 44 | # Initializes the CodeQL tools for scanning. 45 | - name: Initialize CodeQL 46 | uses: github/codeql-action/init@v1 47 | with: 48 | languages: ${{ matrix.language }} 49 | # If you wish to specify custom queries, you can do so here or in a config file. 50 | # By default, queries listed here will override any specified in a config file. 51 | # Prefix the list here with "+" to use these queries and those in the config file. 52 | # queries: ./path/to/local/query, your-org/your-repo/queries@main 53 | 54 | # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). 55 | # If this step fails, then you should remove it and run the build manually (see below) 56 | - name: Autobuild 57 | uses: github/codeql-action/autobuild@v1 58 | 59 | # ℹ️ Command-line programs to run using the OS shell. 60 | # 📚 https://git.io/JvXDl 61 | 62 | # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines 63 | # and modify them (or add more) to build your code if your project 64 | # uses a compiled language 65 | 66 | #- run: | 67 | # make bootstrap 68 | # make release 69 | 70 | - name: Perform CodeQL Analysis 71 | uses: github/codeql-action/analyze@v1 72 | -------------------------------------------------------------------------------- /logo/source/mail-svgrepo-com.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 5 | 8 | 10 | 12 | 14 | 17 | 19 | 23 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | -------------------------------------------------------------------------------- /conf/mailToTelegramForwarder.conf: -------------------------------------------------------------------------------- 1 | [Mail] 2 | # IMAP user 3 | user: 4 | # IMAP password 5 | password: 6 | 7 | # IMAP server 8 | server: 9 | # IMAP port (default: 993) 10 | #port: 11 | # IMAP connection timout in seconds (default: 60) 12 | #timeout: 60 13 | 14 | # use timer in seconds 15 | #refresh: 10 16 | 17 | # disconnect after each loop, not recommended for short refresh rates: [True|False] 18 | #disconnect: False 19 | 20 | # IMAP folder on server to check, ex.: INBOX (default) 21 | #folder: 22 | 23 | # This is from IMAP, "ALL" is also useful. Check IMAP specs for more info. 24 | # Placeholder "${lastUID}" is used to process new mails only (since last loop) 25 | # Ex.: 26 | # UID: Mail ID on server 27 | # UNSEEN: Unseen mails, and mark them as seen 28 | # HEADER
"": Search mails by header, ex.: 29 | #search: (UID ${lastUID}:* UNSEEN HEADER Subject "") 30 | # Default: 31 | #search: (UID ${lastUID}:* UNSEEN) 32 | 33 | # Read mails received before application was started (default: False) 34 | # see command line option "-o" or "--read-old-mails" for one-time use 35 | #read_old_mails: False 36 | 37 | # max length (characters) of forwarded mail content 38 | #max_length: 2000 39 | 40 | # ignore inline image by regular expression 41 | #ignore_inline_image: (spacer\.gif) 42 | 43 | # Not yet available: 44 | # # use IMAPE IDLE (push) mode [True|False] 45 | # push_mode: False 46 | # Not yet available (see IMAP UNSEEN: If used all found mails will be marked as seen for now): 47 | # # mark forwarded message as read: [True|False] 48 | # mark_as_read: False 49 | 50 | 51 | [Telegram] 52 | # from @BotFather: Like "" 53 | bot_token: 54 | # ID of TG chat or user (, ex.: 123456) who gets forwarded messages. 55 | # ID can be found by @myidbot (Bot commands: /start + /getid) 56 | forward_to_chat_id: 57 | 58 | # markdown version: [1|2] 59 | #markdown_version: 2 60 | 61 | # prefer HTML messages: [True|False] 62 | # Prefers HTML Content over plain text part of mail and send HTML formatted messages to Telgram 63 | #prefer_html: True 64 | 65 | # forward attachments: [True|False] 66 | #forward_mail_content: True 67 | # forward attachments: [True|False] 68 | #forward_attachment: True 69 | # forward embedded images: [True|False] 70 | #forward_embedded_images: True 71 | 72 | # the maximum amount of time (in seconds) to wait for a response from Telegram’s server 73 | #connection_read_timeout = 60 74 | # the maximum amount of time (in seconds) to wait for a write operation to complete 75 | #connection_write_timeout = 60 76 | # the maximum amount of time (in seconds) to wait for a connection attempt to a Telegram server 77 | #connection_connect_timeout = 60 78 | # the maximum amount of time (in seconds) to wait for a connection to become available from the connection pool 79 | #connection_pool_timeout = 60 80 | # size of connection pool 81 | #connection_pool_size = 256 82 | -------------------------------------------------------------------------------- /.github/workflows/codecov-report.yml: -------------------------------------------------------------------------------- 1 | # This is a basic workflow to help you get started with Actions 2 | 3 | name: Codecov Report 4 | 5 | # Controls when the action will run. 6 | on: 7 | # Triggers the workflow on push or pull request events but only for the master branch 8 | push: 9 | branches: [ master ] 10 | pull_request: 11 | branches: [ master ] 12 | 13 | # Allows you to run this workflow manually from the Actions tab 14 | workflow_dispatch: 15 | 16 | # A workflow run is made up of one or more jobs that can run sequentially or in parallel 17 | jobs: 18 | # This workflow contains a single job called "build" 19 | build: 20 | # The type of runner that the job will run on 21 | runs-on: ubuntu-latest 22 | 23 | # Steps represent a sequence of tasks that will be executed as part of the job 24 | steps: 25 | # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it 26 | - uses: actions/checkout@v2 27 | 28 | # Runs a single command using the runners shell 29 | - name: Run a one-line script 30 | run: echo Hello, world! 31 | 32 | # Runs a set of commands using the runners shell 33 | - name: Run a multi-line script 34 | run: | 35 | echo Add other actions to build, 36 | echo test, and deploy your project. 37 | - name: Codecov 38 | # You may pin to the exact commit or the version. 39 | # uses: codecov/codecov-action@29386c70ef20e286228c72b668a06fd0e8399192 40 | uses: codecov/codecov-action@v1.5.2 41 | with: 42 | # Repository upload token - get it from codecov.io. Required only for private repositories 43 | token: # optional 44 | # Comma-separated list of files to upload 45 | files: # optional 46 | # Directory to search for coverage reports. 47 | directory: # optional 48 | # Flag upload to group coverage metrics (e.g. unittests | integration | ui,chrome) 49 | flags: # optional 50 | # Extra curl arguments to communicate with AWS. 51 | aws_curl_args: # optional 52 | # Extra curl arguments to communicate with Codecov. e.g., -U "--proxy http://http-proxy" 53 | codecov_curl_args: # optional 54 | # The commit SHA of the parent for which you are uploading coverage. If not present, the parent will be determined using the API of your repository provider. When using the repository providers API, the parent is determined via finding the closest ancestor to the commit. 55 | commit_parent: # optional 56 | # Environment variables to tag the upload with (e.g. PYTHON | OS,PYTHON) 57 | env_vars: # optional 58 | # Specify whether or not CI build should fail if Codecov runs into an error during upload 59 | fail_ci_if_error: # optional 60 | # Path to coverage file to upload 61 | file: # optional 62 | # Comma-separated list, see the README for options and their usage 63 | functionalities: # optional 64 | # extra arguments to pass to gcov 65 | gcov_args: # optional 66 | # gcov executable to run. Defaults to gcov 67 | gcov_executable: # optional 68 | # Paths to ignore during gcov gathering (as a glob) 69 | gcov_path_exclude: # optional 70 | # Paths to include during gcov gathering (as a glob) 71 | gcov_path_include: # optional 72 | # Prefix filepaths to help resolve path fixing 73 | gcov_prefix: # optional 74 | # Project root directory, also used when preparing gcov 75 | gcov_root_dir: # optional 76 | # Move discovered coverage reports to the trash 77 | move_coverage_to_trash: # optional 78 | # User defined upload name. Visible in Codecov UI 79 | name: # optional 80 | # Used to restrict the set of git/hg files that can be matched with filenames in the coverage report. This is useful for monorepos or other setups where a full filepath may not be specified in the coverage report, and that shortened filepath may appear multiple times in a directory structure (e.g. __init__.py) 81 | network_filter: # optional 82 | # Specify the branch name 83 | override_branch: # optional 84 | # Specify the build number 85 | override_build: # optional 86 | # Specify the commit SHA 87 | override_commit: # optional 88 | # Specify the pull request number 89 | override_pr: # optional 90 | # Specify the git tag 91 | override_tag: # optional 92 | # Write upload file to path before uploading 93 | path_to_write_report: # optional 94 | # Used when not in git/hg project to identify project root directory 95 | root_dir: # optional 96 | # Specify whether the Codecov output should be verbose 97 | verbose: # optional 98 | # Directory in which to execute codecov.sh 99 | working-directory: # optional 100 | # Custom Derived Data Path for Coverage.profdata and gcov processing 101 | xcode_derived_data: # optional 102 | # Specify packages to build coverage. Uploader will only build these packages 103 | xcode_package: # optional 104 | -------------------------------------------------------------------------------- /logo/Mail2TelegramForwarder-Bot.svg: -------------------------------------------------------------------------------- 1 | 2 | MailToTelegramForwarder - Serviceimage/svg+xmlMailToTelegramForwarder - Servicegame-icons.net (CC-BY): https://www.svgrepo.com/svg/321066/lob-arrow 28 | SVG Repo (CC0): https://www.svgrepo.com/svg/246368/mail 29 | SVG Repo (CC0): https://www.svgrepo.com/svg/193985/paper-planeAwalonAwalonhttps://github.com/awalon/MailToTelegramForwarder/logo/mail paper planeCC-BY-SA7.6.2021 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 111 | 114 | 117 | 120 | 123 | 126 | 129 | 132 | 135 | 138 | 141 | 144 | 147 | 150 | 153 | 162 | 207 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # [![Logo](logo/Mail2TelegramForwarder-Bot-small.png)](logo/CREDIT.md) MailToTelegramForwarder - Service 2 | [![Project: MailToTelegramForwarder](https://img.shields.io/badge/Project-MailToTelegramForwarder-red.svg?style=flat-square)](https://github.com/awalon/MailToTelegramForwarder/) 3 | [![GitHub issues](https://img.shields.io/github/issues/awalon/MailToTelegramForwarder?style=flat-square)](https://github.com/awalon/MailToTelegramForwarder/issues) 4 | ![Python version: 3](https://img.shields.io/badge/Version-3-informational?style=flat-square&logo=python) 5 | ![API: Telegram Bot](https://img.shields.io/badge/API-Telegram_Bot-informational?style=flat-square&logo=telegram) 6 | [![License: GPL + MIT](https://img.shields.io/badge/license-GPL+MIT-informational?style=flat-square)](README.md#license) 7 | [![GitHub forks](https://img.shields.io/github/forks/awalon/MailToTelegramForwarder?style=flat-square)](https://github.com/awalon/MailToTelegramForwarder/network) 8 | [![GitHub stars](https://img.shields.io/github/stars/awalon/MailToTelegramForwarder?style=flat-square)](https://github.com/awalon/MailToTelegramForwarder/stargazers) 9 | 10 | [![BuyMeCoffee][buymecoffeebadge]][buymecoffee] 11 | 12 | [![codecov](https://codecov.io/gh/awalon/MailToTelegramForwarder/branch/master/graph/badge.svg?style=flat-square&token=6JYTQ90U9M)](https://codecov.io/gh/awalon/MailToTelegramForwarder) 13 | 14 | ## Description 15 | 16 | MailToTelegramForwarder is a Python based daemon that will fetch mails 17 | from a remote IMAP server and forward them via Telegram API. 18 | There's no need for a dedicated mail server and piping Alias to a 19 | script; you can use any IMAP capable provider like gmail, outlook, 20 | self-hosted, etc. to use this feature. Use of a dedicated IMAP mailbox 21 | is strongly recommended. 22 | 23 | The bot only sends messages, it does not respond or listen. 24 | 25 | ## Installation 26 | 27 | Installation is very easy for Linux with Systemd and only needs to copy 28 | and edit some files. 29 | 30 | ### Prerequisites 31 | 32 | To run "mailToTelegramForwarder.py" you have to make sure Python 33 | (Version 3) and following Python libraries are installed: 34 | 35 | `$> pip install $module_name` or `$> apt install python3-$module_name` 36 | 37 | ``` 38 | - configparser 39 | - argparse 40 | - email 41 | - telegram-bot 42 | - imaplib2 43 | - beautifulsoup4 (HTML parser, used to fix broken HTML structure) 44 | ``` 45 | 46 | For Debian 13.x (Trixie) these packages have to be installed: 47 | 48 | **Hint**: python3-python-telegram-bot is available since Bullseye. 49 | ``` 50 | sudo apt install python3-python-telegram-bot python3-imaplib2 python3-bs4 51 | ``` 52 | 53 | For Arch (CachyOS) these packages have to be installed: 54 | ``` 55 | yay -Su python-telegram-bot python-imaplib2 python-beautifulsoup4 56 | ``` 57 | 58 | 59 | #### Create dedicated system user 60 | 61 | Dedicated user is recommended for security reasons, to restrict access 62 | to the minimum. 63 | 64 | ``` 65 | useradd mail2telegram 66 | ``` 67 | 68 | #### Download and place files 69 | ``` 70 | wget https://github.com/awalon/MailToTelegramForwarder/archive/master.zip 71 | unzip master.zip 72 | 73 | cd MailToTelegramForwarder-master 74 | 75 | # "chown" can be skipped, if no dedicated user was created 76 | sudo chown mail2telegram:mail2telegram mailToTelegramForwarder.py 77 | sudo chown mail2telegram:mail2telegram conf/mailToTelegramForwarder.conf 78 | 79 | # make script executable 80 | sudo chmod +x mailToTelegramForwarder.py 81 | 82 | # create application folder and link executable to default path 83 | sudo mkdir /opt/mailToTelegramForwarder 84 | sudo cp mailToTelegramForwarder.py *.md /opt/mailToTelegramForwarder/ 85 | sudo ln -sT /opt/mailToTelegramForwarder/mailToTelegramForwarder.py /usr/local/bin/mailToTelegramForwarder 86 | 87 | # create folder for configuration files 88 | sudo mkdir /etc/mail-to-telegram-forwarder 89 | sudo cp conf/mailToTelegramForwarder.conf /etc/mail-to-telegram-forwarder/ 90 | ``` 91 | 92 | You should edit `/etc/mail-to-telegram-forwarder/mailToTelegramForwarder.conf` 93 | now. 94 | ``` 95 | sudo vi /etc/mail-to-telegram-forwarder/mailToTelegramForwarder.conf 96 | ``` 97 | ### Command line options 98 | `-c`, `--config`: Configuration file. 99 | 100 | `-o`, `--read-old-mails` (optional): Read mails received before application was started. 101 | Can be used to overwrite `read_old_mails` as defined by configuration file. 102 | 103 | ### Configuration 104 | #### Mail 105 | At least `server`, `user` and `password` have to be updated for access to your 106 | Mail server with IMAP support. 107 | 108 | `user`: On many servers email/username should be in format `user@hostname.com`. 109 | 110 | `password`: 111 | If you had enabled 2-factor authentication on your mail server (or Google Account), 112 | you have to create an application password for the bot. 113 | **Hint**: This script does not support 2-factor authentication. 114 | ``` 115 | [Mail] 116 | # IMAP server 117 | server: 118 | # IMAP port (default: 993) 119 | #port: 120 | 121 | # IMAP user 122 | user: 123 | # IMAP password 124 | password: 125 | 126 | # IMAP connection timout in seconds (default: 60) 127 | #timeout: 60 128 | 129 | # use timer in seconds 130 | #refresh: 10 131 | 132 | # disconnect after each loop, not recommended for short refresh rates: [True|False] 133 | #disconnect: False 134 | ``` 135 | 136 | `folder` [**Default** 'Inbox']: Can be used to restrict forwarded mail to a 137 | predefined folder. Ex.: Mail folder, which contains preprocessed mails by 138 | server side ruleset(s). 139 | ``` 140 | # IMAP folder on server to check, ex.: INBOX (default) 141 | #folder: 142 | ``` 143 | 144 | `search` [**Default** '(UID ${lastUID}:* UNSEEN)']: IMAP search command to filter 145 | mails handled by this script. Predefined default will forward all `UNSEEN` mails 146 | since script was started. All these mails will be automatically marked as seen. 147 | 148 | Check IMAP specs for further information. Most important **search commands**: 149 | 150 | `ALL`: All mails 151 | 152 | `UID`: Mails UID on server, which can 153 | defined a range of mails UIDs on mail server. Ex.: `UID :` or `UID :*`. 154 | 155 | `UNSEEN`: Unseen mails, which will be automatically 156 | marked as seen during search. 157 | 158 | `HEADER
""`: Search mails by header fields like 159 | **Subject** or **From**. Ex.: `HEADER From "@google.com"` or 160 | `HEADER Subject "Some News"` 161 | 162 | Supported Placeholder for UID value: 163 | `${lastUID}`: Contains UID of most recent mail on startup and will be updated 164 | to UID of last forwarded mail. Is used to process new mails only (since start 165 | or last loop). 166 | 167 | ``` 168 | # Check IMAP specs for more info. 169 | #search: (UID ${lastUID}:* UNSEEN HEADER Subject "") 170 | ``` 171 | 172 | `read_old_mails` [**Default** False]: Read mails received before application was started. 173 | See command line option `-o` or `--read-old-mails` for one-time use. 174 | 175 | `max_length` [**Default** 2000]: Email content will be trimmed, if longer than this 176 | value. HTML messages will be trimmed to this number of characters after unsupported 177 | HTML Elements was removed. 178 | 179 | **HINT**: Content will be trimmed after formatting was applied. Hidden HTML or 180 | Markdown elements next to masked characters of Telegram message will be counted too. 181 | Expectation: Forwarded content will be smaller than this value. 182 | ``` 183 | # max length (characters) of forwarded mail content 184 | #max_length: 2000 185 | ``` 186 | 187 | `ignore_inline_image` Ignore embedded image(s) if regular expression matches source attribute. 188 | 189 | **Example**: Remove 1x1 pixel image used for layout based on file name using 190 | `ignore_inline_image: (spacer\.gif)`: 191 | `` 192 | 193 | ``` 194 | # ignore inline image by regular expression 195 | #ignore_inline_image: (spacer\.gif) 196 | ``` 197 | 198 | #### Telegram 199 | `bot_token`: When the bot is registered via [@botfather](https://telegram.me/botfather) 200 | it will get a unique and long token. Enter this token here (ex.: `123456789:djc28e398e223lkje`). 201 | 202 | `forward_to_chat_id`: This script posts messages only to predefined chats, which can 203 | be a group or individual chat. The easiest way to get the ID of a chat is to add the 204 | [@myidbot](https://telegram.me/myidbot) bot to the chat. After ID bot was started with 205 | `/start` own ID can be requested by `/getid` (ID > 0), if ID bot was added to a group 206 | chat `/getgroupid` (ID < 0) provides ID of group chat. 207 | 208 | Hint: Bot should be added to the chat to be able to post. 209 | ``` 210 | [Telegram] 211 | # from @BotFather: Like "" 212 | bot_token: 213 | # ID of TG chat or user (, ex.: 123456) who gets forwarded messages. 214 | forward_to_chat_id: 215 | ``` 216 | 217 | **Optional** part of Telegram related configuration: 218 | 219 | `markdown_version`[**Default** 2]: Can be used to switch between version 1 and 2 of 220 | Telegrams markdown, if `prefer_html` was set to `False` or mail has no HTML content. 221 | ``` 222 | # markdown version: [1|2] 223 | #markdown_version: 2 224 | ``` 225 | 226 | If `prefer_html` [**Default** True] was set to `True`, script prefers HTML content 227 | over plain text part and HTML formatted message will be sent to Telgram: 228 | 229 | **Hint**: Can be used to get clickable links from HTML mails in forwarded Telegram 230 | message. 231 | ``` 232 | # prefer HTML messages: [True|False] 233 | #prefer_html: True 234 | ``` 235 | 236 | If both (`forward_mail_content` and `forward_attachment`) was set to `False` only 237 | a short summary having `From`, `Subject` and names of `attached` file(s) will be 238 | forwarded: 239 | 240 | ``` 241 | # forward attachments: [True|False] 242 | #forward_mail_content: True 243 | # forward attachments: [True|False] 244 | #forward_attachment: True 245 | ``` 246 | 247 | Extract embedded image(s), send them before mail content and add placeholders at original 248 | position with captions of image: 249 | 250 | ``` 251 | # forward embedded images: [True|False] 252 | #forward_embedded_images: True 253 | ``` 254 | 255 | See [configuration template](conf/mailToTelegramForwarder.conf) 256 | `conf/mailToTelegramForwarder.conf` for further information. 257 | 258 | ### Installing as systemd service 259 | ``` 260 | sudo cp systemd/mail-to-telegram-forwarder@.service /etc/systemd/system/ 261 | sudo systemctl daemon-reload 262 | ``` 263 | 264 | ### Start systemd daemon 265 | 266 | Daemon can be started by configuration file, as multiple configurations 267 | are supported on a single server. 268 | 269 | You may enable and start the daemon, now: 270 | ``` 271 | # start service with default configuration 272 | sudo systemctl start mail-to-telegram-forwarder@mailToTelegramForwarder 273 | 274 | # check status 275 | sudo systemctl status mail-to-telegram-forwarder@mailToTelegramForwarder 276 | 277 | # enable service, to start default configuration on startup 278 | sudo systemctl enable mail-to-telegram-forwarder@mailToTelegramForwarder 279 | 280 | # check log messages 281 | sudo journalctl -u mail-to-telegram-forwarder@mailToTelegramForwarder 282 | ``` 283 | 284 | ## Update 285 | ``` 286 | # remove old package 287 | rm master.zip 288 | 289 | # get most recent code from GitHub 290 | wget https://github.com/awalon/MailToTelegramForwarder/archive/master.zip 291 | 292 | # use 'A' to replace [A]ll 293 | unzip master.zip 294 | cd MailToTelegramForwarder-master 295 | 296 | # "chown" can be skipped, if no dedicated user was created 297 | sudo chown mail2telegram:mail2telegram mailToTelegramForwarder.py 298 | sudo chown mail2telegram:mail2telegram conf/mailToTelegramForwarder.conf 299 | 300 | # make script executable 301 | sudo chmod +x mailToTelegramForwarder.py 302 | 303 | # copy script to installation folder 304 | sudo cp mailToTelegramForwarder.py *.md /opt/mailToTelegramForwarder/ 305 | 306 | # compare configruation file and manually update if needed 307 | diff -y conf/mailToTelegramForwarder.conf /etc/mail-to-telegram-forwarder/mailToTelegramForwarder.conf 308 | 309 | # restart service 310 | sudo systemctl restart mail-to-telegram-forwarder@mailToTelegramForwarder 311 | 312 | # check status 313 | sudo systemctl status mail-to-telegram-forwarder@mailToTelegramForwarder 314 | ``` 315 | 316 | ## Authors 317 | 318 | - **Florian Paul Hoberg** - *Initial work* - 319 | [@gyptazy](https://github.com/gyptazy) 320 | - **angelos-se** - *Fork* - 321 | [@angelos-se](https://github.com/angelos-se/IMAPBot) based 322 | on - *Initial work* - **Luca Weiss** [@z3ntu](https://github.com/z3ntu/IMAPBot) 323 | [*Abandoned*] 324 | - **Awalon** - *Merged and enhanced Version* - 325 | [@Awalon](https://github.com/awalon/MailToTelegramForwarder) 326 | 327 | ## License 328 | 329 | This project is licensed under the *GPLv3 License* - see the 330 | [LICENSE.md](LICENSE.md) file for details, some parts 331 | (from IMAPBot) are licensed under the *The MIT License (MIT)* - 332 | see the [LICENSE-MIT.md](LICENSE-MIT.md) file for details. 333 | --- 334 | [buymecoffee]: https://www.buymeacoffee.com/awalonde 335 | [buymecoffeebadge]: https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png 336 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | ### GNU GENERAL PUBLIC LICENSE 2 | 3 | Version 3, 29 June 2007 4 | 5 | Copyright (C) 2007 Free Software Foundation, Inc. 6 | [https://fsf.org/](https://fsf.org/) 7 | 8 | Everyone is permitted to copy and distribute verbatim copies of this 9 | license document, but changing it is not allowed. 10 | 11 | ### Preamble 12 | 13 | The GNU General Public License is a free, copyleft license for 14 | software and other kinds of works. 15 | 16 | The licenses for most software and other practical works are designed 17 | to take away your freedom to share and change the works. By contrast, 18 | the GNU General Public License is intended to guarantee your freedom 19 | to share and change all versions of a program--to make sure it remains 20 | free software for all its users. We, the Free Software Foundation, use 21 | the GNU General Public License for most of our software; it applies 22 | also to any other work released this way by its authors. You can apply 23 | it to your programs, too. 24 | 25 | When we speak of free software, we are referring to freedom, not 26 | price. Our General Public Licenses are designed to make sure that you 27 | have the freedom to distribute copies of free software (and charge for 28 | them if you wish), that you receive source code or can get it if you 29 | want it, that you can change the software or use pieces of it in new 30 | free programs, and that you know you can do these things. 31 | 32 | To protect your rights, we need to prevent others from denying you 33 | these rights or asking you to surrender the rights. Therefore, you 34 | have certain responsibilities if you distribute copies of the 35 | software, or if you modify it: responsibilities to respect the freedom 36 | of others. 37 | 38 | For example, if you distribute copies of such a program, whether 39 | gratis or for a fee, you must pass on to the recipients the same 40 | freedoms that you received. You must make sure that they, too, receive 41 | or can get the source code. And you must show them these terms so they 42 | know their rights. 43 | 44 | Developers that use the GNU GPL protect your rights with two steps: 45 | (1) assert copyright on the software, and (2) offer you this License 46 | giving you legal permission to copy, distribute and/or modify it. 47 | 48 | For the developers' and authors' protection, the GPL clearly explains 49 | that there is no warranty for this free software. For both users' and 50 | authors' sake, the GPL requires that modified versions be marked as 51 | changed, so that their problems will not be attributed erroneously to 52 | authors of previous versions. 53 | 54 | Some devices are designed to deny users access to install or run 55 | modified versions of the software inside them, although the 56 | manufacturer can do so. This is fundamentally incompatible with the 57 | aim of protecting users' freedom to change the software. The 58 | systematic pattern of such abuse occurs in the area of products for 59 | individuals to use, which is precisely where it is most unacceptable. 60 | Therefore, we have designed this version of the GPL to prohibit the 61 | practice for those products. If such problems arise substantially in 62 | other domains, we stand ready to extend this provision to those 63 | domains in future versions of the GPL, as needed to protect the 64 | freedom of users. 65 | 66 | Finally, every program is threatened constantly by software patents. 67 | States should not allow patents to restrict development and use of 68 | software on general-purpose computers, but in those that do, we wish 69 | to avoid the special danger that patents applied to a free program 70 | could make it effectively proprietary. To prevent this, the GPL 71 | assures that patents cannot be used to render the program non-free. 72 | 73 | The precise terms and conditions for copying, distribution and 74 | modification follow. 75 | 76 | ### TERMS AND CONDITIONS 77 | 78 | #### 0. Definitions. 79 | 80 | "This License" refers to version 3 of the GNU General Public License. 81 | 82 | "Copyright" also means copyright-like laws that apply to other kinds 83 | of works, such as semiconductor masks. 84 | 85 | "The Program" refers to any copyrightable work licensed under this 86 | License. Each licensee is addressed as "you". "Licensees" and 87 | "recipients" may be individuals or organizations. 88 | 89 | To "modify" a work means to copy from or adapt all or part of the work 90 | in a fashion requiring copyright permission, other than the making of 91 | an exact copy. The resulting work is called a "modified version" of 92 | the earlier work or a work "based on" the earlier work. 93 | 94 | A "covered work" means either the unmodified Program or a work based 95 | on the Program. 96 | 97 | To "propagate" a work means to do anything with it that, without 98 | permission, would make you directly or secondarily liable for 99 | infringement under applicable copyright law, except executing it on a 100 | computer or modifying a private copy. Propagation includes copying, 101 | distribution (with or without modification), making available to the 102 | public, and in some countries other activities as well. 103 | 104 | To "convey" a work means any kind of propagation that enables other 105 | parties to make or receive copies. Mere interaction with a user 106 | through a computer network, with no transfer of a copy, is not 107 | conveying. 108 | 109 | An interactive user interface displays "Appropriate Legal Notices" to 110 | the extent that it includes a convenient and prominently visible 111 | feature that (1) displays an appropriate copyright notice, and (2) 112 | tells the user that there is no warranty for the work (except to the 113 | extent that warranties are provided), that licensees may convey the 114 | work under this License, and how to view a copy of this License. If 115 | the interface presents a list of user commands or options, such as a 116 | menu, a prominent item in the list meets this criterion. 117 | 118 | #### 1. Source Code. 119 | 120 | The "source code" for a work means the preferred form of the work for 121 | making modifications to it. "Object code" means any non-source form of 122 | a work. 123 | 124 | A "Standard Interface" means an interface that either is an official 125 | standard defined by a recognized standards body, or, in the case of 126 | interfaces specified for a particular programming language, one that 127 | is widely used among developers working in that language. 128 | 129 | The "System Libraries" of an executable work include anything, other 130 | than the work as a whole, that (a) is included in the normal form of 131 | packaging a Major Component, but which is not part of that Major 132 | Component, and (b) serves only to enable use of the work with that 133 | Major Component, or to implement a Standard Interface for which an 134 | implementation is available to the public in source code form. A 135 | "Major Component", in this context, means a major essential component 136 | (kernel, window system, and so on) of the specific operating system 137 | (if any) on which the executable work runs, or a compiler used to 138 | produce the work, or an object code interpreter used to run it. 139 | 140 | The "Corresponding Source" for a work in object code form means all 141 | the source code needed to generate, install, and (for an executable 142 | work) run the object code and to modify the work, including scripts to 143 | control those activities. However, it does not include the work's 144 | System Libraries, or general-purpose tools or generally available free 145 | programs which are used unmodified in performing those activities but 146 | which are not part of the work. For example, Corresponding Source 147 | includes interface definition files associated with source files for 148 | the work, and the source code for shared libraries and dynamically 149 | linked subprograms that the work is specifically designed to require, 150 | such as by intimate data communication or control flow between those 151 | subprograms and other parts of the work. 152 | 153 | The Corresponding Source need not include anything that users can 154 | regenerate automatically from other parts of the Corresponding Source. 155 | 156 | The Corresponding Source for a work in source code form is that same 157 | work. 158 | 159 | #### 2. Basic Permissions. 160 | 161 | All rights granted under this License are granted for the term of 162 | copyright on the Program, and are irrevocable provided the stated 163 | conditions are met. This License explicitly affirms your unlimited 164 | permission to run the unmodified Program. The output from running a 165 | covered work is covered by this License only if the output, given its 166 | content, constitutes a covered work. This License acknowledges your 167 | rights of fair use or other equivalent, as provided by copyright law. 168 | 169 | You may make, run and propagate covered works that you do not convey, 170 | without conditions so long as your license otherwise remains in force. 171 | You may convey covered works to others for the sole purpose of having 172 | them make modifications exclusively for you, or provide you with 173 | facilities for running those works, provided that you comply with the 174 | terms of this License in conveying all material for which you do not 175 | control copyright. Those thus making or running the covered works for 176 | you must do so exclusively on your behalf, under your direction and 177 | control, on terms that prohibit them from making any copies of your 178 | copyrighted material outside their relationship with you. 179 | 180 | Conveying under any other circumstances is permitted solely under the 181 | conditions stated below. Sublicensing is not allowed; section 10 makes 182 | it unnecessary. 183 | 184 | #### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 185 | 186 | No covered work shall be deemed part of an effective technological 187 | measure under any applicable law fulfilling obligations under article 188 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 189 | similar laws prohibiting or restricting circumvention of such 190 | measures. 191 | 192 | When you convey a covered work, you waive any legal power to forbid 193 | circumvention of technological measures to the extent such 194 | circumvention is effected by exercising rights under this License with 195 | respect to the covered work, and you disclaim any intention to limit 196 | operation or modification of the work as a means of enforcing, against 197 | the work's users, your or third parties' legal rights to forbid 198 | circumvention of technological measures. 199 | 200 | #### 4. Conveying Verbatim Copies. 201 | 202 | You may convey verbatim copies of the Program's source code as you 203 | receive it, in any medium, provided that you conspicuously and 204 | appropriately publish on each copy an appropriate copyright notice; 205 | keep intact all notices stating that this License and any 206 | non-permissive terms added in accord with section 7 apply to the code; 207 | keep intact all notices of the absence of any warranty; and give all 208 | recipients a copy of this License along with the Program. 209 | 210 | You may charge any price or no price for each copy that you convey, 211 | and you may offer support or warranty protection for a fee. 212 | 213 | #### 5. Conveying Modified Source Versions. 214 | 215 | You may convey a work based on the Program, or the modifications to 216 | produce it from the Program, in the form of source code under the 217 | terms of section 4, provided that you also meet all of these 218 | conditions: 219 | 220 | - a) The work must carry prominent notices stating that you modified 221 | it, and giving a relevant date. 222 | - b) The work must carry prominent notices stating that it is 223 | released under this License and any conditions added under 224 | section 7. This requirement modifies the requirement in section 4 225 | to "keep intact all notices". 226 | - c) You must license the entire work, as a whole, under this 227 | License to anyone who comes into possession of a copy. This 228 | License will therefore apply, along with any applicable section 7 229 | additional terms, to the whole of the work, and all its parts, 230 | regardless of how they are packaged. This License gives no 231 | permission to license the work in any other way, but it does not 232 | invalidate such permission if you have separately received it. 233 | - d) If the work has interactive user interfaces, each must display 234 | Appropriate Legal Notices; however, if the Program has interactive 235 | interfaces that do not display Appropriate Legal Notices, your 236 | work need not make them do so. 237 | 238 | A compilation of a covered work with other separate and independent 239 | works, which are not by their nature extensions of the covered work, 240 | and which are not combined with it such as to form a larger program, 241 | in or on a volume of a storage or distribution medium, is called an 242 | "aggregate" if the compilation and its resulting copyright are not 243 | used to limit the access or legal rights of the compilation's users 244 | beyond what the individual works permit. Inclusion of a covered work 245 | in an aggregate does not cause this License to apply to the other 246 | parts of the aggregate. 247 | 248 | #### 6. Conveying Non-Source Forms. 249 | 250 | You may convey a covered work in object code form under the terms of 251 | sections 4 and 5, provided that you also convey the machine-readable 252 | Corresponding Source under the terms of this License, in one of these 253 | ways: 254 | 255 | - a) Convey the object code in, or embodied in, a physical product 256 | (including a physical distribution medium), accompanied by the 257 | Corresponding Source fixed on a durable physical medium 258 | customarily used for software interchange. 259 | - b) Convey the object code in, or embodied in, a physical product 260 | (including a physical distribution medium), accompanied by a 261 | written offer, valid for at least three years and valid for as 262 | long as you offer spare parts or customer support for that product 263 | model, to give anyone who possesses the object code either (1) a 264 | copy of the Corresponding Source for all the software in the 265 | product that is covered by this License, on a durable physical 266 | medium customarily used for software interchange, for a price no 267 | more than your reasonable cost of physically performing this 268 | conveying of source, or (2) access to copy the Corresponding 269 | Source from a network server at no charge. 270 | - c) Convey individual copies of the object code with a copy of the 271 | written offer to provide the Corresponding Source. This 272 | alternative is allowed only occasionally and noncommercially, and 273 | only if you received the object code with such an offer, in accord 274 | with subsection 6b. 275 | - d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | - e) Convey the object code using peer-to-peer transmission, 288 | provided you inform other peers where the object code and 289 | Corresponding Source of the work are being offered to the general 290 | public at no charge under subsection 6d. 291 | 292 | A separable portion of the object code, whose source code is excluded 293 | from the Corresponding Source as a System Library, need not be 294 | included in conveying the object code work. 295 | 296 | A "User Product" is either (1) a "consumer product", which means any 297 | tangible personal property which is normally used for personal, 298 | family, or household purposes, or (2) anything designed or sold for 299 | incorporation into a dwelling. In determining whether a product is a 300 | consumer product, doubtful cases shall be resolved in favor of 301 | coverage. For a particular product received by a particular user, 302 | "normally used" refers to a typical or common use of that class of 303 | product, regardless of the status of the particular user or of the way 304 | in which the particular user actually uses, or expects or is expected 305 | to use, the product. A product is a consumer product regardless of 306 | whether the product has substantial commercial, industrial or 307 | non-consumer uses, unless such uses represent the only significant 308 | mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to 312 | install and execute modified versions of a covered work in that User 313 | Product from a modified version of its Corresponding Source. The 314 | information must suffice to ensure that the continued functioning of 315 | the modified object code is in no case prevented or interfered with 316 | solely because modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or 331 | updates for a work that has been modified or installed by the 332 | recipient, or for the User Product in which it has been modified or 333 | installed. Access to a network may be denied when the modification 334 | itself materially and adversely affects the operation of the network 335 | or violates the rules and protocols for communication across the 336 | network. 337 | 338 | Corresponding Source conveyed, and Installation Information provided, 339 | in accord with this section must be in a format that is publicly 340 | documented (and with an implementation available to the public in 341 | source code form), and must require no special password or key for 342 | unpacking, reading or copying. 343 | 344 | #### 7. Additional Terms. 345 | 346 | "Additional permissions" are terms that supplement the terms of this 347 | License by making exceptions from one or more of its conditions. 348 | Additional permissions that are applicable to the entire Program shall 349 | be treated as though they were included in this License, to the extent 350 | that they are valid under applicable law. If additional permissions 351 | apply only to part of the Program, that part may be used separately 352 | under those permissions, but the entire Program remains governed by 353 | this License without regard to the additional permissions. 354 | 355 | When you convey a copy of a covered work, you may at your option 356 | remove any additional permissions from that copy, or from any part of 357 | it. (Additional permissions may be written to require their own 358 | removal in certain cases when you modify the work.) You may place 359 | additional permissions on material, added by you to a covered work, 360 | for which you have or can give appropriate copyright permission. 361 | 362 | Notwithstanding any other provision of this License, for material you 363 | add to a covered work, you may (if authorized by the copyright holders 364 | of that material) supplement the terms of this License with terms: 365 | 366 | - a) Disclaiming warranty or limiting liability differently from the 367 | terms of sections 15 and 16 of this License; or 368 | - b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | - c) Prohibiting misrepresentation of the origin of that material, 372 | or requiring that modified versions of such material be marked in 373 | reasonable ways as different from the original version; or 374 | - d) Limiting the use for publicity purposes of names of licensors 375 | or authors of the material; or 376 | - e) Declining to grant rights under trademark law for use of some 377 | trade names, trademarks, or service marks; or 378 | - f) Requiring indemnification of licensors and authors of that 379 | material by anyone who conveys the material (or modified versions 380 | of it) with contractual assumptions of liability to the recipient, 381 | for any liability that these contractual assumptions directly 382 | impose on those licensors and authors. 383 | 384 | All other non-permissive additional terms are considered "further 385 | restrictions" within the meaning of section 10. If the Program as you 386 | received it, or any part of it, contains a notice stating that it is 387 | governed by this License along with a term that is a further 388 | restriction, you may remove that term. If a license document contains 389 | a further restriction but permits relicensing or conveying under this 390 | License, you may add to a covered work material governed by the terms 391 | of that license document, provided that the further restriction does 392 | not survive such relicensing or conveying. 393 | 394 | If you add terms to a covered work in accord with this section, you 395 | must place, in the relevant source files, a statement of the 396 | additional terms that apply to those files, or a notice indicating 397 | where to find the applicable terms. 398 | 399 | Additional terms, permissive or non-permissive, may be stated in the 400 | form of a separately written license, or stated as exceptions; the 401 | above requirements apply either way. 402 | 403 | #### 8. Termination. 404 | 405 | You may not propagate or modify a covered work except as expressly 406 | provided under this License. Any attempt otherwise to propagate or 407 | modify it is void, and will automatically terminate your rights under 408 | this License (including any patent licenses granted under the third 409 | paragraph of section 11). 410 | 411 | However, if you cease all violation of this License, then your license 412 | from a particular copyright holder is reinstated (a) provisionally, 413 | unless and until the copyright holder explicitly and finally 414 | terminates your license, and (b) permanently, if the copyright holder 415 | fails to notify you of the violation by some reasonable means prior to 416 | 60 days after the cessation. 417 | 418 | Moreover, your license from a particular copyright holder is 419 | reinstated permanently if the copyright holder notifies you of the 420 | violation by some reasonable means, this is the first time you have 421 | received notice of violation of this License (for any work) from that 422 | copyright holder, and you cure the violation prior to 30 days after 423 | your receipt of the notice. 424 | 425 | Termination of your rights under this section does not terminate the 426 | licenses of parties who have received copies or rights from you under 427 | this License. If your rights have been terminated and not permanently 428 | reinstated, you do not qualify to receive new licenses for the same 429 | material under section 10. 430 | 431 | #### 9. Acceptance Not Required for Having Copies. 432 | 433 | You are not required to accept this License in order to receive or run 434 | a copy of the Program. Ancillary propagation of a covered work 435 | occurring solely as a consequence of using peer-to-peer transmission 436 | to receive a copy likewise does not require acceptance. However, 437 | nothing other than this License grants you permission to propagate or 438 | modify any covered work. These actions infringe copyright if you do 439 | not accept this License. Therefore, by modifying or propagating a 440 | covered work, you indicate your acceptance of this License to do so. 441 | 442 | #### 10. Automatic Licensing of Downstream Recipients. 443 | 444 | Each time you convey a covered work, the recipient automatically 445 | receives a license from the original licensors, to run, modify and 446 | propagate that work, subject to this License. You are not responsible 447 | for enforcing compliance by third parties with this License. 448 | 449 | An "entity transaction" is a transaction transferring control of an 450 | organization, or substantially all assets of one, or subdividing an 451 | organization, or merging organizations. If propagation of a covered 452 | work results from an entity transaction, each party to that 453 | transaction who receives a copy of the work also receives whatever 454 | licenses to the work the party's predecessor in interest had or could 455 | give under the previous paragraph, plus a right to possession of the 456 | Corresponding Source of the work from the predecessor in interest, if 457 | the predecessor has it or can get it with reasonable efforts. 458 | 459 | You may not impose any further restrictions on the exercise of the 460 | rights granted or affirmed under this License. For example, you may 461 | not impose a license fee, royalty, or other charge for exercise of 462 | rights granted under this License, and you may not initiate litigation 463 | (including a cross-claim or counterclaim in a lawsuit) alleging that 464 | any patent claim is infringed by making, using, selling, offering for 465 | sale, or importing the Program or any portion of it. 466 | 467 | #### 11. Patents. 468 | 469 | A "contributor" is a copyright holder who authorizes use under this 470 | License of the Program or a work on which the Program is based. The 471 | work thus licensed is called the contributor's "contributor version". 472 | 473 | A contributor's "essential patent claims" are all patent claims owned 474 | or controlled by the contributor, whether already acquired or 475 | hereafter acquired, that would be infringed by some manner, permitted 476 | by this License, of making, using, or selling its contributor version, 477 | but do not include claims that would be infringed only as a 478 | consequence of further modification of the contributor version. For 479 | purposes of this definition, "control" includes the right to grant 480 | patent sublicenses in a manner consistent with the requirements of 481 | this License. 482 | 483 | Each contributor grants you a non-exclusive, worldwide, royalty-free 484 | patent license under the contributor's essential patent claims, to 485 | make, use, sell, offer for sale, import and otherwise run, modify and 486 | propagate the contents of its contributor version. 487 | 488 | In the following three paragraphs, a "patent license" is any express 489 | agreement or commitment, however denominated, not to enforce a patent 490 | (such as an express permission to practice a patent or covenant not to 491 | sue for patent infringement). To "grant" such a patent license to a 492 | party means to make such an agreement or commitment not to enforce a 493 | patent against the party. 494 | 495 | If you convey a covered work, knowingly relying on a patent license, 496 | and the Corresponding Source of the work is not available for anyone 497 | to copy, free of charge and under the terms of this License, through a 498 | publicly available network server or other readily accessible means, 499 | then you must either (1) cause the Corresponding Source to be so 500 | available, or (2) arrange to deprive yourself of the benefit of the 501 | patent license for this particular work, or (3) arrange, in a manner 502 | consistent with the requirements of this License, to extend the patent 503 | license to downstream recipients. "Knowingly relying" means you have 504 | actual knowledge that, but for the patent license, your conveying the 505 | covered work in a country, or your recipient's use of the covered work 506 | in a country, would infringe one or more identifiable patents in that 507 | country that you have reason to believe are valid. 508 | 509 | If, pursuant to or in connection with a single transaction or 510 | arrangement, you convey, or propagate by procuring conveyance of, a 511 | covered work, and grant a patent license to some of the parties 512 | receiving the covered work authorizing them to use, propagate, modify 513 | or convey a specific copy of the covered work, then the patent license 514 | you grant is automatically extended to all recipients of the covered 515 | work and works based on it. 516 | 517 | A patent license is "discriminatory" if it does not include within the 518 | scope of its coverage, prohibits the exercise of, or is conditioned on 519 | the non-exercise of one or more of the rights that are specifically 520 | granted under this License. You may not convey a covered work if you 521 | are a party to an arrangement with a third party that is in the 522 | business of distributing software, under which you make payment to the 523 | third party based on the extent of your activity of conveying the 524 | work, and under which the third party grants, to any of the parties 525 | who would receive the covered work from you, a discriminatory patent 526 | license (a) in connection with copies of the covered work conveyed by 527 | you (or copies made from those copies), or (b) primarily for and in 528 | connection with specific products or compilations that contain the 529 | covered work, unless you entered into that arrangement, or that patent 530 | license was granted, prior to 28 March 2007. 531 | 532 | Nothing in this License shall be construed as excluding or limiting 533 | any implied license or other defenses to infringement that may 534 | otherwise be available to you under applicable patent law. 535 | 536 | #### 12. No Surrender of Others' Freedom. 537 | 538 | If conditions are imposed on you (whether by court order, agreement or 539 | otherwise) that contradict the conditions of this License, they do not 540 | excuse you from the conditions of this License. If you cannot convey a 541 | covered work so as to satisfy simultaneously your obligations under 542 | this License and any other pertinent obligations, then as a 543 | consequence you may not convey it at all. For example, if you agree to 544 | terms that obligate you to collect a royalty for further conveying 545 | from those to whom you convey the Program, the only way you could 546 | satisfy both those terms and this License would be to refrain entirely 547 | from conveying the Program. 548 | 549 | #### 13. Use with the GNU Affero General Public License. 550 | 551 | Notwithstanding any other provision of this License, you have 552 | permission to link or combine any covered work with a work licensed 553 | under version 3 of the GNU Affero General Public License into a single 554 | combined work, and to convey the resulting work. The terms of this 555 | License will continue to apply to the part which is the covered work, 556 | but the special requirements of the GNU Affero General Public License, 557 | section 13, concerning interaction through a network will apply to the 558 | combination as such. 559 | 560 | #### 14. Revised Versions of this License. 561 | 562 | The Free Software Foundation may publish revised and/or new versions 563 | of the GNU General Public License from time to time. Such new versions 564 | will be similar in spirit to the present version, but may differ in 565 | detail to address new problems or concerns. 566 | 567 | Each version is given a distinguishing version number. If the Program 568 | specifies that a certain numbered version of the GNU General Public 569 | License "or any later version" applies to it, you have the option of 570 | following the terms and conditions either of that numbered version or 571 | of any later version published by the Free Software Foundation. If the 572 | Program does not specify a version number of the GNU General Public 573 | License, you may choose any version ever published by the Free 574 | Software Foundation. 575 | 576 | If the Program specifies that a proxy can decide which future versions 577 | of the GNU General Public License can be used, that proxy's public 578 | statement of acceptance of a version permanently authorizes you to 579 | choose that version for the Program. 580 | 581 | Later license versions may give you additional or different 582 | permissions. However, no additional obligations are imposed on any 583 | author or copyright holder as a result of your choosing to follow a 584 | later version. 585 | 586 | #### 15. Disclaimer of Warranty. 587 | 588 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 589 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 590 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT 591 | WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT 592 | LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 593 | A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND 594 | PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE 595 | DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR 596 | CORRECTION. 597 | 598 | #### 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR 602 | CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 603 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES 604 | ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT 605 | NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR 606 | LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM 607 | TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER 608 | PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 609 | 610 | #### 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | ### How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these 626 | terms. 627 | 628 | To do so, attach the following notices to the program. It is safest to 629 | attach them to the start of each source file to most effectively state 630 | the exclusion of warranty; and each file should have at least the 631 | "copyright" line and a pointer to where the full notice is found. 632 | 633 | 634 | Copyright (C) 635 | 636 | This program is free software: you can redistribute it and/or modify 637 | it under the terms of the GNU General Public License as published by 638 | the Free Software Foundation, either version 3 of the License, or 639 | (at your option) any later version. 640 | 641 | This program is distributed in the hope that it will be useful, 642 | but WITHOUT ANY WARRANTY; without even the implied warranty of 643 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 644 | GNU General Public License for more details. 645 | 646 | You should have received a copy of the GNU General Public License 647 | along with this program. If not, see . 648 | 649 | Also add information on how to contact you by electronic and paper 650 | mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands \`show w' and \`show c' should show the 661 | appropriate parts of the General Public License. Of course, your 662 | program's commands might be different; for a GUI interface, you would 663 | use an "about box". 664 | 665 | You should also get your employer (if you work as a programmer) or 666 | school, if any, to sign a "copyright disclaimer" for the program, if 667 | necessary. For more information on this, and how to apply and follow 668 | the GNU GPL, see . 669 | 670 | The GNU General Public License does not permit incorporating your 671 | program into proprietary programs. If your program is a subroutine 672 | library, you may consider it more useful to permit linking proprietary 673 | applications with the library. If this is what you want to do, use the 674 | GNU Lesser General Public License instead of this License. But first, 675 | please read . -------------------------------------------------------------------------------- /mailToTelegramForwarder.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | """ 3 | Fetch mails from IMAP-Server and forward them to Telegram Chat. 4 | Copyright (C) 2021 Awalon (https://github.com/awalon) 5 | 6 | This program is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU General Public License as published by 8 | the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | This program is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU General Public License for more details. 15 | 16 | You should have received a copy of the GNU General Public License 17 | along with this program. If not, see . 18 | 19 | --- 20 | 21 | Debian: 22 | sudo apt install python3-python-telegram-bot python3-imaplib2 python3-bs4 23 | Arch: 24 | yay -Su python-telegram-bot python-imaplib2 python-beautifulsoup4 25 | 26 | """ 27 | 28 | try: 29 | # noinspection except,PyUnusedImports 30 | from bs4 import BeautifulSoup 31 | # noinspection except,PyUnusedImports 32 | import asyncio 33 | # noinspection except,PyUnusedImports 34 | import contextlib 35 | # noinspection except,PyUnusedImports 36 | import logging 37 | # noinspection except,PyUnusedImports 38 | import warnings 39 | # noinspection except,PyUnusedImports 40 | import typing 41 | # noinspection except,PyUnusedImports 42 | import sys 43 | # noinspection except,PyUnusedImports 44 | import re 45 | # noinspection except,PyUnusedImports 46 | import unicodedata 47 | # noinspection except,PyUnusedImports 48 | import argparse 49 | # noinspection except,PyUnusedImports 50 | import html 51 | # noinspection except,PyUnusedImports 52 | import socket 53 | # noinspection except,PyUnusedImports 54 | import time 55 | # noinspection except,PyUnusedImports 56 | import configparser 57 | # noinspection except,PyUnusedImports 58 | import imaplib2 59 | # noinspection except,PyUnusedImports 60 | import email 61 | # noinspection except,PyUnusedImports 62 | from email.header import Header, decode_header, make_header 63 | # noinspection except,PyUnusedImports 64 | from enum import Enum 65 | # noinspection except,PyUnusedImports 66 | #from typing import List, Optional, TypedDict 67 | # noinspection except,PyUnusedImports 68 | from re import Match 69 | except ImportError as import_error: 70 | logging.critical(import_error.__class__.__name__ + ": " + import_error.args[0]) 71 | sys.exit(2) 72 | 73 | """ 74 | Mail2TelegramForwarder: 75 | A python script that fetches mails from remote IMAP mail server 76 | and forward body and/or attachments to Telegram chat/user. 77 | 78 | Based on great work done by: 79 | https://github.com/florianpaulhoberg/IMAP2Telegram 80 | https://github.com/angelos-se/IMAPBot 81 | """ 82 | 83 | __appname__ = "Mail to Telegram Forwarder" 84 | __version__ = "0.3" 85 | __author__ = "Awalon (https://github.com/awalon)" 86 | 87 | with warnings.catch_warnings(record=True) as w: 88 | # Cause all warnings to always be triggered. 89 | warnings.simplefilter("always") 90 | 91 | try: 92 | from utils import helpers 93 | except ImportError as import_error: 94 | from telegram import helpers, Bot 95 | from telegram import error, Message, PhotoSize, Bot, ChatFullInfo 96 | from telegram.request import HTTPXRequest 97 | from telegram.constants import ParseMode 98 | 99 | # Ignore not supported warnings 100 | if len(w) > 0: 101 | if 'This is allowed but not supported by python-telegram-bot maintainers' in str(w[-1].message): 102 | w.remove(w[-1]) 103 | 104 | 105 | class Tool: 106 | mask_error_data: list[str] = [] 107 | 108 | def decode_mail_data(self, value) -> str: 109 | result = '' 110 | for msg_part in email.header.decode_header(value): 111 | part, encoding = msg_part 112 | result += self.binary_to_string(part, encoding=encoding) 113 | return result 114 | 115 | @staticmethod 116 | def binary_to_string(value, **kwargs) -> str: 117 | encoding = kwargs.get('encoding') 118 | if not encoding: 119 | encoding = 'utf-8' 120 | if type(value) is bytes: 121 | try: 122 | return str(bytes.decode(value, encoding=encoding, errors='replace')) 123 | except UnicodeDecodeError as decode_error: 124 | logging.error("Can not decode value: '%s' reason: %s" % (value, decode_error.reason)) 125 | return ' ###decoder-error:%s### ' % decode_error.reason 126 | else: 127 | return str(value) 128 | 129 | def _convert_error_message(self, message) -> str: 130 | error_message: str = message 131 | if type(message) is bytes: 132 | error_message = self.binary_to_string(message) 133 | if type(message) is not str: 134 | error_message = '%s' % message # ', '.join(map(str, message.args)) 135 | try: 136 | _, _, tb = sys.exc_info() 137 | if tb is not None: 138 | frame = tb.tb_frame 139 | line_no = tb.tb_lineno 140 | obj_name = frame.f_code.co_name 141 | file_name = frame.f_code.co_filename 142 | trace_msg = " [%s:%s in '%s']" % (file_name, line_no, obj_name) 143 | error_message = '%s%s' % (error_message, trace_msg) 144 | except Exception as ex: 145 | logging.error('Fatal in "build_error_message": %s' % str(ex)) 146 | logging.error('--- initial error: "%s"' % message) 147 | return error_message 148 | 149 | def build_error_message(self, message) -> str: 150 | error_message: str 151 | if type(message) is list: 152 | lines: list[str] = [] 153 | for item in message: 154 | lines.append(self._convert_error_message(item)) 155 | error_message = "; ".join(lines) 156 | else: 157 | error_message = self._convert_error_message(message) 158 | for mask in self.mask_error_data: 159 | error_message = error_message.replace(mask, '****') 160 | return error_message 161 | 162 | 163 | class Config: 164 | config_parser = None 165 | tool: Tool 166 | 167 | imap_user = None 168 | imap_password = None 169 | imap_server = None 170 | imap_port = 993 171 | imap_timeout = 60 172 | imap_refresh = 10 173 | imap_push_mode = False 174 | imap_disconnect = False 175 | imap_folder = 'INBOX' 176 | imap_search = '(UID ${lastUID}:* UNSEEN)' 177 | imap_mark_as_read = False 178 | imap_max_length = 2000 179 | imap_read_old_mails = False 180 | imap_read_old_mails_processed = False 181 | imap_ignore_inline_image = '' 182 | 183 | tg_bot_token = None 184 | tg_forward_to_chat_id = None 185 | tg_prefer_html = True 186 | tg_markdown_version = 2 187 | tg_forward_mail_content = True 188 | tg_forward_attachment = True 189 | tg_forward_embedded_images = True 190 | tg_connection_read_timeout = 60 191 | tg_connection_write_timeout = 60 192 | tg_connection_connect_timeout = 60 193 | tg_connection_pool_timeout = 60 194 | tg_connection_pool_size = 256 195 | 196 | def __init__(self, tool, cmd_args): 197 | """ 198 | Parse config file for login credentials, address of remote mail server, 199 | telegram config and configuration of this application. 200 | """ 201 | try: 202 | self.tool = tool 203 | self.config_parser = configparser.ConfigParser() 204 | files = self.config_parser.read(cmd_args.config) 205 | if len(files) == 0: 206 | logging.critical("Error parsing config file: File '%s' not found!" % cmd_args.config) 207 | sys.exit(2) 208 | 209 | self.imap_user = self.get_config('Mail', 'user', self.imap_user) 210 | self.imap_password = self.get_config('Mail', 'password', self.imap_password) 211 | tool.mask_error_data.append(self.imap_password) 212 | self.imap_server = self.get_config('Mail', 'server', self.imap_server) 213 | self.imap_port = self.get_config('Mail', 'port', self.imap_port, int) 214 | self.imap_timeout = self.get_config('Mail', 'timeout', self.imap_timeout, int) 215 | self.imap_refresh = self.get_config('Mail', 'refresh', self.imap_refresh, int) 216 | self.imap_push_mode = self.get_config('Mail', 'push_mode', self.imap_push_mode, bool) 217 | self.imap_disconnect = self.get_config('Mail', 'disconnect', self.imap_disconnect, bool) 218 | self.imap_folder = self.get_config('Mail', 'folder', self.imap_folder) 219 | self.imap_read_old_mails = self.get_config('Mail', 'read_old_mails', self.imap_read_old_mails) 220 | self.imap_search = self.get_config('Mail', 'search', self.imap_search) 221 | self.imap_mark_as_read = self.get_config('Mail', 'mark_as_read', self.imap_mark_as_read, bool) 222 | self.imap_max_length = self.get_config('Mail', 'max_length', self.imap_max_length, int) 223 | self.imap_ignore_inline_image = self.get_config('Mail', 'ignore_inline_image', 224 | self.imap_ignore_inline_image) 225 | 226 | self.tg_bot_token = self.get_config('Telegram', 'bot_token', self.tg_bot_token) 227 | tool.mask_error_data.append(self.tg_bot_token) 228 | self.tg_forward_to_chat_id = self.get_config('Telegram', 'forward_to_chat_id', 229 | self.tg_forward_to_chat_id, int) 230 | self.tg_forward_mail_content = self.get_config('Telegram', 'forward_mail_content', 231 | self.tg_forward_mail_content, bool) 232 | self.tg_prefer_html = self.get_config('Telegram', 'prefer_html', self.tg_prefer_html, bool) 233 | self.tg_markdown_version = self.get_config('Telegram', 'markdown_version', self.tg_markdown_version, int) 234 | self.tg_forward_attachment = self.get_config('Telegram', 'forward_attachment', 235 | self.tg_forward_attachment, bool) 236 | self.tg_forward_embedded_images = self.get_config('Telegram', 'forward_embedded_images', 237 | self.tg_forward_embedded_images, bool) 238 | 239 | self.tg_connection_read_timeout = self.get_config('Telegram', 'connection_read_timeout', 240 | self.tg_connection_read_timeout, int) 241 | self.tg_connection_write_timeout = self.get_config('Telegram', 'connection_write_timeout', 242 | self.tg_connection_write_timeout, int) 243 | self.tg_connection_connect_timeout = self.get_config('Telegram', 'connection_connect_timeout', 244 | self.tg_connection_connect_timeout, int) 245 | self.tg_connection_pool_timeout = self.get_config('Telegram', 'connection_pool_timeout', 246 | self.tg_connection_pool_timeout, int) 247 | self.tg_connection_pool_size = self.get_config('Telegram', 'connection_pool_size', 248 | self.tg_connection_pool_size, int) 249 | 250 | if cmd_args.read_old_mails: 251 | self.imap_read_old_mails = True 252 | 253 | except configparser.ParsingError as parse_error: 254 | logging.critical( 255 | "Error parsing config file: Impossible to parse file %s. Message: %s" 256 | % (parse_error.source, parse_error.message) 257 | ) 258 | sys.exit(2) 259 | except configparser.Error as config_error: 260 | logging.critical("Error parsing config file: %s." % config_error.message) 261 | sys.exit(2) 262 | 263 | def get_config(self, section, key, default=None, value_type=None): 264 | value = default 265 | try: 266 | if self.config_parser.has_section(section): 267 | if self.config_parser.has_option(section, key): 268 | # get value based on type of default value 269 | if value_type is int: 270 | value = self.config_parser.getint(section, key) 271 | elif value_type is float: 272 | value = self.config_parser.getfloat(section, key) 273 | elif value_type is bool: 274 | value = self.config_parser.getboolean(section, key) 275 | else: 276 | # use string as default 277 | value = self.config_parser.get(section, key) 278 | else: 279 | # raise exception as both sections are mandatory sections (Mail + Telegram) 280 | logging.warning("Get config value error for '%s'.'%s' (default: '%s'): Missing section '%s'." 281 | % (section, key, default, section)) 282 | raise configparser.NoSectionError(section) 283 | 284 | except configparser.Error as config_error: 285 | logging.critical("Error parsing config file: %s." % config_error.message) 286 | raise config_error 287 | except Exception as get_val_error: 288 | logging.critical( 289 | "Get config value error for '%s'.'%s' (default: '%s'): %s." 290 | % (section, key, default, get_val_error) 291 | ) 292 | raise get_val_error 293 | 294 | return value 295 | 296 | 297 | class MailAttachmentType(Enum): 298 | BINARY = 1 299 | IMAGE = 2 300 | 301 | 302 | class MailAttachment: 303 | idx: int = 0 304 | id: str = '' 305 | name: str = '' 306 | alt: str = '' 307 | type: MailAttachmentType = MailAttachmentType.BINARY 308 | file: str | None = None 309 | tg_id: str | None = None 310 | 311 | def __init__(self, attachment_type: MailAttachmentType = MailAttachmentType.BINARY): 312 | super().__init__() 313 | self.type = attachment_type 314 | 315 | def set_name(self, file_name: str): 316 | name: str = '' 317 | for file_name_part in email.header.decode_header(file_name): 318 | part, encoding = file_name_part 319 | tool: Tool = Tool() 320 | name += tool.binary_to_string(part, encoding=encoding) 321 | self.name = name 322 | 323 | def set_id(self, attachment_id: str): 324 | self.id = re.sub(r'[<>]', '', attachment_id) 325 | 326 | def get_title(self): 327 | if self.alt: 328 | return self.alt 329 | elif self.name: 330 | return self.name 331 | else: 332 | return self.file 333 | 334 | 335 | class MailDataType(Enum): 336 | TEXT = 1 337 | HTML = 2 338 | 339 | 340 | class MailImage(dict): 341 | key: str 342 | image: MailAttachment 343 | 344 | 345 | class MailBody: 346 | text: str = '' 347 | html: str = '' 348 | images: list[MailImage] = [] 349 | attachments: list[MailAttachment] = [] 350 | 351 | 352 | class MailData: 353 | uid: str = '' 354 | #raw: str = '' # 355 | raw: None # type :email.message.Message[str,str] | None 356 | type: MailDataType = MailDataType.TEXT 357 | summary: str = '' 358 | mail_from: str = '' 359 | mail_subject: str = '' 360 | mail_body: str = '' 361 | mail_images: list[MailImage] = [] 362 | attachment_summary: str = '' 363 | attachments: list[MailAttachment] = [] 364 | 365 | 366 | class TelegramBot: 367 | config: Config 368 | request: HTTPXRequest 369 | bot: Bot 370 | error_send_message: str = "Failed to send Telegram message: %s" 371 | 372 | def __init__(self, config: Config): 373 | self.config = config 374 | try: 375 | # Initialize the Bot with HTTPXRequest with increased connection pool size and proper timeouts 376 | self.request = HTTPXRequest( 377 | connection_pool_size=config.tg_connection_pool_size, 378 | pool_timeout=config.tg_connection_pool_timeout, 379 | connect_timeout=config.tg_connection_connect_timeout, 380 | read_timeout=config.tg_connection_read_timeout, 381 | write_timeout=config.tg_connection_read_timeout 382 | ) 383 | self.bot = Bot(token=self.config.tg_bot_token, request=self.request) 384 | except error.TelegramError as tg_error: 385 | logging.critical(self.error_send_message % tg_error.message) 386 | 387 | def cleanup_html(self, message: str, images: list[MailImage] | None = None) -> str: 388 | """ 389 | Parse HTML message and remove HTML elements not supported by Telegram 390 | """ 391 | # supported tags 392 | # https://core.telegram.org/bots/api#sendmessage 393 | # bold, bold 394 | # italic, italic 395 | # underline, underline 396 | # strikethrough, strikethrough, strikethrough 397 | # bold italic bold italic bold strikethrough underline italic bold bold 398 | # inline URL 399 | # inline mention of a user 400 | # inline fixed-width code 401 | # 
pre-formatted fixed-width code block
402 | # 
pre-formatted fixed-width code block
 403 |         #      written in the Python programming language
404 | # span elements only supported as spoiler elements 405 | # tg_msg = re.sub(r'<\s*span\b', ']*>(?P.*).*$', r'\g', tg_body, 416 | flags=(re.DOTALL | re.MULTILINE | re.IGNORECASE)) 417 | 418 | # remove control chars 419 | tg_body = "".join(ch for ch in tg_body if "C" != unicodedata.category(ch)[0]) 420 | 421 | # remove all HTML comments 422 | tg_body = re.sub(r'', '', tg_body, flags=(re.DOTALL | re.MULTILINE)) 423 | 424 | # handle inline images 425 | image_seen: dict[str] = {} 426 | for match in re.finditer( 427 | r'(?P<\s*img\s+[^>]*?\s*src\s*=\s*"' 428 | r'(?P(?P(cid|https?)):/*(?P[^"]*))"[^>]*?/?\s*>)', 429 | tg_body, 430 | flags=(re.DOTALL | re.MULTILINE | re.IGNORECASE)): 431 | img: str = match.group('img') 432 | proto: str = match.group('proto') 433 | 434 | # extract alt or title value 435 | alt: str = re.sub(r'^.*?((title|alt)\s*=\s*"(?P[^"]+)")?.*$', r'\g', 436 | img, flags=(re.DOTALL | re.MULTILINE | re.IGNORECASE)) 437 | 438 | if 'http' in proto: 439 | # web link 440 | src = match.group('src') 441 | if self.config.imap_ignore_inline_image \ 442 | and re.search(self.config.imap_ignore_inline_image, src, re.IGNORECASE): 443 | continue 444 | tg_body = tg_body.replace(img, "${img-link:%s|%s}" % (src, alt)) 445 | else: 446 | # attached/embedded image 447 | cid = match.group('cid') 448 | if cid == '' or cid in image_seen: 449 | continue 450 | image_seen[cid] = True 451 | 452 | if cid in images: 453 | # add image reference 454 | tg_body = tg_body.replace(img, '${file:%s}' % cid) 455 | # extract alt/title attributes of img elements 456 | for image in images: 457 | if image.key == cid: 458 | images.alt = alt 459 | break 460 | else: 461 | # no file found, use alt text 462 | tg_body = tg_body.replace(img, alt) 463 | 464 | # use alt text for all images without cid (embedded image) 465 | tg_body = re.sub(r'<\s*img\s+[^>]*?((title|alt)\s*=\s*"(?P[^"]+)")?[^>]*?/?\s*>', r'\g', 466 | tg_body, flags=(re.DOTALL | re.MULTILINE | re.IGNORECASE)) 467 | 468 | # remove multiple line breaks and spaces (regular Browser logic) 469 | tg_body = re.sub(r'\s\s+', ' ', tg_body).strip() 470 | 471 | # remove attributes from elements but href of "a"- elements 472 | tg_msg = re.sub(r'<\s*?(?P\w+)\b\s*?[^>]*?(?P\s+href\s*=\s*"[^"]+")?[^>]*?>', 473 | r'<\g\g>', tg_body, flags=(re.DOTALL | re.MULTILINE | re.IGNORECASE)) 474 | 475 | # remove style and script elements/blocks 476 | tg_msg = re.sub(r'<\s*(?Pscript|style)\s*>.*?', 477 | '', tg_msg, flags=(re.DOTALL | re.MULTILINE | re.IGNORECASE)) 478 | 479 | # translate paragraphs and line breaks (block elements) 480 | tg_msg = re.sub(r'(p|div|table|h\d+))\s*>', '\n', tg_msg, 481 | flags=(re.MULTILINE | re.IGNORECASE)) 482 | tg_msg = re.sub(r'(tr))\s*>', '\n', tg_msg, flags=(re.MULTILINE | re.IGNORECASE)) 483 | tg_msg = re.sub(r']*>', '\n', tg_msg, flags=(re.MULTILINE | re.IGNORECASE)) 484 | 485 | # prepare list items (migrate list items to "- ") 486 | tg_msg = re.sub(r'(<\s*[ou]l\s*>[^<]*)?<\s*li\s*>', '\n- ', tg_msg, flags=(re.MULTILINE | re.IGNORECASE)) 487 | tg_msg = re.sub(r'([^<]*)?', '\n', tg_msg, flags=(re.MULTILINE | re.IGNORECASE)) 488 | 489 | # remove unsupported tags 490 | # https://core.telegram.org/api/entities 491 | regex_filter_elem = re.compile( 492 | r'<\s*(?!/?\s*(?Pbold|strong|i|em|u|ins|s|strike|del|b|a|code|pre)\b)[^>]*>', 493 | flags=(re.MULTILINE | re.IGNORECASE)) 494 | tg_msg = re.sub(regex_filter_elem, ' ', tg_msg) 495 | 496 | # remove empty links 497 | tg_msg = re.sub(r'<\s*a\s*>(?P[^<]*)', r'\g ', tg_msg, 498 | flags=(re.DOTALL | re.MULTILINE | re.IGNORECASE)) 499 | 500 | # remove links without text (tracking stuff, and none clickable) 501 | tg_msg = re.sub(r'<\s*a\s*[^>]*>\s*', ' ', tg_msg, 502 | flags=(re.DOTALL | re.MULTILINE | re.IGNORECASE)) 503 | 504 | # remove empty elements 505 | tg_msg = re.sub(r'<\s*\w\s*>\s*', ' ', tg_msg, flags=(re.DOTALL | re.MULTILINE)) 506 | 507 | # remove multiple line breaks 508 | tg_msg = re.sub(r'\s*[\r\n](\s*[\r\n])+', "\n", tg_msg) 509 | 510 | # preserve NBSPs 511 | tg_msg = re.sub(r' ', ' ', tg_msg, flags=re.IGNORECASE) 512 | 513 | except Exception as ex: 514 | logging.critical(ex) 515 | 516 | return tg_msg 517 | 518 | async def send_message(self, mails: list[MailData]): 519 | """ 520 | Send mail data over Telegram API to chat/user. 521 | """ 522 | try: 523 | # Initialize the Bot with HTTPXRequest with increased connection pool size and proper timeouts 524 | async with Bot(token=self.config.tg_bot_token, request=self.request) as bot: 525 | logging.debug("Bot initialized, connecting to Chat '{0}'...".format(self.config.tg_forward_to_chat_id)) 526 | 527 | tg_chat: ChatFullInfo = await bot.get_chat(self.config.tg_forward_to_chat_id) 528 | 529 | # get chat title 530 | tg_chat_title = tg_chat.full_name 531 | if not tg_chat_title: 532 | tg_chat_title = tg_chat.title 533 | if not tg_chat_title: 534 | tg_chat_title = tg_chat.id 535 | 536 | for mail in mails: 537 | try: 538 | if self.config.tg_markdown_version == 2: 539 | parser = ParseMode.MARKDOWN_V2 540 | else: 541 | parser = ParseMode.MARKDOWN 542 | if mail.type == MailDataType.HTML: 543 | parser = ParseMode.HTML 544 | 545 | if self.config.tg_forward_mail_content or not self.config.tg_forward_attachment: 546 | # send mail content (summary) 547 | message = mail.summary 548 | 549 | # upload images 550 | image_no = 1 551 | for mail_image in mail.mail_images: 552 | # image = mail.mail_images.[image_id] 553 | image = mail_image['image'] 554 | title = '%s' % image.get_title() 555 | 556 | if self.config.tg_forward_embedded_images: 557 | title = '%i. %s: %s' % (image_no, mail.mail_subject, image.get_title()) 558 | doc_message: Message = await self.bot.send_photo( 559 | chat_id=self.config.tg_forward_to_chat_id, 560 | parse_mode=parser, 561 | caption=title, 562 | photo=image.file, 563 | ) 564 | photo_size: list[PhotoSize] = doc_message.photo 565 | image.tg_id = photo_size[0].file_id 566 | 567 | message = message.replace( 568 | '${file:%s}' % image.id, 569 | '🖼 %s' % title 570 | ) 571 | image_no += 1 572 | 573 | # write image links 574 | for img_link in re.finditer(r'(\${img-link:(?P[^|]*)\|(?P[^}]*)})', message, 575 | flags=(re.DOTALL | re.MULTILINE | re.IGNORECASE)): 576 | src = img_link.group('src') 577 | alt = img_link.group('alt') 578 | message = message.replace( 579 | img_link.groups()[0], 580 | '🖼 %s' % (src, alt) 581 | ) 582 | 583 | tg_message: Message = await self.bot.send_message(chat_id=self.config.tg_forward_to_chat_id, 584 | parse_mode=parser, 585 | text=message, 586 | disable_web_page_preview=False) 587 | 588 | logging.info("Mail summary for '%s' (UID: '%s') was sent" 589 | " with message ID '%i' to '%s' (ID: '%i')" 590 | % (mail.mail_subject, mail.uid, tg_message.message_id, 591 | tg_chat_title, self.config.tg_forward_to_chat_id)) 592 | 593 | if self.config.tg_forward_attachment and len(mail.attachments) > 0: 594 | for attachment in mail.attachments: 595 | subject = mail.mail_subject 596 | if mail.type == MailDataType.HTML: 597 | file_name = attachment.name 598 | caption = '' + subject + ':\n' + file_name 599 | else: 600 | file_name = helpers.escape_markdown( 601 | text=attachment.name, version=self.config.tg_markdown_version) 602 | caption = '*' + subject + '*:\n' + file_name 603 | 604 | tg_message = await self.bot.send_document(chat_id=self.config.tg_forward_to_chat_id, 605 | parse_mode=parser, 606 | caption=caption, 607 | document=attachment.file, 608 | filename=attachment.name, 609 | disable_content_type_detection=False) 610 | 611 | logging.info("Attachment '%s' was sent with ID '%i' to '%s' (ID: '%s')" 612 | % (attachment.name, tg_message.message_id, 613 | tg_chat_title, str(self.config.tg_forward_to_chat_id))) 614 | 615 | except error.TelegramError as tg_mail_error: 616 | msg = "❌ Failed to send Telegram message (UID: %s) to '%s': %s" \ 617 | % (mail.uid, str(self.config.tg_forward_to_chat_id), tg_mail_error.message) 618 | logging.critical(msg) 619 | try: 620 | # try to send error via telegram, and ignore further errors 621 | await self.bot.send_message(chat_id=self.config.tg_forward_to_chat_id, 622 | parse_mode=ParseMode.MARKDOWN_V2, 623 | text=helpers.escape_markdown(msg, version=2), 624 | disable_web_page_preview=False) 625 | finally: 626 | logging.critical("Failed to send error message {0}".format(tg_mail_error.message)) 627 | 628 | except Exception as send_mail_error: 629 | error_msgs = [self.config.tool.binary_to_string(arg) for arg in send_mail_error.args] 630 | msg = "Failed to send Telegram message (UID: %s) to '%s': %s" \ 631 | % (mail.uid, str(self.config.tg_forward_to_chat_id), ', '.join(error_msgs)) 632 | logging.critical(msg) 633 | try: 634 | # try to send error via telegram, and ignore further errors 635 | await self.bot.send_message(chat_id=self.config.tg_forward_to_chat_id, 636 | parse_mode=ParseMode.MARKDOWN_V2, 637 | text=helpers.escape_markdown(msg, version=2), 638 | disable_web_page_preview=False) 639 | finally: 640 | logging.critical("Failed to send error message {0}".format("".join(error_msgs))) 641 | 642 | except error.TelegramError as tg_error: 643 | logging.critical(self.error_send_message % tg_error.message) 644 | return False 645 | 646 | except Exception as send_error: 647 | error_msgs = [self.config.tool.binary_to_string(arg) for arg in send_error.args] 648 | logging.critical(self.error_send_message % ', '.join(error_msgs)) 649 | return False 650 | 651 | return True 652 | 653 | 654 | class Mail: 655 | mailbox: typing.Optional[imaplib2.IMAP4_SSL] = None 656 | config: Config 657 | last_uid: str = '' 658 | 659 | previous_error = None 660 | 661 | class MailError(Exception): 662 | def __init__(self, message, errors=None): 663 | super().__init__(message) 664 | self.errors = errors 665 | 666 | def __init__(self, config): 667 | """ 668 | Login to remote IMAP server. 669 | """ 670 | self.config = config 671 | try: 672 | self.mailbox = imaplib2.IMAP4_SSL(host=config.imap_server, 673 | port=config.imap_port, 674 | timeout=config.imap_timeout) 675 | rv, _ = self.mailbox.login(config.imap_user, config.imap_password) 676 | if rv != 'OK': 677 | msg = "Cannot login to mailbox: %s" % str(rv) 678 | raise self.MailError(msg) 679 | 680 | except socket.gaierror as gai_error: 681 | msg = "Connection error '%s:%i': %s" % (config.imap_server, 682 | config.imap_port, 683 | gai_error.strerror) 684 | logging.debug(msg) 685 | raise self.MailError(msg, gai_error) 686 | 687 | except imaplib2.IMAP4_SSL.error as imap_ssl_error: 688 | error_msgs = [self.config.tool.binary_to_string(arg) for arg in imap_ssl_error.args] 689 | msg = "Login to '%s:%i' failed: %s" % (config.imap_server, 690 | config.imap_port, 691 | ', '.join(error_msgs)) 692 | logging.debug(msg) 693 | raise self.MailError(msg, imap_ssl_error) 694 | 695 | except Exception as login_error: 696 | msg = "Mail error during connection to '%s:%i' failed: %s" \ 697 | % (config.imap_server, config.imap_port, ', '.join(map(str, login_error.args))) 698 | logging.debug(msg) 699 | raise self.MailError(msg, login_error) 700 | 701 | rv, mailboxes = self.mailbox.list() 702 | if rv != 'OK': 703 | self.disconnect() 704 | msg = "Can't get list of available mailboxes / folders: %s" % str(rv) 705 | raise self.MailError(msg) 706 | else: 707 | logging.info("Mailboxes:") 708 | logging.info(mailboxes) 709 | 710 | rv, _ = self.mailbox.select(config.imap_folder) 711 | if rv == 'OK': 712 | logging.info("Processing mailbox...") 713 | else: 714 | msg = "ERROR: Unable to open mailbox: %s" % str(rv) 715 | logging.debug(msg) 716 | raise self.MailError(msg) 717 | 718 | def is_connected(self): 719 | if self.mailbox is not None: 720 | try: 721 | rv, _ = self.mailbox.noop() 722 | if rv == 'OK': 723 | logging.debug("Connection is working...") 724 | return True 725 | except Exception as connection_check_error: 726 | msg = "Error during connection check [noop]: %s" \ 727 | % (', '.join(map(str, connection_check_error.args))) 728 | logging.error(msg) 729 | return False 730 | 731 | def disconnect(self): 732 | if self.mailbox is not None: 733 | try: 734 | self.mailbox.close() 735 | self.mailbox.logout() 736 | except Exception as ex: 737 | logging.debug("Cannot close mailbox: %s" % ', '.join(ex.args)) 738 | finally: 739 | self.mailbox = None 740 | 741 | @staticmethod 742 | def decode_body(msg) -> MailBody: 743 | """ 744 | Get payload from message and return structured body data 745 | """ 746 | html_part = None 747 | text_part = None 748 | attachments: list[MailAttachment] = [] 749 | images: list[MailImage] = [] 750 | index: int = 1 751 | 752 | for part in msg.walk(): 753 | if part.get_content_type().startswith('multipart/'): 754 | continue 755 | 756 | elif part.get_content_type() == 'text/plain': 757 | # extract plain text body 758 | text_part = part.get_payload(decode=True) 759 | encoding = part.get_content_charset() 760 | if not encoding: 761 | encoding = 'utf-8' 762 | text_part = bytes(text_part).decode(encoding).strip() 763 | 764 | elif part.get_content_type() == 'text/html': 765 | # extract HTML body 766 | html_part = part.get_payload(decode=True) 767 | encoding = part.get_content_charset() 768 | if not encoding: 769 | encoding = 'utf-8' 770 | html_part = bytes(html_part).decode(encoding).strip() 771 | 772 | elif part.get_content_type() == 'message/rfc822': 773 | continue 774 | 775 | elif part.get_content_type() == 'text/calendar': 776 | # extract calendar/appointment files 777 | attachment = MailAttachment() 778 | attachment.idx = index 779 | attachment.name = 'invite.ics' 780 | attachment.file = part.get_payload(decode=True) 781 | attachments.append(attachment) 782 | index += 1 783 | 784 | elif part.get_content_charset() is None: 785 | if part.get_content_disposition() == 'attachment': 786 | # extract attachments 787 | attachment = MailAttachment() 788 | attachment.idx = index 789 | attachment.set_name(str(part.get_filename())) 790 | attachment.file = part.get_payload(decode=True) 791 | attachments.append(attachment) 792 | index += 1 793 | 794 | elif part.get_content_disposition() == 'inline': 795 | # extract inline images 796 | if part.get_content_type() in ('image/png', 'image/jpeg'): 797 | image = MailAttachment(MailAttachmentType.IMAGE) 798 | image.idx = index 799 | image.set_name(str(part.get_filename())) 800 | image.set_id(part.get('Content-ID', image.name)) 801 | image.file = part.get_payload(decode=True) 802 | images.append(MailImage(key=image.id, image=image)) 803 | index += 1 804 | 805 | body = MailBody() 806 | body.text = text_part 807 | body.html = html_part 808 | body.attachments = attachments 809 | body.images = images 810 | return body 811 | 812 | def get_last_uid(self) -> str: 813 | """ 814 | get UID of most recent mail 815 | """ 816 | rv, data = self.mailbox.uid('search', '', 'UID *') 817 | if rv != 'OK': 818 | logging.info("No messages found!") 819 | return '' 820 | return self.config.tool.binary_to_string(data[0]) 821 | 822 | def parse_mail(self, uid, mail) -> (MailData | None): 823 | """ 824 | parse data from mail like subject, body and attachments and return structured mail data 825 | """ 826 | try: 827 | msg: email.message.Message[str, str] = email.message_from_bytes(mail) 828 | 829 | # decode body data (text, html, multipart/attachments) 830 | body = self.decode_body(msg) 831 | message_type = MailDataType.TEXT 832 | content = '' 833 | 834 | if self.config.tg_forward_mail_content: 835 | # remove useless content 836 | if body.text: 837 | content = body.text.replace('()', '').replace('[]', '').strip() 838 | 839 | # insert inline image 840 | if self.config.tg_forward_embedded_images: 841 | cid: Match[str] 842 | for cid in re.finditer(r'\[cid:([^]]*)]', content, 843 | flags=(re.DOTALL | re.MULTILINE | re.IGNORECASE)): 844 | for mail_image in body.images: 845 | if mail_image['key'] == cid: 846 | content = content.replace( 847 | '[cid:' + cid.string + ']', 848 | '${file:' + mail_image['image'].tg_id + '}' 849 | ) 850 | break 851 | 852 | bot = TelegramBot(self.config) 853 | if self.config.tg_prefer_html: 854 | # Prefer HTML 855 | if body.html: 856 | message_type = MailDataType.HTML 857 | content = bot.cleanup_html(body.html, body.images) 858 | 859 | elif body.text: 860 | content = helpers.escape_markdown(text=content, 861 | version=self.config.tg_markdown_version) 862 | 863 | else: 864 | if body.text: 865 | content = helpers.escape_markdown(text=content, 866 | version=self.config.tg_markdown_version) 867 | 868 | elif body.html: 869 | message_type = MailDataType.HTML 870 | content = bot.cleanup_html(body.html, body.images) 871 | 872 | if content: 873 | # remove multiple line breaks (keeping up to 1 empty line) 874 | content = re.sub(r'(\s*\r?\n){2,}', "\n\n", content) 875 | 876 | if message_type == MailDataType.HTML: 877 | # add space after links (provide space for touch on link lists) 878 | # '<' keep mail marker together (ex.: <t@ex.xom>) 879 | content = re.sub(r'(?P(\s*>)?)\s*', r'\g\n\n', content, flags=re.MULTILINE) 880 | 881 | # remove spaces and line breaks on start and end (enhanced strip) 882 | content = re.sub(r'^\s*', '', content) 883 | content = re.sub(r'\s*$', '', content) 884 | 885 | max_len = self.config.imap_max_length 886 | content_len = len(content) 887 | if message_type == MailDataType.HTML and content_len > 0: 888 | # get length of parsed HTML (all tags and masked images (ex.: '${|}') removed) 889 | content_plain: str = re.sub(r'(<[^>]*>)|(\${[^}]+})', '', content, flags=re.MULTILINE) 890 | # get new max length based on plain text factor 891 | plain_factor: float = (len(content_plain) / content_len) + float(1) 892 | max_len = int(max_len * plain_factor) 893 | if content_len > max_len: 894 | content = content[:max_len] 895 | if message_type == MailDataType.HTML: 896 | # remove incomplete html tag 897 | content = re.sub(r'<(\s*\w*(\s*[^>]*?)?(</[^>]*)?)?$', '', content) 898 | else: 899 | # remove last "\" 900 | content = re.sub(r'\\*$', '', content) 901 | content += "... (first " + str(max_len) + " characters)" 902 | 903 | # attachment summary 904 | attachments_summary = "" 905 | if body.attachments: 906 | if message_type == MailDataType.HTML: 907 | attachments_summary = "\n\n" + chr(10133) + \ 908 | " <b>" + str(len(body.attachments)) + " attachments:</b>\n" 909 | else: 910 | attachments_summary = "\n\n" + chr(10133) + \ 911 | " **" + str(len(body.attachments)) + " attachments:**\n" 912 | for attachment in body.attachments: 913 | if message_type == MailDataType.HTML: 914 | file_name = attachment.name 915 | else: 916 | file_name = helpers.escape_markdown( 917 | text=attachment.name, version=self.config.tg_markdown_version) 918 | attachments_summary += "\n " + str(attachment.idx) + ": " + file_name 919 | 920 | # subject 921 | subject = self.config.tool.decode_mail_data(msg['Subject']) 922 | 923 | # build summary 924 | mail_from = self.config.tool.decode_mail_data(msg['From']) 925 | 926 | if self.config.tg_forward_mail_content: 927 | summary_line = "\n=============================\n" 928 | else: 929 | summary_line = "\n" 930 | 931 | if message_type == MailDataType.HTML: 932 | mail_from = html.escape(mail_from, quote=True) 933 | email_text = "<b>From:</b> " + mail_from + "\n<b>Subject:</b> " 934 | else: 935 | subject = helpers.escape_markdown(text=subject, 936 | version=self.config.tg_markdown_version) 937 | mail_from = helpers.escape_markdown(text=mail_from, 938 | version=self.config.tg_markdown_version) 939 | summary_line = helpers.escape_markdown(text=summary_line, 940 | version=self.config.tg_markdown_version) 941 | email_text = "*From:* " + mail_from + "\n*Subject:* " 942 | email_text += subject + summary_line + content + " " + attachments_summary 943 | 944 | mail_data = MailData() 945 | mail_data.uid = uid 946 | mail_data.raw = msg 947 | mail_data.type = message_type 948 | mail_data.mail_from = mail_from 949 | mail_data.mail_subject = subject 950 | mail_data.mail_body = content 951 | mail_data.mail_images = body.images 952 | mail_data.summary = email_text 953 | mail_data.attachment_summary = attachments_summary 954 | mail_data.attachments = body.attachments 955 | 956 | return mail_data 957 | 958 | except Exception as parse_error: 959 | if len(parse_error.args) > 0: 960 | logging.critical("Cannot parse mail: %s" % parse_error.args[0]) 961 | else: 962 | logging.critical("Cannot parse mail: %s" % parse_error.__str__()) 963 | return None 964 | 965 | def search_mails(self) -> list[MailData]: 966 | """ 967 | Search mail on remote IMAP server and return list of parsed mails. 968 | """ 969 | if self.last_uid is None or self.last_uid == '': 970 | self.last_uid = self.get_last_uid() 971 | logging.info("Most recent UID: '%s'" % self.last_uid) 972 | 973 | # build IMAP search string 974 | search_string = self.config.imap_search 975 | if not search_string: 976 | search_string = "(UID %s:* UNSEEN)" % str(self.last_uid) 977 | else: 978 | search_string = re.sub(r'\${lastUID}', str(self.last_uid), search_string, flags=re.IGNORECASE) 979 | 980 | if re.match(r'.*\bUID\b\s*:.*', search_string) and self.last_uid == '': 981 | # empty mailbox 982 | return [] 983 | 984 | try: 985 | rv, data = self.mailbox.uid('search', '', search_string) 986 | if rv != 'OK': 987 | logging.info("No messages found!") 988 | return [] 989 | 990 | except imaplib2.IMAP4_SSL.error as search_error: 991 | error_msgs = [self.config.tool.binary_to_string(arg) for arg in search_error.args] 992 | msg = "Search with '%s' returned: %s" % (search_string, ', '.join(error_msgs)) 993 | if msg != self.previous_error: 994 | logging.error(msg) 995 | self.previous_error = msg 996 | self.disconnect() 997 | raise self.MailError(msg) 998 | 999 | except Exception as search_ex: 1000 | msg = ', '.join(map(str, search_ex.args)) 1001 | logging.critical("Cannot search mail: %s" % msg) 1002 | self.disconnect() 1003 | raise self.MailError(msg) 1004 | 1005 | mails = [] 1006 | if self.config.imap_read_old_mails and not self.config.imap_read_old_mails_processed: 1007 | # ignore current/max UID during first loop 1008 | max_uid = '' 1009 | # don't repeat this on next loops 1010 | self.config.imap_read_old_mails = False 1011 | logging.info("Ignore most recent UID '%s', as old mails have to be processed first..." % self.last_uid) 1012 | else: 1013 | max_uid = self.last_uid 1014 | if not self.config.imap_read_old_mails_processed: 1015 | self.config.imap_read_old_mails_processed = True 1016 | logging.info("Reading mails having UID more recent than '%s', using search: '%s'" 1017 | % (self.last_uid, search_string)) 1018 | 1019 | for cur_uid in sorted(data[0].split()): 1020 | current_uid = self.config.tool.binary_to_string(cur_uid) 1021 | 1022 | try: 1023 | rv, data = self.mailbox.uid('fetch', cur_uid, '(RFC822)') 1024 | if rv != 'OK': 1025 | logging.error("ERROR getting message: %s" % current_uid) 1026 | return [] 1027 | 1028 | msg_raw = data[0][1] 1029 | mail = self.parse_mail(current_uid, msg_raw) 1030 | if mail is None: 1031 | logging.error("Can't parse mail with UID: '%s'" % current_uid) 1032 | else: 1033 | logging.info("Parsed mail with UID '%s': '%s'" % (current_uid, mail.mail_subject)) 1034 | mails.append(mail) 1035 | 1036 | except Exception as mail_error: 1037 | logging.critical("Cannot process mail with UID '%s': %s" % (current_uid, 1038 | ', '.join(map(str, mail_error.args)))) 1039 | 1040 | finally: 1041 | # remember new UID for next loop 1042 | max_uid = current_uid 1043 | 1044 | if len(mails) > 0: 1045 | self.last_uid = max_uid 1046 | logging.info("Got %i new mail(s) to forward, using most recent UID: '%s'" % (len(mails), self.last_uid)) 1047 | return mails 1048 | 1049 | 1050 | class SystemdHandler(logging.Handler): 1051 | """ 1052 | Class to handle logging options. 1053 | """ 1054 | PREFIX = { 1055 | logging.CRITICAL: "<2> " + __appname__ + ": ", 1056 | logging.ERROR: "<3> " + __appname__ + ": ", 1057 | logging.WARNING: "<4> " + __appname__ + ": ", 1058 | logging.INFO: "<6> " + __appname__ + ": ", 1059 | logging.DEBUG: "<7> " + __appname__ + ": ", 1060 | logging.NOTSET: "<7> " + __appname__ + ": ", 1061 | } 1062 | tool: Tool 1063 | 1064 | def __init__(self, stream=sys.stdout): 1065 | self.stream = stream 1066 | logging.Handler.__init__(self) 1067 | 1068 | def emit(self, record): 1069 | try: 1070 | if self.tool is not None: 1071 | # Normalize message and replace sensitive data 1072 | record.msg = self.tool.build_error_message(record.msg) 1073 | msg = self.PREFIX[record.levelno] + self.format(record) + "\n" 1074 | self.stream.write(msg) 1075 | self.stream.flush() 1076 | except Exception as emit_error: 1077 | self.handleError(record) 1078 | if len(emit_error.args) > 0: 1079 | print("ERROR: SystemdHandler.emit failed with: " + emit_error.args[0]) 1080 | else: 1081 | print("ERROR: SystemdHandler.emit failed with: " + emit_error.__str__()) 1082 | 1083 | 1084 | async def main() -> None: 1085 | """ 1086 | Run the main program 1087 | """ 1088 | sys_handler = SystemdHandler() 1089 | root_logger = logging.getLogger() 1090 | root_logger.setLevel("INFO") 1091 | root_logger.addHandler(sys_handler) 1092 | 1093 | args_parser = argparse.ArgumentParser(description='Mail to Telegram Forwarder') 1094 | args_parser.add_argument('-c', '--config', type=str, help='Path to config file', required=True) 1095 | args_parser.add_argument('-o', '--read-old-mails', action='store_true', required=False, 1096 | help='Read mails received, before application was started') 1097 | cmd_args = args_parser.parse_args() 1098 | 1099 | if cmd_args.config is None: 1100 | logging.warning("Could not load config file, as no config file was provided.") 1101 | sys.exit(2) 1102 | 1103 | mailbox = None 1104 | last_try = time.time() 1105 | tool = Tool() 1106 | sys_handler.tool = tool 1107 | try: 1108 | config = Config(tool, cmd_args) 1109 | sys_handler.mask_error_data = tool.mask_error_data 1110 | tg_bot = TelegramBot(config) 1111 | mailbox = Mail(config) 1112 | 1113 | # Keep polling 1114 | while True: 1115 | try: 1116 | if mailbox is None: 1117 | mailbox = Mail(config) 1118 | else: 1119 | if not mailbox.is_connected(): # reconnect on error (broken connection) 1120 | if last_try + 60 < time.time(): 1121 | mailbox = Mail(config) 1122 | if not mailbox.is_connected(): 1123 | await asyncio.sleep(20) 1124 | continue 1125 | else: 1126 | last_try = time.time() # new timeout on success 1127 | else: 1128 | await asyncio.sleep(20) 1129 | continue 1130 | 1131 | mails = mailbox.search_mails() 1132 | 1133 | if config.imap_disconnect: 1134 | # if not reuse previous connection 1135 | mailbox.disconnect() 1136 | 1137 | # send mail data via TG bot 1138 | if mails is not None and len(mails) > 0: 1139 | await tg_bot.send_message(mails) 1140 | 1141 | if config.imap_push_mode: 1142 | logging.info("IMAP IDLE mode") 1143 | else: 1144 | await asyncio.sleep(float(config.imap_refresh)) 1145 | 1146 | except Mail.MailError as mail_ex: 1147 | if len(mail_ex.args) > 0: 1148 | logging.critical('Error occurred [mail]: %s' % ', '.join(map(str, mail_ex.args))) 1149 | else: 1150 | logging.critical('Error occurred [mail]: %s' % mail_ex.__str__()) 1151 | 1152 | if mailbox is not None: 1153 | mailbox.disconnect() 1154 | 1155 | # ignore errors already handled by Mail- Class 1156 | 1157 | except Exception as loop_error: 1158 | if len(loop_error.args) > 0: 1159 | logging.critical('Error occurred [loop]: %s' % ', '.join(map(str, loop_error.args))) 1160 | else: 1161 | logging.critical('Error occurred [loop]: %s' % loop_error.__str__()) 1162 | 1163 | if mailbox is not None: 1164 | mailbox.disconnect() 1165 | 1166 | except KeyboardInterrupt: 1167 | logging.critical('Stopping user aborted with CTRL+C') 1168 | 1169 | except Mail.MailError: # ignore errors already handled by Mail- Class 1170 | pass 1171 | 1172 | except Exception as main_error: 1173 | if len(main_error.args) > 0: 1174 | logging.critical('Error occurred [main]: %s' % ', '.join(map(str, main_error.args))) 1175 | else: 1176 | logging.critical('Error occurred [main]: %s' % main_error.__str__()) 1177 | 1178 | finally: 1179 | if mailbox is not None: 1180 | mailbox.disconnect() 1181 | logging.info('Mail to Telegram Forwarder stopped!') 1182 | 1183 | 1184 | if __name__ == "__main__": 1185 | with contextlib.suppress(KeyboardInterrupt): # Ignore exception when Ctrl-C is pressed 1186 | asyncio.run(main()) 1187 | --------------------------------------------------------------------------------