Current section

Files

Jump to
mailman docs Mailman.Emails.html
Raw

docs/Mailman.Emails.html

<!DOCTYPE html>
<html>
<head>
<title>Mailman.Emails</title>
<meta charset="utf-8">
<link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
relpath = '';
if (relpath != '') relpath += '/';
</script>
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
</head>
<body>
<script type="text/javascript" charset="utf-8">
if (window.top.frames.main) document.body.className = 'frames';
</script>
<div id="content">
<div class="breadcrumbs">Mailman v0.0.3 &rarr; <a href="overview.html">Overview</a> &rarr; <a href="Mailman.html">Mailman</a> &rarr; <a href="Mailman.Emails.html">Emails</a></div>
<h1>
Mailman.Emails
</h1>
<ul class="summary_links">
<li><a href="#summary">Summary</a></li>
<li><a href="#functions_details">Functions</a></li>
</ul>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/emails.ex#L1" class="view_source">Source</a>
<h2 id="summary">Summary<div class="detail_header_links"><a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a></div></h2>
<table class="summary">
<tr>
<td class="summary_signature"><a href="#alternatives_header/1">alternatives_header(envelope)</a></td>
</tr>
<tr>
<td class="summary_signature"><a href="#boundary_for/1">boundary_for(envelope)</a></td>
</tr>
<tr>
<td class="summary_signature"><a href="#compile_alternatives/1">compile_alternatives(envelope)</a></td>
</tr>
<tr>
<td class="summary_signature"><a href="#compile_alternatives_from_html/1">compile_alternatives_from_html(envelope)</a></td>
</tr>
<tr>
<td class="summary_signature"><a href="#compile_parts/2">compile_parts(email, composer)</a></td>
</tr>
<tr>
<td class="summary_signature"><a href="#compile_plain/1">compile_plain(envelope)</a></td>
</tr>
<tr>
<td class="summary_signature"><a href="#has_alternatives?/1">has_alternatives?(envelope)</a></td>
</tr>
<tr>
<td class="summary_signature"><a href="#has_html?/1">has_html?(envelope)</a></td>
</tr>
<tr>
<td class="summary_signature"><a href="#has_plain?/1">has_plain?(envelope)</a></td>
</tr>
<tr>
<td class="summary_signature"><a href="#header_for/1">header_for(envelope)</a></td>
</tr>
<tr>
<td class="summary_signature"><a href="#html_header/0">html_header()</a></td>
</tr>
<tr>
<td class="summary_signature"><a href="#html_part/1">html_part(envelope)</a></td>
</tr>
<tr>
<td class="summary_signature"><a href="#main_content_type_for/1">main_content_type_for(envelope)</a></td>
</tr>
<tr>
<td class="summary_signature"><a href="#plain_from_html_part/1">plain_from_html_part()</a></td>
</tr>
<tr>
<td class="summary_signature"><a href="#plain_header/0">plain_header()</a></td>
</tr>
<tr>
<td class="summary_signature"><a href="#plain_part/1">plain_part(envelope)</a></td>
</tr>
<tr>
<td class="summary_signature"><a href="#render/2">render(email, composer)</a></td>
<td class="summary_synopsis"><p>Returns a tuple with all data needed for the underlying adapter to send</p>
</td>
</tr>
<tr>
<td class="summary_signature"><a href="#to_envelope/2">to_envelope(email, composer)</a></td>
</tr>
<tr>
<td class="summary_signature"><a href="#to_message/1">to_message(envelope)</a></td>
</tr>
</table>
<div id="functions_details" class="details_list">
<h2>Functions</h2>
<div class="detail">
<div class="detail_header" id="alternatives_header/1">
<span class="signature"><strong>alternatives_header(envelope)</strong></span>
<div class="detail_header_links">
<span class="detail_type">(function)</span>
<a href="#alternatives_header/1" class="detail_link" title="Link to this function">#</a>
<a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a>
</div>
</div>
<div class="docstring"></div>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/emails.ex#L69" class="view_source">Source</a>
</div>
<div class="detail">
<div class="detail_header" id="boundary_for/1">
<span class="signature"><strong>boundary_for(envelope)</strong></span>
<div class="detail_header_links">
<span class="detail_type">(function)</span>
<a href="#boundary_for/1" class="detail_link" title="Link to this function">#</a>
<a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a>
</div>
</div>
<div class="docstring"></div>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/emails.ex#L105" class="view_source">Source</a>
</div>
<div class="detail">
<div class="detail_header" id="compile_alternatives/1">
<span class="signature"><strong>compile_alternatives(envelope)</strong></span>
<div class="detail_header_links">
<span class="detail_type">(function)</span>
<a href="#compile_alternatives/1" class="detail_link" title="Link to this function">#</a>
<a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a>
</div>
</div>
<div class="docstring"></div>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/emails.ex#L53" class="view_source">Source</a>
</div>
<div class="detail">
<div class="detail_header" id="compile_alternatives_from_html/1">
<span class="signature"><strong>compile_alternatives_from_html(envelope)</strong></span>
<div class="detail_header_links">
<span class="detail_type">(function)</span>
<a href="#compile_alternatives_from_html/1" class="detail_link" title="Link to this function">#</a>
<a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a>
</div>
</div>
<div class="docstring"></div>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/emails.ex#L57" class="view_source">Source</a>
</div>
<div class="detail">
<div class="detail_header" id="compile_parts/2">
<span class="signature"><strong>compile_parts(email, composer)</strong></span>
<div class="detail_header_links">
<span class="detail_type">(function)</span>
<a href="#compile_parts/2" class="detail_link" title="Link to this function">#</a>
<a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a>
</div>
</div>
<div class="docstring"></div>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/emails.ex#L19" class="view_source">Source</a>
</div>
<div class="detail">
<div class="detail_header" id="compile_plain/1">
<span class="signature"><strong>compile_plain(envelope)</strong></span>
<div class="detail_header_links">
<span class="detail_type">(function)</span>
<a href="#compile_plain/1" class="detail_link" title="Link to this function">#</a>
<a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a>
</div>
</div>
<div class="docstring"></div>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/emails.ex#L49" class="view_source">Source</a>
</div>
<div class="detail">
<div class="detail_header" id="has_alternatives?/1">
<span class="signature"><strong>has_alternatives?(envelope)</strong></span>
<div class="detail_header_links">
<span class="detail_type">(function)</span>
<a href="#has_alternatives?/1" class="detail_link" title="Link to this function">#</a>
<a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a>
</div>
</div>
<div class="docstring"></div>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/emails.ex#L45" class="view_source">Source</a>
</div>
<div class="detail">
<div class="detail_header" id="has_html?/1">
<span class="signature"><strong>has_html?(envelope)</strong></span>
<div class="detail_header_links">
<span class="detail_type">(function)</span>
<a href="#has_html?/1" class="detail_link" title="Link to this function">#</a>
<a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a>
</div>
</div>
<div class="docstring"></div>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/emails.ex#L37" class="view_source">Source</a>
</div>
<div class="detail">
<div class="detail_header" id="has_plain?/1">
<span class="signature"><strong>has_plain?(envelope)</strong></span>
<div class="detail_header_links">
<span class="detail_type">(function)</span>
<a href="#has_plain?/1" class="detail_link" title="Link to this function">#</a>
<a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a>
</div>
</div>
<div class="docstring"></div>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/emails.ex#L41" class="view_source">Source</a>
</div>
<div class="detail">
<div class="detail_header" id="header_for/1">
<span class="signature"><strong>header_for(envelope)</strong></span>
<div class="detail_header_links">
<span class="detail_type">(function)</span>
<a href="#header_for/1" class="detail_link" title="Link to this function">#</a>
<a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a>
</div>
</div>
<div class="docstring"></div>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/emails.ex#L92" class="view_source">Source</a>
</div>
<div class="detail">
<div class="detail_header" id="html_header/0">
<span class="signature"><strong>html_header()</strong></span>
<div class="detail_header_links">
<span class="detail_type">(function)</span>
<a href="#html_header/0" class="detail_link" title="Link to this function">#</a>
<a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a>
</div>
</div>
<div class="docstring"></div>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/emails.ex#L65" class="view_source">Source</a>
</div>
<div class="detail">
<div class="detail_header" id="html_part/1">
<span class="signature"><strong>html_part(envelope)</strong></span>
<div class="detail_header_links">
<span class="detail_type">(function)</span>
<a href="#html_part/1" class="detail_link" title="Link to this function">#</a>
<a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a>
</div>
</div>
<div class="docstring"></div>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/emails.ex#L84" class="view_source">Source</a>
</div>
<div class="detail">
<div class="detail_header" id="main_content_type_for/1">
<span class="signature"><strong>main_content_type_for(envelope)</strong></span>
<div class="detail_header_links">
<span class="detail_type">(function)</span>
<a href="#main_content_type_for/1" class="detail_link" title="Link to this function">#</a>
<a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a>
</div>
</div>
<div class="docstring"></div>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/emails.ex#L73" class="view_source">Source</a>
</div>
<div class="detail">
<div class="detail_header" id="plain_from_html_part/1">
<span class="signature"><strong>plain_from_html_part()</strong></span>
<div class="detail_header_links">
<span class="detail_type">(function)</span>
<a href="#plain_from_html_part/1" class="detail_link" title="Link to this function">#</a>
<a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a>
</div>
</div>
<div class="docstring"></div>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/emails.ex#L88" class="view_source">Source</a>
</div>
<div class="detail">
<div class="detail_header" id="plain_header/0">
<span class="signature"><strong>plain_header()</strong></span>
<div class="detail_header_links">
<span class="detail_type">(function)</span>
<a href="#plain_header/0" class="detail_link" title="Link to this function">#</a>
<a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a>
</div>
</div>
<div class="docstring"></div>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/emails.ex#L61" class="view_source">Source</a>
</div>
<div class="detail">
<div class="detail_header" id="plain_part/1">
<span class="signature"><strong>plain_part(envelope)</strong></span>
<div class="detail_header_links">
<span class="detail_type">(function)</span>
<a href="#plain_part/1" class="detail_link" title="Link to this function">#</a>
<a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a>
</div>
</div>
<div class="docstring"></div>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/emails.ex#L80" class="view_source">Source</a>
</div>
<div class="detail">
<div class="detail_header" id="render/2">
<span class="signature"><strong>render(email, composer)</strong></span>
<div class="detail_header_links">
<span class="detail_type">(function)</span>
<a href="#render/2" class="detail_link" title="Link to this function">#</a>
<a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a>
</div>
</div>
<div class="docstring"><p>Returns a tuple with all data needed for the underlying adapter to send</p>
</div>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/emails.ex#L4" class="view_source">Source</a>
</div>
<div class="detail">
<div class="detail_header" id="to_envelope/2">
<span class="signature"><strong>to_envelope(email, composer)</strong></span>
<div class="detail_header_links">
<span class="detail_type">(function)</span>
<a href="#to_envelope/2" class="detail_link" title="Link to this function">#</a>
<a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a>
</div>
</div>
<div class="docstring"></div>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/emails.ex#L8" class="view_source">Source</a>
</div>
<div class="detail">
<div class="detail_header" id="to_message/1">
<span class="signature"><strong>to_message(envelope)</strong></span>
<div class="detail_header_links">
<span class="detail_type">(function)</span>
<a href="#to_message/1" class="detail_link" title="Link to this function">#</a>
<a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a>
</div>
</div>
<div class="docstring"></div>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/emails.ex#L27" class="view_source">Source</a>
</div>
</div>
</div>
</body>
</html>