svn commit: r1711895 - /incubator/sirona/site-content/trunk/src/site/markdown/alerts.md

[rm...@apache.org]

Author: rmannibucau
Date: Mon Nov  2 04:44:27 2015
New Revision: 1711895

URL: http://svn.apache.org/viewvc?rev=1711895&view=rev
Log:
mail alerter config

Modified:
    incubator/sirona/site-content/trunk/src/site/markdown/alerts.md

Modified: incubator/sirona/site-content/trunk/src/site/markdown/alerts.md
URL: http://svn.apache.org/viewvc/incubator/sirona/site-content/trunk/src/site/markdown/alerts.md?rev=1711895&r1=1711894&r2=1711895&view=diff
==============================================================================
--- incubator/sirona/site-content/trunk/src/site/markdown/alerts.md (original)
+++ incubator/sirona/site-content/trunk/src/site/markdown/alerts.md Mon Nov  2 04:44:27 2015
@@ -43,3 +43,28 @@ mail.host = xxxxx
 mail.password = ...
 mail.protocol = smtp
 ]]></pre>
+
+## MailAlerter
+
+`sirona-alerter-mail` provides a javamail alerter.
+
+Here is the configuration supposing your alerter is named `mail`:
+
+<pre class="prettyprint linenums"><![CDATA[
+mail.from = me@provider.com
+mail.port = 1234
+mail.host = provider.com
+mail.to = target@provider.com
+mail.user = xxx
+mail.password = xxx
+mail.timeout = 60000
+mail.tls = true
+mail.auth = true
+mail.protocol = smtp
+mail.template = ${marker} throw an alert for:\n${resultsCsv}
+mail.subjectTemplate = ${marker} throw an alert at ${date}
+
+
+# true to use the default javamail session with the previous configuration (Session.getDefaultInstance())
+mail.useDefault = false
+]]></pre>