0.22.0-feature-f57d65-lkjizk5t • Published 10 months ago

processcube.extensions.engine.mail_service v0.22.0-feature-f57d65-lkjizk5t

Weekly downloads
-
License
MIT
Repository
-
Last release
10 months ago

MailService

Installationsanleitung

Download der Extension

processcube.extensions.engine.mail_service-1.0.0.tgz

Installation der Extension (Installationsdatei)

Die tgz-Datei muss wie eine zip-Datei entpackt werden.

Im entpackten Ordner befindet sich eine Installationsdatei, die ausgeführt werden muss:

install.sh (linux)

install.bat (windows)

Nach der Ausführung der Installationsdatei kann die tgz-Datei und das enpackte Verzeichnis wieder gelöscht werden.

Installation der Extension (manuell)

Die tgz-Datei muss wie eine zip-Datei entpackt und in das Verzeichnis: <user>/.atlas/engine/extensions/ kopieren werden.

Der Verzeichnisname package sollte im Namen der Extension umbenannt werden.

Sollten die Verzeichnisse /.atlas/engine/extensions/ noch nicht existieren, so müssen diese vorher angelegt werden.

Die tgz-Datei darf beim Ausführen des Studios nicht in das oben genannte Verzeichnis liegen.

Vor einer Aktualisierung muss das Extension-Verzeichnis gelöscht werden.

Abhängigkeiten

Note Für diese Engine-Extension kann die Studio-Extension processcube.extensions.studio.custom_service_tasks verwendet werden!

Version 1.0

Problemstellung

Häufig wird eine Benachrichtigung der Benutzer per Email aus den Prozessen benötigt.

Zielzustand

Es wurde ein Service Task programmiert, der Emails über einen SMTP-Server versenden kann.

Dieser kann im Studio an jeder beliebigen Stelle definiert werden.

Der Service Task benötigt die Custom Property: engine.setServiceTaskType mit dem Wert: MailService.

npm.io

Zusätzlich zu den statischen Environment Variablen (siehe unten) müssen die folgenden dynamischen Parameter im PreScript definiert werden:

  • Empfänger recipient
  • Empfänger cc (optional) recipientCc
  • Betreff subject
  • Emailtext mailtext

npm.io

Für den Emailversand wurde das externe Modul "nodemailer": "^6.9.3" angebunden.

Neben reinen Text-Nachrichten können auch Html-Emails versendet werden.

Hierzu muss der Emailtext mit dem Parameter: <!DOCTYPE html>” beginnen.

Zusätzlich kann durch die Konfiguration von Parametern (siehe weiter unten) eine automatische Signatur erstellt und angehangen werden.

npm.io npm.io

Konfiguration

Die folgenden 4 Parameter müssen beim Start des Engine-Containers übergeben werden.

Die restlichen Parameter sind optional und dienen, neben der Anpassung der Konfiguration des Emailversands, auch zur Konfiguration einer Standard-Signatur.

Letzteres benötigt mindestens einen der unter genannten Signatur-Parameter.

Environment Variablen

environment:
- PC_EXT_MAILSERVICE_HOST=smtp.office365.com
- PC_EXT_MAILSERVICE_AUTH_USER=null
- PC_EXT_MAILSERVICE_AUTH_PASS=null
- PC_EXT_MAILSERVICE_SENDER=5Minds ProcessCube Notification <noreply-5minds-notifcations@muster.de>
#- PC_EXT_MAILSERVICE_PORT=587
#- PC_EXT_MAILSERVICE_AUTH_TYPE=login
#- PC_EXT_MAILSERVICE_SIGNATURE_TITLE= 5Minds ProcessCube Notification
#- PC_EXT_MAILSERVICE_SIGNATURE_NOTE=Bitte antworten Sie nicht auf diese Email!
#- PC_EXT_MAILSERVICE_SIGNATURE_CONTACT_PERSON= Muster Mustermann, Musterposition
#- PC_EXT_MAILSERVICE_SIGNATURE_CONTACT_MAIL=muster.mustermann@muster.de