| 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 |
|
|---|
| 11 | <title>Running Mailjam — Mailjam 0.1.0 documentation</title>
|
|---|
| 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>
|
|---|
| 28 | <link rel="top" title="Mailjam 0.1.0 documentation" href="index.html" />
|
|---|
| 29 | <link rel="next" title="Some examples" href="examples.html" />
|
|---|
| 30 | <link rel="prev" title="Configuration" href="configuration.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" >
|
|---|
| 40 | <a href="examples.html" title="Some examples"
|
|---|
| 41 | accesskey="N">next</a> |</li>
|
|---|
| 42 | <li class="right" >
|
|---|
| 43 | <a href="configuration.html" title="Configuration"
|
|---|
| 44 | accesskey="P">previous</a> |</li>
|
|---|
| 45 | <li><a href="index.html">Mailjam 0.1.0 documentation</a> »</li>
|
|---|
| 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="running-mailjam">
|
|---|
| 55 | <h1><a class="toc-backref" href="#id10">Running Mailjam</a><a class="headerlink" href="#running-mailjam" title="Permalink to this headline">¶</a></h1>
|
|---|
| 56 | <p>In order to run Mailjam, you have to run the different components, depending on
|
|---|
| 57 | what you want to do. Basically, you will need to run a server
|
|---|
| 58 | (<a class="reference internal" href="overview.html#overview-mailjam-daemon"><em>Mailjam daemon</em></a>) all the time, then you will need one
|
|---|
| 59 | <a class="reference internal" href="overview.html#overview-mailjam-mta-client"><em>MTA client</em></a> per mailing list.</p>
|
|---|
| 60 | <p>Ocasionally, you will need to add or delete a mailing list, or edit its
|
|---|
| 61 | information, members list, etc. To do that, you will have to run a Mailjam
|
|---|
| 62 | client (either the <a class="reference internal" href="overview.html#overview-mailjam-cli-client"><em>CLI client</em></a> or the
|
|---|
| 63 | <a class="reference internal" href="overview.html#overview-mailjam-web-client"><em>Web client</em></a>).</p>
|
|---|
| 64 | <p>Keep reading if you want to learn more about the way you can start each
|
|---|
| 65 | component, the different arguments/parameters you can provide on startup, etc.</p>
|
|---|
| 66 | <div class="admonition warning">
|
|---|
| 67 | <p class="first admonition-title">Warning</p>
|
|---|
| 68 | <p class="last">Remember that, before being able to run any component, you have to
|
|---|
| 69 | <a class="reference internal" href="install.html#install-setting-up-mailjam"><em>set up proper configuration files</em></a>. You
|
|---|
| 70 | can learn more about Mailjam configuration files in the
|
|---|
| 71 | <a class="reference internal" href="configuration.html"><em>configuration files documentation</em></a>.</p>
|
|---|
| 72 | </div>
|
|---|
| 73 | <div class="contents topic" id="contents">
|
|---|
| 74 | <p class="topic-title first">Contents</p>
|
|---|
| 75 | <ul class="simple">
|
|---|
| 76 | <li><a class="reference internal" href="#running-mailjam" id="id10">Running Mailjam</a><ul>
|
|---|
| 77 | <li><a class="reference internal" href="#the-daemon" id="id11">The daemon</a><ul>
|
|---|
| 78 | <li><a class="reference internal" href="#additional-parameters" id="id12">Additional parameters</a><ul>
|
|---|
| 79 | <li><a class="reference internal" href="#help" id="id13">–help</a></li>
|
|---|
| 80 | <li><a class="reference internal" href="#config" id="id14">–config</a></li>
|
|---|
| 81 | <li><a class="reference internal" href="#version" id="id15">–version</a></li>
|
|---|
| 82 | </ul>
|
|---|
| 83 | </li>
|
|---|
| 84 | </ul>
|
|---|
| 85 | </li>
|
|---|
| 86 | <li><a class="reference internal" href="#the-cli-client" id="id16">The CLI client</a></li>
|
|---|
| 87 | <li><a class="reference internal" href="#the-mta-client" id="id17">The MTA client</a><ul>
|
|---|
| 88 | <li><a class="reference internal" href="#quick-configuration-you-are-a-mail-servers-master" id="id18">Quick configuration (you are a mail-servers-master)</a></li>
|
|---|
| 89 | <li><a class="reference internal" href="#explained-configuration-you-really-want-to-know-what-s-happening-here" id="id19">Explained configuration (you really want to know what’s happening here)</a></li>
|
|---|
| 90 | <li><a class="reference internal" href="#running-mta-client-parameters" id="id20">Additional parameters</a><ul>
|
|---|
| 91 | <li><a class="reference internal" href="#running-mta-client-help" id="id21">–help</a></li>
|
|---|
| 92 | <li><a class="reference internal" href="#running-mta-client-config" id="id22">–config</a></li>
|
|---|
| 93 | <li><a class="reference internal" href="#running-mta-client-version" id="id23">–version</a></li>
|
|---|
| 94 | <li><a class="reference internal" href="#address-required" id="id24">–address (required)</a></li>
|
|---|
| 95 | <li><a class="reference internal" href="#input" id="id25">–input</a></li>
|
|---|
| 96 | </ul>
|
|---|
| 97 | </li>
|
|---|
| 98 | </ul>
|
|---|
| 99 | </li>
|
|---|
| 100 | <li><a class="reference internal" href="#the-web-client" id="id26">The Web client</a></li>
|
|---|
| 101 | </ul>
|
|---|
| 102 | </li>
|
|---|
| 103 | </ul>
|
|---|
| 104 | </div>
|
|---|
| 105 | <div class="section" id="the-daemon">
|
|---|
| 106 | <span id="running-daemon"></span><h2><a class="toc-backref" href="#id11">The daemon</a><a class="headerlink" href="#the-daemon" title="Permalink to this headline">¶</a></h2>
|
|---|
| 107 | <p>First component you should start is the <a class="reference internal" href="overview.html#overview-mailjam-daemon"><em>Mailjam daemon</em></a>. It is
|
|---|
| 108 | quite easy, just run this command from a shell/console:</p>
|
|---|
| 109 | <div class="highlight-python"><div class="highlight"><pre><span class="n">mailjam</span><span class="o">-</span><span class="n">server</span>
|
|---|
| 110 | </pre></div>
|
|---|
| 111 | </div>
|
|---|
| 112 | <p>The server process will read the <a class="reference internal" href="configuration.html#configuration-daemon"><em>mailjam.conf</em></a>
|
|---|
| 113 | configuration file, will prepare everything and will start listening for XMLRPC
|
|---|
| 114 | requests on <em>localhost:9876</em></p>
|
|---|
| 115 | <div class="admonition warning">
|
|---|
| 116 | <p class="first admonition-title">Warning</p>
|
|---|
| 117 | <p class="last"><em>localhost:9876</em> is the default value provided by the default configuration
|
|---|
| 118 | files. If you have modified that, it will be a different <em>address:port</em>
|
|---|
| 119 | combination.</p>
|
|---|
| 120 | </div>
|
|---|
| 121 | <div class="admonition warning">
|
|---|
| 122 | <p class="first admonition-title">Warning</p>
|
|---|
| 123 | <p class="last">If you didn’t add a valid configuration file to one of the
|
|---|
| 124 | <a class="reference internal" href="install.html#install-setting-up-mailjam"><em>default paths</em></a>, the server will refuse to
|
|---|
| 125 | start, giving you an error message.</p>
|
|---|
| 126 | </div>
|
|---|
| 127 | <div class="admonition warning">
|
|---|
| 128 | <p class="first admonition-title">Warning</p>
|
|---|
| 129 | <p class="last">As of the current version of Mailjam, there are no pre-made init scripts that
|
|---|
| 130 | can handle the start/stop/restart of the daemon, but those will be added in
|
|---|
| 131 | one of the future releases.</p>
|
|---|
| 132 | </div>
|
|---|
| 133 | <div class="section" id="additional-parameters">
|
|---|
| 134 | <span id="running-daemon-parameters"></span><h3><a class="toc-backref" href="#id12">Additional parameters</a><a class="headerlink" href="#additional-parameters" title="Permalink to this headline">¶</a></h3>
|
|---|
| 135 | <p>You can pass some parameters to <em>mailjam-server</em> to modify the behaviour of
|
|---|
| 136 | the daemon or get more information.</p>
|
|---|
| 137 | <div class="admonition note">
|
|---|
| 138 | <p class="first admonition-title">Note</p>
|
|---|
| 139 | <p class="last">Remember that the proper way to modify the behaviour of the daemon is
|
|---|
| 140 | editing its configuration file, <a class="reference internal" href="configuration.html#configuration-daemon"><em>mailjam.conf</em></a></p>
|
|---|
| 141 | </div>
|
|---|
| 142 | <div class="section" id="help">
|
|---|
| 143 | <span id="running-daemon-help"></span><h4><a class="toc-backref" href="#id13">–help</a><a class="headerlink" href="#help" title="Permalink to this headline">¶</a></h4>
|
|---|
| 144 | <p>You can get some help by passing the <em>-h</em> or <em>–help</em> parameters:</p>
|
|---|
| 145 | <div class="highlight-python"><div class="highlight"><pre><span class="n">mailjam</span><span class="o">-</span><span class="n">server</span> <span class="o">-</span><span class="n">h</span>
|
|---|
| 146 | </pre></div>
|
|---|
| 147 | </div>
|
|---|
| 148 | <div class="highlight-python"><div class="highlight"><pre><span class="n">mailjam</span><span class="o">-</span><span class="n">server</span> <span class="o">--</span><span class="n">help</span>
|
|---|
| 149 | </pre></div>
|
|---|
| 150 | </div>
|
|---|
| 151 | </div>
|
|---|
| 152 | <div class="section" id="config">
|
|---|
| 153 | <span id="running-daemon-config"></span><h4><a class="toc-backref" href="#id14">–config</a><a class="headerlink" href="#config" title="Permalink to this headline">¶</a></h4>
|
|---|
| 154 | <p>You can set the path to the config file the server will load on startup,
|
|---|
| 155 | passing the <em>-c</em> or <em>–config</em> parameters:</p>
|
|---|
| 156 | <div class="highlight-python"><div class="highlight"><pre><span class="n">mailjam</span><span class="o">-</span><span class="n">server</span> <span class="o">-</span><span class="n">c</span> <span class="o">/</span><span class="n">home</span><span class="o">/</span><span class="n">mailjam</span><span class="o">/</span><span class="n">mailjam</span><span class="o">.</span><span class="n">conf</span>
|
|---|
| 157 | </pre></div>
|
|---|
| 158 | </div>
|
|---|
| 159 | <div class="highlight-python"><div class="highlight"><pre><span class="n">mailjam</span><span class="o">-</span><span class="n">server</span> <span class="o">--</span><span class="n">config</span> <span class="o">/</span><span class="n">home</span><span class="o">/</span><span class="n">mailjam</span><span class="o">/</span><span class="n">mailjam</span><span class="o">.</span><span class="n">conf</span>
|
|---|
| 160 | </pre></div>
|
|---|
| 161 | </div>
|
|---|
| 162 | <div class="admonition warning">
|
|---|
| 163 | <p class="first admonition-title">Warning</p>
|
|---|
| 164 | <p class="last">If the file does not exist, or if it is not a valid configuration file,
|
|---|
| 165 | an error will be shown and the daemon will refuse to start.</p>
|
|---|
| 166 | </div>
|
|---|
| 167 | </div>
|
|---|
| 168 | <div class="section" id="version">
|
|---|
| 169 | <span id="running-daemon-version"></span><h4><a class="toc-backref" href="#id15">–version</a><a class="headerlink" href="#version" title="Permalink to this headline">¶</a></h4>
|
|---|
| 170 | <p>You can check the version of the mailjam server you are trying to run by
|
|---|
| 171 | passing the <em>-v</em> or <em>–version</em> parameters:</p>
|
|---|
| 172 | <div class="highlight-python"><div class="highlight"><pre><span class="n">mailjam</span><span class="o">-</span><span class="n">server</span> <span class="o">-</span><span class="n">v</span>
|
|---|
| 173 | </pre></div>
|
|---|
| 174 | </div>
|
|---|
| 175 | <div class="highlight-python"><div class="highlight"><pre><span class="n">mailjam</span><span class="o">-</span><span class="n">server</span> <span class="o">--</span><span class="n">version</span>
|
|---|
| 176 | </pre></div>
|
|---|
| 177 | </div>
|
|---|
| 178 | </div>
|
|---|
| 179 | </div>
|
|---|
| 180 | </div>
|
|---|
| 181 | <div class="section" id="the-cli-client">
|
|---|
| 182 | <span id="running-cli-client"></span><h2><a class="toc-backref" href="#id16">The CLI client</a><a class="headerlink" href="#the-cli-client" title="Permalink to this headline">¶</a></h2>
|
|---|
| 183 | </div>
|
|---|
| 184 | <div class="section" id="the-mta-client">
|
|---|
| 185 | <span id="running-mta-client"></span><h2><a class="toc-backref" href="#id17">The MTA client</a><a class="headerlink" href="#the-mta-client" title="Permalink to this headline">¶</a></h2>
|
|---|
| 186 | <p>Once you have your <a class="reference internal" href="#running-daemon"><em>daemon running</em></a>, you have to add
|
|---|
| 187 | as many <a class="reference internal" href="overview.html#overview-mailjam-mta-client"><em>MTA clients</em></a> as mailing lists you
|
|---|
| 188 | want to manage to your mail server.</p>
|
|---|
| 189 | <div class="section" id="quick-configuration-you-are-a-mail-servers-master">
|
|---|
| 190 | <span id="running-mta-client-quick"></span><h3><a class="toc-backref" href="#id18">Quick configuration (you are a mail-servers-master)</a><a class="headerlink" href="#quick-configuration-you-are-a-mail-servers-master" title="Permalink to this headline">¶</a></h3>
|
|---|
| 191 | <p>Edit your mail server aliases file <a class="footnote-reference" href="#id8" id="id1">[1]</a> (probably <em>/etc/aliases</em> or
|
|---|
| 192 | <em>/etc/mail/aliases</em>) and add an entry like:</p>
|
|---|
| 193 | <div class="highlight-python"><pre>list@mydomain.com: "|/usr/local/bin/mailjam-mta -a list@mydomain.com -i -"</pre>
|
|---|
| 194 | </div>
|
|---|
| 195 | <div class="admonition warning">
|
|---|
| 196 | <p class="first admonition-title">Warning</p>
|
|---|
| 197 | <p class="last">replace <em>list@mydomain.com</em> with the real address of your mailing list</p>
|
|---|
| 198 | </div>
|
|---|
| 199 | <div class="admonition warning">
|
|---|
| 200 | <p class="first admonition-title">Warning</p>
|
|---|
| 201 | <p class="last">replace <em>/usr/local/bin/mailjam-mta</em> with the real path to your mailjam-mta
|
|---|
| 202 | installation</p>
|
|---|
| 203 | </div>
|
|---|
| 204 | <p>Rebuild your <em>aliases</em> database:</p>
|
|---|
| 205 | <div class="highlight-python"><div class="highlight"><pre><span class="n">newaliases</span>
|
|---|
| 206 | </pre></div>
|
|---|
| 207 | </div>
|
|---|
| 208 | <div class="admonition warning">
|
|---|
| 209 | <p class="first admonition-title">Warning</p>
|
|---|
| 210 | <p class="last">Refer to your OS documentation to see how you can rebuild <em>aliases</em>. In most
|
|---|
| 211 | unix-like systems it is done by the newaliases <a class="footnote-reference" href="#id9" id="id2">[2]</a> command.</p>
|
|---|
| 212 | </div>
|
|---|
| 213 | </div>
|
|---|
| 214 | <div class="section" id="explained-configuration-you-really-want-to-know-what-s-happening-here">
|
|---|
| 215 | <span id="running-mta-client-explained"></span><h3><a class="toc-backref" href="#id19">Explained configuration (you really want to know what’s happening here)</a><a class="headerlink" href="#explained-configuration-you-really-want-to-know-what-s-happening-here" title="Permalink to this headline">¶</a></h3>
|
|---|
| 216 | <p>When new messages arrive at your mail server for your mailing list address
|
|---|
| 217 | (let’s use the example address <em>list@mydomain.com</em>) one of the steps in the
|
|---|
| 218 | process that checks the message, it’s origin, destination, contents, etc is
|
|---|
| 219 | the step where the mail server checks its internal <em>aliases</em> database, that is,
|
|---|
| 220 | a list of <em>special</em> addresses that, instead of being <em>real</em> addresses, they are
|
|---|
| 221 | related to some other addresses in some way.</p>
|
|---|
| 222 | <p>Most MTAs out there support one very <em>convenient</em> feature that is to <em>pipe</em> the
|
|---|
| 223 | contents of the message (headers and body) to a given shell command. That means
|
|---|
| 224 | that the all the received data will be sent to an external command for it to
|
|---|
| 225 | process such data.</p>
|
|---|
| 226 | <p><strong>Here is where mailjam-mta comes in</strong>.</p>
|
|---|
| 227 | <p>What you have to do is just tell your mail server that all messages with
|
|---|
| 228 | destination <em>list@mydomain.com</em> (to keep using the same example address) will be
|
|---|
| 229 | <em>piped</em> to mailman-mta. The Mailjam MTA client will then know what to do with
|
|---|
| 230 | the message, performing some checks and re-sending it to the proper destinations
|
|---|
| 231 | (the members/suscriptors of the given mailing list).</p>
|
|---|
| 232 | <p>So, first thing you have to find out is <strong>where is your aliases file?</strong>.</p>
|
|---|
| 233 | <p>In unix-like systems, like the different Linux distributions or the different
|
|---|
| 234 | BSD flavours, that file is <em>/etc/mail/aliases</em> or <em>/etc/aliases</em> (usually one is
|
|---|
| 235 | a simbolic link to the other).</p>
|
|---|
| 236 | <div class="admonition note">
|
|---|
| 237 | <p class="first admonition-title">Note</p>
|
|---|
| 238 | <p>Usually the aliases file contains some lines like:</p>
|
|---|
| 239 | <div class="last highlight-python"><pre>MAILER-DAEMON: postmaster
|
|---|
| 240 | postmaster: root</pre>
|
|---|
| 241 | </div>
|
|---|
| 242 | </div>
|
|---|
| 243 | <p>Once you’ve found out where the file is, edit it and add this line to the bottom
|
|---|
| 244 | of the file:</p>
|
|---|
| 245 | <div class="highlight-python"><pre>list@mydomain.com: "|/usr/local/bin/mailjam-mta -a list@mydomain.com -i -"</pre>
|
|---|
| 246 | </div>
|
|---|
| 247 | <div class="admonition warning">
|
|---|
| 248 | <p class="first admonition-title">Warning</p>
|
|---|
| 249 | <p class="last">replace <em>list@mydomain.com</em> with the real address of your mailing list</p>
|
|---|
| 250 | </div>
|
|---|
| 251 | <div class="admonition warning">
|
|---|
| 252 | <p class="first admonition-title">Warning</p>
|
|---|
| 253 | <p class="last">replace <em>/usr/local/bin/mailjam-mta</em> with the real path to your mailjam-mta
|
|---|
| 254 | installation</p>
|
|---|
| 255 | </div>
|
|---|
| 256 | <p>There you are telling your mail server that any message coming <strong>to</strong>
|
|---|
| 257 | <em>list@mydomain.com</em> will be passed to the mailjam-mta command, passing some
|
|---|
| 258 | parameters to it:</p>
|
|---|
| 259 | <ul class="simple">
|
|---|
| 260 | <li><strong>-a list@mydomain.com</strong> tells mailjam-mta that the message is actually for
|
|---|
| 261 | that mailing list. The MTA client will then use that value to check (against
|
|---|
| 262 | the mailjam daemon) if it is a valid mailing list.</li>
|
|---|
| 263 | <li><strong>-i -</strong> tells mailjam-mta that the message will be <em>piped</em> directly. This is
|
|---|
| 264 | important, as mailjam-mta can read the messages from files, but in this case
|
|---|
| 265 | the mail server will <em>pipe</em> the data directly to mailjam-mta.</li>
|
|---|
| 266 | </ul>
|
|---|
| 267 | <p>Once you’ve added that line to your <em>aliases</em> file, you have to rebuild your
|
|---|
| 268 | <em>aliases</em> database:</p>
|
|---|
| 269 | <div class="highlight-python"><div class="highlight"><pre><span class="n">newaliases</span>
|
|---|
| 270 | </pre></div>
|
|---|
| 271 | </div>
|
|---|
| 272 | <div class="admonition warning">
|
|---|
| 273 | <p class="first admonition-title">Warning</p>
|
|---|
| 274 | <p class="last">Refer to your OS documentation to see how you can rebuild <em>aliases</em>. In most
|
|---|
| 275 | unix-like systems it is done by the newaliases <a class="footnote-reference" href="#id9" id="id3">[2]</a> command.</p>
|
|---|
| 276 | </div>
|
|---|
| 277 | <p>And you are done. Everything is ready now.</p>
|
|---|
| 278 | </div>
|
|---|
| 279 | <div class="section" id="running-mta-client-parameters">
|
|---|
| 280 | <span id="id4"></span><h3><a class="toc-backref" href="#id20">Additional parameters</a><a class="headerlink" href="#running-mta-client-parameters" title="Permalink to this headline">¶</a></h3>
|
|---|
| 281 | <p>You can pass some parameters to <em>mailjam-mta</em> to modify the behaviour of
|
|---|
| 282 | the client or get more information.</p>
|
|---|
| 283 | <div class="admonition note">
|
|---|
| 284 | <p class="first admonition-title">Note</p>
|
|---|
| 285 | <p class="last">Remember that the proper way to modify the behaviour of the client is
|
|---|
| 286 | editing its configuration file,
|
|---|
| 287 | <a class="reference internal" href="configuration.html#configuration-mta-client"><em>mailjam-mta.conf</em></a></p>
|
|---|
| 288 | </div>
|
|---|
| 289 | <div class="section" id="running-mta-client-help">
|
|---|
| 290 | <span id="id5"></span><h4><a class="toc-backref" href="#id21">–help</a><a class="headerlink" href="#running-mta-client-help" title="Permalink to this headline">¶</a></h4>
|
|---|
| 291 | <p>You can get some help by passing the <em>-h</em> or <em>–help</em> parameters:</p>
|
|---|
| 292 | <div class="highlight-python"><div class="highlight"><pre><span class="n">mailjam</span><span class="o">-</span><span class="n">mta</span> <span class="o">-</span><span class="n">h</span>
|
|---|
| 293 | </pre></div>
|
|---|
| 294 | </div>
|
|---|
| 295 | <div class="highlight-python"><div class="highlight"><pre><span class="n">mailjam</span><span class="o">-</span><span class="n">mta</span> <span class="o">--</span><span class="n">help</span>
|
|---|
| 296 | </pre></div>
|
|---|
| 297 | </div>
|
|---|
| 298 | </div>
|
|---|
| 299 | <div class="section" id="running-mta-client-config">
|
|---|
| 300 | <span id="id6"></span><h4><a class="toc-backref" href="#id22">–config</a><a class="headerlink" href="#running-mta-client-config" title="Permalink to this headline">¶</a></h4>
|
|---|
| 301 | <p>You can set the path to the config file the client will load on startup,
|
|---|
| 302 | passing the <em>-c</em> or <em>–config</em> parameters:</p>
|
|---|
| 303 | <div class="highlight-python"><div class="highlight"><pre><span class="n">mailjam</span><span class="o">-</span><span class="n">mta</span> <span class="o">-</span><span class="n">c</span> <span class="o">/</span><span class="n">home</span><span class="o">/</span><span class="n">mailjam</span><span class="o">/</span><span class="n">mailjam</span><span class="o">-</span><span class="n">mta</span><span class="o">.</span><span class="n">conf</span>
|
|---|
| 304 | </pre></div>
|
|---|
| 305 | </div>
|
|---|
| 306 | <div class="highlight-python"><div class="highlight"><pre><span class="n">mailjam</span><span class="o">-</span><span class="n">mta</span> <span class="o">--</span><span class="n">config</span> <span class="o">/</span><span class="n">home</span><span class="o">/</span><span class="n">mailjam</span><span class="o">/</span><span class="n">mailjam</span><span class="o">-</span><span class="n">mta</span><span class="o">.</span><span class="n">conf</span>
|
|---|
| 307 | </pre></div>
|
|---|
| 308 | </div>
|
|---|
| 309 | <div class="admonition warning">
|
|---|
| 310 | <p class="first admonition-title">Warning</p>
|
|---|
| 311 | <p class="last">If the file does not exist, or if it is not a valid configuration file,
|
|---|
| 312 | an error will be shown and the client will refuse to start.</p>
|
|---|
| 313 | </div>
|
|---|
| 314 | </div>
|
|---|
| 315 | <div class="section" id="running-mta-client-version">
|
|---|
| 316 | <span id="id7"></span><h4><a class="toc-backref" href="#id23">–version</a><a class="headerlink" href="#running-mta-client-version" title="Permalink to this headline">¶</a></h4>
|
|---|
| 317 | <p>You can check the version of the mailjam client you are trying to run by
|
|---|
| 318 | passing the <em>-v</em> or <em>–version</em> parameters:</p>
|
|---|
| 319 | <div class="highlight-python"><div class="highlight"><pre><span class="n">mailjam</span><span class="o">-</span><span class="n">mta</span> <span class="o">-</span><span class="n">v</span>
|
|---|
| 320 | </pre></div>
|
|---|
| 321 | </div>
|
|---|
| 322 | <div class="highlight-python"><div class="highlight"><pre><span class="n">mailjam</span><span class="o">-</span><span class="n">mta</span> <span class="o">--</span><span class="n">version</span>
|
|---|
| 323 | </pre></div>
|
|---|
| 324 | </div>
|
|---|
| 325 | </div>
|
|---|
| 326 | <div class="section" id="address-required">
|
|---|
| 327 | <span id="running-mta-client-address"></span><h4><a class="toc-backref" href="#id24">–address (required)</a><a class="headerlink" href="#address-required" title="Permalink to this headline">¶</a></h4>
|
|---|
| 328 | <p>This parameter is required (you have to provide it with a value in order to
|
|---|
| 329 | run the mailjam-mta). It sets the address of the mailing list managed by this
|
|---|
| 330 | MTA client instance.</p>
|
|---|
| 331 | <p>The MTA client will use the provided value to do some checks on the daemon,
|
|---|
| 332 | retrieving all the needed data to perform its tasks.</p>
|
|---|
| 333 | <p>You can pass a valid address using both the <em>-a</em> and <em>–address</em> parameters:</p>
|
|---|
| 334 | <div class="highlight-python"><pre>mailjam-mta -a list@mydomain.com</pre>
|
|---|
| 335 | </div>
|
|---|
| 336 | <div class="highlight-python"><pre>mailjam-mta --address list@mydomain.com</pre>
|
|---|
| 337 | </div>
|
|---|
| 338 | </div>
|
|---|
| 339 | <div class="section" id="input">
|
|---|
| 340 | <span id="running-mta-client-input"></span><h4><a class="toc-backref" href="#id25">–input</a><a class="headerlink" href="#input" title="Permalink to this headline">¶</a></h4>
|
|---|
| 341 | <p>This parameter tells mailjam-mta from where it has to read the message sent
|
|---|
| 342 | to the mailing list. That could be a local file (to be readed from disk) or
|
|---|
| 343 | a stream of data coming directly from the standard input (<em>stdin</em>).</p>
|
|---|
| 344 | <p>For a regular configuration/setup, the second option is preferred, as the mail
|
|---|
| 345 | server will send the stream of data directly to mailjam-mta (as
|
|---|
| 346 | <a class="reference internal" href="#running-mta-client-explained"><em>explained before</em></a>):</p>
|
|---|
| 347 | <div class="highlight-python"><pre>mailjam-mta -i -</pre>
|
|---|
| 348 | </div>
|
|---|
| 349 | <div class="highlight-python"><pre>mailjam-mta --input -</pre>
|
|---|
| 350 | </div>
|
|---|
| 351 | <p>But perhaps some time you would like to send (again) a message you have on disk,
|
|---|
| 352 | that could be done easily, passing the path to the file containing that message
|
|---|
| 353 | to mailjam-mta:</p>
|
|---|
| 354 | <div class="highlight-python"><div class="highlight"><pre><span class="n">mailjam</span><span class="o">-</span><span class="n">mta</span> <span class="o">-</span><span class="n">i</span> <span class="o">/</span><span class="n">home</span><span class="o">/</span><span class="n">backups</span><span class="o">/</span><span class="n">mail</span><span class="o">/</span><span class="n">that</span><span class="o">-</span><span class="n">important</span><span class="o">-</span><span class="n">mail</span><span class="o">.</span><span class="n">txt</span>
|
|---|
| 355 | </pre></div>
|
|---|
| 356 | </div>
|
|---|
| 357 | <div class="highlight-python"><div class="highlight"><pre><span class="n">mailjam</span><span class="o">-</span><span class="n">mta</span> <span class="o">-</span><span class="nb">input</span> <span class="o">/</span><span class="n">home</span><span class="o">/</span><span class="n">backups</span><span class="o">/</span><span class="n">mail</span><span class="o">/</span><span class="n">that</span><span class="o">-</span><span class="n">important</span><span class="o">-</span><span class="n">mail</span><span class="o">.</span><span class="n">txt</span>
|
|---|
| 358 | </pre></div>
|
|---|
| 359 | </div>
|
|---|
| 360 | </div>
|
|---|
| 361 | </div>
|
|---|
| 362 | </div>
|
|---|
| 363 | <div class="section" id="the-web-client">
|
|---|
| 364 | <span id="running-web-client"></span><h2><a class="toc-backref" href="#id26">The Web client</a><a class="headerlink" href="#the-web-client" title="Permalink to this headline">¶</a></h2>
|
|---|
| 365 | <table class="docutils footnote" frame="void" id="id8" rules="none">
|
|---|
| 366 | <colgroup><col class="label" /><col /></colgroup>
|
|---|
| 367 | <tbody valign="top">
|
|---|
| 368 | <tr><td class="label"><a class="fn-backref" href="#id1">[1]</a></td><td><a class="reference external" href="http://en.wikipedia.org/wiki/Email_alias">http://en.wikipedia.org/wiki/Email_alias</a></td></tr>
|
|---|
| 369 | </tbody>
|
|---|
| 370 | </table>
|
|---|
| 371 | <table class="docutils footnote" frame="void" id="id9" rules="none">
|
|---|
| 372 | <colgroup><col class="label" /><col /></colgroup>
|
|---|
| 373 | <tbody valign="top">
|
|---|
| 374 | <tr><td class="label">[2]</td><td><em>(<a class="fn-backref" href="#id2">1</a>, <a class="fn-backref" href="#id3">2</a>)</em> <a class="reference external" href="http://www.freebsd.org/cgi/man.cgi?query=newaliases">http://www.freebsd.org/cgi/man.cgi?query=newaliases</a></td></tr>
|
|---|
| 375 | </tbody>
|
|---|
| 376 | </table>
|
|---|
| 377 | </div>
|
|---|
| 378 | </div>
|
|---|
| 379 |
|
|---|
| 380 |
|
|---|
| 381 | </div>
|
|---|
| 382 | </div>
|
|---|
| 383 | </div>
|
|---|
| 384 | <div class="sphinxsidebar">
|
|---|
| 385 | <div class="sphinxsidebarwrapper">
|
|---|
| 386 | <h3><a href="index.html">Table Of Contents</a></h3>
|
|---|
| 387 | <ul>
|
|---|
| 388 | <li><a class="reference internal" href="#">Running Mailjam</a><ul>
|
|---|
| 389 | <li><a class="reference internal" href="#the-daemon">The daemon</a><ul>
|
|---|
| 390 | <li><a class="reference internal" href="#additional-parameters">Additional parameters</a><ul>
|
|---|
| 391 | <li><a class="reference internal" href="#help">–help</a></li>
|
|---|
| 392 | <li><a class="reference internal" href="#config">–config</a></li>
|
|---|
| 393 | <li><a class="reference internal" href="#version">–version</a></li>
|
|---|
| 394 | </ul>
|
|---|
| 395 | </li>
|
|---|
| 396 | </ul>
|
|---|
| 397 | </li>
|
|---|
| 398 | <li><a class="reference internal" href="#the-cli-client">The CLI client</a></li>
|
|---|
| 399 | <li><a class="reference internal" href="#the-mta-client">The MTA client</a><ul>
|
|---|
| 400 | <li><a class="reference internal" href="#quick-configuration-you-are-a-mail-servers-master">Quick configuration (you are a mail-servers-master)</a></li>
|
|---|
| 401 | <li><a class="reference internal" href="#explained-configuration-you-really-want-to-know-what-s-happening-here">Explained configuration (you really want to know what’s happening here)</a></li>
|
|---|
| 402 | <li><a class="reference internal" href="#running-mta-client-parameters">Additional parameters</a><ul>
|
|---|
| 403 | <li><a class="reference internal" href="#running-mta-client-help">–help</a></li>
|
|---|
| 404 | <li><a class="reference internal" href="#running-mta-client-config">–config</a></li>
|
|---|
| 405 | <li><a class="reference internal" href="#running-mta-client-version">–version</a></li>
|
|---|
| 406 | <li><a class="reference internal" href="#address-required">–address (required)</a></li>
|
|---|
| 407 | <li><a class="reference internal" href="#input">–input</a></li>
|
|---|
| 408 | </ul>
|
|---|
| 409 | </li>
|
|---|
| 410 | </ul>
|
|---|
| 411 | </li>
|
|---|
| 412 | <li><a class="reference internal" href="#the-web-client">The Web client</a></li>
|
|---|
| 413 | </ul>
|
|---|
| 414 | </li>
|
|---|
| 415 | </ul>
|
|---|
| 416 |
|
|---|
| 417 | <h4>Previous topic</h4>
|
|---|
| 418 | <p class="topless"><a href="configuration.html"
|
|---|
| 419 | title="previous chapter">Configuration</a></p>
|
|---|
| 420 | <h4>Next topic</h4>
|
|---|
| 421 | <p class="topless"><a href="examples.html"
|
|---|
| 422 | title="next chapter">Some examples</a></p>
|
|---|
| 423 | <h3>This Page</h3>
|
|---|
| 424 | <ul class="this-page-menu">
|
|---|
| 425 | <li><a href="_sources/running.txt"
|
|---|
| 426 | rel="nofollow">Show Source</a></li>
|
|---|
| 427 | </ul>
|
|---|
| 428 | <div id="searchbox" style="display: none">
|
|---|
| 429 | <h3>Quick search</h3>
|
|---|
| 430 | <form class="search" action="search.html" method="get">
|
|---|
| 431 | <input type="text" name="q" />
|
|---|
| 432 | <input type="submit" value="Go" />
|
|---|
| 433 | <input type="hidden" name="check_keywords" value="yes" />
|
|---|
| 434 | <input type="hidden" name="area" value="default" />
|
|---|
| 435 | </form>
|
|---|
| 436 | <p class="searchtip" style="font-size: 90%">
|
|---|
| 437 | Enter search terms or a module, class or function name.
|
|---|
| 438 | </p>
|
|---|
| 439 | </div>
|
|---|
| 440 | <script type="text/javascript">$('#searchbox').show(0);</script>
|
|---|
| 441 | </div>
|
|---|
| 442 | </div>
|
|---|
| 443 | <div class="clearer"></div>
|
|---|
| 444 | </div>
|
|---|
| 445 | <div class="related">
|
|---|
| 446 | <h3>Navigation</h3>
|
|---|
| 447 | <ul>
|
|---|
| 448 | <li class="right" style="margin-right: 10px">
|
|---|
| 449 | <a href="genindex.html" title="General Index"
|
|---|
| 450 | >index</a></li>
|
|---|
| 451 | <li class="right" >
|
|---|
| 452 | <a href="examples.html" title="Some examples"
|
|---|
| 453 | >next</a> |</li>
|
|---|
| 454 | <li class="right" >
|
|---|
| 455 | <a href="configuration.html" title="Configuration"
|
|---|
| 456 | >previous</a> |</li>
|
|---|
| 457 | <li><a href="index.html">Mailjam 0.1.0 documentation</a> »</li>
|
|---|
| 458 | </ul>
|
|---|
| 459 | </div>
|
|---|
| 460 | <div class="footer">
|
|---|
| 461 | © Copyright 2012, Soluciones Informaticas Codigo23 S.L.U..
|
|---|
| 462 | Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
|
|---|
| 463 | </div>
|
|---|
| 464 | </body>
|
|---|
| 465 | </html>
|
|---|
