Create email template content
This topic describes how to define the content of an email notification template. The content includes the subject line and message body that the recipient receives by email for a corresponding marketplace event.
- To view the default content for each notification type, see Notification template content.
- To view the list and description of available parameters, see Parameter descriptions.
To create a template's email content
đź“ť Note: If the AppDirect logo appears in the upper-left corner of the page, when Manage > Marketplace appears in this topic, click the grid icon > Switch to | Store, instead.
- Go to Manage > Marketplace > Settings > Custom UI | Notifications. The Notifications page opens.
- Click the gear icon > Edit next to the v2 notification type whose contents you want to define. The Default template for the selected notification type opens.
- Ensure the Email notification method is selected (top right).
- (Optional) To edit a custom (non-default) template, select another template from the drop-down list. The selected template displays the default subject and message body content.
- (Optional) Edit the default Subject field as appropriate. A default subject line is included with every notification type template. You can add or edit the plain text, and add or remove simple and advanced parameters.
- (Optional) Edit the default Content field as required, using one or more of the following elements:
- Plain text—You can type characters directly into the appropriate content fields.
- HTML text—You can add content in HTML format. Click Tools in the menu, then select Source.
- Simple template parameters—These are variables that serve as general placeholders in the template, then are substituted with actual event-specific data when the notification is generated. For example, the simple parameter
{userName}
is substituted with John Smith when the notification is generated. To insert parameters into the content section of an email template, do one of the following:- Place your cursor in the content field where you want to add the parameter, then click the parameter button. The parameter is added to the content.
- Click and hold a parameter button, then drag it into the content field where you want the parameter to appear.
- Advanced template parameters—These are variables that contain nested properties or are organized in an array. When used in a template, you must update these parameters manually in dot-separated format. For example,
user.address.city
. For information about the description of each available parameter, see Parameter descriptions.
- (Optional) Click Preview. The Email Preview (with Parameters) dialog opens. It displays the notification parameters defined for this notification type paired with sample data values. For example, the
{applicationName}
parameter is paired with Office 365 sample data ("applicationName": "Office 365"
).- Edit any of the sample data values in the preview.
- Click Preview. The Email Content Preview dialog opens. It contains the changes that you made in step a and the default sample data displayed in an approximation of the actual email message sent to the recipient. The recipient's email client (and to a lesser extent, operating system and browser) determine the final rendering of the actual message.
- Click Close to return to the Email Preview (with Parameters) dialog.
- Click Close to return to the selected email template.
- Edit the template contents as appropriate based on the preview.
- (Optional, currently available only for the Invoice PDF Created notification) From the Attachments drop-down list, select PDF invoice to send the Invoice PDF Create notification as an attachment to the email received by the customer. If you select this option, the email recipient needs to enter a password to view the attached invoice. For more information, see Configure the PDF attachment policy.
- Click Save. A confirmation message appears.
- (Optional) To Manage the unsubscribe link that appears in the email footer, see Manage the unsubscribe feature.
tip
You can click the links at the bottom of the page to view parameter examples and parameter definitions.
Was this page helpful?
Tell us more…
Help us improve our content. Responses are anonymous.
Thanks
We appreciate your feedback!