PowerCMS Xからメールを送信する時に使われるテンプレートのルールについて紹介します。PowerCMS Xから送信されるメールには以下のようなものがあります。
- パスワードリセット
- 二段階認証
- ワークフロー関連の通知
- フォームやコメントの通知や Thanksメール
利用されるテンプレートは {app_dir}/tmpl/email/配下にある各ファイルですが、以下のルールでカスタマイズできます。
- 代替テンプレートを使う方法 : 管理画面のカスタマイズ アイコン別ウィンドウで開きます
- ビューを登録する方法 : ファイル名のベースネームと同名のビューを作成し、クラス「メール」を選択します。ビューが使われる時、件名欄に入力されたテンプレートがメールの件名になります。※
※ workspace_id付きのリクエストではそのスコープのビューが優先されます。
| メール種別 | 説明 | ビュー |
|---|---|---|
| パスワードをリセットするURLを通知するメール | パスワードを忘れた時、パスワードリセット画面からメールアドレスを入力して一時URLを送信するメールです。 | ベースネーム「recover_password」、クラス「メール」のビュー(存在しない場合、 tmpl/email/recover_password.tmpl が利用されます) |
| 二段階認証のトークンを通知するメール | 二段階認証の設定がある時、ログイン用の認証コード(5桁の数字)を送信するメールです。 | ベースネーム「confirmation_code」、クラス「メール」のビュー(存在しない場合、 tmpl/email/confirmation_code.tmpl が利用されます) |
| ワークフローで新しくアサインされたユーザーへの通知 | 承認依頼または差し戻しの両方で、新しく担当者にアサインされたユーザーへの通知メールです。 | ベースネーム「notify_new_user」、クラス「メール」のビュー(存在しない場合 tmpl/email/notify_new_user.tmpl が利用されます)※1 |
| ワークフローで自分の担当オブジェクトが他のユーザーへアサインされた時の通知 | 自分の担当のオブジェクトが他のユーザーによって別のユーザーにアサインされた時、担当だったユーザーに送信されるメール | ベースネーム「notify_old_user」、クラス「メール」のビュー(存在しない場合 tmpl/email/notify_old_user.tmpl が利用されます) |
| ステータスの変更によって自分の担当オブジェクトが他のユーザーへアサインされた時の通知 | 他のユーザーによって自分の担当オブジェクトのステータスが変更された結果、対象オブジェクトが別のユーザーにアサインされた事を担当だったユーザーに通知するメール | ベースネーム「notify_previous_owner」、クラス「メール」のビュー(存在しない場合、 tmpl/email/notify_previous_owner.tmpl が利用されます) |
| ワークフロー経由でオブジェクトが公開された時に過去に担当したユーザーへの通知 | ワークフローを経てオブジェクトが公開された時、過去にアサインされ操作したユーザー全員に送信されるメールです。 | ベースネーム「notify_participants」、クラス「メール」のビュー(存在しない場合、 tmpl/email/notify_participants.tmpl が利用されます) |
| リビジョンがマスタに適用して公開された時に過去に担当したユーザーへの通知 | ワークフローを経てリビジョンがマスタに適用されて公開された時、過去にアサインされ操作したユーザー全員に送信されるメールです。 | ベースネーム「notify_rev_participants」、クラス「メール」のビュー(存在しない場合、 tmpl/email/notify_participants.tmpl が利用されます) |
| 一覧画面でステータス変更に伴い担当ユーザーが変更された時の通知 | 一覧画面からまとめてステータスを変更した時に、元のオブジェクトの担当ユーザーが変更後のステータスへのアクセス件を持たない場合に元の担当者へ送信されるメール※2 | ベースネーム「batch_status_change」、クラス「メール」のビュー(存在しない場合、 tmpl/email/batch_status_change.tmpl が利用されます) |
| ワークフロー利用時の引き戻しの通知(ver.3.06/ver.2.64以降) | ワークフローを利用時に、ユーザーがオブジェクトを引き戻した時、担当にアサインされているユーザーに送信されるメールです。 | ベースネーム「notify_pull_back」、クラス「メール」のビュー(存在しない場合、 tmpl/email/notify_pull_back.tmpl が利用されます) |
| フォームへの投稿を管理者に通知するメール | 管理者に通知設定のあるフォームへの投稿を管理者に通知するメールです。 | ベースネーム「form_notify」、クラス「メール」のビュー(存在しない場合、 tmpl/email/form_notify.tmpl が利用されます) |
| フォームへの投稿者に投稿を受け取ったことを通知するメール | 投稿者へのThanksメール送信設定のあるフォームへの投稿を受け取ったことを投稿者に通知するメールです。 | ベースネーム「form_thanks」、クラス「メール」のビュー(存在しない場合、 tmpl/email/form_thanks.tmpl が利用されます) |
| コメント投稿を管理者に通知するメール | コメントの投稿を管理者(そのオブジェクトに対するコメント通知の権限のあるユーザー)に通知するメールです。 | ベースネーム「comment_notify」、クラス「メール」のビュー(存在しない場合、 tmpl/email/comment_notify.tmpl が利用されます) |
| コメント投稿者に投稿を受け取ったことを通知するメール | 投稿者へのThanksメール送信設定のあるコメント投稿を受け取ったことを投稿者に通知するメールです。 | ベースネーム「comment_thanks」、クラス「メール」のビュー(存在しない場合、 tmpl/email/comment_thanks.tmpl が利用されます) |
| メールフッター | 各メールテンプレートからインクルードされている共通メールフッタ。 | ビューは設定できません。tmpl/email/mail_footer.tmpl が利用されます |
※ 1 ワークスペースに該当のビューがない場合、システムに該当するビューを探しにいき、それでもない場合は、デフォルトのテンプレートが利用されます。
※ 2 レビュアーが担当しているオブジェクトが、公開者によってステータス公開や公開予約に変更された場合など。
プラグインMembersの会員サイトで利用されるメールテンプレート
システムのメールテンプレートと同様に、対象のスコープに該当するベースネームと一致するビュー(クラスが「メール」指定のビュー)がある時、それが使われます。ない場合は、plugins/Members/tmpl/email配下のテンプレートが利用されます。代替テンプレートの指定も可能です。ビューがある時、メールの件名はビューの「件名」となります(MTタグが利用できます)。
- members_sign_up_confirm.tmpl : サインアップ後にメンバーに本登録用のURLを送信するメール用です。
- members_sign_up_notification.tmpl : メンバーがサインアップ後、本登録を完了した時、管理者に通知を送信するメール用です。
- members_activate_notification.tmpl : 管理画面でメンバーの編集画面の「有効化されたことをメンバーに通知する」にチェックを入れて保存した時に、メンバーに通知を送信するメール用です。