Customising email notifications

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

Editing Crucible email templates

Template files for Crucible are stored in the <Crucible home directory>/template/crucible/ folder and the <Crucible home directory>/template/shared folder.

There are sets of templates for both HTML and plain-text emails, as listed in the table below. Note that these templates do not support embedding full diffs into notifications. They are only for changing the appearance and order of certain content inside the messages.

You can edit templates in any text editor:

• Either: Stop Crucible before editing templates to avoid disrupting notifications that may otherwise be sent.
• Or: Avoid editing a live template file, as Crucible 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.
• After an edit, the change to the email template will take place immediately. No restart is required.

Advanced editing of Crucible 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.

See Freemarker Data Model for Email Templates in the FishEye documentation for details of the data model used by FishEye/Crucible.

Crucible email template files

The following template files for Crucible notification are stored in the <Crucible home directory>/template/crucible/ folder, or its subfolders.
 

Template filename	HTML	Plain-text
common-mention-macros.ftl	Both
crucible-notification-subject.ftl All of the content must be contained within the first line of the template. You can't use markup in this line. Currently not working – see CRUC-4180 - Getting issue details... STATUS	Both
changeset-headet.ftl	Shared
util.ftl	Shared
all-completed-notification.ftl
all-uncompleted-notification.ftl
batch-comment-note.ftl
batch-reviewer-note.ftl
batch-revision-added-note.ftl
batch-state-note.ftl
comment-render-macro.ftl
crucible-layout.ftl
cscomment-notification.ftl
general-notification.ftl
invite.ftl
mention-macros.ftl
mention-user-in-changeset-comment-notification.ftl
mention-user-in-review-comment-notification.ftl
mention-user-in-review-description-notification.ftl
review-allcomments.ftl
review-header.ftl
review-participant-row.ftl
review-reminder-notification.ftl
review-summary.ftl
share-footer.ftl
share-header.ftl
share-notification.ftl

See also Customising FishEye Email Notifications.