de:Plugins:eMail - Schrolli91/BOSWatch GitHub Wiki

Plugin: eMail

Dieses Plugin stellt die Funktionalität zur Verfügung, Alarme via E-Mail zu versenden. Dabei sind Aufbau und Inhalt der Mail frei konfigurierbar.

Einstellungen

Die Einstellungen des Plugins erfolgen in der zentralen config/config.ini

Server-Einstellungen

[eMail]
# SMTP-Server
smtp_server = localhost
# Port of SMTP-server (default: )
smtp_port =
# use tls for connection (0|1)
tls = 0
# Use this, when SMTP-server has restricted access
user =
password =

In diesem Abschnitt werden die Servereinstellungen angegeben: Die URL des SMTP-Servers sowie der zu verwendende Port (üblicherweise 25 oder 465, evtl auch 587). Weiterhin ist ein Schalter für die Verwendung von TLS (Transport Layer Security, auch bekannt als SSL) vorgesehen. Sollten Anmeldedaten (Benutzername und Passwort) für den Mailserver erforderlich sein, so sind diese hier anzugeben (ACHTUNG: Die Konfigurationsdatei speichert das Passwort im Klartext ab!).

Adressaten

# Parameters for Alarm-Msg:
# "to" can be more than one address, comma separated
from = local@localhost
to   = user@irgendwo, user2@woanders
# Priority of the eMail:
# normal|urgent|non-urgent
priority = urgent

An dieser Stelle wird die Absenderkennung (from) festgelegt sowie die An-Adressaten (to) als kommagetrennte Liste eingetragen; dies kann in beiden Fällen

  1. in Form einer einfachen Mailadresse '[email protected]' oder
  2. in der Form bspw. 'Alarmsystem FF XYZ <[email protected]>'

geschehen.

Die E-Mail wird mit der Priorität 'hoch' (urgent) verschickt.

eMail für FMS

# %FMS%     = FMS Code
# %STATUS%  = FMS Status
# %DIR%     = Direction of the telegram (0/1)
# %DIRT%    = Direction of the telegram (Text-String)
# %TSI%     = Tactical Short Information (I-IV)
# %DESCR%   = Description, if description-module is used
# %DATE%    = Date (by script)
# %TIME%    = Time (by script)
# %BR%      = Insert line wrap (only in message)
# %LPAR%    = (
# %RPAR%    = )
fms_subject = FMS: %FMS%
fms_message = %DATE% %TIME%: %FMS%%BR%Status: %STATUS% - Direction: %DIRT% - TSI: %TSI%

Wenn BOSWatch für die Auswertung von FMS konfiguriert wurde, ist mittels fms_subject der Betreff der E-Mail und mittels fms_message der Inhalt konfigurierbar. Dazu können auch die zur Verfügung stehenden Daten verwendet werden, die Platzhalter werden automatisch durch das Programm ersetzt. Die Platzhalter date, time .. RPAR stehen in allen Dekodern zur Verfügung.

eMail für ZVEI

# %ZVEI%    = ZVEI 5-tone Code
# %DESCR%   = Description, if description-module is used
zvei_subject = Alarm: %ZVEI%
zvei_message = %DATE% %TIME%: %ZVEI%

Analog zu den FMS-E-Mails kann an dieser Stelle die E-Mail für die Auswertung der 5-Ton-Folge erstellt werden. Bis auf die Tonfolge und eine eventuell angelegte Klartextbeschreibung stehen keine weiteren Informationen zur Verfügung.

eMail für POCSAG

# %RIC%      = POCSAG RIC
# %FUNC%     = POCSAG function/Subric (1-4)
# %FUNCCHAR% = POCSAG function/Subric als character (a-d)
# %FUNCTEXT% = POCSAG function/Subric static massage definded in POCSAG section
# %MSG%      = Message of the POCSAG telegram
# %BITRATE%  = Bitrate of the POCSAG telegram
poc_subject = Alarm: %RIC%%LPAR%%FUNCCHAR%%RPAR%
poc_message = %DATE% %TIME% - %DESCR%: %MSG%

Für die Auswertung von POCSAG stehen o.g. Platzhalter zur Verfügung und können in den E-Mailtext eingearbeitet werden.