162 lines
5.5 KiB
HTML
162 lines
5.5 KiB
HTML
<!DOCTYPE HTML PUBLIC "%-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
|
<html>
|
|
<head>
|
|
<title>E-MailRelay Readme</title>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
|
|
<link rel="stylesheet" href="emailrelay.css" type="text/css">
|
|
</head>
|
|
<body>
|
|
<!-- index:0::::E-MailRelay Readme -->
|
|
<div class="div-main">
|
|
<h1><a class="a-header" name="H_1">E-MailRelay Readme</a></h1> <!-- index:1:H:1::E-MailRelay Readme -->
|
|
<h2><a class="a-header" name="SH_1_1">Abstract</a></h2> <!-- index:2:SH:1:1:Abstract -->
|
|
<p>
|
|
E-MailRelay is an e-mail store-and-forward message transfer agent and proxy
|
|
server. It runs on Unix-like operating systems (including Linux and Mac OS X),
|
|
and on Windows.
|
|
</p>
|
|
|
|
<p>
|
|
E-MailRelay does three things: it stores any incoming e-mail messages that
|
|
it receives, it forwards e-mail messages on to another remote e-mail server,
|
|
and it serves up stored e-mail messages to local e-mail reader programs. More
|
|
technically, it acts as a SMTP storage daemon, a SMTP forwarding agent, and
|
|
a POP3 server.
|
|
</p>
|
|
|
|
<p>
|
|
Whenever an e-mail message is received it can be passed through a user-defined
|
|
program, such as a spam filter, which can drop, re-address or edit messages as
|
|
they pass through.
|
|
</p>
|
|
|
|
<img src="whatisit.png" alt="image">
|
|
|
|
|
|
<p>
|
|
E-MailRelay uses the same non-blocking i/o model as Squid and nginx giving
|
|
excellent scalability and resource usage.
|
|
</p>
|
|
|
|
<p>
|
|
C++ source code is available and distribution is permitted under the GNU
|
|
General Public License V3.
|
|
</p>
|
|
<h2><a class="a-header" name="SH_1_2">Quick start</a></h2> <!-- index:2:SH:1:2:Quick start -->
|
|
<p>
|
|
To use E-MailRelay in store-and-forward mode use the <em>--as-server</em> option to
|
|
start the storage daemon in the background, and then do delivery of spooled
|
|
messages by running with the <em>--as-client</em> option.
|
|
</p>
|
|
|
|
<img src="serverclient.png" alt="image">
|
|
|
|
|
|
<p>
|
|
For example, to start a storage daemon listening on port 587 use a command
|
|
like this:
|
|
</p>
|
|
|
|
<div class="div-pre">
|
|
<pre>emailrelay --as-server --port 587 --spool-dir /tmp
|
|
</pre>
|
|
</div><!-- div-pre -->
|
|
<p>
|
|
And then to forward the spooled mail to <em>smtp.example.com</em> run something
|
|
like this:
|
|
</p>
|
|
|
|
<div class="div-pre">
|
|
<pre>emailrelay --as-client smtp.example.com:25 --spool-dir /tmp
|
|
</pre>
|
|
</div><!-- div-pre -->
|
|
<p>
|
|
To get behaviour more like a proxy you can add the <em>--poll</em> and <em>--forward-to</em>
|
|
options so that messages are forwarded continuously rather than on-demand.
|
|
</p>
|
|
|
|
<img src="forwardto.png" alt="image">
|
|
|
|
|
|
<p>
|
|
This example starts a store-and-forward server that forwards spooled-up e-mail
|
|
every minute:
|
|
</p>
|
|
|
|
<div class="div-pre">
|
|
<pre>emailrelay --as-server --poll 60 --forward-to smtp.example.com:25
|
|
</pre>
|
|
</div><!-- div-pre -->
|
|
<p>
|
|
Or for a proxy server that forwards each message soon after it has been
|
|
received, you can use <em>--as-proxy</em> or add <em>--forward-on-disconnect</em>:
|
|
</p>
|
|
|
|
<div class="div-pre">
|
|
<pre>emailrelay --as-server --forward-on-disconnect --forward-to smtp.example.com:25
|
|
</pre>
|
|
</div><!-- div-pre -->
|
|
<p>
|
|
To edit or filter e-mail as it passes through the proxy specify your filter
|
|
program with the <em>--filter</em> option, something like this:
|
|
</p>
|
|
|
|
<div class="div-pre">
|
|
<pre>emailrelay --as-proxy smtp.example.com:25 --filter addsig.js
|
|
</pre>
|
|
</div><!-- div-pre -->
|
|
<p>
|
|
To run E-MailRelay as a POP server without SMTP use <em>--pop</em> and <em>--no-smtp</em>:
|
|
</p>
|
|
|
|
<div class="div-pre">
|
|
<pre>emailrelay --pop --no-smtp --log --close-stderr
|
|
</pre>
|
|
</div><!-- div-pre -->
|
|
<p>
|
|
The <em>emailrelay-submit</em> utility can be used to put messages straight into the
|
|
spool directory so that the POP clients can fetch them.
|
|
</p>
|
|
|
|
<p>
|
|
By default E-MailRelay will always reject connections from remote machines. To
|
|
allow connections from anywhere use the <em>--remote-clients</em> option, but please
|
|
check your firewall settings to make sure this cannot be exploited by spammers.
|
|
</p>
|
|
|
|
<p>
|
|
For more information on the command-line options refer to the reference guide
|
|
or run:
|
|
</p>
|
|
|
|
<div class="div-pre">
|
|
<pre>emailrelay --help --verbose</pre>
|
|
</div><!-- div-pre -->
|
|
<h2><a class="a-header" name="SH_1_3">Documentation</a></h2> <!-- index:2:SH:1:3:Documentation -->
|
|
<p>
|
|
The following documentation is provided:
|
|
</p>
|
|
<ul>
|
|
<li>README -- this document</li>
|
|
<li>COPYING -- the GNU General Public License</li>
|
|
<li>INSTALL -- generic build & install instructions</li>
|
|
<li>AUTHORS -- authors, credits and additional copyrights</li>
|
|
<li>userguide.txt -- user guide</li>
|
|
<li>reference.txt -- reference document</li>
|
|
<li>ChangeLog -- change log for releases</li>
|
|
</ul>
|
|
|
|
<p>
|
|
Source code documentation will be generated when building from source if
|
|
<em>doxygen</em> is available.
|
|
</p>
|
|
<h2><a class="a-header" name="SH_1_4">Feedback</a></h2> <!-- index:2:SH:1:4:Feedback -->
|
|
<p>
|
|
Please feel free to e-mail the author at <em>mailto:graeme_walker@users.sourceforge.net</em>.
|
|
</p>
|
|
|
|
</div> <!-- div-main -->
|
|
</body>
|
|
</html>
|
|
<!-- Copyright (C) 2001-2019 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->
|