sample.rcfile 3.35 KB
Newer Older
1
# fetchmail control file sample
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
Eric S. Raymond's avatar
Eric S. Raymond committed
5
# file may be no greater than -rw-------, 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 25 26 27
#   poll                      -- must be followed by a mailserver name
#   skip                      -- must be followed by a mailserver name
#   protocol (or proto)       -- must be followed by a protocol ID
#   port                      -- must be followed by a TCP/IP port number
#   authenticate (or auth)    -- must be followed by an authentication type
#   timeout                   -- must be followed by a numeric timeout value
Eric S. Raymond's avatar
Eric S. Raymond committed
28
#   envelope                  -- must be followed by an envelope header name
Eric S. Raymond's avatar
Eric S. Raymond committed
29
#   aka                       -- must be followed by one or more server aliases
30
#
Eric S. Raymond's avatar
Eric S. Raymond committed
31 32 33 34 35 36
#   username (or user)        -- must be followed by a name
#   is                        -- must be followed by one or more names
#   remotefolder (or remote)  -- must be followed by a filename
#   password (or pass)        -- must be followed by a password string
#   smtphost (or smtp)        -- must be followed by a host name
#   mda                       -- must be followed by an MDA command string
37 38
#   preconnect (or pre)       -- must be followed by an initialization command
#
Eric S. Raymond's avatar
Eric S. Raymond committed
39 40 41
#   keep
#   flush
#   fetchall
42
#   rewrite
Eric S. Raymond's avatar
Eric S. Raymond committed
43 44 45
#   nokeep
#   noflush
#   nofetchall
46
#   norewrite
Eric S. Raymond's avatar
Eric S. Raymond committed
47 48
#   limit                     -- must be followed by numeric size limit
#   fetchlimit                -- must be followed by numeric msg fetch limit
Eric S. Raymond's avatar
Eric S. Raymond committed
49 50 51 52 53 54
#
# Legal protocol identifiers are
#   pop2 (or POP2)
#   pop3 (or POP3)
#   imap (or IMAP)
#   apop (or APOP)
55
#   kpop (or KPOP)
Eric S. Raymond's avatar
Eric S. Raymond committed
56
#
57 58 59 60
# Legal authentication types are
#   login
#   kerberos
#
Eric S. Raymond's avatar
Eric S. Raymond committed
61 62 63
# Legal global option statements are
#
#   set batchlimit =		-- must be followed by a number
64
#   set logfile =		-- must be followed by a string
65 66
#   set interface =             -- must be followed by IP address
#   set monitor =               -- must be followed by IP address
Eric S. Raymond's avatar
Eric S. Raymond committed
67
#
Eric S. Raymond's avatar
Eric S. Raymond committed
68 69 70
# 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
# punctuation charactes `,' `:' `;' are also ignored. 
Eric S. Raymond's avatar
Eric S. Raymond committed
71
#
Eric S. Raymond's avatar
Eric S. Raymond committed
72 73 74 75
# 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
76

Eric S. Raymond's avatar
Eric S. Raymond committed
77 78
set batchlimit = 0		# I forward to sendmail
set interface = sl0/10.0.2.15	# SLIRP's default IP address
Eric S. Raymond's avatar
Eric S. Raymond committed
79

Eric S. Raymond's avatar
Eric S. Raymond committed
80
defaults password not_blowing_my_cover;
Eric S. Raymond's avatar
Eric S. Raymond committed
81

Eric S. Raymond's avatar
Eric S. Raymond committed
82 83 84 85 86 87 88
# Use this for production
poll locke.ccil.org with protocol APOP:
	user esr there with password my_apop_secret is esr here;

# Use this to test IMAP
skip locke protocol IMAP:
	user esr here is esr there;
Eric S. Raymond's avatar
Eric S. Raymond committed
89

Eric S. Raymond's avatar
Eric S. Raymond committed
90 91 92
# Use this to test against POP2 using a local server
skip localhost protocol pop2:
	user esr here is esr there;