timbre/taoensso.timbre.appenders.postal.html
Peter Taoussanis a550f84c84 v3.4.0
2015-04-29 12:04:43 +07:00

11 lines
4.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.4.0 API documentation</a></h1></div><div class="sidebar" id="namespaces"><h3><a href="index.html"><span class="inner">Namespaces</span></a></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>taoensso</span></div></div></li><li class="depth-2"><a href="taoensso.timbre.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>timbre</span></div></a></li><li class="depth-3"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>appenders</span></div></div></li><li class="depth-4 branch"><a href="taoensso.timbre.appenders.carmine.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>carmine</span></div></a></li><li class="depth-4 branch"><a href="taoensso.timbre.appenders.irc.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>irc</span></div></a></li><li class="depth-4 branch current"><a href="taoensso.timbre.appenders.postal.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>postal</span></div></a></li><li class="depth-4 branch"><a href="taoensso.timbre.appenders.rolling.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>rolling</span></div></a></li><li class="depth-4"><a href="taoensso.timbre.appenders.rotor.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>rotor</span></div></a></li><li class="depth-3 branch"><a href="taoensso.timbre.profiling.html"><div class="inner"><span class="tree" style="top: -176px;"><span class="top" style="height: 185px;"></span><span class="bottom"></span></span><span>profiling</span></div></a></li><li class="depth-3"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>tools</span></div></div></li><li class="depth-4"><a href="taoensso.timbre.tools.logging.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>logging</span></div></a></li><li class="depth-3"><a href="taoensso.timbre.utils.html"><div class="inner"><span class="tree" style="top: -52px;"><span class="top" style="height: 61px;"></span><span class="bottom"></span></span><span>utils</span></div></a></li></ul></div><div class="sidebar" id="vars"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="taoensso.timbre.appenders.postal.html#var-make-postal-appender"><div class="inner"><span>make-postal-appender</span></div></a></li><li class="depth-1"><a href="taoensso.timbre.appenders.postal.html#var-postal-appender"><div class="inner"><span>postal-appender</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h2 class="anchor" id="top">taoensso.timbre.appenders.postal</h2><div class="doc"><pre class="plaintext">Email appender. Requires <a href="https://github.com/drewr/postal">https://github.com/drewr/postal</a>.
</pre></div><div class="public anchor" 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><div class="doc"><pre class="plaintext">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&apos;s logger &lt;me@draines.com&gt;&quot; :to &quot;foo@example.com&quot;}})</pre></div></div><div class="public anchor" id="var-postal-appender"><h3>postal-appender</h3><div class="usage"></div><div class="doc"><pre class="plaintext">DEPRECATED: Use `make-postal-appender` instead.
</pre></div></div></div></body></html>