Nozioni di base sui messaggi

Questa pagina illustra i dettagli dell’utilizzo del componente Messaggi per includere una funzione di messaggistica in un sito Web.

Essentials for Client-Side

Componi messaggio

resourceType

social/messaging/components/hbs/composemessaggio

clientllibs

cq.social.hbs.messaging

templates /libs/social/messaging/components/hbs/composemessage/composemessage.hbs
css /libs/social/messaging/components/hbs/composemessage/clientlibs/composemessage.css
proprietà Vedere Configurare i messaggi
configurazione amministratore Configurare i messaggi

Elenco messaggi

(per Inbox, Inviato e Cestino)

resourceType

social/messaging/components/hbs/messagebox

clientllibs

cq.social.hbs.messaging

templates /libs/social/messaging/components/hbs/messagebox/messagebox.hbs
css /libs/social/messaging/components/hbs/messagebox/clientlibs/messagebox.css
proprietà Vedere Configurare i messaggi
configurazione amministratore Configurare i messaggi

Vedere anche Personalizzazioni lato client

Essentials for Server-Side

CAUTION

Il parametro String deve contenere not una barra finale "/" per i seguenti metodi di MessageBuilder:

  • setInboxPath()
  • setSentItemsPath()

Esempio:

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

Sito community

Una struttura del sito community, creata utilizzando la procedura guidata, include la funzione di messaggistica selezionata. Vedere Impostazioni User Management della console Siti della community.

Codice di esempio: Messaggio ricevuto notifica

La funzione Messaggi social genera eventi per le operazioni, ad esempio send, marking read, marking delete. Questi eventi possono essere rilevati e le azioni eseguite sui dati contenuti nell’evento.

L'esempio seguente fa riferimento a un gestore eventi in ascolto dell'evento message sent e invia un'e-mail a tutti i destinatari del messaggio utilizzando la variabile Day CQ Mail Service.

Per provare lo script di esempio lato server, è necessario un ambiente di sviluppo e la capacità di creare un bundle OSGi:

  1. Accedete come amministratore a [CRXDE|Lite](https://localhost:4502/crx/de).

  2. Create un bundle nodein /apps/engage/install con nomi arbitrari, ad esempio:

    • Nome simbolico: com.engage.media.social.messaging.MessagingNotification
    • Nome: Notifica dei messaggi per l’esercitazione introduttiva
    • Descrizione: Un servizio di esempio per inviare una notifica e-mail agli utenti che ricevono un messaggio
    • Pacchetto: com.engage.media.social.messaging.notification
  3. Passare a /apps/engage/install/com.engage.media.social.messaging.MessagingNotification/src/main/java/com/engage/media/social/messaging/notification, quindi:

    1. Eliminate la classe Activator.java creata automaticamente.
    2. Creare la classe MessageEventHandler.java.
    3. Copiate e incollate il codice riportato di seguito in MessageEventHandler.java.
  4. Fare clic su Salva tutto.

  5. Passare a /apps/engage/install/com.engage.media.social.messaging.MessagingNotification/com.engage.media.social.messaging.MessagingNotification.bnd e aggiungere tutte le istruzioni di importazione come scritte nel codice MessageEventHandler.java.

  6. Create il bundle.

  7. Verificare che il servizio Day CQ Mail ServiceOSGi sia configurato.

  8. Effettuate l'accesso come utente dimostrativo e inviate un'e-mail a un altro utente.

  9. Il destinatario riceve un'e-mail relativa a un nuovo messaggio.

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();
        }

    }
}

In questa pagina