.\" -*- 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 "NEWS2MAIL 8"
.TH NEWS2MAIL 8 2024-04-01 "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
news2mail \- Channel script to gateway news into e\-mails
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBnews2mail\fR
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBnews2mail\fR runs as a channel process underneath \fBinnd\fR.  It is set
up as channel feed in \fInewsfeeds\fR, with different mailing-lists as funnel
entries pointing to it (see below); \fBnews2mail\fR expects the token of an
article followed by a sequence of list names.
.PP
\&\fBnews2mail\fR uses the configuration file \fIpathetc\fR/news2mail.cf to map
mailing-list names to e\-mail addresses.  \fBnews2mail\fR causes the mail
transport agent (usually \fBsendmail\fR, as set in the \fImta\fR parameter in
\&\fIinn.conf\fR) to queue the messages for later delivery (to avoid DOS attacks
by mass postings).  You must run \f(CW\*(C`sendmail \-q\*(C'\fR periodically to get the queue
processed.
.SH "CONFIGURATION FILE"
.IX Header "CONFIGURATION FILE"
The configuration file format is simple: comments (starting with a hash sign
\&\f(CW\*(C`#\*(C'\fR) and blank lines are ignored.  All other lines have two or three fields
on them.  The first is the list name and is what \fBinnd\fR uses (i.e. the site
field of the entry in the \fInewsfeeds\fR file).  The second field is the
actual e\-mail address to send the article to.  The third field is optional:
it sets the envelope-from address (for instance a list member's address;
if not set, it defaults to the \f(CW\*(C`news\*(C'\fR user).
.PP
In e\-mail messages, the To header field body will have the mailing-list
address (i.e. the second field).  Besides, \fBnews2mail\fR strips most article
header fields from the article before mailing.
.PP
In \fInewsfeeds\fR, the channel feed should look like:
.PP
.Vb 1
\&    news2mail!:!*:Ac,Tc,Wn*:<pathbin>/news2mail
.Ve
.PP
and for each mailing-list, you only have to add to \fInewsfeeds\fR an entry list
like:
.PP
.Vb 3
\&    list\-big\-red\-ants/lists.ucsd.edu\e
\&        :!*,rec.pets.red\-ants\e
\&        :Ap,Tm:news2mail!
.Ve
.PP
Please note the use of \f(CW\*(C`Ap\*(C'\fR and the exclusion of the list owner domain
to protect the list from feeding back new arrivals from the list.
The site name used in the \fInewfeeds\fR entry for a mailing-list (above
\&\f(CW\*(C`list\-big\-red\-ants\*(C'\fR) must be the same as the first field in an entry in
\&\fInews2mail.cf\fR.  For instance:
.PP
.Vb 2
\&    # newsfeeds\-name   list\-to\-address      [list\-sender\-address]
\&    list\-big\-red\-ants  ants@lists.ucsd.edu  news+ants@news.server.org
.Ve
.SH FILES
.IX Header "FILES"
.IP \fIpathbin\fR/news2mail 4
.IX Item "pathbin/news2mail"
The Perl program itself used to gateway news into e\-mails.
.IP \fIpathetc\fR/news2mail.cf 4
.IX Item "pathetc/news2mail.cf"
The configuration file which specifies the mapping to use for gatewaying.
.SH BUGS
.IX Header "BUGS"
The \fBnews2mail\fR program is set up as a funnelled channel in \fInewsfeeds\fR,
implying multiple matches should be handled as one \-\ and multiple matching
funnelled feeds will result in a single call to the script.  Therefore,
since only one mail is sent, crossposts are not currently properly handled
as for the envelope-from address (which then defaults to the \f(CW\*(C`news\*(C'\fR user).
.SH HISTORY
.IX Header "HISTORY"
\&\fBnews2mail\fR was written by Brian Kantor in 1998.  This man page was written
by James Brister and converted to POD by Julien Elie.  The third optional
field in \fInews2mail.cf\fR was added by D.\ Stussy in 2008.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
innd(8), newsfeeds(5).