電子メール通知の設定

AEM は、次のようなユーザーに電子メール通知を送信します。

  • 変更やレプリケーションなど、ページイベントを購読したことがある。通知インボックスでは、このようなイベントを購読する方法について説明します。

  • フォーラムイベントを購読したことがある

  • ワークフローで手順を実行する必要がある。参加者ステップでは、ワークフローで電子メール通知を実行する方法について説明します。

前提条件:

  • ユーザーのプロファイルで有効な電子メールアドレスが定義されている必要があります。
  • Day CQ Mail Service​を正しく設定する必要があります。

ユーザーへの通知は、各自がプロファイルで定義している言語の電子メールで送信されます。言語ごとに、独自のカスタマイズ可能なテンプレートがあります。新しい言語用には新しい電子メールテンプレートを追加できます。

メモ

AEM を操作しているときは、このようなサービスの設定を管理する方法がいくつかあります。詳細および推奨事項については、OSGi の設定を参照してください。

メールサービスの設定

AEM で電子メールを送信できるようにするために、Day CQ Mail Service を適切に設定する必要があります。設定は、Web コンソールで表示できます。AEM を操作しているときは、このようなサービスの設定を管理する方法がいくつかあります。詳細および推奨事項については、OSGi の設定を参照してください。

以下の制約が適用されます。

  • SMTP サーバーポート​は 25 以上にする必要があります。

  • SMTPサーバーのホスト名​は空白にできません。

  • 「送信元」アドレス​は空白にしてはなりません。

Day CQ Mail Service の問題をデバッグしやすくするために、サービスのログを監視できます。

com.day.cq.mailer.DefaultMailService

設定は、Web コンソールに次のように表示されます。

chlimage_1-276

電子メール通知チャネルの設定

ページまたはフォーラムのイベント通知を購読するとき、送信元の電子メールアドレスは、デフォルトで no-reply@acme.com に設定されます。この値は、Web コンソールで Notification Email Channel サービスを設定することで変更できます。

差出人の電子メールアドレスを設定するには、リポジトリにsling:OsgiConfigノードを追加します。 次の手順を実行し、ノードを直接CRXDE Liteします。

  1. CRXDE Lite で、config という名前のノードを、アプリケーションフォルダーの下に追加します。

  2. configフォルダーに、次の名前のノードを追加します。

    com.day.cq.wcm.notification.email.impl.EmailChannelリソースのタイプは次のとおりとします。sling:OsgiConfig

  3. Stringプロパティをemail.fromという名前のノードに追加します。 値には、使用する電子メールアドレスを指定します。

  4. すべて保存」をクリックします。

次の手順を使用して、コンテンツパッケージソースフォルダーでノードを定義します。

  1. jcr_root/apps/*app_name*/config folderに、com.day.cq.wcm.notification.email.impl.EmailChannel.xmlという名前のファイルを作成します。

  2. このノードを表現する次の XML を追加します。

    <?xml version="1.0" encoding="UTF-8"?> <jcr:root xmlns:sling="https://sling.apache.org/jcr/sling/1.0" xmlns:jcr="https://www.jcp.org/jcr/1.0" jcr:primaryType="sling:OsgiConfig" email.from="name@server.com"/>

  3. email.from 属性の値(name@server.com)を、実際の電子メールアドレスに置き換えます。

  4. ファイルを保存します。

ワークフロー電子メール通知サービスの設定

ワークフロー電子メール通知を受信したとき、送信元電子メールアドレスとホスト URL プレフィックスはいずれもデフォルトに設定されています。これらの値は、Web コンソールで Day CQ Workflow Email Notification Service を設定することによって変更できます。その場合は、変更をリポジトリに保持することをお勧めします。

デフォルト設定は、Web コンソールに次のように表示されます。

chlimage_1-277

ページ通知用の電子メールテンプレート

ページ通知用の電子メールテンプレートは次の場所にあります。

/etc/notification/email/default/com.day.cq.wcm.core.page

デフォルトの英語のテンプレート(en.txt)は次のように定義されています。

subject=[CQ Page Event Notification]: Page Event

header=-------------------------------------------------------------------------------------\n \
Time: ${time}\n \
User: ${userFullName} (${userId})\n \
-------------------------------------------------------------------------------------\n\n

message=The following pages were affected by the event: \n \
 \n \
${modifications} \n \
 \n\n
footer=\n \
-------------------------------------------------------------------------------------\n \
This is an automatically generated message. Please do not reply.

ページ通知用の電子メールテンプレートのカスタマイズ

ページ通知用の英語の電子メールテンプレートをカスタマイズするには:

  1. CRXDEで、次のファイルを開きます。

    /etc/notification/email/default/com.day.cq.wcm.core.page/en.txt

  2. ニーズに合わせてファイルを変更します。

  3. 変更内容を保存します。

テンプレートには以下の書式が必要です。

 subject=<text_1>
 header=<text_2>
 message=<text_3>
 footer=<text_4>

<text_x> には、静的テキストと動的文字列変数を混在させることができます。ページ通知用の電子メールテンプレート内では次の変数を使用できます。

  • ${time}、イベントの日時。

  • ${userFullName}:イベントをトリガーしたユーザーの完全名。

  • ${userId}:イベントをトリガーしたユーザーのID。

  • ${modifications}は、ページイベントのタイプとページパスを次の形式で表します。

    <page event="" type=""> => <page path="">

    次に例を示します。

    PageModified => /content/geometrixx/en/products

フォーラム通知用の電子メールテンプレート

フォーラム通知用の電子メールテンプレートは次の場所にあります。

/etc/notification/email/default/com.day.cq.collab.forum

デフォルトの英語のテンプレート(en.txt)は次のように定義されています。

subject=[CQ Forum Notification]

header=-------------------------------------------------------------------------------------\n \
Time: Time: ${time}\n \
Forum Page Path: ${forum.path}\n \
-------------------------------------------------------------------------------------\n\n

message=Page: ${host.prefix}${forum.path}.html\n

footer=\n \
-------------------------------------------------------------------------------------\n \
This is an automatically generated message. Please do not reply.

フォーラム通知用の電子メールテンプレートのカスタマイズ

フォーラム通知用の英語の電子メールテンプレートをカスタマイズするには:

  1. CRXDEで、次のファイルを開きます。

    /etc/notification/email/default/com.day.cq.collab.forum/en.txt

  2. ニーズに合わせてファイルを変更します。

  3. 変更内容を保存します。

テンプレートには以下の書式が必要です。

 subject=<text_1>
 header=<text_2>
 message=<text_3>
 footer=<text_4>

<text_x>は、静的テキストと動的文字列変数を組み合わせた値にすることができます。

フォーラム通知用の電子メールテンプレート内では次の変数を使用できます。

  • ${time}、イベントの日時。

  • ${forum.path}:フォーラムページへのパス。

ワークフロー通知用の電子メールテンプレート

ワークフロー通知用の電子メールテンプレート(英語)は次の場所にあります。

/etc/workflow/notification/email/default/en.txt

次のように定義されています。

subject=Workflow notification: ${event.EventType}

header=-------------------------------------------------------------------------------------\n \
Time: ${event.TimeStamp}\n \
Step: ${item.node.title}\n \
User: ${participant.name} (${participant.id})\n \
Workflow: ${model.title}\n \
-------------------------------------------------------------------------------------\n\n

message=Content: ${host.prefix}${payload.path.open}\n

footer=\n \
-------------------------------------------------------------------------------------\n \
View the overview in your ${host.prefix}/aem/inbox\n \
-------------------------------------------------------------------------------------\n \
This is an automatically generated message. Please do not reply.

ワークフロー通知用の電子メールテンプレートのカスタマイズ

ワークフローイベント通知用の英語の電子メールテンプレートをカスタマイズするには:

  1. CRXDEで、次のファイルを開きます。

    /etc/workflow/notification/email/default/en.txt

  2. ニーズに合わせてファイルを変更します。

  3. 変更内容を保存します。

テンプレートには以下の書式が必要です。

subject=<text_1>
 header=<text_2>
 message=<text_3>
 footer=<text_4>
メモ

<text_x>は、静的テキストと動的文字列変数を組み合わせた値にすることができます。 <text_x>項目の各行は、最後のインスタンスを除き、バックスラッシュ(\)で終わる必要があります。バックスラッシュがない場合、<text_x>文字列変数の終わりを示します。

テンプレート形式について詳しくは、Properties.load() メソッドの javadocs を参照してください。

メソッド${payload.path.open}は、作業項目のペイロードへのパスを表示します。 例えば、Sitesのページの場合、payload.path.open/bin/wcmcommand?cmd=open&path=…に似ています。;これはサーバー名が付いていないので、テンプレートでは${host.prefix}が先頭に追加されます。

電子メールテンプレート内では以下の変数を使用できます。

  • ${event.EventType}、イベントのタイプ

  • ${event.TimeStamp}、イベントの日時

  • ${event.User}:イベントをトリガーしたユーザー

  • ${initiator.home}、イニシエータノードパス

  • ${initiator.name}、イニシエータ名

  • ${initiator.email}(イニシエーターのEメールアドレス)

  • ${item.id}(作業項目のID)

  • ${item.node.id}(この作業項目に関連付けられたワークフローモデル内のノードのid)

  • ${item.node.title}(作業項目のタイトル)

  • ${participant.email}(参加者の電子メールアドレス)

  • ${participant.name}、参加者の名前

  • ${participant.familyName}(参加者の姓)

  • ${participant.id}、参加者のid

  • ${participant.language}、参加者の言語

  • ${instance.id}、ワークフローID

  • ${instance.state}(ワークフローの状態)

  • ${model.title}(ワークフローモデルのタイトル)

  • ${model.id}(ワークフローモデルのid)

  • ${model.version}(ワークフローモデルのバージョン)

  • ${payload.data}、ペイロード

  • ${payload.type}、ペイロードタイプ

  • ${payload.path}(ペイロードのパス)

  • ${host.prefix}、ホストプレフィックス。例:http://localhost:4502

新しい言語用の電子メールテンプレートの追加

新しい言語用のテンプレートを追加するには:

  1. CRXDEで、以下に<language-code>.txtファイルを追加します。

    • /etc/notification/email/default/com.day.cq.wcm.core.page :(ページ通知の場合)
    • /etc/notification/email/default/com.day.cq.collab.forum :フォーラム通知
    • /etc/workflow/notification/email/default :ワークフロー通知の場合
  2. 言語に合わせてファイルを調整します。

  3. 変更内容を保存します。

メモ

電子メールテンプレートのファイル名として使用される<language-code>は、AEMで認識される2文字の小文字の言語コードにする必要があります。 言語コードについては、AEM は ISO-639-1 に依存しています。

AEM Assets の電子メール通知の設定

AEM Assets のコレクションが共有されている場合も共有されていない場合も、AEM から電子メール通知を受信できます。電子メール通知を設定するには、次の手順に従います。

  1. メールサービスの設定で説明したように、電子メールサービスを設定します。
  2. AEM に管理者としてログインします。ツール操作Web コンソール​をクリックして、Web コンソール設定を開きます。
  3. Day CQ DAM Resource Collection Servlet を編集します。「send email」を選択します。「保存」をクリックします。

OAuthの設定

AEMは、組織が安全な電子メール要件に準拠できるように、OAuth2の統合メーラーサービスをサポートしています。

以下に示すように、複数のEメールプロバイダーに対してOAuthを設定できます。

Gmail

  1. https://console.developers.google.com/projectcreateにプロジェクトを作成します。
  2. プロジェクトを選択し、APIとサービス - ダッシュボード — 資格情報​に移動します。
  3. 必要に応じてOAuth同意画面を設定する
  4. 次の[更新]画面で、次の2つのスコープを追加します。
    • https://mail.google.com/
    • https://www.googleapis.com//auth/gmail.send
  5. スコープを追加したら、左側のメニューの「資格情報」に戻り、「資格情報を作成 - OAuthクライアントID - デスクトップアプリ」に戻ります。
  6. 新しいウィンドウが開き、クライアントIDとクライアント秘密鍵が表示されます。
  7. これらの資格情報を保存します。

AEM側の設定

メモ

Adobe管理サービスのお客様は、カスタマーサービスエンジニアと協力して、これらの変更を実稼動環境に加えることができます。

最初に、メールサービスを設定します。

  1. http://serveraddress:serverport/system/console/configMgrに移動して、AEM Webコンソールを開きます。
  2. を探して、「Day CQ Mail Service」をクリックします。
  3. 次の設定を追加します。
    • SMTP サーバーのホスト名: smtp.gmail.com
    • SMTPサーバーポート:25または587(要件に応じて)
    • SMPTでStarTLS​を使用し、SMTPでStarTLS​が必要になるかどうかを確認します。
    • OAuth flow​を確認し、「保存」をクリックします。

次に、以下の手順に従って、SMTP OAuthプロバイダーを設定します。

  1. http://serveraddress:serverport/system/console/configMgrに移動して、AEM Webコンソールを開きます。
  2. を探して、CQ Mailer SMTP OAuth2 Provider​をクリックします。
  3. 必要な情報を次のように入力します。
    • 認証URL:https://accounts.google.com/o/oauth2/auth
    • トークンURL:https://accounts.google.com/o/oauth2/token
    • スコープ:https://www.googleapis.com/auth/gmail.sendhttps://mail.google.com/が表示されます。 設定済みの各スコープの右側にある​+​ボタンを押すと、複数のスコープを追加できます。
    • クライアントIDとクライアント秘密鍵:上記の段落で説明したように取得した値を使用して、これらのフィールドを設定します。
    • 更新トークン URL: https://accounts.google.com/o/oauth2/token
    • 更新トークンの有効期限:never
  4. 保存」をクリックします。

設定が完了すると、設定は次のようになります。

oauth smtpプロバイダ

次に、OAuthコンポーネントをアクティブ化します。 手順は次のとおりです。

  1. 次のURLにアクセスして、コンポーネントコンソールに移動します。http://serveraddress:serverport/system/console/components

  2. 次のコンポーネントを探します。

    • com.day.cq.mailer.oauth.servlets.handler.OAuthCodeGenerateServlet
    • com.day.cq.mailer.oauth.servlets.handler.OAuthCodeAccessTokenGenerator
  3. コンポーネントの左側にある再生アイコンを押します。

    コンポーネント

最後に、次の手順で設定を確認します。

  1. パブリッシュインスタンスのアドレスに移動し、管理者としてログインします。
  2. ブラウザーで新しいタブを開き、http://serveraddress:serverport/services/mailer/oauth2/authorizeに移動します。 これにより、SMTPプロバイダー(この場合はGmail)のページにリダイレクトされます。
  3. ログインと、必要な権限の付与に対する同意
  4. 同意した後、トークンはリポジトリに保存されます。 accessTokenの下でこのURLに直接アクセスするには、パブリッシュインスタンスで次のURLに直接アクセスします。http://serveraddress:serverport/crx/de/index.jsp#/conf/global/settings/mailer/oauth2
  5. パブリッシュインスタンスごとに上記を繰り返します。

Microsoft Outlook

  1. https://portal.azure.com/に移動し、ログインします。

  2. 検索バーで​Azure Active Directory​を検索し、結果をクリックします。 または、https://portal.azure.com/#blade/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/Overviewを直接参照することもできます。

  3. アプリの登録 - 新しい登録​をクリックします。

  4. 必要に応じて情報を入力し、登録​をクリックします。

  5. 新しく作成されたアプリに移動し、API権限​を選択します。

  6. 権限​を追加 — グラフ権限 - 委任権限​に移動します。

  7. アプリに対して以下の権限を選択し、「権限を追加」をクリックします。

    • SMTP.Send
    • Mail.Read
    • Mail.Send
    • openid
    • offline_access
  8. 認証 - プラットフォーム - Web​を追加し、「リダイレクトURL」セクションに次のURLを追加してOAuthコードをリダイレクトし、設定​を押します。

    • http://localhost:4503/services/mailer/oauth2/token
  9. パブリッシュインスタンスごとに上記を繰り返します。

  10. 要件に従って設定を指定します

  11. 次に、「証明書とシークレット」に移動し、「新しいクライアントシークレット」をクリックし、画面の手順に従ってシークレットを作成します。 後で使用するために、必ずこの秘密を書き留めてください

  12. 左側のウィンドウで​Overview​を押し、後で使用するために、Application (client) ID​および​Directory (tenant) ID​の値をコピーします。

要約すると、AEM側でMailerサービスのOAuth2を設定するには、次の情報が必要です。

  • 認証URL。テナントIDを使用して構築されます。 次の形式になります。https://login.microsoftonline.com/<tenantID>/oauth2/v2.0/authorize
  • トークンURL。テナントIDを使用して構築されます。 次の形式になります。https://login.microsoftonline.com/<tenantID>/oauth2/v2.0/token
  • 更新URL。テナントIDを使用して構築されます。 次の形式になります。https://login.microsoftonline.com/<tenantID>/oauth2/v2.0/token
  • クライアントID
  • クライアント秘密鍵

AEM側の設定

次に、OAuth2設定をAEMと統合します。

  1. http://serveraddress:serverport/system/console/configMgrを参照して、ローカルインスタンスのWebコンソールに移動します。
  2. Day CQ Mail Service​を探してクリックします。
  3. 次の設定を追加します。
    • SMTP サーバーのホスト名: smtp.office365.com
    • SMTPユーザー:電子メール形式のユーザー名
    • "差出人"アドレス:メーラーから送信されるメッセージの「差出人:」フィールドで使用する電子メールアドレス
    • SMTPサーバーポート:要件に応じて25または587
    • SMPTでStarTLS​を使用し、SMTPでStarTLS​が必要になるかどうかを確認します。
    • OAuth flow​を確認し、「保存」をクリックします。
  4. を探して、CQ Mailer SMTP OAuth2 Provider​をクリックします。
  5. 必要な情報を次のように入力します。
    • この手順の最後で説明したように、認証URL、トークンURL、更新トークンURLを作成して入力します。
    • クライアントIDとクライアント秘密鍵:これらのフィールドに、前述のように取得した値を設定します。
    • 次のスコープを構成に追加します。
      • openid
      • offline_access
      • https://outlook.office365.com/Mail.Send
      • https://outlook.office365.com/Mail.Read
      • https://outlook.office365.com/SMTP.Send
    • AuthCodeリダイレクトUrl:http://localhost:4503/services/mailer/oauth2/token
    • 更新トークンURL:これは、上記のトークンURLと同じ値にする必要があります
  6. 保存」をクリックします。

設定が完了すると、設定は次のようになります。

次に、OAuthコンポーネントをアクティブ化します。 手順は次のとおりです。

  1. 次のURLにアクセスして、コンポーネントコンソールに移動します。http://serveraddress:serverport/system/console/components
  2. 次のコンポーネントを探します。
    • com.day.cq.mailer.oauth.servlets.handler.OAuthCodeGenerateServlet
    • com.day.cq.mailer.oauth.servlets.handler.OAuthCodeAccessTokenGenerator
  3. コンポーネントの左側にある再生アイコンを押します。

components2

最後に、次の手順で設定を確認します。

  1. パブリッシュインスタンスのアドレスに移動し、管理者としてログインします。
  2. ブラウザーで新しいタブを開き、http://serveraddress:serverport/services/mailer/oauth2/authorizeに移動します。 これにより、SMTPプロバイダー(この場合はGmail)のページにリダイレクトされます。
  3. ログインと、必要な権限の付与に対する同意
  4. 同意した後、トークンはリポジトリに保存されます。 accessTokenの下でこのURLに直接アクセスするには、パブリッシュインスタンスで次のURLに直接アクセスします。http://serveraddress:serverport/crx/de/index.jsp#/conf/global/settings/mailer/oauth2

このページ