Changeset 16:cd4170142d87 in mailjam for docs


Ignore:
Timestamp:
May 22, 2012, 9:31:15 AM (12 years ago)
Author:
Borja Lopez <borja@…>
Branch:
default
Phase:
public
Message:

Renamed the project to Mailjam

Location:
docs/src
Files:
1 added
29 edited
1 moved

Legend:

Unmodified
Added
Removed

  • docs/src/_build/html/.buildinfo

    r13 r16  
    11# Sphinx build info version 1
    22# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
    3 config: d6b13f3c5a0c2b1ecbf54831463e3bec
     3config: ceb77347f0c7a864ec9030a8b3dabfdc
    44tags: fbb0d17656682115ca4d033fb2f83ba1

  • docs/src/_build/html/_sources/configuration.txt

    r13 r16  
    66.. _configuration_daemon:
    77
    8 Postman daemon configuration file
     8Mailjam daemon configuration file
    99---------------------------------
    1010
    11 All the configurations that can be applied to the Postman daemon are registered
    12 in the **postman.conf** file. That file contains ini-style [1]_ configuration
     11All the configurations that can be applied to the Mailjam daemon are registered
     12in the **mailjam.conf** file. That file contains ini-style [1]_ configuration
    1313parameters, separated in different *categories*.
    1414
    1515.. note::
    1616
    17    The postman.conf file will be installed in different locations depending on
     17   The mailjam.conf file will be installed in different locations depending on
    1818   your setup. The usual locations are:
    1919
    20    - */etc/postman.conf* - In most Linux systems (like archlinux, gentoo,
     20   - */etc/mailjam.conf* - In most Linux systems (like archlinux, gentoo,
    2121     fedora, debian, ubuntu, etc)
    2222
    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,
    2424     NetBSD, etc)
    2525
    … …  
    7373*******
    7474
    75 Default: ``/usr/local/etc/postman/ssl/postman.key``
     75Default: ``/usr/local/etc/mailjam/ssl/mailjam.key``
    7676
    7777Path to the ssl key used for encrypted SSL sessions.
    … …  
    8686*******
    8787
    88 Default: ``/usr/local/etc/postman/ssl/postman.crt``
     88Default: ``/usr/local/etc/mailjam/ssl/mailjam.crt``
    8989
    9090Path to the ssl certificate used for encrypted SSL sessions.
    … …  
    9999*******
    100100
    101 Default: ``/var/log/postman/xmlrpc_server.log``
     101Default: ``/var/log/mailjam/xmlrpc_server.log``
    102102
    103103Path to the file where log messages will be saved
    … …  
    128128****
    129129
    130 Default: ``/usr/local/postman/storage``
     130Default: ``/usr/local/mailjam/storage``
    131131
    132132Path to the directory where the backend will save data.
    … …  
    137137********
    138138
    139 Default: ``/usr/local/postman/storage/mailings.json``
     139Default: ``/usr/local/mailjam/storage/mailings.json``
    140140
    141141Path to the file where the identifiers of existing mailing lists will be saved.
    … …  
    165165**********
    166166
    167 Default: ``/usr/local/postman/storage/members.json``
     167Default: ``/usr/local/mailjam/storage/members.json``
    168168
    169169Path to the file where the identifiers of existing members will be saved.
    … …  
    191191Default: ``true``
    192192
    193 Enables/disables the *archives* feature. When enabled, Postman saves copies of
     193Enables/disables the *archives* feature. When enabled, Mailjam saves copies of
    194194email address into an *archive*, so they can be read later, through a web
    195195interface.
    … …  
    220220****
    221221
    222 Default: ``/usr/local/postman/archives``
     222Default: ``/usr/local/mailjam/archives``
    223223
    224224Path to the directory where the archives will be saved.
    … …  
    238238.. warning::
    239239
    240    This parameters are not currently used in postman, we are still working
     240   This parameters are not currently used in mailjam, we are still working
    241241   on per-mailing-list configuration parameters.
    242242
    … …  
    265265.. warning::
    266266
    267    This parameters are not currently used in postman, we are still working
     267   This parameters are not currently used in mailjam, we are still working
    268268   on per-member configuration parameters.
    269269

  • docs/src/_build/html/_sources/index.txt

    r13 r16  
    1 Postman official documentation
     1Mailjam official documentation
    22==============================
    33
    4 This is the official documentation for Postman_, a mailing list management
     4This is the official documentation for Mailjam_, a mailing list management
    55software written in Python_.
    66
    … …  
    2525* :ref:`search`
    2626
    27 .. _Postman: https://bitbucket.org/codigo23/postman
     27.. _Mailjam: https://bitbucket.org/codigo23/mailjam
    2828.. _Python: http://python.org

  • docs/src/_build/html/_sources/install.txt

    r13 r16  
    99---------------------------
    1010
    11 So far, the only dependency you will need in order to run postman is Python_
     11So far, the only dependency you will need in order to run mailjam is Python_
    1212
    13 Postman has been tested with python *2.7.x*, but it should work with versions
     13Mailjam has been tested with python *2.7.x*, but it should work with versions
    1414*2.6.x* too.
    1515
    … …  
    1717more about how to install python.
    1818
    19 .. _install_postman:
     19.. _install_mailjam:
    2020
    21 Second, install Postman
     21Second, install Mailjam
    2222-----------------------
    2323
    … …  
    2727++++++++++++++++++++
    2828
    29 You can install Postman using pip_::
     29You can install Mailjam using pip_::
    3030
    31   pip install -e https://bitbucket.org/codigo23/postman#egg=postman
     31  pip install -e https://bitbucket.org/codigo23/mailjam#egg=mailjam
    3232
    3333.. note::
    3434
    35    Postman 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 Postman repo.
     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.
    3737
    3838.. _install_with_easy_install:
    … …  
    4141+++++++++++++++++++++++++++++
    4242
    43 You can not install Postman using easy_install_ yet (until we do record/upload
     43You can not install Mailjam using easy_install_ yet (until we do record/upload
    4444it to pypi)
    4545
    … …  
    4949++++++++++++++++++++++++++++++
    5050
    51 You can install Postman inside a virtualenv_. Just create a virtualenv::
     51You can install Mailjam inside a virtualenv_. Just create a virtualenv::
    5252
    5353  virtualenv /path/to/your/env
    … …  
    6464     source /path/to/your/env/bin/activate.csh
    6565
    66 And, once the environment has been activated, use pip to install Postman::
     66And, once the environment has been activated, use pip to install Mailjam::
    6767
    68   env$ pip install -e https://bitbucket.org/codigo23/postman#egg=postman
     68  env$ pip install -e https://bitbucket.org/codigo23/mailjam#egg=mailjam
    6969
    7070.. _install_from_sources:
    … …  
    8989***************
    9090
    91 The source code of Postman is hosted in bitbucket_ [1]_. In order to grab
     91The source code of Mailjam is hosted in bitbucket_ [1]_. In order to grab
    9292the latest sources you need Mercurial_.
    9393
    9494To get a copy of the sources, just *clone* the repository::
    9595
    96   hg clone https://bitbucket.org/codigo23/postman postman-repo
     96  hg clone https://bitbucket.org/codigo23/mailjam mailjam-repo
    9797
    98 Then, go inside the *postman-repo* directory and run::
     98Then, go inside the *mailjam-repo* directory and run::
    9999
    100100  python setup.py install
    … …  
    110110   This process will work inside a virtualenv_ too.
    111111
    112 .. _install_setting_up_postman:
     112.. _install_setting_up_mailjam:
    113113
    114 Setting up Postman
     114Setting up Mailjam
    115115------------------
    116116
    117117TBW
    118118
    119 .. _install_running_postman:
     119.. _install_running_mailjam:
    120120
    121 Running Postman
     121Running Mailjam
    122122---------------
    123123
    … …  
    140140.. _sudo: http://sudo.ws
    141141
    142 .. [1] https://bitbucket.org/codigo23/postman
     142.. [1] https://bitbucket.org/codigo23/mailjam

  • docs/src/_build/html/_sources/overview.txt

    r13 r16  
    1 Overview of postman's architecture
     1Overview of mailjam's architecture
    22==================================
    33
    … …  
    77------------
    88
    9 Postman has been designed following a **multi-component structure**. There is
     9Mailjam has been designed following a **multi-component structure**. There is
    1010**a daemon** that manage the mailing lists and members information in a storage
    1111backend and there are **different kinds of clients** (currently, three of them)
    … …  
    1414This is the scheme of the architecture:
    1515
    16 .. image:: /postman_architecture.png
    17    :alt: Scheme of the architecture behind Postman
     16.. image:: /mailjam_architecture.png
     17   :alt: Scheme of the architecture behind Mailjam
    1818   :class: open_fancybox
    1919
    2020
    21 .. _overview_postman_daemon:
     21.. _overview_mailjam_daemon:
    2222
    23 Postman daemon
     23Mailjam daemon
    2424--------------
    2525
    … …  
    3232to add/update/delete data from the backend.
    3333
    34 .. _overview_postman_mta_client:
     34.. _overview_mailjam_mta_client:
    3535
    3636MTA client
    … …  
    4141backend to tell the MTA what it has to do with the incoming emails.
    4242
    43 .. _overview_postman_cli_client:
     43.. _overview_mailjam_cli_client:
    4444
    4545CLI client
    … …  
    4747
    4848This is a shell-like interface that can be used to add mailing lists to a given
    49 Postman server, edit such mailing lists information, add members, etc.
     49Mailjam server, edit such mailing lists information, add members, etc.
    5050
    51 .. _overview_postman_web_client:
     51.. _overview_mailjam_web_client:
    5252
    5353Web client
    … …  
    5656This is a small *webapp* that can be used to perform the same management
    5757operations 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 Postman
     1Running Mailjam
    22===============
    33

  • docs/src/_build/html/configuration.html

    r13 r16  
    99    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    1010   
    11     <title>Configuration &mdash; Postman 0.1.0 documentation</title>
     11    <title>Configuration &mdash; Mailjam 0.1.0 documentation</title>
    1212   
    1313    <link rel="stylesheet" href="_static/default.css" type="text/css" />
    … …  
    2626    <script type="text/javascript" src="_static/underscore.js"></script>
    2727    <script type="text/javascript" src="_static/doctools.js"></script>
    28     <link rel="top" title="Postman 0.1.0 documentation" href="index.html" />
    29     <link rel="next" title="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" />
    3030    <link rel="prev" title="Installation instructions" href="install.html" />
    3131  </head>
    … …  
    3838             accesskey="I">index</a></li>
    3939        <li class="right" >
    40           <a href="running.html" title="Running Postman"
     40          <a href="running.html" title="Running Mailjam"
    4141             accesskey="N">next</a> |</li>
    4242        <li class="right" >
    4343          <a href="install.html" title="Installation instructions"
    4444             accesskey="P">previous</a> |</li>
    45         <li><a href="index.html">Postman 0.1.0 documentation</a> &raquo;</li>
     45        <li><a href="index.html">Mailjam 0.1.0 documentation</a> &raquo;</li>
    4646      </ul>
    4747    </div> 
    … …  
    5858<ul class="simple">
    5959<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">Postman daemon configuration file</a><ul>
     60<li><a class="reference internal" href="#mailjam-daemon-configuration-file" id="id10">Mailjam daemon configuration file</a><ul>
    6161<li><a class="reference internal" href="#xmlrpc-server" id="id11">xmlrpc_server</a><ul>
    6262<li><a class="reference internal" href="#address" id="id12">address</a></li>
    … …  
    9696</ul>
    9797</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 Postman daemon are registered
    101 in the <strong>postman.conf</strong> file. That file contains ini-style <a class="footnote-reference" href="#id6" id="id1">[1]</a> configuration
     98<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
     101in the <strong>mailjam.conf</strong> file. That file contains ini-style <a class="footnote-reference" href="#id6" id="id1">[1]</a> configuration
    102102parameters, separated in different <em>categories</em>.</p>
    103103<div class="admonition note">
    104104<p class="first admonition-title">Note</p>
    105 <p>The postman.conf file will be installed in different locations depending on
     105<p>The mailjam.conf file will be installed in different locations depending on
    106106your setup. The usual locations are:</p>
    107107<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,
    109109fedora, 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,
    111111NetBSD, etc)</li>
    112112</ul>
    … …  
    140140<div class="section" id="ssl-key">
    141141<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>
    143143<p>Path to the ssl key used for encrypted SSL sessions.</p>
    144144<div class="admonition warning">
    … …  
    149149<div class="section" id="ssl-crt">
    150150<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>
    152152<p>Path to the ssl certificate used for encrypted SSL sessions.</p>
    153153<div class="admonition warning">
    … …  
    158158<div class="section" id="logfile">
    159159<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>
    161161<p>Path to the file where log messages will be saved</p>
    162162</div>
    … …  
    175175<div class="section" id="path">
    176176<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>
    178178<p>Path to the directory where the backend will save data.</p>
    179179</div>
    180180<div class="section" id="lists-db">
    181181<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>
    183183<p>Path to the file where the identifiers of existing mailing lists will be saved.</p>
    184184<div class="admonition note">
    … …  
    201201<div class="section" id="members-db">
    202202<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>
    204204<p>Path to the file where the identifiers of existing members will be saved.</p>
    205205<div class="admonition note">
    … …  
    218218<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>
    219219<p>Default: <tt class="docutils literal"><span class="pre">true</span></tt></p>
    220 <p>Enables/disables the <em>archives</em> feature. When enabled, Postman saves copies of
     220<p>Enables/disables the <em>archives</em> feature. When enabled, Mailjam saves copies of
    221221email address into an <em>archive</em>, so they can be read later, through a web
    222222interface.</p>
    … …  
    239239<div class="section" id="configuration-daemon-archive-path">
    240240<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>
    242242<p>Path to the directory where the archives will be saved.</p>
    243243<div class="admonition warning">
    … …  
    253253<div class="admonition warning">
    254254<p class="first admonition-title">Warning</p>
    255 <p class="last">This parameters are not currently used in postman, we are still working
     255<p class="last">This parameters are not currently used in mailjam, we are still working
    256256on per-mailing-list configuration parameters.</p>
    257257</div>
    … …  
    271271<div class="admonition warning">
    272272<p class="first admonition-title">Warning</p>
    273 <p class="last">This parameters are not currently used in postman, we are still working
     273<p class="last">This parameters are not currently used in mailjam, we are still working
    274274on per-member configuration parameters.</p>
    275275</div>
    … …  
    322322  <ul>
    323323<li><a class="reference internal" href="#">Configuration</a><ul>
    324 <li><a class="reference internal" href="#postman-daemon-configuration-file">Postman daemon configuration file</a><ul>
     324<li><a class="reference internal" href="#mailjam-daemon-configuration-file">Mailjam daemon configuration file</a><ul>
    325325<li><a class="reference internal" href="#xmlrpc-server">xmlrpc_server</a><ul>
    326326<li><a class="reference internal" href="#address">address</a></li>
    … …  
    365365  <h4>Next topic</h4>
    366366  <p class="topless"><a href="running.html"
    367                         title="next chapter">Running Postman</a></p>
     367                        title="next chapter">Running Mailjam</a></p>
    368368  <h3>This Page</h3>
    369369  <ul class="this-page-menu">
    … …  
    395395             >index</a></li>
    396396        <li class="right" >
    397           <a href="running.html" title="Running Postman"
     397          <a href="running.html" title="Running Mailjam"
    398398             >next</a> |</li>
    399399        <li class="right" >
    400400          <a href="install.html" title="Installation instructions"
    401401             >previous</a> |</li>
    402         <li><a href="index.html">Postman 0.1.0 documentation</a> &raquo;</li>
     402        <li><a href="index.html">Mailjam 0.1.0 documentation</a> &raquo;</li>
    403403      </ul>
    404404    </div>

  • docs/src/_build/html/development.html

    r13 r16  
    99    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    1010   
    11     <title>Developers documentation &mdash; Postman 0.1.0 documentation</title>
     11    <title>Developers documentation &mdash; Mailjam 0.1.0 documentation</title>
    1212   
    1313    <link rel="stylesheet" href="_static/default.css" type="text/css" />
    … …  
    2626    <script type="text/javascript" src="_static/underscore.js"></script>
    2727    <script type="text/javascript" src="_static/doctools.js"></script>
    28     <link rel="top" title="Postman 0.1.0 documentation" href="index.html" />
     28    <link rel="top" title="Mailjam 0.1.0 documentation" href="index.html" />
    2929    <link rel="prev" title="Some examples" href="examples.html" />
    3030  </head>
    … …  
    3939          <a href="examples.html" title="Some examples"
    4040             accesskey="P">previous</a> |</li>
    41         <li><a href="index.html">Postman 0.1.0 documentation</a> &raquo;</li>
     41        <li><a href="index.html">Mailjam 0.1.0 documentation</a> &raquo;</li>
    4242      </ul>
    4343    </div> 
    … …  
    9898          <a href="examples.html" title="Some examples"
    9999             >previous</a> |</li>
    100         <li><a href="index.html">Postman 0.1.0 documentation</a> &raquo;</li>
     100        <li><a href="index.html">Mailjam 0.1.0 documentation</a> &raquo;</li>
    101101      </ul>
    102102    </div>

  • docs/src/_build/html/examples.html

    r13 r16  
    99    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    1010   
    11     <title>Some examples &mdash; Postman 0.1.0 documentation</title>
     11    <title>Some examples &mdash; Mailjam 0.1.0 documentation</title>
    1212   
    1313    <link rel="stylesheet" href="_static/default.css" type="text/css" />
    … …  
    2626    <script type="text/javascript" src="_static/underscore.js"></script>
    2727    <script type="text/javascript" src="_static/doctools.js"></script>
    28     <link rel="top" title="Postman 0.1.0 documentation" href="index.html" />
     28    <link rel="top" title="Mailjam 0.1.0 documentation" href="index.html" />
    2929    <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" />
    3131  </head>
    3232  <body>
    … …  
    4141             accesskey="N">next</a> |</li>
    4242        <li class="right" >
    43           <a href="running.html" title="Running Postman"
     43          <a href="running.html" title="Running Mailjam"
    4444             accesskey="P">previous</a> |</li>
    45         <li><a href="index.html">Postman 0.1.0 documentation</a> &raquo;</li>
     45        <li><a href="index.html">Mailjam 0.1.0 documentation</a> &raquo;</li>
    4646      </ul>
    4747    </div> 
    … …  
    7070  <h4>Previous topic</h4>
    7171  <p class="topless"><a href="running.html"
    72                         title="previous chapter">Running Postman</a></p>
     72                        title="previous chapter">Running Mailjam</a></p>
    7373  <h4>Next topic</h4>
    7474  <p class="topless"><a href="development.html"
    … …  
    106106             >next</a> |</li>
    107107        <li class="right" >
    108           <a href="running.html" title="Running Postman"
     108          <a href="running.html" title="Running Mailjam"
    109109             >previous</a> |</li>
    110         <li><a href="index.html">Postman 0.1.0 documentation</a> &raquo;</li>
     110        <li><a href="index.html">Mailjam 0.1.0 documentation</a> &raquo;</li>
    111111      </ul>
    112112    </div>

  • docs/src/_build/html/genindex.html

    r13 r16  
    1111    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    1212   
    13     <title>Index &mdash; Postman 0.1.0 documentation</title>
     13    <title>Index &mdash; Mailjam 0.1.0 documentation</title>
    1414   
    1515    <link rel="stylesheet" href="_static/default.css" type="text/css" />
    … …  
    2828    <script type="text/javascript" src="_static/underscore.js"></script>
    2929    <script type="text/javascript" src="_static/doctools.js"></script>
    30     <link rel="top" title="Postman 0.1.0 documentation" href="index.html" />
     30    <link rel="top" title="Mailjam 0.1.0 documentation" href="index.html" />
    3131  </head>
    3232  <body>
    … …  
    3737          <a href="#" title="General Index"
    3838             accesskey="I">index</a></li>
    39         <li><a href="index.html">Postman 0.1.0 documentation</a> &raquo;</li>
     39        <li><a href="index.html">Mailjam 0.1.0 documentation</a> &raquo;</li>
    4040      </ul>
    4141    </div> 
    … …  
    8585          <a href="#" title="General Index"
    8686             >index</a></li>
    87         <li><a href="index.html">Postman 0.1.0 documentation</a> &raquo;</li>
     87        <li><a href="index.html">Mailjam 0.1.0 documentation</a> &raquo;</li>
    8888      </ul>
    8989    </div>

  • docs/src/_build/html/index.html

    r13 r16  
    99    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    1010   
    11     <title>Postman official documentation &mdash; Postman 0.1.0 documentation</title>
     11    <title>Mailjam official documentation &mdash; Mailjam 0.1.0 documentation</title>
    1212   
    1313    <link rel="stylesheet" href="_static/default.css" type="text/css" />
    … …  
    2626    <script type="text/javascript" src="_static/underscore.js"></script>
    2727    <script type="text/javascript" src="_static/doctools.js"></script>
    28     <link rel="top" title="Postman 0.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" />
    3030  </head>
    3131  <body>
    … …  
    3737             accesskey="I">index</a></li>
    3838        <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"
    4040             accesskey="N">next</a> |</li>
    41         <li><a href="#">Postman 0.1.0 documentation</a> &raquo;</li>
     41        <li><a href="#">Mailjam 0.1.0 documentation</a> &raquo;</li>
    4242      </ul>
    4343    </div> 
    … …  
    4848          <div class="body">
    4949           
    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 management
     50  <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
    5353software written in <a class="reference external" href="http://python.org">Python</a>.</p>
    5454<p>Contents:</p>
    5555<div class="toctree-wrapper compound">
    5656<ul>
    57 <li class="toctree-l1"><a class="reference internal" href="overview.html">Overview of postman&#8217;s architecture</a><ul>
     57<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview of mailjam&#8217;s architecture</a><ul>
    5858<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">Postman daemon</a></li>
     59<li class="toctree-l2"><a class="reference internal" href="overview.html#mailjam-daemon">Mailjam daemon</a></li>
    6060<li class="toctree-l2"><a class="reference internal" href="overview.html#mta-client">MTA client</a></li>
    6161<li class="toctree-l2"><a class="reference internal" href="overview.html#cli-client">CLI client</a></li>
    … …  
    6565<li class="toctree-l1"><a class="reference internal" href="install.html">Installation instructions</a><ul>
    6666<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>
    7070<li class="toctree-l2"><a class="reference internal" href="install.html#running-tests-developers-only">Running tests (developers only)</a></li>
    7171</ul>
    7272</li>
    7373<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">Postman daemon 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>
    7575</ul>
    7676</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>
    7878<li class="toctree-l1"><a class="reference internal" href="examples.html">Some examples</a></li>
    7979<li class="toctree-l1"><a class="reference internal" href="development.html">Developers documentation</a></li>
    … …  
    9898  <h3><a href="#">Table Of Contents</a></h3>
    9999  <ul>
    100 <li><a class="reference internal" href="#">Postman official documentation</a><ul>
     100<li><a class="reference internal" href="#">Mailjam official documentation</a><ul>
    101101</ul>
    102102</li>
    … …  
    106106  <h4>Next topic</h4>
    107107  <p class="topless"><a href="overview.html"
    108                         title="next chapter">Overview of postman&#8217;s architecture</a></p>
     108                        title="next chapter">Overview of mailjam&#8217;s architecture</a></p>
    109109  <h3>This Page</h3>
    110110  <ul class="this-page-menu">
    … …  
    136136             >index</a></li>
    137137        <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"
    139139             >next</a> |</li>
    140         <li><a href="#">Postman 0.1.0 documentation</a> &raquo;</li>
     140        <li><a href="#">Mailjam 0.1.0 documentation</a> &raquo;</li>
    141141      </ul>
    142142    </div>

  • docs/src/_build/html/install.html

    r13 r16  
    99    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    1010   
    11     <title>Installation instructions &mdash; Postman 0.1.0 documentation</title>
     11    <title>Installation instructions &mdash; Mailjam 0.1.0 documentation</title>
    1212   
    1313    <link rel="stylesheet" href="_static/default.css" type="text/css" />
    … …  
    2626    <script type="text/javascript" src="_static/underscore.js"></script>
    2727    <script type="text/javascript" src="_static/doctools.js"></script>
    28     <link rel="top" title="Postman 0.1.0 documentation" href="index.html" />
     28    <link rel="top" title="Mailjam 0.1.0 documentation" href="index.html" />
    2929    <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" />
    3131  </head>
    3232  <body>
    … …  
    4141             accesskey="N">next</a> |</li>
    4242        <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"
    4444             accesskey="P">previous</a> |</li>
    45         <li><a href="index.html">Postman 0.1.0 documentation</a> &raquo;</li>
     45        <li><a href="index.html">Mailjam 0.1.0 documentation</a> &raquo;</li>
    4646      </ul>
    4747    </div> 
    … …  
    5959<li><a class="reference internal" href="#installation-instructions" id="id3">Installation instructions</a><ul>
    6060<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>
    6262<li><a class="reference internal" href="#installing-using-pip" id="id6">Installing using pip</a></li>
    6363<li><a class="reference internal" href="#installing-using-easy-install" id="id7">Installing using easy_install</a></li>
    … …  
    7070</ul>
    7171</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>
    7474<li><a class="reference internal" href="#running-tests-developers-only" id="id14">Running tests (developers only)</a></li>
    7575</ul>
    … …  
    7979<div class="section" id="first-install-dependencies">
    8080<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 postman is <a class="reference external" href="http://python.org">Python</a></p>
    82 <p>Postman has been tested with python <em>2.7.x</em>, but it should work with versions
     81<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
    8383<em>2.6.x</em> too.</p>
    8484<p>Please, refer to your operating system package system documentation to learn
    8585more about how to install python.</p>
    8686</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>
    8989<div class="section" id="installing-using-pip">
    9090<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 Postman 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/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>
    9393</div>
    9494<div class="admonition note">
    9595<p class="first admonition-title">Note</p>
    96 <p class="last">Postman 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 Postman repo.</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
     97it using pip you will have to provide the URL for the public Mailjam repo.</p>
    9898</div>
    9999</div>
    100100<div class="section" id="installing-using-easy-install">
    101101<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 Postman using <a class="reference external" href="http://peak.telecommunity.com/DevCenter/EasyInstall">easy_install</a> yet (until we do record/upload
     102<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
    103103it to pypi)</p>
    104104</div>
    105105<div class="section" id="installing-inside-a-virtualenv">
    106106<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 Postman inside 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>
    108108<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>
    109109</pre></div>
    … …  
    121121</div>
    122122</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>
    125125</div>
    126126</div>
    … …  
    136136<div class="section" id="from-repository">
    137137<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 Postman 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
     138<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
    139139the latest sources you need <a class="reference external" href="http://mercurial.selenic.com">Mercurial</a>.</p>
    140140<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>
    144144<div class="highlight-python"><pre>python setup.py install</pre>
    145145</div>
    … …  
    157157</div>
    158158</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>
    161161<p>TBW</p>
    162162</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>
    165165<p>TBW</p>
    166166</div>
    … …  
    171171<colgroup><col class="label" /><col /></colgroup>
    172172<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>
    174174</tbody>
    175175</table>
    … …  
    187187<li><a class="reference internal" href="#">Installation instructions</a><ul>
    188188<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>
    190190<li><a class="reference internal" href="#installing-using-pip">Installing using pip</a></li>
    191191<li><a class="reference internal" href="#installing-using-easy-install">Installing using easy_install</a></li>
    … …  
    198198</ul>
    199199</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>
    202202<li><a class="reference internal" href="#running-tests-developers-only">Running tests (developers only)</a></li>
    203203</ul>
    … …  
    207207  <h4>Previous topic</h4>
    208208  <p class="topless"><a href="overview.html"
    209                         title="previous chapter">Overview of postman&#8217;s architecture</a></p>
     209                        title="previous chapter">Overview of mailjam&#8217;s architecture</a></p>
    210210  <h4>Next topic</h4>
    211211  <p class="topless"><a href="configuration.html"
    … …  
    243243             >next</a> |</li>
    244244        <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"
    246246             >previous</a> |</li>
    247         <li><a href="index.html">Postman 0.1.0 documentation</a> &raquo;</li>
     247        <li><a href="index.html">Mailjam 0.1.0 documentation</a> &raquo;</li>
    248248      </ul>
    249249    </div>

  • docs/src/_build/html/overview.html

    r13 r16  
    99    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    1010   
    11     <title>Overview of postman’s architecture &mdash; Postman 0.1.0 documentation</title>
     11    <title>Overview of mailjam’s architecture &mdash; Mailjam 0.1.0 documentation</title>
    1212   
    1313    <link rel="stylesheet" href="_static/default.css" type="text/css" />
    … …  
    2626    <script type="text/javascript" src="_static/underscore.js"></script>
    2727    <script type="text/javascript" src="_static/doctools.js"></script>
    28     <link rel="top" title="Postman 0.1.0 documentation" href="index.html" />
     28    <link rel="top" title="Mailjam 0.1.0 documentation" href="index.html" />
    2929    <link rel="next" title="Installation instructions" href="install.html" />
    30     <link rel="prev" title="Postman official documentation" href="index.html" />
     30    <link rel="prev" title="Mailjam official documentation" href="index.html" />
    3131  </head>
    3232  <body>
    … …  
    4141             accesskey="N">next</a> |</li>
    4242        <li class="right" >
    43           <a href="index.html" title="Postman official documentation"
     43          <a href="index.html" title="Mailjam official documentation"
    4444             accesskey="P">previous</a> |</li>
    45         <li><a href="index.html">Postman 0.1.0 documentation</a> &raquo;</li>
     45        <li><a href="index.html">Mailjam 0.1.0 documentation</a> &raquo;</li>
    4646      </ul>
    4747    </div> 
    … …  
    5252          <div class="body">
    5353           
    54   <div class="section" id="overview-of-postman-s-architecture">
    55 <h1><a class="toc-backref" href="#id1">Overview of postman&#8217;s architecture</a><a class="headerlink" href="#overview-of-postman-s-architecture" title="Permalink to this headline">¶</a></h1>
     54  <div class="section" id="overview-of-mailjam-s-architecture">
     55<h1><a class="toc-backref" href="#id1">Overview of mailjam&#8217;s architecture</a><a class="headerlink" href="#overview-of-mailjam-s-architecture" title="Permalink to this headline">¶</a></h1>
    5656<div class="contents topic" id="contents">
    5757<p class="topic-title first">Contents</p>
    5858<ul class="simple">
    59 <li><a class="reference internal" href="#overview-of-postman-s-architecture" id="id1">Overview of postman&#8217;s architecture</a><ul>
     59<li><a class="reference internal" href="#overview-of-mailjam-s-architecture" id="id1">Overview of mailjam&#8217;s architecture</a><ul>
    6060<li><a class="reference internal" href="#introduction" id="id2">Introduction</a></li>
    61 <li><a class="reference internal" href="#postman-daemon" id="id3">Postman daemon</a></li>
     61<li><a class="reference internal" href="#mailjam-daemon" id="id3">Mailjam daemon</a></li>
    6262<li><a class="reference internal" href="#mta-client" id="id4">MTA client</a></li>
    6363<li><a class="reference internal" href="#cli-client" id="id5">CLI client</a></li>
    … …  
    6969<div class="section" id="introduction">
    7070<h2><a class="toc-backref" href="#id2">Introduction</a><a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h2>
    71 <p>Postman has been designed following a <strong>multi-component structure</strong>. There is
     71<p>Mailjam has been designed following a <strong>multi-component structure</strong>. There is
    7272<strong>a daemon</strong> that manage the mailing lists and members information in a storage
    7373backend and there are <strong>different kinds of clients</strong> (currently, three of them)
    7474that <strong>interact with the daemon using a XMLRPC link</strong>.</p>
    7575<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" />
    7777</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>
    8080<p>The daemon will perform all the operations regarding the management of the
    8181mailing lists and members. The daemon will save information of a given
    … …  
    8686</div>
    8787<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>
    8989<p>This client is attached to a given MTA, and is called but the MTA itself when
    9090emails for a mailing lists are received. The client performs some checks on the
    … …  
    9292</div>
    9393<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>
    9595<p>This is a shell-like interface that can be used to add mailing lists to a given
    96 Postman server, edit such mailing lists information, add members, etc.</p>
     96Mailjam server, edit such mailing lists information, add members, etc.</p>
    9797</div>
    9898<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>
    100100<p>This is a small <em>webapp</em> that can be used to perform the same management
    101101operations 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>
    103103</div>
    104104</div>
    … …  
    112112  <h3><a href="index.html">Table Of Contents</a></h3>
    113113  <ul>
    114 <li><a class="reference internal" href="#">Overview of postman&#8217;s architecture</a><ul>
     114<li><a class="reference internal" href="#">Overview of mailjam&#8217;s architecture</a><ul>
    115115<li><a class="reference internal" href="#introduction">Introduction</a></li>
    116 <li><a class="reference internal" href="#postman-daemon">Postman daemon</a></li>
     116<li><a class="reference internal" href="#mailjam-daemon">Mailjam daemon</a></li>
    117117<li><a class="reference internal" href="#mta-client">MTA client</a></li>
    118118<li><a class="reference internal" href="#cli-client">CLI client</a></li>
    … …  
    124124  <h4>Previous topic</h4>
    125125  <p class="topless"><a href="index.html"
    126                         title="previous chapter">Postman official documentation</a></p>
     126                        title="previous chapter">Mailjam official documentation</a></p>
    127127  <h4>Next topic</h4>
    128128  <p class="topless"><a href="install.html"
    … …  
    160160             >next</a> |</li>
    161161        <li class="right" >
    162           <a href="index.html" title="Postman official documentation"
     162          <a href="index.html" title="Mailjam official documentation"
    163163             >previous</a> |</li>
    164         <li><a href="index.html">Postman 0.1.0 documentation</a> &raquo;</li>
     164        <li><a href="index.html">Mailjam 0.1.0 documentation</a> &raquo;</li>
    165165      </ul>
    166166    </div>

  • docs/src/_build/html/running.html

    r13 r16  
    99    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    1010   
    11     <title>Running Postman &mdash; Postman 0.1.0 documentation</title>
     11    <title>Running Mailjam &mdash; Mailjam 0.1.0 documentation</title>
    1212   
    1313    <link rel="stylesheet" href="_static/default.css" type="text/css" />
    … …  
    2626    <script type="text/javascript" src="_static/underscore.js"></script>
    2727    <script type="text/javascript" src="_static/doctools.js"></script>
    28     <link rel="top" title="Postman 0.1.0 documentation" href="index.html" />
     28    <link rel="top" title="Mailjam 0.1.0 documentation" href="index.html" />
    2929    <link rel="next" title="Some examples" href="examples.html" />
    3030    <link rel="prev" title="Configuration" href="configuration.html" />
    … …  
    4343          <a href="configuration.html" title="Configuration"
    4444             accesskey="P">previous</a> |</li>
    45         <li><a href="index.html">Postman 0.1.0 documentation</a> &raquo;</li>
     45        <li><a href="index.html">Mailjam 0.1.0 documentation</a> &raquo;</li>
    4646      </ul>
    4747    </div> 
    … …  
    5252          <div class="body">
    5353           
    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>
    5656<div class="contents topic" id="contents">
    5757<p class="topic-title first">Contents</p>
    5858<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>
    6060</ul>
    6161</div>
    … …  
    108108          <a href="configuration.html" title="Configuration"
    109109             >previous</a> |</li>
    110         <li><a href="index.html">Postman 0.1.0 documentation</a> &raquo;</li>
     110        <li><a href="index.html">Mailjam 0.1.0 documentation</a> &raquo;</li>
    111111      </ul>
    112112    </div>

  • docs/src/_build/html/search.html

    r13 r16  
    99    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    1010   
    11     <title>Search &mdash; Postman 0.1.0 documentation</title>
     11    <title>Search &mdash; Mailjam 0.1.0 documentation</title>
    1212   
    1313    <link rel="stylesheet" href="_static/default.css" type="text/css" />
    … …  
    2727    <script type="text/javascript" src="_static/doctools.js"></script>
    2828    <script type="text/javascript" src="_static/searchtools.js"></script>
    29     <link rel="top" title="Postman 0.1.0 documentation" href="index.html" />
     29    <link rel="top" title="Mailjam 0.1.0 documentation" href="index.html" />
    3030  <script type="text/javascript">
    3131    jQuery(function() { Search.loadIndex("searchindex.js"); });
    … …  
    4141          <a href="genindex.html" title="General Index"
    4242             accesskey="I">index</a></li>
    43         <li><a href="index.html">Postman 0.1.0 documentation</a> &raquo;</li>
     43        <li><a href="index.html">Mailjam 0.1.0 documentation</a> &raquo;</li>
    4444      </ul>
    4545    </div> 
    … …  
    8989          <a href="genindex.html" title="General Index"
    9090             >index</a></li>
    91         <li><a href="index.html">Postman 0.1.0 documentation</a> &raquo;</li>
     91        <li><a href="index.html">Mailjam 0.1.0 documentation</a> &raquo;</li>
    9292      </ul>
    9393    </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&#8217;s architecture","Running Postman","Some examples","Installation instructions","Configuration"],objnames:{},filenames:["development","index","overview","running","examples","install","configuration"]})
     1Search.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&#8217;s architecture","Running Mailjam","Some examples","Installation instructions","Configuration"],objnames:{},filenames:["development","index","overview","running","examples","install","configuration"]})

  • docs/src/conf.py

    r13 r16  
    11# -*- coding: utf-8 -*-
    22#
    3 # Postman documentation build configuration file, created by
     3# Mailjam documentation build configuration file, created by
    44# sphinx-quickstart on Sun May 20 12:34:00 2012.
    55#
    … …  
    4141
    4242# General information about the project.
    43 project = u'Postman'
     43project = u'Mailjam'
    4444copyright = u'2012, Soluciones Informaticas Codigo23 S.L.U.'
    4545
    … …  
    165165
    166166# Output file base name for HTML help builder.
    167 htmlhelp_basename = 'Postmandoc'
     167htmlhelp_basename = 'Mailjamdoc'
    168168
    169169
    … …  
    184184# (source start file, target name, title, author, documentclass [howto/manual]).
    185185latex_documents = [
    186   ('index', 'Postman.tex', u'Postman Documentation',
     186  ('index', 'Mailjam.tex', u'Mailjam Documentation',
    187187   u'Soluciones Informaticas Codigo23 S.L.U.', 'manual'),
    188188]
    … …  
    214214# (source start file, name, description, authors, manual section).
    215215man_pages = [
    216     ('index', 'postman', u'Postman Documentation',
     216    ('index', 'mailjam', u'Mailjam Documentation',
    217217     [u'Soluciones Informaticas Codigo23 S.L.U.'], 1)
    218218]
    … …  
    228228#  dir menu entry, description, category)
    229229texinfo_documents = [
    230   ('index', 'Postman', u'Postman Documentation',
    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.',
    232232   'Miscellaneous'),
    233233]
    … …  
    246246
    247247# Bibliographic Dublin Core info.
    248 epub_title = u'Postman'
     248epub_title = u'Mailjam'
    249249epub_author = u'Soluciones Informaticas Codigo23 S.L.U.'
    250250epub_publisher = u'Soluciones Informaticas Codigo23 S.L.U.'

  • docs/src/configuration.rst

    r13 r16  
    66.. _configuration_daemon:
    77
    8 Postman daemon configuration file
     8Mailjam daemon configuration file
    99---------------------------------
    1010
    11 All the configurations that can be applied to the Postman daemon are registered
    12 in the **postman.conf** file. That file contains ini-style [1]_ configuration
     11All the configurations that can be applied to the Mailjam daemon are registered
     12in the **mailjam.conf** file. That file contains ini-style [1]_ configuration
    1313parameters, separated in different *categories*.
    1414
    1515.. note::
    1616
    17    The postman.conf file will be installed in different locations depending on
     17   The mailjam.conf file will be installed in different locations depending on
    1818   your setup. The usual locations are:
    1919
    20    - */etc/postman.conf* - In most Linux systems (like archlinux, gentoo,
     20   - */etc/mailjam.conf* - In most Linux systems (like archlinux, gentoo,
    2121     fedora, debian, ubuntu, etc)
    2222
    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,
    2424     NetBSD, etc)
    2525
    … …  
    7373*******
    7474
    75 Default: ``/usr/local/etc/postman/ssl/postman.key``
     75Default: ``/usr/local/etc/mailjam/ssl/mailjam.key``
    7676
    7777Path to the ssl key used for encrypted SSL sessions.
    … …  
    8686*******
    8787
    88 Default: ``/usr/local/etc/postman/ssl/postman.crt``
     88Default: ``/usr/local/etc/mailjam/ssl/mailjam.crt``
    8989
    9090Path to the ssl certificate used for encrypted SSL sessions.
    … …  
    9999*******
    100100
    101 Default: ``/var/log/postman/xmlrpc_server.log``
     101Default: ``/var/log/mailjam/xmlrpc_server.log``
    102102
    103103Path to the file where log messages will be saved
    … …  
    128128****
    129129
    130 Default: ``/usr/local/postman/storage``
     130Default: ``/usr/local/mailjam/storage``
    131131
    132132Path to the directory where the backend will save data.
    … …  
    137137********
    138138
    139 Default: ``/usr/local/postman/storage/mailings.json``
     139Default: ``/usr/local/mailjam/storage/mailings.json``
    140140
    141141Path to the file where the identifiers of existing mailing lists will be saved.
    … …  
    165165**********
    166166
    167 Default: ``/usr/local/postman/storage/members.json``
     167Default: ``/usr/local/mailjam/storage/members.json``
    168168
    169169Path to the file where the identifiers of existing members will be saved.
    … …  
    191191Default: ``true``
    192192
    193 Enables/disables the *archives* feature. When enabled, Postman saves copies of
     193Enables/disables the *archives* feature. When enabled, Mailjam saves copies of
    194194email address into an *archive*, so they can be read later, through a web
    195195interface.
    … …  
    220220****
    221221
    222 Default: ``/usr/local/postman/archives``
     222Default: ``/usr/local/mailjam/archives``
    223223
    224224Path to the directory where the archives will be saved.
    … …  
    238238.. warning::
    239239
    240    This parameters are not currently used in postman, we are still working
     240   This parameters are not currently used in mailjam, we are still working
    241241   on per-mailing-list configuration parameters.
    242242
    … …  
    265265.. warning::
    266266
    267    This parameters are not currently used in postman, we are still working
     267   This parameters are not currently used in mailjam, we are still working
    268268   on per-member configuration parameters.
    269269

  • docs/src/index.rst

    r13 r16  
    1 Postman official documentation
     1Mailjam official documentation
    22==============================
    33
    4 This is the official documentation for Postman_, a mailing list management
     4This is the official documentation for Mailjam_, a mailing list management
    55software written in Python_.
    66
    … …  
    2525* :ref:`search`
    2626
    27 .. _Postman: https://bitbucket.org/codigo23/postman
     27.. _Mailjam: https://bitbucket.org/codigo23/mailjam
    2828.. _Python: http://python.org

  • docs/src/install.rst

    r13 r16  
    99---------------------------
    1010
    11 So far, the only dependency you will need in order to run postman is Python_
     11So far, the only dependency you will need in order to run mailjam is Python_
    1212
    13 Postman has been tested with python *2.7.x*, but it should work with versions
     13Mailjam has been tested with python *2.7.x*, but it should work with versions
    1414*2.6.x* too.
    1515
    … …  
    1717more about how to install python.
    1818
    19 .. _install_postman:
     19.. _install_mailjam:
    2020
    21 Second, install Postman
     21Second, install Mailjam
    2222-----------------------
    2323
    … …  
    2727++++++++++++++++++++
    2828
    29 You can install Postman using pip_::
     29You can install Mailjam using pip_::
    3030
    31   pip install -e https://bitbucket.org/codigo23/postman#egg=postman
     31  pip install -e https://bitbucket.org/codigo23/mailjam#egg=mailjam
    3232
    3333.. note::
    3434
    35    Postman 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 Postman repo.
     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.
    3737
    3838.. _install_with_easy_install:
    … …  
    4141+++++++++++++++++++++++++++++
    4242
    43 You can not install Postman using easy_install_ yet (until we do record/upload
     43You can not install Mailjam using easy_install_ yet (until we do record/upload
    4444it to pypi)
    4545
    … …  
    4949++++++++++++++++++++++++++++++
    5050
    51 You can install Postman inside a virtualenv_. Just create a virtualenv::
     51You can install Mailjam inside a virtualenv_. Just create a virtualenv::
    5252
    5353  virtualenv /path/to/your/env
    … …  
    6464     source /path/to/your/env/bin/activate.csh
    6565
    66 And, once the environment has been activated, use pip to install Postman::
     66And, once the environment has been activated, use pip to install Mailjam::
    6767
    68   env$ pip install -e https://bitbucket.org/codigo23/postman#egg=postman
     68  env$ pip install -e https://bitbucket.org/codigo23/mailjam#egg=mailjam
    6969
    7070.. _install_from_sources:
    … …  
    8989***************
    9090
    91 The source code of Postman is hosted in bitbucket_ [1]_. In order to grab
     91The source code of Mailjam is hosted in bitbucket_ [1]_. In order to grab
    9292the latest sources you need Mercurial_.
    9393
    9494To get a copy of the sources, just *clone* the repository::
    9595
    96   hg clone https://bitbucket.org/codigo23/postman postman-repo
     96  hg clone https://bitbucket.org/codigo23/mailjam mailjam-repo
    9797
    98 Then, go inside the *postman-repo* directory and run::
     98Then, go inside the *mailjam-repo* directory and run::
    9999
    100100  python setup.py install
    … …  
    110110   This process will work inside a virtualenv_ too.
    111111
    112 .. _install_setting_up_postman:
     112.. _install_setting_up_mailjam:
    113113
    114 Setting up Postman
     114Setting up Mailjam
    115115------------------
    116116
    117117TBW
    118118
    119 .. _install_running_postman:
     119.. _install_running_mailjam:
    120120
    121 Running Postman
     121Running Mailjam
    122122---------------
    123123
    … …  
    140140.. _sudo: http://sudo.ws
    141141
    142 .. [1] https://bitbucket.org/codigo23/postman
     142.. [1] https://bitbucket.org/codigo23/mailjam

  • docs/src/overview.rst

    r13 r16  
    1 Overview of postman's architecture
     1Overview of mailjam's architecture
    22==================================
    33
    … …  
    77------------
    88
    9 Postman has been designed following a **multi-component structure**. There is
     9Mailjam has been designed following a **multi-component structure**. There is
    1010**a daemon** that manage the mailing lists and members information in a storage
    1111backend and there are **different kinds of clients** (currently, three of them)
    … …  
    1414This is the scheme of the architecture:
    1515
    16 .. image:: /postman_architecture.png
    17    :alt: Scheme of the architecture behind Postman
     16.. image:: /mailjam_architecture.png
     17   :alt: Scheme of the architecture behind Mailjam
    1818   :class: open_fancybox
    1919
    2020
    21 .. _overview_postman_daemon:
     21.. _overview_mailjam_daemon:
    2222
    23 Postman daemon
     23Mailjam daemon
    2424--------------
    2525
    … …  
    3232to add/update/delete data from the backend.
    3333
    34 .. _overview_postman_mta_client:
     34.. _overview_mailjam_mta_client:
    3535
    3636MTA client
    … …  
    4141backend to tell the MTA what it has to do with the incoming emails.
    4242
    43 .. _overview_postman_cli_client:
     43.. _overview_mailjam_cli_client:
    4444
    4545CLI client
    … …  
    4747
    4848This is a shell-like interface that can be used to add mailing lists to a given
    49 Postman server, edit such mailing lists information, add members, etc.
     49Mailjam server, edit such mailing lists information, add members, etc.
    5050
    51 .. _overview_postman_web_client:
     51.. _overview_mailjam_web_client:
    5252
    5353Web client
    … …  
    5656This is a small *webapp* that can be used to perform the same management
    5757operations 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 Postman
     1Running Mailjam
    22===============
    33
Note: See TracChangeset for help on using the changeset viewer.