This documentation relates to an earlier version of FishEye.
View

Unknown macro: {spacejump}

or visit the current documentation home.

Email notifications in FishEye can be customised to change their formatting, by editing template files. This page contains instructions for this process.

Editing FishEye Email Templates

Template files for FishEye are stored in the FISHEYE_HOME/templates/ folder.

They templates are only for changing the appearance and order of certain content inside the messages.

If you edit the templates of an operational FishEye instance, you may disrupt notifications that are being sent at that time. To avoid this, shut FishEye down during template editing.

Editing the Subject Line

  1. Open the 'fisheye-mail-subject.ftl' template file from FISHEYE_HOME/templates/ in a text editor.
  2. Type in your new text for the email subject, ensuring that all of the content is contained within line 1 of the template. 'fisheye-mail-subject.ftl' is used as the subject template for all FishEye email notifications.
  3. ファイルを保存して閉じます。
  4. Restarting FishEye will activate the new templates.

Editing the Header

Header information will be included at the beginning of the email body text.

  1. Open the 'fisheye-mail-header.ftl' template file from FISHEYE_HOME/templates/ in a text editor.
  2. Add your new header content. 'fisheye-mail-header.ftl' is used as the header template for all FishEye email notifications.
  3. ファイルを保存して閉じます。
  4. Restarting FishEye will activate the new templates.

Editing the Footer

Footer information will be included at the end of the email body text.

  1. Open the 'fisheye-mail-footer.ftl' template file from FISHEYE_HOME/templates/ in a text editor. 'fisheye-mail-footer.ftl' is used as the footer template for all FishEye email notifications.
  2. Add your new footer content.
  3. ファイルを保存して閉じます。
  4. Restarting FishEye will activate the new templates.

After an edit, the change to the email template will take place immediately. No restart is required.

Try and avoid editing the live template file, as FishEye may try to use it while you are editing. This could have unpredictable results. Instead, back up the template file (it's wise to keep original versions of all these files), edit a copy you have made, then overwrite the 'live' template once you have finished.

Advanced Editing of FishEye Email Templates

The email notification templates use the Freemarker format. Freemarker is a general templating engine enabling automated content.

If you are familiar with Freemarker, more advanced customisations can be made to the email notification templates. However, you make such adjustments at your own risk.

FishEye Email Template File List

The following template files for FishEye notifications are stored in the FISHEYE_HOME/templates/ folder.

Template filename

目的

fisheye-mail-subject.ftl

Subject template

fisheye-mail-header.ftl

Header template

fisheye-mail-footer.ftl

Footer template

changeset-mail-html.ftl

HTML email template

changeset-mail-plain.ftl

Plain text email template

See also Customising Crucible Email Notifications.

  • ラベルなし



Log a request with our support team.



Raise an issue for our developers.



See answers from the community.



Blog and update.

Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 2.5 Australia License.