このページでは、メッセージングコンポーネントを使用してメッセージング機能を 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メソッドの文字列パラメーターは、**ではなく、末尾にスラッシュ「/」を含める必要があります。
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バンドルを構築する機能が必要です。
[CRXDE|Lite](https://localhost:4502/crx/de)
に管理者としてログインします。
/apps/engage/install
内に、次のような任意の名前のbundle node
を作成します。
com.engage.media.social.messaging.MessagingNotification
com.engage.media.social.messaging.notification
/apps/engage/install/com.engage.media.social.messaging.MessagingNotification/src/main/java/com/engage/media/social/messaging/notification
に移動し、次の操作を行います。
Activator.java
クラスを削除します。MessageEventHandler.java
を作成します。MessageEventHandler.java
に貼り付けます。「すべて保存」をクリックします。
/apps/engage/install/com.engage.media.social.messaging.MessagingNotification/com.engage.media.social.messaging.MessagingNotification.bnd
に移動し、MessageEventHandler.java
コードに記述されているように、すべてのimport文を追加します。
バンドルをビルドします。
Day CQ Mail Service
OSGiサービスが設定されていることを確認します。
デモユーザーとしてログインし、別のユーザーに電子メールを送信します。
受信者に、新しいメッセージに関するEメールが届きます。
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();
}
}
}