Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gregorykogan/mostpp-mailing-bot

Automating email invitations
https://github.com/gregorykogan/mostpp-mailing-bot

automation email email-reader email-sender email-template invitation-system telegram-bot

Last synced: 1 day ago
JSON representation

Automating email invitations

Host: GitHub
URL: https://github.com/gregorykogan/mostpp-mailing-bot
Owner: GregoryKogan
License: gpl-3.0
Created: 2024-01-16T10:26:42.000Z (10 months ago)
Default Branch: main
Last Pushed: 2024-04-12T23:07:43.000Z (7 months ago)
Last Synced: 2024-04-13T04:44:07.415Z (7 months ago)
Topics: automation, email, email-reader, email-sender, email-template, invitation-system, telegram-bot
Language: Python
Homepage: https://t.me/mostpp_mailing_bot
Size: 75.2 KB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# mostpp-mailing-bot

![License](https://img.shields.io/github/license/GregoryKogan/mostpp-mailing-bot)
[![Hits-of-Code](https://hitsofcode.com/github/GregoryKogan/mostpp-mailing-bot?branch=main)](https://hitsofcode.com/github/GregoryKogan/mostpp-mailing-bot/view?branch=main)

This bot obtains registration information by reading notification emails in your inbox. Subsequently, you can view the data of those who registered, send them confirmation letters or thanks for their participation.

### Environment variables

`.env` file should be created in the root directory with the following variables:

- `EMAIL_ADDRESS`: Email address to send emails from
- `EMAIL_APP_PASSWORD`: App password for the email address
- `NOTIFIER_ADDRESS`: Email address to receive notifications from
- `DUMP_EMAIL_ADDRESS`: Email address to send all emails to in DEV mode
- `BOT_TOKEN`: Telegram bot token
- `ALLOWED_USERS`: String of comma-separated list of allowed users
- `DEVELOPER_CHAT_ID`: Chat ID of the developer

Example:

```shell
[email protected]
EMAIL_APP_PASSWORD=123ABC123ABC
[email protected]
[email protected]
BOT_TOKEN=12312313123:ABCABCABCABC
ALLOWED_USERS="123456789,987654321"
DEVELOPER_CHAT_ID=123456789
```

### Configuration

Configuration is done in `src/config.py` file.
The most important setting is `MODE` which can be either `DEV` or `PROD`. In `DEV` mode, all emails are sent to `DUMP_EMAIL_ADDRESS` and in `PROD` mode, the bot sends emails to the actual recipients.

### Running the bot

```shell
docker compose build
docker compose up -d
```

Container will be started in detached mode. It's configured to always restart on failure. So to stop the bot, use

```shell
docker stop mostpp-bot
docker rm mostpp-bot
```