aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README116
1 files changed, 116 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..da80bc8
--- /dev/null
+++ b/README
@@ -0,0 +1,116 @@
+mockmta README
+
+* Introduction
+
+This is a simplistic implementation of the SMTP mail transport agent,
+designed for testing purposes. It behaves almost identically to any
+real MTA, except that it listens on localhost only and delivers all
+messages to the given UNIX mailbox file.
+
+No attempts are made to interpret the data supplied during the STMP
+transaction, such as domain names, email addresses, etc, neither is
+the material supplied in the DATA command verified to be a valid
+email message. Except for being written to mailbox, these data are
+ignored.
+
+The program is derived from the eponymous tool I wrote for the GNU
+mailutils testsuite.
+
+* Compilation
+
+The usual sequence applies:
+
+ ./configure
+ make
+ make install
+
+If you want mockmta to support STARTTLS command, make sure the GnuTLS
+library version 3.3.0 or newer is installed on your system and is
+reported correctly by pkg-config.
+
+* Usage
+
+Mockmta can work both as an inetd-style process (default) and as a
+standalone daemon.
+
+In inetd mode it reads SMTP commands from stdin and issues responses
+on stdout. Logging messages go to stderr.
+
+To run mockmta as a daemon, give it the -d option. In this mode it
+listens on localhost port 25 by default. The port number can be changed
+using the -p command line option.
+
+In daemon mode, logging goes to the syslog facility "mail".
+
+In both modes, logging verbosity can be controlled using the -l (ell)
+option. By default, mockmta outputs error and warning messages, as well
+as the status of each SMTP transaction. This corresponds to the option
+"-l info". To request detailed transcript of each SMTP session, use
+"-l debug". To output only notices and more important messages, use
+"-l notice".
+
+Support for STARTTLS command is enabled using the following three
+options:
+
+ -c CERT
+ Sets the name of certificate file.
+
+ -a CA
+ Sets the name of certificate authority file.
+
+ -k KEY
+ Sets the name of certificate key file.
+
+Two informative options are provided: -? prints a short usage summary,
+and -v prints the program version and TLS support status.
+
+See documentation for a detailed discussion.
+
+* Documentation
+
+Manual page is included in distribution. After successful installation,
+run "man mockmta" and read the docs.
+
+The online copy of the documentation is available at
+
+ http://man.gnu.org.ua/1/mockmta
+
+* Downloads
+
+Mockmta is available for download from
+
+ https://download.gnu.org.ua/release/mockmta
+
+* Development and bug reports
+
+To track development of mockmta, visit
+
+ https://puszcza.gnu.org.ua/projects/mockmta
+
+Use the bug tracker on that page to report bugs or problems, or mail
+them to <gray@gnu.org.ua>
+
+* License
+
+Copyright (C) 2020-2021 Sergey Poznyakoff
+
+Mockmta 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, or (at your option)
+any later version.
+
+Mockmta 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 GNU Mailutils. If not, see <http://www.gnu.org/licenses/>.
+
+
+Local Variables:
+mode: outline
+paragraph-separate: "[ ]*$"
+version-control: never
+End:
+

Return to:

Send suggestions and report system problems to the System administrator.