.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "INNMAIL 1"
.TH INNMAIL 1 2024-02-12 "INN 2.7.2" "InterNetNews Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
innmail \- Simple mail\-sending program
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBinnmail\fR [\fB\-h\fR] [\fB\-a\fR \fIheader\fR] [\fB\-s\fR \fIsubject\fR] \fIaddress\fR
[\fIaddress\fR ...]
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBinnmail\fR is a Perl script intended to provide the non-interactive
mail-sending functionality of mail(1) while avoiding nasty security
problems.  It takes the body of a mail message on standard input and sends
it to the specified addresses by invoking the value of \fImta\fR in
\&\fIinn.conf\fR.
.PP
At least one address (formatted for the MTA specified in \fIinn.conf\fR, if it
matters) is required.  \fBinnmail\fR will sanitize the addresses so that they
contain only alphanumerics and the symbols \f(CW\*(C`@\*(C'\fR, \f(CW\*(C`.\*(C'\fR, \f(CW\*(C`\-\*(C'\fR, \f(CW\*(C`+\*(C'\fR, \f(CW\*(C`_\*(C'\fR,
and \f(CW\*(C`%\*(C'\fR.
.PP
\&\fBinnmail\fR was written to be suitable for the \fImailcmd\fR setting in
\&\fIinn.conf\fR.
.SH OPTIONS
.IX Header "OPTIONS"
.IP "\fB\-a\fR \fIheader\fR" 4
.IX Item "-a header"
Specifies an additional header field to add in the headers of the message.
It should be a well-formed header field surrounded by quotes, consisting
of a name and a body separated with a colon and a space.  For instance,
\&\f(CW\*(C`Auto\-Submitted: auto\-generated\*(C'\fR is used by some programs invoking
\&\fBinnmail\fR.
.Sp
You may provide more than one header field if \fIheader\fR is a multi-line
string, which can for instance be done with these commands:
.Sp
.Vb 2
\&    HEADERS=$(echo \-e "Hdr1: Body1\enHdr2: Body2")
\&    echo "test" | innmail \-a "$HEADERS" \-s Test joe
.Ve
.IP \fB\-h\fR 4
.IX Item "-h"
Gives usage information.
.IP "\fB\-s\fR \fIsubject\fR" 4
.IX Item "-s subject"
Sets the Subject header field body of the message.  A warning is issued
if this option is omitted.
.SH EXAMPLES
.IX Header "EXAMPLES"
This sends a one-line message to the local user \f(CW\*(C`joe\*(C'\fR:
.PP
.Vb 1
\&    echo "A one\-line message." | innmail \-s "Simple message" joe
.Ve
.PP
\&\fBinnmail\fR by default is used by INN for sending nightly reports to the news
administrator, as well as errors during the execution of a few programs.
.SH BUGS
.IX Header "BUGS"
\&\fBinnmail\fR fails on addresses that begin with \f(CW\*(C`\-\*(C'\fR, although one might
hope that the news server will not need to contact any such addresses.
.PP
There are many "correct" addresses that will be silently modified by the
sanitization process.  A news administrator should be careful to use
particularly sane addresses if they may be passed to \fBinnmail\fR.
.SH HISTORY
.IX Header "HISTORY"
\&\fBinnmail\fR was written by James Brister <brister@vix.com> for
InterNetNews.  This manual page was originally written by Jeffrey
M. Vinocur.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
inn.conf(5), mail(1).