A tool to send regular reminders, e.g. to the System Hackers to review documentation
Go to file
tobiasd 74eb8d826b
continuous-integration/drone/push Build is passing Details
rm delliott from fooled-friday
2024-09-02 10:23:30 +02:00
.reuse make project REUSE compliant 2019-09-12 18:43:24 +02:00
LICENSES make project REUSE compliant 2019-09-12 18:43:24 +02:00
mails rm delliott from fooled-friday 2024-09-02 10:23:30 +02:00
.drone.yml Update docker Docker tag to v27 2024-06-26 00:16:48 +00:00
.gitignore make project REUSE compliant 2019-09-12 18:43:24 +02:00
.msmtprc simplify and modernise setup 2022-03-17 15:37:45 +01:00
Dockerfile allow to set dynamic variables per mail template 2022-03-17 17:01:51 +01:00
LICENSE add license information 2018-04-06 08:49:36 +02:00
README.md add docs-centralizer CI job 2023-01-11 14:28:43 +01:00
cron.txt update interval for testimonials 2024-07-26 11:31:44 +02:00
docker-compose.yml migrate to cont1.noris 2021-07-14 15:51:32 +02:00
reminder-mails.sh allow to set dynamic variables per mail template 2022-03-17 17:01:51 +01:00
renovate.json update renovate to support depedency dashboard 2023-07-04 13:22:49 +02:00
renovate.json.license simplify and modernise setup 2022-03-17 15:37:45 +01:00

README.md

Reminder Mails

in docs.fsfe.org Build Status REUSE status

This program sends periodic mails which can be defined by easy mail templates. The interval for each mail can be defined in cron style. Sending works by using msmtp.

Install

This repository is meant to be installed using Docker and Drone CI. Docker logs will contain the status of the cron commands.

Configure templates

The templates shall be plain text files. The must contain at least the following headers: To, From, Subject. The Date and Message-ID headers are added automatically.

You can put comments in the file using # as the first character of a line. These will be deleted before sending.

Variables

You can add variables to a template by prepending # var: . Here is a simple example:

# var: directory="/tmp"
# var: files=$(ls -l "$directory")
To: me <me@example.com>
From: no-reply@example.com
Subject: Regular file listing in ${directory}

Hello. Here are all files in ${directory}:

${files}

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

The program in this repository meet the requirements to be REUSE compliant, meaning its license and copyright is expressed in such as way so that it can be read by both humans and computers alike.

For more information, see https://reuse.software/