diff options
Diffstat (limited to 'fetchmail.man')
| -rw-r--r-- | fetchmail.man | 310 |
1 files changed, 155 insertions, 155 deletions
diff --git a/fetchmail.man b/fetchmail.man index f46ffa23..b8d5b1de 100644 --- a/fetchmail.man +++ b/fetchmail.man @@ -99,7 +99,7 @@ requires that the language Python and the Tk toolkit be present on your system. If you are first setting up fetchmail for single-user mode, it is recommended that you use Novice mode. Expert mode provides complete control of fetchmail configuration, including the multidrop features. -In either case, the `Autoprobe' button will tell you the most capable +In either case, the 'Autoprobe' button will tell you the most capable protocol a given mailserver supports, and warn you of potential problems with that server. @@ -115,7 +115,7 @@ declarations. .PP Each server name that you specify following the options on the command line will be queried. If you don't specify any servers -on the command line, each `poll' entry in your +on the command line, each 'poll' entry in your .I ~/.fetchmailrc file will be queried. .PP @@ -203,7 +203,7 @@ mailserver before retrieving new messages. This option does not work with ETRN or ODMR. Warning: if your local MTA hangs and fetchmail is aborted, the next time you run fetchmail, it will delete mail that was never delivered to you. What you probably want is the default -setting: if you don't specify `-k', then fetchmail will automatically +setting: if you don't specify '-k', then fetchmail will automatically delete messages after successful delivery. .SS Protocol and Query Options .TP @@ -251,8 +251,8 @@ a static DNS. .B \-U | \-\-uidl (Keyword: uidl) Force UIDL use (effective only with POP3). Force client-side tracking -of `newness' of messages (UIDL stands for ``unique ID listing'' and is -described in RFC1939). Use with `keep' to use a mailbox as a baby +of 'newness' of messages (UIDL stands for ''unique ID listing'' and is +described in RFC1939). Use with 'keep' to use a mailbox as a baby news drop for a group of users. The fact that seen messages are skipped is logged, unless error logging is done through syslog while running in daemon mode. Note that fetchmail may automatically enable this option @@ -311,7 +311,7 @@ POP3, ETRN, or ODMR. .TP .B \-\-tracepolls (Keyword: tracepolls) -Tell fetchmail to poll trace information in the form `polling %s +Tell fetchmail to poll trace information in the form 'polling %s account %s' to the Received line it generates, where the %s parts are replaced by the user's remote name and the poll label (the Received header also normally includes the server's true name). This can be @@ -358,8 +358,8 @@ server. This can cause some complications in daemon mode. .TP .B \-\-sslproto <name> (Keyword: sslproto) -Forces an SSL protocol. Possible values are \&`\fBssl2\fR', `\fBssl3\fR' and -`\fBtls1\fR'. Try this if the default handshake does not work for your server. +Forces an SSL protocol. Possible values are '\fBssl2\fR', '\fBssl3\fR' and +\&'\fBtls1\fR'. Try this if the default handshake does not work for your server. .TP .B \-\-sslcertck (Keyword: sslcertck) @@ -395,12 +395,12 @@ match. This can be used to prevent man-in-the-middle attacks. Specify a hunt list of hosts to forward mail to (one or more hostnames, comma-separated). Hosts are tried in list order; the first one that is up becomes the forwarding target for the current run. -Normally, `localhost' is added to the end of the list as an invisible +Normally, 'localhost' is added to the end of the list as an invisible default. However, when using Kerberos authentication, the FQDN of the machine running fetchmail is added to the end of the list as an invisible default. Each hostname may have a port number following the host name. The port number is separated from the host name by a -slash; the default port is 25 (or ``smtp'' under IPv6). If you +slash; the default port is 25 (or ''smtp'' under IPv6). If you specify an absolute path name (beginning with a /), it will be interpreted as the name of a UNIX socket accepting LMTP connections (such as is supported by the Cyrus IMAP daemon) Example: @@ -472,7 +472,7 @@ default port 25 will (in accordance with RFC 2033) not be accepted. (keyword: bsmtp) Append fetched mail to a BSMTP file. This simply contains the SMTP commands that would normally be generated by fetchmail when passing -mail to an SMTP listener daemon. An argument of `-' causes the mail +mail to an SMTP listener daemon. An argument of '-' causes the mail to be written to standard output. Note that fetchmail's reconstruction of MAIL FROM and RCPT TO lines is not guaranteed correct; the caveats discussed under THE USE AND ABUSE OF MULTIDROP @@ -498,9 +498,9 @@ This option does not work with ETRN or ODMR. (Keyword: warnings) Takes an interval in seconds. When you call .I fetchmail -with a `limit' option in daemon mode, this controls the interval at +with a 'limit' option in daemon mode, this controls the interval at which warnings about oversized messages are mailed to the calling user -(or the user specified by the `postmaster' option). One such +(or the user specified by the 'postmaster' option). One such notification is always mailed at the end of the the first poll that the oversized message is detected. Thereafter, renotification is suppressed until after the warning interval elapses (it will take @@ -542,11 +542,11 @@ non-zero value is 1. Do a binary instead of linear search for the first unseen UID. Binary search avoids downloading the UIDs of all mails. This saves time (especially in daemon mode) where downloading the same set of UIDs in -each poll is a waste of bandwidth. The number `n' indicates how rarely +each poll is a waste of bandwidth. The number 'n' indicates how rarely a linear search should be done. In daemon mode, linear search is used -once followed by binary searches in `n-1' polls if `n' is greater than -1; binary search is always used if `n' is 1; linear search is always -used if `n' is 0. In non-daemon mode, binary search is used if `n' is +once followed by binary searches in 'n-1' polls if 'n' is greater than +1; binary search is always used if 'n' is 1; linear search is always +used if 'n' is 0. In non-daemon mode, binary search is used if 'n' is 1; otherwise linear search is used. This option works with POP3 only. .TP @@ -637,8 +637,8 @@ when interface data is being collected. (Keyword: auth[enticate]) This option permits you to specify an authentication type (see USER AUTHENTICATION below for details). The possible values are \fBany\fR, -\&`\fBpassword\fR', `\fBkerberos_v5\fR' and `\fBkerberos\fR' (or, for -excruciating exactness, `\fBkerberos_v4\fR'), \fRgssapi\fR, +\&'\fBpassword\fR', '\fBkerberos_v5\fR' and '\fBkerberos\fR' (or, for +excruciating exactness, '\fBkerberos_v4\fR'), \fRgssapi\fR, \fIcram-md5\fR, \fIotp\fR, \fIntlm\fR, and \fBssh\fR. When \fBany\fR (the default) is specified, fetchmail tries first methods that don't require a password (GSSAPI, KERBEROS_IV); then it looks for methods @@ -688,11 +688,11 @@ When using ETRN or ODMR, the rewrite option is ineffective. This option changes the header .I fetchmail assumes will carry a copy of the mail's envelope address. Normally -this is `X-Envelope-To' but as this header is not standard, practice +this is 'X-Envelope-To' but as this header is not standard, practice varies. See the discussion of multidrop address handling below. As a -special case, `envelope "Received"' enables parsing of sendmail-style +special case, 'envelope "Received"' enables parsing of sendmail-style Received lines. This is the default, and it should not be necessary -unless you have globally disabled Received parsing with `no envelope' +unless you have globally disabled Received parsing with 'no envelope' in the \fI.fetchmailrc\fR file. .TP .B \-Q <prefix> | \-\-qvirtual <prefix> @@ -706,25 +706,25 @@ to collect the mail for an entire domain and your ISP (or your mail redirection provider) is using qmail. One of the basic features of qmail is the .sp -\&`Delivered-To:' +\&'Delivered-To:' .sp message header. Whenever qmail delivers a message to a local mailbox it puts the username and hostname of the envelope recipient on this line. The major reason for this is to prevent mail loops. To set up qmail to batch mail for a disconnected site the ISP-mailhost will have -normally put that site in its `Virtualhosts' control file so it will +normally put that site in its 'Virtualhosts' control file so it will add a prefix to all mail addresses for this site. This results in mail .\" The \&@\& tries to stop HTML converters from making a mailto URL here. sent to 'username\&@\&userhost.userdom.dom.com' having a -\&`Delivered-To:' line of the form: +\&'Delivered-To:' line of the form: .sp Delivered-To: mbox-userstr-username\&@\&userhost.userdom.dom.com .sp The ISP can make the 'mbox-userstr-' prefix anything they choose but a string matching the user host name is likely. -By using the option `envelope Delivered-To:' you can make fetchmail reliably +By using the option 'envelope Delivered-To:' you can make fetchmail reliably identify the original envelope recipient, but you have to strip the -`mbox-userstr-' prefix to deliver to the correct user. +\&'mbox-userstr-' prefix to deliver to the correct user. This is what this option is for. .TP .B --configdump @@ -822,8 +822,8 @@ a reserved port, with the command RPOP rather than PASS to alert the server that it should do special checking. RPOP is supported by .I fetchmail -(you can specify `protocol RPOP' to have the program send `RPOP' -rather than `PASS') but its use is strongly discouraged. This +(you can specify 'protocol RPOP' to have the program send 'RPOP' +rather than 'PASS') but its use is strongly discouraged. This facility was vulnerable to spoofing and was withdrawn in RFC1460. .PP RFC1460 introduced APOP authentication. In this variant of POP3, @@ -842,7 +842,7 @@ If your \fIfetchmail\fR was built with Kerberos support and you specify Kerberos authentication (either with --auth or the \fI.fetchmailrc\fR option \fBauthenticate kerberos_v4\fR) it will try to get a Kerberos ticket from the mailserver at the start of each query. Note: if -either the pollname or via name is `hesiod', fetchmail will try to use +either the pollname or via name is 'hesiod', fetchmail will try to use Hesiod to look up the mailserver. .PP If you use POP3 or IMAP with GSSAPI authentication, \fIfetchmail\fR will @@ -856,7 +856,7 @@ option \fBuser\fR. If your IMAP daemon returns the PREAUTH response in its greeting line, fetchmail will notice this and skip the normal authentication step. This can be useful, e.g. if you start imapd explicitly using ssh. -In this case you can declare the authentication value `ssh' on that +In this case you can declare the authentication value 'ssh' on that site entry to stop \fI.fetchmail\fR from asking you for a password when it starts up. .PP @@ -875,7 +875,7 @@ Exchange) is supported. If you compile in the support, \fIfetchmail\fR will try to perform an NTLM authentication (instead of sending over the password en clair) whenever the server returns AUTH=NTLM in its capability response. Specify a user option value that looks like -`user@domain': the part to the left of the @ will be passed as the +\&'user@domain': the part to the left of the @ will be passed as the username and the part to the right as the NTLM domain. .SS Secure Socket Layers (SSL) .PP @@ -920,7 +920,7 @@ security of your mailbox. .B fetchmail also supports authentication to the ESMTP server on the client side according to RFC 2554. You can specify a name/password pair to be -used with the keywords `esmtpname' and `esmtppassword'; the former +used with the keywords 'esmtpname' and 'esmtppassword'; the former defaults to the username of the calling user. .SH DAEMON MODE @@ -944,13 +944,13 @@ fetchmail -d 900 .PP will, therefore, poll all the hosts described in your .I ~/.fetchmailrc -file (except those explicitly excluded with the `skip' verb) once +file (except those explicitly excluded with the 'skip' verb) once every fifteen minutes. .PP It is possible to set a polling interval in your .I ~/.fetchmailrc -file by saying `set daemon <interval>', where <interval> is an +file by saying 'set daemon <interval>', where <interval> is an integer number of seconds. If you do this, fetchmail will always start in daemon mode unless you override it with the command-line option --daemon 0 or -d0. @@ -962,7 +962,7 @@ makes a per-user lockfile to guarantee this. Normally, calling fetchmail with a daemon in the background sends a wake-up signal to the daemon, forcing it to poll mailservers immediately. (The wake-up signal is SIGHUP if fetchmail is running as -root, SIGUSR1 otherwise.) The wake-up action also clears any `wedged' +root, SIGUSR1 otherwise.) The wake-up action also clears any 'wedged' flags indicating that connections have wedged due to failed authentication or multiple timeouts. .PP @@ -1055,7 +1055,7 @@ which multidrop mail is to be forwarded if no matching local recipient can be found. Normally this is just the user who invoked .IR fetchmail . If the invoking user is root, then the default of this option is -the user `postmaster'. Setting postmaster to the empty string causes +the user 'postmaster'. Setting postmaster to the empty string causes such mail to be discarded. .PP The @@ -1095,7 +1095,7 @@ example, occur if you have an account on the same server running a mailing list, and are subscribed to the list using that account). The default is not adding any such header. In .IR .fetchmailrc , -this is called `tracepolls'. +this is called 'tracepolls'. .SH RETRIEVAL FAILURE MODES The protocols \fIfetchmail\fR uses to talk to mailservers are next to @@ -1106,7 +1106,7 @@ the message has been either accepted for delivery or rejected due to a spam block. .PP When forwarding to an MDA, however, there is more possibility -of error. Some MDAs are `safe' and reliably return a nonzero status +of error. Some MDAs are 'safe' and reliably return a nonzero status on any delivery error, even one due to temporary resource limits. The well-known .IR procmail (1) @@ -1120,7 +1120,7 @@ can be used with the mda option with no risk of mail loss. Unsafe MDAs, though, may return 0 even on delivery failure. If this happens, you will lose mail. .PP -The normal mode of \fIfetchmail\fR is to try to download only `new' +The normal mode of \fIfetchmail\fR is to try to download only 'new' messages, leaving untouched (and undeleted) messages you have already read directly on the server (or fetched with a previous \fIfetchmail --keep\fR). But you may find that messages you've already read on the @@ -1128,7 +1128,7 @@ server are being fetched (and deleted) even when you don't specify --all. There are several reasons this can happen. .PP One could be that you're using POP2. The POP2 protocol includes no -representation of `new' or `old' state in messages, so \fIfetchmail\fR +representation of 'new' or 'old' state in messages, so \fIfetchmail\fR must treat all messages as new all the time. But POP2 is obsolete, so this is unlikely. .PP @@ -1161,7 +1161,7 @@ instead, it asks the server's SMTP listener to start a queue flush to the client via SMTP. Therefore it sends only undelivered messages. .SH SPAM FILTERING -Many SMTP listeners allow administrators to set up `spam filters' that +Many SMTP listeners allow administrators to set up 'spam filters' that block unsolicited email from specified domains. A MAIL FROM or DATA line that triggers this feature will elicit an SMTP response which (unfortunately) varies according to the listener. @@ -1190,7 +1190,7 @@ code that contains more information). Return codes which .I fetchmail treats as antispam responses and discards -the message can be set with the `antispam' option. This is one of the +the message can be set with the 'antispam' option. This is one of the .I only three circumstance under which fetchmail ever discards mail (the others are the 552 and 553 errors described below, and the suppression of @@ -1254,40 +1254,40 @@ There are four kinds of tokens: grammar keywords, numbers A quoted string is bounded by double quotes and may contain whitespace (and quoted digits are treated as a string). An unquoted string is any whitespace-delimited token that is neither numeric, string -quoted nor contains the special characters `,', `;', `:', or `='. +quoted nor contains the special characters ',', ';', ':', or '='. .PP Any amount of whitespace separates tokens in server entries, but is otherwise ignored. You may use standard C-style escapes (\en, \et, \eb, octal, and hex) to embed non-printable characters or string delimiters in strings. .PP -Each server entry consists of one of the keywords `poll' or `skip', +Each server entry consists of one of the keywords 'poll' or 'skip', followed by a server name, followed by server options, followed by any number of user descriptions. Note: the most common cause of syntax errors is mixing up user and server options. .PP -For backward compatibility, the word `server' is a synonym for `poll'. +For backward compatibility, the word 'server' is a synonym for 'poll'. .PP -You can use the noise keywords `and', `with', -\&`has', `wants', and `options' anywhere in an entry to make +You can use the noise keywords 'and', 'with', +\&'has', 'wants', and 'options' anywhere in an entry to make it resemble English. They're ignored, but but can make entries much easier to read at a glance. The punctuation characters ':', ';' and \&',' are also ignored. .PP .SS Poll vs. Skip -The `poll' verb tells fetchmail to query this host when it is run with -no arguments. The `skip' verb tells +The 'poll' verb tells fetchmail to query this host when it is run with +no arguments. The 'skip' verb tells .I fetchmail not to poll this host unless it is explicitly named on the command -line. (The `skip' verb allows you to experiment with test entries +line. (The 'skip' verb allows you to experiment with test entries safely, or easily disable entries for hosts that are temporarily down.) .PP .SS Keyword/Option Summary Here are the legal options. Keyword suffixes enclosed in square brackets are optional. Those corresponding to command-line -options are followed by `-' and the appropriate option letter. +options are followed by '-' and the appropriate option letter. If option is only relevant to a single mode of operation, it is noted -as `s' or `m' for singledrop- or multidrop-mode, respectively. +as 's' or 'm' for singledrop- or multidrop-mode, respectively. Here are the legal global options: @@ -1344,7 +1344,7 @@ port -P \& T{ Specify TCP/IP service port T} auth[enticate] \& \& T{ -Set authentication type (default `any') +Set authentication type (default 'any') T} timeout -t \& T{ Server inactivity timeout in seconds (default 300) @@ -1416,7 +1416,7 @@ Keyword Opt Mode Function _ user[name] -u \& T{ Set remote user name -(local user name if name followed by `here') +(local user name if name followed by 'here') T} is \& \& T{ Connect local and remote user names @@ -1563,7 +1563,7 @@ T} .PP Remember that all user options must \fIfollow\fR all server options. .PP -In the .fetchmailrc file, the `envelope' string argument may be +In the .fetchmailrc file, the 'envelope' string argument may be preceded by a whitespace-separated number. This number, if specified, is the number of such headers to skip (that is, an argument of 1 selects the second header of the given type). This is sometime useful @@ -1571,19 +1571,19 @@ for ignoring bogus Received headers created by an ISP's local delivery agent. .SS Keywords Not Corresponding To Option Switches .PP -The `folder' and `smtphost' options (unlike their command-line +The 'folder' and 'smtphost' options (unlike their command-line equivalents) can take a space- or comma-separated list of names following them. .PP All options correspond to the obvious command-line arguments, except -the following: `via', `interval', `aka', `is', `to', `dns'/`no dns', -`checkalias'/`no checkalias', `password', `preconnect', `postconnect', -`localdomains', `stripcr'/`no stripcr', `forcecr'/`no forcecr', -`pass8bits'/`no pass8bits' `dropstatus/no dropstatus', -`dropdelivered/no dropdelivered', `mimedecode/no mimedecode', `idle/no -idle', and `no envelope'. -.PP -The `via' option is for if you want to have more +the following: 'via', 'interval', 'aka', 'is', 'to', 'dns'/'no dns', +\&'checkalias'/'no checkalias', 'password', 'preconnect', 'postconnect', +\&'localdomains', 'stripcr'/'no stripcr', 'forcecr'/'no forcecr', +\&'pass8bits'/'no pass8bits' 'dropstatus/no dropstatus', +\&'dropdelivered/no dropdelivered', 'mimedecode/no mimedecode', 'idle/no +idle', and 'no envelope'. +.PP +The 'via' option is for if you want to have more than one configuration pointing at the same site. If it is present, the string argument will be taken as the actual DNS name of the mailserver host to query. @@ -1591,14 +1591,14 @@ This will override the argument of poll, which can then simply be a distinct label for the configuration (e.g. what you would give on the command line to explicitly query this host). .PP -The `interval' option (which takes a numeric argument) allows you to poll a +The 'interval' option (which takes a numeric argument) allows you to poll a server less frequently than the basic poll interval. If you say -\&`interval N' the server this option is attached to will only be +\&'interval N' the server this option is attached to will only be queried every N poll intervals. .PP -The `is' or `to' keywords associate the following local (client) +The 'is' or 'to' keywords associate the following local (client) name(s) (or server-name to client-name mappings separated by =) with -the mailserver user name in the entry. If an is/to list has `*' as +the mailserver user name in the entry. If an is/to list has '*' as its last name, unrecognized names are simply passed through. .PP A single local name can be used to support redirecting your mail when @@ -1611,76 +1611,76 @@ never does DNS lookups. .PP When there is more than one local name (or name mapping) the \fIfetchmail\fR code does look at the Received, To, Cc, and Bcc -headers of retrieved mail (this is `multidrop mode'). It looks for -addresses with hostname parts that match your poll name or your `via', -`aka' or `localdomains' options, and usually also for hostname parts +headers of retrieved mail (this is 'multidrop mode'). It looks for +addresses with hostname parts that match your poll name or your 'via', +\&'aka' or 'localdomains' options, and usually also for hostname parts which DNS tells it are aliases of the mailserver. See the discussion -of `dns', `checkalias', `localdomains', and `aka' for details on how +of 'dns', 'checkalias', 'localdomains', and 'aka' for details on how matching addresses are handled. .PP If \fIfetchmail\fR cannot match any mailserver usernames or localdomain addresses, the mail will be bounced. -Normally it will be bounced to the sender, but if `nobounce' is on +Normally it will be bounced to the sender, but if 'nobounce' is on it will go to the postmaster (which in turn defaults to being the calling user). .PP -The `dns' option (normally on) controls the way addresses from +The 'dns' option (normally on) controls the way addresses from multidrop mailboxes are checked. On, it enables logic to check each -host address that doesn't match an `aka' or `localdomains' declaration +host address that doesn't match an 'aka' or 'localdomains' declaration by looking it up with DNS. When a mailserver username is recognized attached to a matching hostname part, its local mapping is added to the list of local recipients. .PP -The `checkalias' option (normally off) extends the lookups performed -by the `dns' keyword in multidrop mode, providing a way to cope with +The 'checkalias' option (normally off) extends the lookups performed +by the 'dns' keyword in multidrop mode, providing a way to cope with remote MTAs that identify themselves using their canonical name, while they're polled using an alias. When such a server is polled, checks to extract the envelope address fail, and .IR fetchmail reverts to delivery using the To/Cc/Bcc headers (See below -`Header vs. Envelope addresses'). +\&'Header vs. Envelope addresses'). Specifying this option instructs .IR fetchmail to retrieve all the IP addresses associated with both the poll name and the name used by the remote MTA and to do a comparison of the IP addresses. This comes in handy in situations where the remote server undergoes frequent canonical name changes, that would otherwise -require modifications to the rcfile. `checkalias' has no effect if -`no dns' is specified in the rcfile. +require modifications to the rcfile. 'checkalias' has no effect if +\&'no dns' is specified in the rcfile. .PP -The `aka' option is for use with multidrop mailboxes. It allows you +The 'aka' option is for use with multidrop mailboxes. It allows you to pre-declare a list of DNS aliases for a server. This is an optimization hack that allows you to trade space for speed. When .IR fetchmail , while processing a multidrop mailbox, grovels through message headers looking for names of the mailserver, pre-declaring common ones can save it from having to do DNS lookups. Note: the names you give -as arguments to `aka' are matched as suffixes -- if you specify -(say) `aka netaxs.com', this will match not just a hostname -netaxs.com, but any hostname that ends with `.netaxs.com'; such as +as arguments to 'aka' are matched as suffixes -- if you specify +(say) 'aka netaxs.com', this will match not just a hostname +netaxs.com, but any hostname that ends with '.netaxs.com'; such as (say) pop3.netaxs.com and mail.netaxs.com. .PP -The `localdomains' option allows you to declare a list of domains +The 'localdomains' option allows you to declare a list of domains which fetchmail should consider local. When fetchmail is parsing address lines in multidrop modes, and a trailing segment of a host name matches a declared local domain, that address is passed through to the listener or MDA unaltered (local-name mappings are \fInot\fR applied). .PP -If you are using `localdomains', you may also need to specify \&`no +If you are using 'localdomains', you may also need to specify \&'no envelope', which disables \fIfetchmail\fR's normal attempt to deduce an envelope address from the Received line or X-Envelope-To header or -whatever header has been previously set by `envelope'. If you set `no +whatever header has been previously set by 'envelope'. If you set 'no envelope' in the defaults entry it is possible to undo that in -individual entries by using `envelope <string>'. As a special case, -\&`envelope "Received"' restores the default parsing of +individual entries by using 'envelope <string>'. As a special case, +\&'envelope "Received"' restores the default parsing of Received lines. .PP The \fBpassword\fR option requires a string argument, which is the password to be used with the entry's server. .PP -The `preconnect' keyword allows you to specify a shell command to be +The 'preconnect' keyword allows you to specify a shell command to be executed just before each time .I fetchmail establishes a mailserver connection. This may be useful if you are @@ -1689,37 +1689,37 @@ attempting to set up secure POP connections with the aid of If the command returns a nonzero status, the poll of that mailserver will be aborted. .PP -Similarly, the `postconnect' keyword similarly allows you to specify a +Similarly, the 'postconnect' keyword similarly allows you to specify a shell command to be executed just after each time a mailserver connection is taken down. .PP -The `forcecr' option controls whether lines terminated by LF only are +The 'forcecr' option controls whether lines terminated by LF only are given CRLF termination before forwarding. Strictly speaking RFC821 requires this, but few MTAs enforce the requirement it so this option is normally off (only one such MTA, qmail, is in significant use at time of writing). .PP -The `stripcr' option controls whether carriage returns are stripped +The 'stripcr' option controls whether carriage returns are stripped out of retrieved mail before it is forwarded. It is normally not -necessary to set this, because it defaults to `on' (CR stripping -enabled) when there is an MDA declared but `off' (CR stripping -disabled) when forwarding is via SMTP. If `stripcr' and `forcecr' are -both on, `stripcr' will override. +necessary to set this, because it defaults to 'on' (CR stripping +enabled) when there is an MDA declared but 'off' (CR stripping +disabled) when forwarding is via SMTP. If 'stripcr' and 'forcecr' are +both on, 'stripcr' will override. .PP -The `pass8bits' option exists to cope with Microsoft mail programs that +The 'pass8bits' option exists to cope with Microsoft mail programs that stupidly slap a "Content-Transfer-Encoding: 7bit" on everything. With this option off (the default) and such a header present, .I fetchmail declares BODY=7BIT to an ESMTP-capable listener; this causes problems for messages actually using 8-bit ISO or KOI-8 character sets, which will be garbled by having the high bits of all characters stripped. If -\&`pass8bits' is on, +\&'pass8bits' is on, .I fetchmail is forced to declare BODY=8BITMIME to any ESMTP-capable listener. If the listener is 8-bit-clean (as all the major ones now are) the right thing will probably result. .PP -The `dropstatus' option controls whether nonempty Status and +The 'dropstatus' option controls whether nonempty Status and X-Mozilla-Status lines are retained in fetched mail (the default) or discarded. Retaining them allows your MUA to see what messages (if any) were marked seen on the server. On the other hand, it can @@ -1727,13 +1727,13 @@ confuse some new-mail notifiers, which assume that anything with a Status line in it has been seen. (Note: the empty Status lines inserted by some buggy POP servers are unconditionally discarded.) .PP -The `dropdelivered' option controls whether Delivered-To headers will +The 'dropdelivered' option controls whether Delivered-To headers will be kept in fetched mail (the default) or discarded. These headers are added by Qmail and Postfix mailservers in order to avoid mail loops but may get in your way if you try to "mirror" a mailserver within the same domain. Use with caution. .PP -The `mimedecode' option controls whether MIME messages using the +The 'mimedecode' option controls whether MIME messages using the quoted-printable encoding are automatically converted into pure 8-bit data. If you are delivering mail to an ESMTP-capable, 8-bit-clean listener (that includes all of the major MTAs like sendmail), then @@ -1745,7 +1745,7 @@ default, because doing RFC2047 conversion on headers throws away character-set information and can lead to bad results if the encoding of the headers differs from the body encoding. .PP -The `idle' option is intended to be used with IMAP servers supporting +The 'idle' option is intended to be used with IMAP servers supporting the RFC2177 IDLE command extension, but does not strictly require it. If it is enabled, and fetchmail detects that IDLE is supported, an IDLE will be issued at the end of each poll. This will tell the IMAP @@ -1760,20 +1760,20 @@ It also doesn't work with multiple folders; only the first folder will ever be polled. .PP -The `properties' option is an extension mechanism. It takes a string +The 'properties' option is an extension mechanism. It takes a string argument, which is ignored by fetchmail itself. The string argument may be used to store configuration information for scripts which require it. -In particular, the output of `--configdump' option will make properties +In particular, the output of '--configdump' option will make properties associated with a user entry readily available to a Python script. .PP .SS Miscellaneous Run Control Options -The words `here' and `there' have useful English-like -significance. Normally `user eric is esr' would mean that -mail for the remote user `eric' is to be delivered to `esr', -but you can make this clearer by saying `user eric there is esr here', -or reverse it by saying `user esr here is eric there' +The words 'here' and 'there' have useful English-like +significance. Normally 'user eric is esr' would mean that +mail for the remote user 'eric' is to be delivered to 'esr', +but you can make this clearer by saying 'user eric there is esr here', +or reverse it by saying 'user esr here is eric there' .PP -Legal protocol identifiers for use with the `protocol' keyword are: +Legal protocol identifiers for use with the 'protocol' keyword are: .sp .nf auto (or AUTO) @@ -1786,27 +1786,27 @@ Legal protocol identifiers for use with the `protocol' keyword are: .fi .sp .PP -Legal authentication types are `any', `password', `kerberos', 'kerberos_v5' -and `gssapi', `cram-md5', `otp', `ntlm', `ssh`. -The `password' type specifies authentication by normal transmission of a +Legal authentication types are 'any', 'password', 'kerberos', 'kerberos_v5' +and 'gssapi', 'cram-md5', 'otp', 'ntlm', 'ssh'. +The 'password' type specifies authentication by normal transmission of a password (the password may be plain text or subject to -protocol-specific encryption as in APOP); `kerberos' tells +protocol-specific encryption as in APOP); 'kerberos' tells \fIfetchmail\fR to try to get a Kerberos ticket at the start of each query instead, and send an arbitrary string as the password; and -`gssapi' tells fetchmail to use GSSAPI authentication. See the description -of the `auth' keyword for more. +\&'gssapi' tells fetchmail to use GSSAPI authentication. See the description +of the 'auth' keyword for more. .PP -Specifying `kpop' sets POP3 protocol over port 1109 with Kerberos V4 +Specifying 'kpop' sets POP3 protocol over port 1109 with Kerberos V4 authentication. These defaults may be overridden by later options. .PP -There are currently four global option statements; `set logfile' +There are currently four global option statements; 'set logfile' followed by a string sets the same global specified by --logfile. A -command-line --logfile option will override this. Also, `set daemon' +command-line --logfile option will override this. Also, 'set daemon' sets the poll interval as --daemon does. This can be overridden by a command-line --daemon option; in particular --daemon 0 can be used to -force foreground operation. The `set postmaster' statement sets the +force foreground operation. The 'set postmaster' statement sets the address to which multidrop mail defaults if there are no local -matches. Finally, `set syslog' sends log messages to syslogd(8). +matches. Finally, 'set syslog' sends log messages to syslogd(8). .SH INTERACTION WITH RFC 822 When trying to determine the originating address of a message, @@ -1831,7 +1831,7 @@ rather to the list manager (which is less annoying). In multidrop mode, destination headers are processed as follows: First, fetchmail looks for the Received: header (or whichever one is -specified by the `envelope' option) to determine the local +specified by the 'envelope' option) to determine the local recipient address. If the mail is addressed to more than one recipient, the Received line won't contain any information regarding recipient addresses. @@ -1898,7 +1898,7 @@ string in double quotes. Thus: .fi You may have an initial server description headed by the keyword -`defaults' instead of `poll' followed by a name. Such a record +\&'defaults' instead of 'poll' followed by a name. Such a record is interpreted as defaults for all queries to use. It may be overwritten by individual server descriptions. So, you could write: @@ -1913,7 +1913,7 @@ by individual server descriptions. So, you could write: It's possible to specify more than one user per server (this is only likely to be useful when running fetchmail in daemon mode as root). -The `user' keyword leads off a user description, and every user specification +The 'user' keyword leads off a user description, and every user specification in a multi-user entry must include it. Here's an example: .nf @@ -1922,9 +1922,9 @@ in a multi-user entry must include it. Here's an example: user jones with pass "secret2" is "jjones" here keep .fi -This associates the local username `smith' with the pop.provider.net -username `jsmith' and the local username `jjones' with the -pop.provider.net username `jones'. Mail for `jones' is kept on the +This associates the local username 'smith' with the pop.provider.net +username 'jsmith' and the local username 'jjones' with the +pop.provider.net username 'jones'. Mail for 'jones' is kept on the server after download. .PP Here's what a simple retrieval configuration for a multi-drop mailbox @@ -1935,12 +1935,12 @@ looks like: user maildrop with pass secret1 to golux 'hurkle'='happy' snark here .fi -This says that the mailbox of account `maildrop' on the server is a +This says that the mailbox of account 'maildrop' on the server is a multi-drop box, and that messages in it should be parsed for the -server user names `golux', `hurkle', and `snark'. It further -specifies that `golux' and `snark' have the same name on the -client as on the server, but mail for server user `hurkle' should be -delivered to client user `happy'. +server user names 'golux', 'hurkle', and 'snark'. It further +specifies that 'golux' and 'snark' have the same name on the +client as on the server, but mail for server user 'hurkle' should be +delivered to client user 'happy'. .PP Here's an example of another kind of multidrop connection: @@ -1949,10 +1949,10 @@ Here's an example of another kind of multidrop connection: user maildrop with pass secret1 to * here .fi -This also says that the mailbox of account `maildrop' on the server is +This also says that the mailbox of account 'maildrop' on the server is a multi-drop box. It tells fetchmail that any address in the loonytoons.org or toons.org domains (including sub-domain addresses like -`joe@daffy.loonytoons.org') should be passed through to the local SMTP +\&'joe@daffy.loonytoons.org') should be passed through to the local SMTP listener without modification. Be careful of mail loops if you do this! .PP Here's an example configuration using ssh and the plugin option. The @@ -1979,8 +1979,8 @@ to multiple users are delivered to a multidrop box. The fundamental problem is that by having your mailserver toss several peoples' mail in a single maildrop box, you may have thrown away potentially vital information about who each piece of mail was -actually addressed to (the `envelope address', as opposed to the -header addresses in the RFC822 To/Cc/Bcc headers). This `envelope +actually addressed to (the 'envelope address', as opposed to the +header addresses in the RFC822 To/Cc/Bcc headers). This 'envelope address' is the address you need in order to reroute mail properly. .PP Sometimes @@ -1988,25 +1988,25 @@ Sometimes can deduce the envelope address. If the mailserver MTA is .I sendmail and the item of mail had just one recipient, the MTA will have written -a `by/for' clause that gives the envelope addressee into its Received +a 'by/for' clause that gives the envelope addressee into its Received header. But this doesn't work reliably for other MTAs, nor if there is more than one recipient. By default, \fIfetchmail\fR looks for envelope addresses in these lines; you can restore this default with --E "Received" or \&`envelope Received'. +-E "Received" or \&'envelope Received'. .PP Alternatively, some SMTP listeners and/or mail servers insert a header in each message containing a copy of the envelope addresses. This -header (when it exists) is often `X-Envelope-To'. Fetchmail's -assumption about this can be changed with the -E or `envelope' option. +header (when it exists) is often 'X-Envelope-To'. Fetchmail's +assumption about this can be changed with the -E or 'envelope' option. Note that writing an envelope header of this kind exposes the names of recipients (including blind-copy recipients) to all receivers of the messages; it is therefore regarded by some administrators as a security/privacy problem. .PP -A slight variation of the `X-Envelope-To' header is the `Delivered-To' put +A slight variation of the 'X-Envelope-To' header is the 'Delivered-To' put by qmail to avoid mail loops. It will probably prefix the user name with a string that normally matches the user's domain. To remove this prefix you -can use the -Q or `qvirtual' option. +can use the -Q or 'qvirtual' option. .PP Sometimes, unfortunately, neither of these methods works. When they all fail, fetchmail must fall back on the contents of To/Cc/Bcc @@ -2030,16 +2030,16 @@ writes X-Envelope or an equivalent header into messages in your maildrop. .SS Good Ways To Use Multidrop Mailboxes Multiple local names can be used to administer a mailing list from the client side of a \fIfetchmail\fR collection. Suppose your name is -\&`esr', and you want to both pick up your own mail and maintain a mailing +\&'esr', and you want to both pick up your own mail and maintain a mailing list called (say) "fetchmail-friends", and you want to keep the alias list on your client machine. .PP -On your server, you can alias \&`fetchmail-friends' to `esr'; then, in -your \fI.fetchmailrc\fR, declare \&`to esr fetchmail-friends here'. -Then, when mail including `fetchmail-friends' as a local address +On your server, you can alias \&'fetchmail-friends' to 'esr'; then, in +your \fI.fetchmailrc\fR, declare \&'to esr fetchmail-friends here'. +Then, when mail including 'fetchmail-friends' as a local address gets fetched, the list name will be appended to the list of recipients your SMTP listener sees. Therefore it will undergo alias -expansion locally. Be sure to include `esr' in the local alias +expansion locally. Be sure to include 'esr' in the local alias expansion of fetchmail-friends, or you'll never see mail sent only to the list. Also be sure that your listener has the "me-too" option set (sendmail's -oXm command-line option or OXm declaration) so your name @@ -2048,7 +2048,7 @@ isn't removed from alias expansions in messages you send. This trick is not without its problems, however. You'll begin to see this when a message comes in that is addressed only to a mailing list you do \fInot\fR have declared as a local name. Each such message -will feature an `X-Fetchmail-Warning' header which is generated +will feature an 'X-Fetchmail-Warning' header which is generated because fetchmail cannot find a valid local name in the recipient addresses. Such messages default (as was described above) to being sent to the local user running @@ -2090,11 +2090,11 @@ name mappings described in the "to ... here" declaration are done and the mail locally delivered. .PP This is a convenient but also slow method. To speed -it up, pre-declare mailserver aliases with `aka'; these are checked +it up, pre-declare mailserver aliases with 'aka'; these are checked before DNS lookups are done. If you're certain your aka list contains .B all DNS aliases of the mailserver (and all MX names pointing at it) -you can declare `no dns' to suppress DNS lookups entirely and +you can declare 'no dns' to suppress DNS lookups entirely and \fIonly\fR match against the aka list. .SH EXIT CODES @@ -2269,7 +2269,7 @@ conversation. .PP Use of the %F or %T escapes in an mda option could open a security hole, because they pass text manipulable by an attacker to a shell -command. Potential shell characters are replaced by `_' before +command. Potential shell characters are replaced by '_' before execution. The hole is further reduced by the fact that fetchmail temporarily discards any suid privileges it may have while running the MDA. For maximum safety, however, don't use an mda command containing @@ -2290,13 +2290,13 @@ code in the kernel. The -f - option (reading a configuration from stdin) is incompatible with the plugin option. .PP -The `principal' option only handles Kerberos IV, not V. +The 'principal' option only handles Kerberos IV, not V. .PP Send comments, bug reports, gripes, and the like to the fetchmail-devel list <fetchmail-devel@lists.berlios.de>. An HTML FAQ is available at the fetchmail home page; surf to http://fetchmail.berlios.de/ or do a WWW search for pages with -`fetchmail' in their titles. +\&'fetchmail' in their titles. .SH AUTHOR Eric S. Raymond <esr@snark.thyrsus.com>. Too many other people to |