openpkg-packages/smtpfeed/smtpfeed.8

.\"
.\"  smtpfeed.8 -- SMTPfeed Unix Manual Page
.\"
.TH SMTPFEED 8 "December 2001" Unix "User Manuals"
.SH NAME
.PP
smtpfeed \- SMTP Fast Exploding External Deliverer
.SH SYNOPSIS
.PP
\fBsmtpfeed\fP
[\fB-1\fP]
[\fB-5\fP]
[\fB-A\fP]
[\fB-a\fP \fIalias\fP]
[\fB-b\fP \fIbufsize\fP]
[\fB-c\fP \fIname\fP]
[\fB-d\fP \fIdebugopt\fP]
[\fB-E\fP]
[\fB-F\fP]
[\fB-F -F\fP]
[\fB-g\fP \fIpgateway\fP]
[\fB-h\fP]
[\fB-i\fP \fIqueue-id\fP]
[\fB-I\fP \fIqueue-id\fP]
[\fB-l\fP \fIfacility\fP]
[\fB-M\fP \fImapfile\fP]
[\fB-m\fP \fIfallback-mx\fP]
[\fB-N\fP \fIdomain\fP]
[\fB-n\fP \fInum\fP]
[\fB-o\fP \fIsource-addr\fP]
[\fB-p\fP \fIsource-port\fP]
[\fB-r\fP \fInum\fP]
[\fB-R\fP \fInum\fP]
[\fB-S\fP \fIpattern\fP]
[\fB-s\fP \fIsize\fP]
[\fB-t\fP \fIcategory=value\fP]
[\fB-u\fP]
[\fB-V\fP]
[\fB-x\fP]
[\fB-y\fP]
[\fB-z\fP]
.SH DESCRIPTION
.PP
This manual page documents the \fBsmtpfeed\fP command, an
LMTP-speaking mail delivery agent (MDA) dedicated to mass mail delivery, i.e.,
the delivery of mails via SMTP, addressed to large number of recipients.  So
\fBsmtpfeed\fP is effective for delivery of large mailing lists.
\fBsmtpfeed\fP is spawned by a mail transfer agent (MTA) like Sendmail or
Postfix, receives the mail and recipients via LMTP on stdin/stdout and
performs SMTP delivery by first processing DNS queries in parallel, followed
by parallel processing of SMTP deliveries.  \fBsmtpfeed\fP can not deliver
huge messages because it stores all information (includes message data) in
memory.
.SH OPTIONS
.PP
A description of the available command options are included below.
.IP "\fB-1\fP"
Disable SMTP piggybacking (equivalent to \fB-R1\fP).
.IP "\fB-5\fP"
If \fBsmtpfeed\fP works only with IPv4 (IPv6) protocol
(see option \fB-N\fP), and if peer host has
only AAAA (A) RRs in DNS, message will not be
bounced back with "Host not found" error, and fallback MX
(option \fB-m\fP) will be used.
.IP "\fB-A\fP"
Try T_ANY DNS query first to get MX list.
.IP "\fB-a\fP \fIalias\fP"
Specify this host's alias name, which is used to check MX list.
.IP "\fB-b\fP \fIbufsize\fP"
Specify TCP send buffer size.
.IP "\fB-c\fP \fIname\fP"
Specify official full-qualified domain name (FQDN) of this host, which 
is used in SMTP HELO command.
.IP "\fB-d\fP \fIdebugopt\fP"
Specify debug options.
Possible values for \fIdebugopt\fP are one or more of the following: 
A: all, a: address, c: connection, e: event, h: hash, l: LMTP, 
m: map, n: DNS, s: SMTP, t: transaction, u: resource usage, D: no delivery,
Q: DNS query only.
.IP "\fB-E\fP"
Get queue-id information from Received: header.
.IP "\fB-F\fP"
Insert recipient information on Received: header line if number of recipients
for an SMTP transaction is only one (see also option \fB-1\fP).
.IP "\fB-F -F\fP"
Modify envelope sender address like
"SenderUser+RcptUser=RcptDomain@SenderDomain" when \fB-1\fP option is specified.
If you want to use this feature, configure your mail server to receive such
addresses. Note: this modification will not be done when envelope sender is
"<>". See also option \fB-S\fP.
.IP "\fB-g\fP \fIpgateway\fP"
Protocol gateway host (Default: not defined). Option \fB-5\fP must be
specified at the same time. Option \fB-N4\fP or \fB-N6\fP must also be
specified at the same time if compiled with -DINET6. If \fB-N4\fP is specified
(or compiled without -DINET6), if an MX has IPv6 addresses, \fIpgateway\fP
will be used as first MX. This feature will be useful when delivery via
\fIpgateway\fP with fat IPv6 network is faster than direct delivery with
narrow IPv4 network. If \fB-N6\fP is specified, \fIpgateway\fP will be used if
an MX has IPv4 addresses, conversely.
.IP "\fB-h\fP"
Show help message.
.IP "\fB-i\fP \fIqueue-id\fB"
The \fIqueue-id\fP
as generated by the MTA - just for logging purposes. 
(macro name for \fIqueue-id\fP in sendmail.cf is $i.)
.IP "\fB-I\fP \fIqueue-id\fB"
Equivalent to option \fB-i\fP, but no purge on SMTP RSET command.
.IP "\fB-l\fP \fIfacility\fB"
Specify syslog(3) logging facility (default is "local5").
.IP "\fB-M\fP \fImapfile\fB"
Path of host map file (Default: not defined).
Syntax of map file is: "DOMAIN DEST1:DEST2:... # comments"
where DOMAIN can be "domain" (exact matching) or ".domain" (substring
matching) and DEST can be 
"hostname" (MX for hostname), 
"[hostname]" (A for hostname), 
"[IPaddress]" (IP address),
"MX" (MX for domain part of a mail address),
"MX?" (same as MX (skip to following dest. even under DNS lookup failure),
"A" (A for domain part of a mail address),
"=alias" (MX for an aliased mail address).
.IP "\fB-m\fP \fIfallback-mx\fB"
Fallback MX host.
.IP "\fB-N\fP \fIdomain\fB"
Specify network domain.
Possible .I domain
specifiers are: 
4: use IPv4 only, 6: use IPv6 only, B: use both of IPv4/IPv6
at random, B4: IPv4 then IPv6, B6: IPv6 then IPv4.
.IP "\fB-n\fP \fInum\fB"
Specify maximum number of available sockets for use.
(Default: FD_SETSIZE-1).
.IP "\fB-o\fP \fIsource-addr\fB"
Source TCP/IP address for outgoing SMTP connections.
(Default: an appropriate address will be dynamically assigned.)
.IP "\fB-p\fP \fIsource-port\fB"
Source TCP/IP port for outgoing SMTP connections.
(Default: a free port will be dynamically assigned.)
.IP "\fB-R\fP \fInum\fB"
Specify maximum number of recipients in a single SMTP transaction.
(Default: 100)
.IP "\fB-r\fP \fInum\fB"
Specify minimum number of recipients required for an SMTP transaction.
(Default: 1)
.IP "\fB-S\fP \fIpattern\fB"
Format to be used at envelope sender address conversion when
\fB-F -F\fP option specified. (Default: <%s+%s=%s@%s>)
.IP "\fB-s\fP \fIsize\fB"
Specify maximum message size.
(Default: unlimited)
.IP "\fB-t\fP \fIcategory=value\fB"
Set communication timeouts.
Numbers followed by 's' means 'in seconds', by 'm' means
 'in minutes' and by 'h' means 'in hours'. default is 'm'.
Values for \fIcategory\fP are: 
"total" (total processing limit (55m), it will be take "total + quit"),
"connect" (till TCP connection establishment (5m)), 
"greet" (till get SMTP greeting message (5m)), 
"helo" (till get response for HELO (5m)),
"mail" (till get response for MAIL (10m)), 
"rcpt" (till get response for RCPT (60m)),
"data" (till get response for DATA (5m)), 
"body" (till send next datablock (20m)), 
"term" (till get response for DATA termination (60m)), 
"cache" (for idle SMTP connection (5m)), 
"rset" (till get response for RSET (5m)), 
"quit" (till get response for QUIT (2m)).
.IP "\fB-u\fP"
Reuse SMTP connection for other MX.
(default: off)
.IP "\fB-V\fP"
Force to insert version number in Received: line.
.IP "\fB-x\fP"
No error even if MX RRs point to absent A/AAAA RRs.
.IP "\fB-y\fP"
Refer to DNS A RR if this host is the first MX.
.IP "\fB-z\fP"
Disable SMTP pipelining.
.SH AUTHOR
.PP
This manual page was written by Ralf S. Engelschall
<rse@engelschall.com> for the OpenPKG \fBsmtpfeed\fP
package.