Email templates serve as a structure for the content of an email. Their purpose is to generate emails with dynamic content that gets populated from Rules or other sources. The dynamic elements in these templates are called Placeholders. 

Creating email template folders

It's convenient to categorize your email templates using a folder structure.

  1. Open Environment's Setup of your solution's environment.
  2. From the left menu, select Letter Templates -> Email Templates
  3. Right-click on either the  AppBase node or an existing  folder node and select the New Folder menu item.
  4. A white text field appears, enter a meaningful name for it and press the Enter key.

Cloning folders

Cloning the folder copies all the sub folders and email templates into a new folder.

  1. Open Environment's Setup of your solution's environment.
  2. From the left menu, select Letter Templates -> Email Templates
  3. Right-click on either the  AppBase node or an existing  folder node and select the Clone Folder menu item. The Add Similar popup appears.

  4. Enter the properties as follows:

    PropertyDescription
    New NameEnter a meaningful names. This name can be displayed when you let your users select the template they want to use.
    API Permanent IDThis field is automatically prepopulated and needs to be unique across all Email Templates in your environment.
  5. Click Clone
Editing folder name
  1. Open Environment's Setup of your solution's environment.
  2. From the left menu, select Letter Templates -> Email Templates
  3. Left-click three times on the name of a folder node you want to edit. 
  4. A white text field appears, enter a meaningful name for it and press the Enter key.

Deleting a folder

Deleting a folder will delete all it's sub folders and all their containing email templates.

  1. Open Environment's Setup of your solution's environment.
  2. From the left menu, select Letter Templates -> Email Templates
  3. Right-click on either the  AppBase node or an existing  folder node and select the Delete menu item.
  4. A confirmation message will appear, click Yes.

New email templates

Email templates serve as a structure for the content of an email. 

  1. Open Environment's Setup of your solution's environment.
  2. From the left menu, select Letter Templates -> Email Templates
  3. Right-click on either the  AppBase node or an existing  folder node and select the New Template menu item. The New Letter Template popup appears.

  4. Enter the letter template properties as follows:

    PropertyDescription
    Templae NameEnter a meaningful names. This name can be displayed when you let your users select the template they want to use.
    API Permanent IDThis field is automatically prepopulated and needs to be unique across all Email Templates in your environment.
    FromThe sender's name or company name. You can either set it here or leave it blank to dynamically fill it when an email is rendered using this template. You can use placeholders in this field. Example: @@NAME@@, Account Manager
    SubjectThe email's subject. You can use placeholders in this line. Example: Welcome, @@NAME@@ to the mailing list
    FormatTwo options: text/html: The email body will be designed using HTML and should be used if you intend to have formatting or images. text/plain: The email body will be plain text without formatting and images. These generally show up better on smartphones and are usually more light weight than HTML emails.
    EncodingThe only option right now UTF-8. This encodes the email into a Unicode character that supports multiple languages and special characters.
    Email body

    If you selected text/html then a toolbar appears on top of the text area to help you design the HTML form. You can also copy-and-paste HTML into this area. Otherwise just write the body of the email with appropriate Placeholders.

    Welcome @@NAME@@,
    Thank you for creating an online account with @@COMPANY@@. We look forward to getting to know you more through our events. Your Account ID is @@ACCOUNTID@@.

    To submit an application or to learn more about our work and community, please visit www.eccentex.com.
    @@COMPANY@@
    Please do not reply to this email address as it is not monitored.

    Additional Information: @@OTHER@@

    In the From, Subject and Email body all text that is wrapped in double ampersat symbols. For example, @@NAME@@ will be a Placeholder that can then be replaced with data from a Bookmark. The following are requirements for placeholders:

    • They have to be in all capitals
    • They can only be alphanumerical values and underscores.
    • It can not begin with a number.
  5. Click Save
  6. The View Letter Template page displays. Go to the Placeholders tab.
  7. Double click a Placeholder's Bookmark cell and map it to an existing Bookmark. A Placeholder does not require a Bookmark, you can leave the cell empty and have the content be determined manually every time the email gets rendered. More about that is explained below.

Cloning an email template

  1. Open Environment's Setup of your solution's environment.
  2. From the left menu, select Letter Templates -> Email Templates
  3. Select the folder where your email template is.
  4. On the right side next to the Name of the template, click the Clone button.

  5. Enter the properties as follows:

    PropertyDescription
    New NameEnter a meaningful names. This name can be displayed when you let your users select the template they want to use.
    API Permanent IDThis field is automatically prepopulated and needs to be unique across all Email Templates in your environment.
  6. Click Clone

Editing an email template's fields and body

  1. Open Environment's Setup of your solution's environment.
  2. From the left menu, select Letter Templates -> Email Templates
  3. Select the folder where your email template is.
  4. Click on the  Edit button next to the template you want to modify. The Edit Letter Template pop up displays.
  5. Update the Modify Bookmark Edit Letter Template pop up.
  6. Click Save.

Editing an email template's placeholders

  1. Open Environment's Setup of your solution's environment.
  2. From the left menu, select Letter Templates -> Email Templates
  3. Select the folder where your email template is.
  4. Click on the template's name (blue link) whose placeholders you want to manage. The View Letter Template page displays.
  5. Go to the Placeholders tab and update them.
  6. Click Save.

Using this feature

The most common way to use this feature is from a page by making an AJAX request. You can also call this service from a rule using WCF. 

JavaScript Example

Text

CURL Example

Text

WCF Example

Text

  • No labels