| [13] | 1 |
|
|---|
| 2 |
|
|---|
| 3 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|---|
| 4 | "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|---|
| 5 |
|
|---|
| 6 |
|
|---|
| 7 | <html xmlns="http://www.w3.org/1999/xhtml">
|
|---|
| 8 | <head>
|
|---|
| 9 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|---|
| 10 |
|
|---|
| [16] | 11 | <title>Overview of mailjam’s architecture — Mailjam 0.1.0 documentation</title>
|
|---|
| [13] | 12 |
|
|---|
| 13 | <link rel="stylesheet" href="_static/default.css" type="text/css" />
|
|---|
| 14 | <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|---|
| 15 |
|
|---|
| 16 | <script type="text/javascript">
|
|---|
| 17 | var DOCUMENTATION_OPTIONS = {
|
|---|
| 18 | URL_ROOT: '',
|
|---|
| 19 | VERSION: '0.1.0',
|
|---|
| 20 | COLLAPSE_INDEX: false,
|
|---|
| 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>
|
|---|
| [16] | 28 | <link rel="top" title="Mailjam 0.1.0 documentation" href="index.html" />
|
|---|
| [13] | 29 | <link rel="next" title="Installation instructions" href="install.html" />
|
|---|
| [16] | 30 | <link rel="prev" title="Mailjam official documentation" href="index.html" />
|
|---|
| [13] | 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" >
|
|---|
| [16] | 43 | <a href="index.html" title="Mailjam official documentation"
|
|---|
| [13] | 44 | accesskey="P">previous</a> |</li>
|
|---|
| [16] | 45 | <li><a href="index.html">Mailjam 0.1.0 documentation</a> »</li>
|
|---|
| [13] | 46 | </ul>
|
|---|
| 47 | </div>
|
|---|
| 48 |
|
|---|
| 49 | <div class="document">
|
|---|
| 50 | <div class="documentwrapper">
|
|---|
| 51 | <div class="bodywrapper">
|
|---|
| 52 | <div class="body">
|
|---|
| 53 |
|
|---|
| [16] | 54 | <div class="section" id="overview-of-mailjam-s-architecture">
|
|---|
| 55 | <h1><a class="toc-backref" href="#id1">Overview of mailjam’s architecture</a><a class="headerlink" href="#overview-of-mailjam-s-architecture" title="Permalink to this headline">¶</a></h1>
|
|---|
| [13] | 56 | <div class="contents topic" id="contents">
|
|---|
| 57 | <p class="topic-title first">Contents</p>
|
|---|
| 58 | <ul class="simple">
|
|---|
| [16] | 59 | <li><a class="reference internal" href="#overview-of-mailjam-s-architecture" id="id1">Overview of mailjam’s architecture</a><ul>
|
|---|
| [13] | 60 | <li><a class="reference internal" href="#introduction" id="id2">Introduction</a></li>
|
|---|
| [16] | 61 | <li><a class="reference internal" href="#mailjam-daemon" id="id3">Mailjam daemon</a></li>
|
|---|
| [13] | 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>
|
|---|
| 65 | </ul>
|
|---|
| 66 | </li>
|
|---|
| 67 | </ul>
|
|---|
| 68 | </div>
|
|---|
| 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>
|
|---|
| [16] | 71 | <p>Mailjam has been designed following a <strong>multi-component structure</strong>. There is
|
|---|
| [13] | 72 | <strong>a daemon</strong> that manage the mailing lists and members information in a storage
|
|---|
| 73 | backend and there are <strong>different kinds of clients</strong> (currently, three of them)
|
|---|
| 74 | that <strong>interact with the daemon using a XMLRPC link</strong>.</p>
|
|---|
| 75 | <p>This is the scheme of the architecture:</p>
|
|---|
| [16] | 76 | <img alt="Scheme of the architecture behind Mailjam" class="open-fancybox" src="_images/mailjam_architecture.png" />
|
|---|
| [27] | 77 | <p>This architecture works for small setups (everything running on a single server)
|
|---|
| 78 | but it works for bigger/larger installations with up to N mail servers, running
|
|---|
| 79 | each server its own <a class="reference internal" href="#overview-mailjam-mta-client"><em>MTA client</em></a> (or multiple instances
|
|---|
| 80 | of it) to connect to N <a class="reference internal" href="#overview-mailjam-daemon"><em>Mailjam daemon</em></a> servers (managed locally
|
|---|
| 81 | or remotely using up to N <a class="reference internal" href="#overview-mailjam-cli-client"><em>CLI client</em></a> or
|
|---|
| 82 | <a class="reference internal" href="#overview-mailjam-web-client"><em>Web client</em></a> instances).</p>
|
|---|
| 83 | <div class="admonition-see-also admonition seealso">
|
|---|
| 84 | <p class="first admonition-title">See also</p>
|
|---|
| 85 | <p class="last"><a class="reference internal" href="examples.html"><em>The examples documentation</em></a> contains some useful examples
|
|---|
| 86 | about different kinds of setups.</p>
|
|---|
| 87 | </div>
|
|---|
| [13] | 88 | </div>
|
|---|
| [16] | 89 | <div class="section" id="mailjam-daemon">
|
|---|
| 90 | <span id="overview-mailjam-daemon"></span><h2><a class="toc-backref" href="#id3">Mailjam daemon</a><a class="headerlink" href="#mailjam-daemon" title="Permalink to this headline">¶</a></h2>
|
|---|
| [13] | 91 | <p>The daemon will perform all the operations regarding the management of the
|
|---|
| 92 | mailing lists and members. The daemon will save information of a given
|
|---|
| 93 | mailing list to the storage backend, and will read information of already
|
|---|
| 94 | saved lists from there too.</p>
|
|---|
| 95 | <p>It listens for incoming XMLRPC requests on a given tcp port, allowing clients
|
|---|
| 96 | to add/update/delete data from the backend.</p>
|
|---|
| 97 | </div>
|
|---|
| 98 | <div class="section" id="mta-client">
|
|---|
| [16] | 99 | <span id="overview-mailjam-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>
|
|---|
| [13] | 100 | <p>This client is attached to a given MTA, and is called but the MTA itself when
|
|---|
| 101 | emails for a mailing lists are received. The client performs some checks on the
|
|---|
| 102 | backend to tell the MTA what it has to do with the incoming emails.</p>
|
|---|
| 103 | </div>
|
|---|
| 104 | <div class="section" id="cli-client">
|
|---|
| [16] | 105 | <span id="overview-mailjam-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>
|
|---|
| [13] | 106 | <p>This is a shell-like interface that can be used to add mailing lists to a given
|
|---|
| [16] | 107 | Mailjam server, edit such mailing lists information, add members, etc.</p>
|
|---|
| [13] | 108 | </div>
|
|---|
| 109 | <div class="section" id="web-client">
|
|---|
| [16] | 110 | <span id="overview-mailjam-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>
|
|---|
| [13] | 111 | <p>This is a small <em>webapp</em> that can be used to perform the same management
|
|---|
| 112 | operations you can achieve using the
|
|---|
| [16] | 113 | <a class="reference internal" href="#overview-mailjam-cli-client"><em>CLI client</em></a>.</p>
|
|---|
| [13] | 114 | </div>
|
|---|
| 115 | </div>
|
|---|
| 116 |
|
|---|
| 117 |
|
|---|
| 118 | </div>
|
|---|
| 119 | </div>
|
|---|
| 120 | </div>
|
|---|
| 121 | <div class="sphinxsidebar">
|
|---|
| 122 | <div class="sphinxsidebarwrapper">
|
|---|
| 123 | <h3><a href="index.html">Table Of Contents</a></h3>
|
|---|
| 124 | <ul>
|
|---|
| [16] | 125 | <li><a class="reference internal" href="#">Overview of mailjam’s architecture</a><ul>
|
|---|
| [13] | 126 | <li><a class="reference internal" href="#introduction">Introduction</a></li>
|
|---|
| [16] | 127 | <li><a class="reference internal" href="#mailjam-daemon">Mailjam daemon</a></li>
|
|---|
| [13] | 128 | <li><a class="reference internal" href="#mta-client">MTA client</a></li>
|
|---|
| 129 | <li><a class="reference internal" href="#cli-client">CLI client</a></li>
|
|---|
| 130 | <li><a class="reference internal" href="#web-client">Web client</a></li>
|
|---|
| 131 | </ul>
|
|---|
| 132 | </li>
|
|---|
| 133 | </ul>
|
|---|
| 134 |
|
|---|
| 135 | <h4>Previous topic</h4>
|
|---|
| 136 | <p class="topless"><a href="index.html"
|
|---|
| [16] | 137 | title="previous chapter">Mailjam official documentation</a></p>
|
|---|
| [13] | 138 | <h4>Next topic</h4>
|
|---|
| 139 | <p class="topless"><a href="install.html"
|
|---|
| 140 | title="next chapter">Installation instructions</a></p>
|
|---|
| 141 | <h3>This Page</h3>
|
|---|
| 142 | <ul class="this-page-menu">
|
|---|
| 143 | <li><a href="_sources/overview.txt"
|
|---|
| 144 | rel="nofollow">Show Source</a></li>
|
|---|
| 145 | </ul>
|
|---|
| 146 | <div id="searchbox" style="display: none">
|
|---|
| 147 | <h3>Quick search</h3>
|
|---|
| 148 | <form class="search" action="search.html" method="get">
|
|---|
| 149 | <input type="text" name="q" />
|
|---|
| 150 | <input type="submit" value="Go" />
|
|---|
| 151 | <input type="hidden" name="check_keywords" value="yes" />
|
|---|
| 152 | <input type="hidden" name="area" value="default" />
|
|---|
| 153 | </form>
|
|---|
| 154 | <p class="searchtip" style="font-size: 90%">
|
|---|
| 155 | Enter search terms or a module, class or function name.
|
|---|
| 156 | </p>
|
|---|
| 157 | </div>
|
|---|
| 158 | <script type="text/javascript">$('#searchbox').show(0);</script>
|
|---|
| 159 | </div>
|
|---|
| 160 | </div>
|
|---|
| 161 | <div class="clearer"></div>
|
|---|
| 162 | </div>
|
|---|
| 163 | <div class="related">
|
|---|
| 164 | <h3>Navigation</h3>
|
|---|
| 165 | <ul>
|
|---|
| 166 | <li class="right" style="margin-right: 10px">
|
|---|
| 167 | <a href="genindex.html" title="General Index"
|
|---|
| 168 | >index</a></li>
|
|---|
| 169 | <li class="right" >
|
|---|
| 170 | <a href="install.html" title="Installation instructions"
|
|---|
| 171 | >next</a> |</li>
|
|---|
| 172 | <li class="right" >
|
|---|
| [16] | 173 | <a href="index.html" title="Mailjam official documentation"
|
|---|
| [13] | 174 | >previous</a> |</li>
|
|---|
| [16] | 175 | <li><a href="index.html">Mailjam 0.1.0 documentation</a> »</li>
|
|---|
| [13] | 176 | </ul>
|
|---|
| 177 | </div>
|
|---|
| 178 | <div class="footer">
|
|---|
| 179 | © Copyright 2012, Soluciones Informaticas Codigo23 S.L.U..
|
|---|
| 180 | Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
|
|---|
| 181 | </div>
|
|---|
| 182 | </body>
|
|---|
| 183 | </html>
|
|---|
