burble.dn42/emailrelay
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

v2.5

Browse Source
This commit is contained in:
Graeme Walker 2023-08-10 12:00:00 +00:00
parent dc349ee357
commit 2a4d620121
710 changed files with 41355 additions and 23081 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
.readthedocs.yaml Normal file
View File

@ -0,0 +1,15 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html
# Required
version: 2
build:
os: ubuntu-22.04
tools:
python: "3.11"
sphinx:
configuration: doc/conf.py

15
ChangeLog
View File

@ -1,6 +1,21 @@
E-MailRelay Change Log
======================
2.4 -> 2.5
----------
* Multiple configurations in one process.
* SMTP PIPELINING (RFC-2920).
* SMTP CHUNKING/8BITMIME 'BDAT' extension (RFC-3030), disabled by default.
* SMTP SMTPUTF8 extension (RFC-6531), disabled by default.
* No 7-bit/8-bit check on received message content (see NEWS file).
* New built-in filters: "deliver:", "split:", "copy:", "mx:", "msgid:".
* New built-in address verifier: "account:"
* No ".local" files (see NEWS file).
* PAM authentication is now enabled with "--server-auth=pam:" not "/pam".
* Client authentication details can be given directly from the command-line.
* Multiple "client" authentication secrets, selected by a new envelope field.
* Main binary can act as a simple submission tool ("configure --enable-submission").
2.3 -> 2.4
----------
* Multiple "--filter" and "--client-filter" options allowed.

5
LICENSE
View File

@ -1,4 +1,5 @@
Licenses
========
GPLv3 is used for E-MailRelay source code (see COPYING), but relicensing
requests will be considered. See also AUTHORS.
The GPLv3 license (GPL-3.0-or-later) is used for E-MailRelay source code
(see COPYING), except for a few files using the GNU All-permissive
license (FSFAP).

23
Makefile.am
View File

@ -1,5 +1,5 @@
#
## Copyright (C) 2001-2022 Graeme Walker <graeme_walker@users.sourceforge.net>
## Copyright (C) 2001-2023 Graeme Walker <graeme_walker@users.sourceforge.net>
##
## This program is free software: you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published by
@ -59,9 +59,10 @@ EXTRA_DIST = \
autogen.sh \
winbuild.bat \
winbuild.pl \
runperl.bat
runperl.bat \
.readthedocs.yaml
SUBDIRS = bin src etc doc debian test m4 bsd po unity
SUBDIRS = libexec bin src etc doc debian test m4 bsd po unity
# work-round PKG_CHECK_MODULES if no pkg-config
ACLOCAL_AMFLAGS = -I m4
@ -104,7 +105,7 @@ deb: $(DEB)
$(DEB): dist
-mv emailrelay-$(VERSION) emailrelay-$(VERSION).old.$$$$ || true
tar -xzf $(TAR)
cd emailrelay-$(VERSION) && fakeroot debian/rules binary
cd emailrelay-$(VERSION) && fakeroot debian/rules binary # or dpkg-buildpackage -b --jobs=10
mkdir emailrelay-$(VERSION)/debian/source
.PHONY: deb-src
@ -119,8 +120,8 @@ deb-src: dist
tidy:
$(MAKE) -C unity tidy
.PHONY: unitybuild
unitybuild:
.PHONY: unity
unity:
$(MAKE) -C unity programs
.PHONY: format
@ -129,8 +130,8 @@ format:
.PHONY: cmake
cmake:
@chmod +x bin/make2cmake || true
bin/make2cmake
@chmod +x libexec/make2cmake || true
libexec/make2cmake
test -d build || mkdir build
cd build && cmake -DCMAKE_MAKE_PROGRAM:FILEPATH=/usr/bin/make -DCMAKE_EXPORT_COMPILE_COMMANDS=ON ..
@echo now run make from the '"build"' directory
@ -145,8 +146,10 @@ $(TAR):
zip: $(ZIP)
$(ZIP): $(TAR)
tar -xzf $(TAR)
sh -c "cd emailrelay-$(VERSION) && zip -r ../$(ZIP) ."
-mkdir zip.d 2>/dev/null
-@rm -rf zip.d/* 2>/dev/null
tar -C zip.d --strip-components=1 -xzf $(TAR)
sh -c "cd zip.d && zip -r ../$(ZIP) ."
.PHONY: mbedtls
mbedtls:

70
Makefile.in
View File

@ -1,7 +1,7 @@
# Makefile.in generated by automake 1.16.1 from Makefile.am.
# Makefile.in generated by automake 1.16.3 from Makefile.am.
# @configure_input@
# Copyright (C) 1994-2018 Free Software Foundation, Inc.
# Copyright (C) 1994-2020 Free Software Foundation, Inc.
# This Makefile.in is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
@ -125,7 +125,6 @@ subdir = .
ACLOCAL_M4 = $(top_srcdir)/aclocal.m4
am__aclocal_m4_deps = $(top_srcdir)/m4/acinclude.m4 \
$(top_srcdir)/m4/m4_ax_cxx_compile_stdcxx.m4 \
$(top_srcdir)/m4/m4_ax_cxx_compile_stdcxx_11.m4 \
$(top_srcdir)/m4/pkg.m4 $(top_srcdir)/configure.ac
am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \
$(ACLOCAL_M4)
@ -201,6 +200,7 @@ am__recursive_targets = \
$(am__extra_recursive_targets)
AM_RECURSIVE_TARGETS = $(am__recursive_targets:-recursive=) TAGS CTAGS \
cscope distdir distdir-am dist dist-all distcheck
am__extra_recursive_targets = extra-recursive
am__tagged_files = $(HEADERS) $(SOURCES) $(TAGS_FILES) $(LISP)
# Read a list of newline-separated strings from the standard input,
# and print each of them once, without duplicates. Input order is
@ -223,7 +223,7 @@ CTAGS = ctags
CSCOPE = cscope
DIST_SUBDIRS = $(SUBDIRS)
am__DIST_COMMON = $(srcdir)/Makefile.in AUTHORS COPYING ChangeLog \
INSTALL NEWS README compile depcomp install-sh missing
INSTALL NEWS README compile install-sh missing
DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST)
distdir = $(PACKAGE)-$(VERSION)
top_distdir = $(distdir)
@ -262,6 +262,8 @@ am__relativize = \
DIST_ARCHIVES = $(distdir).tar.gz
GZIP_ENV = --best
DIST_TARGETS = dist-gzip
# Exists only to be overridden by the user if desired.
AM_DISTCHECK_DVI_TARGET = dvi
distuninstallcheck_listfiles = find . -type f -print
am__distuninstallcheck_listfiles = $(distuninstallcheck_listfiles) \
| sed 's|^\./|$(prefix)/|' | grep -v '$(infodir)/dir$$'
@ -270,6 +272,7 @@ ACLOCAL = @ACLOCAL@
AMTAR = @AMTAR@
AM_DEFAULT_VERBOSITY = @AM_DEFAULT_VERBOSITY@
AR = @AR@
ARFLAGS = @ARFLAGS@
AUTOCONF = @AUTOCONF@
AUTOHEADER = @AUTOHEADER@
AUTOMAKE = @AUTOMAKE@
@ -359,7 +362,7 @@ e_docdir = @e_docdir@
e_examplesdir = @e_examplesdir@
e_icondir = @e_icondir@
e_initdir = @e_initdir@
e_libexecdir = @e_libexecdir@
e_libdir = @e_libdir@
e_pamdir = @e_pamdir@
e_rundir = @e_rundir@
e_spooldir = @e_spooldir@
@ -404,9 +407,10 @@ EXTRA_DIST = \
autogen.sh \
winbuild.bat \
winbuild.pl \
runperl.bat
runperl.bat \
.readthedocs.yaml
SUBDIRS = bin src etc doc debian test m4 bsd po unity
SUBDIRS = libexec bin src etc doc debian test m4 bsd po unity
# work-round PKG_CHECK_MODULES if no pkg-config
ACLOCAL_AMFLAGS = -I m4
@ -506,6 +510,7 @@ $(am__recursive_targets):
if test "$$dot_seen" = "no"; then \
$(MAKE) $(AM_MAKEFLAGS) "$$target-am" || exit 1; \
fi; test -z "$$fail"
extra-local:
ID: $(am__tagged_files)
$(am__define_uniq_tagged_files); mkid -fID $$unique
@ -662,6 +667,10 @@ dist-xz: distdir
tardir=$(distdir) && $(am__tar) | XZ_OPT=$${XZ_OPT--e} xz -c >$(distdir).tar.xz
$(am__post_remove_distdir)
dist-zstd: distdir
tardir=$(distdir) && $(am__tar) | zstd -c $${ZSTD_CLEVEL-$${ZSTD_OPT--19}} >$(distdir).tar.zst
$(am__post_remove_distdir)
dist-tarZ: distdir
@echo WARNING: "Support for distribution archives compressed with" \
"legacy program 'compress' is deprecated." >&2
@ -704,6 +713,8 @@ distcheck: dist
eval GZIP= gzip $(GZIP_ENV) -dc $(distdir).shar.gz | unshar ;;\
*.zip*) \
unzip $(distdir).zip ;;\
*.tar.zst*) \
zstd -dc $(distdir).tar.zst | $(am__untar) ;;\
esac
chmod -R a-w $(distdir)
chmod u+w $(distdir)
@ -719,7 +730,7 @@ distcheck: dist
$(DISTCHECK_CONFIGURE_FLAGS) \
--srcdir=../.. --prefix="$$dc_install_base" \
&& $(MAKE) $(AM_MAKEFLAGS) \
&& $(MAKE) $(AM_MAKEFLAGS) dvi \
&& $(MAKE) $(AM_MAKEFLAGS) $(AM_DISTCHECK_DVI_TARGET) \
&& $(MAKE) $(AM_MAKEFLAGS) check \
&& $(MAKE) $(AM_MAKEFLAGS) install \
&& $(MAKE) $(AM_MAKEFLAGS) installcheck \
@ -821,6 +832,10 @@ dvi: dvi-recursive
dvi-am:
extra: extra-recursive
extra-am: extra-local
html: html-recursive
html-am:
@ -883,17 +898,18 @@ uninstall-am: uninstall-e_docDATA uninstall-local
am--refresh check check-am clean clean-cscope clean-generic \
cscope cscopelist-am ctags ctags-am dist dist-all dist-bzip2 \
dist-gzip dist-lzip dist-shar dist-tarZ dist-xz dist-zip \
distcheck distclean distclean-generic distclean-tags \
distcleancheck distdir distuninstallcheck dvi dvi-am html \
html-am info info-am install install-am install-data \
install-data-am install-dvi install-dvi-am install-e_docDATA \
install-exec install-exec-am install-html install-html-am \
install-info install-info-am install-man install-pdf \
install-pdf-am install-ps install-ps-am install-strip \
installcheck installcheck-am installdirs installdirs-am \
maintainer-clean maintainer-clean-generic mostlyclean \
mostlyclean-generic pdf pdf-am ps ps-am tags tags-am uninstall \
uninstall-am uninstall-e_docDATA uninstall-local
dist-zstd distcheck distclean distclean-generic distclean-tags \
distcleancheck distdir distuninstallcheck dvi dvi-am extra-am \
extra-local html html-am info info-am install install-am \
install-data install-data-am install-dvi install-dvi-am \
install-e_docDATA install-exec install-exec-am install-html \
install-html-am install-info install-info-am install-man \
install-pdf install-pdf-am install-ps install-ps-am \
install-strip installcheck installcheck-am installdirs \
installdirs-am maintainer-clean maintainer-clean-generic \
mostlyclean mostlyclean-generic pdf pdf-am ps ps-am tags \
tags-am uninstall uninstall-am uninstall-e_docDATA \
uninstall-local
.PRECIOUS: Makefile
@ -930,7 +946,7 @@ deb: $(DEB)
$(DEB): dist
-mv emailrelay-$(VERSION) emailrelay-$(VERSION).old.$$$$ || true
tar -xzf $(TAR)
cd emailrelay-$(VERSION) && fakeroot debian/rules binary
cd emailrelay-$(VERSION) && fakeroot debian/rules binary # or dpkg-buildpackage -b --jobs=10
mkdir emailrelay-$(VERSION)/debian/source
.PHONY: deb-src
@ -945,8 +961,8 @@ deb-src: dist
tidy:
$(MAKE) -C unity tidy
.PHONY: unitybuild
unitybuild:
.PHONY: unity
unity:
$(MAKE) -C unity programs
.PHONY: format
@ -955,8 +971,8 @@ format:
.PHONY: cmake
cmake:
@chmod +x bin/make2cmake || true
bin/make2cmake
@chmod +x libexec/make2cmake || true
libexec/make2cmake
test -d build || mkdir build
cd build && cmake -DCMAKE_MAKE_PROGRAM:FILEPATH=/usr/bin/make -DCMAKE_EXPORT_COMPILE_COMMANDS=ON ..
@echo now run make from the '"build"' directory
@ -971,8 +987,10 @@ $(TAR):
zip: $(ZIP)
$(ZIP): $(TAR)
tar -xzf $(TAR)
sh -c "cd emailrelay-$(VERSION) && zip -r ../$(ZIP) ."
-mkdir zip.d 2>/dev/null
-@rm -rf zip.d/* 2>/dev/null
tar -C zip.d --strip-components=1 -xzf $(TAR)
sh -c "cd zip.d && zip -r ../$(ZIP) ."
.PHONY: mbedtls
mbedtls:

200
NEWS
View File

@ -1,34 +1,178 @@
News
----
Low-level changes include a rework of the event-loops. The Unix event loop
defaults to an epoll() implementation.
====
The i18n of the main server (not the gui) has been extended somewhat by marking
for translation the text of most C++ exceptions. This is only relevant if
building "--with-gettext" and running with "--localedir".
Overview
--------
The E-MailRelay 2.5 release is no longer just a store-and-forward SMTP relay or
proxy; it can do routing (improved from 2.4), client account selection and
message delivery, making it more useful as a general-purpose MTA. Routing and
client account selection are activated by having an external filter script to
edit e-mail message envelope files.
The "--anonyous" option has changed slightly in v2.4 so that it will now force
the AUTH parameter on the MAIL command to be "AUTH=<>". Replace "--anonymous"
with "--anonymous=vrfy,server,content" to keep the same behaviour as before.
Multiple configurations
-----------------------
In previous releases E-MailRelay runs with one spool directory and typically
one SMTP server and one SMTP client doing store-and-forward. In this release
one E-MailRelay process can have multiple configurations, each with their own
independent spool directory, SMTP server and SMTP client. Everything still
runs single-threaded (except as documented in "developer.txt").
The "emailrelay-submit" utility's "--content" option no longer suppresses
reading of the standard input stream; there is a new "--no-stdin" option
instead. A dot on its own does not terminate the input any more, so use ^D or
^Z to stop reading from the terminal. Header-only content with no body text is
now permitted.
Refer to the reference document for more details.
Authentication using PAM no longer insists on TLS encryption because the
"--server-auth-config" option can be used to disable password authentication
over an unencypted connection.
More built-in filters and address verifiers
-------------------------------------------
E-MailRelay allows filters that are not simple scripts by using command-line
options like "--filter=exit:99" and "--filter=spam:localhost:783", with a
small number of special prefixes like "exit:", "net:", "file:" and "spam:".
In this release there are more built-in filters and address verifiers, including
"deliver:", "split:", "mx:", "copy:" and "msgid:" filters and the "account:"
address verifier.
Refer to the reference document for more details.
Delivery
--------
E-MailRelay can now act as a Message Delivery Agent (MDA) so it can deliver
e-mail messages to local mailboxes according to the e-mail addressees.
A mailbox is a simple sub-directory of some delivery base directory, defaulting
to the spool directory. So Alice's mailbox might be the "alice" sub-directory
"/var/spool/emailrelay/alice", containing envelope and content files. Or it
can have its own "maildir" structure, "/var/spool/emailrelay/alice/new,cur,tmp",
in which case the content file will be delivered to the "cur" directory and
there will be no envelope file.
Refer to the reference document for more details.
Client account selection
------------------------
This release allows for multiple client accounts to be used for SMTP
authentication when forwarding. A new "ClientAccountSelector" field in the
envelope file must match against the fifth field of a "client" line in the
secrets file. A filter should be used to fill in the selector field in the
envelope, typically based on the message addressing.
When the account changes from one message to the next the SMTP connection is
dropped and re-connected. It is necessary to drop the connection because some
common SMTP servers do not allow re-authentication within an existing SMTP
connection.
Client rows in the client secrets file can now have a fifth field for the
selector, but this raises a backwards compatibility issue because in previous
releases the fifth column (and beyond) in a client secrets file is ignored and
might be a comment without a leading '#' character. In upgrading, the first word
of the comment would be treated as a selector and the "client" row would be
effectively disabled resulting in a failure of message forwarding. Therefore,
fifth fields in the secrets file that start with '#' are treated as comments
(extending to the end of the line) and lines in the secrets file with six or
more fields result in a warning. It follows that filters should not generate
selectors starting with a '#' character.
Local files
-----------
In previous releases ".local" message files were created for messages with local
recipients (as determined by an address verifier) in order to create a separate
path for messages sent to the local postmaster. These files are no longer
created because E-MailRelay can now run multiple filters in a chain and it is
easy enough to write a filter to separate out these messages.
7BIT/8BITMIME
-------------
Previous versions of E-MailRelay test message content when a message is received
and populate the "Content" field of the envelope file as either "7bit" or
"8bit". However, the SMTP client code has always largely ignored this field and
it would attempt to forward 8-bit messages to a remote server that did not
advertise 8BITMIME, albeit with a warning in the log.
In this release E-MailRelay no longer tests messages for eight-bit content,
so the envelope "Content" field will always be "8bit". If this is not the
desired behaviour then a filter script should be used to test for seven-bit or
eight-bit content and edit the "Content" value in the envelope file accordingly.
If necessary the SMTP client can now be made to behave more strictly so that it
does not try to forward eight-bit messages to seven-bit servers (see
"--client-smtp-config").
PIPELINING
----------
This release adds support for the PIPELINING SMTP extension.
Previous releases allow pipelining of the SMTP QUIT command but otherwise
require SMTP requests and responses in turn (as per RFC-5321 2.1). In this
release the SMTP server code allows all SMTP commands to be pipelined, whether
or not the PIPELINING extension is advertised. The PIPELINING advertisement can
be disabled with the new "--server-smtp-config" command-line option.
The response batching behaviour described by RFC-2920 is not implemented.
The SMTP client code uses pipelining only for MAIL-FROM and RCPT-TO SMTP
commands when talking to a remote server that supports the PIPELINING extension.
This can be disabled using the "--client-smtp-config" command-line option so
then each MAIL-FROM or RCPT-TO request waits for a response before continuing.
CHUNKING/BINARYMIME and SMTPUTF8
--------------------------------
This release adds support for the CHUNKING+BINARYMIME and SMTPUTF8 extensions
to SMTP, although they are disabled by default.
It is important to note that if CHUNKING+BINARYMIME or SMTPUTF8 support is
enabled in the E-MailRelay server then the destination next-hop server must
also support these extensions. If the remote server does not support these
extensions then messages may fail immediately when they are forwarded.
In principle filter scripts can be used to convert BINARYMIME and SMTPUTF8
messages to non-BINARYMIME and non-SMTPUTF8 forms (RFC-3030 calls these
"gateway transformations"), but it might be easier to leave these extensions
disabled in the E-MailRelay server if there is any doubt about the capabilities
of the next-hop server.
In previous releases address verifiers only need to deal with printable ASCII
addresses because of the character-set retrictions imposed by the SMTP protocol.
But if the the SMTPUTF8 extension is enabled in the E-MailRelay server then the
addresses passed to any address verifier script might contain UTF-8 characters
and this might require changes to the script.
In passing, note that recipient addresses given to address verifier scripts are
as they appear on the wire, so a badly-behaved SMTP client might send addresses
containing double-quotes and backslash escapes that are semantically redundant.
For example, a message submitted to "\A\l\i\c\e"@example.com will have that
address passed to the verifier with all the redundant double quotes and
backslashes present. Normalising an address by removing quotes and backslashes
is reasonably easy in ASCII but might be more tricky with UTF-8.
Another corner case with SMTPUTF8 is that the remote client might use the VRFY
SMTP command without the optional SMTPUTF8 parameter. In principle a UTF-8
address verifier script should not then return UTF-8 results, but in practice
the script has no way of knowning whether the SMTPUTF8 parameter was used. If
necessary the VRFY command can be disabled by using "--anonymous".
Hashed passwords
----------------
Hashed passwords created by "emailrelay-passwd" that use the SHA-1 or SHA-256
hashing algorithm will no longer work when E-MailRelay is built using the latest
versions of the OpenSSL and MbedTLS libraries. Both libraries have stopped
exposing the relevant state variables used within their hashing functions. MD5
hashed passwords will still work.
Code size
---------
The source code now contains a lot of conditional compilation directives like
"#ifndef G_LIB_SMALL" that reduce the size of the built binaries.
The Windows build and the build of the GUI on Linux are not affected because
they are built without the "G_LIB_SMALL" switch.
These extra directives make the code rather ugly so they can be removed if
necessary by running:
libexec/reduce.sh --undo
Filter-copy utility
-------------------
The emailrelay-filter-copy utility was included in previous releases as a
set-user-id file program to copy e-mail message files into sub-directories for
"--pop-by-name" access. This can now be done by the built-in "copy:pop" filter,
albeit with minor differences in behaviour, so emailrelay-filter-copy has been
removed.
Limited support for routing is included. The envelope files have two new fields:
ForwardTo and ForwardToAddress. A filter script can examine the message content
and deposit the appropriate domain name and port number in the ForwardTo field.
If the SMTP client sees a ForwardTo value then it runs the client-filter early
allowing the client filter to do a DNS MX lookup of the ForwardTo value and
deposit the address into the ForwardToAddress field. If the SMTP client sees a
ForwardToAddress it will initiate a connection to that address to send the
message. The client-filter is run a second time in the normal way once the SMTP
session has been established. A connection to the main "--forward-to" address
will always be made even if all the messages are routed elsewhere, and each
routed connection will carry only one message.

130
README
View File

@ -1,101 +1,123 @@
E-MailRelay Readme
==================
Abstract
--------
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.
Introduction
------------
E-MailRelay is a lightweight SMTP store-and-forward mail server with POP access
to spooled messages. It can be used as a personal internet mail server with
SpamAssassin spam filtering and DNSBL connection blocking. Forwarding can be
to a fixed smarthost or using DNS MX routing. External scripts can be used for
address validation and e-mail message processing.
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.
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.
E-MailRelay uses the same non-blocking i/o model as Squid and nginx giving
excellent scalability and resource usage.
C++ source code is available and distribution is permitted under the GNU
General Public License V3.
E-MailRelay runs as a single process using the same non-blocking i/o model as
Squid and nginx giving excellent scalability and resource usage.
Quick start
-----------
E-MailRelay can be run straight from the command-line, and on Windows you can
run "emailrelay.exe" or "emailrelay-textmode.exe" from the zip file without
going through the installation process.
To use E-MailRelay in store-and-forward mode use the "--as-server" option to
start the storage daemon in the background, and then do delivery of spooled
messages by running with the "--as-client" option.
messages by running with "--as-client".
For example, to start a storage daemon listening on port 587 use a command
like this:
For example, to start a storage daemon in the background listening on port 10025
use a command like this:
emailrelay --as-server --port 587 --spool-dir /tmp
emailrelay --as-server --port 10025 --spool-dir /tmp
On Windows use "c:/temp" for testing, rather than "/tmp".
Or to run it in the foreground:
emailrelay --log --no-daemon --port 10025 --spool-dir /tmp
And then to forward the spooled mail to "smtp.example.com" run something
like this:
emailrelay --as-client smtp.example.com:25 --spool-dir /tmp
To get behaviour more like a proxy you can add the "--poll" and "--forward-to"
options so that messages are forwarded continuously rather than on-demand.
To forward continuously you can add the "--poll" and "--forward-to" options to
the server command-line:
This example starts a store-and-forward server that forwards spooled-up e-mail
every minute:
For example, this starts a server that also forwards spooled-up e-mail every
minute:
emailrelay --as-server --poll 60 --forward-to smtp.example.com:25
Or for a proxy server that forwards each message soon after it has been
received, you can use "--as-proxy" or add "--forward-on-disconnect":
Or for a server that forwards each message as soon as it has been received, you
can use "--forward-on-disconnect":
emailrelay --as-server --forward-on-disconnect --forward-to smtp.example.com:25
To edit or filter e-mail as it passes through the proxy specify your filter
To edit or filter e-mail as it passes through the server specify your filter
program with the "--filter" option, something like this:
emailrelay --as-proxy smtp.example.com:25 --filter addsig.js
emailrelay --as-server --filter /tmp/set-from.js
To run E-MailRelay as a POP server without SMTP use "--pop" and "--no-smtp":
Look for example filter scripts in the "examples" directory.
emailrelay --pop --no-smtp --log --close-stderr
E-MailRelay can also be used as a personal internet mail server:
The "emailrelay-submit" utility can be used to put messages straight into the
spool directory so that the POP clients can fetch them.
Use "--remote-clients" ("-r") to allow connections from outside the local
network, define your domain name with "--domain" and use an address verifier as
a first line of defense against spammers:
By default E-MailRelay will always reject connections from remote networks. To
allow connections from anywhere use the "--remote-clients" option, but please
check your firewall settings to make sure this cannot be exploited by spammers.
emailrelay --as-server -v -r --domain=example.com --address-verifier=account:
Then enable POP access to the incoming e-mails with "--pop", "--pop-port" and
"--pop-auth":
emailrelay ... --pop --pop-port 10110 --pop-auth /etc/emailrelay.auth
Set up the POP account with a user-id and password in the "--pop-auth" secrets
file. The secrets file should contain a single line of text like this:
server plain <userid> <password>
For more information on the command-line options refer to the reference guide
or run:
emailrelay --help --verbose
Packages
--------
To install on Linux from a RPM or DEB package:
Autostart
---------
To install E-MailRelay on Windows run the "emailrelay-setup" program and choose
the automatic startup option on the last page so that E-MailRelay runs as a
Windows service. Use the Windows "Services" utility to configure the E-MailRelay
service as automatic or manual startup.
sudo $SHELL # or 'su'
rpm -i emailrelay*.rpm # if RPM
dpkg -i emailrelay*.deb # if DEB
To install E-MailRelay on Linux from a RPM package:
If your Linux system uses "systemd" then you should check the E-MailRelay
configuration file "/etc/emailrelay.conf" is as you want it and then run:
sudo rpm -i emailrelay*.rpm
Or from a DEB package:
sudo dpkg -i emailrelay*.deb
To get the E-MailRelay server to start automatically you should check the
configuration file "/etc/emailrelay.conf" is as you want it and then run the
following commands to activate the "systemd" service:
systemctl enable emailrelay
systemctl start emailrelay
systemctl status emailrelay
On other systems try these commands:
On other Linux systems try some combination of these commands to set up and
activate the E-MailRelay service:
cp /usr/lib/emailrelay/init/emailrelay /etc/init.d/
update-rc.d emailrelay enable || rc-update add emailrelay
invoke-rc.d emailrelay start || service emailrelay start
tail /var/log/messages /var/log/syslog 2>/dev/null
update-rc.d emailrelay enable
rc-update add emailrelay
invoke-rc.d emailrelay start
service emailrelay start
tail /var/log/messages
tail /var/log/syslog
On Windows run the setup program.
On BSD systems add this line to /etc/rc.conf:
emailrelay_enable="YES"
Documentation
-------------
@ -111,3 +133,7 @@ The following documentation is provided:
Source code documentation will be generated when building from source if
"doxygen" is available.
Feedback
--------
To give feedback, including reviews, bug reports and feature requests, please
use the SourceForge project website at https://sourceforge.net/p/emailrelay

133
README.md
View File

@ -1,107 +1,131 @@
E-MailRelay Readme
==================
Abstract
--------
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.
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.
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.
Introduction
------------
E-MailRelay is a lightweight [SMTP][] store-and-forward mail server with [POP][] access
to spooled messages. It can be used as a personal internet mail server with
SpamAssassin spam filtering and [DNSBL][] connection blocking. Forwarding can be
to a fixed smarthost or using DNS MX routing. External scripts can be used for
address validation and e-mail message processing.
![whatisit.png](whatisit.png)
E-MailRelay uses the same non-blocking i/o model as Squid and nginx giving
excellent scalability and resource usage.
C++ source code is available and distribution is permitted under the GNU
General Public License V3.
E-MailRelay runs as a single process using the same non-blocking i/o model as
Squid and nginx giving excellent scalability and resource usage.
Quick start
-----------
E-MailRelay can be run straight from the command-line, and on Windows you can
run `emailrelay.exe` or `emailrelay-textmode.exe` from the zip file without
going through the installation process.
To use E-MailRelay in store-and-forward mode use the `--as-server` option to
start the storage daemon in the background, and then do delivery of spooled
messages by running with the `--as-client` option.
messages by running with `--as-client`.
![serverclient.png](serverclient.png)
For example, to start a storage daemon listening on port 587 use a command
like this:
For example, to start a storage daemon in the background listening on port 10025
use a command like this:
emailrelay --as-server --port 587 --spool-dir /tmp
emailrelay --as-server --port 10025 --spool-dir /tmp
On Windows use `c:/temp` for testing, rather than `/tmp`.
Or to run it in the foreground:
emailrelay --log --no-daemon --port 10025 --spool-dir /tmp
And then to forward the spooled mail to `smtp.example.com` run something
like this:
emailrelay --as-client smtp.example.com:25 --spool-dir /tmp
To get behaviour more like a proxy you can add the `--poll` and `--forward-to`
options so that messages are forwarded continuously rather than on-demand.
To forward continuously you can add the `--poll` and `--forward-to` options to
the server command-line:
![forwardto.png](forwardto.png)
This example starts a store-and-forward server that forwards spooled-up e-mail
every minute:
For example, this starts a server that also forwards spooled-up e-mail every
minute:
emailrelay --as-server --poll 60 --forward-to smtp.example.com:25
Or for a proxy server that forwards each message soon after it has been
received, you can use `--as-proxy` or add `--forward-on-disconnect`:
Or for a server that forwards each message as soon as it has been received, you
can use `--forward-on-disconnect`:
emailrelay --as-server --forward-on-disconnect --forward-to smtp.example.com:25
To edit or filter e-mail as it passes through the proxy specify your filter
To edit or filter e-mail as it passes through the server specify your filter
program with the `--filter` option, something like this:
emailrelay --as-proxy smtp.example.com:25 --filter addsig.js
emailrelay --as-server --filter /tmp/set-from.js
To run E-MailRelay as a [POP][] server without SMTP use `--pop` and `--no-smtp`:
Look for example filter scripts in the `examples` directory.
emailrelay --pop --no-smtp --log --close-stderr
E-MailRelay can also be used as a personal internet mail server:
The `emailrelay-submit` utility can be used to put messages straight into the
spool directory so that the POP clients can fetch them.
![mailserver.png](mailserver.png)
By default E-MailRelay will always reject connections from remote networks. To
allow connections from anywhere use the `--remote-clients` option, but please
check your firewall settings to make sure this cannot be exploited by spammers.
Use `--remote-clients` (`-r`) to allow connections from outside the local
network, define your domain name with `--domain` and use an address verifier as
a first line of defense against spammers:
emailrelay --as-server -v -r --domain=example.com --address-verifier=account:
Then enable POP access to the incoming e-mails with `--pop`, `--pop-port` and
`--pop-auth`:
emailrelay ... --pop --pop-port 10110 --pop-auth /etc/emailrelay.auth
Set up the POP account with a user-id and password in the `--pop-auth` secrets
file. The secrets file should contain a single line of text like this:
server plain <userid> <password>
For more information on the command-line options refer to the reference guide
or run:
emailrelay --help --verbose
Packages
--------
To install on Linux from a RPM or DEB package:
Autostart
---------
To install E-MailRelay on Windows run the `emailrelay-setup` program and choose
the automatic startup option on the last page so that E-MailRelay runs as a
Windows service. Use the Windows `Services` utility to configure the E-MailRelay
service as automatic or manual startup.
sudo $SHELL # or 'su'
rpm -i emailrelay*.rpm # if RPM
dpkg -i emailrelay*.deb # if DEB
To install E-MailRelay on Linux from a RPM package:
If your Linux system uses `systemd` then you should check the E-MailRelay
configuration file `/etc/emailrelay.conf` is as you want it and then run:
sudo rpm -i emailrelay*.rpm
Or from a DEB package:
sudo dpkg -i emailrelay*.deb
To get the E-MailRelay server to start automatically you should check the
configuration file `/etc/emailrelay.conf` is as you want it and then run the
following commands to activate the `systemd` service:
systemctl enable emailrelay
systemctl start emailrelay
systemctl status emailrelay
On other systems try these commands:
On other Linux systems try some combination of these commands to set up and
activate the E-MailRelay service:
cp /usr/lib/emailrelay/init/emailrelay /etc/init.d/
update-rc.d emailrelay enable || rc-update add emailrelay
invoke-rc.d emailrelay start || service emailrelay start
tail /var/log/messages /var/log/syslog 2>/dev/null
update-rc.d emailrelay enable
rc-update add emailrelay
invoke-rc.d emailrelay start
service emailrelay start
tail /var/log/messages
tail /var/log/syslog
On Windows run the setup program.
On BSD systems add this line to /etc/rc.conf:
emailrelay_enable="YES"
Documentation
-------------
@ -118,7 +142,12 @@ The following documentation is provided:
Source code documentation will be generated when building from source if
`doxygen` is available.
Feedback
--------
To give feedback, including reviews, bug reports and feature requests, please
use the SourceForge project website at https://sourceforge.net/p/emailrelay
[DNSBL]: https://en.wikipedia.org/wiki/DNSBL
[POP]: https://en.wikipedia.org/wiki/Post_Office_Protocol
[SMTP]: https://en.wikipedia.org/wiki/Simple_Mail_Transfer_Protocol

153
README.rst
View File

@ -1,49 +1,50 @@
******************
E-MailRelay Readme
******************
******
Readme
******
Abstract
========
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.
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.
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.
Introduction
============
E-MailRelay is a lightweight SMTP_ store-and-forward mail server with POP_ access
to spooled messages. It can be used as a personal internet mail server with
SpamAssassin spam filtering and DNSBL_ connection blocking. Forwarding can be
to a fixed smarthost or using DNS MX routing. External scripts can be used for
address validation and e-mail message processing.
.. image:: whatisit.png
:alt: whatisit.png
E-MailRelay uses the same non-blocking i/o model as Squid and nginx giving
excellent scalability and resource usage.
C++ source code is available and distribution is permitted under the GNU
General Public License V3.
E-MailRelay runs as a single process using the same non-blocking i/o model as
Squid and nginx giving excellent scalability and resource usage.
Quick start
===========
E-MailRelay can be run straight from the command-line, and on Windows you can
run *emailrelay.exe* or *emailrelay-textmode.exe* from the zip file without
going through the installation process.
To use E-MailRelay in store-and-forward mode use the *--as-server* option to
start the storage daemon in the background, and then do delivery of spooled
messages by running with the *--as-client* option.
messages by running with *--as-client*.
.. image:: serverclient.png
:alt: serverclient.png
For example, to start a storage daemon listening on port 587 use a command
like this:
For example, to start a storage daemon in the background listening on port 10025
use a command like this:
::
emailrelay --as-server --port 587 --spool-dir /tmp
emailrelay --as-server --port 10025 --spool-dir /tmp
On Windows use *c:/temp* for testing, rather than */tmp*.
Or to run it in the foreground:
::
emailrelay --log --no-daemon --port 10025 --spool-dir /tmp
And then to forward the spooled mail to *smtp.example.com* run something
like this:
@ -52,46 +53,63 @@ like this:
emailrelay --as-client smtp.example.com:25 --spool-dir /tmp
To get behaviour more like a proxy you can add the *--poll* and *--forward-to*
options so that messages are forwarded continuously rather than on-demand.
To forward continuously you can add the *--poll* and *--forward-to* options to
the server command-line:
.. image:: forwardto.png
:alt: forwardto.png
This example starts a store-and-forward server that forwards spooled-up e-mail
every minute:
For example, this starts a server that also forwards spooled-up e-mail every
minute:
::
emailrelay --as-server --poll 60 --forward-to smtp.example.com:25
Or for a proxy server that forwards each message soon after it has been
received, you can use *--as-proxy* or add *--forward-on-disconnect*:
Or for a server that forwards each message as soon as it has been received, you
can use *--forward-on-disconnect*:
::
emailrelay --as-server --forward-on-disconnect --forward-to smtp.example.com:25
To edit or filter e-mail as it passes through the proxy specify your filter
To edit or filter e-mail as it passes through the server specify your filter
program with the *--filter* option, something like this:
::
emailrelay --as-proxy smtp.example.com:25 --filter addsig.js
emailrelay --as-server --filter /tmp/set-from.js
To run E-MailRelay as a POP_ server without SMTP use *--pop* and *--no-smtp*:
Look for example filter scripts in the *examples* directory.
E-MailRelay can also be used as a personal internet mail server:
.. image:: mailserver.png
:alt: mailserver.png
Use *--remote-clients* (\ *-r*\ ) to allow connections from outside the local
network, define your domain name with *--domain* and use an address verifier as
a first line of defense against spammers:
::
emailrelay --pop --no-smtp --log --close-stderr
emailrelay --as-server -v -r --domain=example.com --address-verifier=account:
The *emailrelay-submit* utility can be used to put messages straight into the
spool directory so that the POP clients can fetch them.
Then enable POP access to the incoming e-mails with *--pop*, *--pop-port* and
\ *--pop-auth*\ :
By default E-MailRelay will always reject connections from remote networks. To
allow connections from anywhere use the *--remote-clients* option, but please
check your firewall settings to make sure this cannot be exploited by spammers.
::
emailrelay ... --pop --pop-port 10110 --pop-auth /etc/emailrelay.auth
Set up the POP account with a user-id and password in the *--pop-auth* secrets
file. The secrets file should contain a single line of text like this:
::
server plain <userid> <password>
For more information on the command-line options refer to the reference guide
or run:
@ -100,18 +118,29 @@ or run:
emailrelay --help --verbose
Packages
========
To install on Linux from a RPM or DEB package:
Autostart
=========
To install E-MailRelay on Windows run the *emailrelay-setup* program and choose
the automatic startup option on the last page so that E-MailRelay runs as a
Windows service. Use the Windows *Services* utility to configure the E-MailRelay
service as automatic or manual startup.
To install E-MailRelay on Linux from a RPM package:
::
sudo $SHELL # or 'su'
rpm -i emailrelay*.rpm # if RPM
dpkg -i emailrelay*.deb # if DEB
sudo rpm -i emailrelay*.rpm
If your Linux system uses *systemd* then you should check the E-MailRelay
configuration file */etc/emailrelay.conf* is as you want it and then run:
Or from a DEB package:
::
sudo dpkg -i emailrelay*.deb
To get the E-MailRelay server to start automatically you should check the
configuration file */etc/emailrelay.conf* is as you want it and then run the
following commands to activate the *systemd* service:
::
@ -119,16 +148,25 @@ configuration file */etc/emailrelay.conf* is as you want it and then run:
systemctl start emailrelay
systemctl status emailrelay
On other systems try these commands:
On other Linux systems try some combination of these commands to set up and
activate the E-MailRelay service:
::
cp /usr/lib/emailrelay/init/emailrelay /etc/init.d/
update-rc.d emailrelay enable || rc-update add emailrelay
invoke-rc.d emailrelay start || service emailrelay start
tail /var/log/messages /var/log/syslog 2>/dev/null
update-rc.d emailrelay enable
rc-update add emailrelay
invoke-rc.d emailrelay start
service emailrelay start
tail /var/log/messages
tail /var/log/syslog
On BSD systems add this line to /etc/rc.conf:
::
emailrelay_enable="YES"
On Windows run the setup program.
Documentation
=============
@ -145,7 +183,12 @@ The following documentation is provided:
Source code documentation will be generated when building from source if
*doxygen* is available.
Feedback
========
To give feedback, including reviews, bug reports and feature requests, please
use the SourceForge project website at https://sourceforge.net/p/emailrelay
.. _DNSBL: https://en.wikipedia.org/wiki/DNSBL
.. _POP: https://en.wikipedia.org/wiki/Post_Office_Protocol
.. _SMTP: https://en.wikipedia.org/wiki/Simple_Mail_Transfer_Protocol

2
VERSION
View File

@ -1 +1 @@
2.4.1
2.5

75
aclocal.m4 vendored
View File

@ -1,6 +1,6 @@
# generated automatically by aclocal 1.16.1 -*- Autoconf -*-
# generated automatically by aclocal 1.16.3 -*- Autoconf -*-
# Copyright (C) 1996-2018 Free Software Foundation, Inc.
# Copyright (C) 1996-2020 Free Software Foundation, Inc.
# This file is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
@ -20,7 +20,7 @@ You have another version of autoconf. It may work, but is not guaranteed to.
If you have problems, you may need to regenerate the build system entirely.
To do so, use the procedure documented by the package, typically 'autoreconf'.])])
# Copyright (C) 2002-2018 Free Software Foundation, Inc.
# Copyright (C) 2002-2020 Free Software Foundation, Inc.
#
# This file is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
@ -35,7 +35,7 @@ AC_DEFUN([AM_AUTOMAKE_VERSION],
[am__api_version='1.16'
dnl Some users find AM_AUTOMAKE_VERSION and mistake it for a way to
dnl require some minimum version. Point them to the right macro.
m4_if([$1], [1.16.1], [],
m4_if([$1], [1.16.3], [],
[AC_FATAL([Do not call $0, use AM_INIT_AUTOMAKE([$1]).])])dnl
])
@ -51,14 +51,14 @@ m4_define([_AM_AUTOCONF_VERSION], [])
# Call AM_AUTOMAKE_VERSION and AM_AUTOMAKE_VERSION so they can be traced.
# This function is AC_REQUIREd by AM_INIT_AUTOMAKE.
AC_DEFUN([AM_SET_CURRENT_AUTOMAKE_VERSION],
[AM_AUTOMAKE_VERSION([1.16.1])dnl
[AM_AUTOMAKE_VERSION([1.16.3])dnl
m4_ifndef([AC_AUTOCONF_VERSION],
[m4_copy([m4_PACKAGE_VERSION], [AC_AUTOCONF_VERSION])])dnl
_AM_AUTOCONF_VERSION(m4_defn([AC_AUTOCONF_VERSION]))])
# AM_AUX_DIR_EXPAND -*- Autoconf -*-
# Copyright (C) 2001-2018 Free Software Foundation, Inc.
# Copyright (C) 2001-2020 Free Software Foundation, Inc.
#
# This file is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
@ -110,7 +110,7 @@ am_aux_dir=`cd "$ac_aux_dir" && pwd`
# AM_CONDITIONAL -*- Autoconf -*-
# Copyright (C) 1997-2018 Free Software Foundation, Inc.
# Copyright (C) 1997-2020 Free Software Foundation, Inc.
#
# This file is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
@ -141,7 +141,7 @@ AC_CONFIG_COMMANDS_PRE(
Usually this means the macro was only invoked conditionally.]])
fi])])
# Copyright (C) 1999-2018 Free Software Foundation, Inc.
# Copyright (C) 1999-2020 Free Software Foundation, Inc.
#
# This file is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
@ -332,7 +332,7 @@ _AM_SUBST_NOTMAKE([am__nodep])dnl
# Generate code to set up dependency tracking. -*- Autoconf -*-
# Copyright (C) 1999-2018 Free Software Foundation, Inc.
# Copyright (C) 1999-2020 Free Software Foundation, Inc.
#
# This file is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
@ -371,7 +371,9 @@ AC_DEFUN([_AM_OUTPUT_DEPENDENCY_COMMANDS],
done
if test $am_rc -ne 0; then
AC_MSG_FAILURE([Something went wrong bootstrapping makefile fragments
for automatic dependency tracking. Try re-running configure with the
for automatic dependency tracking. If GNU make was not used, consider
re-running the configure script with MAKE="gmake" (or whatever is
necessary). You can also try re-running configure with the
'--disable-dependency-tracking' option to at least be able to build
the package (albeit without support for automatic dependency tracking).])
fi
@ -396,9 +398,26 @@ AC_DEFUN([AM_OUTPUT_DEPENDENCY_COMMANDS],
[test x"$AMDEP_TRUE" != x"" || _AM_OUTPUT_DEPENDENCY_COMMANDS],
[AMDEP_TRUE="$AMDEP_TRUE" MAKE="${MAKE-make}"])])
# AM_EXTRA_RECURSIVE_TARGETS -*- Autoconf -*-
# Copyright (C) 2012-2020 Free Software Foundation, Inc.
#
# This file is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
# with or without modifications, as long as this notice is preserved.
# AM_EXTRA_RECURSIVE_TARGETS
# --------------------------
# Define the list of user recursive targets. This macro exists only to
# be traced by Automake, which will ensure that a proper definition of
# user-defined recursive targets (and associated rules) is propagated
# into all the generated Makefiles.
# TODO: We should really reject non-literal arguments here...
AC_DEFUN([AM_EXTRA_RECURSIVE_TARGETS], [])
# Do all the work for Automake. -*- Autoconf -*-
# Copyright (C) 1996-2018 Free Software Foundation, Inc.
# Copyright (C) 1996-2020 Free Software Foundation, Inc.
#
# This file is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
@ -595,7 +614,7 @@ for _am_header in $config_headers :; do
done
echo "timestamp for $_am_arg" >`AS_DIRNAME(["$_am_arg"])`/stamp-h[]$_am_stamp_count])
# Copyright (C) 2001-2018 Free Software Foundation, Inc.
# Copyright (C) 2001-2020 Free Software Foundation, Inc.
#
# This file is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
@ -616,7 +635,7 @@ if test x"${install_sh+set}" != xset; then
fi
AC_SUBST([install_sh])])
# Copyright (C) 2003-2018 Free Software Foundation, Inc.
# Copyright (C) 2003-2020 Free Software Foundation, Inc.
#
# This file is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
@ -638,7 +657,7 @@ AC_SUBST([am__leading_dot])])
# Add --enable-maintainer-mode option to configure. -*- Autoconf -*-
# From Jim Meyering
# Copyright (C) 1996-2018 Free Software Foundation, Inc.
# Copyright (C) 1996-2020 Free Software Foundation, Inc.
#
# This file is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
@ -673,7 +692,7 @@ AC_MSG_CHECKING([whether to enable maintainer-specific portions of Makefiles])
# Check to see how 'make' treats includes. -*- Autoconf -*-
# Copyright (C) 2001-2018 Free Software Foundation, Inc.
# Copyright (C) 2001-2020 Free Software Foundation, Inc.
#
# This file is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
@ -716,7 +735,7 @@ AC_SUBST([am__quote])])
# Fake the existence of programs that GNU maintainers use. -*- Autoconf -*-
# Copyright (C) 1997-2018 Free Software Foundation, Inc.
# Copyright (C) 1997-2020 Free Software Foundation, Inc.
#
# This file is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
@ -737,12 +756,7 @@ AC_DEFUN([AM_MISSING_HAS_RUN],
[AC_REQUIRE([AM_AUX_DIR_EXPAND])dnl
AC_REQUIRE_AUX_FILE([missing])dnl
if test x"${MISSING+set}" != xset; then
case $am_aux_dir in
*\ * | *\ *)
MISSING="\${SHELL} \"$am_aux_dir/missing\"" ;;
*)
MISSING="\${SHELL} $am_aux_dir/missing" ;;
esac
MISSING="\${SHELL} '$am_aux_dir/missing'"
fi
# Use eval to expand $SHELL
if eval "$MISSING --is-lightweight"; then
@ -755,7 +769,7 @@ fi
# Helper functions for option handling. -*- Autoconf -*-
# Copyright (C) 2001-2018 Free Software Foundation, Inc.
# Copyright (C) 2001-2020 Free Software Foundation, Inc.
#
# This file is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
@ -784,7 +798,7 @@ AC_DEFUN([_AM_SET_OPTIONS],
AC_DEFUN([_AM_IF_OPTION],
[m4_ifset(_AM_MANGLE_OPTION([$1]), [$2], [$3])])
# Copyright (C) 1999-2018 Free Software Foundation, Inc.
# Copyright (C) 1999-2020 Free Software Foundation, Inc.
#
# This file is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
@ -831,7 +845,7 @@ AC_LANG_POP([C])])
# For backward compatibility.
AC_DEFUN_ONCE([AM_PROG_CC_C_O], [AC_REQUIRE([AC_PROG_CC])])
# Copyright (C) 2001-2018 Free Software Foundation, Inc.
# Copyright (C) 2001-2020 Free Software Foundation, Inc.
#
# This file is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
@ -850,7 +864,7 @@ AC_DEFUN([AM_RUN_LOG],
# Check to make sure that the build environment is sane. -*- Autoconf -*-
# Copyright (C) 1996-2018 Free Software Foundation, Inc.
# Copyright (C) 1996-2020 Free Software Foundation, Inc.
#
# This file is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
@ -931,7 +945,7 @@ AC_CONFIG_COMMANDS_PRE(
rm -f conftest.file
])
# Copyright (C) 2009-2018 Free Software Foundation, Inc.
# Copyright (C) 2009-2020 Free Software Foundation, Inc.
#
# This file is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
@ -991,7 +1005,7 @@ AC_SUBST([AM_BACKSLASH])dnl
_AM_SUBST_NOTMAKE([AM_BACKSLASH])dnl
])
# Copyright (C) 2001-2018 Free Software Foundation, Inc.
# Copyright (C) 2001-2020 Free Software Foundation, Inc.
#
# This file is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
@ -1019,7 +1033,7 @@ fi
INSTALL_STRIP_PROGRAM="\$(install_sh) -c -s"
AC_SUBST([INSTALL_STRIP_PROGRAM])])
# Copyright (C) 2006-2018 Free Software Foundation, Inc.
# Copyright (C) 2006-2020 Free Software Foundation, Inc.
#
# This file is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
@ -1038,7 +1052,7 @@ AC_DEFUN([AM_SUBST_NOTMAKE], [_AM_SUBST_NOTMAKE($@)])
# Check how to create a tarball. -*- Autoconf -*-
# Copyright (C) 2004-2018 Free Software Foundation, Inc.
# Copyright (C) 2004-2020 Free Software Foundation, Inc.
#
# This file is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
@ -1171,5 +1185,4 @@ AC_SUBST([am__untar])
m4_include([m4/acinclude.m4])
m4_include([m4/m4_ax_cxx_compile_stdcxx.m4])
m4_include([m4/m4_ax_cxx_compile_stdcxx_11.m4])
m4_include([m4/pkg.m4])

56
bin/Makefile.am
View File

@ -1,5 +1,5 @@
#
## Copyright (C) 2001-2022 Graeme Walker <graeme_walker@users.sourceforge.net>
## Copyright (C) 2001-2023 Graeme Walker <graeme_walker@users.sourceforge.net>
##
## This program is free software: you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published by
@ -17,24 +17,29 @@
example_scripts_static = \
emailrelay-bcc-check.pl \
emailrelay-check-ipaddress.js \
emailrelay-check-ipaddress.pl \
emailrelay-dkim-signer.pl \
emailrelay-ldap-verify.py \
emailrelay-multicast.sh \
emailrelay-rot13.pl \
emailrelay-sendmail.pl \
emailrelay-sendmail.pl
example_scripts_js = \
emailrelay-check-ipaddress.js \
emailrelay-set-message-id.js \
emailrelay-set-from.js \
emailrelay-set-from.pl
emailrelay-set-from.pl \
emailrelay-edit-content.js \
emailrelay-edit-envelope.js \
emailrelay-resubmit.js \
emailrelay-service-install.js
example_scripts_in = \
emailrelay-deliver.sh.in \
emailrelay-notify.sh.in \
emailrelay-resubmit.sh.in \
emailrelay-submit.sh.in
example_scripts_out = \
emailrelay-deliver.sh \
emailrelay-notify.sh \
emailrelay-resubmit.sh \
emailrelay-submit.sh \
@ -46,41 +51,18 @@ init_script_in = \
init_script_out = \
emailrelay
work_scripts = \
doxygen.sh \
make-manifest.sh \
make-setup.sh \
make-format \
make2cmake \
make2cdb \
make2unity \
AutoMakeParser.pm \
CompilationDatabase.pm \
ConfigStatus.pm \
winbuild.pm
js_scripts = \
emailrelay-edit-content.js \
emailrelay-edit-envelope.js \
emailrelay-resubmit.js \
emailrelay-service-install.js
EXTRA_DIST = \
$(example_scripts_static) \
$(example_scripts_js) \
$(example_scripts_in) \
$(init_script_in) \
$(work_scripts) \
$(js_scripts)
noinst_SCRIPTS = \
$(work_scripts) \
$(js_scripts)
$(init_script_in)
e_examples_DATA = \
$(example_scripts_static)
$(example_scripts_js)
e_examples_SCRIPTS = \
$(example_scripts_out)
$(example_scripts_out) \
$(example_scripts_static)
e_init_SCRIPTS = \
$(init_script_out)
@ -88,11 +70,7 @@ e_init_SCRIPTS = \
CLEANFILES = \
$(example_scripts_out)
do_sed = sed -e "s%__SPOOL_DIR__%${e_spooldir}%g" -e "s%__SBIN_DIR__%${sbindir}%g" -e "s%__SYSCONF_DIR__%${e_sysconfdir}%g" -e "s%__LIBEXEC_DIR__%${e_libexecdir}%g" -e "s%__RUN_DIR__%${e_rundir}%g"
emailrelay-deliver.sh: emailrelay-deliver.sh.in
$(do_sed) < $(srcdir)/emailrelay-deliver.sh.in > emailrelay-deliver.sh
chmod +x emailrelay-deliver.sh
do_sed = sed -e "s%__SPOOL_DIR__%${e_spooldir}%g" -e "s%__SBIN_DIR__%${sbindir}%g" -e "s%__SYSCONF_DIR__%${e_sysconfdir}%g" -e "s%__LIB_DIR__%${e_libdir}%g" -e "s%__RUN_DIR__%${e_rundir}%g"
emailrelay-notify.sh: emailrelay-notify.sh.in
$(do_sed) < $(srcdir)/emailrelay-notify.sh.in > emailrelay-notify.sh

95
bin/Makefile.in
View File

@ -1,7 +1,7 @@
# Makefile.in generated by automake 1.16.1 from Makefile.am.
# Makefile.in generated by automake 1.16.3 from Makefile.am.
# @configure_input@
# Copyright (C) 1994-2018 Free Software Foundation, Inc.
# Copyright (C) 1994-2020 Free Software Foundation, Inc.
# This Makefile.in is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
@ -94,7 +94,6 @@ subdir = bin
ACLOCAL_M4 = $(top_srcdir)/aclocal.m4
am__aclocal_m4_deps = $(top_srcdir)/m4/acinclude.m4 \
$(top_srcdir)/m4/m4_ax_cxx_compile_stdcxx.m4 \
$(top_srcdir)/m4/m4_ax_cxx_compile_stdcxx_11.m4 \
$(top_srcdir)/m4/pkg.m4 $(top_srcdir)/configure.ac
am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \
$(ACLOCAL_M4)
@ -132,7 +131,7 @@ am__uninstall_files_from_dir = { \
}
am__installdirs = "$(DESTDIR)$(e_examplesdir)" \
"$(DESTDIR)$(e_initdir)" "$(DESTDIR)$(e_examplesdir)"
SCRIPTS = $(e_examples_SCRIPTS) $(e_init_SCRIPTS) $(noinst_SCRIPTS)
SCRIPTS = $(e_examples_SCRIPTS) $(e_init_SCRIPTS)
AM_V_P = $(am__v_P_@AM_V@)
am__v_P_ = $(am__v_P_@AM_DEFAULT_V@)
am__v_P_0 = false
@ -153,6 +152,7 @@ am__can_run_installinfo = \
*) (install-info --version) >/dev/null 2>&1;; \
esac
DATA = $(e_examples_DATA)
am__extra_recursive_targets = extra-recursive
am__tagged_files = $(HEADERS) $(SOURCES) $(TAGS_FILES) $(LISP)
am__DIST_COMMON = $(srcdir)/Makefile.in
DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST)
@ -160,6 +160,7 @@ ACLOCAL = @ACLOCAL@
AMTAR = @AMTAR@
AM_DEFAULT_VERBOSITY = @AM_DEFAULT_VERBOSITY@
AR = @AR@
ARFLAGS = @ARFLAGS@
AUTOCONF = @AUTOCONF@
AUTOHEADER = @AUTOHEADER@
AUTOMAKE = @AUTOMAKE@
@ -249,7 +250,7 @@ e_docdir = @e_docdir@
e_examplesdir = @e_examplesdir@
e_icondir = @e_icondir@
e_initdir = @e_initdir@
e_libexecdir = @e_libexecdir@
e_libdir = @e_libdir@
e_pamdir = @e_pamdir@
e_rundir = @e_rundir@
e_spooldir = @e_spooldir@
@ -284,24 +285,29 @@ top_builddir = @top_builddir@
top_srcdir = @top_srcdir@
example_scripts_static = \
emailrelay-bcc-check.pl \
emailrelay-check-ipaddress.js \
emailrelay-check-ipaddress.pl \
emailrelay-dkim-signer.pl \
emailrelay-ldap-verify.py \
emailrelay-multicast.sh \
emailrelay-rot13.pl \
emailrelay-sendmail.pl \
emailrelay-sendmail.pl
example_scripts_js = \
emailrelay-check-ipaddress.js \
emailrelay-set-message-id.js \
emailrelay-set-from.js \
emailrelay-set-from.pl
emailrelay-set-from.pl \
emailrelay-edit-content.js \
emailrelay-edit-envelope.js \
emailrelay-resubmit.js \
emailrelay-service-install.js
example_scripts_in = \
emailrelay-deliver.sh.in \
emailrelay-notify.sh.in \
emailrelay-resubmit.sh.in \
emailrelay-submit.sh.in
example_scripts_out = \
emailrelay-deliver.sh \
emailrelay-notify.sh \
emailrelay-resubmit.sh \
emailrelay-submit.sh \
@ -313,41 +319,18 @@ init_script_in = \
init_script_out = \
emailrelay
work_scripts = \
doxygen.sh \
make-manifest.sh \
make-setup.sh \
make-format \
make2cmake \
make2cdb \
make2unity \
AutoMakeParser.pm \
CompilationDatabase.pm \
ConfigStatus.pm \
winbuild.pm
js_scripts = \
emailrelay-edit-content.js \
emailrelay-edit-envelope.js \
emailrelay-resubmit.js \
emailrelay-service-install.js
EXTRA_DIST = \
$(example_scripts_static) \
$(example_scripts_js) \
$(example_scripts_in) \
$(init_script_in) \
$(work_scripts) \
$(js_scripts)
noinst_SCRIPTS = \
$(work_scripts) \
$(js_scripts)
$(init_script_in)
e_examples_DATA = \
$(example_scripts_static)
$(example_scripts_js)
e_examples_SCRIPTS = \
$(example_scripts_out)
$(example_scripts_out) \
$(example_scripts_static)
e_init_SCRIPTS = \
$(init_script_out)
@ -355,7 +338,7 @@ e_init_SCRIPTS = \
CLEANFILES = \
$(example_scripts_out)
do_sed = sed -e "s%__SPOOL_DIR__%${e_spooldir}%g" -e "s%__SBIN_DIR__%${sbindir}%g" -e "s%__SYSCONF_DIR__%${e_sysconfdir}%g" -e "s%__LIBEXEC_DIR__%${e_libexecdir}%g" -e "s%__RUN_DIR__%${e_rundir}%g"
do_sed = sed -e "s%__SPOOL_DIR__%${e_spooldir}%g" -e "s%__SBIN_DIR__%${sbindir}%g" -e "s%__SYSCONF_DIR__%${e_sysconfdir}%g" -e "s%__LIB_DIR__%${e_libdir}%g" -e "s%__RUN_DIR__%${e_rundir}%g"
all: all-am
.SUFFIXES:
@ -479,6 +462,7 @@ uninstall-e_examplesDATA:
@list='$(e_examples_DATA)'; test -n "$(e_examplesdir)" || list=; \
files=`for p in $$list; do echo $$p; done | sed -e 's|^.*/||'`; \
dir='$(DESTDIR)$(e_examplesdir)'; $(am__uninstall_files_from_dir)
extra-local:
tags TAGS:
ctags CTAGS:
@ -569,6 +553,10 @@ dvi: dvi-am
dvi-am:
extra: extra-am
extra-am: extra-local
html: html-am
html-am:
@ -628,26 +616,23 @@ uninstall-am: uninstall-e_examplesDATA uninstall-e_examplesSCRIPTS \
.MAKE: install-am install-strip
.PHONY: all all-am check check-am clean clean-generic cscopelist-am \
ctags-am distclean distclean-generic distdir dvi dvi-am html \
html-am info info-am install install-am install-data \
install-data-am install-dvi install-dvi-am \
install-e_examplesDATA install-e_examplesSCRIPTS \
install-e_initSCRIPTS install-exec install-exec-am \
install-html install-html-am install-info install-info-am \
install-man install-pdf install-pdf-am install-ps \
install-ps-am install-strip installcheck installcheck-am \
installdirs maintainer-clean maintainer-clean-generic \
mostlyclean mostlyclean-generic pdf pdf-am ps ps-am tags-am \
uninstall uninstall-am uninstall-e_examplesDATA \
uninstall-e_examplesSCRIPTS uninstall-e_initSCRIPTS
ctags-am distclean distclean-generic distdir dvi dvi-am \
extra-am extra-local html html-am info info-am install \
install-am install-data install-data-am install-dvi \
install-dvi-am install-e_examplesDATA \
install-e_examplesSCRIPTS install-e_initSCRIPTS install-exec \
install-exec-am install-html install-html-am install-info \
install-info-am install-man install-pdf install-pdf-am \
install-ps install-ps-am install-strip installcheck \
installcheck-am installdirs maintainer-clean \
maintainer-clean-generic mostlyclean mostlyclean-generic pdf \
pdf-am ps ps-am tags-am uninstall uninstall-am \
uninstall-e_examplesDATA uninstall-e_examplesSCRIPTS \
uninstall-e_initSCRIPTS
.PRECIOUS: Makefile
emailrelay-deliver.sh: emailrelay-deliver.sh.in
$(do_sed) < $(srcdir)/emailrelay-deliver.sh.in > emailrelay-deliver.sh
chmod +x emailrelay-deliver.sh
emailrelay-notify.sh: emailrelay-notify.sh.in
$(do_sed) < $(srcdir)/emailrelay-notify.sh.in > emailrelay-notify.sh
chmod +x emailrelay-notify.sh

2
bin/emailrelay-bcc-check.pl
View File

@ -1,6 +1,6 @@
#!/usr/bin/env perl
#
# Copyright (C) 2001-2022 Graeme Walker <graeme_walker@users.sourceforge.net>
# Copyright (C) 2001-2023 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# Copying and distribution of this file, with or without modification,
# are permitted in any medium without royalty provided the copyright

2
bin/emailrelay-check-ipaddress.js Executable file → Normal file
View File

@ -1,5 +1,5 @@
//
// Copyright (C) 2001-2022 Graeme Walker <graeme_walker@users.sourceforge.net>
// Copyright (C) 2001-2023 Graeme Walker <graeme_walker@users.sourceforge.net>
//
// Copying and distribution of this file, with or without modification,
// are permitted in any medium without royalty provided the copyright

2
bin/emailrelay-check-ipaddress.pl
View File

@ -1,6 +1,6 @@
#!/usr/bin/env perl
#
# Copyright (C) 2001-2022 Graeme Walker <graeme_walker@users.sourceforge.net>
# Copyright (C) 2001-2023 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# Copying and distribution of this file, with or without modification,
# are permitted in any medium without royalty provided the copyright

70
bin/emailrelay-deliver.sh.in
View File

@ -1,70 +0,0 @@
#!/bin/sh
#
# Copyright (C) 2001-2022 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# Copying and distribution of this file, with or without modification,
# are permitted in any medium without royalty provided the copyright
# notice and this notice are preserved. This file is offered as-is,
# without any warranty.
# ===
#
# emailrelay-deliver.sh
#
# Looks for local mail in the E-MailRelay spool directory and delivers is using
# 'procmail'.
#
# usage: emailrelay-deliver.sh [<spool-dir>]
#
# This illustrates how delivery to local "postmaster" mailboxes could be done,
# although it is not likely to be a useful feature for a typical mail relay
# setup.
#
store="__SPOOL_DIR__"
postmaster="root"
procmail="procmail"
# parse the command line
#
if test $# -ge 1
then
store="${1}"
fi
# check the spool directory is valid
#
if test \! -d "${store}"
then
echo `basename $0`: invalid spool directory >&2
exit 1
fi
# for each e-mail to a local recipient...
#
for file in "${store}"/emailrelay.*.envelope.local ""
do
if test -f "${file}"
then
content="`echo \"${file}\" | sed 's/envelope/content/'`"
deliver_to="`fgrep X-MailRelay-To-Local ${file} | sed 's/X-MailRelay-To-Local: //' | tr -d '\015' | sed \"s/postmaster/${postmaster}/g\"`"
if test "${deliver_to}" = ""
then
deliver_to="${postmaster}"
fi
# deliver using procmail
#
if test -f "${content}"
then
echo `basename $0`: delivering `basename "${content}"` to ${deliver_to}
"${procmail}" -d "${deliver_to}" < "${content}"
rc=$?
if test "${rc}" -eq 0
then
rm -f "${file}" 2>/dev/null
fi
fi
fi
done

2
bin/emailrelay-dkim-signer.pl
View File

@ -1,6 +1,6 @@
#!/usr/bin/env perl
#
# Copyright (C) 2001-2022 Graeme Walker <graeme_walker@users.sourceforge.net>
# Copyright (C) 2001-2023 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# Copying and distribution of this file, with or without modification,
# are permitted in any medium without royalty provided the copyright

2
bin/emailrelay-edit-content.js
View File

@ -1,5 +1,5 @@
//
// Copyright (C) 2001-2022 Graeme Walker <graeme_walker@users.sourceforge.net>
// Copyright (C) 2001-2023 Graeme Walker <graeme_walker@users.sourceforge.net>
//
// Copying and distribution of this file, with or without modification,
// are permitted in any medium without royalty provided the copyright

2
bin/emailrelay-edit-envelope.js
View File

@ -1,5 +1,5 @@
//
// Copyright (C) 2001-2022 Graeme Walker <graeme_walker@users.sourceforge.net>
// Copyright (C) 2001-2023 Graeme Walker <graeme_walker@users.sourceforge.net>
//
// Copying and distribution of this file, with or without modification,
// are permitted in any medium without royalty provided the copyright

4
bin/emailrelay-ldap-verify.py
View File

@ -1,6 +1,6 @@
#!/usr/bin/env python3
#
# Copyright (C) 2020-2022 <richardwvm@users.sourceforge.net>
# Copyright (C) 2020-2023 <richardwvm@users.sourceforge.net>
#
# Copying and distribution of this file, with or without modification,
# are permitted in any medium without royalty provided the copyright
@ -12,6 +12,8 @@
#
# Example address verifier script using LDAP.
#
# See also: https://www.python-ldap.org/en/python-ldap-3.3.0
#
import sys
import ldap

2
bin/emailrelay-multicast.sh
View File

@ -1,6 +1,6 @@
#!/bin/sh
#
# Copyright (C) 2001-2022 Graeme Walker <graeme_walker@users.sourceforge.net>
# Copyright (C) 2001-2023 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# Copying and distribution of this file, with or without modification,
# are permitted in any medium without royalty provided the copyright

2
bin/emailrelay-notify.sh.in
View File

@ -1,6 +1,6 @@
#!/bin/sh
#
# Copyright (C) 2001-2022 Graeme Walker <graeme_walker@users.sourceforge.net>
# Copyright (C) 2001-2023 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# Copying and distribution of this file, with or without modification,
# are permitted in any medium without royalty provided the copyright

2
bin/emailrelay-resubmit.js
View File

@ -1,5 +1,5 @@
//
// Copyright (C) 2001-2022 Graeme Walker <graeme_walker@users.sourceforge.net>
// Copyright (C) 2001-2023 Graeme Walker <graeme_walker@users.sourceforge.net>
//
// Copying and distribution of this file, with or without modification,
// are permitted in any medium without royalty provided the copyright

2
bin/emailrelay-resubmit.sh.in
View File

@ -1,6 +1,6 @@
#!/bin/sh
#
# Copyright (C) 2001-2022 Graeme Walker <graeme_walker@users.sourceforge.net>
# Copyright (C) 2001-2023 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# Copying and distribution of this file, with or without modification,
# are permitted in any medium without royalty provided the copyright

2
bin/emailrelay-rot13.pl
View File

@ -1,6 +1,6 @@
#!/usr/bin/env perl
#
# Copyright (C) 2001-2022 Graeme Walker <graeme_walker@users.sourceforge.net>
# Copyright (C) 2001-2023 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# Copying and distribution of this file, with or without modification,
# are permitted in any medium without royalty provided the copyright

9
bin/emailrelay-sendmail.pl
View File

@ -1,6 +1,6 @@
#!/usr/bin/env perl
#
# Copyright (C) 2001-2022 Graeme Walker <graeme_walker@users.sourceforge.net>
# Copyright (C) 2001-2023 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# Copying and distribution of this file, with or without modification,
# are permitted in any medium without royalty provided the copyright
@ -19,13 +19,16 @@ use FileHandle ;
use Getopt::Std ;
my $exe = "/usr/sbin/emailrelay-submit" ;
my $usage = "usage: emailrelay-sendmail [-intUv] [-ABbCDdFfGhiLNnOopqRrtUVvX <arg>] [-f <from>] <to> [<to> ...]" ;
# parse and mostly ignore sendmail command-line options
my $usage = "usage: emailrelay-sendmail [-intUv] [-ABbCDdFfGhiLNnOopqRrtUVvX <arg>] [-f <from>] <to> [<to> ...]" ;
my %opt = () ;
$Getopt::Std::STANDARD_HELP_VERSION = 1 ;
sub HELP_MESSAGE() { print "$usage\n" }
sub VERSION_MESSAGE() {}
getopts( 'A:B:b:C:D:d:F:f:Gh:iL:N:nO:o:p:q:R:r:tUV:vX:' , \%opt ) or die "$usage\n" ;
my $from = defined($opt{f}) ? $opt{f} : $ENV{USER} ;
my @submit_args = ( "--content-date" , @ARGV ) ; # also consider using "--copy"
my @submit_args = ( "--content-date" , @ARGV ) ; # also consider adding "--copy" here
# if "-t" read envelope 'to' addresses from content headers
if( $opt{t} )

2
bin/emailrelay-service-install.js
View File

@ -1,5 +1,5 @@
//
// Copyright (C) 2001-2022 Graeme Walker <graeme_walker@users.sourceforge.net>
// Copyright (C) 2001-2023 Graeme Walker <graeme_walker@users.sourceforge.net>
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by

5
bin/emailrelay-set-from.js Executable file → Normal file
View File

@ -1,5 +1,5 @@
//
// Copyright (C) 2001-2022 Graeme Walker <graeme_walker@users.sourceforge.net>
// Copyright (C) 2001-2023 Graeme Walker <graeme_walker@users.sourceforge.net>
//
// Copying and distribution of this file, with or without modification,
// are permitted in any medium without royalty provided the copyright
@ -12,6 +12,9 @@
// An example "--filter" script that edits the content originator fields
// (ie. From, Sender and Reply-To) to a fixed value.
//
// Also consider setting the envelope-from field by editing the envelope
// file, as in emailrelay-edit-envelope.js.
//
// See also: emailrelay-set-from.pl, RFC-2822
//
try

5
bin/emailrelay-set-from.pl
View File

@ -1,6 +1,6 @@
#!/usr/bin/env perl
#
# Copyright (C) 2001-2022 Graeme Walker <graeme_walker@users.sourceforge.net>
# Copyright (C) 2001-2023 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# Copying and distribution of this file, with or without modification,
# are permitted in any medium without royalty provided the copyright
@ -13,6 +13,9 @@
# An example E-MailRelay "--filter" script that edits the content originator
# fields (ie. From, Sender and Reply-To) to a fixed value.
#
# Also consider setting the envelope-from field by editing the envelope
# file.
#
# See also: emailrelay-set-from.js, RFC-2822
#

77
bin/emailrelay-set-message-id.js Normal file
View File

@ -0,0 +1,77 @@
//
// Copyright (C) 2001-2023 Graeme Walker <graeme_walker@users.sourceforge.net>
//
// Copying and distribution of this file, with or without modification,
// are permitted in any medium without royalty provided the copyright
// notice and this notice are preserved. This file is offered as-is,
// without any warranty.
// ===
//
// emailrelay-set-message-id.js
//
// An example "--filter" script that sets a message-id header if there
// is none.
//
try
{
var domain = "example.com" ;
var content = WScript.Arguments( 0 ) ;
var fs = WScript.CreateObject( "Scripting.FileSystemObject" ) ;
var in_ = fs.OpenTextFile( content , 1 , false ) ;
var out_ = fs.OpenTextFile( content + ".tmp" , 8 , true ) ;
var re_message_id = /^Message-ID:/i ;
var re_fold = /^[ \t]/ ;
var in_message_id = 0 ;
var have_message_id = 0 ;
while( !in_.AtEndOfStream )
{
var line = in_.ReadLine() ;
if( line === "" )
{
if( !have_message_id )
{
var now = new Date() ;
var lhs = (now.getTime()/1000) + "." + (Math.random()*1000).toFixed(0) ) ;
var new_message_id = lhs + "@" + domain ;
out_.WriteLine( "Message-ID: " + new_message_id ) ;
}
out_.WriteLine( line ) ;
break ;
}
if( line.match(re_message_id) )
{
have_message_id = 1 ;
in_message_id = 1 ;
}
else if( in_message_id && line.match(re_fold) )
{
}
else
{
in_message_id = 0 ;
out_.WriteLine( line ) ;
}
}
while( !in_.AtEndOfStream )
{
var body_line = in_.ReadLine() ;
out_.WriteLine( body_line ) ;
}
in_.Close() ;
out_.Close() ;
fs.DeleteFile( content ) ;
fs.MoveFile( content + ".tmp" , content ) ;
WScript.Quit( 0 ) ;
}
catch( e )
{
WScript.StdOut.WriteLine( "<<edit failed>>" ) ;
WScript.StdOut.WriteLine( "<<" + e + ">>" ) ;
WScript.Quit( 1 ) ;
}

2
bin/emailrelay-submit.sh.in
View File

@ -1,6 +1,6 @@
#!/bin/sh
#
# Copyright (C) 2001-2022 Graeme Walker <graeme_walker@users.sourceforge.net>
# Copyright (C) 2001-2023 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# Copying and distribution of this file, with or without modification,
# are permitted in any medium without royalty provided the copyright

26
bin/emailrelay.sh.in
View File

@ -1,6 +1,6 @@
#!/bin/sh
#
# Copyright (C) 2001-2022 Graeme Walker <graeme_walker@users.sourceforge.net>
# Copyright (C) 2001-2023 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
@ -115,9 +115,9 @@ log_end_msg()
#
setup_config()
{
if test ! -f "$CONFIG" -a -f "$CONFIG.template"
if test ! -e "$CONFIG"
then
cp -p "$CONFIG.template" "$CONFIG"
echo "# emailrelay.conf" > "$CONFIG"
fi
}
root_root()
@ -130,7 +130,7 @@ root_root()
spooldir()
{
# Prints the spool directory path from the config file, but with a
# default because packaged installs may not edit the config file
# default because packaged installs might not edit the config file
# like 'make install' does
( echo spool-dir /var/spool/emailrelay ; cat "$CONFIG" ) | \
tr '\t' ' ' | sed 's/ */ /g' | grep '^spool-dir [^ ]' | \
@ -179,7 +179,6 @@ setup_sgid()
setup_tools()
{
setup_sgid "__SBIN_DIR__/emailrelay-submit"
setup_sgid "__LIBEXEC_DIR__/emailrelay-filter-copy"
}
setup_openrc()
{
@ -201,19 +200,6 @@ if test "$1" = "setup" ; then setup ; exit 0 ; fi
#
test -f /lib/lsb/init-functions && . /lib/lsb/init-functions
# Ignore /etc/default 'enabled' switch if running from systemd.
#
# (The 'enabled' mechanism is needed on non-systemd debian distros
# because the dpkg postinstall script starts the server, whereas
# on systemd systems the dpkg postinstall script's call to update-rc.d
# does nothing. On rpm or 'make install' systems the /etc/default file
# is not installed at all.)
#
if test -d /run/systemd/system -a "$PPID" -eq 1
then
EMAILRELAY_ENABLED="1"
fi
case "$1" in
restart|force-reload)
@ -261,10 +247,10 @@ case "$1" in
if pidofproc -p "$PIDFILE" "$DAEMON" >/dev/null
then
log_success_msg "$NAME is running"
true
exit 0
else
log_failure_msg "$NAME is not running"
false
exit 32 # see guiboot_unix.cpp
fi
;;

2
bsd/Makefile.am
View File

@ -1,5 +1,5 @@
#
## Copyright (C) 2001-2022 Graeme Walker <graeme_walker@users.sourceforge.net>
## Copyright (C) 2001-2023 Graeme Walker <graeme_walker@users.sourceforge.net>
##
## This program is free software: you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published by

35
bsd/Makefile.in
View File

@ -1,7 +1,7 @@
# Makefile.in generated by automake 1.16.1 from Makefile.am.
# Makefile.in generated by automake 1.16.3 from Makefile.am.
# @configure_input@
# Copyright (C) 1994-2018 Free Software Foundation, Inc.
# Copyright (C) 1994-2020 Free Software Foundation, Inc.
# This Makefile.in is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
@ -93,7 +93,6 @@ subdir = bsd
ACLOCAL_M4 = $(top_srcdir)/aclocal.m4
am__aclocal_m4_deps = $(top_srcdir)/m4/acinclude.m4 \
$(top_srcdir)/m4/m4_ax_cxx_compile_stdcxx.m4 \
$(top_srcdir)/m4/m4_ax_cxx_compile_stdcxx_11.m4 \
$(top_srcdir)/m4/pkg.m4 $(top_srcdir)/configure.ac
am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \
$(ACLOCAL_M4)
@ -150,6 +149,7 @@ am__can_run_installinfo = \
n|no|NO) false;; \
*) (install-info --version) >/dev/null 2>&1;; \
esac
am__extra_recursive_targets = extra-recursive
am__tagged_files = $(HEADERS) $(SOURCES) $(TAGS_FILES) $(LISP)
am__DIST_COMMON = $(srcdir)/Makefile.in
DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST)
@ -157,6 +157,7 @@ ACLOCAL = @ACLOCAL@
AMTAR = @AMTAR@
AM_DEFAULT_VERBOSITY = @AM_DEFAULT_VERBOSITY@
AR = @AR@
ARFLAGS = @ARFLAGS@
AUTOCONF = @AUTOCONF@
AUTOHEADER = @AUTOHEADER@
AUTOMAKE = @AUTOMAKE@
@ -246,7 +247,7 @@ e_docdir = @e_docdir@
e_examplesdir = @e_examplesdir@
e_icondir = @e_icondir@
e_initdir = @e_initdir@
e_libexecdir = @e_libexecdir@
e_libdir = @e_libdir@
e_pamdir = @e_pamdir@
e_rundir = @e_rundir@
e_spooldir = @e_spooldir@
@ -353,6 +354,7 @@ uninstall-e_bsdinitSCRIPTS:
files=`for p in $$list; do echo "$$p"; done | \
sed -e 's,.*/,,;$(transform)'`; \
dir='$(DESTDIR)$(e_bsdinitdir)'; $(am__uninstall_files_from_dir)
extra-local:
tags TAGS:
ctags CTAGS:
@ -443,6 +445,10 @@ dvi: dvi-am
dvi-am:
extra: extra-am
extra-am: extra-local
html: html-am
html-am:
@ -500,16 +506,17 @@ uninstall-am: uninstall-e_bsdinitSCRIPTS
.MAKE: install-am install-strip
.PHONY: all all-am check check-am clean clean-generic cscopelist-am \
ctags-am distclean distclean-generic distdir dvi dvi-am html \
html-am info info-am install install-am install-data \
install-data-am install-dvi install-dvi-am \
install-e_bsdinitSCRIPTS install-exec install-exec-am \
install-html install-html-am install-info install-info-am \
install-man install-pdf install-pdf-am install-ps \
install-ps-am install-strip installcheck installcheck-am \
installdirs maintainer-clean maintainer-clean-generic \
mostlyclean mostlyclean-generic pdf pdf-am ps ps-am tags-am \
uninstall uninstall-am uninstall-e_bsdinitSCRIPTS
ctags-am distclean distclean-generic distdir dvi dvi-am \
extra-am extra-local html html-am info info-am install \
install-am install-data install-data-am install-dvi \
install-dvi-am install-e_bsdinitSCRIPTS install-exec \
install-exec-am install-html install-html-am install-info \
install-info-am install-man install-pdf install-pdf-am \
install-ps install-ps-am install-strip installcheck \
installcheck-am installdirs maintainer-clean \
maintainer-clean-generic mostlyclean mostlyclean-generic pdf \
pdf-am ps ps-am tags-am uninstall uninstall-am \
uninstall-e_bsdinitSCRIPTS
.PRECIOUS: Makefile

2
bsd/emailrelay-bsd.sh.in
View File

@ -1,6 +1,6 @@
#!/bin/sh
#
# Copyright (C) 2001-2022 Graeme Walker <graeme_walker@users.sourceforge.net>
# Copyright (C) 2001-2023 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by

17
compile
View File

@ -1,9 +1,9 @@
#! /bin/sh
# Wrapper for compilers which do not understand '-c -o'.
scriptversion=2012-10-14.11; # UTC
scriptversion=2018-03-07.03; # UTC
# Copyright (C) 1999-2014 Free Software Foundation, Inc.
# Copyright (C) 1999-2020 Free Software Foundation, Inc.
# Written by Tom Tromey <tromey@cygnus.com>.
#
# This program is free software; you can redistribute it and/or modify
@ -17,7 +17,7 @@ scriptversion=2012-10-14.11; # UTC
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
# along with this program. If not, see <https://www.gnu.org/licenses/>.
# As a special exception to the GNU General Public License, if you
# distribute this file as part of a program that contains a
@ -53,7 +53,7 @@ func_file_conv ()
MINGW*)
file_conv=mingw
;;
CYGWIN*)
CYGWIN* | MSYS*)
file_conv=cygwin
;;
*)
@ -67,7 +67,7 @@ func_file_conv ()
mingw/*)
file=`cmd //C echo "$file " | sed -e 's/"\(.*\) " *$/\1/'`
;;
cygwin/*)
cygwin/* | msys/*)
file=`cygpath -m "$file" || echo "$file"`
;;
wine/*)
@ -255,7 +255,8 @@ EOF
echo "compile $scriptversion"
exit $?
;;
cl | *[/\\]cl | cl.exe | *[/\\]cl.exe )
cl | *[/\\]cl | cl.exe | *[/\\]cl.exe | \
icl | *[/\\]icl | icl.exe | *[/\\]icl.exe )
func_cl_wrapper "$@" # Doesn't return...
;;
esac
@ -339,9 +340,9 @@ exit $ret
# Local Variables:
# mode: shell-script
# sh-indentation: 2
# eval: (add-hook 'write-file-hooks 'time-stamp)
# eval: (add-hook 'before-save-hook 'time-stamp)
# time-stamp-start: "scriptversion="
# time-stamp-format: "%:y-%02m-%02d.%02H"
# time-stamp-time-zone: "UTC"
# time-stamp-time-zone: "UTC0"
# time-stamp-end: "; # UTC"
# End:

726
configure vendored
View File

File diff suppressed because it is too large Load Diff

21
configure.ac Executable file → Normal file
View File

@ -1,4 +1,4 @@
dnl Copyright (C) 2001-2022 Graeme Walker <graeme_walker@users.sourceforge.net>
dnl Copyright (C) 2001-2023 Graeme Walker <graeme_walker@users.sourceforge.net>
dnl
dnl This program is free software: you can redistribute it and/or modify
dnl it under the terms of the GNU General Public License as published by
@ -19,10 +19,12 @@ dnl
dnl Process this file with autoconf to produce a configure script.
dnl
AC_INIT([E-MailRelay],[2.4.1],[],[emailrelay])
AC_INIT([E-MailRelay],[2.5],[],[emailrelay])
AC_CONFIG_SRCDIR([src/glib/gdef.h])
AC_CONFIG_MACRO_DIR([m4])
AM_INIT_AUTOMAKE([no-define])
AM_SILENT_RULES([no])
AM_EXTRA_RECURSIVE_TARGETS([extra])
AC_CONFIG_HEADERS([src/gconfig_defs.h])
AM_MAINTAINER_MODE
AC_DISABLE_OPTION_CHECKING
@ -31,7 +33,7 @@ dnl check for programs
dnl
AC_PROG_CC([cc gcc clang])
AC_PROG_CXX([c++ g++ clang++])
AX_CXX_COMPILE_STDCXX_11([],[mandatory])
AX_CXX_COMPILE_STDCXX([11],[noext],[mandatory])
AC_PROG_INSTALL
AC_PROG_RANLIB
AC_PROG_SED
@ -43,6 +45,7 @@ AC_CHECK_PROG([GCONFIG_HAVE_DOXYGEN],[doxygen],[yes])
AC_CHECK_PROG([GCONFIG_HAVE_MAN2HTML],[man2html],[yes])
GCONFIG_FN_PROG_WINDRES
GCONFIG_FN_PROG_WINDMC
GCONFIG_FN_ARFLAGS
dnl check for system libraries
dnl
@ -71,7 +74,7 @@ GCONFIG_FN_QT_BUILD
GCONFIG_FN_TLS_OPENSSL
GCONFIG_FN_TLS_MBEDTLS
dnl "--enable-whatever"
dnl "--enable-whatever" for internal features
dnl
AC_ARG_ENABLE([bsd],AS_HELP_STRING([--enable-bsd],[enable building for bsd (default auto)]))
GCONFIG_FN_ENABLE_BSD
@ -85,6 +88,8 @@ AC_ARG_ENABLE([install-hook],AS_HELP_STRING([--enable-install-hook],[enable fixi
GCONFIG_FN_ENABLE_INSTALL_HOOK
AC_ARG_ENABLE([interface-names],AS_HELP_STRING([--enable-interface-names],[allow network interface names for defining listening addresses (default yes)]))
GCONFIG_FN_ENABLE_INTERFACE_NAMES
AC_ARG_ENABLE([pop],AS_HELP_STRING([--enable-pop],[enable pop (default yes)]))
GCONFIG_FN_ENABLE_POP
AC_ARG_ENABLE([mac],AS_HELP_STRING([--enable-mac],[enable building for mac os x (default auto)]))
GCONFIG_FN_ENABLE_MAC
AC_ARG_ENABLE([std-thread],AS_HELP_STRING([--enable-std-thread],[use std::thread or not (default auto)]))
@ -99,12 +104,14 @@ AC_ARG_ENABLE([uds],AS_HELP_STRING([--enable-uds],[enable unix domain sockets (d
GCONFIG_FN_ENABLE_UDS
AC_ARG_ENABLE([dnsbl],AS_HELP_STRING([--enable-dnsbl],[enable DNSBL (default yes)]))
GCONFIG_FN_ENABLE_DNSBL
AC_ARG_ENABLE([submission],AS_HELP_STRING([--enable-submission],[main binary is a submission tool when named emailrelay-submit (default no)]))
GCONFIG_FN_ENABLE_SUBMISSION
dnl "--with-whatever"
dnl "--with-whatever" for external dependencies
dnl
AC_ARG_WITH([doxygen],AS_HELP_STRING([--with-doxygen],[generate source code documentation with doxygen (default auto)]))
GCONFIG_FN_WITH_DOXYGEN
AC_ARG_WITH([gettext],AS_HELP_STRING([--with-gettext],[use GNU gettext (default no)]))
AC_ARG_WITH([gettext],AS_HELP_STRING([--with-gettext],[use gettext (default auto)]))
GCONFIG_FN_WITH_GETTEXT
AC_ARG_WITH([man2html],AS_HELP_STRING([--with-man2html],[convert man pages to html using man2html (default auto)]))
GCONFIG_FN_WITH_MAN2HTML
@ -121,7 +128,7 @@ GCONFIG_FN_SET_DIRECTORIES_E
dnl generate files
dnl
AC_CONFIG_FILES([Makefile src/Makefile src/glib/Makefile src/gssl/Makefile src/gnet/Makefile src/gauth/Makefile src/gsmtp/Makefile src/gpop/Makefile src/main/Makefile src/main/icon/Makefile src/win32/Makefile src/gui/Makefile bin/Makefile doc/Makefile etc/Makefile test/Makefile test/certificates/Makefile m4/Makefile bsd/Makefile debian/Makefile po/Makefile unity/Makefile])
AC_CONFIG_FILES([Makefile libexec/Makefile src/Makefile src/glib/Makefile src/gssl/Makefile src/gnet/Makefile src/gauth/Makefile src/gstore/Makefile src/gsmtp/Makefile src/gpop/Makefile src/gfilters/Makefile src/gverifiers/Makefile src/main/Makefile src/main/icon/Makefile src/win32/Makefile src/gui/Makefile bin/Makefile doc/Makefile etc/Makefile test/Makefile test/certificates/Makefile m4/Makefile bsd/Makefile debian/Makefile po/Makefile unity/Makefile])
AC_OUTPUT
dnl final warnings

15
configure.sh
View File

@ -1,6 +1,6 @@
#!/bin/sh
#
# Copyright (C) 2001-2022 Graeme Walker <graeme_walker@users.sourceforge.net>
# Copyright (C) 2001-2023 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
@ -31,8 +31,8 @@
# -w64 cross-compile for windows 64-bit with mingw-w64
# -p cross-compile for rpi
# -g git-clone mbedtls and exit
# -S force e_systemddir for systemd
# -X suppress e_systemddir for systemd
# -S force e_systemddir
# -X suppress e_systemddir
#
# When cross-compiling with mbedtls the mbedtls source should be unpacked
# into this base directory (see MBEDTLS_DIR below), or use '-g' to
@ -77,9 +77,12 @@ fi
if test "0$opt_git" -eq 1
then
git clone https://salsa.debian.org/debian/mbedtls.git
branch="mbedtls-2.28"
#branch="master"
git clone https://github.com/Mbed-TLS/mbedtls.git
( cd mbedtls && git checkout -q remotes/origin/$branch )
e="$?"
sed -i 's/defined._TRUNCATE./0/' mbedtls/library/platform.c
patch -d mbedtls/library -l -p1 < src/gssl/mbedtls-vsnprintf-fix-new.p1 || patch -d mbedtls/library -l -p1 < src/gssl/mbedtls-vsnprintf-fix.p1
if test "$e" -eq 0 -a "0$opt_mingw" -eq 0
then
echo build with...
@ -196,7 +199,7 @@ then
export AR="$SDK_TOOLCHAIN_DIR/bin/$TARGET-ar"
export STRIP="$SDK_TOOLCHAIN_DIR/bin/$TARGET-strip"
export CXXFLAGS="-fno-rtti -fno-threadsafe-statics -Os $CXXFLAGS"
export CXXFLAGS="$CXXFLAGS -DG_SMALL"
export CXXFLAGS="$CXXFLAGS -DG_LIB_SMALL -DG_SMALL"
export LDFLAGS="$LDFLAGS -static"
export LIBS="-lgcc_eh"
if test -x "$CXX" ; then : ; else echo "error: no c++ compiler for target [$TARGET]: CXX=[$CXX]\n" ; exit 1 ; fi

5
debian/Makefile.am vendored
View File

@ -1,5 +1,5 @@
#
## Copyright (C) 2001-2022 Graeme Walker <graeme_walker@users.sourceforge.net>
## Copyright (C) 2001-2023 Graeme Walker <graeme_walker@users.sourceforge.net>
##
## This program is free software: you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published by
@ -19,9 +19,10 @@ EXTRA_DIST = \
emailrelay.init \
emailrelay.default \
emailrelay.service \
emailrelay.pam \
changelog \
conffiles \
control \
compat \
copyright \
preinst \
postinst \

36
debian/Makefile.in vendored
View File

@ -1,7 +1,7 @@
# Makefile.in generated by automake 1.16.1 from Makefile.am.
# Makefile.in generated by automake 1.16.3 from Makefile.am.
# @configure_input@
# Copyright (C) 1994-2018 Free Software Foundation, Inc.
# Copyright (C) 1994-2020 Free Software Foundation, Inc.
# This Makefile.in is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
@ -92,7 +92,6 @@ subdir = debian
ACLOCAL_M4 = $(top_srcdir)/aclocal.m4
am__aclocal_m4_deps = $(top_srcdir)/m4/acinclude.m4 \
$(top_srcdir)/m4/m4_ax_cxx_compile_stdcxx.m4 \
$(top_srcdir)/m4/m4_ax_cxx_compile_stdcxx_11.m4 \
$(top_srcdir)/m4/pkg.m4 $(top_srcdir)/configure.ac
am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \
$(ACLOCAL_M4)
@ -120,6 +119,7 @@ am__can_run_installinfo = \
n|no|NO) false;; \
*) (install-info --version) >/dev/null 2>&1;; \
esac
am__extra_recursive_targets = extra-recursive
am__tagged_files = $(HEADERS) $(SOURCES) $(TAGS_FILES) $(LISP)
am__DIST_COMMON = $(srcdir)/Makefile.in
DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST)
@ -127,6 +127,7 @@ ACLOCAL = @ACLOCAL@
AMTAR = @AMTAR@
AM_DEFAULT_VERBOSITY = @AM_DEFAULT_VERBOSITY@
AR = @AR@
ARFLAGS = @ARFLAGS@
AUTOCONF = @AUTOCONF@
AUTOHEADER = @AUTOHEADER@
AUTOMAKE = @AUTOMAKE@
@ -216,7 +217,7 @@ e_docdir = @e_docdir@
e_examplesdir = @e_examplesdir@
e_icondir = @e_icondir@
e_initdir = @e_initdir@
e_libexecdir = @e_libexecdir@
e_libdir = @e_libdir@
e_pamdir = @e_pamdir@
e_rundir = @e_rundir@
e_spooldir = @e_spooldir@
@ -253,9 +254,10 @@ EXTRA_DIST = \
emailrelay.init \
emailrelay.default \
emailrelay.service \
emailrelay.pam \
changelog \
conffiles \
control \
compat \
copyright \
preinst \
postinst \
@ -295,6 +297,7 @@ $(top_srcdir)/configure: @MAINTAINER_MODE_TRUE@ $(am__configure_deps)
$(ACLOCAL_M4): @MAINTAINER_MODE_TRUE@ $(am__aclocal_m4_deps)
cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh
$(am__aclocal_m4_deps):
extra-local:
tags TAGS:
ctags CTAGS:
@ -381,6 +384,10 @@ dvi: dvi-am
dvi-am:
extra: extra-am
extra-am: extra-local
html: html-am
html-am:
@ -438,15 +445,16 @@ uninstall-am:
.MAKE: install-am install-strip
.PHONY: all all-am check check-am clean clean-generic cscopelist-am \
ctags-am distclean distclean-generic distdir dvi dvi-am html \
html-am info info-am install install-am install-data \
install-data-am install-dvi install-dvi-am install-exec \
install-exec-am install-html install-html-am install-info \
install-info-am install-man install-pdf install-pdf-am \
install-ps install-ps-am install-strip installcheck \
installcheck-am installdirs maintainer-clean \
maintainer-clean-generic mostlyclean mostlyclean-generic pdf \
pdf-am ps ps-am tags-am uninstall uninstall-am
ctags-am distclean distclean-generic distdir dvi dvi-am \
extra-am extra-local html html-am info info-am install \
install-am install-data install-data-am install-dvi \
install-dvi-am install-exec install-exec-am install-html \
install-html-am install-info install-info-am install-man \
install-pdf install-pdf-am install-ps install-ps-am \
install-strip installcheck installcheck-am installdirs \
maintainer-clean maintainer-clean-generic mostlyclean \
mostlyclean-generic pdf pdf-am ps ps-am tags-am uninstall \
uninstall-am
.PRECIOUS: Makefile

17
debian/changelog vendored
View File

@ -1,3 +1,18 @@
emailrelay (2.5) unstable; urgency=low
* Multiple configurations in one process.
* SMTP PIPELINING (RFC-2920).
* SMTP CHUNKING/8BITMIME 'BDAT' extension (RFC-3030), disabled by default.
* SMTP SMTPUTF8 extension (RFC-6531), disabled by default.
* No 7-bit/8-bit check on received message content (see NEWS file).
* New built-in filters: "deliver:", "split:", "copy:", "mx:", "msgid:".
* New built-in address verifier: "account:"
* No ".local" files (see NEWS file).
* PAM authentication is now enabled with "--server-auth=pam:" not "/pam".
* Client authentication details can be given directly from the command-line.
* Multiple "client" authentication secrets, selected by a new envelope field.
* Main binary can act as a simple submission tool ("configure --enable-submission").
-- maintainer graeme_walker <graeme_walker@users.sourceforge.net> Thu, 10 Aug 2023 00:00:00 +0000
emailrelay (2.4) unstable; urgency=low
* Multiple "--filter" and "--client-filter" options allowed.
* TLS key and certificate files can be specified separately.
@ -9,7 +24,7 @@ emailrelay (2.4) unstable; urgency=low
* The Linux event loop uses "epoll" by default rather than "select".
* Some support for message routing (see NEWS).
* Fix of error handling in network client filters ("--client-filter=net:...") [bug-id #50].
-- maintainer graeme_walker <graeme_walker@users.sourceforge.net> Sun, 27 Nov 2022 00:00:00 +0000
-- maintainer graeme_walker <graeme_walker@users.sourceforge.net> Thu, 10 Aug 2023 00:00:00 +0000
emailrelay (2.3) unstable; urgency=low
* Unix domain sockets supported (eg. "--interface=/tmp/smtp.s").

1
debian/compat vendored
View File

@ -1 +0,0 @@
10

0
debian/conffiles vendored Normal file
View File

12
debian/control vendored
View File

@ -2,7 +2,7 @@ Source: emailrelay
Section: mail
Priority: optional
Maintainer: Graeme Walker <graeme_walker@users.sourceforge.net>
Build-Depends: debhelper (>= 9), autotools-dev, libssl-dev, libpam0g-dev
Build-Depends: debhelper-compat (= 13), autotools-dev, libssl-dev, libpam0g-dev
Standards-Version: 3.9.8
Homepage: http://emailrelay.sourceforge.net
@ -10,8 +10,8 @@ Package: emailrelay
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}
Description: E-mail store-and-forward transfer agent and pop server.
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.
E-MailRelay is a lightweight SMTP store-and-forward mail server with POP access
to spooled messages. It can be used as a personal internet mail server with
SpamAssassin spam filtering and DNSBL connection blocking. Forwarding can be
to a fixed smarthost or using DNS MX routing. External scripts can be used for
address validation and e-mail message processing.

2
debian/copyright vendored
View File

@ -1,6 +1,6 @@
Copyright
=========
Copyright (C) 2001-2022 Graeme Walker <graeme_walker@users.sourceforge.net>
Copyright (C) 2001-2023 Graeme Walker <graeme_walker@users.sourceforge.net>
Refer to the file COPYING (included), /usr/share/common-licenses/GPL-3, or
<http://www.gnu.org/licenses/> for the terms of the GNU General Public License.

5
debian/emailrelay.default vendored
View File

@ -1,3 +1,2 @@
# change this to 1 to enable the emailrelay system-v init script
# and run 'service emailrelay start' when configured
EMAILRELAY_ENABLED=0
# set EMAILRELAY_ENABLED=0 to disable sysv-init emailrelay start
#EMAILRELAY_ENABLED=0

26
debian/emailrelay.init vendored
View File

@ -1,6 +1,6 @@
#!/bin/sh
#
# Copyright (C) 2001-2022 Graeme Walker <graeme_walker@users.sourceforge.net>
# Copyright (C) 2001-2023 Graeme Walker <graeme_walker@users.sourceforge.net>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
@ -115,9 +115,9 @@ log_end_msg()
#
setup_config()
{
if test ! -f "$CONFIG" -a -f "$CONFIG.template"
if test ! -e "$CONFIG"
then
cp -p "$CONFIG.template" "$CONFIG"
echo "# emailrelay.conf" > "$CONFIG"
fi
}
root_root()
@ -130,7 +130,7 @@ root_root()
spooldir()
{
# Prints the spool directory path from the config file, but with a
# default because packaged installs may not edit the config file
# default because packaged installs might not edit the config file
# like 'make install' does
( echo spool-dir /var/spool/emailrelay ; cat "$CONFIG" ) | \
tr '\t' ' ' | sed 's/ */ /g' | grep '^spool-dir [^ ]' | \
@ -179,7 +179,6 @@ setup_sgid()
setup_tools()
{
setup_sgid "/usr/sbin/emailrelay-submit"
setup_sgid "/usr/lib/emailrelay/emailrelay-filter-copy"
}
setup_openrc()
{
@ -201,19 +200,6 @@ if test "$1" = "setup" ; then setup ; exit 0 ; fi
#
test -f /lib/lsb/init-functions && . /lib/lsb/init-functions
# Ignore /etc/default 'enabled' switch if running from systemd.
#
# (The 'enabled' mechanism is needed on non-systemd debian distros
# because the dpkg postinstall script starts the server, whereas
# on systemd systems the dpkg postinstall script's call to update-rc.d
# does nothing. On rpm or 'make install' systems the /etc/default file
# is not installed at all.)
#
if test -d /run/systemd/system -a "$PPID" -eq 1
then
EMAILRELAY_ENABLED="1"
fi
case "$1" in
restart|force-reload)
@ -261,10 +247,10 @@ case "$1" in
if pidofproc -p "$PIDFILE" "$DAEMON" >/dev/null
then
log_success_msg "$NAME is running"
true
exit 0
else
log_failure_msg "$NAME is not running"
false
exit 32 # see guiboot_unix.cpp
fi
;;

2
debian/emailrelay.pam vendored Normal file
View File

@ -0,0 +1,2 @@
# emailrelay pam configuration
auth requisite pam_unix.so nullok_secure

6
debian/rules vendored
View File

@ -6,9 +6,9 @@
#
%:
dh $@ --with autotools_dev
dh $@ --parallel --no-start
override_dh_auto_configure:
# (the init script goes to one side under /usr/lib since we have debian/emailrelay.init)
dh_auto_configure -- --libexecdir=/usr/lib e_initdir=/usr/lib/emailrelay/init e_rundir=/run/emailrelay --without-doxygen --without-man2html --with-openssl --without-mbedtls --with-pam --disable-gui --disable-install-hook --disable-testing
# (the init script and pam file go to one side under /usr/lib since we have .init and .pam files in debian/)
dh_auto_configure -- e_libdir=/usr/lib/emailrelay e_initdir=/usr/lib/emailrelay/init e_rundir=/run/emailrelay e_pamdir=/usr/lib/emailrelay/pam --without-doxygen --without-man2html --with-openssl --without-mbedtls --with-pam --disable-gui --disable-testing

10
depcomp
View File

@ -1,9 +1,9 @@
#! /bin/sh
# depcomp - compile a program generating dependencies as side-effects
scriptversion=2013-05-30.07; # UTC
scriptversion=2018-03-07.03; # UTC
# Copyright (C) 1999-2014 Free Software Foundation, Inc.
# Copyright (C) 1999-2020 Free Software Foundation, Inc.
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
@ -16,7 +16,7 @@ scriptversion=2013-05-30.07; # UTC
# GNU General Public License for more details.
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
# along with this program. If not, see <https://www.gnu.org/licenses/>.
# As a special exception to the GNU General Public License, if you
# distribute this file as part of a program that contains a
@ -783,9 +783,9 @@ exit 0
# Local Variables:
# mode: shell-script
# sh-indentation: 2
# eval: (add-hook 'write-file-hooks 'time-stamp)
# eval: (add-hook 'before-save-hook 'time-stamp)
# time-stamp-start: "scriptversion="
# time-stamp-format: "%:y-%02m-%02d.%02H"
# time-stamp-time-zone: "UTC"
# time-stamp-time-zone: "UTC0"
# time-stamp-end: "; # UTC"
# End:

46
doc/Makefile.am
View File

@ -1,5 +1,5 @@
#
## Copyright (C) 2001-2022 Graeme Walker <graeme_walker@users.sourceforge.net>
## Copyright (C) 2001-2023 Graeme Walker <graeme_walker@users.sourceforge.net>
##
## This program is free software: you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published by
@ -22,24 +22,21 @@ txt_files_install=\
userguide.txt userguide.md userguide.rst \
windows.txt windows.md windows.rst \
changelog.txt changelog.md changelog.rst \
doxygen.cfg.in \
index.rst conf.py.sphinx
doxygen.cfg.in
txt_files_noinstall=\
index.rst \
conf.py
man_files_install=\
emailrelay.1 \
emailrelay-passwd.1 \
emailrelay-submit.1 \
emailrelay-filter-copy.1
emailrelay-submit.1
man_files_clean=\
emailrelay.1.gz \
emailrelay-passwd.1.gz \
emailrelay-submit.1.gz \
emailrelay-filter-copy.1.gz
html_files_noinstall=\
man2html-missing.html \
doxygen-missing.html
emailrelay-submit.1.gz
html_files_install=\
index.html \
@ -51,6 +48,10 @@ html_files_install=\
windows.html \
changelog.html
html_files_noinstall=\
man2html-missing.html \
doxygen-missing.html
css_files_install=\
emailrelay.css \
emailrelay-doxygen.css
@ -59,25 +60,28 @@ svg_files_noinstall=\
authentication.svg \
forwardto.svg \
serverclient.svg \
whatisit.svg
whatisit.svg \
mailserver.svg \
popbyname.svg
png_files_install=\
authentication.png \
forwardto.png \
serverclient.png \
whatisit.png \
download-button.png
download-button.png \
mailserver.png \
popbyname.png
EXTRA_DIST = \
$(man_files_install) \
$(txt_files_install) \
$(txt_files_noinstall) \
$(css_files_install) \
$(png_files_install) \
$(svg_files_noinstall) \
$(html_files_install) \
$(html_files_noinstall) \
make-website
$(html_files_noinstall)
noinst_SCRIPTS = .dox
man1_MANS = $(man_files_install)
@ -86,7 +90,7 @@ CLEANFILES = $(noinst_SCRIPTS) $(man_files_clean) emailrelay-man.html doxygen.ou
SUFFIXES = .txt .html
run_doxygen=$(top_srcdir)/bin/doxygen.sh
run_doxygen=$(top_srcdir)/libexec/doxygen.sh
.dox:
-@chmod +x $(run_doxygen)
@ -104,9 +108,6 @@ emailrelay-passwd.1.gz : emailrelay-passwd.1
emailrelay-submit.1.gz : emailrelay-submit.1
if test -n "$(GZIP)" ; then $(GZIP) -c "$(top_srcdir)/doc/emailrelay-submit.1" > emailrelay-submit.1.gz ; fi
emailrelay-filter-copy.1.gz : emailrelay-filter-copy.1
if test -n "$(GZIP)" ; then $(GZIP) -c "$(top_srcdir)/doc/emailrelay-filter-copy.1" > emailrelay-filter-copy.1.gz ; fi
install-data-local: install-e_docDATA
$(mkinstalldirs) "$(DESTDIR)$(e_docdir)/doxygen"
if test -d doxygen ; then for file in doxygen/* ; do $(INSTALL) -m 644 "$$file" "$(DESTDIR)$(e_docdir)/$$file" || true ; done ; else true ; fi
@ -126,11 +127,10 @@ md:
.PHONY: sphinx
sphinx:
cp conf.py.sphinx conf.py
sphinx-build -b html . ./_build
.PHONY: website
website:
@chmod +x $(top_srcdir)/doc/make-website || true
$(top_srcdir)/doc/make-website `cat $(top_srcdir)/VERSION`
@chmod +x $(top_srcdir)/libexec/make-website || true
$(top_srcdir)/libexec/make-website `cat $(top_srcdir)/VERSION`

80
doc/Makefile.in
View File

@ -1,7 +1,7 @@
# Makefile.in generated by automake 1.16.1 from Makefile.am.
# Makefile.in generated by automake 1.16.3 from Makefile.am.
# @configure_input@
# Copyright (C) 1994-2018 Free Software Foundation, Inc.
# Copyright (C) 1994-2020 Free Software Foundation, Inc.
# This Makefile.in is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
@ -94,7 +94,6 @@ subdir = doc
ACLOCAL_M4 = $(top_srcdir)/aclocal.m4
am__aclocal_m4_deps = $(top_srcdir)/m4/acinclude.m4 \
$(top_srcdir)/m4/m4_ax_cxx_compile_stdcxx.m4 \
$(top_srcdir)/m4/m4_ax_cxx_compile_stdcxx_11.m4 \
$(top_srcdir)/m4/pkg.m4 $(top_srcdir)/configure.ac
am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \
$(ACLOCAL_M4)
@ -155,6 +154,7 @@ am__installdirs = "$(DESTDIR)$(man1dir)" "$(DESTDIR)$(e_docdir)"
NROFF = nroff
MANS = $(man1_MANS)
DATA = $(e_doc_DATA)
am__extra_recursive_targets = extra-recursive
am__tagged_files = $(HEADERS) $(SOURCES) $(TAGS_FILES) $(LISP)
am__DIST_COMMON = $(srcdir)/Makefile.in
DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST)
@ -162,6 +162,7 @@ ACLOCAL = @ACLOCAL@
AMTAR = @AMTAR@
AM_DEFAULT_VERBOSITY = @AM_DEFAULT_VERBOSITY@
AR = @AR@
ARFLAGS = @ARFLAGS@
AUTOCONF = @AUTOCONF@
AUTOHEADER = @AUTOHEADER@
AUTOMAKE = @AUTOMAKE@
@ -251,7 +252,7 @@ e_docdir = @e_docdir@
e_examplesdir = @e_examplesdir@
e_icondir = @e_icondir@
e_initdir = @e_initdir@
e_libexecdir = @e_libexecdir@
e_libdir = @e_libdir@
e_pamdir = @e_pamdir@
e_rundir = @e_rundir@
e_spooldir = @e_spooldir@
@ -291,24 +292,21 @@ txt_files_install = \
userguide.txt userguide.md userguide.rst \
windows.txt windows.md windows.rst \
changelog.txt changelog.md changelog.rst \
doxygen.cfg.in \
index.rst conf.py.sphinx
doxygen.cfg.in
txt_files_noinstall = \
index.rst \
conf.py
man_files_install = \
emailrelay.1 \
emailrelay-passwd.1 \
emailrelay-submit.1 \
emailrelay-filter-copy.1
emailrelay-submit.1
man_files_clean = \
emailrelay.1.gz \
emailrelay-passwd.1.gz \
emailrelay-submit.1.gz \
emailrelay-filter-copy.1.gz
html_files_noinstall = \
man2html-missing.html \
doxygen-missing.html
emailrelay-submit.1.gz
html_files_install = \
index.html \
@ -320,6 +318,10 @@ html_files_install = \
windows.html \
changelog.html
html_files_noinstall = \
man2html-missing.html \
doxygen-missing.html
css_files_install = \
emailrelay.css \
emailrelay-doxygen.css
@ -328,31 +330,35 @@ svg_files_noinstall = \
authentication.svg \
forwardto.svg \
serverclient.svg \
whatisit.svg
whatisit.svg \
mailserver.svg \
popbyname.svg
png_files_install = \
authentication.png \
forwardto.png \
serverclient.png \
whatisit.png \
download-button.png
download-button.png \
mailserver.png \
popbyname.png
EXTRA_DIST = \
$(man_files_install) \
$(txt_files_install) \
$(txt_files_noinstall) \
$(css_files_install) \
$(png_files_install) \
$(svg_files_noinstall) \
$(html_files_install) \
$(html_files_noinstall) \
make-website
$(html_files_noinstall)
noinst_SCRIPTS = .dox
man1_MANS = $(man_files_install)
e_doc_DATA = $(txt_files_install) $(html_files_install) $(css_files_install) $(png_files_install)
CLEANFILES = $(noinst_SCRIPTS) $(man_files_clean) emailrelay-man.html doxygen.out doxygen.cfg doxygen/search/* doxygen/*
SUFFIXES = .txt .html
run_doxygen = $(top_srcdir)/bin/doxygen.sh
run_doxygen = $(top_srcdir)/libexec/doxygen.sh
all: all-am
.SUFFIXES:
@ -448,6 +454,7 @@ uninstall-e_docDATA:
@list='$(e_doc_DATA)'; test -n "$(e_docdir)" || list=; \
files=`for p in $$list; do echo $$p; done | sed -e 's|^.*/||'`; \
dir='$(DESTDIR)$(e_docdir)'; $(am__uninstall_files_from_dir)
extra-local:
tags TAGS:
ctags CTAGS:
@ -538,6 +545,10 @@ dvi: dvi-am
dvi-am:
extra: extra-am
extra-am: extra-local
html: html-am
html-am:
@ -597,17 +608,18 @@ uninstall-man: uninstall-man1
.MAKE: install-am install-strip
.PHONY: all all-am check check-am clean clean-generic cscopelist-am \
ctags-am distclean distclean-generic distdir dvi dvi-am html \
html-am info info-am install install-am install-data \
install-data-am install-data-local install-dvi install-dvi-am \
install-e_docDATA install-exec install-exec-am install-html \
install-html-am install-info install-info-am install-man \
install-man1 install-pdf install-pdf-am install-ps \
install-ps-am install-strip installcheck installcheck-am \
installdirs maintainer-clean maintainer-clean-generic \
mostlyclean mostlyclean-generic pdf pdf-am ps ps-am tags-am \
uninstall uninstall-am uninstall-e_docDATA uninstall-local \
uninstall-man uninstall-man1
ctags-am distclean distclean-generic distdir dvi dvi-am \
extra-am extra-local html html-am info info-am install \
install-am install-data install-data-am install-data-local \
install-dvi install-dvi-am install-e_docDATA install-exec \
install-exec-am install-html install-html-am install-info \
install-info-am install-man install-man1 install-pdf \
install-pdf-am install-ps install-ps-am install-strip \
installcheck installcheck-am installdirs maintainer-clean \
maintainer-clean-generic mostlyclean mostlyclean-generic pdf \
pdf-am ps ps-am tags-am uninstall uninstall-am \
uninstall-e_docDATA uninstall-local uninstall-man \
uninstall-man1
.PRECIOUS: Makefile
@ -628,9 +640,6 @@ emailrelay-passwd.1.gz : emailrelay-passwd.1
emailrelay-submit.1.gz : emailrelay-submit.1
if test -n "$(GZIP)" ; then $(GZIP) -c "$(top_srcdir)/doc/emailrelay-submit.1" > emailrelay-submit.1.gz ; fi
emailrelay-filter-copy.1.gz : emailrelay-filter-copy.1
if test -n "$(GZIP)" ; then $(GZIP) -c "$(top_srcdir)/doc/emailrelay-filter-copy.1" > emailrelay-filter-copy.1.gz ; fi
install-data-local: install-e_docDATA
$(mkinstalldirs) "$(DESTDIR)$(e_docdir)/doxygen"
if test -d doxygen ; then for file in doxygen/* ; do $(INSTALL) -m 644 "$$file" "$(DESTDIR)$(e_docdir)/$$file" || true ; done ; else true ; fi
@ -650,13 +659,12 @@ md:
.PHONY: sphinx
sphinx:
cp conf.py.sphinx conf.py
sphinx-build -b html . ./_build
.PHONY: website
website:
@chmod +x $(top_srcdir)/doc/make-website || true
$(top_srcdir)/doc/make-website `cat $(top_srcdir)/VERSION`
@chmod +x $(top_srcdir)/libexec/make-website || true
$(top_srcdir)/libexec/make-website `cat $(top_srcdir)/VERSION`
# Tell versions [3.59,3.63) of GNU make to not export all variables.
# Otherwise a system limit (for SysV at least) may be exceeded.

BIN
doc/authentication.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 18 KiB

After

Width:  |  Height:  |  Size: 18 KiB

66
doc/authentication.svg
View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- Created with Inkscape (http://www.inkscape.org/) -->
<!-- Copyright (C) 2001-2022 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->
<!-- Copyright (C) 2001-2023 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->
<svg
xmlns:dc="http://purl.org/dc/elements/1.1/"
@ -12,7 +12,7 @@
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
id="svg3036"
version="1.1"
inkscape:version="0.48.4 r9939"
inkscape:version="0.92.4 (5da689c313, 2019-01-14)"
width="1650"
height="1023"
sodipodi:docname="authentication.svg"
@ -27,7 +27,7 @@
<dc:format>image/svg+xml</dc:format>
<dc:type
rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
<dc:title></dc:title>
<dc:title />
</cc:Work>
</rdf:RDF>
</metadata>
@ -42,14 +42,14 @@
guidetolerance="10"
inkscape:pageopacity="0"
inkscape:pageshadow="2"
inkscape:window-width="1536"
inkscape:window-height="943"
inkscape:window-width="2108"
inkscape:window-height="1169"
id="namedview3038"
showgrid="false"
inkscape:zoom="0.41425821"
inkscape:cx="699.63064"
inkscape:zoom="0.7584233"
inkscape:cx="701.35349"
inkscape:cy="362.80329"
inkscape:window-x="-12"
inkscape:window-x="0"
inkscape:window-y="150"
inkscape:window-maximized="0"
inkscape:current-layer="layer4" />
@ -90,26 +90,26 @@
style="fill:#161616" />
<text
xml:space="preserve"
style="font-size:48px;font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;font-family:DejaVu Sans;-inkscape-font-specification:DejaVu Sans Bold"
style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;line-height:0%;font-family:'DejaVu Sans';-inkscape-font-specification:'DejaVu Sans Bold';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none"
x="1066.4489"
y="380.74576"
id="text3324"
sodipodi:linespacing="125%"><tspan
id="text3324"><tspan
sodipodi:role="line"
id="tspan3326"
x="1066.4489"
y="380.74576">--client-auth</tspan></text>
y="380.74576"
style="font-size:48px;line-height:1.25">--client-auth</tspan></text>
<text
xml:space="preserve"
style="font-size:48px;font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;display:inline;font-family:DejaVu Sans;-inkscape-font-specification:DejaVu Sans Bold"
style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;line-height:0%;font-family:'DejaVu Sans';-inkscape-font-specification:'DejaVu Sans Bold';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;display:inline;fill:#000000;fill-opacity:1;stroke:none"
x="176.8667"
y="385.01154"
id="text3324-9"
sodipodi:linespacing="125%"><tspan
id="text3324-9"><tspan
sodipodi:role="line"
id="tspan3326-1"
x="176.8667"
y="385.01154">--server-auth</tspan></text>
y="385.01154"
style="font-size:48px;line-height:1.25">--server-auth</tspan></text>
<g
id="g3384"
transform="translate(-155.02689,-30.664659)">
@ -130,16 +130,16 @@
d="m 1680.1083,124.22703 c 7.0818,-0.2751 10.2071,-1.0243 14.2901,-2.5674 l 0,-2e-4 c 7.0507,-2.6646 11.1812,-6.0188 13.8472,-11.2445 1.9056,-3.7354 1.9254,-4.0795 0.3352,-5.8366 -3.0633,-3.3849 -8.2846,-4.43 -20.9479,-4.1932 -6.8882,0.1288 -13.6023,-0.2658 -15.7613,-0.926202 -3.4318,-1.0499 -3.9877,-0.9393 -6.3473,1.263102 -3.0038,2.8037 -5.8546,8.0568 -6.8328,12.5908 -0.9266,4.2944 1.6041,9.1015 5.2095,9.896 1.5025,0.3311 3.1819,0.783 3.7319,1.0042 0.55,0.2212 5.5,0.2275 11,0.014 m -0.3448,10.1672 c -0.39,-0.075 -0.7802,-0.1993 -2.1552,-0.4052 -12.019,-1.8001 -14.4349,-2.7238 -18.7581,-7.1721 -2.3812,-2.45 -4.9847,-6.023 -5.7857,-7.94 -4.7123,-11.2783 1.6556,-23.835002 15.8795,-31.312402 9.2319,-4.8531 12.0541,-4.7682 20.1517,0.6068 3.5494,2.3559 6.6277,3.5194 10.2516,3.8745 6.4828,0.6353 11.9926,3.4083 17.7688,8.942902 3.6122,3.4611 4.4922,4.9758 4.4922,7.7323 0,13.5694 -10.6345,21.7402 -32.2909,24.8103 -4.285,0.6075 -8.11,1.0432 -8.5,0.9683"
style="fill:#161616" />
<text
sodipodi:linespacing="125%"
id="text3379"
y="288.75177"
x="1633.7449"
style="font-size:48px;font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;font-family:DejaVu Sans;-inkscape-font-specification:DejaVu Sans Bold"
style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;line-height:0%;font-family:'DejaVu Sans';-inkscape-font-specification:'DejaVu Sans Bold';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none"
xml:space="preserve"><tspan
y="288.75177"
x="1633.7449"
id="tspan3381"
sodipodi:role="line">bob</tspan></text>
sodipodi:role="line"
style="font-size:48px;line-height:1.25">bob</tspan></text>
</g>
<path
style="fill:#161616;display:inline"
@ -177,34 +177,36 @@
inkscape:connector-curvature="0" />
<text
xml:space="preserve"
style="font-size:28px;font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;font-family:DejaVu Sans Mono;-inkscape-font-specification:DejaVu Sans Mono Bold"
style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;line-height:0%;font-family:'DejaVu Sans Mono';-inkscape-font-specification:'DejaVu Sans Mono Bold';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none"
x="218.47667"
y="514.90009"
id="text3405"
sodipodi:linespacing="125%"><tspan
id="text3405"><tspan
sodipodi:role="line"
id="tspan3407"
x="218.47667"
y="514.90009">server plain alice ...</tspan><tspan
y="514.90009"
style="font-size:28px;line-height:1.25">server plain alice ...</tspan><tspan
sodipodi:role="line"
x="218.47667"
y="549.90009"
id="tspan3409">server plain carol ...</tspan><tspan
id="tspan3409"
style="font-size:28px;line-height:1.25">server plain carol ...</tspan><tspan
sodipodi:role="line"
x="218.47667"
y="584.90009"
id="tspan3411">server plain dave ...</tspan></text>
id="tspan3411"
style="font-size:28px;line-height:1.25">server plain dave ...</tspan></text>
<text
xml:space="preserve"
style="font-size:28px;font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;font-family:DejaVu Sans Mono;-inkscape-font-specification:DejaVu Sans Mono Bold"
style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;line-height:0%;font-family:'DejaVu Sans Mono';-inkscape-font-specification:'DejaVu Sans Mono Bold';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none"
x="928.94977"
y="521.77808"
id="text3413"
sodipodi:linespacing="125%"><tspan
id="text3413"><tspan
sodipodi:role="line"
id="tspan3415"
x="928.94977"
y="521.77808">client plain bob ...</tspan></text>
y="521.77808"
style="font-size:28px;line-height:1.25">client plain bob ...</tspan></text>
</g>
<g
inkscape:groupmode="layer"
@ -215,16 +217,16 @@
id="g3393"
transform="translate(-52.811358,-27.257475)">
<text
sodipodi:linespacing="125%"
id="text3375"
y="283.64099"
x="95.401161"
style="font-size:48px;font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;display:inline;font-family:DejaVu Sans;-inkscape-font-specification:DejaVu Sans Bold"
style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;line-height:0%;font-family:'DejaVu Sans';-inkscape-font-specification:'DejaVu Sans Bold';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;display:inline;fill:#000000;fill-opacity:1;stroke:none"
xml:space="preserve"><tspan
y="283.64099"
x="95.401161"
id="tspan3377"
sodipodi:role="line">alice</tspan></text>
sodipodi:role="line"
style="font-size:48px;line-height:1.25">alice</tspan></text>
<path
inkscape:connector-curvature="0"
id="path8377-5"

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 30 KiB

After

Width:  |  Height:  |  Size: 31 KiB

89
doc/changelog.html
View File

@ -9,7 +9,22 @@
<!-- index:0::::E-MailRelay Change Log -->
<div class="div-main">
<h1><a class="a-header" name="H_1">E-MailRelay Change Log</a></h1> <!-- index:1:H:E-MailRelay Change Log -->
<h2><a class="a-header" name="SH_1_1">2.3 -> 2.4</a></h2> <!-- index:2:SH:1:1:2.3 -> 2.4 -->
<h2><a class="a-header" name="SH_1_1">2.4 -> 2.5</a></h2> <!-- index:2:SH:1:1:2.4 -> 2.5 -->
<ul>
<li>Multiple configurations in one process.</li>
<li>SMTP PIPELINING (RFC-2920).</li>
<li>SMTP CHUNKING/8BITMIME 'BDAT' extension (RFC-3030), disabled by default.</li>
<li>SMTP SMTPUTF8 extension (RFC-6531), disabled by default.</li>
<li>No 7-bit/8-bit check on received message content (see NEWS file).</li>
<li>New built-in filters: <em>deliver:</em>, <em>split:</em>, <em>copy:</em>, <em>mx:</em>, <em>msgid:</em>.</li>
<li>New built-in address verifier: <em>account:</em></li>
<li>No <em>.local</em> files (see NEWS file).</li>
<li>PAM authentication is now enabled with <em>--server-auth=pam:</em> not <em>/pam</em>.</li>
<li>Client authentication details can be given directly from the command-line.</li>
<li>Multiple <em>client</em> authentication secrets, selected by a new envelope field.</li>
<li>Main binary can act as a simple submission tool (<em>configure --enable-submission</em>).</li>
</ul>
<h2><a class="a-header" name="SH_1_2">2.3 -> 2.4</a></h2> <!-- index:2:SH:1:2:2.3 -> 2.4 -->
<ul>
<li>Multiple <em>--filter</em> and <em>--client-filter</em> options allowed.</li>
<li>TLS key and certificate files can be specified separately.</li>
@ -22,7 +37,7 @@
<li>Some support for message routing (see NEWS).</li>
<li>Fix of error handling in network client filters (<em>--client-filter=net:...</em>) [bug-id #50].</li>
</ul>
<h2><a class="a-header" name="SH_1_2">2.2 -> 2.3</a></h2> <!-- index:2:SH:1:2:2.2 -> 2.3 -->
<h2><a class="a-header" name="SH_1_3">2.2 -> 2.3</a></h2> <!-- index:2:SH:1:3:2.2 -> 2.3 -->
<ul>
<li>Unix domain sockets supported (eg. <em>--interface=/tmp/smtp.s</em>).</li>
<li>Windows event log not used for verbose logging (prefer <em>--log-file</em>).</li>
@ -30,7 +45,7 @@
<li>Optional base64 encoding of passwords in secrets files (<em>plain:b</em>).</li>
<li>Support for MbedTLS version 3.</li>
</ul>
<h2><a class="a-header" name="SH_1_3">2.1 -> 2.2</a></h2> <!-- index:2:SH:1:3:2.1 -> 2.2 -->
<h2><a class="a-header" name="SH_1_4">2.1 -> 2.2</a></h2> <!-- index:2:SH:1:4:2.1 -> 2.2 -->
<ul>
<li>Connections from IPv4 'private use' addresses are allowed by default (see <em>--remote-clients</em>).</li>
<li>Interface names can be used with <em>--interface</em> (eg. <em>--interface=eth0</em>).</li>
@ -46,7 +61,7 @@
<li>Support for Windows XP restored when built with mingw-w64.</li>
<li>C++ 2011 compiler is required.</li>
</ul>
<h2><a class="a-header" name="SH_1_4">2.0.1 -> 2.1</a></h2> <!-- index:2:SH:1:4:2.0.1 -> 2.1 -->
<h2><a class="a-header" name="SH_1_5">2.0.1 -> 2.1</a></h2> <!-- index:2:SH:1:5:2.0.1 -> 2.1 -->
<ul>
<li>Backwards compatibility features for 1.9-to-2.0 transition removed.</li>
<li>Better handling of too-many-connections on Windows.</li>
@ -63,11 +78,11 @@
<li>Certificate contents are not logged.</li>
<li>Timestamp parts of spool filenames no longer limited to six digits.</li>
</ul>
<h2><a class="a-header" name="SH_1_5">2.0 -> 2.0.1</a></h2> <!-- index:2:SH:1:5:2.0 -> 2.0.1 -->
<h2><a class="a-header" name="SH_1_6">2.0 -> 2.0.1</a></h2> <!-- index:2:SH:1:6:2.0 -> 2.0.1 -->
<ul>
<li>Make PLAIN client authentication work against servers with broken 334 responses.</li>
</ul>
<h2><a class="a-header" name="SH_1_6">1.9.2 -> 2.0</a></h2> <!-- index:2:SH:1:6:1.9.2 -> 2.0 -->
<h2><a class="a-header" name="SH_1_7">1.9.2 -> 2.0</a></h2> <!-- index:2:SH:1:7:1.9.2 -> 2.0 -->
<ul>
<li>Improved IPv6 support, with IPv4 and IPv6 used independently at run-time (see <em>--interface</em>).</li>
<li>Server process is not blocked during <em>--filter</em> or <em>--address-verifier</em> execution, if multi-threaded.</li>
@ -98,7 +113,7 @@
<li>C++ 2011 is preferred, and required for multi-threading.</li>
<li>Support for very old versions of Windows is dropped.</li>
</ul>
<h2><a class="a-header" name="SH_1_7">1.9.1 -> 1.9.2</a></h2> <!-- index:2:SH:1:7:1.9.1 -> 1.9.2 -->
<h2><a class="a-header" name="SH_1_8">1.9.1 -> 1.9.2</a></h2> <!-- index:2:SH:1:8:1.9.1 -> 1.9.2 -->
<ul>
<li>Fixed a leak in the event-loop garbage collection.</li>
<li>A local hostname that fails to resolve is not an error.</li>
@ -114,11 +129,11 @@
<li>Qt4 or Qt5 selected by the <em>configure</em> script.</li>
<li>Improved the RPM spec file.</li>
</ul>
<h2><a class="a-header" name="SH_1_8">1.9 -> 1.9.1</a></h2> <!-- index:2:SH:1:8:1.9 -> 1.9.1 -->
<h2><a class="a-header" name="SH_1_9">1.9 -> 1.9.1</a></h2> <!-- index:2:SH:1:9:1.9 -> 1.9.1 -->
<ul>
<li>Updated OpenSSL from 1.0.1e to 1.0.1g in the Windows build.</li>
</ul>
<h2><a class="a-header" name="SH_1_9">1.8.2 -> 1.9</a></h2> <!-- index:2:SH:1:9:1.8.2 -> 1.9 -->
<h2><a class="a-header" name="SH_1_10">1.8.2 -> 1.9</a></h2> <!-- index:2:SH:1:10:1.8.2 -> 1.9 -->
<ul>
<li>Added negotiated TLS/SSL for POP (ie. <em>STLS</em>).</li>
<li>The first two fields in the secrets files are reordered (with backwards compatibility).</li>
@ -143,17 +158,17 @@
<li>Added Windows <em>--peer-lookup</em> option.</li>
<li>Fix for MD5 code in 64-bit builds.</li>
</ul>
<h2><a class="a-header" name="SH_1_10">1.8.1 -> 1.8.2</a></h2> <!-- index:2:SH:1:10:1.8.1 -> 1.8.2 -->
<h2><a class="a-header" name="SH_1_11">1.8.1 -> 1.8.2</a></h2> <!-- index:2:SH:1:11:1.8.1 -> 1.8.2 -->
<ul>
<li>Fix namespaces for gcc 3.4.</li>
</ul>
<h2><a class="a-header" name="SH_1_11">1.8 -> 1.8.1</a></h2> <!-- index:2:SH:1:11:1.8 -> 1.8.1 -->
<h2><a class="a-header" name="SH_1_12">1.8 -> 1.8.1</a></h2> <!-- index:2:SH:1:12:1.8 -> 1.8.1 -->
<ul>
<li>Changed the definition of <em>--as-proxy</em> to use <em>--poll 0</em> rather than <em>--immediate</em> [bug-id 1961652].</li>
<li>Fixed stalling bug when using server-side TLS/SSL (<em>--server-tls</em>) [bug-id 1961655].</li>
<li>Improved Debian packaging for Linux (<em>make deb</em>).</li>
</ul>
<h2><a class="a-header" name="SH_1_12">1.7 -> 1.8</a></h2> <!-- index:2:SH:1:12:1.7 -> 1.8 -->
<h2><a class="a-header" name="SH_1_13">1.7 -> 1.8</a></h2> <!-- index:2:SH:1:13:1.7 -> 1.8 -->
<ul>
<li>Speed optimisations (as identified by KCachegrind/valgrind in KDevelop).</li>
<li>Build-time size optimisations (eg. <em>./configure --disable-exec --enable-small-exceptions ...</em>).</li>
@ -169,7 +184,7 @@
<li>Improved native support for Mac OS X (10.5) with graphical installation from disk image.</li>
<li>Compatibility with gcc 2.95 restored.</li>
</ul>
<h2><a class="a-header" name="SH_1_13">1.6 -> 1.7</a></h2> <!-- index:2:SH:1:13:1.6 -> 1.7 -->
<h2><a class="a-header" name="SH_1_14">1.6 -> 1.7</a></h2> <!-- index:2:SH:1:14:1.6 -> 1.7 -->
<ul>
<li>TLS/SSL support for SMTP using OpenSSL (<em>./configure --with-openssl</em> with <em>--client-tls</em> and <em>--server-tls</em>).</li>
<li>Authentication mechanism <em>PLAIN</em> added.</li>
@ -177,7 +192,7 @@
<li>Windows service wrapper has an <em>--uninstall</em> option.</li>
<li>Windows installation GUI uninstalls the service before reinstalling it.</li>
</ul>
<h2><a class="a-header" name="SH_1_14">1.5 -> 1.6</a></h2> <!-- index:2:SH:1:14:1.5 -> 1.6 -->
<h2><a class="a-header" name="SH_1_15">1.5 -> 1.6</a></h2> <!-- index:2:SH:1:15:1.5 -> 1.6 -->
<ul>
<li>GPLv3 licence (see <em>http://gplv3.fsf.org</em>).</li>
<li>New <em>--prompt-timeout</em> switch for the timeout when waiting for the initial 220 prompt from the SMTP server.</li>
@ -197,7 +212,7 @@
<li>Experimental SpamAssassin spamc/spamd protocol support.</li>
<li>Acceptance tests added to the distribution.</li>
</ul>
<h2><a class="a-header" name="SH_1_15">1.4 -> 1.5</a></h2> <!-- index:2:SH:1:15:1.4 -> 1.5 -->
<h2><a class="a-header" name="SH_1_16">1.4 -> 1.5</a></h2> <!-- index:2:SH:1:16:1.4 -> 1.5 -->
<ul>
<li>New installation and configuration GUI using TrollTech Qt 4.x (<em>./configure --enable-gui</em>)</li>
<li>Default address verifier accepts all addresses as valid and never treats them as local mailboxes.</li>
@ -212,7 +227,7 @@
<li>Documentation also created in docbook format (requires xmlto).</li>
<li>Windows installation document revised.</li>
</ul>
<h2><a class="a-header" name="SH_1_16">1.3.3 -> 1.4</a></h2> <!-- index:2:SH:1:16:1.3.3 -> 1.4 -->
<h2><a class="a-header" name="SH_1_17">1.3.3 -> 1.4</a></h2> <!-- index:2:SH:1:17:1.3.3 -> 1.4 -->
<ul>
<li>POP3 server (enable with <em>--pop</em>, disable at build-time with <em>./configure --disable-pop</em>).</li>
<li>Fix for logging reentrancy bug (affects <em>./configure --enable-debug</em> with <em>--debug</em>).</li>
@ -226,7 +241,7 @@
<li>The <em>--dont-listen</em> switch is now <em>--no-smtp</em>.</li>
<li>Better IPv6 support (Linux only).</li>
</ul>
<h2><a class="a-header" name="SH_1_17">1.3.2 -> 1.3.3</a></h2> <!-- index:2:SH:1:17:1.3.2 -> 1.3.3 -->
<h2><a class="a-header" name="SH_1_18">1.3.2 -> 1.3.3</a></h2> <!-- index:2:SH:1:18:1.3.2 -> 1.3.3 -->
<ul>
<li>No bind() for outgoing connections [bug-id 1051689].</li>
<li>Updated rpm spec file [bug-id 1224850].</li>
@ -235,21 +250,21 @@
<li>Documentation of <em>auth</em> switches corrected.</li>
<li>State-machine template type declaration modernised, possibly breaking older compilers.</li>
</ul>
<h2><a class="a-header" name="SH_1_18">1.3.1 -> 1.3.2</a></h2> <!-- index:2:SH:1:18:1.3.1 -> 1.3.2 -->
<h2><a class="a-header" name="SH_1_19">1.3.1 -> 1.3.2</a></h2> <!-- index:2:SH:1:19:1.3.1 -> 1.3.2 -->
<ul>
<li>Fix for core dump when <em>--client-filter</em> pre-processing fails.</li>
<li>Revised code structure to prepare for asynchronous pre-processing.</li>
<li>Better diagnostics when pre-processor exec() fails.</li>
<li>Better cleanup of empty and orphaned files.</li>
</ul>
<h2><a class="a-header" name="SH_1_19">1.3 -> 1.3.1</a></h2> <!-- index:2:SH:1:19:1.3 -> 1.3.1 -->
<h2><a class="a-header" name="SH_1_20">1.3 -> 1.3.1</a></h2> <!-- index:2:SH:1:20:1.3 -> 1.3.1 -->
<ul>
<li>Windows resource leak from CreateProcess() fixed.</li>
<li>Windows dialog box double-close fix.</li>
<li>Some documentation for the <em>--scanner</em> switch.</li>
<li>New usage patterns section in the user guide.</li>
</ul>
<h2><a class="a-header" name="SH_1_20">1.2 -> 1.3</a></h2> <!-- index:2:SH:1:20:1.2 -> 1.3 -->
<h2><a class="a-header" name="SH_1_21">1.2 -> 1.3</a></h2> <!-- index:2:SH:1:21:1.2 -> 1.3 -->
<ul>
<li>Client protocol waits for a greeting from the server on startup [bug-id 842156].</li>
<li>Fix for incorrect backslash normalisation on <em>--verifier</em> command-lines containing spaces [bug-id 890646].</li>
@ -262,7 +277,7 @@
<li>New switches for the <em>configure</em> script.</li>
<li>More JavaScript example scripts.</li>
</ul>
<h2><a class="a-header" name="SH_1_21">1.1.2 -> 1.2</a></h2> <!-- index:2:SH:1:21:1.1.2 -> 1.2 -->
<h2><a class="a-header" name="SH_1_22">1.1.2 -> 1.2</a></h2> <!-- index:2:SH:1:22:1.1.2 -> 1.2 -->
<ul>
<li>The <em>--filter</em> and <em>--verifier</em> arguments interpreted as command-lines; spaces in executable paths now need escaping.</li>
<li>The <em>--interface</em> switch applies to outgoing connections too.</li>
@ -271,7 +286,7 @@
<li>Fix for dangling reference bug, seen after <em>quit</em> command on Windows.</li>
<li>JavaScript examples in the documentation.</li>
</ul>
<h2><a class="a-header" name="SH_1_22">1.1.1 -> 1.1.2</a></h2> <!-- index:2:SH:1:22:1.1.1 -> 1.1.2 -->
<h2><a class="a-header" name="SH_1_23">1.1.1 -> 1.1.2</a></h2> <!-- index:2:SH:1:23:1.1.1 -> 1.1.2 -->
<ul>
<li>Earlier check for un-bindable ports on startup, and later fork()ing [bug-id 776972].</li>
<li>Resolved the file-descriptor kludge for <em>--verifier</em> on Windows.</li>
@ -280,7 +295,7 @@
<li>Pre-processor (<em>--filter</em>) program's standard output searched for a failure reason string.</li>
<li>Undocumented <em>--scanner</em> switch added for asynchronous processing by a separate network server.</li>
</ul>
<h2><a class="a-header" name="SH_1_23">1.1.0 -> 1.1.1</a></h2> <!-- index:2:SH:1:23:1.1.0 -> 1.1.1 -->
<h2><a class="a-header" name="SH_1_24">1.1.0 -> 1.1.1</a></h2> <!-- index:2:SH:1:24:1.1.0 -> 1.1.1 -->
<ul>
<li>Restored the fix for building with gcc2.96.</li>
<li>Support for MinGW builds on Windows.</li>
@ -290,7 +305,7 @@
<li>Fix for <em>make install</em> when <em>man2html</em> is not available.</li>
<li>Updated init script.</li>
</ul>
<h2><a class="a-header" name="SH_1_24">1.0.2 -> 1.1.0</a></h2> <!-- index:2:SH:1:24:1.0.2 -> 1.1.0 -->
<h2><a class="a-header" name="SH_1_25">1.0.2 -> 1.1.0</a></h2> <!-- index:2:SH:1:25:1.0.2 -> 1.1.0 -->
<ul>
<li>In proxy mode unexpected client-side disconnects and timeouts do not leave <em>.bad</em> files [see also bug-id 659039].</li>
<li>By default proxy mode does not interpret addresses for local delivery (<em>--postmaster</em>).</li>
@ -305,14 +320,14 @@
<li>Support for Sun WorkShop 5.0 added.</li>
<li>Documentation overhaul.</li>
</ul>
<h2><a class="a-header" name="SH_1_25">1.0.0 -> 1.0.2</a></h2> <!-- index:2:SH:1:25:1.0.0 -> 1.0.2 -->
<h2><a class="a-header" name="SH_1_26">1.0.0 -> 1.0.2</a></h2> <!-- index:2:SH:1:26:1.0.0 -> 1.0.2 -->
<ul>
<li>Support for trusted IP addresses, allowing certain clients to avoid authentication.</li>
<li>Address verifier interface extended to include authentication information.</li>
<li>New public mail relay section added to the user guide.</li>
<li>Example verifier scripts etc. added to the reference guide.</li>
</ul>
<h2><a class="a-header" name="SH_1_26">1.0.0 -> 1.0.1</a></h2> <!-- index:2:SH:1:26:1.0.0 -> 1.0.1 -->
<h2><a class="a-header" name="SH_1_27">1.0.0 -> 1.0.1</a></h2> <!-- index:2:SH:1:27:1.0.0 -> 1.0.1 -->
<ul>
<li>In proxy mode unexpected client-side disconnects and timeouts result in <em>.bad</em> files [bug-id 659039].</li>
<li>Require successful <em>AUTH</em> before <em>MAIL FROM</em> when using <em>--server-auth</em>.</li>
@ -325,7 +340,7 @@
<li>Fix build when using gcc2.96 rather than gcc2.95 (1.0.0-pl1).</li>
<li>Fix default spool directory in example scripts (1.0.0-pl1).</li>
</ul>
<h2><a class="a-header" name="SH_1_27">0.9.9 -> 1.0.0</a></h2> <!-- index:2:SH:1:27:0.9.9 -> 1.0.0 -->
<h2><a class="a-header" name="SH_1_28">0.9.9 -> 1.0.0</a></h2> <!-- index:2:SH:1:28:0.9.9 -> 1.0.0 -->
<ul>
<li>Briefer <em>--help</em> output; works with <em>--verbose</em>.</li>
<li>Option to listen on a specific network interface (<em>--interface</em>).</li>
@ -338,7 +353,7 @@
<li>EHLO response parsing is now case-insensitive [bug-id 561522].</li>
<li>Fewer missing-secrets warnings [bug-id 564987].</li>
</ul>
<h2><a class="a-header" name="SH_1_28">0.9.8 -> 0.9.9</a></h2> <!-- index:2:SH:1:28:0.9.8 -> 0.9.9 -->
<h2><a class="a-header" name="SH_1_29">0.9.8 -> 0.9.9</a></h2> <!-- index:2:SH:1:29:0.9.8 -> 0.9.9 -->
<ul>
<li>More flexible logging options (<em>--verbose</em> and <em>--debug</em> work better).</li>
<li>File Hierarchy Standard (FHS) option for <em>configure</em> (<em>--enable-fhs</em>).</li>
@ -354,14 +369,14 @@
<li>Submit utility works under Windows. [rc2]</li>
<li>Improved Windows project files. [rc2]</li>
</ul>
<h2><a class="a-header" name="SH_1_29">0.9.7 -> 0.9.8</a></h2> <!-- index:2:SH:1:29:0.9.7 -> 0.9.8 -->
<h2><a class="a-header" name="SH_1_30">0.9.7 -> 0.9.8</a></h2> <!-- index:2:SH:1:30:0.9.7 -> 0.9.8 -->
<ul>
<li>Fix for running pre-processor (<em>--filter</em>) as root.</li>
<li>Ignore bogus <em>AUTH=LOGIN</em> lines in EHLO response.</li>
<li>Submit utility improved to work with mutt.</li>
<li>Installation of submit man page.</li>
</ul>
<h2><a class="a-header" name="SH_1_30">0.9.6 -> 0.9.7</a></h2> <!-- index:2:SH:1:30:0.9.6 -> 0.9.7 -->
<h2><a class="a-header" name="SH_1_31">0.9.6 -> 0.9.7</a></h2> <!-- index:2:SH:1:31:0.9.6 -> 0.9.7 -->
<ul>
<li>CRAM-MD5 authentication mechanism added.</li>
<li>Revoke root permissions at start up, and reclaim them when needed.</li>
@ -377,7 +392,7 @@
<li>Submission utility <em>emailrelay-submit</em> added.</li>
<li>HTML4.0 compliant HTML documentation, using CSS.</li>
</ul>
<h2><a class="a-header" name="SH_1_31">0.9.5 -> 0.9.6</a></h2> <!-- index:2:SH:1:31:0.9.5 -> 0.9.6 -->
<h2><a class="a-header" name="SH_1_32">0.9.5 -> 0.9.6</a></h2> <!-- index:2:SH:1:32:0.9.5 -> 0.9.6 -->
<ul>
<li>SMTP AUTHentication extension -- LOGIN mechanism only.</li>
<li>Client-side protocol timeout.</li>
@ -387,7 +402,7 @@
<li>Multiple hard-coded listening addresses supported at compile-time.</li>
<li>Fix for automatic reopening of stderr stream.</li>
</ul>
<h2><a class="a-header" name="SH_1_32">0.9.4 -> 0.9.5</a></h2> <!-- index:2:SH:1:32:0.9.4 -> 0.9.5 -->
<h2><a class="a-header" name="SH_1_33">0.9.4 -> 0.9.5</a></h2> <!-- index:2:SH:1:33:0.9.4 -> 0.9.5 -->
<p>
Windows fixes and improvements...
</p>
@ -397,14 +412,14 @@
<li>fix for content file deletion</li>
<li>fix for directory iterator</li>
</ul>
<h2><a class="a-header" name="SH_1_33">0.9.3 -> 0.9.4</a></h2> <!-- index:2:SH:1:33:0.9.3 -> 0.9.4 -->
<h2><a class="a-header" name="SH_1_34">0.9.3 -> 0.9.4</a></h2> <!-- index:2:SH:1:34:0.9.3 -> 0.9.4 -->
<ul>
<li>Fixed memory leak when no <em>--log</em> switch.</li>
<li>Windows build is more <em>gui</em> and less <em>command-line</em>.</li>
<li><em>Info</em> command added to the administration interface.</li>
<li>Doxygen files removed from binary RPM.</li>
</ul>
<h2><a class="a-header" name="SH_1_34">0.9.2 -> 0.9.3</a></h2> <!-- index:2:SH:1:34:0.9.2 -> 0.9.3 -->
<h2><a class="a-header" name="SH_1_35">0.9.2 -> 0.9.3</a></h2> <!-- index:2:SH:1:35:0.9.2 -> 0.9.3 -->
<ul>
<li>Proxy mode (<em>--immediate</em> and <em>--as-proxy</em>).</li>
<li>Message pre-processing (<em>--filter</em>).</li>
@ -412,7 +427,7 @@
<li>Improved notification script, with MIME encoding.</li>
<li>Builds with old 2.91 version of gcc.</li>
</ul>
<h2><a class="a-header" name="SH_1_35">0.9.1 -> 0.9.2</a></h2> <!-- index:2:SH:1:35:0.9.1 -> 0.9.2 -->
<h2><a class="a-header" name="SH_1_36">0.9.1 -> 0.9.2</a></h2> <!-- index:2:SH:1:36:0.9.1 -> 0.9.2 -->
<ul>
<li>Better autoconf detection.</li>
<li>Workround for FreeBSD uname() feature.</li>
@ -420,7 +435,7 @@
<li>Fixed a benign directory iterator bug.</li>
<li>Use of gcc's <em>exception</em> header.</li>
</ul>
<h2><a class="a-header" name="SH_1_36">0.9 -> 0.9.1</a></h2> <!-- index:2:SH:1:36:0.9 -> 0.9.1 -->
<h2><a class="a-header" name="SH_1_37">0.9 -> 0.9.1</a></h2> <!-- index:2:SH:1:37:0.9 -> 0.9.1 -->
<ul>
<li>Improved documentation from doxygen.</li>
<li>More complete use of namespaces.</li>
@ -430,4 +445,4 @@
</div> <!-- div-main -->
</body>
</html>
<!-- Copyright (C) 2001-2022 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->
<!-- Copyright (C) 2001-2023 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->

23
doc/changelog.md
View File

@ -1,6 +1,22 @@
E-MailRelay Change Log
======================
2.4 -> 2.5
----------
* Multiple configurations in one process.
* [SMTP][] PIPELINING ([RFC-2920][]).
* SMTP CHUNKING/8BITMIME 'BDAT' extension ([RFC-3030][]), disabled by default.
* SMTP SMTPUTF8 extension ([RFC-6531][]), disabled by default.
* No 7-bit/8-bit check on received message content (see NEWS file).
* New built-in filters: `deliver:`, `split:`, `copy:`, `mx:`, `msgid:`.
* New built-in address verifier: `account:`
* No `.local` files (see NEWS file).
* [PAM][] authentication is now enabled with `--server-auth=pam:` not `/pam`.
* Client authentication details can be given directly from the command-line.
* Multiple `client` authentication secrets, selected by a new envelope field.
* Main binary can act as a simple submission tool (`configure --enable-submission`).
2.3 -> 2.4
----------
@ -34,7 +50,7 @@ E-MailRelay Change Log
* New `--log-address` option to aid adaptive firewalling.
* Dynamic log file rolling when using `--log-file=%d`.
* Choice of syslog 'facility' on Linux with `--syslog=local0` etc.
* Pipelined [SMTP][] QUIT commands sent by broken clients are tolerated.
* Pipelined SMTP QUIT commands sent by broken clients are tolerated.
* Better handling of overly-verbose or unkillable `--filter` scripts.
* Optional epoll event loop on Linux (`configure --enable-epoll`).
* Some internationalisation support (see NEWS file).
@ -123,7 +139,7 @@ E-MailRelay Change Log
* Added negotiated TLS/SSL for [POP][] (ie. `STLS`).
* The first two fields in the secrets files are reordered (with backwards compatibility).
* Added Linux [PAM][] authentication (`configure --with-pam` and then `--server-auth=/pam`).
* Added Linux PAM authentication (`configure --with-pam` and then `--server-auth=/pam`).
* Optional protocol-specific `--interface` qualifiers, eg. `--interface smtp=127.0.0.1,pop=192.168.1.1`.
* Outgoing client connection bound with the first `--interface` or `--interface client=...` address.
* Support for SMTP-over-TLS on outgoing client connection (`--client-tls-connection`) (cf. `STARTTLS`)
@ -457,8 +473,11 @@ Windows fixes and improvements...
[FHS]: https://wiki.linuxfoundation.org/lsb/fhs
[PAM]: https://en.wikipedia.org/wiki/Linux_PAM
[POP]: https://en.wikipedia.org/wiki/Post_Office_Protocol
[RFC-2920]: https://tools.ietf.org/html/rfc2920
[RFC-3030]: https://tools.ietf.org/html/rfc3030
[RFC-3848]: https://tools.ietf.org/html/rfc3848
[RFC-5782]: https://tools.ietf.org/html/rfc5782
[RFC-6531]: https://tools.ietf.org/html/rfc6531
[RFC-8314]: https://tools.ietf.org/html/rfc8314
[SMTP]: https://en.wikipedia.org/wiki/Simple_Mail_Transfer_Protocol
[SOCKS]: https://en.wikipedia.org/wiki/SOCKS

29
doc/changelog.rst
View File

@ -1,6 +1,22 @@
**********************
E-MailRelay Change Log
**********************
**********
Change Log
**********
2.4 -> 2.5
==========
* Multiple configurations in one process.
* SMTP_ PIPELINING (RFC-2920_).
* SMTP CHUNKING/8BITMIME 'BDAT' extension (RFC-3030_), disabled by default.
* SMTP SMTPUTF8 extension (RFC-6531_), disabled by default.
* No 7-bit/8-bit check on received message content (see NEWS file).
* New built-in filters: *deliver:*, *split:*, *copy:*, *mx:*, *msgid:*.
* New built-in address verifier: *account:*
* No *.local* files (see NEWS file).
* PAM_ authentication is now enabled with *--server-auth=pam:* not */pam*.
* Client authentication details can be given directly from the command-line.
* Multiple *client* authentication secrets, selected by a new envelope field.
* Main binary can act as a simple submission tool (\ *configure --enable-submission*\ ).
2.3 -> 2.4
==========
@ -35,7 +51,7 @@ E-MailRelay Change Log
* New *--log-address* option to aid adaptive firewalling.
* Dynamic log file rolling when using *--log-file=%d*.
* Choice of syslog 'facility' on Linux with *--syslog=local0* etc.
* Pipelined SMTP_ QUIT commands sent by broken clients are tolerated.
* Pipelined SMTP QUIT commands sent by broken clients are tolerated.
* Better handling of overly-verbose or unkillable *--filter* scripts.
* Optional epoll event loop on Linux (\ *configure --enable-epoll*\ ).
* Some internationalisation support (see NEWS file).
@ -124,7 +140,7 @@ E-MailRelay Change Log
* Added negotiated TLS/SSL for POP_ (ie. *STLS*).
* The first two fields in the secrets files are reordered (with backwards compatibility).
* Added Linux PAM_ authentication (*configure --with-pam* and then *--server-auth=/pam*).
* Added Linux PAM authentication (*configure --with-pam* and then *--server-auth=/pam*).
* Optional protocol-specific *--interface* qualifiers, eg. *--interface smtp=127.0.0.1,pop=192.168.1.1*.
* Outgoing client connection bound with the first *--interface* or *--interface client=...* address.
* Support for SMTP-over-TLS on outgoing client connection (\ *--client-tls-connection*\ ) (cf. *STARTTLS*)
@ -458,8 +474,11 @@ Windows fixes and improvements...
.. _FHS: https://wiki.linuxfoundation.org/lsb/fhs
.. _PAM: https://en.wikipedia.org/wiki/Linux_PAM
.. _POP: https://en.wikipedia.org/wiki/Post_Office_Protocol
.. _RFC-2920: https://tools.ietf.org/html/rfc2920
.. _RFC-3030: https://tools.ietf.org/html/rfc3030
.. _RFC-3848: https://tools.ietf.org/html/rfc3848
.. _RFC-5782: https://tools.ietf.org/html/rfc5782
.. _RFC-6531: https://tools.ietf.org/html/rfc6531
.. _RFC-8314: https://tools.ietf.org/html/rfc8314
.. _SMTP: https://en.wikipedia.org/wiki/Simple_Mail_Transfer_Protocol
.. _SOCKS: https://en.wikipedia.org/wiki/SOCKS

15
doc/changelog.txt
View File

@ -1,6 +1,21 @@
E-MailRelay Change Log
======================
2.4 -> 2.5
----------
* Multiple configurations in one process.
* SMTP PIPELINING (RFC-2920).
* SMTP CHUNKING/8BITMIME 'BDAT' extension (RFC-3030), disabled by default.
* SMTP SMTPUTF8 extension (RFC-6531), disabled by default.
* No 7-bit/8-bit check on received message content (see NEWS file).
* New built-in filters: "deliver:", "split:", "copy:", "mx:", "msgid:".
* New built-in address verifier: "account:"
* No ".local" files (see NEWS file).
* PAM authentication is now enabled with "--server-auth=pam:" not "/pam".
* Client authentication details can be given directly from the command-line.
* Multiple "client" authentication secrets, selected by a new envelope field.
* Main binary can act as a simple submission tool ("configure --enable-submission").
2.3 -> 2.4
----------
* Multiple "--filter" and "--client-filter" options allowed.

6
doc/conf.py.sphinx → doc/conf.py
View File

@ -7,10 +7,10 @@ templates_path = ['_templates']
source_suffix = '.rst'
master_doc = 'index'
project = u'E-MailRelay'
copyright = u'2022, Graeme Walker'
copyright = u'2023, Graeme Walker'
author = u'Graeme Walker'
version = u'2.4.1'
release = u'2.4.1'
version = u'2.5'
release = u'2.5'
language = None
today_fmt = '%Y-%m-%d'
exclude_patterns = []

202
doc/developer.html
View File

@ -14,29 +14,16 @@
The main principles in the design of E-MailRelay can be summarised as:
</p>
<ul>
<li>Functionality without imposing policy</li>
<li>Minimal third-party dependencies</li>
<li>Windows/Unix portability without #ifdefs</li>
<li>Event-driven, non-blocking, single-threaded networking code</li>
<li>Functionality without imposing policy</li>
<li>Multi-threading optional</li>
</ul>
<h2><a class="a-header" name="SH_1_2">Dependencies</a></h2> <!-- index:2:SH:1:2:Dependencies -->
<h2><a class="a-header" name="SH_1_2">Portability</a></h2> <!-- index:2:SH:1:2:Portability -->
<p>
E-MailRelay started life at a time when Linux had no decent package manager and
Windows was in the grip of DLL hell. As a result, a key principle is that it
has no dependencies other than a good C++ run-time. Since that time OpenSSL
has been introduced as a dependency to support TLS encryption, and the optional
configuration and installation GUI has been developed using the Qt toolkit.
</p>
<p>
In those early years multi-threading support in C++ libraries was poor, so up
until version 2.0 the code was single-threaded throughout, and multi-threading
is still optional.
</p>
<h2><a class="a-header" name="SH_1_3">Portability</a></h2> <!-- index:2:SH:1:3:Portability -->
<p>
The E-MailRelay code is now written in C++11. Earlier versions of E-MailRelay
used C++03.
The E-MailRelay code is written in C++11. Earlier versions of E-MailRelay used
C++03.
</p>
<p>
@ -60,7 +47,7 @@
Underscores in source file names are used exclusively to indicate build-time
alternatives.
</p>
<h2><a class="a-header" name="SH_1_4">Event model</a></h2> <!-- index:2:SH:1:4:Event model -->
<h2><a class="a-header" name="SH_1_3">Event model</a></h2> <!-- index:2:SH:1:3:Event model -->
<p>
The E-MailRelay server uses non-blocking socket i/o, with a select() or epoll()
event loop. This event model means that the server can handle multiple network
@ -69,6 +56,11 @@
executed (see <em>--filter</em> and <em>--address-verifier</em>).
</p>
<p>
The advantages of a non-blocking event model are discussed in the well-known
<a href="http://www.kegel.com/c10k.html">C10K Problem</a> document.
</p>
<p>
This event model can make the code more complicated than the equivalent
multi-threaded approach since (for example) it is not possible to wait for a
@ -76,17 +68,12 @@
might be other connections that need servicing half way through.
</p>
<p>
The advantages of a non-blocking event model are discussed in the well-known
<a href="http://www.kegel.com/c10k.html">C10K Problem</a> document.
</p>
<p>
At higher levels the C++ slot/signal design pattern is used to propagate events
between objects (not to be confused with operating system signals). The
slot/signal implementation has been simplified compared to Qt or boost by not
supporting signal multicasting, so each signal connects to no more than one
slot.
slot. The implementation now uses std::function.
</p>
<p>
@ -98,7 +85,7 @@
particularly when emitting more than one signal, defensive measures are
required.
</p>
<h2><a class="a-header" name="SH_1_5">Module structure</a></h2> <!-- index:2:SH:1:5:Module structure -->
<h2><a class="a-header" name="SH_1_4">Module structure</a></h2> <!-- index:2:SH:1:4:Module structure -->
<p>
The main C++ libraries in the E-MailRelay code base are as follows:
</p>
@ -121,12 +108,24 @@
</dd>
<h3><a class="a-header"><em>gsmtp</em></a></h3>
<dd>
SMTP protocol and message-store classes.
SMTP protocol classes.
</dd>
<h3><a class="a-header"><em>gpop</em></a></h3>
<dd>
POP3 protocol classes.
</dd>
<h3><a class="a-header"><em>gstore</em></a></h3>
<dd>
Message store classes.
</dd>
<h3><a class="a-header"><em>gfilters</em></a></h3>
<dd>
Built-in filters.
</dd>
<h3><a class="a-header"><em>gverifiers</em></a></h3>
<dd>
Built-in address verifiers.
</dd>
<p>
All of these libraries are portable between Unix-like systems and Windows.
</p>
@ -135,7 +134,7 @@
Under Windows there is an additional library under <em>src/win32</em> for the user
interface implemented using the Microsoft Win32 API.
</p>
<h2><a class="a-header" name="SH_1_6">SMTP class structure</a></h2> <!-- index:2:SH:1:6:SMTP class structure -->
<h2><a class="a-header" name="SH_1_5">SMTP class structure</a></h2> <!-- index:2:SH:1:5:SMTP class structure -->
<p>
The message-store functionality uses three abstract interfaces: <em>MessageStore</em>,
<em>NewMessage</em> and <em>StoredMessage</em>. The <em>NewMessage</em> interface is used to create
@ -163,18 +162,25 @@
</p>
<p>
Message filtering (<em>--filter</em>) is implemented via an abstract <em>Filter</em>
interface. Concrete implementations are provided for doing nothing, running an
external executable program and talking to an external network server.
Message filtering (<em>--filter</em>) is implemented via an abstract <em>GSmtp::Filter</em>
interface. Concrete implementations in the <em>GFilters</em> namespace are provided for
doing nothing, running an external executable program, talking to an external
network server, etc.
</p>
<p>
The protocol, processor and message-store interfaces are brought together by the
high-level <em>GSmtp::Server</em> and <em>GSmtp::Client</em> classes. Dependency injection is
used to create the concrete instances of the <em>ProtocolMessage</em> and <em>Filter</em>
interfaces.
Address verifiers (<em>--address-verifier</em>) are implemented via an abstract
<em>GSmtp::Verifier</em> interface, with concrete implementations in the <em>GVerifiers</em>
namespace.
</p>
<h2><a class="a-header" name="SH_1_7">Event handling and exceptions</a></h2> <!-- index:2:SH:1:7:Event handling and exceptions -->
<p>
The protocol, processor and message-store interfaces are brought together by
the high-level <em>GSmtp::Server</em> and <em>GSmtp::Client</em> classes. Dependency
injection is used to create the concrete instances of the <em>MessageStore</em>,
<em>Filter</em> and <em>Verifier</em> interfaces.
</p>
<h2><a class="a-header" name="SH_1_6">Event handling and exceptions</a></h2> <!-- index:2:SH:1:6:Event handling and exceptions -->
<p>
The use of non-blocking i/o in the network library means that most processing
operates within the context of an i/o event or timeout callback, so the top
@ -186,40 +192,42 @@
<p>
The event loop delivers asynchronous socket events to the <em>EventHandler</em>
interface, timer events to the <em>TimerBase</em> interface, and 'future' events to the
<em>FutureEventCallback</em> interface. If any of the these event handlers throws an
exception then the event loop catches it and delivers it back to an exception
handler through the <em>onException()</em> method of an associated <em>ExceptionHandler</em>
interface. If an exception is thrown out of _this_ callback then the event loop
code lets it propagate back to <em>main()</em>, typically terminating the program.
interface, timer events to the <em>TimerBase</em> interface, and 'future' events to
the <em>FutureEventCallback</em> interface. If any of the these event handlers throws
an exception then the event loop catches it and delivers it back to an
exception handler through the <em>onException()</em> method of an associated
<em>ExceptionHandler</em> interface. If an exception is thrown out of _this_ callback
then the event loop code lets it propagate back to <em>main()</em>, typically
terminating the program.
</p>
<p>
However, sometimes there are objects that need to be more resilient to
exceptions. In particular, a network server should not terminate just because
one of its connections fails unexpectedly. In these cases the owning parent
object receives the exception notification together with a pointer that
identifies the child object that threw the exception (ie. the exception
source). This allows the parent object to absorb the exception and delete the
child, without the exception killing the whole server.
object receives the exception notification together with an <em>ExceptionSource</em>
pointer that identifies the child object that threw the exception. This allows
the parent object to absorb the exception and delete the child, without the
exception killing the whole server.
</p>
<p>
Event sources in the event loop are held as a file descriptor, a windows event
handle, an EventHandler pointer, an ExceptionHandler pointer and an
ExceptionSource pointer. The first two together are known as a Descriptor, and
the last two together are known as an ExceptionSink.
Event sources in the event loop are typically held as a file descriptor and a
windows event handle, together known as a <em>Descriptor</em>. Event loop
implementations typically watch a set of Descriptors for events and call the
relevant EventHandler/ExceptionHandler code via the <em>EventEmitter</em> class.
</p>
<h2><a class="a-header" name="SH_1_8">Multi-threading</a></h2> <!-- index:2:SH:1:8:Multi-threading -->
<h2><a class="a-header" name="SH_1_7">Multi-threading</a></h2> <!-- index:2:SH:1:7:Multi-threading -->
<p>
Multi-threading can be used as a build-time option to make DNS lookup and the
execution of helper programs asynchronous; if enabled then std::thread is
used in a future/promise pattern to wrap up <em>getaddrinfo()</em> and <em>waitpid()</em>
system calls. The shared state comprises only the parameters and return results
from these system calls, and synchronisation back to the main thread uses the
event loop (see <em>GNet::FutureEvent</em>).
Multi-threading is used to make DNS lookup and external program asynchronous so
unless disabled at build-time std::thread is used in a future/promise pattern to
wrap up <em>getaddrinfo()</em> and <em>waitpid()</em> system calls. The shared state comprises
only the parameters and return results from these system calls, and
synchronisation back to the main thread uses the main event loop (see
<em>GNet::FutureEvent</em>). Threading is not used elsewhere so the C/C++ run-time
library does not need to be thread-safe.
</p>
<h2><a class="a-header" name="SH_1_9">E-MailRelay GUI</a></h2> <!-- index:2:SH:1:9:E-MailRelay GUI -->
<h2><a class="a-header" name="SH_1_8">E-MailRelay GUI</a></h2> <!-- index:2:SH:1:8:E-MailRelay GUI -->
<p>
The optional GUI program <em>emailrelay-gui</em> uses the Qt toolkit for its user
interface components. The GUI can run as an installer or as a configuration
@ -253,28 +261,52 @@
<p>
When run in install mode the GUI expects to unpack all the E-MailRelay files
from the payload into target directories. The payload is a simple directory
tree that lives alongside the GUI exectuable or inside the Mac application
tree that lives alongside the GUI executable or inside the Mac application
bundle, and it contains a configuration file to tell the installer where
to copy its files.
</p>
<h2><a class="a-header" name="SH_1_10">Windows build</a></h2> <!-- index:2:SH:1:10:Windows build -->
<p>
When building the GUI program the library code shared with the main server
executable is compiled separately so that different GUI-specific compiler
options can be used. This is done as a 'unity build', concatenating the shared
code into one source file and compiling that for the GUI. (This technique
requires that private 'detail' namespaces are named rather than anonymous so
that there cannot be any name clashes within the combined anonymous namespace.)
</p>
<h2><a class="a-header" name="SH_1_9">Windows build</a></h2> <!-- index:2:SH:1:9:Windows build -->
<p>
E-MailRelay can be compiled on Windows using Microsoft Visual Studio C++ (MSVC)
or mingw-w64. For MSVC builds there is a perl script (<em>winbuild.pl</em>) that creates
<em>cmake</em> files from the autotools makefiles, runs <em>cmake</em> to create the MSVC
project files and then runs <em>msbuild</em> to compile E-MailRelay. If perl, cmake,
MSVC, Qt and mbedTLS source are installed in the right way then the
<em>winbuild.bat</em> batch file should be able to do a complete MSVC release build
in one go.
or mingw-w64.
</p>
<p>
For MinGW cross-builds use <em>./configure.sh -m</em> and <em>make</em> on a Linux box and
For MSVC builds there is a perl script (<em>winbuild.pl</em>) that creates <em>cmake</em>
files from the autotools makefiles, runs <em>cmake</em> to create the MSVC project
files and then runs <em>msbuild</em> to compile E-MailRelay. If perl, cmake, MSVC, Qt
and mbedTLS source are installed in the right way then the <em>winbuild.bat</em> batch
file should be able to do a complete MSVC release build in one go. After that
the <em>winbuild-install.bat</em> batch file can be used to create a distribution.
</p>
<p>
When building for a public release the E-MailRelay setup program should be
statically linked and copied into the distribution created by <em>winbuild.pl</em>.
This requires a static build of Qt: edit <em>msvc-desktop.conf</em> to use <em>/MT</em>;
run <em>configure.bat</em> with <em>-static -release</em>; run <em>nmake -f Makefile</em> for
<em>release</em> then <em>install</em>. Then build the E-MailRelay GUI using
<em>emailrelay-gui.pro</em>: <em>qmake CONFIG+='win static' emailrelay-gui.pro</em>;
then <em>mc messages.mc</em>; then copy <em>emailrelay-icon.ico</em>; and finally
<em>nmake -f Makefile.Release</em>.
</p>
<p>
For MinGW cross-builds use <em>./configure.sh -w64</em> and <em>make</em> on a Linux box and
copy the built executables and the MinGW run-time to the target. Any extra
run-time files can be identified by running <em>dumpbin /dependents</em> in the normal
way.
</p>
<h2><a class="a-header" name="SH_1_11">Windows packaging</a></h2> <!-- index:2:SH:1:11:Windows packaging -->
<h2><a class="a-header" name="SH_1_10">Windows packaging</a></h2> <!-- index:2:SH:1:10:Windows packaging -->
<p>
On Windows E-MailRelay is packaged as a zip file containing the executables
(including the emailrelay GUI as <em>emailrelay-setup.exe</em>), documentation, and a
@ -284,15 +316,16 @@
<p>
The Qt tool <em>windeployqt</em> is used to add run-time dependencies, such as the
Qt DLLs.
platform DLL. (Public releases of Windows builds are normally statically linked,
so many of the DLLs added by <em>windeployqt</em> are not needed.)
</p>
<p>
To target ancient versions of Windows start with a cross-build using MinGW;
then <em>winbuild.pl mingw</em> can be used to assemble a slimmed-down package for
distribution.
To target ancient versions of Windows start with a cross-build using MinGW
for 32-bit (<em>./configure.sh -w32</em>); then <em>winbuild.pl mingw</em> can be used to
assemble a slimmed-down package for distribution.
</p>
<h2><a class="a-header" name="SH_1_12">Unix packaging</a></h2> <!-- index:2:SH:1:12:Unix packaging -->
<h2><a class="a-header" name="SH_1_11">Unix packaging</a></h2> <!-- index:2:SH:1:11:Unix packaging -->
<p>
On Unix-like operating systems it is more natural to use some sort of package
derived from the <em>make install</em> process rather than an installer program, so
@ -303,7 +336,7 @@
Top-level makefile targets <em>dist</em>, <em>deb</em> and <em>rpm</em> can be used to create a
binary tarball, a debian package, and an RPM package respectively.
</p>
<h2><a class="a-header" name="SH_1_13">Internationalisation</a></h2> <!-- index:2:SH:1:13:Internationalisation -->
<h2><a class="a-header" name="SH_1_12">Internationalisation</a></h2> <!-- index:2:SH:1:12:Internationalisation -->
<p>
The GUI code has i18n support using the Qt framework, with the tr() function
used throughout the GUI source code. The GUI main() function loads translations
@ -313,12 +346,17 @@
</p>
<p>
The non-GUI code has minimal i18n support using gettext(), mostly for startup
error messages and usage help. This is disabled by default and requires a
configure-script option (<em>--with-gettext</em>) to enable it at build-time and
a <em>--localedir</em> option at run-time. See also <em>po/Makefile.am</em>.
The non-GUI code has some i18n support by using gettext() via the inline txt()
and tx() functions defined in <em>src/glib/ggettext.h</em>. The configure script
detects gettext support in the C run-time library, but without trying different
compile and link options. See also <em>po/Makefile.am</em>.
</p>
<h2><a class="a-header" name="SH_1_14">Source control</a></h2> <!-- index:2:SH:1:14:Source control -->
<p>
On Windows the main server executable has a tabbed dialog-box as its user
interface, but that does not have any support for i18n.
</p>
<h2><a class="a-header" name="SH_1_13">Source control</a></h2> <!-- index:2:SH:1:13:Source control -->
<p>
The source code is stored in the SourceForge <em>svn</em> repository. A working
copy can be checked out as follows:
@ -327,7 +365,7 @@
<div class="div-pre">
<pre>$ svn co https://svn.code.sf.net/p/emailrelay/code/trunk emailrelay</pre>
</div><!-- div-pre -->
<h2><a class="a-header" name="SH_1_15">Compile-time features</a></h2> <!-- index:2:SH:1:15:Compile-time features -->
<h2><a class="a-header" name="SH_1_14">Compile-time features</a></h2> <!-- index:2:SH:1:14:Compile-time features -->
<p>
Compile-time features can be selected with options passed to the <em>configure</em>
script. These include the following:
@ -350,10 +388,10 @@
<div class="div-footer">
<p>
Copyright (C) 2001-2022 Graeme Walker
Copyright (C) 2001-2023 Graeme Walker
</p>
</div><!-- div-footer -->
</div> <!-- div-main -->
</body>
</html>
<!-- Copyright (C) 2001-2022 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->
<!-- Copyright (C) 2001-2023 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->

163
doc/developer.md
View File

@ -5,27 +5,16 @@ Principles
----------
The main principles in the design of E-MailRelay can be summarised as:
* Functionality without imposing policy
* Minimal third-party dependencies
* Windows/Unix portability without #ifdefs
* Event-driven, non-blocking, single-threaded networking code
* Functionality without imposing policy
Dependencies
------------
E-MailRelay started life at a time when Linux had no decent package manager and
Windows was in the grip of DLL hell. As a result, a key principle is that it
has no dependencies other than a good C++ run-time. Since that time OpenSSL
has been introduced as a dependency to support [TLS][] encryption, and the optional
configuration and installation GUI has been developed using the Qt toolkit.
In those early years multi-threading support in C++ libraries was poor, so up
until version 2.0 the code was single-threaded throughout, and multi-threading
is still optional.
* Multi-threading optional
Portability
-----------
The E-MailRelay code is now written in C++11. Earlier versions of E-MailRelay
used C++03.
The E-MailRelay code is written in C++11. Earlier versions of E-MailRelay used
C++03.
The header files `gdef.h` in `src/glib` is used to fix up some compiler
portability issues such as missing standard types, non-standard system headers
@ -51,19 +40,19 @@ connections simultaneously from a single thread, and even if multi-threading is
disabled at build-time the only blocking occurs when external programs are
executed (see `--filter` and `--address-verifier`).
The advantages of a non-blocking event model are discussed in the well-known
[C10K Problem](http://www.kegel.com/c10k.html) document.
This event model can make the code more complicated than the equivalent
multi-threaded approach since (for example) it is not possible to wait for a
complete line of input to be received from a remote [SMTP][] client because there
might be other connections that need servicing half way through.
The advantages of a non-blocking event model are discussed in the well-known
[C10K Problem](http://www.kegel.com/c10k.html) document.
At higher levels the C++ slot/signal design pattern is used to propagate events
between objects (not to be confused with operating system signals). The
slot/signal implementation has been simplified compared to Qt or boost by not
supporting signal multicasting, so each signal connects to no more than one
slot.
slot. The implementation now uses std::function.
The synchronous slot/signal pattern needs some care when when the signalling
object gets destructed as a side-effect of raising a signal, and that situation
@ -85,7 +74,7 @@ The main C++ libraries in the E-MailRelay code base are as follows:
### "gssl" ###
A thin layer over the third-party TLS libraries.
A thin layer over the third-party [TLS][] libraries.
### "gnet" ###
@ -100,13 +89,28 @@ The main C++ libraries in the E-MailRelay code base are as follows:
### "gsmtp" ###
SMTP protocol and message-store classes.
SMTP protocol classes.
### "gpop" ###
POP3 protocol classes.
### "gstore" ###
Message store classes.
### "gfilters" ###
Built-in filters.
### "gverifiers" ###
Built-in address verifiers.
All of these libraries are portable between Unix-like systems and Windows.
Under Windows there is an additional library under `src/win32` for the user
@ -134,14 +138,19 @@ pattern is used whereby the forwarding class uses an instance of the storage
class to do the message storing and filtering, while adding in an instance
of the `GSmtp::Client` class to do the forwarding.
Message filtering (`--filter`) is implemented via an abstract `Filter`
interface. Concrete implementations are provided for doing nothing, running an
external executable program and talking to an external network server.
Message filtering (`--filter`) is implemented via an abstract `GSmtp::Filter`
interface. Concrete implementations in the `GFilters` namespace are provided for
doing nothing, running an external executable program, talking to an external
network server, etc.
The protocol, processor and message-store interfaces are brought together by the
high-level `GSmtp::Server` and `GSmtp::Client` classes. Dependency injection is
used to create the concrete instances of the `ProtocolMessage` and `Filter`
interfaces.
Address verifiers (`--address-verifier`) are implemented via an abstract
`GSmtp::Verifier` interface, with concrete implementations in the `GVerifiers`
namespace.
The protocol, processor and message-store interfaces are brought together by
the high-level `GSmtp::Server` and `GSmtp::Client` classes. Dependency
injection is used to create the concrete instances of the `MessageStore`,
`Filter` and `Verifier` interfaces.
Event handling and exceptions
-----------------------------
@ -153,34 +162,36 @@ because it is not possible to put a single catch block around a particular
high-level feature.
The event loop delivers asynchronous socket events to the `EventHandler`
interface, timer events to the `TimerBase` interface, and 'future' events to the
`FutureEventCallback` interface. If any of the these event handlers throws an
exception then the event loop catches it and delivers it back to an exception
handler through the `onException()` method of an associated `ExceptionHandler`
interface. If an exception is thrown out of _this_ callback then the event loop
code lets it propagate back to `main()`, typically terminating the program.
interface, timer events to the `TimerBase` interface, and 'future' events to
the `FutureEventCallback` interface. If any of the these event handlers throws
an exception then the event loop catches it and delivers it back to an
exception handler through the `onException()` method of an associated
`ExceptionHandler` interface. If an exception is thrown out of _this_ callback
then the event loop code lets it propagate back to `main()`, typically
terminating the program.
However, sometimes there are objects that need to be more resilient to
exceptions. In particular, a network server should not terminate just because
one of its connections fails unexpectedly. In these cases the owning parent
object receives the exception notification together with a pointer that
identifies the child object that threw the exception (ie. the exception
source). This allows the parent object to absorb the exception and delete the
child, without the exception killing the whole server.
object receives the exception notification together with an `ExceptionSource`
pointer that identifies the child object that threw the exception. This allows
the parent object to absorb the exception and delete the child, without the
exception killing the whole server.
Event sources in the event loop are held as a file descriptor, a windows event
handle, an EventHandler pointer, an ExceptionHandler pointer and an
ExceptionSource pointer. The first two together are known as a Descriptor, and
the last two together are known as an ExceptionSink.
Event sources in the event loop are typically held as a file descriptor and a
windows event handle, together known as a `Descriptor`. Event loop
implementations typically watch a set of Descriptors for events and call the
relevant EventHandler/ExceptionHandler code via the `EventEmitter` class.
Multi-threading
---------------
Multi-threading can be used as a build-time option to make DNS lookup and the
execution of helper programs asynchronous; if enabled then std::thread is
used in a future/promise pattern to wrap up `getaddrinfo()` and `waitpid()`
system calls. The shared state comprises only the parameters and return results
from these system calls, and synchronisation back to the main thread uses the
event loop (see `GNet::FutureEvent`).
Multi-threading is used to make DNS lookup and external program asynchronous so
unless disabled at build-time std::thread is used in a future/promise pattern to
wrap up `getaddrinfo()` and `waitpid()` system calls. The shared state comprises
only the parameters and return results from these system calls, and
synchronisation back to the main thread uses the main event loop (see
`GNet::FutureEvent`). Threading is not used elsewhere so the C/C++ run-time
library does not need to be thread-safe.
E-MailRelay GUI
---------------
@ -208,21 +219,39 @@ When run in configure mode the GUI normally ends up simply editing the
When run in install mode the GUI expects to unpack all the E-MailRelay files
from the payload into target directories. The payload is a simple directory
tree that lives alongside the GUI exectuable or inside the Mac application
tree that lives alongside the GUI executable or inside the Mac application
bundle, and it contains a configuration file to tell the installer where
to copy its files.
When building the GUI program the library code shared with the main server
executable is compiled separately so that different GUI-specific compiler
options can be used. This is done as a 'unity build', concatenating the shared
code into one source file and compiling that for the GUI. (This technique
requires that private 'detail' namespaces are named rather than anonymous so
that there cannot be any name clashes within the combined anonymous namespace.)
Windows build
-------------
E-MailRelay can be compiled on Windows using Microsoft Visual Studio C++ (MSVC)
or mingw-w64. For MSVC builds there is a perl script (`winbuild.pl`) that creates
`cmake` files from the autotools makefiles, runs `cmake` to create the MSVC
project files and then runs `msbuild` to compile E-MailRelay. If perl, cmake,
MSVC, Qt and mbedTLS source are installed in the right way then the
`winbuild.bat` batch file should be able to do a complete MSVC release build
in one go.
or mingw-w64.
For MinGW cross-builds use `./configure.sh -m` and `make` on a Linux box and
For MSVC builds there is a perl script (`winbuild.pl`) that creates `cmake`
files from the autotools makefiles, runs `cmake` to create the MSVC project
files and then runs `msbuild` to compile E-MailRelay. If perl, cmake, MSVC, Qt
and mbedTLS source are installed in the right way then the `winbuild.bat` batch
file should be able to do a complete MSVC release build in one go. After that
the `winbuild-install.bat` batch file can be used to create a distribution.
When building for a public release the E-MailRelay setup program should be
statically linked and copied into the distribution created by `winbuild.pl`.
This requires a static build of Qt: edit `msvc-desktop.conf` to use `/MT`;
run `configure.bat` with `-static -release`; run `nmake -f Makefile` for
`release` then `install`. Then build the E-MailRelay GUI using
`emailrelay-gui.pro`: `qmake CONFIG+='win static' emailrelay-gui.pro`;
then `mc messages.mc`; then copy `emailrelay-icon.ico`; and finally
`nmake -f Makefile.Release`.
For MinGW cross-builds use `./configure.sh -w64` and `make` on a Linux box and
copy the built executables and the MinGW run-time to the target. Any extra
run-time files can be identified by running `dumpbin /dependents` in the normal
way.
@ -235,11 +264,12 @@ On Windows E-MailRelay is packaged as a zip file containing the executables
again, and while this duplication is not ideal it is at least straightforward.
The Qt tool `windeployqt` is used to add run-time dependencies, such as the
Qt DLLs.
platform DLL. (Public releases of Windows builds are normally statically linked,
so many of the DLLs added by `windeployqt` are not needed.)
To target ancient versions of Windows start with a cross-build using MinGW;
then `winbuild.pl mingw` can be used to assemble a slimmed-down package for
distribution.
To target ancient versions of Windows start with a cross-build using MinGW
for 32-bit (`./configure.sh -w32`); then `winbuild.pl mingw` can be used to
assemble a slimmed-down package for distribution.
Unix packaging
--------------
@ -258,10 +288,13 @@ from the `translations` sub-directory (relative to the executable), although
that can be overridden with the `--qm` command-line option. Qt's `-reverse`
option can also be used to reverse the widgets when using RTL languages.
The non-GUI code has minimal i18n support using gettext(), mostly for startup
error messages and usage help. This is disabled by default and requires a
configure-script option (`--with-gettext`) to enable it at build-time and
a `--localedir` option at run-time. See also `po/Makefile.am`.
The non-GUI code has some i18n support by using gettext() via the inline txt()
and tx() functions defined in `src/glib/ggettext.h`. The configure script
detects gettext support in the C run-time library, but without trying different
compile and link options. See also `po/Makefile.am`.
On Windows the main server executable has a tabbed dialog-box as its user
interface, but that does not have any support for i18n.
Source control
--------------
@ -292,4 +325,4 @@ Use `./configure --help` to see a complete list of options.
[TLS]: https://en.wikipedia.org/wiki/Transport_Layer_Security
_____________________________________
Copyright (C) 2001-2022 Graeme Walker
Copyright (C) 2001-2023 Graeme Walker

188
doc/developer.rst
View File

@ -1,32 +1,21 @@
***************************
E-MailRelay Developer Guide
***************************
***************
Developer Guide
***************
Principles
==========
The main principles in the design of E-MailRelay can be summarised as:
* Functionality without imposing policy
* Minimal third-party dependencies
* Windows/Unix portability without #ifdefs
* Event-driven, non-blocking, single-threaded networking code
* Functionality without imposing policy
Dependencies
============
E-MailRelay started life at a time when Linux had no decent package manager and
Windows was in the grip of DLL hell. As a result, a key principle is that it
has no dependencies other than a good C++ run-time. Since that time OpenSSL
has been introduced as a dependency to support TLS_ encryption, and the optional
configuration and installation GUI has been developed using the Qt toolkit.
In those early years multi-threading support in C++ libraries was poor, so up
until version 2.0 the code was single-threaded throughout, and multi-threading
is still optional.
* Multi-threading optional
Portability
===========
The E-MailRelay code is now written in C++11. Earlier versions of E-MailRelay
used C++03.
The E-MailRelay code is written in C++11. Earlier versions of E-MailRelay used
C++03.
The header files *gdef.h* in *src/glib* is used to fix up some compiler
portability issues such as missing standard types, non-standard system headers
@ -52,19 +41,19 @@ connections simultaneously from a single thread, and even if multi-threading is
disabled at build-time the only blocking occurs when external programs are
executed (see *--filter* and *--address-verifier*).
The advantages of a non-blocking event model are discussed in the well-known
`C10K Problem <http://www.kegel.com/c10k.html>`_ document.
This event model can make the code more complicated than the equivalent
multi-threaded approach since (for example) it is not possible to wait for a
complete line of input to be received from a remote SMTP_ client because there
might be other connections that need servicing half way through.
The advantages of a non-blocking event model are discussed in the well-known
`C10K Problem <http://www.kegel.com/c10k.html>`_ document.
At higher levels the C++ slot/signal design pattern is used to propagate events
between objects (not to be confused with operating system signals). The
slot/signal implementation has been simplified compared to Qt or boost by not
supporting signal multicasting, so each signal connects to no more than one
slot.
slot. The implementation now uses std::function.
The synchronous slot/signal pattern needs some care when when the signalling
object gets destructed as a side-effect of raising a signal, and that situation
@ -77,19 +66,52 @@ required.
Module structure
================
The main C++ libraries in the E-MailRelay code base are as follows:
"glib"
------
Low-level classes for file-system abstraction, date and time representation,
string utility functions, logging, command line parsing etc.
A thin layer over the third-party TLS libraries.
"gssl"
------
A thin layer over the third-party TLS_ libraries.
"gnet"
------
Network and event-loop classes.
"gauth"
-------
Implements various authentication mechanisms.
SMTP protocol and message-store classes.
"gsmtp"
-------
SMTP protocol classes.
"gpop"
------
POP3 protocol classes.
"gstore"
--------
Message store classes.
"gfilters"
----------
Built-in filters.
"gverifiers"
------------
Built-in address verifiers.
All of these libraries are portable between Unix-like systems and Windows.
Under Windows there is an additional library under *src/win32* for the user
@ -117,14 +139,19 @@ pattern is used whereby the forwarding class uses an instance of the storage
class to do the message storing and filtering, while adding in an instance
of the *GSmtp::Client* class to do the forwarding.
Message filtering (\ *--filter*\ ) is implemented via an abstract *Filter*
interface. Concrete implementations are provided for doing nothing, running an
external executable program and talking to an external network server.
Message filtering (\ *--filter*\ ) is implemented via an abstract *GSmtp::Filter*
interface. Concrete implementations in the *GFilters* namespace are provided for
doing nothing, running an external executable program, talking to an external
network server, etc.
The protocol, processor and message-store interfaces are brought together by the
high-level *GSmtp::Server* and *GSmtp::Client* classes. Dependency injection is
used to create the concrete instances of the *ProtocolMessage* and *Filter*
interfaces.
Address verifiers (\ *--address-verifier*\ ) are implemented via an abstract
*GSmtp::Verifier* interface, with concrete implementations in the *GVerifiers*
namespace.
The protocol, processor and message-store interfaces are brought together by
the high-level *GSmtp::Server* and *GSmtp::Client* classes. Dependency
injection is used to create the concrete instances of the *MessageStore*,
*Filter* and *Verifier* interfaces.
Event handling and exceptions
=============================
@ -136,34 +163,36 @@ because it is not possible to put a single catch block around a particular
high-level feature.
The event loop delivers asynchronous socket events to the *EventHandler*
interface, timer events to the *TimerBase* interface, and 'future' events to the
*FutureEventCallback* interface. If any of the these event handlers throws an
exception then the event loop catches it and delivers it back to an exception
handler through the *onException()* method of an associated *ExceptionHandler*
interface. If an exception is thrown out of _this_ callback then the event loop
code lets it propagate back to *main()*, typically terminating the program.
interface, timer events to the *TimerBase* interface, and 'future' events to
the *FutureEventCallback* interface. If any of the these event handlers throws
an exception then the event loop catches it and delivers it back to an
exception handler through the *onException()* method of an associated
*ExceptionHandler* interface. If an exception is thrown out of _this_ callback
then the event loop code lets it propagate back to *main()*, typically
terminating the program.
However, sometimes there are objects that need to be more resilient to
exceptions. In particular, a network server should not terminate just because
one of its connections fails unexpectedly. In these cases the owning parent
object receives the exception notification together with a pointer that
identifies the child object that threw the exception (ie. the exception
source). This allows the parent object to absorb the exception and delete the
child, without the exception killing the whole server.
object receives the exception notification together with an *ExceptionSource*
pointer that identifies the child object that threw the exception. This allows
the parent object to absorb the exception and delete the child, without the
exception killing the whole server.
Event sources in the event loop are held as a file descriptor, a windows event
handle, an EventHandler pointer, an ExceptionHandler pointer and an
ExceptionSource pointer. The first two together are known as a Descriptor, and
the last two together are known as an ExceptionSink.
Event sources in the event loop are typically held as a file descriptor and a
windows event handle, together known as a *Descriptor*. Event loop
implementations typically watch a set of Descriptors for events and call the
relevant EventHandler/ExceptionHandler code via the *EventEmitter* class.
Multi-threading
===============
Multi-threading can be used as a build-time option to make DNS lookup and the
execution of helper programs asynchronous; if enabled then std::thread is
used in a future/promise pattern to wrap up *getaddrinfo()* and *waitpid()*
system calls. The shared state comprises only the parameters and return results
from these system calls, and synchronisation back to the main thread uses the
event loop (see *GNet::FutureEvent*).
Multi-threading is used to make DNS lookup and external program asynchronous so
unless disabled at build-time std::thread is used in a future/promise pattern to
wrap up *getaddrinfo()* and *waitpid()* system calls. The shared state comprises
only the parameters and return results from these system calls, and
synchronisation back to the main thread uses the main event loop (see
\ *GNet::FutureEvent*\ ). Threading is not used elsewhere so the C/C++ run-time
library does not need to be thread-safe.
E-MailRelay GUI
===============
@ -191,21 +220,39 @@ When run in configure mode the GUI normally ends up simply editing the
When run in install mode the GUI expects to unpack all the E-MailRelay files
from the payload into target directories. The payload is a simple directory
tree that lives alongside the GUI exectuable or inside the Mac application
tree that lives alongside the GUI executable or inside the Mac application
bundle, and it contains a configuration file to tell the installer where
to copy its files.
When building the GUI program the library code shared with the main server
executable is compiled separately so that different GUI-specific compiler
options can be used. This is done as a 'unity build', concatenating the shared
code into one source file and compiling that for the GUI. (This technique
requires that private 'detail' namespaces are named rather than anonymous so
that there cannot be any name clashes within the combined anonymous namespace.)
Windows build
=============
E-MailRelay can be compiled on Windows using Microsoft Visual Studio C++ (MSVC)
or mingw-w64. For MSVC builds there is a perl script (\ *winbuild.pl*\ ) that creates
*cmake* files from the autotools makefiles, runs *cmake* to create the MSVC
project files and then runs *msbuild* to compile E-MailRelay. If perl, cmake,
MSVC, Qt and mbedTLS source are installed in the right way then the
*winbuild.bat* batch file should be able to do a complete MSVC release build
in one go.
or mingw-w64.
For MinGW cross-builds use *./configure.sh -m* and *make* on a Linux box and
For MSVC builds there is a perl script (\ *winbuild.pl*\ ) that creates *cmake*
files from the autotools makefiles, runs *cmake* to create the MSVC project
files and then runs *msbuild* to compile E-MailRelay. If perl, cmake, MSVC, Qt
and mbedTLS source are installed in the right way then the *winbuild.bat* batch
file should be able to do a complete MSVC release build in one go. After that
the *winbuild-install.bat* batch file can be used to create a distribution.
When building for a public release the E-MailRelay setup program should be
statically linked and copied into the distribution created by *winbuild.pl*.
This requires a static build of Qt: edit *msvc-desktop.conf* to use */MT*;
run *configure.bat* with *-static -release*; run *nmake -f Makefile* for
*release* then *install*. Then build the E-MailRelay GUI using
\ *emailrelay-gui.pro*\ : *qmake CONFIG+='win static' emailrelay-gui.pro*;
then *mc messages.mc*; then copy *emailrelay-icon.ico*; and finally
\ *nmake -f Makefile.Release*\ .
For MinGW cross-builds use *./configure.sh -w64* and *make* on a Linux box and
copy the built executables and the MinGW run-time to the target. Any extra
run-time files can be identified by running *dumpbin /dependents* in the normal
way.
@ -218,11 +265,12 @@ On Windows E-MailRelay is packaged as a zip file containing the executables
again, and while this duplication is not ideal it is at least straightforward.
The Qt tool *windeployqt* is used to add run-time dependencies, such as the
Qt DLLs.
platform DLL. (Public releases of Windows builds are normally statically linked,
so many of the DLLs added by *windeployqt* are not needed.)
To target ancient versions of Windows start with a cross-build using MinGW;
then *winbuild.pl mingw* can be used to assemble a slimmed-down package for
distribution.
To target ancient versions of Windows start with a cross-build using MinGW
for 32-bit (\ *./configure.sh -w32*\ ); then *winbuild.pl mingw* can be used to
assemble a slimmed-down package for distribution.
Unix packaging
==============
@ -241,10 +289,13 @@ from the *translations* sub-directory (relative to the executable), although
that can be overridden with the *--qm* command-line option. Qt's *-reverse*
option can also be used to reverse the widgets when using RTL languages.
The non-GUI code has minimal i18n support using gettext(), mostly for startup
error messages and usage help. This is disabled by default and requires a
configure-script option (\ *--with-gettext*\ ) to enable it at build-time and
a *--localedir* option at run-time. See also *po/Makefile.am*.
The non-GUI code has some i18n support by using gettext() via the inline txt()
and tx() functions defined in *src/glib/ggettext.h*. The configure script
detects gettext support in the C run-time library, but without trying different
compile and link options. See also *po/Makefile.am*.
On Windows the main server executable has a tabbed dialog-box as its user
interface, but that does not have any support for i18n.
Source control
==============
@ -255,6 +306,7 @@ copy can be checked out as follows:
$ svn co https://svn.code.sf.net/p/emailrelay/code/trunk emailrelay
Compile-time features
=====================
Compile-time features can be selected with options passed to the *configure*
@ -277,4 +329,4 @@ Use *./configure --help* to see a complete list of options.
.. _SMTP: https://en.wikipedia.org/wiki/Simple_Mail_Transfer_Protocol
.. _TLS: https://en.wikipedia.org/wiki/Transport_Layer_Security
.. footer:: Copyright (C) 2001-2022 Graeme Walker
.. footer:: Copyright (C) 2001-2023 Graeme Walker

155
doc/developer.txt
View File

@ -4,27 +4,16 @@ E-MailRelay Developer Guide
Principles
----------
The main principles in the design of E-MailRelay can be summarised as:
* Functionality without imposing policy
* Minimal third-party dependencies
* Windows/Unix portability without #ifdefs
* Event-driven, non-blocking, single-threaded networking code
* Functionality without imposing policy
Dependencies
------------
E-MailRelay started life at a time when Linux had no decent package manager and
Windows was in the grip of DLL hell. As a result, a key principle is that it
has no dependencies other than a good C++ run-time. Since that time OpenSSL
has been introduced as a dependency to support TLS encryption, and the optional
configuration and installation GUI has been developed using the Qt toolkit.
In those early years multi-threading support in C++ libraries was poor, so up
until version 2.0 the code was single-threaded throughout, and multi-threading
is still optional.
* Multi-threading optional
Portability
-----------
The E-MailRelay code is now written in C++11. Earlier versions of E-MailRelay
used C++03.
The E-MailRelay code is written in C++11. Earlier versions of E-MailRelay used
C++03.
The header files "gdef.h" in "src/glib" is used to fix up some compiler
portability issues such as missing standard types, non-standard system headers
@ -50,19 +39,19 @@ connections simultaneously from a single thread, and even if multi-threading is
disabled at build-time the only blocking occurs when external programs are
executed (see "--filter" and "--address-verifier").
The advantages of a non-blocking event model are discussed in the well-known
*C10K Problem* [http://www.kegel.com/c10k.html] document.
This event model can make the code more complicated than the equivalent
multi-threaded approach since (for example) it is not possible to wait for a
complete line of input to be received from a remote SMTP client because there
might be other connections that need servicing half way through.
The advantages of a non-blocking event model are discussed in the well-known
*C10K Problem* [http://www.kegel.com/c10k.html] document.
At higher levels the C++ slot/signal design pattern is used to propagate events
between objects (not to be confused with operating system signals). The
slot/signal implementation has been simplified compared to Qt or boost by not
supporting signal multicasting, so each signal connects to no more than one
slot.
slot. The implementation now uses std::function.
The synchronous slot/signal pattern needs some care when when the signalling
object gets destructed as a side-effect of raising a signal, and that situation
@ -90,11 +79,20 @@ The main C++ libraries in the E-MailRelay code base are as follows:
Implements various authentication mechanisms.
# "gsmtp"
SMTP protocol and message-store classes.
SMTP protocol classes.
# "gpop"
POP3 protocol classes.
# "gstore"
Message store classes.
# "gfilters"
Built-in filters.
# "gverifiers"
Built-in address verifiers.
All of these libraries are portable between Unix-like systems and Windows.
Under Windows there is an additional library under "src/win32" for the user
@ -122,14 +120,19 @@ pattern is used whereby the forwarding class uses an instance of the storage
class to do the message storing and filtering, while adding in an instance
of the "GSmtp::Client" class to do the forwarding.
Message filtering ("--filter") is implemented via an abstract "Filter"
interface. Concrete implementations are provided for doing nothing, running an
external executable program and talking to an external network server.
Message filtering ("--filter") is implemented via an abstract "GSmtp::Filter"
interface. Concrete implementations in the "GFilters" namespace are provided for
doing nothing, running an external executable program, talking to an external
network server, etc.
The protocol, processor and message-store interfaces are brought together by the
high-level "GSmtp::Server" and "GSmtp::Client" classes. Dependency injection is
used to create the concrete instances of the "ProtocolMessage" and "Filter"
interfaces.
Address verifiers ("--address-verifier") are implemented via an abstract
"GSmtp::Verifier" interface, with concrete implementations in the "GVerifiers"
namespace.
The protocol, processor and message-store interfaces are brought together by
the high-level "GSmtp::Server" and "GSmtp::Client" classes. Dependency
injection is used to create the concrete instances of the "MessageStore",
"Filter" and "Verifier" interfaces.
Event handling and exceptions
-----------------------------
@ -141,34 +144,36 @@ because it is not possible to put a single catch block around a particular
high-level feature.
The event loop delivers asynchronous socket events to the "EventHandler"
interface, timer events to the "TimerBase" interface, and 'future' events to the
"FutureEventCallback" interface. If any of the these event handlers throws an
exception then the event loop catches it and delivers it back to an exception
handler through the "onException()" method of an associated "ExceptionHandler"
interface. If an exception is thrown out of _this_ callback then the event loop
code lets it propagate back to "main()", typically terminating the program.
interface, timer events to the "TimerBase" interface, and 'future' events to
the "FutureEventCallback" interface. If any of the these event handlers throws
an exception then the event loop catches it and delivers it back to an
exception handler through the "onException()" method of an associated
"ExceptionHandler" interface. If an exception is thrown out of _this_ callback
then the event loop code lets it propagate back to "main()", typically
terminating the program.
However, sometimes there are objects that need to be more resilient to
exceptions. In particular, a network server should not terminate just because
one of its connections fails unexpectedly. In these cases the owning parent
object receives the exception notification together with a pointer that
identifies the child object that threw the exception (ie. the exception
source). This allows the parent object to absorb the exception and delete the
child, without the exception killing the whole server.
object receives the exception notification together with an "ExceptionSource"
pointer that identifies the child object that threw the exception. This allows
the parent object to absorb the exception and delete the child, without the
exception killing the whole server.
Event sources in the event loop are held as a file descriptor, a windows event
handle, an EventHandler pointer, an ExceptionHandler pointer and an
ExceptionSource pointer. The first two together are known as a Descriptor, and
the last two together are known as an ExceptionSink.
Event sources in the event loop are typically held as a file descriptor and a
windows event handle, together known as a "Descriptor". Event loop
implementations typically watch a set of Descriptors for events and call the
relevant EventHandler/ExceptionHandler code via the "EventEmitter" class.
Multi-threading
---------------
Multi-threading can be used as a build-time option to make DNS lookup and the
execution of helper programs asynchronous; if enabled then std::thread is
used in a future/promise pattern to wrap up "getaddrinfo()" and "waitpid()"
system calls. The shared state comprises only the parameters and return results
from these system calls, and synchronisation back to the main thread uses the
event loop (see "GNet::FutureEvent").
Multi-threading is used to make DNS lookup and external program asynchronous so
unless disabled at build-time std::thread is used in a future/promise pattern to
wrap up "getaddrinfo()" and "waitpid()" system calls. The shared state comprises
only the parameters and return results from these system calls, and
synchronisation back to the main thread uses the main event loop (see
"GNet::FutureEvent"). Threading is not used elsewhere so the C/C++ run-time
library does not need to be thread-safe.
E-MailRelay GUI
---------------
@ -196,21 +201,39 @@ When run in configure mode the GUI normally ends up simply editing the
When run in install mode the GUI expects to unpack all the E-MailRelay files
from the payload into target directories. The payload is a simple directory
tree that lives alongside the GUI exectuable or inside the Mac application
tree that lives alongside the GUI executable or inside the Mac application
bundle, and it contains a configuration file to tell the installer where
to copy its files.
When building the GUI program the library code shared with the main server
executable is compiled separately so that different GUI-specific compiler
options can be used. This is done as a 'unity build', concatenating the shared
code into one source file and compiling that for the GUI. (This technique
requires that private 'detail' namespaces are named rather than anonymous so
that there cannot be any name clashes within the combined anonymous namespace.)
Windows build
-------------
E-MailRelay can be compiled on Windows using Microsoft Visual Studio C++ (MSVC)
or mingw-w64. For MSVC builds there is a perl script ("winbuild.pl") that creates
"cmake" files from the autotools makefiles, runs "cmake" to create the MSVC
project files and then runs "msbuild" to compile E-MailRelay. If perl, cmake,
MSVC, Qt and mbedTLS source are installed in the right way then the
"winbuild.bat" batch file should be able to do a complete MSVC release build
in one go.
or mingw-w64.
For MinGW cross-builds use "./configure.sh -m" and "make" on a Linux box and
For MSVC builds there is a perl script ("winbuild.pl") that creates "cmake"
files from the autotools makefiles, runs "cmake" to create the MSVC project
files and then runs "msbuild" to compile E-MailRelay. If perl, cmake, MSVC, Qt
and mbedTLS source are installed in the right way then the "winbuild.bat" batch
file should be able to do a complete MSVC release build in one go. After that
the "winbuild-install.bat" batch file can be used to create a distribution.
When building for a public release the E-MailRelay setup program should be
statically linked and copied into the distribution created by "winbuild.pl".
This requires a static build of Qt: edit "msvc-desktop.conf" to use "/MT";
run "configure.bat" with "-static -release"; run "nmake -f Makefile" for
"release" then "install". Then build the E-MailRelay GUI using
"emailrelay-gui.pro": "qmake CONFIG+='win static' emailrelay-gui.pro";
then "mc messages.mc"; then copy "emailrelay-icon.ico"; and finally
"nmake -f Makefile.Release".
For MinGW cross-builds use "./configure.sh -w64" and "make" on a Linux box and
copy the built executables and the MinGW run-time to the target. Any extra
run-time files can be identified by running "dumpbin /dependents" in the normal
way.
@ -223,11 +246,12 @@ On Windows E-MailRelay is packaged as a zip file containing the executables
again, and while this duplication is not ideal it is at least straightforward.
The Qt tool "windeployqt" is used to add run-time dependencies, such as the
Qt DLLs.
platform DLL. (Public releases of Windows builds are normally statically linked,
so many of the DLLs added by "windeployqt" are not needed.)
To target ancient versions of Windows start with a cross-build using MinGW;
then "winbuild.pl mingw" can be used to assemble a slimmed-down package for
distribution.
To target ancient versions of Windows start with a cross-build using MinGW
for 32-bit ("./configure.sh -w32"); then "winbuild.pl mingw" can be used to
assemble a slimmed-down package for distribution.
Unix packaging
--------------
@ -246,10 +270,13 @@ from the "translations" sub-directory (relative to the executable), although
that can be overridden with the "--qm" command-line option. Qt's "-reverse"
option can also be used to reverse the widgets when using RTL languages.
The non-GUI code has minimal i18n support using gettext(), mostly for startup
error messages and usage help. This is disabled by default and requires a
configure-script option ("--with-gettext") to enable it at build-time and
a "--localedir" option at run-time. See also "po/Makefile.am".
The non-GUI code has some i18n support by using gettext() via the inline txt()
and tx() functions defined in "src/glib/ggettext.h". The configure script
detects gettext support in the C run-time library, but without trying different
compile and link options. See also "po/Makefile.am".
On Windows the main server executable has a tabbed dialog-box as its user
interface, but that does not have any support for i18n.
Source control
--------------
@ -275,4 +302,4 @@ Use "./configure --help" to see a complete list of options.
_____________________________________
Copyright (C) 2001-2022 Graeme Walker
Copyright (C) 2001-2023 Graeme Walker

2
doc/doxygen-missing.html
View File

@ -11,4 +11,4 @@
</div>
</body>
</html>
<!-- Copyright (C) 2001-2022 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->
<!-- Copyright (C) 2001-2023 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->

304
doc/doxygen.cfg.in
View File

@ -1,4 +1,4 @@
# Doxyfile 1.8.15
# Doxyfile 1.9.1
# This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project.
@ -197,6 +197,16 @@ SHORT_NAMES = NO
JAVADOC_AUTOBRIEF = YES
# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
# such as
# /***************
# as being the beginning of a Javadoc-style comment "banner". If set to NO, the
# Javadoc-style will behave just like regular comments and it will not be
# interpreted by doxygen.
# The default value is: NO.
JAVADOC_BANNER = NO
# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
# line (until the first dot) of a Qt-style comment as the brief description. If
# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
@ -217,6 +227,14 @@ QT_AUTOBRIEF = NO
MULTILINE_CPP_IS_BRIEF = NO
# By default Python docstrings are displayed as preformatted text and doxygen's
# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the
# doxygen's special commands can be used and the contents of the docstring
# documentation blocks is shown as doxygen documentation.
# The default value is: YES.
PYTHON_DOCSTRING = YES
# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
# documentation from any documented member that it re-implements.
# The default value is: YES.
@ -253,12 +271,6 @@ TAB_SIZE = 4
ALIASES =
# This tag can be used to specify a number of word-keyword mappings (TCL only).
# A mapping has the form "name=value". For example adding "class=itcl::class"
# will allow you to use the command class in the itcl::class meaning.
TCL_SUBST =
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
# only. Doxygen will then generate output that is more tailored for C. For
# instance, some of the names that are used will be different. The list of all
@ -299,19 +311,22 @@ OPTIMIZE_OUTPUT_SLICE = NO
# parses. With this tag you can assign which parser to use for a given
# extension. Doxygen has a built-in mapping, but you can override or extend it
# using this tag. The format is ext=language, where ext is a file extension, and
# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice,
# language is one of the parsers supported by doxygen: IDL, Java, JavaScript,
# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, VHDL,
# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
# tries to guess whether the code is fixed or free formatted code, this is the
# default for Fortran type files), VHDL, tcl. For instance to make doxygen treat
# .inc files as Fortran files (default is PHP), and .f files as C (default is
# Fortran), use: inc=Fortran f=C.
# default for Fortran type files). For instance to make doxygen treat .inc files
# as Fortran files (default is PHP), and .f files as C (default is Fortran),
# use: inc=Fortran f=C.
#
# Note: For files without extension you can use no_extension as a placeholder.
#
# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
# the files are not read by doxygen.
# the files are not read by doxygen. When specifying no_extension you should add
# * to the FILE_PATTERNS.
#
# Note see also the list of default file extension mappings.
EXTENSION_MAPPING =
@ -329,10 +344,10 @@ MARKDOWN_SUPPORT = YES
# to that level are automatically included in the table of contents, even if
# they do not have an id attribute.
# Note: This feature currently applies only to Markdown headings.
# Minimum value: 0, maximum value: 99, default value: 0.
# Minimum value: 0, maximum value: 99, default value: 5.
# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
TOC_INCLUDE_HEADINGS = 0
TOC_INCLUDE_HEADINGS = 5
# When enabled doxygen tries to link words that correspond to documented
# classes, or namespaces to their corresponding documentation. Such a link can
@ -445,6 +460,19 @@ TYPEDEF_HIDES_STRUCT = NO
LOOKUP_CACHE_SIZE = 0
# The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use
# during processing. When set to 0 doxygen will based this on the number of
# cores available in the system. You can set it explicitly to a value larger
# than 0 to get more control over the balance between CPU load and processing
# speed. At this moment only the input processing can be done using multiple
# threads. Since this is still an experimental feature the default is set to 1,
# which efficively disables parallel processing. Please report any issues you
# encounter. Generating dot graphs in parallel is controlled by the
# DOT_NUM_THREADS setting.
# Minimum value: 0, maximum value: 32, default value: 1.
NUM_PROC_THREADS = 1
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
@ -465,6 +493,12 @@ EXTRACT_ALL = NO
EXTRACT_PRIVATE = NO
# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
# methods of a class will be included in the documentation.
# The default value is: NO.
EXTRACT_PRIV_VIRTUAL = NO
# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
# scope will be included in the documentation.
# The default value is: NO.
@ -502,6 +536,13 @@ EXTRACT_LOCAL_METHODS = NO
EXTRACT_ANON_NSPACES = NO
# If this flag is set to YES, the name of an unnamed parameter in a declaration
# will be determined by the corresponding definition. By default unnamed
# parameters remain unnamed in the output.
# The default value is: YES.
RESOLVE_UNNAMED_PARAMS = YES
# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
# undocumented members inside documented classes or files. If set to NO these
# members will be included in the various overviews, but no documentation
@ -519,8 +560,8 @@ HIDE_UNDOC_MEMBERS = NO
HIDE_UNDOC_CLASSES = NO
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
# (class|struct|union) declarations. If set to NO, these declarations will be
# included in the documentation.
# declarations. If set to NO, these declarations will be included in the
# documentation.
# The default value is: NO.
HIDE_FRIEND_COMPOUNDS = NO
@ -539,11 +580,18 @@ HIDE_IN_BODY_DOCS = NO
INTERNAL_DOCS = NO
# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
# names in lower-case letters. If set to YES, upper-case letters are also
# allowed. This is useful if you have classes or files whose names only differ
# in case and if your file system supports case sensitive file names. Windows
# and Mac users are advised to set this option to NO.
# With the correct setting of option CASE_SENSE_NAMES doxygen will better be
# able to match the capabilities of the underlying filesystem. In case the
# filesystem is case sensitive (i.e. it supports files in the same directory
# whose names only differ in casing), the option must be set to YES to properly
# deal with such files in case they appear in the input. For filesystems that
# are not case sensitive the option should be be set to NO to properly deal with
# output files written for symbols that only differ in casing, such as for two
# classes, one named CLASS and the other named Class, and to also support
# references to files without having to specify the exact matching casing. On
# Windows (including Cygwin) and MacOS, users should typically set this option
# to NO, whereas on Linux or other Unix flavors it should typically be set to
# YES.
# The default value is: system dependent.
CASE_SENSE_NAMES = YES
@ -782,7 +830,10 @@ WARN_IF_DOC_ERROR = YES
WARN_NO_PARAMDOC = NO
# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
# a warning is encountered.
# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but
# at the end of the doxygen process doxygen will return with a non-zero status.
# Possible values are: NO, YES and FAIL_ON_WARNINGS.
# The default value is: NO.
WARN_AS_ERROR = NO
@ -813,13 +864,13 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.
INPUT = __TOP_SRC__/src/glib __TOP_SRC__/src/gssl __TOP_SRC__/src/gnet __TOP_SRC__/src/gauth __TOP_SRC__/src/gsmtp __TOP_SRC__/src/gpop __TOP_SRC__/src/main/doxygen.h
INPUT = __TOP_SRC__/src/glib __TOP_SRC__/src/gssl __TOP_SRC__/src/gnet __TOP_SRC__/src/gauth __TOP_SRC__/src/gverifiers __TOP_SRC__/src/gfilters __TOP_SRC__/src/gstore __TOP_SRC__/src/gsmtp __TOP_SRC__/src/gpop __TOP_SRC__/src/main/doxygen.h
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
# documentation (see: https://www.gnu.org/software/libiconv/) for the list of
# possible encodings.
# documentation (see:
# https://www.gnu.org/software/libiconv/) for the list of possible encodings.
# The default value is: UTF-8.
INPUT_ENCODING = UTF-8
@ -832,11 +883,15 @@ INPUT_ENCODING = UTF-8
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
# read by doxygen.
#
# Note the list of default checked file patterns might differ from the list of
# default file extension mappings.
#
# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice.
# *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment),
# *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, *.vhdl,
# *.ucf, *.qsf and *.ice.
FILE_PATTERNS = *.h *.cpp
@ -1050,6 +1105,44 @@ USE_HTAGS = NO
VERBATIM_HEADERS = YES
# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
# clang parser (see:
# http://clang.llvm.org/) for more accurate parsing at the cost of reduced
# performance. This can be particularly helpful with template rich C++ code for
# which doxygen's built-in parser lacks the necessary type information.
# Note: The availability of this option depends on whether or not doxygen was
# generated with the -Duse_libclang=ON option for CMake.
# The default value is: NO.
CLANG_ASSISTED_PARSING = NO
# If clang assisted parsing is enabled and the CLANG_ADD_INC_PATHS tag is set to
# YES then doxygen will add the directory of each input to the include path.
# The default value is: YES.
CLANG_ADD_INC_PATHS = YES
# If clang assisted parsing is enabled you can provide the compiler with command
# line options that you would normally use when invoking the compiler. Note that
# the include paths will already be set by doxygen for the files and directories
# specified with INPUT and INCLUDE_PATH.
# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
CLANG_OPTIONS =
# If clang assisted parsing is enabled you can provide the clang parser with the
# path to the directory containing a file called compile_commands.json. This
# file is the compilation database (see:
# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the
# options used when the source files were built. This is equivalent to
# specifying the -p option to a clang tool, such as clang-check. These options
# will then be passed to the parser. Any options specified with CLANG_OPTIONS
# will be added as well.
# Note: The availability of this option depends on whether or not doxygen was
# generated with the -Duse_libclang=ON option for CMake.
CLANG_DATABASE_PATH =
#---------------------------------------------------------------------------
# Configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
@ -1061,13 +1154,6 @@ VERBATIM_HEADERS = YES
ALPHABETICAL_INDEX = YES
# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
# which the alphabetical index list will be split.
# Minimum value: 1, maximum value: 20, default value: 5.
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
COLS_IN_ALPHA_INDEX = 5
# In case all classes in a project start with a common prefix, all classes will
# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
# can be used to specify a prefix (or a list of prefixes) that should be ignored
@ -1206,9 +1292,9 @@ HTML_TIMESTAMP = NO
# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
# documentation will contain a main index with vertical navigation menus that
# are dynamically created via Javascript. If disabled, the navigation index will
# are dynamically created via JavaScript. If disabled, the navigation index will
# consists of multiple levels of tabs that are statically embedded in every HTML
# page. Disable this option to support browsers that do not have Javascript,
# page. Disable this option to support browsers that do not have JavaScript,
# like the Qt help browser.
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.
@ -1238,10 +1324,11 @@ HTML_INDEX_NUM_ENTRIES = 100
# If the GENERATE_DOCSET tag is set to YES, additional index files will be
# generated that can be used as input for Apple's Xcode 3 integrated development
# environment (see: https://developer.apple.com/xcode/), introduced with OSX
# 10.5 (Leopard). To create a documentation set, doxygen will generate a
# Makefile in the HTML output directory. Running make will produce the docset in
# that directory and running make install will install the docset in
# environment (see:
# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To
# create a documentation set, doxygen will generate a Makefile in the HTML
# output directory. Running make will produce the docset in that directory and
# running make install will install the docset in
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy
# genXcode/_index.html for more information.
@ -1283,8 +1370,8 @@ DOCSET_PUBLISHER_NAME = Publisher
# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
# (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on
# Windows.
# (see:
# https://www.microsoft.com/en-us/download/details.aspx?id=21138) on Windows.
#
# The HTML Help Workshop contains a compiler that can convert all HTML output
# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
@ -1314,7 +1401,7 @@ CHM_FILE =
HHC_LOCATION =
# The GENERATE_CHI flag controls if a separate .chi index file is generated
# (YES) or that it should be included in the master .chm file (NO).
# (YES) or that it should be included in the main .chm file (NO).
# The default value is: NO.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
@ -1359,7 +1446,8 @@ QCH_FILE =
# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
# Project output. For more information please see Qt Help Project / Namespace
# (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
# (see:
# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
# The default value is: org.doxygen.Project.
# This tag requires that the tag GENERATE_QHP is set to YES.
@ -1367,8 +1455,8 @@ QHP_NAMESPACE = org.doxygen.Project
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
# Help Project output. For more information please see Qt Help Project / Virtual
# Folders (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-
# folders).
# Folders (see:
# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders).
# The default value is: doc.
# This tag requires that the tag GENERATE_QHP is set to YES.
@ -1376,30 +1464,30 @@ QHP_VIRTUAL_FOLDER = doc
# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
# filter to add. For more information please see Qt Help Project / Custom
# Filters (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-
# filters).
# Filters (see:
# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_CUST_FILTER_NAME =
# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
# custom filter to add. For more information please see Qt Help Project / Custom
# Filters (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-
# filters).
# Filters (see:
# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_CUST_FILTER_ATTRS =
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
# project's filter section matches. Qt Help Project / Filter Attributes (see:
# http://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_SECT_FILTER_ATTRS =
# The QHG_LOCATION tag can be used to specify the location of Qt's
# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
# generated .qhp file.
# The QHG_LOCATION tag can be used to specify the location (absolute path
# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to
# run qhelpgenerator on the generated .qhp file.
# This tag requires that the tag GENERATE_QHP is set to YES.
QHG_LOCATION =
@ -1476,6 +1564,17 @@ TREEVIEW_WIDTH = 100
EXT_LINKS_IN_WINDOW = NO
# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg
# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see
# https://inkscape.org) to generate formulas as SVG images instead of PNGs for
# the HTML output. These images will generally look nicer at scaled resolutions.
# Possible values are: png (the default) and svg (looks nicer but requires the
# pdf2svg or inkscape tool).
# The default value is: png.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_FORMULA_FORMAT = png
# Use this tag to change the font size of LaTeX formulas included as images in
# the HTML documentation. When you change the font size after a successful
# doxygen run you need to manually remove any form_*.png images from the HTML
@ -1496,8 +1595,14 @@ FORMULA_FONTSIZE = 10
FORMULA_TRANSPARENT = YES
# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands
# to create new LaTeX commands to be used in formulas as building blocks. See
# the section "Including formulas" for details.
FORMULA_MACROFILE =
# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
# https://www.mathjax.org) which uses client side Javascript for the rendering
# https://www.mathjax.org) which uses client side JavaScript for the rendering
# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
# installed or if you want to formulas look prettier in the HTML output. When
# enabled you may also need to install MathJax separately and configure the path
@ -1509,7 +1614,7 @@ USE_MATHJAX = NO
# When MathJax is enabled you can set the default output format to be used for
# the MathJax output. See the MathJax site (see:
# http://docs.mathjax.org/en/latest/output.html) for more details.
# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details.
# Possible values are: HTML-CSS (which is slower, but has the best
# compatibility), NativeMML (i.e. MathML) and SVG.
# The default value is: HTML-CSS.
@ -1525,10 +1630,10 @@ MATHJAX_FORMAT = HTML-CSS
# Content Delivery Network so you can quickly see the result without installing
# MathJax. However, it is strongly recommended to install a local copy of
# MathJax from https://www.mathjax.org before deployment.
# The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/.
# The default value is: https://cdn.jsdelivr.net/npm/mathjax@2.
# This tag requires that the tag USE_MATHJAX is set to YES.
MATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/
MATHJAX_RELPATH = https://cdn.jsdelivr.net/npm/mathjax@2
# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
# extension names that should be enabled during MathJax rendering. For example
@ -1539,7 +1644,8 @@ MATHJAX_EXTENSIONS =
# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
# of code that will be used on startup of the MathJax code. See the MathJax site
# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
# (see:
# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an
# example see the documentation.
# This tag requires that the tag USE_MATHJAX is set to YES.
@ -1567,7 +1673,7 @@ MATHJAX_CODEFILE =
SEARCHENGINE = YES
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
# implemented using a web server instead of a web client using Javascript. There
# implemented using a web server instead of a web client using JavaScript. There
# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
# setting. When disabled, doxygen will generate a PHP script for searching and
# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
@ -1586,7 +1692,8 @@ SERVER_BASED_SEARCH = NO
#
# Doxygen ships with an example indexer (doxyindexer) and search engine
# (doxysearch.cgi) which are based on the open source search engine library
# Xapian (see: https://xapian.org/).
# Xapian (see:
# https://xapian.org/).
#
# See the section "External Indexing and Searching" for details.
# The default value is: NO.
@ -1599,8 +1706,9 @@ EXTERNAL_SEARCH = NO
#
# Doxygen ships with an example indexer (doxyindexer) and search engine
# (doxysearch.cgi) which are based on the open source search engine library
# Xapian (see: https://xapian.org/). See the section "External Indexing and
# Searching" for details.
# Xapian (see:
# https://xapian.org/). See the section "External Indexing and Searching" for
# details.
# This tag requires that the tag SEARCHENGINE is set to YES.
SEARCHENGINE_URL =
@ -1671,13 +1779,14 @@ LATEX_CMD_NAME =
MAKEINDEX_CMD_NAME = makeindex
# The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
# generate index for LaTeX.
# generate index for LaTeX. In case there is no backslash (\) as first character
# it will be automatically added in the LaTeX code.
# Note: This tag is used in the generated output file (.tex).
# See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
# The default value is: \makeindex.
# The default value is: makeindex.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_MAKEINDEX_CMD = \makeindex
LATEX_MAKEINDEX_CMD = makeindex
# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
# documents. This may be useful for small projects and may help to save some
@ -1763,9 +1872,11 @@ LATEX_EXTRA_FILES =
PDF_HYPERLINKS = YES
# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
# the PDF file directly from the LaTeX files. Set this option to YES, to get a
# higher quality PDF documentation.
# If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as
# specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX
# files. Set this option to YES, to get a higher quality PDF documentation.
#
# See also section LATEX_CMD_NAME for selecting the engine.
# The default value is: YES.
# This tag requires that the tag GENERATE_LATEX is set to YES.
@ -2166,12 +2277,6 @@ EXTERNAL_GROUPS = YES
EXTERNAL_PAGES = YES
# The PERL_PATH should be the absolute path and name of the perl script
# interpreter (i.e. the result of 'which perl').
# The default file (with absolute path) is: /usr/bin/perl.
PERL_PATH = /usr/bin/perl
#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
@ -2185,15 +2290,6 @@ PERL_PATH = /usr/bin/perl
CLASS_DIAGRAMS = YES
# You can define message sequence charts within doxygen comments using the \msc
# command. Doxygen will then run the mscgen tool (see:
# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
# documentation. The MSCGEN_PATH tag allows you to specify the directory where
# the mscgen tool resides. If left empty the tool is assumed to be found in the
# default search path.
MSCGEN_PATH =
# You can include diagrams made with dia in doxygen documentation. Doxygen will
# then run dia to produce the diagram and insert it in the documentation. The
# DIA_PATH tag allows you to specify the directory where the dia binary resides.
@ -2212,9 +2308,9 @@ HIDE_UNDOC_RELATIONS = YES
# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
# Bell Labs. The other options in this section have no effect if this option is
# set to NO
# The default value is: NO.
# The default value is: YES.
HAVE_DOT = NO
HAVE_DOT = YES
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
# to run in parallel. When set to 0 doxygen will base this on the number of
@ -2291,10 +2387,32 @@ UML_LOOK = NO
# but if the number exceeds 15, the total amount of fields shown is limited to
# 10.
# Minimum value: 0, maximum value: 100, default value: 10.
# This tag requires that the tag HAVE_DOT is set to YES.
# This tag requires that the tag UML_LOOK is set to YES.
UML_LIMIT_NUM_FIELDS = 10
# If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and
# methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS
# tag is set to YES, doxygen will add type and arguments for attributes and
# methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen
# will not generate fields with class member information in the UML graphs. The
# class diagrams will look similar to the default class diagrams but using UML
# notation for the relationships.
# Possible values are: NO, YES and NONE.
# The default value is: NO.
# This tag requires that the tag UML_LOOK is set to YES.
DOT_UML_DETAILS = NO
# The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters
# to display on a single line. If the actual line length exceeds this threshold
# significantly it will wrapped across multiple lines. Some heuristics are apply
# to avoid ugly line breaks.
# Minimum value: 0, maximum value: 1000, default value: 17.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_WRAP_THRESHOLD = 17
# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
# collaboration graphs will show the relations between templates and their
# instances.
@ -2368,7 +2486,9 @@ DIRECTORY_GRAPH = YES
# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
# to make the SVG files visible in IE 9+ (other browsers do not have this
# requirement).
# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,
# Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
# png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
# gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd, png:cairo,
# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
# png:gdiplus:gdiplus.
# The default value is: png.
@ -2484,9 +2604,11 @@ DOT_MULTI_TARGETS = NO
GENERATE_LEGEND = YES
# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate
# files that are used to generate the various graphs.
#
# Note: This setting is not only used for dot files but also for msc and
# plantuml temporary files.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_CLEANUP = YES

22
doc/emailrelay-doxygen.css
View File

@ -1,5 +1,5 @@
/*
Copyright (C) 2001-2022 Graeme Walker <graeme_walker@users.sourceforge.net>
Copyright (C) 2001-2023 Graeme Walker <graeme_walker@users.sourceforge.net>
*/
/*
@ -36,6 +36,26 @@ pre.fragment
{
}
pre.fragment a
{
color: black ;
}
pre.fragment a:visited
{
color: black ;
}
a.option
{
color: black ;
}
a.option:visited
{
color: black ;
}
code
{
/* font-weight: bold ; */

57
doc/emailrelay-filter-copy.1
View File

@ -1,57 +0,0 @@
.\" Copyright (C) 2001-2022 Graeme Walker <graeme_walker@users.sourceforge.net>
.\"
.\" This program is free software: you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation, either version 3 of the License, or
.\" (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program. If not, see <http://www.gnu.org/licenses/>.
.TH EMAILRELAY-FILTER-COPY 1 local
.SH NAME
emailrelay-filter-copy \- an emailrelay filter program for pop-by-name
.SH SYNOPSIS
.B emailrelay-filter-copy
.I <emailrelay-content-file>
.LP
.B emailrelay-filter-copy
-d
.I <spool-directory>
.LP
.B emailrelay-filter-copy
[--help]
.SH DESCRIPTION
The
.I emailrelay-filter-copy
utility can be used as an
.B E-MailRelay
.I "--filter"
program to copy e-mail messages from the main spool directory into
all available sub-directories. When using the
.I "--pop-by-name"
feature of the
.B E-MailRelay
server this results in messages being copied to all POP clients.
.LP
Only the message envelope is copied; the content file stays in
the main directory. If the envelope is successfully copied to
one or more sub-directories then it is removed from the main
spool directory and it will therefore not be available for SMTP
forwarding.
.LP
When using
.I "-d"
all envelope files in the spool directory are copied to all
sub-directories. This can be used after
.B emailrelay-submit
has deposited an envelope file into the main spool
directory, or perhaps periodically from cron.
.SH SEE ALSO
.BR emailrelay (1),
.SH AUTHOR
Graeme Walker, mailto:graeme_walker@users.sourceforge.net

40
doc/emailrelay-man.html
View File

@ -99,6 +99,10 @@ Displays version information and then exits.
<H3>SMTP client options</H3>
<DL COMPACT>
<DT><B>-c, --client-smtp-config </B><I>&lt;config&gt;</I>
<DD>
Configures the SMTP client protocol using a comma-separated list of optional features, including 'pipelining', 'smtputf8strict', 'eightbitstrict' and 'binarymimestrict'.
<DT><B>-f, --forward</B>
<DD>
@ -135,6 +139,10 @@ Specifies a timeout (in seconds) for receiving network traffic from remote SMTP
<DD>
Specifies a timeout (in seconds) for getting responses from remote SMTP servers. The default is 60 seconds.
<DT><B>--forward-to-all</B>
<DD>
Requires all recipient addresses to be accepted by the remote server before forwarding. This is currently the default behaviour so this option is for forwards compatibility only.
<DT><B>--forward-to-some</B>
<DD>
@ -159,11 +167,15 @@ Allows incoming connections from addresses that are not local. The default behav
<DT><B>--address-verifier </B><I>&lt;program&gt;</I>
<DD>
Runs the specified external program to verify a message recipent's e-mail address. A network verifier can be specified as <I>net:&lt;tcp-address&gt;</I>.
Runs the specified external program to verify a message recipient's e-mail address. A network verifier can be specified as <I>net:&lt;tcp-address&gt;</I>. The <I>account:</I> built-in address verifier can be used to check recipient addresses against the list of local system account names.
<DT><B>-A, --anonymous, --anonymous=</B><I>&lt;scope&gt;</I>
<DD>
Disables the server's SMTP VRFY command, sends less verbose SMTP greeting and responses, stops <I>Received</I> lines being added to mail message content files, and stops the SMTP client protocol adding <I>AUTH=</I> to the <I>MAIL</I> command. For finer control use a comma-separated list of things to anonymise: <I>vrfy</I>, <I>server</I>, <I>content</I> and/or <I>client</I>, eg. <I>--anonymous</I>=server,content.
<DT><B>-s, --delivery-dir </B><I>&lt;dir&gt;</I>
<DD>
Specifies the base directory for mailboxes when delivering messages that have local recipients. This defaults to the main spool directory.
<DT><B>--dnsbl </B><I>&lt;config&gt;</I>
<DD>
@ -183,11 +195,15 @@ Specifies a timeout (in seconds) for running a <I>--filter</I> program. The defa
<DT><B>-I, --interface </B><I>&lt;ip-address-list&gt;</I>
<DD>
Specifies the IP network addresses or interface names used to bind listening ports. By default listening ports for incoming SMTP, POP and administration connections will bind the 'any' address for IPv4 and for IPv6, ie. <I>0.0.0.0</I> and <I>::</I>. Multiple addresses can be specified by using the option more than once or by using a comma-separated list. Use a prefix of <I>smtp=</I>, <I>pop=</I> or <I>admin=</I> on addresses that should apply only to those types of listening port. Any link-local IPv6 addresses must include a zone name or scope id. Interface names can be used instead of addresses, in which case all the addresses associated with that interface at startup will used for listening. When an interface name is decorated with a <I>-ipv4</I> or <I>-ipv6</I> suffix only their IPv4 or IPv6 addresses will be used (eg. <I>ppp0-ipv4</I>). To inherit listening file descriptors from the parent process on unix use a syntax like this: <I>--interface</I>=smtp=fd#3,smtp=fd#4,pop=fd#5.
Specifies the IP network addresses or interface names used to bind listening ports. By default listening ports for incoming SMTP, POP and administration connections will bind the 'any' address for IPv4 and for IPv6, ie. <I>0.0.0.0</I> and <I>::</I>. Multiple addresses can be specified by using the option more than once or by using a comma-separated list. Use a prefix of <I>smtp=</I>, <I>pop=</I> or <I>admin=</I> on addresses that should apply only to those types of listening port. Any link-local IPv6 addresses must include a zone name or scope id. Interface names can be used instead of addresses, in which case all the addresses associated with that interface at startup will used for listening. When an interface name is decorated with a <I>-ipv4</I> or <I>-ipv6</I> suffix only their IPv4 or IPv6 addresses will be used (eg. <I>ppp0-ipv4</I>). To inherit listening file descriptors from the parent process on unix use a syntax like this: <I>--interface</I> smtp=fd#3,smtp=fd#4,pop=fd#5.
<DT><B>-w, --prompt-timeout </B><I>&lt;time&gt;</I>
<DD>
Specifies a timeout (in seconds) for getting the initial prompt from a remote SMTP server. If no prompt is received after this time then the SMTP dialog goes ahead without it.
<DT><B>-Z, --server-smtp-config </B><I>&lt;config&gt;</I>
<DD>
Configures the SMTP server protocol using a comma-separated list of optional features, including 'pipelining', 'chunking', 'smtputf8', and 'smtputf8strict'.
<DT><B>-M, --size </B><I>&lt;bytes&gt;</I>
<DD>
@ -204,7 +220,7 @@ Enables the POP server, listening by default on port 110, providing access to sp
<DT><B>-J, --pop-by-name</B>
<DD>
Modifies the spool directory used by the POP server to be a sub-directory with the same name as the POP authentication user-id. This allows multiple POP clients to read the spooled mail messages without interfering with each other, particularly when also using <I>--pop-no-delete</I>. Content files can stay in the main spool directory with only the envelope files copied into user-specific sub-directories. The <I>emailrelay-filter-copy</I> program is a convenient way of doing this when run via <I>--filter</I>.
Modifies the POP server's spool directory to be the sub-directory with the same name as the user-id used for POP authentication. This allows POP clients to see only their own messages after they have been moved into separate sub-directories typically by the built-in <I>deliver:</I> or <I>copy:</I> filters. Content files can remain in the main spool directory to save disk space; they will be deleted by the POP server when it deletes the last matching envelope file.
<DT><B>-G, --pop-no-delete</B>
<DD>
@ -234,7 +250,7 @@ Enables the <I>terminate</I> command in the administration interface.
<DT><B>-C, --client-auth </B><I>&lt;file&gt;</I>
<DD>
Enables SMTP client authentication with the remote server, using the client account details taken from the specified secrets file. The secrets file should normally contain one line that starts with <I>client</I> and that line should have between four and five space-separated fields; the second field is the password encoding (<I>plain</I> or <I>md5</I>), the third is the user-id and the fourth is the password. The user-id is RFC-1891 xtext encoded, and the password is either xtext encoded or generated by <I>emailrelay-passwd</I>. If the remote server does not support SMTP authentication then the SMTP connection will fail.
Enables SMTP client authentication with the remote server, using the client account details taken from the specified secrets file. The secrets file should normally contain one line having between four and five space-separated fields. The first field must be <I>client</I>, the second field is the password type (<I>plain</I> or <I>md5</I>), the third is the xtext-encoded user-id and the fourth is the xtext-encoded password. Alternatively, the user-id and password fields can be Base64 encoded if the second field is <I>plain:b</I>. It is also possible to do without a secrets file and give the Base64 encoded user-id and password directly on the command-line or in the configuration file formatted as <I>plain:&lt;base64-user-id&gt;:&lt;base64-password&gt;</I>. Note that putting these account details on the command-line is not recommended because it will make the password easily visible to all users on the local machine.
<DT><B>--client-auth-config </B><I>&lt;config&gt;</I>
<DD>
@ -242,7 +258,7 @@ Configures the SMTP client authentication module using a semicolon-separated lis
<DT><B>-S, --server-auth </B><I>&lt;file&gt;</I>
<DD>
Enables SMTP server authentication of remote SMTP clients. Account names and passwords are taken from the specified secrets file. The secrets file should contain lines that have four space-separated fields, starting with <I>server</I> in the first field; the second field is the password encoding (<I>plain</I> or <I>md5</I>), the third is the client user-id and the fourth is the password. The user-id is RFC-1891 xtext encoded, and the password is either xtext encoded or generated by <I>emailrelay-passwd</I>. A special value of <I>/pam</I> can be used for authentication using linux PAM.
Enables SMTP server authentication of remote SMTP clients. Account names and passwords are taken from the specified secrets file. The secrets file should contain lines that have four space-separated fields, starting with <I>server</I> in the first field; the second field is the password encoding (<I>plain</I> or <I>md5</I>), the third is the client user-id and the fourth is the password. The user-id is RFC-1891 xtext encoded, and the password is either xtext encoded or generated by <I>emailrelay-passwd</I>. Alternatively, the username and password can be Base64 encoded if the second field is <I>plain:b</I>. A special value of <I>pam:</I> can be used for authentication using linux PAM.
<DT><B>--server-auth-config </B><I>&lt;config&gt;</I>
<DD>
@ -250,7 +266,7 @@ Configures the SMTP server authentication module using a semicolon-separated lis
<DT><B>-F, --pop-auth </B><I>&lt;file&gt;</I>
<DD>
Specifies a file containing valid POP account details. The file format is the same as for the SMTP server secrets file, ie. lines starting with <I>server</I>, with user-id and password in the third and fourth fields. A special value of <I>/pam</I> can be used for authentication using linux PAM.
Specifies a file containing valid POP account details. The file format is the same as for the SMTP server secrets file, ie. lines starting with <I>server</I>, with user-id and password in the third and fourth fields. A special value of <I>pam:</I> can be used for authentication using linux PAM.
</DL>
<A NAME="lbAL">&nbsp;</A>
<H3>TLS options</H3>
@ -279,7 +295,7 @@ Defines the target server hostname in the TLS handshake. With <I>--client-tls-co
<DT><B>--client-tls-verify </B><I>&lt;ca-list&gt;</I>
<DD>
Enables verification of the remote SMTP server's certificate against any of the trusted CA certificates in the specified file or directory. In many use cases this should be a file containing just your self-signed root certificate. Specify <I>&lt;default&gt;</I> for the TLS library's default set of trusted CAs.
Enables verification of the remote SMTP server's certificate against any of the trusted CA certificates in the specified file or directory. In many use cases this should be a file containing just your self-signed root certificate. Specify <I>&lt;default&gt;</I> (including the angle brackets) for the TLS library's default set of trusted CAs.
<DT><B>--client-tls-verify-name </B><I>&lt;cname&gt;</I>
<DD>
@ -291,7 +307,7 @@ Enables TLS for incoming SMTP and POP connections. SMTP clients can then request
<DT><B>--server-tls-certificate </B><I>&lt;pem-file&gt;</I>
<DD>
Defines the TLS certificate file when acting as a SMTP or POP server. This file must contain the server's private key and certificate chain using the PEM file format. Alternatively, use this option twice with the first one specifying the key file and the second the certificate file. Keep the file permissions tight to avoid accidental exposure of the private key.
Defines the TLS certificate file when acting as a SMTP or POP server. This file must contain the server's private key and certificate chain using the PEM file format. Alternatively, use this option twice with the first specifying the key file and the second the certificate file. Keep the file permissions tight to avoid accidental exposure of the private key.
<DT><B>--server-tls-connection</B>
<DD>
@ -303,7 +319,7 @@ Makes the use of TLS mandatory for any incoming SMTP and POP connections. SMTP c
<DT><B>--server-tls-verify </B><I>&lt;ca-list&gt;</I>
<DD>
Enables verification of remote SMTP and POP clients' certificates against any of the trusted CA certificates in the specified file or directory. In many use cases this should be a file containing just your self-signed root certificate. Specify <I>&lt;default&gt;</I> for the TLS library's default set of trusted CAs.
Enables verification of remote SMTP and POP clients' certificates against any of the trusted CA certificates in the specified file or directory. In many use cases this should be a file containing just your self-signed root certificate. Specify <I>&lt;default&gt;</I> (including the angle brackets) for the TLS library's default set of trusted CAs.
<DT><B>-9, --tls-config </B><I>&lt;options&gt;</I>
<DD>
@ -340,7 +356,7 @@ Causes the process-id to be written into the specified file when the program sta
<DT><B>-u, --user </B><I>&lt;username&gt;</I>
<DD>
When started as root the program switches to a non-privileged effective user-id when idle. This option can be used to define the idle user-id and also the group ownership of new files and sockets. Specify <I>root</I> to disable all user-id switching. Ignored on Windows.
When started as root the program switches to a non-privileged effective user-id when idle or when running external filter scripts and address verifiers. This option can be used to define the non-privileged user-id. It also determines the group ownership of new files and sockets if the directory owner is not 'sticky'. Specify <I>root</I> to disable all user-id switching. Ignored on Windows.
</DL>
<A NAME="lbAN">&nbsp;</A>
<H3>Logging options</H3>
@ -357,7 +373,7 @@ Enables logging to the standard error stream and to the syslog. The <I>--close-s
<DT><B>-g, --debug</B>
<DD>
Enables debug level logging, if built in. Debug messages are usually only useful when cross-referenced with the source code and they may expose plaintext passwords and mail message content.
Enables debug level logging, if built in. Debug messages are usually only useful when cross-referenced with the source code and they may expose plain-text passwords and mail message content.
<DT><B>--log-address</B>
<DD>
@ -423,4 +439,4 @@ This document was created by
using the manual pages.<BR>
</BODY>
</HTML>
<!-- Copyright (C) 2001-2022 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->
<!-- Copyright (C) 2001-2023 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->

4
doc/emailrelay-passwd.1
View File

@ -1,4 +1,4 @@
.\" Copyright (C) 2001-2022 Graeme Walker <graeme_walker@users.sourceforge.net>
.\" Copyright (C) 2001-2023 Graeme Walker <graeme_walker@users.sourceforge.net>
.\"
.\" This program is free software: you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
@ -47,7 +47,7 @@ Specifies the hash function, such as MD5 or SHA1. MD5 is the default, and a hash
Shows help text and exits.
.TP
.B \-b, --base64
The input password is interpreted as being base-64 encoded.
The input password is interpreted as being Base64 encoded.
.TP
.B \-d, --dotted
Generates a dotted decimal format, for backwards compatibility.

5
doc/emailrelay-submit.1
View File

@ -1,4 +1,4 @@
.\" Copyright (C) 2001-2022 Graeme Walker <graeme_walker@users.sourceforge.net>
.\" Copyright (C) 2001-2023 Graeme Walker <graeme_walker@users.sourceforge.net>
.\"
.\" This program is free software: you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
@ -53,6 +53,9 @@ Adds a \fIDate:\fR content header if there is none.
.B \-F, --content-from
Adds the envelope 'from' addresses as a \fIFrom:\fR content header.
.TP
.B \-I, --content-message-id \fI<domain-part>\fR
Adds a \fIMessage-ID:\fR content header if there is none.
.TP
.B \-t, --content-to
Adds the envelope 'to' addresses as \fITo:\fR content headers.
.TP

38
doc/emailrelay.1
View File

@ -1,4 +1,4 @@
.\" Copyright (C) 2001-2022 Graeme Walker <graeme_walker@users.sourceforge.net>
.\" Copyright (C) 2001-2023 Graeme Walker <graeme_walker@users.sourceforge.net>
.\"
.\" This program is free software: you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
@ -72,6 +72,9 @@ Displays help text and then exits. Use with \fI--verbose\fR for more complete ou
Displays version information and then exits.
.SS SMTP client options
.TP
.B \-c, --client-smtp-config \fI<config>\fR
Configures the SMTP client protocol using a comma-separated list of optional features, including 'pipelining', 'smtputf8strict', 'eightbitstrict' and 'binarymimestrict'.
.TP
.B \-f, --forward
Causes spooled mail messages to be forwarded when the program first starts.
.TP
@ -99,6 +102,9 @@ Specifies a timeout (in seconds) for receiving network traffic from remote SMTP
.B \-T, --response-timeout \fI<time>\fR
Specifies a timeout (in seconds) for getting responses from remote SMTP servers. The default is 60 seconds.
.TP
.B --forward-to-all
Requires all recipient addresses to be accepted by the remote server before forwarding. This is currently the default behaviour so this option is for forwards compatibility only.
.TP
.B --forward-to-some
Allow forwarding to continue even if some recipient addresses on an e-mail envelope are rejected by the remote server.
.TP
@ -113,10 +119,13 @@ Sets the port number used for listening for incoming SMTP connections.
Allows incoming connections from addresses that are not local. The default behaviour is to reject connections that are not local in order to prevent accidental exposure to the public internet, although a firewall should also be used. Local address ranges are defined in RFC-1918, RFC-6890 etc.
.TP
.B --address-verifier \fI<program>\fR
Runs the specified external program to verify a message recipent's e-mail address. A network verifier can be specified as \fInet:<tcp-address>\fR.
Runs the specified external program to verify a message recipient's e-mail address. A network verifier can be specified as \fInet:<tcp-address>\fR. The \fIaccount:\fR built-in address verifier can be used to check recipient addresses against the list of local system account names.
.TP
.B \-A, --anonymous, --anonymous=\fI<scope>\fR
Disables the server's SMTP VRFY command, sends less verbose SMTP greeting and responses, stops \fIReceived\fR lines being added to mail message content files, and stops the SMTP client protocol adding \fIAUTH=\fR to the \fIMAIL\fR command. For finer control use a comma-separated list of things to anonymise: \fIvrfy\fR, \fIserver\fR, \fIcontent\fR and/or \fIclient\fR, eg. \fI--anonymous\fR=server,content.
Disables the server's SMTP VRFY command, sends less verbose SMTP greeting and responses, stops \fIReceived\fR lines being added to mail message content files, and stops the SMTP client protocol adding \fIAUTH=\fR to the \fIMAIL\fR command. For finer control use a comma-separated list of things to anonymise: \fIvrfy\fR, \fIserver\fR, \fIcontent\fR and/or \fIclient\fR, eg. \fI--anonymous\fR=server\fR,content.
.TP
.B \-s, --delivery-dir \fI<dir>\fR
Specifies the base directory for mailboxes when delivering messages that have local recipients. This defaults to the main spool directory.
.TP
.B --dnsbl \fI<config>\fR
Specifies a list of DNSBL servers that are used to reject SMTP connections from blocked addresses. The configuration string is made up of comma-separated fields: the DNS server's transport address, a timeout in milliseconds, a rejection threshold, and then the list of DNSBL servers.
@ -131,11 +140,14 @@ Runs the specified external filter program whenever a mail message is stored. Th
Specifies a timeout (in seconds) for running a \fI--filter\fR program. The default is 60 seconds.
.TP
.B \-I, --interface \fI<ip-address-list>\fR
Specifies the IP network addresses or interface names used to bind listening ports. By default listening ports for incoming SMTP, POP and administration connections will bind the 'any' address for IPv4 and for IPv6, ie. \fI0.0.0.0\fR and \fI::\fR. Multiple addresses can be specified by using the option more than once or by using a comma-separated list. Use a prefix of \fIsmtp=\fR, \fIpop=\fR or \fIadmin=\fR on addresses that should apply only to those types of listening port. Any link-local IPv6 addresses must include a zone name or scope id. Interface names can be used instead of addresses, in which case all the addresses associated with that interface at startup will used for listening. When an interface name is decorated with a \fI-ipv4\fR or \fI-ipv6\fR suffix only their IPv4 or IPv6 addresses will be used (eg. \fIppp0-ipv4\fR). To inherit listening file descriptors from the parent process on unix use a syntax like this: \fI--interface\fR=smtp=fd#3,smtp=fd#4,pop=fd#5.
Specifies the IP network addresses or interface names used to bind listening ports. By default listening ports for incoming SMTP, POP and administration connections will bind the 'any' address for IPv4 and for IPv6, ie. \fI0.0.0.0\fR and \fI::\fR. Multiple addresses can be specified by using the option more than once or by using a comma-separated list. Use a prefix of \fIsmtp=\fR, \fIpop=\fR or \fIadmin=\fR on addresses that should apply only to those types of listening port. Any link-local IPv6 addresses must include a zone name or scope id. Interface names can be used instead of addresses, in which case all the addresses associated with that interface at startup will used for listening. When an interface name is decorated with a \fI-ipv4\fR or \fI-ipv6\fR suffix only their IPv4 or IPv6 addresses will be used (eg. \fIppp0-ipv4\fR). To inherit listening file descriptors from the parent process on unix use a syntax like this: \fI--interface\fR smtp=fd#3,smtp=fd#4,pop=fd#5.
.TP
.B \-w, --prompt-timeout \fI<time>\fR
Specifies a timeout (in seconds) for getting the initial prompt from a remote SMTP server. If no prompt is received after this time then the SMTP dialog goes ahead without it.
.TP
.B \-Z, --server-smtp-config \fI<config>\fR
Configures the SMTP server protocol using a comma-separated list of optional features, including 'pipelining', 'chunking', 'smtputf8', and 'smtputf8strict'.
.TP
.B \-M, --size \fI<bytes>\fR
Limits the size of mail messages that can be submitted over SMTP.
.SS POP server options
@ -144,7 +156,7 @@ Limits the size of mail messages that can be submitted over SMTP.
Enables the POP server, listening by default on port 110, providing access to spooled mail messages. Negotiated TLS using the POP \fISTLS\fR command will be enabled if the \fI--server-tls\fR option is also given.
.TP
.B \-J, --pop-by-name
Modifies the spool directory used by the POP server to be a sub-directory with the same name as the POP authentication user-id. This allows multiple POP clients to read the spooled mail messages without interfering with each other, particularly when also using \fI--pop-no-delete\fR. Content files can stay in the main spool directory with only the envelope files copied into user-specific sub-directories. The \fIemailrelay-filter-copy\fR program is a convenient way of doing this when run via \fI--filter\fR.
Modifies the POP server's spool directory to be the sub-directory with the same name as the user-id used for POP authentication. This allows POP clients to see only their own messages after they have been moved into separate sub-directories typically by the built-in \fIdeliver:\fR or \fIcopy:\fR filters. Content files can remain in the main spool directory to save disk space; they will be deleted by the POP server when it deletes the last matching envelope file.
.TP
.B \-G, --pop-no-delete
Disables the POP DELE command so that the command appears to succeed but mail messages are not deleted from the spool directory.
@ -161,19 +173,19 @@ Enables the \fIterminate\fR command in the administration interface.
.SS Authentication options
.TP
.B \-C, --client-auth \fI<file>\fR
Enables SMTP client authentication with the remote server, using the client account details taken from the specified secrets file. The secrets file should normally contain one line that starts with \fIclient\fR and that line should have between four and five space-separated fields; the second field is the password encoding (\fIplain\fR or \fImd5\fR), the third is the user-id and the fourth is the password. The user-id is RFC-1891 xtext encoded, and the password is either xtext encoded or generated by \fIemailrelay-passwd\fR. If the remote server does not support SMTP authentication then the SMTP connection will fail.
Enables SMTP client authentication with the remote server, using the client account details taken from the specified secrets file. The secrets file should normally contain one line having between four and five space-separated fields. The first field must be \fIclient\fR, the second field is the password type (\fIplain\fR or \fImd5\fR), the third is the xtext-encoded user-id and the fourth is the xtext-encoded password. Alternatively, the user-id and password fields can be Base64 encoded if the second field is \fIplain:b\fR. It is also possible to do without a secrets file and give the Base64 encoded user-id and password directly on the command-line or in the configuration file formatted as \fIplain:<base64-user-id>:<base64-password>\fR. Note that putting these account details on the command-line is not recommended because it will make the password easily visible to all users on the local machine.
.TP
.B --client-auth-config \fI<config>\fR
Configures the SMTP client authentication module using a semicolon-separated list of configuration items. Each item is a single-character key, followed by a colon and then a comma-separated list. A 'm' character introduces an ordered list of preferred authentication mechanisms and an 'x' introduces a list of mechanisms to avoid. An 'a' list and a 'd' list can be used similarly to prefer and avoid certain mechanisms once the session is encrypted with TLS.
.TP
.B \-S, --server-auth \fI<file>\fR
Enables SMTP server authentication of remote SMTP clients. Account names and passwords are taken from the specified secrets file. The secrets file should contain lines that have four space-separated fields, starting with \fIserver\fR in the first field; the second field is the password encoding (\fIplain\fR or \fImd5\fR), the third is the client user-id and the fourth is the password. The user-id is RFC-1891 xtext encoded, and the password is either xtext encoded or generated by \fIemailrelay-passwd\fR. A special value of \fI/pam\fR can be used for authentication using linux PAM.
Enables SMTP server authentication of remote SMTP clients. Account names and passwords are taken from the specified secrets file. The secrets file should contain lines that have four space-separated fields, starting with \fIserver\fR in the first field; the second field is the password encoding (\fIplain\fR or \fImd5\fR), the third is the client user-id and the fourth is the password. The user-id is RFC-1891 xtext encoded, and the password is either xtext encoded or generated by \fIemailrelay-passwd\fR. Alternatively, the username and password can be Base64 encoded if the second field is \fIplain:b\fR. A special value of \fIpam:\fR can be used for authentication using linux PAM.
.TP
.B --server-auth-config \fI<config>\fR
Configures the SMTP server authentication module using a semicolon-separated list of configuration items. Each item is a single-character key, followed by a colon and then a comma-separated list. A 'm' character introduces an ordered list of allowed authentication mechanisms and an 'x' introduces a list of mechanisms to deny. An 'a' list and a 'd' list can be used similarly to allow and deny mechanisms once the session is encrypted with TLS. In typical usage you might have an empty allow list for an unencrypted session and a single preferred mechanism once encrypted, \fIm:;a:plain\fR.
.TP
.B \-F, --pop-auth \fI<file>\fR
Specifies a file containing valid POP account details. The file format is the same as for the SMTP server secrets file, ie. lines starting with \fIserver\fR, with user-id and password in the third and fourth fields. A special value of \fI/pam\fR can be used for authentication using linux PAM.
Specifies a file containing valid POP account details. The file format is the same as for the SMTP server secrets file, ie. lines starting with \fIserver\fR, with user-id and password in the third and fourth fields. A special value of \fIpam:\fR can be used for authentication using linux PAM.
.SS TLS options
.TP
.B \-j, --client-tls
@ -192,7 +204,7 @@ Makes the use of TLS mandatory for outgoing SMTP connections. The SMTP STARTTLS
Defines the target server hostname in the TLS handshake. With \fI--client-tls-connection\fR this can be used for SNI, allowing the remote server to adopt an appropriate identity.
.TP
.B --client-tls-verify \fI<ca-list>\fR
Enables verification of the remote SMTP server's certificate against any of the trusted CA certificates in the specified file or directory. In many use cases this should be a file containing just your self-signed root certificate. Specify \fI<default>\fR for the TLS library's default set of trusted CAs.
Enables verification of the remote SMTP server's certificate against any of the trusted CA certificates in the specified file or directory. In many use cases this should be a file containing just your self-signed root certificate. Specify \fI<default>\fR (including the angle brackets) for the TLS library's default set of trusted CAs.
.TP
.B --client-tls-verify-name \fI<cname>\fR
Enables verification of the CNAME within the remote SMTP server's certificate.
@ -201,7 +213,7 @@ Enables verification of the CNAME within the remote SMTP server's certificate.
Enables TLS for incoming SMTP and POP connections. SMTP clients can then request TLS encryption by issuing the STARTTLS command. The \fI--server-tls-certificate\fR option must be used to define the server certificate.
.TP
.B --server-tls-certificate \fI<pem-file>\fR
Defines the TLS certificate file when acting as a SMTP or POP server. This file must contain the server's private key and certificate chain using the PEM file format. Alternatively, use this option twice with the first one specifying the key file and the second the certificate file. Keep the file permissions tight to avoid accidental exposure of the private key.
Defines the TLS certificate file when acting as a SMTP or POP server. This file must contain the server's private key and certificate chain using the PEM file format. Alternatively, use this option twice with the first specifying the key file and the second the certificate file. Keep the file permissions tight to avoid accidental exposure of the private key.
.TP
.B --server-tls-connection
Enables SMTP over TLS when acting as an SMTP server. This is for SMTP over TLS (SMTPS), not TLS negotiated within SMTP using STARTTLS.
@ -210,7 +222,7 @@ Enables SMTP over TLS when acting as an SMTP server. This is for SMTP over TLS (
Makes the use of TLS mandatory for any incoming SMTP and POP connections. SMTP clients must use the STARTTLS command to establish a TLS session before they can issue SMTP AUTH or SMTP MAIL-TO commands.
.TP
.B --server-tls-verify \fI<ca-list>\fR
Enables verification of remote SMTP and POP clients' certificates against any of the trusted CA certificates in the specified file or directory. In many use cases this should be a file containing just your self-signed root certificate. Specify \fI<default>\fR for the TLS library's default set of trusted CAs.
Enables verification of remote SMTP and POP clients' certificates against any of the trusted CA certificates in the specified file or directory. In many use cases this should be a file containing just your self-signed root certificate. Specify \fI<default>\fR (including the angle brackets) for the TLS library's default set of trusted CAs.
.TP
.B \-9, --tls-config \fI<options>\fR
Selects and configures the low-level TLS library, using a comma-separated list of keywords. If OpenSSL and mbedTLS are both built in then keywords of \fIopenssl\fR and \fImbedtls\fR will select one or the other. Keywords like \fItlsv1.0\fR can be used to set a minimum TLS protocol version, or \fI-tlsv1.2\fR to set a maximum version.
@ -235,7 +247,7 @@ Disables listening for incoming SMTP connections.
Causes the process-id to be written into the specified file when the program starts up, typically after it has become a background daemon. The immediate parent directory is created if necessary.
.TP
.B \-u, --user \fI<username>\fR
When started as root the program switches to a non-privileged effective user-id when idle. This option can be used to define the idle user-id and also the group ownership of new files and sockets. Specify \fIroot\fR to disable all user-id switching. Ignored on Windows.
When started as root the program switches to a non-privileged effective user-id when idle or when running external filter scripts and address verifiers. This option can be used to define the non-privileged user-id. It also determines the group ownership of new files and sockets if the directory owner is not 'sticky'. Specify \fIroot\fR to disable all user-id switching. Ignored on Windows.
.SS Logging options
.TP
.B \-v, --verbose
@ -245,7 +257,7 @@ Enables more verbose logging when used with \fI--log\fR, and more verbose help w
Enables logging to the standard error stream and to the syslog. The \fI--close-stderr\fR and \fI--no-syslog\fR options can be used to disable output to standard error stream and the syslog separately. Note that \fI--as-server\fR, \fI--as-client\fR and \fI--as-proxy\fR imply \fI--log\fR, and \fI--as-server\fR and \fI--as-proxy\fR also imply \fI--close-stderr\fR.
.TP
.B \-g, --debug
Enables debug level logging, if built in. Debug messages are usually only useful when cross-referenced with the source code and they may expose plaintext passwords and mail message content.
Enables debug level logging, if built in. Debug messages are usually only useful when cross-referenced with the source code and they may expose plain-text passwords and mail message content.
.TP
.B --log-address
Adds the network address of remote clients to the logging output.

8
doc/emailrelay.css
View File

@ -1,5 +1,5 @@
/*
Copyright (C) 2001-2022 Graeme Walker <graeme_walker@users.sourceforge.net>
Copyright (C) 2001-2023 Graeme Walker <graeme_walker@users.sourceforge.net>
*/
/*
@ -28,7 +28,6 @@ h2
h3
{
font-size: smaller ;
color: #09c ;
}
@ -40,12 +39,15 @@ div.div-main
div.div-footer
{
margin-top: 60px ;
color: #888 ;
font-size: smaller ;
}
div.div-pre
{
margin-left: 3% ;
background-color: #ddd ;
background-color: #eee ;
padding: 0.5em ;
border: none ;
}

BIN
doc/forwardto.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 17 KiB

After

Width:  |  Height:  |  Size: 17 KiB

56
doc/forwardto.svg
View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- Created with Inkscape (http://www.inkscape.org/) -->
<!-- Copyright (C) 2001-2022 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->
<!-- Copyright (C) 2001-2023 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->
<svg
xmlns:dc="http://purl.org/dc/elements/1.1/"
@ -12,7 +12,7 @@
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
id="svg3036"
version="1.1"
inkscape:version="0.48.4 r9939"
inkscape:version="0.92.4 (5da689c313, 2019-01-14)"
width="1650"
height="1023"
sodipodi:docname="forwardto.svg"
@ -27,7 +27,7 @@
<dc:format>image/svg+xml</dc:format>
<dc:type
rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
<dc:title></dc:title>
<dc:title />
</cc:Work>
</rdf:RDF>
</metadata>
@ -42,13 +42,13 @@
guidetolerance="10"
inkscape:pageopacity="0"
inkscape:pageshadow="2"
inkscape:window-width="1323"
inkscape:window-height="916"
inkscape:window-width="1717"
inkscape:window-height="1148"
id="namedview3038"
showgrid="false"
inkscape:zoom="0.3103688"
inkscape:cx="964.09848"
inkscape:cy="499.69607"
inkscape:zoom="0.78606456"
inkscape:cx="725.0482"
inkscape:cy="595.63404"
inkscape:window-x="253"
inkscape:window-y="171"
inkscape:window-maximized="0"
@ -138,59 +138,59 @@
style="display:inline">
<text
xml:space="preserve"
style="font-size:48px;font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;display:inline;font-family:DejaVu Sans;-inkscape-font-specification:DejaVu Sans Bold"
style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;line-height:0%;font-family:'DejaVu Sans';-inkscape-font-specification:'DejaVu Sans Bold';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;display:inline;fill:#000000;fill-opacity:1;stroke:none"
x="335.11108"
y="545.05994"
id="text3298"
sodipodi:linespacing="125%"><tspan
id="text3298"><tspan
sodipodi:role="line"
id="tspan3300"
x="335.11108"
y="545.05994">--filter</tspan></text>
y="545.05994"
style="font-size:48px;line-height:1.25">--filter</tspan></text>
<text
xml:space="preserve"
style="font-size:48px;font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;display:inline;font-family:DejaVu Sans;-inkscape-font-specification:DejaVu Sans Bold"
style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;line-height:0%;font-family:'DejaVu Sans';-inkscape-font-specification:'DejaVu Sans Bold';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;display:inline;fill:#000000;fill-opacity:1;stroke:none"
x="729.98431"
y="672.42761"
id="text3302"
sodipodi:linespacing="125%"><tspan
id="text3302"><tspan
sodipodi:role="line"
id="tspan3304"
x="729.98431"
y="672.42761">--spool-dir</tspan></text>
y="672.42761"
style="font-size:48px;line-height:1.25">--spool-dir</tspan></text>
<text
xml:space="preserve"
style="font-size:48px;font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;font-family:DejaVu Sans;-inkscape-font-specification:DejaVu Sans Bold"
style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;line-height:0%;font-family:'DejaVu Sans';-inkscape-font-specification:'DejaVu Sans Bold';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none"
x="928.52094"
y="283.65533"
id="text3053"
sodipodi:linespacing="125%"><tspan
id="text3053"><tspan
sodipodi:role="line"
id="tspan3055"
x="928.52094"
y="283.65533">--forward-to=smtp.com:25</tspan></text>
y="283.65533"
style="font-size:48px;line-height:1.25">--forward-to=smtp.com:25</tspan></text>
<text
xml:space="preserve"
style="font-size:48px;font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;display:inline;font-family:DejaVu Sans;-inkscape-font-specification:DejaVu Sans Bold"
style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;line-height:0%;font-family:'DejaVu Sans';-inkscape-font-specification:'DejaVu Sans Bold';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;display:inline;fill:#000000;fill-opacity:1;stroke:none"
x="834.14893"
y="462.69864"
id="text3053-6"
sodipodi:linespacing="125%"><tspan
id="text3053-6"><tspan
sodipodi:role="line"
id="tspan3055-7"
x="834.14893"
y="462.69864">--poll=60</tspan></text>
y="462.69864"
style="font-size:48px;line-height:1.25">--poll=60</tspan></text>
<text
xml:space="preserve"
style="font-size:48px;font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;display:inline;font-family:DejaVu Sans;-inkscape-font-specification:DejaVu Sans Bold"
style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;line-height:0%;font-family:'DejaVu Sans';-inkscape-font-specification:'DejaVu Sans Bold';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;display:inline;fill:#000000;fill-opacity:1;stroke:none"
x="47.497009"
y="303.86072"
id="text3053-6-5"
sodipodi:linespacing="125%"><tspan
id="text3053-6-5"><tspan
sodipodi:role="line"
id="tspan3055-7-3"
x="47.497009"
y="303.86072">--port=587</tspan></text>
y="303.86072"
style="font-size:48px;line-height:1.25">--port=587</tspan></text>
</g>
</svg>

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 29 KiB

After

Width:  |  Height:  |  Size: 29 KiB

2
doc/index.html
View File

@ -20,4 +20,4 @@
</div>
</body>
</html>
<!-- Copyright (C) 2001-2022 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->
<!-- Copyright (C) 2001-2023 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->

BIN
doc/mailserver.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 33 KiB

482
doc/mailserver.svg Normal file
View File

@ -0,0 +1,482 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<svg
<!-- Copyright (C) 2001-2023 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->
xmlns:dc="http://purl.org/dc/elements/1.1/"
xmlns:cc="http://creativecommons.org/ns#"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns="http://www.w3.org/2000/svg"
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
version="1.0"
width="210mm"
height="297mm"
viewBox="0 0 595.27559 841.88976"
preserveAspectRatio="xMidYMid meet"
id="svg8"
sodipodi:docname="mailserver.svg"
inkscape:version="1.0.2 (e86c870879, 2021-01-15)"
inkscape:export-filename="/home/graeme/src/trunk/gnetapps/emailrelay/doc/graphics/mailserver.png"
inkscape:export-xdpi="57.367428"
inkscape:export-ydpi="57.367428">
<defs
id="defs12">
<inkscape:path-effect
effect="fill_between_many"
method="originald"
linkedpaths="#path4,0"
id="path-effect2166"
is_visible="true"
allow_transforms="false" />
<inkscape:path-effect
allow_transforms="false"
is_visible="true"
effect="fill_between_many"
method="originald"
linkedpaths="#path4,0"
id="path-effect2166-3" />
<inkscape:path-effect
allow_transforms="false"
is_visible="true"
id="path-effect2166-6"
linkedpaths="#path4,0"
method="originald"
effect="fill_between_many" />
<inkscape:path-effect
id="path-effect2166-3-2"
linkedpaths="#path4,0"
method="originald"
effect="fill_between_many"
is_visible="true"
allow_transforms="false" />
</defs>
<sodipodi:namedview
pagecolor="#ffffff"
bordercolor="#666666"
borderopacity="1"
objecttolerance="10"
gridtolerance="10"
guidetolerance="10"
inkscape:pageopacity="0"
inkscape:pageshadow="2"
inkscape:window-width="2560"
inkscape:window-height="1380"
id="namedview10"
showgrid="false"
inkscape:zoom="1.5352946"
inkscape:cx="250.23625"
inkscape:cy="398.01192"
inkscape:window-x="0"
inkscape:window-y="0"
inkscape:window-maximized="1"
inkscape:current-layer="g2839"
inkscape:pagecheckerboard="0"
inkscape:document-units="pt"
units="mm"
inkscape:document-rotation="0" />
<metadata
id="metadata2">
Created by potrace 1.16, written by Peter Selinger 2001-2019
<rdf:RDF>
<cc:Work
rdf:about="">
<dc:format>image/svg+xml</dc:format>
<dc:type
rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
<dc:title />
</cc:Work>
</rdf:RDF>
</metadata>
<g
inkscape:groupmode="layer"
id="layer2"
inkscape:label="lines"
style="display:inline"
transform="translate(0,614.88976)">
<g
id="g2839"
transform="matrix(0.75058102,0,0,0.77099094,115.95815,-132.17932)">
<flowRoot
style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:48px;line-height:125%;font-family:'DejaVu Sans';-inkscape-font-specification:'DejaVu Sans Bold';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
id="flowRoot1095"
xml:space="preserve"><flowRegion
id="flowRegion1097"><rect
y="1673.1166"
x="258.28561"
height="213.43361"
width="218.07347"
id="rect1099" /></flowRegion><flowPara
id="flowPara1101" /></flowRoot>
<flowRoot
style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:48px;line-height:125%;font-family:'DejaVu Sans';-inkscape-font-specification:'DejaVu Sans Bold';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
id="flowRoot1103"
xml:space="preserve"><flowRegion
id="flowRegion1105"><rect
y="1683.9429"
x="133.00935"
height="157.75528"
width="406.76117"
id="rect1107" /></flowRegion><flowPara
id="flowPara1109" /></flowRoot>
<path
inkscape:connector-curvature="0"
id="path3237"
d="m 134.59062,-482.21782 c -0.41203,-0.28759 -0.37615,-0.65951 0.16828,-1.74448 0.75095,-1.49647 1.71948,-2.04172 5.2204,-2.93887 1.08451,-0.27791 1.97158,-0.58484 1.97127,-0.68208 -0.001,-0.20901 -6.99886,-1.85065 -10.41411,-2.44295 -1.31269,-0.22764 -2.79804,-0.50812 -3.30079,-0.62326 -1.25919,-0.28837 -10.77836,-1.93104 -15.55144,-2.68361 -4.21557,-0.66466 -6.66062,-0.99331 -13.476633,-1.81148 -2.386716,-0.28648 -5.737552,-0.69299 -7.446189,-0.90333 -7.257884,-0.89348 -28.215983,-1.46603 -31.391923,-0.85758 -0.835374,0.16001 -2.397582,0.32525 -3.471592,0.36716 -4.754208,0.18558 -9.21133,0.75416 -11.860146,1.51297 -2.410598,0.69058 -3.496071,0.37455 -3.856562,-1.1228 -0.186992,-0.77671 -0.07558,-0.87689 1.355871,-1.21914 0.857704,-0.20511 1.852428,-0.51958 2.210352,-0.69883 0.839852,-0.42045 4.92896,-0.89825 7.160149,-0.83661 2.442897,0.0675 7.862742,-0.27156 9.249839,-0.57864 1.596836,-0.35351 8.453689,-0.4509 11.362515,-0.16137 1.312706,0.13065 4.449898,0.26676 6.971544,0.30243 2.521647,0.0357 4.932663,0.17769 5.357813,0.3155 0.42515,0.13784 1.739289,0.19684 2.920289,0.1311 1.403873,-0.0782 2.703922,0.0179 3.755006,0.27722 0.884272,0.21818 3.230963,0.51442 5.214858,0.65827 1.983919,0.14385 4.023579,0.43051 4.532489,0.63706 0.6134,0.24885 1.45331,0.32659 2.49072,0.23048 0.97986,-0.0908 2.18528,0.005 3.22299,0.25627 0.9118,0.22067 2.02593,0.40125 2.47591,0.40125 0.99544,0 13.72399,2.04142 15.9997,2.56606 0.59667,0.13756 2.35416,0.45115 3.9055,0.69686 3.26716,0.5175 8.12,1.38053 9.22133,1.6399 0.45932,0.10817 0.7594,0.0658 0.7594,-0.10732 0,-0.1574 -0.34172,-0.35985 -0.7594,-0.44987 -0.94201,-0.20303 -3.25275,-1.11607 -3.68135,-1.4546 -0.45068,-0.35594 0.0863,-1.94003 0.80743,-2.38198 0.53234,-0.32624 0.74795,-0.31779 1.79375,0.0704 0.65376,0.2427 2.94614,0.95947 5.09417,1.59283 5.61042,1.65425 11.05358,3.56123 12.74103,4.46376 1.42026,0.75962 2.66208,2.08718 3.25227,3.47676 0.25419,0.5985 0.0765,0.76786 -1.39921,1.33362 -1.54627,0.59279 -2.25894,0.66692 -8.35921,0.86935 -7.58371,0.25165 -9.15984,0.4601 -11.44979,1.51435 -1.86319,0.85781 -2.07722,0.88727 -2.79653,0.38516 z"
style="fill:#161616;stroke-width:0.28719714" />
<text
xml:space="preserve"
style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:3.7832px;line-height:0%;font-family:'DejaVu Sans';-inkscape-font-specification:'DejaVu Sans Bold';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;display:inline;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.315267"
x="84.211464"
y="-565.79468"
id="text3053-3"
transform="scale(1.0407029,0.96088898)"><tspan
id="tspan1141"
sodipodi:role="line"
x="84.211464"
y="-565.79468"
style="font-size:15.1328px;line-height:1.25;stroke-width:0.315267">--remote-clients</tspan><tspan
id="tspan1133"
sodipodi:role="line"
x="84.211464"
y="-546.87866"
style="font-size:15.1328px;line-height:1.25;stroke-width:0.315267">--port=25</tspan></text>
<g
id="g1573"
transform="matrix(0.59703729,0,0,0.55486049,706.76708,-550.42365)">
<g
style="fill:#000000;stroke:none"
transform="matrix(0.13621129,0,0,-0.13160476,-1424.8083,235.04321)"
id="g881">
<path
inkscape:connector-curvature="0"
d="m 1332,1799 c -81,-10 -121,-23 -206,-67 -79,-41 -183,-141 -227,-217 -33,-58 -39,-141 -14,-202 8,-19 15,-36 15,-38 0,-1 -17,1 -37,4 -73,12 -236,-34 -325,-90 -134,-86 -160,-181 -77,-285 16,-20 29,-39 29,-41 0,-3 -25,-32 -55,-66 C 287,634 270,460 396,400 c 78,-38 260,-36 444,5 21,5 28,0 41,-27 39,-82 256,-133 471,-111 178,19 347,73 458,147 21,15 57,26 93,30 65,7 226,60 305,100 62,31 127,88 148,128 18,35 20,124 4,175 -18,55 -75,137 -126,182 l -45,39 23,38 c 19,33 23,53 23,130 0,84 -3,95 -37,165 -92,185 -247,299 -408,299 -35,0 -79,-6 -98,-12 -29,-11 -36,-11 -40,0 -27,80 -169,130 -320,111 z m 201,-94 c 43,-18 56,-39 50,-80 -10,-63 68,-107 94,-53 11,21 25,29 70,38 119,25 215,-10 308,-112 76,-85 97,-127 103,-214 5,-80 -7,-114 -59,-162 -39,-37 -34,-59 23,-93 110,-65 178,-158 178,-244 0,-39 -6,-51 -42,-91 -78,-84 -282,-162 -399,-151 -45,4 -63,2 -72,-9 -54,-65 -97,-93 -202,-132 -172,-63 -423,-80 -561,-38 -67,21 -83,39 -55,63 28,24 26,57 -5,82 -21,16 -30,18 -46,10 -36,-19 -182,-57 -261,-68 -156,-22 -241,-8 -265,42 -18,37 3,99 63,189 58,86 99,118 153,118 37,0 42,3 42,23 0,31 -29,64 -65,73 -15,4 -45,24 -66,45 -34,34 -37,41 -29,68 12,44 16,48 81,96 69,51 147,82 231,94 56,7 61,6 96,-21 48,-39 87,-36 87,7 0,17 4,35 8,42 4,6 -4,36 -18,67 -45,98 -29,155 68,254 63,64 174,134 251,158 58,18 195,17 239,-1 z"
id="path879" />
</g>
<path
transform="matrix(1.2562029,0,0,1.3516911,-1155.935,-149.90388)"
inkscape:connector-curvature="0"
id="path920"
d="m -96.297678,249.97747 c -4.381462,-0.68332 -9.214782,-1.91057 -10.740712,-2.72722 -2.53523,-1.35681 -2.5971,-1.75546 -0.71762,-4.62391 1.83203,-2.79603 1.81186,-3.4888 -0.18462,-6.33916 -2.45799,-3.50928 -3.94647,-3.46514 -18.44781,0.54703 -19.49929,5.39499 -39.95122,5.39652 -43.89484,0.003 -5.4297,-7.42556 12.8806,-29.77971 24.39259,-29.77971 1.81352,0 2.81631,-0.91046 2.81631,-2.557 0,-2.75791 -4.07917,-7.14429 -6.64392,-7.14429 -0.86626,0 -3.71829,-1.88181 -6.33784,-4.18181 -5.65545,-4.96555 -5.39665,-8.23161 1.03402,-13.04952 7.07748,-5.3025 14.94473,-8.7329 24.20714,-10.55517 8.18358,-1.61002 9.06913,-1.52424 14.23438,1.37879 3.02936,1.7026 6.33629,2.77775 7.34875,2.38923 3.03712,-1.16545 3.97223,-10.00182 1.55344,-14.67924 -1.17393,-2.27012 -2.13441,-6.39114 -2.13441,-9.15782 0,-4.28654 1.17832,-6.19526 7.96892,-12.90864 4.647992,-4.59513 11.979428,-9.89128 17.592579,-12.70868 8.392196,-4.21229 11.189328,-4.89253 21.858943,-5.31593 13.971981,-0.55444 19.102682,1.44571 19.102682,7.44697 0,3.56883 4.329379,8.97639 7.186646,8.97639 0.903675,0 3.06612,-1.3369 4.805422,-2.97089 4.023277,-3.77967 14.878395,-4.94414 23.5240452,-2.52351 7.51499243,2.10407 22.0730098,14.7679 24.9850728,21.7342 1.025329,2.45281 1.864241,7.26443 1.864241,10.69248 0,4.94914 -0.856305,7.20812 -4.157695,10.96819 -2.286732,2.60444 -4.157695,5.73659 -4.157695,6.96033 0,1.22374 2.650531,3.86717 5.890068,5.87429 16.77393,10.39262 22.112619,22.05483 13.869655,30.2978 -8.008538,8.00853 -25.9671478,14.5941 -39.7976098,14.5941 -7.6709202,0 -9.1113252,0.49869 -15.6661542,5.4239 -14.448393,10.85631 -48.480377,17.5028 -71.353978,13.93551 z"
style="fill:#e8f3f7;fill-opacity:1;stroke:none;stroke-width:1.38589835px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" />
</g>
<text
xml:space="preserve"
style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:3.7832px;line-height:0%;font-family:'DejaVu Sans';-inkscape-font-specification:'DejaVu Sans Bold';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;display:inline;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.315267"
x="59.188995"
y="-490.17343"
id="text3053-3-7-3"
transform="scale(1.0407029,0.96088899)"><tspan
sodipodi:role="line"
x="59.188995"
y="-490.17343"
style="font-size:15.1328px;line-height:1.25;stroke-width:0.315267"
id="tspan1215-5">SMTP</tspan></text>
<flowRoot
xml:space="preserve"
id="flowRoot1095-9"
style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:48px;line-height:125%;font-family:'DejaVu Sans';-inkscape-font-specification:'DejaVu Sans Bold';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
transform="translate(538.65334,11.022668)"><flowRegion
id="flowRegion1097-3"><rect
id="rect1099-6"
width="218.07347"
height="213.43361"
x="258.28561"
y="1673.1166" /></flowRegion><flowPara
id="flowPara1101-0" /></flowRoot>
<flowRoot
xml:space="preserve"
id="flowRoot1103-6"
style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:48px;line-height:125%;font-family:'DejaVu Sans';-inkscape-font-specification:'DejaVu Sans Bold';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
transform="translate(538.65334,11.022668)"><flowRegion
id="flowRegion1105-2"><rect
id="rect1107-6"
width="406.76117"
height="157.75528"
x="133.00935"
y="1683.9429" /></flowRegion><flowPara
id="flowPara1109-1" /></flowRoot>
<path
sodipodi:nodetypes="csscscsssccsscsssscccssssssscsccsccssssssssssccsscssscsssssssccsccsscsssscsscscssccssssccccscssc"
style="fill:#161616;stroke-width:0.31526655"
d="m 188.20358,-413.84941 c 5.24105,1.93607 5.90555,2.10141 13.4552,4.00142 0.63159,0.15896 2.03421,0.40845 3.11694,0.55444 1.08273,0.14599 3.22357,0.47852 4.75743,0.73892 5.85246,0.99363 18.55243,1.36034 27.43927,0.79224 6.42907,-0.41097 15.80554,-1.58109 19.47888,-2.43082 0.63158,-0.14608 1.8462,-0.34731 2.69916,-0.44713 0.85296,-0.0998 1.63679,-0.30997 1.74187,-0.46695 0.1051,-0.15698 0.65171,-0.28543 1.21472,-0.28543 0.56303,0 1.47711,-0.12586 2.03127,-0.2797 0.55419,-0.15383 1.81964,-0.44765 2.81214,-0.65295 0.9925,-0.20527 2.91187,-0.71238 4.26528,-1.12689 1.35341,-0.41451 2.9775,-0.86128 3.6091,-0.99281 1.74946,-0.36434 5.45123,-1.62728 8.30267,-2.83264 1.40853,-0.59539 2.78835,-1.08254 3.06632,-1.08254 0.27796,0 0.89725,-0.18548 1.37624,-0.41221 0.479,-0.22671 2.49496,-1.12964 4.47996,-2.00652 5.21776,-2.30501 10.1791,-4.9966 14.3787,-7.80064 4.49453,-3.00101 11.69709,-9.87211 13.68612,-13.05637 0.2775,-0.44422 0.87963,-1.35297 1.33808,-2.01943 1.32982,-1.93324 3.42269,-5.90196 4.1535,-7.87634 2.42944,-6.56318 3.03751,-10.15478 2.88911,-17.06434 -0.18193,-8.47115 -1.01422,-12.60844 -4.21515,-20.95415 -4.08359,-10.647 -12.57733,-20.71468 -23.04359,-27.3136 -6.48317,-4.08761 -14.93536,-7.81251 -20.99833,-9.2541 -1.08272,-0.25743 -3.22357,-0.79133 -4.75743,-1.18645 -6.47563,-1.66805 -12.35317,-2.29595 -21.81859,-2.33082 -6.82609,-0.0251 -8.06293,0.0528 -12.9599,0.81635 -5.46321,0.85192 -12.33514,2.24734 -15.13658,3.07366 -0.83626,0.24668 -1.69982,0.44849 -1.91902,0.44849 -0.2192,0 -0.86379,0.19325 -1.43241,0.42944 -0.56863,0.23617 -1.99356,0.73078 -3.16652,1.09909 -1.17296,0.36828 -2.42793,0.81556 -2.78884,0.99393 -0.57844,0.28588 -0.48557,0.35204 0.78353,0.5584 1.6064,0.26123 1.83259,0.3801 1.54388,0.81142 -0.19443,0.29048 -1.56866,0.79736 -7.57662,2.79471 -1.62388,0.53986 -4.57677,1.69792 -6.56198,2.57347 -3.28969,1.45085 -4.4836,2.05997 -9.4859,4.83962 -2.4158,1.34237 -8.8396,5.7915 -11.1847,7.74647 -0.36091,0.30087 -1.39048,1.13173 -2.28792,1.84636 -3.47204,2.76475 -10.5948,9.61901 -12.80463,12.32199 -0.72181,0.88291 -1.83442,2.17202 -2.47246,2.86471 -2.66739,2.89586 -5.20428,6.69029 -8.20411,12.27083 -5.65702,10.52364 -6.96065,20.79345 -3.78631,29.82801 1.27598,3.6316 3.92329,8.64737 6.02593,11.41709 5.94466,7.83068 15.67275,14.51442 27.46669,18.87116 m -0.26753,2.56029 c -11.66496,-4.45246 -20.22176,-10.15787 -26.77466,-17.55954 -4.55575,-5.14589 -6.16397,-7.62193 -8.22094,-12.65707 -0.57855,-1.41622 -1.25986,-3.02263 -1.514,-3.56976 -0.25415,-0.54717 -0.46209,-1.39029 -0.46209,-1.87363 0,-0.48337 -0.16164,-1.26258 -0.3592,-1.73162 -0.49654,-1.17884 -0.71864,-8.24347 -0.34586,-11.00116 0.4418,-3.26832 1.36497,-7.66655 1.68425,-8.02429 0.15044,-0.16855 0.58864,-1.19254 0.97378,-2.27554 0.38513,-1.08299 1.15311,-2.85517 1.70662,-3.93817 2.60432,-5.09563 2.7983,-5.41204 6.08511,-9.92573 0.93845,-1.28875 2.1196,-2.936 2.62479,-3.66053 1.40948,-2.0215 7.66296,-8.58409 11.88922,-12.47691 10.60431,-9.7676 18.87851,-14.95338 31.84619,-19.95922 1.45685,-0.56237 2.92922,-1.39342 3.60909,-2.03703 1.26191,-1.19463 2.35542,-1.69854 3.10769,-1.43198 0.27407,0.0971 1.17568,-0.29073 2.05346,-0.88331 2.02456,-1.36669 4.98266,-2.5854 9.2752,-3.82135 1.89477,-0.54556 3.88798,-1.17655 4.42934,-1.40217 1.0801,-0.4502 8.83127,-1.97975 10.66321,-2.10423 0.6316,-0.0429 2.18186,-0.25274 3.44504,-0.46631 3.38516,-0.57237 17.79438,-0.49999 21.81858,0.10957 1.71431,0.25968 4.07662,0.61845 5.24957,0.79727 4.0994,0.62502 10.06123,2.23718 15.42066,4.16995 16.55876,5.9716 28.87355,15.66044 37.14022,29.22055 1.92352,3.1552 4.47452,8.48425 5.48155,11.45105 1.42044,4.18461 1.67157,5.00508 1.67157,5.46127 0,0.28282 0.28889,1.58945 0.64199,2.90358 0.82425,3.06778 1.40098,10.53374 1.14402,14.80977 -0.3325,5.5334 -2.04379,12.2747 -4.19104,16.50966 -0.4951,0.97648 -3.93424,6.44263 -5.07909,8.07279 -2.99342,4.26213 -8.94477,9.83952 -13.55768,12.70569 -0.92809,0.57667 -2.22077,1.42595 -2.87259,1.88726 -0.65184,0.46134 -1.55428,1.00269 -2.00542,1.20302 -0.45113,0.20034 -1.7061,0.9049 -2.78883,1.56573 -1.08273,0.66082 -2.3377,1.34285 -2.78884,1.51562 -0.45114,0.17279 -1.04171,0.44489 -1.3124,0.60472 -0.64035,0.37807 -4.54859,2.13327 -4.75008,2.13327 -0.0852,0 -1.15527,0.42621 -2.37786,0.94714 -1.22256,0.52092 -3.18256,1.26478 -4.35552,1.65306 -1.17295,0.38827 -2.94469,0.99965 -3.93718,1.35863 -0.99251,0.35898 -2.46895,0.83169 -3.28099,1.0505 -0.81205,0.21878 -2.36231,0.66573 -3.44504,0.99317 -1.08274,0.32748 -2.78065,0.76474 -3.77315,0.9717 -0.9925,0.207 -2.09845,0.51699 -2.4577,0.68891 -0.66764,0.31954 -5.20955,1.26434 -8.269,1.72011 -0.93722,0.13962 -1.83167,0.32668 -1.98769,0.41574 -1.21078,0.69091 -25.75199,3.07304 -29.44631,2.85826 -0.54136,-0.0315 -2.23928,-0.0924 -3.77314,-0.13531 -14.02901,-0.39288 -26.96727,-2.70108 -37.34585,-6.66251"
id="path3257-8"
inkscape:connector-curvature="0" />
<g
id="layer6-7"
inkscape:label="colour"
style="display:inline"
transform="matrix(0.32809886,0,0,0.30293617,29.943152,-542.28211)">
<path
style="display:inline;fill:#ddffdd;fill-opacity:1;stroke:none"
d="m 554.99775,441.33848 c -75.21714,-9.37864 -141.10301,-48.21472 -165.49853,-97.5523 -12.16037,-24.59314 -14.91307,-37.10424 -13.36523,-60.7455 2.83502,-43.30151 25.87459,-86.11586 70.69643,-131.37492 35.78606,-36.13513 64.67414,-55.667175 107.95002,-72.988037 20.00723,-8.007756 27.06735,-12.945778 19.01164,-13.29721 -8.19547,-0.357528 23.83022,-10.32233 51.07725,-15.8927 27.73809,-5.670761 34.51142,-6.171832 68.38466,-5.058892 30.95125,1.016936 41.65196,2.386243 60.53611,7.746461 91.2608,25.904136 149.14818,94.538608 154.45538,183.130968 6.1079,101.95624 -77.07608,174.58867 -230.75804,201.48742 -33.24747,5.81926 -94.14629,8.07877 -122.48969,4.54471 z"
id="path7860-9"
inkscape:connector-curvature="0" />
</g>
<text
transform="scale(1.0407029,0.96088898)"
id="text3053-3-23"
y="-566.92059"
x="282.61624"
style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:3.7832px;line-height:0%;font-family:'DejaVu Sans';-inkscape-font-specification:'DejaVu Sans Bold';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;display:inline;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.315267"
xml:space="preserve"><tspan
style="font-size:15.1328px;line-height:1.25;stroke-width:0.315267"
y="-566.92059"
x="282.61624"
sodipodi:role="line"
id="tspan1141-9">--pop</tspan><tspan
style="font-size:15.1328px;line-height:1.25;stroke-width:0.315267"
y="-548.00458"
x="282.61624"
sodipodi:role="line"
id="tspan1133-2">--pop-port=110</tspan></text>
<path
inkscape:connector-curvature="0"
id="path3235"
d="m 333.91537,-485.26624 c -0.61647,-0.67696 -0.67477,-2.06725 -0.10114,-2.41201 1.00235,-0.60238 6.70048,-2.61508 11.7897,-4.16429 1.36032,-0.41412 2.73107,-0.86034 3.04599,-0.99163 0.31494,-0.13128 0.79891,-0.2387 1.07539,-0.2387 0.27651,0 1.13182,-0.21776 1.90073,-0.48389 0.76887,-0.26615 1.76896,-0.54225 2.22242,-0.6136 0.77488,-0.1219 3.31107,-0.76581 4.78183,-1.21405 1.08362,-0.33029 5.17987,-1.17772 6.59561,-1.3645 0.72554,-0.0957 1.50305,-0.29096 1.72783,-0.43381 0.2248,-0.14288 1.33779,-0.28599 2.47335,-0.31803 1.34182,-0.0379 2.55127,-0.25 3.45453,-0.60588 0.76443,-0.30119 1.87739,-0.53648 2.47336,-0.52288 0.59593,0.0137 1.9739,-0.15556 3.06218,-0.37595 1.08829,-0.22037 2.47076,-0.40246 3.07215,-0.40464 0.60143,-0.003 1.38933,-0.12574 1.75094,-0.27461 2.23737,-0.92096 28.89294,-1.67821 41.5112,-1.17925 3.53688,0.13986 7.16152,0.26648 8.05473,0.28139 l 1.624,0.027 -0.0791,-1.6869 c -0.0476,-1.01601 0.0649,-1.7554 0.28309,-1.85909 0.19919,-0.0947 0.83959,0.0407 1.42311,0.30077 0.58351,0.26009 1.72874,0.6251 2.54493,0.81112 4.26712,0.97246 9.47435,2.68389 11.1942,3.67916 0.62471,0.36152 1.34538,0.6573 1.60145,0.6573 0.25613,0 1.04343,0.35201 1.74975,0.78225 1.26538,0.77086 1.28412,0.80726 1.28412,2.49716 0,2.31756 -0.24752,2.45818 -6.06698,3.44644 -1.25093,0.21246 -3.15654,0.74788 -4.23465,1.18983 -2.40635,0.98649 -3.00759,0.82022 -3.15339,-0.87207 -0.0957,-1.11092 -0.0478,-1.17623 1.48407,-2.02443 1.35827,-0.75215 3.30219,-1.44625 5.84607,-2.08747 0.54723,-0.13793 0.57013,-0.20771 0.16493,-0.50143 -0.57115,-0.41396 -10.90409,-1.21833 -16.4867,-1.28339 -2.09774,-0.0244 -3.98833,-0.12733 -4.20142,-0.22861 -0.41716,-0.1983 -23.78309,-0.2382 -27.60093,-0.0471 -1.26964,0.0636 -3.94088,0.18762 -5.93606,0.27572 -1.99518,0.0881 -4.66647,0.28043 -5.93611,0.42742 -1.26962,0.14699 -2.90203,0.3013 -3.62757,0.3429 -1.54756,0.0888 -6.74756,0.75511 -7.69219,0.9857 -0.35937,0.0877 -1.44687,0.26707 -2.41666,0.39851 -4.24779,0.57578 -13.30133,2.41131 -15.6141,3.1656 -0.54413,0.17748 -1.65712,0.4606 -2.47333,0.62918 -3.48248,0.71916 -16.25337,4.78746 -19.47594,6.20419 -1.80485,0.79351 -2.43556,0.81114 -3.09541,0.0865 z"
style="fill:#161616;stroke-width:0.28551146" />
<text
transform="scale(1.066351,0.93777755)"
xml:space="preserve"
style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:4.00875px;line-height:0%;font-family:'DejaVu Sans';-inkscape-font-specification:'DejaVu Sans Bold';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;display:inline;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.334062"
x="314.73795"
y="-404.68732"
id="text3324-9"><tspan
sodipodi:role="line"
id="tspan3326-1"
x="314.73795"
y="-404.68732"
style="font-size:16.035px;line-height:1.25;stroke-width:0.334062">--pop-auth</tspan></text>
<path
style="color:#000000;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:medium;line-height:normal;font-family:Sans;-inkscape-font-specification:Sans;text-indent:0;text-align:start;text-decoration:none;text-decoration-line:none;letter-spacing:normal;word-spacing:normal;text-transform:none;writing-mode:lr-tb;direction:ltr;baseline-shift:baseline;text-anchor:start;display:inline;overflow:visible;visibility:visible;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.50409442px;marker:none;enable-background:accumulate"
d="m 303.62872,-424.57603 c -1.38753,4.69907 0.61612,8.71506 2.30342,10.91995 8.68357,16.57725 15.87278,40.64633 25.25109,52.96413 4.09217,6.26961 7.6682,10.98207 11.76336,17.22651 1.31677,-3.52388 1.34767,-6.63964 -0.48221,-9.01373 -5.5223,-8.02508 -9.62192,-10.45824 -15.96786,-22.3606 -6.34594,-11.90235 -14.67227,-35.15084 -21.78045,-50.61604 -0.81499,-2.03829 -0.5917,-2.17354 -1.08735,0.87978 z"
id="path3439"
inkscape:connector-curvature="0"
sodipodi:nodetypes="ccccczcc" />
<g
transform="matrix(0.38698728,0,0,0.39592217,602.84257,-466.41691)"
id="g1616">
<path
sodipodi:nodetypes="cccccsssssssccscssscsccsscssssssccsccssssssssccccscsssscccsc"
inkscape:connector-curvature="0"
id="path3255-3-2-3"
d="m -630.68174,256.24931 c 17.83082,-0.37381 31.02946,-0.71104 32.97458,-0.74924 1.94519,-0.0384 6.45449,-0.21932 10.02061,-0.40243 3.56619,-0.18304 14.97198,-0.54144 25.34623,-0.79627 10.37425,-0.25492 21.27652,-0.64177 24.22728,-0.85964 9.01417,-0.66578 59.34312,-1.54029 82.79484,-1.43865 20.3046,0.088 56.9753,2.10942 59.3877,3.27368 5.1239,2.47296 6.459,4.63631 7.214,11.68943 0.4231,3.95304 0.7525,8.39558 0.732,9.87228 -0.045,3.19014 -3.4416,22.38207 -5.4992,31.06831 -1.0493,4.42919 -1.3896,18.48841 -1.223,50.52363 0.2571,49.4142 -0.1084,47.284 8.1273,47.284 5.7201,0 3.8116,-0.9249 6.8217,1.8259 2.0237,1.8493 0.6188,4.8196 -0.293,5.7545 -0.9955,1.0209 4.3017,1.1938 -3.8436,0.9735 l -9.9055,-0.2679 -2.0234,2.7611 c -2.0752,2.8317 -4.5634,3.4979 -6.7312,1.8022 -0.674,-0.5274 -2.2026,-1.7921 -3.3964,-2.8105 -1.9359,-1.6512 -3.2432,-1.8806 -12.0833,-2.1202 -5.4519,-0.1477 -21.8487,0.084 -36.4375,0.5154 -14.58884,0.4313 -32.36068,0.9581 -39.49292,1.1707 -7.13232,0.2127 -15.62035,0.5487 -18.86229,0.7467 -19.31204,1.1798 -96.76295,2.6715 -117.29984,2.2592 -39.12963,-0.7854 -61.61992,-2.2546 -66.14262,-5.3124 -3.55601,-2.4041 -5.67743,-6.5246 -4.27101,-8.2958 0.70851,-0.8923 0.42959,-4.694 -0.78808,-10.7397 -1.03661,-5.1471 -1.20087,-15.5721 -2.13833,-23.1666 -2.03819,-16.5115 -3.36601,-34.176 -5.00504,-41.0408 -3.25633,-13.63842 -3.30781,-36.43051 -3.66159,-50.65358 -0.21539,-8.66231 -0.74165,-16.34309 -1.16935,-17.0684 -2.18979,-3.71324 0.97435,-4.24462 28.35745,-4.76219 10.37425,-0.19608 33.45109,-0.66233 51.28183,-1.03623 m -5.33954,8.29593 c -11.34685,0.40657 -25.60639,0.93397 -35.33225,1.17193 -9.72587,0.23796 -19.92589,0.63172 -22.6667,0.87505 l -4.9833,0.44248 0.64438,13.91545 c 0.77454,16.72626 -2.11297,16.86442 0.3962,32.32631 1.09542,6.75065 1.05043,13.33406 1.673,14.62975 0.6227,1.2956 1.13221,3.9067 1.13221,5.8022 0,1.8954 1.15975,7.3308 1.87975,12.2194 0.81362,5.5243 1.20101,10.3177 1.4487,13.0602 0.24767,2.7424 0.14992,6.721 0.47848,7.9868 0.32856,1.2657 1.42339,8.3424 2.433,15.7259 2.61006,19.0888 3.4841,23.0597 5.23016,23.7618 8.00539,3.2195 58.23779,4.2017 123.15004,2.5942 v 10e-5 c 13.61625,-0.3371 25.55253,-0.5422 26.52516,-0.4556 0.97256,0.087 11.31736,-0.3507 22.98843,-0.9717 24.03141,-1.2786 72.18597,-2.6694 92.69337,-2.6771 10.3748,-0.01 14.0444,-0.2691 15.0926,-1.0909 1.017,-0.7975 1.2015,-5.7369 0.6947,-18.6026 -2.0834,-52.884 -1.5972,-70.52814 2.4167,-87.70823 0.9365,-4.0082 2.0448,-13.01709 2.4629,-20.01973 0.6257,-10.47746 0.4677,-12.85461 -0.892,-13.42412 -1.7285,-0.724 -15.0176,-2.44565 -19.684,-2.55013 -40.9988,-2.50205 -78.07265,-1.28225 -114.00436,-0.20045 -10.37432,0.48666 -32.6554,1.23698 -49.51352,1.66726 -16.85819,0.43035 -39.93504,1.11508 -51.28185,1.52173"
style="display:inline;fill:#161616;stroke-width:0.74597353" />
<path
inkscape:connector-curvature="0"
id="path3090"
d="m -681.90881,406.33471 c -4.91241,-1.25 -5.41811,-2.2103 -7.47054,-14.1858 -1.2108,-7.0648 -3.38567,-22.5792 -4.83304,-34.4764 -1.44737,-11.8972 -3.42483,-27.0846 -4.39435,-33.74975 -0.96952,-6.66515 -1.77871,-21.89807 -1.79821,-33.85091 l -0.0355,-21.73246 16.30788,-1.08034 c 8.96933,-0.59418 46.8521,-1.92848 84.18393,-2.96509 37.33176,-1.03661 84.13978,-2.38725 104.01779,-3.00143 37.01235,-1.14358 91.04095,1.55201 94.00855,4.69027 1.0046,1.0623 0.1239,13.1047 -2.2839,31.23272 -3.271,24.62654 -3.8175,35.82189 -3.3056,67.72359 l 0.6131,38.2197 -26.4452,1.1725 c -42.05738,1.8647 -242.75318,3.4822 -248.56496,2.0034 z"
style="fill:#fff6d5;stroke:none;stroke-width:0.74597353" />
<text
id="text3413"
y="284.61945"
x="-717.47424"
style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:8.95168px;line-height:0%;font-family:'DejaVu Sans Mono';-inkscape-font-specification:'DejaVu Sans Mono Bold';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.745974"
xml:space="preserve"
transform="scale(0.97243546,1.0283459)"><tspan
style="font-size:20.8873px;line-height:1.25;stroke-width:0.745974"
y="284.61945"
x="-717.47424"
id="tspan3415"
sodipodi:role="line">server plain alice ...</tspan></text>
</g>
<g
transform="matrix(0.59703729,0,0,0.55486049,790.91486,-546.69079)"
id="g1763">
<g
id="g1596"
transform="translate(-1566.9239,-562.35878)">
<path
style="display:inline;fill:#fbdeb2;fill-opacity:1;stroke:none;stroke-width:0.74597353"
d="m 1188.427,633.29793 c -1.2847,-2.53848 -1.193,-4.90835 0.314,-8.1189 1.8053,-3.84566 3.5912,-4.62234 11.7633,-5.11574 13.4634,-0.81288 21.4294,0.98343 20.7419,4.67727 -1.0638,5.71622 -9.7804,10.51873 -20.5925,11.34577 -8.9317,0.68321 -10.6705,0.28666 -12.2267,-2.7884 z"
id="path8377"
inkscape:connector-curvature="0" />
<path
style="fill:#161616;stroke-width:0.74597353"
d="m 1182.8316,723.99303 c -1.5625,-1.75885 -1.6538,-2.35483 -1.294,-8.45311 0.4048,-6.86088 2.4142,-12.53726 5.8725,-16.58849 0.8606,-1.00822 2.423,-3.04132 3.4719,-4.51802 1.0489,-1.4767 2.9207,-3.89313 4.1596,-5.36983 2.3876,-2.84616 2.4244,-2.94029 2.5546,-6.52051 0.07,-1.93966 0.3686,-2.29054 1.8971,-2.23255 0.9975,0.0376 2.3032,0.21043 2.9017,0.38356 0.7279,0.21058 1.0473,-0.19308 0.965,-1.21948 -0.196,-2.44397 -1.8365,-8.3484 -2.6109,-9.39721 -0.8793,-1.19088 -6.5059,-1.23929 -12.6446,-0.10878 -3.4707,0.63917 -5.1272,0.62628 -6.6753,-0.0522 -2.2512,-0.98605 -3.9044,-3.94007 -3.236,-5.78208 0.5418,-1.49297 1.6323,-1.7053 12.5952,-2.45271 l 9.0676,-0.61822 0.3628,-6.90407 c 0.3301,-6.28439 0.4994,-6.9247 1.8861,-7.13413 0.9722,-0.14682 2.4636,0.76413 4.1217,2.51761 2.2543,2.3839 2.5444,3.09916 2.1911,5.40167 -0.6376,4.15471 0.5082,4.96824 6.997,4.96824 4.9032,0 5.7813,0.21763 7.1654,1.77542 3.3112,3.72736 1.3762,5.84852 -5.4479,5.97225 -6.713,0.12167 -7.8086,0.66348 -8.0716,3.99194 -0.1241,1.57144 0.4811,5.87291 1.345,9.55869 l 1.5706,6.70154 6.5135,7.05742 c 6.8484,7.42034 7.7367,9.60847 4.083,10.05647 -2.4742,0.30332 -6.4785,-2.41742 -10.9392,-7.43254 -4.7162,-5.30248 -5.7365,-5.7988 -8.0186,-3.90057 -2.8319,2.35567 -10.9168,13.00121 -12.7372,16.77152 -0.8961,1.85581 -1.9606,5.30785 -2.3657,7.67119 -0.7253,4.23119 -2.2765,7.74889 -3.4171,7.74889 -0.3203,0 -1.3388,-0.8515 -2.2633,-1.89225 z"
id="path3239"
inkscape:connector-curvature="0" />
<path
style="fill:#161616;stroke-width:0.74597353"
d="m 1201.6093,637.35302 c 5.1372,-0.21104 7.4043,-0.78576 10.3662,-1.9695 v -1.6e-4 c 5.1146,-2.04406 8.111,-4.61713 10.0449,-8.62586 1.3823,-2.8655 1.3967,-3.12947 0.2432,-4.47737 -2.2222,-2.59662 -6.0098,-3.39834 -15.1959,-3.21668 -4.9968,0.0988 -9.8672,-0.2039 -11.4334,-0.71051 -2.4895,-0.8054 -2.8927,-0.72055 -4.6044,0.96895 -2.179,2.15077 -4.247,6.18052 -4.9566,9.65864 -0.6722,3.29431 1.1636,6.98193 3.779,7.59141 1.09,0.25399 2.3082,0.60065 2.7072,0.77034 0.399,0.16968 3.9898,0.17452 7.9795,0.0107 m -0.2501,7.79945 c -0.2829,-0.0575 -0.566,-0.15289 -1.5634,-0.31084 -8.7187,-1.38089 -10.4712,-2.08948 -13.6073,-5.50185 -1.7274,-1.87944 -3.616,-4.62036 -4.1971,-6.09093 -3.4183,-8.65179 1.201,-18.28427 11.5192,-24.02033 6.6969,-3.7229 8.7442,-3.65777 14.6183,0.46549 2.5748,1.80726 4.8078,2.6998 7.4366,2.9722 4.7027,0.48735 8.6996,2.61457 12.8897,6.86027 2.6203,2.65508 3.2587,3.81703 3.2587,5.93159 0,10.40934 -7.7144,16.67732 -23.4242,19.03245 -3.1084,0.46602 -5.8831,0.80026 -6.166,0.7428"
id="path3066"
inkscape:connector-curvature="0"
sodipodi:nodetypes="ccccsscscsscccccscssssc" />
</g>
<text
id="text3375"
y="190.32147"
x="-420.66235"
style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:8.95168px;line-height:0%;font-family:'DejaVu Sans';-inkscape-font-specification:'DejaVu Sans Bold';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;display:inline;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.745974"
xml:space="preserve"
transform="scale(0.97243546,1.0283459)"><tspan
y="190.32147"
x="-420.66235"
id="tspan3377"
sodipodi:role="line"
style="font-size:35.8067px;line-height:1.25;stroke-width:0.745974">alice</tspan></text>
</g>
<text
transform="scale(1.0407029,0.96088898)"
id="text3053-3-2-3"
y="-494.69147"
x="359.72815"
style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:3.7832px;line-height:0%;font-family:'DejaVu Sans';-inkscape-font-specification:'DejaVu Sans Bold';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;display:inline;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.315267"
xml:space="preserve"><tspan
style="font-size:15.1328px;line-height:1.25;stroke-width:0.315267"
y="-494.69147"
x="359.72815"
sodipodi:role="line"
id="tspan1133-9-0">POP</tspan></text>
<g
transform="matrix(0.24432879,0,0,0.19605893,-38.556549,-572.78252)"
id="g2155">
<g
id="g2127">
<path
style="fill:#161616;stroke-width:1.30307257"
d="m 2121.4452,291.22157 c 19,-0.65868 33.0642,-1.25288 35.137,-1.3202 2.0727,-0.0676 6.8777,-0.38644 10.6777,-0.70909 3.8,-0.32252 15.9538,-0.95403 27.0084,-1.40306 11.0545,-0.44917 22.6718,-1.13082 25.8161,-1.5147 9.6053,-1.17314 63.2347,-2.71406 88.2243,-2.53496 21.6361,0.15503 60.7117,3.71688 63.2823,5.76834 5.4599,4.35744 6.8826,8.16935 7.687,20.5972 0.4509,6.9654 0.8019,14.79331 0.78,17.39532 -0.048,5.62114 -3.6672,39.43802 -5.8598,54.74349 -1.1181,7.80439 -1.4807,32.57724 -1.3032,89.0244 0.274,87.06973 -0.1155,83.31621 8.6603,83.31621 6.0952,0 9.9254,1.99564 13.1328,6.84253 2.1564,3.25853 2.545,4.86704 1.5734,6.51434 -1.0607,1.79884 -3.1656,2.10364 -11.8451,1.71544 l -10.555,-0.47215 -2.1561,4.86514 c -2.2113,4.98963 -4.8627,6.16344 -7.1726,3.17553 -0.7183,-0.92929 -2.3471,-3.15769 -3.6192,-4.95206 -2.0628,-2.90951 -3.4558,-3.31367 -12.8756,-3.73593 -5.8094,-0.26034 -23.2816,0.14841 -38.8271,0.9082 -15.5455,0.75992 -34.4828,1.68812 -42.0828,2.06281 -7.6,0.37483 -16.6447,0.96687 -20.0992,1.31574 -20.5785,2.07876 -103.1085,4.70713 -124.9922,3.98073 -41.6957,-1.384 -59.477,-3.97276 -64.2962,-9.3606 -3.7893,-4.2362 -6.0498,-11.49667 -4.5511,-14.61759 0.7549,-1.57229 0.4577,-8.271 -0.8398,-18.92368 -1.1046,-9.06944 -2.8256,-27.43865 -3.8245,-40.82039 -2.1719,-29.09394 -5.1327,-60.21946 -6.8792,-72.31547 -3.4699,-24.03132 -6.6167,-64.19182 -6.9937,-89.25338 -0.2295,-15.2633 -0.7903,-28.79711 -1.246,-30.07513 -2.3334,-6.54286 1.0382,-7.47918 30.2171,-8.39116 11.0545,-0.3455 35.6447,-1.16705 54.6448,-1.82587 m -5.6897,14.61773 c -12.091,0.7164 -27.2856,1.64568 -37.6493,2.06498 -10.3637,0.41929 -21.2326,1.11312 -24.1532,1.54187 l -5.3101,0.77966 0.6867,24.51954 c 0.8253,29.47227 0.8404,29.71571 3.5141,56.96013 1.1672,11.89488 2.6653,23.49509 3.3287,25.7781 0.6635,2.283 1.2064,6.88375 1.2064,10.22365 0,3.33989 0.9014,13.02881 2.003,21.53109 1.1019,8.50213 2.2191,19.41217 2.4831,24.24447 0.2639,4.83229 0.7664,10.61077 1.1165,12.84106 0.3501,2.23029 1.5167,14.69964 2.5925,27.70967 2.7813,33.63521 3.7126,40.63197 5.5732,41.86917 8.5303,5.67278 55.873,7.40349 125.0421,4.57102 v 2.7e-4 c 14.5092,-0.59407 27.2282,-0.95538 28.2646,-0.80291 1.0364,0.15261 12.0596,-0.61786 24.496,-1.71205 25.6074,-2.253 76.9198,-4.70361 98.7721,-4.71713 11.0552,-0.0135 14.9654,-0.47417 16.0823,-1.92224 1.0837,-1.40522 1.2803,-10.10862 0.7402,-32.77851 -2.2199,-93.18342 -1.7019,-124.27313 2.5752,-154.54506 0.998,-7.06259 2.1789,-22.93658 2.6245,-35.27549 0.6667,-18.46167 0.4983,-22.65029 -0.9506,-23.65378 -1.8418,-1.27573 -16.0024,-4.30933 -20.9748,-4.49343 -2.6125,-0.0973 -2.8077,0.3267 -2.0786,4.50857 0.6918,3.96789 0.3472,4.93799 -2.4555,6.9139 -3.9473,2.78299 -4.1278,5.84295 -0.6275,10.63105 4.4696,6.11424 0.021,10.36855 -5.8471,5.59235 -3.1695,-2.57957 -7.3763,-2.5989 -9.3475,-0.0433 -1.6452,2.13284 -9.449,2.81531 -10.5367,0.92145 -0.3495,-0.60839 0.729,-4.27486 2.3966,-8.14772 1.8185,-4.2235 2.9229,-9.05525 2.7595,-12.0729 -0.2715,-5.01437 -0.2555,-5.0314 4.7525,-5.05262 6.9631,-0.0297 11.3652,-1.80748 9.4839,-3.83002 -1.9294,-2.0743 -82.4626,-1.90886 -109.9802,0.226 -11.0546,0.85752 -34.7968,2.17961 -52.7605,2.93777 -17.9637,0.7583 -42.5539,1.96482 -54.6448,2.68135"
id="path3255-3"
inkscape:connector-curvature="0"
sodipodi:nodetypes="cccccsssssssccscssscsccsscssssssccsccssssssssccccscssssccsccscccsccssc" />
<path
style="fill:#161616;stroke-width:1.30307257"
d="m 2170.5717,542.71762 c -0.3327,-0.57933 -1.5143,-11.37597 -2.6257,-23.99251 -2.0983,-23.8218 -6.228,-55.79133 -8.3192,-64.4016 -2.0785,-8.55877 -3.9157,-33.49909 -3.8379,-52.10066 0.064,-15.18206 0.4579,-18.67659 2.6229,-23.24314 1.4016,-2.95601 2.0652,-5.69589 1.4748,-6.08856 -0.5904,-0.39266 -5.8151,-0.10137 -11.6104,0.64881 -31.4153,4.06265 -45.6807,4.9622 -51.8281,3.26785 -6.2764,-1.72989 -9.1218,-4.38921 -7.0649,-6.6026 1.5286,-1.64474 31.9783,-5.64994 51.6222,-6.79022 8.5672,-0.49729 23.2082,-1.8994 32.5354,-3.11579 13.4686,-1.75638 29.6818,-2.22948 78.7804,-2.29868 57.2659,-0.0811 61.9836,0.0879 64.0215,2.27841 6.0713,6.52826 -9.0715,9.93628 -36.6528,8.2491 -23.6135,-1.44455 -73.0665,-0.84657 -92.959,1.12393 -8.2908,0.82129 -16.7227,1.55742 -18.7374,1.63582 -4.7445,0.18464 -5.4141,2.56807 -1.4973,5.32958 l 3.0977,2.18393 -0.6824,18.02155 c -0.6654,17.57564 1.1197,50.23466 3.3399,61.10225 7.7323,37.84844 9.6166,73.75935 4.3261,82.44735 -2.0323,3.33759 -4.8122,4.42314 -6.0058,2.34518 z"
id="path3253"
inkscape:connector-curvature="0" />
<path
style="fill:#161616;stroke-width:1.30307257"
d="m 2108.5636,523.49887 c -7.2311,-0.54094 -9.6538,-1.30127 -11.9166,-3.73918 -4.0145,-4.32528 -1.8336,-7.79142 4.8126,-7.64881 9.9274,0.21316 28.7985,3.55265 30.5816,5.4119 4.5976,4.79336 -5.3712,7.33089 -23.4776,5.97609 z"
id="path3251"
inkscape:connector-curvature="0" />
<path
style="fill:#161616;stroke-width:1.30307257"
d="m 2096.8922,497.98597 c -3.76,-3.37747 -4.1014,-4.16861 -2.6252,-6.08261 1.3322,-1.72705 4.0719,-2.20001 12.7462,-2.20001 12.5733,0 15.0234,0.65787 15.0234,4.03412 0,3.45993 -2.2,4.82865 -10.5732,6.57814 -9.8994,2.06836 -9.6269,2.11189 -14.5712,-2.32964 z"
id="path3249"
inkscape:connector-curvature="0" />
<path
style="fill:#161616;stroke-width:1.30307257"
d="m 2088.0408,476.50503 c -6.2707,-6.02881 -4.6287,-7.91712 7.8298,-9.00375 15.0324,-1.311 32.447,1.83614 32.447,5.86378 0,2.71406 -3.9114,4.06953 -13.8607,4.80391 -5.8494,0.43159 -13.2612,1.12285 -16.4708,1.53606 -5.1821,0.66719 -6.2955,0.30886 -9.9453,-3.2 z"
id="path3247"
inkscape:connector-curvature="0" />
<path
style="fill:#161616;stroke-width:1.30307257"
d="m 2098.7968,461.70794 c -6.9224,-1.94455 -12.3471,-10.16175 -7.8512,-11.89313 0.8636,-0.33265 7.3695,-0.83278 14.4576,-1.11149 13.6461,-0.53649 17.2825,0.59582 16.4559,5.12466 -0.5396,2.95629 -2.2303,3.94316 -10.5002,6.12965 -9.2281,2.43967 -9.8163,2.52158 -12.5621,1.75031 z"
id="path3245"
inkscape:connector-curvature="0" />
<path
style="fill:#161616;stroke-width:1.30307257"
d="m 2085.3242,437.58376 c -4.8312,-2.82111 -6.7804,-7.09286 -4.4034,-9.65053 1.5777,-1.69759 4.2401,-1.7622 18.6516,-0.45322 18.2126,1.65447 22.4048,3.39207 18.45,7.64746 -1.2988,1.39751 -5.6185,2.5989 -11.889,3.30637 -13.8002,1.55702 -16.9042,1.43023 -20.8092,-0.85008 z"
id="path3243"
inkscape:connector-curvature="0" />
<path
style="fill:#161616;stroke-width:1.30307257"
d="m 2075.2627,418.14496 c -6.9334,-6.71615 -4.3453,-7.73424 24.5373,-9.65229 17.581,-1.16746 25.263,-1.22991 26.2081,-0.21316 4.1192,4.43246 -6.9961,9.1477 -27.6777,11.74119 -9.2023,1.15394 -17.234,2.0981 -17.8483,2.0981 -0.6142,0 -2.963,-1.78829 -5.2194,-3.97384 z"
id="path3241"
inkscape:connector-curvature="0" />
</g>
</g>
<path
inkscape:connector-curvature="0"
id="path2157"
d="m 468.81846,-463.47332 c -1.99386,-0.34562 -2.47955,-1.46277 -3.04581,-7.00588 -0.39321,-3.84924 -1.95011,-16.37432 -3.23547,-26.02918 -0.30323,-2.27755 -0.68597,-6.58984 -0.85057,-9.58286 l -0.29924,-5.44184 2.4738,-0.31375 c 6.97646,-0.88479 71.35974,-2.58491 65.68647,-1.73454 -1.46257,0.21923 -1.91896,0.61963 -2.13473,1.87284 -0.15094,0.87669 -0.46802,2.04513 -0.70463,2.59652 -0.37902,0.88328 0.004,0.99639 3.2169,0.95083 3.24939,-0.0461 3.61577,-0.17148 3.35987,-1.15006 -0.15797,-0.60409 0.0206,-1.76195 0.39676,-2.57303 0.69784,-1.50457 1.856,-1.78737 4.46284,-1.08974 1.39292,0.37277 1.40756,0.45286 1.05319,5.75975 -0.19765,2.95995 -0.64512,7.9107 -0.99439,11.00167 -0.39838,3.52556 -0.48358,10.41494 -0.22864,18.48663 0.34087,10.79251 0.27346,12.87287 -0.41817,12.90499 -20.04763,0.93119 -28.6776,1.19202 -46.07984,1.39274 -11.55045,0.13323 -21.7467,0.11294 -22.65834,-0.0451 z m 25.14537,-4.63959 c 0.58059,-2.05418 0.14494,-7.09867 -1.124,-13.0146 -0.4885,-2.27754 -0.99652,-7.18759 -1.12889,-10.9112 -0.13706,-3.8551 -0.51004,-6.93666 -0.86625,-7.1568 -1.09332,-0.67571 8.0622,-1.1578 22.16586,-1.16715 13.20224,-0.009 15.75378,-0.30001 14.88882,-1.69952 -0.93622,-1.51482 -50.08218,-0.20644 -55.53191,1.47839 -0.8904,0.27527 -0.94086,0.48095 -0.30578,1.24619 0.64834,0.7812 1.89812,0.85749 8.46658,0.51681 l 7.70594,-0.39969 -0.21267,4.68306 c -0.14247,3.1372 0.28225,7.68561 1.28667,13.77906 0.82464,5.00281 1.66864,10.37642 1.87552,11.94135 0.28833,2.18074 0.59834,2.80254 1.32734,2.66208 0.52313,-0.1008 1.17688,-0.98189 1.45277,-1.95798 z m -11.44681,-2.3787 c 0.79382,-0.7938 -1.30959,-1.55319 -5.20727,-1.87995 -3.99514,-0.33495 -4.27844,-0.28203 -4.07746,0.76164 0.13004,0.67518 0.91951,1.28392 1.98351,1.52942 1.8032,0.41605 6.75276,0.13736 7.30122,-0.41111 z m -3.13355,-4.67181 c 1.65734,-1.21187 0.61855,-1.82752 -3.02382,-1.79214 -3.59063,0.0349 -4.31727,0.42355 -3.23346,1.72948 0.94531,1.13902 4.73339,1.17695 6.25728,0.0627 z m -0.70803,-3.67821 c 2.92071,-0.40032 3.68801,-1.59928 1.41359,-2.2088 -2.20475,-0.59085 -8.62859,-0.41697 -9.03749,0.24463 -0.65606,1.06154 0.96338,2.34037 2.96376,2.34037 1.05352,0 3.15059,-0.16929 4.66014,-0.3762 z m 1.13927,-4.28911 c 1.15306,-1.15305 -0.36153,-1.84199 -4.04948,-1.84199 -3.90622,0 -4.71428,0.60548 -3.07084,2.30099 0.82328,0.84936 6.15571,0.50561 7.12032,-0.459 z m -1.2046,-3.98605 c 2.78814,-0.81322 0.15673,-1.96507 -4.58468,-2.00685 -3.66063,-0.0322 -2.48937,-0.86784 1.90566,-1.35951 3.53486,-0.39544 5.70115,-1.35814 5.13121,-2.28033 -0.26398,-0.42712 -2.31649,-0.49601 -6.32028,-0.21216 -7.40456,0.52496 -7.89893,0.68761 -6.56617,2.16029 0.55251,0.61053 1.42919,1.13106 1.94815,1.15675 0.61151,0.0303 0.68334,0.1517 0.2041,0.34508 -1.19213,0.48104 -0.85041,1.9661 0.59156,2.57089 1.23855,0.51946 5.30499,0.32162 7.69045,-0.37416 z"
style="fill:#fdfdd2;fill-opacity:1;stroke:none;stroke-width:0.59157223px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" />
<text
xml:space="preserve"
style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:36px;line-height:125%;font-family:'DejaVu Sans';-inkscape-font-specification:'DejaVu Sans Bold';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.75px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
x="177.90413"
y="466.5358"
id="text1137-3" />
<g
transform="matrix(0.43162108,0,0,0.37310069,-142.51071,-612.87753)"
id="g3077">
<path
style="display:inline;fill:#fee3fc;fill-opacity:1;stroke:none"
d="m 796.72964,795.46886 c -28.15885,-3.38238 -59.1579,-11.17271 -61.86084,-15.54616 -2.20379,-3.5658 8.71818,-13.34277 22.9771,-20.56831 25.09227,-12.71522 45.18971,-16.19287 101.68928,-17.59629 33.25313,-0.82599 51.36777,-0.44355 50.43555,1.06481 -2.37712,3.84628 13.62809,9.99402 40.02177,15.37271 25.26262,5.14819 38.36132,10.66518 38.36132,16.15724 0,4.07519 -19.98438,13.93218 -35.17153,17.34782 -36.35998,8.17747 -105.81755,9.85036 -156.45265,3.76818 z"
id="path8383"
inkscape:connector-curvature="0" />
<path
style="display:inline;fill:#fee3fc;fill-opacity:1;stroke:none"
d="m 822.19868,957.94987 c -40.05573,-5.90283 -65.51346,-15.0004 -72.70993,-25.98359 -2.01682,-3.07806 -4.30035,-10.43745 -5.07452,-16.3542 -1.2898,-9.85762 -5.37106,-116.6071 -4.51748,-118.15939 0.20392,-0.37085 3.52386,0.58097 7.37763,2.11514 14.99739,5.97043 40.58646,9.39838 90.43437,12.11472 58.32742,3.17842 97.18218,0.81229 128.48792,-7.82447 9.82609,-2.71087 18.76955,-4.01783 19.87437,-2.90436 4.88343,4.92165 10.38147,122.45861 5.915,126.45076 -6.16256,5.50812 -47.00687,18.9145 -80.03933,26.27141 -16.45108,3.66395 -74.97521,6.45099 -89.74803,4.27398 z"
id="path8385"
inkscape:connector-curvature="0" />
<path
inkscape:connector-curvature="0"
id="path3265"
d="m 871.23286,728.31478 c -33.8154,-0.047 -63.70282,1.7376 -78.49995,5.0313 -14.69211,3.2703 -34.44393,9.4876 -43.9375,13.8437 -7.12982,3.2714 -18.3797,11.3106 -21.8125,15.5938 -5.56118,6.9387 -4.6923,18.7403 1.65625,25.7812 -0.49009,1.7206 -0.5,5.7969 -0.5,15.9375 0,39.5719 0.99004,70.7154 2.6875,85.81249 0.97688,8.6883 2.01698,16.1781 2.3125,16.6563 0.29552,0.4781 0.0157,3.1895 -0.59375,6.0312 -2.39006,11.1445 3.85236,24.6775 15.78125,34.2813 11.08521,8.9246 32.85571,17.6749 50.3125,20.2187 2.475,0.3607 5.85,1.0603 7.5,1.5313 3.4844,0.9948 19.8457,2.7077 33.5,3.5312 5.2182,0.3147 9.6951,0.7889 9.9375,1.0313 0.2424,0.2426 1.8107,0.2129 3.5,-0.062 1.6893,-0.2756 9.5875,-0.7583 17.5625,-1.0625 26.8286,-1.0233 40.6891,-2.8183 53.5,-6.9688 2.2,-0.7128 6.7,-1.8498 10,-2.5312 9.7684,-2.017 25.5698,-10.0033 31.1411,-15.221 4.066,-3.8078 4.1245,-5.3302 1.1992,-5.9665 -2.3697,-0.5154 -14.741,1.7444 -16.1216,3.125 -0.6108,0.6108 -2.0931,1.0937 -3.3125,1.0937 -1.2194,0 -4.1794,0.8402 -6.5625,1.8438 -2.3831,1.0036 -8.8437,2.8316 -14.3437,4.0625 -5.5,1.2308 -11.5632,2.625 -13.5,3.125 -3.5549,0.9176 -11.249,2.154 -25,4 -11.9123,1.5992 -39.214,2.0708 -55,0.9375 -16.8428,-1.2091 -41.82599,-5.1938 -50.15625,-8 -3.18066,-1.0715 -6.29629,-1.9688 -6.9375,-1.9688 -0.64122,0 -5.49261,-2.0298 -10.78125,-4.5312 -15.82805,-7.4866 -22.28641,-15.4906 -21.375,-26.4688 0.25114,-3.025 -0.29514,-12.025 -1.21875,-20 -0.92362,-7.975 -1.86849,-25.07499 -2.125,-37.99999 -0.2565,-12.925 -0.75656,-33.6025 -1.09375,-45.9687 l -0.5625,-19.9063 c 5.54399,2.7043 12.59759,5.2719 19.5,6.9688 9.2983,2.2858 12.9371,2.9582 29.84375,5.5312 20.955,3.1891 102.90735,5.6605 123.99995,3.75 34.7729,-3.1497 44.5459,-4.9076 66.5625,-11.9375 7.6722,-2.4497 9.9375,-1.9858 9.9375,2.0313 0,1.5675 0.6481,5.0689 1.4375,7.7812 1.8828,6.4687 3.3933,25.9188 4.0625,51.9375 0.297,11.55 1.0102,29.53239 1.5937,39.93749 1.0839,19.3272 0.7233,26.7042 -1.4062,28.3125 -0.6606,0.4989 -5.6875,2.3881 -11.1875,4.1875 -5.5,1.7995 -14.5603,4.7759 -15.3853,5.5822 -1.3294,1.2992 -2.038,2.1863 0.5115,4.4004 2.7326,2.3727 8.1829,1.202 18.7488,1.0174 6.1516,-0.1075 12.2424,0.2832 13.62504,0.875 3.4046,1.4571 3.4429,1.4474 5.375,-0.6875 1.4486,-1.6006 1.7007,-4.2291 1.7187,-17.5 0.012,-8.5808 -0.2056,-15.9615 -0.5,-16.4375 -0.2941,-0.4761 -0.769,-11.6355 -1.0624,-24.78119 -1.2602,-56.4483 -4.2972,-83.3899 -10.03134,-89.375 l -2.5937,-2.7188 3.5312,-5.25 c 2.9741,-4.4195 3.56254,-6.1375 3.56254,-10.7187 0,-7.999 -4.06084,-15.0163 -12.00004,-20.7813 -4.467,-3.2436 -21.2211,-8.9974 -29.5625,-10.1562 -2.1772,-0.3024 -7.3125,-1.1775 -11.4375,-1.9375 -4.125,-0.7599 -14.1375,-1.5813 -22.25,-1.8125 -12.0828,-0.3444 -14.75,-0.1626 -14.75,0.9687 0,0.7596 0.959,1.375 2.1563,1.375 1.1973,0 4.4598,1.5683 7.25,3.4688 4.4536,3.0335 6.4981,3.6317 16.5937,5.0312 18.9996,2.6339 36.0706,6.4855 42.625,9.5938 6.2374,2.9581 12.375,7.8176 12.375,9.8125 0,0.6028 -1.5607,2.7976 -3.4375,4.875 -3.0046,3.3256 -8.0565,6.1745 -19.0625,10.75 -3.7391,1.5544 -15.3655,4.5382 -22,5.625 -29.0373,4.7569 -42.0633,5.5654 -82,5.25 -38.21815,-0.3018 -49.36885,-0.7147 -60.49995,-2.3438 -3.575,-0.5233 -11,-1.477 -16.5,-2.0937 -23.55531,-2.6414 -48.79512,-9.2846 -53.0625,-14 -2.94091,-3.2497 -1.16978,-8.1774 4.84375,-13.5 5.10326,-4.517 24.14318,-14.5962 30.21875,-16 1.64155,-0.3793 7.05,-2.0297 12,-3.6563 4.94997,-1.6266 11.25,-3.3775 14,-3.9062 8.05,-1.5479 33.3118,-4.6016 45.49995,-5.5 6.4369,-0.4746 59.0867,-0.4045 67.7813,0.094 20.592,1.1801 38.3617,6.1469 41.3575,7.1099 4.696,1.5094 6.2206,0.8867 4.6309,-3.6736 -2.0888,-5.9917 -6.3864,-11.5689 -36.2697,-13.0925 -15.9406,-0.8128 -32.1293,-1.1976 -47.5,-1.2188 z"
style="fill:#161616"
sodipodi:nodetypes="cscscsscssccsccscsccsssccsssscssscccsssscssccccsccccscccssccssssscsccsscssssscccccscc" />
</g>
<path
style="fill:#161616;stroke-width:0.30228513"
d="m 250.91155,-344.05225 c -0.39156,-0.55579 -0.41732,-1.02052 -0.25814,-4.65852 0.0972,-2.2226 0.28113,-4.53693 0.40862,-5.14285 0.12745,-0.60597 0.30205,-1.88675 0.38795,-2.84619 0.0859,-0.95944 0.25671,-1.8836 0.37963,-2.05368 0.12291,-0.17012 0.22348,-0.64998 0.22348,-1.06638 0,-0.41637 0.10422,-1.10351 0.2317,-1.52693 0.12739,-0.42345 0.36084,-1.51358 0.51869,-2.42255 0.15774,-0.90893 0.44751,-2.07851 0.64377,-2.59897 0.19632,-0.52053 0.35977,-1.18156 0.36328,-1.46902 0.004,-0.28743 0.29059,-1.51416 0.63805,-2.72609 0.34745,-1.2119 0.73049,-2.57531 0.85129,-3.02978 0.12077,-0.45447 0.40241,-1.3634 0.62586,-2.01987 0.22349,-0.65646 0.51114,-1.55089 0.63924,-1.98771 0.12817,-0.43678 0.62883,-1.66245 1.11258,-2.7237 0.48377,-1.06125 0.8796,-2.05525 0.8796,-2.20896 0,-0.15368 0.28145,-0.69075 0.62542,-1.19337 0.34398,-0.50273 0.62539,-1.09723 0.62539,-1.32125 0,-0.22401 0.0949,-0.48577 0.2109,-0.58165 0.11605,-0.096 0.40675,-0.67026 0.64599,-1.2762 0.23928,-0.60599 0.59219,-1.34967 0.78433,-1.65265 0.63183,-0.99652 2.86162,-5.17329 2.86162,-5.36044 0,-0.10075 0.22089,-0.32993 0.49087,-0.50929 0.26998,-0.17932 0.62194,-0.62595 0.78212,-0.99247 0.16013,-0.3665 0.4325,-0.79033 0.60518,-0.9418 0.17273,-0.1515 0.39068,-0.48201 0.48446,-0.73453 0.0937,-0.25248 0.26542,-0.62432 0.38154,-0.82628 1.21192,-2.1077 1.1544,-2.55499 -0.27762,-2.15819 -0.63692,0.17647 -0.92041,0.16276 -1.55996,-0.0755 -1.49199,-0.55585 -1.49322,-0.55122 0.54778,-2.0491 1.05752,-0.77607 2.76702,-2.06308 3.79892,-2.85997 2.07892,-1.60559 2.90398,-1.94667 4.7085,-1.94667 0.93678,0 1.37058,0.10097 1.8576,0.43224 0.58237,0.3962 0.64808,0.59904 0.78794,2.43302 0.0839,1.10045 0.26207,2.74348 0.39591,3.65116 0.20513,1.39148 0.18421,1.6938 -0.13332,1.92685 -0.33535,0.24616 -0.50592,0.22629 -1.55757,-0.18141 -1.57251,-0.60964 -2.0289,-1.31637 -2.04451,-3.16627 -0.007,-0.78271 -0.10197,-1.4231 -0.21192,-1.4231 -0.10996,0 -0.34456,0.30988 -0.52134,0.68857 -0.17678,0.37877 -0.55143,1.06043 -0.83253,1.51493 -0.28107,0.45447 -0.8993,1.48736 -1.37383,2.29528 -0.47453,0.80795 -1.34901,2.21268 -1.94328,3.12164 -0.59431,0.90891 -1.25668,1.94722 -1.47181,2.30731 -1.08947,1.82312 -2.51447,4.39551 -2.84152,5.12944 -0.20251,0.45446 -0.63917,1.2911 -0.97035,1.85922 -0.33122,0.56804 -0.60226,1.20958 -0.60226,1.42556 0,0.37026 -0.0784,0.52264 -0.78808,1.5312 -0.15829,0.22495 -0.43974,0.80337 -0.62539,1.28536 -0.18565,0.48201 -0.51512,1.31016 -0.73206,1.84043 -0.36001,0.87952 -0.79296,2.10979 -1.34097,3.81018 -0.11395,0.35346 -0.38134,1.11289 -0.59418,1.68764 -0.21287,0.57469 -0.45894,1.44234 -0.54679,1.92802 -0.0879,0.48573 -0.25913,1.04835 -0.38054,1.25036 -0.33443,0.55639 -2.16603,7.9567 -2.36328,9.54843 -0.0626,0.50498 -0.34892,2.15759 -0.63637,3.6725 -0.28745,1.51487 -0.47474,3.16559 -0.4163,3.6683 0.0584,0.50269 0.0116,1.08109 -0.10368,1.28535 -0.38679,0.68416 -0.68802,6.03528 -0.43496,7.72598 0.27886,1.86236 0.14055,2.06969 -1.48763,2.22998 -0.95155,0.0937 -1.03953,0.0622 -1.44802,-0.51763 z"
id="path3261"
inkscape:connector-curvature="0" />
<text
transform="scale(1.0404018,0.96116714)"
xml:space="preserve"
style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:4.10873px;line-height:0%;font-family:'DejaVu Sans';-inkscape-font-specification:'DejaVu Sans Bold';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;display:inline;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.342394"
x="174.19933"
y="-239.95801"
id="text3324-9-3"><tspan
sodipodi:role="line"
x="174.19933"
y="-239.95801"
style="font-size:16.4349px;line-height:1.25;stroke-width:0.342394"
id="tspan1550">--spool-dir</tspan></text>
<flowRoot
transform="matrix(0.59703729,0,0,0.55486049,690.1363,-531.71402)"
xml:space="preserve"
id="flowRoot1554"
style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:48px;line-height:125%;font-family:'DejaVu Sans';-inkscape-font-specification:'DejaVu Sans Bold';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"><flowRegion
id="flowRegion1556"><rect
id="rect1558"
width="134.43214"
height="309.05533"
x="1459.351"
y="169.02161" /></flowRegion><flowPara
id="flowPara1560" /></flowRoot>
<flowRoot
transform="matrix(0.59703729,0,0,0.55486049,690.1363,-531.71402)"
xml:space="preserve"
id="flowRoot1562"
style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:48px;line-height:125%;font-family:'DejaVu Sans';-inkscape-font-specification:'DejaVu Sans Bold';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"><flowRegion
id="flowRegion1564"><rect
id="rect1566"
width="264.7066"
height="353.40408"
x="1433.0189"
y="151.00493" /></flowRegion><flowPara
id="flowPara1568" /></flowRoot>
<path
sodipodi:nodetypes="ccccccccccsccsccccscccscccccsccsscccccc"
style="fill:#161616;stroke-width:0.29839823"
d="m 210.4769,-374.02905 c -0.17536,-0.58897 -0.33607,-0.87232 -0.66736,-1.73314 -0.33128,-0.86087 -0.60634,-1.71345 -0.61121,-1.89468 -0.005,-0.18122 -0.25059,-0.73727 -0.54609,-1.23563 -0.29543,-0.49841 -0.82754,-1.72168 -1.18241,-2.71839 -1.55855,-3.29086 1.94023,2.44521 -4.82074,-8.81426 -0.35174,-0.49835 -0.96277,-1.42514 -1.35787,-2.05939 -0.39512,-0.63431 -1.00511,-1.56104 -1.35552,-2.05939 -0.35038,-0.49842 -0.84766,-1.2398 -1.10499,-1.64755 -0.25731,-0.40779 -1.19869,-1.57978 -2.09196,-2.60447 -0.89325,-1.02469 -1.62412,-1.90782 -1.62412,-1.96253 0,-0.20851 -2.84301,-2.78724 -3.59276,-3.25872 -2.44446,-1.53733 -2.73378,-2.2743 -0.92315,-2.35147 3.35602,-0.14299 7.02947,3.0083 12.53575,10.75382 0.90182,1.26856 1.96366,2.82548 2.35957,3.45978 0.39597,0.63431 0.85923,1.37569 1.02942,1.64754 3.04487,4.46751 9.60868,20.90989 9.86084,27.21708 0.1082,0.97861 0.19742,1.96466 0.19812,2.19123 0,0.22651 0.18541,1.18022 0.41038,2.1193 0.22496,0.93909 0.38781,2.05117 0.3619,2.47131 -0.026,0.42009 0.0408,0.9862 0.14834,1.25809 0.10758,0.2718 0.0734,1.19853 -0.0758,2.0594 -0.1492,0.86082 -0.20259,1.62715 -0.11863,1.70298 0.0838,0.0758 0.57755,-0.082 1.09704,-0.3509 2.03659,-1.05395 2.96171,-1.0352 3.33984,0.0677 0.14164,0.4132 0.0559,0.70503 -0.29248,0.99602 -0.27098,0.22632 -0.41144,0.52747 -0.31209,0.66922 0.0994,0.14165 -0.0155,0.37664 -0.25489,0.52212 -0.7335,0.44543 -2.0978,2.70188 -2.43117,4.02098 -0.16195,0.6408 -0.34257,0.82065 -0.9514,0.94737 -1.05217,0.21887 -2.61306,0.19462 -3.19666,-0.0496 -0.2706,-0.11328 -0.96889,-0.76202 -1.55181,-1.44165 -1.5688,-1.82896 -4.12745,-4.31431 -5.07098,-4.92565 -1.11356,-0.7215 -1.08321,-1.25417 0.0904,-1.58628 0.50803,-0.14379 1.18931,-0.21277 1.52509,-0.15445 0.99242,0.1724 2.66593,1.06853 3.3344,1.78557 0.86674,0.92976 1.79673,1.58906 2.09775,1.48723 0.37576,-0.12706 0.30258,-1.77431 -0.22243,-5.00872 -2.16459,-15.58553 -0.81151,-7.46499 -3.77837,-18.61704"
id="path3259"
inkscape:connector-curvature="0" />
<text
id="text1137"
y="455.51312"
x="-360.74921"
style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:36px;line-height:125%;font-family:'DejaVu Sans';-inkscape-font-specification:'DejaVu Sans Bold';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.75px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
xml:space="preserve" />
<text
xml:space="preserve"
style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:3.7832px;line-height:0%;font-family:'DejaVu Sans';-inkscape-font-specification:'DejaVu Sans Bold';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;display:inline;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.315267"
x="-45.23877"
y="-415.38376"
id="text3053-3-7"
transform="scale(1.0407029,0.96088902)"><tspan
id="tspan1141-5"
sodipodi:role="line"
x="-45.23877"
y="-415.38376"
style="font-size:15.1328px;line-height:1.25;stroke-width:0.315267">--domain=example.com</tspan><tspan
id="tspan2718"
sodipodi:role="line"
x="-45.23877"
y="-396.46777"
style="font-size:15.1328px;line-height:1.25;stroke-width:0.315267">--address-verifier=account:</tspan></text>
</g>
</g>
</svg>
Side by Side

After

Width:  |  Height:  |  Size: 59 KiB

2
doc/man2html-missing.html
View File

@ -12,4 +12,4 @@
</div>
</body>
</html>
<!-- Copyright (C) 2001-2022 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->
<!-- Copyright (C) 2001-2023 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->

BIN
doc/popbyname.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 26 KiB

431
doc/popbyname.svg Normal file
View File

@ -0,0 +1,431 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<svg
<!-- Copyright (C) 2001-2023 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->
xmlns:dc="http://purl.org/dc/elements/1.1/"
xmlns:cc="http://creativecommons.org/ns#"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns="http://www.w3.org/2000/svg"
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
version="1.0"
width="210mm"
height="297mm"
viewBox="0 0 595.27559 841.88976"
preserveAspectRatio="xMidYMid meet"
id="svg8"
sodipodi:docname="popbyname.svg"
inkscape:version="0.92.4 (5da689c313, 2019-01-14)"
inkscape:export-filename="/home/graeme/src/trunk/gnetapps/emailrelay/doc/graphics/popbyname.png"
inkscape:export-xdpi="15.59"
inkscape:export-ydpi="15.59">
<defs
id="defs12">
<inkscape:path-effect
effect="fill_between_many"
method="originald"
linkedpaths="#path4,0"
id="path-effect2166"
is_visible="true"
allow_transforms="false" />
<inkscape:path-effect
allow_transforms="false"
is_visible="true"
effect="fill_between_many"
method="originald"
linkedpaths="#path4,0"
id="path-effect2166-3" />
</defs>
<sodipodi:namedview
pagecolor="#ffffff"
bordercolor="#666666"
borderopacity="1"
objecttolerance="10"
gridtolerance="10"
guidetolerance="10"
inkscape:pageopacity="0"
inkscape:pageshadow="2"
inkscape:window-width="1835"
inkscape:window-height="1357"
id="namedview10"
showgrid="false"
inkscape:zoom="0.71252295"
inkscape:cx="521.99332"
inkscape:cy="710.42418"
inkscape:window-x="839"
inkscape:window-y="208"
inkscape:window-maximized="0"
inkscape:current-layer="layer2"
inkscape:pagecheckerboard="0"
inkscape:document-units="pt"
units="mm" />
<metadata
id="metadata2">
Created by potrace 1.16, written by Peter Selinger 2001-2019
<rdf:RDF>
<cc:Work
rdf:about="">
<dc:format>image/svg+xml</dc:format>
<dc:type
rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
<dc:title />
</cc:Work>
</rdf:RDF>
</metadata>
<g
inkscape:groupmode="layer"
id="layer2"
inkscape:label="lines"
style="display:inline"
transform="translate(0,614.88976)">
<g
id="g957"
inkscape:export-xdpi="46.889999"
inkscape:export-ydpi="46.889999">
<flowRoot
style="fill:black;stroke:none;stroke-opacity:1;stroke-width:1px;stroke-linejoin:miter;stroke-linecap:butt;fill-opacity:1;font-family:DejaVu Sans;font-style:normal;font-weight:bold;font-size:48px;line-height:125%;letter-spacing:0px;word-spacing:0px;-inkscape-font-specification:DejaVu Sans Bold;font-stretch:normal;font-variant:normal;text-anchor:start;text-align:start;writing-mode:lr"
id="flowRoot1095"
xml:space="preserve"><flowRegion
id="flowRegion1097"><rect
y="1673.1166"
x="258.28561"
height="213.43361"
width="218.07347"
id="rect1099" /></flowRegion><flowPara
id="flowPara1101" /></flowRoot> <flowRoot
style="fill:black;stroke:none;stroke-opacity:1;stroke-width:1px;stroke-linejoin:miter;stroke-linecap:butt;fill-opacity:1;font-family:DejaVu Sans;font-style:normal;font-weight:bold;font-size:48px;line-height:125%;letter-spacing:0px;word-spacing:0px;-inkscape-font-specification:DejaVu Sans Bold;font-stretch:normal;font-variant:normal;text-anchor:start;text-align:start;writing-mode:lr"
id="flowRoot1103"
xml:space="preserve"><flowRegion
id="flowRegion1105"><rect
y="1683.9429"
x="133.00935"
height="157.75528"
width="406.76117"
id="rect1107" /></flowRegion><flowPara
id="flowPara1109" /></flowRoot> <path
inkscape:connector-curvature="0"
id="path3257"
d="m 178.61694,-404.08361 c 5.24105,1.93607 5.90555,2.10141 13.4552,4.00142 0.63159,0.15896 2.03421,0.40845 3.11694,0.55444 1.08273,0.14599 3.22357,0.47852 4.75743,0.73892 5.85246,0.99363 18.55243,1.36034 27.43927,0.79224 6.42907,-0.41097 15.80554,-1.58109 19.47888,-2.43082 0.63158,-0.14608 1.8462,-0.34731 2.69916,-0.44713 0.85296,-0.0998 1.63679,-0.30997 1.74187,-0.46695 0.1051,-0.15698 0.65171,-0.28543 1.21472,-0.28543 0.56303,0 1.47711,-0.12586 2.03127,-0.2797 0.55419,-0.15383 1.81964,-0.44765 2.81214,-0.65295 0.9925,-0.20527 2.91187,-0.71238 4.26528,-1.12689 1.35341,-0.41451 2.9775,-0.86128 3.6091,-0.99281 1.74946,-0.36434 5.45123,-1.62728 8.30267,-2.83264 1.40853,-0.59539 2.78835,-1.08254 3.06632,-1.08254 0.27796,0 0.89725,-0.18548 1.37624,-0.41221 0.479,-0.22671 2.49496,-1.12964 4.47996,-2.00652 5.21776,-2.30501 10.1791,-4.9966 14.3787,-7.80064 4.49453,-3.00101 11.69709,-9.87211 13.68612,-13.05637 0.2775,-0.44422 0.87963,-1.35297 1.33808,-2.01943 1.32982,-1.93324 3.42269,-5.90196 4.1535,-7.87634 2.42944,-6.56318 3.03751,-10.15478 2.88911,-17.06434 -0.18193,-8.47115 -1.01422,-12.60844 -4.21515,-20.95415 -4.08359,-10.647 -12.57733,-20.71468 -23.04359,-27.3136 -6.48317,-4.08761 -14.93536,-7.81251 -20.99833,-9.2541 -1.08272,-0.25743 -3.22357,-0.79133 -4.75743,-1.18645 -6.47563,-1.66805 -12.35317,-2.29595 -21.81859,-2.33082 -6.82609,-0.0251 -8.06293,0.0528 -12.9599,0.81635 -5.46321,0.85192 -12.33514,2.24734 -15.13658,3.07366 -0.83626,0.24668 -1.69982,0.44849 -1.91902,0.44849 -0.2192,0 -0.86379,0.19325 -1.43241,0.42944 -0.56863,0.23617 -1.99356,0.73078 -3.16652,1.09909 -1.17296,0.36828 -2.42793,0.81556 -2.78884,0.99393 -0.57844,0.28588 -0.48557,0.35204 0.78353,0.5584 1.6064,0.26123 1.83259,0.3801 1.54388,0.81142 -0.19443,0.29048 -1.56866,0.79736 -7.57662,2.79471 -1.62388,0.53986 -4.57677,1.69792 -6.56198,2.57347 -3.28969,1.45085 -4.4836,2.05997 -9.4859,4.83962 -2.4158,1.34237 -8.8396,5.7915 -11.1847,7.74647 -0.36091,0.30087 -1.39048,1.13173 -2.28792,1.84636 -3.47204,2.76475 -10.5948,9.61901 -12.80463,12.32199 -0.72181,0.88291 -1.83442,2.17202 -2.47246,2.86471 -2.66739,2.89586 -5.20428,6.69029 -8.20411,12.27083 -5.65702,10.52364 -6.96065,20.79345 -3.78631,29.82801 1.27598,3.6316 3.92329,8.64737 6.02593,11.41709 5.94466,7.83068 15.67275,14.51442 27.46669,18.87116 m -0.26753,2.56029 c -11.66496,-4.45246 -20.22176,-10.15787 -26.77465,-17.55954 -4.55576,-5.14589 -6.16398,-7.62193 -8.22095,-12.65707 -0.57855,-1.41622 -1.25986,-3.02263 -1.514,-3.56976 -0.25415,-0.54717 -0.46209,-1.39029 -0.46209,-1.87363 0,-0.48337 -0.16164,-1.26258 -0.3592,-1.73162 -0.49654,-1.17884 -0.71864,-8.24347 -0.34586,-11.00116 0.4418,-3.26832 1.36497,-7.66655 1.68425,-8.02429 0.15044,-0.16855 0.58864,-1.19254 0.97378,-2.27554 0.38513,-1.08299 1.15311,-2.85517 1.70662,-3.93817 2.60432,-5.09563 2.7983,-5.41204 6.08511,-9.92573 0.93845,-1.28875 2.1196,-2.936 2.62479,-3.66053 1.40948,-2.0215 7.66296,-8.58409 11.88922,-12.47691 10.60431,-9.7676 18.87851,-14.95338 31.84619,-19.95922 1.45685,-0.56237 2.92922,-1.39342 3.60909,-2.03703 1.26191,-1.19463 2.35542,-1.69854 3.10769,-1.43198 0.27407,0.0971 1.17568,-0.29073 2.05346,-0.88331 2.02456,-1.36669 4.98266,-2.5854 9.2752,-3.82135 1.89477,-0.54556 3.88798,-1.17655 4.42934,-1.40217 1.0801,-0.4502 8.83127,-1.97975 10.66321,-2.10423 0.6316,-0.0429 2.18186,-0.25274 3.44504,-0.46631 3.38516,-0.57237 17.79438,-0.49999 21.81858,0.10957 1.71431,0.25968 4.07662,0.61845 5.24957,0.79727 4.0994,0.62502 10.06123,2.23718 15.42066,4.16995 16.55876,5.9716 28.87355,15.66044 37.14022,29.22055 1.92352,3.1552 4.47452,8.48425 5.48155,11.45105 1.42044,4.18461 1.67157,5.00508 1.67157,5.46127 0,0.28282 0.28889,1.58945 0.64199,2.90358 0.82425,3.06778 1.40098,10.53374 1.14402,14.80977 -0.3325,5.5334 -2.04379,12.2747 -4.19104,16.50966 -0.4951,0.97648 -3.93424,6.44263 -5.0791,8.07279 -2.99341,4.26213 -8.94476,9.83952 -13.55767,12.70569 -0.92809,0.57667 -2.22077,1.42595 -2.87259,1.88726 -0.65184,0.46134 -1.55428,1.00269 -2.00542,1.20302 -0.45113,0.20034 -1.7061,0.9049 -2.78883,1.56573 -1.08273,0.66082 -2.3377,1.34285 -2.78884,1.51562 -0.45114,0.17279 -1.04171,0.44489 -1.3124,0.60472 -0.64035,0.37807 -4.54859,2.13327 -4.75008,2.13327 -0.0852,0 -1.15527,0.42621 -2.37786,0.94714 -1.22256,0.52092 -3.18256,1.26478 -4.35552,1.65306 -1.17295,0.38827 -2.94469,0.99965 -3.93718,1.35863 -0.99251,0.35898 -2.46895,0.83169 -3.28099,1.0505 -0.81205,0.21878 -2.36231,0.66573 -3.44504,0.99317 -1.08274,0.32748 -2.78065,0.76474 -3.77315,0.9717 -0.9925,0.207 -2.09845,0.51699 -2.4577,0.68891 -0.66764,0.31954 -5.20955,1.26434 -8.269,1.72011 -0.93722,0.13962 -1.83167,0.32668 -1.98769,0.41574 -1.21078,0.69091 -25.75199,3.07304 -29.44631,2.85826 -0.54136,-0.0315 -2.23928,-0.0924 -3.77314,-0.13531 -14.02901,-0.39288 -26.96727,-2.70108 -37.34585,-6.66251"
style="fill:#161616;stroke-width:0.31526655"
sodipodi:nodetypes="csscscsssccsscsssscccssssssscsccsccssssssssssccsscssscsssssssccsccsscsssscsscscssccssssccccscssc" />
<g
transform="matrix(0.32809885,0,0,0.30293618,20.356524,-532.51631)"
style="display:inline"
inkscape:label="colour"
id="layer6">
<path
inkscape:connector-curvature="0"
id="path7860"
d="m 554.99775,441.33848 c -75.21714,-9.37864 -141.10301,-48.21472 -165.49853,-97.5523 -12.16037,-24.59314 -14.91307,-37.10424 -13.36523,-60.7455 2.83502,-43.30151 25.87459,-86.11586 70.69643,-131.37492 35.78606,-36.13513 64.67414,-55.667175 107.95002,-72.988037 20.00723,-8.007756 27.06735,-12.945778 19.01164,-13.29721 -8.19547,-0.357528 23.83022,-10.32233 51.07725,-15.8927 27.73809,-5.670761 34.51142,-6.171832 68.38466,-5.058892 30.95125,1.016936 41.65196,2.386243 60.53611,7.746461 91.2608,25.904136 149.14818,94.538608 154.45538,183.130968 6.1079,101.95624 -77.07608,174.58867 -230.75804,201.48742 -33.24747,5.81926 -94.14629,8.07877 -122.48969,4.54471 z"
style="display:inline;fill:#ddffdd;fill-opacity:1;stroke:none" />
</g>
<text
xml:space="preserve"
style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:3.78319883px;line-height:0%;font-family:'DejaVu Sans';-inkscape-font-specification:'DejaVu Sans Bold';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;display:inline;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.31526655"
x="50.548248"
y="-383.24792"
id="text3302"
transform="scale(1.0407029,0.960889)"><tspan
sodipodi:role="line"
id="tspan3304"
x="50.548248"
y="-383.24792"
style="font-size:15.13279533px;line-height:1.25;stroke-width:0.31526655">--spool-dir</tspan></text>
<text
xml:space="preserve"
style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:3.78319883px;line-height:0%;font-family:'DejaVu Sans';-inkscape-font-specification:'DejaVu Sans Bold';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;display:inline;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.31526655"
x="288.38611"
y="-582.04529"
id="text3053-3"
transform="scale(1.0407029,0.960889)"><tspan
sodipodi:role="line"
id="tspan3055-6"
x="288.38611"
y="-581.06256"
style="font-size:15.13279533px;line-height:1.25;stroke-width:0.31526655" /><tspan
id="tspan1141"
sodipodi:role="line"
x="288.38611"
y="-568.65631"
style="font-size:15.13279533px;line-height:1.25;stroke-width:0.31526655">--pop</tspan><tspan
id="tspan1133"
sodipodi:role="line"
x="288.38611"
y="-549.7403"
style="font-size:15.13279533px;line-height:1.25;stroke-width:0.31526655">--pop-port=110</tspan></text>
<path
style="fill:#161616;stroke-width:0.33527976"
d="m 325.06371,-470.92266 c -0.61647,-0.93353 -0.67477,-2.85076 -0.10114,-3.32618 1.00235,-0.8307 6.70048,-3.60623 11.7897,-5.7426 1.36032,-0.57108 2.73107,-1.18642 3.04599,-1.36747 0.31494,-0.18105 0.79891,-0.32918 1.07539,-0.32918 0.27651,0 1.13182,-0.30029 1.90073,-0.66728 0.76887,-0.36703 1.76896,-0.74777 2.22242,-0.84617 0.77488,-0.1681 3.31107,-1.05606 4.78183,-1.67419 1.08362,-0.45546 5.17987,-1.62408 6.59561,-1.88166 0.72554,-0.13204 1.50305,-0.40123 1.72783,-0.59823 0.2248,-0.19703 1.33779,-0.39438 2.47335,-0.43856 1.34182,-0.0522 2.55127,-0.34475 3.45453,-0.83552 0.76443,-0.41534 1.87739,-0.7398 2.47336,-0.72105 0.59593,0.0189 1.9739,-0.21452 3.06218,-0.51844 1.08829,-0.3039 2.47076,-0.555 3.07215,-0.55801 0.60143,-0.004 1.38933,-0.17339 1.75094,-0.37868 2.23737,-1.27002 28.89294,-2.31427 41.5112,-1.62621 3.53688,0.19287 7.16152,0.36749 8.05472,0.38805 l 1.62401,0.0373 -0.0791,-2.32626 c -0.0476,-1.40109 0.0649,-2.42071 0.28309,-2.5637 0.19919,-0.13057 0.83959,0.0561 1.42311,0.41477 0.58351,0.35867 1.72874,0.86201 2.54493,1.11854 4.26712,1.34103 9.47435,3.70112 11.19419,5.0736 0.62472,0.49854 1.34539,0.90642 1.60146,0.90642 0.25612,0 1.04343,0.48543 1.74975,1.07873 1.26538,1.06303 1.28412,1.11322 1.28412,3.44361 0,3.19594 -0.24752,3.38986 -6.06698,4.75268 -1.25093,0.29298 -3.15654,1.03133 -4.23465,1.64079 -2.40635,1.36038 -3.00759,1.1311 -3.15339,-1.20259 -0.0957,-1.53197 -0.0478,-1.62204 1.48406,-2.79171 1.35828,-1.03722 3.3022,-1.9944 5.84608,-2.87865 0.54723,-0.19021 0.57013,-0.28644 0.16493,-0.69148 -0.57115,-0.57085 -10.90409,-1.68008 -16.4867,-1.7698 -2.09774,-0.0336 -3.98833,-0.17559 -4.20142,-0.31526 -0.41716,-0.27346 -23.78309,-0.32848 -27.60093,-0.065 -1.26964,0.0877 -3.94088,0.25874 -5.93606,0.38022 -1.99518,0.12148 -4.66647,0.38672 -5.93611,0.58942 -1.26962,0.2027 -2.90203,0.4155 -3.62757,0.47287 -1.54756,0.12239 -6.74756,1.0413 -7.69219,1.35929 -0.35937,0.12099 -1.44687,0.36829 -2.41666,0.54954 -4.24779,0.79401 -13.30133,3.32522 -15.6141,4.3654 -0.54413,0.24475 -1.65712,0.63517 -2.47333,0.86764 -3.48248,0.99173 -16.25337,6.60197 -19.47594,8.55565 -1.80485,1.09426 -2.43556,1.11857 -3.09541,0.11934 z"
id="path3235"
inkscape:connector-curvature="0" />
<text
id="text3324-9"
y="-394.27353"
x="305.74783"
style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:4.00874519px;line-height:0%;font-family:'DejaVu Sans';-inkscape-font-specification:'DejaVu Sans Bold';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;display:inline;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.3340621"
xml:space="preserve"
transform="scale(1.0663509,0.9377776)"><tspan
style="font-size:16.03498077px;line-height:1.25;stroke-width:0.3340621"
y="-394.27353"
x="305.74783"
id="tspan3326-1"
sodipodi:role="line">--pop-auth</tspan></text>
<path
sodipodi:nodetypes="ccccczcc"
inkscape:connector-curvature="0"
id="path3439"
d="m 294.04208,-414.81023 c -1.38753,4.69907 0.61612,8.71506 2.30342,10.91995 8.68357,16.57725 15.87278,40.64633 25.25109,52.96413 4.09217,6.26961 7.6682,10.98207 11.76336,17.22651 1.31677,-3.52388 1.34767,-6.63964 -0.48221,-9.01373 -5.5223,-8.02508 -9.62192,-10.45824 -15.96786,-22.3606 -6.34594,-11.90235 -14.67227,-35.15084 -21.78045,-50.61604 -0.81499,-2.03829 -0.5917,-2.17354 -1.08735,0.87978 z"
style="color:#000000;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:medium;line-height:normal;font-family:Sans;-inkscape-font-specification:Sans;text-indent:0;text-align:start;text-decoration:none;text-decoration-line:none;letter-spacing:normal;word-spacing:normal;text-transform:none;writing-mode:lr-tb;direction:ltr;baseline-shift:baseline;text-anchor:start;display:inline;overflow:visible;visibility:visible;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.50409442px;marker:none;enable-background:accumulate" />
<g
id="g1616"
transform="matrix(0.38698727,0,0,0.39592218,593.25592,-456.65111)">
<path
style="display:inline;fill:#161616;stroke-width:0.74597353"
d="m -630.68174,256.24931 c 17.83082,-0.37381 31.02946,-0.71104 32.97458,-0.74924 1.94519,-0.0384 6.45449,-0.21932 10.02061,-0.40243 3.56619,-0.18304 14.97198,-0.54144 25.34623,-0.79627 10.37425,-0.25492 21.27652,-0.64177 24.22728,-0.85964 9.01417,-0.66578 59.34312,-1.54029 82.79484,-1.43865 20.3046,0.088 56.9753,2.10942 59.3877,3.27368 5.1239,2.47296 6.459,4.63631 7.214,11.68943 0.4231,3.95304 0.7525,8.39558 0.732,9.87228 -0.045,3.19014 -3.4416,22.38207 -5.4992,31.06831 -1.0493,4.42919 -1.3896,18.48841 -1.223,50.52363 0.2571,49.4142 -0.1084,47.284 8.1273,47.284 5.7201,0 3.8116,-0.9249 6.8217,1.8259 2.0237,1.8493 0.6188,4.8196 -0.293,5.7545 -0.9955,1.0209 4.3017,1.1938 -3.8436,0.9735 l -9.9055,-0.2679 -2.0234,2.7611 c -2.0752,2.8317 -4.5634,3.4979 -6.7312,1.8022 -0.674,-0.5274 -2.2026,-1.7921 -3.3964,-2.8105 -1.9359,-1.6512 -3.2432,-1.8806 -12.0833,-2.1202 -5.4519,-0.1477 -21.8487,0.084 -36.4375,0.5154 -14.58884,0.4313 -32.36068,0.9581 -39.49292,1.1707 -7.13232,0.2127 -15.62035,0.5487 -18.86229,0.7467 -19.31204,1.1798 -96.76295,2.6715 -117.29984,2.2592 -39.12963,-0.7854 -61.61992,-2.2546 -66.14262,-5.3124 -3.55601,-2.4041 -5.67743,-6.5246 -4.27101,-8.2958 0.70851,-0.8923 0.42959,-4.694 -0.78808,-10.7397 -1.03661,-5.1471 -1.20087,-15.5721 -2.13833,-23.1666 -2.03819,-16.5115 -3.36601,-34.176 -5.00504,-41.0408 -3.25633,-13.63842 -3.30781,-36.43051 -3.66159,-50.65358 -0.21539,-8.66231 -0.74165,-16.34309 -1.16935,-17.0684 -2.18979,-3.71324 0.97435,-4.24462 28.35745,-4.76219 10.37425,-0.19608 33.45109,-0.66233 51.28183,-1.03623 m -5.33954,8.29593 c -11.34685,0.40657 -25.60639,0.93397 -35.33225,1.17193 -9.72587,0.23796 -19.92589,0.63172 -22.6667,0.87505 l -4.9833,0.44248 0.64438,13.91545 c 0.77454,16.72626 -2.11297,16.86442 0.3962,32.32631 1.09542,6.75065 1.05043,13.33406 1.673,14.62975 0.6227,1.2956 1.13221,3.9067 1.13221,5.8022 0,1.8954 1.15975,7.3308 1.87975,12.2194 0.81362,5.5243 1.20101,10.3177 1.4487,13.0602 0.24767,2.7424 0.14992,6.721 0.47848,7.9868 0.32856,1.2657 1.42339,8.3424 2.433,15.7259 2.61006,19.0888 3.4841,23.0597 5.23016,23.7618 8.00539,3.2195 58.23779,4.2017 123.15004,2.5942 v 10e-5 c 13.61625,-0.3371 25.55253,-0.5422 26.52516,-0.4556 0.97256,0.087 11.31736,-0.3507 22.98843,-0.9717 24.03141,-1.2786 72.18597,-2.6694 92.69337,-2.6771 10.3748,-0.01 14.0444,-0.2691 15.0926,-1.0909 1.017,-0.7975 1.2015,-5.7369 0.6947,-18.6026 -2.0834,-52.884 -1.5972,-70.52814 2.4167,-87.70823 0.9365,-4.0082 2.0448,-13.01709 2.4629,-20.01973 0.6257,-10.47746 0.4677,-12.85461 -0.892,-13.42412 -1.7285,-0.724 -15.0176,-2.44565 -19.684,-2.55013 -40.9988,-2.50205 -78.07265,-1.28225 -114.00436,-0.20045 -10.37432,0.48666 -32.6554,1.23698 -49.51352,1.66726 -16.85819,0.43035 -39.93504,1.11508 -51.28185,1.52173"
id="path3255-3-2-3"
inkscape:connector-curvature="0"
sodipodi:nodetypes="cccccsssssssccscssscsccsscssssssccsccssssssssccccscsssscccsc" />
<path
style="fill:#fff6d5;stroke:none;stroke-width:0.74597353"
d="m -681.90881,406.33471 c -4.91241,-1.25 -5.41811,-2.2103 -7.47054,-14.1858 -1.2108,-7.0648 -3.38567,-22.5792 -4.83304,-34.4764 -1.44737,-11.8972 -3.42483,-27.0846 -4.39435,-33.74975 -0.96952,-6.66515 -1.77871,-21.89807 -1.79821,-33.85091 l -0.0355,-21.73246 16.30788,-1.08034 c 8.96933,-0.59418 46.8521,-1.92848 84.18393,-2.96509 37.33176,-1.03661 84.13978,-2.38725 104.01779,-3.00143 37.01235,-1.14358 91.04095,1.55201 94.00855,4.69027 1.0046,1.0623 0.1239,13.1047 -2.2839,31.23272 -3.271,24.62654 -3.8175,35.82189 -3.3056,67.72359 l 0.6131,38.2197 -26.4452,1.1725 c -42.05738,1.8647 -242.75318,3.4822 -248.56496,2.0034 z"
id="path3090"
inkscape:connector-curvature="0" />
<text
transform="scale(0.97243546,1.0283459)"
xml:space="preserve"
style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:8.95168209px;line-height:0%;font-family:'DejaVu Sans Mono';-inkscape-font-specification:'DejaVu Sans Mono Bold';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.74597353"
x="-717.47424"
y="284.61945"
id="text3413"><tspan
sodipodi:role="line"
id="tspan3415"
x="-717.47424"
y="284.61945"
style="font-size:20.88725853px;line-height:1.25;stroke-width:0.74597353">server plain alice ...</tspan></text>
</g>
<g
id="g1763"
transform="matrix(0.59703729,0,0,0.55486049,781.32822,-536.92499)">
<g
transform="translate(-1566.9239,-562.35878)"
id="g1596">
<path
inkscape:connector-curvature="0"
id="path8377"
d="m 1188.427,633.29793 c -1.2847,-2.53848 -1.193,-4.90835 0.314,-8.1189 1.8053,-3.84566 3.5912,-4.62234 11.7633,-5.11574 13.4634,-0.81288 21.4294,0.98343 20.7419,4.67727 -1.0638,5.71622 -9.7804,10.51873 -20.5925,11.34577 -8.9317,0.68321 -10.6705,0.28666 -12.2267,-2.7884 z"
style="display:inline;fill:#fbdeb2;fill-opacity:1;stroke:none;stroke-width:0.74597353" />
<path
inkscape:connector-curvature="0"
id="path3239"
d="m 1182.8316,723.99303 c -1.5625,-1.75885 -1.6538,-2.35483 -1.294,-8.45311 0.4048,-6.86088 2.4142,-12.53726 5.8725,-16.58849 0.8606,-1.00822 2.423,-3.04132 3.4719,-4.51802 1.0489,-1.4767 2.9207,-3.89313 4.1596,-5.36983 2.3876,-2.84616 2.4244,-2.94029 2.5546,-6.52051 0.07,-1.93966 0.3686,-2.29054 1.8971,-2.23255 0.9975,0.0376 2.3032,0.21043 2.9017,0.38356 0.7279,0.21058 1.0473,-0.19308 0.965,-1.21948 -0.196,-2.44397 -1.8365,-8.3484 -2.6109,-9.39721 -0.8793,-1.19088 -6.5059,-1.23929 -12.6446,-0.10878 -3.4707,0.63917 -5.1272,0.62628 -6.6753,-0.0522 -2.2512,-0.98605 -3.9044,-3.94007 -3.236,-5.78208 0.5418,-1.49297 1.6323,-1.7053 12.5952,-2.45271 l 9.0676,-0.61822 0.3628,-6.90407 c 0.3301,-6.28439 0.4994,-6.9247 1.8861,-7.13413 0.9722,-0.14682 2.4636,0.76413 4.1217,2.51761 2.2543,2.3839 2.5444,3.09916 2.1911,5.40167 -0.6376,4.15471 0.5082,4.96824 6.997,4.96824 4.9032,0 5.7813,0.21763 7.1654,1.77542 3.3112,3.72736 1.3762,5.84852 -5.4479,5.97225 -6.713,0.12167 -7.8086,0.66348 -8.0716,3.99194 -0.1241,1.57144 0.4811,5.87291 1.345,9.55869 l 1.5706,6.70154 6.5135,7.05742 c 6.8484,7.42034 7.7367,9.60847 4.083,10.05647 -2.4742,0.30332 -6.4785,-2.41742 -10.9392,-7.43254 -4.7162,-5.30248 -5.7365,-5.7988 -8.0186,-3.90057 -2.8319,2.35567 -10.9168,13.00121 -12.7372,16.77152 -0.8961,1.85581 -1.9606,5.30785 -2.3657,7.67119 -0.7253,4.23119 -2.2765,7.74889 -3.4171,7.74889 -0.3203,0 -1.3388,-0.8515 -2.2633,-1.89225 z"
style="fill:#161616;stroke-width:0.74597353" />
<path
sodipodi:nodetypes="ccccsscscsscccccscssssc"
inkscape:connector-curvature="0"
id="path3066"
d="m 1201.6093,637.35302 c 5.1372,-0.21104 7.4043,-0.78576 10.3662,-1.9695 v -1.6e-4 c 5.1146,-2.04406 8.111,-4.61713 10.0449,-8.62586 1.3823,-2.8655 1.3967,-3.12947 0.2432,-4.47737 -2.2222,-2.59662 -6.0098,-3.39834 -15.1959,-3.21668 -4.9968,0.0988 -9.8672,-0.2039 -11.4334,-0.71051 -2.4895,-0.8054 -2.8927,-0.72055 -4.6044,0.96895 -2.179,2.15077 -4.247,6.18052 -4.9566,9.65864 -0.6722,3.29431 1.1636,6.98193 3.779,7.59141 1.09,0.25399 2.3082,0.60065 2.7072,0.77034 0.399,0.16968 3.9898,0.17452 7.9795,0.0107 m -0.2501,7.79945 c -0.2829,-0.0575 -0.566,-0.15289 -1.5634,-0.31084 -8.7187,-1.38089 -10.4712,-2.08948 -13.6073,-5.50185 -1.7274,-1.87944 -3.616,-4.62036 -4.1971,-6.09093 -3.4183,-8.65179 1.201,-18.28427 11.5192,-24.02033 6.6969,-3.7229 8.7442,-3.65777 14.6183,0.46549 2.5748,1.80726 4.8078,2.6998 7.4366,2.9722 4.7027,0.48735 8.6996,2.61457 12.8897,6.86027 2.6203,2.65508 3.2587,3.81703 3.2587,5.93159 0,10.40934 -7.7144,16.67732 -23.4242,19.03245 -3.1084,0.46602 -5.8831,0.80026 -6.166,0.7428"
style="fill:#161616;stroke-width:0.74597353" />
</g>
<text
transform="scale(0.97243546,1.0283459)"
xml:space="preserve"
style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:8.95168209px;line-height:0%;font-family:'DejaVu Sans';-inkscape-font-specification:'DejaVu Sans Bold';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;display:inline;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.74597353"
x="-420.66235"
y="190.32147"
id="text3375"><tspan
style="font-size:35.80672836px;line-height:1.25;stroke-width:0.74597353"
sodipodi:role="line"
id="tspan3377"
x="-420.66235"
y="190.32147">alice</tspan></text>
</g>
<g
id="g1628"
transform="matrix(0.66855501,0,0,0.63996899,747.80386,-556.98759)">
<g
style="fill:#000000;fill-rule:evenodd;stroke:none"
transform="matrix(0.07829591,0,0,-0.08628172,-999.92745,499.12095)"
id="g6">
<path
inkscape:original-d="M 0,0"
inkscape:path-effect="#path-effect2166"
d="m 1960.5985,701.05915 c 14,30 0,105 -20,105 -14,0 -37,-31 -38,-51 -1,-42 -126.8268,-114.40417 -251.8268,-146.40417 -58,-15 -274,-50 -309,-50 -2,0 -4,-6 -4,-13 0,-29 51,-42 164,-41 168,1 333.8268,52.40417 409.8268,123.40417 18,17 43.427,68.76634 46.427,65.76634 z"
id="path2168"
style="fill-rule:evenodd"
inkscape:connector-curvature="0" />
<path
d="m 1960.5985,701.05915 c 14,30 0,105 -20,105 -14,0 -37,-31 -38,-51 -1,-42 -126.8268,-114.40417 -251.8268,-146.40417 -58,-15 -274,-50 -309,-50 -2,0 -4,-6 -4,-13 0,-29 51,-42 164,-41 168,1 333.8268,52.40417 409.8268,123.40417 18,17 43.427,68.76634 46.427,65.76634 M 1920.0532,445.90561 C 1860.0532,323.90561 1765,263 1619,225 1542,205 1397,180 1353,180 h -33 l 6,93 c 3,50 8,101 9,112 2,11 4,115 4,232 l 1,212 38,6 c 207,34 366,81 493,145 l 76,39 1.5936,-67 c 4,-37 -0.7899,-175.47353 7.2101,-215.47353 37,-178 64.7119,-146.64182 44.7119,54.35818 -9,91 0.4844,358.11535 -0.5156,621.11535 0,239 -4,417 -10,432 -6,17 -6,35 1,52 7,20 5,41 -6,80 -16,55 -60,101 -130,137 -106,53 -370,98 -491,82 -144.5898,-34.945 21.9832,-48.4127 71,-55 219,-30 336,-60 418,-105 99,-56 111,-95 48,-156 -71,-67 -226,-109 -496,-133 -215,-20 -594,-13 -825,15 -182,22 -344,75 -376,124 -22,33 3,65 90,117 91,55 186,86 371,123 149,30 398,44 480,27 28,-5 76,-16 108,-22 70,-16 88.21,0.6179 58.3476,39.7234 C 1299.2093,2185.6188 1269,2196 1240,2204 c -61,18 -267,27 -385,16 -188,-17 -332,-43 -455,-83 -156,-51 -234,-103 -248,-165 -16,-68 0,-231 48,-497 39,-214 36,-196 59,-400 36,-326 41,-399 41,-542 V 391 l 31,-36 c 61,-69 258,-174 394,-210 157,-40 247,-50 465,-49 233,1 327,13 475,61 125,40 181.9741,84.96117 251.9741,169.96117 25.1016,30.33106 62.1437,114.92204 74.9231,180.15175 8.7874,44.85353 -0.788,80.3538 4.2099,109.94679 -9.0344,26.72111 -24.5719,17.74432 -28.3457,-2.81478 -6.0067,-32.72324 -33.3187,-140.59388 -47.7082,-168.33932 z M 1926,1536 c -8,-6 -16,-22 -18,-36 -7,-55 -169,-121 -422,-170 -77,-16 -141,-28 -142,-27 0,1 -8,15 -18,31 -16,25 -20,27 -33,13 -12,-12 -15,-51 -14,-236 l 2,-220 -36,-16 c -41,-16 -39,-30 5,-40 l 30,-7 -1,-206 c -1,-114 -4,-261 -8,-327 l -6,-120 -80,-3 c -160,-6 -407,30 -544,79 -103,37 -268,130 -287,161 -5,7 -8,94 -7,193 1,99 -2,214 -7,255 -5,41 -16,143 -25,225 -9,83 -20,168 -25,190 -31,136 -86,502 -78,511 3,2 25,-7 49,-20 72,-41 180,-66 379,-90 236,-29 645,-24 931,9 146,18 255,49 329,94 l 35,21 3,-126 c 2,-101 0,-129 -12,-138 z m 14,-276 c 0,-125 -1,-130 -25,-155 -32,-31 -63,-47 -178,-92 -78,-30 -387,-117 -393,-110 -1,1 -4,72 -5,158 l -4,156 85,12 c 203,31 382,81 465,130 28,17 51,30 53,30 1,1 2,-57 2,-129 z"
id="path4"
inkscape:connector-curvature="0"
sodipodi:nodetypes="csccsscccccscccccccccccccccccccccccccccsccccccsccccccscscscccccccccccccsccsscccccccccssccccccccs"
style="fill-rule:evenodd" />
</g>
<path
style="fill:#fee3fc;fill-opacity:1;stroke:none;stroke-width:0.23834935px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
d="m -916.26683,484.03666 c -15.72135,-1.40276 -27.68021,-4.01205 -36.16206,-7.89015 -5.12547,-2.34348 -12.04255,-6.39612 -16.12473,-9.44731 -2.87247,-2.147 -3.44794,-2.75293 -3.70532,-3.90144 -0.12503,-0.55789 -0.31655,-8.53087 -0.43274,-18.01508 -0.11465,-9.35785 -0.26524,-17.46463 -0.33466,-18.01508 -0.0694,-0.55048 -0.69231,-6.68685 -1.38418,-13.63643 -1.68628,-16.93792 -2.17447,-20.92319 -3.38946,-27.66971 -2.23838,-12.42915 -5.96431,-39.7755 -5.49052,-40.29761 0.15677,-0.17275 2.32044,0.83357 4.09021,1.90237 5.48453,3.31218 14.89343,5.70215 30.0671,7.63737 10.08974,1.28682 25.29239,1.83205 39.41408,1.41354 33.08464,-0.98046 48.82409,-3.84076 59.18364,-10.75527 l 1.92993,-1.28815 0.14024,3.81551 c 0.23017,6.26222 0.21627,15.28937 -0.0257,16.6954 -0.14147,0.82201 -0.46408,1.61222 -0.86225,2.11196 -0.67958,0.85294 -1.0169,1.6501 -1.40154,3.31199 -0.82133,3.54876 -9.29429,7.99295 -22.10018,11.59191 -4.12805,1.16016 -19.28226,4.63363 -20.97876,4.80852 -0.67865,0.07 -0.80484,-0.0551 -1.92993,-1.91328 -1.67753,-2.77051 -2.11907,-2.9613 -3.17131,-1.37035 -0.74276,1.12305 -0.87065,4.34405 -0.87065,21.92728 v 17.08066 l -2.4408,1.3163 c -1.89765,1.02338 -2.45678,1.44015 -2.5126,1.87287 -0.10036,0.77808 1.00923,1.46871 3.19375,1.98788 l 1.75965,0.41819 -0.004,7.90153 c -0.006,11.61326 -0.38733,30.49387 -0.80574,39.92837 -0.20139,4.54129 -0.39948,8.29438 -0.44019,8.34019 -0.11353,0.12774 -13.92195,0.25304 -15.21099,0.13802 z"
id="path12"
inkscape:connector-curvature="0" />
<path
style="fill:#fee3fc;fill-opacity:1;stroke:none;stroke-width:0.23834935px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
d="m -929.07253,349.04983 c -9.92299,-0.38133 -20.5175,-1.25969 -27.0191,-2.24005 -13.89117,-2.09461 -25.59533,-6.54159 -27.82556,-10.57228 -1.31099,-2.36939 0.14822,-4.77226 5.06982,-8.34838 6.07586,-4.41486 12.62703,-7.33379 22.07458,-9.83551 13.98351,-3.70286 25.75072,-5.1907 39.0682,-4.93977 l 6.34207,0.1195 5.56275,1.3058 c 6.25218,1.46763 8.50302,1.68799 9.28486,0.90899 0.52927,-0.5274 0.60603,-1.16991 0.23182,-1.94047 -0.21131,-0.43509 -0.18696,-0.48885 0.17028,-0.3761 0.96759,0.30537 3.17388,0.70134 7.22837,1.29728 19.41629,2.85385 29.34545,5.77648 36.06233,10.61488 3.57979,2.57864 5.05134,4.93197 4.50122,7.19853 -0.36321,1.49652 -1.27069,2.90211 -3.07349,4.76056 -2.63548,2.71682 -6.60034,4.86256 -12.33997,6.67824 -8.63867,2.73278 -22.27385,4.72308 -36.95676,5.39453 -6.21519,0.28423 -20.65691,0.27113 -28.38142,-0.0257 z"
id="path822"
inkscape:connector-curvature="0" />
<path
style="fill:#fee3fc;fill-opacity:1;stroke:none;stroke-width:0.23834935px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
d="m -894.75718,417.32218 c -0.0759,-2.09863 -0.19246,-7.08093 -0.25908,-11.07176 -0.0666,-3.99085 -0.1797,-8.33065 -0.25129,-9.64402 l -0.13014,-2.38794 3.02958,-0.45224 c 9.84236,-1.46924 20.51478,-3.93818 28.23226,-6.53118 5.54448,-1.86289 9.36543,-3.64738 13.36506,-6.24186 1.78475,-1.15771 2.28201,-1.38286 2.44858,-1.10865 0.31274,0.51476 0.10216,20.13645 -0.22824,21.26728 -0.62752,2.14793 -3.4507,4.6933 -7.56453,6.82016 -5.91677,3.05898 -12.50196,5.55733 -24.53909,9.30985 -5.08424,1.58498 -13.14604,3.85605 -13.68812,3.85605 -0.19988,0 -0.31546,-1.06275 -0.41499,-3.81569 z"
id="path824"
inkscape:connector-curvature="0" />
<path
style="fill:#a0a0a0;stroke:none;stroke-width:0.23834935px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
d="m -894.9013,439.22783 c 0,-7.343 0.0809,-11.5845 0.22096,-11.5845 0.50335,0 8.31275,-1.5348 11.47217,-2.25466 8.73362,-1.98989 18.05833,-5.0278 24.1544,-7.8693 1.67124,-0.779 4.87515,-2.42946 7.11978,-3.66769 2.24464,-1.23824 4.14622,-2.17965 4.22574,-2.09202 0.16063,0.17701 0.43314,8.47542 0.46631,14.19952 l 0.0215,3.69535 -0.53968,-0.14927 c -1.05227,-0.29103 -3.3202,2.76402 -3.3202,4.47255 0,0.72932 -0.95995,2.2227 -2.25346,3.50564 -2.89946,2.87585 -9.90571,6.64754 -15.79712,8.50416 -4.35375,1.37203 -18.57814,4.07548 -24.91889,4.73601 l -0.85143,0.0887 z"
id="path826"
inkscape:connector-curvature="0" />
<path
style="fill:#fee3fc;fill-opacity:1;stroke:none;stroke-width:0.23834935px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
d="m -896.39322,481.87624 c 0.0734,-0.8601 0.23902,-3.42161 0.3679,-5.69227 0.12887,-2.27065 0.38341,-5.95996 0.56563,-8.19848 0.18225,-2.2385 0.33134,-6.43264 0.33134,-9.3203 0,-2.88764 0.0897,-5.25028 0.19925,-5.25028 0.10959,0 0.32617,0.16853 0.4813,0.37452 0.45659,0.60627 2.99311,1.3396 5.72304,1.65458 3.17528,0.36639 11.32103,0.14823 14.91178,-0.39937 10.07463,-1.53639 19.46461,-5.52725 23.53758,-10.00374 0.63005,-0.69248 1.67593,-2.2292 2.32415,-3.41492 1.62902,-2.97975 1.72975,-3.04174 2.0832,-1.2825 0.15876,0.79018 0.47651,1.98593 0.70611,2.65723 0.4115,1.20313 0.41094,1.22636 -0.0396,1.6284 -0.34028,0.30365 -0.79569,1.87753 -1.78256,6.16063 -1.4597,6.3351 -2.3148,9.13499 -3.50178,11.46593 -3.76427,7.3922 -9.50987,12.46742 -17.73688,15.66744 -6.19636,2.41016 -20.9283,5.51339 -26.18575,5.51592 l -2.11828,7.1e-4 z"
id="path828"
inkscape:connector-curvature="0" />
<path
style="fill:#fee3fc;fill-opacity:1;stroke:none;stroke-width:0.23834935px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
d="m -894.9013,444.97622 c 0,-3.15957 -0.0595,-7.14165 -0.13204,-8.84904 -0.0934,-2.19718 -0.0626,-2.99467 0.10574,-2.72903 0.17239,0.27214 0.25551,-0.48449 0.30231,-2.75231 l 0.0646,-3.12761 0.60269,0.0773 c 0.33149,0.0425 0.66112,-0.0267 0.7325,-0.1541 0.0714,-0.12729 0.37568,-0.17963 0.67622,-0.11632 0.30055,0.0632 0.61278,-0.004 0.69385,-0.14774 0.0811,-0.14455 0.29739,-0.19941 0.48073,-0.1219 0.1833,0.0775 0.5121,0.058 0.73063,-0.0432 0.4114,-0.19057 0.56414,-0.22083 2.40765,-0.47714 0.60615,-0.0843 1.28241,-0.25954 1.50275,-0.38951 0.22035,-0.12997 0.46076,-0.17003 0.53423,-0.0891 0.0734,0.0809 0.31679,0.0597 0.54072,-0.0472 0.22391,-0.10696 0.57687,-0.17178 0.78435,-0.14405 0.20747,0.0278 0.44064,-0.0626 0.51813,-0.20083 0.0776,-0.13818 0.29221,-0.18728 0.47711,-0.10909 0.18491,0.0782 0.47202,0.0179 0.63801,-0.13385 0.166,-0.15182 0.35403,-0.21849 0.41785,-0.14818 0.11219,0.12364 2.8968,-0.49705 3.58854,-0.79988 0.18732,-0.0821 0.54492,-0.18037 0.79468,-0.21858 0.60667,-0.0928 4.22423,-1.09432 4.65454,-1.2886 0.18732,-0.0845 0.44276,-0.16784 0.56763,-0.18506 0.62579,-0.0863 1.84298,-0.47358 2.04347,-0.6502 0.12487,-0.11002 0.30538,-0.20108 0.40112,-0.20235 0.36863,-0.005 1.66809,-0.36601 2.20996,-0.61415 0.3122,-0.14295 0.64426,-0.28342 0.73792,-0.31214 0.0937,-0.0287 0.19583,-0.0747 0.22705,-0.10212 0.0312,-0.0275 0.27273,-0.0948 0.53668,-0.1496 0.26394,-0.0549 0.77482,-0.2341 1.13526,-0.3983 0.36043,-0.16422 0.73197,-0.32209 0.82563,-0.35082 0.0937,-0.0287 0.22137,-0.0804 0.28381,-0.1148 0.0624,-0.0344 0.21569,-0.0907 0.34059,-0.1251 0.12487,-0.0344 0.27813,-0.0907 0.34056,-0.12511 0.0624,-0.0344 0.19016,-0.083 0.28382,-0.10796 0.0937,-0.025 0.50236,-0.13243 0.90822,-0.2388 0.40584,-0.10638 0.73791,-0.31583 0.73791,-0.46545 0,-0.14961 0.0627,-0.20279 0.13959,-0.11819 0.17798,0.19614 3.08666,-1.00139 3.28311,-1.35168 0.0811,-0.14452 0.18702,-0.24392 0.23549,-0.22091 0.19997,0.0949 1.33694,-0.3175 1.33694,-0.48494 0,-0.0998 0.12771,-0.18284 0.28381,-0.18461 0.15609,-0.002 2.23564,-1.03389 4.62121,-2.29359 2.38556,-1.25969 4.38792,-2.29037 4.44966,-2.29037 0.16714,0 0.3741,4.85974 0.49658,11.66106 l 0.1086,6.03134 -0.56565,-0.0684 c -0.96065,-0.11621 -2.97298,2.24748 -3.17888,3.73394 -0.0408,0.29449 -0.10213,0.75767 -0.13632,1.02928 -0.0863,0.68522 -2.72741,3.71038 -4.06553,4.65664 -0.60791,0.42987 -1.10528,0.90121 -1.10528,1.04743 0,0.14619 -0.0602,0.1994 -0.13393,0.11823 -0.15006,-0.16536 -4.93162,2.54839 -5.05089,2.86661 -0.0418,0.11177 -0.16194,0.14477 -0.26679,0.0733 -0.23682,-0.16129 -1.35993,0.38332 -1.35993,0.65944 0,0.11122 -0.14009,0.14297 -0.3113,0.0706 -0.17122,-0.0723 -0.4522,0.0156 -0.62439,0.1955 -0.17221,0.17992 -0.41527,0.33149 -0.54015,0.33678 -0.53591,0.0228 -2.15699,0.71452 -2.15699,0.92048 0,0.12395 -0.0842,0.16805 -0.18701,0.098 -0.10285,-0.0701 -0.80242,0.0837 -1.5546,0.34168 -0.75216,0.25799 -2.63484,0.76892 -4.18372,1.13544 -1.54888,0.36649 -2.9694,0.72577 -3.15671,0.79839 -0.18734,0.0726 -0.74927,0.17596 -1.24879,0.22967 -0.49951,0.0537 -1.06146,0.17004 -1.24878,0.25851 -0.18732,0.0885 -0.5607,0.13746 -0.82976,0.10888 -0.26904,-0.0286 -0.55708,0.0692 -0.64008,0.21709 -0.0829,0.14797 -0.23175,0.214 -0.33056,0.1467 -0.0988,-0.0673 -0.98577,0.0489 -1.97101,0.25819 -0.98525,0.2093 -2.06562,0.3739 -2.40082,0.36577 -0.33519,-0.008 -0.67432,0.10087 -0.7536,0.24222 -0.0793,0.14137 -0.2303,0.19834 -0.3356,0.12662 -0.10529,-0.0717 -1.5542,0.0868 -3.21979,0.35229 -1.66558,0.26547 -3.71801,0.56061 -4.56093,0.65588 l -1.53259,0.1732 z"
id="path830"
inkscape:connector-curvature="0" />
<path
inkscape:connector-curvature="0"
id="path1598"
d="m -894.47748,439.35638 0.27589,-11.15443 8.74292,-1.92524 c 11.88825,-2.61787 20.50329,-5.50385 29.28691,-9.81095 4.06143,-1.99154 7.54843,-3.62099 7.74888,-3.62099 0.85581,0 0.27402,15.88288 -0.62383,17.02986 -0.54353,0.69436 -1.97757,2.90879 -3.18672,4.92094 -4.0118,6.67603 -16.9049,11.74125 -38.35831,15.06958 l -4.16164,0.64564 z"
style="fill:#fbdeb2;fill-opacity:1;stroke:none;stroke-width:1.00767934px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" />
</g>
<g
id="g1700"
transform="matrix(0.02880459,0,0,-0.03320629,183.59509,-282.3018)"
style="fill:#000000;stroke:none">
<path
id="path1698"
d="m 2123,3195 c -11,-8 -58,-58 -102,-110 -81,-95 -82,-95 -67,-124 14,-26 58,-51 92,-51 7,0 25,12 39,27 l 25,28 v -26 c 0,-14 -7,-77 -15,-140 -37,-281 -107,-539 -223,-819 -56,-137 -86,-194 -200,-392 -12,-21 -31,-55 -43,-75 -54,-96 -257,-373 -375,-513 C 1146,872 949,665 852,577 754,489 594,377 504,336 397,285 385,281 340,271 c -62,-14 -108,-13 -155,4 -51,18 -67,18 -89,2 -18,-13 -18,-15 -2,-39 9,-14 40,-36 69,-49 65,-28 183,-30 277,-6 60,16 228,89 240,105 3,4 25,21 49,37 220,149 422,346 686,671 134,164 343,461 363,514 3,8 26,49 50,90 220,374 383,907 409,1337 l 6,102 35,-30 c 50,-44 80,-54 103,-33 11,10 19,24 19,32 0,14 -59,93 -113,151 -44,47 -123,65 -164,36 z"
inkscape:connector-curvature="0" />
</g>
<text
xml:space="preserve"
style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:3.7831986px;line-height:0%;font-family:'DejaVu Sans';-inkscape-font-specification:'DejaVu Sans Bold';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;display:inline;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.31526655"
x="175.28424"
y="-266.33444"
id="text3053-3-2"
transform="scale(1.0407029,0.96088902)"><tspan
sodipodi:role="line"
id="tspan3055-6-7"
x="175.28424"
y="-265.35168"
style="font-size:15.13279438px;line-height:1.25;stroke-width:0.31526655" /><tspan
id="tspan1133-9"
sodipodi:role="line"
x="175.28424"
y="-252.94547"
style="font-size:15.13279438px;line-height:1.25;stroke-width:0.31526655">--pop-by-name</tspan></text>
<text
xml:space="preserve"
style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:3.7831986px;line-height:0%;font-family:'DejaVu Sans';-inkscape-font-specification:'DejaVu Sans Bold';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;display:inline;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.31526655"
x="350.51648"
y="-497.91714"
id="text3053-3-2-3"
transform="scale(1.0407029,0.96088901)"><tspan
sodipodi:role="line"
id="tspan3055-6-7-6"
x="350.51648"
y="-496.93439"
style="font-size:15.13279438px;line-height:1.25;stroke-width:0.31526655" /><tspan
id="tspan1133-9-0"
sodipodi:role="line"
x="350.51648"
y="-484.52817"
style="font-size:15.13279438px;line-height:1.25;stroke-width:0.31526655">POP</tspan></text>
<g
id="g2155"
transform="matrix(0.24432878,0,0,0.19605893,-48.143176,-563.01672)">
<g
id="g2127">
<path
sodipodi:nodetypes="cccccsssssssccscssscsccsscssssssccsccssssssssccccscssssccsccscccsccssc"
inkscape:connector-curvature="0"
id="path3255-3"
d="m 2121.4452,291.22157 c 19,-0.65868 33.0642,-1.25288 35.137,-1.3202 2.0727,-0.0676 6.8777,-0.38644 10.6777,-0.70909 3.8,-0.32252 15.9538,-0.95403 27.0084,-1.40306 11.0545,-0.44917 22.6718,-1.13082 25.8161,-1.5147 9.6053,-1.17314 63.2347,-2.71406 88.2243,-2.53496 21.6361,0.15503 60.7117,3.71688 63.2823,5.76834 5.4599,4.35744 6.8826,8.16935 7.687,20.5972 0.4509,6.9654 0.8019,14.79331 0.78,17.39532 -0.048,5.62114 -3.6672,39.43802 -5.8598,54.74349 -1.1181,7.80439 -1.4807,32.57724 -1.3032,89.0244 0.274,87.06973 -0.1155,83.31621 8.6603,83.31621 6.0952,0 9.9254,1.99564 13.1328,6.84253 2.1564,3.25853 2.545,4.86704 1.5734,6.51434 -1.0607,1.79884 -3.1656,2.10364 -11.8451,1.71544 l -10.555,-0.47215 -2.1561,4.86514 c -2.2113,4.98963 -4.8627,6.16344 -7.1726,3.17553 -0.7183,-0.92929 -2.3471,-3.15769 -3.6192,-4.95206 -2.0628,-2.90951 -3.4558,-3.31367 -12.8756,-3.73593 -5.8094,-0.26034 -23.2816,0.14841 -38.8271,0.9082 -15.5455,0.75992 -34.4828,1.68812 -42.0828,2.06281 -7.6,0.37483 -16.6447,0.96687 -20.0992,1.31574 -20.5785,2.07876 -103.1085,4.70713 -124.9922,3.98073 -41.6957,-1.384 -59.477,-3.97276 -64.2962,-9.3606 -3.7893,-4.2362 -6.0498,-11.49667 -4.5511,-14.61759 0.7549,-1.57229 0.4577,-8.271 -0.8398,-18.92368 -1.1046,-9.06944 -2.8256,-27.43865 -3.8245,-40.82039 -2.1719,-29.09394 -5.1327,-60.21946 -6.8792,-72.31547 -3.4699,-24.03132 -6.6167,-64.19182 -6.9937,-89.25338 -0.2295,-15.2633 -0.7903,-28.79711 -1.246,-30.07513 -2.3334,-6.54286 1.0382,-7.47918 30.2171,-8.39116 11.0545,-0.3455 35.6447,-1.16705 54.6448,-1.82587 m -5.6897,14.61773 c -12.091,0.7164 -27.2856,1.64568 -37.6493,2.06498 -10.3637,0.41929 -21.2326,1.11312 -24.1532,1.54187 l -5.3101,0.77966 0.6867,24.51954 c 0.8253,29.47227 0.8404,29.71571 3.5141,56.96013 1.1672,11.89488 2.6653,23.49509 3.3287,25.7781 0.6635,2.283 1.2064,6.88375 1.2064,10.22365 0,3.33989 0.9014,13.02881 2.003,21.53109 1.1019,8.50213 2.2191,19.41217 2.4831,24.24447 0.2639,4.83229 0.7664,10.61077 1.1165,12.84106 0.3501,2.23029 1.5167,14.69964 2.5925,27.70967 2.7813,33.63521 3.7126,40.63197 5.5732,41.86917 8.5303,5.67278 55.873,7.40349 125.0421,4.57102 v 2.7e-4 c 14.5092,-0.59407 27.2282,-0.95538 28.2646,-0.80291 1.0364,0.15261 12.0596,-0.61786 24.496,-1.71205 25.6074,-2.253 76.9198,-4.70361 98.7721,-4.71713 11.0552,-0.0135 14.9654,-0.47417 16.0823,-1.92224 1.0837,-1.40522 1.2803,-10.10862 0.7402,-32.77851 -2.2199,-93.18342 -1.7019,-124.27313 2.5752,-154.54506 0.998,-7.06259 2.1789,-22.93658 2.6245,-35.27549 0.6667,-18.46167 0.4983,-22.65029 -0.9506,-23.65378 -1.8418,-1.27573 -16.0024,-4.30933 -20.9748,-4.49343 -2.6125,-0.0973 -2.8077,0.3267 -2.0786,4.50857 0.6918,3.96789 0.3472,4.93799 -2.4555,6.9139 -3.9473,2.78299 -4.1278,5.84295 -0.6275,10.63105 4.4696,6.11424 0.021,10.36855 -5.8471,5.59235 -3.1695,-2.57957 -7.3763,-2.5989 -9.3475,-0.0433 -1.6452,2.13284 -9.449,2.81531 -10.5367,0.92145 -0.3495,-0.60839 0.729,-4.27486 2.3966,-8.14772 1.8185,-4.2235 2.9229,-9.05525 2.7595,-12.0729 -0.2715,-5.01437 -0.2555,-5.0314 4.7525,-5.05262 6.9631,-0.0297 11.3652,-1.80748 9.4839,-3.83002 -1.9294,-2.0743 -82.4626,-1.90886 -109.9802,0.226 -11.0546,0.85752 -34.7968,2.17961 -52.7605,2.93777 -17.9637,0.7583 -42.5539,1.96482 -54.6448,2.68135"
style="fill:#161616;stroke-width:1.30307257" />
<path
inkscape:connector-curvature="0"
id="path3253"
d="m 2170.5717,542.71762 c -0.3327,-0.57933 -1.5143,-11.37597 -2.6257,-23.99251 -2.0983,-23.8218 -6.228,-55.79133 -8.3192,-64.4016 -2.0785,-8.55877 -3.9157,-33.49909 -3.8379,-52.10066 0.064,-15.18206 0.4579,-18.67659 2.6229,-23.24314 1.4016,-2.95601 2.0652,-5.69589 1.4748,-6.08856 -0.5904,-0.39266 -5.8151,-0.10137 -11.6104,0.64881 -31.4153,4.06265 -45.6807,4.9622 -51.8281,3.26785 -6.2764,-1.72989 -9.1218,-4.38921 -7.0649,-6.6026 1.5286,-1.64474 31.9783,-5.64994 51.6222,-6.79022 8.5672,-0.49729 23.2082,-1.8994 32.5354,-3.11579 13.4686,-1.75638 29.6818,-2.22948 78.7804,-2.29868 57.2659,-0.0811 61.9836,0.0879 64.0215,2.27841 6.0713,6.52826 -9.0715,9.93628 -36.6528,8.2491 -23.6135,-1.44455 -73.0665,-0.84657 -92.959,1.12393 -8.2908,0.82129 -16.7227,1.55742 -18.7374,1.63582 -4.7445,0.18464 -5.4141,2.56807 -1.4973,5.32958 l 3.0977,2.18393 -0.6824,18.02155 c -0.6654,17.57564 1.1197,50.23466 3.3399,61.10225 7.7323,37.84844 9.6166,73.75935 4.3261,82.44735 -2.0323,3.33759 -4.8122,4.42314 -6.0058,2.34518 z"
style="fill:#161616;stroke-width:1.30307257" />
<path
inkscape:connector-curvature="0"
id="path3251"
d="m 2108.5636,523.49887 c -7.2311,-0.54094 -9.6538,-1.30127 -11.9166,-3.73918 -4.0145,-4.32528 -1.8336,-7.79142 4.8126,-7.64881 9.9274,0.21316 28.7985,3.55265 30.5816,5.4119 4.5976,4.79336 -5.3712,7.33089 -23.4776,5.97609 z"
style="fill:#161616;stroke-width:1.30307257" />
<path
inkscape:connector-curvature="0"
id="path3249"
d="m 2096.8922,497.98597 c -3.76,-3.37747 -4.1014,-4.16861 -2.6252,-6.08261 1.3322,-1.72705 4.0719,-2.20001 12.7462,-2.20001 12.5733,0 15.0234,0.65787 15.0234,4.03412 0,3.45993 -2.2,4.82865 -10.5732,6.57814 -9.8994,2.06836 -9.6269,2.11189 -14.5712,-2.32964 z"
style="fill:#161616;stroke-width:1.30307257" />
<path
inkscape:connector-curvature="0"
id="path3247"
d="m 2088.0408,476.50503 c -6.2707,-6.02881 -4.6287,-7.91712 7.8298,-9.00375 15.0324,-1.311 32.447,1.83614 32.447,5.86378 0,2.71406 -3.9114,4.06953 -13.8607,4.80391 -5.8494,0.43159 -13.2612,1.12285 -16.4708,1.53606 -5.1821,0.66719 -6.2955,0.30886 -9.9453,-3.2 z"
style="fill:#161616;stroke-width:1.30307257" />
<path
inkscape:connector-curvature="0"
id="path3245"
d="m 2098.7968,461.70794 c -6.9224,-1.94455 -12.3471,-10.16175 -7.8512,-11.89313 0.8636,-0.33265 7.3695,-0.83278 14.4576,-1.11149 13.6461,-0.53649 17.2825,0.59582 16.4559,5.12466 -0.5396,2.95629 -2.2303,3.94316 -10.5002,6.12965 -9.2281,2.43967 -9.8163,2.52158 -12.5621,1.75031 z"
style="fill:#161616;stroke-width:1.30307257" />
<path
inkscape:connector-curvature="0"
id="path3243"
d="m 2085.3242,437.58376 c -4.8312,-2.82111 -6.7804,-7.09286 -4.4034,-9.65053 1.5777,-1.69759 4.2401,-1.7622 18.6516,-0.45322 18.2126,1.65447 22.4048,3.39207 18.45,7.64746 -1.2988,1.39751 -5.6185,2.5989 -11.889,3.30637 -13.8002,1.55702 -16.9042,1.43023 -20.8092,-0.85008 z"
style="fill:#161616;stroke-width:1.30307257" />
<path
inkscape:connector-curvature="0"
id="path3241"
d="m 2075.2627,418.14496 c -6.9334,-6.71615 -4.3453,-7.73424 24.5373,-9.65229 17.581,-1.16746 25.263,-1.22991 26.2081,-0.21316 4.1192,4.43246 -6.9961,9.1477 -27.6777,11.74119 -9.2023,1.15394 -17.234,2.0981 -17.8483,2.0981 -0.6142,0 -2.963,-1.78829 -5.2194,-3.97384 z"
style="fill:#161616;stroke-width:1.30307257" />
</g>
</g>
<path
style="fill:#fdfdd2;fill-opacity:1;stroke:none;stroke-width:0.59157223px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
d="m 459.23181,-453.70752 c -1.99386,-0.34562 -2.47954,-1.46277 -3.0458,-7.00588 -0.39322,-3.84924 -1.95011,-16.37432 -3.23548,-26.02918 -0.30322,-2.27755 -0.68597,-6.58984 -0.85056,-9.58286 l -0.29925,-5.44184 2.4738,-0.31375 c 6.97646,-0.88479 71.35975,-2.58491 65.68647,-1.73454 -1.46257,0.21923 -1.91896,0.61963 -2.13472,1.87284 -0.15095,0.87669 -0.46803,2.04513 -0.70464,2.59652 -0.37902,0.88328 0.004,0.99639 3.2169,0.95083 3.24939,-0.0461 3.61577,-0.17148 3.35987,-1.15006 -0.15797,-0.60409 0.0206,-1.76195 0.39676,-2.57303 0.69784,-1.50457 1.856,-1.78737 4.46284,-1.08974 1.39292,0.37277 1.40756,0.45286 1.05319,5.75975 -0.19765,2.95995 -0.64512,7.9107 -0.99439,11.00167 -0.39838,3.52556 -0.48358,10.41494 -0.22864,18.48663 0.34087,10.79251 0.27346,12.87287 -0.41817,12.90499 -20.04763,0.93119 -28.6776,1.19202 -46.07983,1.39274 -11.55045,0.13323 -21.74671,0.11294 -22.65835,-0.0451 z m 25.14537,-4.63959 c 0.5806,-2.05418 0.14494,-7.09867 -1.12399,-13.0146 -0.48851,-2.27754 -0.99652,-7.18759 -1.1289,-10.9112 -0.13706,-3.8551 -0.51004,-6.93666 -0.86625,-7.1568 -1.09332,-0.67571 8.0622,-1.1578 22.16586,-1.16715 13.20224,-0.009 15.75378,-0.30001 14.88882,-1.69952 -0.93621,-1.51482 -50.08217,-0.20644 -55.53191,1.47839 -0.8904,0.27527 -0.94086,0.48095 -0.30578,1.24619 0.64835,0.7812 1.89812,0.85749 8.46658,0.51681 l 7.70594,-0.39969 -0.21266,4.68306 c -0.14247,3.1372 0.28225,7.68561 1.28667,13.77906 0.82464,5.00281 1.66863,10.37642 1.87552,11.94135 0.28832,2.18074 0.59834,2.80254 1.32734,2.66208 0.52313,-0.1008 1.17687,-0.98189 1.45276,-1.95798 z m -11.4468,-2.3787 c 0.79381,-0.7938 -1.3096,-1.55319 -5.20727,-1.87995 -3.99514,-0.33495 -4.27845,-0.28203 -4.07746,0.76164 0.13003,0.67518 0.9195,1.28392 1.9835,1.52942 1.8032,0.41605 6.75276,0.13736 7.30123,-0.41111 z m -3.13356,-4.67181 c 1.65734,-1.21187 0.61855,-1.82752 -3.02382,-1.79214 -3.59063,0.0349 -4.31727,0.42355 -3.23345,1.72948 0.9453,1.13902 4.73339,1.17695 6.25727,0.0627 z m -0.70803,-3.67821 c 2.92071,-0.40032 3.68802,-1.59928 1.4136,-2.2088 -2.20475,-0.59085 -8.6286,-0.41697 -9.03749,0.24463 -0.65607,1.06154 0.96338,2.34037 2.96375,2.34037 1.05352,0 3.15059,-0.16929 4.66014,-0.3762 z m 1.13928,-4.28911 c 1.15305,-1.15305 -0.36153,-1.84199 -4.04949,-1.84199 -3.90622,0 -4.71428,0.60548 -3.07084,2.30099 0.82328,0.84936 6.15572,0.50561 7.12033,-0.459 z m -1.20461,-3.98605 c 2.78814,-0.81322 0.15673,-1.96507 -4.58468,-2.00685 -3.66063,-0.0322 -2.48937,-0.86784 1.90567,-1.35951 3.53485,-0.39544 5.70114,-1.35814 5.1312,-2.28033 -0.26398,-0.42712 -2.31648,-0.49601 -6.32028,-0.21216 -7.40455,0.52496 -7.89892,0.68761 -6.56617,2.16029 0.55252,0.61053 1.42919,1.13106 1.94815,1.15675 0.61152,0.0303 0.68334,0.1517 0.2041,0.34508 -1.19212,0.48104 -0.85041,1.9661 0.59157,2.57089 1.23854,0.51946 5.30498,0.32162 7.69044,-0.37416 z"
id="path2157"
inkscape:connector-curvature="0" />
<text
id="text1137"
y="455.51312"
x="-360.74921"
style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:36px;line-height:125%;font-family:'DejaVu Sans';-inkscape-font-specification:'DejaVu Sans Bold';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.75px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
xml:space="preserve"><tspan
style="stroke-width:0.75px"
y="487.36469"
x="-360.74921"
id="tspan1135"
sodipodi:role="line" /><tspan
id="tspan1139"
style="stroke-width:0.75px"
y="532.36469"
x="-360.74921"
sodipodi:role="line" /></text>
<text
xml:space="preserve"
style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:2.41259456px;line-height:0%;font-family:'DejaVu Sans';-inkscape-font-specification:'DejaVu Sans Bold';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;display:inline;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.20104955"
x="156.56393"
y="-276.06079"
id="text3053-3-2-2"
transform="scale(0.96943274,1.0315311)"><tspan
sodipodi:role="line"
id="tspan3055-6-7-3"
x="156.56393"
y="-275.43408"
style="font-size:9.65037823px;line-height:1.25;stroke-width:0.20104955" /><tspan
id="tspan1133-9-7"
sodipodi:role="line"
x="156.56393"
y="-267.52246"
style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:9.65037823px;line-height:1.25;font-family:'DejaVu Sans';-inkscape-font-specification:'DejaVu Sans';stroke-width:0.20104955">alice</tspan></text>
</g>
</g>
</svg>
Side by Side

After

Width:  |  Height:  |  Size: 52 KiB

163
doc/readme.html
View File

@ -9,56 +9,57 @@
<!-- 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:E-MailRelay Readme -->
<h2><a class="a-header" name="SH_1_1">Abstract</a></h2> <!-- index:2:SH:1:1:Abstract -->
<h2><a class="a-header" name="SH_1_1">Introduction</a></h2> <!-- index:2:SH:1:1:Introduction -->
<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.
E-MailRelay is a lightweight SMTP store-and-forward mail server with POP access
to spooled messages. It can be used as a personal internet mail server with
SpamAssassin spam filtering and DNSBL connection blocking. Forwarding can be
to a fixed smarthost or using DNS MX routing. External scripts can be used for
address validation and e-mail message processing.
</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.
E-MailRelay runs as a single process using the same non-blocking i/o model as
Squid and nginx giving excellent scalability and resource usage.
</p>
<h2><a class="a-header" name="SH_1_2">Quick start</a></h2> <!-- index:2:SH:1:2:Quick start -->
<p>
E-MailRelay can be run straight from the command-line, and on Windows you can
run <em>emailrelay.exe</em> or <em>emailrelay-textmode.exe</em> from the zip file without
going through the installation process.
</p>
<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.
messages by running with <em>--as-client</em>.
</p>
<img src="serverclient.png" alt="image">
<p>
For example, to start a storage daemon listening on port 587 use a command
like this:
For example, to start a storage daemon in the background listening on port 10025
use a command like this:
</p>
<div class="div-pre">
<pre>emailrelay --as-server --port 587 --spool-dir /tmp
<pre>emailrelay --as-server --port 10025 --spool-dir /tmp
</pre>
</div><!-- div-pre -->
<p>
On Windows use <em>c:/temp</em> for testing, rather than <em>/tmp</em>.
</p>
<p>
Or to run it in the foreground:
</p>
<div class="div-pre">
<pre>emailrelay --log --no-daemon --port 10025 --spool-dir /tmp
</pre>
</div><!-- div-pre -->
<p>
@ -71,16 +72,16 @@
</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.
To forward continuously you can add the <em>--poll</em> and <em>--forward-to</em> options to
the server command-line:
</p>
<img src="forwardto.png" alt="image">
<p>
This example starts a store-and-forward server that forwards spooled-up e-mail
every minute:
For example, this starts a server that also forwards spooled-up e-mail every
minute:
</p>
<div class="div-pre">
@ -88,8 +89,8 @@
</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>:
Or for a server that forwards each message as soon as it has been received, you
can use <em>--forward-on-disconnect</em>:
</p>
<div class="div-pre">
@ -97,33 +98,53 @@
</pre>
</div><!-- div-pre -->
<p>
To edit or filter e-mail as it passes through the proxy specify your filter
To edit or filter e-mail as it passes through the server 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>emailrelay --as-server --filter /tmp/set-from.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>:
Look for example filter scripts in the <em>examples</em> directory.
</p>
<p>
E-MailRelay can also be used as a personal internet mail server:
</p>
<img src="mailserver.png" alt="image">
<p>
Use <em>--remote-clients</em> (<em>-r</em>) to allow connections from outside the local
network, define your domain name with <em>--domain</em> and use an address verifier as
a first line of defense against spammers:
</p>
<div class="div-pre">
<pre>emailrelay --pop --no-smtp --log --close-stderr
<pre>emailrelay --as-server -v -r --domain=example.com --address-verifier=account:
</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.
Then enable POP access to the incoming e-mails with <em>--pop</em>, <em>--pop-port</em> and
<em>--pop-auth</em>:
</p>
<div class="div-pre">
<pre>emailrelay ... --pop --pop-port 10110 --pop-auth /etc/emailrelay.auth
</pre>
</div><!-- div-pre -->
<p>
By default E-MailRelay will always reject connections from remote networks. 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.
Set up the POP account with a user-id and password in the <em>--pop-auth</em> secrets
file. The secrets file should contain a single line of text like this:
</p>
<div class="div-pre">
<pre>server plain &lt;userid&gt; &lt;password&gt;
</pre>
</div><!-- div-pre -->
<p>
For more information on the command-line options refer to the reference guide
or run:
@ -132,20 +153,34 @@
<div class="div-pre">
<pre>emailrelay --help --verbose</pre>
</div><!-- div-pre -->
<h2><a class="a-header" name="SH_1_3">Packages</a></h2> <!-- index:2:SH:1:3:Packages -->
<h2><a class="a-header" name="SH_1_3">Autostart</a></h2> <!-- index:2:SH:1:3:Autostart -->
<p>
To install on Linux from a RPM or DEB package:
To install E-MailRelay on Windows run the <em>emailrelay-setup</em> program and choose
the automatic startup option on the last page so that E-MailRelay runs as a
Windows service. Use the Windows <em>Services</em> utility to configure the E-MailRelay
service as automatic or manual startup.
</p>
<p>
To install E-MailRelay on Linux from a RPM package:
</p>
<div class="div-pre">
<pre>sudo $SHELL # or 'su'
rpm -i emailrelay*.rpm # if RPM
dpkg -i emailrelay*.deb # if DEB
<pre>sudo rpm -i emailrelay*.rpm
</pre>
</div><!-- div-pre -->
<p>
If your Linux system uses <em>systemd</em> then you should check the E-MailRelay
configuration file <em>/etc/emailrelay.conf</em> is as you want it and then run:
Or from a DEB package:
</p>
<div class="div-pre">
<pre>sudo dpkg -i emailrelay*.deb
</pre>
</div><!-- div-pre -->
<p>
To get the E-MailRelay server to start automatically you should check the
configuration file <em>/etc/emailrelay.conf</em> is as you want it and then run the
following commands to activate the <em>systemd</em> service:
</p>
<div class="div-pre">
@ -155,19 +190,27 @@ systemctl status emailrelay
</pre>
</div><!-- div-pre -->
<p>
On other systems try these commands:
On other Linux systems try some combination of these commands to set up and
activate the E-MailRelay service:
</p>
<div class="div-pre">
<pre>cp /usr/lib/emailrelay/init/emailrelay /etc/init.d/
update-rc.d emailrelay enable || rc-update add emailrelay
invoke-rc.d emailrelay start || service emailrelay start
tail /var/log/messages /var/log/syslog 2&gt;/dev/null
update-rc.d emailrelay enable
rc-update add emailrelay
invoke-rc.d emailrelay start
service emailrelay start
tail /var/log/messages
tail /var/log/syslog
</pre>
</div><!-- div-pre -->
<p>
On Windows run the setup program.
On BSD systems add this line to /etc/rc.conf:
</p>
<div class="div-pre">
<pre>emailrelay_enable="YES"</pre>
</div><!-- div-pre -->
<h2><a class="a-header" name="SH_1_4">Documentation</a></h2> <!-- index:2:SH:1:4:Documentation -->
<p>
The following documentation is provided:
@ -186,8 +229,12 @@ tail /var/log/messages /var/log/syslog 2&gt;/dev/null
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_5">Feedback</a></h2> <!-- index:2:SH:1:5:Feedback -->
<p>
To give feedback, including reviews, bug reports and feature requests, please
use the SourceForge project website at https://sourceforge.net/p/emailrelay
</p>
</div> <!-- div-main -->
</body>
</html>
<!-- Copyright (C) 2001-2022 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->
<!-- Copyright (C) 2001-2023 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->

133
doc/readme.md
View File

@ -1,107 +1,131 @@
E-MailRelay Readme
==================
Abstract
--------
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.
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.
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.
Introduction
------------
E-MailRelay is a lightweight [SMTP][] store-and-forward mail server with [POP][] access
to spooled messages. It can be used as a personal internet mail server with
SpamAssassin spam filtering and [DNSBL][] connection blocking. Forwarding can be
to a fixed smarthost or using DNS MX routing. External scripts can be used for
address validation and e-mail message processing.
![whatisit.png](whatisit.png)
E-MailRelay uses the same non-blocking i/o model as Squid and nginx giving
excellent scalability and resource usage.
C++ source code is available and distribution is permitted under the GNU
General Public License V3.
E-MailRelay runs as a single process using the same non-blocking i/o model as
Squid and nginx giving excellent scalability and resource usage.
Quick start
-----------
E-MailRelay can be run straight from the command-line, and on Windows you can
run `emailrelay.exe` or `emailrelay-textmode.exe` from the zip file without
going through the installation process.
To use E-MailRelay in store-and-forward mode use the `--as-server` option to
start the storage daemon in the background, and then do delivery of spooled
messages by running with the `--as-client` option.
messages by running with `--as-client`.
![serverclient.png](serverclient.png)
For example, to start a storage daemon listening on port 587 use a command
like this:
For example, to start a storage daemon in the background listening on port 10025
use a command like this:
emailrelay --as-server --port 587 --spool-dir /tmp
emailrelay --as-server --port 10025 --spool-dir /tmp
On Windows use `c:/temp` for testing, rather than `/tmp`.
Or to run it in the foreground:
emailrelay --log --no-daemon --port 10025 --spool-dir /tmp
And then to forward the spooled mail to `smtp.example.com` run something
like this:
emailrelay --as-client smtp.example.com:25 --spool-dir /tmp
To get behaviour more like a proxy you can add the `--poll` and `--forward-to`
options so that messages are forwarded continuously rather than on-demand.
To forward continuously you can add the `--poll` and `--forward-to` options to
the server command-line:
![forwardto.png](forwardto.png)
This example starts a store-and-forward server that forwards spooled-up e-mail
every minute:
For example, this starts a server that also forwards spooled-up e-mail every
minute:
emailrelay --as-server --poll 60 --forward-to smtp.example.com:25
Or for a proxy server that forwards each message soon after it has been
received, you can use `--as-proxy` or add `--forward-on-disconnect`:
Or for a server that forwards each message as soon as it has been received, you
can use `--forward-on-disconnect`:
emailrelay --as-server --forward-on-disconnect --forward-to smtp.example.com:25
To edit or filter e-mail as it passes through the proxy specify your filter
To edit or filter e-mail as it passes through the server specify your filter
program with the `--filter` option, something like this:
emailrelay --as-proxy smtp.example.com:25 --filter addsig.js
emailrelay --as-server --filter /tmp/set-from.js
To run E-MailRelay as a [POP][] server without SMTP use `--pop` and `--no-smtp`:
Look for example filter scripts in the `examples` directory.
emailrelay --pop --no-smtp --log --close-stderr
E-MailRelay can also be used as a personal internet mail server:
The `emailrelay-submit` utility can be used to put messages straight into the
spool directory so that the POP clients can fetch them.
![mailserver.png](mailserver.png)
By default E-MailRelay will always reject connections from remote networks. To
allow connections from anywhere use the `--remote-clients` option, but please
check your firewall settings to make sure this cannot be exploited by spammers.
Use `--remote-clients` (`-r`) to allow connections from outside the local
network, define your domain name with `--domain` and use an address verifier as
a first line of defense against spammers:
emailrelay --as-server -v -r --domain=example.com --address-verifier=account:
Then enable POP access to the incoming e-mails with `--pop`, `--pop-port` and
`--pop-auth`:
emailrelay ... --pop --pop-port 10110 --pop-auth /etc/emailrelay.auth
Set up the POP account with a user-id and password in the `--pop-auth` secrets
file. The secrets file should contain a single line of text like this:
server plain <userid> <password>
For more information on the command-line options refer to the reference guide
or run:
emailrelay --help --verbose
Packages
--------
To install on Linux from a RPM or DEB package:
Autostart
---------
To install E-MailRelay on Windows run the `emailrelay-setup` program and choose
the automatic startup option on the last page so that E-MailRelay runs as a
Windows service. Use the Windows `Services` utility to configure the E-MailRelay
service as automatic or manual startup.
sudo $SHELL # or 'su'
rpm -i emailrelay*.rpm # if RPM
dpkg -i emailrelay*.deb # if DEB
To install E-MailRelay on Linux from a RPM package:
If your Linux system uses `systemd` then you should check the E-MailRelay
configuration file `/etc/emailrelay.conf` is as you want it and then run:
sudo rpm -i emailrelay*.rpm
Or from a DEB package:
sudo dpkg -i emailrelay*.deb
To get the E-MailRelay server to start automatically you should check the
configuration file `/etc/emailrelay.conf` is as you want it and then run the
following commands to activate the `systemd` service:
systemctl enable emailrelay
systemctl start emailrelay
systemctl status emailrelay
On other systems try these commands:
On other Linux systems try some combination of these commands to set up and
activate the E-MailRelay service:
cp /usr/lib/emailrelay/init/emailrelay /etc/init.d/
update-rc.d emailrelay enable || rc-update add emailrelay
invoke-rc.d emailrelay start || service emailrelay start
tail /var/log/messages /var/log/syslog 2>/dev/null
update-rc.d emailrelay enable
rc-update add emailrelay
invoke-rc.d emailrelay start
service emailrelay start
tail /var/log/messages
tail /var/log/syslog
On Windows run the setup program.
On BSD systems add this line to /etc/rc.conf:
emailrelay_enable="YES"
Documentation
-------------
@ -118,7 +142,12 @@ The following documentation is provided:
Source code documentation will be generated when building from source if
`doxygen` is available.
Feedback
--------
To give feedback, including reviews, bug reports and feature requests, please
use the SourceForge project website at https://sourceforge.net/p/emailrelay
[DNSBL]: https://en.wikipedia.org/wiki/DNSBL
[POP]: https://en.wikipedia.org/wiki/Post_Office_Protocol
[SMTP]: https://en.wikipedia.org/wiki/Simple_Mail_Transfer_Protocol

153
doc/readme.rst
View File

@ -1,49 +1,50 @@
******************
E-MailRelay Readme
******************
******
Readme
******
Abstract
========
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.
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.
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.
Introduction
============
E-MailRelay is a lightweight SMTP_ store-and-forward mail server with POP_ access
to spooled messages. It can be used as a personal internet mail server with
SpamAssassin spam filtering and DNSBL_ connection blocking. Forwarding can be
to a fixed smarthost or using DNS MX routing. External scripts can be used for
address validation and e-mail message processing.
.. image:: whatisit.png
:alt: whatisit.png
E-MailRelay uses the same non-blocking i/o model as Squid and nginx giving
excellent scalability and resource usage.
C++ source code is available and distribution is permitted under the GNU
General Public License V3.
E-MailRelay runs as a single process using the same non-blocking i/o model as
Squid and nginx giving excellent scalability and resource usage.
Quick start
===========
E-MailRelay can be run straight from the command-line, and on Windows you can
run *emailrelay.exe* or *emailrelay-textmode.exe* from the zip file without
going through the installation process.
To use E-MailRelay in store-and-forward mode use the *--as-server* option to
start the storage daemon in the background, and then do delivery of spooled
messages by running with the *--as-client* option.
messages by running with *--as-client*.
.. image:: serverclient.png
:alt: serverclient.png
For example, to start a storage daemon listening on port 587 use a command
like this:
For example, to start a storage daemon in the background listening on port 10025
use a command like this:
::
emailrelay --as-server --port 587 --spool-dir /tmp
emailrelay --as-server --port 10025 --spool-dir /tmp
On Windows use *c:/temp* for testing, rather than */tmp*.
Or to run it in the foreground:
::
emailrelay --log --no-daemon --port 10025 --spool-dir /tmp
And then to forward the spooled mail to *smtp.example.com* run something
like this:
@ -52,46 +53,63 @@ like this:
emailrelay --as-client smtp.example.com:25 --spool-dir /tmp
To get behaviour more like a proxy you can add the *--poll* and *--forward-to*
options so that messages are forwarded continuously rather than on-demand.
To forward continuously you can add the *--poll* and *--forward-to* options to
the server command-line:
.. image:: forwardto.png
:alt: forwardto.png
This example starts a store-and-forward server that forwards spooled-up e-mail
every minute:
For example, this starts a server that also forwards spooled-up e-mail every
minute:
::
emailrelay --as-server --poll 60 --forward-to smtp.example.com:25
Or for a proxy server that forwards each message soon after it has been
received, you can use *--as-proxy* or add *--forward-on-disconnect*:
Or for a server that forwards each message as soon as it has been received, you
can use *--forward-on-disconnect*:
::
emailrelay --as-server --forward-on-disconnect --forward-to smtp.example.com:25
To edit or filter e-mail as it passes through the proxy specify your filter
To edit or filter e-mail as it passes through the server specify your filter
program with the *--filter* option, something like this:
::
emailrelay --as-proxy smtp.example.com:25 --filter addsig.js
emailrelay --as-server --filter /tmp/set-from.js
To run E-MailRelay as a POP_ server without SMTP use *--pop* and *--no-smtp*:
Look for example filter scripts in the *examples* directory.
E-MailRelay can also be used as a personal internet mail server:
.. image:: mailserver.png
:alt: mailserver.png
Use *--remote-clients* (\ *-r*\ ) to allow connections from outside the local
network, define your domain name with *--domain* and use an address verifier as
a first line of defense against spammers:
::
emailrelay --pop --no-smtp --log --close-stderr
emailrelay --as-server -v -r --domain=example.com --address-verifier=account:
The *emailrelay-submit* utility can be used to put messages straight into the
spool directory so that the POP clients can fetch them.
Then enable POP access to the incoming e-mails with *--pop*, *--pop-port* and
\ *--pop-auth*\ :
By default E-MailRelay will always reject connections from remote networks. To
allow connections from anywhere use the *--remote-clients* option, but please
check your firewall settings to make sure this cannot be exploited by spammers.
::
emailrelay ... --pop --pop-port 10110 --pop-auth /etc/emailrelay.auth
Set up the POP account with a user-id and password in the *--pop-auth* secrets
file. The secrets file should contain a single line of text like this:
::
server plain <userid> <password>
For more information on the command-line options refer to the reference guide
or run:
@ -100,18 +118,29 @@ or run:
emailrelay --help --verbose
Packages
========
To install on Linux from a RPM or DEB package:
Autostart
=========
To install E-MailRelay on Windows run the *emailrelay-setup* program and choose
the automatic startup option on the last page so that E-MailRelay runs as a
Windows service. Use the Windows *Services* utility to configure the E-MailRelay
service as automatic or manual startup.
To install E-MailRelay on Linux from a RPM package:
::
sudo $SHELL # or 'su'
rpm -i emailrelay*.rpm # if RPM
dpkg -i emailrelay*.deb # if DEB
sudo rpm -i emailrelay*.rpm
If your Linux system uses *systemd* then you should check the E-MailRelay
configuration file */etc/emailrelay.conf* is as you want it and then run:
Or from a DEB package:
::
sudo dpkg -i emailrelay*.deb
To get the E-MailRelay server to start automatically you should check the
configuration file */etc/emailrelay.conf* is as you want it and then run the
following commands to activate the *systemd* service:
::
@ -119,16 +148,25 @@ configuration file */etc/emailrelay.conf* is as you want it and then run:
systemctl start emailrelay
systemctl status emailrelay
On other systems try these commands:
On other Linux systems try some combination of these commands to set up and
activate the E-MailRelay service:
::
cp /usr/lib/emailrelay/init/emailrelay /etc/init.d/
update-rc.d emailrelay enable || rc-update add emailrelay
invoke-rc.d emailrelay start || service emailrelay start
tail /var/log/messages /var/log/syslog 2>/dev/null
update-rc.d emailrelay enable
rc-update add emailrelay
invoke-rc.d emailrelay start
service emailrelay start
tail /var/log/messages
tail /var/log/syslog
On BSD systems add this line to /etc/rc.conf:
::
emailrelay_enable="YES"
On Windows run the setup program.
Documentation
=============
@ -145,7 +183,12 @@ The following documentation is provided:
Source code documentation will be generated when building from source if
*doxygen* is available.
Feedback
========
To give feedback, including reviews, bug reports and feature requests, please
use the SourceForge project website at https://sourceforge.net/p/emailrelay
.. _DNSBL: https://en.wikipedia.org/wiki/DNSBL
.. _POP: https://en.wikipedia.org/wiki/Post_Office_Protocol
.. _SMTP: https://en.wikipedia.org/wiki/Simple_Mail_Transfer_Protocol

130
doc/readme.txt
View File

@ -1,101 +1,123 @@
E-MailRelay Readme
==================
Abstract
--------
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.
Introduction
------------
E-MailRelay is a lightweight SMTP store-and-forward mail server with POP access
to spooled messages. It can be used as a personal internet mail server with
SpamAssassin spam filtering and DNSBL connection blocking. Forwarding can be
to a fixed smarthost or using DNS MX routing. External scripts can be used for
address validation and e-mail message processing.
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.
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.
E-MailRelay uses the same non-blocking i/o model as Squid and nginx giving
excellent scalability and resource usage.
C++ source code is available and distribution is permitted under the GNU
General Public License V3.
E-MailRelay runs as a single process using the same non-blocking i/o model as
Squid and nginx giving excellent scalability and resource usage.
Quick start
-----------
E-MailRelay can be run straight from the command-line, and on Windows you can
run "emailrelay.exe" or "emailrelay-textmode.exe" from the zip file without
going through the installation process.
To use E-MailRelay in store-and-forward mode use the "--as-server" option to
start the storage daemon in the background, and then do delivery of spooled
messages by running with the "--as-client" option.
messages by running with "--as-client".
For example, to start a storage daemon listening on port 587 use a command
like this:
For example, to start a storage daemon in the background listening on port 10025
use a command like this:
emailrelay --as-server --port 587 --spool-dir /tmp
emailrelay --as-server --port 10025 --spool-dir /tmp
On Windows use "c:/temp" for testing, rather than "/tmp".
Or to run it in the foreground:
emailrelay --log --no-daemon --port 10025 --spool-dir /tmp
And then to forward the spooled mail to "smtp.example.com" run something
like this:
emailrelay --as-client smtp.example.com:25 --spool-dir /tmp
To get behaviour more like a proxy you can add the "--poll" and "--forward-to"
options so that messages are forwarded continuously rather than on-demand.
To forward continuously you can add the "--poll" and "--forward-to" options to
the server command-line:
This example starts a store-and-forward server that forwards spooled-up e-mail
every minute:
For example, this starts a server that also forwards spooled-up e-mail every
minute:
emailrelay --as-server --poll 60 --forward-to smtp.example.com:25
Or for a proxy server that forwards each message soon after it has been
received, you can use "--as-proxy" or add "--forward-on-disconnect":
Or for a server that forwards each message as soon as it has been received, you
can use "--forward-on-disconnect":
emailrelay --as-server --forward-on-disconnect --forward-to smtp.example.com:25
To edit or filter e-mail as it passes through the proxy specify your filter
To edit or filter e-mail as it passes through the server specify your filter
program with the "--filter" option, something like this:
emailrelay --as-proxy smtp.example.com:25 --filter addsig.js
emailrelay --as-server --filter /tmp/set-from.js
To run E-MailRelay as a POP server without SMTP use "--pop" and "--no-smtp":
Look for example filter scripts in the "examples" directory.
emailrelay --pop --no-smtp --log --close-stderr
E-MailRelay can also be used as a personal internet mail server:
The "emailrelay-submit" utility can be used to put messages straight into the
spool directory so that the POP clients can fetch them.
Use "--remote-clients" ("-r") to allow connections from outside the local
network, define your domain name with "--domain" and use an address verifier as
a first line of defense against spammers:
By default E-MailRelay will always reject connections from remote networks. To
allow connections from anywhere use the "--remote-clients" option, but please
check your firewall settings to make sure this cannot be exploited by spammers.
emailrelay --as-server -v -r --domain=example.com --address-verifier=account:
Then enable POP access to the incoming e-mails with "--pop", "--pop-port" and
"--pop-auth":
emailrelay ... --pop --pop-port 10110 --pop-auth /etc/emailrelay.auth
Set up the POP account with a user-id and password in the "--pop-auth" secrets
file. The secrets file should contain a single line of text like this:
server plain <userid> <password>
For more information on the command-line options refer to the reference guide
or run:
emailrelay --help --verbose
Packages
--------
To install on Linux from a RPM or DEB package:
Autostart
---------
To install E-MailRelay on Windows run the "emailrelay-setup" program and choose
the automatic startup option on the last page so that E-MailRelay runs as a
Windows service. Use the Windows "Services" utility to configure the E-MailRelay
service as automatic or manual startup.
sudo $SHELL # or 'su'
rpm -i emailrelay*.rpm # if RPM
dpkg -i emailrelay*.deb # if DEB
To install E-MailRelay on Linux from a RPM package:
If your Linux system uses "systemd" then you should check the E-MailRelay
configuration file "/etc/emailrelay.conf" is as you want it and then run:
sudo rpm -i emailrelay*.rpm
Or from a DEB package:
sudo dpkg -i emailrelay*.deb
To get the E-MailRelay server to start automatically you should check the
configuration file "/etc/emailrelay.conf" is as you want it and then run the
following commands to activate the "systemd" service:
systemctl enable emailrelay
systemctl start emailrelay
systemctl status emailrelay
On other systems try these commands:
On other Linux systems try some combination of these commands to set up and
activate the E-MailRelay service:
cp /usr/lib/emailrelay/init/emailrelay /etc/init.d/
update-rc.d emailrelay enable || rc-update add emailrelay
invoke-rc.d emailrelay start || service emailrelay start
tail /var/log/messages /var/log/syslog 2>/dev/null
update-rc.d emailrelay enable
rc-update add emailrelay
invoke-rc.d emailrelay start
service emailrelay start
tail /var/log/messages
tail /var/log/syslog
On Windows run the setup program.
On BSD systems add this line to /etc/rc.conf:
emailrelay_enable="YES"
Documentation
-------------
@ -111,3 +133,7 @@ The following documentation is provided:
Source code documentation will be generated when building from source if
"doxygen" is available.
Feedback
--------
To give feedback, including reviews, bug reports and feature requests, please
use the SourceForge project website at https://sourceforge.net/p/emailrelay

1649
doc/reference.html
View File

File diff suppressed because it is too large Load Diff

1330
doc/reference.md
View File

File diff suppressed because it is too large Load Diff

1426
doc/reference.rst
View File

File diff suppressed because it is too large Load Diff

1295
doc/reference.txt
View File

File diff suppressed because it is too large Load Diff

BIN
doc/serverclient.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 17 KiB

After

Width:  |  Height:  |  Size: 17 KiB

40
doc/serverclient.svg
View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- Created with Inkscape (http://www.inkscape.org/) -->
<!-- Copyright (C) 2001-2022 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->
<!-- Copyright (C) 2001-2023 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->
<svg
xmlns:dc="http://purl.org/dc/elements/1.1/"
@ -12,7 +12,7 @@
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
id="svg3036"
version="1.1"
inkscape:version="0.48.4 r9939"
inkscape:version="0.92.4 (5da689c313, 2019-01-14)"
width="1650"
height="1023"
sodipodi:docname="serverclient.svg"
@ -27,7 +27,7 @@
<dc:format>image/svg+xml</dc:format>
<dc:type
rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
<dc:title></dc:title>
<dc:title />
</cc:Work>
</rdf:RDF>
</metadata>
@ -46,7 +46,7 @@
inkscape:window-height="803"
id="namedview3038"
showgrid="false"
inkscape:zoom="0.37165321"
inkscape:zoom="0.23040183"
inkscape:cx="964.09848"
inkscape:cy="499.69607"
inkscape:window-x="258"
@ -149,48 +149,48 @@
style="display:inline">
<text
xml:space="preserve"
style="font-size:48px;font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;display:inline;font-family:DejaVu Sans;-inkscape-font-specification:DejaVu Sans Bold"
style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;line-height:0%;font-family:'DejaVu Sans';-inkscape-font-specification:'DejaVu Sans Bold';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;display:inline;fill:#000000;fill-opacity:1;stroke:none"
x="326.78262"
y="76.436295"
id="text3290"
sodipodi:linespacing="125%"><tspan
id="text3290"><tspan
sodipodi:role="line"
x="326.78262"
y="76.436295"
id="tspan3306">--as-server</tspan></text>
id="tspan3306"
style="font-size:48px;line-height:1.25">--as-server</tspan></text>
<text
xml:space="preserve"
style="font-size:48px;font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;display:inline;font-family:DejaVu Sans;-inkscape-font-specification:DejaVu Sans Bold"
style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;line-height:0%;font-family:'DejaVu Sans';-inkscape-font-specification:'DejaVu Sans Bold';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;display:inline;fill:#000000;fill-opacity:1;stroke:none"
x="429.3356"
y="579.32336"
id="text3298"
sodipodi:linespacing="125%"><tspan
id="text3298"><tspan
sodipodi:role="line"
id="tspan3300"
x="429.3356"
y="579.32336">--filter</tspan></text>
y="579.32336"
style="font-size:48px;line-height:1.25">--filter</tspan></text>
<text
xml:space="preserve"
style="font-size:48px;font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;display:inline;font-family:DejaVu Sans;-inkscape-font-specification:DejaVu Sans Bold"
style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;line-height:0%;font-family:'DejaVu Sans';-inkscape-font-specification:'DejaVu Sans Bold';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;display:inline;fill:#000000;fill-opacity:1;stroke:none"
x="832.77466"
y="698.12524"
id="text3302"
sodipodi:linespacing="125%"><tspan
id="text3302"><tspan
sodipodi:role="line"
id="tspan3304"
x="832.77466"
y="698.12524">--spool-dir</tspan></text>
y="698.12524"
style="font-size:48px;line-height:1.25">--spool-dir</tspan></text>
<text
xml:space="preserve"
style="font-size:48px;font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;font-family:DejaVu Sans;-inkscape-font-specification:DejaVu Sans Bold"
style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;line-height:0%;font-family:'DejaVu Sans';-inkscape-font-specification:'DejaVu Sans Bold';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none"
x="1149.9675"
y="78.613342"
id="text3053"
sodipodi:linespacing="125%"><tspan
id="text3053"><tspan
sodipodi:role="line"
id="tspan3055"
x="1149.9675"
y="78.613342">--as-client</tspan></text>
y="78.613342"
style="font-size:48px;line-height:1.25">--as-client</tspan></text>
</g>
</svg>

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 33 KiB

After

Width:  |  Height:  |  Size: 33 KiB

631
doc/userguide.html
View File

@ -11,62 +11,21 @@
<h1><a class="a-header" name="H_1">E-MailRelay User Guide</a></h1> <!-- index:1:H:E-MailRelay User Guide -->
<h2><a class="a-header" name="SH_1_1">What is it?</a></h2> <!-- index:2:SH:1:1:What is it? -->
<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.
E-MailRelay is a lightweight SMTP store-and-forward mail server with POP access
to spooled messages. It can be used as a personal internet mail server with
SpamAssassin spam filtering and DNSBL connection blocking. Forwarding can be
to a fixed smarthost or using DNS MX routing. External scripts can be used for
address validation and e-mail message processing.
</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.
E-MailRelay runs as a single process using 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">What it's not</a></h2> <!-- index:2:SH:1:2:What it's not -->
<p>
E-MailRelay does not normally do routing of individual messages; it is not a
routing MTA. It forwards all e-mail messages to a pre-configured SMTP server,
regardless of any message addressing or DNS redirects.
</p>
<h2><a class="a-header" name="SH_1_3">Why use it?</a></h2> <!-- index:2:SH:1:3:Why use it? -->
<p>
E-MailRelay is a simple tool that does SMTP. For simple tasks it is likely
to be easier to understand and configure than a more general purpose MTA.
</p>
<p>
Typical applications of E-MailRelay include:
</p>
<ul>
<li>spam filtering and virus checking incoming mail</li>
<li>adding digital signatures or legal disclaimers to outgoing mail</li>
<li>store-and-forward for outgoing mail across an intermittent internet connection</li>
<li>adding authentication and encryption where the existing infrastructure does not support it</li>
<li>taking messages in with SMTP and serving them to local POP clients</li>
<li>giving multiple POP clients independent copies of incoming e-mail</li>
<li>SMTP proxying by running as a proxy server on a firewall machine</li>
</ul>
<p>
The code has few dependencies on third-party libraries or run-time environments
so it is easy to build and install.
@ -77,23 +36,41 @@
policies for message retries, bounces, local mailbox delivery, spam filtering
etc. through external scripts.
</p>
<h2><a class="a-header" name="SH_1_4">Running E-MailRelay</a></h2> <!-- index:2:SH:1:4:Running E-MailRelay -->
<h2><a class="a-header" name="SH_1_2">Basic operation</a></h2> <!-- index:2:SH:1:2:Basic operation -->
<p>
E-MailRelay can be run straight from the command-line, and on Windows you can
run <em>emailrelay.exe</em> or <em>emailrelay-textmode.exe</em> from the zip file without
going through the installation process.
</p>
<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.
messages by running with <em>--as-client</em>.
</p>
<img src="serverclient.png" alt="image">
<p>
For example, to start a storage daemon listening on port 587 use a command
like this:
For example, to start a storage daemon in the background listening on port 10025
use a command like this:
</p>
<div class="div-pre">
<pre>emailrelay --as-server --port 587 --spool-dir /tmp
<pre>emailrelay --as-server --port 10025 --spool-dir /tmp
</pre>
</div><!-- div-pre -->
<p>
On Windows use <em>c:/temp</em> for testing, rather than <em>/tmp</em>.
</p>
<p>
Or to run it in the foreground:
</p>
<div class="div-pre">
<pre>emailrelay --log --no-daemon --port 10025 --spool-dir /tmp
</pre>
</div><!-- div-pre -->
<p>
@ -106,16 +83,16 @@
</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.
To forward continuously you can add the <em>--poll</em> and <em>--forward-to</em> options to
the server command-line:
</p>
<img src="forwardto.png" alt="image">
<p>
This example starts a store-and-forward server that forwards spooled-up e-mail
every minute:
For example, this starts a server that also forwards spooled-up e-mail every
minute:
</p>
<div class="div-pre">
@ -123,8 +100,8 @@
</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>:
Or for a server that forwards each message as soon as it has been received, you
can use <em>--forward-on-disconnect</em>:
</p>
<div class="div-pre">
@ -132,33 +109,53 @@
</pre>
</div><!-- div-pre -->
<p>
To edit or filter e-mail as it passes through the proxy specify your filter
To edit or filter e-mail as it passes through the server 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>emailrelay --as-server --filter /tmp/set-from.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>:
Look for example filter scripts in the <em>examples</em> directory.
</p>
<p>
E-MailRelay can also be used as a personal internet mail server:
</p>
<img src="mailserver.png" alt="image">
<p>
Use <em>--remote-clients</em> (<em>-r</em>) to allow connections from outside the local
network, define your domain name with <em>--domain</em> and use an address verifier as
a first line of defense against spammers:
</p>
<div class="div-pre">
<pre>emailrelay --pop --no-smtp --log --close-stderr
<pre>emailrelay --as-server -v -r --domain=example.com --address-verifier=account:
</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.
Then enable POP access to the incoming e-mails with <em>--pop</em>, <em>--pop-port</em> and
<em>--pop-auth</em>:
</p>
<div class="div-pre">
<pre>emailrelay ... --pop --pop-port 10110 --pop-auth /etc/emailrelay.auth
</pre>
</div><!-- div-pre -->
<p>
By default E-MailRelay will always reject connections from remote networks. 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.
Set up the POP account with a user-id and password in the <em>--pop-auth</em> secrets
file. The secrets file should contain a single line of text like this:
</p>
<div class="div-pre">
<pre>server plain &lt;userid&gt; &lt;password&gt;
</pre>
</div><!-- div-pre -->
<p>
For more information on the command-line options refer to the reference guide
or run:
@ -167,107 +164,112 @@
<div class="div-pre">
<pre>emailrelay --help --verbose</pre>
</div><!-- div-pre -->
<h2><a class="a-header" name="SH_1_5">Configuration</a></h2> <!-- index:2:SH:1:5:Configuration -->
<h2><a class="a-header" name="SH_1_3">Configuration</a></h2> <!-- index:2:SH:1:3:Configuration -->
<p>
The <em>emailrelay</em> program itself is mostly configured through command-line
options (such as <em>--port</em> and <em>--forward-to</em>).
After a full installation the E-MailRelay server will normally be started up
automatically when the machine boots up.
</p>
<p>
In most installations on Unix-like system the E-MailRelay server will be
started up by the boot-time script called <em>emailrelay</em> in the <em>/etc/init.d</em>
directory, and this script uses the configuration file <em>/etc/emailrelay.conf</em> to
define the server command-line. Each entry in the configuration file corresponds
to an E-MailRelay command-line option, so you can edit this file to add and
remove server options. Refer to the reference guide for a complete list of
configuration options.
On Unix-like systems the server will read its configuration settings from a file
<em>/etc/emailrelay.conf</em>.
</p>
<p>
On Windows the installation program creates a startup batch file called
<em>emailrelay-start.bat</em> that contains all the server command-line options and
you can edit this file to change the server configuration. You can also set up
your own shortcuts to the E-MailRelay executable and add and remove command-line
options using the shortcut properties tab.
On Windows E-MailRelay typically runs as a Windows Service and it reads its
configuration from the startup batch file <em>emailrelay-start.bat</em>.
</p>
<p>
If you are using authentication then you will have to create the text files
containing your authentication secrets (account names, passwords and password
hashes). The <em>--server-auth</em>, <em>--client-auth</em> and <em>--pop-auth</em> command-line
options are used to point to these files.
You can change the E-MailRelay server configuration by editing the configuration
file or startup batch file directly and then restarting the server. Or you can
use the E-MailRelay configuration GUI if it is available.
</p>
<p>
There is also a graphical configuration program called <em>emailrelay-gui</em> that
may be available to help with configuring the system. This is mostly intended
to be used once at installation time since it is the basis of the Windows
installer, but it can also be used to do some simple reconfiguration of an
already-installed system. It takes you through a sequence of configuration
pages and then on the last page creates or updates the configuration files, ie.
the authentication secrets file and the configuration file <em>emailrelay.conf</em>
or <em>emailrelay-start.bat</em>.
</p>
<h2><a class="a-header" name="SH_1_6">Logging</a></h2> <!-- index:2:SH:1:6:Logging -->
<p>
If the <em>--log</em> option is used then E-MailRelay program sends warnings and error
messages to its standard error stream, and to the <em>syslog</em> system on Unix or
to the Event Viewer on Windows.
In many cases E-MailRelay will need to be configured with user-ids and
passwords. For example, if e-mail is being forwarded to a <em>smarthost</em> for onward
routing then you will need to supply the user-id and password for your account
on the smarthost. These details must be entered into a <em>secrets</em> file and then
one of <em>--server-auth</em>, <em>--client-auth</em> or <em>--pop-auth</em> must be used to point to
the file.
</p>
<p>
The standard error stream logging can be redirected to a file by using the
<em>--log-file</em> option, and daily log files can be created by using <em>%d</em> in the
filename.
The E-MailRelay reference document describes the format of the secrets file.
</p>
<h2><a class="a-header" name="SH_1_4">Logging</a></h2> <!-- index:2:SH:1:4:Logging -->
<p>
E-MailRelay is normally installed so that it logs its activity to a log file,
but it can also send logging information to <em>syslog</em> on Unix systems or the to
the Event Viewer on Windows.
</p>
<p>
For more verbose logging add the <em>--verbose</em> option to the command-line.
</p>
<h2><a class="a-header" name="SH_1_7">Preventing open mail relay</a></h2> <!-- index:2:SH:1:7:Preventing open mail relay -->
<p>
If you are running E-MailRelay as a server with a permanent connection to the
internet it is important to prevent open mail relay because this can be
exploited by spammers and get you into trouble with your ISP. By default open
mail relaying is not possible because E-MailRelay does not accept IP connections
from remote clients. However, if you use the <em>--remote-clients</em> option then you
need to be more careful.
Logging is configured with options like <em>--log</em>, <em>--log-file</em>, <em>--as-server</em> and
<em>--syslog</em>, so check these in the configuration file or startup batch file.
</p>
<p>
If the only required access to the E-MailRelay server is from a local network
and not from the internet then just set up your firewall to block incoming
connections on ports 25 (SMTP) and 110 (POP) and also use the <em>--interface</em>
option on the E-MailRelay command-line so that it only listens for incoming
connections on the local network.
For more verbose logging add the <em>--verbose</em> option. This is a good idea when
setting up or trouble-shooting your E-MailRelay configuration.
</p>
<h2><a class="a-header" name="SH_1_5">Failures and retries</a></h2> <!-- index:2:SH:1:5:Failures and retries -->
<p>
If e-mail messages cannot be forwarded by the E-MailRelay system then the
envelope files in the spool directory are given a <em>.bad</em> suffix. The reason for
the failure will be recorded in the envelope file itself.
</p>
<p>
If you do need to accept connections from the internet then you should require
all clients to authenticate themselves by using the <em>--server-auth</em> option on
the E-MailRelay command-line. If you also want local clients running on your
internal network to be able to bypass this authentication then you can put those
trusted IP addresses in the E-MailRelay secrets file with an authentication
mechanism of <em>none</em>. Refer to the reference guide for more information.
</p>
<h2><a class="a-header" name="SH_1_8">Running as a POP server</a></h2> <!-- index:2:SH:1:8:Running as a POP server -->
<p>
E-MailRelay can run as a POP server so that e-mail client programs can retrieve
messages from the E-MailRelay spool directory directly.
You should check for <em>.bad</em> envelope files in the E-MailRelay spool directory
from time to time. If you want failed messages to be retried then just remove
the <em>.bad</em> filename suffix. On Unix-like systems you can do this automatically
with a cron job that runs the <em>emailrelay-resubmit.sh</em> script occasionally.
</p>
<p>
To allow POP access to spooled messages use a command-line something like this:
Once a failed message has been renamed it will be forwarded along with all the
others. It is a good idea to use regular polling (eg. <em>--poll=60</em>) to make sure
that this happens in a timely manner.
</p>
<h2><a class="a-header" name="SH_1_6">Open mail servers</a></h2> <!-- index:2:SH:1:6:Open mail servers -->
<p>
If you are running E-MailRelay as an internet mail server then you need to be
careful about abuse by spammers and bot-nets. You will also need to be sure that
incoming e-mail messages are never automatically routed back out to the internet
because that will definitely attract abuse.
</p>
<p>
By default an E-MailRelay server will only accept connections from local network
addresses, so for an internet mail server you will need to add the
<em>--remote-clients</em> option. When you add <em>--remote-clients</em> you should be
sure that you have a firewall that blocks connections to any other ports that
E-MailRelay might have open, or use the <em>--interface</em> option to limit their
scope.
</p>
<p>
A good first step in limiting abuse is to use an address verifier that checks
that e-mails are correctly addressed to you. You can use the built-in address
verifier called <em>account:</em> to do this or you can write your own verifier script.
</p>
<div class="div-pre">
<pre>emailrelay --as-server --pop --pop-auth=/etc/pop.auth
<pre>emailrelay --as-server --remote-clients --address-verifier=account: --domain=mydomain.com
</pre>
</div><!-- div-pre -->
<p>
You will need to create the authentication secrets file (<em>pop.auth</em> in this
example) containing usernames and passwords. A simple example would look
like this:
Refer to the <em>Address verifiers</em> section in the E-MailRelay reference document
for more details.
</p>
<p>
If you want to run an internet mail server that is not open to everyone then you
can require that remote users authenticate themselves. Do this with a secrets
file containing a user-id and password for every remote user, something like
this:
</p>
<div class="div-pre">
@ -276,35 +278,107 @@ server plain user2 password2
</pre>
</div><!-- div-pre -->
<p>
It can sometimes be useful to serve up the same e-mail messages to multiple POP
clients. For example, you might use several e-mail clients on your local network
and you would like to see your mail on all of them equally. The <em>--pop-by-name</em>
option is intended to be used in this scenario; each e-mail client sees its own
copy of the e-mail messages, stored in its own sub-directory of the main spool
directory. The name of the sub-directory is simply the name that the client uses
to authenticate with the E-MailRelay server. You just need to create the
sub-directory for each client and then specify <em>emailrelay-filter-copy</em>
as the E-MailRelay <em>--filter</em> program.
And then use <em>--server-auth</em> to point to the file:
</p>
<div class="div-pre">
<pre>emailrelay --as-server --remote-clients --server-auth=/etc/emailrelay.auth
</pre>
</div><!-- div-pre -->
<p>
Refer to the <em>Authentication</em> section in the E-MailRelay reference document for
more details.
</p>
<h2><a class="a-header" name="SH_1_7">Running as a POP server</a></h2> <!-- index:2:SH:1:7:Running as a POP server -->
<p>
E-MailRelay can run as a POP server so that an e-mail client program can
retrieve messages from the E-MailRelay spool directory.
</p>
<p>
Refer to the documentation of the various <em>--pop</em> command-line options for
more detail: <em>--pop</em>, <em>--pop-port</em>, <em>--pop-auth</em>, <em>--pop-no-delete</em> and
<em>--pop-by-name</em>.
To allow POP access use the <em>--pop</em> and <em>--pop-auth</em> command-line options,
something like this:
</p>
<div class="div-pre">
<pre>emailrelay --as-server --pop --pop-auth=/etc/pop.auth
</pre>
</div><!-- div-pre -->
<p>
You will need to create the POP authentication secrets file containing usernames
and passwords, as above.
</p>
<p>
If you use more than one e-mail client program then you will probably want to
make independent copies of your e-mails for each. Use a <em>--filter</em> program to
copy the e-mail files into multiple sub-directories of the main spool directory
and then use <em>--pop-by-name</em> so that each e-mail client accesses its own
sub-directory according to which account name it used when authenticating.
</p>
<p>
The filter can be an external program or the built-in <em>copy:</em> filter:
</p>
<div class="div-pre">
<pre>emailrelay --as-server --filter=copy:pop --pop --pop-by-name --pop-auth=/etc/pop.auth
</pre>
</div><!-- div-pre -->
<p>
Add the account for each e-mail client in the POP authentication secrets file
and manually create the corresponding sub-directory.
</p>
<p>
The <em>--pop-by-name</em> option is also useful when e-mail messages are being
copied into individual mailboxes by the <em>deliver:</em> filter. In this case each
sub-directory is a mailbox containing only those e-mails that are addressed to
the mailbox owner.
</p>
<img src="popbyname.png" alt="image">
<p>
Refer to the <em>Delivery</em> section in the E-MailRelay reference document for more
information.
</p>
<p>
If you are using POP to view a spool directory that is also being used for
e-mail forwarding then you must use <em>--pop-no-delete</em>.
</p>
<h2><a class="a-header" name="SH_1_8">IMAP</a></h2> <!-- index:2:SH:1:8:IMAP -->
<p>
E-MailRelay does not support the IMAP protocol directly but a simple filter
script can be used to move e-mails into a <em>maildir</em> directory and an IMAP server
such as <em>dovecot</em> can be used to serve them from there.
</p>
<p>
It is normally sufficient for a filter script to just move the E-MailRelay
content file straight into the mailbox <em>cur</em> directory, delete the corresponding
envelope file and then exit with an exit code of 100.
</p>
<p>
The built-in <em>deliver:</em> filter will automatically do this if it sees that the
target sub-directory of the spool directory is actually a <em>maildir</em> mailbox.
</p>
<h2><a class="a-header" name="SH_1_9">Triggering delivery</a></h2> <!-- index:2:SH:1:9:Triggering delivery -->
<p>
If you are using E-MailRelay on Unix to store and forward e-mail over an
intermittent link to the internet such as dial-up or wireless networking, then
you might need to set things up so that the network tells E-MailRelay when to
start forwarding e-mail.
If you are using E-MailRelay on a Linux/Unix system to store and forward e-mail
over an intermittent link to the internet such as dial-up or wireless
networking, then you might need to arrange for E-MailRelay to be notified when
it can start forwarding e-mail.
</p>
<p>
On Linux systems you should find that there are special directories where you
can install your own hook scripts that are called whenever a dial-up or wireless
network connection is established. For dial-up this might be <em>/etc/ppp/ip-up.d</em>,
and for wireless <em>/etc/network/if-up.d</em>.
You should find that there are special directories where you can install your
own hook scripts that are called whenever a dial-up or wireless network
connection is established. For dial-up this might be <em>/etc/ppp/ip-up.d</em>, and for
wireless <em>/etc/network/if-up.d</em>.
</p>
<p>
@ -319,60 +393,16 @@ exec /usr/local/sbin/emailrelay --as-client=smtp.example.com:smtp
<p>
and make it executable using <em>chmod +x</em>.
</p>
<h2><a class="a-header" name="SH_1_10">Failed e-mails</a></h2> <!-- index:2:SH:1:10:Failed e-mails -->
<p>
If e-mail messages cannot be forwarded by the E-MailRelay system then the
envelope files in the spool directory are given a <em>.bad</em> suffix. The reason for
the failure will be recorded in the envelope file itself.
</p>
<p>
You should check for <em>.bad</em> envelope files in the E-MailRelay spool directory
from time to time. If you want them to be retried next time then just remove
the <em>.bad</em> filename suffix.
You can also trigger forwarding from the E-MailRelay server via the <em>--admin</em>
interface.
</p>
<p>
You can run the <em>emailrelay-resubmit</em> script periodically to automate this; it
removes the <em>.bad</em> suffix from files in the spool directory as long as they
have not been retried too many times already.
</p>
<h2><a class="a-header" name="SH_1_11">Usage patterns</a></h2> <!-- index:2:SH:1:11:Usage patterns -->
<p>
The simplest ways of using E-MailRelay for SMTP are to run it as a proxy or to
do store-and-forward, but many other configurations are possible. For example,
multiple E-MailRelay servers can run in parallel sharing the same spool
directory, or they can be chained in series to that e-mail messages get
transferred from one to the next.
</p>
<p>
Remember that messages can be introduced directly into the E-MailRelay spool
directory using the <em>emailrelay-submit</em> utility, and they can be moved out again
at any time, as long as the envelope file is not locked (ie. with a special
filename extension). Your <em>--filter</em> program can edit messages in any way you
want, and it can even delete the current message from the spool directory.
</p>
<p>
When using E-MailRelay as a POP server the <em>--pop-by-name</em> feature can be used
to serve up different spooled messages according to the username that the
client authenticated with. Rather than use <em>emailrelay-filter-copy</em> to
distribute incoming e-mail messages into all subdirectories you could use a
custom script to do it based on the message addressing.
</p>
<p>
The POP server can also be used for checking e-mails that are taken out of the
normal store-and-forward flow. For example, a <em>--filter</em> script that checks for
spam could move suspicious e-mails into a subdirectory of the spool directory
that is accessible via the <em>--pop-by-name</em> feature.
</p>
<h2><a class="a-header" name="SH_1_12">Rate limiting</a></h2> <!-- index:2:SH:1:12:Rate limiting -->
<h2><a class="a-header" name="SH_1_10">Rate limiting</a></h2> <!-- index:2:SH:1:10:Rate limiting -->
<p>
If you need to slow the rate at which e-mails are forwarded you can use a
<em>--client-filter</em> program to introduce a delay. On Windows this JavaScript
program would give you a delay of a minute:
filter program would give you a delay of a minute:
</p>
<div class="div-pre">
@ -385,7 +415,7 @@ WScript.Quit( 0 ) ;
<em>--client-filter exit:102</em> so that only one e-mail message is forwarded on each
polling cycle, and then use <em>--poll 60</em> to limit it to one e-mail per minute.
</p>
<h2><a class="a-header" name="SH_1_13">SpamAssassin</a></h2> <!-- index:2:SH:1:13:SpamAssassin -->
<h2><a class="a-header" name="SH_1_11">SpamAssassin</a></h2> <!-- index:2:SH:1:11:SpamAssassin -->
<p>
The E-MailRelay server can use <a href="http://spamassassin.apache.org">SpamAssassin</a>
to mark or reject potential spam.
@ -393,74 +423,47 @@ WScript.Quit( 0 ) ;
<p>
It's easiest to run SpamAssassin's <em>spamd</em> program in the background and let
E-MailRelay send incoming messages to it over the network. By default
SpamAssassin <em>spamd</em> uses port 783 so you should use an E-MailRelay
command-line option of <em>--filter spam-edit:127.0.0.1:783</em> if you want spam
messages to pass through with a warning added, or <em>--filter spam:127.0.0.1:783</em>
if you want spam messages to be rejected outright.
E-MailRelay send incoming messages to it over the local network.
</p>
<p>
Alternatively you can run SpamAssassin on demand for each message. To get
E-MailRelay to reject spam outright you can just use <em>spamassassin -e</em> as
your E-MailRelay <em>--filter</em> program:
The built-in <em>spam-edit:</em> filter is used to pass e-mail messages to spamd:
</p>
<div class="div-pre">
<pre>emailrelay --as-server --filter="/usr/bin/spamassassin -e"
<pre>emailrelay --as-server --filter=spam-edit:127.0.0.1:783
</pre>
</div><!-- div-pre -->
<p>
Or on Windows:
</p>
<div class="div-pre">
<pre>emailrelay --as-server --filter="c:/perl/site/bin/spamassassin.bat -e"
</pre>
</div><!-- div-pre -->
<p>
To get spam messages identified by SpamAssassin but still pass through the
E-MailRelay system you will have to have a small <em>--filter</em> script to collect
the output from the <em>spamassassin</em> program and write it back into the
E-MailRelay content file.
If SpamAssassin detects a message is spam it will edit it into a spam report
with the original e-mail moved into an attachment.
</p>
<p>
On Unix your <em>--filter</em> shell script could look something like this:
Alternatively use the <em>spam:</em> filter if spam e-mails should be rejected
outright:
</p>
<div class="div-pre">
<pre>#!/bin/sh
spamassassin "$1" &gt; "$1.tmp"
mv "$1.tmp" "$1"
exit 0
</pre>
<pre>emailrelay --as-server --filter=spam:127.0.0.1:783</pre>
</div><!-- div-pre -->
<p>
On Windows an equivalent batch script would be:
</p>
<div class="div-pre">
<pre>c:\perl\site\bin\spamassassin.bat %1 &gt; %1.tmp
ren %1.tmp %1
exit 0</pre>
</div><!-- div-pre -->
<h2><a class="a-header" name="SH_1_14">Google mail</a></h2> <!-- index:2:SH:1:14:Google mail -->
<h2><a class="a-header" name="SH_1_12">Google mail</a></h2> <!-- index:2:SH:1:12:Google mail -->
<p>
To send mail via Google mail's SMTP gateway you will need to obtain a new
<em>application password</em> from Google. Log in to your Google account and look for
<em>application password</em> from Google: log in to your Google account and look for
the account's security settings and then <em>app passwords</em>. Create the password
for E-MailRelay as application type <em>other</em>.
for E-MailRelay selecting an application type <em>other</em>.
</p>
<p>
Then you need to create a client secrets file for E-MailRelay containing your
account name and the new application password. You may already have this file
on Windows as <em>C:\ProgramData\E-MailRelay\emailrelay.auth</em>.
Then create a client secrets file for E-MailRelay containing your account name
and the new application password. You may already have this file on Windows as
<em>C:\ProgramData\E-MailRelay\emailrelay.auth</em>.
</p>
<p>
You should edit the file to contain one <em>client</em> line, something like this:
You should edit the secrets file to contain one <em>client</em> line, something like
this:
</p>
<div class="div-pre">
@ -469,9 +472,12 @@ exit 0</pre>
</div><!-- div-pre -->
<p>
Then change the E-MailRelay startup batch file or configuration file to refer
to your secrets file by using the <em>--client-auth</em> option. The <em>--as-proxy</em> or
<em>--forward-to</em> options should be set to <em>smtp.gmail.com:587</em> and you will also
need to add the <em>--client-tls</em> option to enable TLS encryption.
to your secrets file by using the <em>--client-auth</em> option.
</p>
<p>
Also set the <em>--as-proxy</em> or <em>--forward-to</em> option to <em>smtp.gmail.com:587</em> and
add <em>--client-tls</em> to enable TLS encryption.
</p>
<p>
@ -483,7 +489,7 @@ exit 0</pre>
</pre>
</div><!-- div-pre -->
<p>
Or in a configration file like this:
Or an equivalent configuration file like this:
</p>
<div class="div-pre">
@ -491,7 +497,7 @@ exit 0</pre>
client-tls
client-auth C:/ProgramData/E-MailRelay/emailrelay.auth</pre>
</div><!-- div-pre -->
<h2><a class="a-header" name="SH_1_15">Connection tunnelling</a></h2> <!-- index:2:SH:1:15:Connection tunnelling -->
<h2><a class="a-header" name="SH_1_13">Connection tunnelling</a></h2> <!-- index:2:SH:1:13:Connection tunnelling -->
<p>
E-MailRelay can send mail out via a SOCKS v4 proxy, which makes it easy to route
your mail through an encrypted tunnel created by <em>ssh -N -D</em> or via the Tor
@ -504,21 +510,126 @@ client-auth C:/ProgramData/E-MailRelay/emailrelay.auth</pre>
</p>
<div class="div-pre">
<pre>emailrelay --port 587 --as-proxy=smtp.example.com:25@localhost:9050 --domain=anonymous.net --anonymous --connection-timeout=300</pre>
<pre>emailrelay --port 587 --as-proxy=smtp.example.com:25@localhost:9050 --domain=anon.net --anonymous --connection-timeout=300</pre>
</div><!-- div-pre -->
<h2><a class="a-header" name="SH_1_16">Blocklists and dynamic firewalls</a></h2> <!-- index:2:SH:1:16:Blocklists and dynamic firewalls -->
<h2><a class="a-header" name="SH_1_14">Blocklists and dynamic firewalls</a></h2> <!-- index:2:SH:1:14:Blocklists and dynamic firewalls -->
<p>
E-MailRelay can consult with remote DNSBL blocklist servers in order to block
incoming connections from known spammers. Refer to the documentation of the
<em>--dnsbl</em> option for more details.
incoming connections from known spammers. For example:
</p>
<div class="div-pre">
<pre>emailrelay -r --dnsbl=zen.spamhaus.org,bl.mailspike.net ...
</pre>
</div><!-- div-pre -->
<p>
Refer to the documentation of the <em>--dnsbl</em> option for more details.
</p>
<p>
It is also possible to integrate E-MailRelay with intrusion detection systems
such as <em>fail2ban</em> that monitor log files and dynamically modify your iptables
firewall. Use E-MailRelay's <em>--log-address</em> command-line option so that the
remote IP address of any badly-behaved remote user is logged and made available
to <em>fail2ban</em>.
spammers' IP addresses are logged and made visible to <em>fail2ban</em>.
</p>
<h2><a class="a-header" name="SH_1_15">Bcc handling</a></h2> <!-- index:2:SH:1:15:Bcc handling -->
<p>
E-MailRelay transfers e-mail messages without changing their content in any way,
other than by adding a <em>Received</em> header. In particular, if a message contains a
<em>Bcc:</em> header when it is submitted to the E-MailRelay server it will have the
same <em>Bcc:</em> header when forwarded.
</p>
<p>
It is normally the responsibility of the program that submits an e-mail message
to submit it separately for each <em>Bcc</em> recipient, removing the <em>Bcc:</em> header
from the message content or changing it to contain only the 'current' recipient.
If this is not done, perhaps through misconfiguration of the e-mail user agent
program, then <em>Bcc</em> recipients may be visible to the <em>To</em> and <em>Cc</em> message
recipients.
</p>
<p>
An E-MailRelay <em>--filter</em> script can be used to reject messages with incorrect
<em>Bcc:</em> headers, and an example script is included.
</p>
<h2><a class="a-header" name="SH_1_16">Advanced set-up</a></h2> <!-- index:2:SH:1:16:Advanced set-up -->
<p>
As an example of an advanced E-MailRelay setup consider the following
command-line, split onto multiple lines for readability:
</p>
<div class="div-pre">
<pre>emailrelay
--log --verbose --log-time --log-network
--close-stderr --syslog
--pid-file @app/emailrelay.pid
--user root
--in-spool-dir @app/in
--in-port 25
--in-domain example.com
--in-address-verifier account:
--in-dnsbl 1.1.1.1:53,500,1,dnsbl.example.com
--in-filter spam-edit:127.0.0.1:783
--in-filter deliver:
--in-server-smtp-config +chunking,+smtputf8
--in-size 100000000
--in-pop
--in-pop-port 110
--in-pop-auth pam:
--in-pop-by-name
--out-spool-dir @app/out
--out-port 587
--out-forward-on-disconnect
--out-forward-to-some
--out-poll 60
--out-address-verifier account:check
--out-delivery-dir @app/in
--out-filter deliver:
--out-filter split:
--out-client-filter mx:
--out-forward-to 127.0.0.1:588
--out-domain example.com
--other-spool-dir @app/other
--other-port 588
--other-interface 127.0.0.1
--other-client-tls
--other-client-auth plain:YWxpY2VAZ21haWwuY29t:UGFzc3cwcmQ
--other-forward-to smtp.gmail.com:587
--other-poll 3600
</pre>
</div><!-- div-pre -->
<p>
This is a three-in-one configuration so there are effectively three E-MailRelay
servers running in one process, named <em>in</em>, <em>out</em> and <em>other</em>.
</p>
<p>
The <em>in</em> server is an internet-facing e-mail server with delivery to individual
mailboxes that can be accessed via POP. The <em>account:</em> verifier checks the
addressees in the incoming e-mails against the list of accounts on the local
machine and against the given domain name; the IP address of the network
connection is checked against a DNSBL database; SpamAssassin is used to
identify spam; and Linux PAM is used for POP authentication.
</p>
<p>
The <em>out</em> server is a routing MTA that sends outgoing e-mail messages directly
to destination servers. The filter makes copies so that eash e-mail message goes
to just one domain. The client filter uses DNS MX queries against the local
system's default name servers to do the routing. If any e-mail messages are
addressed to local users they are short-circuited and delivered directly to
their <em>in</em> mailboxes.
</p>
<p>
The <em>other</em> server does store-and-forward to a gmail smarthost and acts as the
default destination for the <em>out</em> server. In this example the gmail password is
given directly on the command-line but it is normally more secure to use a
separate secrets file.
</p>
@ -526,10 +637,10 @@ client-auth C:/ProgramData/E-MailRelay/emailrelay.auth</pre>
<div class="div-footer">
<p>
Copyright (C) 2001-2022 Graeme Walker
Copyright (C) 2001-2023 Graeme Walker
</p>
</div><!-- div-footer -->
</div> <!-- div-main -->
</body>
</html>
<!-- Copyright (C) 2001-2022 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->
<!-- Copyright (C) 2001-2023 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->

520
doc/userguide.md
View File

@ -3,48 +3,16 @@ E-MailRelay User Guide
What is it?
-----------
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.
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.
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.
E-MailRelay is a lightweight [SMTP][] store-and-forward mail server with [POP][] access
to spooled messages. It can be used as a personal internet mail server with
SpamAssassin spam filtering and [DNSBL][] connection blocking. Forwarding can be
to a fixed smarthost or using DNS MX routing. External scripts can be used for
address validation and e-mail message processing.
![whatisit.png](whatisit.png)
E-MailRelay uses the same non-blocking i/o model as Squid and nginx giving
excellent scalability and resource usage.
C++ source code is available and distribution is permitted under the GNU
General Public License V3.
What it's not
-------------
E-MailRelay does not normally do routing of individual messages; it is not a
routing [MTA][]. It forwards all e-mail messages to a pre-configured SMTP server,
regardless of any message addressing or DNS redirects.
Why use it?
-----------
E-MailRelay is a simple tool that does SMTP. For simple tasks it is likely
to be easier to understand and configure than a more general purpose MTA.
Typical applications of E-MailRelay include:
* spam filtering and virus checking incoming mail
* adding digital signatures or legal disclaimers to outgoing mail
* store-and-forward for outgoing mail across an intermittent internet connection
* adding authentication and encryption where the existing infrastructure does not support it
* taking messages in with SMTP and serving them to local [POP][] clients
* giving multiple POP clients independent copies of incoming e-mail
* SMTP proxying by running as a proxy server on a firewall machine
E-MailRelay runs as a single process using the same non-blocking i/o model as
Squid and nginx giving excellent scalability and resource usage.
The code has few dependencies on third-party libraries or run-time environments
so it is easy to build and install.
@ -53,54 +21,75 @@ E-MailRelay is designed to be policy-free, so that you can implement your own
policies for message retries, bounces, local mailbox delivery, spam filtering
etc. through external scripts.
Running E-MailRelay
-------------------
Basic operation
---------------
E-MailRelay can be run straight from the command-line, and on Windows you can
run `emailrelay.exe` or `emailrelay-textmode.exe` from the zip file without
going through the installation process.
To use E-MailRelay in store-and-forward mode use the `--as-server` option to
start the storage daemon in the background, and then do delivery of spooled
messages by running with the `--as-client` option.
messages by running with `--as-client`.
![serverclient.png](serverclient.png)
For example, to start a storage daemon listening on port 587 use a command
like this:
For example, to start a storage daemon in the background listening on port 10025
use a command like this:
emailrelay --as-server --port 587 --spool-dir /tmp
emailrelay --as-server --port 10025 --spool-dir /tmp
On Windows use `c:/temp` for testing, rather than `/tmp`.
Or to run it in the foreground:
emailrelay --log --no-daemon --port 10025 --spool-dir /tmp
And then to forward the spooled mail to `smtp.example.com` run something
like this:
emailrelay --as-client smtp.example.com:25 --spool-dir /tmp
To get behaviour more like a proxy you can add the `--poll` and `--forward-to`
options so that messages are forwarded continuously rather than on-demand.
To forward continuously you can add the `--poll` and `--forward-to` options to
the server command-line:
![forwardto.png](forwardto.png)
This example starts a store-and-forward server that forwards spooled-up e-mail
every minute:
For example, this starts a server that also forwards spooled-up e-mail every
minute:
emailrelay --as-server --poll 60 --forward-to smtp.example.com:25
Or for a proxy server that forwards each message soon after it has been
received, you can use `--as-proxy` or add `--forward-on-disconnect`:
Or for a server that forwards each message as soon as it has been received, you
can use `--forward-on-disconnect`:
emailrelay --as-server --forward-on-disconnect --forward-to smtp.example.com:25
To edit or filter e-mail as it passes through the proxy specify your filter
To edit or filter e-mail as it passes through the server specify your filter
program with the `--filter` option, something like this:
emailrelay --as-proxy smtp.example.com:25 --filter addsig.js
emailrelay --as-server --filter /tmp/set-from.js
To run E-MailRelay as a POP server without SMTP use `--pop` and `--no-smtp`:
Look for example filter scripts in the `examples` directory.
emailrelay --pop --no-smtp --log --close-stderr
E-MailRelay can also be used as a personal internet mail server:
The `emailrelay-submit` utility can be used to put messages straight into the
spool directory so that the POP clients can fetch them.
![mailserver.png](mailserver.png)
By default E-MailRelay will always reject connections from remote networks. To
allow connections from anywhere use the `--remote-clients` option, but please
check your firewall settings to make sure this cannot be exploited by spammers.
Use `--remote-clients` (`-r`) to allow connections from outside the local
network, define your domain name with `--domain` and use an address verifier as
a first line of defense against spammers:
emailrelay --as-server -v -r --domain=example.com --address-verifier=account:
Then enable POP access to the incoming e-mails with `--pop`, `--pop-port` and
`--pop-auth`:
emailrelay ... --pop --pop-port 10110 --pop-auth /etc/emailrelay.auth
Set up the POP account with a user-id and password in the `--pop-auth` secrets
file. The secrets file should contain a single line of text like this:
server plain <userid> <password>
For more information on the command-line options refer to the reference guide
or run:
@ -109,112 +98,156 @@ or run:
Configuration
-------------
The `emailrelay` program itself is mostly configured through command-line
options (such as `--port` and `--forward-to`).
After a full installation the E-MailRelay server will normally be started up
automatically when the machine boots up.
In most installations on Unix-like system the E-MailRelay server will be
started up by the boot-time script called `emailrelay` in the `/etc/init.d`
directory, and this script uses the configuration file `/etc/emailrelay.conf` to
define the server command-line. Each entry in the configuration file corresponds
to an E-MailRelay command-line option, so you can edit this file to add and
remove server options. Refer to the reference guide for a complete list of
configuration options.
On Unix-like systems the server will read its configuration settings from a file
`/etc/emailrelay.conf`.
On Windows the installation program creates a startup batch file called
`emailrelay-start.bat` that contains all the server command-line options and
you can edit this file to change the server configuration. You can also set up
your own shortcuts to the E-MailRelay executable and add and remove command-line
options using the shortcut properties tab.
On Windows E-MailRelay typically runs as a Windows Service and it reads its
configuration from the startup batch file `emailrelay-start.bat`.
If you are using authentication then you will have to create the text files
containing your authentication secrets (account names, passwords and password
hashes). The `--server-auth`, `--client-auth` and `--pop-auth` command-line
options are used to point to these files.
You can change the E-MailRelay server configuration by editing the configuration
file or startup batch file directly and then restarting the server. Or you can
use the E-MailRelay configuration GUI if it is available.
There is also a graphical configuration program called `emailrelay-gui` that
may be available to help with configuring the system. This is mostly intended
to be used once at installation time since it is the basis of the Windows
installer, but it can also be used to do some simple reconfiguration of an
already-installed system. It takes you through a sequence of configuration
pages and then on the last page creates or updates the configuration files, ie.
the authentication secrets file and the configuration file `emailrelay.conf`
or `emailrelay-start.bat`.
In many cases E-MailRelay will need to be configured with user-ids and
passwords. For example, if e-mail is being forwarded to a `smarthost` for onward
routing then you will need to supply the user-id and password for your account
on the smarthost. These details must be entered into a `secrets` file and then
one of `--server-auth`, `--client-auth` or `--pop-auth` must be used to point to
the file.
The E-MailRelay reference document describes the format of the secrets file.
Logging
-------
If the `--log` option is used then E-MailRelay program sends warnings and error
messages to its standard error stream, and to the `syslog` system on Unix or
to the Event Viewer on Windows.
E-MailRelay is normally installed so that it logs its activity to a log file,
but it can also send logging information to `syslog` on Unix systems or the to
the Event Viewer on Windows.
The standard error stream logging can be redirected to a file by using the
`--log-file` option, and daily log files can be created by using `%d` in the
filename.
Logging is configured with options like `--log`, `--log-file`, `--as-server` and
`--syslog`, so check these in the configuration file or startup batch file.
For more verbose logging add the `--verbose` option to the command-line.
For more verbose logging add the `--verbose` option. This is a good idea when
setting up or trouble-shooting your E-MailRelay configuration.
Preventing open mail relay
--------------------------
If you are running E-MailRelay as a server with a permanent connection to the
internet it is important to prevent open mail relay because this can be
exploited by spammers and get you into trouble with your ISP. By default open
mail relaying is not possible because E-MailRelay does not accept IP connections
from remote clients. However, if you use the `--remote-clients` option then you
need to be more careful.
Failures and retries
--------------------
If e-mail messages cannot be forwarded by the E-MailRelay system then the
envelope files in the spool directory are given a `.bad` suffix. The reason for
the failure will be recorded in the envelope file itself.
If the only required access to the E-MailRelay server is from a local network
and not from the internet then just set up your firewall to block incoming
connections on ports 25 (SMTP) and 110 (POP) and also use the `--interface`
option on the E-MailRelay command-line so that it only listens for incoming
connections on the local network.
You should check for `.bad` envelope files in the E-MailRelay spool directory
from time to time. If you want failed messages to be retried then just remove
the `.bad` filename suffix. On Unix-like systems you can do this automatically
with a cron job that runs the `emailrelay-resubmit.sh` script occasionally.
If you do need to accept connections from the internet then you should require
all clients to authenticate themselves by using the `--server-auth` option on
the E-MailRelay command-line. If you also want local clients running on your
internal network to be able to bypass this authentication then you can put those
trusted IP addresses in the E-MailRelay secrets file with an authentication
mechanism of `none`. Refer to the reference guide for more information.
Once a failed message has been renamed it will be forwarded along with all the
others. It is a good idea to use regular polling (eg. `--poll=60`) to make sure
that this happens in a timely manner.
Running as a POP server
-----------------------
E-MailRelay can run as a POP server so that e-mail client programs can retrieve
messages from the E-MailRelay spool directory directly.
Open mail servers
-----------------
If you are running E-MailRelay as an internet mail server then you need to be
careful about abuse by spammers and bot-nets. You will also need to be sure that
incoming e-mail messages are never automatically routed back out to the internet
because that will definitely attract abuse.
To allow POP access to spooled messages use a command-line something like this:
By default an E-MailRelay server will only accept connections from local network
addresses, so for an internet mail server you will need to add the
`--remote-clients` option. When you add `--remote-clients` you should be
sure that you have a firewall that blocks connections to any other ports that
E-MailRelay might have open, or use the `--interface` option to limit their
scope.
emailrelay --as-server --pop --pop-auth=/etc/pop.auth
A good first step in limiting abuse is to use an address verifier that checks
that e-mails are correctly addressed to you. You can use the built-in address
verifier called `account:` to do this or you can write your own verifier script.
You will need to create the authentication secrets file (`pop.auth` in this
example) containing usernames and passwords. A simple example would look
like this:
emailrelay --as-server --remote-clients --address-verifier=account: --domain=mydomain.com
Refer to the `Address verifiers` section in the E-MailRelay reference document
for more details.
If you want to run an internet mail server that is not open to everyone then you
can require that remote users authenticate themselves. Do this with a secrets
file containing a user-id and password for every remote user, something like
this:
server plain user1 password1
server plain user2 password2
It can sometimes be useful to serve up the same e-mail messages to multiple POP
clients. For example, you might use several e-mail clients on your local network
and you would like to see your mail on all of them equally. The `--pop-by-name`
option is intended to be used in this scenario; each e-mail client sees its own
copy of the e-mail messages, stored in its own sub-directory of the main spool
directory. The name of the sub-directory is simply the name that the client uses
to authenticate with the E-MailRelay server. You just need to create the
sub-directory for each client and then specify `emailrelay-filter-copy`
as the E-MailRelay `--filter` program.
And then use `--server-auth` to point to the file:
Refer to the documentation of the various `--pop` command-line options for
more detail: `--pop`, `--pop-port`, `--pop-auth`, `--pop-no-delete` and
`--pop-by-name`.
emailrelay --as-server --remote-clients --server-auth=/etc/emailrelay.auth
Refer to the `Authentication` section in the E-MailRelay reference document for
more details.
Running as a POP server
-----------------------
E-MailRelay can run as a POP server so that an e-mail client program can
retrieve messages from the E-MailRelay spool directory.
To allow POP access use the `--pop` and `--pop-auth` command-line options,
something like this:
emailrelay --as-server --pop --pop-auth=/etc/pop.auth
You will need to create the POP authentication secrets file containing usernames
and passwords, as above.
If you use more than one e-mail client program then you will probably want to
make independent copies of your e-mails for each. Use a `--filter` program to
copy the e-mail files into multiple sub-directories of the main spool directory
and then use `--pop-by-name` so that each e-mail client accesses its own
sub-directory according to which account name it used when authenticating.
The filter can be an external program or the built-in `copy:` filter:
emailrelay --as-server --filter=copy:pop --pop --pop-by-name --pop-auth=/etc/pop.auth
Add the account for each e-mail client in the POP authentication secrets file
and manually create the corresponding sub-directory.
The `--pop-by-name` option is also useful when e-mail messages are being
copied into individual mailboxes by the `deliver:` filter. In this case each
sub-directory is a mailbox containing only those e-mails that are addressed to
the mailbox owner.
![popbyname.png](popbyname.png)
Refer to the `Delivery` section in the E-MailRelay reference document for more
information.
If you are using POP to view a spool directory that is also being used for
e-mail forwarding then you must use `--pop-no-delete`.
IMAP
----
E-MailRelay does not support the [IMAP][] protocol directly but a simple filter
script can be used to move e-mails into a [maildir][] directory and an IMAP server
such as [dovecot][] can be used to serve them from there.
It is normally sufficient for a filter script to just move the E-MailRelay
content file straight into the mailbox `cur` directory, delete the corresponding
envelope file and then exit with an exit code of 100.
The built-in `deliver:` filter will automatically do this if it sees that the
target sub-directory of the spool directory is actually a `maildir` mailbox.
Triggering delivery
-------------------
If you are using E-MailRelay on Unix to store and forward e-mail over an
intermittent link to the internet such as dial-up or wireless networking, then
you might need to set things up so that the network tells E-MailRelay when to
start forwarding e-mail.
If you are using E-MailRelay on a Linux/Unix system to store and forward e-mail
over an intermittent link to the internet such as dial-up or wireless
networking, then you might need to arrange for E-MailRelay to be notified when
it can start forwarding e-mail.
On Linux systems you should find that there are special directories where you
can install your own hook scripts that are called whenever a dial-up or wireless
network connection is established. For dial-up this might be `/etc/ppp/ip-up.d`,
and for wireless `/etc/network/if-up.d`.
You should find that there are special directories where you can install your
own hook scripts that are called whenever a dial-up or wireless network
connection is established. For dial-up this might be `/etc/ppp/ip-up.d`, and for
wireless `/etc/network/if-up.d`.
Just create a two-line script like this in the relevant directory:
@ -223,50 +256,14 @@ Just create a two-line script like this in the relevant directory:
and make it executable using `chmod +x`.
Failed e-mails
--------------
If e-mail messages cannot be forwarded by the E-MailRelay system then the
envelope files in the spool directory are given a `.bad` suffix. The reason for
the failure will be recorded in the envelope file itself.
You should check for `.bad` envelope files in the E-MailRelay spool directory
from time to time. If you want them to be retried next time then just remove
the `.bad` filename suffix.
You can run the `emailrelay-resubmit` script periodically to automate this; it
removes the `.bad` suffix from files in the spool directory as long as they
have not been retried too many times already.
Usage patterns
--------------
The simplest ways of using E-MailRelay for SMTP are to run it as a proxy or to
do store-and-forward, but many other configurations are possible. For example,
multiple E-MailRelay servers can run in parallel sharing the same spool
directory, or they can be chained in series to that e-mail messages get
transferred from one to the next.
Remember that messages can be introduced directly into the E-MailRelay spool
directory using the `emailrelay-submit` utility, and they can be moved out again
at any time, as long as the envelope file is not locked (ie. with a special
filename extension). Your `--filter` program can edit messages in any way you
want, and it can even delete the current message from the spool directory.
When using E-MailRelay as a POP server the `--pop-by-name` feature can be used
to serve up different spooled messages according to the username that the
client authenticated with. Rather than use `emailrelay-filter-copy` to
distribute incoming e-mail messages into all subdirectories you could use a
custom script to do it based on the message addressing.
The POP server can also be used for checking e-mails that are taken out of the
normal store-and-forward flow. For example, a `--filter` script that checks for
spam could move suspicious e-mails into a subdirectory of the spool directory
that is accessible via the `--pop-by-name` feature.
You can also trigger forwarding from the E-MailRelay server via the `--admin`
interface.
Rate limiting
-------------
If you need to slow the rate at which e-mails are forwarded you can use a
`--client-filter` program to introduce a delay. On Windows this JavaScript
program would give you a delay of a minute:
filter program would give you a delay of a minute:
WScript.Sleep( 60000 ) ;
WScript.Quit( 0 ) ;
@ -281,65 +278,47 @@ The E-MailRelay server can use [SpamAssassin](http://spamassassin.apache.org)
to mark or reject potential spam.
It's easiest to run SpamAssassin's `spamd` program in the background and let
E-MailRelay send incoming messages to it over the network. By default
SpamAssassin `spamd` uses port 783 so you should use an E-MailRelay
command-line option of `--filter spam-edit:127.0.0.1:783` if you want spam
messages to pass through with a warning added, or `--filter spam:127.0.0.1:783`
if you want spam messages to be rejected outright.
E-MailRelay send incoming messages to it over the local network.
Alternatively you can run SpamAssassin on demand for each message. To get
E-MailRelay to reject spam outright you can just use `spamassassin -e` as
your E-MailRelay `--filter` program:
The built-in `spam-edit:` filter is used to pass e-mail messages to spamd:
emailrelay --as-server --filter="/usr/bin/spamassassin -e"
emailrelay --as-server --filter=spam-edit:127.0.0.1:783
Or on Windows:
If SpamAssassin detects a message is spam it will edit it into a spam report
with the original e-mail moved into an attachment.
emailrelay --as-server --filter="c:/perl/site/bin/spamassassin.bat -e"
Alternatively use the `spam:` filter if spam e-mails should be rejected
outright:
To get spam messages identified by SpamAssassin but still pass through the
E-MailRelay system you will have to have a small `--filter` script to collect
the output from the `spamassassin` program and write it back into the
E-MailRelay content file.
On Unix your `--filter` shell script could look something like this:
#!/bin/sh
spamassassin "$1" > "$1.tmp"
mv "$1.tmp" "$1"
exit 0
On Windows an equivalent batch script would be:
c:\perl\site\bin\spamassassin.bat %1 > %1.tmp
ren %1.tmp %1
exit 0
emailrelay --as-server --filter=spam:127.0.0.1:783
Google mail
-----------
To send mail via Google mail's SMTP gateway you will need to obtain a new
`application password` from Google. Log in to your Google account and look for
`application password` from Google: log in to your Google account and look for
the account's security settings and then `app passwords`. Create the password
for E-MailRelay as application type `other`.
for E-MailRelay selecting an application type `other`.
Then you need to create a client secrets file for E-MailRelay containing your
account name and the new application password. You may already have this file
on Windows as `C:\ProgramData\E-MailRelay\emailrelay.auth`.
Then create a client secrets file for E-MailRelay containing your account name
and the new application password. You may already have this file on Windows as
`C:\ProgramData\E-MailRelay\emailrelay.auth`.
You should edit the file to contain one `client` line, something like this:
You should edit the secrets file to contain one `client` line, something like
this:
client plain myname@gmail.com myapppassword
Then change the E-MailRelay startup batch file or configuration file to refer
to your secrets file by using the `--client-auth` option. The `--as-proxy` or
`--forward-to` options should be set to `smtp.gmail.com:587` and you will also
need to add the `--client-tls` option to enable [TLS][] encryption.
to your secrets file by using the `--client-auth` option.
Also set the `--as-proxy` or `--forward-to` option to `smtp.gmail.com:587` and
add `--client-tls` to enable [TLS][] encryption.
On Windows the E-MailRelay startup batch file should contain something like this:
emailrelay --as-proxy=smtp.gmail.com:587 --client-tls --client-auth=C:/ProgramData/E-MailRelay/emailrelay.auth ...
Or in a configration file like this:
Or an equivalent configuration file like this:
forward-to smtp.gmail.com:587
client-tls
@ -354,30 +333,121 @@ anonymising network.
For example, this will run an E-MailRelay proxy on port 587 that routes via a
local Tor server on port 9050 to the mail server at smtp.example.com:
emailrelay --port 587 --as-proxy=smtp.example.com:25@localhost:9050 --domain=anonymous.net --anonymous --connection-timeout=300
emailrelay --port 587 --as-proxy=smtp.example.com:25@localhost:9050 --domain=anon.net --anonymous --connection-timeout=300
Blocklists and dynamic firewalls
--------------------------------
E-MailRelay can consult with remote [DNSBL][] blocklist servers in order to block
incoming connections from known spammers. Refer to the documentation of the
`--dnsbl` option for more details.
E-MailRelay can consult with remote DNSBL blocklist servers in order to block
incoming connections from known spammers. For example:
emailrelay -r --dnsbl=zen.spamhaus.org,bl.mailspike.net ...
Refer to the documentation of the `--dnsbl` option for more details.
It is also possible to integrate E-MailRelay with intrusion detection systems
such as `fail2ban` that monitor log files and dynamically modify your iptables
firewall. Use E-MailRelay's `--log-address` command-line option so that the
remote IP address of any badly-behaved remote user is logged and made available
to `fail2ban`.
spammers' IP addresses are logged and made visible to `fail2ban`.
Bcc handling
------------
E-MailRelay transfers e-mail messages without changing their content in any way,
other than by adding a `Received` header. In particular, if a message contains a
`Bcc:` header when it is submitted to the E-MailRelay server it will have the
same `Bcc:` header when forwarded.
It is normally the responsibility of the program that submits an e-mail message
to submit it separately for each `Bcc` recipient, removing the `Bcc:` header
from the message content or changing it to contain only the 'current' recipient.
If this is not done, perhaps through misconfiguration of the e-mail user agent
program, then `Bcc` recipients may be visible to the `To` and `Cc` message
recipients.
An E-MailRelay `--filter` script can be used to reject messages with incorrect
`Bcc:` headers, and an example script is included.
Advanced set-up
---------------
As an example of an advanced E-MailRelay setup consider the following
command-line, split onto multiple lines for readability:
emailrelay
--log --verbose --log-time --log-network
--close-stderr --syslog
--pid-file @app/emailrelay.pid
--user root
--in-spool-dir @app/in
--in-port 25
--in-domain example.com
--in-address-verifier account:
--in-dnsbl 1.1.1.1:53,500,1,dnsbl.example.com
--in-filter spam-edit:127.0.0.1:783
--in-filter deliver:
--in-server-smtp-config +chunking,+smtputf8
--in-size 100000000
--in-pop
--in-pop-port 110
--in-pop-auth pam:
--in-pop-by-name
--out-spool-dir @app/out
--out-port 587
--out-forward-on-disconnect
--out-forward-to-some
--out-poll 60
--out-address-verifier account:check
--out-delivery-dir @app/in
--out-filter deliver:
--out-filter split:
--out-client-filter mx:
--out-forward-to 127.0.0.1:588
--out-domain example.com
--other-spool-dir @app/other
--other-port 588
--other-interface 127.0.0.1
--other-client-tls
--other-client-auth plain:YWxpY2VAZ21haWwuY29t:UGFzc3cwcmQ
--other-forward-to smtp.gmail.com:587
--other-poll 3600
This is a three-in-one configuration so there are effectively three E-MailRelay
servers running in one process, named `in`, `out` and `other`.
The `in` server is an internet-facing e-mail server with delivery to individual
mailboxes that can be accessed via POP. The `account:` verifier checks the
addressees in the incoming e-mails against the list of accounts on the local
machine and against the given domain name; the IP address of the network
connection is checked against a DNSBL database; SpamAssassin is used to
identify spam; and Linux [PAM][] is used for POP authentication.
The `out` server is a routing [MTA][] that sends outgoing e-mail messages directly
to destination servers. The filter makes copies so that eash e-mail message goes
to just one domain. The client filter uses DNS MX queries against the local
system's default name servers to do the routing. If any e-mail messages are
addressed to local users they are short-circuited and delivered directly to
their `in` mailboxes.
The `other` server does store-and-forward to a gmail smarthost and acts as the
default destination for the `out` server. In this example the gmail password is
given directly on the command-line but it is normally more secure to use a
separate secrets file.
[DNSBL]: https://en.wikipedia.org/wiki/DNSBL
[IMAP]: https://en.wikipedia.org/wiki/Internet_Message_Access_Protocol
[MTA]: https://en.wikipedia.org/wiki/Message_transfer_agent
[PAM]: https://en.wikipedia.org/wiki/Linux_PAM
[POP]: https://en.wikipedia.org/wiki/Post_Office_Protocol
[SMTP]: https://en.wikipedia.org/wiki/Simple_Mail_Transfer_Protocol
[SOCKS]: https://en.wikipedia.org/wiki/SOCKS
[TLS]: https://en.wikipedia.org/wiki/Transport_Layer_Security
[dovecot]: https://www.dovecot.org
[maildir]: https://en.wikipedia.org/wiki/Maildir
_____________________________________
Copyright (C) 2001-2022 Graeme Walker
Copyright (C) 2001-2023 Graeme Walker

554
doc/userguide.rst
View File

@ -1,53 +1,21 @@
**********************
E-MailRelay User Guide
**********************
**********
User Guide
**********
What is it?
===========
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.
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.
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.
E-MailRelay is a lightweight SMTP_ store-and-forward mail server with POP_ access
to spooled messages. It can be used as a personal internet mail server with
SpamAssassin spam filtering and DNSBL_ connection blocking. Forwarding can be
to a fixed smarthost or using DNS MX routing. External scripts can be used for
address validation and e-mail message processing.
.. image:: whatisit.png
:alt: whatisit.png
E-MailRelay uses the same non-blocking i/o model as Squid and nginx giving
excellent scalability and resource usage.
C++ source code is available and distribution is permitted under the GNU
General Public License V3.
What it's not
=============
E-MailRelay does not normally do routing of individual messages; it is not a
routing MTA_. It forwards all e-mail messages to a pre-configured SMTP server,
regardless of any message addressing or DNS redirects.
Why use it?
===========
E-MailRelay is a simple tool that does SMTP. For simple tasks it is likely
to be easier to understand and configure than a more general purpose MTA.
Typical applications of E-MailRelay include:
* spam filtering and virus checking incoming mail
* adding digital signatures or legal disclaimers to outgoing mail
* store-and-forward for outgoing mail across an intermittent internet connection
* adding authentication and encryption where the existing infrastructure does not support it
* taking messages in with SMTP and serving them to local POP_ clients
* giving multiple POP clients independent copies of incoming e-mail
* SMTP proxying by running as a proxy server on a firewall machine
E-MailRelay runs as a single process using the same non-blocking i/o model as
Squid and nginx giving excellent scalability and resource usage.
The code has few dependencies on third-party libraries or run-time environments
so it is easy to build and install.
@ -56,22 +24,34 @@ E-MailRelay is designed to be policy-free, so that you can implement your own
policies for message retries, bounces, local mailbox delivery, spam filtering
etc. through external scripts.
Running E-MailRelay
===================
Basic operation
===============
E-MailRelay can be run straight from the command-line, and on Windows you can
run *emailrelay.exe* or *emailrelay-textmode.exe* from the zip file without
going through the installation process.
To use E-MailRelay in store-and-forward mode use the *--as-server* option to
start the storage daemon in the background, and then do delivery of spooled
messages by running with the *--as-client* option.
messages by running with *--as-client*.
.. image:: serverclient.png
:alt: serverclient.png
For example, to start a storage daemon listening on port 587 use a command
like this:
For example, to start a storage daemon in the background listening on port 10025
use a command like this:
::
emailrelay --as-server --port 587 --spool-dir /tmp
emailrelay --as-server --port 10025 --spool-dir /tmp
On Windows use *c:/temp* for testing, rather than */tmp*.
Or to run it in the foreground:
::
emailrelay --log --no-daemon --port 10025 --spool-dir /tmp
And then to forward the spooled mail to *smtp.example.com* run something
like this:
@ -80,46 +60,63 @@ like this:
emailrelay --as-client smtp.example.com:25 --spool-dir /tmp
To get behaviour more like a proxy you can add the *--poll* and *--forward-to*
options so that messages are forwarded continuously rather than on-demand.
To forward continuously you can add the *--poll* and *--forward-to* options to
the server command-line:
.. image:: forwardto.png
:alt: forwardto.png
This example starts a store-and-forward server that forwards spooled-up e-mail
every minute:
For example, this starts a server that also forwards spooled-up e-mail every
minute:
::
emailrelay --as-server --poll 60 --forward-to smtp.example.com:25
Or for a proxy server that forwards each message soon after it has been
received, you can use *--as-proxy* or add *--forward-on-disconnect*:
Or for a server that forwards each message as soon as it has been received, you
can use *--forward-on-disconnect*:
::
emailrelay --as-server --forward-on-disconnect --forward-to smtp.example.com:25
To edit or filter e-mail as it passes through the proxy specify your filter
To edit or filter e-mail as it passes through the server specify your filter
program with the *--filter* option, something like this:
::
emailrelay --as-proxy smtp.example.com:25 --filter addsig.js
emailrelay --as-server --filter /tmp/set-from.js
To run E-MailRelay as a POP server without SMTP use *--pop* and *--no-smtp*:
Look for example filter scripts in the *examples* directory.
E-MailRelay can also be used as a personal internet mail server:
.. image:: mailserver.png
:alt: mailserver.png
Use *--remote-clients* (\ *-r*\ ) to allow connections from outside the local
network, define your domain name with *--domain* and use an address verifier as
a first line of defense against spammers:
::
emailrelay --pop --no-smtp --log --close-stderr
emailrelay --as-server -v -r --domain=example.com --address-verifier=account:
The *emailrelay-submit* utility can be used to put messages straight into the
spool directory so that the POP clients can fetch them.
Then enable POP access to the incoming e-mails with *--pop*, *--pop-port* and
\ *--pop-auth*\ :
By default E-MailRelay will always reject connections from remote networks. To
allow connections from anywhere use the *--remote-clients* option, but please
check your firewall settings to make sure this cannot be exploited by spammers.
::
emailrelay ... --pop --pop-port 10110 --pop-auth /etc/emailrelay.auth
Set up the POP account with a user-id and password in the *--pop-auth* secrets
file. The secrets file should contain a single line of text like this:
::
server plain <userid> <password>
For more information on the command-line options refer to the reference guide
or run:
@ -128,118 +125,171 @@ or run:
emailrelay --help --verbose
Configuration
=============
The *emailrelay* program itself is mostly configured through command-line
options (such as *--port* and *--forward-to*).
After a full installation the E-MailRelay server will normally be started up
automatically when the machine boots up.
In most installations on Unix-like system the E-MailRelay server will be
started up by the boot-time script called *emailrelay* in the */etc/init.d*
directory, and this script uses the configuration file */etc/emailrelay.conf* to
define the server command-line. Each entry in the configuration file corresponds
to an E-MailRelay command-line option, so you can edit this file to add and
remove server options. Refer to the reference guide for a complete list of
configuration options.
On Unix-like systems the server will read its configuration settings from a file
\ */etc/emailrelay.conf*\ .
On Windows the installation program creates a startup batch file called
*emailrelay-start.bat* that contains all the server command-line options and
you can edit this file to change the server configuration. You can also set up
your own shortcuts to the E-MailRelay executable and add and remove command-line
options using the shortcut properties tab.
On Windows E-MailRelay typically runs as a Windows Service and it reads its
configuration from the startup batch file *emailrelay-start.bat*.
If you are using authentication then you will have to create the text files
containing your authentication secrets (account names, passwords and password
hashes). The *--server-auth*, *--client-auth* and *--pop-auth* command-line
options are used to point to these files.
You can change the E-MailRelay server configuration by editing the configuration
file or startup batch file directly and then restarting the server. Or you can
use the E-MailRelay configuration GUI if it is available.
There is also a graphical configuration program called *emailrelay-gui* that
may be available to help with configuring the system. This is mostly intended
to be used once at installation time since it is the basis of the Windows
installer, but it can also be used to do some simple reconfiguration of an
already-installed system. It takes you through a sequence of configuration
pages and then on the last page creates or updates the configuration files, ie.
the authentication secrets file and the configuration file *emailrelay.conf*
or *emailrelay-start.bat*.
In many cases E-MailRelay will need to be configured with user-ids and
passwords. For example, if e-mail is being forwarded to a *smarthost* for onward
routing then you will need to supply the user-id and password for your account
on the smarthost. These details must be entered into a *secrets* file and then
one of *--server-auth*, *--client-auth* or *--pop-auth* must be used to point to
the file.
The E-MailRelay reference document describes the format of the secrets file.
Logging
=======
If the *--log* option is used then E-MailRelay program sends warnings and error
messages to its standard error stream, and to the *syslog* system on Unix or
to the Event Viewer on Windows.
E-MailRelay is normally installed so that it logs its activity to a log file,
but it can also send logging information to *syslog* on Unix systems or the to
the Event Viewer on Windows.
The standard error stream logging can be redirected to a file by using the
*--log-file* option, and daily log files can be created by using *%d* in the
filename.
Logging is configured with options like *--log*, *--log-file*, *--as-server* and
\ *--syslog*\ , so check these in the configuration file or startup batch file.
For more verbose logging add the *--verbose* option to the command-line.
For more verbose logging add the *--verbose* option. This is a good idea when
setting up or trouble-shooting your E-MailRelay configuration.
Preventing open mail relay
==========================
If you are running E-MailRelay as a server with a permanent connection to the
internet it is important to prevent open mail relay because this can be
exploited by spammers and get you into trouble with your ISP. By default open
mail relaying is not possible because E-MailRelay does not accept IP connections
from remote clients. However, if you use the *--remote-clients* option then you
need to be more careful.
Failures and retries
====================
If e-mail messages cannot be forwarded by the E-MailRelay system then the
envelope files in the spool directory are given a *.bad* suffix. The reason for
the failure will be recorded in the envelope file itself.
If the only required access to the E-MailRelay server is from a local network
and not from the internet then just set up your firewall to block incoming
connections on ports 25 (SMTP) and 110 (POP) and also use the *--interface*
option on the E-MailRelay command-line so that it only listens for incoming
connections on the local network.
You should check for *.bad* envelope files in the E-MailRelay spool directory
from time to time. If you want failed messages to be retried then just remove
the *.bad* filename suffix. On Unix-like systems you can do this automatically
with a cron job that runs the *emailrelay-resubmit.sh* script occasionally.
If you do need to accept connections from the internet then you should require
all clients to authenticate themselves by using the *--server-auth* option on
the E-MailRelay command-line. If you also want local clients running on your
internal network to be able to bypass this authentication then you can put those
trusted IP addresses in the E-MailRelay secrets file with an authentication
mechanism of *none*. Refer to the reference guide for more information.
Once a failed message has been renamed it will be forwarded along with all the
others. It is a good idea to use regular polling (eg. *--poll=60*) to make sure
that this happens in a timely manner.
Running as a POP server
=======================
E-MailRelay can run as a POP server so that e-mail client programs can retrieve
messages from the E-MailRelay spool directory directly.
Open mail servers
=================
If you are running E-MailRelay as an internet mail server then you need to be
careful about abuse by spammers and bot-nets. You will also need to be sure that
incoming e-mail messages are never automatically routed back out to the internet
because that will definitely attract abuse.
To allow POP access to spooled messages use a command-line something like this:
By default an E-MailRelay server will only accept connections from local network
addresses, so for an internet mail server you will need to add the
*--remote-clients* option. When you add *--remote-clients* you should be
sure that you have a firewall that blocks connections to any other ports that
E-MailRelay might have open, or use the *--interface* option to limit their
scope.
A good first step in limiting abuse is to use an address verifier that checks
that e-mails are correctly addressed to you. You can use the built-in address
verifier called *account:* to do this or you can write your own verifier script.
::
emailrelay --as-server --pop --pop-auth=/etc/pop.auth
emailrelay --as-server --remote-clients --address-verifier=account: --domain=mydomain.com
You will need to create the authentication secrets file (*pop.auth* in this
example) containing usernames and passwords. A simple example would look
like this:
Refer to the *Address verifiers* section in the E-MailRelay reference document
for more details.
If you want to run an internet mail server that is not open to everyone then you
can require that remote users authenticate themselves. Do this with a secrets
file containing a user-id and password for every remote user, something like
this:
::
server plain user1 password1
server plain user2 password2
It can sometimes be useful to serve up the same e-mail messages to multiple POP
clients. For example, you might use several e-mail clients on your local network
and you would like to see your mail on all of them equally. The *--pop-by-name*
option is intended to be used in this scenario; each e-mail client sees its own
copy of the e-mail messages, stored in its own sub-directory of the main spool
directory. The name of the sub-directory is simply the name that the client uses
to authenticate with the E-MailRelay server. You just need to create the
sub-directory for each client and then specify *emailrelay-filter-copy*
as the E-MailRelay *--filter* program.
And then use *--server-auth* to point to the file:
Refer to the documentation of the various *--pop* command-line options for
more detail: *--pop*, *--pop-port*, *--pop-auth*, *--pop-no-delete* and
\ *--pop-by-name*\ .
::
emailrelay --as-server --remote-clients --server-auth=/etc/emailrelay.auth
Refer to the *Authentication* section in the E-MailRelay reference document for
more details.
Running as a POP server
=======================
E-MailRelay can run as a POP server so that an e-mail client program can
retrieve messages from the E-MailRelay spool directory.
To allow POP access use the *--pop* and *--pop-auth* command-line options,
something like this:
::
emailrelay --as-server --pop --pop-auth=/etc/pop.auth
You will need to create the POP authentication secrets file containing usernames
and passwords, as above.
If you use more than one e-mail client program then you will probably want to
make independent copies of your e-mails for each. Use a *--filter* program to
copy the e-mail files into multiple sub-directories of the main spool directory
and then use *--pop-by-name* so that each e-mail client accesses its own
sub-directory according to which account name it used when authenticating.
The filter can be an external program or the built-in *copy:* filter:
::
emailrelay --as-server --filter=copy:pop --pop --pop-by-name --pop-auth=/etc/pop.auth
Add the account for each e-mail client in the POP authentication secrets file
and manually create the corresponding sub-directory.
The *--pop-by-name* option is also useful when e-mail messages are being
copied into individual mailboxes by the *deliver:* filter. In this case each
sub-directory is a mailbox containing only those e-mails that are addressed to
the mailbox owner.
.. image:: popbyname.png
:alt: popbyname.png
Refer to the *Delivery* section in the E-MailRelay reference document for more
information.
If you are using POP to view a spool directory that is also being used for
e-mail forwarding then you must use *--pop-no-delete*.
IMAP
====
E-MailRelay does not support the IMAP_ protocol directly but a simple filter
script can be used to move e-mails into a maildir_ directory and an IMAP server
such as dovecot_ can be used to serve them from there.
It is normally sufficient for a filter script to just move the E-MailRelay
content file straight into the mailbox *cur* directory, delete the corresponding
envelope file and then exit with an exit code of 100.
The built-in *deliver:* filter will automatically do this if it sees that the
target sub-directory of the spool directory is actually a *maildir* mailbox.
Triggering delivery
===================
If you are using E-MailRelay on Unix to store and forward e-mail over an
intermittent link to the internet such as dial-up or wireless networking, then
you might need to set things up so that the network tells E-MailRelay when to
start forwarding e-mail.
If you are using E-MailRelay on a Linux/Unix system to store and forward e-mail
over an intermittent link to the internet such as dial-up or wireless
networking, then you might need to arrange for E-MailRelay to be notified when
it can start forwarding e-mail.
On Linux systems you should find that there are special directories where you
can install your own hook scripts that are called whenever a dial-up or wireless
network connection is established. For dial-up this might be */etc/ppp/ip-up.d*,
and for wireless */etc/network/if-up.d*.
You should find that there are special directories where you can install your
own hook scripts that are called whenever a dial-up or wireless network
connection is established. For dial-up this might be */etc/ppp/ip-up.d*, and for
wireless */etc/network/if-up.d*.
Just create a two-line script like this in the relevant directory:
@ -250,50 +300,14 @@ Just create a two-line script like this in the relevant directory:
and make it executable using *chmod +x*.
Failed e-mails
==============
If e-mail messages cannot be forwarded by the E-MailRelay system then the
envelope files in the spool directory are given a *.bad* suffix. The reason for
the failure will be recorded in the envelope file itself.
You should check for *.bad* envelope files in the E-MailRelay spool directory
from time to time. If you want them to be retried next time then just remove
the *.bad* filename suffix.
You can run the *emailrelay-resubmit* script periodically to automate this; it
removes the *.bad* suffix from files in the spool directory as long as they
have not been retried too many times already.
Usage patterns
==============
The simplest ways of using E-MailRelay for SMTP are to run it as a proxy or to
do store-and-forward, but many other configurations are possible. For example,
multiple E-MailRelay servers can run in parallel sharing the same spool
directory, or they can be chained in series to that e-mail messages get
transferred from one to the next.
Remember that messages can be introduced directly into the E-MailRelay spool
directory using the *emailrelay-submit* utility, and they can be moved out again
at any time, as long as the envelope file is not locked (ie. with a special
filename extension). Your *--filter* program can edit messages in any way you
want, and it can even delete the current message from the spool directory.
When using E-MailRelay as a POP server the *--pop-by-name* feature can be used
to serve up different spooled messages according to the username that the
client authenticated with. Rather than use *emailrelay-filter-copy* to
distribute incoming e-mail messages into all subdirectories you could use a
custom script to do it based on the message addressing.
The POP server can also be used for checking e-mails that are taken out of the
normal store-and-forward flow. For example, a *--filter* script that checks for
spam could move suspicious e-mails into a subdirectory of the spool directory
that is accessible via the *--pop-by-name* feature.
You can also trigger forwarding from the E-MailRelay server via the *--admin*
interface.
Rate limiting
=============
If you need to slow the rate at which e-mails are forwarded you can use a
*--client-filter* program to introduce a delay. On Windows this JavaScript
program would give you a delay of a minute:
filter program would give you a delay of a minute:
::
@ -310,69 +324,48 @@ The E-MailRelay server can use `SpamAssassin <http://spamassassin.apache.org>`_
to mark or reject potential spam.
It's easiest to run SpamAssassin's *spamd* program in the background and let
E-MailRelay send incoming messages to it over the network. By default
SpamAssassin *spamd* uses port 783 so you should use an E-MailRelay
command-line option of *--filter spam-edit:127.0.0.1:783* if you want spam
messages to pass through with a warning added, or *--filter spam:127.0.0.1:783*
if you want spam messages to be rejected outright.
E-MailRelay send incoming messages to it over the local network.
Alternatively you can run SpamAssassin on demand for each message. To get
E-MailRelay to reject spam outright you can just use *spamassassin -e* as
your E-MailRelay *--filter* program:
The built-in *spam-edit:* filter is used to pass e-mail messages to spamd:
::
emailrelay --as-server --filter="/usr/bin/spamassassin -e"
emailrelay --as-server --filter=spam-edit:127.0.0.1:783
Or on Windows:
If SpamAssassin detects a message is spam it will edit it into a spam report
with the original e-mail moved into an attachment.
Alternatively use the *spam:* filter if spam e-mails should be rejected
outright:
::
emailrelay --as-server --filter="c:/perl/site/bin/spamassassin.bat -e"
emailrelay --as-server --filter=spam:127.0.0.1:783
To get spam messages identified by SpamAssassin but still pass through the
E-MailRelay system you will have to have a small *--filter* script to collect
the output from the *spamassassin* program and write it back into the
E-MailRelay content file.
On Unix your *--filter* shell script could look something like this:
::
#!/bin/sh
spamassassin "$1" > "$1.tmp"
mv "$1.tmp" "$1"
exit 0
On Windows an equivalent batch script would be:
::
c:\perl\site\bin\spamassassin.bat %1 > %1.tmp
ren %1.tmp %1
exit 0
Google mail
===========
To send mail via Google mail's SMTP gateway you will need to obtain a new
*application password* from Google. Log in to your Google account and look for
*application password* from Google: log in to your Google account and look for
the account's security settings and then *app passwords*. Create the password
for E-MailRelay as application type *other*.
for E-MailRelay selecting an application type *other*.
Then you need to create a client secrets file for E-MailRelay containing your
account name and the new application password. You may already have this file
on Windows as *C:\\ProgramData\\E-MailRelay\\emailrelay.auth*.
Then create a client secrets file for E-MailRelay containing your account name
and the new application password. You may already have this file on Windows as
\ *C:\\ProgramData\\E-MailRelay\\emailrelay.auth*\ .
You should edit the file to contain one *client* line, something like this:
You should edit the secrets file to contain one *client* line, something like
this:
::
client plain myname@gmail.com myapppassword
Then change the E-MailRelay startup batch file or configuration file to refer
to your secrets file by using the *--client-auth* option. The *--as-proxy* or
*--forward-to* options should be set to *smtp.gmail.com:587* and you will also
need to add the *--client-tls* option to enable TLS_ encryption.
to your secrets file by using the *--client-auth* option.
Also set the *--as-proxy* or *--forward-to* option to *smtp.gmail.com:587* and
add *--client-tls* to enable TLS_ encryption.
On Windows the E-MailRelay startup batch file should contain something like this:
@ -380,7 +373,7 @@ On Windows the E-MailRelay startup batch file should contain something like this
emailrelay --as-proxy=smtp.gmail.com:587 --client-tls --client-auth=C:/ProgramData/E-MailRelay/emailrelay.auth ...
Or in a configration file like this:
Or an equivalent configuration file like this:
::
@ -388,6 +381,7 @@ Or in a configration file like this:
client-tls
client-auth C:/ProgramData/E-MailRelay/emailrelay.auth
Connection tunnelling
=====================
E-MailRelay can send mail out via a SOCKS_ v4 proxy, which makes it easy to route
@ -399,19 +393,111 @@ local Tor server on port 9050 to the mail server at smtp.example.com:
::
emailrelay --port 587 --as-proxy=smtp.example.com:25@localhost:9050 --domain=anonymous.net --anonymous --connection-timeout=300
emailrelay --port 587 --as-proxy=smtp.example.com:25@localhost:9050 --domain=anon.net --anonymous --connection-timeout=300
Blocklists and dynamic firewalls
================================
E-MailRelay can consult with remote DNSBL_ blocklist servers in order to block
incoming connections from known spammers. Refer to the documentation of the
*--dnsbl* option for more details.
E-MailRelay can consult with remote DNSBL blocklist servers in order to block
incoming connections from known spammers. For example:
::
emailrelay -r --dnsbl=zen.spamhaus.org,bl.mailspike.net ...
Refer to the documentation of the *--dnsbl* option for more details.
It is also possible to integrate E-MailRelay with intrusion detection systems
such as *fail2ban* that monitor log files and dynamically modify your iptables
firewall. Use E-MailRelay's *--log-address* command-line option so that the
remote IP address of any badly-behaved remote user is logged and made available
to *fail2ban*.
spammers' IP addresses are logged and made visible to *fail2ban*.
Bcc handling
============
E-MailRelay transfers e-mail messages without changing their content in any way,
other than by adding a *Received* header. In particular, if a message contains a
*Bcc:* header when it is submitted to the E-MailRelay server it will have the
same *Bcc:* header when forwarded.
It is normally the responsibility of the program that submits an e-mail message
to submit it separately for each *Bcc* recipient, removing the *Bcc:* header
from the message content or changing it to contain only the 'current' recipient.
If this is not done, perhaps through misconfiguration of the e-mail user agent
program, then *Bcc* recipients may be visible to the *To* and *Cc* message
recipients.
An E-MailRelay *--filter* script can be used to reject messages with incorrect
*Bcc:* headers, and an example script is included.
Advanced set-up
===============
As an example of an advanced E-MailRelay setup consider the following
command-line, split onto multiple lines for readability:
::
emailrelay
--log --verbose --log-time --log-network
--close-stderr --syslog
--pid-file @app/emailrelay.pid
--user root
--in-spool-dir @app/in
--in-port 25
--in-domain example.com
--in-address-verifier account:
--in-dnsbl 1.1.1.1:53,500,1,dnsbl.example.com
--in-filter spam-edit:127.0.0.1:783
--in-filter deliver:
--in-server-smtp-config +chunking,+smtputf8
--in-size 100000000
--in-pop
--in-pop-port 110
--in-pop-auth pam:
--in-pop-by-name
--out-spool-dir @app/out
--out-port 587
--out-forward-on-disconnect
--out-forward-to-some
--out-poll 60
--out-address-verifier account:check
--out-delivery-dir @app/in
--out-filter deliver:
--out-filter split:
--out-client-filter mx:
--out-forward-to 127.0.0.1:588
--out-domain example.com
--other-spool-dir @app/other
--other-port 588
--other-interface 127.0.0.1
--other-client-tls
--other-client-auth plain:YWxpY2VAZ21haWwuY29t:UGFzc3cwcmQ
--other-forward-to smtp.gmail.com:587
--other-poll 3600
This is a three-in-one configuration so there are effectively three E-MailRelay
servers running in one process, named *in*, *out* and *other*.
The *in* server is an internet-facing e-mail server with delivery to individual
mailboxes that can be accessed via POP. The *account:* verifier checks the
addressees in the incoming e-mails against the list of accounts on the local
machine and against the given domain name; the IP address of the network
connection is checked against a DNSBL database; SpamAssassin is used to
identify spam; and Linux PAM_ is used for POP authentication.
The *out* server is a routing MTA_ that sends outgoing e-mail messages directly
to destination servers. The filter makes copies so that eash e-mail message goes
to just one domain. The client filter uses DNS MX queries against the local
system's default name servers to do the routing. If any e-mail messages are
addressed to local users they are short-circuited and delivered directly to
their *in* mailboxes.
The *other* server does store-and-forward to a gmail smarthost and acts as the
default destination for the *out* server. In this example the gmail password is
given directly on the command-line but it is normally more secure to use a
separate secrets file.
@ -419,10 +505,14 @@ to *fail2ban*.
.. _DNSBL: https://en.wikipedia.org/wiki/DNSBL
.. _IMAP: https://en.wikipedia.org/wiki/Internet_Message_Access_Protocol
.. _MTA: https://en.wikipedia.org/wiki/Message_transfer_agent
.. _PAM: https://en.wikipedia.org/wiki/Linux_PAM
.. _POP: https://en.wikipedia.org/wiki/Post_Office_Protocol
.. _SMTP: https://en.wikipedia.org/wiki/Simple_Mail_Transfer_Protocol
.. _SOCKS: https://en.wikipedia.org/wiki/SOCKS
.. _TLS: https://en.wikipedia.org/wiki/Transport_Layer_Security
.. _dovecot: https://www.dovecot.org
.. _maildir: https://en.wikipedia.org/wiki/Maildir
.. footer:: Copyright (C) 2001-2022 Graeme Walker
.. footer:: Copyright (C) 2001-2023 Graeme Walker

513
doc/userguide.txt
View File

@ -3,47 +3,16 @@ E-MailRelay User Guide
What is it?
-----------
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.
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.
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.
E-MailRelay is a lightweight SMTP store-and-forward mail server with POP access
to spooled messages. It can be used as a personal internet mail server with
SpamAssassin spam filtering and DNSBL connection blocking. Forwarding can be
to a fixed smarthost or using DNS MX routing. External scripts can be used for
address validation and e-mail message processing.
<<whatisit.png>>
E-MailRelay uses the same non-blocking i/o model as Squid and nginx giving
excellent scalability and resource usage.
C++ source code is available and distribution is permitted under the GNU
General Public License V3.
What it's not
-------------
E-MailRelay does not normally do routing of individual messages; it is not a
routing MTA. It forwards all e-mail messages to a pre-configured SMTP server,
regardless of any message addressing or DNS redirects.
Why use it?
-----------
E-MailRelay is a simple tool that does SMTP. For simple tasks it is likely
to be easier to understand and configure than a more general purpose MTA.
Typical applications of E-MailRelay include:
* spam filtering and virus checking incoming mail
* adding digital signatures or legal disclaimers to outgoing mail
* store-and-forward for outgoing mail across an intermittent internet connection
* adding authentication and encryption where the existing infrastructure does not support it
* taking messages in with SMTP and serving them to local POP clients
* giving multiple POP clients independent copies of incoming e-mail
* SMTP proxying by running as a proxy server on a firewall machine
E-MailRelay runs as a single process using the same non-blocking i/o model as
Squid and nginx giving excellent scalability and resource usage.
The code has few dependencies on third-party libraries or run-time environments
so it is easy to build and install.
@ -52,54 +21,75 @@ E-MailRelay is designed to be policy-free, so that you can implement your own
policies for message retries, bounces, local mailbox delivery, spam filtering
etc. through external scripts.
Running E-MailRelay
-------------------
Basic operation
---------------
E-MailRelay can be run straight from the command-line, and on Windows you can
run "emailrelay.exe" or "emailrelay-textmode.exe" from the zip file without
going through the installation process.
To use E-MailRelay in store-and-forward mode use the "--as-server" option to
start the storage daemon in the background, and then do delivery of spooled
messages by running with the "--as-client" option.
messages by running with "--as-client".
<<serverclient.png>>
For example, to start a storage daemon listening on port 587 use a command
like this:
For example, to start a storage daemon in the background listening on port 10025
use a command like this:
emailrelay --as-server --port 587 --spool-dir /tmp
emailrelay --as-server --port 10025 --spool-dir /tmp
On Windows use "c:/temp" for testing, rather than "/tmp".
Or to run it in the foreground:
emailrelay --log --no-daemon --port 10025 --spool-dir /tmp
And then to forward the spooled mail to "smtp.example.com" run something
like this:
emailrelay --as-client smtp.example.com:25 --spool-dir /tmp
To get behaviour more like a proxy you can add the "--poll" and "--forward-to"
options so that messages are forwarded continuously rather than on-demand.
To forward continuously you can add the "--poll" and "--forward-to" options to
the server command-line:
<<forwardto.png>>
This example starts a store-and-forward server that forwards spooled-up e-mail
every minute:
For example, this starts a server that also forwards spooled-up e-mail every
minute:
emailrelay --as-server --poll 60 --forward-to smtp.example.com:25
Or for a proxy server that forwards each message soon after it has been
received, you can use "--as-proxy" or add "--forward-on-disconnect":
Or for a server that forwards each message as soon as it has been received, you
can use "--forward-on-disconnect":
emailrelay --as-server --forward-on-disconnect --forward-to smtp.example.com:25
To edit or filter e-mail as it passes through the proxy specify your filter
To edit or filter e-mail as it passes through the server specify your filter
program with the "--filter" option, something like this:
emailrelay --as-proxy smtp.example.com:25 --filter addsig.js
emailrelay --as-server --filter /tmp/set-from.js
To run E-MailRelay as a POP server without SMTP use "--pop" and "--no-smtp":
Look for example filter scripts in the "examples" directory.
emailrelay --pop --no-smtp --log --close-stderr
E-MailRelay can also be used as a personal internet mail server:
The "emailrelay-submit" utility can be used to put messages straight into the
spool directory so that the POP clients can fetch them.
<<mailserver.png>>
By default E-MailRelay will always reject connections from remote networks. To
allow connections from anywhere use the "--remote-clients" option, but please
check your firewall settings to make sure this cannot be exploited by spammers.
Use "--remote-clients" ("-r") to allow connections from outside the local
network, define your domain name with "--domain" and use an address verifier as
a first line of defense against spammers:
emailrelay --as-server -v -r --domain=example.com --address-verifier=account:
Then enable POP access to the incoming e-mails with "--pop", "--pop-port" and
"--pop-auth":
emailrelay ... --pop --pop-port 10110 --pop-auth /etc/emailrelay.auth
Set up the POP account with a user-id and password in the "--pop-auth" secrets
file. The secrets file should contain a single line of text like this:
server plain <userid> <password>
For more information on the command-line options refer to the reference guide
or run:
@ -108,112 +98,156 @@ or run:
Configuration
-------------
The "emailrelay" program itself is mostly configured through command-line
options (such as "--port" and "--forward-to").
After a full installation the E-MailRelay server will normally be started up
automatically when the machine boots up.
In most installations on Unix-like system the E-MailRelay server will be
started up by the boot-time script called "emailrelay" in the "/etc/init.d"
directory, and this script uses the configuration file "/etc/emailrelay.conf" to
define the server command-line. Each entry in the configuration file corresponds
to an E-MailRelay command-line option, so you can edit this file to add and
remove server options. Refer to the reference guide for a complete list of
configuration options.
On Unix-like systems the server will read its configuration settings from a file
"/etc/emailrelay.conf".
On Windows the installation program creates a startup batch file called
"emailrelay-start.bat" that contains all the server command-line options and
you can edit this file to change the server configuration. You can also set up
your own shortcuts to the E-MailRelay executable and add and remove command-line
options using the shortcut properties tab.
On Windows E-MailRelay typically runs as a Windows Service and it reads its
configuration from the startup batch file "emailrelay-start.bat".
If you are using authentication then you will have to create the text files
containing your authentication secrets (account names, passwords and password
hashes). The "--server-auth", "--client-auth" and "--pop-auth" command-line
options are used to point to these files.
You can change the E-MailRelay server configuration by editing the configuration
file or startup batch file directly and then restarting the server. Or you can
use the E-MailRelay configuration GUI if it is available.
There is also a graphical configuration program called "emailrelay-gui" that
may be available to help with configuring the system. This is mostly intended
to be used once at installation time since it is the basis of the Windows
installer, but it can also be used to do some simple reconfiguration of an
already-installed system. It takes you through a sequence of configuration
pages and then on the last page creates or updates the configuration files, ie.
the authentication secrets file and the configuration file "emailrelay.conf"
or "emailrelay-start.bat".
In many cases E-MailRelay will need to be configured with user-ids and
passwords. For example, if e-mail is being forwarded to a "smarthost" for onward
routing then you will need to supply the user-id and password for your account
on the smarthost. These details must be entered into a "secrets" file and then
one of "--server-auth", "--client-auth" or "--pop-auth" must be used to point to
the file.
The E-MailRelay reference document describes the format of the secrets file.
Logging
-------
If the "--log" option is used then E-MailRelay program sends warnings and error
messages to its standard error stream, and to the "syslog" system on Unix or
to the Event Viewer on Windows.
E-MailRelay is normally installed so that it logs its activity to a log file,
but it can also send logging information to "syslog" on Unix systems or the to
the Event Viewer on Windows.
The standard error stream logging can be redirected to a file by using the
"--log-file" option, and daily log files can be created by using "%d" in the
filename.
Logging is configured with options like "--log", "--log-file", "--as-server" and
"--syslog", so check these in the configuration file or startup batch file.
For more verbose logging add the "--verbose" option to the command-line.
For more verbose logging add the "--verbose" option. This is a good idea when
setting up or trouble-shooting your E-MailRelay configuration.
Preventing open mail relay
--------------------------
If you are running E-MailRelay as a server with a permanent connection to the
internet it is important to prevent open mail relay because this can be
exploited by spammers and get you into trouble with your ISP. By default open
mail relaying is not possible because E-MailRelay does not accept IP connections
from remote clients. However, if you use the "--remote-clients" option then you
need to be more careful.
Failures and retries
--------------------
If e-mail messages cannot be forwarded by the E-MailRelay system then the
envelope files in the spool directory are given a ".bad" suffix. The reason for
the failure will be recorded in the envelope file itself.
If the only required access to the E-MailRelay server is from a local network
and not from the internet then just set up your firewall to block incoming
connections on ports 25 (SMTP) and 110 (POP) and also use the "--interface"
option on the E-MailRelay command-line so that it only listens for incoming
connections on the local network.
You should check for ".bad" envelope files in the E-MailRelay spool directory
from time to time. If you want failed messages to be retried then just remove
the ".bad" filename suffix. On Unix-like systems you can do this automatically
with a cron job that runs the "emailrelay-resubmit.sh" script occasionally.
If you do need to accept connections from the internet then you should require
all clients to authenticate themselves by using the "--server-auth" option on
the E-MailRelay command-line. If you also want local clients running on your
internal network to be able to bypass this authentication then you can put those
trusted IP addresses in the E-MailRelay secrets file with an authentication
mechanism of "none". Refer to the reference guide for more information.
Once a failed message has been renamed it will be forwarded along with all the
others. It is a good idea to use regular polling (eg. "--poll=60") to make sure
that this happens in a timely manner.
Running as a POP server
-----------------------
E-MailRelay can run as a POP server so that e-mail client programs can retrieve
messages from the E-MailRelay spool directory directly.
Open mail servers
-----------------
If you are running E-MailRelay as an internet mail server then you need to be
careful about abuse by spammers and bot-nets. You will also need to be sure that
incoming e-mail messages are never automatically routed back out to the internet
because that will definitely attract abuse.
To allow POP access to spooled messages use a command-line something like this:
By default an E-MailRelay server will only accept connections from local network
addresses, so for an internet mail server you will need to add the
"--remote-clients" option. When you add "--remote-clients" you should be
sure that you have a firewall that blocks connections to any other ports that
E-MailRelay might have open, or use the "--interface" option to limit their
scope.
emailrelay --as-server --pop --pop-auth=/etc/pop.auth
A good first step in limiting abuse is to use an address verifier that checks
that e-mails are correctly addressed to you. You can use the built-in address
verifier called "account:" to do this or you can write your own verifier script.
You will need to create the authentication secrets file ("pop.auth" in this
example) containing usernames and passwords. A simple example would look
like this:
emailrelay --as-server --remote-clients --address-verifier=account: --domain=mydomain.com
Refer to the "Address verifiers" section in the E-MailRelay reference document
for more details.
If you want to run an internet mail server that is not open to everyone then you
can require that remote users authenticate themselves. Do this with a secrets
file containing a user-id and password for every remote user, something like
this:
server plain user1 password1
server plain user2 password2
It can sometimes be useful to serve up the same e-mail messages to multiple POP
clients. For example, you might use several e-mail clients on your local network
and you would like to see your mail on all of them equally. The "--pop-by-name"
option is intended to be used in this scenario; each e-mail client sees its own
copy of the e-mail messages, stored in its own sub-directory of the main spool
directory. The name of the sub-directory is simply the name that the client uses
to authenticate with the E-MailRelay server. You just need to create the
sub-directory for each client and then specify "emailrelay-filter-copy"
as the E-MailRelay "--filter" program.
And then use "--server-auth" to point to the file:
Refer to the documentation of the various "--pop" command-line options for
more detail: "--pop", "--pop-port", "--pop-auth", "--pop-no-delete" and
"--pop-by-name".
emailrelay --as-server --remote-clients --server-auth=/etc/emailrelay.auth
Refer to the "Authentication" section in the E-MailRelay reference document for
more details.
Running as a POP server
-----------------------
E-MailRelay can run as a POP server so that an e-mail client program can
retrieve messages from the E-MailRelay spool directory.
To allow POP access use the "--pop" and "--pop-auth" command-line options,
something like this:
emailrelay --as-server --pop --pop-auth=/etc/pop.auth
You will need to create the POP authentication secrets file containing usernames
and passwords, as above.
If you use more than one e-mail client program then you will probably want to
make independent copies of your e-mails for each. Use a "--filter" program to
copy the e-mail files into multiple sub-directories of the main spool directory
and then use "--pop-by-name" so that each e-mail client accesses its own
sub-directory according to which account name it used when authenticating.
The filter can be an external program or the built-in "copy:" filter:
emailrelay --as-server --filter=copy:pop --pop --pop-by-name --pop-auth=/etc/pop.auth
Add the account for each e-mail client in the POP authentication secrets file
and manually create the corresponding sub-directory.
The "--pop-by-name" option is also useful when e-mail messages are being
copied into individual mailboxes by the "deliver:" filter. In this case each
sub-directory is a mailbox containing only those e-mails that are addressed to
the mailbox owner.
<<popbyname.png>>
Refer to the "Delivery" section in the E-MailRelay reference document for more
information.
If you are using POP to view a spool directory that is also being used for
e-mail forwarding then you must use "--pop-no-delete".
IMAP
----
E-MailRelay does not support the IMAP protocol directly but a simple filter
script can be used to move e-mails into a "maildir" directory and an IMAP server
such as "dovecot" can be used to serve them from there.
It is normally sufficient for a filter script to just move the E-MailRelay
content file straight into the mailbox "cur" directory, delete the corresponding
envelope file and then exit with an exit code of 100.
The built-in "deliver:" filter will automatically do this if it sees that the
target sub-directory of the spool directory is actually a "maildir" mailbox.
Triggering delivery
-------------------
If you are using E-MailRelay on Unix to store and forward e-mail over an
intermittent link to the internet such as dial-up or wireless networking, then
you might need to set things up so that the network tells E-MailRelay when to
start forwarding e-mail.
If you are using E-MailRelay on a Linux/Unix system to store and forward e-mail
over an intermittent link to the internet such as dial-up or wireless
networking, then you might need to arrange for E-MailRelay to be notified when
it can start forwarding e-mail.
On Linux systems you should find that there are special directories where you
can install your own hook scripts that are called whenever a dial-up or wireless
network connection is established. For dial-up this might be "/etc/ppp/ip-up.d",
and for wireless "/etc/network/if-up.d".
You should find that there are special directories where you can install your
own hook scripts that are called whenever a dial-up or wireless network
connection is established. For dial-up this might be "/etc/ppp/ip-up.d", and for
wireless "/etc/network/if-up.d".
Just create a two-line script like this in the relevant directory:
@ -222,50 +256,14 @@ Just create a two-line script like this in the relevant directory:
and make it executable using "chmod +x".
Failed e-mails
--------------
If e-mail messages cannot be forwarded by the E-MailRelay system then the
envelope files in the spool directory are given a ".bad" suffix. The reason for
the failure will be recorded in the envelope file itself.
You should check for ".bad" envelope files in the E-MailRelay spool directory
from time to time. If you want them to be retried next time then just remove
the ".bad" filename suffix.
You can run the "emailrelay-resubmit" script periodically to automate this; it
removes the ".bad" suffix from files in the spool directory as long as they
have not been retried too many times already.
Usage patterns
--------------
The simplest ways of using E-MailRelay for SMTP are to run it as a proxy or to
do store-and-forward, but many other configurations are possible. For example,
multiple E-MailRelay servers can run in parallel sharing the same spool
directory, or they can be chained in series to that e-mail messages get
transferred from one to the next.
Remember that messages can be introduced directly into the E-MailRelay spool
directory using the "emailrelay-submit" utility, and they can be moved out again
at any time, as long as the envelope file is not locked (ie. with a special
filename extension). Your "--filter" program can edit messages in any way you
want, and it can even delete the current message from the spool directory.
When using E-MailRelay as a POP server the "--pop-by-name" feature can be used
to serve up different spooled messages according to the username that the
client authenticated with. Rather than use "emailrelay-filter-copy" to
distribute incoming e-mail messages into all subdirectories you could use a
custom script to do it based on the message addressing.
The POP server can also be used for checking e-mails that are taken out of the
normal store-and-forward flow. For example, a "--filter" script that checks for
spam could move suspicious e-mails into a subdirectory of the spool directory
that is accessible via the "--pop-by-name" feature.
You can also trigger forwarding from the E-MailRelay server via the "--admin"
interface.
Rate limiting
-------------
If you need to slow the rate at which e-mails are forwarded you can use a
"--client-filter" program to introduce a delay. On Windows this JavaScript
program would give you a delay of a minute:
filter program would give you a delay of a minute:
WScript.Sleep( 60000 ) ;
WScript.Quit( 0 ) ;
@ -280,65 +278,47 @@ The E-MailRelay server can use *SpamAssassin* [http://spamassassin.apache.org]
to mark or reject potential spam.
It's easiest to run SpamAssassin's "spamd" program in the background and let
E-MailRelay send incoming messages to it over the network. By default
SpamAssassin "spamd" uses port 783 so you should use an E-MailRelay
command-line option of "--filter spam-edit:127.0.0.1:783" if you want spam
messages to pass through with a warning added, or "--filter spam:127.0.0.1:783"
if you want spam messages to be rejected outright.
E-MailRelay send incoming messages to it over the local network.
Alternatively you can run SpamAssassin on demand for each message. To get
E-MailRelay to reject spam outright you can just use "spamassassin -e" as
your E-MailRelay "--filter" program:
The built-in "spam-edit:" filter is used to pass e-mail messages to spamd:
emailrelay --as-server --filter="/usr/bin/spamassassin -e"
emailrelay --as-server --filter=spam-edit:127.0.0.1:783
Or on Windows:
If SpamAssassin detects a message is spam it will edit it into a spam report
with the original e-mail moved into an attachment.
emailrelay --as-server --filter="c:/perl/site/bin/spamassassin.bat -e"
Alternatively use the "spam:" filter if spam e-mails should be rejected
outright:
To get spam messages identified by SpamAssassin but still pass through the
E-MailRelay system you will have to have a small "--filter" script to collect
the output from the "spamassassin" program and write it back into the
E-MailRelay content file.
On Unix your "--filter" shell script could look something like this:
#!/bin/sh
spamassassin "$1" > "$1.tmp"
mv "$1.tmp" "$1"
exit 0
On Windows an equivalent batch script would be:
c:\perl\site\bin\spamassassin.bat %1 > %1.tmp
ren %1.tmp %1
exit 0
emailrelay --as-server --filter=spam:127.0.0.1:783
Google mail
-----------
To send mail via Google mail's SMTP gateway you will need to obtain a new
"application password" from Google. Log in to your Google account and look for
"application password" from Google: log in to your Google account and look for
the account's security settings and then "app passwords". Create the password
for E-MailRelay as application type "other".
for E-MailRelay selecting an application type "other".
Then you need to create a client secrets file for E-MailRelay containing your
account name and the new application password. You may already have this file
on Windows as "C:\ProgramData\E-MailRelay\emailrelay.auth".
Then create a client secrets file for E-MailRelay containing your account name
and the new application password. You may already have this file on Windows as
"C:\ProgramData\E-MailRelay\emailrelay.auth".
You should edit the file to contain one "client" line, something like this:
You should edit the secrets file to contain one "client" line, something like
this:
client plain myname@gmail.com myapppassword
Then change the E-MailRelay startup batch file or configuration file to refer
to your secrets file by using the "--client-auth" option. The "--as-proxy" or
"--forward-to" options should be set to "smtp.gmail.com:587" and you will also
need to add the "--client-tls" option to enable TLS encryption.
to your secrets file by using the "--client-auth" option.
Also set the "--as-proxy" or "--forward-to" option to "smtp.gmail.com:587" and
add "--client-tls" to enable TLS encryption.
On Windows the E-MailRelay startup batch file should contain something like this:
emailrelay --as-proxy=smtp.gmail.com:587 --client-tls --client-auth=C:/ProgramData/E-MailRelay/emailrelay.auth ...
Or in a configration file like this:
Or an equivalent configuration file like this:
forward-to smtp.gmail.com:587
client-tls
@ -353,22 +333,109 @@ anonymising network.
For example, this will run an E-MailRelay proxy on port 587 that routes via a
local Tor server on port 9050 to the mail server at smtp.example.com:
emailrelay --port 587 --as-proxy=smtp.example.com:25@localhost:9050 --domain=anonymous.net --anonymous --connection-timeout=300
emailrelay --port 587 --as-proxy=smtp.example.com:25@localhost:9050 --domain=anon.net --anonymous --connection-timeout=300
Blocklists and dynamic firewalls
--------------------------------
E-MailRelay can consult with remote DNSBL blocklist servers in order to block
incoming connections from known spammers. Refer to the documentation of the
"--dnsbl" option for more details.
incoming connections from known spammers. For example:
emailrelay -r --dnsbl=zen.spamhaus.org,bl.mailspike.net ...
Refer to the documentation of the "--dnsbl" option for more details.
It is also possible to integrate E-MailRelay with intrusion detection systems
such as "fail2ban" that monitor log files and dynamically modify your iptables
firewall. Use E-MailRelay's "--log-address" command-line option so that the
remote IP address of any badly-behaved remote user is logged and made available
to "fail2ban".
spammers' IP addresses are logged and made visible to "fail2ban".
Bcc handling
------------
E-MailRelay transfers e-mail messages without changing their content in any way,
other than by adding a "Received" header. In particular, if a message contains a
"Bcc:" header when it is submitted to the E-MailRelay server it will have the
same "Bcc:" header when forwarded.
It is normally the responsibility of the program that submits an e-mail message
to submit it separately for each "Bcc" recipient, removing the "Bcc:" header
from the message content or changing it to contain only the 'current' recipient.
If this is not done, perhaps through misconfiguration of the e-mail user agent
program, then "Bcc" recipients may be visible to the "To" and "Cc" message
recipients.
An E-MailRelay "--filter" script can be used to reject messages with incorrect
"Bcc:" headers, and an example script is included.
Advanced set-up
---------------
As an example of an advanced E-MailRelay setup consider the following
command-line, split onto multiple lines for readability:
emailrelay
--log --verbose --log-time --log-network
--close-stderr --syslog
--pid-file @app/emailrelay.pid
--user root
--in-spool-dir @app/in
--in-port 25
--in-domain example.com
--in-address-verifier account:
--in-dnsbl 1.1.1.1:53,500,1,dnsbl.example.com
--in-filter spam-edit:127.0.0.1:783
--in-filter deliver:
--in-server-smtp-config +chunking,+smtputf8
--in-size 100000000
--in-pop
--in-pop-port 110
--in-pop-auth pam:
--in-pop-by-name
--out-spool-dir @app/out
--out-port 587
--out-forward-on-disconnect
--out-forward-to-some
--out-poll 60
--out-address-verifier account:check
--out-delivery-dir @app/in
--out-filter deliver:
--out-filter split:
--out-client-filter mx:
--out-forward-to 127.0.0.1:588
--out-domain example.com
--other-spool-dir @app/other
--other-port 588
--other-interface 127.0.0.1
--other-client-tls
--other-client-auth plain:YWxpY2VAZ21haWwuY29t:UGFzc3cwcmQ
--other-forward-to smtp.gmail.com:587
--other-poll 3600
This is a three-in-one configuration so there are effectively three E-MailRelay
servers running in one process, named "in", "out" and "other".
The "in" server is an internet-facing e-mail server with delivery to individual
mailboxes that can be accessed via POP. The "account:" verifier checks the
addressees in the incoming e-mails against the list of accounts on the local
machine and against the given domain name; the IP address of the network
connection is checked against a DNSBL database; SpamAssassin is used to
identify spam; and Linux PAM is used for POP authentication.
The "out" server is a routing MTA that sends outgoing e-mail messages directly
to destination servers. The filter makes copies so that eash e-mail message goes
to just one domain. The client filter uses DNS MX queries against the local
system's default name servers to do the routing. If any e-mail messages are
addressed to local users they are short-circuited and delivered directly to
their "in" mailboxes.
The "other" server does store-and-forward to a gmail smarthost and acts as the
default destination for the "out" server. In this example the gmail password is
given directly on the command-line but it is normally more secure to use a
separate secrets file.
_____________________________________
Copyright (C) 2001-2022 Graeme Walker
Copyright (C) 2001-2023 Graeme Walker

BIN
doc/whatisit.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 22 KiB

After

Width:  |  Height:  |  Size: 22 KiB

68
doc/whatisit.svg
View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- Created with Inkscape (http://www.inkscape.org/) -->
<!-- Copyright (C) 2001-2022 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->
<!-- Copyright (C) 2001-2023 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->
<svg
xmlns:dc="http://purl.org/dc/elements/1.1/"
@ -12,7 +12,7 @@
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
id="svg3036"
version="1.1"
inkscape:version="0.48.4 r9939"
inkscape:version="0.92.4 (5da689c313, 2019-01-14)"
width="1650"
height="1023"
sodipodi:docname="whatisit.svg"
@ -27,7 +27,7 @@
<dc:format>image/svg+xml</dc:format>
<dc:type
rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
<dc:title></dc:title>
<dc:title />
</cc:Work>
</rdf:RDF>
</metadata>
@ -42,13 +42,13 @@
guidetolerance="10"
inkscape:pageopacity="0"
inkscape:pageshadow="2"
inkscape:window-width="1536"
inkscape:window-height="943"
inkscape:window-width="1922"
inkscape:window-height="1165"
id="namedview3038"
showgrid="false"
inkscape:zoom="0.41506811"
inkscape:zoom="0.54973453"
inkscape:cx="523.60455"
inkscape:cy="499.69607"
inkscape:cy="396.79451"
inkscape:window-x="7"
inkscape:window-y="72"
inkscape:window-maximized="0"
@ -207,78 +207,80 @@
style="display:inline">
<text
xml:space="preserve"
style="font-size:64px;font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;display:inline;font-family:DejaVu Sans;-inkscape-font-specification:DejaVu Sans Bold"
style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;line-height:0%;font-family:'DejaVu Sans';-inkscape-font-specification:'DejaVu Sans Bold';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;display:inline;fill:#000000;fill-opacity:1;stroke:none"
x="709.20923"
y="268.20572"
id="text3286"
sodipodi:linespacing="125%"><tspan
id="text3286"><tspan
sodipodi:role="line"
id="tspan3288"
x="709.20923"
y="268.20572">E-MailRelay</tspan></text>
y="268.20572"
style="font-size:64px;line-height:1.25">E-MailRelay</tspan></text>
<text
xml:space="preserve"
style="font-size:48px;font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;display:inline;font-family:DejaVu Sans;-inkscape-font-specification:DejaVu Sans Bold"
style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;line-height:0%;font-family:'DejaVu Sans';-inkscape-font-specification:'DejaVu Sans Bold';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;display:inline;fill:#000000;fill-opacity:1;stroke:none"
x="412.44125"
y="74.294838"
id="text3290"
sodipodi:linespacing="125%"><tspan
id="text3290"><tspan
sodipodi:role="line"
id="tspan3292"
x="412.44125"
y="74.294838">SMTP</tspan><tspan
y="74.294838"
style="font-size:48px;line-height:1.25">SMTP</tspan><tspan
sodipodi:role="line"
x="412.44125"
y="134.29483"
id="tspan3306">store</tspan></text>
id="tspan3306"
style="font-size:48px;line-height:1.25">store</tspan></text>
<text
xml:space="preserve"
style="font-size:48px;font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;display:inline;font-family:DejaVu Sans;-inkscape-font-specification:DejaVu Sans Bold"
style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;line-height:0%;font-family:'DejaVu Sans';-inkscape-font-specification:'DejaVu Sans Bold';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;display:inline;fill:#000000;fill-opacity:1;stroke:none"
x="1258.9043"
y="69.236244"
id="text3294"
sodipodi:linespacing="125%"><tspan
id="text3294"><tspan
sodipodi:role="line"
id="tspan3296"
x="1258.9043"
y="69.236244">SMTP</tspan><tspan
y="69.236244"
style="font-size:48px;line-height:1.25">SMTP</tspan><tspan
sodipodi:role="line"
x="1258.9043"
y="129.23624"
id="tspan3308">forward</tspan></text>
id="tspan3308"
style="font-size:48px;line-height:1.25">forward</tspan></text>
<text
xml:space="preserve"
style="font-size:48px;font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;display:inline;font-family:DejaVu Sans;-inkscape-font-specification:DejaVu Sans Bold"
style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;line-height:0%;font-family:'DejaVu Sans';-inkscape-font-specification:'DejaVu Sans Bold';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;display:inline;fill:#000000;fill-opacity:1;stroke:none"
x="587.80414"
y="551.48431"
id="text3298"
sodipodi:linespacing="125%"><tspan
id="text3298"><tspan
sodipodi:role="line"
id="tspan3300"
x="587.80414"
y="551.48431">filter</tspan></text>
y="551.48431"
style="font-size:48px;line-height:1.25">filter</tspan></text>
<text
xml:space="preserve"
style="font-size:48px;font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;display:inline;font-family:DejaVu Sans;-inkscape-font-specification:DejaVu Sans Bold"
style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;line-height:0%;font-family:'DejaVu Sans';-inkscape-font-specification:'DejaVu Sans Bold';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;display:inline;fill:#000000;fill-opacity:1;stroke:none"
x="1244.9161"
y="370.42093"
id="text3690"
sodipodi:linespacing="125%"><tspan
id="text3690"><tspan
sodipodi:role="line"
id="tspan3692"
x="1244.9161"
y="370.42093">POP</tspan></text>
y="370.42093"
style="font-size:48px;line-height:1.25">POP</tspan></text>
<text
xml:space="preserve"
style="font-size:48px;font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;display:inline;font-family:DejaVu Sans;-inkscape-font-specification:DejaVu Sans Bold"
style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;line-height:0%;font-family:'DejaVu Sans';-inkscape-font-specification:'DejaVu Sans Bold';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;display:inline;fill:#000000;fill-opacity:1;stroke:none"
x="785.66241"
y="873.72546"
id="text3302"
sodipodi:linespacing="125%"><tspan
id="text3302"><tspan
sodipodi:role="line"
id="tspan3304"
x="785.66241"
y="873.72546">Spool</tspan></text>
y="873.72546"
style="font-size:48px;line-height:1.25">Spool</tspan></text>
</g>
</svg>

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 46 KiB

After

Width:  |  Height:  |  Size: 46 KiB

133
doc/windows.html
View File

@ -11,92 +11,121 @@
<h1><a class="a-header" name="H_1">E-MailRelay Windows</a></h1> <!-- index:1:H:E-MailRelay Windows -->
<h2><a class="a-header" name="SH_1_1">Setup program</a></h2> <!-- index:2:SH:1:1:Setup program -->
<p>
Installing E-MailRelay on Windows should be straightforward if you have the
setup program <em>emailrelay-setup.exe</em> and its associated <em>payload</em> files.
To install E-MailRelay on Windows run <em>emailrelay-setup.exe</em>.
</p>
<p>
Run <em>emailrelay-setup.exe</em> as an administrator if you are going to be installing
into protected directories like <em>Program Files</em>.
The installation GUI will take you through the installation options and then
install the run-time files from the <em>payload</em> directory into your chosen
locations and also create a startup batch file (<em>emailrelay-start.bat</em>).
</p>
<p>
You may need to run <em>vc_redist.x64.exe</em> first to install the Microsoft C++
run-time files.
If you plan to install into <em>Program Files</em> and <em>ProgramData</em>, or if you want
to run E-MailRelay as a Windows service then you will need to allow the
installation program to run as Administrator.
</p>
<p>
The setup GUI will take you through the installation options and then install
the run-time files into your chosen locations.
</p>
<p>
If anything goes wrong with the installation process then you can still just
run the main E-MailRelay executable straight out of the distribution zip file.
Follow the <em>Manual installation</em> section below for more help.
You can also run the main E-MailRelay program <em>emailrelay.exe</em> directly without
going through the installation process but you will need to refer to the
documentation to set the appropriate configuration options.
</p>
<h2><a class="a-header" name="SH_1_2">Running the program</a></h2> <!-- index:2:SH:1:2:Running the program -->
<p>
After a successful installation you should see E-MailRelay listed in the Windows
Start Menu, or an E-MailRelay link under <em>Program Files/E-MailRelay</em>. This will
run the <em>emailrelay-start.bat</em> batch file to start the E-MailRelay server, and
you should then see an icon appear in the Windows system tray under the "Show
hidden icons" button.
After a successful installation you should see E-MailRelay listed in the
Windows Start Menu and/or as an entry in the Windows <em>Services</em> tool.
</p>
<p>
Note that the <em>emailrelay-start.bat</em> file lives under <em>ProgramData</em>, and
although this might be a hidden directory you can still navigate there by
right-clicking on the <em>E-MailRelay</em> link under <em>Program Files</em> and selecting
<em>Open file location</em>.
The Start Menu item will run the startup batch file <em>emailrelay-start.bat</em>
which contains all the necessary configuration options, and once the
E-MailRelay server is running you should see an icon appear in the Windows
system notification area under the <em>Show hidden icons</em> button.
</p>
<p>
Or if E-MailRelay runs as a service you should see an entry in the Windows
<em>Services</em> tool with a status of Running. Check the E-MailRelay log file to see
what it is doing.
</p>
<h2><a class="a-header" name="SH_1_3">Configuration</a></h2> <!-- index:2:SH:1:3:Configuration -->
<p>
E-MailRelay is configured though command-line options like <em>--verbose</em> or
<em>--spool-dir=c:/temp</em> in the <em>emailrelay-startup.bat</em> batch file.
E-MailRelay is configured with options like <em>--verbose</em> or <em>--spool-dir</em> in the
<em>emailrelay-startup.bat</em> batch file.
</p>
<p>
You can edit the batch file directly using Notepad, or run <em>emailrelay-gui.exe</em>.
Note that <em>emailrelay-start.bat</em> lives under <em>ProgramData</em>, and although this
might be a hidden directory you can still navigate there by right-clicking on
the E-MailRelay link under <em>Program Files</em> and selecting <em>Open file location</em>.
</p>
<p>
All command-line options are documented in the E-MailRelay reference document.
You can edit the batch file using Notepad: right-click on the E-MailRelay link
or on the <em>emailrelay-start.bat</em> file, then <em>show more options</em> and <em>edit</em>.
</p>
<p>
Account information can be configured by editing the E-MailRelay <em>secrets</em> file.
Look for the <em>--client-auth</em> or <em>--server-auth</em> options in the startup batch
file to find out where this is.
Alternatively, use the <em>emailrelay-gui</em> program to make the changes.
</p>
<p>
All configuration options are documented in the E-MailRelay reference document.
</p>
<p>
Account user-ids and passwords can be configured by editing the E-MailRelay
<em>secrets</em> file. Check the <em>--client-auth</em> or <em>--server-auth</em> options in the
startup batch file to find out where this is.
</p>
<h2><a class="a-header" name="SH_1_4">Manual installation</a></h2> <!-- index:2:SH:1:4:Manual installation -->
<p>
The manual installation process for when you do not have the self-extracting
setup program, goes something like this:
The manual installation process for when you cannot run the setup program can be
as simple as this:
</p>
<ul>
<li>Create a new program directory <em>c:\Program Files\E-MailRelay</em></li>
<li>Copy the packaged files into <em>c:\Program Files\E-MailRelay</em></li>
<li>Create a new spool directory <em>c:\ProgramData\E-MailRelay\spool</em></li>
<li>Create a new text file, eg. <em>c:\ProgramData\E-MailRelay\auth.txt</em>, to contain account details</li>
<li>Add your account details to <em>auth.txt</em> with a line like <em>client plain myaccount mypassword</em></li>
<li>Create a new program directory <em>c:\Program Files\E-MailRelay</em>.</li>
<li>Create a new spool directory <em>c:\Program Files\E-MailRelay\spool</em>.</li>
<li>Copy the EXE files from <em>programs</em> in the zip file into <em>c:\Program Files\E-MailRelay</em>.</li>
<li>Create a new text file, eg. <em>c:\Program Files\E-MailRelay\auth.txt</em>, to contain account details.</li>
<li>Add account details to <em>auth.txt</em> with a line like <em>client plain myaccount mypassword</em>.</li>
<li>Right-drag <em>emailrelay.exe</em> onto the desktop to create a shortcut for the server.</li>
<li>Add <em>--as-server --verbose</em> to the server shortcut properties in the <em>target</em> box.</li>
<li>Right-drag again to create a shortcut to do the forwarding.</li>
<li>Add <em>--as-client example.com:smtp --client-auth c:\ProgramData\E-MailRelay\auth.txt</em> to the client shortcut.</li>
<li>Add configuration options to the server shortcut properties in the <em>target</em> box.</li>
</ul>
<p>
Copy the shortcuts to <em>Start Menu</em> and <em>Startup</em> folders as necessary.
The configuration options should normally include:
</p>
<ul>
<li><em>--log</em></li>
<li><em>--verbose</em></li>
<li><em>--log-file=@app\log-%d.txt</em></li>
<li><em>--spool-dir=@app\spool</em></li>
<li><em>--client-auth=@app\auth.txt</em></li>
<li><em>--client-tls</em></li>
<li><em>--forward-to=smtp.example.com:25</em></li>
<li><em>--forward-on-disconnect</em></li>
<li><em>--poll=60</em></li>
</ul>
<p>
Copy the shortcut to <em>Start Menu</em> and <em>Startup</em> folders as necessary.
</p>
<h2><a class="a-header" name="SH_1_5">Running as a service</a></h2> <!-- index:2:SH:1:5:Running as a service -->
<p>
E-MailRelay can be set up as a service so that it starts up automatically at
boot-time. Do do this manually you must first have a one-line batch file
called <em>emailrelay-start.bat</em> that contains all the command-line options for
running the E-MailRelay server, and you must have a simple service-wrapper
configuration file called <em>emailrelay-service.cfg</em> that points to it, and this
must be in the same directory as the service wrapper executable
E-MailRelay can be set up as a Windows service so that it starts up
automatically at boot-time. This can be enabled on the <em>Server startup</em> page
in the installation program or later using the <em>emailrelay-gui</em> configuration
program.
</p>
<p>
Alternatively, to set up the service manually you must first have a one-line
batch file called <em>emailrelay-start.bat</em> that contains all the configuration
options for running the E-MailRelay server, and you must have a simple
service-wrapper configuration file called <em>emailrelay-service.cfg</em> that points
to it, and this must be in the same directory as the service wrapper executable
(<em>emailrelay-service.exe</em>).
</p>
@ -138,7 +167,7 @@
name and display name on the <em>emailrelay-service --install <name> <display-name></em>
command-line. The service name you give is used to derive the name of the
<em><name>-start.bat</em> batch file that contains the E-MailRelay server's
command-line options, so you will need to create that first.
configuration options, so you will need to create that first.
</p>
<h2><a class="a-header" name="SH_1_6">Uninstall</a></h2> <!-- index:2:SH:1:6:Uninstall -->
<p>
@ -168,7 +197,7 @@
<p>
You can increase the verbosity of the logging by adding the <em>--verbose</em> option
to the E-MailRelay command-line, typically by editing the <em>emailrelay-start.bat</em>
to the E-MailRelay options, typically by editing the <em>emailrelay-start.bat</em>
batch script in <em>C:\ProgramData\E-MailRelay</em>.
</p>
<h2><a class="a-header" name="SH_1_8">Testing with telnet</a></h2> <!-- index:2:SH:1:8:Testing with telnet -->
@ -193,7 +222,7 @@
<p>
This should show a greeting from the E-MailRelay server and then you can
start typing SMTP commands like <em>EHLO</em>, <em>MAIL FROM:<..></em>, <em>RCPT TO:<...></em>
and <em>DATA</em>.
and <em>DATA</em>. Refer to RFC-821 Appendix F for some examples.
</p>
@ -201,10 +230,10 @@
<div class="div-footer">
<p>
Copyright (C) 2001-2022 Graeme Walker
Copyright (C) 2001-2023 Graeme Walker
</p>
</div><!-- div-footer -->
</div> <!-- div-main -->
</body>
</html>
<!-- Copyright (C) 2001-2022 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->
<!-- Copyright (C) 2001-2023 Graeme Walker <graeme_walker@users.sourceforge.net>. All rights reserved. -->

119
doc/windows.md
View File

@ -3,73 +3,93 @@ E-MailRelay Windows
Setup program
-------------
Installing E-MailRelay on Windows should be straightforward if you have the
setup program `emailrelay-setup.exe` and its associated `payload` files.
To install E-MailRelay on Windows run `emailrelay-setup.exe`.
Run `emailrelay-setup.exe` as an administrator if you are going to be installing
into protected directories like `Program Files`.
The installation GUI will take you through the installation options and then
install the run-time files from the `payload` directory into your chosen
locations and also create a startup batch file (`emailrelay-start.bat`).
You may need to run `vc_redist.x64.exe` first to install the Microsoft C++
run-time files.
If you plan to install into `Program Files` and `ProgramData`, or if you want
to run E-MailRelay as a Windows service then you will need to allow the
installation program to run as Administrator.
The setup GUI will take you through the installation options and then install
the run-time files into your chosen locations.
If anything goes wrong with the installation process then you can still just
run the main E-MailRelay executable straight out of the distribution zip file.
Follow the `Manual installation` section below for more help.
You can also run the main E-MailRelay program `emailrelay.exe` directly without
going through the installation process but you will need to refer to the
documentation to set the appropriate configuration options.
Running the program
-------------------
After a successful installation you should see E-MailRelay listed in the Windows
Start Menu, or an E-MailRelay link under `Program Files/E-MailRelay`. This will
run the `emailrelay-start.bat` batch file to start the E-MailRelay server, and
you should then see an icon appear in the Windows system tray under the "Show
hidden icons" button.
After a successful installation you should see E-MailRelay listed in the
Windows Start Menu and/or as an entry in the Windows `Services` tool.
Note that the `emailrelay-start.bat` file lives under `ProgramData`, and
although this might be a hidden directory you can still navigate there by
right-clicking on the `E-MailRelay` link under `Program Files` and selecting
`Open file location`.
The Start Menu item will run the startup batch file `emailrelay-start.bat`
which contains all the necessary configuration options, and once the
E-MailRelay server is running you should see an icon appear in the Windows
system notification area under the `Show hidden icons` button.
Or if E-MailRelay runs as a service you should see an entry in the Windows
`Services` tool with a status of Running. Check the E-MailRelay log file to see
what it is doing.
Configuration
-------------
E-MailRelay is configured though command-line options like `--verbose` or
`--spool-dir=c:/temp` in the `emailrelay-startup.bat` batch file.
E-MailRelay is configured with options like `--verbose` or `--spool-dir` in the
`emailrelay-startup.bat` batch file.
You can edit the batch file directly using Notepad, or run `emailrelay-gui.exe`.
Note that `emailrelay-start.bat` lives under `ProgramData`, and although this
might be a hidden directory you can still navigate there by right-clicking on
the E-MailRelay link under `Program Files` and selecting `Open file location`.
All command-line options are documented in the E-MailRelay reference document.
You can edit the batch file using Notepad: right-click on the E-MailRelay link
or on the `emailrelay-start.bat` file, then `show more options` and `edit`.
Account information can be configured by editing the E-MailRelay `secrets` file.
Look for the `--client-auth` or `--server-auth` options in the startup batch
file to find out where this is.
Alternatively, use the `emailrelay-gui` program to make the changes.
All configuration options are documented in the E-MailRelay reference document.
Account user-ids and passwords can be configured by editing the E-MailRelay
`secrets` file. Check the `--client-auth` or `--server-auth` options in the
startup batch file to find out where this is.
Manual installation
-------------------
The manual installation process for when you do not have the self-extracting
setup program, goes something like this:
The manual installation process for when you cannot run the setup program can be
as simple as this:
* Create a new program directory `c:\Program Files\E-MailRelay`
* Copy the packaged files into `c:\Program Files\E-MailRelay`
* Create a new spool directory `c:\ProgramData\E-MailRelay\spool`
* Create a new text file, eg. `c:\ProgramData\E-MailRelay\auth.txt`, to contain account details
* Add your account details to `auth.txt` with a line like `client plain myaccount mypassword`
* Create a new program directory `c:\Program Files\E-MailRelay`.
* Create a new spool directory `c:\Program Files\E-MailRelay\spool`.
* Copy the EXE files from `programs` in the zip file into `c:\Program Files\E-MailRelay`.
* Create a new text file, eg. `c:\Program Files\E-MailRelay\auth.txt`, to contain account details.
* Add account details to `auth.txt` with a line like `client plain myaccount mypassword`.
* Right-drag `emailrelay.exe` onto the desktop to create a shortcut for the server.
* Add `--as-server --verbose` to the server shortcut properties in the `target` box.
* Right-drag again to create a shortcut to do the forwarding.
* Add `--as-client example.com:smtp --client-auth c:\ProgramData\E-MailRelay\auth.txt` to the client shortcut.
* Add configuration options to the server shortcut properties in the `target` box.
Copy the shortcuts to `Start Menu` and `Startup` folders as necessary.
The configuration options should normally include:
* `--log`
* `--verbose`
* `--log-file=@app\log-%d.txt`
* `--spool-dir=@app\spool`
* `--client-auth=@app\auth.txt`
* `--client-tls`
* `--forward-to=smtp.example.com:25`
* `--forward-on-disconnect`
* `--poll=60`
Copy the shortcut to `Start Menu` and `Startup` folders as necessary.
Running as a service
--------------------
E-MailRelay can be set up as a service so that it starts up automatically at
boot-time. Do do this manually you must first have a one-line batch file
called `emailrelay-start.bat` that contains all the command-line options for
running the E-MailRelay server, and you must have a simple service-wrapper
configuration file called `emailrelay-service.cfg` that points to it, and this
must be in the same directory as the service wrapper executable
E-MailRelay can be set up as a Windows service so that it starts up
automatically at boot-time. This can be enabled on the `Server startup` page
in the installation program or later using the `emailrelay-gui` configuration
program.
Alternatively, to set up the service manually you must first have a one-line
batch file called `emailrelay-start.bat` that contains all the configuration
options for running the E-MailRelay server, and you must have a simple
service-wrapper configuration file called `emailrelay-service.cfg` that points
to it, and this must be in the same directory as the service wrapper executable
(`emailrelay-service.exe`).
The startup batch file should contain a single line, something like this:
@ -95,7 +115,7 @@ If you need to run multiple E-MailRelay services then put a unique service
name and display name on the `emailrelay-service --install <name> <display-name>`
command-line. The service name you give is used to derive the name of the
`<name>-start.bat` batch file that contains the E-MailRelay server's
command-line options, so you will need to create that first.
configuration options, so you will need to create that first.
Uninstall
---------
@ -120,7 +140,7 @@ The Windows Event Log can be accessed by running `eventvwr.exe` or searching for
`Event Viewer`; from there look under `Windows Logs` and `Application`.
You can increase the verbosity of the logging by adding the `--verbose` option
to the E-MailRelay command-line, typically by editing the `emailrelay-start.bat`
to the E-MailRelay options, typically by editing the `emailrelay-start.bat`
batch script in `C:\ProgramData\E-MailRelay`.
Testing with telnet
@ -137,13 +157,14 @@ port number as command-line parameters:
This should show a greeting from the E-MailRelay server and then you can
start typing [SMTP][] commands like `EHLO`, `MAIL FROM:<..>`, `RCPT TO:<...>`
and `DATA`.
and `DATA`. Refer to [RFC-821][] Appendix F for some examples.
[RFC-821]: https://tools.ietf.org/html/rfc821
[SMTP]: https://en.wikipedia.org/wiki/Simple_Mail_Transfer_Protocol
_____________________________________
Copyright (C) 2001-2022 Graeme Walker
Copyright (C) 2001-2023 Graeme Walker

Some files were not shown because too many files have changed in this diff Show More