消息传送要点 messaging-essentials

本页记录了关于使用消息传送组件在网站上包含消息传送功能的详细信息。

适用于客户端的Essentials essentials-for-client-side

撰写邮件

resourceType
social/messaging/components/hbs/composemessage
clientllibs
cq.social.hbs.messaging
模板
/libs/social/messaging/components/hbs/composemessage/composemessage.hbs
css
/libs/social/messaging/components/hbs/composemessage/clientlibs/composemessage.css
属性
请参阅配置消息传送
管理员配置
配置消息传送

消息列表

(收件箱、已发送和垃圾桶)

resourceType
social/messaging/components/hbs/message box
clientllibs
cq.social.hbs.messaging
模板
/libs/social/messaging/components/hbs/messagebox/messagebox.hbs
css
/libs/social/messaging/components/hbs/messagebox/clientlibs/messagebox.css
属性
请参阅配置消息传送
管理员配置
配置消息传送

另请参阅客户端自定义

服务器端的Essentials essentials-for-server-side

CAUTION
对于以下MessageBuilder方法,String参数必须​ ​包含尾随斜杠“/”:
  • setInboxPath()
  • setSentItemsPath()
例如:
code language-none
valid: mb.setInboxPath( "/mail/inbox" );
 not valid: mb.setInboxPath( "/mail/inbox/" );

社区站点 community-site

使用该向导创建的社区站点结构在选中时包括消息传送功能。 查看社区站点控制台User Management设置。

示例代码:消息接收通知 sample-code-message-received-notification

Social Messaging功能会引发操作事件,例如sendmarking readmarking delete。 可以捕获这些事件,并对事件中包含的数据执行操作。

以下示例是一个事件处理程序,该处理程序监听message sent事件并使用Day CQ Mail Service向所有邮件收件人发送电子邮件。

要试用服务器端示例脚本,您需要一个开发环境和构建OSGi捆绑包的功能:

  1. 以管理员身份登录 [CRXDE|Lite](https://localhost:4502/crx/de)

  2. /apps/engage/install中创建具有任意名称的bundle node,例如:

    • 符号名称: com.engage.media.social.messaging.MessagingNotification
    • 名称:入门教程消息通知
    • 描述:用于在用户收到消息时向其发送电子邮件通知的示例服务
    • 包: com.engage.media.social.messaging.notification
  3. 导航到/apps/engage/install/com.engage.media.social.messaging.MessagingNotification/src/main/java/com/engage/media/social/messaging/notification,然后:

    1. 删除自动创建的Activator.java类。
    2. 创建类MessageEventHandler.java
    3. 将下面的代码复制并粘贴到MessageEventHandler.java中。
  4. 单击​ 全部保存

  5. 导航到/apps/engage/install/com.engage.media.social.messaging.MessagingNotification/com.engage.media.social.messaging.MessagingNotification.bnd,并添加所有在MessageEventHandler.java代码中写入的import语句。

  6. 构建捆绑包。

  7. 确保已配置Day CQ Mail ServiceOSGi服务。

  8. 以演示用户身份登录,并向其他用户发送电子邮件。

  9. 收件人将收到有关新消息的电子邮件。

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