sample.rcfile 1.84 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 22
#
# 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
#   server
23 24 25
#   protocol (or proto) -- nuat be followed by a protocol ID
#   port
#   authenticate (or auth) -- must be followed by an authentication type
26
#   timeout
27
#
Eric S. Raymond's avatar
Eric S. Raymond committed
28
#   username (or user)
29 30
#   is
#   remotefolder (or remote)
Eric S. Raymond's avatar
Eric S. Raymond committed
31
#   password (or pass)
32
#   smtphost (or smtp)
33
#   mda
34 35 36
#   keep
#   flush
#   fetchall
37
#   rewrite
38 39 40
#   nokeep
#   noflush
#   nofetchall
41
#   norewrite
Eric S. Raymond's avatar
Eric S. Raymond committed
42 43 44 45 46 47
#
# Legal protocol identifiers are
#   pop2 (or POP2)
#   pop3 (or POP3)
#   imap (or IMAP)
#   apop (or APOP)
48
#   kpop (or KPOP)
Eric S. Raymond's avatar
Eric S. Raymond committed
49
#
50 51 52 53
# Legal authentication types are
#   login
#   kerberos
#
Eric S. Raymond's avatar
Eric S. Raymond committed
54
# Basic format is
Eric S. Raymond's avatar
Eric S. Raymond committed
55
# poll SERVERNAME protocol PROTOCOL username NAME password PASSWORD 
Eric S. Raymond's avatar
Eric S. Raymond committed
56 57
# Example:
#
Eric S. Raymond's avatar
Eric S. Raymond committed
58
poll pop.provider.net protocol pop3 username jsmith password secret1
Eric S. Raymond's avatar
Eric S. Raymond committed
59 60 61

# Or, using some abbreviations:
#
Eric S. Raymond's avatar
Eric S. Raymond committed
62
poll pop.provider.net proto pop3 user jsmith password secret1
Eric S. Raymond's avatar
Eric S. Raymond committed
63 64

# Multiple servers may be listed
Eric S. Raymond's avatar
Eric S. Raymond committed
65
#
Eric S. Raymond's avatar
Eric S. Raymond committed
66 67
poll pop.provider.net proto pop3 user jsmith password secret1
poll other.provider.net proto pop2 user John.Smith password My^Hat
Eric S. Raymond's avatar
Eric S. Raymond committed
68

Eric S. Raymond's avatar
Eric S. Raymond committed
69 70 71 72
# Other possibilities
poll pop.provider.net
	proto pop3
	user jsmith
73
	pass secret1