2 .\" ** The above line should force tbl to be used as a preprocessor **
4 .\" Manual page in man(7) format with tbl(1) macros for fetchmail
6 .\" For license terms, see the file COPYING in this directory.
8 .TH fetchmail 1 "fetchmail 6.3.9" "fetchmail" "fetchmail reference manual"
10 fetchmail \- fetch mail from a POP, IMAP, ETRN, or ODMR-capable server
13 \fBfetchmail\fR [\fIoption...\fR] [\fImailserver...\fR]
19 is a mail-retrieval and forwarding utility; it fetches mail from
20 remote mailservers and forwards it to your local (client) machine's
21 delivery system. You can then handle the retrieved mail using normal
22 mail user agents such as \fImutt\fR(1), \fIelm\fR(1) or \fIMail\fR(1).
23 The \fIfetchmail\fR utility can be run in a daemon mode to repeatedly
24 poll one or more systems at a specified interval.
28 program can gather mail from servers supporting any of the common
29 mail-retrieval protocols: POP2 (legacy, to be removed from future
30 release), POP3, IMAP2bis, IMAP4, and IMAP4rev1.
31 It can also use the ESMTP ETRN extension and ODMR. (The RFCs describing all
32 these protocols are listed at the end of this manual page.)
36 is primarily intended to be used over on-demand TCP/IP links (such as
37 SLIP or PPP connections), it may also be useful as a message transfer
38 agent for sites which refuse for security reasons to permit
39 (sender-initiated) SMTP transactions with sendmail.
43 is used with a POP or an IMAP server, it has two fundamental modes of
44 operation for each user account from which it retrieves mail:
45 \fIsingledrop\fR- and \fImultidrop\fR-mode. In singledrop-mode,
47 assumes that all messages in the user's account are intended for a single
48 recipient. An individual mail message will not be inspected for recipient
49 information, rather, the identity of the recipient will either default to
50 the local user currently executing \fIfetchmail\fR,
51 or else will need to be explicitly specified in the configuration file.
52 Singledrop-mode is used when the fetchmailrc configuration contains at
53 most a single local user specification for a given server account.
57 is not able to assume that there is only a single recipient, but rather
58 that the mail server account actually contains mail intended for any
59 number of different recipients. Therefore,
61 must attempt to deduce the proper "envelope recipient" from the mail
62 headers of each message. In this mode of operation,
64 almost resembles an MTA, however it is important to note that neither
65 the POP nor IMAP protocols were intended for use in this fashion, and
66 hence envelope information is often not directly available. Instead,
68 must resort to a process of informed guess-work in an attempt to
69 discover the true envelope recipient of a message, unless the ISP stores
70 the envelope information in some header (not all do). Even if this
71 information is present in the headers, the process can
72 be error-prone and is dependent upon the specific mail server used
73 for mail retrieval. Multidrop-mode is used when more than one local
74 user is specified for a particular server account in the configuration
75 file. Note that the forgoing discussion of singledrop- and
76 multidrop-modes does not apply to the ESMTP ETRN or ODMR retrieval
77 methods, since they are based upon the SMTP protocol which
78 specifically provides the envelope recipient to \fIfetchmail\fR.
80 As each message is retrieved, \fIfetchmail\fR normally delivers it via SMTP to
81 port 25 on the machine it is running on (localhost), just as though it
82 were being passed in over a normal TCP/IP link. \fIfetchmail\fR provides
83 the SMTP server with an envelope recipient derived in the manner described
84 previously. The mail will then be
85 delivered locally via your system's MDA (Mail Delivery Agent, usually
86 \fIsendmail\fR(8) but your system may use a different one such
87 as \fIsmail\fR, \fImmdf\fR, \fIexim\fR, \fIpostfix\fR, or \fIqmail\fR). All the
88 delivery-control mechanisms (such as \fI.forward\fR files) normally
89 available through your system MDA and local delivery agents will
90 therefore work automatically.
92 If no port 25 listener is available, but your fetchmail configuration
93 was told about a reliable local MDA, it will use that MDA for local
98 is available, it will assist you in setting up and editing a
99 fetchmailrc configuration. It runs under the X window system and
100 requires that the language Python and the Tk toolkit be present on your
101 system. If you are first setting up fetchmail for single-user mode, it
102 is recommended that you use Novice mode. Expert mode provides complete
103 control of fetchmail configuration, including the multidrop features.
104 In either case, the 'Autoprobe' button will tell you the most capable
105 protocol a given mailserver supports, and warn you of potential problems
108 .SH GENERAL OPERATION
111 is controlled by command-line options and a run control file,
112 .IR ~/.fetchmailrc\fR ,
113 the syntax of which we describe in a later section (this file is what
114 the \fIfetchmailconf\fR program edits). Command-line options override
118 Each server name that you specify following the options on the
119 command line will be queried. If you don't specify any servers
120 on the command line, each 'poll' entry in your
122 file will be queried.
124 To facilitate the use of
126 in scripts and pipelines, it returns an appropriate exit code upon
127 termination -- see EXIT CODES below.
129 The following options modify the behavior of \fIfetchmail\fR. It is
130 seldom necessary to specify any of these once you have a
131 working \fI.fetchmailrc\fR file set up.
133 Almost all options have a corresponding keyword which can be used to
138 Some special options are not covered here, but are documented instead
139 in sections on AUTHENTICATION and DAEMON MODE which follow.
143 Displays the version information for your copy of
145 No mail fetch is performed.
146 Instead, for each server specified, all the option information
147 that would be computed if
149 were connecting to that server is displayed. Any non-printables in
150 passwords or other string names are shown as backslashed C-like
151 escape sequences. This option is useful for verifying that your
152 options are set the way you want them.
155 Return a status code to indicate whether there is mail waiting,
156 without actually fetching or deleting mail (see EXIT CODES below).
157 This option turns off daemon mode (in which it would be useless). It
158 doesn't play well with queries to multiple sites, and doesn't work
159 with ETRN or ODMR. It will return a false positive if you leave read but
160 undeleted mail in your server mailbox and your fetch protocol can't
161 tell kept messages from new ones. This means it will work with IMAP,
162 not work with POP2, and may occasionally flake out under POP3.
165 Silent mode. Suppresses all progress/status messages that are
166 normally echoed to standard output during a fetch (but does not
167 suppress actual error messages). The \-\-verbose option overrides this.
170 Verbose mode. All control messages passed between
172 and the mailserver are echoed to stdout. Overrides \-\-silent.
173 Doubling this option (\-v \-v) causes extra diagnostic information
177 .B \-a | \-\-all | (since v6.3.3) \-\-fetchall
178 (Keyword: fetchall, since v3.0)
179 Retrieve both old (seen) and new messages from the mailserver. The
180 default is to fetch only messages the server has not marked seen.
181 Under POP3, this option also forces the use of RETR rather than TOP.
182 Note that POP2 retrieval behaves as though \-\-all is always on (see
183 RETRIEVAL FAILURE MODES below) and this option does not work with ETRN
184 or ODMR. While the \-a and \-\-all command-line and fetchall rcfile
185 options have been supported for a long time, the \-\-fetchall
186 command-line option was added in v6.3.3.
190 Keep retrieved messages on the remote mailserver. Normally, messages
191 are deleted from the folder on the mailserver after they have been retrieved.
192 Specifying the \fBkeep\fR option causes retrieved messages to remain in
193 your folder on the mailserver. This option does not work with ETRN or
194 ODMR. If used with POP3, it is recommended to also specify the \-\-uidl
195 option or uidl keyword.
199 Delete retrieved messages from the remote mailserver. This
200 option forces retrieved mail to be deleted. It may be useful if
201 you have specified a default of \fBkeep\fR in your
202 \&\fI.fetchmailrc\fR. This option is forced on with ETRN and ODMR.
205 POP3/IMAP only. This is a dangerous option and can cause mail loss when
206 used improperly. It deletes old (seen) messages from the mailserver
207 before retrieving new messages. \fBWarning:\fR This can cause mail loss if
208 you check your mail with other clients than fetchmail, and cause
209 fetchmail to delete a message it had never fetched before. It can also
210 cause mail loss if the mail server marks the message seen after
211 retrieval (IMAP2 servers). You should probably not use this option in your
212 configuration file. If you use it with POP3, you must use the 'uidl'
213 option. What you probably want is the default setting: if you don't
214 specify '\-k', then fetchmail will automatically delete messages after
218 POP3/IMAP only, since version 6.3.0. Delete oversized messages from the
219 mailserver before retrieving new messages. The size limit should be
220 separately specified with the \-\-limit option. This option does not
221 work with ETRN or ODMR.
222 .SS Protocol and Query Options
224 .B \-p <proto> | \-\-proto <proto> | \-\-protocol <proto>
225 (Keyword: proto[col])
226 Specify the protocol to use when communicating with the remote
227 mailserver. If no protocol is specified, the default is AUTO.
229 may be one of the following:
232 Tries IMAP, POP3, and POP2 (skipping any of these for which support
233 has not been compiled in).
235 Post Office Protocol 2 (legacy, to be removed from future release)
237 Post Office Protocol 3
239 Use POP3 with old-fashioned MD5-challenge authentication.
240 Considered not resistant to man-in-the-middle attacks.
242 Use POP3 with RPOP authentication.
244 Use POP3 with Kerberos V4 authentication on port 1109.
246 Use POP3 with Demon Internet's SDPS extensions.
248 IMAP2bis, IMAP4, or IMAP4rev1 (\fIfetchmail\fR automatically detects their capabilities).
250 Use the ESMTP ETRN option.
252 Use the the On-Demand Mail Relay ESMTP profile.
255 All these alternatives work in basically the same way (communicating
256 with standard server daemons to fetch mail already delivered to a
257 mailbox on the server) except ETRN and ODMR. The ETRN mode
258 allows you to ask a compliant ESMTP server (such as BSD sendmail at
259 release 8.8.0 or higher) to immediately open a sender-SMTP connection
260 to your client machine and begin forwarding any items addressed to
261 your client machine in the server's queue of undelivered mail. The
262 ODMR mode requires an ODMR-capable server and works similarly to
263 ETRN, except that it does not require the client machine to have
268 Force UIDL use (effective only with POP3). Force client-side tracking
269 of 'newness' of messages (UIDL stands for "unique ID listing" and is
270 described in RFC1939). Use with 'keep' to use a mailbox as a baby
271 news drop for a group of users. The fact that seen messages are skipped
272 is logged, unless error logging is done through syslog while running in
273 daemon mode. Note that fetchmail may automatically enable this option
274 depending on upstream server capabilities. Note also that this option
275 may be removed and forced enabled in a future fetchmail version. See
278 .B \-\-idle (since 6.3.3)
279 (Keyword: idle, since before 6.0.0)
280 Enable IDLE use (effective only with IMAP). Note that this works with
281 only one folder at a given time. While the idle rcfile keyword had been
282 supported for a long time, the \-\-idle command-line option was added in
283 version 6.3.3. IDLE use means that fetchmail tells the IMAP server to
284 send notice of new messages, so they can be retrieved sooner than would
285 be possible with regular polls.
287 .B \-P <portnumber> | \-\-service <servicename>
288 (Keyword: service) Since version 6.3.0.
289 The service option permits you to specify a service name to connect to.
290 You can specify a decimal port number here, if your services database
291 lacks the required service-port assignments. See the FAQ item R12 and
292 the \-\-ssl documentation for details. This replaces the older \-\-port
295 .B \-\-port <portnumber>
297 Obsolete version of \-\-service that does not take service names.
299 this option may be removed from a future version.
301 .B \-\-principal <principal>
303 The principal option permits you to specify a service principal for
304 mutual authentication. This is applicable to POP3 or IMAP with Kerberos
307 .B \-t <seconds> | \-\-timeout <seconds>
309 The timeout option allows you to set a server-nonresponse
310 timeout in seconds. If a mailserver does not send a greeting message
311 or respond to commands for the given number of seconds,
312 \fIfetchmail\fR will hang up on it. Without such a timeout
313 \fIfetchmail\fR might hang indefinitely trying to fetch mail from a
314 down host. This would be particularly annoying for a \fIfetchmail\fR
315 running in the background. There is a default timeout which fetchmail\~\-V
316 will report. If a given connection receives too many timeouts in
317 succession, fetchmail will consider it wedged and stop retrying.
318 The calling user will be notified by email if this happens.
320 .B \-\-plugin <command>
321 (Keyword: plugin) The plugin option allows you to use an external
322 program to establish the TCP connection. This is useful if you want
323 to use SSL, ssh, or need some special firewalling setup. The
324 program will be looked up in $PATH and can optionally be passed the
325 hostname and port as arguments using "%h" and "%p" respectively (note
326 that the interpolation logic is rather primitive, and these token must
327 be bounded by whitespace or beginning of string or end of string).
328 Fetchmail will write to the plugin's stdin and read from the plugin's
331 .B \-\-plugout <command>
333 Identical to the plugin option above, but this one is used for the SMTP
334 connections (which will probably not need it, so it has been separated
337 .B \-r <name> | \-\-folder <name>
339 Causes a specified non-default mail folder on the mailserver (or
340 comma-separated list of folders) to be retrieved. The syntax of the
341 folder name is server-dependent. This option is not available under
345 (Keyword: tracepolls)
346 Tell fetchmail to poll trace information in the form 'polling %s
347 account %s' and 'folder %s' to the Received line it generates,
348 where the %s parts are replaced by the user's remote name, the poll
349 label, and the folder (mailbox) where available (the Received header
350 also normally includes the server's true name). This can be used to
351 facilitate mail filtering based on the account it is being received
352 from. The folder information is written only since version 6.3.4.
356 Causes the connection to the mail server to be encrypted via SSL. Connect
357 to the server using the specified base protocol over a connection secured
358 by SSL. This option defeats TLS negotiation. Use \-\-sslcertck to
359 validate the certificates presented by the server.
361 Note that fetchmail may still try to negotiate TLS even if this option
362 is not given. You can use the \-\-sslproto option to defeat this
363 behavior or tell fetchmail to negotiate a particular SSL protocol.
365 If no port is specified, the connection is attempted to the well known
366 port of the SSL version of the base protocol. This is generally a
367 different port than the port used by the base protocol. For IMAP, this
368 is port 143 for the clear protocol and port 993 for the SSL secured
369 protocol, for POP3, it is port 110 for the clear text and port 995 for
370 the encrypted variant.
372 If your system lacks the corresponding entries from /etc/services, see
373 the \-\-service option and specify the numeric port number as given in
374 the previous paragraph (unless your ISP had directed you to different
375 ports, which is uncommon however).
377 .B \-\-sslcert <name>
379 Specifies the file name of the client side public SSL certificate. Some
380 SSL encrypted servers may require client side keys and certificates for
381 authentication. In most cases, this is optional. This specifies
382 the location of the public key certificate to be presented to the server
383 at the time the SSL session is established. It is not required (but may
384 be provided) if the server does not require it. Some servers may
385 require it, some servers may request it but not require it, and some
386 servers may not request it at all. It may be the same file
387 as the private key (combined key and certificate file) but this is not
391 If you use client authentication, the user name is fetched from the
392 certificate's CommonName and overrides the name set with \-\-user.
396 Specifies the file name of the client side private SSL key. Some SSL
397 encrypted servers may require client side keys and certificates for
398 authentication. In most cases, this is optional. This specifies
399 the location of the private key used to sign transactions with the server
400 at the time the SSL session is established. It is not required (but may
401 be provided) if the server does not require it. Some servers may
402 require it, some servers may request it but not require it, and some
403 servers may not request it at all. It may be the same file
404 as the public key (combined key and certificate file) but this is not
405 recommended. If a password is required to unlock the key, it will be
406 prompted for at the time just prior to establishing the session to the
407 server. This can cause some complications in daemon mode.
409 .B \-\-sslproto <name>
411 Forces an SSL or TLS protocol. Possible values are '\fBSSL2\fR',
412 \&'\fBSSL3\fR', '\fBSSL23\fR', and '\fBTLS1\fR'. Try this if the default
413 handshake does not work for your server. Use this option with
414 \&'\fBTLS1\fR' to enforce a TLS connection. To defeat opportunistic TLSv1
415 negotiation when the server advertises STARTTLS or STLS, use \fB''\fR.
416 This option, even if the argument is the empty string, will also
417 suppress the diagnostic 'SERVER: opportunistic upgrade to TLS.' message
418 in verbose mode. The default is to try appropriate protocols depending
423 Causes fetchmail to strictly check the server certificate against a set of
424 local trusted certificates (see the \fBsslcertpath\fR option). If the server
425 certificate cannot be obtained or is not signed by one of the trusted ones
426 (directly or indirectly), the SSL connection will fail, regardless of
427 the \fBsslfingerprint\fR option.
428 Note that CRL are only supported in OpenSSL 0.9.7 and newer! Your system
429 clock should also be reasonably accurate when using this option.
431 Note that this optional behavior may become default behavior in future
434 .B \-\-sslcertpath <directory>
435 (Keyword: sslcertpath)
436 Sets the directory fetchmail uses to look up local certificates. The default
437 is your OpenSSL default one. The directory must be hashed as OpenSSL expects
438 it - every time you add or modify a certificate in the directory, you need
439 to use the \fBc_rehash\fR tool (which comes with OpenSSL in the tools/
442 .B \-\-sslcommonname <common name>
443 (Keyword: sslcommonname)
444 Use of this option is discouraged. Before using it, contact the
445 administrator of your upstream server and ask for a proper SSL
446 certificate to be used. If that cannot be attained, this option can be
447 used to specify the name (CommonName) that fetchmail expects on the
448 server certificate. A correctly configured server will have this set to
449 the hostname by which it is reached, and by default fetchmail will
450 expect as much. Use this option when the CommonName is set to some other
451 value, to avoid the "Server CommonName mismatch" warning, and only if
452 the upstream server can't be made to use proper certificates.
454 .B \-\-sslfingerprint <fingerprint>
455 (Keyword: sslfingerprint)
456 Specify the fingerprint of the server key (an MD5 hash of the key) in
457 hexadecimal notation with colons separating groups of two digits. The letter
458 hex digits must be in upper case. This is the default format OpenSSL uses,
459 and the one fetchmail uses to report the fingerprint when an SSL connection
460 is established. When this is specified, fetchmail will compare the server key
461 fingerprint with the given one, and the connection will fail if they do not
462 match regardless of the \fBsslcertck\fR setting. The connection will
463 also fail if fetchmail cannot obtain an SSL certificate from the server.
464 This can be used to prevent man-in-the-middle attacks, but the finger
465 print from the server needs to be obtained or verified over a secure
466 channel, and certainly not over the same Internet connection that
469 Using this option will prevent printing certificate verification errors
470 as long as \-\-sslcertck is unset.
472 To obtain the fingerprint of a certificate stored in the file cert.pem,
476 openssl x509 \-in cert.pem \-noout \-md5 \-fingerprint
481 .SS Delivery Control Options
483 .B \-S <hosts> | \-\-smtphost <hosts>
484 (Keyword: smtp[host])
485 Specify a hunt list of hosts to forward mail to (one or more
486 hostnames, comma-separated). Hosts are tried in list order; the first
487 one that is up becomes the forwarding target for the current run. If
488 this option is not specified, 'localhost' is used as the default.
489 Each hostname may have a port number following the host name. The
490 port number is separated from the host name by a slash; the default
491 port is "smtp". If you specify an absolute path name (beginning with
492 a /), it will be interpreted as the name of a UNIX socket accepting
493 LMTP connections (such as is supported by the Cyrus IMAP daemon)
497 \-\-smtphost server1,server2/2525,server3,/var/imap/socket/lmtp
500 This option can be used with ODMR, and will make fetchmail a relay
501 between the ODMR server and SMTP or LMTP receiver.
503 .B \-\-fetchdomains <hosts>
504 (Keyword: fetchdomains)
505 In ETRN or ODMR mode, this option specifies the list of domains the
506 server should ship mail for once the connection is turned around. The
507 default is the FQDN of the machine running
510 .B \-D <domain> | \-\-smtpaddress <domain>
511 (Keyword: smtpaddress) Specify the domain to be appended to addresses
512 in RCPT TO lines shipped to SMTP. When this is not specified, the name
513 of the SMTP server (as specified by \-\-smtphost) is used for SMTP/LMTP
514 and 'localhost' is used for UNIX socket/BSMTP.
516 .B \-\-smtpname <user@domain>
518 Specify the domain and user to be put in RCPT TO lines shipped to SMTP.
519 The default user is the current local user.
521 .B \-Z <nnn> | \-\-antispam <nnn[, nnn]...>
523 Specifies the list of numeric SMTP errors that are to be interpreted
524 as a spam-block response from the listener. A value of \-1 disables
525 this option. For the command-line option, the list values should
528 .B \-m <command> | \-\-mda <command>
529 (Keyword: mda) You can force mail to be passed to an MDA directly
530 (rather than forwarded to port 25) with the \-\-mda or \-m option.
533 avoid losing mail, use this option only with MDAs like maildrop or
534 MTAs like sendmail that return a nonzero status on disk-full and other
535 resource-exhaustion errors; the nonzero status tells fetchmail that
536 delivery failed and prevents the message from being deleted off the
539 If \fIfetchmail\fR is running as root, it sets its user id to
540 that of the target user while delivering mail through an MDA. Some
541 possible MDAs are "/usr/sbin/sendmail \-i \-f %F \-\- %T" (\fBNote:\fR
542 some several older or vendor sendmail versions mistake \-\- for an
543 address, rather than an indicator to mark the end of the option arguments),
544 "/usr/bin/deliver" and "/usr/bin/maildrop \-d %T". Local delivery
545 addresses will be inserted into the MDA command wherever you place a
546 %T; the mail message's From address will be inserted where you place
549 .B "DO NOT ENCLOSE THE %F OR %T STRING IN SINGLE QUOTES!"
550 For both %T and %F, fetchmail encloses the addresses in single quotes
551 ('), after removing any single quotes they may contain, before the MDA
552 command is passed to the shell.
554 \fRDo \fINOT\fP use an MDA invocation that dispatches on the contents of
555 To/Cc/Bcc,\fP like "sendmail \-i \-t" or "qmail-inject", it will create
556 mail loops and bring the just wrath of many postmasters down upon your
557 head. This is one of the most frequent configuration errors!
559 Also, do \fInot\fR try to combine multidrop mode with an MDA such
560 as maildrop that can only accept one address, unless your upstream
561 stores one copy of the message per recipient and transports the envelope
562 recipient in a header; you will lose mail.
566 package is very hard to configure properly, it has a very nasty "fall
567 through to the next rule" behavior on delivery errors (even temporary
568 ones, such as out of disk space if another user's mail daemon copies the
569 mailbox around to purge old messages), so your mail will end up in the
570 wrong mailbox sooner or later. The proper procmail configuration is
571 outside the scope of this document. Using
573 is usually much easier, and many users find the filter syntax used by
574 maildrop easier to understand.
576 Finally, we strongly advise that you do
578 use qmail-inject. The command line interface is non-standard without
579 providing benefits for typical use, and fetchmail makes no attempts to
580 accomodate qmail-inject's deviations from the standard. Some of
581 qmail-inject's command-line and environment options are actually
582 dangerous and can cause broken threads, non-detected duplicate messages
583 and forwarding loops.
588 Cause delivery via LMTP (Local Mail Transfer Protocol). A service
589 host and port \fBmust\fR be explicitly specified on each host in the
590 smtphost hunt list (see above) if this option is selected; the default
591 port 25 will (in accordance with RFC 2033) not be accepted.
593 .B \-\-bsmtp <filename>
595 Append fetched mail to a BSMTP file. This simply contains the SMTP
596 commands that would normally be generated by fetchmail when passing
597 mail to an SMTP listener daemon. An argument of '\-' causes the mail
598 to be written to standard output. Note that fetchmail's
599 reconstruction of MAIL FROM and RCPT TO lines is not guaranteed
600 correct; the caveats discussed under THE USE AND ABUSE OF MULTIDROP
601 MAILBOXES below apply.
602 .SS Resource Limit Control Options
604 .B \-l <maxbytes> | \-\-limit <maxbytes>
605 (Keyword: limit) Takes a maximum octet size argument, where 0 is the
606 default and also the special value designating "no limit".
607 If nonzero, messages larger than this size will not be fetched and will
608 be left on the server (in foreground sessions, the progress messages
609 will note that they are "oversized"). If the fetch protocol permits (in
610 particular, under IMAP or POP3 without the fetchall option) the message
611 will not be marked seen.
613 An explicit \-\-limit of 0 overrides any limits set in your
614 run control file. This option is intended for those needing to
615 strictly control fetch time due to expensive and variable phone rates.
617 Combined with \-\-limitflush, it can be used to delete oversized
618 messages waiting on a server. In daemon mode, oversize notifications
619 are mailed to the calling user (see the \-\-warnings option). This
620 option does not work with ETRN or ODMR.
622 .B \-w <interval> | \-\-warnings <interval>
624 Takes an interval in seconds. When you call
626 with a 'limit' option in daemon mode, this controls the interval at
627 which warnings about oversized messages are mailed to the calling user
628 (or the user specified by the 'postmaster' option). One such
629 notification is always mailed at the end of the the first poll that
630 the oversized message is detected. Thereafter, re-notification is
631 suppressed until after the warning interval elapses (it will take
632 place at the end of the first following poll).
634 .B \-b <count> | \-\-batchlimit <count>
635 (Keyword: batchlimit)
636 Specify the maximum number of messages that will be shipped to an SMTP
637 listener before the connection is deliberately torn down and rebuilt
638 (defaults to 0, meaning no limit). An explicit \-\-batchlimit of 0
639 overrides any limits set in your run control file. While
640 \fBsendmail\fR(8) normally initiates delivery of a message immediately
641 after receiving the message terminator, some SMTP listeners are not so
642 prompt. MTAs like \fIsmail\fR(8) may wait till the
643 delivery socket is shut down to deliver. This may produce annoying
644 delays when \fIfetchmail\fR is processing very large batches. Setting
645 the batch limit to some nonzero size will prevent these delays. This
646 option does not work with ETRN or ODMR.
648 .B \-B <number> | \-\-fetchlimit <number>
649 (Keyword: fetchlimit)
650 Limit the number of messages accepted from a given server in a single
651 poll. By default there is no limit. An explicit \-\-fetchlimit of 0
652 overrides any limits set in your run control file.
653 This option does not work with ETRN or ODMR.
655 .B \-\-fetchsizelimit <number>
656 (Keyword: fetchsizelimit)
657 Limit the number of sizes of messages accepted from a given server in
658 a single transaction. This option is useful in reducing the delay in
659 downloading the first mail when there are too many mails in the
660 mailbox. By default, the limit is 100. If set to 0, sizes of all
661 messages are downloaded at the start.
662 This option does not work with ETRN or ODMR. For POP3, the only valid
665 .B \-\-fastuidl <number>
667 Do a binary instead of linear search for the first unseen UID. Binary
668 search avoids downloading the UIDs of all mails. This saves time
669 (especially in daemon mode) where downloading the same set of UIDs in
670 each poll is a waste of bandwidth. The number 'n' indicates how rarely
671 a linear search should be done. In daemon mode, linear search is used
672 once followed by binary searches in 'n-1' polls if 'n' is greater than
673 1; binary search is always used if 'n' is 1; linear search is always
674 used if 'n' is 0. In non-daemon mode, binary search is used if 'n' is
675 1; otherwise linear search is used. The default value of 'n' is 4.
676 This option works with POP3 only.
678 .B \-e <count> | \-\-expunge <count>
680 Arrange for deletions to be made final after a given number of
681 messages. Under POP2 or POP3, fetchmail cannot make deletions final
682 without sending QUIT and ending the session -- with this option on,
683 fetchmail will break a long mail retrieval session into multiple
684 sub-sessions, sending QUIT after each sub-session. This is a good
685 defense against line drops on POP3 servers. Under IMAP,
687 normally issues an EXPUNGE command after each deletion in order to
688 force the deletion to be done immediately. This is safest when your
689 connection to the server is flaky and expensive, as it avoids
690 resending duplicate mail after a line hit. However, on large
691 mailboxes the overhead of re-indexing after every message can slam the
692 server pretty hard, so if your connection is reliable it is good to do
693 expunges less frequently. Also note that some servers enforce a delay
694 of a few seconds after each quit, so fetchmail may not be able to get
695 back in immediately after an expunge -- you may see "lock busy" errors
696 if this happens. If you specify this option to an integer N,
699 to only issue expunges on every Nth delete. An argument of zero
700 suppresses expunges entirely (so no expunges at all will be done until
701 the end of run). This option does not work with ETRN or ODMR.
702 .SS Authentication Options
704 .B \-u <name> | \-\-user <name> | \-\-username <name>
705 (Keyword: user[name])
706 Specifies the user identification to be used when logging in to the mailserver.
707 The appropriate user identification is both server and user-dependent.
708 The default is your login name on the client machine that is running
710 See USER AUTHENTICATION below for a complete description.
712 .B \-I <specification> | \-\-interface <specification>
714 Require that a specific interface device be up and have a specific local
715 or remote IPv4 (IPv6 is not supported by this option yet) address (or
716 range) before polling. Frequently \fIfetchmail\fP
717 is used over a transient point-to-point TCP/IP link established directly
718 to a mailserver via SLIP or PPP. That is a relatively secure channel.
719 But when other TCP/IP routes to the mailserver exist (e.g. when the link
720 is connected to an alternate ISP), your username and password may be
721 vulnerable to snooping (especially when daemon mode automatically polls
722 for mail, shipping a clear password over the net at predictable
723 intervals). The \-\-interface option may be used to prevent this. When
724 the specified link is not up or is not connected to a matching IP
725 address, polling will be skipped. The format is:
728 interface/iii.iii.iii.iii[/mmm.mmm.mmm.mmm]
731 The field before the first slash is the interface name (i.e. sl0, ppp0
732 etc.). The field before the second slash is the acceptable IP address.
733 The field after the second slash is a mask which specifies a range of
734 IP addresses to accept. If no mask is present 255.255.255.255 is
735 assumed (i.e. an exact match). This option is currently only supported
736 under Linux and FreeBSD. Please see the
738 section for below for FreeBSD specific information.
740 Note that this option may be removed from a future fetchmail version.
742 .B \-M <interface> | \-\-monitor <interface>
744 Daemon mode can cause transient links which are automatically taken down
745 after a period of inactivity (e.g. PPP links) to remain up
746 indefinitely. This option identifies a system TCP/IP interface to be
747 monitored for activity. After each poll interval, if the link is up but
748 no other activity has occurred on the link, then the poll will be
749 skipped. However, when fetchmail is woken up by a signal, the
750 monitor check is skipped and the poll goes through unconditionally.
751 This option is currently only supported under Linux and FreeBSD.
756 options to work for non root users under FreeBSD, the fetchmail binary
757 must be installed SGID kmem. This would be a security hole, but
758 fetchmail runs with the effective GID set to that of the kmem group
760 when interface data is being collected.
762 Note that this option may be removed from a future fetchmail version.
765 (Keyword: auth[enticate])
766 This option permits you to specify an authentication type (see USER
767 AUTHENTICATION below for details). The possible values are \fBany\fR,
768 \&\fBpassword\fR, \fBkerberos_v5\fR, \fBkerberos\fR (or, for
769 excruciating exactness, \fBkerberos_v4\fR), \fBgssapi\fR,
770 \fBcram\-md5\fR, \fBotp\fR, \fBntlm\fR, \fBmsn\fR (only for POP3),
771 \fBexternal\fR (only IMAP) and \fBssh\fR.
772 When \fBany\fR (the default) is specified, fetchmail tries
773 first methods that don't require a password (EXTERNAL, GSSAPI, KERBEROS\ IV,
774 KERBEROS\ 5); then it looks for methods that mask your password
775 (CRAM-MD5, X\-OTP - note that NTLM and MSN are not autoprobed for POP3
776 and MSN is only supported for POP3); and only if the server doesn't
777 support any of those will it ship your password en clair. Other values
778 may be used to force various authentication methods
779 (\fBssh\fR suppresses authentication and is thus useful for IMAP PREAUTH).
780 (\fBexternal\fR suppresses authentication and is thus useful for IMAP EXTERNAL).
781 Any value other than \fBpassword\fR, \fBcram\-md5\fR, \fBntlm\fR,
782 \&\fBmsn\fR or \fBotp\fR suppresses fetchmail's normal inquiry for a
783 password. Specify \fBssh\fR when you are using an end-to-end secure
784 connection such as an ssh tunnel; specify \fBexternal\fR when you use
785 TLS with client authentication and specify \fBgssapi\fR or
786 \&\fBkerberos_v4\fR if you are using a protocol variant that employs
787 GSSAPI or K4. Choosing KPOP protocol automatically selects Kerberos
788 authentication. This option does not work with ETRN.
789 .SS Miscellaneous Options
791 .B \-f <pathname> | \-\-fetchmailrc <pathname>
792 Specify a non-default name for the
794 run control file. The pathname argument must be either "-" (a single
795 dash, meaning to read the configuration from standard input) or a
796 filename. Unless the \-\-version option is also on, a named file
797 argument must have permissions no more open than 0700 (u=rwx,g=,o=) or
800 .B \-i <pathname> | \-\-idfile <pathname>
802 Specify an alternate name for the .fetchids file used to save message
803 UIDs. NOTE: since fetchmail 6.3.0, write access to the directory
804 containing the idfile is required, as fetchmail writes a temporary file
805 and renames it into the place of the real idfile only if the temporary
806 file has been written successfully. This avoids the truncation of
807 idfiles when running out of disk space.
809 .B \--pidfile <pathname>
810 (Keyword: pidfile; since fetchmail v6.3.4)
811 Override the default location of the PID file. Default: see
814 .B \-n | \-\-norewrite
815 (Keyword: no rewrite)
818 edits RFC-822 address headers (To, From, Cc, Bcc, and Reply\-To) in
819 fetched mail so that any mail IDs local to the server are expanded to
820 full addresses (@ and the mailserver hostname are appended). This enables
821 replies on the client to get addressed correctly (otherwise your
822 mailer might think they should be addressed to local users on the
823 client machine!). This option disables the rewrite. (This option is
824 provided to pacify people who are paranoid about having an MTA edit
825 mail headers and want to know they can prevent it, but it is generally
826 not a good idea to actually turn off rewrite.)
827 When using ETRN or ODMR, the rewrite option is ineffective.
829 .B \-E <line> | \-\-envelope <line>
830 (Keyword: envelope; Multidrop only)
832 In the configuration file, an enhanced syntax is used:
834 .B envelope [<count>] <line>
836 This option changes the header
838 assumes will carry a copy of the mail's envelope address. Normally
839 this is 'X\-Envelope\-To'. Other typically found headers to carry envelope
840 information are 'X\-Original\-To' and 'Delivered\-To'. Now, since
841 these headers are not standardized, practice varies. See the discussion
842 of multidrop address handling below. As a special case, 'envelope
843 "Received"' enables parsing of sendmail-style Received lines. This is
844 the default, but discouraged because it is not fully reliable.
847 that fetchmail expects the Received-line to be in a specific
848 format: It must contain "by \fIhost\fP for \fIaddress\fR", where
849 \fIhost\fP must match one of the mailserver names that fetchmail
850 recognizes for the account in question.
852 The optional count argument (only available in the configuration file)
853 determines how many header lines of this kind are skipped. A count of 1
854 means: skip the first, take the second. A count of 2 means: skip the
855 first and second, take the third, and so on.
857 .B \-Q <prefix> | \-\-qvirtual <prefix>
858 (Keyword: qvirtual; Multidrop only)
859 The string prefix assigned to this option will be removed from the user
860 name found in the header specified with the \fIenvelope\fR option
861 (\fIbefore\fR doing multidrop name mapping or localdomain checking,
862 if either is applicable). This option is useful if you are using
864 to collect the mail for an entire domain and your ISP (or your mail
865 redirection provider) is using qmail.
866 One of the basic features of qmail is the
870 message header. Whenever qmail delivers a message to a local mailbox
871 it puts the username and hostname of the envelope recipient on this
872 line. The major reason for this is to prevent mail loops. To set up
873 qmail to batch mail for a disconnected site the ISP-mailhost will have
874 normally put that site in its 'Virtualhosts' control file so it will
875 add a prefix to all mail addresses for this site. This results in mail
876 .\" The \&@\& tries to stop HTML converters from making a mailto URL here.
877 sent to 'username\&@\&userhost.userdom.dom.com' having a
878 \&'Delivered\-To:' line of the form:
880 Delivered\-To: mbox\-userstr\-username\&@\&userhost.example.com
882 The ISP can make the 'mbox\-userstr\-' prefix anything they choose
883 but a string matching the user host name is likely.
884 By using the option 'envelope Delivered\-To:' you can make fetchmail reliably
885 identify the original envelope recipient, but you have to strip the
886 \&'mbox\-userstr\-' prefix to deliver to the correct user.
887 This is what this option is for.
892 file, interpret any command-line options specified, and dump a
893 configuration report to standard output. The configuration report is
894 a data structure assignment in the language Python. This option
895 is meant to be used with an interactive
903 Removed before version 6.3.0, the required underlying inet6_apps library
904 had been discontinued and is no longer available.
906 .SH USER AUTHENTICATION AND ENCRYPTION
907 All modes except ETRN require authentication of the client to the server.
908 Normal user authentication in
910 is very much like the authentication mechanism of
912 The correct user-id and password depend upon the underlying security
913 system at the mailserver.
915 If the mailserver is a Unix machine on which you have an ordinary user
916 account, your regular login name and password are used with
918 If you use the same login name on both the server and the client machines,
919 you needn't worry about specifying a user-id with the
921 option -- the default behavior is to use your login name on the
922 client machine as the user-id on the server machine. If you use a
923 different login name on the server machine, specify that login name
926 option. e.g. if your login name is 'jsmith' on a machine named 'mailgrunt',
931 fetchmail \-u jsmith mailgrunt
933 The default behavior of
935 is to prompt you for your mailserver password before the connection is
936 established. This is the safest way to use
938 and ensures that your password will not be compromised. You may also specify
939 your password in your
941 file. This is convenient when using
943 in daemon mode or with scripts.
944 .SS Using netrc files
946 If you do not specify a password, and
948 cannot extract one from your
950 file, it will look for a
952 file in your home directory before requesting one interactively; if an
953 entry matching the mailserver is found in that file, the password will
954 be used. Fetchmail first looks for a match on poll name; if it finds none,
955 it checks for a match on via name. See the
957 man page for details of the syntax of the
959 file. To show a practical example, a .netrc might look like
963 machine hermes.example.org
968 You can repeat this block with different user information if you need to
969 provide more than one password.
971 This feature may allow you to avoid duplicating password
972 information in more than one file.
974 On mailservers that do not provide ordinary user accounts, your user-id and
975 password are usually assigned by the server administrator when you apply for
976 a mailbox on the server. Contact your server administrator if you don't know
977 the correct user-id and password for your mailbox account.
980 Early versions of POP3 (RFC1081, RFC1225) supported a crude form of
981 independent authentication using the
983 file on the mailserver side. Under this RPOP variant, a fixed
984 per-user ID equivalent to a password was sent in clear over a link to
985 a reserved port, with the command RPOP rather than PASS to alert the
986 server that it should do special checking. RPOP is supported
989 (you can specify 'protocol RPOP' to have the program send 'RPOP'
990 rather than 'PASS') but its use is strongly discouraged, and support
991 will be removed from a future fetchmail version. This
992 facility was vulnerable to spoofing and was withdrawn in RFC1460.
994 RFC1460 introduced APOP authentication. In this variant of POP3,
995 you register an APOP password on your server host (on some servers, the
996 program to do this is called \fIpopauth\fR(8)). You put the same
997 password in your \fI~/.fetchmailrc\fP file. Each time \fIfetchmail\fP
998 logs in, it sends an MD5 hash of your password and the server greeting
999 time to the server, which can verify it by checking its authorization
1002 \fBNote that APOP is no longer considered resistant against
1003 man-in-the-middle attacks.\fP
1006 makes some efforts to make the server believe messages had not been
1007 retrieved, by using the TOP command with a large number of lines when
1008 possible. TOP is a command that retrieves the full header and
1009 a \fIfetchmail\fP-specified amount of body lines. It is optional and
1010 therefore not implemented by all servers, and some are known to
1011 implement it improperly. On many servers however, the RETR command which
1012 retrieves the full message with header and body, sets the "seen" flag
1013 (for instance, in a web interface), whereas the TOP command does not do
1017 will always use the RETR command if "fetchall" is set.
1019 will also use the RETR command if "keep" is set and "uidl" is unset.
1022 will use the RETR command on Maillennium POP3/PROXY
1023 servers (used by Comcast) to avoid a deliberate TOP misinterpretation in
1024 this server that causes message corruption.
1028 will use the TOP command. This implies that in "keep" setups, "uidl"
1029 must be set if "TOP" is desired.
1032 that this description is true for the current version of fetchmail, but
1033 the behavior may change in future versions. In particular, fetchmail may
1034 prefer the RETR command because the TOP command causes much grief on
1035 some servers and is only optional.
1036 .SH ALTERNATE AUTHENTICATION FORMS
1038 If your \fIfetchmail\fR was built with Kerberos support and you specify
1039 Kerberos authentication (either with \-\-auth or the \fI.fetchmailrc\fR
1040 option \fBauthenticate kerberos_v4\fR) it will try to get a Kerberos
1041 ticket from the mailserver at the start of each query. Note: if
1042 either the pollname or via name is 'hesiod', fetchmail will try to use
1043 Hesiod to look up the mailserver.
1045 If you use POP3 or IMAP with GSSAPI authentication, \fIfetchmail\fR will
1046 expect the server to have RFC1731- or RFC1734-conforming GSSAPI
1047 capability, and will use it. Currently this has only been tested over
1048 Kerberos V, so you're expected to already have a ticket-granting
1049 ticket. You may pass a username different from your principal name
1050 using the standard \fB\-\-user\fR command or by the \fI.fetchmailrc\fR
1053 If your IMAP daemon returns the PREAUTH response in its greeting line,
1054 fetchmail will notice this and skip the normal authentication step.
1055 This can be useful, e.g. if you start imapd explicitly using ssh.
1056 In this case you can declare the authentication value 'ssh' on that
1057 site entry to stop \fI.fetchmail\fR from asking you for a password
1060 If you use client authentication with \fITLS1\fR and your IMAP daemon
1061 returns the \fIAUTH=EXTERNAL\fR response, fetchmail will notice this
1062 and will use the authentication shortcut and will not send the
1063 passphrase. In this case you can declare the authentication value 'external'
1064 on that site to stop \fIfetchmail\fR from asking you for a password
1067 If you are using POP3, and the server issues a one-time-password
1068 challenge conforming to RFC1938, \fIfetchmail\fR will use your
1069 password as a pass phrase to generate the required response. This
1070 avoids sending secrets over the net unencrypted.
1072 Compuserve's RPA authentication is supported. If you
1073 compile in the support, \fIfetchmail\fR will try to perform an RPA pass-phrase
1074 authentication instead of sending over the password en clair if it
1075 detects "@compuserve.com" in the hostname.
1077 If you are using IMAP, Microsoft's NTLM authentication (used by Microsoft
1078 Exchange) is supported. If you compile in the support, \fIfetchmail\fR
1079 will try to perform an NTLM authentication (instead of sending over the
1080 password en clair) whenever the server returns AUTH=NTLM in its
1081 capability response. Specify a user option value that looks like
1082 \&'user@domain': the part to the left of the @ will be passed as the
1083 username and the part to the right as the NTLM domain.
1084 .SS Secure Socket Layers (SSL) and Transport Layer Security (TLS)
1086 You can access SSL encrypted services by specifying the \-\-ssl option.
1087 You can also do this using the "ssl" user option in the .fetchmailrc
1088 file. With SSL encryption enabled, queries are initiated over a connection
1089 after negotiating an SSL session, and the connection fails if SSL cannot
1090 be negotiated. Some services, such as POP3 and IMAP, have different
1091 well known ports defined for the SSL encrypted services. The encrypted
1092 ports will be selected automatically when SSL is enabled and no explicit
1093 port is specified. The \-\-sslproto option can be used to select the SSL
1094 protocols (default: v2 or v3). The \-\-sslcertck command line or
1095 sslcertck run control file option should be used to force strict
1096 certificate checking - see below.
1098 If SSL is not configured, fetchmail will usually opportunistically try to use
1099 TLS. TLS can be enforced by using \-\-sslproto "TLS1". TLS
1100 connections use the same port as the unencrypted version of the
1101 protocol and negotiate TLS via special parameter. The \-\-sslcertck
1102 command line or sslcertck run control file option should be used to
1103 force strict certificate checking - see below.
1106 recommended: When connecting to an SSL or TLS encrypted server, the
1107 server presents a certificate to the client for validation. The
1108 certificate is checked to verify that the common name in the certificate
1109 matches the name of the server being contacted and that the effective
1110 and expiration dates in the certificate indicate that it is currently
1111 valid. If any of these checks fail, a warning message is printed, but
1112 the connection continues. The server certificate does not need to be
1113 signed by any specific Certifying Authority and may be a "self-signed"
1114 certificate. If the \-\-sslcertck command line option or sslcertck run
1115 control file option is used, fetchmail will instead abort if any of
1116 these checks fail. Use of the sslcertck or \-\-sslcertck option is
1119 Some SSL encrypted servers may request a client side certificate. A client
1120 side public SSL certificate and private SSL key may be specified. If
1121 requested by the server, the client certificate is sent to the server for
1122 validation. Some servers may require a valid client certificate and may
1123 refuse connections if a certificate is not provided or if the certificate
1124 is not valid. Some servers may require client side certificates be signed
1125 by a recognized Certifying Authority. The format for the key files and
1126 the certificate files is that required by the underlying SSL libraries
1127 (OpenSSL in the general case).
1129 A word of care about the use of SSL: While above mentioned
1130 setup with self-signed server certificates retrieved over the wires
1131 can protect you from a passive eavesdropper, it doesn't help against an
1132 active attacker. It's clearly an improvement over sending the
1133 passwords in clear, but you should be aware that a man-in-the-middle
1134 attack is trivially possible (in particular with tools such as dsniff,
1135 http://monkey.org/~dugsong/dsniff/). Use of strict certificate checking
1136 with a certification authority recognized by server and client, or
1137 perhaps of an SSH tunnel (see below for some examples) is preferable if
1138 you care seriously about the security of your mailbox and passwords.
1142 also supports authentication to the ESMTP server on the client side
1143 according to RFC 2554. You can specify a name/password pair to be
1144 used with the keywords 'esmtpname' and 'esmtppassword'; the former
1145 defaults to the username of the calling user.
1148 .SS Introducing the daemon mode
1151 puts itself into the background and runs forever, querying each
1152 specified host and then sleeping for a given polling interval.
1153 .SS Starting the daemon mode
1154 There are several ways to make fetchmail work in daemon mode. On the
1155 command line, \fB\-\-daemon\ <interval>\fR or \fB\-d\ <interval>\fR
1156 option runs \fIfetchmail\fR in daemon mode. You must specify a numeric
1157 argument which is a polling interval (time to wait after completing a
1158 whole poll cycle with the last server and before starting the next poll
1159 cycle with the first server) in seconds.
1161 Example: simply invoking
1165 will, therefore, poll all the hosts described in your
1167 file (except those explicitly excluded with the 'skip' verb) a bit less
1168 often than once every 15 minutes (exactly: 15 minutes + time that the
1171 It is also possible to set a polling interval
1172 in your \fI~/.fetchmailrc\fR file by saying 'set\ daemon\ <interval>',
1173 where <interval> is an integer number of seconds. If you do this,
1174 fetchmail will always start in daemon mode unless you override it with
1175 the command-line option \-\-daemon 0 or \-d0.
1177 Only one daemon process is permitted per user; in daemon mode,
1178 \fIfetchmail\fR sets up a per-user lockfile to guarantee this.
1179 (You can however cheat and set the FETCHMAILHOME environment variable to
1180 overcome this setting, but in that case, it is your responsibility to
1181 make sure you aren't polling the same server with two processes at the
1183 .SS Awakening the background daemon
1185 Normally, calling fetchmail with a daemon in the background sends a
1186 wake-up signal to the daemon and quits without output. The background
1187 daemon then starts its next poll cycle immediately. The wake-up signal,
1188 SIGUSR1, can also be sent manually. The wake-up action also clears any
1189 \&'wedged' flags indicating that connections have wedged due to failed
1190 authentication or multiple timeouts.
1191 .SS Terminating the background daemon
1195 will kill a running daemon process instead of waking it up (if there
1196 is no such process, \fIfetchmail\fP will notify you).
1197 If the \-\-quit option appears last on the command line, \fIfetchmail\fP
1198 will kill the running daemon process and then quit. Otherwise,
1199 \fIfetchmail\fP will first kill a running daemon process and then
1200 continue running with the other options.
1201 .SS Useful options for daemon mode
1206 .B \-\-logfile <filename>
1207 option (keyword: set logfile) is only effective when fetchmail is
1208 detached and in daemon mode. Note that the logfile must exist BEFORE
1209 fetchmail is run, you
1212 command with the filename as its sole argument to create it.
1214 This option allows you to redirect status messages
1215 into a specified logfile (follow the option with the logfile name). The
1216 logfile is opened for append, so previous messages aren't deleted. This
1217 is primarily useful for debugging configurations. Note that fetchmail
1218 does not detect if the logfile is rotated, the logfile is only opened
1219 once when fetchmail starts. You need to restart fetchmail after rotating
1220 the logfile and before compressing it (if applicable).
1224 option (keyword: set syslog) allows you to redirect status and error
1225 messages emitted to the
1227 system daemon if available.
1228 Messages are logged with an id of \fBfetchmail\fR, the facility \fBLOG_MAIL\fR,
1229 and priorities \fBLOG_ERR\fR, \fBLOG_ALERT\fR or \fBLOG_INFO\fR.
1230 This option is intended for logging status and error messages which
1231 indicate the status of the daemon and the results while fetching mail
1233 Error messages for command line options and parsing the \fI.fetchmailrc\fR
1234 file are still written to stderr, or to the specified log file.
1237 option turns off use of
1239 assuming it's turned on in the
1244 .B \-\-logfile <file>
1251 option suppresses backgrounding and detachment of the
1252 daemon process from its control terminal. This is useful
1253 for debugging or when fetchmail runs as the child of a supervisor
1258 Note that this also causes the logfile option to be
1259 ignored (though perhaps it shouldn't).
1261 Note that while running in daemon mode polling a POP2 or IMAP2bis server,
1262 transient errors (such as DNS failures or sendmail delivery refusals)
1263 may force the fetchall option on for the duration of the next polling
1264 cycle. This is a robustness feature. It means that if a message is
1265 fetched (and thus marked seen by the mailserver) but not delivered
1266 locally due to some transient error, it will be re-fetched during the
1267 next poll cycle. (The IMAP logic doesn't delete messages until
1268 they're delivered, so this problem does not arise.)
1270 If you touch or change the
1272 file while fetchmail is running in daemon mode, this will be detected
1273 at the beginning of the next poll cycle. When a changed
1275 is detected, fetchmail rereads it and restarts from scratch (using
1276 exec(2); no state information is retained in the new instance).
1277 Note also that if you break the
1279 file's syntax, the new instance will softly and silently vanish away
1282 .SH ADMINISTRATIVE OPTIONS
1285 .B \-\-postmaster <name>
1286 option (keyword: set postmaster) specifies the last-resort username to
1287 which multidrop mail is to be forwarded if no matching local recipient
1288 can be found. It is also used as destination of undeliverable mail if
1289 the 'bouncemail' global option is off and additionally for spam-blocked
1290 mail if the 'bouncemail' global option is off and the 'spambounce'
1291 global option is on. This option defaults to the user who invoked
1293 If the invoking user is root, then the default of this option is
1294 the user 'postmaster'. Setting postmaster to the empty string causes
1295 such mail as described above to be discarded - this however is usually a
1297 See also the description of the 'FETCHMAILUSER' environment variable in
1298 the ENVIRONMENT section below.
1302 behaves like the "set no bouncemail" global option, which see.
1306 option (keyword: set invisible) tries to make fetchmail invisible.
1307 Normally, fetchmail behaves like any other MTA would -- it generates a
1308 Received header into each message describing its place in the chain of
1309 transmission, and tells the MTA it forwards to that the mail came from
1310 the machine fetchmail itself is running on. If the invisible option
1311 is on, the Received header is suppressed and fetchmail tries to spoof
1312 the MTA it forwards to into thinking it came directly from the
1317 option (keyword: set showdots) forces fetchmail to show progress dots
1318 even if the output goes to a file or fetchmail is not in verbose mode.
1319 Fetchmail shows the dots by default when run in \-\-verbose mode
1320 \fIand\fP output goes to console. This option is ignored in \-\-silent mode.
1324 option, you can ask fetchmail to add information to the Received
1325 header on the form "polling {label} account {user}", where {label} is
1326 the account label (from the specified rcfile, normally ~/.fetchmailrc)
1327 and {user} is the username which is used to log on to the mail
1328 server. This header can be used to make filtering email where no
1329 useful header information is available and you want mail from
1330 different accounts sorted into different mailboxes (this could, for
1331 example, occur if you have an account on the same server running a
1332 mailing list, and are subscribed to the list using that account). The
1333 default is not adding any such header. In
1335 this is called 'tracepolls'.
1337 .SH RETRIEVAL FAILURE MODES
1338 The protocols \fIfetchmail\fR uses to talk to mailservers are next to
1339 bulletproof. In normal operation forwarding to port 25, no message is
1340 ever deleted (or even marked for deletion) on the host until the SMTP
1341 listener on the client side has acknowledged to \fIfetchmail\fR that
1342 the message has been either accepted for delivery or rejected due to a
1345 When forwarding to an MDA, however, there is more possibility
1346 of error. Some MDAs are 'safe' and reliably return a nonzero status
1347 on any delivery error, even one due to temporary resource limits.
1350 program is like this; so are most programs designed as mail transport
1353 including the sendmail wrapper of Postfix and
1355 These programs give back a reliable positive acknowledgement and
1356 can be used with the mda option with no risk of mail loss. Unsafe
1357 MDAs, though, may return 0 even on delivery failure. If this
1358 happens, you will lose mail.
1360 The normal mode of \fIfetchmail\fR is to try to download only 'new'
1361 messages, leaving untouched (and undeleted) messages you have already
1362 read directly on the server (or fetched with a previous \fIfetchmail
1363 \-\-keep\fR). But you may find that messages you've already read on the
1364 server are being fetched (and deleted) even when you don't specify
1365 \-\-all. There are several reasons this can happen.
1367 One could be that you're using POP2. The POP2 protocol includes no
1368 representation of 'new' or 'old' state in messages, so \fIfetchmail\fR
1369 must treat all messages as new all the time. But POP2 is obsolete, so
1372 A potential POP3 problem might be servers that insert messages
1373 in the middle of mailboxes (some VMS implementations of mail are
1374 rumored to do this). The \fIfetchmail\fR code assumes that new
1375 messages are appended to the end of the mailbox; when this is not true
1376 it may treat some old messages as new and vice versa. Using UIDL whilst
1377 setting fastuidl 0 might fix this, otherwise, consider switching to IMAP.
1379 Yet another POP3 problem is that if they can't make tempfiles in the
1380 user's home directory, some POP3 servers will hand back an
1381 undocumented response that causes fetchmail to spuriously report "No
1384 The IMAP code uses the presence or absence of the server flag \eSeen
1385 to decide whether or not a message is new. This isn't the right thing
1386 to do, fetchmail should check the UIDVALIDITY and use UID, but it
1387 doesn't do that yet. Under Unix, it counts on your IMAP server to notice
1388 the BSD-style Status flags set by mail user agents and set the \eSeen
1389 flag from them when appropriate. All Unix IMAP servers we know of do
1390 this, though it's not specified by the IMAP RFCs. If you ever trip over
1391 a server that doesn't, the symptom will be that messages you have
1392 already read on your host will look new to the server. In this
1393 (unlikely) case, only messages you fetched with \fIfetchmail \-\-keep\fR
1394 will be both undeleted and marked old.
1396 In ETRN and ODMR modes, \fIfetchmail\fR does not actually retrieve messages;
1397 instead, it asks the server's SMTP listener to start a queue flush
1398 to the client via SMTP. Therefore it sends only undelivered messages.
1401 Many SMTP listeners allow administrators to set up 'spam filters' that
1402 block unsolicited email from specified domains. A MAIL FROM or DATA line that
1403 triggers this feature will elicit an SMTP response which
1404 (unfortunately) varies according to the listener.
1408 return an error code of 571.
1410 According to RFC2821, the correct thing to return in this situation is
1411 550 "Requested action not taken: mailbox unavailable" (the draft adds
1412 "[E.g., mailbox not found, no access, or command rejected for policy
1415 Older versions of the
1417 MTA return 501 "Syntax error in parameters or arguments".
1421 MTA runs 554 as an antispam response.
1424 may reject code with a 500 response (followed by an enhanced status
1425 code that contains more information).
1429 treats as antispam responses and discards
1430 the message can be set with the 'antispam' option. This is one of the
1432 three circumstance under which fetchmail ever discards mail (the others
1433 are the 552 and 553 errors described below, and the suppression of
1434 multidropped messages with a message-ID already seen).
1438 is fetching from an IMAP server, the antispam response will be detected and
1439 the message rejected immediately after the headers have been fetched,
1440 without reading the message body. Thus, you won't pay for downloading
1441 spam message bodies.
1443 By default, the list of antispam responses is empty.
1445 If the \fIspambounce\fR global option is on, mail that is spam-blocked
1446 triggers an RFC1892/RFC1894 bounce message informing the originator that
1447 we do not accept mail from it. See also BUGS.
1449 .SH SMTP/ESMTP ERROR HANDLING
1450 Besides the spam-blocking described above, fetchmail takes special
1451 actions on the following SMTP/ESMTP error responses
1453 452 (insufficient system storage)
1454 Leave the message in the server mailbox for later retrieval.
1456 552 (message exceeds fixed maximum message size)
1457 Delete the message from the server. Send bounce-mail to the
1460 553 (invalid sending domain)
1461 Delete the message from the server. Don't even try to send
1462 bounce-mail to the originator.
1464 Other errors trigger bounce mail back to the originator. See also BUGS.
1466 .SH THE RUN CONTROL FILE
1467 The preferred way to set up fetchmail is to write a
1468 \&\fI.fetchmailrc\fR file in your home directory (you may do this
1469 directly, with a text editor, or indirectly via \fIfetchmailconf\fR).
1470 When there is a conflict between the command-line arguments and the
1471 arguments in this file, the command-line arguments take precedence.
1473 To protect the security of your passwords,
1474 your \fI~/.fetchmailrc\fR may not normally have more than 0700 (u=rwx,g=,o=) permissions;
1476 will complain and exit otherwise (this check is suppressed when
1479 You may read the \fI.fetchmailrc\fR file as a list of commands to
1482 is called with no arguments.
1483 .SS Run Control Syntax
1485 Comments begin with a '#' and extend through the end of the line.
1486 Otherwise the file consists of a series of server entries or global
1487 option statements in a free-format, token-oriented syntax.
1489 There are four kinds of tokens: grammar keywords, numbers
1490 (i.e. decimal digit sequences), unquoted strings, and quoted strings.
1491 A quoted string is bounded by double quotes and may contain
1492 whitespace (and quoted digits are treated as a string). Note that
1493 quoted strings will also contain line feed characters if they run across
1494 two or more lines, unless you use a backslash to join lines (see below).
1495 An unquoted string is any whitespace-delimited token that is neither
1496 numeric, string quoted nor contains the special characters ',', ';',
1499 Any amount of whitespace separates tokens in server entries, but is
1500 otherwise ignored. You may use backslash escape sequences (\en for LF,
1501 \&\et for HT, \eb for BS, \er for CR, \e\fInnn\fP for decimal (where
1502 nnn cannot start with a 0), \e0\fIooo\fP for octal, and \ex\fIhh\fP for
1503 hex) to embed non-printable characters or string delimiters in strings.
1504 In quoted strings, a backslash at the very end of a line will cause the
1505 backslash itself and the line feed (LF or NL, new line) character to be
1506 ignored, so that you can wrap long strings. Without the backslash at the
1507 line end, the line feed character would become part of the string.
1510 while these resemble C-style escape sequences, they are not the same.
1511 fetchmail only supports these eight styles. C supports more escape
1512 sequences that consist of backslash (\e) and a single character, but
1513 does not support decimal codes and does not require the leading 0 in
1514 octal notation. Example: fetchmail interprets \e233 the same as \exE9
1515 (Latin small letter e with acute), where C would interpret \e233 as
1516 octal 0233 = \ex9B (CSI, control sequence introducer).
1518 Each server entry consists of one of the keywords 'poll' or 'skip',
1519 followed by a server name, followed by server options, followed by any
1520 number of user (or username) descriptions, followed by user options.
1521 Note: the most common cause of syntax errors is mixing up user and
1522 server options or putting user options before the user descriptions.
1524 For backward compatibility, the word 'server' is a synonym for 'poll'.
1526 You can use the noise keywords 'and', 'with',
1527 \&'has', 'wants', and 'options' anywhere in an entry to make
1528 it resemble English. They're ignored, but but can make entries much
1529 easier to read at a glance. The punctuation characters ':', ';' and
1530 \&',' are also ignored.
1533 The 'poll' verb tells fetchmail to query this host when it is run with
1534 no arguments. The 'skip' verb tells
1536 not to poll this host unless it is explicitly named on the command
1537 line. (The 'skip' verb allows you to experiment with test entries
1538 safely, or easily disable entries for hosts that are temporarily down.)
1540 .SS Keyword/Option Summary
1541 Here are the legal options. Keyword suffixes enclosed in
1542 square brackets are optional. Those corresponding to short command-line
1543 options are followed by '\-' and the appropriate option letter. If
1544 option is only relevant to a single mode of operation, it is noted as
1545 \&'s' or 'm' for singledrop- or multidrop-mode, respectively.
1547 Here are the legal global options:
1551 Keyword Opt Mode Function
1553 set daemon \-d \& T{
1554 Set a background poll interval in seconds.
1556 set postmaster \& \& T{
1557 Give the name of the last-resort mail recipient (default: user running
1558 fetchmail, "postmaster" if run by the root user)
1560 set bouncemail \& \& T{
1561 Direct error mail to the sender (default)
1563 set no bouncemail \& \& T{
1564 Direct error mail to the local postmaster (as per the 'postmaster'
1565 global option above).
1567 set no spambounce \& \& T{
1568 Do not bounce spam-blocked mail (default).
1570 set spambounce \& \& T{
1571 Bounce blocked spam-blocked mail (as per the 'antispam' user option)
1572 back to the destination as indicated by the 'bouncemail' global option.
1573 Warning: Do not use this to bounce spam back to the sender - most spam
1574 is sent with false sender address and thus this option hurts innocent
1577 set logfile \-L \& T{
1578 Name of a file to append error and status messages to.
1580 set idfile \-i \& T{
1581 Name of the file to store UID lists in.
1584 Do error logging through syslog(3).
1586 set no syslog \& \& T{
1587 Turn off error logging through syslog(3). (default)
1589 set properties \& \& T{
1590 String value that is ignored by fetchmail (may be used by extension
1595 Here are the legal server options:
1599 Keyword Opt Mode Function
1602 Specify DNS name of mailserver, overriding poll name
1604 proto[col] \-p \& T{
1605 Specify protocol (case insensitive):
1606 POP2, POP3, IMAP, APOP, KPOP
1608 local[domains] \& m T{
1609 Specify domain(s) to be regarded as local
1612 Specify TCP/IP service port (obsolete, use 'service' instead).
1615 Specify service name (a numeric value is also allowed and
1616 considered a TCP/IP port number).
1618 auth[enticate] \& \& T{
1619 Set authentication type (default 'any')
1622 Server inactivity timeout in seconds (default 300)
1625 Specify envelope-address header name
1628 Disable looking for envelope address
1631 Qmail virtual domain prefix to remove from user name
1634 Specify alternate DNS names of mailserver
1637 specify IP interface(s) that must be up for server poll to take place
1640 Specify IP address to monitor for activity
1643 Specify command through which to make server connections.
1646 Specify command through which to make listener connections.
1649 Enable DNS lookup for multidrop (default)
1652 Disable DNS lookup for multidrop
1655 Do comparison by IP address for multidrop
1657 no checkalias \& m T{
1658 Do comparison by name for multidrop (default)
1661 Force POP3 to use client-side UIDLs (recommended)
1664 Turn off POP3 use of client-side UIDLs (default)
1667 Only check this site every N poll cycles; N is a numeric argument.
1670 Add poll tracing information to the Received header
1673 Set Kerberos principal (only useful with IMAP and kerberos)
1676 Set name for RFC2554 authentication to the ESMTP server.
1678 esmtppassword \& \& T{
1679 Set password for RFC2554 authentication to the ESMTP server.
1683 Here are the legal user descriptions and options:
1687 Keyword Opt Mode Function
1689 user[name] \-u \& T{
1690 This is the user description and must come first after server
1691 description and after possible server options, and before user options.
1693 It sets the remote user name if by itself or followed by 'there', or the
1694 local user name if followed by 'here'.
1697 Connect local and remote user names
1700 Connect local and remote user names
1703 Specify remote account password
1706 Connect to server over the specified base protocol using SSL encryption
1709 Specify file for client side public SSL certificate
1712 Specify file for client side private SSL key
1715 Force ssl protocol for connection
1718 Specify remote folder to query
1721 Specify smtp host(s) to forward to
1723 fetchdomains \& m T{
1724 Specify domains for which mail should be fetched
1726 smtpaddress \-D \& T{
1727 Specify the domain to be put in RCPT TO lines
1730 Specify the user and domain to be put in RCPT TO lines
1733 Specify what SMTP returns are interpreted as spam-policy blocks
1736 Specify MDA for local delivery
1739 Specify BSMTP batch file to append to
1742 Command to be executed before each connection
1744 postconnect \& \& T{
1745 Command to be executed after each connection
1748 Don't delete seen messages from server (for POP3, uidl is recommended)
1751 Flush all seen messages before querying (DANGEROUS)
1754 Flush all oversized messages before querying
1757 Fetch all messages whether seen or not
1760 Rewrite destination addresses for reply (default)
1763 Strip carriage returns from ends of lines
1766 Force carriage returns at ends of lines
1769 Force BODY=8BITMIME to ESMTP listener
1772 Strip Status and X-Mozilla-Status lines out of incoming mail
1774 dropdelivered \& \& T{
1775 Strip Delivered-To lines out of incoming mail
1778 Convert quoted-printable to 8-bit in MIME messages
1781 Idle waiting for new messages after each poll (IMAP only)
1784 Delete seen messages from server (default)
1787 Don't flush all seen messages before querying (default)
1789 no fetchall \& \& T{
1790 Retrieve only new messages (default)
1793 Don't rewrite headers
1796 Don't strip carriage returns (default)
1799 Don't force carriage returns at EOL (default)
1801 no pass8bits \& \& T{
1802 Don't force BODY=8BITMIME to ESMTP listener (default)
1804 no dropstatus \& \& T{
1805 Don't drop Status headers (default)
1807 no dropdelivered \& \& T{
1808 Don't drop Delivered\-To headers (default)
1810 no mimedecode \& \& T{
1811 Don't convert quoted-printable to 8-bit in MIME messages (default)
1814 Don't idle waiting for new messages after each poll (IMAP only)
1817 Set message size limit
1820 Set message size warning interval
1822 batchlimit \-b \& T{
1823 Max # messages to forward in single connect
1825 fetchlimit \-B \& T{
1826 Max # messages to fetch in single connect
1828 fetchsizelimit \& \& T{
1829 Max # message sizes to fetch in single transaction
1832 Use binary search for first unseen message (POP3 only)
1835 Perform an expunge on every #th message (IMAP and POP3 only)
1838 String value is ignored by fetchmail (may be used by extension scripts)
1842 All user options must begin with a user description (user or username
1843 option) and \fIfollow\fR all server descriptions and options.
1845 In the .fetchmailrc file, the 'envelope' string argument may be
1846 preceded by a whitespace-separated number. This number, if specified,
1847 is the number of such headers to skip over (that is, an argument of 1
1848 selects the second header of the given type). This is sometime useful
1849 for ignoring bogus envelope headers created by an ISP's local delivery
1850 agent or internal forwards (through mail inspection systems, for
1852 .SS Keywords Not Corresponding To Option Switches
1854 The 'folder' and 'smtphost' options (unlike their command-line
1855 equivalents) can take a space- or comma-separated list of names
1858 All options correspond to the obvious command-line arguments, except
1859 the following: 'via', 'interval', 'aka', 'is', 'to', 'dns'/'no dns',
1860 \&'checkalias'/'no checkalias', 'password', 'preconnect', 'postconnect',
1861 \&'localdomains', 'stripcr'/'no stripcr', 'forcecr'/'no forcecr',
1862 \&'pass8bits'/'no pass8bits' 'dropstatus/no dropstatus',
1863 \&'dropdelivered/no dropdelivered', 'mimedecode/no mimedecode', 'no idle',
1866 The 'via' option is for if you want to have more
1867 than one configuration pointing at the same site. If it is present,
1868 the string argument will be taken as the actual DNS name of the
1869 mailserver host to query.
1870 This will override the argument of poll, which can then simply be a
1871 distinct label for the configuration (e.g. what you would give on the
1872 command line to explicitly query this host).
1874 The 'interval' option (which takes a numeric argument) allows you to poll a
1875 server less frequently than the basic poll interval. If you say
1876 \&'interval N' the server this option is attached to will only be
1877 queried every N poll intervals.
1878 .SS Singledrop vs. Multidrop options
1880 Please ensure you read the section titled
1881 .B THE USE AND ABUSE OF MULTIDROP MAILBOXES
1882 if you intend to use multidrop mode.
1884 The 'is' or 'to' keywords associate the following local (client)
1885 name(s) (or server-name to client-name mappings separated by =) with
1886 the mailserver user name in the entry. If an is/to list has '*' as
1887 its last name, unrecognized names are simply passed through. Note that
1888 until \fIfetchmail\fR version 6.3.4 inclusively, these lists could only
1889 contain local parts of user names (fetchmail would only look at the part
1890 before the @ sign). \fIfetchmail\fR versions 6.3.5 and
1891 newer support full addresses on the left hand side of these mappings,
1892 and they take precedence over any 'localdomains', 'aka', 'via' or
1895 A single local name can be used to support redirecting your mail when
1896 your username on the client machine is different from your name on the
1897 mailserver. When there is only a single local name, mail is forwarded
1898 to that local username regardless of the message's Received, To, Cc,
1899 and Bcc headers. In this case,
1901 never does DNS lookups.
1903 When there is more than one local name (or name mapping),
1904 \fIfetchmail\fR looks at the envelope header, if configured, and
1905 otherwise at the Received, To, Cc, and Bcc headers of retrieved mail
1906 (this is 'multidrop mode'). It looks for addresses with hostname parts
1907 that match your poll name or your 'via', 'aka' or 'localdomains'
1908 options, and usually also for hostname parts which DNS tells it are
1909 aliases of the mailserver. See the discussion of 'dns', 'checkalias',
1910 \&'localdomains', and 'aka' for details on how matching addresses are
1913 If \fIfetchmail\fR cannot match any mailserver usernames or
1914 localdomain addresses, the mail will be bounced.
1915 Normally it will be bounced to the sender, but if the 'bouncemail'
1916 global option is off, the mail will go to the local postmaster instead.
1917 (see the 'postmaster' global option). See also BUGS.
1919 The 'dns' option (normally on) controls the way addresses from
1920 multidrop mailboxes are checked. On, it enables logic to check each
1921 host address that does not match an 'aka' or 'localdomains' declaration
1922 by looking it up with DNS. When a mailserver username is recognized
1923 attached to a matching hostname part, its local mapping is added to
1924 the list of local recipients.
1926 The 'checkalias' option (normally off) extends the lookups performed
1927 by the 'dns' keyword in multidrop mode, providing a way to cope with
1928 remote MTAs that identify themselves using their canonical name, while
1929 they're polled using an alias.
1930 When such a server is polled, checks to extract the envelope address
1933 reverts to delivery using the To/Cc/Bcc headers (See below
1934 \&'Header vs. Envelope addresses').
1935 Specifying this option instructs
1937 to retrieve all the IP addresses associated with both the poll name
1938 and the name used by the remote MTA and to do a comparison of the IP
1939 addresses. This comes in handy in situations where the remote server
1940 undergoes frequent canonical name changes, that would otherwise
1941 require modifications to the rcfile. 'checkalias' has no effect if
1942 \&'no dns' is specified in the rcfile.
1944 The 'aka' option is for use with multidrop mailboxes. It allows you
1945 to pre-declare a list of DNS aliases for a server. This is an
1946 optimization hack that allows you to trade space for speed. When
1948 while processing a multidrop mailbox, grovels through message headers
1949 looking for names of the mailserver, pre-declaring common ones can
1950 save it from having to do DNS lookups. Note: the names you give
1951 as arguments to 'aka' are matched as suffixes -- if you specify
1952 (say) 'aka netaxs.com', this will match not just a hostname
1953 netaxs.com, but any hostname that ends with '.netaxs.com'; such as
1954 (say) pop3.netaxs.com and mail.netaxs.com.
1956 The 'localdomains' option allows you to declare a list of domains
1957 which fetchmail should consider local. When fetchmail is parsing
1958 address lines in multidrop modes, and a trailing segment of a host
1959 name matches a declared local domain, that address is passed through
1960 to the listener or MDA unaltered (local-name mappings are \fInot\fR
1963 If you are using 'localdomains', you may also need to specify 'no
1964 envelope', which disables \fIfetchmail\fR's normal attempt to deduce
1965 an envelope address from the Received line or X-Envelope-To header or
1966 whatever header has been previously set by 'envelope'. If you set 'no
1967 envelope' in the defaults entry it is possible to undo that in
1968 individual entries by using 'envelope <string>'. As a special case,
1969 \&'envelope "Received"' restores the default parsing of
1972 The \fBpassword\fR option requires a string argument, which is the password
1973 to be used with the entry's server.
1975 The 'preconnect' keyword allows you to specify a shell command to be
1976 executed just before each time
1978 establishes a mailserver connection. This may be useful if you are
1979 attempting to set up secure POP connections with the aid of
1981 If the command returns a nonzero status, the poll of that mailserver
1984 Similarly, the 'postconnect' keyword similarly allows you to specify a
1985 shell command to be executed just after each time a mailserver
1986 connection is taken down.
1988 The 'forcecr' option controls whether lines terminated by LF only are
1989 given CRLF termination before forwarding. Strictly speaking RFC821
1990 requires this, but few MTAs enforce the requirement it so this option
1991 is normally off (only one such MTA, qmail, is in significant use at
1994 The 'stripcr' option controls whether carriage returns are stripped
1995 out of retrieved mail before it is forwarded. It is normally not
1996 necessary to set this, because it defaults to 'on' (CR stripping
1997 enabled) when there is an MDA declared but 'off' (CR stripping
1998 disabled) when forwarding is via SMTP. If 'stripcr' and 'forcecr' are
1999 both on, 'stripcr' will override.
2001 The 'pass8bits' option exists to cope with Microsoft mail programs that
2002 stupidly slap a "Content-Transfer-Encoding: 7bit" on everything. With
2003 this option off (the default) and such a header present,
2005 declares BODY=7BIT to an ESMTP-capable listener; this causes problems for
2006 messages actually using 8-bit ISO or KOI-8 character sets, which will
2007 be garbled by having the high bits of all characters stripped. If
2008 \&'pass8bits' is on,
2010 is forced to declare BODY=8BITMIME to any ESMTP-capable listener. If
2011 the listener is 8-bit-clean (as all the major ones now are) the right
2012 thing will probably result.
2014 The 'dropstatus' option controls whether nonempty Status and
2015 X-Mozilla-Status lines are retained in fetched mail (the default) or
2016 discarded. Retaining them allows your MUA to see what messages (if
2017 any) were marked seen on the server. On the other hand, it can
2018 confuse some new-mail notifiers, which assume that anything with a
2019 Status line in it has been seen. (Note: the empty Status lines
2020 inserted by some buggy POP servers are unconditionally discarded.)
2022 The 'dropdelivered' option controls whether Delivered\-To headers will
2023 be kept in fetched mail (the default) or discarded. These headers are
2024 added by Qmail and Postfix mailservers in order to avoid mail loops but
2025 may get in your way if you try to "mirror" a mailserver within the same
2026 domain. Use with caution.
2028 The 'mimedecode' option controls whether MIME messages using the
2029 quoted-printable encoding are automatically converted into pure 8-bit
2030 data. If you are delivering mail to an ESMTP-capable, 8-bit-clean
2031 listener (that includes all of the major MTAs like sendmail), then
2032 this will automatically convert quoted-printable message headers and
2033 data into 8-bit data, making it easier to understand when reading
2034 mail. If your e-mail programs know how to deal with MIME messages,
2035 then this option is not needed. The mimedecode option is off by
2036 default, because doing RFC2047 conversion on headers throws away
2037 character-set information and can lead to bad results if the encoding
2038 of the headers differs from the body encoding.
2040 The 'idle' option is intended to be used with IMAP servers supporting
2041 the RFC2177 IDLE command extension, but does not strictly require it.
2042 If it is enabled, and fetchmail detects that IDLE is supported, an
2043 IDLE will be issued at the end of each poll. This will tell the IMAP
2044 server to hold the connection open and notify the client when new mail
2045 is available. If IDLE is not supported, fetchmail will simulate it by
2046 periodically issuing NOOP. If you need to poll a link frequently, IDLE
2047 can save bandwidth by eliminating TCP/IP connects and LOGIN/LOGOUT
2048 sequences. On the other hand, an IDLE connection will eat almost all
2049 of your fetchmail's time, because it will never drop the connection
2050 and allow other polls to occur unless the server times out the IDLE.
2051 It also doesn't work with multiple folders; only the first folder will
2055 The 'properties' option is an extension mechanism. It takes a string
2056 argument, which is ignored by fetchmail itself. The string argument may be
2057 used to store configuration information for scripts which require it.
2058 In particular, the output of '\-\-configdump' option will make properties
2059 associated with a user entry readily available to a Python script.
2061 .SS Miscellaneous Run Control Options
2062 The words 'here' and 'there' have useful English-like
2063 significance. Normally 'user eric is esr' would mean that
2064 mail for the remote user 'eric' is to be delivered to 'esr',
2065 but you can make this clearer by saying 'user eric there is esr here',
2066 or reverse it by saying 'user esr here is eric there'
2068 Legal protocol identifiers for use with the 'protocol' keyword are:
2071 auto (or AUTO) (legacy, to be removed from future release)
2072 pop2 (or POP2) (legacy, to be removed from future release)
2081 Legal authentication types are 'any', 'password', 'kerberos',
2082 \&'kerberos_v4', 'kerberos_v5' and 'gssapi', 'cram\-md5', 'otp', 'msn'
2083 (only for POP3), 'ntlm', 'ssh', 'external' (only IMAP).
2084 The 'password' type specifies
2085 authentication by normal transmission of a password (the password may be
2086 plain text or subject to protocol-specific encryption as in CRAM-MD5);
2087 \&'kerberos' tells \fIfetchmail\fR to try to get a Kerberos ticket at the
2088 start of each query instead, and send an arbitrary string as the
2089 password; and 'gssapi' tells fetchmail to use GSSAPI authentication.
2090 See the description of the 'auth' keyword for more.
2092 Specifying 'kpop' sets POP3 protocol over port 1109 with Kerberos V4
2093 authentication. These defaults may be overridden by later options.
2095 There are some global option statements: 'set logfile'
2096 followed by a string sets the same global specified by \-\-logfile. A
2097 command-line \-\-logfile option will override this. Note that \-\-logfile is
2098 only effective if fetchmail detaches itself from the terminal and the
2099 logfile already exists before fetchmail is run. Also,
2100 \&'set daemon' sets the poll interval as \-\-daemon does. This can be
2101 overridden by a command-line \-\-daemon option; in particular \-\-daemon\~0
2102 can be used to force foreground operation. The 'set postmaster'
2103 statement sets the address to which multidrop mail defaults if there are
2104 no local matches. Finally, 'set syslog' sends log messages to
2107 .SH DEBUGGING FETCHMAIL
2108 .SS Fetchmail crashing
2109 There are various ways in that fetchmail may "crash", i. e. stop
2110 operation suddenly and unexpectedly. A "crash" usually refers to an
2111 error condition that the software did not handle by itself. A well-known
2112 failure mode is the "segmentation fault" or "signal 11" or "SIGSEGV" or
2113 just "segfault" for short. These can be caused by hardware or by software
2114 problems. Software-induced segfaults can usually be reproduced easily
2115 and in the same place, whereas hardware-induced segfaults can go away if
2116 the computer is rebooted, or powered off for a few hours, and can happen
2117 in random locations even if you use the software the same way.
2119 For solving hardware-induced segfaults, find the faulty component and repair or
2120 replace it. <http://www.bitwizard.nl/sig11/> may help you with details.
2122 For solving software-induced segfaults, the developers may need a "stack
2125 .SS Enabling fetchmail core dumps
2126 By default, fetchmail suppresses core dumps as these might contain
2127 passwords and other sensitive information. For debugging fetchmail
2128 crashes, obtaining a "stack backtrace" from a core dump is often the
2129 quickest way to solve the problem, and when posting your problem on a
2130 mailing list, the developers may ask you for a "backtrace".
2132 1. To get useful backtraces, fetchmail needs to be installed without
2133 getting stripped of its compilation symbols. Unfortunately, most
2134 binary packages that are installed are stripped, and core files from
2135 symbol-stripped programs are worthless. So you may need to recompile
2136 fetchmail. On many systems, you can type
2139 file `which fetchmail`
2142 to find out if fetchmail was symbol-stripped or not. If yours was
2143 unstripped, fine, proceed, if it was stripped, you need to recompile the
2144 source code first. You do not usually need to install fetchmail in order
2147 2. The shell environment that starts fetchmail needs to enable core
2148 dumps. The key is the "maximum core (file) size" that can usually be
2149 configured with a tool named "limit" or "ulimit". See the documentation
2150 for your shell for details. In the popular bash shell, "ulimit \-Sc
2151 unlimited" will allow the core dump.
2153 3. You need to tell fetchmail, too, to allow core dumps. To do
2154 this, run fetchmail with the \fB\-d0 \-v\fP options. It is often easier
2155 to also add \fB\-\-nosyslog \-N\fR as well.
2157 Finally, you need to reproduce the crash. You can just start fetchmail
2158 from the directory where you compiled it by typing \fB./fetchmail\fR,
2159 so the complete command line will start with \fB./fetchmail \-Nvd0
2160 \&\-\-nosyslog\fR and perhaps list your other options.
2162 After the crash, run your debugger to obtain the core dump. The
2163 debugger will often be GNU GDB, you can then type (adjust paths as
2164 necessary) \fBgdb ./fetchmail fetchmail.core\fR and then, after GDB
2165 has started up and read all its files, type \fBbacktrace full\fR, save
2166 the output (copy & paste will do, the backtrace will be read by a human)
2167 and then type \fBquit\fR to leave gdb.
2169 on some systems, the core
2170 files have different names, they might contain a number instead of the
2171 program name, or number and name, but it will usually have "core" as
2174 .SH INTERACTION WITH RFC 822
2175 When trying to determine the originating address of a message,
2176 fetchmail looks through headers in the following order:
2180 Resent-Sender: (ignored if it doesn't contain an @ or !)
2181 Sender: (ignored if it doesn't contain an @ or !)
2188 The originating address is used for logging, and to set the MAIL FROM
2189 address when forwarding to SMTP. This order is intended to cope
2190 gracefully with receiving mailing list messages in multidrop mode. The
2191 intent is that if a local address doesn't exist, the bounce message
2192 won't be returned blindly to the author or to the list itself, but
2193 rather to the list manager (which is less annoying).
2195 In multidrop mode, destination headers are processed as follows:
2196 First, fetchmail looks for the header specified by the 'envelope' option
2197 in order to determine the local recipient address. If the mail is
2198 addressed to more than one recipient, the Received line won't contain
2199 any information regarding recipient addresses.
2201 Then fetchmail looks for the Resent-To:, Resent-Cc:, and Resent-Bcc:
2202 lines. If they exist, they should contain the final recipients and
2203 have precedence over their To:/Cc:/Bcc: counterparts. If the Resent\-*
2204 lines don't exist, the To:, Cc:, Bcc: and Apparently-To: lines are
2205 looked for. (The presence of a Resent\-To: is taken to imply that the
2206 person referred by the To: address has already received the original
2209 .SH CONFIGURATION EXAMPLES
2210 Note that although there are password declarations in a good many
2211 of the examples below, this is mainly for illustrative purposes.
2212 We recommend stashing account/password pairs in your $HOME/.netrc
2213 file, where they can be used not just by fetchmail but by ftp(1) and
2219 poll SERVERNAME protocol PROTOCOL username NAME password PASSWORD
2225 poll pop.provider.net protocol pop3 username "jsmith" password "secret1" ssl
2228 Or, using some abbreviations:
2231 poll pop.provider.net proto pop3 user "jsmith" password "secret1"
2234 Multiple servers may be listed:
2237 poll pop.provider.net proto pop3 user "jsmith" pass "secret1"
2238 poll other.provider.net proto pop2 user "John.Smith" pass "My^Hat"
2241 Here's a version of those two with more whitespace and some noise words:
2244 poll pop.provider.net proto pop3
2245 user "jsmith", with password secret1, is "jsmith" here;
2246 poll other.provider.net proto pop2:
2247 user "John.Smith", with password "My^Hat", is "John.Smith" here;
2250 This version is much easier to read and doesn't cost significantly
2251 more (parsing is done only once, at startup time).
2254 If you need to include whitespace in a parameter string or start the
2255 latter with a number, enclose the string in double quotes. Thus:
2258 poll mail.provider.net with proto pop3:
2259 user "jsmith" there has password "4u but u can't krak this"
2260 is jws here and wants mda "/bin/mail"
2263 You may have an initial server description headed by the keyword
2264 \&'defaults' instead of 'poll' followed by a name. Such a record
2265 is interpreted as defaults for all queries to use. It may be overwritten
2266 by individual server descriptions. So, you could write:
2271 poll pop.provider.net
2273 poll mail.provider.net
2274 user "jjsmith" there has password "secret2"
2277 It's possible to specify more than one user per server.
2278 The 'user' keyword leads off a user description, and every user specification
2279 in a multi-user entry must include it. Here's an example:
2282 poll pop.provider.net proto pop3 port 3111
2283 user "jsmith" with pass "secret1" is "smith" here
2284 user jones with pass "secret2" is "jjones" here keep
2287 This associates the local username 'smith' with the pop.provider.net
2288 username 'jsmith' and the local username 'jjones' with the
2289 pop.provider.net username 'jones'. Mail for 'jones' is kept on the
2290 server after download.
2292 Here's what a simple retrieval configuration for a multidrop mailbox
2296 poll pop.provider.net:
2297 user maildrop with pass secret1 to golux 'hurkle'='happy' snark here
2300 This says that the mailbox of account 'maildrop' on the server is a
2301 multidrop box, and that messages in it should be parsed for the
2302 server user names 'golux', 'hurkle', and 'snark'. It further
2303 specifies that 'golux' and 'snark' have the same name on the
2304 client as on the server, but mail for server user 'hurkle' should be
2305 delivered to client user 'happy'.
2310 until version 6.3.4, did NOT allow full user@domain specifications here,
2311 these would never match. \fIFetchmail\fP 6.3.5 and newer support
2312 user@domain specifications on the left-hand side of a user mapping.
2314 Here's an example of another kind of multidrop connection:
2317 poll pop.provider.net localdomains loonytoons.org toons.org
2318 envelope X-Envelope-To
2319 user maildrop with pass secret1 to * here
2322 This also says that the mailbox of account 'maildrop' on the server is
2323 a multidrop box. It tells fetchmail that any address in the
2324 loonytoons.org or toons.org domains (including sub-domain addresses like
2325 \&'joe@daffy.loonytoons.org') should be passed through to the local SMTP
2326 listener without modification. Be careful of mail loops if you do this!
2328 Here's an example configuration using ssh and the plugin option. The
2329 queries are made directly on the stdin and stdout of imapd via ssh.
2330 Note that in this setup, IMAP authentication can be skipped.
2333 poll mailhost.net with proto imap:
2334 plugin "ssh %h /usr/sbin/imapd" auth ssh;
2335 user esr is esr here
2338 .SH THE USE AND ABUSE OF MULTIDROP MAILBOXES
2339 Use the multiple-local-recipients feature with caution -- it can bite.
2340 All multidrop features are ineffective in ETRN and ODMR modes.
2342 Also, note that in multidrop mode duplicate mails are suppressed. A
2343 piece of mail is considered duplicate if it has the same message-ID as
2344 the message immediately preceding and more than one addressee. Such
2345 runs of messages may be generated when copies of a message addressed
2346 to multiple users are delivered to a multidrop box.
2348 .SS Header vs. Envelope addresses
2349 The fundamental problem is that by having your mailserver toss several
2350 peoples' mail in a single maildrop box, you may have thrown away
2351 potentially vital information about who each piece of mail was
2352 actually addressed to (the 'envelope address', as opposed to the
2353 header addresses in the RFC822 To/Cc headers - the Bcc is not available
2354 at the receiving end). This 'envelope address' is the address you need
2355 in order to reroute mail properly.
2359 can deduce the envelope address. If the mailserver MTA is
2361 and the item of mail had just one recipient, the MTA will have written
2362 a 'by/for' clause that gives the envelope addressee into its Received
2363 header. But this doesn't work reliably for other MTAs, nor if there is
2364 more than one recipient. By default, \fIfetchmail\fR looks for
2365 envelope addresses in these lines; you can restore this default with
2366 \&\-E "Received" or 'envelope Received'.
2368 .B As a better alternative,
2369 some SMTP listeners and/or mail servers insert a header
2370 in each message containing a copy of the envelope addresses. This
2371 header (when it exists) is often 'X\-Original\-To', 'Delivered\-To' or
2372 \&'X\-Envelope\-To'. Fetchmail's assumption about this can be changed with
2373 the \-E or 'envelope' option. Note that writing an envelope header of
2374 this kind exposes the names of recipients (including blind-copy
2375 recipients) to all receivers of the messages, so the upstream must store
2376 one copy of the message per recipient to avoid becoming a privacy problem.
2378 Postfix, since version 2.0, writes an X\-Original\-To: header which
2379 contains a copy of the envelope as it was received.
2381 Qmail and Postfix generally write a 'Delivered\-To' header upon
2382 delivering the message to the mail spool and use it to avoid mail loops.
2383 Qmail virtual domains however will prefix the user name with a string
2384 that normally matches the user's domain. To remove this prefix you can
2385 use the \-Q or 'qvirtual' option.
2387 Sometimes, unfortunately, neither of these methods works. That is the
2388 point when you should contact your ISP and ask them to provide such an
2389 envelope header, and you should not use multidrop in this situation.
2390 When they all fail, fetchmail must fall back on the contents of To/Cc
2391 headers (Bcc headers are not available - see below) to try to determine
2392 recipient addressees -- and these are unreliable.
2393 In particular, mailing-list software often ships mail with only
2394 the list broadcast address in the To header.
2396 .B Note that a future version of \fIfetchmail\fP may remove To/Cc parsing!
2400 cannot deduce a recipient address that is local, and the intended
2401 recipient address was anyone other than fetchmail's invoking user,
2402 .B mail will get lost.
2403 This is what makes the multidrop feature risky without proper envelope
2406 A related problem is that when you blind-copy a mail message, the Bcc
2407 information is carried \fIonly\fR as envelope address (it's removed from
2408 the headers by the sending mail server, so fetchmail can see it only if
2409 there is an X-\Envelope\-To header). Thus, blind-copying to someone who
2410 gets mail over a fetchmail multidrop link will fail unless the the
2411 mailserver host routinely writes X\-Envelope\-To or an equivalent header
2412 into messages in your maildrop.
2414 \fBIn conclusion, mailing lists and Bcc'd mail can only work if the
2415 server you're fetching from (1) stores one copy of the message per
2416 recipient in \fIyour\fP domain and (2) records the envelope
2417 information in a special header (X\-Original\-To, Delivered\-To,
2418 X\-Envelope\-To).\fR
2420 .SS Good Ways To Use Multidrop Mailboxes
2421 Multiple local names can be used to administer a mailing list from the
2422 client side of a \fIfetchmail\fR collection. Suppose your name is
2423 \&'esr', and you want to both pick up your own mail and maintain a mailing
2424 list called (say) "fetchmail-friends", and you want to keep the alias
2425 list on your client machine.
2427 On your server, you can alias 'fetchmail\-friends' to 'esr'; then, in
2428 your \fI.fetchmailrc\fR, declare 'to esr fetchmail\-friends here'.
2429 Then, when mail including 'fetchmail\-friends' as a local address
2430 gets fetched, the list name will be appended to the list of
2431 recipients your SMTP listener sees. Therefore it will undergo alias
2432 expansion locally. Be sure to include 'esr' in the local alias
2433 expansion of fetchmail\-friends, or you'll never see mail sent only to
2434 the list. Also be sure that your listener has the "me-too" option set
2435 (sendmail's \-oXm command-line option or OXm declaration) so your name
2436 isn't removed from alias expansions in messages you send.
2438 This trick is not without its problems, however. You'll begin to see
2439 this when a message comes in that is addressed only to a mailing list
2440 you do \fInot\fR have declared as a local name. Each such message
2441 will feature an 'X\-Fetchmail\-Warning' header which is generated
2442 because fetchmail cannot find a valid local name in the recipient
2443 addresses. Such messages default (as was described above) to being
2444 sent to the local user running
2446 but the program has no way to know that that's actually the right thing.
2448 .SS Bad Ways To Abuse Multidrop Mailboxes
2449 Multidrop mailboxes and
2451 serving multiple users in daemon mode do not mix. The problem, again, is
2452 mail from mailing lists, which typically does not have an individual
2453 recipient address on it. Unless
2455 can deduce an envelope address, such mail will only go to the account
2456 running fetchmail (probably root). Also, blind-copied users are very
2457 likely never to see their mail at all.
2459 If you're tempted to use
2461 to retrieve mail for multiple users from a single mail drop via POP or
2462 IMAP, think again (and reread the section on header and envelope
2463 addresses above). It would be smarter to just let the mail sit in the
2464 mailserver's queue and use fetchmail's ETRN or ODMR modes to trigger
2465 SMTP sends periodically (of course, this means you have to poll more
2466 frequently than the mailserver's expiry period). If you can't arrange
2467 this, try setting up a UUCP feed.
2469 If you absolutely \fImust\fR use multidrop for this purpose, make sure
2470 your mailserver writes an envelope-address header that fetchmail can
2471 see. Otherwise you \fIwill\fR lose mail and it \fIwill\fR come back
2474 .SS Speeding Up Multidrop Checking
2475 Normally, when multiple users are declared
2477 extracts recipient addresses as described above and checks each host
2478 part with DNS to see if it's an alias of the mailserver. If so, the
2479 name mappings described in the "to ... here" declaration are done and
2480 the mail locally delivered.
2482 This is a convenient but also slow method. To speed
2483 it up, pre-declare mailserver aliases with 'aka'; these are checked
2484 before DNS lookups are done. If you're certain your aka list contains
2486 DNS aliases of the mailserver (and all MX names pointing at it - note
2487 this may change in a future version)
2488 you can declare 'no dns' to suppress DNS lookups entirely and
2489 \fIonly\fR match against the aka list.
2492 Support for socks4/5 is a \fBcompile time\fP configuration option. Once
2493 compiled in, fetchmail will always use the socks libraries and
2494 configuration on your system, there are no run-time switches in
2495 fetchmail - but you can still configure SOCKS: you can specify which
2496 SOCKS configuration file is used in the \fBSOCKS_CONF\fP environment
2499 For instance, if you wanted to bypass the SOCKS proxy altogether and
2500 have fetchmail connect directly, you could just pass
2501 SOCKS_CONF=/dev/null in the environment, for example (add your usual
2502 command line options - if any - to the end of this line):
2505 env SOCKS_CONF=/dev/null fetchmail
2509 To facilitate the use of
2511 in shell scripts, an exit\ status code is returned to give an indication
2512 of what occurred during a given connection.
2514 The exit codes returned by
2518 One or more messages were successfully retrieved (or, if the \-c option
2519 was selected, were found waiting but not retrieved).
2521 There was no mail awaiting retrieval. (There may have been old mail still
2522 on the server but not selected for retrieval.)
2524 An error was encountered when attempting to open a socket to retrieve
2525 mail. If you don't know what a socket is, don't worry about it --
2526 just treat this as an 'unrecoverable error'. This error can also be
2527 because a protocol fetchmail wants to use is not listed in /etc/services.
2529 The user authentication step failed. This usually means that a bad
2530 user-id, password, or APOP id was specified. Or it may mean that you
2531 tried to run fetchmail under circumstances where it did not have
2532 standard input attached to a terminal and could not prompt for a
2535 Some sort of fatal protocol error was detected.
2537 There was a syntax error in the arguments to
2538 \fIfetchmail\fP, or a pre- or post-connect command failed.
2540 The run control file had bad permissions.
2542 There was an error condition reported by the server. Can also
2545 timed out while waiting for the server.
2547 Client-side exclusion error. This means
2549 either found another copy of itself already running, or failed in such
2550 a way that it isn't sure whether another copy is running.
2552 The user authentication step failed because the server responded "lock
2553 busy". Try again after a brief pause! This error is not implemented
2554 for all protocols, nor for all servers. If not implemented for your
2555 server, "3" will be returned instead, see above. May be returned when
2556 talking to qpopper or other servers that can respond with "lock busy"
2557 or some similar text containing the word "lock".
2561 run failed while trying to do an SMTP port open or transaction.
2563 Fatal DNS error. Fetchmail encountered an error while performing
2564 a DNS lookup at startup and could not proceed.
2566 BSMTP batch file could not be opened.
2568 Poll terminated by a fetch limit (see the \-\-fetchlimit option).
2570 Server busy indication.
2572 Internal error. You should see a message on standard error with
2574 .IP "24 - 26, 28, 29"
2575 These are internal codes and should not appear externally.
2579 queries more than one host, return status is 0 if \fIany\fR query
2580 successfully retrieved mail. Otherwise the returned error status is
2581 that of the last host queried.
2586 default run control file
2589 default location of file recording last message UIDs seen per host.
2592 lock file to help prevent concurrent runs (non-root mode).
2595 your FTP run control file, which (if present) will be searched for
2596 passwords as a last resort before prompting for one interactively.
2598 /var/run/fetchmail.pid
2599 lock file to help prevent concurrent runs (root mode, Linux systems).
2602 lock file to help prevent concurrent runs (root mode, systems without /var/run).
2606 If the FETCHMAILUSER variable is set, it is used as the name of the
2607 calling user (default local name) for purposes such as mailing error
2608 notifications. Otherwise, if either the LOGNAME or USER variable is
2609 correctly set (e.g. the corresponding UID matches the session user ID)
2610 then that name is used as the default local name. Otherwise
2611 \fBgetpwuid\fR(3) must be able to retrieve a password entry for the
2612 session ID (this elaborate logic is designed to handle the case of
2613 multiple names per userid gracefully).
2616 If the environment variable FETCHMAILHOME is set to a valid and
2617 existing directory name, fetchmail will read $FETCHMAILHOME/fetchmailrc
2618 (the dot is missing in this case), $FETCHMAILHOME/.fetchids and
2619 $FETCHMAILHOME/.fetchmail.pid rather than from the user's home
2620 directory. The .netrc file is always looked for in the the invoking
2621 user's home directory regardless of FETCHMAILHOME's setting.
2624 If the HOME_ETC variable is set, fetchmail will read
2625 $HOME_ETC/.fetchmailrc instead of ~/.fetchmailrc.
2627 If HOME_ETC and FETCHMAILHOME are both set, HOME_ETC will be ignored.
2630 (only if SOCKS support is compiled in) this variable is used by the
2631 socks library to find out which configuration file it should read. Set
2632 this to /dev/null to bypass the SOCKS proxy.
2637 daemon is running as root, SIGUSR1 wakes it up from its sleep phase and
2638 forces a poll of all non-skipped servers. For compatibility reasons,
2639 SIGHUP can also be used in 6.3.X but may not be available in future
2644 is running in daemon mode as non-root, use SIGUSR1 to wake it (this is
2645 so SIGHUP due to logout can retain the default action of killing it).
2649 in foreground while a background fetchmail is running will do
2650 whichever of these is appropriate to wake it up.
2652 .SH BUGS AND KNOWN PROBLEMS
2654 Please check the \fBNEWS\fP file that shipped with fetchmail for more
2655 known bugs than those listed here.
2657 Fetchmail cannot handle user names that contain blanks after a "@"
2658 character, for instance "demonstr@ti on". These are rather uncommon and
2659 only hurt when using UID-based \-\-keep setups, so the 6.3.X versions of
2660 fetchmail won't be fixed.
2662 The assumptions that the DNS and in particular the checkalias options
2663 make are not often sustainable. For instance, it has become uncommon for
2664 an MX server to be a POP3 or IMAP server at the same time. Therefore the
2665 MX lookups may go away in a future release.
2667 The mda and plugin options interact badly. In order to collect error
2668 status from the MDA, fetchmail has to change its normal signal
2669 handling so that dead plugin processes don't get reaped until the end
2670 of the poll cycle. This can cause resource starvation if too many
2671 zombies accumulate. So either don't deliver to a MDA using plugins or
2672 risk being overrun by an army of undead.
2674 The \-\-interface option does not support IPv6 and it is doubtful if it
2675 ever will, since there is no portable way to query interface IPv6
2678 The RFC822 address parser used in multidrop mode chokes on some
2679 @-addresses that are technically legal but bizarre. Strange uses of
2680 quoting and embedded comments are likely to confuse it.
2682 In a message with multiple envelope headers, only the last one
2683 processed will be visible to fetchmail.
2685 Use of some of these protocols requires that the program send
2686 unencrypted passwords over the TCP/IP connection to the mailserver.
2687 This creates a risk that name/password pairs might be snaffled with a
2688 packet sniffer or more sophisticated monitoring software. Under Linux
2689 and FreeBSD, the \-\-interface option can be used to restrict polling to
2690 availability of a specific interface device with a specific local or
2691 remote IP address, but snooping is still possible if (a) either host
2692 has a network device that can be opened in promiscuous mode, or (b)
2693 the intervening network link can be tapped. We recommend the use of
2695 tunnelling to not only shroud your passwords but encrypt the entire
2698 Use of the %F or %T escapes in an mda option could open a security
2699 hole, because they pass text manipulable by an attacker to a shell
2700 command. Potential shell characters are replaced by '_' before
2701 execution. The hole is further reduced by the fact that fetchmail
2702 temporarily discards any suid privileges it may have while running the
2703 MDA. For maximum safety, however, don't use an mda command containing
2704 %F or %T when fetchmail is run from the root account itself.
2706 Fetchmail's method of sending bounces due to errors or spam-blocking and
2707 spam bounces requires that port 25 of localhost be available for sending
2712 while a background instance is running and break the syntax, the
2713 background instance will die silently. Unfortunately, it can't
2714 die noisily because we don't yet know whether syslog should be enabled.
2715 On some systems, fetchmail dies quietly even if there is no syntax
2716 error; this seems to have something to do with buggy terminal ioctl
2719 The \-f\~\- option (reading a configuration from stdin) is incompatible
2720 with the plugin option.
2722 The 'principal' option only handles Kerberos IV, not V.
2724 Interactively entered passwords are truncated after 63 characters. If
2725 you really need to use a longer password, you will have to use a
2728 A backslash as the last character of a configuration file will be
2729 flagged as a syntax error rather than ignored.
2731 The BSMTP error handling is virtually nonexistent and may leave broken
2734 Send comments, bug reports, gripes, and the like to the
2735 fetchmail\-devel list <fetchmail\-devel@lists.berlios.de>. An HTML FAQ is
2736 available at the fetchmail home page; surf to
2737 http://fetchmail.berlios.de/ or do a WWW search for pages with
2738 \&'fetchmail' in their titles.
2741 Fetchmail is currently maintained by Matthias Andree and Rob Funk with
2742 major assistance from Sunil Shetye (for code) and Rob MacGregor (for the
2745 Most of the code is from Eric S. Raymond <esr@snark.thyrsus.com>. Too
2746 many other people to name here have contributed code and patches.
2748 This program is descended from and replaces
2750 by Carl Harris <ceharris@mal.com>; the internals have become quite different,
2751 but some of its interface design is directly traceable to that
2754 This manual page has been improved by R.\ Hannes Beinert and H\['e]ctor
2758 mutt(1), elm(1), mail(1), sendmail(8), popd(8), imapd(8), netrc(5)
2760 The fetchmail home page: <http://fetchmail.berlios.de/>
2762 The maildrop home page: <http://www.courier-mta.org/maildrop/>
2763 .SH APPLICABLE STANDARDS
2765 Note that this list is just a collection of references and not a
2766 statement as to the actual protocol conformance or requirements in
2770 RFC 821, RFC 2821, RFC 1869, RFC 1652, RFC 1870, RFC 1983, RFC 1985,
2774 RFC 822, RFC 2822, RFC 1123, RFC 1892, RFC 1894.
2780 RFC 1081, RFC 1225, RFC 1460, RFC 1725, RFC 1734, RFC 1939, RFC 1957,
2793 RFC 1730, RFC 1731, RFC 1732, RFC 2060, RFC 2061, RFC 2195, RFC 2177,
projects / ~andy / fetchmail / blob