Fundamentos de mensagens messaging-essentials
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
Lista de Mensagens
(para Caixa de entrada, Enviado e Lixeira)
Consulte também Personalizações do lado do cliente
Essentials para o lado do servidor essentials-for-server-side
- Configuração de mensagens
- APIs de cliente de mensagens para componentes SCF
- APIs de mensagens para o serviço
- Pontos de Extremidade de Mensagens
- Personalizações do lado do servidor
setInboxPath
()setSentItemsPath
()
code language-none |
---|
|
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 do 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 o evento message sent
e envia um email para todos os destinatários 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:
-
Faça logon como administrador em
[CRXDE|Lite](https://localhost:4502/crx/de)
. -
Crie um
bundle node
em/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
- Nome Simbólico:
-
Navegue até
/apps/engage/install/com.engage.media.social.messaging.MessagingNotification/src/main/java/com/engage/media/social/messaging/notification
e, em seguida:- Exclua a classe
Activator.java
criada automaticamente. - Criar classe
MessageEventHandler.java
. - Copie e cole o código abaixo em
MessageEventHandler.java
.
- Exclua a classe
-
Clique em Salvar tudo.
-
Navegue até
/apps/engage/install/com.engage.media.social.messaging.MessagingNotification/com.engage.media.social.messaging.MessagingNotification.bnd
e adicione todas as instruções de importação conforme escritas no códigoMessageEventHandler.java
. -
Crie o pacote.
-
Verifique se o serviço OSGi
Day CQ Mail Service
está configurado. -
Faça logon como um usuário de demonstração e envie email para outro usuário.
-
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();
}
}
}