timbre/taoensso.timbre.appenders.postal.html
Peter Taoussanis 49431a2af6 v3.0.0-RC2
2013-12-04 16:49:19 +07:00

11 lines
2.6 KiB
HTML

<!DOCTYPE html>
<html><head><meta charset="UTF-8"><link href="css/default.css" rel="stylesheet" type="text/css"><script src="js/jquery.min.js" type="text/javascript"></script><script src="js/page_effects.js" type="text/javascript"></script><title>taoensso.timbre.appenders.postal documentation</title></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html">Timbre 3.0.0-RC2 API documentation</a></h1></div><div class="sidebar" id="namespaces"><h3><span>Namespaces</span></h3><ul><li><a href="taoensso.timbre.html"><span>taoensso.timbre</span></a></li><li><a href="taoensso.timbre.appenders.carmine.html"><span>taoensso.timbre.appenders.carmine</span></a></li><li class="current"><a href="taoensso.timbre.appenders.postal.html"><span>taoensso.timbre.appenders.postal</span></a></li><li><a href="taoensso.timbre.appenders.rotor.html"><span>taoensso.timbre.appenders.rotor</span></a></li><li><a href="taoensso.timbre.profiling.html"><span>taoensso.timbre.profiling</span></a></li><li><a href="taoensso.timbre.tools.logging.html"><span>taoensso.timbre.tools.logging</span></a></li><li><a href="taoensso.timbre.utils.html"><span>taoensso.timbre.utils</span></a></li></ul></div><div class="sidebar" id="vars"><h3>Public Vars</h3><ul><li><a href="taoensso.timbre.appenders.postal.html#var-make-postal-appender"><span>make-postal-appender</span></a></li><li><a href="taoensso.timbre.appenders.postal.html#var-postal-appender"><span>postal-appender</span></a></li></ul></div><div class="namespace-docs" id="content"><h2>taoensso.timbre.appenders.postal documentation</h2><pre class="doc">Email appender. Requires https://github.com/drewr/postal.
</pre><div class="public" id="var-make-postal-appender"><h3>make-postal-appender</h3><div class="usage"><code>(make-postal-appender &amp; [appender-opts {:keys [postal-config subject-len body-fn], :or {subject-len 150, body-fn (fn [output] [{:type &quot;text/plain; charset=utf-8&quot;, :content output}])}}])</code></div><pre class="doc">Returns a Postal email appender.
A Postal config map can be provided here as an argument, or as a :postal key
in :shared-appender-config.
(make-postal-appender {:enabled? true}
{:postal-config
^{:host &quot;mail.isp.net&quot; :user &quot;jsmith&quot; :pass &quot;sekrat!!1&quot;}
{:from &quot;Bob's logger &lt;me@draines.com&gt;&quot; :to &quot;foo@example.com&quot;}})</pre></div><div class="public" id="var-postal-appender"><h3>postal-appender</h3><div class="usage"></div><pre class="doc">DEPRECATED: Use `make-postal-appender` instead.
</pre></div></div></body></html>