Messaging Essentials

本頁面記錄使用傳訊元件以在網站上包含傳訊功能的詳細資訊。

用戶端的要點

撰寫訊息

resourceType

社交/傳訊/元件/hbs/組合訊息

clientllibs

cq.social.hbs.messaging

範本 /libs/social/messaging/components/hbs/composemessage/composemessage.hbs
cs /libs/social/messaging/components/hbs/composemessage/clientlibs/composemessage.css
屬性 請參閱 配置消息
管理組態 配置消息

訊息清單

(用於收件匣、已傳送和清除)

resourceType

社交/傳訊/元件/hbs/messagebox

clientllibs

cq.social.hbs.messaging

範本 /libs/social/messaging/components/hbs/messagebox/messagebox.hbs
cs /libs/social/messaging/components/hbs/messagebox/clientlibs/messagebox.css
屬性 請參閱 配置消息
管理組態 配置消息

另請參閱 用戶端自訂

伺服器端的Essentials

注意

字串參數必須 not 包含下列MessageBuilder方法的尾隨斜線「/」:

  • setInboxPath()
  • setSentItemsPath()

例如:

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

社群網站

使用精靈建立的社群網站結構,會在選取時包含傳訊功能。 請參閱 User Management 設定 社群網站主控台.

程式碼範例:收到的消息通知

Social傳訊功能會擲回操作的事件,例如 send, marking read, marking delete. 您可以擷取這些事件,並對事件中包含的資料採取動作。

以下範例為事件處理常式,其偵聽 message sent 事件,並使用 Day CQ Mail Service.

若要試用伺服器端範例指令碼,您需要開發環境和建立OSGi套件組合的能力:

  1. 以管理員身分登入以 [CRXDE|Lite](https://localhost:4502/crx/de).

  2. 建立 bundle nodein /apps/engage/install 具有任意名稱,例如:

    • 符號名稱: 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 程式碼。

  6. 建立套件組合。

  7. 確保 Day CQ Mail Service已配置OSGi服務。

  8. 以示範使用者身分登入,並傳送電子郵件給其他使用者。

  9. 收件者會收到有關新訊息的電子郵件。

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

    }
}

本頁內容