DocumentaçãoAEM 6.5Guia do Communities

Fundamentos de mensagens messaging-essentials

Last update: Tue Nov 07 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

Criado para:

  • User

Esta página documenta os detalhes de como trabalhar com o usando o componente Mensagens para incluir um recurso de mensagens em um site.

Essentials para o lado do cliente essentials-for-client-side

Compor mensagem

resourceType
social/messaging/components/hbs/composemessage
clientllibs
cq.social.hbs.messaging
modelos
/libs/social/messaging/components/hbs/composemessage/composemessage.hbs
css
/libs/social/messaging/components/hbs/composemessage/clientlibs/composemessage.css
propriedades
Consulte Configurar mensagens
configuração do administrador
Configurar mensagens

Lista de mensagens

(para Caixa de entrada, Enviado e Lixeira)

resourceType
social/messaging/components/hbs/messagebox
clientllibs
cq.social.hbs.messaging
modelos
/libs/social/messaging/components/hbs/messagebox/messagebox.hbs
css
/libs/social/messaging/components/hbs/messagebox/clientlibs/messagebox.css
propriedades
Consulte Configurar mensagens
configuração do administrador
Configurar mensagens

Consulte também Personalizações do lado do cliente

Essentials para o lado do servidor essentials-for-server-side

CAUTION
O parâmetro String deve não contém uma barra à direita "/" para os seguintes métodos do MessageBuilder:
  • setInboxPath()
  • setSentItemsPath()
Por exemplo:
code language-none 
valid: mb.setInboxPath( "/mail/inbox" );
 not valid: mb.setInboxPath( "/mail/inbox/" );

Site da comunidade community-site

Uma estrutura de site da comunidade, criada usando o assistente, inclui o recurso de mensagens quando selecionado. Consulte User Management configurações de Console de sites da comunidade.

Código de exemplo: Notificação de mensagem recebida sample-code-message-received-notification

O recurso Social Messaging lança eventos para operações, por exemplo, send, marking read, marking delete. Esses eventos podem ser capturados e as ações tomadas nos dados contidos no evento.

O exemplo a seguir é de um manipulador de eventos que escuta a message sent evento e envia um email a todos os recipients de mensagem usando o Day CQ Mail Service.

Para experimentar o script de amostra do lado do servidor, você precisa de um ambiente de desenvolvimento e da capacidade de criar um pacote OSGi:

  1. Efetue login como administrador no [CRXDE|Lite](https://localhost:4502/crx/de).

  2. Criar um bundle nodein /apps/engage/install com nomes arbitrários, como:

    • Nome simbólico: com.engage.media.social.messaging.MessagingNotification
    • Nome: Notificação de mensagem do tutorial de introdução
    • Descrição: Um exemplo de serviço para enviar uma notificação por email aos usuários quando eles recebem uma mensagem
    • Pacote: com.engage.media.social.messaging.notification

  3. Navegue até /apps/engage/install/com.engage.media.social.messaging.MessagingNotification/src/main/java/com/engage/media/social/messaging/notificatione depois:

    1. Exclua o Activator.java classe criada automaticamente.
    2. Criar classe MessageEventHandler.java.
    3. Copie e cole o código abaixo em MessageEventHandler.java.

  4. Clique em Salvar tudo.

  5. Navegue até /apps/engage/install/com.engage.media.social.messaging.MessagingNotification/com.engage.media.social.messaging.MessagingNotification.bnde adicione todas as declarações de importação conforme redigidas no MessageEventHandler.java código.

  6. Crie o pacote.

  7. Assegurar Day CQ Mail ServiceO serviço OSGi está configurado.

  8. Faça logon como um usuário de demonstração e envie email para outro usuário.

  9. O recipient recebe um email sobre uma nova mensagem.

MessageEventHandler.java messageeventhandler-java

package com.engage.media.social.messaging.notification;

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.sling.api.resource.ResourceResolver;
import org.apache.sling.api.resource.ResourceResolverFactory;
import org.apache.sling.api.resource.Resource;
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;
import com.adobe.cq.social.messaging.api.Message;
import com.adobe.cq.social.messaging.api.MessagingEvent;
import com.day.cq.mailer.MessageGatewayService;
import com.day.cq.mailer.MessageGateway;

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

    @Reference
    ResourceResolverFactory resourceResolverFactory;

    @Reference
    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 {
         email.addTo(to);
            email.addReplyTo(from);
            email.setFrom(from);
            email.setMsg(content);
            email.setSubject(subject);
         messageGateway.send(email);
        } catch(EmailException ex) {
            logger.error("MessageNotificaiton : Error sending email : "+ex.getMessage());
        }
        logger.info("**** 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");
        try{
            if(MessagingEvent.MessagingActions.MessageSent.equals(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 {
            resourceResolver.close();
        }

    }
}
recommendation-more-help
81e2cd9d-0789-409d-b87c-2a8ce4f28791