1 # fetchmail control file sample (remove this header comment from yours!)
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 # principal -- must be followed by a principal name
32 # sslkeyfile -- must be followed by path to private key file
33 # sslcertfile -- must be followed by path to certificate file
34 # authenticate (or auth) -- must be followed by an authentication type
35 # timeout -- must be followed by a numeric timeout value
36 # envelope -- must be followed by an envelope header name
37 # qvirtual -- must be followed by a name prefix
39 # aka -- must be followed by one or more server aliases
40 # localdomains -- must be followed by one or more domain names
41 # interface -- must be followed by device/IP address/mask
42 # monitor -- must be followed by device
43 # plugin -- must be followed by a string command name
44 # plugout -- must be followed by a string command name
47 # checkalias -- do multidrop address comparison by IP address
48 # no checkalias -- do multidrop address comparison by name
50 # username (or user) -- must be followed by a name
51 # is -- must be followed by one or more names
52 # folder -- must be followed by remote folder names
53 # password (or pass) -- must be followed by a password string
54 # smtphost (or smtp) -- must be followed by host names
55 # smtpaddress -- must be followed by a host name
56 # antispam -- must be followed by a numeric response value
57 # mda -- must be followed by an MDA command string
58 # bsmtp -- must be followed by a filename or -
60 # preconnect (or pre) -- must be followed by an executable command
61 # postconnect (or post) -- must be followed by an executable command
83 # limit -- must be followed by numeric size limit
84 # warnings -- must be followed by numeric size limit
85 # fetchlimit -- must be followed by numeric msg fetch limit
86 # batchlimit -- must be followed by numeric SMTP batch limit
87 # expunge -- must be followed by numeric delete count
88 # properties -- must be followed by a string
90 # Legal protocol identifiers are
94 # imap-k4 (or IMAP-K4)
100 # Add ssl for protocols operating over an SSL connection (POP3 and IMAP)
101 # Default port for IMAPS (IMAP over SSL) is 993
102 # Default port for POP3S (POP3 over SSL) is 995
103 # Taken from assigned numbers and compatible with netscape/outlook usage.
105 # Legal authentication types are
110 # Legal global option statements are
112 # set logfile -- must be followed by a string
113 # set idfile -- must be followed by a string
114 # set postmaster -- must be followed by a string
115 # set daemon -- must be followed by a number
120 # The noise keywords `and', `with', `has', `wants', and `options' are ignored
121 # anywhere in an entry; they can be used to make it resemble English. The
122 # punctuation characters `,' `:' `;' are also ignored.
124 # The run control file format is fully described (with more examples) on the
125 # fetchmail manual page.
127 # This is what the developer's .fetchmailrc looks like:
129 set daemon 300 # Poll at 5-minute intervals
132 interface "sl0/10.0.2.15" # SLIRP standard address
133 user esr is esr fetchmail-friends magic-numbers here
136 # Use this for production
137 poll imap.ccil.org protocol IMAP:
138 no dns, aka snark.thyrsus.com thyrsus.com locke.ccil.org ccil.org
139 password my_remote_password;
141 # Use this to test POP3
142 skip pop3.ccil.org with protocol APOP:
143 no dns, aka snark.thyrsus.com thyrsus.com locke.ccil.org ccil.org
144 password my_apop_secret;
146 # Use this to test against a different server
147 skip pop3.netaxs.com:
148 password my_netaxs.password;