sample.rcfile 1.81 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 
4
# in your home directory with the name .fetchrc.  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.
#
8
# To see what effect your ~/.fetchrc 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 23 24 25 26 27
#
# 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
#   protocol (or proto)
#   username (or user)
#   password (or pass)
#   remotefolder (or remote)
#   localfolder (or local)
28
#   mda
29
#   smtphost (or smtp)
30 31 32
#   keep
#   flush
#   fetchall
33
#   rewrite
34
#   skip
35 36 37
#   nokeep
#   noflush
#   nofetchall
38
#   norewrite
39
#   noskip
40
#   port
Eric S. Raymond's avatar
Eric S. Raymond committed
41 42 43 44 45 46 47 48 49
#
# Legal protocol identifiers are
#   pop2 (or POP2)
#   pop3 (or POP3)
#   imap (or IMAP)
#   apop (or APOP)
#   rpop (or RPOP)
#
# Basic format is
Eric S. Raymond's avatar
Eric S. Raymond committed
50 51 52
# server SERVERNAME protocol PROTOCOL username NAME password PASSWORD 
# Example:
#
Eric S. Raymond's avatar
Eric S. Raymond committed
53
server pop.provider.net protocol pop3 username jsmith password secret1
Eric S. Raymond's avatar
Eric S. Raymond committed
54 55 56

# Or, using some abbreviations:
#
Eric S. Raymond's avatar
Eric S. Raymond committed
57 58 59
server pop.provider.net proto pop3 user jsmith password secret1

# Multiple servers may be listed
Eric S. Raymond's avatar
Eric S. Raymond committed
60
#
Eric S. Raymond's avatar
Eric S. Raymond committed
61 62 63 64 65 66 67 68 69 70
server pop.provider.net proto pop3 user jsmith password secret1
server other.provider.net proto pop2 user John.Smith password My^Hat

# Other possibilities (note use of \ to escape newline -- this is all 
# one server definition.
server pop.provider.net 	\
	proto pop3		\
	user jsmith		\
	pass secret1		\
	localfolder ~/mbox