Configuring Email Notification configuring-email-notification

AEM sends email notifications to users who:

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.

Configuring the Mail Service configuring-the-mail-service

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:

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:

Configuring the Email Notification Channel configuring-the-email-notification-channel

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:

Use the following procedure to define the node in your content package source folders:

Configuring the Workflow Email Notification Service configuring-the-workflow-email-notification-service

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 Notification email-templates-for-page-notification

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.

Customizing Email Templates for Page Notification customizing-email-templates-for-page-notification

To customize the English email template for page notification:

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:

Email Templates for Forum Notification email-templates-for-forum-notification

Email templates for forum notifications are located under:

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

The default English template ( en.txt) is defined as follows:

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.

Customizing Email Templates for Forum Notification customizing-email-templates-for-forum-notification

To customize the English email template for forum notification:

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 forum notifications:

Email Templates for Workflow Notification email-templates-for-workflow-notification

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.

Customizing Email Templates for Workflow Notification customizing-email-templates-for-workflow-notification

To customize the English email template for workflow event notification:

The template needs to have the following format:

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

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:

Adding an Email Template for a New Language adding-an-email-template-for-a-new-language

To add a template for a new language:

Configuring AEM Assets email notifications assetsconfig

When Collections in AEM Assets are shared or unshared, users can receive email notifications from AEM. To configure email notifications, follow these steps.