| [13] | 1 |
|
|---|
| 2 |
|
|---|
| 3 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|---|
| 4 | "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|---|
| 5 |
|
|---|
| 6 |
|
|---|
| 7 | <html xmlns="http://www.w3.org/1999/xhtml">
|
|---|
| 8 | <head>
|
|---|
| 9 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|---|
| 10 |
|
|---|
| [16] | 11 | <title>Configuration — Mailjam 0.1.0 documentation</title>
|
|---|
| [13] | 12 |
|
|---|
| 13 | <link rel="stylesheet" href="_static/default.css" type="text/css" />
|
|---|
| 14 | <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|---|
| 15 |
|
|---|
| 16 | <script type="text/javascript">
|
|---|
| 17 | var DOCUMENTATION_OPTIONS = {
|
|---|
| 18 | URL_ROOT: '',
|
|---|
| 19 | VERSION: '0.1.0',
|
|---|
| 20 | COLLAPSE_INDEX: false,
|
|---|
| 21 | FILE_SUFFIX: '.html',
|
|---|
| 22 | HAS_SOURCE: true
|
|---|
| 23 | };
|
|---|
| 24 | </script>
|
|---|
| 25 | <script type="text/javascript" src="_static/jquery.js"></script>
|
|---|
| 26 | <script type="text/javascript" src="_static/underscore.js"></script>
|
|---|
| 27 | <script type="text/javascript" src="_static/doctools.js"></script>
|
|---|
| [16] | 28 | <link rel="top" title="Mailjam 0.1.0 documentation" href="index.html" />
|
|---|
| 29 | <link rel="next" title="Running Mailjam" href="running.html" />
|
|---|
| [13] | 30 | <link rel="prev" title="Installation instructions" href="install.html" />
|
|---|
| 31 | </head>
|
|---|
| 32 | <body>
|
|---|
| 33 | <div class="related">
|
|---|
| 34 | <h3>Navigation</h3>
|
|---|
| 35 | <ul>
|
|---|
| 36 | <li class="right" style="margin-right: 10px">
|
|---|
| 37 | <a href="genindex.html" title="General Index"
|
|---|
| 38 | accesskey="I">index</a></li>
|
|---|
| 39 | <li class="right" >
|
|---|
| [16] | 40 | <a href="running.html" title="Running Mailjam"
|
|---|
| [13] | 41 | accesskey="N">next</a> |</li>
|
|---|
| 42 | <li class="right" >
|
|---|
| 43 | <a href="install.html" title="Installation instructions"
|
|---|
| 44 | accesskey="P">previous</a> |</li>
|
|---|
| [16] | 45 | <li><a href="index.html">Mailjam 0.1.0 documentation</a> »</li>
|
|---|
| [13] | 46 | </ul>
|
|---|
| 47 | </div>
|
|---|
| 48 |
|
|---|
| 49 | <div class="document">
|
|---|
| 50 | <div class="documentwrapper">
|
|---|
| 51 | <div class="bodywrapper">
|
|---|
| 52 | <div class="body">
|
|---|
| 53 |
|
|---|
| 54 | <div class="section" id="configuration">
|
|---|
| [27] | 55 | <h1><a class="toc-backref" href="#id28">Configuration</a><a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h1>
|
|---|
| 56 | <p>Mailjam has separate configuration files for the different apps (the daemon and
|
|---|
| 57 | the variety of different clients available). Check below to read more about the
|
|---|
| 58 | configuration file you need to modify depending on what you want to do.</p>
|
|---|
| [13] | 59 | <div class="contents topic" id="contents">
|
|---|
| 60 | <p class="topic-title first">Contents</p>
|
|---|
| 61 | <ul class="simple">
|
|---|
| [27] | 62 | <li><a class="reference internal" href="#configuration" id="id28">Configuration</a><ul>
|
|---|
| 63 | <li><a class="reference internal" href="#mailjam-daemon-configuration-file-mailjam-conf" id="id29">Mailjam daemon configuration file - mailjam.conf</a><ul>
|
|---|
| 64 | <li><a class="reference internal" href="#xmlrpc-server" id="id30">xmlrpc_server</a><ul>
|
|---|
| 65 | <li><a class="reference internal" href="#address" id="id31">address</a></li>
|
|---|
| 66 | <li><a class="reference internal" href="#port" id="id32">port</a></li>
|
|---|
| 67 | <li><a class="reference internal" href="#ssl" id="id33">ssl</a></li>
|
|---|
| 68 | <li><a class="reference internal" href="#ssl-key" id="id34">ssl_key</a></li>
|
|---|
| 69 | <li><a class="reference internal" href="#ssl-crt" id="id35">ssl_crt</a></li>
|
|---|
| 70 | <li><a class="reference internal" href="#logfile" id="id36">logfile</a></li>
|
|---|
| 71 | </ul>
|
|---|
| 72 | </li>
|
|---|
| 73 | <li><a class="reference internal" href="#storage" id="id37">storage</a><ul>
|
|---|
| 74 | <li><a class="reference internal" href="#backend" id="id38">backend</a></li>
|
|---|
| 75 | <li><a class="reference internal" href="#path" id="id39">path</a></li>
|
|---|
| 76 | <li><a class="reference internal" href="#lists-db" id="id40">lists_db</a></li>
|
|---|
| 77 | <li><a class="reference internal" href="#members-db" id="id41">members_db</a></li>
|
|---|
| 78 | </ul>
|
|---|
| 79 | </li>
|
|---|
| 80 | <li><a class="reference internal" href="#archive" id="id42">archive</a><ul>
|
|---|
| 81 | <li><a class="reference internal" href="#enabled" id="id43">enabled</a></li>
|
|---|
| 82 | <li><a class="reference internal" href="#configuration-daemon-archive-backend" id="id44">backend</a></li>
|
|---|
| 83 | <li><a class="reference internal" href="#configuration-daemon-archive-path" id="id45">path</a></li>
|
|---|
| 84 | </ul>
|
|---|
| 85 | </li>
|
|---|
| 86 | <li><a class="reference internal" href="#mailing-lists" id="id46">mailing_lists</a><ul>
|
|---|
| 87 | <li><a class="reference internal" href="#private" id="id47">private</a></li>
|
|---|
| [13] | 88 | </ul>
|
|---|
| 89 | </li>
|
|---|
| [27] | 90 | <li><a class="reference internal" href="#members" id="id48">members</a><ul>
|
|---|
| 91 | <li><a class="reference internal" href="#auto-signup" id="id49">auto_signup</a></li>
|
|---|
| 92 | <li><a class="reference internal" href="#allow-chpasswd" id="id50">allow_chpasswd</a></li>
|
|---|
| 93 | </ul>
|
|---|
| 94 | </li>
|
|---|
| 95 | </ul>
|
|---|
| 96 | </li>
|
|---|
| 97 | <li><a class="reference internal" href="#mailjam-mta-client-configuration-file-mailjam-mta-conf" id="id51">Mailjam MTA client configuration file - mailjam-mta.conf</a><ul>
|
|---|
| 98 | <li><a class="reference internal" href="#server" id="id52">server</a><ul>
|
|---|
| 99 | <li><a class="reference internal" href="#configuration-mta-client-server-address" id="id53">address</a></li>
|
|---|
| 100 | <li><a class="reference internal" href="#configuration-mta-client-server-port" id="id54">port</a></li>
|
|---|
| 101 | <li><a class="reference internal" href="#uri" id="id55">uri</a></li>
|
|---|
| 102 | <li><a class="reference internal" href="#configuration-mta-client-server-ssl" id="id56">ssl</a></li>
|
|---|
| [13] | 103 | </ul>
|
|---|
| 104 | </li>
|
|---|
| [27] | 105 | <li><a class="reference internal" href="#configuration-mta-client-archive" id="id57">archive</a><ul>
|
|---|
| 106 | <li><a class="reference internal" href="#persistent" id="id58">persistent</a></li>
|
|---|
| 107 | <li><a class="reference internal" href="#configuration-mta-client-archive-path" id="id59">path</a></li>
|
|---|
| 108 | </ul>
|
|---|
| 109 | </li>
|
|---|
| [13] | 110 | </ul>
|
|---|
| 111 | </li>
|
|---|
| [27] | 112 | <li><a class="reference internal" href="#mailjam-cli-client-configuration-file-mailjam-cli-conf" id="id60">Mailjam CLI client configuration file - mailjam-cli.conf</a><ul>
|
|---|
| 113 | <li><a class="reference internal" href="#configuration-cli-client-server" id="id61">server</a><ul>
|
|---|
| 114 | <li><a class="reference internal" href="#configuration-cli-client-server-address" id="id62">address</a></li>
|
|---|
| 115 | <li><a class="reference internal" href="#configuration-cli-client-server-port" id="id63">port</a></li>
|
|---|
| 116 | <li><a class="reference internal" href="#configuration-cli-client-server-uri" id="id64">uri</a></li>
|
|---|
| 117 | <li><a class="reference internal" href="#configuration-cli-client-server-ssl" id="id65">ssl</a></li>
|
|---|
| [13] | 118 | </ul>
|
|---|
| 119 | </li>
|
|---|
| [27] | 120 | <li><a class="reference internal" href="#history" id="id66">history</a><ul>
|
|---|
| 121 | <li><a class="reference internal" href="#configurtion-cli-client-archive-enabled" id="id67">enabled</a></li>
|
|---|
| 122 | <li><a class="reference internal" href="#configuration-cli-client-history-path" id="id68">path</a></li>
|
|---|
| [13] | 123 | </ul>
|
|---|
| 124 | </li>
|
|---|
| 125 | </ul>
|
|---|
| 126 | </li>
|
|---|
| 127 | </ul>
|
|---|
| 128 | </li>
|
|---|
| 129 | </ul>
|
|---|
| 130 | </div>
|
|---|
| [27] | 131 | <div class="section" id="mailjam-daemon-configuration-file-mailjam-conf">
|
|---|
| 132 | <span id="configuration-daemon"></span><h2><a class="toc-backref" href="#id29">Mailjam daemon configuration file - mailjam.conf</a><a class="headerlink" href="#mailjam-daemon-configuration-file-mailjam-conf" title="Permalink to this headline">¶</a></h2>
|
|---|
| 133 | <p>All the configurations that can be applied to the <a class="reference internal" href="overview.html#overview-mailjam-daemon"><em>Mailjam daemon</em></a>
|
|---|
| 134 | are registered in the <strong>mailjam.conf</strong> file. That file contains ini-style <a class="footnote-reference" href="#id24" id="id1">[1]</a>
|
|---|
| 135 | configuration parameters, separated in different <em>categories</em>.</p>
|
|---|
| [13] | 136 | <div class="admonition note">
|
|---|
| 137 | <p class="first admonition-title">Note</p>
|
|---|
| [16] | 138 | <p>The mailjam.conf file will be installed in different locations depending on
|
|---|
| [13] | 139 | your setup. The usual locations are:</p>
|
|---|
| 140 | <ul class="simple">
|
|---|
| [27] | 141 | <li><em>/etc/mailjam/mailjam.conf</em> - In most Linux systems (like archlinux,
|
|---|
| 142 | gentoo, fedora, debian, ubuntu, etc)</li>
|
|---|
| 143 | <li><em>/usr/local/etc/mailjam/mailjam.conf</em> - In most BSD systems (like FreeBSD,
|
|---|
| 144 | OpenBSD, NetBSD, etc)</li>
|
|---|
| [13] | 145 | </ul>
|
|---|
| 146 | <p class="last">There is a copy of the configuration file in the <em>conf/</em> directory, within
|
|---|
| 147 | the sources.</p>
|
|---|
| 148 | </div>
|
|---|
| 149 | <div class="section" id="xmlrpc-server">
|
|---|
| [27] | 150 | <span id="configuration-daemon-xmlrpc"></span><h3><a class="toc-backref" href="#id30">xmlrpc_server</a><a class="headerlink" href="#xmlrpc-server" title="Permalink to this headline">¶</a></h3>
|
|---|
| [13] | 151 | <p>This section contains the configuration parameters that modify the behaviour of
|
|---|
| [27] | 152 | the daemon when serving content through XMLRPC <a class="footnote-reference" href="#id25" id="id2">[2]</a>.</p>
|
|---|
| [13] | 153 | <p>These are all the available parameters in this section:</p>
|
|---|
| 154 | <div class="section" id="address">
|
|---|
| [27] | 155 | <span id="configuration-daemon-xmlrpc-address"></span><h4><a class="toc-backref" href="#id31">address</a><a class="headerlink" href="#address" title="Permalink to this headline">¶</a></h4>
|
|---|
| [13] | 156 | <p>Default: <tt class="docutils literal"><span class="pre">localhost</span></tt></p>
|
|---|
| 157 | <p>The address where the daemon will be listening for XMLRPC requests. Use <tt class="docutils literal"><span class="pre">*</span></tt>
|
|---|
| 158 | to listen an all available addresses, or any specific <tt class="docutils literal"><span class="pre">hostname</span></tt> or
|
|---|
| 159 | <tt class="docutils literal"><span class="pre">ip</span> <span class="pre">address</span></tt> value.</p>
|
|---|
| 160 | </div>
|
|---|
| 161 | <div class="section" id="port">
|
|---|
| [27] | 162 | <span id="configuration-daemon-xmlrpc-port"></span><h4><a class="toc-backref" href="#id32">port</a><a class="headerlink" href="#port" title="Permalink to this headline">¶</a></h4>
|
|---|
| [13] | 163 | <p>Default: <tt class="docutils literal"><span class="pre">9876</span></tt></p>
|
|---|
| 164 | <p>The port where the daemon will be listening por XMLRPC requests.</p>
|
|---|
| 165 | </div>
|
|---|
| 166 | <div class="section" id="ssl">
|
|---|
| [27] | 167 | <span id="configuration-daemon-xmlrpc-ssl"></span><h4><a class="toc-backref" href="#id33">ssl</a><a class="headerlink" href="#ssl" title="Permalink to this headline">¶</a></h4>
|
|---|
| 168 | <p>Default: <tt class="docutils literal"><span class="pre">false</span></tt> (because ssl support hasn’t been added yet)</p>
|
|---|
| 169 | <p>Enables/disables SSL <a class="footnote-reference" href="#id26" id="id3">[3]</a> support in the daemon. If <tt class="docutils literal"><span class="pre">false</span></tt> all the traffic
|
|---|
| 170 | to/from the server will travel unencrypted. If <tt class="docutils literal"><span class="pre">true</span></tt> all the traffic will
|
|---|
| [13] | 171 | travel encrypted.</p>
|
|---|
| 172 | </div>
|
|---|
| 173 | <div class="section" id="ssl-key">
|
|---|
| [27] | 174 | <span id="configuration-daemon-xmlrpc-ssl-key"></span><h4><a class="toc-backref" href="#id34">ssl_key</a><a class="headerlink" href="#ssl-key" title="Permalink to this headline">¶</a></h4>
|
|---|
| [16] | 175 | <p>Default: <tt class="docutils literal"><span class="pre">/usr/local/etc/mailjam/ssl/mailjam.key</span></tt></p>
|
|---|
| [13] | 176 | <p>Path to the ssl key used for encrypted SSL sessions.</p>
|
|---|
| 177 | <div class="admonition warning">
|
|---|
| 178 | <p class="first admonition-title">Warning</p>
|
|---|
| 179 | <p class="last">This parameter is not used right now, as ssl support hasn’t been added yet)</p>
|
|---|
| 180 | </div>
|
|---|
| 181 | </div>
|
|---|
| 182 | <div class="section" id="ssl-crt">
|
|---|
| [27] | 183 | <span id="configuration-daemon-xmlrpc-ssl-crt"></span><h4><a class="toc-backref" href="#id35">ssl_crt</a><a class="headerlink" href="#ssl-crt" title="Permalink to this headline">¶</a></h4>
|
|---|
| [16] | 184 | <p>Default: <tt class="docutils literal"><span class="pre">/usr/local/etc/mailjam/ssl/mailjam.crt</span></tt></p>
|
|---|
| [13] | 185 | <p>Path to the ssl certificate used for encrypted SSL sessions.</p>
|
|---|
| 186 | <div class="admonition warning">
|
|---|
| 187 | <p class="first admonition-title">Warning</p>
|
|---|
| 188 | <p class="last">This parameter is not used right now, as ssl support hasn’t been added yet)</p>
|
|---|
| 189 | </div>
|
|---|
| 190 | </div>
|
|---|
| 191 | <div class="section" id="logfile">
|
|---|
| [27] | 192 | <span id="configuration-daemon-xmlrpc-logfile"></span><h4><a class="toc-backref" href="#id36">logfile</a><a class="headerlink" href="#logfile" title="Permalink to this headline">¶</a></h4>
|
|---|
| [16] | 193 | <p>Default: <tt class="docutils literal"><span class="pre">/var/log/mailjam/xmlrpc_server.log</span></tt></p>
|
|---|
| [13] | 194 | <p>Path to the file where log messages will be saved</p>
|
|---|
| 195 | </div>
|
|---|
| 196 | </div>
|
|---|
| 197 | <div class="section" id="storage">
|
|---|
| [27] | 198 | <span id="configuration-daemon-storage"></span><h3><a class="toc-backref" href="#id37">storage</a><a class="headerlink" href="#storage" title="Permalink to this headline">¶</a></h3>
|
|---|
| [13] | 199 | <p>This section contains the configuration parameters that modify the way the
|
|---|
| 200 | daemon saves data to disk, using one of the storage backends.</p>
|
|---|
| 201 | <p>These are all the available parameters in this section:</p>
|
|---|
| 202 | <div class="section" id="backend">
|
|---|
| [27] | 203 | <span id="configuration-daemon-storage-backend"></span><h4><a class="toc-backref" href="#id38">backend</a><a class="headerlink" href="#backend" title="Permalink to this headline">¶</a></h4>
|
|---|
| [13] | 204 | <p>Default: <tt class="docutils literal"><span class="pre">json</span></tt></p>
|
|---|
| 205 | <p>Sets the type of backend the daemon is going to use. Right now the only backend
|
|---|
| 206 | available is <tt class="docutils literal"><span class="pre">json</span></tt>.</p>
|
|---|
| 207 | </div>
|
|---|
| 208 | <div class="section" id="path">
|
|---|
| [27] | 209 | <span id="configuration-daemon-xmlrpc-path"></span><h4><a class="toc-backref" href="#id39">path</a><a class="headerlink" href="#path" title="Permalink to this headline">¶</a></h4>
|
|---|
| [16] | 210 | <p>Default: <tt class="docutils literal"><span class="pre">/usr/local/mailjam/storage</span></tt></p>
|
|---|
| [13] | 211 | <p>Path to the directory where the backend will save data.</p>
|
|---|
| 212 | </div>
|
|---|
| 213 | <div class="section" id="lists-db">
|
|---|
| [27] | 214 | <span id="configuration-daemon-storage-lists-db"></span><h4><a class="toc-backref" href="#id40">lists_db</a><a class="headerlink" href="#lists-db" title="Permalink to this headline">¶</a></h4>
|
|---|
| [16] | 215 | <p>Default: <tt class="docutils literal"><span class="pre">/usr/local/mailjam/storage/mailings.json</span></tt></p>
|
|---|
| [13] | 216 | <p>Path to the file where the identifiers of existing mailing lists will be saved.</p>
|
|---|
| 217 | <div class="admonition note">
|
|---|
| 218 | <p class="first admonition-title">Note</p>
|
|---|
| 219 | <p>The default configuration file contains a dynamic setting for this
|
|---|
| 220 | parameter:</p>
|
|---|
| 221 | <div class="highlight-python"><pre>lists_db = %(path)s/mailings.%(backend)s</pre>
|
|---|
| 222 | </div>
|
|---|
| 223 | <p class="last">That means that the parameter will inherit the values of the base path and
|
|---|
| 224 | the extension of the file from the <em>storage.path</em> and <em>storage.backend</em>
|
|---|
| 225 | settings.</p>
|
|---|
| 226 | </div>
|
|---|
| 227 | <div class="admonition-see-also admonition seealso">
|
|---|
| 228 | <p class="first admonition-title">See also</p>
|
|---|
| 229 | <p>More information about this (and other tricks) here:</p>
|
|---|
| 230 | <p><a class="reference external" href="http://docs.python.org/library/configparser.html">http://docs.python.org/library/configparser.html</a></p>
|
|---|
| 231 | <p class="last"><a class="reference external" href="http://www.doughellmann.com/PyMOTW/ConfigParser">http://www.doughellmann.com/PyMOTW/ConfigParser</a></p>
|
|---|
| 232 | </div>
|
|---|
| 233 | </div>
|
|---|
| 234 | <div class="section" id="members-db">
|
|---|
| [27] | 235 | <span id="configuration-daemon-xmlrpc-members-db"></span><h4><a class="toc-backref" href="#id41">members_db</a><a class="headerlink" href="#members-db" title="Permalink to this headline">¶</a></h4>
|
|---|
| [16] | 236 | <p>Default: <tt class="docutils literal"><span class="pre">/usr/local/mailjam/storage/members.json</span></tt></p>
|
|---|
| [13] | 237 | <p>Path to the file where the identifiers of existing members will be saved.</p>
|
|---|
| 238 | <div class="admonition note">
|
|---|
| 239 | <p class="first admonition-title">Note</p>
|
|---|
| 240 | <p class="last">The same notes as for the <em>lists_db</em> parameter apply to this configuration
|
|---|
| 241 | parameter.</p>
|
|---|
| 242 | </div>
|
|---|
| 243 | </div>
|
|---|
| 244 | </div>
|
|---|
| 245 | <div class="section" id="archive">
|
|---|
| [27] | 246 | <span id="configuration-daemon-archive"></span><h3><a class="toc-backref" href="#id42">archive</a><a class="headerlink" href="#archive" title="Permalink to this headline">¶</a></h3>
|
|---|
| [13] | 247 | <p>This section contains the configuration parameters that modify the way the
|
|---|
| 248 | daemon saves data to disk, using one of the storage backends.</p>
|
|---|
| 249 | <p>These are all the available parameters in this section:</p>
|
|---|
| 250 | <div class="section" id="enabled">
|
|---|
| [27] | 251 | <span id="configuration-daemon-archive-enabled"></span><h4><a class="toc-backref" href="#id43">enabled</a><a class="headerlink" href="#enabled" title="Permalink to this headline">¶</a></h4>
|
|---|
| [13] | 252 | <p>Default: <tt class="docutils literal"><span class="pre">true</span></tt></p>
|
|---|
| [16] | 253 | <p>Enables/disables the <em>archives</em> feature. When enabled, Mailjam saves copies of
|
|---|
| [13] | 254 | email address into an <em>archive</em>, so they can be read later, through a web
|
|---|
| 255 | interface.</p>
|
|---|
| 256 | <p>To disable that feature, set this to <tt class="docutils literal"><span class="pre">false</span></tt>.</p>
|
|---|
| 257 | <div class="admonition warning">
|
|---|
| 258 | <p class="first admonition-title">Warning</p>
|
|---|
| 259 | <p class="last">This feature is not ready yet, so it doesn’t matter if you set this to true
|
|---|
| 260 | or false</p>
|
|---|
| 261 | </div>
|
|---|
| 262 | </div>
|
|---|
| 263 | <div class="section" id="configuration-daemon-archive-backend">
|
|---|
| [27] | 264 | <span id="id4"></span><h4><a class="toc-backref" href="#id44">backend</a><a class="headerlink" href="#configuration-daemon-archive-backend" title="Permalink to this headline">¶</a></h4>
|
|---|
| [13] | 265 | <p>Default: <tt class="docutils literal"><span class="pre">json</span></tt></p>
|
|---|
| 266 | <p>Sets the type of backend used to store messages into the archive.</p>
|
|---|
| 267 | <div class="admonition warning">
|
|---|
| 268 | <p class="first admonition-title">Warning</p>
|
|---|
| 269 | <p class="last">This feature is not ready yet.</p>
|
|---|
| 270 | </div>
|
|---|
| 271 | </div>
|
|---|
| 272 | <div class="section" id="configuration-daemon-archive-path">
|
|---|
| [27] | 273 | <span id="id5"></span><h4><a class="toc-backref" href="#id45">path</a><a class="headerlink" href="#configuration-daemon-archive-path" title="Permalink to this headline">¶</a></h4>
|
|---|
| [16] | 274 | <p>Default: <tt class="docutils literal"><span class="pre">/usr/local/mailjam/archives</span></tt></p>
|
|---|
| [13] | 275 | <p>Path to the directory where the archives will be saved.</p>
|
|---|
| 276 | <div class="admonition warning">
|
|---|
| 277 | <p class="first admonition-title">Warning</p>
|
|---|
| 278 | <p class="last">This feature is not ready yet.</p>
|
|---|
| 279 | </div>
|
|---|
| 280 | </div>
|
|---|
| 281 | </div>
|
|---|
| 282 | <div class="section" id="mailing-lists">
|
|---|
| [27] | 283 | <span id="configuration-daemon-mailing-lists"></span><h3><a class="toc-backref" href="#id46">mailing_lists</a><a class="headerlink" href="#mailing-lists" title="Permalink to this headline">¶</a></h3>
|
|---|
| [13] | 284 | <p>This section contains the configuration parameters that set the default
|
|---|
| 285 | behaviour for mailing lists.</p>
|
|---|
| 286 | <div class="admonition warning">
|
|---|
| 287 | <p class="first admonition-title">Warning</p>
|
|---|
| [16] | 288 | <p class="last">This parameters are not currently used in mailjam, we are still working
|
|---|
| [13] | 289 | on per-mailing-list configuration parameters.</p>
|
|---|
| 290 | </div>
|
|---|
| 291 | <p>These are all the available parameters in this section:</p>
|
|---|
| 292 | <div class="section" id="private">
|
|---|
| [27] | 293 | <span id="configuration-daemon-mailing-lists-private"></span><h4><a class="toc-backref" href="#id47">private</a><a class="headerlink" href="#private" title="Permalink to this headline">¶</a></h4>
|
|---|
| [13] | 294 | <p>Default: <tt class="docutils literal"><span class="pre">true</span></tt></p>
|
|---|
| 295 | <p>Sets if a given mailing list is <em>private</em> (only registered members can send
|
|---|
| 296 | messages to the list) or not (anyone can send messages to the list).</p>
|
|---|
| 297 | <p>If <tt class="docutils literal"><span class="pre">false</span></tt>, by default all new lists will not be private.</p>
|
|---|
| 298 | </div>
|
|---|
| 299 | </div>
|
|---|
| 300 | <div class="section" id="members">
|
|---|
| [27] | 301 | <span id="configuration-daemon-members"></span><h3><a class="toc-backref" href="#id48">members</a><a class="headerlink" href="#members" title="Permalink to this headline">¶</a></h3>
|
|---|
| [13] | 302 | <p>This section contains the configuration parameters that set the default
|
|---|
| 303 | behaviour for members.</p>
|
|---|
| 304 | <div class="admonition warning">
|
|---|
| 305 | <p class="first admonition-title">Warning</p>
|
|---|
| [16] | 306 | <p class="last">This parameters are not currently used in mailjam, we are still working
|
|---|
| [13] | 307 | on per-member configuration parameters.</p>
|
|---|
| 308 | </div>
|
|---|
| 309 | <p>These are all the available parameters in this section:</p>
|
|---|
| 310 | <div class="section" id="auto-signup">
|
|---|
| [27] | 311 | <span id="configuration-daemon-members-auto-signup"></span><h4><a class="toc-backref" href="#id49">auto_signup</a><a class="headerlink" href="#auto-signup" title="Permalink to this headline">¶</a></h4>
|
|---|
| [13] | 312 | <p>Default: <tt class="docutils literal"><span class="pre">false</span></tt></p>
|
|---|
| 313 | <p>Enables/disables auto-registration of members to mailing lists through a public
|
|---|
| 314 | web application. If <tt class="docutils literal"><span class="pre">true</span></tt>, users can register themselves into mailing lists
|
|---|
| 315 | using a public web interface. If <tt class="docutils literal"><span class="pre">false</span></tt>, only mailing lists administrators
|
|---|
| 316 | will be able to add new members to the list.</p>
|
|---|
| 317 | </div>
|
|---|
| 318 | <div class="section" id="allow-chpasswd">
|
|---|
| [27] | 319 | <span id="configuration-daemon-members-allow-chpasswd"></span><h4><a class="toc-backref" href="#id50">allow_chpasswd</a><a class="headerlink" href="#allow-chpasswd" title="Permalink to this headline">¶</a></h4>
|
|---|
| [13] | 320 | <p>Default: <tt class="docutils literal"><span class="pre">false</span></tt></p>
|
|---|
| 321 | <p>Enables/disables the option to update passwords by the members themselves.</p>
|
|---|
| 322 | <p>If <tt class="docutils literal"><span class="pre">true</span></tt>, members of a mailing list will be able to update their passwords
|
|---|
| 323 | using a public web interface. If <tt class="docutils literal"><span class="pre">false</span></tt>, only mailing lists administrators
|
|---|
| 324 | will be able to reset those passwords.</p>
|
|---|
| [27] | 325 | </div>
|
|---|
| 326 | </div>
|
|---|
| 327 | </div>
|
|---|
| 328 | <div class="section" id="mailjam-mta-client-configuration-file-mailjam-mta-conf">
|
|---|
| 329 | <span id="configuration-mta-client"></span><h2><a class="toc-backref" href="#id51">Mailjam MTA client configuration file - mailjam-mta.conf</a><a class="headerlink" href="#mailjam-mta-client-configuration-file-mailjam-mta-conf" title="Permalink to this headline">¶</a></h2>
|
|---|
| 330 | <p>This file contains all the parameters to configure the
|
|---|
| 331 | <a class="reference internal" href="overview.html#overview-mailjam-mta-client"><em>MTA client</em></a> properly. It contains ini-style <a class="footnote-reference" href="#id24" id="id6">[1]</a>
|
|---|
| 332 | configuration parameters, separated in different <em>categories</em>.</p>
|
|---|
| 333 | <div class="admonition note">
|
|---|
| 334 | <p class="first admonition-title">Note</p>
|
|---|
| 335 | <p>The mailjam-mta.conf file will be installed in different locations
|
|---|
| 336 | depending on your setup. The usual locations are:</p>
|
|---|
| 337 | <ul class="simple">
|
|---|
| 338 | <li><em>/etc/mailjam/mailjam-mta.conf</em> - In most Linux systems (like archlinux,
|
|---|
| 339 | gentoo, fedora, debian, ubuntu, etc)</li>
|
|---|
| 340 | <li><em>/usr/local/etc/mailjam/mailjam-mta.conf</em> - In most BSD systems (like
|
|---|
| 341 | FreeBSD, OpenBSD, NetBSD, etc)</li>
|
|---|
| 342 | </ul>
|
|---|
| 343 | <p class="last">There is a copy of the configuration file in the <em>conf/</em> directory, within
|
|---|
| 344 | the sources.</p>
|
|---|
| 345 | </div>
|
|---|
| 346 | <div class="section" id="server">
|
|---|
| 347 | <span id="configuration-mta-client-server"></span><h3><a class="toc-backref" href="#id52">server</a><a class="headerlink" href="#server" title="Permalink to this headline">¶</a></h3>
|
|---|
| 348 | <p>This section contains the configuration parameters that tell the MTA client
|
|---|
| 349 | where to connect when trying to interact with the
|
|---|
| 350 | <a class="reference internal" href="overview.html#overview-mailjam-daemon"><em>Mailjam daemon</em></a>.</p>
|
|---|
| 351 | <p>These are all the available parameters in this section:</p>
|
|---|
| 352 | <div class="section" id="configuration-mta-client-server-address">
|
|---|
| 353 | <span id="id7"></span><h4><a class="toc-backref" href="#id53">address</a><a class="headerlink" href="#configuration-mta-client-server-address" title="Permalink to this headline">¶</a></h4>
|
|---|
| 354 | <p>Default: <tt class="docutils literal"><span class="pre">localhost</span></tt></p>
|
|---|
| 355 | <p>The address where the daemon is listening for XMLRPC requests. This is
|
|---|
| 356 | the address to where the client will try to connect to.</p>
|
|---|
| 357 | </div>
|
|---|
| 358 | <div class="section" id="configuration-mta-client-server-port">
|
|---|
| 359 | <span id="id8"></span><h4><a class="toc-backref" href="#id54">port</a><a class="headerlink" href="#configuration-mta-client-server-port" title="Permalink to this headline">¶</a></h4>
|
|---|
| 360 | <p>Default: <tt class="docutils literal"><span class="pre">9876</span></tt></p>
|
|---|
| 361 | <p>The port where the daemon accepts incoming XMLRPC requests. This is the
|
|---|
| 362 | port to where the client will try to connect to.</p>
|
|---|
| 363 | </div>
|
|---|
| 364 | <div class="section" id="uri">
|
|---|
| 365 | <span id="configuration-mta-client-server-uri"></span><h4><a class="toc-backref" href="#id55">uri</a><a class="headerlink" href="#uri" title="Permalink to this headline">¶</a></h4>
|
|---|
| 366 | <p>Default: <a class="reference external" href="http://localhost:9876">http://localhost:9876</a></p>
|
|---|
| 367 | <p>This is the URI <a class="footnote-reference" href="#id27" id="id9">[4]</a> to where the client will connect to. It is constructed
|
|---|
| 368 | based on the values of the <a class="reference internal" href="#configuration-mta-client-server-address"><em>address</em></a>
|
|---|
| 369 | and <a class="reference internal" href="#configuration-mta-client-server-port"><em>port</em></a> parameters.</p>
|
|---|
| 370 | <div class="admonition note">
|
|---|
| 371 | <p class="first admonition-title">Note</p>
|
|---|
| 372 | <p>The default configuration file contains a dynamic setting for this
|
|---|
| 373 | parameter:</p>
|
|---|
| 374 | <div class="highlight-python"><pre>uri = http://%(address)s:%(port)s</pre>
|
|---|
| 375 | </div>
|
|---|
| 376 | <p class="last">That means that the parameter will inherit the values from the
|
|---|
| 377 | <a class="reference internal" href="#configuration-mta-client-server-address"><em>address</em></a>
|
|---|
| 378 | and <a class="reference internal" href="#configuration-mta-client-server-port"><em>port</em></a> parameters.</p>
|
|---|
| 379 | </div>
|
|---|
| 380 | <div class="admonition-see-also admonition seealso">
|
|---|
| 381 | <p class="first admonition-title">See also</p>
|
|---|
| 382 | <p>More information about this (and other tricks) here:</p>
|
|---|
| 383 | <p><a class="reference external" href="http://docs.python.org/library/configparser.html">http://docs.python.org/library/configparser.html</a></p>
|
|---|
| 384 | <p class="last"><a class="reference external" href="http://www.doughellmann.com/PyMOTW/ConfigParser">http://www.doughellmann.com/PyMOTW/ConfigParser</a></p>
|
|---|
| 385 | </div>
|
|---|
| 386 | <div class="admonition warning">
|
|---|
| 387 | <p class="first admonition-title">Warning</p>
|
|---|
| 388 | <p class="last">You can replace this with any URI you would like, <strong>this is the parameter
|
|---|
| 389 | that is really used for establishing new connections</strong> so be aware that if
|
|---|
| 390 | you remove the references to the
|
|---|
| 391 | <a class="reference internal" href="#configuration-mta-client-server-address"><em>address</em></a> and
|
|---|
| 392 | <a class="reference internal" href="#configuration-mta-client-server-port"><em>port</em></a> parameters, the values you have
|
|---|
| 393 | provided for those parameters will be ignored.</p>
|
|---|
| 394 | </div>
|
|---|
| 395 | </div>
|
|---|
| 396 | <div class="section" id="configuration-mta-client-server-ssl">
|
|---|
| 397 | <span id="id10"></span><h4><a class="toc-backref" href="#id56">ssl</a><a class="headerlink" href="#configuration-mta-client-server-ssl" title="Permalink to this headline">¶</a></h4>
|
|---|
| 398 | <p>Default: <tt class="docutils literal"><span class="pre">false</span></tt> (because ssl support hasn’t been added yet)</p>
|
|---|
| 399 | <p>Enables/disables SSL <a class="footnote-reference" href="#id26" id="id11">[3]</a> connections to the daemon. If <tt class="docutils literal"><span class="pre">false</span></tt> all the
|
|---|
| 400 | traffic to/from the server will travel unencrypted. If <tt class="docutils literal"><span class="pre">true</span></tt> all the traffic
|
|---|
| 401 | will travel encrypted.</p>
|
|---|
| 402 | <div class="admonition warning">
|
|---|
| 403 | <p class="first admonition-title">Warning</p>
|
|---|
| 404 | <p class="last">In order to enable SSL support in the client, you have to be sure the
|
|---|
| 405 | <a class="reference internal" href="overview.html#overview-mailjam-daemon"><em>Mailjam daemon</em></a> supports SSL too (check the
|
|---|
| 406 | <a class="reference internal" href="#configuration-daemon-xmlrpc-ssl"><em>ssl</em></a> parameter in the
|
|---|
| 407 | <a class="reference internal" href="#configuration-daemon-xmlrpc"><em>xmlrpc_server</em></a> section of the
|
|---|
| 408 | <a class="reference internal" href="#configuration-daemon"><em>daemon configuration file</em></a>)</p>
|
|---|
| 409 | </div>
|
|---|
| 410 | </div>
|
|---|
| 411 | </div>
|
|---|
| 412 | <div class="section" id="configuration-mta-client-archive">
|
|---|
| 413 | <span id="id12"></span><h3><a class="toc-backref" href="#id57">archive</a><a class="headerlink" href="#configuration-mta-client-archive" title="Permalink to this headline">¶</a></h3>
|
|---|
| 414 | <p>This section contains the configuration parameters that set where the files
|
|---|
| 415 | generated by the client will be stored/saved.</p>
|
|---|
| 416 | <div class="admonition-see-also admonition seealso">
|
|---|
| 417 | <p class="first admonition-title">See also</p>
|
|---|
| 418 | <p class="last">For more information about the kind of files the client does generate,
|
|---|
| 419 | take a look at the
|
|---|
| 420 | <a class="reference internal" href="overview.html#overview-mailjam-mta-client"><em>MTA client documentation</em></a>.</p>
|
|---|
| 421 | </div>
|
|---|
| 422 | <p>These are all the available parameters in this section:</p>
|
|---|
| 423 | <div class="section" id="persistent">
|
|---|
| 424 | <span id="configurtion-mta-client-archive-persistent"></span><h4><a class="toc-backref" href="#id58">persistent</a><a class="headerlink" href="#persistent" title="Permalink to this headline">¶</a></h4>
|
|---|
| 425 | <p>Default: <tt class="docutils literal"><span class="pre">true</span></tt></p>
|
|---|
| 426 | <p>Enables/disables the local archive for the client. If <tt class="docutils literal"><span class="pre">true</span></tt>, the client
|
|---|
| 427 | will save a copy of every email sent to the list in an internal archive,
|
|---|
| 428 | that could be checked/queried later. If <tt class="docutils literal"><span class="pre">false</span></tt>, the emails will not be
|
|---|
| 429 | kept on disk after being processed.</p>
|
|---|
| 430 | <div class="admonition warning">
|
|---|
| 431 | <p class="first admonition-title">Warning</p>
|
|---|
| 432 | <p class="last">This feature is not ready yet.</p>
|
|---|
| 433 | </div>
|
|---|
| 434 | </div>
|
|---|
| 435 | <div class="section" id="configuration-mta-client-archive-path">
|
|---|
| 436 | <span id="id13"></span><h4><a class="toc-backref" href="#id59">path</a><a class="headerlink" href="#configuration-mta-client-archive-path" title="Permalink to this headline">¶</a></h4>
|
|---|
| 437 | <p>Default: <tt class="docutils literal"><span class="pre">/usr/local/mailjam/archive-mta</span></tt></p>
|
|---|
| 438 | <p>Path to the directory where the archives will be saved.</p>
|
|---|
| 439 | <div class="admonition warning">
|
|---|
| 440 | <p class="first admonition-title">Warning</p>
|
|---|
| 441 | <p class="last">This feature is not ready yet.</p>
|
|---|
| 442 | </div>
|
|---|
| 443 | </div>
|
|---|
| 444 | </div>
|
|---|
| 445 | </div>
|
|---|
| 446 | <div class="section" id="mailjam-cli-client-configuration-file-mailjam-cli-conf">
|
|---|
| 447 | <span id="configuration-cli-client"></span><h2><a class="toc-backref" href="#id60">Mailjam CLI client configuration file - mailjam-cli.conf</a><a class="headerlink" href="#mailjam-cli-client-configuration-file-mailjam-cli-conf" title="Permalink to this headline">¶</a></h2>
|
|---|
| 448 | <p>This file contains all the parameters to configure the
|
|---|
| 449 | <a class="reference internal" href="overview.html#overview-mailjam-cli-client"><em>CLI client</em></a> properly. It contains ini-style <a class="footnote-reference" href="#id24" id="id14">[1]</a>
|
|---|
| 450 | configuration parameters, separated in different <em>categories</em>.</p>
|
|---|
| 451 | <div class="admonition note">
|
|---|
| 452 | <p class="first admonition-title">Note</p>
|
|---|
| 453 | <p>The mailjam-cli.conf file will be installed in different locations
|
|---|
| 454 | depending on your setup. The usual locations are:</p>
|
|---|
| 455 | <ul class="simple">
|
|---|
| 456 | <li><em>/etc/mailjam/mailjam-cli.conf</em> - In most Linux systems (like archlinux,
|
|---|
| 457 | gentoo, fedora, debian, ubuntu, etc)</li>
|
|---|
| 458 | <li><em>/usr/local/etc/mailjam/mailjam-cli.conf</em> - In most BSD systems (like
|
|---|
| 459 | FreeBSD, OpenBSD, NetBSD, etc)</li>
|
|---|
| 460 | </ul>
|
|---|
| 461 | <p class="last">There is a copy of the configuration file in the <em>conf/</em> directory, within
|
|---|
| 462 | the sources.</p>
|
|---|
| 463 | </div>
|
|---|
| 464 | <div class="section" id="configuration-cli-client-server">
|
|---|
| 465 | <span id="id15"></span><h3><a class="toc-backref" href="#id61">server</a><a class="headerlink" href="#configuration-cli-client-server" title="Permalink to this headline">¶</a></h3>
|
|---|
| 466 | <p>This section contains the configuration parameters that tell the cli client
|
|---|
| 467 | where to connect when trying to interact with the
|
|---|
| 468 | <a class="reference internal" href="overview.html#overview-mailjam-daemon"><em>Mailjam daemon</em></a>.</p>
|
|---|
| 469 | <p>These are all the available parameters in this section:</p>
|
|---|
| 470 | <div class="section" id="configuration-cli-client-server-address">
|
|---|
| 471 | <span id="id16"></span><h4><a class="toc-backref" href="#id62">address</a><a class="headerlink" href="#configuration-cli-client-server-address" title="Permalink to this headline">¶</a></h4>
|
|---|
| 472 | <p>Default: <tt class="docutils literal"><span class="pre">localhost</span></tt></p>
|
|---|
| 473 | <p>The address where the daemon is listening for XMLRPC requests. This is
|
|---|
| 474 | the address to where the client will try to connect to.</p>
|
|---|
| 475 | </div>
|
|---|
| 476 | <div class="section" id="configuration-cli-client-server-port">
|
|---|
| 477 | <span id="id17"></span><h4><a class="toc-backref" href="#id63">port</a><a class="headerlink" href="#configuration-cli-client-server-port" title="Permalink to this headline">¶</a></h4>
|
|---|
| 478 | <p>Default: <tt class="docutils literal"><span class="pre">9876</span></tt></p>
|
|---|
| 479 | <p>The port where the daemon accepts incoming XMLRPC requests. This is the
|
|---|
| 480 | port to where the client will try to connect to.</p>
|
|---|
| 481 | </div>
|
|---|
| 482 | <div class="section" id="configuration-cli-client-server-uri">
|
|---|
| 483 | <span id="id18"></span><h4><a class="toc-backref" href="#id64">uri</a><a class="headerlink" href="#configuration-cli-client-server-uri" title="Permalink to this headline">¶</a></h4>
|
|---|
| 484 | <p>Default: <a class="reference external" href="http://localhost:9876">http://localhost:9876</a></p>
|
|---|
| 485 | <p>This is the URI <a class="footnote-reference" href="#id27" id="id19">[4]</a> to where the client will connect to. It is constructed
|
|---|
| 486 | based on the values of the <a class="reference internal" href="#configuration-cli-client-server-address"><em>address</em></a>
|
|---|
| 487 | and <a class="reference internal" href="#configuration-cli-client-server-port"><em>port</em></a> parameters.</p>
|
|---|
| 488 | <div class="admonition note">
|
|---|
| 489 | <p class="first admonition-title">Note</p>
|
|---|
| 490 | <p>The default configuration file contains a dynamic setting for this
|
|---|
| 491 | parameter:</p>
|
|---|
| 492 | <div class="highlight-python"><pre>uri = http://%(address)s:%(port)s</pre>
|
|---|
| 493 | </div>
|
|---|
| 494 | <p class="last">That means that the parameter will inherit the values from the
|
|---|
| 495 | <a class="reference internal" href="#configuration-cli-client-server-address"><em>address</em></a>
|
|---|
| 496 | and <a class="reference internal" href="#configuration-cli-client-server-port"><em>port</em></a> parameters.</p>
|
|---|
| 497 | </div>
|
|---|
| 498 | <div class="admonition-see-also admonition seealso">
|
|---|
| 499 | <p class="first admonition-title">See also</p>
|
|---|
| 500 | <p>More information about this (and other tricks) here:</p>
|
|---|
| 501 | <p><a class="reference external" href="http://docs.python.org/library/configparser.html">http://docs.python.org/library/configparser.html</a></p>
|
|---|
| 502 | <p class="last"><a class="reference external" href="http://www.doughellmann.com/PyMOTW/ConfigParser">http://www.doughellmann.com/PyMOTW/ConfigParser</a></p>
|
|---|
| 503 | </div>
|
|---|
| 504 | <div class="admonition warning">
|
|---|
| 505 | <p class="first admonition-title">Warning</p>
|
|---|
| 506 | <p class="last">You can replace this with any URI you would like, <strong>this is the parameter
|
|---|
| 507 | that is really used for establishing new connections</strong> so be aware that if
|
|---|
| 508 | you remove the references to the
|
|---|
| 509 | <a class="reference internal" href="#configuration-cli-client-server-address"><em>address</em></a> and
|
|---|
| 510 | <a class="reference internal" href="#configuration-cli-client-server-port"><em>port</em></a> parameters, the values you have
|
|---|
| 511 | provided for those parameters will be ignored.</p>
|
|---|
| 512 | </div>
|
|---|
| 513 | </div>
|
|---|
| 514 | <div class="section" id="configuration-cli-client-server-ssl">
|
|---|
| 515 | <span id="id20"></span><h4><a class="toc-backref" href="#id65">ssl</a><a class="headerlink" href="#configuration-cli-client-server-ssl" title="Permalink to this headline">¶</a></h4>
|
|---|
| 516 | <p>Default: <tt class="docutils literal"><span class="pre">false</span></tt> (because ssl support hasn’t been added yet)</p>
|
|---|
| 517 | <p>Enables/disables SSL <a class="footnote-reference" href="#id26" id="id21">[3]</a> connections to the daemon. If <tt class="docutils literal"><span class="pre">false</span></tt> all the
|
|---|
| 518 | traffic to/from the server will travel unencrypted. If <tt class="docutils literal"><span class="pre">true</span></tt> all the traffic
|
|---|
| 519 | will travel encrypted.</p>
|
|---|
| 520 | <div class="admonition warning">
|
|---|
| 521 | <p class="first admonition-title">Warning</p>
|
|---|
| 522 | <p class="last">In order to enable SSL support in the client, you have to be sure the
|
|---|
| 523 | <a class="reference internal" href="overview.html#overview-mailjam-daemon"><em>Mailjam daemon</em></a> supports SSL too (check the
|
|---|
| 524 | <a class="reference internal" href="#configuration-daemon-xmlrpc-ssl"><em>ssl</em></a> parameter in the
|
|---|
| 525 | <a class="reference internal" href="#configuration-daemon-xmlrpc"><em>xmlrpc_server</em></a> section of the
|
|---|
| 526 | <a class="reference internal" href="#configuration-daemon"><em>daemon configuration file</em></a>)</p>
|
|---|
| 527 | </div>
|
|---|
| 528 | </div>
|
|---|
| 529 | </div>
|
|---|
| 530 | <div class="section" id="history">
|
|---|
| 531 | <span id="configuration-cli-client-history"></span><h3><a class="toc-backref" href="#id66">history</a><a class="headerlink" href="#history" title="Permalink to this headline">¶</a></h3>
|
|---|
| 532 | <p>This section contains the configuration parameters that set the behaviour
|
|---|
| 533 | of the client feature that allows it to save a history of commands provided
|
|---|
| 534 | by the user.</p>
|
|---|
| 535 | <p>These are all the available parameters in this section:</p>
|
|---|
| 536 | <div class="section" id="configurtion-cli-client-archive-enabled">
|
|---|
| 537 | <span id="id22"></span><h4><a class="toc-backref" href="#id67">enabled</a><a class="headerlink" href="#configurtion-cli-client-archive-enabled" title="Permalink to this headline">¶</a></h4>
|
|---|
| 538 | <p>Default: <tt class="docutils literal"><span class="pre">true</span></tt></p>
|
|---|
| 539 | <p>Enables/disables history support in the client. If <tt class="docutils literal"><span class="pre">true</span></tt> all commands
|
|---|
| 540 | provided by an user will be saved to disk. If <tt class="docutils literal"><span class="pre">false</span></tt> nothing will be
|
|---|
| 541 | written to disk.</p>
|
|---|
| 542 | </div>
|
|---|
| 543 | <div class="section" id="configuration-cli-client-history-path">
|
|---|
| 544 | <span id="id23"></span><h4><a class="toc-backref" href="#id68">path</a><a class="headerlink" href="#configuration-cli-client-history-path" title="Permalink to this headline">¶</a></h4>
|
|---|
| 545 | <p>Default: <tt class="docutils literal"><span class="pre">~/.mailjam/cli/history</span></tt></p>
|
|---|
| 546 | <p>Path to the file where the list of executed commands will be saved.</p>
|
|---|
| 547 | <table class="docutils footnote" frame="void" id="id24" rules="none">
|
|---|
| [13] | 548 | <colgroup><col class="label" /><col /></colgroup>
|
|---|
| 549 | <tbody valign="top">
|
|---|
| [27] | 550 | <tr><td class="label">[1]</td><td><em>(<a class="fn-backref" href="#id1">1</a>, <a class="fn-backref" href="#id6">2</a>, <a class="fn-backref" href="#id14">3</a>)</em> <a class="reference external" href="http://en.wikipedia.org/wiki/INI_file">http://en.wikipedia.org/wiki/INI_file</a></td></tr>
|
|---|
| [13] | 551 | </tbody>
|
|---|
| 552 | </table>
|
|---|
| [27] | 553 | <table class="docutils footnote" frame="void" id="id25" rules="none">
|
|---|
| [13] | 554 | <colgroup><col class="label" /><col /></colgroup>
|
|---|
| 555 | <tbody valign="top">
|
|---|
| 556 | <tr><td class="label"><a class="fn-backref" href="#id2">[2]</a></td><td><a class="reference external" href="http://en.wikipedia.org/wiki/XML-RPC">http://en.wikipedia.org/wiki/XML-RPC</a></td></tr>
|
|---|
| 557 | </tbody>
|
|---|
| 558 | </table>
|
|---|
| [27] | 559 | <table class="docutils footnote" frame="void" id="id26" rules="none">
|
|---|
| [13] | 560 | <colgroup><col class="label" /><col /></colgroup>
|
|---|
| 561 | <tbody valign="top">
|
|---|
| [27] | 562 | <tr><td class="label">[3]</td><td><em>(<a class="fn-backref" href="#id3">1</a>, <a class="fn-backref" href="#id11">2</a>, <a class="fn-backref" href="#id21">3</a>)</em> <a class="reference external" href="http://en.wikipedia.org/wiki/Secure_Socket_Layer">http://en.wikipedia.org/wiki/Secure_Socket_Layer</a></td></tr>
|
|---|
| 563 | </tbody>
|
|---|
| 564 | </table>
|
|---|
| 565 | <table class="docutils footnote" frame="void" id="id27" rules="none">
|
|---|
| 566 | <colgroup><col class="label" /><col /></colgroup>
|
|---|
| 567 | <tbody valign="top">
|
|---|
| 568 | <tr><td class="label">[4]</td><td><em>(<a class="fn-backref" href="#id9">1</a>, <a class="fn-backref" href="#id19">2</a>)</em> <a class="reference external" href="http://en.wikipedia.org/wiki/Uniform_resource_identifier">http://en.wikipedia.org/wiki/Uniform_resource_identifier</a></td></tr>
|
|---|
| [13] | 569 | </tbody>
|
|---|
| 570 | </table>
|
|---|
| 571 | </div>
|
|---|
| 572 | </div>
|
|---|
| 573 | </div>
|
|---|
| 574 | </div>
|
|---|
| 575 |
|
|---|
| 576 |
|
|---|
| 577 | </div>
|
|---|
| 578 | </div>
|
|---|
| 579 | </div>
|
|---|
| 580 | <div class="sphinxsidebar">
|
|---|
| 581 | <div class="sphinxsidebarwrapper">
|
|---|
| 582 | <h3><a href="index.html">Table Of Contents</a></h3>
|
|---|
| 583 | <ul>
|
|---|
| 584 | <li><a class="reference internal" href="#">Configuration</a><ul>
|
|---|
| [27] | 585 | <li><a class="reference internal" href="#mailjam-daemon-configuration-file-mailjam-conf">Mailjam daemon configuration file - mailjam.conf</a><ul>
|
|---|
| [13] | 586 | <li><a class="reference internal" href="#xmlrpc-server">xmlrpc_server</a><ul>
|
|---|
| 587 | <li><a class="reference internal" href="#address">address</a></li>
|
|---|
| 588 | <li><a class="reference internal" href="#port">port</a></li>
|
|---|
| 589 | <li><a class="reference internal" href="#ssl">ssl</a></li>
|
|---|
| 590 | <li><a class="reference internal" href="#ssl-key">ssl_key</a></li>
|
|---|
| 591 | <li><a class="reference internal" href="#ssl-crt">ssl_crt</a></li>
|
|---|
| 592 | <li><a class="reference internal" href="#logfile">logfile</a></li>
|
|---|
| 593 | </ul>
|
|---|
| 594 | </li>
|
|---|
| 595 | <li><a class="reference internal" href="#storage">storage</a><ul>
|
|---|
| 596 | <li><a class="reference internal" href="#backend">backend</a></li>
|
|---|
| 597 | <li><a class="reference internal" href="#path">path</a></li>
|
|---|
| 598 | <li><a class="reference internal" href="#lists-db">lists_db</a></li>
|
|---|
| 599 | <li><a class="reference internal" href="#members-db">members_db</a></li>
|
|---|
| 600 | </ul>
|
|---|
| 601 | </li>
|
|---|
| 602 | <li><a class="reference internal" href="#archive">archive</a><ul>
|
|---|
| 603 | <li><a class="reference internal" href="#enabled">enabled</a></li>
|
|---|
| 604 | <li><a class="reference internal" href="#configuration-daemon-archive-backend">backend</a></li>
|
|---|
| 605 | <li><a class="reference internal" href="#configuration-daemon-archive-path">path</a></li>
|
|---|
| 606 | </ul>
|
|---|
| 607 | </li>
|
|---|
| 608 | <li><a class="reference internal" href="#mailing-lists">mailing_lists</a><ul>
|
|---|
| 609 | <li><a class="reference internal" href="#private">private</a></li>
|
|---|
| 610 | </ul>
|
|---|
| 611 | </li>
|
|---|
| 612 | <li><a class="reference internal" href="#members">members</a><ul>
|
|---|
| 613 | <li><a class="reference internal" href="#auto-signup">auto_signup</a></li>
|
|---|
| 614 | <li><a class="reference internal" href="#allow-chpasswd">allow_chpasswd</a></li>
|
|---|
| 615 | </ul>
|
|---|
| 616 | </li>
|
|---|
| 617 | </ul>
|
|---|
| 618 | </li>
|
|---|
| [27] | 619 | <li><a class="reference internal" href="#mailjam-mta-client-configuration-file-mailjam-mta-conf">Mailjam MTA client configuration file - mailjam-mta.conf</a><ul>
|
|---|
| 620 | <li><a class="reference internal" href="#server">server</a><ul>
|
|---|
| 621 | <li><a class="reference internal" href="#configuration-mta-client-server-address">address</a></li>
|
|---|
| 622 | <li><a class="reference internal" href="#configuration-mta-client-server-port">port</a></li>
|
|---|
| 623 | <li><a class="reference internal" href="#uri">uri</a></li>
|
|---|
| 624 | <li><a class="reference internal" href="#configuration-mta-client-server-ssl">ssl</a></li>
|
|---|
| 625 | </ul>
|
|---|
| 626 | </li>
|
|---|
| 627 | <li><a class="reference internal" href="#configuration-mta-client-archive">archive</a><ul>
|
|---|
| 628 | <li><a class="reference internal" href="#persistent">persistent</a></li>
|
|---|
| 629 | <li><a class="reference internal" href="#configuration-mta-client-archive-path">path</a></li>
|
|---|
| 630 | </ul>
|
|---|
| 631 | </li>
|
|---|
| 632 | </ul>
|
|---|
| 633 | </li>
|
|---|
| 634 | <li><a class="reference internal" href="#mailjam-cli-client-configuration-file-mailjam-cli-conf">Mailjam CLI client configuration file - mailjam-cli.conf</a><ul>
|
|---|
| 635 | <li><a class="reference internal" href="#configuration-cli-client-server">server</a><ul>
|
|---|
| 636 | <li><a class="reference internal" href="#configuration-cli-client-server-address">address</a></li>
|
|---|
| 637 | <li><a class="reference internal" href="#configuration-cli-client-server-port">port</a></li>
|
|---|
| 638 | <li><a class="reference internal" href="#configuration-cli-client-server-uri">uri</a></li>
|
|---|
| 639 | <li><a class="reference internal" href="#configuration-cli-client-server-ssl">ssl</a></li>
|
|---|
| 640 | </ul>
|
|---|
| 641 | </li>
|
|---|
| 642 | <li><a class="reference internal" href="#history">history</a><ul>
|
|---|
| 643 | <li><a class="reference internal" href="#configurtion-cli-client-archive-enabled">enabled</a></li>
|
|---|
| 644 | <li><a class="reference internal" href="#configuration-cli-client-history-path">path</a></li>
|
|---|
| 645 | </ul>
|
|---|
| 646 | </li>
|
|---|
| 647 | </ul>
|
|---|
| 648 | </li>
|
|---|
| [13] | 649 | </ul>
|
|---|
| 650 | </li>
|
|---|
| 651 | </ul>
|
|---|
| 652 |
|
|---|
| 653 | <h4>Previous topic</h4>
|
|---|
| 654 | <p class="topless"><a href="install.html"
|
|---|
| 655 | title="previous chapter">Installation instructions</a></p>
|
|---|
| 656 | <h4>Next topic</h4>
|
|---|
| 657 | <p class="topless"><a href="running.html"
|
|---|
| [16] | 658 | title="next chapter">Running Mailjam</a></p>
|
|---|
| [13] | 659 | <h3>This Page</h3>
|
|---|
| 660 | <ul class="this-page-menu">
|
|---|
| 661 | <li><a href="_sources/configuration.txt"
|
|---|
| 662 | rel="nofollow">Show Source</a></li>
|
|---|
| 663 | </ul>
|
|---|
| 664 | <div id="searchbox" style="display: none">
|
|---|
| 665 | <h3>Quick search</h3>
|
|---|
| 666 | <form class="search" action="search.html" method="get">
|
|---|
| 667 | <input type="text" name="q" />
|
|---|
| 668 | <input type="submit" value="Go" />
|
|---|
| 669 | <input type="hidden" name="check_keywords" value="yes" />
|
|---|
| 670 | <input type="hidden" name="area" value="default" />
|
|---|
| 671 | </form>
|
|---|
| 672 | <p class="searchtip" style="font-size: 90%">
|
|---|
| 673 | Enter search terms or a module, class or function name.
|
|---|
| 674 | </p>
|
|---|
| 675 | </div>
|
|---|
| 676 | <script type="text/javascript">$('#searchbox').show(0);</script>
|
|---|
| 677 | </div>
|
|---|
| 678 | </div>
|
|---|
| 679 | <div class="clearer"></div>
|
|---|
| 680 | </div>
|
|---|
| 681 | <div class="related">
|
|---|
| 682 | <h3>Navigation</h3>
|
|---|
| 683 | <ul>
|
|---|
| 684 | <li class="right" style="margin-right: 10px">
|
|---|
| 685 | <a href="genindex.html" title="General Index"
|
|---|
| 686 | >index</a></li>
|
|---|
| 687 | <li class="right" >
|
|---|
| [16] | 688 | <a href="running.html" title="Running Mailjam"
|
|---|
| [13] | 689 | >next</a> |</li>
|
|---|
| 690 | <li class="right" >
|
|---|
| 691 | <a href="install.html" title="Installation instructions"
|
|---|
| 692 | >previous</a> |</li>
|
|---|
| [16] | 693 | <li><a href="index.html">Mailjam 0.1.0 documentation</a> »</li>
|
|---|
| [13] | 694 | </ul>
|
|---|
| 695 | </div>
|
|---|
| 696 | <div class="footer">
|
|---|
| 697 | © Copyright 2012, Soluciones Informaticas Codigo23 S.L.U..
|
|---|
| 698 | Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
|
|---|
| 699 | </div>
|
|---|
| 700 | </body>
|
|---|
| 701 | </html>
|
|---|
