Article summary

Summary

Discusses how to develop an AEM HTML Template Language (HTL - formerly known as Sightly) component that sends email messages based on an AEM email template. 

If you want to know how to use AEM to send text-based emails that DO NOT use email templates, see Creating custom AEM workflow steps that send email messages.

A special thank you to community members Ranta Kumar Kotla and Dinakar Gundluri for testing this Community Article to ensure it works.

HTL is the AEM template language that can be used to replace use of JSP when developing an AEM component. HTL helps you to separate your design from your application logic. For more information, see Introduction to the HTML Template Language.

Digital Marketing Solution(s) Adobe Experience Manager (Adobe CQ)
Audience
Developer (beginner - intermediate)
Required Skills
JCR nodes, JavaScript, HTML
Version Adobe Experience Manager 6.2
Video https://youtu.be/9Ztc9hBbrwg

Download

Note:

You can download an AEM package that contains code and the OSGi bundle that are used in this article. Download the package and deploy using package manager. The purpose of this code is to show the community these concepts in action. That is, it's to illustrate how to write an AEM HTL component that sends email messages that are based on templates. This community code is for teaching purposes only and not meant to go into production as is.
You can view the application by using the following URL: http://localhost:4502/editor.html/content/emailHTL/en.html (assuming you deploy on author).

Note:

You still have to configure the MessageGatewayService as described in this artilce after you install this package and rebuild and deploy the Java to send to a valid email address.  

Introduction

You can create an Adobe Experience Manager (AEM) HTML Template Language (HTL) component lets web site visitors populate a form and submit the data to a backend. The backend Servlet can then send an email to email recipients. The email message is based on an email template that is located in the AEM JCR repository. 

An email template is simply a text file located in the AEM JCR that contains HTML tags and variables. The application logic that sends the email also populates the variables.  For example, consider the following template. 

subject=[CQ Forum] ${topic.subject}

header=<html>\n \
<head>\n \
<title>CQ Forum Update</title>
</head>

message=<body>
<P> 
Time: ${time}<br>\n \
Forum URL: ${host.prefix}${forum.url}\n \
</p>
A new reply was posted by ${modifiedBy.fullname} for CQ Forum topic "${topic.subject}".<br><br>
-------------------------------------------------------------------------------------<br>
${post.message} <br>
-------------------------------------------------------------------------------------<br><br>
This is an automatically generated message. Please do not reply.<br> 
Please follow this link to view all replies to this topic.<br>
${host.prefix}${topic.url}<br><br>

In this development article, an HTL component is developed that lets a user enter values and submits them to a Sling Servlet. This type of HTL component can be used to gather customer feedback. For example, it can be used in a web site where management wants customer feedback emailed to them.

The Sling Servlet peforms these tasks:

  • retrieves the values posted from a HTL front end
  • references the AEM templae from the AEM JCR
  • injects the submitted values into the email message 
  • sends the email message

The following illustration shows an email message that is based on an AEM template that contains the submitted values. 

Client
An HTL component sends an email message that is based on an AEM template

Experience Manager email templates are located at the following JCR location: 

/etc/notification/email

An email template a JCR node of type nt:file. Each node has a text file as shown in the following illustration. 

templates_Email2
Location of AEM Email templates

Note:

To follow along with this article, replace the text located in this JCR location with the text shown at the start of this article:  /etc/notification/email/html/com.day.cq.collab.forum/en.txt.

This development article discusses how to programmatically send an AEM email message that is based on a template. Futhermore, it also discusses how to populate the variables in the template with values. To send email messages that are based on AEM email templates, you use the MessageGatewayService API.

Setup Maven in your development environment

You can use Maven to build an OSGi bundle that contains a Sling Servlet. Maven manages required JAR files that a Java project needs in its class path. Instead of searching the Internet trying to find and download third-party JAR files to include in your project’s class path, Maven manages these dependencies for you.

You can download Maven 3 from the following URL:

http://maven.apache.org/download.html

After you download and extract Maven, create an environment variable named M3_HOME. Assign the Maven install location to this environment variable. For example:

C:\Programs\Apache\apache-maven-3.0.4

Set up a system environment variable to reference Maven. To test whether you properly setup Maven, enter the following Maven command into a command prompt:

%M3_HOME%\bin\mvn -version

This command provides Maven and Java install details and resembles the following message:

Default locale: en_US, platform encoding: Cp1252
OS name: "windows 7", version: "6.1", arch: "amd64", family: "windows"

Note:

It is recommended that you use Maven 3.0.3 or greater. For more information about setting up Maven and the Home variable, see: Maven in 5 Minutes.

Next, copy the Maven configuration file named settings.xml from [install location]\apache-maven-3.0.4\conf\ to your user profile. For example, C:\Users\scottm\.m2\.

You have to configure your settings.xml file to use Adobe’s public repository. For information, see Adobe Public Maven Repository at http://repo.adobe.com/.

The following XML code represents a settings.xml file that you can use.

<?xml version="1.0" encoding="UTF-8"?>
 
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at
 
    http://www.apache.org/licenses/LICENSE-2.0
 
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.
-->
 
<!--
 | This is the configuration file for Maven. It can be specified at two levels:
 |
 |  1. User Level. This settings.xml file provides configuration for a single user, 
 |                 and is normally provided in ${user.home}/.m2/settings.xml.
 |
 |                 NOTE: This location can be overridden with the CLI option:
 |
 |                 -s /path/to/user/settings.xml
 |
 |  2. Global Level. This settings.xml file provides configuration for all Maven
 |                 users on a machine (assuming they're all using the same Maven
 |                 installation). It's normally provided in 
 |                 ${maven.home}/conf/settings.xml.
 |
 |                 NOTE: This location can be overridden with the CLI option:
 |
 |                 -gs /path/to/global/settings.xml
 |
 | The sections in this sample file are intended to give you a running start at
 | getting the most out of your Maven installation. Where appropriate, the default
 | values (values used when the setting is not specified) are provided.
 |
 |-->
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">
  <!-- localRepository
   | The path to the local repository maven will use to store artifacts.
   |
   | Default: ~/.m2/repository
  <localRepository>/path/to/local/repo</localRepository>
  -->
 
  <!-- interactiveMode
   | This will determine whether maven prompts you when it needs input. If set to false,
   | maven will use a sensible default value, perhaps based on some other setting, for
   | the parameter in question.
   |
   | Default: true
  <interactiveMode>true</interactiveMode>
  -->
 
  <!-- offline
   | Determines whether maven should attempt to connect to the network when executing a build.
   | This will have an effect on artifact downloads, artifact deployment, and others.
   |
   | Default: false
  <offline>false</offline>
  -->
 
  <!-- pluginGroups
   | This is a list of additional group identifiers that will be searched when resolving plugins by their prefix, i.e.
   | when invoking a command line like "mvn prefix:goal". Maven will automatically add the group identifiers
   | "org.apache.maven.plugins" and "org.codehaus.mojo" if these are not already contained in the list.
   |-->
  <pluginGroups>
    <!-- pluginGroup
     | Specifies a further group identifier to use for plugin lookup.
    <pluginGroup>com.your.plugins</pluginGroup>
    -->
  </pluginGroups>
 
  <!-- proxies
   | This is a list of proxies which can be used on this machine to connect to the network.
   | Unless otherwise specified (by system property or command-line switch), the first proxy
   | specification in this list marked as active will be used.
   |-->
  <proxies>
    <!-- proxy
     | Specification for one proxy, to be used in connecting to the network.
     |
    <proxy>
      <id>optional</id>
      <active>true</active>
      <protocol>http</protocol>
      <username>proxyuser</username>
      <password>proxypass</password>
      <host>proxy.host.net</host>
      <port>80</port>
      <nonProxyHosts>local.net|some.host.com</nonProxyHosts>
    </proxy>
    -->
  </proxies>
 
  <!-- servers
   | This is a list of authentication profiles, keyed by the server-id used within the system.
   | Authentication profiles can be used whenever maven must make a connection to a remote server.
   |-->
  <servers>
    <!-- server
     | Specifies the authentication information to use when connecting to a particular server, identified by
     | a unique name within the system (referred to by the 'id' attribute below).
     | 
     | NOTE: You should either specify username/password OR privateKey/passphrase, since these pairings are 
     |       used together.
     |
    <server>
      <id>deploymentRepo</id>
      <username>repouser</username>
      <password>repopwd</password>
    </server>
    -->
     
    <!-- Another sample, using keys to authenticate.
    <server>
      <id>siteServer</id>
      <privateKey>/path/to/private/key</privateKey>
      <passphrase>optional; leave empty if not used.</passphrase>
    </server>
    -->
  </servers>
 
  <!-- mirrors
   | This is a list of mirrors to be used in downloading artifacts from remote repositories.
   | 
   | It works like this: a POM may declare a repository to use in resolving certain artifacts.
   | However, this repository may have problems with heavy traffic at times, so people have mirrored
   | it to several places.
   |
   | That repository definition will have a unique id, so we can create a mirror reference for that
   | repository, to be used as an alternate download site. The mirror site will be the preferred 
   | server for that repository.
   |-->
  <mirrors>
    <!-- mirror
     | Specifies a repository mirror site to use instead of a given repository. The repository that
     | this mirror serves has an ID that matches the mirrorOf element of this mirror. IDs are used
     | for inheritance and direct lookup purposes, and must be unique across the set of mirrors.
     |
    <mirror>
      <id>mirrorId</id>
      <mirrorOf>repositoryId</mirrorOf>
      <name>Human Readable Name for this Mirror.</name>
      <url>http://my.repository.com/repo/path</url>
    </mirror>
     -->
  </mirrors>
   
  <!-- profiles
   | This is a list of profiles which can be activated in a variety of ways, and which can modify
   | the build process. Profiles provided in the settings.xml are intended to provide local machine-
   | specific paths and repository locations which allow the build to work in the local environment.
   |
   | For example, if you have an integration testing plugin - like cactus - that needs to know where
   | your Tomcat instance is installed, you can provide a variable here such that the variable is 
   | dereferenced during the build process to configure the cactus plugin.
   |
   | As noted above, profiles can be activated in a variety of ways. One way - the activeProfiles
   | section of this document (settings.xml) - will be discussed later. Another way essentially
   | relies on the detection of a system property, either matching a particular value for the property,
   | or merely testing its existence. Profiles can also be activated by JDK version prefix, where a 
   | value of '1.4' might activate a profile when the build is executed on a JDK version of '1.4.2_07'.
   | Finally, the list of active profiles can be specified directly from the command line.
   |
   | NOTE: For profiles defined in the settings.xml, you are restricted to specifying only artifact
   |       repositories, plugin repositories, and free-form properties to be used as configuration
   |       variables for plugins in the POM.
   |
   |-->
  <profiles>
    <!-- profile
     | Specifies a set of introductions to the build process, to be activated using one or more of the
     | mechanisms described above. For inheritance purposes, and to activate profiles via <activatedProfiles/>
     | or the command line, profiles have to have an ID that is unique.
     |
     | An encouraged best practice for profile identification is to use a consistent naming convention
     | for profiles, such as 'env-dev', 'env-test', 'env-production', 'user-jdcasey', 'user-brett', etc.
     | This will make it more intuitive to understand what the set of introduced profiles is attempting
     | to accomplish, particularly when you only have a list of profile id's for debug.
     |
     | This profile example uses the JDK version to trigger activation, and provides a JDK-specific repo.
    <profile>
      <id>jdk-1.4</id>
 
      <activation>
        <jdk>1.4</jdk>
      </activation>
 
      <repositories>
        <repository>
          <id>jdk14</id>
          <name>Repository for JDK 1.4 builds</name>
          <url>http://www.myhost.com/maven/jdk14</url>
          <layout>default</layout>
          <snapshotPolicy>always</snapshotPolicy>
        </repository>
      </repositories>
    </profile>
    -->
 
    <!--
     | Here is another profile, activated by the system property 'target-env' with a value of 'dev',
     | which provides a specific path to the Tomcat instance. To use this, your plugin configuration
     | might hypothetically look like:
     |
     | ...
     | <plugin>
     |   <groupId>org.myco.myplugins</groupId>
     |   <artifactId>myplugin</artifactId>
     |   
     |   <configuration>
     |     <tomcatLocation>${tomcatPath}</tomcatLocation>
     |   </configuration>
     | </plugin>
     | ...
     |
     | NOTE: If you just wanted to inject this configuration whenever someone set 'target-env' to
     |       anything, you could just leave off the <value/> inside the activation-property.
     |
    <profile>
      <id>env-dev</id>
 
      <activation>
        <property>
          <name>target-env</name>
          <value>dev</value>
        </property>
      </activation>
 
      <properties>
        <tomcatPath>/path/to/tomcat/instance</tomcatPath>
      </properties>
    </profile>
    -->
   
 
<profile>
 
                <id>adobe-public</id>
 
                <activation>
 
                    <activeByDefault>true</activeByDefault>
 
                </activation>
 
                <repositories>
 
                  <repository>
 
                    <id>adobe</id>
 
                    <name>Nexus Proxy Repository</name>
 
                    <url>http://repo.adobe.com/nexus/content/groups/public/</url>
 
                    <layout>default</layout>
 
                  </repository>
 
                </repositories>
 
                <pluginRepositories>
 
                  <pluginRepository>
 
                    <id>adobe</id>
 
                    <name>Nexus Proxy Repository</name>
 
                    <url>http://repo.adobe.com/nexus/content/groups/public/</url>
 
                    <layout>default</layout>
 
                  </pluginRepository>
 
                </pluginRepositories>
 
            </profile>
 
</profiles>
 
  <!-- activeProfiles
   | List of profiles that are active for all builds.
   |
  <activeProfiles>
    <activeProfile>alwaysActiveProfile</activeProfile>
    <activeProfile>anotherAlwaysActiveProfile</activeProfile>
  </activeProfiles>
  -->
</settings>

Note:

The Adobe repository URL is now made secured. Change http://repo.adobe.com/nexus/content/groups/public/ to https://repo.adobe.com/nexus/content/groups/public/.

Create an AEM Maven 10 archetype project

You can create an Experience Manager archetype project by using the Maven archetype plugin. In this example, assume that the working directory is C:\AdobeCQ.

files
Maven Archetype 10 generated files

To create an Experience Manager archetype project, perform these steps:

1. Open the command prompt and go to your working directory (for example, C:\AdobeCQ).

2. Run the following Maven command:

mvn archetype:generate -DarchetypeGroupId=com.adobe.granite.archetypes -DarchetypeArtifactId=aem-project-archetype -DarchetypeVersion=10 -DarchetypeRepository=https://repo.adobe.com/nexus/content/groups/public/

3. When prompted, specify the following information:

  • groupId - emailHTL
  • artifactId - emailHTL
  • version - 1.0-SNAPSHOT
  • package - com.aem.community
  • appsFolderName - emailHTL
  • artifactName - emailHTL
  • componentGroupName - emailHTL
  • contentFolderName - emailHTL
  • cssId - emailHTL
  • packageGroup - emailHTL
  • siteName - emailHTL

4. WHen prompted, specify Y.

5. Once done, you will see a message like:

[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 01:42 min
[INFO] Finished at: 2016-04-25T14:34:19-04:00
[INFO] Final Memory: 16M/463M
[INFO] ------------------------------------------------------------------------

6. Change the working directory to emailHTL and then enter the following command.

mvn eclipse:eclipse

After you run this command, you can import the project into Eclipse as discussed in the next section.

Add Java files to the Maven project using Eclipse

To make it easier to work with the Maven generated project, import it into the Eclipse development environment, as shown in the following illustration.

project
An Eclipse Import Dialog

The Eclipse project that you work in to build the OSGi bundle that uses AEM Email API is emailHTL.core. You do not have to work in the other projects under emailHTL. 

Note:

Do not worry about the errors reported in Eclipse. It does not read the POM file where the APIs are resolved. You build the bundle with Maven. Eclipse is used to edit the Java files and the POM file.  

The next step is to overwrite the Java file named SimpleServlet located in the com.aem.community.core.servlets package. The Java class represents the Sling Servlet to which the HTL component posts data to. This class supports the doPost method that lets you submit data from an Experience Manager web page to the Sling servlet. For information about this class, see Class SlingAllMethodsServlet.

The Sling Servlet contains application logic to reference the AEM email template and inject values into it. Assume that the email template contains these values: 

  • topic.subject
  • time
  • host.prefix
  • forum.url
  • modifiedBy.fullname
  • topic.url
  • post.message

The Java application populates these email template variables using a MAP object. They key of the Map references the variable name and the value is the value that is injected into the email message. The following Java code shows the Map object being created to populate the variables in the email template. 

 //Creare a MAP to populate the email template variables 
  Map myMap = new HashMap() ; 
  String timeStamp = new SimpleDateFormat("yyyy.MM.dd.HH.mm.ss").format(new Date());
       		  
    		  
  //Populate the MAP with the values submitted from the HTL front end
   myMap.put("topic.subject",TopicSubject); 
   myMap.put("time",timeStamp); 
   myMap.put("host.prefix",hostPrefix); 
   myMap.put("forum.url",forumUrl); 
   myMap.put("modifiedBy.fullname",modifiedByFullname); 
   myMap.put("topic.url",topicUrl); 
   myMap.put("post.message",message);

The following Java code represents the SimpleServlet class that extends org.apache.sling.api.servlets.SlingAllMethodsServlet.  This servlet references the email template located in the JCR, injects values by using a MAP object, and sending the email using a MessageGatewayService instance that is injected using a @Reference annotation. 

 

package com.aem.community.core.servlets;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.PrintWriter;
import java.net.HttpURLConnection;
import java.net.URL;
import java.rmi.ServerException;
import java.util.Dictionary;
  
import org.apache.felix.scr.annotations.Properties;
import org.apache.felix.scr.annotations.Property;
import org.apache.felix.scr.annotations.Reference;
import org.apache.felix.scr.annotations.sling.SlingServlet;
import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.SlingHttpServletResponse;
import org.apache.sling.api.servlets.SlingSafeMethodsServlet;
import org.apache.sling.commons.osgi.OsgiUtil;
import org.apache.sling.jcr.api.SlingRepository;
import org.apache.felix.scr.annotations.Reference;
import org.osgi.service.component.ComponentContext;
import javax.jcr.Session;
import javax.jcr.Node; 
import java.util.UUID;
import java.util.Date; 
import java.text.SimpleDateFormat;  

import org.apache.sling.api.resource.Resource ; 

import java.util.Map; 
import java.util.HashMap; 
//import javax.mail.MessagingException ; 

import org.apache.commons.lang.text.StrLookup; 

import org.apache.felix.scr.annotations.Reference;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
  



import com.day.cq.mailer.MessageGateway;
import com.day.cq.mailer.MessageGatewayService;

import com.day.cq.commons.mail.MailTemplate ;  
  
import org.apache.commons.mail.Email;
import org.apache.commons.mail.HtmlEmail;
import org.apache.commons.mail.EmailException;
import org.apache.commons.mail.SimpleEmail;
  
@SlingServlet(paths="/bin/htlSearchServlet", methods = "POST", metatype=true)
public class SimpleServlet extends org.apache.sling.api.servlets.SlingAllMethodsServlet {
     private static final long serialVersionUID = 2598426539166789515L;
       
     @Reference
     private MessageGatewayService messageGatewayService;
     
     
     /** Default log. */
     protected final Logger log = LoggerFactory.getLogger(this.getClass());
           
            
     @Override
     protected void doPost(SlingHttpServletRequest request, SlingHttpServletResponse response) throws ServerException, IOException {
        
      try
      {
         //Get the submitted data from the HTL front end
          String hostPrefix = request.getParameter("hostPrefix");
          String forumUrl = request.getParameter("forumUrl");
          String modifiedByFullname = request.getParameter("modifiedByFullname");
          String TopicSubject = request.getParameter("TopicSubject");
          String topicUrl = request.getParameter("topicUrl");
          String message = request.getParameter("message"); 
                    
          log.info("*** SUBJECT: "+TopicSubject); 
     
          
          //Send the email based on a AEM JCR template
          SendHHTMLEmail(request, hostPrefix,forumUrl,modifiedByFullname, TopicSubject,topicUrl,message  )  ;
          
         
         
         //Return the JSON formatted data
         response.getWriter().write("EMAIL GONE");   
         
      }
      catch(Exception e)
      {
          e.printStackTrace();
      }
    }
     
 
    //Send an AEM Email based on a template located at 
     ///etc/notification/email/html/com.day.cq.collab.forum/en.txt
    private void SendHHTMLEmail(SlingHttpServletRequest request, String hostPrefix,String forumUrl, String modifiedByFullname, String TopicSubject, String topicUrl, String message  )
    {
    	 try
    	 {
    		  //Creare a MAP to populate the email template variables 
    		  Map myMap = new HashMap() ; 
    		  String timeStamp = new SimpleDateFormat("yyyy.MM.dd.HH.mm.ss").format(new Date());
       		  
    		  
    		  //Populate the MAP with the values submitted from the HTL front end
    		  myMap.put("topic.subject",TopicSubject); 
    		  myMap.put("time",timeStamp); 
    		  myMap.put("host.prefix",hostPrefix); 
    		  myMap.put("forum.url",forumUrl); 
    		  myMap.put("modifiedBy.fullname",modifiedByFullname); 
    		  myMap.put("topic.url",topicUrl); 
    		  myMap.put("post.message",message); 
    		 
             
             //Declare a MessageGateway service
             MessageGateway<HtmlEmail> messageGateway; 
                       
             //Specify the EMail template 
             String template ="/etc/notification/email/html/com.day.cq.collab.forum/en.txt";
             
            Resource templateRsrc = request.getResourceResolver().getResource(template);
              
            MailTemplate mailTemplate = MailTemplate.create(templateRsrc.getPath(), templateRsrc.getResourceResolver().adaptTo(Session.class));
                     
           HtmlEmail email = mailTemplate.getEmail(StrLookup.mapLookup(myMap), HtmlEmail.class);
                   
           email.addTo("tblue@noserver.com");
           email.setSubject("AEM Email Template");
           email.setFrom("wwhite@noserver.com"); 
                     
            
          //Inject a MessageGateway Service and send the message
           messageGateway = this.messageGatewayService.getGateway(HtmlEmail.class);
         messageGateway.send((HtmlEmail) email);
         
    	 }
    	     catch (Exception e)
    	     {
    	    	 
    	    	  log.info(e.getMessage())  ; 
    	     }
    }
     
}

Note:

Update the email addresses in the Java code so AEM sends the email message to the correct email recipients. 

The Java class uses a SlingServlet annotation:

@SlingServlet(paths="/bin/htlSearchServlet", methods = "POST", metatype=true)

The paths property corresponds to the URL that you specify when using an AJAX request. For information about different ways to register sling servlets, see Servlet Registration.

To use an AJAX request to post data to this Sling Servlet, you use this syntax:

type: 'POST',
url:'/bin/htlSearchServlet',
data:'hostPrefix='+ hostPrefix+'&forumUrl='+ forumUrl+'&modifiedByFullname='+ modifiedByFullname+'&TopicSubject='+ TopicSubject+'&topicUrl='+ topicUrl+'&message='+ message,
success: function(msg){

}
});

Notice that the url in the AJAX request maps to the path property in the SlingServlet annotation. The type in the AJAX request maps to the methods property in the SlingServlet annotation. Finally notice that the AJAX request specifies the form data that is submitted. Each form field is retrieved in the doPost method by using the request.getParameter method.

Modify the Maven POM file

Add the following POM dependency to the POM file located at C:\AdobeCQ\emailHTL.

<dependency>
               <groupId>com.adobe.aem</groupId>
               <artifactId>uber-jar</artifactId>
               <version>6.2.0</version>
               <!-- for AEM6.1 use this version     : <version>6.1.0</version> -->
               <!-- for AEM6.1 SP1 use this version : <version>6.1.0-SP1-B0001</version> -->
               <!-- for AEM6.1 SP2 use this version : <version>6.1.0-SP2</version> -->
               <!-- for AEM6.2 use this version     : <version>6.2.0</version> -->
               <classifier>obfuscated-apis</classifier>
               <scope>provided</scope>
           </dependency>
            
           <dependency>
               <groupId>org.apache.geronimo.specs</groupId>
               <artifactId>geronimo-atinject_1.0_spec</artifactId>
               <version>1.0</version>
               <scope>provided</scope>
           </dependency>

You need to modify two POM files. The first one is the parent POM file shown in this illustration.

ParentPOM
Parent POM

Add the dependency shown above to the Parent POM file. Next, modify the POM file located at C:\AdobeCQ\emailHTL\core. The following code represents this POM file. 

<?xml version="1.0" encoding="UTF-8"?>
<!--
 |  Copyright 2015 Adobe Systems Incorporated
 |
 |  Licensed under the Apache License, Version 2.0 (the "License");
 |  you may not use this file except in compliance with the License.
 |  You may obtain a copy of the License at
 |
 |      http://www.apache.org/licenses/LICENSE-2.0
 |
 |  Unless required by applicable law or agreed to in writing, software
 |  distributed under the License is distributed on an "AS IS" BASIS,
 |  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 |  See the License for the specific language governing permissions and
 |  limitations under the License.
-->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>emailHTL</groupId>
        <artifactId>emailHTL</artifactId>
        <version>1.0-SNAPSHOT</version>
        <relativePath>../pom.xml</relativePath>
    </parent>
    <artifactId>emailHTL.core</artifactId>
    <packaging>bundle</packaging>
    <name>emailHTL - Core</name>
    <description>Core bundle for emailHTL</description>
    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.felix</groupId>
                <artifactId>maven-scr-plugin</artifactId>
            </plugin>
            <plugin>
                <groupId>org.apache.felix</groupId>
                <artifactId>maven-bundle-plugin</artifactId>
                <extensions>true</extensions>
                <configuration>
                    <instructions>
                        <!--
                        <Embed-Dependency>
                            artifactId1,
                            artifactId2;inline=true
                        </Embed-Dependency>
                        -->
                        <Sling-Model-Packages>
                            com.aem.community.core
                        </Sling-Model-Packages>
                    </instructions>
                </configuration>
            </plugin>
        </plugins>
    </build>
    <profiles>
        <!-- Development profile: install only the bundle -->
        <profile>
            <id>autoInstallBundle</id>
            <activation>
                <activeByDefault>false</activeByDefault>
            </activation>
            <build>
                <plugins>
                    <plugin>
                        <groupId>org.apache.sling</groupId>
                        <artifactId>maven-sling-plugin</artifactId>
                        <configuration>
                            <!-- Note that this requires /apps/emailHTL/install to exist!!          -->
                            <!--    This is typically the case when ui.apps is deployed first                -->
                            <!--    Otherwise, create /apps/emailHTL/install manually (CRXDE|Lite)  -->
                            <slingUrlSuffix>/apps/emailHTL/install/</slingUrlSuffix>
                            <failOnError>true</failOnError>
                        </configuration>
                    </plugin>
                </plugins>
            </build>
        </profile>
    </profiles>
   <dependencies>
       <!-- OSGi Dependencies -->
             
        <dependency>
            <groupId>com.adobe.aem</groupId>
            <artifactId>uber-jar</artifactId>
            <classifier>obfuscated-apis</classifier>
        </dependency>
         <dependency>
            <groupId>org.apache.geronimo.specs</groupId>
            <artifactId>geronimo-atinject_1.0_spec</artifactId>
        </dependency>
        <dependency>
            <groupId>org.apache.felix</groupId>
            <artifactId>org.apache.felix.scr</artifactId>
        </dependency>
        <dependency>
            <groupId>org.apache.felix</groupId>
            <artifactId>org.apache.felix.scr.annotations</artifactId>
        </dependency>
        <dependency>
            <groupId>biz.aQute</groupId>
            <artifactId>bndlib</artifactId>
        </dependency>
        <dependency>
            <groupId>org.osgi</groupId>
            <artifactId>org.osgi.core</artifactId>
        </dependency>
        <dependency>
            <groupId>org.osgi</groupId>
            <artifactId>org.osgi.compendium</artifactId>
        </dependency>
        <!-- Other Dependencies -->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
        </dependency>
        <dependency>
            <groupId>javax.jcr</groupId>
            <artifactId>jcr</artifactId>
        </dependency>
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>servlet-api</artifactId>
        </dependency>
        <dependency>
            <groupId>com.adobe.aem</groupId>
            <artifactId>aem-api</artifactId>
        </dependency>
        <dependency>
            <groupId>org.apache.sling</groupId>
            <artifactId>org.apache.sling.models.api</artifactId>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
        </dependency>
        <dependency>
            <groupId>org.mockito</groupId>
            <artifactId>mockito-all</artifactId>
        </dependency>
        <dependency>
            <groupId>junit-addons</groupId>
            <artifactId>junit-addons</artifactId>
        </dependency>
               <dependency>
	<groupId>com.day.commons.osgi.wrapper</groupId>
	<artifactId>com.day.commons.osgi.wrapper.commons-email</artifactId>
	<version>1.2.0-0002</version>
	<scope>provided</scope>
</dependency>
<dependency>
	<groupId>com.day.commons.osgi.wrapper</groupId>
	<artifactId>com.day.commons.osgi.wrapper.commons-lang2</artifactId>
	<version>2.5-0001</version>
	<scope>provided</scope>
</dependency>
<dependency>
    <groupId>javax.mail</groupId>
    <artifactId>mailapi</artifactId>
    <version>1.4.3</version>
</dependency>

    </dependencies>
</project>

Build the OSGi bundle using Maven

To build the OSGi bundle by using Maven, perform these steps:

  1. Open the command prompt and go to the C:\AdobeCQ\emailHTL.
  2. Run the following maven command: mvn -PautoInstallPackage install.
  3. The OSGi component can be found in the following folder: C:\AdobeCQ\emailHTL\core\target. The file name of the OSGi component is emailHTL.core-1.0-SNAPSHOT.jar.

The command -PautoInstallPackage automatically deploys the OSGi bundle to AEM.

Configure AEM to use a Mail Server

Configure Experience Manager to use a Mail Server so that the custom workflow step can send email messages. For information, see Configuring Email Notification.

To configure Experience Manager to use a Mail Server, perform these tasks:

1. Login to Apache Felix Web Console at http://server:port/system/console/bundles (default admin user = admin with password= admin).

2. Under the OSGi menu item, select Configuration.

3. Click the + icon that appearts in the Day CQ Mail Service row.

4. Enter the following values:

  • SMTP server host name - the SMTP server that you want to use.
  • SMTP server port - the server port to use, Typically this value is 25. 
  • Username - the user name for the SMTP user. 
  • Password - the corresponding password.

5. Click Save.

Note:

If you are using GMAIL to configure AEM, see Mailing Issue in AEM with Gmail SMTP Configuration.

Create the HTL Front End Component

When you use the Maven Archetype 10 archetype to create an AEM project, a default front end project is created, as shown in the following illustration.

hello
Default files created by Adobe Maven 10 Archetype project

Note:

For information about the default files created by the Maven 10 Archetype project, see this community article: Creating your first AEM 6.2 Project using Adobe Maven Archetype 10.

Add HTL code

For the purpose of this article, the HTL code is written within a Maven Archetype 10 default component located here:

/apps/emailHTL/components/content/helloworld

Add the following HTML code that creates a basic form. 

<sly data-sly-use.clientLib="/libs/granite/sightly/templates/clientlib.html" data-sly-call="${clientLib.js @ categories='htlajax'}" data-sly-unwrap/>
<p data-sly-test="${properties.text}">Text property: ${properties.text}</p>


<h1>AEM HTL Email Template Example</h1>

</div>
          
<form method="#">
            
 <table border="1" align="left">
  
 <tr>
 <td>
<label for="hostPrefix" id="hostPrefix">A.2. Host Prefix</label>
 </td>
 <td>
 <input id="hostPrefixF" name="A.2 Host Prefix"  type="text" value="MyHost">
 </td>
 </tr> 
  
  <tr>
 <td>
<label for="forumUrl" id="forumUrl" >B2. Forum Url</label>
 </td>
 <td>
<input id="forumUrlF" name="B1. Forum Url    " type="text" value="www.myurl.com">
 </td>
 </tr> 

 <tr>
 <td>
<label for="modifiedByFullname" id="modifiedByFullname" name="modifiedByFullname">C1. Modified By Fullname     </label>
 </td>
 <td>
<input id="modifiedByFullnameF" name="C1. Modified By Fullname    " type="text" value="Tom Blue">
 </td>
 </tr> 
  
 <tr>
 <td>
<label for="TopicSubject">D1. Topic Subject </label>
 </td>
 <td>
<select id="TopicSubjectF" name="Topic Subject ">
              <option value="Home">Home Claim</option>
              <option value="Auto">Auto Claim</option>
              <option value="Boat">Boat Claim</option>
              <option value="Personal">Personnal Claim</option>
            </select>
 </td>
 </tr> 
  
 <tr>
 <td>
<label for="topicUrl" id="topicUrl" name="topicUrl">E1. Topic URL   </label>
 </td>
 <td>
<input id="topicUrlF" name="topicUrl   " type="text" value="My Topic">
 </td>
 </tr> 
  

 <tr>
 <td></td>
  
  <td>
<textarea id="message" rows="4" cols="50">
</textarea>
 </td>
  
 </tr> 
  
 <tr>
 <td></td>
 <td>
<input type="button" value="Submit"  name="submit" id="submit" value="Submit">
 
 </td>
  
 </tr> 
  
 </table>
 
</form>

In this example, notice:

<sly data-sly-use.clientLib="/libs/granite/sightly/templates/clientlib.html" data-sly-call="${clientLib.js @ categories='htlajax'}" data-sly-unwrap/> 

references a AEM ClientLibs folder named htlajax. This ClientLibs contains script that performs the AJAX operation and posts data that a user enters into the web page. THis is how you perform AJAX operations from an HTL component. 

Create the ClientLibs folder

In order to perform an AJEX operation to work with a HTL component, you need to create a ClientLibs folder. Add a cq:ClientLibraryFolder node to the Helloworld component located at:

/apps/emailHTL/components/content/helloworld/clientlibs

In this folder, add the following two files:

  • js.txt - references the script.js file
  • script.js - contains JavaScript logic that you want to use as part of your HTL component

The following code represents the script.js file

$(document).ready(function() {
  
    $('body').hide().fadeIn(5000);

   $('#submit').click(function() {
    var failure = function(err) {
             alert("Unable to retrive data "+err);
   };
  
    //Get the user-defined values that represent claim data to persist in the Adobe CQ JCR
    var hostPrefix= $('#hostPrefixF').val() ; 
    var forumUrl= $('#forumUrlF').val() ; 
    var modifiedByFullname= $('#modifiedByFullnameF').val() ; 
    var TopicSubject= $('#TopicSubjectF').val() ; 
    var topicUrl= $('#topicUrlF').val() ; 
    var message= $('#message').val() ; 

  
  
    //Use JQuery AJAX request to post data to a Sling Servlet
    $.ajax({
         type: 'POST',    
         url:'/bin/htlSearchServlet',
         data:'hostPrefix='+ hostPrefix+'&forumUrl='+ forumUrl+'&modifiedByFullname='+ modifiedByFullname+'&TopicSubject='+ TopicSubject+'&topicUrl='+ topicUrl+'&message='+ message,
         success: function(msg){
 

            $('#message').val(msg);   
         }
     });
  });

});

Assign the value htlajax to the categories property of the clientlibs node. In addition, assign the value cq.jquery to the dependencies property. This property is required to use AEM JQuery library that lets you use JQuery in the script. 

crxde
Properties that belong to the ClientLibs folder

View the output of the HTL component

To access the component, enter the following URL: 

http://localhost:4502/editor.html/content/emailHTL/en.html

The following illustration shows the HTL component.

clientaa
The HTL component created in this article

After you click the submit button, an email is sent with the submitted values, as shown in this illustration. 

email
An email that is sent from AEM

See also

Congratulations, you have just created an AEM sample application that uses a HTL component that sends email messages based on AEM email templates. Please refer to the AEM community page for other articles that discuss how to build AEM services/applications.

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy