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-------, 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
25 # port -- must be followed by a TCP/IP port number
26 # authenticate (or auth) -- must be followed by an authentication type
27 # timeout -- must be followed by a numeric timeout value
28 # envelope -- must be followed by an envelope header name
29 # aka -- must be followed by one or more server aliases
30 # localdomains -- must be followed by one or more domain names
31 # interface -- must be followed by device/IP address/mask
32 # monitor -- must be followed by IP address
34 # username (or user) -- must be followed by a name
35 # is -- must be followed by one or more names
36 # remotefolder (or remote) -- must be followed by a filename
37 # password (or pass) -- must be followed by a password string
38 # smtphost (or smtp) -- must be followed by a host name
39 # mda -- must be followed by an MDA command string
40 # preconnect (or pre) -- must be followed by an initialization command
50 # limit -- must be followed by numeric size limit
51 # fetchlimit -- must be followed by numeric msg fetch limit
53 # Legal protocol identifiers are
60 # Legal authentication types are
64 # Legal global option statements are
66 # set batchlimit = -- must be followed by a number
67 # set logfile = -- must be followed by a string
69 # The noise keywords `and', `with', `has', `wants', and `options' are ignored
70 # anywhere in an entry; they can be used to make it resemble English. The
71 # punctuation charactes `,' `:' `;' are also ignored.
73 # The run control file format is fully described (with more examples) on the
74 # fetchmail manual page.
76 # This is what the developer's .fetchmailrc looks like:
78 set batchlimit = 0 # I forward to sendmail
81 interface "sl0/10.0.2.15" # SLIRP standard address
82 user esr is esr fetchmail-friends magic-numbers here
85 # Use this for production
86 poll locke.ccil.org with protocol APOP:
87 password my_apop_secret;
89 # Use this to test IMAP
90 skip locke protocol IMAP:
91 password my_remote_password;
93 # Use this to test against POP2 using a local server
94 skip localhost protocol pop2:
95 password my_local_password;