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 or label
23 # skip -- must be followed by a mailserver name or label
24 # via -- must be followed by true name of host to poll
25 # interval -- must be followed by an interval skip count
26 # protocol (or proto) -- must be followed by a protocol ID
29 # port -- must be followed by a TCP/IP port number
30 # authenticate (or auth) -- must be followed by an authentication type
31 # timeout -- must be followed by a numeric timeout value
32 # envelope -- must be followed by an envelope header name
34 # aka -- must be followed by one or more server aliases
35 # localdomains -- must be followed by one or more domain names
36 # interface -- must be followed by device/IP address/mask
37 # monitor -- must be followed by device
41 # username (or user) -- must be followed by a name
42 # is -- must be followed by one or more names
43 # folder -- must be followed by remote folder names
44 # password (or pass) -- must be followed by a password string
45 # smtphost (or smtp) -- must be followed by host names
46 # mda -- must be followed by an MDA command string
47 # preconnect (or pre) -- must be followed by an executable command
48 # postconnect (or post) -- must be followed by an executable command
66 # limit -- must be followed by numeric size limit
67 # fetchlimit -- must be followed by numeric msg fetch limit
68 # batchlimit -- must be followed by numeric SMTP batch limit
70 # Legal protocol identifiers are
74 # imap-k4 (or IMAP-K4)
80 # Legal authentication types are
84 # Legal global option statements are
86 # set logfile = -- must be followed by a string
87 # set daemon -- must be followed by a number
90 # The noise keywords `and', `with', `has', `wants', and `options' are ignored
91 # anywhere in an entry; they can be used to make it resemble English. The
92 # punctuation characters `,' `:' `;' are also ignored.
94 # The run control file format is fully described (with more examples) on the
95 # fetchmail manual page.
97 # This is what the developer's .fetchmailrc looks like:
99 set daemon 300 # Poll at 5-minute intervals
102 interface "sl0/10.0.2.15" # SLIRP standard address
103 user esr is esr fetchmail-friends magic-numbers here
106 # Use this for production
107 poll imap.ccil.org protocol IMAP:
108 no dns, aka snark.thyrsus.com thyrsus.com locke.ccil.org ccil.org
109 password my_remote_password;
111 # Use this to test POP3
112 skip pop3.ccil.org with protocol APOP:
113 no dns, aka snark.thyrsus.com thyrsus.com locke.ccil.org ccil.org
114 password my_apop_secret;
116 # Use this to test against a different server
117 skip pop3.netaxs.com:
118 password my_netaxs.password;