source: mailjam/docs/src/_build/html/overview.html@ 13:f1f11159dbed

Last change on this file since 13:f1f11159dbed was 13:f1f11159dbed, checked in by Borja Lopez <borja@…>, 10 years ago

Added first version of the project documentation. Inside docs/src there is
the sphinx [1] project we use to manage the docs. Inside docs/html there is
a copy of the docs in html format.

Fixed some typos in the INSTALL file

Added two new parameters to the postman.conf file (both the example config
file inside conf/ and the one used for testing in postman/tests/). These
parameters do nothing yet (they are related to ssl stuff) but we do talk
about them in the docs.

Added a new method to the XMLRPC list of methods related to members.


File size: 7.8 KB
3<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4 "">
7<html xmlns="">
8 <head>
9 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
11 <title>Overview of postman’s architecture &mdash; Postman 0.1.0 documentation</title>
13 <link rel="stylesheet" href="_static/default.css" type="text/css" />
14 <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
16 <script type="text/javascript">
18 URL_ROOT: '',
19 VERSION: '0.1.0',
21 FILE_SUFFIX: '.html',
22 HAS_SOURCE: true
23 };
24 </script>
25 <script type="text/javascript" src="_static/jquery.js"></script>
26 <script type="text/javascript" src="_static/underscore.js"></script>
27 <script type="text/javascript" src="_static/doctools.js"></script>
28 <link rel="top" title="Postman 0.1.0 documentation" href="index.html" />
29 <link rel="next" title="Installation instructions" href="install.html" />
30 <link rel="prev" title="Postman official documentation" href="index.html" />
31 </head>
32 <body>
33 <div class="related">
34 <h3>Navigation</h3>
35 <ul>
36 <li class="right" style="margin-right: 10px">
37 <a href="genindex.html" title="General Index"
38 accesskey="I">index</a></li>
39 <li class="right" >
40 <a href="install.html" title="Installation instructions"
41 accesskey="N">next</a> |</li>
42 <li class="right" >
43 <a href="index.html" title="Postman official documentation"
44 accesskey="P">previous</a> |</li>
45 <li><a href="index.html">Postman 0.1.0 documentation</a> &raquo;</li>
46 </ul>
47 </div>
49 <div class="document">
50 <div class="documentwrapper">
51 <div class="bodywrapper">
52 <div class="body">
54 <div class="section" id="overview-of-postman-s-architecture">
55<h1><a class="toc-backref" href="#id1">Overview of postman&#8217;s architecture</a><a class="headerlink" href="#overview-of-postman-s-architecture" title="Permalink to this headline"></a></h1>
56<div class="contents topic" id="contents">
57<p class="topic-title first">Contents</p>
58<ul class="simple">
59<li><a class="reference internal" href="#overview-of-postman-s-architecture" id="id1">Overview of postman&#8217;s architecture</a><ul>
60<li><a class="reference internal" href="#introduction" id="id2">Introduction</a></li>
61<li><a class="reference internal" href="#postman-daemon" id="id3">Postman daemon</a></li>
62<li><a class="reference internal" href="#mta-client" id="id4">MTA client</a></li>
63<li><a class="reference internal" href="#cli-client" id="id5">CLI client</a></li>
64<li><a class="reference internal" href="#web-client" id="id6">Web client</a></li>
69<div class="section" id="introduction">
70<h2><a class="toc-backref" href="#id2">Introduction</a><a class="headerlink" href="#introduction" title="Permalink to this headline"></a></h2>
71<p>Postman has been designed following a <strong>multi-component structure</strong>. There is
72<strong>a daemon</strong> that manage the mailing lists and members information in a storage
73backend and there are <strong>different kinds of clients</strong> (currently, three of them)
74that <strong>interact with the daemon using a XMLRPC link</strong>.</p>
75<p>This is the scheme of the architecture:</p>
76<img alt="Scheme of the architecture behind Postman" class="open-fancybox" src="_images/postman_architecture.png" />
78<div class="section" id="postman-daemon">
79<span id="overview-postman-daemon"></span><h2><a class="toc-backref" href="#id3">Postman daemon</a><a class="headerlink" href="#postman-daemon" title="Permalink to this headline"></a></h2>
80<p>The daemon will perform all the operations regarding the management of the
81mailing lists and members. The daemon will save information of a given
82mailing list to the storage backend, and will read information of already
83saved lists from there too.</p>
84<p>It listens for incoming XMLRPC requests on a given tcp port, allowing clients
85to add/update/delete data from the backend.</p>
87<div class="section" id="mta-client">
88<span id="overview-postman-mta-client"></span><h2><a class="toc-backref" href="#id4">MTA client</a><a class="headerlink" href="#mta-client" title="Permalink to this headline"></a></h2>
89<p>This client is attached to a given MTA, and is called but the MTA itself when
90emails for a mailing lists are received. The client performs some checks on the
91backend to tell the MTA what it has to do with the incoming emails.</p>
93<div class="section" id="cli-client">
94<span id="overview-postman-cli-client"></span><h2><a class="toc-backref" href="#id5">CLI client</a><a class="headerlink" href="#cli-client" title="Permalink to this headline"></a></h2>
95<p>This is a shell-like interface that can be used to add mailing lists to a given
96Postman server, edit such mailing lists information, add members, etc.</p>
98<div class="section" id="web-client">
99<span id="overview-postman-web-client"></span><h2><a class="toc-backref" href="#id6">Web client</a><a class="headerlink" href="#web-client" title="Permalink to this headline"></a></h2>
100<p>This is a small <em>webapp</em> that can be used to perform the same management
101operations you can achieve using the
102<a class="reference internal" href="#overview-postman-cli-client"><em>CLI client</em></a>.</p>
107 </div>
108 </div>
109 </div>
110 <div class="sphinxsidebar">
111 <div class="sphinxsidebarwrapper">
112 <h3><a href="index.html">Table Of Contents</a></h3>
113 <ul>
114<li><a class="reference internal" href="#">Overview of postman&#8217;s architecture</a><ul>
115<li><a class="reference internal" href="#introduction">Introduction</a></li>
116<li><a class="reference internal" href="#postman-daemon">Postman daemon</a></li>
117<li><a class="reference internal" href="#mta-client">MTA client</a></li>
118<li><a class="reference internal" href="#cli-client">CLI client</a></li>
119<li><a class="reference internal" href="#web-client">Web client</a></li>
124 <h4>Previous topic</h4>
125 <p class="topless"><a href="index.html"
126 title="previous chapter">Postman official documentation</a></p>
127 <h4>Next topic</h4>
128 <p class="topless"><a href="install.html"
129 title="next chapter">Installation instructions</a></p>
130 <h3>This Page</h3>
131 <ul class="this-page-menu">
132 <li><a href="_sources/overview.txt"
133 rel="nofollow">Show Source</a></li>
134 </ul>
135<div id="searchbox" style="display: none">
136 <h3>Quick search</h3>
137 <form class="search" action="search.html" method="get">
138 <input type="text" name="q" />
139 <input type="submit" value="Go" />
140 <input type="hidden" name="check_keywords" value="yes" />
141 <input type="hidden" name="area" value="default" />
142 </form>
143 <p class="searchtip" style="font-size: 90%">
144 Enter search terms or a module, class or function name.
145 </p>
147<script type="text/javascript">$('#searchbox').show(0);</script>
148 </div>
149 </div>
150 <div class="clearer"></div>
151 </div>
152 <div class="related">
153 <h3>Navigation</h3>
154 <ul>
155 <li class="right" style="margin-right: 10px">
156 <a href="genindex.html" title="General Index"
157 >index</a></li>
158 <li class="right" >
159 <a href="install.html" title="Installation instructions"
160 >next</a> |</li>
161 <li class="right" >
162 <a href="index.html" title="Postman official documentation"
163 >previous</a> |</li>
164 <li><a href="index.html">Postman 0.1.0 documentation</a> &raquo;</li>
165 </ul>
166 </div>
167 <div class="footer">
168 &copy; Copyright 2012, Soluciones Informaticas Codigo23 S.L.U..
169 Created using <a href="">Sphinx</a> 1.1.2.
170 </div>
171 </body>
Note: See TracBrowser for help on using the repository browser.