| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>FreemarkerMailGenerator (Apache Archiva Redback 3.0.0-SNAPSHOT API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="FreemarkerMailGenerator (Apache Archiva Redback 3.0.0-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/FreemarkerMailGenerator.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li><a href="../../../../../../org/apache/archiva/redback/integration/mail/Mailer.html" title="interface in org.apache.archiva.redback.integration.mail"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/archiva/redback/integration/mail/FreemarkerMailGenerator.html" target="_top">Frames</a></li> |
| <li><a href="FreemarkerMailGenerator.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.archiva.redback.integration.mail</div> |
| <h2 title="Class FreemarkerMailGenerator" class="title">Class FreemarkerMailGenerator</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.archiva.redback.integration.mail.FreemarkerMailGenerator</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../../org/apache/archiva/redback/integration/mail/MailGenerator.html" title="interface in org.apache.archiva.redback.integration.mail">MailGenerator</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>@Service(value="mailGenerator#freemarker") |
| public class <a href="../../../../../../src-html/org/apache/archiva/redback/integration/mail/FreemarkerMailGenerator.html#line.65">FreemarkerMailGenerator</a> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements <a href="../../../../../../org/apache/archiva/redback/integration/mail/MailGenerator.html" title="interface in org.apache.archiva.redback.integration.mail">MailGenerator</a></pre> |
| <div class="block">Mail generator that uses freemarker templates. |
| |
| This implementation sets the following model values that can be used in templates: |
| <ul> |
| <li>applicationUrl</li> |
| <li>urlPath</li> |
| <li>authKey</li> |
| <li>accountId</li> |
| <li>requestedOn</li> |
| <li>expiresOn</li> |
| </ul> |
| |
| The additional template data is added for interpolation, if not <code>null</code>. |
| |
| This implementation is location enabled. That means, it will try to find templates in the following order: |
| <ul> |
| <li><i>templateName</i>_<i>language</i>_<i>country</i>.ftl</li> |
| <li><i>templateName</i>_<i>language</i>.ftl</li> |
| <li><i>templateName</i>.ftl</li> |
| </ul> |
| |
| The default encoding used for reading the template is UTF-8</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd>Martin Stockhammer <martin_s@apache.org></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/archiva/redback/integration/mail/FreemarkerMailGenerator.html#DEFAULT_ENCODING">DEFAULT_ENCODING</a></span></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/archiva/redback/integration/mail/FreemarkerMailGenerator.html#FreemarkerMailGenerator--">FreemarkerMailGenerator</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/archiva/redback/integration/mail/FreemarkerMailGenerator.html#generateMail-java.lang.String-org.apache.archiva.redback.keys.AuthenticationKey-java.lang.String-">generateMail</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> templateName, |
| <a href="../../../../../../org/apache/archiva/redback/keys/AuthenticationKey.html" title="interface in org.apache.archiva.redback.keys">AuthenticationKey</a> authenticationKey, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> baseUrl)</code> |
| <div class="block">Generates a mail string from a template.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/archiva/redback/integration/mail/FreemarkerMailGenerator.html#generateMail-java.lang.String-java.util.Locale-org.apache.archiva.redback.keys.AuthenticationKey-java.lang.String-">generateMail</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> templateName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> locale, |
| <a href="../../../../../../org/apache/archiva/redback/keys/AuthenticationKey.html" title="interface in org.apache.archiva.redback.keys">AuthenticationKey</a> authenticationKey, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> baseUrl)</code> |
| <div class="block">Generates a mail string from a template.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/archiva/redback/integration/mail/FreemarkerMailGenerator.html#generateMail-java.lang.String-java.util.Locale-org.apache.archiva.redback.keys.AuthenticationKey-java.lang.String-java.util.Map-">generateMail</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> templateName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> locale, |
| <a href="../../../../../../org/apache/archiva/redback/keys/AuthenticationKey.html" title="interface in org.apache.archiva.redback.keys">AuthenticationKey</a> authkey, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> baseUrl, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> templateData)</code> |
| <div class="block">Generates a mail string from a template.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/archiva/redback/configuration/UserConfiguration.html" title="interface in org.apache.archiva.redback.configuration">UserConfiguration</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/archiva/redback/integration/mail/FreemarkerMailGenerator.html#getConfig--">getConfig</a></span>()</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>freemarker.template.Configuration</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/archiva/redback/integration/mail/FreemarkerMailGenerator.html#getFreemarkerConfiguration--">getFreemarkerConfiguration</a></span>()</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/archiva/redback/integration/mail/FreemarkerMailGenerator.html#setConfig-org.apache.archiva.redback.configuration.UserConfiguration-">setConfig</a></span>(<a href="../../../../../../org/apache/archiva/redback/configuration/UserConfiguration.html" title="interface in org.apache.archiva.redback.configuration">UserConfiguration</a> config)</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/archiva/redback/integration/mail/FreemarkerMailGenerator.html#setFreemarkerConfiguration-freemarker.template.Configuration-">setFreemarkerConfiguration</a></span>(freemarker.template.Configuration freemarkerConfiguration)</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="DEFAULT_ENCODING"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DEFAULT_ENCODING</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/archiva/redback/integration/mail/FreemarkerMailGenerator.html#line.69">DEFAULT_ENCODING</a></pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.apache.archiva.redback.integration.mail.FreemarkerMailGenerator.DEFAULT_ENCODING">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="FreemarkerMailGenerator--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>FreemarkerMailGenerator</h4> |
| <pre>public <a href="../../../../../../src-html/org/apache/archiva/redback/integration/mail/FreemarkerMailGenerator.html#line.65">FreemarkerMailGenerator</a>()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="generateMail-java.lang.String-java.util.Locale-org.apache.archiva.redback.keys.AuthenticationKey-java.lang.String-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>generateMail</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/archiva/redback/integration/mail/FreemarkerMailGenerator.html#line.108">generateMail</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> templateName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> locale, |
| <a href="../../../../../../org/apache/archiva/redback/keys/AuthenticationKey.html" title="interface in org.apache.archiva.redback.keys">AuthenticationKey</a> authkey, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> baseUrl, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> templateData)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/archiva/redback/integration/mail/MailGenerator.html#generateMail-java.lang.String-java.util.Locale-org.apache.archiva.redback.keys.AuthenticationKey-java.lang.String-java.util.Map-">MailGenerator</a></code></span></div> |
| <div class="block">Generates a mail string from a template. The given locale is used for retrieving the template. |
| How the template will be located depends on the underlying implementation. |
| The templateData is used as model data that is interpolated from the template.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/archiva/redback/integration/mail/MailGenerator.html#generateMail-java.lang.String-java.util.Locale-org.apache.archiva.redback.keys.AuthenticationKey-java.lang.String-java.util.Map-">generateMail</a></code> in interface <code><a href="../../../../../../org/apache/archiva/redback/integration/mail/MailGenerator.html" title="interface in org.apache.archiva.redback.integration.mail">MailGenerator</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>templateName</code> - the template name without extension</dd> |
| <dd><code>locale</code> - the locale used to find the template file</dd> |
| <dd><code>authkey</code> - the authentication key</dd> |
| <dd><code>baseUrl</code> - the base url</dd> |
| <dd><code>templateData</code> - additional template data, may be <code>null</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the string generated from the template</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="generateMail-java.lang.String-org.apache.archiva.redback.keys.AuthenticationKey-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>generateMail</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/archiva/redback/integration/mail/FreemarkerMailGenerator.html#line.127">generateMail</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> templateName, |
| <a href="../../../../../../org/apache/archiva/redback/keys/AuthenticationKey.html" title="interface in org.apache.archiva.redback.keys">AuthenticationKey</a> authenticationKey, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> baseUrl)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/archiva/redback/integration/mail/MailGenerator.html#generateMail-java.lang.String-org.apache.archiva.redback.keys.AuthenticationKey-java.lang.String-">MailGenerator</a></code></span></div> |
| <div class="block">Generates a mail string from a template. How the template will be located depends on the underlying |
| implementation. |
| It uses a default locale.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/archiva/redback/integration/mail/MailGenerator.html#generateMail-java.lang.String-org.apache.archiva.redback.keys.AuthenticationKey-java.lang.String-">generateMail</a></code> in interface <code><a href="../../../../../../org/apache/archiva/redback/integration/mail/MailGenerator.html" title="interface in org.apache.archiva.redback.integration.mail">MailGenerator</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>templateName</code> - the template name without extension</dd> |
| <dd><code>authenticationKey</code> - the authentication key of the current user</dd> |
| <dd><code>baseUrl</code> - the base url</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A string for the mail body generated from the template</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="generateMail-java.lang.String-java.util.Locale-org.apache.archiva.redback.keys.AuthenticationKey-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>generateMail</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/archiva/redback/integration/mail/FreemarkerMailGenerator.html#line.133">generateMail</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> templateName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> locale, |
| <a href="../../../../../../org/apache/archiva/redback/keys/AuthenticationKey.html" title="interface in org.apache.archiva.redback.keys">AuthenticationKey</a> authenticationKey, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> baseUrl)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/archiva/redback/integration/mail/MailGenerator.html#generateMail-java.lang.String-java.util.Locale-org.apache.archiva.redback.keys.AuthenticationKey-java.lang.String-">MailGenerator</a></code></span></div> |
| <div class="block">Generates a mail string from a template. The given locale is used for retrieving the template. |
| How the template will be located depends on the underlying implementation.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/archiva/redback/integration/mail/MailGenerator.html#generateMail-java.lang.String-java.util.Locale-org.apache.archiva.redback.keys.AuthenticationKey-java.lang.String-">generateMail</a></code> in interface <code><a href="../../../../../../org/apache/archiva/redback/integration/mail/MailGenerator.html" title="interface in org.apache.archiva.redback.integration.mail">MailGenerator</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>templateName</code> - the template name without extension</dd> |
| <dd><code>locale</code> - the locale used to find the template file</dd> |
| <dd><code>authenticationKey</code> - the authentication key of the current user</dd> |
| <dd><code>baseUrl</code> - the base url</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a string for the mail body generated from the template</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFreemarkerConfiguration--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFreemarkerConfiguration</h4> |
| <pre>public freemarker.template.Configuration <a href="../../../../../../src-html/org/apache/archiva/redback/integration/mail/FreemarkerMailGenerator.html#line.187">getFreemarkerConfiguration</a>()</pre> |
| </li> |
| </ul> |
| <a name="setFreemarkerConfiguration-freemarker.template.Configuration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFreemarkerConfiguration</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/archiva/redback/integration/mail/FreemarkerMailGenerator.html#line.192">setFreemarkerConfiguration</a>(freemarker.template.Configuration freemarkerConfiguration)</pre> |
| </li> |
| </ul> |
| <a name="getConfig--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConfig</h4> |
| <pre>public <a href="../../../../../../org/apache/archiva/redback/configuration/UserConfiguration.html" title="interface in org.apache.archiva.redback.configuration">UserConfiguration</a> <a href="../../../../../../src-html/org/apache/archiva/redback/integration/mail/FreemarkerMailGenerator.html#line.197">getConfig</a>()</pre> |
| </li> |
| </ul> |
| <a name="setConfig-org.apache.archiva.redback.configuration.UserConfiguration-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setConfig</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/archiva/redback/integration/mail/FreemarkerMailGenerator.html#line.202">setConfig</a>(<a href="../../../../../../org/apache/archiva/redback/configuration/UserConfiguration.html" title="interface in org.apache.archiva.redback.configuration">UserConfiguration</a> config)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/FreemarkerMailGenerator.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li><a href="../../../../../../org/apache/archiva/redback/integration/mail/Mailer.html" title="interface in org.apache.archiva.redback.integration.mail"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/archiva/redback/integration/mail/FreemarkerMailGenerator.html" target="_top">Frames</a></li> |
| <li><a href="FreemarkerMailGenerator.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2006–2019 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
