Настройка содержимого электронной почты

JIRA генерирует электронные письма в ответ на события с использованием механизма шаблонов. Шаблонный движок - скорость Apache. Шаблонный движок  относительно простой в использовании языка шаблонов, который может разделить Java-объекты полезными способами. Письма генерируются внутри JIRA, вызывая Velocity с набором объектов, релевантных для события.

Обращаем ваше внимание,

  • Чтобы изменить столбцы в подписках на фильтры, вам не нужно настраивать почтовые шаблоны. См. раздел «Настройка навигатора задач».
  • Для улучшения этого в JRA-7266 есть функция, за которую вы можете проголосовать, чтобы улучшить возможности применения.
  • Имейте в виду, что в следующий раз, когда вы обновите JIRA или вам понадобится новая установка по любой причине, вам придется вручную скопировать все изменения, внесенные вами в шаблоны Velocity (а также JSP) в новую установку JIRA. Если шаблоны Velocity и / или JSP изменились в новой версии, вам придется вручную перенести свои настройки в них (в отличие от копирования этих файлов непосредственно из старой установки JIRA на вашу обновленную).

Расположение шаблонов электронной почты

Чтобы настроить содержимое электронной почты, выполните следующую процедуру:

  1. Откройте дистрибутив JIRA и перейдите по следующим путям:
  • WEB-INF / classes / templates / email / <jira-application-dir> в каталоге установки JIRA
  • jira / src / etc / java / templates / email / в вашем извлеченном исходном каталоге JIRA.
  1. В этом каталоге есть три каталога: html, текст и тема. Подкаталог html содержит шаблоны, используемые для создания электронных писем в html, а в текстовом каталоге - обычные текстовые сообщения. Тематический каталог содержит шаблоны, используемые для генерации темы писем. Шаблоны названы в честь события, которое вызовет электронное письмо.
  2. Перенесите шаблон в свой любимый текстовый редактор. Обратившись к документации по шаблонам JIRA (в частности, Velocity Context для шаблонов электронной почты) и руководству пользователя Velocity, и сделайте необходимые настройки.
  3. Перезапустите JIRA.

Для новых шаблонов электронной почты:

  1. Создайте новые файлы mytemplate.vm в html, текстовых и тематических каталогах на основе существующих файлов в этих каталогах.
  2. Добавьте шаблоны в atlassian-jira / WEB-INF / classes / email-template-id-mappings.xml, чтобы сделать их действительными вариантами при добавлении нового события.

Обратите внимание, что поскольку JIRA 4.1 каждый новый шаблон должен иметь соответствующий файл в тематическом каталоге.

 

Расширенная настройка

Объект Задача передается в шаблоны vm. Обратите внимание на некоторые его реализации в /includes/summary-topleft.vm. Например, вызов $ issue.getProject () позволит вам определить проект, из которого возникла задача, и даже создать логику для отображения различной информации для электронных писем из разных проектов.

Развертывание шаблонов Velocity  без перезапуска JIRA

В экземпляре разработки вы можете варъировать с перестановкой изменений файла Velocity  без перезагрузки.

Из <jira-install> /atlassian-jira/WEB-INF/classes/velocity.properties:

  1. Измените resource.loader.cache от true до false
  2. Удалите знак комментария (#) из # velocityimacro.library.autoreload = true

Это изменение в процессе производства в конечном итоге приведет к тому, что JIRA не будет обслуживать страницы вместе с ошибками алгоритмов синтаксического анализа.(жарг. па́рсер ← англ. parser) в файле журнала.

См. также  «Добавление пользовательских полей в электронную почту».

 

По материалам Atlassian JIRA Administrator's Guide: Customizing Email Content