AEM sends email notifications to users who:
Have subscribed to page events, for example, modification or replication. The Notification Inbox section describes how to subscribe to such events.
Have subscribed to forum events.
Have to perform a step in a workflow. The Participant Step section describes how to trigger email notification in a workflow.
Pre-requisites:
When a user is notified, he receives an email in the language that is defined in his profile. Each language has its own template that can be customized. New email templates can be added for new languages.
When working with AEM, there are several methods of managing the configuration settings for such services; see Configuring OSGi for more details and the recommended practices.
For AEM to be able to send emails, the Day CQ Mail Service needs to be properly configured. You can view the configuration in the Web console. When working with AEM, there are several methods of managing the configuration settings for such services; see Configuring OSGi for more details and the recommended practices.
The following constraints apply:
The SMTP server port must be 25 or higher.
The SMTP server host name must not be blank.
The “From” address must not be blank.
To help you debug an issue with the Day CQ Mail Service, you can watch the logs of the service:
com.day.cq.mailer.DefaultMailService
The configuration looks as follows in the Web console:
When you subscribe to either page or forum events notifications, the from-email address is set to no-reply@acme.com
per default. You can change this value by configuring the Notification Email Channel service in the Web Console.
To configure the from-email address, add a sling:OsgiConfig
node to the repository. Use the following procedure to add the node directly using CRXDE Lite:
In CRXDE Lite, add a folder named config
below your application folder.
In the config folder, add a node named:
com.day.cq.wcm.notification.email.impl.EmailChannel
of type sling:OsgiConfig
Add a String
property to the node named email.from
. For the value, specify the email address that you want to use.
Click Save All.
Use the following procedure to define the node in your content package source folders:
In your jcr_root/apps/*app_name*/config folder
, create a file named com.day.cq.wcm.notification.email.impl.EmailChannel.xml
Add the following XML to represent the node:
<?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"/>
Replace the value of the email.from
attribute ( name@server.com
) with your email address.
Save the file.
When you receive workflow email notifications, both the from-email address and the host URL prefix are set to default values. You can change these values by configuring the Day CQ Workflow Email Notification Service in the Web Console. If you do so, it is recommended to persist the change in the repository.
The default configuration looks as follows in the Web Console:
Email templates for page notifications are located below:
/libs/settings/notification-templates/com.day.cq.wcm.core.page
The default English template ( en.txt
) is defined as follows:
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.
To customize the English email template for page notification:
In CRXDE, open the file:
/libs/settings/notification-templates/com.day.cq.wcm.core.page/en.txt
Modify the file to your needs.
Save the changes.
The template needs to have the following format:
subject=<text_1>
header=<text_2>
message=<text_3>
footer=<text_4>
Where <text_x> can be a mix of static text and dynamic string variables. The following variables can be used within the email template for page notifications:
${time}
, the event date and time.
${userFullName}
, the full name of the user who triggered the event.
${userId}
, the ID of the user who triggered the event.
${modifications}
, describes the type of the page event and the page path in the format:
<page event type> => <page path>
For example:
PageModified => /content/geometrixx/en/products
The email template for workflow notifications (English) is located at:
/libs/settings/workflow/notification/email/default/en.txt
It is defined as follows:
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.
To customize the English email template for workflow event notification:
In CRXDE, open the file:
/libs/settings/workflow/notification/email/default/en.txt
Modify the file to your needs.
Save the changes.
The template needs to have the following format:
subject=<text_1>
header=<text_2>
message=<text_3>
footer=<text_4>
Where <text_x>
can be a mix of static text and dynamic string variables. Each line of an <text_x>
item needs to be ended with a backslash ( \
), except for the last instance, when the absence of the backslash indicates the end of the <text_x>
string variable.
More information about the template format can be found in the javadocs of the Properties.load() method.
The method ${payload.path.open}
reveals the path to the payload of the workitem. For example, for a page in Sites then then payload.path.open
would be similar to /bin/wcmcommand?cmd=open&path=…
.; this is without the server name, which is why the template prepends this with ${host.prefix}
.
The following variables can be used within the email template:
${event.EventType}
, type of the event
${event.TimeStamp}
, date and time of the event
${event.User}
, the user who triggered the event
${initiator.home}
, the initiator node path
${initiator.name}
, the initiator name
${initiator.email}
, email address of the initiator
${item.id}
, the id of the work item
${item.node.id}
, id of the node in the workflow model associated with this workitem
${item.node.title}
, title of the work item
${participant.email}
, email address of the participant
${participant.name}
, name of the participant
${participant.familyName}
, family name of the participant
${participant.id}
, id of the participant
${participant.language}
, the participant language
${instance.id}
, the workflow id
${instance.state}
, the workflow state
${model.title}
, title of the workflow model
${model.id}
, the id of the workflow model
${model.version}
, the version of the workflow model
${payload.data}
, the payload
${payload.type}
, the payload type
${payload.path}
, path of the payload
${host.prefix}
, host prefix, for example,: http://localhost:4502
To add a template for a new language:
In CRXDE, add a file <language-code>.txt
below:
/libs/settings/notification-templates/com.day.cq.wcm.core.page
: for page notifications/libs/settings/workflow/notification/email/default
: for workflow notificationsAdapt the file to the language.
Save the changes.
The <language-code>
used as the filename for the email template needs to be a two-letters lower-case language code that is recognized by AEM. For language codes, AEM relies on ISO-639-1.
When Collections in AEM Assets are shared or unshared, users can receive email notifications from AEM. To configure email notifications, follow these steps.
AEM offers OAuth2 support for its integrated Mailer Service, to allow organizations to adhere to secure email requirements.
You can configure OAuth for multiple email providers, as outlined below.
This procedure is an example for a Publish instance. If you wish to enable email notifications on an Author instance, you need to follow the same steps on the Author.
https://console.developers.google.com/projectcreate
https://mail.google.com/
https://www.googleapis.com//auth/gmail.send
AEM Side Configurations
Adobe Managed Service customers can work with their Customer Service Engineer to make these changes to production environments.
First, configure the Mail Service:
http://serveraddress:serverport/system/console/configMgr
smtp.gmail.com
25
or 587
, depending on the requirementsNext, configure your SMTP OAuth provider by following the procedure below:
http://serveraddress:serverport/system/console/configMgr
https://accounts.google.com/o/oauth2/auth
https://accounts.google.com/o/oauth2/token
https://www.googleapis.com/auth/gmail.send
and https://mail.google.com/
. You can add more than one scope by pressing the + button to the right hand side of each configured scope.https://accounts.google.com/o/oauth2/token
Once configured, the settings should look like this:
Now, activate the OAuth components. You can do this by:
Go to the Components Console by visiting this URL: http://serveraddress:serverport/system/console/components
Look for the following components
com.day.cq.mailer.oauth.servlets.handler.OAuthCodeGenerateServlet
com.day.cq.mailer.oauth.servlets.handler.OAuthCodeAccessTokenGenerator
Press the Play icon to the left of the components
Finally, confirm the configuration by:
http://serveraddress:serverport/services/mailer/oauth2/authorize
. This will redirect you to the page of your SMTP provider, in this case Gmail.accessToken
by directly accessing this URL on your publish instance: http://serveraddress:serverport/crx/de/index.jsp#/conf/global/settings/mailer/oauth
Go to https://portal.azure.com/ and log in.
Search for Azure Active Directory in the search bar and click the result. Alternatively, you can browse directly to https://portal.azure.com/#blade/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/Overview
Click on App Registration - New Registration
Fill in the information according to your requirements, then click Register
Go to the newly created app, and select API Permissions
Go to Add Permission - Graph Permission - Delegated Permissions
Select the below permissions for your app, then click Add Permission:
SMTP.Send
Mail.Read
Mail.Send
openid
offline_access
Go to Authentication - Add a platform - Web, and in the Redirect Urls section, add the following URL for redirecting the OAuth code, then press Configure:
http://localhost:4503/services/mailer/oauth2/token
Repeat the above for each publish instance
Configure the settings according to your requirements
Next, go to Certificates and Secrets, click New client secret and follow the on screen steps to create a secret. Make sure to take note of this secret for later use
Press Overview in the left hand pane and copy the values for Application (client) ID and Directory (tenant) ID for later use
To recap, you must have the following information to configure OAuth2 for the Mailer service on the AEM side:
https://login.microsoftonline.com/<tenantID>/oauth2/v2.0/authorize
https://login.microsoftonline.com/<tenantID>/oauth2/v2.0/token
https://login.microsoftonline.com/<tenantID>/oauth2/v2.0/token
AEM Side Configurations
Next, integrate your OAuth2 settings with AEM:
http://serveraddress:serverport/system/console/configMgr
smtp.office365.com
25
or 587
depending on the requirementshttps://outlook.office365.com/Mail.Send
https://outlook.office365.com/Mail.Read
https://outlook.office365.com/SMTP.Send
http://localhost:4503/services/mailer/oauth2/token
Once configured, the settings should look like this:
Now, activate the OAuth components. You can do this by:
http://serveraddress:serverport/system/console/components
com.day.cq.mailer.oauth.servlets.handler.OAuthCodeGenerateServlet
com.day.cq.mailer.oauth.servlets.handler.OAuthCodeAccessTokenGenerator
Finally, confirm the configuration by:
http://serveraddress:serverport/services/mailer/oauth2/authorize
. This will redirect you to the page of your SMTP provider, in this case Outlook.accessToken
by directly accessing this URL on your publish instance: http://serveraddress:serverport/crx/de/index.jsp#/conf/global/settings/mailer/oauth