Changeset 16:cd4170142d87 in mailjam
- Timestamp:
- May 22, 2012, 9:31:15 AM (13 years ago)
- Branch:
- default
- Phase:
- public
- Files:
-
- 2 added
- 33 edited
- 23 moved
Legend:
- Unmodified
- Added
- Removed
-
INSTALL
r13 r16 1 Postman- installation instructions1 Mailjam - installation instructions 2 2 =================================== 3 3 … … 7 7 --------------------------- 8 8 9 So far, the only dependency you will need in order to run postmanis Python [1]_9 So far, the only dependency you will need in order to run mailjam is Python [1]_ 10 10 11 Postmanhas been tested with python *2.7.x*, but it should work with versions11 Mailjam has been tested with python *2.7.x*, but it should work with versions 12 12 *2.6.x* too. 13 13 … … 15 15 more about how to install python. 16 16 17 Second, install Postman17 Second, install Mailjam 18 18 ----------------------- 19 19 … … 21 21 ++++++++++++++++++++ 22 22 23 You can install Postmanusing pip [2]_::23 You can install Mailjam using pip [2]_:: 24 24 25 pip install -e https://bitbucket.org/codigo23/ postman#egg=postman25 pip install -e https://bitbucket.org/codigo23/mailjam#egg=mailjam 26 26 27 27 .. note:: 28 28 29 Postmanhas not been recorded/uploaded to pypi [3]_ yet, so, in order29 Mailjam has not been recorded/uploaded to pypi [3]_ yet, so, in order 30 30 to install it using pip you will have to provide the URL for the public 31 Postmanrepo.31 Mailjam repo. 32 32 33 33 Installing using easy_install 34 34 +++++++++++++++++++++++++++++ 35 35 36 You can not install Postmanusing easy_install [4]_ yet (until we do36 You can not install Mailjam using easy_install [4]_ yet (until we do 37 37 record/upload it to pypi) 38 38 … … 40 40 ++++++++++++++++++++++++++++++ 41 41 42 You can install Postmaninside a virtualenv [5]_. Just create a virtualenv::42 You can install Mailjam inside a virtualenv [5]_. Just create a virtualenv:: 43 43 44 44 virtualenv /path/to/your/env … … 55 55 source /path/to/your/env/bin/activate.csh 56 56 57 And, once the environment has been activated, use pip to install Postman::57 And, once the environment has been activated, use pip to install Mailjam:: 58 58 59 env$ pip install -e https://bitbucket.org/codigo23/ postman#egg=postman59 env$ pip install -e https://bitbucket.org/codigo23/mailjam#egg=mailjam 60 60 61 61 Installing from sources … … 70 70 *************** 71 71 72 The source code of Postmanis hosted in bitbucket [6]_. In order to grab72 The source code of Mailjam is hosted in bitbucket [6]_. In order to grab 73 73 the latest sources you need Mercurial [7]_. 74 74 75 75 To get a copy of the sources, just *clone* the repository:: 76 76 77 hg clone https://bitbucket.org/codigo23/ postman postman-repo77 hg clone https://bitbucket.org/codigo23/mailjam mailjam-repo 78 78 79 Then, go inside the * postman-repo* directory and run::79 Then, go inside the *mailjam-repo* directory and run:: 80 80 81 81 python setup.py install … … 87 87 *root* privileges - for example using sudo [8]_) 88 88 89 Setting up Postman89 Setting up Mailjam 90 90 ------------------ 91 91 92 92 TBW 93 93 94 Running Postman94 Running Mailjam 95 95 --------------- 96 96 … … 107 107 .. [4] http://peak.telecommunity.com/DevCenter/EasyInstall 108 108 .. [5] http://www.virtualenv.org/en/latest/index.html 109 .. [6] https://bitbucket.org/codigo23/ postman109 .. [6] https://bitbucket.org/codigo23/mailjam 110 110 .. [7] http://mercurial.selenic.com 111 111 .. [8] http://sudo.ws -
README
r3 r16 1 Postman- Mailing lists manager1 Mailjam - Mailing lists manager 2 2 =============================== 3 3 … … 8 8 ------------ 9 9 10 Postmanis a mailing list manager. With it you will be able to create mailing10 Mailjam is a mailing list manager. With it you will be able to create mailing 11 11 lists and manage them. 12 12 13 Postman requires a functional MTA [1]_ (Postmanhas been successfully tested13 Mailjam requires a functional MTA [1]_ (Mailjam has been successfully tested 14 14 with sendmail [2]_ and postfix [3]_ but it should work with other MTA software) 15 15 … … 25 25 ---------- 26 26 27 If you would like to learn more about Postman(its internals, how it works,27 If you would like to learn more about Mailjam (its internals, how it works, 28 28 etc) take a look at the official documentation inside the docs/ subdirectory 29 29 -
bin/run_tests
r10 r16 1 1 #!/usr/bin/env python 2 2 # 3 # Run the tests for the postmanpackage3 # Run the tests for the mailjam package 4 4 5 5 import os, shutil, sys, unittest 6 6 7 7 try: 8 from postman.tests import *8 from mailjam.tests import * 9 9 except ImportError: 10 10 sys.path.append(os.path.join(os.path.dirname(__file__), '../')) 11 11 try: 12 from postman.tests import *12 from mailjam.tests import * 13 13 except ImportError: 14 raise SystemExit('Could not find postmanon your filesystem')14 raise SystemExit('Could not find mailjam on your filesystem') 15 15 16 16 try: … … 18 18 finally: 19 19 # FIXME: hardcoded path to the tmp directory, we should read this path 20 # from postman/tests/postman.conf21 shutil.rmtree('/tmp/ postman-tests')20 # from mailjam/tests/mailjam.conf 21 shutil.rmtree('/tmp/mailjam-tests') -
conf/mailjam-mta.conf
r15 r16 1 1 # 2 # postman-mta.conf - PostmanMTA client configuration file2 # mailjam-mta.conf - Mailjam MTA client configuration file 3 3 # 4 4 … … 11 11 [archive] 12 12 persistent = true 13 path = /usr/local/ postman/archive-mta13 path = /usr/local/mailjam/archive-mta -
conf/mailjam.conf
r14 r16 1 1 # 2 # postman.conf - Postmandaemon configuration file2 # mailjam.conf - Mailjam daemon configuration file 3 3 # 4 4 … … 7 7 port = 9876 8 8 ssl = false 9 ssl_key = /usr/local/etc/ postman/ssl/postman.key10 ssl_crt = /usr/local/etc/ postman/ssl/postman.crt11 logfile = /var/log/ postman/xmlrpc_server.log9 ssl_key = /usr/local/etc/mailjam/ssl/mailjam.key 10 ssl_crt = /usr/local/etc/mailjam/ssl/mailjam.crt 11 logfile = /var/log/mailjam/xmlrpc_server.log 12 12 13 13 [storage] 14 14 backend = json 15 path = /usr/local/ postman/storage15 path = /usr/local/mailjam/storage 16 16 lists_db = %(path)s/mailings.%(backend)s 17 17 members_db = %(path)s/members.%(backend)s … … 20 20 enabled = true 21 21 backend = json 22 path = /usr/local/ postman/archives22 path = /usr/local/mailjam/archives 23 23 24 24 [mailing_lists] -
docs/src/_build/html/.buildinfo
r13 r16 1 1 # Sphinx build info version 1 2 2 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. 3 config: d6b13f3c5a0c2b1ecbf54831463e3bec3 config: ceb77347f0c7a864ec9030a8b3dabfdc 4 4 tags: fbb0d17656682115ca4d033fb2f83ba1 -
docs/src/_build/html/_sources/configuration.txt
r13 r16 6 6 .. _configuration_daemon: 7 7 8 Postmandaemon configuration file8 Mailjam daemon configuration file 9 9 --------------------------------- 10 10 11 All the configurations that can be applied to the Postmandaemon are registered12 in the ** postman.conf** file. That file contains ini-style [1]_ configuration11 All the configurations that can be applied to the Mailjam daemon are registered 12 in the **mailjam.conf** file. That file contains ini-style [1]_ configuration 13 13 parameters, separated in different *categories*. 14 14 15 15 .. note:: 16 16 17 The postman.conf file will be installed in different locations depending on17 The mailjam.conf file will be installed in different locations depending on 18 18 your setup. The usual locations are: 19 19 20 - */etc/ postman.conf* - In most Linux systems (like archlinux, gentoo,20 - */etc/mailjam.conf* - In most Linux systems (like archlinux, gentoo, 21 21 fedora, debian, ubuntu, etc) 22 22 23 - */usr/local/etc/ postman.conf* - In most BSD systems (like FreeBSD, OpenBSD,23 - */usr/local/etc/mailjam.conf* - In most BSD systems (like FreeBSD, OpenBSD, 24 24 NetBSD, etc) 25 25 … … 73 73 ******* 74 74 75 Default: ``/usr/local/etc/ postman/ssl/postman.key``75 Default: ``/usr/local/etc/mailjam/ssl/mailjam.key`` 76 76 77 77 Path to the ssl key used for encrypted SSL sessions. … … 86 86 ******* 87 87 88 Default: ``/usr/local/etc/ postman/ssl/postman.crt``88 Default: ``/usr/local/etc/mailjam/ssl/mailjam.crt`` 89 89 90 90 Path to the ssl certificate used for encrypted SSL sessions. … … 99 99 ******* 100 100 101 Default: ``/var/log/ postman/xmlrpc_server.log``101 Default: ``/var/log/mailjam/xmlrpc_server.log`` 102 102 103 103 Path to the file where log messages will be saved … … 128 128 **** 129 129 130 Default: ``/usr/local/ postman/storage``130 Default: ``/usr/local/mailjam/storage`` 131 131 132 132 Path to the directory where the backend will save data. … … 137 137 ******** 138 138 139 Default: ``/usr/local/ postman/storage/mailings.json``139 Default: ``/usr/local/mailjam/storage/mailings.json`` 140 140 141 141 Path to the file where the identifiers of existing mailing lists will be saved. … … 165 165 ********** 166 166 167 Default: ``/usr/local/ postman/storage/members.json``167 Default: ``/usr/local/mailjam/storage/members.json`` 168 168 169 169 Path to the file where the identifiers of existing members will be saved. … … 191 191 Default: ``true`` 192 192 193 Enables/disables the *archives* feature. When enabled, Postmansaves copies of193 Enables/disables the *archives* feature. When enabled, Mailjam saves copies of 194 194 email address into an *archive*, so they can be read later, through a web 195 195 interface. … … 220 220 **** 221 221 222 Default: ``/usr/local/ postman/archives``222 Default: ``/usr/local/mailjam/archives`` 223 223 224 224 Path to the directory where the archives will be saved. … … 238 238 .. warning:: 239 239 240 This parameters are not currently used in postman, we are still working240 This parameters are not currently used in mailjam, we are still working 241 241 on per-mailing-list configuration parameters. 242 242 … … 265 265 .. warning:: 266 266 267 This parameters are not currently used in postman, we are still working267 This parameters are not currently used in mailjam, we are still working 268 268 on per-member configuration parameters. 269 269 -
docs/src/_build/html/_sources/index.txt
r13 r16 1 Postmanofficial documentation1 Mailjam official documentation 2 2 ============================== 3 3 4 This is the official documentation for Postman_, a mailing list management4 This is the official documentation for Mailjam_, a mailing list management 5 5 software written in Python_. 6 6 … … 25 25 * :ref:`search` 26 26 27 .. _ Postman: https://bitbucket.org/codigo23/postman27 .. _Mailjam: https://bitbucket.org/codigo23/mailjam 28 28 .. _Python: http://python.org -
docs/src/_build/html/_sources/install.txt
r13 r16 9 9 --------------------------- 10 10 11 So far, the only dependency you will need in order to run postmanis Python_11 So far, the only dependency you will need in order to run mailjam is Python_ 12 12 13 Postmanhas been tested with python *2.7.x*, but it should work with versions13 Mailjam has been tested with python *2.7.x*, but it should work with versions 14 14 *2.6.x* too. 15 15 … … 17 17 more about how to install python. 18 18 19 .. _install_ postman:19 .. _install_mailjam: 20 20 21 Second, install Postman21 Second, install Mailjam 22 22 ----------------------- 23 23 … … 27 27 ++++++++++++++++++++ 28 28 29 You can install Postmanusing pip_::29 You can install Mailjam using pip_:: 30 30 31 pip install -e https://bitbucket.org/codigo23/ postman#egg=postman31 pip install -e https://bitbucket.org/codigo23/mailjam#egg=mailjam 32 32 33 33 .. note:: 34 34 35 Postmanhas not been recorded/uploaded to pypi_ yet, so, in order to install36 it using pip you will have to provide the URL for the public Postmanrepo.35 Mailjam has not been recorded/uploaded to pypi_ yet, so, in order to install 36 it using pip you will have to provide the URL for the public Mailjam repo. 37 37 38 38 .. _install_with_easy_install: … … 41 41 +++++++++++++++++++++++++++++ 42 42 43 You can not install Postmanusing easy_install_ yet (until we do record/upload43 You can not install Mailjam using easy_install_ yet (until we do record/upload 44 44 it to pypi) 45 45 … … 49 49 ++++++++++++++++++++++++++++++ 50 50 51 You can install Postmaninside a virtualenv_. Just create a virtualenv::51 You can install Mailjam inside a virtualenv_. Just create a virtualenv:: 52 52 53 53 virtualenv /path/to/your/env … … 64 64 source /path/to/your/env/bin/activate.csh 65 65 66 And, once the environment has been activated, use pip to install Postman::66 And, once the environment has been activated, use pip to install Mailjam:: 67 67 68 env$ pip install -e https://bitbucket.org/codigo23/ postman#egg=postman68 env$ pip install -e https://bitbucket.org/codigo23/mailjam#egg=mailjam 69 69 70 70 .. _install_from_sources: … … 89 89 *************** 90 90 91 The source code of Postmanis hosted in bitbucket_ [1]_. In order to grab91 The source code of Mailjam is hosted in bitbucket_ [1]_. In order to grab 92 92 the latest sources you need Mercurial_. 93 93 94 94 To get a copy of the sources, just *clone* the repository:: 95 95 96 hg clone https://bitbucket.org/codigo23/ postman postman-repo96 hg clone https://bitbucket.org/codigo23/mailjam mailjam-repo 97 97 98 Then, go inside the * postman-repo* directory and run::98 Then, go inside the *mailjam-repo* directory and run:: 99 99 100 100 python setup.py install … … 110 110 This process will work inside a virtualenv_ too. 111 111 112 .. _install_setting_up_ postman:112 .. _install_setting_up_mailjam: 113 113 114 Setting up Postman114 Setting up Mailjam 115 115 ------------------ 116 116 117 117 TBW 118 118 119 .. _install_running_ postman:119 .. _install_running_mailjam: 120 120 121 Running Postman121 Running Mailjam 122 122 --------------- 123 123 … … 140 140 .. _sudo: http://sudo.ws 141 141 142 .. [1] https://bitbucket.org/codigo23/ postman142 .. [1] https://bitbucket.org/codigo23/mailjam -
docs/src/_build/html/_sources/overview.txt
r13 r16 1 Overview of postman's architecture1 Overview of mailjam's architecture 2 2 ================================== 3 3 … … 7 7 ------------ 8 8 9 Postmanhas been designed following a **multi-component structure**. There is9 Mailjam has been designed following a **multi-component structure**. There is 10 10 **a daemon** that manage the mailing lists and members information in a storage 11 11 backend and there are **different kinds of clients** (currently, three of them) … … 14 14 This is the scheme of the architecture: 15 15 16 .. image:: / postman_architecture.png17 :alt: Scheme of the architecture behind Postman16 .. image:: /mailjam_architecture.png 17 :alt: Scheme of the architecture behind Mailjam 18 18 :class: open_fancybox 19 19 20 20 21 .. _overview_ postman_daemon:21 .. _overview_mailjam_daemon: 22 22 23 Postmandaemon23 Mailjam daemon 24 24 -------------- 25 25 … … 32 32 to add/update/delete data from the backend. 33 33 34 .. _overview_ postman_mta_client:34 .. _overview_mailjam_mta_client: 35 35 36 36 MTA client … … 41 41 backend to tell the MTA what it has to do with the incoming emails. 42 42 43 .. _overview_ postman_cli_client:43 .. _overview_mailjam_cli_client: 44 44 45 45 CLI client … … 47 47 48 48 This is a shell-like interface that can be used to add mailing lists to a given 49 Postmanserver, edit such mailing lists information, add members, etc.49 Mailjam server, edit such mailing lists information, add members, etc. 50 50 51 .. _overview_ postman_web_client:51 .. _overview_mailjam_web_client: 52 52 53 53 Web client … … 56 56 This is a small *webapp* that can be used to perform the same management 57 57 operations you can achieve using the 58 :ref:`CLI client<overview_ postman_cli_client>`.58 :ref:`CLI client<overview_mailjam_cli_client>`. -
docs/src/_build/html/_sources/running.txt
r13 r16 1 Running Postman1 Running Mailjam 2 2 =============== 3 3 -
docs/src/_build/html/configuration.html
r13 r16 9 9 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 10 10 11 <title>Configuration — Postman0.1.0 documentation</title>11 <title>Configuration — Mailjam 0.1.0 documentation</title> 12 12 13 13 <link rel="stylesheet" href="_static/default.css" type="text/css" /> … … 26 26 <script type="text/javascript" src="_static/underscore.js"></script> 27 27 <script type="text/javascript" src="_static/doctools.js"></script> 28 <link rel="top" title=" Postman0.1.0 documentation" href="index.html" />29 <link rel="next" title="Running Postman" href="running.html" />28 <link rel="top" title="Mailjam 0.1.0 documentation" href="index.html" /> 29 <link rel="next" title="Running Mailjam" href="running.html" /> 30 30 <link rel="prev" title="Installation instructions" href="install.html" /> 31 31 </head> … … 38 38 accesskey="I">index</a></li> 39 39 <li class="right" > 40 <a href="running.html" title="Running Postman"40 <a href="running.html" title="Running Mailjam" 41 41 accesskey="N">next</a> |</li> 42 42 <li class="right" > 43 43 <a href="install.html" title="Installation instructions" 44 44 accesskey="P">previous</a> |</li> 45 <li><a href="index.html"> Postman0.1.0 documentation</a> »</li>45 <li><a href="index.html">Mailjam 0.1.0 documentation</a> »</li> 46 46 </ul> 47 47 </div> … … 58 58 <ul class="simple"> 59 59 <li><a class="reference internal" href="#configuration" id="id9">Configuration</a><ul> 60 <li><a class="reference internal" href="# postman-daemon-configuration-file" id="id10">Postmandaemon configuration file</a><ul>60 <li><a class="reference internal" href="#mailjam-daemon-configuration-file" id="id10">Mailjam daemon configuration file</a><ul> 61 61 <li><a class="reference internal" href="#xmlrpc-server" id="id11">xmlrpc_server</a><ul> 62 62 <li><a class="reference internal" href="#address" id="id12">address</a></li> … … 96 96 </ul> 97 97 </div> 98 <div class="section" id=" postman-daemon-configuration-file">99 <span id="configuration-daemon"></span><h2><a class="toc-backref" href="#id10"> Postman daemon configuration file</a><a class="headerlink" href="#postman-daemon-configuration-file" title="Permalink to this headline">¶</a></h2>100 <p>All the configurations that can be applied to the Postmandaemon are registered101 in the <strong> postman.conf</strong> file. That file contains ini-style <a class="footnote-reference" href="#id6" id="id1">[1]</a> configuration98 <div class="section" id="mailjam-daemon-configuration-file"> 99 <span id="configuration-daemon"></span><h2><a class="toc-backref" href="#id10">Mailjam daemon configuration file</a><a class="headerlink" href="#mailjam-daemon-configuration-file" title="Permalink to this headline">¶</a></h2> 100 <p>All the configurations that can be applied to the Mailjam daemon are registered 101 in the <strong>mailjam.conf</strong> file. That file contains ini-style <a class="footnote-reference" href="#id6" id="id1">[1]</a> configuration 102 102 parameters, separated in different <em>categories</em>.</p> 103 103 <div class="admonition note"> 104 104 <p class="first admonition-title">Note</p> 105 <p>The postman.conf file will be installed in different locations depending on105 <p>The mailjam.conf file will be installed in different locations depending on 106 106 your setup. The usual locations are:</p> 107 107 <ul class="simple"> 108 <li><em>/etc/ postman.conf</em> - In most Linux systems (like archlinux, gentoo,108 <li><em>/etc/mailjam.conf</em> - In most Linux systems (like archlinux, gentoo, 109 109 fedora, debian, ubuntu, etc)</li> 110 <li><em>/usr/local/etc/ postman.conf</em> - In most BSD systems (like FreeBSD, OpenBSD,110 <li><em>/usr/local/etc/mailjam.conf</em> - In most BSD systems (like FreeBSD, OpenBSD, 111 111 NetBSD, etc)</li> 112 112 </ul> … … 140 140 <div class="section" id="ssl-key"> 141 141 <span id="configuration-daemon-xmlrpc-ssl-key"></span><h4><a class="toc-backref" href="#id15">ssl_key</a><a class="headerlink" href="#ssl-key" title="Permalink to this headline">¶</a></h4> 142 <p>Default: <tt class="docutils literal"><span class="pre">/usr/local/etc/ postman/ssl/postman.key</span></tt></p>142 <p>Default: <tt class="docutils literal"><span class="pre">/usr/local/etc/mailjam/ssl/mailjam.key</span></tt></p> 143 143 <p>Path to the ssl key used for encrypted SSL sessions.</p> 144 144 <div class="admonition warning"> … … 149 149 <div class="section" id="ssl-crt"> 150 150 <span id="configuration-daemon-xmlrpc-ssl-crt"></span><h4><a class="toc-backref" href="#id16">ssl_crt</a><a class="headerlink" href="#ssl-crt" title="Permalink to this headline">¶</a></h4> 151 <p>Default: <tt class="docutils literal"><span class="pre">/usr/local/etc/ postman/ssl/postman.crt</span></tt></p>151 <p>Default: <tt class="docutils literal"><span class="pre">/usr/local/etc/mailjam/ssl/mailjam.crt</span></tt></p> 152 152 <p>Path to the ssl certificate used for encrypted SSL sessions.</p> 153 153 <div class="admonition warning"> … … 158 158 <div class="section" id="logfile"> 159 159 <span id="configuration-daemon-xmlrpc-logfile"></span><h4><a class="toc-backref" href="#id17">logfile</a><a class="headerlink" href="#logfile" title="Permalink to this headline">¶</a></h4> 160 <p>Default: <tt class="docutils literal"><span class="pre">/var/log/ postman/xmlrpc_server.log</span></tt></p>160 <p>Default: <tt class="docutils literal"><span class="pre">/var/log/mailjam/xmlrpc_server.log</span></tt></p> 161 161 <p>Path to the file where log messages will be saved</p> 162 162 </div> … … 175 175 <div class="section" id="path"> 176 176 <span id="configuration-daemon-xmlrpc-path"></span><h4><a class="toc-backref" href="#id20">path</a><a class="headerlink" href="#path" title="Permalink to this headline">¶</a></h4> 177 <p>Default: <tt class="docutils literal"><span class="pre">/usr/local/ postman/storage</span></tt></p>177 <p>Default: <tt class="docutils literal"><span class="pre">/usr/local/mailjam/storage</span></tt></p> 178 178 <p>Path to the directory where the backend will save data.</p> 179 179 </div> 180 180 <div class="section" id="lists-db"> 181 181 <span id="configuration-daemon-storage-lists-db"></span><h4><a class="toc-backref" href="#id21">lists_db</a><a class="headerlink" href="#lists-db" title="Permalink to this headline">¶</a></h4> 182 <p>Default: <tt class="docutils literal"><span class="pre">/usr/local/ postman/storage/mailings.json</span></tt></p>182 <p>Default: <tt class="docutils literal"><span class="pre">/usr/local/mailjam/storage/mailings.json</span></tt></p> 183 183 <p>Path to the file where the identifiers of existing mailing lists will be saved.</p> 184 184 <div class="admonition note"> … … 201 201 <div class="section" id="members-db"> 202 202 <span id="configuration-daemon-xmlrpc-members-db"></span><h4><a class="toc-backref" href="#id22">members_db</a><a class="headerlink" href="#members-db" title="Permalink to this headline">¶</a></h4> 203 <p>Default: <tt class="docutils literal"><span class="pre">/usr/local/ postman/storage/members.json</span></tt></p>203 <p>Default: <tt class="docutils literal"><span class="pre">/usr/local/mailjam/storage/members.json</span></tt></p> 204 204 <p>Path to the file where the identifiers of existing members will be saved.</p> 205 205 <div class="admonition note"> … … 218 218 <span id="configuration-daemon-archive-enabled"></span><h4><a class="toc-backref" href="#id24">enabled</a><a class="headerlink" href="#enabled" title="Permalink to this headline">¶</a></h4> 219 219 <p>Default: <tt class="docutils literal"><span class="pre">true</span></tt></p> 220 <p>Enables/disables the <em>archives</em> feature. When enabled, Postmansaves copies of220 <p>Enables/disables the <em>archives</em> feature. When enabled, Mailjam saves copies of 221 221 email address into an <em>archive</em>, so they can be read later, through a web 222 222 interface.</p> … … 239 239 <div class="section" id="configuration-daemon-archive-path"> 240 240 <span id="id5"></span><h4><a class="toc-backref" href="#id26">path</a><a class="headerlink" href="#configuration-daemon-archive-path" title="Permalink to this headline">¶</a></h4> 241 <p>Default: <tt class="docutils literal"><span class="pre">/usr/local/ postman/archives</span></tt></p>241 <p>Default: <tt class="docutils literal"><span class="pre">/usr/local/mailjam/archives</span></tt></p> 242 242 <p>Path to the directory where the archives will be saved.</p> 243 243 <div class="admonition warning"> … … 253 253 <div class="admonition warning"> 254 254 <p class="first admonition-title">Warning</p> 255 <p class="last">This parameters are not currently used in postman, we are still working255 <p class="last">This parameters are not currently used in mailjam, we are still working 256 256 on per-mailing-list configuration parameters.</p> 257 257 </div> … … 271 271 <div class="admonition warning"> 272 272 <p class="first admonition-title">Warning</p> 273 <p class="last">This parameters are not currently used in postman, we are still working273 <p class="last">This parameters are not currently used in mailjam, we are still working 274 274 on per-member configuration parameters.</p> 275 275 </div> … … 322 322 <ul> 323 323 <li><a class="reference internal" href="#">Configuration</a><ul> 324 <li><a class="reference internal" href="# postman-daemon-configuration-file">Postmandaemon configuration file</a><ul>324 <li><a class="reference internal" href="#mailjam-daemon-configuration-file">Mailjam daemon configuration file</a><ul> 325 325 <li><a class="reference internal" href="#xmlrpc-server">xmlrpc_server</a><ul> 326 326 <li><a class="reference internal" href="#address">address</a></li> … … 365 365 <h4>Next topic</h4> 366 366 <p class="topless"><a href="running.html" 367 title="next chapter">Running Postman</a></p>367 title="next chapter">Running Mailjam</a></p> 368 368 <h3>This Page</h3> 369 369 <ul class="this-page-menu"> … … 395 395 >index</a></li> 396 396 <li class="right" > 397 <a href="running.html" title="Running Postman"397 <a href="running.html" title="Running Mailjam" 398 398 >next</a> |</li> 399 399 <li class="right" > 400 400 <a href="install.html" title="Installation instructions" 401 401 >previous</a> |</li> 402 <li><a href="index.html"> Postman0.1.0 documentation</a> »</li>402 <li><a href="index.html">Mailjam 0.1.0 documentation</a> »</li> 403 403 </ul> 404 404 </div> -
docs/src/_build/html/development.html
r13 r16 9 9 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 10 10 11 <title>Developers documentation — Postman0.1.0 documentation</title>11 <title>Developers documentation — Mailjam 0.1.0 documentation</title> 12 12 13 13 <link rel="stylesheet" href="_static/default.css" type="text/css" /> … … 26 26 <script type="text/javascript" src="_static/underscore.js"></script> 27 27 <script type="text/javascript" src="_static/doctools.js"></script> 28 <link rel="top" title=" Postman0.1.0 documentation" href="index.html" />28 <link rel="top" title="Mailjam 0.1.0 documentation" href="index.html" /> 29 29 <link rel="prev" title="Some examples" href="examples.html" /> 30 30 </head> … … 39 39 <a href="examples.html" title="Some examples" 40 40 accesskey="P">previous</a> |</li> 41 <li><a href="index.html"> Postman0.1.0 documentation</a> »</li>41 <li><a href="index.html">Mailjam 0.1.0 documentation</a> »</li> 42 42 </ul> 43 43 </div> … … 98 98 <a href="examples.html" title="Some examples" 99 99 >previous</a> |</li> 100 <li><a href="index.html"> Postman0.1.0 documentation</a> »</li>100 <li><a href="index.html">Mailjam 0.1.0 documentation</a> »</li> 101 101 </ul> 102 102 </div> -
docs/src/_build/html/examples.html
r13 r16 9 9 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 10 10 11 <title>Some examples — Postman0.1.0 documentation</title>11 <title>Some examples — Mailjam 0.1.0 documentation</title> 12 12 13 13 <link rel="stylesheet" href="_static/default.css" type="text/css" /> … … 26 26 <script type="text/javascript" src="_static/underscore.js"></script> 27 27 <script type="text/javascript" src="_static/doctools.js"></script> 28 <link rel="top" title=" Postman0.1.0 documentation" href="index.html" />28 <link rel="top" title="Mailjam 0.1.0 documentation" href="index.html" /> 29 29 <link rel="next" title="Developers documentation" href="development.html" /> 30 <link rel="prev" title="Running Postman" href="running.html" />30 <link rel="prev" title="Running Mailjam" href="running.html" /> 31 31 </head> 32 32 <body> … … 41 41 accesskey="N">next</a> |</li> 42 42 <li class="right" > 43 <a href="running.html" title="Running Postman"43 <a href="running.html" title="Running Mailjam" 44 44 accesskey="P">previous</a> |</li> 45 <li><a href="index.html"> Postman0.1.0 documentation</a> »</li>45 <li><a href="index.html">Mailjam 0.1.0 documentation</a> »</li> 46 46 </ul> 47 47 </div> … … 70 70 <h4>Previous topic</h4> 71 71 <p class="topless"><a href="running.html" 72 title="previous chapter">Running Postman</a></p>72 title="previous chapter">Running Mailjam</a></p> 73 73 <h4>Next topic</h4> 74 74 <p class="topless"><a href="development.html" … … 106 106 >next</a> |</li> 107 107 <li class="right" > 108 <a href="running.html" title="Running Postman"108 <a href="running.html" title="Running Mailjam" 109 109 >previous</a> |</li> 110 <li><a href="index.html"> Postman0.1.0 documentation</a> »</li>110 <li><a href="index.html">Mailjam 0.1.0 documentation</a> »</li> 111 111 </ul> 112 112 </div> -
docs/src/_build/html/genindex.html
r13 r16 11 11 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 12 12 13 <title>Index — Postman0.1.0 documentation</title>13 <title>Index — Mailjam 0.1.0 documentation</title> 14 14 15 15 <link rel="stylesheet" href="_static/default.css" type="text/css" /> … … 28 28 <script type="text/javascript" src="_static/underscore.js"></script> 29 29 <script type="text/javascript" src="_static/doctools.js"></script> 30 <link rel="top" title=" Postman0.1.0 documentation" href="index.html" />30 <link rel="top" title="Mailjam 0.1.0 documentation" href="index.html" /> 31 31 </head> 32 32 <body> … … 37 37 <a href="#" title="General Index" 38 38 accesskey="I">index</a></li> 39 <li><a href="index.html"> Postman0.1.0 documentation</a> »</li>39 <li><a href="index.html">Mailjam 0.1.0 documentation</a> »</li> 40 40 </ul> 41 41 </div> … … 85 85 <a href="#" title="General Index" 86 86 >index</a></li> 87 <li><a href="index.html"> Postman0.1.0 documentation</a> »</li>87 <li><a href="index.html">Mailjam 0.1.0 documentation</a> »</li> 88 88 </ul> 89 89 </div> -
docs/src/_build/html/index.html
r13 r16 9 9 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 10 10 11 <title> Postman official documentation — Postman0.1.0 documentation</title>11 <title>Mailjam official documentation — Mailjam 0.1.0 documentation</title> 12 12 13 13 <link rel="stylesheet" href="_static/default.css" type="text/css" /> … … 26 26 <script type="text/javascript" src="_static/underscore.js"></script> 27 27 <script type="text/javascript" src="_static/doctools.js"></script> 28 <link rel="top" title=" Postman0.1.0 documentation" href="#" />29 <link rel="next" title="Overview of postman’s architecture" href="overview.html" />28 <link rel="top" title="Mailjam 0.1.0 documentation" href="#" /> 29 <link rel="next" title="Overview of mailjam’s architecture" href="overview.html" /> 30 30 </head> 31 31 <body> … … 37 37 accesskey="I">index</a></li> 38 38 <li class="right" > 39 <a href="overview.html" title="Overview of postman’s architecture"39 <a href="overview.html" title="Overview of mailjam’s architecture" 40 40 accesskey="N">next</a> |</li> 41 <li><a href="#"> Postman0.1.0 documentation</a> »</li>41 <li><a href="#">Mailjam 0.1.0 documentation</a> »</li> 42 42 </ul> 43 43 </div> … … 48 48 <div class="body"> 49 49 50 <div class="section" id=" postman-official-documentation">51 <h1> Postman official documentation<a class="headerlink" href="#postman-official-documentation" title="Permalink to this headline">¶</a></h1>52 <p>This is the official documentation for <a class="reference external" href="https://bitbucket.org/codigo23/ postman">Postman</a>, a mailing list management50 <div class="section" id="mailjam-official-documentation"> 51 <h1>Mailjam official documentation<a class="headerlink" href="#mailjam-official-documentation" title="Permalink to this headline">¶</a></h1> 52 <p>This is the official documentation for <a class="reference external" href="https://bitbucket.org/codigo23/mailjam">Mailjam</a>, a mailing list management 53 53 software written in <a class="reference external" href="http://python.org">Python</a>.</p> 54 54 <p>Contents:</p> 55 55 <div class="toctree-wrapper compound"> 56 56 <ul> 57 <li class="toctree-l1"><a class="reference internal" href="overview.html">Overview of postman’s architecture</a><ul>57 <li class="toctree-l1"><a class="reference internal" href="overview.html">Overview of mailjam’s architecture</a><ul> 58 58 <li class="toctree-l2"><a class="reference internal" href="overview.html#introduction">Introduction</a></li> 59 <li class="toctree-l2"><a class="reference internal" href="overview.html# postman-daemon">Postmandaemon</a></li>59 <li class="toctree-l2"><a class="reference internal" href="overview.html#mailjam-daemon">Mailjam daemon</a></li> 60 60 <li class="toctree-l2"><a class="reference internal" href="overview.html#mta-client">MTA client</a></li> 61 61 <li class="toctree-l2"><a class="reference internal" href="overview.html#cli-client">CLI client</a></li> … … 65 65 <li class="toctree-l1"><a class="reference internal" href="install.html">Installation instructions</a><ul> 66 66 <li class="toctree-l2"><a class="reference internal" href="install.html#first-install-dependencies">First, install dependencies</a></li> 67 <li class="toctree-l2"><a class="reference internal" href="install.html#second-install- postman">Second, install Postman</a></li>68 <li class="toctree-l2"><a class="reference internal" href="install.html#setting-up- postman">Setting up Postman</a></li>69 <li class="toctree-l2"><a class="reference internal" href="install.html#running- postman">Running Postman</a></li>67 <li class="toctree-l2"><a class="reference internal" href="install.html#second-install-mailjam">Second, install Mailjam</a></li> 68 <li class="toctree-l2"><a class="reference internal" href="install.html#setting-up-mailjam">Setting up Mailjam</a></li> 69 <li class="toctree-l2"><a class="reference internal" href="install.html#running-mailjam">Running Mailjam</a></li> 70 70 <li class="toctree-l2"><a class="reference internal" href="install.html#running-tests-developers-only">Running tests (developers only)</a></li> 71 71 </ul> 72 72 </li> 73 73 <li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a><ul> 74 <li class="toctree-l2"><a class="reference internal" href="configuration.html# postman-daemon-configuration-file">Postmandaemon configuration file</a></li>74 <li class="toctree-l2"><a class="reference internal" href="configuration.html#mailjam-daemon-configuration-file">Mailjam daemon configuration file</a></li> 75 75 </ul> 76 76 </li> 77 <li class="toctree-l1"><a class="reference internal" href="running.html">Running Postman</a></li>77 <li class="toctree-l1"><a class="reference internal" href="running.html">Running Mailjam</a></li> 78 78 <li class="toctree-l1"><a class="reference internal" href="examples.html">Some examples</a></li> 79 79 <li class="toctree-l1"><a class="reference internal" href="development.html">Developers documentation</a></li> … … 98 98 <h3><a href="#">Table Of Contents</a></h3> 99 99 <ul> 100 <li><a class="reference internal" href="#"> Postmanofficial documentation</a><ul>100 <li><a class="reference internal" href="#">Mailjam official documentation</a><ul> 101 101 </ul> 102 102 </li> … … 106 106 <h4>Next topic</h4> 107 107 <p class="topless"><a href="overview.html" 108 title="next chapter">Overview of postman’s architecture</a></p>108 title="next chapter">Overview of mailjam’s architecture</a></p> 109 109 <h3>This Page</h3> 110 110 <ul class="this-page-menu"> … … 136 136 >index</a></li> 137 137 <li class="right" > 138 <a href="overview.html" title="Overview of postman’s architecture"138 <a href="overview.html" title="Overview of mailjam’s architecture" 139 139 >next</a> |</li> 140 <li><a href="#"> Postman0.1.0 documentation</a> »</li>140 <li><a href="#">Mailjam 0.1.0 documentation</a> »</li> 141 141 </ul> 142 142 </div> -
docs/src/_build/html/install.html
r13 r16 9 9 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 10 10 11 <title>Installation instructions — Postman0.1.0 documentation</title>11 <title>Installation instructions — Mailjam 0.1.0 documentation</title> 12 12 13 13 <link rel="stylesheet" href="_static/default.css" type="text/css" /> … … 26 26 <script type="text/javascript" src="_static/underscore.js"></script> 27 27 <script type="text/javascript" src="_static/doctools.js"></script> 28 <link rel="top" title=" Postman0.1.0 documentation" href="index.html" />28 <link rel="top" title="Mailjam 0.1.0 documentation" href="index.html" /> 29 29 <link rel="next" title="Configuration" href="configuration.html" /> 30 <link rel="prev" title="Overview of postman’s architecture" href="overview.html" />30 <link rel="prev" title="Overview of mailjam’s architecture" href="overview.html" /> 31 31 </head> 32 32 <body> … … 41 41 accesskey="N">next</a> |</li> 42 42 <li class="right" > 43 <a href="overview.html" title="Overview of postman’s architecture"43 <a href="overview.html" title="Overview of mailjam’s architecture" 44 44 accesskey="P">previous</a> |</li> 45 <li><a href="index.html"> Postman0.1.0 documentation</a> »</li>45 <li><a href="index.html">Mailjam 0.1.0 documentation</a> »</li> 46 46 </ul> 47 47 </div> … … 59 59 <li><a class="reference internal" href="#installation-instructions" id="id3">Installation instructions</a><ul> 60 60 <li><a class="reference internal" href="#first-install-dependencies" id="id4">First, install dependencies</a></li> 61 <li><a class="reference internal" href="#second-install- postman" id="id5">Second, install Postman</a><ul>61 <li><a class="reference internal" href="#second-install-mailjam" id="id5">Second, install Mailjam</a><ul> 62 62 <li><a class="reference internal" href="#installing-using-pip" id="id6">Installing using pip</a></li> 63 63 <li><a class="reference internal" href="#installing-using-easy-install" id="id7">Installing using easy_install</a></li> … … 70 70 </ul> 71 71 </li> 72 <li><a class="reference internal" href="#setting-up- postman" id="id12">Setting up Postman</a></li>73 <li><a class="reference internal" href="#running- postman" id="id13">Running Postman</a></li>72 <li><a class="reference internal" href="#setting-up-mailjam" id="id12">Setting up Mailjam</a></li> 73 <li><a class="reference internal" href="#running-mailjam" id="id13">Running Mailjam</a></li> 74 74 <li><a class="reference internal" href="#running-tests-developers-only" id="id14">Running tests (developers only)</a></li> 75 75 </ul> … … 79 79 <div class="section" id="first-install-dependencies"> 80 80 <span id="install-dependencies"></span><h2><a class="toc-backref" href="#id4">First, install dependencies</a><a class="headerlink" href="#first-install-dependencies" title="Permalink to this headline">¶</a></h2> 81 <p>So far, the only dependency you will need in order to run postmanis <a class="reference external" href="http://python.org">Python</a></p>82 <p> Postmanhas been tested with python <em>2.7.x</em>, but it should work with versions81 <p>So far, the only dependency you will need in order to run mailjam is <a class="reference external" href="http://python.org">Python</a></p> 82 <p>Mailjam has been tested with python <em>2.7.x</em>, but it should work with versions 83 83 <em>2.6.x</em> too.</p> 84 84 <p>Please, refer to your operating system package system documentation to learn 85 85 more about how to install python.</p> 86 86 </div> 87 <div class="section" id="second-install- postman">88 <span id="install- postman"></span><h2><a class="toc-backref" href="#id5">Second, install Postman</a><a class="headerlink" href="#second-install-postman" title="Permalink to this headline">¶</a></h2>87 <div class="section" id="second-install-mailjam"> 88 <span id="install-mailjam"></span><h2><a class="toc-backref" href="#id5">Second, install Mailjam</a><a class="headerlink" href="#second-install-mailjam" title="Permalink to this headline">¶</a></h2> 89 89 <div class="section" id="installing-using-pip"> 90 90 <span id="install-with-pip"></span><h3><a class="toc-backref" href="#id6">Installing using pip</a><a class="headerlink" href="#installing-using-pip" title="Permalink to this headline">¶</a></h3> 91 <p>You can install Postmanusing <a class="reference external" href="http://www.pip-installer.org/en/latest/index.html">pip</a>:</p>92 <div class="highlight-python"><pre>pip install -e https://bitbucket.org/codigo23/ postman#egg=postman</pre>91 <p>You can install Mailjam using <a class="reference external" href="http://www.pip-installer.org/en/latest/index.html">pip</a>:</p> 92 <div class="highlight-python"><pre>pip install -e https://bitbucket.org/codigo23/mailjam#egg=mailjam</pre> 93 93 </div> 94 94 <div class="admonition note"> 95 95 <p class="first admonition-title">Note</p> 96 <p class="last"> Postmanhas not been recorded/uploaded to <a class="reference external" href="http://pypi.python.org/pypi">pypi</a> yet, so, in order to install97 it using pip you will have to provide the URL for the public Postmanrepo.</p>96 <p class="last">Mailjam has not been recorded/uploaded to <a class="reference external" href="http://pypi.python.org/pypi">pypi</a> yet, so, in order to install 97 it using pip you will have to provide the URL for the public Mailjam repo.</p> 98 98 </div> 99 99 </div> 100 100 <div class="section" id="installing-using-easy-install"> 101 101 <span id="install-with-easy-install"></span><h3><a class="toc-backref" href="#id7">Installing using easy_install</a><a class="headerlink" href="#installing-using-easy-install" title="Permalink to this headline">¶</a></h3> 102 <p>You can not install Postmanusing <a class="reference external" href="http://peak.telecommunity.com/DevCenter/EasyInstall">easy_install</a> yet (until we do record/upload102 <p>You can not install Mailjam using <a class="reference external" href="http://peak.telecommunity.com/DevCenter/EasyInstall">easy_install</a> yet (until we do record/upload 103 103 it to pypi)</p> 104 104 </div> 105 105 <div class="section" id="installing-inside-a-virtualenv"> 106 106 <span id="install-inside-virtualenv"></span><h3><a class="toc-backref" href="#id8">Installing inside a virtualenv</a><a class="headerlink" href="#installing-inside-a-virtualenv" title="Permalink to this headline">¶</a></h3> 107 <p>You can install Postmaninside a <a class="reference external" href="http://www.virtualenv.org/en/latest/index.html">virtualenv</a>. Just create a virtualenv:</p>107 <p>You can install Mailjam inside a <a class="reference external" href="http://www.virtualenv.org/en/latest/index.html">virtualenv</a>. Just create a virtualenv:</p> 108 108 <div class="highlight-python"><div class="highlight"><pre><span class="n">virtualenv</span> <span class="o">/</span><span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="n">your</span><span class="o">/</span><span class="n">env</span> 109 109 </pre></div> … … 121 121 </div> 122 122 </div> 123 <p>And, once the environment has been activated, use pip to install Postman:</p>124 <div class="highlight-python"><pre>env$ pip install -e https://bitbucket.org/codigo23/ postman#egg=postman</pre>123 <p>And, once the environment has been activated, use pip to install Mailjam:</p> 124 <div class="highlight-python"><pre>env$ pip install -e https://bitbucket.org/codigo23/mailjam#egg=mailjam</pre> 125 125 </div> 126 126 </div> … … 136 136 <div class="section" id="from-repository"> 137 137 <span id="install-from-repository"></span><h4><a class="toc-backref" href="#id11">From repository</a><a class="headerlink" href="#from-repository" title="Permalink to this headline">¶</a></h4> 138 <p>The source code of Postmanis hosted in <a class="reference external" href="https://bitbucket.org">bitbucket</a> <a class="footnote-reference" href="#id2" id="id1">[1]</a>. In order to grab138 <p>The source code of Mailjam is hosted in <a class="reference external" href="https://bitbucket.org">bitbucket</a> <a class="footnote-reference" href="#id2" id="id1">[1]</a>. In order to grab 139 139 the latest sources you need <a class="reference external" href="http://mercurial.selenic.com">Mercurial</a>.</p> 140 140 <p>To get a copy of the sources, just <em>clone</em> the repository:</p> 141 <div class="highlight-python"><pre>hg clone https://bitbucket.org/codigo23/ postman postman-repo</pre>142 </div> 143 <p>Then, go inside the <em> postman-repo</em> directory and run:</p>141 <div class="highlight-python"><pre>hg clone https://bitbucket.org/codigo23/mailjam mailjam-repo</pre> 142 </div> 143 <p>Then, go inside the <em>mailjam-repo</em> directory and run:</p> 144 144 <div class="highlight-python"><pre>python setup.py install</pre> 145 145 </div> … … 157 157 </div> 158 158 </div> 159 <div class="section" id="setting-up- postman">160 <span id="install-setting-up- postman"></span><h2><a class="toc-backref" href="#id12">Setting up Postman</a><a class="headerlink" href="#setting-up-postman" title="Permalink to this headline">¶</a></h2>159 <div class="section" id="setting-up-mailjam"> 160 <span id="install-setting-up-mailjam"></span><h2><a class="toc-backref" href="#id12">Setting up Mailjam</a><a class="headerlink" href="#setting-up-mailjam" title="Permalink to this headline">¶</a></h2> 161 161 <p>TBW</p> 162 162 </div> 163 <div class="section" id="running- postman">164 <span id="install-running- postman"></span><h2><a class="toc-backref" href="#id13">Running Postman</a><a class="headerlink" href="#running-postman" title="Permalink to this headline">¶</a></h2>163 <div class="section" id="running-mailjam"> 164 <span id="install-running-mailjam"></span><h2><a class="toc-backref" href="#id13">Running Mailjam</a><a class="headerlink" href="#running-mailjam" title="Permalink to this headline">¶</a></h2> 165 165 <p>TBW</p> 166 166 </div> … … 171 171 <colgroup><col class="label" /><col /></colgroup> 172 172 <tbody valign="top"> 173 <tr><td class="label"><a class="fn-backref" href="#id1">[1]</a></td><td><a class="reference external" href="https://bitbucket.org/codigo23/ postman">https://bitbucket.org/codigo23/postman</a></td></tr>173 <tr><td class="label"><a class="fn-backref" href="#id1">[1]</a></td><td><a class="reference external" href="https://bitbucket.org/codigo23/mailjam">https://bitbucket.org/codigo23/mailjam</a></td></tr> 174 174 </tbody> 175 175 </table> … … 187 187 <li><a class="reference internal" href="#">Installation instructions</a><ul> 188 188 <li><a class="reference internal" href="#first-install-dependencies">First, install dependencies</a></li> 189 <li><a class="reference internal" href="#second-install- postman">Second, install Postman</a><ul>189 <li><a class="reference internal" href="#second-install-mailjam">Second, install Mailjam</a><ul> 190 190 <li><a class="reference internal" href="#installing-using-pip">Installing using pip</a></li> 191 191 <li><a class="reference internal" href="#installing-using-easy-install">Installing using easy_install</a></li> … … 198 198 </ul> 199 199 </li> 200 <li><a class="reference internal" href="#setting-up- postman">Setting up Postman</a></li>201 <li><a class="reference internal" href="#running- postman">Running Postman</a></li>200 <li><a class="reference internal" href="#setting-up-mailjam">Setting up Mailjam</a></li> 201 <li><a class="reference internal" href="#running-mailjam">Running Mailjam</a></li> 202 202 <li><a class="reference internal" href="#running-tests-developers-only">Running tests (developers only)</a></li> 203 203 </ul> … … 207 207 <h4>Previous topic</h4> 208 208 <p class="topless"><a href="overview.html" 209 title="previous chapter">Overview of postman’s architecture</a></p>209 title="previous chapter">Overview of mailjam’s architecture</a></p> 210 210 <h4>Next topic</h4> 211 211 <p class="topless"><a href="configuration.html" … … 243 243 >next</a> |</li> 244 244 <li class="right" > 245 <a href="overview.html" title="Overview of postman’s architecture"245 <a href="overview.html" title="Overview of mailjam’s architecture" 246 246 >previous</a> |</li> 247 <li><a href="index.html"> Postman0.1.0 documentation</a> »</li>247 <li><a href="index.html">Mailjam 0.1.0 documentation</a> »</li> 248 248 </ul> 249 249 </div> -
docs/src/_build/html/overview.html
r13 r16 9 9 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 10 10 11 <title>Overview of postman’s architecture — Postman0.1.0 documentation</title>11 <title>Overview of mailjam’s architecture — Mailjam 0.1.0 documentation</title> 12 12 13 13 <link rel="stylesheet" href="_static/default.css" type="text/css" /> … … 26 26 <script type="text/javascript" src="_static/underscore.js"></script> 27 27 <script type="text/javascript" src="_static/doctools.js"></script> 28 <link rel="top" title=" Postman0.1.0 documentation" href="index.html" />28 <link rel="top" title="Mailjam 0.1.0 documentation" href="index.html" /> 29 29 <link rel="next" title="Installation instructions" href="install.html" /> 30 <link rel="prev" title=" Postmanofficial documentation" href="index.html" />30 <link rel="prev" title="Mailjam official documentation" href="index.html" /> 31 31 </head> 32 32 <body> … … 41 41 accesskey="N">next</a> |</li> 42 42 <li class="right" > 43 <a href="index.html" title=" Postmanofficial documentation"43 <a href="index.html" title="Mailjam official documentation" 44 44 accesskey="P">previous</a> |</li> 45 <li><a href="index.html"> Postman0.1.0 documentation</a> »</li>45 <li><a href="index.html">Mailjam 0.1.0 documentation</a> »</li> 46 46 </ul> 47 47 </div> … … 52 52 <div class="body"> 53 53 54 <div class="section" id="overview-of- postman-s-architecture">55 <h1><a class="toc-backref" href="#id1">Overview of postman’s architecture</a><a class="headerlink" href="#overview-of-postman-s-architecture" title="Permalink to this headline">¶</a></h1>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> 56 56 <div class="contents topic" id="contents"> 57 57 <p class="topic-title first">Contents</p> 58 58 <ul class="simple"> 59 <li><a class="reference internal" href="#overview-of- postman-s-architecture" id="id1">Overview of postman’s architecture</a><ul>59 <li><a class="reference internal" href="#overview-of-mailjam-s-architecture" id="id1">Overview of mailjam’s architecture</a><ul> 60 60 <li><a class="reference internal" href="#introduction" id="id2">Introduction</a></li> 61 <li><a class="reference internal" href="# postman-daemon" id="id3">Postmandaemon</a></li>61 <li><a class="reference internal" href="#mailjam-daemon" id="id3">Mailjam daemon</a></li> 62 62 <li><a class="reference internal" href="#mta-client" id="id4">MTA client</a></li> 63 63 <li><a class="reference internal" href="#cli-client" id="id5">CLI client</a></li> … … 69 69 <div class="section" id="introduction"> 70 70 <h2><a class="toc-backref" href="#id2">Introduction</a><a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h2> 71 <p> Postmanhas been designed following a <strong>multi-component structure</strong>. There is71 <p>Mailjam has been designed following a <strong>multi-component structure</strong>. There is 72 72 <strong>a daemon</strong> that manage the mailing lists and members information in a storage 73 73 backend and there are <strong>different kinds of clients</strong> (currently, three of them) 74 74 that <strong>interact with the daemon using a XMLRPC link</strong>.</p> 75 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" />76 <img alt="Scheme of the architecture behind Mailjam" class="open-fancybox" src="_images/mailjam_architecture.png" /> 77 77 </div> 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>78 <div class="section" id="mailjam-daemon"> 79 <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> 80 80 <p>The daemon will perform all the operations regarding the management of the 81 81 mailing lists and members. The daemon will save information of a given … … 86 86 </div> 87 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>88 <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> 89 89 <p>This client is attached to a given MTA, and is called but the MTA itself when 90 90 emails for a mailing lists are received. The client performs some checks on the … … 92 92 </div> 93 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>94 <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> 95 95 <p>This is a shell-like interface that can be used to add mailing lists to a given 96 Postmanserver, edit such mailing lists information, add members, etc.</p>96 Mailjam server, edit such mailing lists information, add members, etc.</p> 97 97 </div> 98 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>99 <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> 100 100 <p>This is a small <em>webapp</em> that can be used to perform the same management 101 101 operations you can achieve using the 102 <a class="reference internal" href="#overview- postman-cli-client"><em>CLI client</em></a>.</p>102 <a class="reference internal" href="#overview-mailjam-cli-client"><em>CLI client</em></a>.</p> 103 103 </div> 104 104 </div> … … 112 112 <h3><a href="index.html">Table Of Contents</a></h3> 113 113 <ul> 114 <li><a class="reference internal" href="#">Overview of postman’s architecture</a><ul>114 <li><a class="reference internal" href="#">Overview of mailjam’s architecture</a><ul> 115 115 <li><a class="reference internal" href="#introduction">Introduction</a></li> 116 <li><a class="reference internal" href="# postman-daemon">Postmandaemon</a></li>116 <li><a class="reference internal" href="#mailjam-daemon">Mailjam daemon</a></li> 117 117 <li><a class="reference internal" href="#mta-client">MTA client</a></li> 118 118 <li><a class="reference internal" href="#cli-client">CLI client</a></li> … … 124 124 <h4>Previous topic</h4> 125 125 <p class="topless"><a href="index.html" 126 title="previous chapter"> Postmanofficial documentation</a></p>126 title="previous chapter">Mailjam official documentation</a></p> 127 127 <h4>Next topic</h4> 128 128 <p class="topless"><a href="install.html" … … 160 160 >next</a> |</li> 161 161 <li class="right" > 162 <a href="index.html" title=" Postmanofficial documentation"162 <a href="index.html" title="Mailjam official documentation" 163 163 >previous</a> |</li> 164 <li><a href="index.html"> Postman0.1.0 documentation</a> »</li>164 <li><a href="index.html">Mailjam 0.1.0 documentation</a> »</li> 165 165 </ul> 166 166 </div> -
docs/src/_build/html/running.html
r13 r16 9 9 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 10 10 11 <title>Running Postman — Postman0.1.0 documentation</title>11 <title>Running Mailjam — Mailjam 0.1.0 documentation</title> 12 12 13 13 <link rel="stylesheet" href="_static/default.css" type="text/css" /> … … 26 26 <script type="text/javascript" src="_static/underscore.js"></script> 27 27 <script type="text/javascript" src="_static/doctools.js"></script> 28 <link rel="top" title=" Postman0.1.0 documentation" href="index.html" />28 <link rel="top" title="Mailjam 0.1.0 documentation" href="index.html" /> 29 29 <link rel="next" title="Some examples" href="examples.html" /> 30 30 <link rel="prev" title="Configuration" href="configuration.html" /> … … 43 43 <a href="configuration.html" title="Configuration" 44 44 accesskey="P">previous</a> |</li> 45 <li><a href="index.html"> Postman0.1.0 documentation</a> »</li>45 <li><a href="index.html">Mailjam 0.1.0 documentation</a> »</li> 46 46 </ul> 47 47 </div> … … 52 52 <div class="body"> 53 53 54 <div class="section" id="running- postman">55 <h1><a class="toc-backref" href="#id1">Running Postman</a><a class="headerlink" href="#running-postman" title="Permalink to this headline">¶</a></h1>54 <div class="section" id="running-mailjam"> 55 <h1><a class="toc-backref" href="#id1">Running Mailjam</a><a class="headerlink" href="#running-mailjam" title="Permalink to this headline">¶</a></h1> 56 56 <div class="contents topic" id="contents"> 57 57 <p class="topic-title first">Contents</p> 58 58 <ul class="simple"> 59 <li><a class="reference internal" href="#running- postman" id="id1">Running Postman</a></li>59 <li><a class="reference internal" href="#running-mailjam" id="id1">Running Mailjam</a></li> 60 60 </ul> 61 61 </div> … … 108 108 <a href="configuration.html" title="Configuration" 109 109 >previous</a> |</li> 110 <li><a href="index.html"> Postman0.1.0 documentation</a> »</li>110 <li><a href="index.html">Mailjam 0.1.0 documentation</a> »</li> 111 111 </ul> 112 112 </div> -
docs/src/_build/html/search.html
r13 r16 9 9 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 10 10 11 <title>Search — Postman0.1.0 documentation</title>11 <title>Search — Mailjam 0.1.0 documentation</title> 12 12 13 13 <link rel="stylesheet" href="_static/default.css" type="text/css" /> … … 27 27 <script type="text/javascript" src="_static/doctools.js"></script> 28 28 <script type="text/javascript" src="_static/searchtools.js"></script> 29 <link rel="top" title=" Postman0.1.0 documentation" href="index.html" />29 <link rel="top" title="Mailjam 0.1.0 documentation" href="index.html" /> 30 30 <script type="text/javascript"> 31 31 jQuery(function() { Search.loadIndex("searchindex.js"); }); … … 41 41 <a href="genindex.html" title="General Index" 42 42 accesskey="I">index</a></li> 43 <li><a href="index.html"> Postman0.1.0 documentation</a> »</li>43 <li><a href="index.html">Mailjam 0.1.0 documentation</a> »</li> 44 44 </ul> 45 45 </div> … … 89 89 <a href="genindex.html" title="General Index" 90 90 >index</a></li> 91 <li><a href="index.html"> Postman0.1.0 documentation</a> »</li>91 <li><a href="index.html">Mailjam 0.1.0 documentation</a> »</li> 92 92 </ul> 93 93 </div> -
docs/src/_build/html/searchindex.js
r13 r16 1 Search.setIndex({objects:{},terms:{all:[2,6],code:5,identifi:6,edg:5,just:5, softwar:1,gentoo:6,abl:6,offici:[1,5],becaus:6,tcp:2,ssl_kei:6,session:6,through:6,file:[1,6],follow:2,netbsd:6,disk:6,ssl_crt:6,dynam:6,paramet:6,xml:6,content:[0,1,2,3,4,5,6],privat:6,password:6,locat:6,cli:[1,2],listen:[2,6],also:6,configur:[1,6],activ:5,send:6,should:5,add:[2,6],archlinux:6,appli:6,mail:[1,6,2],save:[2,6],local:6,xmlrpc_server:6,bin:5,applic:6,them:2,sourc:[6,5],env:5,xmlrpc:[2,6],get:5,read:[2,6],auto:6,pypi:5,multi:2,tbw:5,repo:5,ssl:6,traffic:6,usual:6,now:6,mailing_list:6,introduct:[1,2],daemon:[1,6,2],like:[2,6],specif:6,edit:2,list:[1,6,2],upload:5,server:[2,6],separ:6,"default":6,achiev:2,exampl:[1,4,5],updat:[2,6],contain:6,small:2,privileg:5,grab:5,secure_socket_lay:6,where:6,manag:[1,2],mean:6,wiki:6,certif:6,www:6,set:[1,6,5],members_db:6,some:[1,4,2],see:6,design:2,download:5,themselv:6,administr:6,port:[2,6],librari:6,hostnam:6,virtualenv:5,index:1,what:2,still:6,postman:[1,3,6,5,2],matter:6,section:6,wikipedia:6,per:6,yet:[6,5],categori:6,delet:2,written:1,version:5,directori:[6,5],"new":6,"public":[6,5],localhost:6,refer:5,hasn:6,run:[1,3,5],insid:5,web:[1,6,2],style:6,here:6,behaviour:6,extens:6,host:5,base:6,repositori:5,ubuntu:6,releas:5,depend:[1,6,5],modifi:6,bleed:5,valu:6,about:[6,5],perform:2,architectur:[1,2],pymotw:6,current:[2,6],doughellmann:6,page:1,configpars:6,etc:[2,6],fals:6,com:6,disabl:6,logfil:6,oper:[2,5],pleas:5,note:[6,5],overview:[1,2],modul:1,within:6,por:6,easy_instal:5,system:[6,5],email:[2,6],instruct:[1,5],alreadi:2,been:[2,6,5],linux:6,instal:[1,6,5],storag:[2,6],your:[6,5],backend:[2,6],kei:6,avail:6,differ:[2,6],from:[2,6,5],log:6,wai:[6,5],interact:2,support:6,regist:6,three:2,messag:6,mercuri:5,attach:2,json:6,interfac:[2,6],usr:6,"var":6,call:2,scheme:2,type:6,until:5,store:6,more:[6,5],shell:[2,5],option:6,python:[1,6,5],copi:[6,5],search:1,warn:[6,5],thi:[1,6,5,2],allow_chpasswd:6,link:2,too:[2,5],webapp:2,given:[2,6],"true":6,those:6,serv:6,wide:5,kind:2,onli:[1,6,5],conf:6,provid:5,setup:[6,5],work:[6,5],onc:5,second:[1,5],structur:2,tell:2,trick:6,record:5,archiv:6,can:[2,6,5],learn:5,exist:6,mta:[1,2],root:5,address:6,unencrypt:6,featur:6,openbsd:6,ini_fil:6,creat:5,process:5,sudo:5,ani:6,doesn:6,compon:2,packag:5,itself:2,right:6,ini:6,have:5,tabl:1,pip:5,incom:2,path:[6,5],check:[2,5],probabl:5,readi:6,encrypt:6,thei:6,want:5,inform:[2,6],receiv:2,travel:6,when:[2,6,5],same:[2,6],reset:6,member:[2,6],how:5,need:5,html:6,anyon:6,rememb:5,test:[1,5],codigo23:5,you:[2,6,5],document:[0,1,5],enabl:6,regard:2,http:[6,5],allow:2,tcsh:5,clone:5,auto_signup:6,most:6,rpc:6,user:6,crt:6,bsd:6,develop:[0,1,5],data:[2,6],debian:6,org:[6,5],csh:5,other:6,bitbucket:5,lists_db:6,off:6,url:5,doc:6,later:6,request:[2,6],inherit:6,fedora:6,registr:6,client:[1,2],environ:5,freebsd:6,indic:1,far:5,first:[1,5],egg:5,order:5,latest:5},objtypes:{},titles:["Developers documentation","Postman official documentation","Overview of postman’s architecture","Running Postman","Some examples","Installation instructions","Configuration"],objnames:{},filenames:["development","index","overview","running","examples","install","configuration"]})1 Search.setIndex({objects:{},terms:{all:[2,6],code:5,identifi:6,edg:5,just:5,tcsh:5,wikipedia:6,offici:[1,5],becaus:6,tcp:2,ssl_kei:6,session:6,through:6,url:5,ini_fil:6,follow:2,netbsd:6,disk:6,ssl_crt:6,dynam:6,paramet:6,xml:6,categori:6,privat:6,password:6,locat:6,cli:[1,2],how:5,configur:[1,6],activ:5,send:6,should:5,add:[2,6],archlinux:6,overview:[1,2],mail:[1,6,2],tell:2,save:[2,6],local:6,latest:5,bin:5,applic:6,them:2,sourc:[6,5],rememb:5,xmlrpc:[2,6],get:5,read:[2,6],auto:6,pypi:5,kind:2,tbw:5,repo:5,ssl:6,traffic:6,enabl:6,now:6,mailing_list:6,introduct:[1,2],daemon:[1,6,2],like:[2,6],specif:6,edit:2,list:[1,6,2],upload:5,server:[2,6],separ:6,provid:5,achiev:2,have:5,contain:6,small:2,privileg:5,grab:5,secure_socket_lay:6,where:6,manag:[1,2],mean:6,wiki:6,certif:6,www:6,set:[1,6,5],members_db:6,some:[1,4,2],see:6,member:[2,6],design:2,download:5,run:[1,3,5],port:[2,6],librari:6,virtualenv:5,index:1,what:2,still:6,postman:[],record:5,freebsd:6,section:6,abl:6,per:6,yet:[6,5],content:[0,1,2,3,4,5,6],delet:2,written:1,version:5,"new":6,"public":[6,5],localhost:6,refer:5,hasn:6,more:[6,5],themselv:6,insid:5,web:[1,6,2],pleas:5,style:6,here:6,behaviour:6,extens:6,host:5,base:6,repositori:5,ubuntu:6,releas:5,depend:[1,6,5],modifi:6,bleed:5,valu:6,about:[6,5],architectur:[1,2],pymotw:6,current:[2,6],doughellmann:6,page:1,configpars:6,etc:[2,6],fals:6,com:6,disabl:6,user:6,oper:[2,5],softwar:1,client:[1,2],note:[6,5],appli:6,modul:1,within:6,por:6,easy_instal:5,three:2,email:[2,6],instruct:[1,5],alreadi:2,messag:6,right:6,linux:6,instal:[1,6,5],storag:[2,6],your:[6,5],backend:[2,6],kei:6,mercuri:5,differ:[2,6],from:[2,6,5],log:6,wai:[6,5],attach:2,interact:2,support:6,regist:6,system:[6,5],been:[2,6,5],avail:6,mailjam:[1,3,6,5,2],json:6,interfac:[2,6],usr:6,"var":6,call:2,scheme:2,type:6,administr:6,store:6,listen:[2,6],shell:[2,5],option:6,python:[1,6,5],copi:[6,5],search:1,warn:[6,5],allow_chpasswd:6,link:2,too:[2,5],webapp:2,given:[2,6],"true":6,those:6,serv:6,wide:5,multi:2,onli:[1,6,5],"default":6,setup:[6,5],work:[6,5],onc:5,second:[1,5],structur:2,until:5,trick:6,matter:6,itself:2,can:[2,6,5],learn:5,mta:[1,2],root:5,html:6,address:6,unencrypt:6,featur:6,openbsd:6,conf:6,creat:5,process:5,sudo:5,ani:6,doesn:6,compon:2,packag:5,archiv:6,exist:6,ini:6,file:[1,6],tabl:1,pip:5,incom:2,path:[6,5],check:[2,5],probabl:5,readi:6,encrypt:6,thei:6,want:5,inform:[2,6],perform:2,allow:2,travel:6,when:[2,6,5],same:[2,6],reset:6,lists_db:6,also:6,need:5,xmlrpc_server:6,anyon:6,env:5,test:[1,5],environ:5,you:[2,6,5],document:[0,1,5],updat:[2,6],regard:2,http:[6,5],hostnam:6,gentoo:6,clone:5,auto_signup:6,most:6,rpc:6,logfil:6,crt:6,bsd:6,develop:[0,1,5],data:[2,6],debian:6,org:[6,5],csh:5,other:6,bitbucket:5,receiv:2,off:6,directori:[6,5],doc:6,later:6,request:[2,6],inherit:6,fedora:6,registr:6,exampl:[1,4,5],codigo23:5,thi:[1,6,5,2],indic:1,far:5,first:[1,5],egg:5,order:5,usual:6},objtypes:{},titles:["Developers documentation","Mailjam official documentation","Overview of mailjam’s architecture","Running Mailjam","Some examples","Installation instructions","Configuration"],objnames:{},filenames:["development","index","overview","running","examples","install","configuration"]}) -
docs/src/conf.py
r13 r16 1 1 # -*- coding: utf-8 -*- 2 2 # 3 # Postmandocumentation build configuration file, created by3 # Mailjam documentation build configuration file, created by 4 4 # sphinx-quickstart on Sun May 20 12:34:00 2012. 5 5 # … … 41 41 42 42 # General information about the project. 43 project = u' Postman'43 project = u'Mailjam' 44 44 copyright = u'2012, Soluciones Informaticas Codigo23 S.L.U.' 45 45 … … 165 165 166 166 # Output file base name for HTML help builder. 167 htmlhelp_basename = ' Postmandoc'167 htmlhelp_basename = 'Mailjamdoc' 168 168 169 169 … … 184 184 # (source start file, target name, title, author, documentclass [howto/manual]). 185 185 latex_documents = [ 186 ('index', ' Postman.tex', u'PostmanDocumentation',186 ('index', 'Mailjam.tex', u'Mailjam Documentation', 187 187 u'Soluciones Informaticas Codigo23 S.L.U.', 'manual'), 188 188 ] … … 214 214 # (source start file, name, description, authors, manual section). 215 215 man_pages = [ 216 ('index', ' postman', u'PostmanDocumentation',216 ('index', 'mailjam', u'Mailjam Documentation', 217 217 [u'Soluciones Informaticas Codigo23 S.L.U.'], 1) 218 218 ] … … 228 228 # dir menu entry, description, category) 229 229 texinfo_documents = [ 230 ('index', ' Postman', u'PostmanDocumentation',231 u'Soluciones Informaticas Codigo23 S.L.U.', ' Postman', 'One line description of project.',230 ('index', 'Mailjam', u'Mailjam Documentation', 231 u'Soluciones Informaticas Codigo23 S.L.U.', 'Mailjam', 'One line description of project.', 232 232 'Miscellaneous'), 233 233 ] … … 246 246 247 247 # Bibliographic Dublin Core info. 248 epub_title = u' Postman'248 epub_title = u'Mailjam' 249 249 epub_author = u'Soluciones Informaticas Codigo23 S.L.U.' 250 250 epub_publisher = u'Soluciones Informaticas Codigo23 S.L.U.' -
docs/src/configuration.rst
r13 r16 6 6 .. _configuration_daemon: 7 7 8 Postmandaemon configuration file8 Mailjam daemon configuration file 9 9 --------------------------------- 10 10 11 All the configurations that can be applied to the Postmandaemon are registered12 in the ** postman.conf** file. That file contains ini-style [1]_ configuration11 All the configurations that can be applied to the Mailjam daemon are registered 12 in the **mailjam.conf** file. That file contains ini-style [1]_ configuration 13 13 parameters, separated in different *categories*. 14 14 15 15 .. note:: 16 16 17 The postman.conf file will be installed in different locations depending on17 The mailjam.conf file will be installed in different locations depending on 18 18 your setup. The usual locations are: 19 19 20 - */etc/ postman.conf* - In most Linux systems (like archlinux, gentoo,20 - */etc/mailjam.conf* - In most Linux systems (like archlinux, gentoo, 21 21 fedora, debian, ubuntu, etc) 22 22 23 - */usr/local/etc/ postman.conf* - In most BSD systems (like FreeBSD, OpenBSD,23 - */usr/local/etc/mailjam.conf* - In most BSD systems (like FreeBSD, OpenBSD, 24 24 NetBSD, etc) 25 25 … … 73 73 ******* 74 74 75 Default: ``/usr/local/etc/ postman/ssl/postman.key``75 Default: ``/usr/local/etc/mailjam/ssl/mailjam.key`` 76 76 77 77 Path to the ssl key used for encrypted SSL sessions. … … 86 86 ******* 87 87 88 Default: ``/usr/local/etc/ postman/ssl/postman.crt``88 Default: ``/usr/local/etc/mailjam/ssl/mailjam.crt`` 89 89 90 90 Path to the ssl certificate used for encrypted SSL sessions. … … 99 99 ******* 100 100 101 Default: ``/var/log/ postman/xmlrpc_server.log``101 Default: ``/var/log/mailjam/xmlrpc_server.log`` 102 102 103 103 Path to the file where log messages will be saved … … 128 128 **** 129 129 130 Default: ``/usr/local/ postman/storage``130 Default: ``/usr/local/mailjam/storage`` 131 131 132 132 Path to the directory where the backend will save data. … … 137 137 ******** 138 138 139 Default: ``/usr/local/ postman/storage/mailings.json``139 Default: ``/usr/local/mailjam/storage/mailings.json`` 140 140 141 141 Path to the file where the identifiers of existing mailing lists will be saved. … … 165 165 ********** 166 166 167 Default: ``/usr/local/ postman/storage/members.json``167 Default: ``/usr/local/mailjam/storage/members.json`` 168 168 169 169 Path to the file where the identifiers of existing members will be saved. … … 191 191 Default: ``true`` 192 192 193 Enables/disables the *archives* feature. When enabled, Postmansaves copies of193 Enables/disables the *archives* feature. When enabled, Mailjam saves copies of 194 194 email address into an *archive*, so they can be read later, through a web 195 195 interface. … … 220 220 **** 221 221 222 Default: ``/usr/local/ postman/archives``222 Default: ``/usr/local/mailjam/archives`` 223 223 224 224 Path to the directory where the archives will be saved. … … 238 238 .. warning:: 239 239 240 This parameters are not currently used in postman, we are still working240 This parameters are not currently used in mailjam, we are still working 241 241 on per-mailing-list configuration parameters. 242 242 … … 265 265 .. warning:: 266 266 267 This parameters are not currently used in postman, we are still working267 This parameters are not currently used in mailjam, we are still working 268 268 on per-member configuration parameters. 269 269 -
docs/src/index.rst
r13 r16 1 Postmanofficial documentation1 Mailjam official documentation 2 2 ============================== 3 3 4 This is the official documentation for Postman_, a mailing list management4 This is the official documentation for Mailjam_, a mailing list management 5 5 software written in Python_. 6 6 … … 25 25 * :ref:`search` 26 26 27 .. _ Postman: https://bitbucket.org/codigo23/postman27 .. _Mailjam: https://bitbucket.org/codigo23/mailjam 28 28 .. _Python: http://python.org -
docs/src/install.rst
r13 r16 9 9 --------------------------- 10 10 11 So far, the only dependency you will need in order to run postmanis Python_11 So far, the only dependency you will need in order to run mailjam is Python_ 12 12 13 Postmanhas been tested with python *2.7.x*, but it should work with versions13 Mailjam has been tested with python *2.7.x*, but it should work with versions 14 14 *2.6.x* too. 15 15 … … 17 17 more about how to install python. 18 18 19 .. _install_ postman:19 .. _install_mailjam: 20 20 21 Second, install Postman21 Second, install Mailjam 22 22 ----------------------- 23 23 … … 27 27 ++++++++++++++++++++ 28 28 29 You can install Postmanusing pip_::29 You can install Mailjam using pip_:: 30 30 31 pip install -e https://bitbucket.org/codigo23/ postman#egg=postman31 pip install -e https://bitbucket.org/codigo23/mailjam#egg=mailjam 32 32 33 33 .. note:: 34 34 35 Postmanhas not been recorded/uploaded to pypi_ yet, so, in order to install36 it using pip you will have to provide the URL for the public Postmanrepo.35 Mailjam has not been recorded/uploaded to pypi_ yet, so, in order to install 36 it using pip you will have to provide the URL for the public Mailjam repo. 37 37 38 38 .. _install_with_easy_install: … … 41 41 +++++++++++++++++++++++++++++ 42 42 43 You can not install Postmanusing easy_install_ yet (until we do record/upload43 You can not install Mailjam using easy_install_ yet (until we do record/upload 44 44 it to pypi) 45 45 … … 49 49 ++++++++++++++++++++++++++++++ 50 50 51 You can install Postmaninside a virtualenv_. Just create a virtualenv::51 You can install Mailjam inside a virtualenv_. Just create a virtualenv:: 52 52 53 53 virtualenv /path/to/your/env … … 64 64 source /path/to/your/env/bin/activate.csh 65 65 66 And, once the environment has been activated, use pip to install Postman::66 And, once the environment has been activated, use pip to install Mailjam:: 67 67 68 env$ pip install -e https://bitbucket.org/codigo23/ postman#egg=postman68 env$ pip install -e https://bitbucket.org/codigo23/mailjam#egg=mailjam 69 69 70 70 .. _install_from_sources: … … 89 89 *************** 90 90 91 The source code of Postmanis hosted in bitbucket_ [1]_. In order to grab91 The source code of Mailjam is hosted in bitbucket_ [1]_. In order to grab 92 92 the latest sources you need Mercurial_. 93 93 94 94 To get a copy of the sources, just *clone* the repository:: 95 95 96 hg clone https://bitbucket.org/codigo23/ postman postman-repo96 hg clone https://bitbucket.org/codigo23/mailjam mailjam-repo 97 97 98 Then, go inside the * postman-repo* directory and run::98 Then, go inside the *mailjam-repo* directory and run:: 99 99 100 100 python setup.py install … … 110 110 This process will work inside a virtualenv_ too. 111 111 112 .. _install_setting_up_ postman:112 .. _install_setting_up_mailjam: 113 113 114 Setting up Postman114 Setting up Mailjam 115 115 ------------------ 116 116 117 117 TBW 118 118 119 .. _install_running_ postman:119 .. _install_running_mailjam: 120 120 121 Running Postman121 Running Mailjam 122 122 --------------- 123 123 … … 140 140 .. _sudo: http://sudo.ws 141 141 142 .. [1] https://bitbucket.org/codigo23/ postman142 .. [1] https://bitbucket.org/codigo23/mailjam -
docs/src/overview.rst
r13 r16 1 Overview of postman's architecture1 Overview of mailjam's architecture 2 2 ================================== 3 3 … … 7 7 ------------ 8 8 9 Postmanhas been designed following a **multi-component structure**. There is9 Mailjam has been designed following a **multi-component structure**. There is 10 10 **a daemon** that manage the mailing lists and members information in a storage 11 11 backend and there are **different kinds of clients** (currently, three of them) … … 14 14 This is the scheme of the architecture: 15 15 16 .. image:: / postman_architecture.png17 :alt: Scheme of the architecture behind Postman16 .. image:: /mailjam_architecture.png 17 :alt: Scheme of the architecture behind Mailjam 18 18 :class: open_fancybox 19 19 20 20 21 .. _overview_ postman_daemon:21 .. _overview_mailjam_daemon: 22 22 23 Postmandaemon23 Mailjam daemon 24 24 -------------- 25 25 … … 32 32 to add/update/delete data from the backend. 33 33 34 .. _overview_ postman_mta_client:34 .. _overview_mailjam_mta_client: 35 35 36 36 MTA client … … 41 41 backend to tell the MTA what it has to do with the incoming emails. 42 42 43 .. _overview_ postman_cli_client:43 .. _overview_mailjam_cli_client: 44 44 45 45 CLI client … … 47 47 48 48 This is a shell-like interface that can be used to add mailing lists to a given 49 Postmanserver, edit such mailing lists information, add members, etc.49 Mailjam server, edit such mailing lists information, add members, etc. 50 50 51 .. _overview_ postman_web_client:51 .. _overview_mailjam_web_client: 52 52 53 53 Web client … … 56 56 This is a small *webapp* that can be used to perform the same management 57 57 operations you can achieve using the 58 :ref:`CLI client<overview_ postman_cli_client>`.58 :ref:`CLI client<overview_mailjam_cli_client>`. -
docs/src/running.rst
r13 r16 1 Running Postman1 Running Mailjam 2 2 =============== 3 3 -
mailjam/__init__.py
r4 r16 1 1 # -*- coding: utf-8 -*- 2 2 3 from m odels import Member, MailingList4 from storage import JsonStorage3 from mailjam.models import Member, MailingList 4 from mailjam.storage import JsonStorage -
mailjam/config.py
r15 r16 2 2 3 3 """ 4 The postmanproject - config.py4 The mailjam project - config.py 5 5 6 6 This file is released under the BSD license, see LICENSE for … … 17 17 def __init__(self, configfile=None): 18 18 self.configfile = configfile 19 self.default_paths = ['/usr/local/etc/ postman', '/usr/local/etc',20 '/etc/ postman', '/etc',19 self.default_paths = ['/usr/local/etc/mailjam', '/usr/local/etc', 20 '/etc/mailjam', '/etc', 21 21 os.path.join(os.path.dirname(__file__),'../conf')] 22 22 self.config = {} … … 28 28 of an attribute for easier subclassing 29 29 """ 30 return ' postman.conf'30 return 'mailjam.conf' 31 31 32 32 @property … … 87 87 @property 88 88 def default_filename(self): 89 return ' postman-mta.conf'89 return 'mailjam-mta.conf' 90 90 91 91 @property -
mailjam/daemon.py
r15 r16 4 4 from SimpleXMLRPCServer import SimpleXMLRPCServer, list_public_methods 5 5 6 from postmanimport config7 from postman.models import Member, MailingList8 from postman.storage import JsonStorage as Storage9 10 11 class Postman():6 from mailjam import config 7 from mailjam.models import Member, MailingList 8 from mailjam.storage import JsonStorage as Storage 9 10 11 class Mailjam(): 12 12 13 13 def __init__(self, configfile=None): … … 33 33 if self.mailings: 34 34 # Save the config file from where we can reload information about 35 # the mailing lists managed by this postmaninstance35 # the mailing lists managed by this mailjam instance 36 36 self.dbs['mailings'].write(self.mailings_addresses) 37 37 # Save each mailing list data into its separated persistence file … … 64 64 Delete all stored data from disk (useful for testing). 65 65 DANGER: Calling this method will remove all data from disk, leaving the 66 postman instance with no persistence data, if the postmanprocess die,66 mailjam instance with no persistence data, if the mailjam process die, 67 67 before another .save() call is made, all data will be lost. 68 68 """ … … 76 76 def add_mailing_list(self, info={}): 77 77 """ 78 Add a new mailing list to this postmaninstance. expects one parameter,78 Add a new mailing list to this mailjam instance. expects one parameter, 79 79 info, which is a dictionary that should contain, at least, the 80 80 following keys: … … 96 96 if info['address'] in self.mailings_addresses: 97 97 raise IndexError(info['address'], 98 ' has been already added to postman')98 ' has been already added to mailjam') 99 99 100 100 mailing = MailingList(info['name'], info['address'], … … 109 109 """ 110 110 Add a new member for the mailing list represented by list_addr (a string 111 containing the email address of any mailing list managed by this postman111 containing the email address of any mailing list managed by this mailjam 112 112 instance). member_addr is a string representing the email address of the 113 113 new member … … 130 130 131 131 132 class PostmanXMLRPC():132 class MailjamXMLRPC(): 133 133 """ 134 134 This class is a wrapper we will use to limit the methods that will be … … 159 159 class MailingListXMLRPC(): 160 160 def __init__(self): 161 self. postman = Postman()162 self. postman.load()161 self.mailjam = Mailjam() 162 self.mailjam.load() 163 163 def add(self, info={}): 164 self. postman.add_mailing_list(info)164 self.mailjam.add_mailing_list(info) 165 165 def addresses(self): 166 return self. postman.mailings_addresses166 return self.mailjam.mailings_addresses 167 167 168 168 169 169 class MemberXMLRPC(): 170 170 def __init__(self): 171 self. postman = Postman()172 self. postman.load()171 self.mailjam = Mailjam() 172 self.mailjam.load() 173 173 def add(self, member_addr=None, list_addr=None): 174 self. postman.add_mailing_member(member_addr, list_addr)174 self.mailjam.add_mailing_member(member_addr, list_addr) 175 175 def list(self, mailing): 176 if mailing in self. postman.mailings_addresses:177 return self. postman.mailings[mailing].members_addresses()178 179 180 class PostmanDaemon():176 if mailing in self.mailjam.mailings_addresses: 177 return self.mailjam.mailings[mailing].members_addresses() 178 179 180 class MailjamDaemon(): 181 181 def __init__(self, configfile=None): 182 182 self.config = config.get_config_parameters('xmlrpc_server', configfile) … … 211 211 """ 212 212 Check if there is an initialized server (initialize it if there is none) 213 and then register all the Postmanpublic methods to be served through213 and then register all the Mailjam public methods to be served through 214 214 the xml-rpc link 215 215 … … 221 221 msg = 'Registering public methods' 222 222 logging.info(msg) 223 root = PostmanXMLRPC()223 root = MailjamXMLRPC() 224 224 root.lists = MailingListXMLRPC() 225 225 root.members = MemberXMLRPC() -
mailjam/models.py
r11 r16 2 2 3 3 """ 4 The postmanproject - models.py4 The mailjam project - models.py 5 5 6 6 This file is released under the BSD license, see LICENSE for … … 109 109 def info(self): 110 110 """ 111 Returns a dict we can use to add this mailing list to a postman111 Returns a dict we can use to add this mailing list to a mailjam 112 112 instance 113 113 """ -
mailjam/mta.py
r15 r16 2 2 3 3 """ 4 The postmanproject - mta.py4 The mailjam project - mta.py 5 5 6 6 This file is released under the BSD license, see LICENSE for … … 13 13 import os, sys, email, smtplib, xmlrpclib 14 14 from datetime import datetime 15 from postman.models import MailingList16 from postman.config import MTAClientConfig17 from postman.tools import validate_email_address15 from mailjam.models import MailingList 16 from mailjam.config import MTAClientConfig 17 from mailjam.tools import validate_email_address 18 18 19 19 class MTAClient(): -
mailjam/storage.py
r11 r16 2 2 3 3 """ 4 The postmanproject - storage.py4 The mailjam project - storage.py 5 5 6 6 This file is released under the BSD license, see LICENSE for -
mailjam/tests/__init__.py
r15 r16 2 2 3 3 """ 4 The postmanproject - tests module4 The mailjam project - tests module 5 5 6 6 This file is released under the BSD license, see LICENSE for -
mailjam/tests/daemon.py
r11 r16 2 2 3 3 """ 4 The postmanproject - daemon.py4 The mailjam project - daemon.py 5 5 6 6 This file is released under the BSD license, see LICENSE for … … 15 15 from unittest import TestCase 16 16 17 from postman.daemon import Postman, PostmanXMLRPC, PostmanDaemon18 from postman.models import Member, MailingList19 from postman.storage import JsonStorage as Storage20 21 22 class Test Postman(TestCase):23 """ 24 postman.daemon.Postmantests.25 26 Remember to call the .clear() method of postmanafter each test, so17 from mailjam.daemon import Mailjam, MailjamXMLRPC, MailjamDaemon 18 from mailjam.models import Member, MailingList 19 from mailjam.storage import JsonStorage as Storage 20 21 22 class TestMailjam(TestCase): 23 """ 24 mailjam.daemon.Mailjam tests. 25 26 Remember to call the .clear() method of mailjam after each test, so 27 27 the temp storage files are deleted 28 28 """ 29 29 def setUp(self): 30 self.configfile = os.path.join(os.path.dirname(__file__), ' postman.conf')30 self.configfile = os.path.join(os.path.dirname(__file__), 'mailjam.conf') 31 31 self.mailing_list = MailingList('test_list', 'test_list@example.com', 32 32 members={}, configfile=self.configfile) … … 34 34 35 35 def test___init__(self): 36 postman = Postman(configfile=self.configfile)37 self.assertIsInstance( postman, Postman)38 self.assertEqual( postman.mailings, {})39 self.assertEqual( postman.mailings_addresses, [])40 self.assertIsInstance( postman.dbs, dict)41 self.assertTrue('mailings' in postman.dbs.keys())42 self.assertTrue('members' in postman.dbs.keys())43 self.assertIsInstance( postman.dbs['mailings'], Storage)44 self.assertIsInstance( postman.dbs['members'], Storage)36 mailjam = Mailjam(configfile=self.configfile) 37 self.assertIsInstance(mailjam, Mailjam) 38 self.assertEqual(mailjam.mailings, {}) 39 self.assertEqual(mailjam.mailings_addresses, []) 40 self.assertIsInstance(mailjam.dbs, dict) 41 self.assertTrue('mailings' in mailjam.dbs.keys()) 42 self.assertTrue('members' in mailjam.dbs.keys()) 43 self.assertIsInstance(mailjam.dbs['mailings'], Storage) 44 self.assertIsInstance(mailjam.dbs['members'], Storage) 45 45 46 46 def test_save(self): 47 postman = Postman(configfile=self.configfile)48 self.assertFalse( postman.save())49 postman.add_mailing_list(self.mailing_list.info())50 self.assertTrue( postman.save())47 mailjam = Mailjam(configfile=self.configfile) 48 self.assertFalse(mailjam.save()) 49 mailjam.add_mailing_list(self.mailing_list.info()) 50 self.assertTrue(mailjam.save()) 51 51 # FIXME: We have to test here that the generated json file 52 52 # contains the data it should contain 53 53 54 54 # Clear the files created by the tests 55 postman.clear()55 mailjam.clear() 56 56 57 57 def test_load(self): 58 postman = Postman(configfile=self.configfile)59 self.assertFalse( postman.mailings)60 self.assertFalse( postman.mailings_addresses)61 self.assertFalse( postman.load())62 postman.add_mailing_list(self.mailing_list.info())63 self.assertTrue( postman.load())64 65 # Check that another postmaninstance is able to load the saved data66 postman_load = Postman(configfile=self.configfile)67 self.assertFalse( postman_load.mailings)68 self.assertFalse( postman_load.mailings_addresses)69 postman_load.load()70 self.assertTrue( postman_load.mailings)71 self.assertIsInstance( postman_load.mailings, dict)72 self.assertTrue( postman_load.mailings_addresses)73 self.assertIsInstance( postman_load.mailings_addresses, list)74 75 # Clear the files created by the tests 76 postman.clear()58 mailjam = Mailjam(configfile=self.configfile) 59 self.assertFalse(mailjam.mailings) 60 self.assertFalse(mailjam.mailings_addresses) 61 self.assertFalse(mailjam.load()) 62 mailjam.add_mailing_list(self.mailing_list.info()) 63 self.assertTrue(mailjam.load()) 64 65 # Check that another mailjam instance is able to load the saved data 66 mailjam_load = Mailjam(configfile=self.configfile) 67 self.assertFalse(mailjam_load.mailings) 68 self.assertFalse(mailjam_load.mailings_addresses) 69 mailjam_load.load() 70 self.assertTrue(mailjam_load.mailings) 71 self.assertIsInstance(mailjam_load.mailings, dict) 72 self.assertTrue(mailjam_load.mailings_addresses) 73 self.assertIsInstance(mailjam_load.mailings_addresses, list) 74 75 # Clear the files created by the tests 76 mailjam.clear() 77 77 78 78 def test_clear(self): 79 postman = Postman(configfile=self.configfile)80 self.assertFalse( postman.clear())81 postman.add_mailing_list(self.mailing_list.info())82 self.assertTrue( postman.clear())79 mailjam = Mailjam(configfile=self.configfile) 80 self.assertFalse(mailjam.clear()) 81 mailjam.add_mailing_list(self.mailing_list.info()) 82 self.assertTrue(mailjam.clear()) 83 83 84 84 def test_add_mailing_list(self): 85 postman = Postman(configfile=self.configfile)85 mailjam = Mailjam(configfile=self.configfile) 86 86 with self.assertRaises(TypeError): 87 87 # test improper info values 88 postman.add_mailing_list(['a list', 'is an', 'invalid parameter'])89 postman.add_mailing_list(self.mailing_list)88 mailjam.add_mailing_list(['a list', 'is an', 'invalid parameter']) 89 mailjam.add_mailing_list(self.mailing_list) 90 90 with self.assertRaises(ValueError): 91 91 #test incomplete/missing info values 92 postman.add_mailing_list()93 postman.add_mailing_list({'name': 'missing info'})94 postman.add_mailing_list({'address': 'missing info'})95 postman.add_mailing_list({'name': 'missing info',92 mailjam.add_mailing_list() 93 mailjam.add_mailing_list({'name': 'missing info'}) 94 mailjam.add_mailing_list({'address': 'missing info'}) 95 mailjam.add_mailing_list({'name': 'missing info', 96 96 'address': 'missing info'}) 97 97 # test mailing lists can be added 98 self.assertTrue( postman.add_mailing_list(self.mailing_list.info()))99 self.assertTrue( postman.mailings)100 self.assertIsInstance( postman.mailings, dict)101 self.assertTrue( postman.mailings_addresses)102 self.assertIsInstance( postman.mailings_addresses, list)98 self.assertTrue(mailjam.add_mailing_list(self.mailing_list.info())) 99 self.assertTrue(mailjam.mailings) 100 self.assertIsInstance(mailjam.mailings, dict) 101 self.assertTrue(mailjam.mailings_addresses) 102 self.assertIsInstance(mailjam.mailings_addresses, list) 103 103 with self.assertRaises(IndexError): 104 104 # test what happens when the mailing has been already added 105 postman.add_mailing_list(self.mailing_list.info())106 107 # Clear the files created by the tests 108 postman.clear()105 mailjam.add_mailing_list(self.mailing_list.info()) 106 107 # Clear the files created by the tests 108 mailjam.clear() 109 109 110 110 def test_add_mailing_member(self): 111 postman = Postman(configfile=self.configfile)112 postman.add_mailing_list(self.mailing_list.info())111 mailjam = Mailjam(configfile=self.configfile) 112 mailjam.add_mailing_list(self.mailing_list.info()) 113 113 with self.assertRaises(ValueError): 114 114 # test what happens if we call the method without proper 115 115 # parameters 116 postman.add_mailing_member()117 postman.add_mailing_member(None, None)118 postman.add_mailing_member(None, 'test_list@example.net')119 postman.add_mailing_member('test@example.net', None)120 postman.add_mailing_member('test@example', 'test_list@example.net')116 mailjam.add_mailing_member() 117 mailjam.add_mailing_member(None, None) 118 mailjam.add_mailing_member(None, 'test_list@example.net') 119 mailjam.add_mailing_member('test@example.net', None) 120 mailjam.add_mailing_member('test@example', 'test_list@example.net') 121 121 with self.assertRaises(IndexError): 122 122 # test if we try to add a member to a non-existing mailing list 123 postman.add_mailing_member('test@example.net',123 mailjam.add_mailing_member('test@example.net', 124 124 'test_list_b@example.net') 125 125 # Test adding a member 126 self.assertTrue( postman.add_mailing_member('test@example.net',126 self.assertTrue(mailjam.add_mailing_member('test@example.net', 127 127 self.mailing_list.address)) 128 128 # Test trying to re-add that user 129 self.assertFalse( postman.add_mailing_member('test@example.net',129 self.assertFalse(mailjam.add_mailing_member('test@example.net', 130 130 self.mailing_list.address)) 131 131 132 132 # Clear the files created by the tests 133 postman.clear()134 135 136 class Test PostmanDaemon(TestCase):137 """ 138 postman.daemon.PostmanDaemon tests.139 140 Remember to call the .clear() method of postmanafter each test, so133 mailjam.clear() 134 135 136 class TestMailjamDaemon(TestCase): 137 """ 138 mailjam.daemon.MailjamDaemon tests. 139 140 Remember to call the .clear() method of mailjam after each test, so 141 141 the temp storage files are deleted 142 142 """ 143 143 def setUp(self): 144 144 self.configfile = os.path.join(os.path.dirname(__file__), 145 ' postman.conf')145 'mailjam.conf') 146 146 self.mailing_list = MailingList('test_xmlrpc', 147 147 'test_xmlrpc@example.com', members={}, … … 150 150 151 151 def test___init__(self): 152 daemon = PostmanDaemon(self.configfile)153 self.assertIsInstance(daemon, PostmanDaemon)152 daemon = MailjamDaemon(self.configfile) 153 self.assertIsInstance(daemon, MailjamDaemon) 154 154 self.assertFalse(daemon.ready_to_serve) 155 155 # FIXME: More tests should be added here once the configuration … … 157 157 158 158 def test_create_server(self): 159 daemon = PostmanDaemon(self.configfile)159 daemon = MailjamDaemon(self.configfile) 160 160 daemon.port = 9001 161 161 self.assertTrue(daemon.create_server()) … … 164 164 165 165 def test_add_methods(self): 166 daemon = PostmanDaemon(self.configfile)166 daemon = MailjamDaemon(self.configfile) 167 167 daemon.port = 9002 168 168 self.assertTrue(daemon.add_methods()) 169 169 self.assertTrue(daemon.ready_to_serve) 170 170 171 daemon = PostmanDaemon(self.configfile)171 daemon = MailjamDaemon(self.configfile) 172 172 daemon.port = 9003 173 173 daemon.create_server() … … 176 176 177 177 def test_run(self): 178 daemon = PostmanDaemon(self.configfile)178 daemon = MailjamDaemon(self.configfile) 179 179 daemon.port = 9004 180 180 # start the daemon in another process, so we can start communicating … … 193 193 # available public methods contains the list of methods we have 194 194 # defined in our base XMLRPC class 195 set_class_methods = set( PostmanXMLRPC()._listMethods())195 set_class_methods = set(MailjamXMLRPC()._listMethods()) 196 196 set_xmlrpc_methods = set(client.system.listMethods()) 197 197 self.assertTrue(set_class_methods.issubset(set_xmlrpc_methods)) -
mailjam/tests/mailjam-mta.conf
r15 r16 1 1 # 2 # postman-mta.conf - PostmanMTA client configuration file2 # mailjam-mta.conf - Mailjam MTA client configuration file 3 3 # 4 4 … … 11 11 [archive] 12 12 persistent = true 13 path = /tmp/ postman-tests/mta/archive13 path = /tmp/mailjam-tests/mta/archive -
mailjam/tests/mailjam.conf
r13 r16 1 1 # 2 # postman.conf - Postmanconfiguration file2 # mailjam.conf - Mailjam configuration file 3 3 # 4 4 # IMPORTANT: This config file should be used only … … 9 9 port = 9876 10 10 ssl = false 11 ssl_key = /usr/local/etc/ postman/ssl/postman.key12 ssl_crt = /usr/local/etc/ postman/ssl/postman.crt13 logfile = /tmp/ postman-tests/xmlrpc_server.log11 ssl_key = /usr/local/etc/mailjam/ssl/mailjam.key 12 ssl_crt = /usr/local/etc/mailjam/ssl/mailjam.crt 13 logfile = /tmp/mailjam-tests/xmlrpc_server.log 14 14 15 15 [storage] 16 16 backend = json 17 path = /tmp/ postman-tests/storage17 path = /tmp/mailjam-tests/storage 18 18 lists_db = %(path)s/mailings.%(backend)s 19 19 members_db = %(path)s/members.%(backend)s … … 22 22 enabled = true 23 23 backend = json 24 path = /tmp/ postman-tests/archives24 path = /tmp/mailjam-tests/archives 25 25 26 26 [mailing_lists] -
mailjam/tests/models.py
r10 r16 3 3 import os 4 4 from unittest import TestCase 5 from postman.models import Member, MailingList5 from mailjam.models import Member, MailingList 6 6 7 7 … … 19 19 class TestMailingList(TestCase): 20 20 def setUp(self): 21 configfile = os.path.join(os.path.dirname(__file__), ' postman.conf')21 configfile = os.path.join(os.path.dirname(__file__), 'mailjam.conf') 22 22 self.mailing_list = MailingList('test_list', 'test_list@example.com', 23 23 members={}, configfile=configfile) -
mailjam/tests/mta.py
r15 r16 3 3 import os, sys, multiprocessing, time 4 4 from unittest import TestCase 5 from postman.mta import MTAClient6 from postman.daemon import PostmanDaemon7 from postman.models import Member, MailingList5 from mailjam.mta import MTAClient 6 from mailjam.daemon import MailjamDaemon 7 from mailjam.models import Member, MailingList 8 8 9 9 … … 11 11 """ 12 12 FIXME: These are dummy tests, they cover almost nothing from the 13 real postmanmta client (yet)13 real mailjam mta client (yet) 14 14 """ 15 15 def setUp(self): 16 16 self.mta_configfile = os.path.join(os.path.dirname(__file__), 17 ' postman-mta.conf')17 'mailjam-mta.conf') 18 18 self.configfile = os.path.join(os.path.dirname(__file__), 19 ' postman.conf')19 'mailjam.conf') 20 20 self.mailing_list = MailingList('test_list', 'test_list@example.com', 21 21 members={}, configfile=self.configfile) … … 28 28 29 29 def test___init__(self): 30 # in order to start mta client instances, we need to have a postman30 # in order to start mta client instances, we need to have a mailjam 31 31 # daemon running on the background 32 32 # This should be added to the setUp() method, but then it would be 33 33 # more difficult to terminate the process after all the methods 34 34 # were called 35 daemon = PostmanDaemon(self.configfile)35 daemon = MailjamDaemon(self.configfile) 36 36 daemon.port = 9100 37 37 p = multiprocessing.Process(target=daemon.run) … … 54 54 55 55 def test_get_raw_email(self): 56 # in order to start mta client instances, we need to have a postman56 # in order to start mta client instances, we need to have a mailjam 57 57 # daemon running on the background 58 58 # This should be added to the setUp() method, but then it would be 59 59 # more difficult to terminate the process after all the methods 60 60 # were called 61 daemon = PostmanDaemon(self.configfile)61 daemon = MailjamDaemon(self.configfile) 62 62 daemon.port = 9100 63 63 p = multiprocessing.Process(target=daemon.run) … … 88 88 # sys_stdin = sys.stdin 89 89 # sys.stdin = open(self.raw_email_file, 'r') 90 # self.mta.save_raw_email.filename = '/tmp/ postman-test-mta-save-raw-email'90 # self.mta.save_raw_email.filename = '/tmp/mailjam-test-mta-save-raw-email' 91 91 92 92 -
mailjam/tools.py
r11 r16 2 2 3 3 """ 4 The postmanproject - tools.py4 The mailjam project - tools.py 5 5 6 6 This file is released under the BSD license, see LICENSE for -
setup.py
r15 r16 14 14 15 15 setup( 16 name=' postman',16 name='mailjam', 17 17 version='0.1.0', 18 18 author='Francisco de Borja Lopez Rio', 19 19 author_email='borja@codigo23.net', 20 packages=[' postman'],21 url='https://bitbucket.org/codigo23/ postman',20 packages=['mailjam'], 21 url='https://bitbucket.org/codigo23/mailjam', 22 22 license='BSD licence, see LICENCE', 23 23 description='Mailing lists management software', 24 24 long_description=open('README').read(), 25 scripts=['bin/ postman-server', 'bin/postman-mta'],26 #data_files=[(proper_etc_path()+' postman', ['conf/postman.conf',27 # 'conf/ postman-mta.conf']),25 scripts=['bin/mailjam-server', 'bin/mailjam-mta'], 26 #data_files=[(proper_etc_path()+'mailjam', ['conf/mailjam.conf', 27 # 'conf/mailjam-mta.conf']), 28 28 # ] 29 29 )
Note:
See TracChangeset
for help on using the changeset viewer.