.\" For license terms, see the file COPYING in this directory.
.TH fetchmail 1
.SH NAME
-fetchmail \- fetch mail from a POP, IMAP, or ETRN-capable server
+fetchmail \- fetch mail from a POP, IMAP, ETRN, or ODMR-capable server
.SH SYNOPSIS
-\fBfetchmail\fR [\fIoptions\fR] [\fImailserver...\fR]
+\fBfetchmail\fR [\fIoption...\fR] [\fImailserver...\fR]
.br
\fBfetchmailconf\fR
.SH DESCRIPTION
.I fetchmail
-is a mail-retrieval and forwarding utility; it fetches
-mail from remote mailservers and forwards it to your local (client)
-machine's delivery system. You can then handle the retrieved mail
-using normal mail user agents such as \fIelm\fR(1) or \fIMail\fR(1).
-The \fBfetchmail\fR utility can be run in a daemon mode to repeatedly
+is a mail-retrieval and forwarding utility; it fetches mail from
+remote mailservers and forwards it to your local (client) machine's
+delivery system. You can then handle the retrieved mail using normal
+mail user agents such as \fImutt\fR(1), \fIelm\fR(1) or \fIMail\fR(1).
+The \fIfetchmail\fR utility can be run in a daemon mode to repeatedly
poll one or more systems at a specified interval.
.PP
The
.I fetchmail
program can gather mail from servers supporting any of the common
mail-retrieval protocols: POP2, POP3, IMAP2bis, IMAP4, and IMAPrev1.
-It can also use the ESMTP ETRN extension. (The RFCs describing all
+It can also use the ESMTP ETRN extension and ODMR. (The RFCs describing all
these protocols are listed at the end of this manual page.)
.PP
While
available through your system MDA and local delivery agents will
therefore work.
.PP
+If no port 25 listener is available, but your fetchmail compilation
+detected or was told about a reliable local MDA, it will use that MDA
+for local delivery instead. At build time, fetchmail normally looks
+for executable
+.IR procmail (1)
+and
+.IR sendmail (1)
+binaries.
+.PP
If the program
.I fetchmailconf
is available, it will assist you in setting up and editing a
without actually fetching or deleting mail (see EXIT CODES below).
This option turns off daemon mode (in which it would be useless). It
doesn't play well with queries to multiple sites, and doesn't work
-with ETRN. It will return a false positive if you leave read but
+with ETRN or ODMR. It will return a false positive if you leave read but
undeleted mail in your server mailbox and your fetch protocol can't
tell kept messages from new ones. This means it will work with IMAP,
not work with POP2, and may occasionally flake out under POP3.
.B \-v, --verbose
Verbose mode. All control messages passed between
.I fetchmail
-and the mailserver are echoed to stderr. Overrides --silent.
+and the mailserver are echoed to stdout. Overrides --silent.
Doubling this option (-v -v) causes extra diagnostic information
to be printed.
.SS Disposal Options
default is to fetch only messages the server has not marked seen.
Under POP3, this option also forces the use of RETR rather than TOP.
Note that POP2 retrieval behaves as though --all is always on (see
-RETRIEVAL FAILURE MODES below) and this option does not work with ETRN.
+RETRIEVAL FAILURE MODES below) and this option does not work with ETRN
+or ODMR.
.TP
.B \-k, --keep
(Keyword: keep)
Specifying the
.B keep
option causes retrieved messages to remain in your folder on the
-mailserver. This option does not work with ETRN.
+mailserver. This option does not work with ETRN or ODMR.
.TP
.B \-K, --nokeep
(Keyword: nokeep)
Delete retrieved messages from the remote mailserver. This
option forces retrieved mail to be deleted. It may be useful if
you have specified a default of \fBkeep\fR in your
-\&\fI.fetchmailrc\fR. This option is forced on with ETRN.
+\&\fI.fetchmailrc\fR. This option is forced on with ETRN and ODMR.
.TP
.B \-F, --flush
POP3/IMAP only. Delete old (previously retrieved) messages from the mailserver
-before retrieving new messages. This option does not work with ETRN.
+before retrieving new messages. This option does not work with ETRN or
+ODMR.
Warning: if your local MTA hangs and fetchmail is aborted, the next
time you run fetchmail, it will delete mail that was never delivered to you.
What you probably want is the default setting: if you don't specify `-k', then
.IP POP3
Post Office Protocol 3
.IP APOP
-Use POP3 with MD5 authentication.
+Use POP3 with old-fashioned MD5-challenge authentication.
.IP RPOP
Use POP3 with RPOP authentication.
.IP KPOP
-Use POP3 with Kerberos V4 preauthentication on port 1109.
+Use POP3 with Kerberos V4 authentication on port 1109.
.IP SDPS
Use POP3 with Demon Internet's SDPS extensions.
.IP IMAP
IMAP2bis, IMAP4, or IMAP4rev1 (\fIfetchmail\fR autodetects their capabilities).
-.IP IMAP-K4
-IMAP4, or IMAP4rev1 (\fIfetchmail\fR autodetects their capabilities)
-with RFC 1731 Kerberos v4 preauthentication.
-.IP IMAP-GSS
-IMAP4, or IMAP4rev1 (\fIfetchmail\fR autodetects their capabilities)
-with RFC 1731 GSSAPI preauthentication.
-.IP IMAP-CRAMMD5
-IMAP4, or IMAP4rev1 (\fIfetchmail\fR autodetects their capabilities)
-with RFC 2195 CRAM-MD5 authentication.
-.IP IMAP-LOGIN
-IMAP4, or IMAP4rev1 (\fIfetchmail\fR autodetects their capabilities)
-with plain LOGIN authentication only, even if the server supports
-better methods.
.IP ETRN
Use the ESMTP ETRN option.
+.IP ODMR
+Use the the On-Demand Mail Relay ESMTP profile.
.RE
.P
All these alternatives work in basically the same way (communicating
with standard server daemons to fetch mail already delivered to a
-mailbox on the server) except ETRN. The ETRN mode allows you to ask a
-compliant ESMTP server (such as BSD sendmail at release 8.8.0 or
-higher) to immediately open a sender-SMTP connection to your
-client machine and begin forwarding any items addressed to your client
-machine in the server's queue of undelivered mail.
+mailbox on the server) except ETRN and ODMR. The ETRN mode
+allows you to ask a compliant ESMTP server (such as BSD sendmail at
+release 8.8.0 or higher) to immediately open a sender-SMTP connection
+to your client machine and begin forwarding any items addressed to
+your client machine in the server's queue of undelivered mail. The
+ODMR mode requires an ODMR-capable server and works similarly to
+ETRN, except that it does not require the client machine to have
+a static DNS.
.TP
.B \-U, --uidl
(Keyword: uidl)
The port option permits you to specify a TCP/IP port to connect on.
This option will seldom be necessary as all the supported protocols have
well-established default port numbers.
+.TP
+.B \--principal <principal>
+(Keyword: principal)
+The principal option permits you to specify a service principal for
+mutual authentication. This is applicable to POP3 or IMAP with Kerberos
+authentication.
.TP
.B \-t, --timeout <seconds>
(Keyword: timeout)
the calkling user will be notified by email if this happens.
.TP
.B \--plugin <command>
-(Keyword: plugin)
-The plugin option allows you to use an external program to establish the
-TCP connection. This is useful if you want to use socks or need some
-special firewalling setup. The program will be looked up in $PATH and
-it will be passed two arguments: the name of the server and the name of
-the port. Fetchmail will write to the plugin's stdin and read from
-the plugin's stdout.
+(Keyword: plugin) The plugin option allows you to use an external
+program to establish the TCP connection. This is useful if you want
+to use socks, SSL, ssh, or need some special firewalling setup. The
+program will be looked up in $PATH and can optionally be passed the
+hostname and port as arguments using "%h" and "%p" respectively (note
+that the interpolation logic is rather primitive, and these token must
+be bounded by whitespace or beginning of string or end of string).
+Fetchmail will write to the plugin's stdin and read from the plugin's
+stdout.
.TP
.B \--plugout <command>
(Keyword: plugout)
Causes a specified non-default mail folder on the mailserver (or
comma-separated list of folders) to be retrieved. The syntax of the
folder name is server-dependent. This option is not available under
-POP3 or ETRN.
+POP3, ETRN, or ODMR.
+.TP
+.B \--tracepolls
+(Keyword: tracepolls)
+Tell fetchail to poll trace information in the form `polling %s
+account %s' to the Received line it generates, where the %s parts are
+replaced by the user's remote name and the poll label (the Received
+header also normally includes the server's truename). This can be
+used to facilate mail filtering based on the account it is being
+received from.
.TP
.B \--ssl
(Keyword: ssl)
by SSL. SSL support must be present at the server. If no port is
specified, the connection is attempted to the well known port of the SSL
version of the base protocol. This is generally a different port than the
-port used by the base protocol. For imap, this is port 143 for the clear
+port used by the base protocol. For IMAP, this is port 143 for the clear
protocol and port 993 for the SSL secured protocol.
.TP
.B \--sslcert <name>
recommended. If a password is required to unlock the key, it will be
prompted for at the time just prior to establishing the session to the
server. This can cause some complications in daemon mode.
+.TP
+.B \--sslproto <name>
+(Keyword: sslproto)
+Forces an ssl protocol. Possible values are \&`\fBssl2\fR', `\fBssl3\fR' and
+`\fBtls1\fR'. Try this if the default handshake does not work for your server.
+.TP
+.B \--sslcertck
+(Keyword: sslcertck)
+Causes fetchmail to strictly check the server certificate against a set of
+local trusted certificates (see the \fBsslcertpath\fR option). If the server
+certificate is not signed by one of the trusted ones (directly or indirectly),
+the SSL connection will fail. This checking should prevent man-in-the-middle
+attacks against the SSL connection. Note that CRLs are seemingly not currently
+supported by OpenSSL in certificate verification! Your system clock should
+be reasonably accurate when using this option!
+.TP
+.B \--sslcertpath <directory>
+(Keyword: sslcertpath)
+Sets the directory fetchmail uses to look up local certificates. The default
+is your OpenSSL default one. The directory must be hashed as OpenSSL expects
+it - every time you add or modify a certificate in the directory, you need
+to use the \fBc_rehash\fR tool (which comes with OpenSSL in the tools/
+subdirectory).
+.TP
+.B \--sslfingerprint
+(Keyword: sslfingerprint)
+Specify the fingerprint of the server key (an MD5 hash of the key) in
+hexadecimal notation with colons separating groups of two digits. The letter
+hex digits must be in upper case. This is the default format OpenSSL uses,
+and the one fetchmail uses to report the fingerprint when an SSL connection
+is established. When this is specified, fetchmail will compare the server key
+fingerprint with the given one, and the connection will fail if they do not
+match. This can be used to prevent man-in-the-middle attacks.
.SS Delivery Control Options
.TP
.B \-S <hosts>, --smtphost <hosts>
(Keyword: smtp[host])
Specify a hunt list of hosts to forward mail to (one or more
-hostnames, comma-separated). In ETRN mode, set the host that the
-mailserver is asked to ship mail to. Hosts are tried in list order;
-the first one that is up becomes the forwarding or ETRN target for the
-current run. Normally, `localhost' is added to the end of the list as
-an invisible default. However, when using ETRN mode or Kerberos
-preauthentication, the FQDN of the machine running fetchmail is added to
-the end of the list as an invisible default. Each hostname may have a
-port number following the host name. The port number is separated from
-the host name by a slash; the default port is 25 (or ``smtp'' under IPv6).
-Example:
+hostnames, comma-separated). Hosts are tried in list order; the first
+one that is up becomes the forwarding target for the current run.
+Normally, `localhost' is added to the end of the list as an invisible
+default. However, when using Kerberos authentication, the FQDN of the
+machine running fetchmail is added to the end of the list as an
+invisible default. Each hostname may have a port number following the
+host name. The port number is separated from the host name by a
+slash; the default port is 25 (or ``smtp'' under IPv6). If you
+specify an absolute pathname (beginning with a /), it will be
+interpreted as the name of a UNIX socket accepting LMTP connections
+(such as is supported by the Cyrus IMAP daemon) Example:
- --smtphost server1,server2/2525,server3
+ --smtphost server1,server2/2525,server3,/var/imap/socket/lmtp
+This option can be used with ODMR, and will make fetchmail a relay
+between the ODMR server and and SMTP or LMTP receiver.
+.TP
+.B --fetchdomains <hosts>
+(Keyword: fetchdomains)
+In ETRN or ODMR mode, this option specifies the list of domains the
+server should ship mail for once the connection is turned around. The
+default is the FQDN of the machine running fetchmail.
.TP
.B \-D <domain>, --smtpaddress <domain>
-(Keyword: smtpaddress)
-Specify the domain to be put in RCPT TO lines shipped to SMTP. The
-name of the SMTP server (as specified by --smtphost, or defaulted to
-"localhost") is used when this is not specified.
+(Keyword: smtpaddress) Specify the domain to be appended to addresses
+in RCPT TO lines shipped to SMTP. The name of the SMTP server (as
+specified by --smtphost, or defaulted to "localhost") is used when
+this is not specified.
+.TP
+.B --smtpname <user@domain>
+(Keyword: smtpname)
+Specify the domain and user to be put in RCPT TO lines shipped to SMTP.
+The default user is the current local user.
.TP
.B \-Z <nnn>, --antispam <nnn[, nnn]...>
(Keyword: antispam)
.B \-m <command>, \--mda <command>
(Keyword: mda)
You can force mail to be passed to an MDA directly (rather than
-forwarded to port 25) with the -mda or -m option. Be aware that this
-disables some valuable resource-exhaustion checks and error handling
-provided by SMTP listeners; it's not a good idea unless running an
-SMTP listener is impossible. If \fIfetchmail\fR is running as root,
-it sets its userid to that of the target user while delivering mail
-through an MDA. Some possible MDAs are "/usr/sbin/sendmail -oem -f %F
-%T", "/usr/bin/deliver" and "/usr/bin/procmail -d %T" (but the latter
-is usually redundant as it's what SMTP listeners usually forward
-to). Local delivery addresses will be inserted into the MDA command
-wherever you place a %T; the mail message's From address will be
-inserted where you place an %F. Do \fInot\fR use an MDA invocation
-like "sendmail -oem -t" that dispatches on the contents of To/Cc/Bcc,
-it will create mail loops and bring the just wrath of many postmasters
-down upon your head.
+forwarded to port 25) with the -mda or -m option. To avoid losing
+mail, use this option only with MDAs like procmail or sendmail that
+return a nonzero status on disk-full and other resource-exhaustion
+errors; the nonzero status tells fetchmail that delivery failed and
+prevents the message from being deleted off the server. If
+\fIfetchmail\fR is running as root, it sets its userid to that of the
+target user while delivering mail through an MDA. Some possible MDAs
+are "/usr/sbin/sendmail -oem -f %F %T", "/usr/bin/deliver" and
+"/usr/bin/procmail -d %T" (but the latter is usually redundant as it's
+what SMTP listeners normally forward to). Local delivery addresses
+will be inserted into the MDA command wherever you place a %T; the
+mail message's From address will be inserted where you place an %F.
+Do \fInot\fR use an MDA invocation like "sendmail -oem -t" that
+dispatches on the contents of To/Cc/Bcc, it will create mail loops and
+bring the just wrath of many postmasters down upon your head.
.TP
.B \--lmtp
(Keyword: lmtp)
Cause delivery via LMTP (Local Mail Transfer Protocol). A service
port \fImust\fR be explicitly specified (with a slash suffix) on each
-host in the smtphost hunt list) if this option is selected; the
+host in the smtphost hunt list if this option is selected; the
default port 25 will (in accordance with RFC 2033) not be accepted.
.TP
.B \--bsmtp <filename>
.B \-l <maxbytes>, --limit <maxbytes>
(Keyword: limit)
Takes a maximum octet size argument. Messages larger than this size
-will not be fetched, not be marked seen, and will be left on the
-server (in foreground sessions, the progress messages will note that
-they are "oversized"). An explicit --limit of 0 overrides any limits
-set in your run control file. This option is intended for those
-needing to strictly control fetch time due to expensive and variable
-phone rates. In daemon mode, oversize notifications are mailed to the
-calling user (see the --warnings option). This option does not work
-with ETRN.
+will not be fetched and will be left on the server (in foreground
+sessions, the progress messages will note that they are "oversized").
+If the fetch protocol permits (in particular, under IMAP or POP3
+without the fetchall option) the message will not be marked seen An
+explicit --limit of 0 overrides any limits set in your run control
+file. This option is intended for those needing to strictly control
+fetch time due to expensive and variable phone rates. In daemon mode,
+oversize notifications are mailed to the calling user (see the
+--warnings option). This option does not work with ETRN or ODMR.
.TP
.B \-w <interval>, --warnings <interval>
(Keyword: warnings)
after receiving the message terminator, some SMTP listeners are not so
prompt. MTAs like \fIqmail\fR(8) and \fIsmail\fR(8) may wait till the
delivery socket is shut down to deliver. This may produce annoying
-delays when
-.I fetchmail
-is processing very large batches. Setting the batch limit to some
-nonzero size will prevent these delays.
-This option does not work with ETRN.
+delays when \fIfetchmail\fR is processing very large batches. Setting
+the batch limit to some nonzero size will prevent these delays. This
+option does not work with ETRN or ODMR.
.TP
.B -B <number>, --fetchlimit <number>
(Keyword: fetchlimit)
Limit the number of messages accepted from a given server in a single
poll. By default there is no limit. An explicit --fetchlimit of 0
overrides any limits set in your run control file.
-This option does not work with ETRN.
+This option does not work with ETRN or ODMR.
.TP
.B -e <count>, --expunge <count>
(keyword: expunge)
.I fetchmail
to only issue expunges on every Nth delete. An argument of zero
suppresses expunges entirely (so no expunges at all will be done until
-the end of run). This option does not work with ETRN.
+the end of run). This option does not work with ETRN or ODMR.
.SS Authentication Options
.TP
.B \-u <name>, --username <name>
.B \-I <specification>, --interface <specification>
(Keyword: interface)
Require that a specific interface device be up and have a specific local
-IP address (or range) before polling. Frequently
+or remote IP address (or range) before polling. Frequently
.I fetchmail
is used over a transient point-to-point TCP/IP link established directly
to a mailserver via SLIP or PPP. That is a relatively secure channel.
.I only
when interface data is being collected.
.TP
-.B --preauth <type>
-(Keyword: preauth[enticate])
-This option permits you to specify a preauthentication type (see USER
-AUTHENTICATION below for details). The possible values are
+.B --auth <type>
+(Keyword: auth[enticate])
+This option permits you to specify an authentication type (see USER
+AUTHENTICATION below for details). The possible values are \fBany\fR,
\&`\fBpassword\fR', `\fBkerberos_v5\fR' and `\fBkerberos\fR' (or, for
-excruciating exactness, `\fBkerberos_v4\fR'), and \fBssh\fR. Use
-\fBssh\fR to suppress fetchmail's normal inquiry for a password when
-you are using an end-to-end secure connection such as an ssh tunnel.
-Other values of this option are provided primarily for developers;
-choosing KPOP protocol automatically selects Kerberos
-preauthentication, and all other alternatives use password
-authentication (though APOP uses a generated one-time key as the
-password and IMAP-K4 uses RFC1731 Kerberos v4 authentication). This
-option does not work with ETRN.
+excruciating exactness, `\fBkerberos_v4\fR'), \fRgssapi\fR,
+\fIcram-md5\fR, \fIotp\fR, \fIntlm\fR, and \fBssh\fR. When \fBany\fR (the
+default) is specified, fetchmail tries first methods that don't
+require a password (GSSAPI, KERBEROS_IV); then it looks for methods
+that mask your password (CRAM-MD5, X-OTP, NTLM); and only if the server
+doesn't support any of those will it ship your password en clair.
+Other values may be used to force various authentication methods
+(\fBssh\fR suppresses authentication). Any value other than
+\fIpassword\fR, \fIcram-md5\fR, \fIntlm\fR or \fIotp\fR suppresses fetchmail's
+normal inquiry for a password. Specify \fIssh\fR when you are using
+an end-to-end secure connection such as an ssh tunnel; specify
+\fRgssapi\fR or \fBkerberos_v4\fR if you are using a protocol variant
+that employs GSSAPI or K4. Choosing KPOP protocol automatically
+selects Kerberos authentication. This option does not work with ETRN.
.SS Miscellaneous Options
.TP
.B \-f <pathname>, --fetchmailrc <pathname>
provided to pacify people who are paranoid about having an MTA edit
mail headers and want to know they can prevent it, but it is generally
not a good idea to actually turn off rewrite.)
-When using ETRN, the rewrite option is ineffective.
+When using ETRN or ODMR, the rewrite option is ineffective.
.TP
.B -E <line>, --envelope <line>
(Keyword: envelope)
qmail to batch mail for a disconnected site the ISP-mailhost will have
normally put that site in its `Virtualhosts' control file so it will
add a prefix to all mail addresses for this site. This results in mail
-sent to 'username@userhost.userdom.dom.com' having a
+.\" The \&@\& tries to stop HTML converters from making a mailto URL here.
+sent to 'username\&@\&userhost.userdom.dom.com' having a
\&`Delivered-To:' line of the form:
.sp
-Delivered-To: mbox-userstr-username@userhost.userdom.dom.com
+Delivered-To: mbox-userstr-username\&@\&userhost.userdom.dom.com
.sp
The ISP can make the 'mbox-userstr-' prefix anything they choose
but a string matching the user host name is likely.
written in Python.
.SH USER AUTHENTICATION AND ENCRYPTION
-Every mode except ETRN requires authentication of the client.
+All modes except ETRN require authentication of the client.
Normal user authentication in
.I fetchmail
is very much like the authentication mechanism of
checking its authorization database.
.PP
If your \fIfetchmail\fR was built with Kerberos support and you specify
-Kerberos preauthentication (either with --auth or the \fI.fetchmailrc\fR
+Kerberos authentication (either with --auth or the \fI.fetchmailrc\fR
option \fBauthenticate kerberos_v4\fR) it will try to get a Kerberos
ticket from the mailserver at the start of each query. Note: if
either the pollnane or via name is `hesiod', fetchmail will try to use
Hesiod to look up the mailserver.
.PP
-If you use IMAP-K4, \fIfetchmail\fR will expect the IMAP server to have
-RFC1731-conformant AUTHENTICATE KERBEROS_V4 capability, and will use it.
-.PP
-If you use IMAP-GSS, \fIfetchmail\fR will expect the IMAP server to have
-RFC1731-conformant AUTHENTICATE GSSAPI capability, and will use it.
-Currently this has only been tested over Kerberos V, so you're expected
-to already have a ticket-granting ticket. You may pass a username different
-from your principal name using the standard \fB--user\fR command or by
-the \fI.fetchmailrc\fR option \fBuser\fR.
+If you use POP3 or IMAP with GSSAPI authentication, \fIfetchmail\fR will
+expect the server to have RFC1731- or RFC1734-conformant GSSAPI
+capability, and will use it. Currently this has only been tested over
+Kerberos V, so you're expected to already have a ticket-granting
+ticket. You may pass a username different from your principal name
+using the standard \fB--user\fR command or by the \fI.fetchmailrc\fR
+option \fBuser\fR.
.PP
If your IMAP daemon returns the PREAUTH response in its greeting line,
fetchmail will notice this and skip the normal authentication step.
-This could be useful, e.g. if you start imapd explicitly using ssh.
-In this case you can declare the preauthentication value `ssh' on that
+This can be useful, e.g. if you start imapd explicitly using ssh.
+In this case you can declare the authentication value `ssh' on that
site entry to stop \fI.fetchmail\fR from asking you for a password
when it starts up.
.PP
authentication instead of sending over the password en clair if it
detects "@compuserve.com" in the hostname.
.PP
-Microsoft's NTLM authentication (used by Microsoft Exchange) is
-supported. If you compile in the support, \fIfetchmail\fR will try to
-perform an NTLM authentication (instead of sending over the
+If you are using IMAP, Microsoft's NTLM authentication (used by Microsoft
+Exchange) is supported. If you compile in the support, \fIfetchmail\fR
+will try to perform an NTLM authentication (instead of sending over the
password en clair) whenever the server returns AUTH=NTLM in its
-capability response. Note: if you specify a user option value
-that looks like `user@domain', the part to the left of the @ will
-be passed as the username and the part to the right as the NTLM domain.
+capability response. Specify a user option value that looks like
+`user@domain': the part to the left of the @ will be passed as the
+username and the part to the right as the NTLM domain.
.PP
If you are using IPsec, the -T (--netsec) option can be used to pass
an IP security request to be used when outgoing IP connections are
by a recognized Certifying Authority. The format for the key files and
the certificate files is that required by the underlying SSL libraries
(OpenSSL in the general case).
+.PP
+Finally, a word of care about the use of SSL: While above mentioned
+setup with self-signed server certificates retrieved over the wires
+can protect you from a passive eavesdropper it doesn't help against an
+active attacker. It's clearly an improvement over sending the
+passwords in clear but you should be aware that a man-in-the-middle
+attack is trivially possible (in particular with tools such as dsniff,
+http://www.monkey.org/~dugsong/dsniff/). Use of an ssh tunnel (see
+below for some examples) is preferable if you care seriously about the
+security of your mailbox.
.SH DAEMON MODE
The
which multidrop mail is to be forwarded if no matching local recipient
can be found. Normally this is just the user who invoked fetchmail.
If the invoking user is root, then the default of this option is
-the user `postmaster'.
+the user `postmaster'. Setting postmaster to the empty string causes
+such mail to be discarded.
.PP
The
.B --nobounce
is on, the Received header is suppressed and fetchmail tries to spoof
the MTA it forwards to into thinking it came directly from the
mailserver host.
+.PP
+The
+.B --showdots
+option (keyword: set showdots) forces fetchmail to show progress dots
+even if the current tty is not stdout (for example logfiles).
+Starting with fetchmail version 5.3.0,
+progress dots are only shown on stdout by default.
+.PP
+By specifying the
+.B --tracepolls
+option, you can ask fetchmail to add information to the Received
+header on the form "polling {label} account {user}", where {label} is
+the account label (from the specified rcfile, normally ~/.fetchmailrc)
+and {user} is the username which is used to log on to the mail
+server. This header can be used to make filtering email where no
+useful header information is available and you want mail from
+different accounts sorted into different mailboxes (this could, for
+example, occur if you have an account on the same server running a
+mailing list, and are subscribed to the list using that account). The
+default is not adding any such header. In
+.IR .fetchmailrc ,
+this is called `tracepolls'.
.SH RETRIEVAL FAILURE MODES
The protocols \fIfetchmail\fR uses to talk to mailservers are next to
bulletproof. In normal operation forwarding to port 25, no message is
ever deleted (or even marked for deletion) on the host until the SMTP
-listener on the client has acknowledged to \fIfetchmail\fR that the
-message has been accepted for delivery or rejected due to a apam
-block. When forwarding to an MDA, however, there is more possibility
-of error (because there's no way for fetchmail to get a reliable
-positive acknowledgement from the MDA).
+listener on the client side has acknowledged to \fIfetchmail\fR that
+the message has been either accepted for delivery or rejected due to a
+spam block.
+.PP
+When forwarding to an MDA, however, there is more possibility
+of error. Some MDAs are `safe' and reliably return a nonzero status
+on any delivery error, even one due to temporary resource limits.
+The well-known
+.IR procmail (1)
+program is like this; so are most programs designed as mail transport
+agents, such as
+.IR sendmail (1),
+and
+.IR exim (1).
+These programs give back a reliable positive acknowledgement and
+can be used with the mda option with no risk of mail loss. Unsafe
+MDAs, though, may return 0 even on delivery failure. If this
+happens, you will lose mail.
.PP
The normal mode of \fIfetchmail\fR is to try to download only `new'
messages, leaving untouched (and undeleted) messages you have already
the server. In this (unlikely) case, only messages you fetched with
\fIfetchmail --keep\fR will be both undeleted and marked old.
.PP
-In ETRN mode, \fIfetchmail\fR does not actually retrieve messages;
+In ETRN and ODMR modes, \fIfetchmail\fR does not actually retrieve messages;
instead, it asks the server's SMTP listener to start a queue flush
to the client via SMTP. Therefore it sends only undelivered messages.
without reading the message body. Thus, you won't pay for downloading
spam message bodies.
.PP
-Mail that is spam-blocked triggers an RFC1892 bounce message informing
-the originator that we do not accept mail from it.
+If the \fIspambounce\fR option is on, mail that is spam-blocked
+triggers an RFC1892 bounce message informing the originator that we do
+not accept mail from it.
.SH SMTP/ESMTP ERROR HANDLING
-Besides the spam-blocking described above,fetchmail takes special
+Besides the spam-blocking described above, fetchmail takes special
actions on the following SMTP/ESMTP error responses
.TP 5
452 (insufficient system storage)
set no bouncemail \& T{
Direct error mail to postmaster rather than sender
T}
+set no spambounce \& T{
+Send spam bounces
+T}
set logfile \& T{
Name of a file to dump error and status messages to
T}
T}
proto[col] -p T{
Specify protocol (case insensitive):
-POP2, POP3, IMAP, IMAP-K4, IMAP-GSS, APOP, KPOP
+POP2, POP3, IMAP, APOP, KPOP
+T}
+local[domains] \& T{
+Specify domain(s) to be regarded as local
T}
port -P T{
Specify TCP/IP service port
T}
-auth[enticate] -A T{
-Set preauthentication type (default `password')
+auth[enticate] \& T{
+Set authentication type (default `password')
T}
timeout -t T{
Server inactivity timeout in seconds (default 300)
interval \& T{
Only check this site every N poll cycles; N is a numeric argument.
T}
+netsec \& T{
+Pass in IPsec security option request.
+T}
+principal \& T{
+Set Kerberos principal (only useful with imap and kerberos)
+T}
.TE
Here are the legal user options:
sslkey T{
Specify file for client side private SSL key
T}
+sslproto T{
+Force ssl protocol for connection
+T}
folder -r T{
Specify remote folder to query
T}
smtphost -S T{
Specify smtp host(s) to forward to
T}
+fetchdomains \& T{
+Specify domains for which mail should be fetched
+T}
smtpaddress -D T{
Specify the domain to be put in RCPT TO lines
T}
+smtpname T{
+Specify the user and domain to be put in RCPT TO lines
+T}
antispam -Z T{
Specify what SMTP returns are interpreted as spam-policy blocks
T}
dropstatus \& T{
Strip Status and X-Mozilla-Status lines out of incoming mail
T}
+dropdelivered \& T{
+Strip Delivered-To lines out of incoming mail
+T}
mimedecode \& T{
Convert quoted-printable to 8-bit in MIME messages
T}
no dropstatus \& T{
Don't drop Status headers (default)
T}
+no dropdelivered \& T{
+Don't drop Delivered-To headers (default)
+T}
no mimedecode \& T{
Don't convert quoted-printable to 8-bit in MIME messages (default)
T}
Max # messages to fetch in single connect
T}
expunge -e T{
-Perform an expunge on every #th message (IMAP only)
+Perform an expunge on every #th message (IMAP and POP3 only)
+T}
+tracepolls \& T{
+Add poll tracing information to the Received header
T}
properties \& T{
String value is ignored by fetchmail (may be used by extension scripts)
the following: `via', `interval', `aka', `is', `to', `dns'/`no dns',
`checkalias'/`no checkalias', `password', `preconnect', `postconnect',
`localdomains', `stripcr'/`no stripcr', `forcecr'/`no forcecr',
-`pass8bits'/`no pass8bits' `dropstatus/no dropstatus', `mimedecode/no
-mimedecode', `idle/no idle', and `no envelope'.
+`pass8bits'/`no pass8bits' `dropstatus/no dropstatus',
+`dropdelivered/no dropdelivered', `mimedecode/no mimedecode', `idle/no
+idle', and `no envelope'.
.PP
-The `via' option is for use with ssh, or if you want to have more
+The `via' option is for if you want to have more
than one configuration pointing at the same site. If it is present,
the string argument will be taken as the actual DNS name of the
mailserver host to query.
This will override the argument of poll, which can then simply be a
distinct label for the configuration (e.g. what you would give on the
command line to explicitly query this host).
-If the `via' name is `localhost', the poll name will also still be
-used as a possible match in multidrop mode; otherwise the `via' name
-will be used instead and the poll name will be purely a label.
.PP
The `interval' option (which takes a numeric argument) allows you to poll a
server less frequently than the basic poll interval. If you say
Status line in it has been seen. (Note: the empty Status lines
inserted by some buggy POP servers are unconditionally discarded.)
.PP
+The `dropdelivered' option controls wether Delivered-To headers will
+be kept in fetched mail (the default) or discarded. These headers are
+added by Qmail and Postfix mailservers in order to avoid mail loops but
+may get in your way if you try to "mirror" a mailserver within the same
+domain. Use with caution.
+.PP
The `mimedecode' option controls whether MIME messages using the
quoted-printable encoding are automatically converted into pure 8-bit
data. If you are delivering mail to an ESMTP-capable, 8-bit-clean
open and notify the client when new mail is available. If you need to
poll a link frequently, IDLE can save bandwidth by eliminating TCP/IP
connects and LOGIN/LOGOUT sequences. On the other hand, an IDLE
-connection will eat almost akll of your fetchmail's time, because it
+connection will eat almost all of your fetchmail's time, because it
will never drop the connection and allow other pools to occur unless
-the server times out the IDLE.
+the server times out the IDLE. It also doesn't work with multiple
+folders; only the first folder will ever be polled.
.PP
The `properties' option is an extension mechanism. It takes a string
argument, which is ignored by fetchmail itself. The string argument may be
pop3 (or POP3)
sdps (or SDPS)
imap (or IMAP)
- imap-k4 (or IMAP-K4)
- imap-gss (or IMAP-GSS)
- imap-crammd5 (or IMAP-CRAMMD5)
- imap-login (or IMAP-LOGIN)
apop (or APOP)
kpop (or KPOP)
.PP
-Legal authentication types are `password' or `kerberos'. The former
-specifies authentication by normal transmission of a password (the
-password may be plaintext or subject to protocol-specific encryption
-as in APOP); the second tells \fIfetchmail\fR to try to get a Kerberos
-ticket at the start of each query instead, and send an arbitrary
-string as the password.
+Legal authentication types are `any', `password', `kerberos', 'kereberos_v5'
+and `gssapi', `cram-md5', `otp', `ntlm', `ssh`.
+The `password' type specifies authentication by normal transmission of a
+password (the password may be plaintext or subject to
+protocol-specific encryption as in APOP); `kerberos' tells
+\fIfetchmail\fR to try to get a Kerberos ticket at the start of each
+query instead, and send an arbitrary string as the password; and
+`gssapi' tells fetchmail to use GSSAPI authentication. See the description
+of the `auth' keyword for more.
.PP
Specifying `kpop' sets POP3 protocol over port 1109 with Kerberos V4
-preauthentication. These defaults may be overridden by later options.
+authentication. These defaults may be overridden by later options.
.PP
There are currently four global option statements; `set logfile'
followed by a string sets the same global specified by --logfile. A
fetchmail looks through headers in the following order:
Return-Path:
- Resent-Sender:
- Sender:
+ Resent-Sender: (ignored if it doesn't contain an @ or !)
+ Sender: (ignored if it doesn't contain an @ or !)
Resent-From:
From:
Reply-To:
copy of the mail).
.SH CONFIGURATION EXAMPLES
+Note that although there are password declarations in a good many
+of the examples below, this is mainly for illustrative purposes.
+We recommend stashing account/password pairs in your $HOME/.netrc
+file, where they can be used not just by fetchmail but by ftp(1) and
+other programs.
+
Basic format is:
.nf
.nf
poll pop.provider.net proto pop3 port 3111
user "jsmith" with pass "secret1" is "smith" here
- user jones with pass "secret2" is "jjones" here
+ user jones with pass "secret2" is "jjones" here keep
.fi
This associates the local username `smith' with the pop.provider.net
username `jsmith' and the local username `jjones' with the
-pop.provider.net username `jones'.
+pop.provider.net username `jones'. Mail for `jones' is kept on the
+server after download.
.PP
Here's what a simple retrieval configuration for a multi-drop mailbox
looks like:
.nf
poll pop.provider.net:
- user maildrop with pass secret1 to golux hurkle=happy snark here
+ user maildrop with pass secret1 to golux 'hurkle'='happy' snark here
.fi
This says that the mailbox of account `maildrop' on the server is a
.nf
poll pop.provider.net localdomains loonytoons.org toons.org:
- user maildrop with pass secret1 to esr * here
+ user maildrop with pass secret1 to 'esr' * here
.fi
This also says that the mailbox of account `maildrop' on the server is
`joe@daffy.loonytoons.org') should be passed through to the local SMTP
listener without modification. Be careful of mail loops if you do this!
.PP
-Here's an example configuration using ssh. The queries go through an
-ssh connecting local port 1234 to port 110 on mailhost.net; the
-preconnect command sets up the ssh.
+Here's an example configuration using ssh and the plugin option. The
+queries are made directly on the stdin and stdout of imapd via ssh.
+Note that in this setup, IMAP authentication can be skipped.
.nf
-poll mailhost.net via localhost port 1234 with proto pop3:
- preconnect "ssh -f -L 1234:mailhost.net:110
- mailhost.net sleep 20 </dev/null >/dev/null";
+poll mailhost.net with proto imap:
+ plugin "ssh %h /usr/sbin/imapd" auth ssh;
+ user esr is esr here
.fi
.SH THE USE AND ABUSE OF MULTIDROP MAILBOXES
Use the multiple-local-recipients feature with caution -- it can bite.
-Also note that all multidrop features are ineffective in ETRN mode.
+All multidrop features are ineffective in ETRN and ODMR modes.
Also, note that in multidrop mode duplicate mails are suppressed. A
piece of mail is considered duplicate if it has the same message-ID as
to retrieve mail for multiple users from a single mail drop via POP or
IMAP, think again (and reread the section on header and envelope
addresses above). It would be smarter to just let the mail sit in the
-mailserver's queue and use fetchmail's ETRN mode to trigger SMTP sends
-periodically (of course, this means you have to poll more frequently
-than the mailserver's expiry period). If you can't arrange this, try
-setting up a UUCP feed.
+mailserver's queue and use fetchmail's ETRN or ODMR modes to trigger
+SMTP sends periodically (of course, this means you have to poll more
+frequently than the mailserver's expiry period). If you can't arrange
+this, try setting up a UUCP feed.
.PP
If you absolutely \fImust\fR use multidrop for this purpose, make sure
your mailserver writes an envelope-address header that fetchmail can
to haunt you.
.SS Speeding Up Multidrop Checking
-Normally, when multiple user are declared
+Normally, when multiple users are declared
.I fetchmail
extracts recipient addresses as described above and checks each host
part with DNS to see if it's an alias of the mailserver. If so, the
.IP 2
An error was encountered when attempting to open a socket to retrieve
mail. If you don't know what a socket is, don't worry about it --
-just treat this as an 'unrecoverable error'.
+just treat this as an 'unrecoverable error'. This error can also be
+because a protocol fetchmail wants to use is not listed in /etc/services.
.IP 3
The user authentication step failed. This usually means that a bad
user-id, password, or APOP id was specified. Or it may mean that you
BSMTP batch file could not be opened.
.IP 13
Poll terminated by a fetch limit (see the --fetchlimit option).
+.IP 14
+Server busy indication.
.IP 23
Internal error. You should see a message on standard error with
details.
successfully retrieved mail. Otherwise the returned error status is
that of the last host queried.
-.SH AUTHOR
-Eric S. Raymond <esr@snark.thyrsus.com>. Too many other people to
-name here have contributed code and patches.
-This program is descended from and replaces
-.IR popclient ,
-by Carl Harris <ceharris@mal.com>; the internals have become quite different,
-but some of its interface design is directly traceable to that
-ancestral program.
-
.SH FILES
.TP 5
~/.fetchmailrc
(used only with newer RFC1725-compliant POP3 servers supporting the
UIDL command).
.TP 5
+~/.fetchmail.pid
+lock file to help prevent concurrent runs (non-root mode).
+.TP 5
~/.netrc
your FTP run control file, which (if present) will be searched for
passwords as a last resort before prompting for one interactively.
.TP 5
-~/.fetchmail.pid
-lock file to help prevent concurrent runs (non-root mode).
-.TP 5
/var/run/fetchmail.pid
lock file to help prevent concurrent runs (root mode, Linux systems).
.TP 5
lock file to help prevent concurrent runs (root mode, systems without /var/run).
.SH ENVIRONMENT
-If either the LOGNAME or USER and the variable is correctly set
-(e.g. the corresponding UID matches the session user ID) then that
-name is used as the default local name. Otherwise \fBgetpwuid\fR(3)
-must be able to retrieve a password entry for the session ID (this
-elaborate logic is designed to handle the case of multiple names per
-userid gracefully).
+If the FETCHMAILUSER variable is set, it is used as the name of the
+calling user (default local name) for purposes such as mailing error
+notifications. Otherwise, if either the LOGNAME or USER variable is
+correctly set (e.g. the corresponding UID matches the session user ID)
+then that name is used as the default local name. Otherwise
+\fBgetpwuid\fR(3) must be able to retrieve a password entry for the
+session ID (this elaborate logic is designed to handle the case of
+multiple names per userid gracefully).
+
+If the environment variable FETCHMAILHOME is set to a valid and
+existing directory name, the .fetchmailrc and .fetchids and
+\&.fetchmail.pid files are put there instead of in the invoking user's
+home directory (and lose the leading dots on theirt names). The
+\&.netrc file is looked for in the the invoking user's home directory
+regardless of FETCHMAILHOME's setting.
.SH SIGNALS
If a
whichever of these is appropriate to wake it up.
.SH BUGS AND KNOWN PROBLEMS
+The mda and plugin options interact badly. In order to collect error
+status from the MDA, fetchmail has to change its normal signal
+handling so that dead plugin processes don't get reaped until the end
+of the poll cycle. This can cause resource starvation if too many
+zombies accumulate. So either don't deliver to a MDA using plugins or
+risk being overrun by an army of undead.
+.PP
The RFC822 address parser used in multidrop mode chokes on some
@-addresses that are technically legal but bizarre. Strange uses of
quoting and embedded comments are likely to confuse it.
headers into a single one (procmail, mailagent, or maildrop can be
programmed to do this fairly easily).
.PP
-Use of any of the supported protocols other than POP3 with OTP or RPA,
-APOP, KPOP, IMAP-K4, IMAP-GSS, IMAP-CRAMMD5, or ETRN requires that the
-program send unencrypted passwords over the TCP/IP connection to the
-mailserver. This creates a risk that name/password pairs might be
-snaffled with a packet sniffer or more sophisticated monitoring
-software. Under Linux and FreeBSD, the --interface option can be used
-to restrict polling to availability of a specific interface device
-with a specific local IP address, but snooping is still possible if
-(a) either host has a network device that can be opened in promiscuous
-mode, or (b) the intervening network link can be tapped.
+Use of some of these protocols requires that the program send
+unencrypted passwords over the TCP/IP connection to the mailserver.
+This creates a risk that name/password pairs might be snaffled with a
+packet sniffer or more sophisticated monitoring software. Under Linux
+and FreeBSD, the --interface option can be used to restrict polling to
+availability of a specific interface device with a specific local or
+remote IP address, but snooping is still possible if (a) either host
+has a network device that can be opened in promiscuous mode, or (b)
+the intervening network link can be tapped. We recommend the use of
+.IR ssh (1)
+tunnelling to not only shroud your passwords but encrypt the entire
+conversation.
.PP
Use of the %F or %T escapes in an mda option could open a security
hole, because they pass text manipulable by an attacker to a shell
MDA. For maximum safety, however, don't use an mda command containing
%F or %T when fetchmail is run from the root account itself.
.PP
-Fetchmail's method of sending bouncemail requires that port 25 of localhost
-be available for sending mail via SMTP.
+Fetchmail's method of sending bouncemail and spam bounces requires that
+port 25 of localhost be available for sending mail via SMTP.
.PP
If you modify a
.I .fetchmailrc
background instance will die silently. Unfortunately, it can't
die noisily because we don't yet know whether syslog should be enabled.
.PP
-The RFC 2177 IDLE support is flaky. It sort of works, but may generate
-spurious socket error messages or silently hang in the presence of
-various network or server errors.
+The -f - option (reading a configuration from stdin) is incompatible
+with the plugin option.
+.PP
+The UIDL code is generally flaky and tends to lose its state on errors
+and line drops (so that old messages are re-seen). If this happens to
+you, switch to IMAP4.
+.PP
+The `principal' option only handles Kerberos IV, not V.
.PP
Send comments, bug reports, gripes, and the like to the
-fetchmail-friends list <fetchmail-friends@ccil.org>. An HTML FAQ is
+fetchmail-friends list <fetchmail-friends@lists.ccil.org>. An HTML FAQ is
available at the fetchmail home page; surf to
http://www.tuxedo.org/~esr/fetchmail or do a WWW search for pages with
`fetchmail' in their titles.
+.SH AUTHOR
+Eric S. Raymond <esr@snark.thyrsus.com>. Too many other people to
+name here have contributed code and patches.
+This program is descended from and replaces
+.IR popclient ,
+by Carl Harris <ceharris@mal.com>; the internals have become quite different,
+but some of its interface design is directly traceable to that
+ancestral program.
+
.SH SEE ALSO
-mutt(1), elm(1), mail(1), sendmail(8), popd(8), imapd(8)
+mutt(1), elm(1), mail(1), sendmail(8), popd(8), imapd(8), netrc(5)
.SH APPLICABLE STANDARDS
.TP 5
SMTP/ESMTP:
-RFC 821, RFC 1869, RFC 1652, RFC 1870, RFC1983, RFC 1985
+RFC 821, RFC2821, RFC 1869, RFC 1652, RFC 1870, RFC1983, RFC 1985
.TP 5
mail:
-RFC 822, RFC 1892, RFC 1894
+RFC 822, RFC2822, RFC 1123, RFC 1892, RFC 1894
.TP 5
POP2:
RFC 937
.TP 5
POP3:
-RFC 1081, RFC 1225, RFC 1460, RFC 1725, RFC 1939, RFC 1957, RFC2195, RFC 2449
+RFC 1081, RFC 1225, RFC 1460, RFC 1725, RFC1734, RFC 1939, RFC 1957,
+RFC2195, RFC 2449
.TP 5
APOP:
RFC 1460, RFC 1725, RFC 1939
ETRN:
RFC 1985
.TP 5
+ODMR/ATRN:
+RFC 2645
+.TP 5
OTP:
RFC 1938
.TP 5
LMTP:
RFC 2033
+.TP 5
+GSSAPI:
+RFC 1508
+
projects / ~andy / fetchmail / blobdiff