https://github.com/manuellr/notmail_bot
Telegram bot that acts as an email client
https://github.com/manuellr/notmail_bot
bot docker docker-compose email imap-client notmail-bot python telegram-bot
Last synced: 10 months ago
JSON representation
Telegram bot that acts as an email client
- Host: GitHub
- URL: https://github.com/manuellr/notmail_bot
- Owner: ManuelLR
- License: gpl-3.0
- Created: 2017-10-01T18:48:34.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-01-27T11:37:40.000Z (over 8 years ago)
- Last Synced: 2025-04-01T07:02:39.289Z (about 1 year ago)
- Topics: bot, docker, docker-compose, email, imap-client, notmail-bot, python, telegram-bot
- Language: Python
- Homepage:
- Size: 208 KB
- Stars: 24
- Watchers: 4
- Forks: 4
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Authors: AUTHORS
Awesome Lists containing this project
README
# Notmail Bot
> Telegram bot that acts as an email client.
**V.0.1.0**
# Usage Preview
_Work in progress_
# Features
- Auto check email account and notify news.
- Friendly interface.
- Multiple email accounts.
- Compatible with IMAP protocol. (More in the future).
- Read email on Telegram, mark as read/unread, archive/delete and much more.
# Basic configuration
First of all, we need to know our `username` and the `bot_token`. The `username` could be configure in your Telegram app settings (also known as `alias`). To get the`bot_token` is necessary to speak with the [@BotFather](https://telegram.me/BotFather) and introduce the `/newbot` command. It will ask all necesary data and finally, it will give to you the `bot_token` also called `API Token`.
# Launch
We can launch in several ways:
- [Docker Compose](./README.md#docker-compose) **(recomended)**
- [Docker](./README.md#docker)
- [Python](./README.md#python)
### Docker Compose
To use [docker-compose](https://docs.docker.com/compose/overview/) you need to install on your computer [Docker-CE](https://docs.docker.com/) and [Docker-compose](https://docs.docker.com/compose/install/).
Before running it you need to enter the variables in the new file called `.env`.
```
cp .example.env .env
nano .env
```
Finally, we execute the next command and can start to talk with the bot:
```
docker-compose up -d
```
If we update the code, you only need to update it (`git pull`) and relaunch docker compose with the following command:
```
git pull
docker-compose up -d --build
```
### Docker
```bash
sudo docker build -t notmail_bot .
sudo docker run -d --name Notmail_bot \
--restart always \
--env-file .env \
manuellr/notmail_bot
```
### Python
```bash
pip install -r requirements.txt
python notmail_bot.py --config_path my-config/my_config.ini
```
# License
- The main code is licensed under [GPLv3](./LICENSE)
- The logo of Notmail is licensed under [Free Art License v1.3](./img/notmail_bot_license.txt)
You can consult the contributors in the [AUTHORS file](./AUTHORS) or see the contributors of a specific file executing the next script:
```bash
git blame -C -C -M -- FILE_TO_CONSULT | \
sed -e 's/[^(]*(\([^0-9]*\).*/\1/' -e 's/[\t ]*$//' | \
sort | uniq -c | sort -nr
```