Current section
Files
Jump to
Current section
Files
docs/Mailman.LocalServer.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v0.16.3">
<title>Mailman.LocalServer – Mailman v0.4.0</title>
<link rel="stylesheet" href="dist/app-5b9e160cec.css" />
<link rel="canonical" href="https://hexdocs.pm/mailman/Mailman.LocalServer.html" />
<script src="dist/sidebar_items-f0abb4a495.js"></script>
</head>
<body data-type="modules">
<script>try { if(localStorage.getItem('night-mode')) document.body.className += ' night-mode'; } catch (e) { }</script>
<div class="main">
<button class="sidebar-toggle">
<span class="icon-menu" aria-hidden="true"></span>
<span class="sr-only">Toggle Sidebar</span>
</button>
<section class="sidebar">
<a href="https://github.com/kamilc/mailman" class="sidebar-projectLink">
<div class="sidebar-projectDetails">
<h1 class="sidebar-projectName">
Mailman
</h1>
<h2 class="sidebar-projectVersion">
v0.4.0
</h2>
</div>
</a>
<form class="sidebar-search" action="search.html">
<button type="submit" class="search-button">
<span class="icon-search" aria-hidden="true"></span>
</button>
<input name="q" type="text" id="search-list" class="search-input" placeholder="search" aria-label="Search" autocomplete="off" />
</form>
<ul class="sidebar-listNav">
<li><a id="extras-list" href="#full-list">Pages</a></li>
<li><a id="modules-list" href="#full-list">Modules</a></li>
<li><a id="protocols-list" href="#full-list">Protocols</a></li>
</ul>
<div class="gradient"></div>
<ul id="full-list" class="sidebar-fullList"></ul>
</section>
<section class="content">
<div class="content-outer">
<div id="content" class="content-inner">
<h1>
<small class="visible-xs">Mailman v0.4.0</small>
Mailman.LocalServer
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/local_server.ex#L1" title="View Source" class="view-source" rel="help">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</h1>
<section id="moduledoc">
<p>Basic SMTP implementation via the gen_smtp_sever_session behavior. Implements relay’ing to external servers.</p>
</section>
<section id="summary" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#summary">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this section</span>
</a>
Summary
</h1>
<div class="summary-functions summary">
<h2>
<a href="#functions">Functions</a>
</h2>
<div class="summary-row">
<div class="summary-signature">
<a href="#code_change/3">code_change(old, state, extra)</a>
</div>
<div class="summary-synopsis"><p>Callback implementation for <code class="inline">c::gen_smtp_server_session.code_change/3</code></p>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#handle_AUTH/4">handle_AUTH(type, username, password, state)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#handle_DATA/4">handle_DATA(from, to, data, state)</a>
</div>
<div class="summary-synopsis"><p>Callback implementation for <code class="inline">c::gen_smtp_server_session.handle_DATA/4</code></p>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#handle_EHLO/3">handle_EHLO(hostname, extensions, state)</a>
</div>
<div class="summary-synopsis"><p>Callback implementation for <code class="inline">c::gen_smtp_server_session.handle_EHLO/3</code></p>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#handle_HELO/2">handle_HELO(hostname, state)</a>
</div>
<div class="summary-synopsis"><p>Callback implementation for <code class="inline">c::gen_smtp_server_session.handle_HELO/2</code></p>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#handle_MAIL/2">handle_MAIL(from, state)</a>
</div>
<div class="summary-synopsis"><p>Callback implementation for <code class="inline">c::gen_smtp_server_session.handle_MAIL/2</code></p>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#handle_MAIL_extension/2">handle_MAIL_extension(extension, state)</a>
</div>
<div class="summary-synopsis"><p>Callback implementation for <code class="inline">c::gen_smtp_server_session.handle_MAIL_extension/2</code></p>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#handle_RCPT/2">handle_RCPT(to, state)</a>
</div>
<div class="summary-synopsis"><p>Callback implementation for <code class="inline">c::gen_smtp_server_session.handle_RCPT/2</code></p>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#handle_RCPT_extension/2">handle_RCPT_extension(to, state)</a>
</div>
<div class="summary-synopsis"><p>Callback implementation for <code class="inline">c::gen_smtp_server_session.handle_RCPT_extension/2</code></p>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#handle_RSET/1">handle_RSET(state)</a>
</div>
<div class="summary-synopsis"><p>Callback implementation for <code class="inline">c::gen_smtp_server_session.handle_RSET/1</code></p>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#handle_STARTTLS/1">handle_STARTTLS(state)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#handle_VRFY/2">handle_VRFY(address, state)</a>
</div>
<div class="summary-synopsis"><p>Callback implementation for <code class="inline">c::gen_smtp_server_session.handle_VRFY/2</code></p>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#handle_other/3">handle_other(verb, args, state)</a>
</div>
<div class="summary-synopsis"><p>Callback implementation for <code class="inline">c::gen_smtp_server_session.handle_other/3</code></p>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#init/4">init(hostname, session_count, address, options)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#relay/3">relay(from, list, data)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#start/1">start(port)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#terminate/2">terminate(reason, state)</a>
</div>
</div>
</div>
</section>
<section id="functions" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#functions">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this section</span>
</a>
Functions
</h1>
<div class="detail" id="code_change/3">
<div class="detail-header">
<a href="#code_change/3" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<span class="signature">code_change(old, state, extra)</span>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/local_server.ex#L59" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Callback implementation for <code class="inline">c::gen_smtp_server_session.code_change/3</code>.</p>
</section>
</div>
<div class="detail" id="handle_AUTH/4">
<div class="detail-header">
<a href="#handle_AUTH/4" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<span class="signature">handle_AUTH(type, username, password, state)</span>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/local_server.ex#L51" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</div>
<div class="detail" id="handle_DATA/4">
<div class="detail-header">
<a href="#handle_DATA/4" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<span class="signature">handle_DATA(from, to, data, state)</span>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/local_server.ex#L34" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Callback implementation for <code class="inline">c::gen_smtp_server_session.handle_DATA/4</code>.</p>
</section>
</div>
<div class="detail" id="handle_EHLO/3">
<div class="detail-header">
<a href="#handle_EHLO/3" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<span class="signature">handle_EHLO(hostname, extensions, state)</span>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/local_server.ex#L14" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Callback implementation for <code class="inline">c::gen_smtp_server_session.handle_EHLO/3</code>.</p>
</section>
</div>
<div class="detail" id="handle_HELO/2">
<div class="detail-header">
<a href="#handle_HELO/2" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<span class="signature">handle_HELO(hostname, state)</span>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/local_server.ex#L10" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Callback implementation for <code class="inline">c::gen_smtp_server_session.handle_HELO/2</code>.</p>
</section>
</div>
<div class="detail" id="handle_MAIL/2">
<div class="detail-header">
<a href="#handle_MAIL/2" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<span class="signature">handle_MAIL(from, state)</span>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/local_server.ex#L18" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Callback implementation for <code class="inline">c::gen_smtp_server_session.handle_MAIL/2</code>.</p>
</section>
</div>
<div class="detail" id="handle_MAIL_extension/2">
<div class="detail-header">
<a href="#handle_MAIL_extension/2" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<span class="signature">handle_MAIL_extension(extension, state)</span>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/local_server.ex#L22" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Callback implementation for <code class="inline">c::gen_smtp_server_session.handle_MAIL_extension/2</code>.</p>
</section>
</div>
<div class="detail" id="handle_RCPT/2">
<div class="detail-header">
<a href="#handle_RCPT/2" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<span class="signature">handle_RCPT(to, state)</span>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/local_server.ex#L26" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Callback implementation for <code class="inline">c::gen_smtp_server_session.handle_RCPT/2</code>.</p>
</section>
</div>
<div class="detail" id="handle_RCPT_extension/2">
<div class="detail-header">
<a href="#handle_RCPT_extension/2" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<span class="signature">handle_RCPT_extension(to, state)</span>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/local_server.ex#L30" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Callback implementation for <code class="inline">c::gen_smtp_server_session.handle_RCPT_extension/2</code>.</p>
</section>
</div>
<div class="detail" id="handle_RSET/1">
<div class="detail-header">
<a href="#handle_RSET/1" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<span class="signature">handle_RSET(state)</span>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/local_server.ex#L39" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Callback implementation for <code class="inline">c::gen_smtp_server_session.handle_RSET/1</code>.</p>
</section>
</div>
<div class="detail" id="handle_STARTTLS/1">
<div class="detail-header">
<a href="#handle_STARTTLS/1" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<span class="signature">handle_STARTTLS(state)</span>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/local_server.ex#L55" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</div>
<div class="detail" id="handle_VRFY/2">
<div class="detail-header">
<a href="#handle_VRFY/2" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<span class="signature">handle_VRFY(address, state)</span>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/local_server.ex#L43" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Callback implementation for <code class="inline">c::gen_smtp_server_session.handle_VRFY/2</code>.</p>
</section>
</div>
<div class="detail" id="handle_other/3">
<div class="detail-header">
<a href="#handle_other/3" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<span class="signature">handle_other(verb, args, state)</span>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/local_server.ex#L47" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Callback implementation for <code class="inline">c::gen_smtp_server_session.handle_other/3</code>.</p>
</section>
</div>
<div class="detail" id="init/4">
<div class="detail-header">
<a href="#init/4" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<span class="signature">init(hostname, session_count, address, options)</span>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/local_server.ex#L5" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</div>
<div class="detail" id="relay/3">
<div class="detail-header">
<a href="#relay/3" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<span class="signature">relay(from, list, data)</span>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/local_server.ex#L71" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</div>
<div class="detail" id="start/1">
<div class="detail-header">
<a href="#start/1" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<span class="signature">start(port)</span>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/local_server.ex#L77" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</div>
<div class="detail" id="terminate/2">
<div class="detail-header">
<a href="#terminate/2" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<span class="signature">terminate(reason, state)</span>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/local_server.ex#L63" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</div>
</section>
<footer class="footer">
<p>
<span class="line">
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" rel="help" target="_blank">ExDoc</a> (v0.16.3),
</span>
<span class="line">
designed by
<a href="https://twitter.com/dignifiedquire" target="_blank" title="@dignifiedquire">Friedel Ziegelmayer</a>.
</span>
</p>
<button class="night-mode-toggle"><span class="sr-only">Switch theme</span></button>
</footer>
</div>
</div>
</section>
</div>
<script src="dist/app-da04b39d0c.js"></script>
</body>
</html>