Zum Hauptinhalt springen

E-Mail-Konfiguration

E-Mails werden in der internen und externen Kommunikation, an der Benutzer von ConSol CM beteiligt sind, verwendet. ConSol CM ruft E-Mails von einem oder mehreren Konten ab, um neue Vorgänge zu erstellen, oder sie an bestehende Vorgänge anzuhängen. E-Mail können manuell aus Vorgängen oder automatisch in bestimmten Situationen gesendet werden. ConSol CM sendet E-Mails von einem E-Mail-Konto, die verwendeten Adressen können aber geändert werden.

Die Einstellungen der E-Mail-Konfiguration werden in System-Properties gespeichert.

E-Mails werden in ConSol CM für mehrere Zwecke verwendet. Sie können im Web Client von einem Benutzer geschrieben werden, oder automatisch vom System versendet werden. Wenn die Benutzer mit dem Rich-Text-Editor E-Mails schreiben können sie eine Textvorlage auswählen, um für einen bestimmten Zweck vorbereiteten Text in den Editor einzufügen. Standardmäßig ist die E-Mail-Adresse des Kontakts des Vorgangs als Empfänger ausgewählt. Dies kann im Attribut der Seitenanpassung mailToSelection geändert werden.

Automatische E-Mails werden in mehreren bestimmten Situationen versendet, z. B. wenn sich der zugewiesene Bearbeiter eines Vorgangs ändert oder ein Fehler auftritt. Der E-Mail-Text wird einem technischen Template entnommen. Zusätzlich können Sie automatische E-Mails definieren, die in Workflow-Aktivitäten, oder Kontakt- oder Ressourcenaktionen gesendet werden. Solche E-Mails basieren normalerweise auf einer Textvorlage.

Technische Definitionen:

  • E-Mail-Konto: Information für den Zugriff auf ein Postfach auf einem E-Mail-Server; besteht normalerweise auf dem Hostnamen, Port, Benutzernamen und Passwort
  • E-Mail-Adresse: Identifikation zum Senden und Empfangen von E-Mails mit einem E-Mail-Konto. Ein E-Mail-Konto kann mehrere E-Mail-Adressen haben.
  • E-Mail-Server: Software, die E-Mail-Nachrichten zwischen Clients überträgt. Nicht Teil von ConSol CM.

Verfügbare Einstellungen​

Einstellungen für die eingehende E-Mail-Konten​

ConSol CM kann E-Mail von mehreren Konten abrufen und verhält sich dabei so, wie ein normaler E-Mail-Client. Die Konten für eingehende E-Mails werden im Tab Konten der Seite E-Mail-Konfiguration konfiguriert. Die Konfiguration wird in den System-Properties des Moduls cmas-nimh gespeichert. Es sind folgende Einstellungen verfügbar:

  • Name: Optional. Der Name des Kontos zur Verwendung in ConSol CM.

    Best practice

    Referenzieren Sie das Konto in E-Mail-Skripten immer über seinen Namen. Nutzen Sie dazu nicht die Kontonummer, d.h. die Nummer in den System-Properties des Kontos, da sich diese Nummer ändern kann, wenn Konten hinzugefügt oder entfernt werden.

  • Protokoll: Pflichtangabe. Das Protokoll, über das E-Mails vom E-Mail-Server abgerufen werden. Die unterstützten Protokolle sind IMAP, IMAPs, POP3 und POP3s.

    info

    Wenn ein sicheres Protokoll verwendet wird, muss das entsprechende Zertifikat im Security Store des Applikationsservers gespeichert werden.

  • Host: Pflichtangabe. Der Hostname oder die IP-Adresse des E-Mail-Servers.

  • Port: Optional. Der Port, über den E-Mails vom E-Mail-Server abgerufen werden. Er hängt vom eingesetzten Protokoll ab. Wenn Sie keinen Port angeben, wird der Standardport verwendet (siehe Watermark).

  • Authentifizierungsmethode: Pflichtangabe. Wählen Sie Basic oder OAuth 2.0.

    Für Basic-Authentifizierung müssen Sie folgende Einstellungen angeben:

    • Benutzername: Pflichtangabe. Der Name des E-Mail-Kontos.
    • Passwort: Pflichtangabe. Das Passwort des E-Mail-Kontos. Details zu den unterstützten Zeichen finden Sie in Unterstützte Zeichen für Passwörter in ConSol CM.

    Für OAuth 2.0-Authentifizierung müssen Sie folgende Einstellungen angeben:

    • Benutzername: Pflichtangabe. Der Name des Principals.
    • Client-ID: Pflichtangabe. Die Applikations-ID aus der Registrierung der ConSol CM-Applikation.
    • Client-Secret: Pflichtangabe. Der Secret-Wert aus der Registrierung der ConSol CM-Applikation.
    • Client-Autorität: Pflichtangabe. Die Login-URL mit der Tenant-ID aus der Registrierung der ConSol CM-Applikation, z. B. https://login.microsoftonline.com/1234567890
    • Bereich: Pflichtangabe. Der Bereich, z. B. https://outlook.office365.com/.default
    info

    OAuth 2.0 wird nur mit dem IMAPS-Protokoll unterstützt.

  • Gelesene Nachrichten löschen: Optional. Legt fest, ob die Nachrichten nach dem Abrufen automatisch vom E-Mail-Server gelöscht werden sollen. Gilt nur für die Protokolle IMAP und IMAPS. Bei den Protokollen POP3 und POP3S werden gelesene Nachrichten immer gelöscht. Wählen Sie Globale Konfiguration verwenden, um die Standardeinstellung aus dem Tab Einstellungen zu verwenden, Property mailbox.default.task.delete.read.messages.

  • Konto debuggen: Optional. Legt fest, um Low-Level-Informationen über den E-Mail-Abruf in die Log-Dateien geschrieben werden sollen. Wählen Sie Globale Konfiguration verwenden, um die Standardeinstellung aus dem Tab Einstellungen zu verwenden, Property mailbox.{number}.session.mail.debug.

Einstellungen für die ausgehende E-Mail-Verbindung​

ConSol CM kann E-Mails über ein Konto senden und verhält sich dabei so, wie ein normaler E-Mail-Client. Das Konto für ausgehende E-Mails wird im Tab Einstellungen der Seite E-Mail-Konfiguration konfiguriert. Die Konfiguration wird in System-Properties des Moduls cmas-core-server gespeichert. Es sind folgende Einstellungen verfügbar:

  • Protokoll: Pflichtangabe. Das Protokoll, über das E-Mails gesendet werden. Die unterstützten Protokolle sind SMTP und SMTP mit STARTTLS (setzt mail.smtp.tls.enabled auf true).

    info

    Wenn ein sicheres Protokoll verwendet wird, muss das entsprechende Zertifikat im Security Store des Applikationsservers gespeichert werden.

  • Host: Pflichtangabe. Der Hostname oder die IP-Adresse des E-Mail-Servers.

  • Port: Pflichtangabe. Der Port, über den E-Mails gesendet werden. Er hängt vom eingesetzten Protokoll ab. Wenn Sie keinen Port angeben, wird der Standardport verwendet (siehe Watermark).

  • Authentifizierungsmethode: Pflichtangabe. Wählen Sie Basic oder OAuth 2.0.

    Für Basic-Authentifizierung müssen Sie folgende Einstellungen angeben:

    • Benutzername: Pflichtangabe. Der Name des E-Mail-Kontos.
    • Passwort: Pflichtangabe. Das Passwort des E-Mail-Kontos. Details zu den unterstützten Zeichen finden Sie in Unterstützte Zeichen für Passwörter in ConSol CM.

    Für OAuth 2.0-Authentifizierung müssen Sie folgende Einstellungen angeben:

    • Benutzername: Pflichtangabe. Der Name des Principals.
    • Client-ID: Pflichtangabe. Die Applikations-ID aus der Registrierung der ConSol CM-Applikation.
    • Client-Secret: Pflichtangabe. Der Secret-Wert aus der Registrierung der ConSol CM-Applikation.
    • Client-Autorität: Pflichtangabe. Die Login-URL mit der Tenant-ID aus der Registrierung der ConSol CM-Applikation, z. B. https://login.microsoftonline.com/1234567890
    • Bereich: Pflichtangabe. Der Bereich, z. B. https://outlook.office365.com/.default

  • Timeout zum Verbinden mit dem SMTP-Server (in Millisekunden): Definiert, wie lange ConSol CM auf die Verbindung zum SMTP-Server wartet.

  • Timeout zum Senden einer E-Mail (in Millisekunden): Definiert, wie lange ConSol CM nach dem Senden einer E-Mail auf die Antwort vom SMTP-Server wartet.

Globale Konfiguration​

Die globale Konfiguration gilt für alle E-Mail-Konten. Die folgenden Einstellungen sind im Tab Einstellungen der Seite E-Mail-Konfiguration verfügbar:

  • Muster für den Betreff eingehender E-Mails: Pflichtangabe. Regulärer Ausdruck, der den Betreff von eingehenden E-Mails definiert, der notwendig ist, damit die E-Mail dem richtigen Vorgang zugeordnet werden kann.
  • Vorlage für den Betreff ausgehender E-Mails: Pflichtangabe. Vorlage für das Muster, das zum Erzeugen des Betreffs von ausgehenden E-Mails verwendet wird. Die Vorlage muss zum Muster für den Betreff eingehender E-Mails passen, damit die Antworten auf vom System gesendete E-Mails dem richtigen Vorgang zugeordnet werden können. Dies wird beim Speichern der Einstellungen in diesem Tab überprüft.
  • Anzahl der erneuten Versuche beim Abrufen von E-Mails: Pflichtangabe. Legt die maximale Anzahl der erneuten Versuche nach einem Fehler beim Abrufen der E-Mails fest.
  • Gelesene Nachrichten löschen: Optional. Legt fest, ob die Nachrichten nach dem Abrufen automatisch vom E-Mail-Server gelöscht werden sollen. Gilt nur für die Protokolle IMAP und IMAPS. Bei den Protokollen POP3 und POP3S werden gelesene Nachrichten immer gelöscht. Gilt für alle Konten, für die keine kontospezifische Property gesetzt ist. Property mailbox.default.task.delete.read.messages.
  • Konten debuggen: Optional. Legt fest, um Low-Level-Informationen über den E-Mail-Abruf in die Log-Dateien geschrieben werden sollen. Gilt für alle Konten, für die keine kontospezifische Property gesetzt ist. Property mailbox.{number}.session.mail.debug.

Adressen​

ConSol CM hat mehrere System-Properties zum Verwalten der E-Mail-Adressen, die für Systembenachrichtigungen verwendet werden. Die E-Mail-Adressen können im Tab Adressen der Seite E-Mail-Konfiguration verwaltet werden. Diese enthält eine Liste der System-Properties mit einer kurzen Beschreibung ihrer Verwendung.

Es sind folgende System-Properties verfügbar:

  • cmas-core-security, admin.email: Definiert die E-Mail-Adresse des ConSol CM-Administrators. Anfänglich wird hier der Wert genommen, der bei der Systemeinrichtung eingegeben wurde.
  • cmweb-server-adapter, mail.from: Definiert die globale From-Adresse (Absender) für E-Mail-Kommunikation. Der hier gesetzte Wert erscheint als Absender in E-Mails, die aus ConSol CM gesendet werden.
  • cmweb-server-adapter, mail.reply.to: Definiert die globale Reply-To-Adresse für E-Mail-Kommunikation. Der hier gesetzte Wert erscheint als Reply-To-Header in E-Mails, die aus ConSol CM gesendet werden.
  • cmas-nimh-extension, mail.error.from.address: Definiert die From-Adresse für Fehlerbenachrichtigungs-E-Mails, die gesendet werden, wenn die E-Mail-Verarbeitung fehlschlägt.
  • cmas-nimh-extension, mail.error.to.address: Definiert die To-Adresse für Fehlerbenachrichtigungs-E-Mails, die gesendet werden, wenn die E-Mail-Verarbeitung fehlschlägt. Wenn nicht gesetzt, wird der Wert der Property admin.email verwendet.
  • cmas-core-security, password.reset.mail.from: Definiert die From-Adresse (Absender) von E-Mails zum Zurücksetzen des Passworts. Wenn nicht gesetzt, wird stattdessen der Wert der Property admin.email verwendet.
  • cmas-core-server, mail.notification.sender: Definiert die From-Adresse (Absender) für Benachrichtigungs-E-Mails, die verschickt werden, wenn der Bearbeiter eines Vorgangs wechselt. Wenn nicht gesetzt, wird der Wert des :from Tags aus dem Benachrichtigungs-Template verwendet. Ist dieses ebenfalls nicht gesetzt, wird stattdessen der Wert der Property mail.from verwendet.
  • cmas-core-server, mail.smtp.envelopesender: Definiert die E-Mail-Adresse, die als Absender im SMTP-Envelope benutzt wird. Wenn nicht gesetzt, wird die From-Adresse der E-Mail benutzt.
  • cmas-nimh-extension, mail.attachments.validation.info.sender: Definiert die From-Adresse für Fehlerbenachrichtigungs-E-Mails, die an den Absender der abgelehnten Nachricht gesendet werden, wenn die Validierung des Attachment-Typs fehlschlägt. Wenn diese Property nicht gesetzt ist, wird die in mail.from festgelegte E-Mail-Adresse verwendet. Die Property wird nur verwendet, wenn mail.attachments.validation.handling auf reject_email gesetzt ist.
  • cmas-workflow-engine, jobExecutor.adminMail: Definiert die E-Mail-Adresse, an die Benachrichtigungs-E-Mails, die Probleme der Jobausführung betreffen, geschickt werden (wenn die Anzahl der Neuversuche überschritten wurde).
  • cmas-workflow-engine, jobExecutor.mailFrom: Definiert die E-Mail-Adresse, die bei Fehlern bei der Job-Ausführung als From-Header für Benachrichtigungen an den Administrator gesetzt wird.
  • cmas-dwh-server, notification.error.to: Definiert die To-Adresse für E-Mails mit Fehlermeldungen des DWH.
  • cmas-dwh-server, notification.error.from: Definiert die From-Adresse für E-Mails mit Fehlermeldungen des DWH.
  • cmas-dwh-server, notification.finished_successfully.to: Definiert die To-Adresse für E-Mails des DWHs, wenn eine Übertragung erfolgreich beendet wird.
  • cmas-dwh-server, notification.finished_successfully.from: Definiert die From-Adresse für E-Mails des DWHs, wenn eine Übertragung erfolgreich beendet wird.
  • cmas-core-server, task.execution.notification.mail.from: Definiert die E-Mail-Adresse, die bei Fehlern bei der Task-Ausführung als From-Header für Benachrichtigungen an den Administrator gesetzt wird.

Grundlegende Aufgaben​

Sie können folgende grundlegende Aufgaben auf der Seite E-Mail-Konfiguration durchführen:

  • Eingehendes E-Mail-Konto hinzufügen: Im Tab Konten können Sie ein neues Konto hinzufügen, von dem ConSol CM E-Mail abrufen soll. Klicken Sie auf den Button Neues Konto und füllen Sie die Verbindungsdaten aus, siehe Einstellungen für die eingehende E-Mail-Konten. ConSol CM kann E-Mails von mehreren Konten abrufen.
  • Kontospezifische Einstellungen eines eingehenden E-Mail-Kontos ändern: Im Tab Konten können Sie ein eingehendes E-Mail-Konto ändern. Klicken Sie auf das Konto und füllen Sie die Verbindungsdaten aus, siehe Einstellungen für die eingehende E-Mail-Konten. Diese Einstellungen werden in die kontospezifischen System-Properties geschrieben.
  • Eingehendes E-Mail-Konto deaktivieren: Im Tab Konten können Sie ein eingehendes E-Mail-Konto deaktivieren, indem Sie in den Kontodetails auf das Icon Deaktivieren klicken. Damit wir der Abruf von E-Mails von dem Konto unterbrochen und die System-Property cmas-nimh, mailbox.{name}.task.enabled wird auf false gesetzt. Sie können den Abruf wieder starten, d. h. die Property auf true setzen, indem Sie auf das Icon Aktivieren klicken.
  • Konto für ausgehende E-Mail angeben: Im Tab Einstellungen können Sie das Konto für ausgehende E-Mails angeben, mit dem ConSol CM E-Mails versendet. Füllen Sie die erforderlichen Daten im Abschnitt Ausgehende E-Mail-Verbindung aus, siehe Einstellungen für die ausgehende E-Mail-Verbindung. ConSol CM kann E-Mails von einem Konto senden. Die From- und Reply-to-Adressen können jedoch nach Bedarf geändert werden, siehe Adressen.
  • Verbindung zu E-Mail-Konten testen: Sie können die Verbindung zu den E-Mail-Konten testen, indem Sie auf den Button Verbindung testen klicken (für eingehende Verbindungen im Tab Konten und für ausgehende Verbindungen im Tab Einstellungen). Wenn die Verbindung fehlschlägt, wird die technische Fehlermeldung aus dem E-Mail-Subsystem angezeigt. Wenn ausgehende E-Mails auf dem System abgefangen werden, weil der Wert von mailSender.testArchive.flavour das Flavour des Systems (Property system.flavour) enthält, wird beim Testen der SMTP-Verbindung eine entsprechende Meldung angezeigt.
Best Practice

Es wird empfohlen, einen Namen für jedes eingehende E-Mail-Konto einzugeben und diesen Namen in Skripten zu verwenden. Nutzen Sie dazu nicht die Kontonummer, d.h. die Nummer in den System-Properties des Kontos, da sich diese Nummer ändern kann, wenn Konten hinzugefügt oder entfernt werden.

Erweiterte Aufgaben​

Sie können folgende erweiterte Aufgaben auf der Seite E-Mail-Konfiguration durchführen:

  • Muster für den Vorgangsbetreff ändern: Sie können das Muster für den Betreff eingehender E-Mails im Tab Einstellungen ändern, siehe Globale Konfiguration. Das Muster muss zur Vorlage für den Betreff ausgehender E-Mails passen, damit Antworten auf aus dem System gesendete E-Mails dem richtigen Vorgang zugeordnet werden können. Dies wird beim Speichern der Einstellungen in diesem Tab geprüft.
  • Globale Einstellungen für eingehende E-Mail-Konten ändern: Sie können globale Einstellungen, die für alle eingehenden E-Mail-Konten gelten, im Abschnitt Globale Konfiguration des Tabs Einstellungen ändern, siehe Globale Konfiguration. Diese Einstellungen werden in die Standard-System-Properties geschrieben.
  • E-Mail-Adressen für Systembenachrichtigungen prüfen: Im Tab Adressen können Sie nachschauen, welche E-Mail-Adressen als Empfänger (To-Adressen), Absender (From-Adressen) und Reply-To-Adressen für von ConSol CM gesendete Benachrichtigungen verwendet werden, siehe Adressen.

Technischer Hintergrund von E-Mails​

Das E-Mail-Subsystem heißt NIMH. Es wird als Service ausgeführt, siehe Services. ConSol CM funktioniert gegenüber dem E-Mail-Server, von dem E-Mail abgerufen werden, wie ein normaler E-Mail-Client, der POP, POPs, IMAP oder IMAPs verwendet. Es können E-Mails aus einem oder mehreren Postfächern abgerufen werden. Ein Postfach kann mehrere E-Mail-Adressen haben. Die E-Mails werden zuerst in der Datenbank gespeichert und dann mit den E-Mail-Skripten verarbeitet, siehe E-Mail-Skripte für eingehende E-Mails. E-Mails, die nicht verarbeitet werden können, werden in einer eigenen Datenbanktabelle gespeichert. Die Verarbeitung kann auf der Seite Fehler bei eingehenden E-Mails erneut versucht werden.

info

ConSol CM kann nur E-Mails aus echten Postfächer abrufen. Öffentliche Ordner (z. B. auf Microsoft Exchange Server) werden nicht unterstützt.

ConSol CM sendet E-Mails von einem E-Mail-Konto. Es können jedoch spezifische From- und Reply-To-Adressen gesetzt werden, siehe Adressen. Ausgehende E-Mails werden normalerweise vor dem Senden von einem E-Mail-Skript verarbeitet, siehe E-Mail-Skripte für ausgehende E-Mails.