Editing Email Notification Templates

Edit the email notification templates that the application automatically sends to users after certain actions occur, such as content changes and password reset notifications.

Fastpath: Admin Console: System > Settings > Message Templates

Jive includes a set of email templates for emails it sends to users in response to certain events. You can edit the content of the templates, change their locale, or add new templates to use in other locales.

For information about changing template language and locale, see Localizing Email Templates.

CAUTION:

While you can edit any of the application's email templates, and we encourage you to edit the header and footer email templates, we otherwise recommend that you limit changes to email templates because such customizations will increase your upgrade burden.

The templates cover a wide range of actions in the application. Some of these are very common, such as email notifications when content is changed or added (for blogs, documents, spaces, and so on) or when someone requests a password reset. Others are sent for actions or events that are more rare. You'll find a complete template list in the Admin Console. You can also customize the header and footer of outbound emails.

Note: You configure other specific aspects of email in other parts of the Admin Console. For example, you set whether moderation email should be sent on the Discussions settings pages.

Email messages sent by Jive can be sent as plain text or HTML. Each template includes a plain text version and an HTML version.

When you're editing templates, use the syntax of FreeMarker. Each template supports a specific set of placeholder tokens for email content that will vary from message to message. For example, the notification email sent to users following a document includes tokens for the followed document, the following user, and the URL of the followed document. In the template text, refer to tokens using FreeMarker syntax: ${document}, ${user}, ${docURL}, and so on.

As you edit the template, click the Preview button to see your work.

Here are examples designed to tell a user that an item they're following has been updated. This template begins by telling the recipient the name of the user who created or modified the item. It then provides the title of the item ("subject"). The template then checks to see if the system is configured to support other features related to content, and may display one or all of the following messages to the recipient:

If the system allows commenting on the item by replying to the notification email.
If the system supports updating the item by sending a new version via email.
If the system supports creating new content via mail.

Plain Text Template Example

${contentAuthorName} <#if contentAuthorURL?has_content>[${contentAuthorURL}]</#if> <#if isNewContentItem?? && isNewContentItem>created<#else>modified</#if> the document:

"${contentSubject}"

To view the document, visit: ${contentURL}

<#if includePostContentInEmail && !docVerseDocument && !binaryDocument>
--------------------------------------------------------------
${contentTextBody}
--------------------------------------------------------------
</#if>

<#if emailReplyEnabled>
<#if docVerseDocument && docVerseEnabled>
By replying to this email, you can take action on this document.  If you attach a new version as a file to the email,
a new version of the document will be created.  The body of the reply, if any, will be treated as a comment.
Comment by replying to this email -or- go to the document on ${SkinUtils.getCommunityName()}
[${contentURL}]
<#else>
Comment by replying to this email -or- go to the document on ${SkinUtils.getCommunityName()}
[${contentURL}]
</#if>
<#elseif hasRespondEntitlement>
Comment by going to ${SkinUtils.getCommunityName()}
[${contentURL}]
</#if>

<#if emailCreateEnabled>
Create a new document in ${containerName} by email
[${newContentAddress}] -or- at ${SkinUtils.getCommunityName()}
[${newContentURL}]
<#elseif hasCreateEntitlement>
Create a new document in ${containerName} at ${SkinUtils.getCommunityName()}
[${newContentURL}]
</#if>

HTML Template Example

<h3 style="margin: 10px 0 5px; font-size: 17px; font-weight: normal;">
    ${contentSubject}
</h3>
<span style="margin-bottom: 10px;">
    <#if isNewContentItem?? && isNewContentItem>created by<#else>modified by</#if> <#if contentAuthorURL?has_content><a href="${contentAuthorURL}">${contentAuthorName}</a><#else>${contentAuthorName}</#if> in <i>${containerName}</i> - <a href="${contentURL}">View the full document</a>
</span>
<hr style="margin: 20px 0; border: none; background-color: #dadada; height: 1px;">

<#if includePostContentInEmail && !docVerseDocument && !binaryDocument>
${contentBody}
</#if>

<div style="background-color: #f4f4f4; padding: 10px; margin-top: 20px;">
<#if emailReplyEnabled>
<#if docVerseDocument && docVerseEnabled>
    <p style="margin: 0;">By replying to this email, you can take action on this document.  If you attach a new version as a file to the email,
    a new version of the document will be created.  The body of the reply, if any, will be treated as a comment.</p>
<#else>
	<p style="margin: 0;">Comment by replying to this email -or- <a href="${contentURL}">go to the document on ${SkinUtils.getCommunityName()}</a></p>
</#if>
<#elseif hasRespondEntitlement>
    <p style="margin: 0;">Comment by <a href="${contentURL}">going to ${SkinUtils.getCommunityName()}</a></p>
</#if>

<#if emailCreateEnabled>
	<p style="margin: 0;">Create a new document in ${containerName} by <a href="mailto:${newContentAddress}">email</a> -or- at <a href="${newContentURL}">${SkinUtils.getCommunityName()}</a></p>
<#elseif hasCreateEntitlement>
	<p style="margin: 0;">Create a new document in ${containerName} at <a href="${newContentURL}">${SkinUtils.getCommunityName()}</a></p>
</#if>
</div>