A tiny and resolute mailer CLI app

Find a file

phil 0cb2fcf2fc CI: update uv in build		2024-12-22 15:23:15 +01:00
.forgejo/workflows	CI: update uv in build	2024-12-22 15:23:15 +01:00
configs	Initial commit	2024-12-12 02:47:55 +01:00
src/tinysteady_mailer	Add container; fix typo	2024-12-12 04:32:05 +01:00
.gitignore	Initial commit	2024-12-12 02:47:55 +01:00
.python-version	Initial commit	2024-12-12 02:47:55 +01:00
Containerfile	Add container; fix typo	2024-12-12 04:32:05 +01:00
pyproject.toml	Update README and project details	2024-12-12 05:08:52 +01:00
README.md	Update README.md	2024-12-12 04:14:25 +00:00
uv.lock	Initial commit	2024-12-12 02:47:55 +01:00

README.md

Tinysteady mailer

CLI tool to send mails (campaigns) to lists of addresses.

Mail campaigns are organized in yaml configuration yaml files, and given in the environment variable CONFIG.

The intention is to be able to send mails using mail servers with time limitations with all free accounts in standard mail services. The tool keeps track of failures: a next run with the same config file will process only the failures, so all recipients will eventually be reached.

Installation

tinysteady-mailer is provided as:

a standard Python package
a container

See the Packages section on the project's home page: https://code.philo.ydns.eu/philorg/tinysteady-mailer.

Organisation and workflow

Create a yaml config file per mail campaign. Some example (for different kind of mail servers) are given in the configs directory.

There are 2 sources of address:

embedded in the config file
with an external json file

Run tinysteady-mailer with:

CONFIG=configs/my-first-campaign.yaml tinysteady-mailer

For example, given the local.yaml config file:

CONFIG=configs/local.yaml tinysteady-mailer
INFO     - Using configs/local.yaml
INFO     - Mail sent to root@localhost.localdomain
INFO     - 1 mails sent successfully

A results/<config_name> directory is created, with 2 files named with a timestamp: a .success and a .err files.

If some mails could not be delivered, the .err file contains records (in json format) of the failures.

A subsequent run with the same config will process only those. (that this can be overridden in the config file).

For example:

CONFIG=configs/local.yaml tinysteady-mailer
INFO     - Using configs/local.yaml
INFO     - Using a file with 1 failed attempts for this config (/home/phil/dev/tinysteady-mailer/results/local/2024-12-12 03:24:38.err)
INFO     - Mail sent to root@localhost.localdomain
INFO     - 1 mails sent successfully

Run in container

Using podman (Docker alternative), the above equivalent is:

podman run -it --rm \
    -v ./results:/src/results \
    -v ./configs:/src/configs/ \
    -e CONFIG=configs/local.yaml \
    code.philo.ydns.eu/philorg/tinysteady-mailer