syncope-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From conflue...@apache.org
Subject [CONF] Apache Syncope > Customize notification e-mail templates
Date Fri, 04 Jan 2013 15:06:00 GMT
<html>
<head>
    <base href="https://cwiki.apache.org/confluence">
            <link rel="stylesheet" href="/confluence/s/2042/9/3/_/styles/combined.css?spaceKey=SYNCOPE&amp;forWysiwyg=true"
type="text/css">
    </head>
<body style="background: white;" bgcolor="white" class="email-body">
<div id="pageContent">
<div id="notificationFormat">
<div class="wiki-content">
<div class="email">
    <h2><a href="https://cwiki.apache.org/confluence/display/SYNCOPE/Customize+notification+e-mail+templates">Customize
notification e-mail templates</a></h2>
    <h4>Page <b>edited</b> by             <a href="https://cwiki.apache.org/confluence/display/~dsigno">Denis
Signoretto</a>
    </h4>
        <br/>
                         <h4>Changes (2)</h4>
                                 
    
<div id="page-diffs">
                    <table class="diff" cellpadding="0" cellspacing="0">
    
            <tr><td class="diff-added-lines" style="background-color: #dfd;">h1.
Customize notification e-mail templates <br></td></tr>
            <tr><td class="diff-unchanged" > <br></td></tr>
            <tr><td class="diff-added-lines" style="background-color: #dfd;">In
Syncope you can customize and create your own template messages to personalize the body of
notification messages. <br> <br>This can be achived creating or modifing the email
template files. Each e-mail template it&#39;s made of a couple of files:one for HTML version
and one for the text version of the email message body. <br> <br>Default template
direcotry is located at &quot;/WEB-INF/classes/mailTemplates&quot; of Syncope core
web application. <br> <br>It contains the &quot;optin&quot; default notification
template files: <br> <br>* optin.html.vm <br>* optin.txt.vm <br> <br>These
files are Velocity template files. Syncope use Velocity ([http://velocity.apache.org|http://http://velocity.apache.org])
as template engine to reference and process objects injected by Syncope. <br> <br>If
you want to create your own email template, e.g. &quot;custom-notification&quot;,&amp;nbsp;you
just need to create a couple of files named &quot;custom-notification.html.vm&quot;
and &quot;custom-notification.txt.vm&quot; <br> <br>Within these files
you can use Velocity expressions and reference the following Syncope <br>injected variables:
<br> <br>* user <br>* syncopeConf <br> <br>Refer to default
template files to find out how refer to objects and write simple velocity expressions to customize
your message body. <br></td></tr>
    
            </table>
    </div>                            <h4>Full Content</h4>
                    <div class="notificationGreySide">
        <h1><a name="Customizenotificatione-mailtemplates-Customizenotificationemailtemplates"></a>Customize
notification e-mail templates</h1>

<p>In Syncope you can customize and create your own template messages to personalize
the body of notification messages.</p>

<p>This can be achived creating or modifing the email template files. Each e-mail template
it's made of a couple of files:one for HTML version and one for the text version of the email
message body.</p>

<p>Default template direcotry is located at "/WEB-INF/classes/mailTemplates" of Syncope
core web application.</p>

<p>It contains the "optin" default notification template files:</p>

<ul>
	<li>optin.html.vm</li>
	<li>optin.txt.vm</li>
</ul>


<p>These files are Velocity template files. Syncope use Velocity (<a href="http://http://velocity.apache.org"
class="external-link" rel="nofollow">http://velocity.apache.org</a>) as template
engine to reference and process objects injected by Syncope.</p>

<p>If you want to create your own email template, e.g. "custom-notification",&nbsp;you
just need to create a couple of files named "custom-notification.html.vm" and "custom-notification.txt.vm"</p>

<p>Within these files you can use Velocity expressions and reference the following Syncope<br/>
injected variables:</p>

<ul>
	<li>user</li>
	<li>syncopeConf</li>
</ul>


<p>Refer to default template files to find out how refer to objects and write simple
velocity expressions to customize your message body.</p>
    </div>
        <div id="commentsSection" class="wiki-content pageSection">
        <div style="float: right;">
            <a href="https://cwiki.apache.org/confluence/users/viewnotifications.action"
class="grey">Change Notification Preferences</a>
        </div>
        <a href="https://cwiki.apache.org/confluence/display/SYNCOPE/Customize+notification+e-mail+templates">View
Online</a>
        |
        <a href="https://cwiki.apache.org/confluence/pages/diffpagesbyversion.action?pageId=30747253&revisedVersion=2&originalVersion=1">View
Changes</a>
                |
        <a href="https://cwiki.apache.org/confluence/display/SYNCOPE/Customize+notification+e-mail+templates?showComments=true&amp;showCommentArea=true#addcomment">Add
Comment</a>
            </div>
</div>
</div>
</div>
</div>
</body>
</html>

Mime
View raw message