1 # fetchmail control file sample
3 # This file (or one of your own creation, rather) should be located
4 # in your home directory with the name .fetchmailrc. Permissions on this
5 # file may be no greater than -rw------- (0600), or fetchmail will refuse to
8 # To see what effect your ~/.fetchmailrc file has, do
12 # This will display the fetchmail version number and an explanation
13 # in English of what the currently set options and defaults mean.
15 # Comments begin with a '#' and extend through the end of the line.
16 # Blank lines between server entries are ignored.
17 # Keywords and identifiers are case sensitive.
18 # When there is a conflict between the command-line arguments and the
19 # arguments in this file, the command-line arguments take precedence.
22 # poll -- must be followed by a mailserver name
23 # skip -- must be followed by a mailserver name
24 # protocol (or proto) -- must be followed by a protocol ID
26 # port -- must be followed by a TCP/IP port number
27 # authenticate (or auth) -- must be followed by an authentication type
28 # timeout -- must be followed by a numeric timeout value
29 # envelope -- must be followed by an envelope header name
30 # aka -- must be followed by one or more server aliases
31 # localdomains -- must be followed by one or more domain names
32 # interface -- must be followed by device/IP address/mask
33 # monitor -- must be followed by IP address
35 # username (or user) -- must be followed by a name
36 # is -- must be followed by one or more names
37 # remotefolder (or remote) -- must be followed by a filename
38 # password (or pass) -- must be followed by a password string
39 # smtphost (or smtp) -- must be followed by a host name
40 # mda -- must be followed by an MDA command string
41 # preconnect (or pre) -- must be followed by an initialization command
58 # limit -- must be followed by numeric size limit
59 # fetchlimit -- must be followed by numeric msg fetch limit
60 # batchlimit -- must be followed by numeric SMTP batch limit
62 # Legal protocol identifiers are
71 # Legal authentication types are
75 # Legal global option statements are
77 # set logfile = -- must be followed by a string
78 # set daemon = -- must be followed by a number
80 # The noise keywords `and', `with', `has', `wants', and `options' are ignored
81 # anywhere in an entry; they can be used to make it resemble English. The
82 # punctuation characters `,' `:' `;' are also ignored.
84 # The run control file format is fully described (with more examples) on the
85 # fetchmail manual page.
87 # This is what the developer's .fetchmailrc looks like:
89 set daemon 300 # Poll at 5-minute intervals
92 interface "sl0/10.0.2.15" # SLIRP standard address
93 user esr is esr fetchmail-friends magic-numbers here
96 # Use this for production
97 poll imap.ccil.org protocol IMAP:
98 no dns, aka snark.thyrsus.com thyrsus.com locke.ccil.org ccil.org
99 password my_remote_password;
101 # Use this to test POP3
102 skip pop3.ccil.org with protocol APOP:
103 no dns, aka snark.thyrsus.com thyrsus.com locke.ccil.org ccil.org
104 password my_apop_secret;
106 # Use this to test against a different server
107 skip pop3.netaxs.com:
108 password my_netaxs.password;