Messaging Essentials

Last update: 2023-11-06
  • Created for:
  • User

This page documents the details of working with using the Messaging component to include a messaging feature on a website.

Essentials for Client-Side

Compose Message




templates /libs/social/messaging/components/hbs/composemessage/composemessage.hbs
css /libs/social/messaging/components/hbs/composemessage/clientlibs/composemessage.css
properties See Configure Messaging
admin configuration Configure Messaging

Message List

(For Inbox, Sent, and Trash)




templates /libs/social/messaging/components/hbs/messagebox/messagebox.hbs
css /libs/social/messaging/components/hbs/messagebox/clientlibs/messagebox.css
properties See Configure Messaging
admin configuration Configure Messaging

See also Client-side Customizations

Essentials for Server-Side


The String parameter must not contain a trailing slash “/” for the following MessageBuilder methods:

  • setInboxPath()
  • setSentItemsPath()

For example:

valid: mb.setInboxPath( "/mail/inbox" );
 not valid: mb.setInboxPath( "/mail/inbox/" );

Community Site

A community site structure, created using the wizard, includes the messaging feature when selected. See User Management settings of Community Sites Console.

Sample Code: Message Received Notification

The Social Messaging feature throws events for operations, for example, send, marking read, marking delete. These events can be caught and actions taken on the data contained in the event.

The following example is of an event handler which listens for the message sent event and sends an email to all message recipients using the Day CQ Mail Service.

To try the server-side sample script, you need a development environment and the ability to build an OSGi bundle:

  1. Log in as an administrator to [CRXDE|Lite](https://localhost:4502/crx/de).

  2. Create a bundle nodein /apps/engage/install with arbitrary names, such as:

    • Symbolic Name:
    • Name: Getting Started Tutorial Message Notification
    • Description: A sample service for sending an email notification to users when they receive a message
    • Package:
  3. Navigate to /apps/engage/install/, and then:

    1. Delete the class automatically created.
    2. Create class
    3. Copy and paste the code below into
  4. Click Save All.

  5. Navigate to /apps/engage/install/, and add all the import statements as written in the code.

  6. Build the bundle.

  7. Ensure Day CQ Mail ServiceOSGi service is configured.

  8. Log in as a demo user, and send email to another user.

  9. The recipient receives an email regarding a new message.


import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Properties;
import org.apache.felix.scr.annotations.Property;
import org.apache.felix.scr.annotations.Service;
import org.apache.felix.scr.annotations.Reference;
import org.apache.commons.mail.Email;
import org.apache.commons.mail.EmailException;
import org.apache.commons.mail.SimpleEmail;
import org.apache.commons.mail.HtmlEmail;
import java.util.List;
import org.osgi.service.event.Event;
import org.osgi.service.event.EventHandler;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

        @Property(name = "event.topics", value = "com/adobe/cq/social/message")
public class MessagingEventHandler implements EventHandler {
    private Logger logger = LoggerFactory.getLogger(MessagingEventHandler.class);

    ResourceResolverFactory resourceResolverFactory;

    private MessageGatewayService messageGatewayService;

    ResourceResolver resourceResolver=null;
    MessageGateway messageGateway=null;

    public void sendMail(String from, String to,String subject, String content){
        Email email = new SimpleEmail();
        messageGateway = messageGatewayService.getGateway(SimpleEmail.class);
        try {
        } catch(EmailException ex) {
            logger.error("MessageNotificaiton : Error sending email : "+ex.getMessage());
        }"**** MessageNotification **** Mail sent to " + to);

    public void handleEvent(Event event) {
        //Get Message Path and originator User's ID from event
        String messagePath = (String) event.getProperty("path");
        String senderId = (String) event.getProperty("userId");
        MessagingEvent.MessagingActions action = (MessagingEvent.MessagingActions) event.getProperty("action");
                resourceResolver = resourceResolverFactory.getAdministrativeResourceResolver(null);

                //Read message
                Resource resource = resourceResolver.getResource(messagePath);
                Message msg = resource.adaptTo(Message.class);

                //Get list of recipient Ids from message
                //For Getting Started Tutorial, Id is same as email. If that is not the case in your site,
                //an additional step is needed to retrieve the email for the Id
                List<String> reclist = msg.getRecipientIdList();
                for(int i=0;i<reclist.size();i++){
                    //Send Email using Mailing Service
                    sendMail("admin@cqadmin.qqq",reclist.get(i),"New message on Getting Started Tutorial", "Hi\nYou have received a new message from  " +  senderId + ". To read it, sign in to Getting Started Tutorial.\n\n-Engage Admin");
        } catch(Exception ex){
            logger.error("Error getting message info : " + ex.getMessage());
        } finally {


On this page