DocumentationAEMCore Components Guide

Using the Email Core Components using

Last update: Tue Nov 29 2022 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
  • Admin
  • User

Learn about the basic installation, configuration, and usage of the Email Core Components.

Installing the Email Core Components installation

The Email Core Components can be used with AEM 6.5. See the Requirements section of the Email Core Components Introduction document for more information.

Install Core Components core-components

The Email Core Components are built on the AEM Core Components. Because the Core Components are not shipped with AEM 6.5, you must first install the AEM Core Components before installing the Email Core Components.

See the section Download and Install section of the document Using Core Components for details on how to install the Core Components.

Install Email Core Components email-core-components

Once the Core Components are installed in your instance, you must likewise install the Email Core Components. The Email Core Components are not yet part of the AEM Project Archetype, so you will need to add them manually to your project. Follow the documentation in the Email Core Components GitHub wiki to install.

You can follow these same instructions if you wish to adapt an existing project to use the Email Core Components.

Configuration configuration

After installing the Core Components, you should complete two important configuration steps.

Configure Campaign configure-campaign

You must set up the AEM-Adobe Campaign integration in order for the two solutions to communicate.

Add AEM Resource Type Filter for Email Components aem-resource-filter

In order for Adobe Campaign to be able to render emails based on the Email Core Components, a filter must be adjusted in Campaign.

  1. Log into Adobe Campaign as an administrator using the client console.

  2. Select Tools -> Explorer from the menu bar.

  3. In the explorer, navigate to the Administration -> Platform -> Options node.

  4. Select the AEMResourceTypeFilter option from the list.

  5. In the Value field, append core/email/components/page/<v1>/page if it is not already present.

    • Replace <v1> with the current version of the Email Core Components Page Component such as v1.
    • Note that values in the Values field must be comma-delimited.

  6. Click Save.

Using the Email Core Components using-components

Once the Email Components are installed and the integration with Adobe Campaign is configured, you can use the Email Components to create email content in AEM and then send that content to recipients using Adobe Campaign. The following is an overview of the workflow.

Step
Description
Solution
1
Authors create a free-formed hierarchic structure of folders and email content as pages.
AEM
2
Using the template editor, authors configure an email header and/or footer that would be shared among all email pages resulting from this page template.
AEM
3
Authors use the page editor to create email content using the text editor where they can pick Adobe Campaign variables and use the Segmentation Component to conditional show information if the recipient meets certain criteria.
AEM
4
When the email content is complete, a workflow is run to approve the content and send to Campaign.
AEM
5
A delivery is created, defining a list of recipients.
Campaign
6
The content created in AEM is selected as the content of the delivery.
Campaign
7
The content is sent to the recipients, replacing the Adobe Campaign variables with the personalized information of the recipients.
Campaign

For an example of creating email content in AEM and delivering in Adobe Campaign, please see the following resources.

recommendation-more-help
d2be9096-a81e-404b-9952-d8925af7219c