Document toolboxDocument toolbox

(v2.0) Edit e-mail template

A specialized template editor is used to edit an e-email template. It contains the elements described further below.

The content of the templates is in a “FreeMarker Template Language“ format. Details available HERE. The template must conform to this format. If a modified template contains an error, the rendering of the resulting message will fail, an exception will occur and a default unmodified template will be used in such a case.

? TEMPLATE PARAMETERS

The button on the top can be used to display a list of all parameters usable as variables in the specific template. For each parameter a data type, description and an example is shown.

In the template these parameters are typically used in form of ${parameter_name}.

CREATE CUSTOM MESSAGE SUBJECT

The button is available only if the default subject is not yet modified for the template. After pressing the button a new field is shown, allowing editing of the custom subject, which will replace the default subject.

DELETE CUSTOM MESSAGE SUBJECT

The button is available only if the custom subject is already used instead of the default one. It can be used to delete the custom subject and therefore start using the template default again.

CREATE CUSTOM MESSAGE BODY

The button is available only if the default message body is not yet modified for the template. After pressing the button a new text area is shown, allowing editing of the custom message body, which will replace the default one.

DELETE CUSTOM MESSAGE BODY

The button is available only if the custom message body is already used instead of the default one. It can be used to delete the custom message body and therefore start using the template default again.

CANCEL

The button cancels the currently performed unsaved modifications and returns to the template list.

SEND TEST E-MAIL

The button shows a dialog where an e-mail address can be entered and to which the test e-mail generated according to the current template can be sent.

PREVIEW

Displays a preview of the message generated according to the current template. The styles and fonts may not match the result shown in e-mail client. Useful mainly for checking the contents.

SAVE

Saves the currently performed modifications of the template and returns to the template list.

Â