DocumentationAEM 6.4Communities Guide

Messaging Feature messaging-feature

Last update: Wed May 03 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • User
CAUTION
AEM 6.4 has reached the end of extended support and this documentation is no longer updated. For further details, see our technical support periods. Find the supported versions here.

In addtion to the publicly visible interactions which occur in forums and comments, the messaging feature of AEM Communities enables community members to interact with one another more privately.

This feature may be included when a community site is created.

The messaging features provides the ability to:

  • Send a message to one or more community members
  • Send a message to a community member group
  • Send a message with attachments
  • Forward a message
  • Reply to a message
  • Delete a message
  • Restore a deleted message

In order to enable and modify the messaging feature, visit

NOTE
It is not supported to add Compose Message, Message, or Message List components (found in Communitiescomponent group) to a page in author edit mode.

Configuring Messaging Components configuring-messaging-components

When messaging is enabled for a community site, it is completely setup with no further configuration necessary. This information is provided if there is a need to change the default configuration.

Configuring Message List (messagebox) configuring-message-list-messagebox

In order to modify the configuration of the list of messages for Inbox, Sent Items, and Trash pages of the messaging feature, open the site in author edit mode.

In Preview mode, select the Messages link to open the main messaging page. Then select either Inbox, Sent Items, or Trash in order to configure the component for that message list.

In Edit mode, select the component on the page.

In order to access the configuraiton dialog, it is necessary to cancel inheritance by selecting the linkicon.

Once the configuration is complete, it is necessary to restore inheritance by selecting the broken link icon.

chlimage_1-396

Once inheritance is canceled, it will be possible to select the configure icon to open the configuration dialog.

chlimage_1-397

Basic tab basic-tab

chlimage_1-398

  • Service selector
    (Required) Set this to the value of the property serviceSelector.name from the AEM Communities Messaging Operations Service.

  • Compose Page
    (Required) The page to open when a member clicks on the Reply button. The target page should contain the Compose Message form.

  • Reply/View as Resource
    If checked, the Reply URL and View URL will reference a resource, else data is passed as query parameters in the URL.

  • Profile Display Form
    The profile form to use to display the senders profile.

  • Trash Folder
    If checked, this Message List component displays only messages flagged as deleted (trash).

  • Folder Paths
    (Required) Referencing the values set for inbox.path.name and sentitems.path.name in the AEM Communities Messaging Operations Service. When configuring for an Inbox, add one entry using the value of inbox.path.name. When configuring for an Outbox, add one entry using the value of sentitems.path.name. When configuring for Trash, add two entries with both values.

Display tab display-tab

chlimage_1-399

  • Mark Read Button
    If checked, displays a Readbutton allowing a message to be marked as read.

  • Mark Unread Button
    If checked, displays a Mark Unread button allowing a message to be marked as read.

  • Delete Button
    If checked, displays a Deletebutton allowing a message to be marked as read. Will duplicate the delete functionality if Message Options is also checked.

  • Message Options
    If checked, displays Reply, Reply All, Forward and Delete buttons allowing a message to be resent or deleted. Will duplicate the delete functionality if Delete Button is also checked.

  • Messages Per Page
    The number specified is the maximum number of messages displayed per page in a pagination scheme. If no number is specified (left blank), then all messages are displayed and there is no pagination.

  • Timestamp patterns
    Provide timestamp patterns for one or more languages. Default is for en, de, fr, it, es, ja, zh_CN, ko_KR.

  • Display User
    Choose either Sender or Recipients to determine whether to display the Sender or Recipients.

Configuring Compose Message configuring-compose-message

In order to modify the configuration of the compose message page, open the site in author edit mode.

In Previewmode, select the Messages link to open the main messaging page. Then select the New Message button to open the Compose Message page…

In Edit mode, select the main component on the page containing the Message body.

In order to access the configuraiton dialog, it is necessary to cancel inheritance by selecting the linkicon.

Once the configuration is complete, it is necessary to restore inheritance by selecting the broken link icon.

chlimage_1-400

Once inheritance is canceled, it will be possible to select the configure icon to open the configuration dialog.

chlimage_1-401

Basic tab basic-tab-1

chlimage_1-402

  • Redirect URL
    Enter the URL of the page shown after the message is sent. For example, ../messaging.html.

  • Cancel URL
    Enter the URL of the page shown if the sender cancels the message. For example, ../messaging.html.

  • Maximum length of Message Subject
    The maximum number of characters allowed in the Subject field. For example, 500. Default is no limit.

  • Maximum length of Message Body
    The maximum number of characters allowed in the Content field. For example, 10000. Default is no limit.

  • Service selector
    (Required) Set this to the value of the property serviceSelector.name from the AEM Communities Messaging Operations Service.

Display tab display-tab-1

chlimage_1-403

  • Show Subject Field
    If checked, show the Subject field and enable adding a subject to the message. Default is not checked.

  • Subject Label
    Enter the text to display next to the Subject field. Default is Subject.

  • Show Attach File Field
    If checked, show the Attachment field and enable adding file attachments to the message. Default is not checked.

  • Attach File Label
    Enter the text to display next to the Attachment field. Default is Attach File.

  • Show Content Field
    If checked, show the Content field and enable adding a message body. Default is not checked.

  • Content Label
    Enter the text to display next to the Content field. Default is Body.

  • With Rich Text Editor
    If checked, indicates use of a custom Content text box with its own rich text editor. Default is not checked.

  • Timestamp patterns
    Provide timestamp patterns for one or more languages. Default is for en, de, fr, it, es, ja, zh_CN, ko_KR.

recommendation-more-help
5d37d7b0-a330-461b-814d-068612705ff6