メール コンテンツのカスタマイズ (個別通知)

このページの内容

お困りですか?

アトラシアン コミュニティをご利用ください。

コミュニティに質問

個別通知を使用する場合、課題のすべての更新が個別のメールで送信されます。通知の表示方法を制御するテンプレートは、Jira インストール ディレクトリにあります。

Velocity テンプレートやその他の Jira ファイルのカスタマイズは、アトラシアン サポートの範囲には含まれません。

考慮事項

  • Velocity テンプレート (および JSP) に加えた変更は Jira アップグレード時に上書きされます。その場合、変更したファイルを新しい Jira バージョンに手動でコピーする必要があります。新しいバージョンで Velocity テンプレートおよび JSP が変更されている場合、カスタマイズをそれらに手動でインポートする必要があります (ファイルを古い Jira インストールからアップグレード後のバージョンに直接コピーすることとは異なります)。

  • メールの外観の変更のほかに、通知対象の課題をより詳細に確認できるよう、任意のカスタム フィールドを追加できます。詳細については、「カスタム フィールドをメールに追加する」を参照してください。

メール テンプレートの場所

  1. ご利用の Jira インストール ディレクトリの以下の場所に移動します。 

    /atlassian-jira/WEB-INF/classes/templates/email/

    Jira ソース ファイルを使用している場合、jira/src/etc/java/templates/email/ に移動します。

  2. このディレクトリには、3 つのサブディレクトリがあります。

    • html - html でメールを作成するのに使用されるテンプレートが含まれます。
    • text - プレーン テキスト メールを作成するのに使用されるテンプレートが含まれます。
    • subject - メールの件名を生成するために使用されるテンプレートが含まれます。
  3. テンプレートを任意のテキスト エディターに取り込みます。「Jira テンプレート ドキュメント」および「Velocity Users Guide」を参照し、必要なカスタマイズを行います。
  4. Jira を再起動します。

新しいメール テンプレートの作成

  1. htmltext、および subject ディレクトリで、それらのディレクトリ内の既存のファイルに基づき、新しく mytemplate.vm ファイルを作成します。
  2. テンプレートを atlassian-jira/WEB-INF/classes/email-template-id-mappings.xml に追加して、新しいイベントを追加する際に選択できるようにします。

高度なカスタマイズ

issue オブジェクトは vm テンプレートに渡されます。これに関連する /includes/summary-topleft.vm 内の複数の実装に注意します。例として、$issue.getProject() を呼び出すと、課題が所属するプロジェクトを決定し、別のプロジェクトからのメールでは異なる情報を表示するロジックを作成することもできます。

Jira を再起動せずに Velocity テンプレートをデプロイする

開発インスタンスでは、Velocity ファイルの変更を再起動なしで確認できます。
<jira-install>/atlassian-jira/WEB-INF/classes/velocity.properties で次の内容を実行します。

  1. class.resource.loader.cache を true から false に変更します。
  2. #velocimacro.library.autoreload=true からコメント記号 (#) を削除します。

本番環境でこの変更を行うと、Jira では最終的にページを提供することができなくなり、ログ ファイルに "ran out of parsers" エラーが表示されます。

メールにカスタム フィールドを追加する」も参照してください。

最終更新日: 2020 年 10 月 8 日

この内容はお役に立ちましたか?

はい
いいえ
この記事についてのフィードバックを送信する
Powered by Confluence and Scroll Viewport.