sample.rcfile 5.63 KB
Newer Older
1
# fetchmail control file sample (remove this header comment from yours!)
Eric S. Raymond's avatar
Eric S. Raymond committed
2 3
#
# This file (or one of your own creation, rather) should be located 
Eric S. Raymond's avatar
Eric S. Raymond committed
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
Eric S. Raymond's avatar
Eric S. Raymond committed
6 7
# use it.
#
Eric S. Raymond's avatar
Eric S. Raymond committed
8
# To see what effect your ~/.fetchmailrc file has, do 
Eric S. Raymond's avatar
Eric S. Raymond committed
9
#
Eric S. Raymond's avatar
Eric S. Raymond committed
10
#	fetchmail --version
Eric S. Raymond's avatar
Eric S. Raymond committed
11
#
Eric S. Raymond's avatar
Eric S. Raymond committed
12
# This will display the fetchmail version number and an explanation
Eric S. Raymond's avatar
Eric S. Raymond committed
13
# in English of what the currently set options and defaults mean.
Eric S. Raymond's avatar
Eric S. Raymond committed
14 15 16 17 18 19 20 21
#
# Comments begin with a '#' and extend through the end of the line.
# Blank lines between server entries are ignored.
# Keywords and identifiers are case sensitive.
# When there is a conflict between the command-line arguments and the
# arguments in this file, the command-line arguments take precedence.
#
# Legal keywords are
Eric S. Raymond's avatar
Eric S. Raymond committed
22 23 24
#   poll                      -- must be followed by a mailserver name or label
#   skip                      -- must be followed by a mailserver name or label
#   via                       -- must be followed by true name of host to poll
Eric S. Raymond's avatar
Eric S. Raymond committed
25
#   interval                  -- must be followed by an interval skip count
Eric S. Raymond's avatar
Eric S. Raymond committed
26
#   protocol (or proto)       -- must be followed by a protocol ID
Eric S. Raymond's avatar
Eric S. Raymond committed
27
#   uidl
Eric S. Raymond's avatar
Eric S. Raymond committed
28
#   no uidl
Eric S. Raymond's avatar
Eric S. Raymond committed
29
#   port                      -- must be followed by a TCP/IP port number
Eric S. Raymond's avatar
Eric S. Raymond committed
30
#   principal                 -- must be followed by a principal name
31 32 33
#   ssl
#   sslkeyfile                -- must be followed by path to private key file
#   sslcertfile               -- must be followed by path to certificate file
Eric S. Raymond's avatar
Eric S. Raymond committed
34 35
#   authenticate (or auth)    -- must be followed by an authentication type
#   timeout                   -- must be followed by a numeric timeout value
36
#   envelope                  -- must be followed by an envelope header name
Eric S. Raymond's avatar
Eric S. Raymond committed
37
#   qvirtual                  -- must be followed by a name prefix
38
#   no envelope
Eric S. Raymond's avatar
Eric S. Raymond committed
39
#   aka                       -- must be followed by one or more server aliases
Eric S. Raymond's avatar
Eric S. Raymond committed
40
#   localdomains              -- must be followed by one or more domain names
41
#   interface                 -- must be followed by device/IP address/mask
Eric S. Raymond's avatar
Eric S. Raymond committed
42
#   monitor                   -- must be followed by device
43 44
#   plugin                    -- must be followed by a string command name
#   plugout                   -- must be followed by a string command name
45
#   dns
46
#   no dns
Eric S. Raymond's avatar
Eric S. Raymond committed
47 48
#   checkalias                -- do multidrop address comparison by IP address
#   no checkalias             -- do multidrop address comparison by name
49
#
Eric S. Raymond's avatar
Eric S. Raymond committed
50 51
#   username (or user)        -- must be followed by a name
#   is                        -- must be followed by one or more names
52
#   folder                    -- must be followed by remote folder names
Eric S. Raymond's avatar
Eric S. Raymond committed
53
#   password (or pass)        -- must be followed by a password string
54
#   smtphost (or smtp)        -- must be followed by host names
Eric S. Raymond's avatar
Eric S. Raymond committed
55
#   smtpaddress               -- must be followed by a host name
56
#   antispam                  -- must be followed by a numeric response value
Eric S. Raymond's avatar
Eric S. Raymond committed
57
#   mda                       -- must be followed by an MDA command string
Eric S. Raymond's avatar
Eric S. Raymond committed
58
#   bsmtp                     -- must be followed by a filename or -
Eric S. Raymond's avatar
Eric S. Raymond committed
59
#   lmtp
Eric S. Raymond's avatar
Eric S. Raymond committed
60 61
#   preconnect (or pre)       -- must be followed by an executable command
#   postconnect (or post)     -- must be followed by an executable command
62
#
63 64 65
#   keep
#   flush
#   fetchall
66
#   rewrite
Eric S. Raymond's avatar
Eric S. Raymond committed
67
#   forcecr
Eric S. Raymond's avatar
Eric S. Raymond committed
68
#   stripcr
Eric S. Raymond's avatar
Eric S. Raymond committed
69
#   pass8bits
70
#   dropstatus
Eric S. Raymond's avatar
Eric S. Raymond committed
71
#   mimedecode
72
#   idle
Eric S. Raymond's avatar
Eric S. Raymond committed
73 74 75 76
#   no keep
#   no flush
#   no fetchall
#   no rewrite
Eric S. Raymond's avatar
Eric S. Raymond committed
77
#   no forcecr
Eric S. Raymond's avatar
Eric S. Raymond committed
78
#   no stripcr
79 80
#   no pass8bits
#   no dropstatus
Eric S. Raymond's avatar
Eric S. Raymond committed
81
#   no mimedecode
82
#   no idle
Eric S. Raymond's avatar
Eric S. Raymond committed
83
#   limit                     -- must be followed by numeric size limit
84
#   warnings                  -- must be followed by numeric size limit
Eric S. Raymond's avatar
Eric S. Raymond committed
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
Eric S. Raymond's avatar
Eric S. Raymond committed
89 90 91 92 93
#
# Legal protocol identifiers are
#   pop2 (or POP2)
#   pop3 (or POP3)
#   imap (or IMAP)
94
#   imap-k4 (or IMAP-K4)
Eric S. Raymond's avatar
Eric S. Raymond committed
95
#   apop (or APOP)
Eric S. Raymond's avatar
Eric S. Raymond committed
96
#   rpop (or RPOP)
97
#   kpop (or KPOP)
98
#   etrn (or ETRN)
Eric S. Raymond's avatar
Eric S. Raymond committed
99
#
100 101 102 103 104
# Add ssl for protocols operating over an SSL connection (POP3 and IMAP)
#   Default port for IMAPS (IMAP over SSL) is 993
#   Default port for POP3S (POP3 over SSL) is 995
#      Taken from assigned numbers and compatible with netscape/outlook usage.
#
105 106 107
# Legal authentication types are
#   login
#   kerberos
Eric S. Raymond's avatar
Eric S. Raymond committed
108
#   kerberos_v5
109
#
110 111
# Legal global option statements are
#
Eric S. Raymond's avatar
Eric S. Raymond committed
112 113
#   set logfile			-- must be followed by a string
#   set idfile			-- must be followed by a string
Eric S. Raymond's avatar
Eric S. Raymond committed
114
#   set postmaster		-- must be followed by a string
Eric S. Raymond's avatar
Eric S. Raymond committed
115 116
#   set daemon			-- must be followed by a number   
#   set syslog
117
#   set invisible
118
#   set showdots
119
#
Eric S. Raymond's avatar
Eric S. Raymond committed
120 121
# The noise keywords `and', `with', `has', `wants', and `options' are ignored
# anywhere in an entry; they can be used to make it resemble English.  The
Eric S. Raymond's avatar
Eric S. Raymond committed
122
# punctuation characters `,' `:' `;' are also ignored. 
Eric S. Raymond's avatar
Eric S. Raymond committed
123
#
Eric S. Raymond's avatar
Eric S. Raymond committed
124 125 126 127
# The run control file format is fully described (with more examples) on the
# fetchmail manual page.
# 
# This is what the developer's .fetchmailrc looks like:
Eric S. Raymond's avatar
Eric S. Raymond committed
128

Eric S. Raymond's avatar
Eric S. Raymond committed
129 130
set daemon 300	# Poll at 5-minute intervals

131 132 133 134
defaults
	interface "sl0/10.0.2.15"	# SLIRP standard address
	user esr is esr fetchmail-friends magic-numbers here
	fetchall
Eric S. Raymond's avatar
Eric S. Raymond committed
135

Eric S. Raymond's avatar
Eric S. Raymond committed
136
# Use this for production
Eric S. Raymond's avatar
Eric S. Raymond committed
137
poll imap.ccil.org protocol IMAP:
Eric S. Raymond's avatar
Eric S. Raymond committed
138
	no dns, aka snark.thyrsus.com thyrsus.com locke.ccil.org ccil.org 
Eric S. Raymond's avatar
Eric S. Raymond committed
139
	password my_remote_password;
Eric S. Raymond's avatar
Eric S. Raymond committed
140

Eric S. Raymond's avatar
Eric S. Raymond committed
141 142
# Use this to test POP3
skip pop3.ccil.org with protocol APOP:
Eric S. Raymond's avatar
Eric S. Raymond committed
143
	no dns, aka snark.thyrsus.com thyrsus.com locke.ccil.org ccil.org 
Eric S. Raymond's avatar
Eric S. Raymond committed
144
	password my_apop_secret;
Eric S. Raymond's avatar
Eric S. Raymond committed
145

Eric S. Raymond's avatar
Eric S. Raymond committed
146 147 148
# Use this to test against a different server
skip pop3.netaxs.com:
	password my_netaxs.password;