sample.rcfile 3.45 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
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
Eric S. Raymond's avatar
Eric S. Raymond committed
30
#   localdomains              -- must be followed by one or more domain names
31 32
#   interface                 -- must be followed by device/IP address/mask
#   monitor                   -- must be followed by IP address
33
#
Eric S. Raymond's avatar
Eric S. Raymond committed
34 35 36 37 38 39
#   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
40 41
#   preconnect (or pre)       -- must be followed by an initialization command
#
42 43 44
#   keep
#   flush
#   fetchall
45
#   rewrite
Eric S. Raymond's avatar
Eric S. Raymond committed
46 47 48 49 50 51
#   dns
#   no keep
#   no flush
#   no fetchall
#   no rewrite
#   no dns
Eric S. Raymond's avatar
Eric S. Raymond committed
52 53
#   limit                     -- must be followed by numeric size limit
#   fetchlimit                -- must be followed by numeric msg fetch limit
54
#   batchlimit                -- must be followed by numeric SMTP batch limit
Eric S. Raymond's avatar
Eric S. Raymond committed
55 56 57 58 59 60
#
# Legal protocol identifiers are
#   pop2 (or POP2)
#   pop3 (or POP3)
#   imap (or IMAP)
#   apop (or APOP)
Eric S. Raymond's avatar
Eric S. Raymond committed
61
#   rpop (or RPOP)
62
#   kpop (or KPOP)
Eric S. Raymond's avatar
Eric S. Raymond committed
63
#
64 65 66 67
# Legal authentication types are
#   login
#   kerberos
#
68 69
# Legal global option statements are
#
70
#   set logfile =		-- must be followed by a string
71
#
Eric S. Raymond's avatar
Eric S. Raymond committed
72 73
# 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
74
# punctuation characters `,' `:' `;' are also ignored. 
Eric S. Raymond's avatar
Eric S. Raymond committed
75
#
Eric S. Raymond's avatar
Eric S. Raymond committed
76 77 78 79
# 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
80

81 82 83 84
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
85

Eric S. Raymond's avatar
Eric S. Raymond committed
86 87
# Use this for production
poll locke.ccil.org with protocol APOP:
88
	password my_apop_secret;
Eric S. Raymond's avatar
Eric S. Raymond committed
89 90 91

# Use this to test IMAP
skip locke protocol IMAP:
92
	password my_remote_password;
Eric S. Raymond's avatar
Eric S. Raymond committed
93

Eric S. Raymond's avatar
Eric S. Raymond committed
94 95
# Use this to test against POP2 using a local server
skip localhost protocol pop2:
96
	password my_local_password;