File: //usr/share/doc/python3-aiosmtpd/html/intro.html
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Introduction — aiosmtpd 1.4.4.post2 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=86f27845" />
<link rel="stylesheet" type="text/css" href="_static/aiosmtpd.css?v=4cc6bf70" />
<script src="_static/jquery.js?v=8dae8fb0"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=ad49bbf5"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Concepts" href="concepts.html" />
<link rel="prev" title="aiosmtpd - An asyncio based SMTP server" href="index.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
aiosmtpd
</a>
<div class="version">
1.4.4.post2
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Introduction</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#relevant-rfcs">Relevant RFCs</a></li>
<li class="toctree-l2"><a class="reference internal" href="#other-references">Other references</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="concepts.html">Concepts</a></li>
<li class="toctree-l1"><a class="reference internal" href="cli.html">Command line usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="controller.html">Programmatic usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="smtp.html">The SMTP Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="lmtp.html">The LMTP class</a></li>
<li class="toctree-l1"><a class="reference internal" href="handlers.html">Handlers</a></li>
<li class="toctree-l1"><a class="reference internal" href="auth.html">Authentication System</a></li>
<li class="toctree-l1"><a class="reference internal" href="proxyprotocol.html">PROXY Protocol Support</a></li>
<li class="toctree-l1"><a class="reference internal" href="migrating.html">Migrating from smtpd to aiosmtpd</a></li>
<li class="toctree-l1"><a class="reference internal" href="testing.html">Testing</a></li>
<li class="toctree-l1"><a class="reference internal" href="manpage.html">aiosmtpd</a></li>
<li class="toctree-l1"><a class="reference internal" href="NEWS.html">NEWS for aiosmtpd</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">aiosmtpd</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Introduction</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/intro.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="introduction">
<h1>Introduction<a class="headerlink" href="#introduction" title="Link to this heading"></a></h1>
<p>This library provides an <code class="xref py py-mod docutils literal notranslate"><span class="pre">asyncio</span></code>-based implementation of a server for
<span class="target" id="index-0"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc5321.html"><strong>RFC 5321</strong></a> -
Simple Mail Transfer Protocol (SMTP) and
<span class="target" id="index-1"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2033.html"><strong>RFC 2033</strong></a> -
Local Mail Transfer Protocol (LMTP). It is derived from
<a class="reference external" href="https://hg.python.org/cpython/file/3.5/Lib/smtpd.py">Python 3.5’s smtpd.py</a>
standard library module, and provides both a command line interface and an API
for use in testing applications that send email.</p>
<p>Inspiration for this library comes from several other packages:</p>
<ul class="simple">
<li><p><a class="reference external" href="http://bazaar.launchpad.net/~lazr-developers/lazr.smtptest/devel/files">lazr.smtptest</a></p></li>
<li><p><a class="reference external" href="https://github.com/benjamin-bader/aiosmtp">benjamin-bader/aiosmtp</a></p></li>
<li><p><a class="reference external" href="https://gitlab.com/mailman/mailman/blob/master/src/mailman/runners/lmtp.py#L138">Mailman 3’s LMTP server</a></p></li>
</ul>
<p><code class="docutils literal notranslate"><span class="pre">aiosmtpd</span></code> takes the best of these and consolidates them in one place.</p>
<section id="relevant-rfcs">
<h2>Relevant RFCs<a class="headerlink" href="#relevant-rfcs" title="Link to this heading"></a></h2>
<ul class="simple">
<li><p><span class="target" id="index-2"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc5321.html"><strong>RFC 5321</strong></a> - Simple Mail Transfer Protocol (SMTP)</p></li>
<li><p><span class="target" id="index-3"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2033.html"><strong>RFC 2033</strong></a> - Local Mail Transfer Protocol (LMTP)</p></li>
<li><p><span class="target" id="index-4"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2034.html"><strong>RFC 2034</strong></a> - SMTP Service Extension for Returning Enhanced Error Codes</p></li>
<li><p><span class="target" id="index-5"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc6531.html"><strong>RFC 6531</strong></a> - SMTP Extension for Internationalized Email</p></li>
<li><p><span class="target" id="index-6"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc4954.html"><strong>RFC 4954</strong></a> - SMTP Service Extension for Authentication</p></li>
<li><p><span class="target" id="index-7"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc5322.html"><strong>RFC 5322</strong></a> - Internet Message Format</p></li>
<li><p><span class="target" id="index-8"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc3696.html"><strong>RFC 3696</strong></a> - Application Techniques for Checking and Transformation of Names</p></li>
<li><p><span class="target" id="index-9"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2034.html"><strong>RFC 2034</strong></a> - SMTP Service Extension for Returning Enhanced Error Codes</p></li>
<li><p><span class="target" id="index-10"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc1870.html"><strong>RFC 1870</strong></a> - SMTP Service Extension for Message Size Declaration</p></li>
</ul>
</section>
<section id="other-references">
<h2>Other references<a class="headerlink" href="#other-references" title="Link to this heading"></a></h2>
<ul class="simple">
<li><p><a class="reference external" href="https://en.wikipedia.org/wiki/Simple_Mail_Transfer_Protocol">Wikipedia page on SMTP</a></p></li>
<li><p><a class="reference external" href="https://docs.python.org/3/library/asyncio.html">asyncio module documentation</a></p></li>
<li><p><a class="reference external" href="https://docs.python.org/3/library/asyncio-dev.html#asyncio-dev">Developing with asyncio</a></p></li>
<li><p><a class="reference external" href="http://bugs.python.org/issue25008">Python issue #25008</a> which started
the whole thing.</p></li>
</ul>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="index.html" class="btn btn-neutral float-left" title="aiosmtpd - An asyncio based SMTP server" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="concepts.html" class="btn btn-neutral float-right" title="Concepts" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2015-2024, The aiosmtpd Developers.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>