メッセージングの基本事項

このページでは、メッセージングコンポーネントを使用してメッセージング機能を Web サイトに組み込む方法の詳細をまとめています。

クライアント側の基本事項

メッセージを作成

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
properties 参照 メッセージの設定
管理設定 メッセージングの設定

メッセージリスト (インボックス、送信済みおよびごみ箱用)

resourceType

social/messaging/components/hbs/messagebox

clientllibs

cq.social.hbs.messaging

テンプレート /libs/social/messaging/components/hbs/messagebox/messagebox.hbs
css /libs/social/messaging/components/hbs/messagebox/clientlibs/messagebox.css
プロパティ 詳しくは、 メッセージの設定
管理設定 メッセージングの設定

クライアント側のカスタマイズも参照してください。

サーバー側の基本事項

注意

次の MessageBuilder メソッドの場合、String パラメーターの末尾にスラッシュ「/」を含めることはできません。

  • setInboxPath()
  • setSentItemsPath()

次は例です。

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

コミュニティサイト

ウィザードを使用して作成したコミュニティサイト構造には、選択したメッセージング機能が含まれています。詳しくは、 User Management 設定 コミュニティサイトコンソール.

サンプルコード:メッセージ受信通知

ソーシャルメッセージ機能では、例えば操作に対してイベントが発生します send, marking read, marking delete. これらのイベントを取得し、イベントに含まれるデータに対して実行されるアクションを取得できます。

次の例は、 message sent イベントを送信し、 Day CQ Mail Service.

サーバー側サンプルスクリプトを試すには、開発環境と OSGi バンドルのビルド機能が必要です。

  1. 管理者としてにログインします。 [CRXDE|Lite](http://localhost:4502/crx/de)

  2. の作成 bundle nodein /apps/engage/install 任意の名前を持つ

    • 記号名:com.engage.media.social.messaging.MessagingNotification
    • ​名前:Getting Started Tutorial Message Notificaton
    • 説明:ユーザーがメッセージを受信したときに電子メール通知を送信するサンプルサービス
    • パッケージ: 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 ServiceOSGi サービスが設定されている

  8. 1 人のデモユーザーとしてログインし、別のデモユーザーに電子メールを送信する

  9. 受信者は、新しいメッセージに関する E メールを受信する必要があります

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

    }
}

このページ