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
33 # qvirtual -- must be followed by a name prefix
35 # aka -- must be followed by one or more server aliases
36 # localdomains -- must be followed by one or more domain names
37 # interface -- must be followed by device/IP address/mask
38 # monitor -- must be followed by device
42 # username (or user) -- must be followed by a name
43 # is -- must be followed by one or more names
44 # folder -- must be followed by remote folder names
45 # password (or pass) -- must be followed by a password string
46 # smtphost (or smtp) -- must be followed by host names
47 # smtpaddress -- must be followed by a host name
48 # antispam -- must be followed by a numeric response value
49 # mda -- must be followed by an MDA command string
50 # preconnect (or pre) -- must be followed by an executable command
51 # postconnect (or post) -- must be followed by an executable command
69 # limit -- must be followed by numeric size limit
70 # fetchlimit -- must be followed by numeric msg fetch limit
71 # batchlimit -- must be followed by numeric SMTP batch limit
72 # expunge -- must be followed by numeric delete count
74 # Legal protocol identifiers are
78 # imap-k4 (or IMAP-K4)
84 # Legal authentication types are
89 # Legal global option statements are
91 # set logfile = -- must be followed by a string
92 # set daemon -- must be followed by a number
96 # The noise keywords `and', `with', `has', `wants', and `options' are ignored
97 # anywhere in an entry; they can be used to make it resemble English. The
98 # punctuation characters `,' `:' `;' are also ignored.
100 # The run control file format is fully described (with more examples) on the
101 # fetchmail manual page.
103 # This is what the developer's .fetchmailrc looks like:
105 set daemon 300 # Poll at 5-minute intervals
108 interface "sl0/10.0.2.15" # SLIRP standard address
109 user esr is esr fetchmail-friends magic-numbers here
112 # Use this for production
113 poll imap.ccil.org protocol IMAP:
114 no dns, aka snark.thyrsus.com thyrsus.com locke.ccil.org ccil.org
115 password my_remote_password;
117 # Use this to test POP3
118 skip pop3.ccil.org with protocol APOP:
119 no dns, aka snark.thyrsus.com thyrsus.com locke.ccil.org ccil.org
120 password my_apop_secret;
122 # Use this to test against a different server
123 skip pop3.netaxs.com:
124 password my_netaxs.password;