1<!DOCTYPE html> 2<html class="writer-html5" lang="en"> 3<head> 4 <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> 5 6 <meta name="viewport" content="width=device-width, initial-scale=1.0" /> 7 <title>Mailman - The GNU Mailing List Management System — GNU Mailman 3.3.11b1 documentation</title> 8 <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> 9 <link rel="stylesheet" type="text/css" href="_static/css/theme.css" /> 10 <link rel="stylesheet" type="text/css" href="_static/graphviz.css" /> 11 12 13 <!--[if lt IE 9]> 14
14<script src="_static/js/html5shiv.min.js"></script>
14 15 <![endif]--> 16 17
17<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
17 18
18<script src="_static/jquery.js"></script>
18 19
19<script src="_static/underscore.js"></script>
19 20
20<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
20 21
21<script src="_static/doctools.js"></script>
21 22
22<script src="_static/sphinx_highlight.js"></script>
22 23
23<script> 24$(document).ready(function() { 25 $('.interface').addClass('class'); 26}); 27</script>
27 28
28<script src="_static/js/theme.js"></script>
28 29 <link rel="index" title="Index" href="genindex.html" /> 30 <link rel="search" title="Search" href="search.html" /> 31 <link rel="next" title="Mailman - The GNU Mailing List Management System" href="src/mailman/docs/introduction.html" />
32<script async type="text/javascript" src="/_/static/javascript/readthedocs-addons.js"></script>
32<meta name="readthedocs-project-slug" content="mailman" /><meta name="readthedocs-version-slug" content="latest" /><meta name="readthedocs-resolver-filename" content="/" /><meta name="readthedocs-http-status" content="200" /></head> 33 34<body class="wy-body-for-nav"> 35 <div class="wy-grid-for-nav"> 36 <nav data-toggle="wy-nav-shift" class="wy-nav-side"> 37 <div class="wy-side-scroll"> 38 <div class="wy-side-nav-search" > 39 40 41 42 <a href="#" class="icon icon-home"> 43 GNU Mailman 44 <img src="_static/logo2010-2.jpg" class="logo" alt="Logo"/> 45 </a> 46 <div class="version"> 47 3.3 48 </div> 49<div role="search"> 50 <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> 51 <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> 52 <input type="hidden" name="check_keywords" value="yes" /> 53 <input type="hidden" name="area" value="default" /> 54 </form> 55</div> 56 </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> 57 <ul> 58<li class="toctree-l1"><a class="reference internal" href="src/mailman/docs/introduction.html">Mailman - The GNU Mailing List Management System</a></li> 59<li class="toctree-l1"><a class="reference internal" href="src/mailman/docs/release-notes.html">Release notes</a></li> 60<li class="toctree-l1"><a class="reference internal" href="src/mailman/docs/install.html">Installing and running Mailman 3</a></li> 61<li class="toctree-l1"><a class="reference internal" href="src/mailman/config/docs/config.html">Configuring Mailman</a></li> 62<li class="toctree-l1"><a class="reference internal" href="src/mailman/docs/database.html">Setting up your database</a></li> 63<li class="toctree-l1"><a class="reference internal" href="src/mailman/docs/mta.html">Hooking up your mail server</a></li> 64<li class="toctree-l1"><a class="reference internal" href="src/mailman/docs/postorius.html">Set up Postorius (web interface)</a></li> 65<li class="toctree-l1"><a class="reference internal" href="src/mailman/docs/hyperkitty.html">Set up HyperKitty (archiver)</a></li> 66<li class="toctree-l1"><a class="reference internal" href="src/mailman/docs/documentation.html">Documentation Helpers</a></li> 67<li class="toctree-l1"><a class="reference internal" href="src/mailman/plugins/docs/intro.html">Plugins</a></li> 68<li class="toctree-l1"><a class="reference internal" href="src/mailman/docs/contribute.html">Contributing to Mailman 3</a></li> 69<li class="toctree-l1"><a class="reference internal" href="src/mailman/docs/STYLEGUIDE.html">GNU Mailman Coding Style Guide</a></li> 70<li class="toctree-l1"><a class="reference internal" href="src/mailman/docs/internationalization.html">Mailman 3 Internationalization</a></li> 71<li class="toctree-l1"><a class="reference internal" href="src/mailman/docs/architecture.html">Mailman 3 Core architecture</a></li> 72<li class="toctree-l1"><a class="reference internal" href="src/mailman/docs/8-miles-high.html">Notes from the PyCon 2012 Mailman Sprint</a></li> 73<li class="toctree-l1"><a class="reference internal" href="src/mailman/docs/NEWS.html">GNU Mailman 3 changes</a></li> 74<li class="toctree-l1"><a class="reference internal" href="src/mailman/docs/ACKNOWLEDGMENTS.html">GNU Mailman Acknowledgments</a></li> 75</ul> 76<p class="caption" role="heading"><span class="caption-text">REST API</span></p> 77<ul> 78<li class="toctree-l1"><a class="reference internal" href="src/mailman/rest/docs/rest.html">Mailman 3 Core REST API</a></li> 79</ul> 80<p class="caption" role="heading"><span class="caption-text">Mailman Modules</span></p> 81<ul> 82<li class="toctree-l1"><a class="reference internal" href="src/mailman/model/docs/model.html">Models</a></li> 83<li class="toctree-l1"><a class="reference internal" href="src/mailman/runners/docs/runners.html">Runners</a></li> 84<li class="toctree-l1"><a class="reference internal" href="src/mailman/chains/docs/chains.html">Chains</a></li> 85<li class="toctree-l1"><a class="reference internal" href="src/mailman/rules/docs/rules.html">Rules</a></li> 86<li class="toctree-l1"><a class="reference internal" href="src/mailman/handlers/docs/handlers.html">
86Handlers</a></li> 87<li class="toctree-l1"><a class="reference internal" href="src/mailman/core/docs/core.html">Core</a></li> 88<li class="toctree-l1"><a class="reference internal" href="src/mailman/app/docs/app.html">App</a></li> 89<li class="toctree-l1"><a class="reference internal" href="src/mailman/styles/docs/styles.html">List styles</a></li> 90<li class="toctree-l1"><a class="reference internal" href="src/mailman/archiving/docs/common.html">Archivers</a></li> 91<li class="toctree-l1"><a class="reference internal" href="src/mailman/mta/docs/mta.html">Mail Transport Agents</a></li> 92<li class="toctree-l1"><a class="reference internal" href="src/mailman/bin/docs/master.html">Mailman runner control</a></li> 93<li class="toctree-l1"><a class="reference internal" href="src/mailman/commands/docs/commands.html">Commands</a></li> 94<li class="toctree-l1"><a class="reference internal" href="contrib/README.html">Community Contributions</a></li> 95</ul> 96 97 </div> 98 </div> 99 </nav> 100 101 <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > 102 <i data-toggle="wy-nav-top" class="fa fa-bars"></i> 103 <a href="#">GNU Mailman</a> 104 </nav> 105 106 <div class="wy-nav-content"> 107 <div class="rst-content"> 108 <div role="navigation" aria-label="Page navigation"> 109 <ul class="wy-breadcrumbs"> 110 <li><a href="#" class="icon icon-home" aria-label="Home"></a></li> 111 <li class="breadcrumb-item active">Mailman - The GNU Mailing List Management System</li> 112 <li class="wy-breadcrumbs-aside"> 113 <a href="_sources/index.rst.txt" rel="nofollow"> View page source</a> 114 </li> 115 </ul> 116 <hr/> 117</div> 118 <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> 119 <div itemprop="articleBody"> 120 121 <section id="mailman-the-gnu-mailing-list-management-system"> 122<h1>Mailman - The GNU Mailing List Management System<a class="headerlink" href="#mailman-the-gnu-mailing-list-management-system" title="Permalink to this heading">ï</a></h1> 123<a class="reference external image-reference" href="https://gitlab.com/mailman/mailman/commits/master"><img alt="https://gitlab.com/mailman/mailman/badges/master/pipeline.svg" src="https://gitlab.com/mailman/mailman/badges/master/pipeline.svg" /></a> 124<a class="reference external image-reference" href="https://mailman.readthedocs.io"><img alt="https://readthedocs.org/projects/mailman/badge" src="https://readthedocs.org/projects/mailman/badge" /></a> 125<a class="reference external image-reference" href="https://pypi.org/project/mailman/"><img alt="https://img.shields.io/pypi/v/mailman.svg" src="https://img.shields.io/pypi/v/mailman.svg" /></a> 126<a class="reference external image-reference" href="https://pypi.org/project/mailman/"><img alt="https://img.shields.io/pypi/dm/mailman.svg" src="https://img.shields.io/pypi/dm/mailman.svg" /></a> 127<p>Copyright (C) 1998-2025 by the Free Software Foundation, Inc.</p> 128<p>This is GNU Mailman, a mailing list management system distributed under the 129terms of the GNU General Public License (GPL) version 3 or later. The name of 130this software is spelled âMailmanâ with a leading capital âMâ but with a lower 131case second âmâ. Any other spelling is incorrect.</p> 132<p>Technically speaking, you are reading the documentation for Mailman Core. The 133full <a class="reference external" href="https://docs.mailman3.org">Mailman 3 suite</a> includes a web user 134interface called Postorius, a web archiver called HyperKitty, and a few other 135components. If youâre looking for instructions on installing the full suite, 136read that documentation.</p> 137<p>Mailman is written in Python which is available for all platforms that Python 138is supported on, including GNU/Linux and most other Unix-like operating 139systems (e.g. Solaris, *BSD, MacOSX, etc.). Mailman is not supported on 140Windows, although web and mail clients on any platform should be able to 141interact with Mailman just fine.</p> 142<p>The Mailman home page is:</p> 143<blockquote> 144<div><p><a class="reference external" href="https://www.list.org">https://www.list.org</a></p> 145</div></blockquote> 146<p>and there is a community driven wiki at</p> 147<blockquote> 148<div><p><a class="reference external" href="https://wiki.list.org">https://wiki.list.org</a></p> 149</div></blockquote> 150<p>For more information on Mailman, see the above web sites, or the 151<a class="reference internal" href="src/mailman/docs/introduction.html#start-here"><span class="std std-ref">documentation provided with this software</span></a>.</p> 152<section id="table-of-contents"> 153<h2>Table of Contents<a class="headerlink" href="#table-of-contents" title="Permalink to this heading">ï</a></h2> 154<div class="toctree-wrapper compound"> 155<ul> 156<li class="toctree-l1"><a class="reference internal" href="src/mailman/docs/introduction.html">Mailman - The GNU Mailing List Management System</a></li> 157<li class="toctree-l1"><a class="reference internal" href="src/mailman/docs/release-notes.html">Release notes</a></li> 158<li class="toctree-l1"><a class="reference internal" href="src/mailman/docs/install.html">Installing and running Mailman 3</a></li> 159<li class="toctree-l1"><a class="reference internal" href="src/mailman/config/docs/config.html">Configuring Mailman</a></li> 160<li class="toctree-l1"><a class="reference internal" href="src/mailman/docs/database.html">Setting up your database</a></li> 161<li class="toctree-l1"><a class="reference internal" href="src/mailman/docs/mta.html">Hooking up your mail server</a></li> 162<li class="toctree-l1"><a class="reference internal" href="src/mailman/docs/postorius.html">Set up Postorius (web interface)</a></li> 163<li class="toctree-l1"><a class="reference internal" href="src/mailman/docs/hyperkitty.html">Set up HyperKitty (archiver)</a></li> 164<li class="toctree-l1"><a class="reference internal" href="src/mailman/docs/documentation.html">Documentation Helpers</a></li> 165<li class="toctree-l1"><a class="reference internal" href="src/mailman/plugins/docs/intro.html">Plugins</a></li> 166<li class="toctree-l1"><a class="reference internal" href="src/mailman/docs/contribute.html">Contributing to Mailman 3</a></li> 167<li class="toctree-l1"><a class="reference internal" href="src/mailman/docs/STYLEGUIDE.html">GNU Mailman Coding Style Guide</a></li> 168<li class="toctree-l1"><a class="reference internal" href="src/mailman/docs/internationalization.html">Mailman 3 Internationalization</a></li> 169<li class="toctree-l1"><a class="reference internal" href="src/mailman/docs/architecture.html">Mailman 3 Core architecture</a></li> 170<li class="toctree-l1"><a class="reference internal" href="src/mailman/docs/8-miles-high.html">Notes from the PyCon 2012 Mailman Sprint</a></li> 171<li class="toctree-l1"><a class="reference internal" href="src/mailman/docs/NEWS.html">GNU Mailman 3 changes</a></li> 172<li class="toctree-l1"><a class="reference internal" href="src/mailman/docs/ACKNOWLEDGMENTS.html">GNU Mailman Acknowledgments</a></li> 173</ul> 174</div> 175<section id="rest-api"> 176<h3>REST API<a class="headerlink" href="#rest-api" title="Permalink to this heading">ï</a></h3> 177<div class="toctree-wrapper compound"> 178<p class="caption" role="heading"><span class="caption-text">REST API</span></p> 179<ul> 180<li class="toctree-l1"><a class="reference internal" href="src/mailman/rest/docs/rest.html">Mailman 3 Core REST API</a><ul> 181<li class="toctree-l2"><a class="reference internal" href="src/mailman/rest/docs/rest.html#the-rest-server">The REST server</a></li> 182<li class="toctree-l2"><a class="reference internal" href="src/mailman/rest/docs/rest.html#root-url">Root URL</a></li> 183<li class="toctree-l2"><a class="reference internal" href="src/mailman/rest/docs/rest.html#helpers">Helpers</a></li> 184<li class="toctree-l2"><a class="reference internal" href="src/mailman/rest/docs/rest.html#rest-api-documentation">REST API Documentation</a></li> 185</ul> 186</li> 187</ul> 188</div> 189</section> 190<section id="mailman-modules"> 191<h3>Mailman modules<a class="headerlink" href="#mailman-modules" title="Permalink to this heading">ï</a></h3> 192<p>These documents are generated from the internal module documentation.</p> 193<div class="toctree-wrapper compound"> 194<p class="caption" role="heading"><span class="caption-text">Mailman Modules</span></p> 195<ul> 196<li class="toctree-l1"><a class="reference internal" href="src/mailman/model/docs/model.html">Models</a></li> 197<li class="toctree-l1"><a class="reference internal" href="src/mailman/runners/docs/runners.html">Runners</a></li> 198<li class="toctree-l1"><a class="reference internal" href="src/mailman/chains/docs/chains.html">Chains</a></li> 199<li class="toctree-l1"><a class="reference internal" href="src/mailman/rules/docs/rules.html">Rules</a></li> 200<li class="toctree-l1"><a class="reference internal" href="src/mailman/handlers/docs/handlers.html">
200Handlers</a></li> 201<li class="toctree-l1"><a class="reference internal" href="src/mailman/core/docs/core.html">Core</a></li> 202<li class="toctree-l1"><a class="reference internal" href="src/mailman/app/docs/app.html">App</a></li> 203<li class="toctree-l1"><a class="reference internal" href="src/mailman/styles/docs/styles.html">List styles</a></li> 204<li class="toctree-l1"><a class="reference internal" href="src/mailman/archiving/docs/common.html">Archivers</a></li> 205<li class="toctree-l1"><a class="reference internal" href="src/mailman/mta/docs/mta.html">Mail Transport Agents</a></li> 206<li class="toctree-l1"><a class="reference internal" href="src/mailman/bin/docs/master.html">Mailman runner control</a></li> 207<li class="toctree-l1"><a class="reference internal" href="src/mailman/commands/docs/commands.html">Commands</a></li> 208<li class="toctree-l1"><a class="reference internal" href="contrib/README.html">Community Contributions</a></li> 209</ul> 210</div> 211</section> 212</section> 213<section id="indices-and-tables"> 214<h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this heading">ï</a></h2> 215<ul class="simple"> 216<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li> 217<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li> 218<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li> 219</ul> 220</section> 221</section> 222 223 224 </div> 225 </div> 226 <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> 227 <a href="src/mailman/docs/introduction.html" class="btn btn-neutral float-right" title="Mailman - The GNU Mailing List Management System" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> 228 </div> 229 230 <hr/> 231 232 <div role="contentinfo"> 233 <p>© Copyright 1998-2018 by the Free Software Foundation, Inc..</p> 234 </div> 235 236 Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a 237 <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> 238 provided by <a href="https://readthedocs.org">Read the Docs</a>. 239 240 241</footer> 242 </div> 243 </div> 244 </section> 245 </div> 246
246<script> 247 jQuery(function () { 248 SphinxRtdTheme.Navigation.enable(true); 249 }); 250 </script>
250 251 252</body> 253</html>
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.