source: mailjam/docs/src/_build/html/_sources/overview.txt@ 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.

[1] http://sphinx.pocoo.org

File size: 1.7 KB
Line 
1Overview of postman's architecture
2==================================
3
4.. contents::
5
6Introduction
7------------
8
9Postman has been designed following a **multi-component structure**. There is
10**a daemon** that manage the mailing lists and members information in a storage
11backend and there are **different kinds of clients** (currently, three of them)
12that **interact with the daemon using a XMLRPC link**.
13
14This is the scheme of the architecture:
15
16.. image:: /postman_architecture.png
17 :alt: Scheme of the architecture behind Postman
18 :class: open_fancybox
19
20
21.. _overview_postman_daemon:
22
23Postman daemon
24--------------
25
26The daemon will perform all the operations regarding the management of the
27mailing lists and members. The daemon will save information of a given
28mailing list to the storage backend, and will read information of already
29saved lists from there too.
30
31It listens for incoming XMLRPC requests on a given tcp port, allowing clients
32to add/update/delete data from the backend.
33
34.. _overview_postman_mta_client:
35
36MTA client
37----------
38
39This client is attached to a given MTA, and is called but the MTA itself when
40emails for a mailing lists are received. The client performs some checks on the
41backend to tell the MTA what it has to do with the incoming emails.
42
43.. _overview_postman_cli_client:
44
45CLI client
46----------
47
48This is a shell-like interface that can be used to add mailing lists to a given
49Postman server, edit such mailing lists information, add members, etc.
50
51.. _overview_postman_web_client:
52
53Web client
54----------
55
56This is a small *webapp* that can be used to perform the same management
57operations you can achieve using the
58:ref:`CLI client<overview_postman_cli_client>`.
Note: See TracBrowser for help on using the repository browser.