Plugin mailsend

protocol plugin

Im folgenden sind etwaige Anforderungen und unterstützte Hardware beschrieben. Danach folgt die Beschreibung, wie das Plugin mailsend konfiguriert wird. Außerdem ist im folgenden beschrieben, wie das Plugin in den Item Definitionen genutzt werden kann. [1]

Beschreibung

Versenden von eMails via smtp. Dieses Plugin ermöglicht das Versenden von eMails aus Logiken heraus, durch Aufruf einer Funktion

Anforderungen

  • Minimum SmartHomeNG Version: 1.4

Konfiguration

Im folgenden ist beschrieben, wie das Plugin mailsend konfiguriert wird. Außerdem ist im folgenden beschrieben, wie das Plugin in den Item Definitionen genutzt werden kann.

Parameter

Das Plugin verfügt über folgende Parameter, die in der Datei ../etc/plugin.yaml konfiguriert werden:

host

Adresse des SMTP Hosts

  • Datentyp: str

mail_from

Absender-Adresse der eMails (mail@example.com)

  • Datentyp: str

password

Passwort für die Anmeldung am SMTP host (optional)

  • Datentyp: str

port

Port des SMTP service (bitte 25 nutzen, fals tls deaktiviert wird)

  • Datentyp: int
  • Standardwert: 587
  • Minimalwert: 0
  • Maximalwert: 65535

tls

tls zur Verschlüsselung nutzen

  • Datentyp: bool
  • Standardwert: True

username

Username für die Anmeldung am SMTP host (optional)

  • Datentyp: str

Item Attribute

Das Plugin unterstützt folgende Item Attribute, die in den Dateien im Verzeichnis ../items verwendet werden:

Keine

Logik Parameter

Das Plugin verfügt über folgende Parameter, die in der Datei ../etc/logic.yaml konfiguriert werden:

Keine Logik Parameter in den Metadaten beschrieben - Bitte in der README nachsehen (siehe Fußnote)

Plugin Functions

Das Plugin verfügt über folgende öffentliche Funktionen, die z.B. in Logiken aufgerufen werden können.

send(to, subject, message)

Diese Funktion versendet eine eMail - Beispiel: sh.mail(‚admin@smart.home‘, ‚Testmail‘, ‚Mailtext und Betreff können UTF-8 kodierten Text enthalten‘)

  • Ergebnistyp der Funktion: foo

to

Empfänger der eMail (admin@smart.home)

  • Datentyp: str

subject

Betreff der eMail

  • Datentyp: foo

message

Nachrichtentext der eMail

  • Datentyp: foo
[1]Diese Seite wurde aus den Metadaten des Plugins erzeugt. Für den Fall, dass diese Seite nicht alle benötigten Informationen enthält, bitte auf die englischsprachige README Datei des Plugins zugreifen.