| Table of Contents |
|---|
JETI's default email template (called Default in the template editor) is prepared to render comments into the email body when the "Add comments to outgoing emails" option is enabled. However, if you develop your own custom email template from scratch or not based on Default, you'll have to add velocity template code to render the comments.
In order to append issue comments to the outgoing emails, two requirements must be met:
- You enable the option "Add comments to outgoing emails" in the corresponding component (Email button, Bulk Email, Post Function, Event Notification)
- You add a template fragment to your email template that will render the comments.
The template fragments are different for HTML and TEXT emails. Copy and paste the below code to your templates or use the Field Picker dropdown and select "Comment".
| Note | ||
|---|---|---|
| ||
Only public (non-restricted, i.e. Visible by anyone) comments are added to the emails. This is done to prevent revealing secured comments unintentionally. |
Render comments in emails using templates based on Themes
The new email template themes make it possible to render comments in emails easily in various ways.
...
Generic, multi-purpose comment rendering macro.
| Status | ||||
|---|---|---|---|---|
|
Parameters:
<sorting>: "asc" or "desc"
<number of comments>: an positive integer number or "all" to render all comments matching <restrictions>
<restrictions>: comment restrictions, values are
- empty: render all comments regardless of the restrictions
- "none": render comments which are not limited to groups, roles or which are not internal in Service Management
- "public": render Service Management public comments
- "internal": render Service Management internal comments
Render Comments in emails using traditional templates
Comments in HTML Emails
It is possible to fully control how the comments are rendered in the email. The code block below renders comments in HTML.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
#if ($!emailDef.emailOptions.addComments)
<tr valign="top">
<td style="color:${textColour};font-family:${textFontFamily};font-size:${textSize};padding:0 10px 10px 0;white-space:nowrap;">
<strong style="font-weight:normal;color:${textSubtleColour};">#text("common.words.comments"):</strong>
</td>
<td style="color:${textColour};font-family:${textFontFamily};font-size:${textSize};padding:0 0 10px 0;width:100%;">
#foreach ($comment in $!publicComments)
<p style="border-bottom: 1px solid #DDD;">
<p style="font-weight: bold"><a href="$!baseurl/secure/ViewProfile.jspa?name=$!{comment.author}"><b>$!{comment.authorFullName}</b></a> - <b>$!{dateformatter.format($comment.created)}</b></p>
<p>$!{rendererManager.getRenderedContent($!commentRendererType, $!comment.body, $issue.issueRenderContext)}</p>
</p>
#end
</td>
</tr>
#end |
Comments in Text Emails
It is possible to fully control how the comments are rendered in the email. The code block below renders comments in Text.
| Code Block | ||||
|---|---|---|---|---|
| ||||
-------------------------------------------------------------------------------
#if ($!emailDef.emailOptions.addComments)
$i18n.getText("common.words.comments"):
#foreach ($comment in $!publicComments)
$!{comment.authorFullName} - $!{dateformatter.format($comment.created)}
------------------
$comment.body
#end
#end
|
Reverse Comment List
Normally comments are rendered by date ascending. To render them the latest on top, you must reverse the list:
| Code Block |
|---|
#set($publicComments = $!jetiFieldRenderer.reverse($!publicComments)) |
Last Comment
...
| Code Block |
|---|
#if($!publicComments && !$!publicComments.empty)
#set($lastComment = $!publicComments.get(0))
...
#end |
Without reversing the list first, access the last comment as:
| Code Block |
|---|
#if($!publicComments && !$!publicComments.empty)
#set($lastComment = $!publicComments.get($!publicComments.size()-1))
...
#end |
Access All Comments (even restricted ones)
To access all comments of an issue, use the $commentManager object.
...
| Redirect | ||||
|---|---|---|---|---|
|
Thank you for visiting our old product documentation site. Note that we no longer store or update our documentation here.Please navigate to our new documentation site and update your bookmarks accordingly. If you're looking for the former content of this page, click here. |