Konfigurieren von E-Mail-Benachrichtigungen

AEM sendet E-Mail-Benachrichtigungen an Benutzer, die:

• Seitenereignisse wie Änderungen oder Replikationen abonniert haben. Im Abschnitt Benachrichtigungs-Posteingang ist beschrieben, wie solche Ereignisse abonniert werden können.

• Forenereignisse abonniert haben.

• einen Schritt innerhalb eines Workflows durchführen müssen. Im Abschnitt Teilnehmer-Schritt ist beschreiben, wie E-Mail-Benachrichtigungen in einem Workflow ausgelöst werden können.

Voraussetzungen:

• Benutzer müssen über eine in ihrem Profil festgelegte, gültige E-Mail-Adresse verfügen.
• Der Day CQ Mail Service muss ordnungsgemäß konfiguriert sein.

Wenn ein Benutzer benachrichtigt wird, erhält er eine E-Mail in der Sprache, die in seinem Profil festgelegt ist. Jede Sprache verfügt über eine eigene, anpassbare Vorlage. Für neue Sprachen können neue E-Mail-Vorlagen hinzugefügt werden.

Konfigurieren des E-Mail-Diensts

Damit AEM E-Mails versenden kann, muss der Day CQ Mail Service ordnungsgemäß konfiguriert sein. Sie können die Konfiguration in der Web-Konsole anzeigen. Bei der Verwendung von AEM gibt es mehrere Methoden zur Verwaltung der Konfigurationseinstellungen für solche Services. Weitere Informationen und empfohlene Praktiken finden Sie unter Konfigurieren von OSGi.

Es gelten die folgenden Beschränkungen:

• Der SMTP-Server-Port muss 25 oder höher sein.

• Der SMTP-Server-Hostname darf nicht leer sein.

• Die „Von“-Adresse darf nicht leer sein.

Zum Debuggen eines Problems mit dem Day CQ Mail Service können Sie die Protokolle des Dienstes betrachten:

com.day.cq.mailer.DefaultMailService

Die Konfiguration sieht in der Web-Konsole wie folgt aus:

Konfigurieren des E-Mail-Benachrichtigungskanals

Wenn Sie entweder Benachrichtigungen zu Seiten- oder Forenereignissen abonniert haben, ist die „Von“-E-Mail-Adresse standardmäßig auf no-reply@acme.com eingestellt. Sie können diesen Wert durch die Konfiguration des Diensts Benachrichtigungs-E-Mail-Kanal in der Web-Konsole ändern.

Fügen Sie zum Konfigurieren der „Von“-E-Mail-Adresse einen sling:OsgiConfig-Knoten zum Repository hinzu. Verwenden Sie das folgende Verfahren, um den Knoten direkt mithilfe von CRXDE Lite hinzuzufügen:

1. Fügen Sie in CRXDE Lite einen Ordner mit dem Namen config unter Ihrem Programmordner hinzu.

2. Fügen Sie im Konfigurationsordner einen Knoten mit folgendem Namen hinzu:

   com.day.cq.wcm.notification.email.impl.EmailChannel vom Typ sling:OsgiConfig

3. Fügen Sie eine String-Eigenschaft zum Knoten mit dem Namen email.from hinzu. Legen Sie zu dem Wert die E-Mail-Adresse fest, die Sie verwenden möchten.

4. Klicken Sie auf Alle speichern.

Gehen Sie wie folgt vor, um den Knoten in den Inhaltspaketen Ihrer Quellordner festzulegen:

1. Erstellen Sie in jcr_root/apps/*app_name*/config folder eine Datei mit dem Namen com.day.cq.wcm.notification.email.impl.EmailChannel.xml.

2. Fügen Sie die folgende XML für den Knoten hinzu:

   <?xml version="1.0" encoding="UTF-8"?> <jcr:root xmlns:sling="https://sling.apache.org/jcr/sling/1.0" xmlns:jcr="https://www.jcp.org/jcr/1.0" jcr:primaryType="sling:OsgiConfig" email.from="name@server.com"/>

3. Ersetzen Sie den Wert des Attributs email.from (name@server.com) durch Ihre E-Mail-Adresse.

4. Speichern Sie die Datei.

Konfigurieren des Workflow-E-Mail-Benachrichtigungsdiensts

Wenn Sie Workflow-E-Mail-Benachrichtigungen erhalten, sind beide „Von“-E-Mail-Adressen und das Host-URL-Präfix auf Standardwerte eingestellt. Sie können diese Werte ändern, indem Sie den Day CQ Workflow Email Notification Service in der Web-Konsole konfigurieren. Wenn Sie dies tun, wird empfohlen, die Änderung im Repository beizubehalten.

Die Standardkonfiguration sieht in der Web-Konsole wie folgt aus:

E-Mail-Vorlagen für die Seitenbenachrichtigung

E-Mail-Vorlagen für die Seitenbenachrichtigungen sind zu finden unter:

/libs/settings/notification-templates/com.day.cq.wcm.core.page

Die standardmäßige englische Vorlage (en.txt) wird wie folgt definiert:

subject=[CQ Page Event Notification]: Page Event

header=-------------------------------------------------------------------------------------\n \
Time: ${time}\n \
User: ${userFullName} (${userId})\n \
-------------------------------------------------------------------------------------\n\n

message=The following pages were affected by the event: \n \
 \n \
${modifications} \n \
 \n\n
footer=\n \
-------------------------------------------------------------------------------------\n \
This is an automatically generated message. Please do not reply.

Anpassen von E-Mail-Vorlagen für die Seitenbenachrichtigung

Die englische E-Mail-Vorlage für die Seitenbenachrichtigung können Sie wie folgt anpassen:

1. Öffnen Sie in CRXDE die Datei:

   /libs/settings/notification-templates/com.day.cq.wcm.core.page/en.txt

2. Passen Sie die Datei an Ihre Anforderungen an.

3. Speichern Sie die Änderungen.

Die Vorlage muss folgendes Format aufweisen:

 subject=<text_1>
 header=<text_2>
 message=<text_3>
 footer=<text_4>

Dabei kann <text_x> ein Mix von statischem Text und dynamischen Zeichenfolgenvariablen sein. Die folgenden Variablen können innerhalb der E-Mail-Vorlage für Seitenbenachrichtigungen verwendet werden:

• ${time}, Ereignisdatum und -uhrzeit

• ${userFullName}, der vollständige Name des Benutzers, der das Ereignis ausgelöst hat

• ${userId}, die ID des Benutzers, der das Ereignis ausgelöst hat

• ${modifications}, beschreibt den Typ des Seitenereignisses und den Seitenpfad im folgenden Format:

  <Seitenereignistyp> => <Seitenpfad>

  Beispiel:

  PageModified => /content/geometrixx/en/products

E-Mail-Vorlagen für die Forumsbenachrichtigung

E-Mail-Vorlagen für die Forumsbenachrichtigungen sind zu finden unter:

/etc/notification/email/default/com.day.cq.collab.forum

Die standardmäßige englische Vorlage (en.txt) wird wie folgt definiert:

subject=[CQ Forum Notification]

header=-------------------------------------------------------------------------------------\n \
Time: Time: ${time}\n \
Forum Page Path: ${forum.path}\n \
-------------------------------------------------------------------------------------\n\n

message=Page: ${host.prefix}${forum.path}.html\n

footer=\n \
-------------------------------------------------------------------------------------\n \
This is an automatically generated message. Please do not reply.

Anpassen von E-Mail-Vorlagen für die Forumsbenachrichtigung

Die englische E-Mail-Vorlage für die Forumsbenachrichtigung können Sie wie folgt anpassen:

1. Öffnen Sie in CRXDE die Datei:

   /etc/notification/email/default/com.day.cq.collab.forum/en.txt

2. Passen Sie die Datei an Ihre Anforderungen an.

3. Speichern Sie die Änderungen.

Die Vorlage muss folgendes Format aufweisen:

 subject=<text_1>
 header=<text_2>
 message=<text_3>
 footer=<text_4>

Dabei kann <text_x> ein Mix von statischem Text und dynamischen Zeichenfolgenvariablen sein.

Die folgenden Variablen können innerhalb der E-Mail-Vorlage für Forumsbenachrichtigungen verwendet werden:

• ${time}, Ereignisdatum und -uhrzeit

• ${forum.path}, der Pfad zur Forumsseite.

E-Mail-Vorlagen für die Workflow-Benachrichtigung

Die (englische) Vorlage für die Workflow-Benachrichtigungen befindet sich unter:

/libs/settings/workflow/notification/email/default/en.txt

Sie wird wie folgt definiert:

subject=Workflow notification: ${event.EventType}

header=-------------------------------------------------------------------------------------\n \
Time: ${event.TimeStamp}\n \
Step: ${item.node.title}\n \
User: ${participant.name} (${participant.id})\n \
Workflow: ${model.title}\n \
-------------------------------------------------------------------------------------\n\n

message=Content: ${host.prefix}${payload.path.open}\n

footer=\n \
-------------------------------------------------------------------------------------\n \
View the overview in your ${host.prefix}/aem/inbox\n \
-------------------------------------------------------------------------------------\n \
This is an automatically generated message. Please do not reply.

Anpassen von E-Mail-Vorlagen für die Workflow-Benachrichtigung

Die englische E-Mail-Vorlage für die Benachrichtigung über ein Workflow-Ereignis können Sie wie folgt anpassen:

1. Öffnen Sie in CRXDE die Datei:

   /libs/settings/workflow/notification/email/default/en.txt

2. Passen Sie die Datei an Ihre Anforderungen an.

3. Speichern Sie die Änderungen.

Die Vorlage muss folgendes Format aufweisen:

subject=<text_1>
 header=<text_2>
 message=<text_3>
 footer=<text_4>

Die Methode ${payload.path.open} legt den Pfad zur Payload des Arbeitselements offen. Bei einer Seite in Sites würde payload.path.open dann /bin/wcmcommand?cmd=open&path=…ähneln, das den Server-Namen nicht enthält. Aus diesem Grund stellt die Vorlage diesem ${host.prefix} voran.

Die folgenden Variablen können innerhalb der E-Mail-Vorlage verwendet werden:

• ${event.EventType}, Ereignistyp

• ${event.TimeStamp}, Datum und Uhrzeit des Ereignisses

• ${event.User}, der Benutzer, der das Ereignis ausgelöst hat

• ${initiator.home}, der Knotenpfad des Initiators

• ${initiator.name}, der Name des Initiators

• ${initiator.email}, die E-Mail-Adresse des Initiators

• ${item.id}, die ID des Arbeitselements

• ${item.node.id}, die ID des Knotens innerhalb des Workflow-Modells, das mit diesem Arbeitselement verknüpft ist

• ${item.node.title}, der Titel des Arbeitselements

• ${participant.email}, die E-Mail-Adresse des Teilnehmers

• ${participant.name}, der Vorname des Teilnehmers

• ${participant.familyName}, der Familienname des Teilnehmers

• ${participant.id}, die ID des Teilnehmers

• ${participant.language}, die Sprache des Teilnehmers

• ${instance.id}, die ID des Workflows

• ${instance.state}, der Status des Workflows

• ${model.title}, der Titel des Workflow-Modells

• ${model.id}, die ID des Workflow-Modells

• ${model.version}, die Version des Workflow-Modells

• ${payload.data}, die Payload

• ${payload.type}, der Typ der Payload

• ${payload.path}, der Pfad der Payload

• ${host.prefix}, das Host-Präfix, z. B. http://localhost:4502

Hinzufügen einer E-Mail-Vorlage in einer neuen Sprache

Sie können wie folgt eine Vorlage in einer neuen Sprache hinzufügen:

1. Fügen Sie in CRXDE eine Datei <language-code>.txt hinzu unter:

   • /libs/settings/notification-templates/com.day.cq.wcm.core.page: für Seitenbenachrichtigungen
   • /etc/notification/email/default/com.day.cq.collab.forum: für Forumsbenachrichtigungen
   • /libs/settings/workflow/notification/email/default: für Workflow-Benachrichtigungen

2. Passen Sie die Datei an die Sprache an.

3. Speichern Sie die Änderungen.

Konfigurieren von E-Mail-Benachrichtigungen für AEM Assets

Wenn Sammlungen in AEM Assets freigegeben werden oder ihre Freigabe aufgehoben wird, können Benutzer E-Mail-Benachrichtigungen von AEM erhalten. Um E-Mail-Benachrichtigungen zu konfigurieren, führen Sie diese Schritte aus.

1. Konfigurieren Sie den E-Mail-Dienst, wie oben unter Konfigurieren des E-Mail-Diensts beschrieben.
2. Melden Sie sich in AEM als Admin an. Klicken Sie auf Tools > Vorgänge > Web-Konsole, um die Konfiguration der Web-Konsole zu öffnen.
3. Bearbeiten Sie das Day CQ DAM-Ressourcensammlungs-Servlet. Wählen Sie E-Mail senden. Klicken Sie auf Speichern.

Einrichten von OAuth

AEM bietet OAuth2-Unterstützung für seinen integrierten E-Mail-Service, um Unternehmen die Einhaltung von E-Mail-Sicherheitsanforderungen zu ermöglichen.

Sie können OAuth für mehrere E-Mail-Anbieter konfigurieren, wie unten beschrieben.

Gmail

1. Erstellen Sie Ihr Projekt unter https://console.developers.google.com/projectcreate.
2. Wählen Sie Ihr Projekt aus und gehen Sie dann zu APIs und Dienste – Dashboard – Anmeldedaten.
3. Konfigurieren Sie den OAuth-Einverständnisbildschirm entsprechend Ihren Anforderungen.
4. Fügen Sie auf dem folgenden Aktualisierungsbildschirm diese beiden Bereiche hinzu:
   • https://mail.google.com/
   • https://www.googleapis.com//auth/gmail.send
5. Nachdem Sie die Bereiche hinzugefügt haben, gehen Sie zurück zu Anmeldedaten im Menü links und dann zu Erstellen von Anmeldedaten > OAuth-Client-ID > Desktop-Programm.
6. Daraufhin wird ein neues Fenster mit der Client-ID und dem Client-Geheimnis geöffnet.
7. Speichern Sie diese Anmeldedaten.

AEM-Seitenkonfigurationen

Konfigurieren Sie zunächst den E-Mail-Dienst:

1. Öffnen Sie die AEM-Web-Konsole, indem Sie zu http://serveraddress:serverport/system/console/configMgr gehen.
2. Suchen Sie nach Day CQ Mail Service und klicken Sie darauf.
3. Fügen Sie die folgenden Einstellungen hinzu:
   • SMTP-Server-Host-Name: smtp.gmail.com
   • SMTP-Server-Port: 25 oder 587, abhängig von den Anforderungen
   • Markieren Sie die Kontrollkästchen für SMPT verwendet StarTLS und SMTP erfordert StarTLS.
   • Markieren Sie OAuth-Fluss und klicken Sie auf Speichern.

Konfigurieren Sie anschließend Ihren SMTP-OAuth-Provider wie unten beschrieben:

1. Öffnen Sie die AEM-Web-Konsole, indem Sie zu http://serveraddress:serverport/system/console/configMgr gehen.
2. Suchen Sie nach CQ Mailer SMTP OAuth2 Provider und klicken Sie darauf.
3. Füllen Sie die erforderlichen Informationen wie folgt aus:
   • Autorisierungs-URL: https://accounts.google.com/o/oauth2/auth
   • Token-URL: https://accounts.google.com/o/oauth2/token
   • Bereiche: https://www.googleapis.com/auth/gmail.send und https://mail.google.com/. Sie können mehrere Bereiche hinzufügen, indem Sie auf die Schaltfläche + rechts von jedem konfigurierten Bereich klicken.
   • Client-ID und Client-Geheimnis: Konfigurieren Sie diese Felder mit den Werten, die Sie wie im obigen Absatz beschrieben abgerufen haben.
   • URL für aktualisierten Token: https://accounts.google.com/o/oauth2/token
   • Token-Ablauf aktualisieren: nie
4. Klicken Sie auf Speichern.

Nach der Konfiguration sollten die Einstellungen wie folgt aussehen:

Aktivieren Sie jetzt die OAuth-Komponenten. Gehen Sie dazu wie folgt vor:

1. Rufen Sie die Komponentenkonsole auf, indem Sie diese URL aufrufen: http://serveraddress:serverport/system/console/components

2. Suchen Sie nach den folgenden Komponenten.

   • com.day.cq.mailer.oauth.servlets.handler.OAuthCodeGenerateServlet
   • com.day.cq.mailer.oauth.servlets.handler.OAuthCodeAccessTokenGenerator

3. Klicken Sie links neben den Komponenten auf das Wiedergabesymbol.

   

Bestätigen Sie abschließend die Konfiguration, indem Sie:

1. zur Adresse der Veröffentlichungsinstanz wechseln und sich als Admin anmelden
2. eine neue Registerkarte im Browser öffnen und zu http://serveraddress:serverport/services/mailer/oauth2/authorize navigieren. Dadurch werden Sie zur Seite Ihres SMTP-Anbieters weitergeleitet, in diesem Fall Gmail.
3. Anmelden und Einverständnis zur Erteilung der erforderlichen Berechtigungen
4. Nach der Zustimmung wird das Token im Repository gespeichert. Sie können es unter accessToken aufrufen, indem Sie direkt auf diese URL auf Ihrer Veröffentlichungsinstanz zugreifen: http://serveraddress:serverport/crx/de/index.jsp#/conf/global/settings/mailer/oauth
5. Wiederholen Sie die obigen Schritte für jede Veröffentlichungsinstanz

Microsoft Outlook

1. Gehen Sie zu https://portal.azure.com/ und melden Sie sich an.

2. Suchen Sie in der Suchleiste nach Azure Active Directory und klicken Sie auf das Ergebnis. Alternativ können Sie direkt zu https://portal.azure.com/#blade/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/Overview gehen.

3. Klicken Sie auf Registrierung einer Anwendung – Neue Registrierung

   

4. Füllen Sie die Informationen entsprechend Ihren Anforderungen aus und klicken Sie dann auf Registrieren

5. Wechseln Sie zur neu erstellten Anwendung und wählen Sie API-Berechtigungen aus.

6. Gehen Sie zu Berechtigung hinzufügen – Diagrammberechtigungen – Zugewiesene Berechtigungen.

7. Wählen Sie die folgenden Berechtigungen für Ihre Anwendung aus und klicken Sie dann auf Berechtigung hinzufügen:

   • SMTP.Send
   • Mail.Read
   • Mail.Send
   • openid
   • offline_access

8. Gehen Sie zu Authentifizierung > Plattform hinzufügen > Web und fügen Sie im Abschnitt Umleitungs-URLs die folgende URL für die Umleitung des OAuth-Codes hinzu und klicken Sie dann auf Konfigurieren:

   • http://localhost:4503/services/mailer/oauth2/token

9. Wiederholen Sie die obigen Schritte für jede Veröffentlichungsinstanz

10. Konfigurieren Sie die Einstellungen entsprechend Ihren Anforderungen.

11. Gehen Sie dann zu Zertifikate und Geheimnisse, klicken Sie auf Neues Client-Geheimnis und führen Sie die Schritte auf dem Bildschirm aus, um ein Geheimnis zu erstellen. Notieren Sie sich dieses Geheimnis für die spätere Verwendung.

12. Klicken Sie auf Überblick im linken Bereich und kopieren Sie die Werte für Anwendungs (Client) ID und Directory (Mandant) ID zur späteren Verwendung.

Zusammenfassend benötigen Sie die folgenden Informationen, um OAuth2 für den E-Mail-Service auf der AEM-Seite zu konfigurieren:

• Die Auth-URL, die mit der Mandanten-ID erstellt wird. Sie hat folgendes Format: https://login.microsoftonline.com/<tenantID>/oauth2/v2.0/authorize
• Die Token-URL, die mit der Mandanten-ID erstellt wird. Sie hat folgendes Format: https://login.microsoftonline.com/<tenantID>/oauth2/v2.0/token
• Die Aktualisierungs-URL, die mit der Mandanten-ID erstellt wird. Sie hat folgendes Format: https://login.microsoftonline.com/<tenantID>/oauth2/v2.0/token
• Die Client-ID
• Das Client-Geheimnis

AEM-Seitenkonfigurationen

Integrieren Sie anschließend Ihre OAuth2-Einstellungen mit AEM:

1. Gehen Sie zur Web-Konsole Ihrer lokalen Instanz, indem Sie zu http://serveraddress:serverport/system/console/configMgr navigieren.
2. Suchen Sie nach Day CQ Mail Service und klicken Sie darauf.
3. Fügen Sie die folgenden Einstellungen hinzu:
   • SMTP-Server-Host-Name: smtp.office365.com
   • SMTP-Benutzer: Ihr Benutzername im E-Mail-Format
   • „Von“-Adresse: Die E-Mail-Adresse, die im Feld „Von“ von Nachrichten verwendet werden soll, die vom E-Mail-Service versendet werden
   • SMTP-Server-Port: 25 oder 587, je nach den Anforderungen
   • Markieren Sie die Kontrollkästchen für SMPT verwendet StarTLS und SMTP erfordert StarTLS.
   • Markieren Sie OAuth-Fluss und klicken Sie auf Speichern.
4. Suchen Sie nach CQ Mailer SMTP OAuth2 Provider und klicken Sie darauf.
5. Füllen Sie die erforderlichen Informationen wie folgt aus:
   • Füllen Sie die Autorisierungs-URL, Token-URL und Aktualisierungstoken-URL aus, indem Sie sie wie unter Ende dieses Verfahrens beschrieben dekonstruieren.
   • Client-ID und Client-Geheimnis: Konfigurieren Sie diese Felder mit den Werten, die Sie wie oben beschrieben abgerufen haben.
   • Fügen Sie der Konfiguration die folgenden Umfänge hinzu:
     • openid
     • offline_access
     • https://outlook.office365.com/Mail.Send
     • https://outlook.office365.com/Mail.Read
     • https://outlook.office365.com/SMTP.Send
   • AuthCode-Umleitungs-URL: http://localhost:4503/services/mailer/oauth2/token
   • Aktualisieren der Token-URL: diese sollte denselben Wert wie die Token-URL oben haben.
6. Klicken Sie auf Speichern.

Nach der Konfiguration sollten die Einstellungen wie folgt aussehen:

Aktivieren Sie jetzt die OAuth-Komponenten. Gehen Sie dazu wie folgt vor:

1. Rufen Sie die Komponentenkonsole auf, indem Sie diese URL aufrufen: http://serveraddress:serverport/system/console/components
2. Suchen Sie nach den folgenden Komponenten.
   • com.day.cq.mailer.oauth.servlets.handler.OAuthCodeGenerateServlet
   • com.day.cq.mailer.oauth.servlets.handler.OAuthCodeAccessTokenGenerator
3. Klicken Sie links neben den Komponenten auf das Wiedergabesymbol.

Bestätigen Sie abschließend die Konfiguration, indem Sie:

1. zur Adresse der Veröffentlichungsinstanz wechseln und sich als Admin anmelden
2. eine neue Registerkarte im Browser öffnen und zu http://serveraddress:serverport/services/mailer/oauth2/authorize navigieren. Dadurch werden Sie zur Seite Ihres SMTP-Anbieters weitergeleitet, in diesem Fall Gmail.
3. Anmelden und Einverständnis zur Erteilung der erforderlichen Berechtigungen
4. Nach der Zustimmung wird das Token im Repository gespeichert. Sie können es unter accessToken aufrufen, indem Sie direkt auf diese URL auf Ihrer Veröffentlichungsinstanz zugreifen: http://serveraddress:serverport/crx/de/index.jsp#/conf/global/settings/mailer/oauth

Ressourcen für Business.Adobe.com

Cms Cloud Asset Collections Embedded Charts Mobile Forms Theme Editor Digital Rights Management