.TH SSMTP 8 "August 2007" "OpenFWTK"
.SH NAME
ssmtp, sendmail \- send a message using smtp
.SH SYNOPSIS
.B ssmtp
.RI "[ " flags " ] [ " address " "  ... " ]"
.br
.B sendmail
.RI "[ " flags " ] [ " address " "  ... " ]"
.br
.SH DESCRIPTION
.I ssmtp
is a send-only sendmail emulator for firewall host.
It provides the functionality required for humans and programs to send
mail via the standard or /usr/bin/mail user agents.
.PP
It accepts a mail stream on standard input with recipients specified on the
command line and synchronously forwards the message to the mail transfer
agent of a mailhub for the mailhub MTA to process. Failed messages are
placed in dead.letter in the configured "baddir" directory.
.sp
.PP
It does not attempt to provide all the functionality of sendmail: it is
intended for use where other programs are the primary means of at last mail
delivery.  
.PP
It does not do aliasing, which must be done either in the user agent
or on the mailhub. Nor does it honor .forwards, which have to be done
on the recieving host.  It especially does not deliver to pipelines.
.PP
.I ssmtp
know nothing about MX'es and other things like that. It does
SMTP _only_ and uses static routes defined in netperm-table to deliver
mail.
.SH OPTIONS
.SS Command Line Options
Most sendmail options are irrelevent to sSMTP. Those marked ``ignored'' or
``default'' have no effect on mail transfer.  Those marked ``unsupported''
are fatal errors.  Those marked ``simulated'' are not errors, but the result
is for the program to exit with an informative message. A sort of fatal
non-error.

.TP
.B \-ba
(unsupported) ARPANET mode. All input lines must end with a LINEFEED, and
all messages will be generated with a CR-LF at the end. Also, the ``From:''
and ``Sender:'' fields are examined for the name of the sender.

.TP
.B \-bd 
(unsupported) Run as a daemon.

.TP
.B \-bi
(ignored) Initialise the alias database.

.TP
.B \-bm
(default) Deliver mail in the usual way.

.TP
.B \-bp
(simulated) Print a summary of the mail queue.

.TP
.B \-bs
(unsupported) Read SMTP commands from stdin.

.TP
.B \-bt
(unsupported) Run in address test mode.

.TP
.B \-bv
(unsupported) Verify names only.

.TP
.B \-bz
(unsupported) Create the configuration freeze file.

.TP
\fB\-C\fP\fIfile\fP 
(ignored) Use alternate configuration file.

.TP
\fB\-d\fP\fIX\fP
Set debugging value to X.

.TP
.B \-E 
(ignored) Don't trust userid of sender.

.TP
\fB\-F\fP\fIfullname\fP
Set the full name of the sender.

.TP
\fB\-f\fP\fIname\fP
Sets the name of the ``from'' person. This option is valid only if no
From: line is specified within the header of the email.

.TP
\fB\-h\fP\fI\fN\fP
(ignored) Set the hop count to N.

.TP
.B \-m 
(ignored) Ignore originator in alias.

.TP
\fB\-M\fP\fIid\fP
(ignored) Attempt to deliver the queued message with message-id id.

.TP
\fB\-N\fP \fIdsn\fP
(ignored) Set delivery status notification conditions to dsn.

.TP
.B \-n 
(default) Do not do aliasing.

.TP
\fB\-oA\fP\fIfile\fP
(ignored) Use alternate alias file.

.TP
.B \-oc
(ignored) Delay ``expensive'' connections.

.TP
\fB\-od\fP\fx\fP
(ignored) Set the delivery mode to interactive/synchronous, background or queue
(Always interactive).

.TP
.B \-oD
(ignored) Run newaliases if required.

.TP
\fB\-oe\fP\fx\fP
(ignored) Set error processing to mail, write, print or quit. (Always print).

.TP
\fB\-oF\fP\fImode\fP
(ignored) The mode to use when creating temporary files.

.TP
.B \-of
(ignored) Save UNIX-system-style ``From'' lines at the front of messages.

.TP
\fB\-og\fP\fIN\fP
(ignored) Set group ID to use when calling mailers.

.TP
\fB\-oH\fP\fIfile\fP
(ignored) Set SMTP help file.

.TP
.B \-oi
(default) Do not take dots on a line by themselves as a message terminator.

.TP
\fB\-oL\fP\fIn\fP
(ignored) The log level.

.TP
.B \-om
(default) Send to ``me'' (the sender) also if in an alias.

.TP
.B \-oo
(unsupported) If set, this message may have old style headers. 

.TP
\fB\-oQ\fP\fIqueuedir\fP
(ignored) Select the directory in which to queue messages.

.TP
\fB\-or\fP\fItimeout\fP
(ignored) The timeout on reads.

.TP
\fB\-oS\fP\fIfile\fP 
(ignored) Save statistics in the named file.

.TP
.B \-os
(ignored) Always instantiate the queue.

.TP
\fB\-oT\fP\fItime\fP
(ignored) Set timeout on messages.

.TP
\fB\-ot\fP\fIstz,dtz\fP
(ignored) Set the name of the time zone.

.TP
\fB\-ou\fP\fIN\fP
(ignored) Set the default user id for mailers.

.TP
\fB\-q\fP\fI[time]\fP
(simulated) Process the queue.

.TP
\fB\-r\fP\fIname\fP
Same as -f.

.TP
.B \-t
Read  message, searching for recipients. ``To:'', `Cc:'', and ``Bcc:'' lines
will be scanned for people to send to. Any addresses  in  the  argument list
will be suppressed.

.TP
.B \-v
Go into verbose mode. 

.TP
.B \-V
Say version and quit.

.SS Configuration Options
The
.B ssmtp
program reads configuration rules from the
.IR "/usr/local/etc/netperm-table" .
It reads all rules using the
.B ssmtp
and
.B *
(wildcard) keywords. The
.B ssmtp
program reads the
.I netperm-table
from top to bottom.  If there are multiple rules in the table that
could apply for a particular attribute, the
.B ssmtp
program uses the first one that it finds.  See
.BR "netperm-table"  (5)
for a more complete explanation of
.I netperm-table
syntax and precedence.
.PP
The
.B ssmtp
program recognizes the following attributes:
.TP
.BI "directory " directory
Specifies the directory that the
.B smtpd
proxy makes its root directory before providing service.
.TP
.BI "baddir " directory
Specifies the directory in which the
.B ssmtp
server places any spooled mail that it cannot deliver normally.
.TP
.BI "relay " "domain [domain..]" options
rules specify mail routing path.
There may be several domains following the "relay"
keyword, ending with the first option beginning
with '-'. Sub-options are:
.IP
.IP
.BI "\-via " mailhub
Specifies mail route destination for domain (smtp host)
.IP
.BI "[-server]-dscp " dscp-tag-name
.br 
.BI "[-server]-dscp " dscp-hex-value
Specifies diffserv codepoint (QoS/ToS mark) for smtp session.
.TP
.BI "default-relay " relay
Specifies default mailhub for domains not listed explicitly in
routing rules.
.TP
.BI "default-dscp " dscp-tag-name
.br
.BI "default-dscp " dscp-hex-value
Specifies default diffserv codepoint (QoS/ToS mark) for smtp session.
.TP
.BI "intranet-hosts " "host-pattern [host-pattern..]"
Specifies message originators to be treated as intranet (for filtering
purposes). The relay IP is being extracted from headers formed by
.B smtpd.
.TP
.B "hide-intranet [-log-headers]"
Removes message route for intranet-hosts and replaces it with smap id for 
future reference (-log-headers saves removed Received: 
lines into syslog; you probably don't need this if you are big-brother-friendy 
(well, Sarbannes-Oxley compliant) enough to save duplicates of outgoing
messages or have other reasons to do so.)
.PP
.B milter
.I filter
.br
.B intranet-milter
.I filter
.br
.B extranet-milter
.I filter
.RS
Defines content inspection filter for all, intranet-originated and
outside-originated messages.
.TP
.I filter
Defines milter socket address in unix:/domain-path or inet:port@host
format.
.RE
.TP
.BI "groupid " group
Specifies the name of the group the
.B ssmtp
program uses when running.
.RS
.TP
.I group
Specifies either a name or numeric id from the
.I /etc/group
file.
.RE
.TP
.BI "groupid " group
Specifies the name of the group the
.B ssmtp
program uses when running.
.RS
.TP
.I group
Specifies either a name or numeric id from the
.I /etc/group
file.
.RE
.TP
.BI "timeout " seconds
Specifies the number of seconds the
.B smtpd
proxy is idle (with no network activity) before disconnecting
.TP
.BI "userid " user
Specifies the user ID the proxy uses when running.
.RS
.TP
.I user
Specifies either a name or numeric id from the
.I /etc/passwd
file.
.RE


.SH FILES
.IP /usr/local/etc/netperm-table
The network permissions file contains configuration information
for the Firewall Toolkit, including the network news proxy.

.SH BUGS
sSMTP does not support exception lists to the -t option (never seen it
used).
.PP
sSMTP does not do ESMTP and does not support authentication at the moment.
.PP
sSMTP will fail if the mailhub is unreachable.
Report bugs to arkenoi@gmail.com or fwtk-users@buoy.com mailing list.
Include a complete example, explaining what you expected to happen and what actually
happened.  Be sure to indicate the type of system (operating system,
hardware, etc.) you are using, as well as the version of the ssmtp.

.SH AUTHORS
Hugo Haas (hugo@debian.org)
Christoph Lameter (clameter@debian.org)

.SH SEE ALSO
RFC821, RFC2822,
.BR netperm-table "(5), " smtpd "(8), " smtpfwdd "(8)"