The base syntax of an Email Template^[40] is described by example in the following XML file:

<?xml version= "1.0" encoding= "UTF-8" ?>
<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd"> 

<properties>
    <!-- $obj.attr$ placeholders are replaced at runtime --> 

    <!-- TEXT --> 
    <entry key="text"><![CDATA[Text with $obj.attr$ placeholders.]]></entry>

    <!-- HTML --> 
    <entry key="html"><![CDATA[<b>HTML</b><p>
      with $obj.attr$ and other placeholders</p>]]>
    </entry>

</properties>

<entry key="cid_1">SAVAPAGE_ICON</entry>           
<entry key="cid_2">images/mysite-logo.png</entry>  

<entry key="html"><![CDATA[
  <img src="cid:$cid_1$" alt="$app.name$">         

  <a href="https://mysite.xyz">
    <img alt="mysite.xyz" src="cid:$cid_2$"/>       
  </a>

]]></entry>

An Email Stationary Template is used by an Email Message Template as container to embed its content in. A stationary is typically used by many Email Messages Types, and thus gives a common look-and-feel to various email output.

A Stationary Template contains the following placeholder objects:

And this is how it looks like:

<?xml version= "1.0" encoding= "UTF-8" ?>
<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">

<properties>

    <!-- TEXT -->     
    <entry key="text"><![CDATA[Plain text with $stationary.header$  
$stationary.content$ and additional app placeholders]]></entry>     

    <!-- HTML -->
    <entry key="html"><![CDATA[HTML with <b>$stationary.header$</b>
      <p>$stationary.content$ and additional cid_ and app placeholders</p>]]> 
    </entry>

</properties>

Email Message Templates are used by Email Message Types.

Template and Type are tied by name.

For example: the JobTicketCompleted message type will look for the nearest i18n version of a JobTicketCompleted.xml template file. In this way, JobTicketCompleted_de.xml will be the perfect match when a German email message is requested.

Email Message Template adds the entry key “subject” to the syntax. Optionally, entry keys “stationary” and “header” can be used to link to an Email Stationary Template.

The syntax is described by example in the following XML file:

<?xml version= "1.0" encoding= "UTF-8" ?>
<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">
<properties>

    <!-- Email subject -->        
    <entry key="subject">Text with $obj.attr$ placeholders</entry>
 
    <!-- Optional stationary -->  
    <entry key="stationary">EmailStationary</entry>
    <entry key="header">Stationary header with placeholders</entry>

    <!-- TEXT -->     
    <entry key="text"><![CDATA[Plain text with placeholders.]]></entry>

    <!-- HTML -->
    <entry key="html"><![CDATA[<p>HTML with placeholders.</p>]]></entry>

</properties>

Placeholder Objects are used in Email Stationary, and in Email Message Templates tied to Email Messages Types.

SavaPage uses its own Email Stationary Types. As the table below shows, currently there is just one type in use. You can use this type in your own custom Email Message Template files. Or, you can override this type by creating your own EmailStationary.xml i18n variants in the custom template/ directory.

The sections below describe email message types that can be customized. The list is limited for now, but will grow as more messages are refactored for this purpose.

Custom templates are located in the /opt/savapage/server/custom/template/ directory. Sub-locations can be defined for different template groups. These sub-locations can then be activated for different applications, with the following configuration properties:

See Section 4.11.14, “Config Editor” on how to set these items.