Reminder

Aus Magrathea Laboratories e.V.
Wechseln zu: Navigation, Suche

Der Reminder ist ein Script zum Versenden von Einladungs- und Erinnerungs-Mails für anstehende Veranstaltungen.

Die Liste der Events wird in der momentanen Konfiguration im Wiki verwaltet.


Funktion

Der Reminder besteht aus dem eigendlichen Script, einem Template und einer Event-Liste.

Das Script wird durch einen Cron-Job täglich gestartet. Nach dem Start wird die Event-Liste von einer URL heruntergeladen und nach anstehenden Terminen durchsucht. Wenn ein Termin gefunden wird, wird das Template mit den Daten des gefundenen Termins befüllt und per E-Mail versendet.


Installation

Das Script ist ein BASH-Script. Es als GIT-Repository von folgender URL geklont werden:

https://github.com/mag-lab/reminder.git


Konfiguration

Zu müssen einige Konfigurationen vorgenommen werden. Dafür muss das Script reminder/reminder editiert werden.

Folgende Optionen stehen zur verfügung:

FROM
Absender-Addresse der Einladungs-EMails
RCPT
Empfänger-Addresse der Einladungs-EMails
LOOKAHEAD
Die Vorlaufzeit mit der zu einem anstehenden Event eingeladen wird
URL
Die URL unter der die Event-Liste verfügbar ist

Zur Anpassung der zu versendeten EMail kann das Template reminder/template angepasst werden. Dabei stehen folgende Variablen zur Verfügung:

${FROM}
Der Absender laut Konfiguration
${RCPT}
Der Empfänger laut Konfiguration
${SUBJECT}
Der Betreff der Nachricht laut Event-Beschreibung
${DATE}
Das Datum des Events laut Event-Beschreibung
${TIME}
Die Zeit des Events laut Event-Beschreibung
${LOCATION}
Der Ort des Events laut Event-Beschreibung

Die Event-Liste beinhaltet eine Zeile pro Event. Jede Zeile muss folgende Felder, durch Tabulator getrennt, enthalten:

  1. Datum
  2. Zeit
  3. Ort
  4. Betreff

Optional kann jede Zeile mit belibigen Leerzeichen beginnen um eine Formatierung im Wiki zu ermöglichen.