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

このページでは、メッセージコンポーネントを使用してを Web サイトのメッセージング機能に含める方法の詳細について説明します。

クライアントサイドの基本事項 essentials-for-client-side

メッセージを作成

resourceType
ソーシャル/メッセージング/コンポーネント/hbs/composemessage
clientlibs
cq.social.hbs.messaging
templates
/libs/social/messaging/components/hbs/composemessage/composemessage.hbs
css
/libs/social/messaging/components/hbs/composemessage/clientlibs/composemessage.css
properties
メッセージングの設定を参照してください。
管理設定
メッセージングの設定

メッセージリスト

(インボックス、送信済み、ごみ箱の場合)

resourceType
ソーシャル/メッセージング/コンポーネント/hbs/messagebox
clientlibs
cq.social.hbs.messaging
templates
/libs/social/messaging/components/hbs/messagebox/messagebox.hbs
css
/libs/social/messaging/components/hbs/messagebox/clientlibs/messagebox.css
properties
メッセージングの設定を参照してください。
管理設定
メッセージングの設定

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

サーバーサイドの初期設定 essentials-for-server-side

CAUTION
次の MessageBuilder メソッドでは、文字列パラメーターに末尾のスラッシュ「/」を含める しないでください
  • 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

ソーシャルメッセージング機能は、操作(sendmarking readmarking 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 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