]> Pileus Git - ~andy/fetchmail/blob - sample.rcfile
Remove some dependencies on the name of the rc file.
[~andy/fetchmail] / sample.rcfile
1 # fetchmail control file sample
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
5 # file may be no greater than -rw-------, or fetchmail will refuse to
6 # use it.
7 #
8 # To see what effect your ~/.fetchrc file has, do 
9 #
10 #       fetchmail --version
11 #
12 # This will display the fetchmail version number and an explanation
13 # in English of what the currently set options and defaults mean.
14 #
15 # Comments begin with a '#' and extend through the end of the line.
16 # Blank lines between server entries are ignored.
17 # Keywords and identifiers are case sensitive.
18 # When there is a conflict between the command-line arguments and the
19 # arguments in this file, the command-line arguments take precedence.
20 #
21 # Legal keywords are
22 #   server
23 #   protocol (or proto)
24 #   username (or user)
25 #   password (or pass)
26 #   rpopid
27 #   remotefolder (or remote)
28 #   localfolder (or local)
29 #   mda
30 #   smtphost (or smtp)
31 #   keep
32 #   flush
33 #   fetchall
34 #   rewrite
35 #   nokeep
36 #   noflush
37 #   nofetchall
38 #   norewrite
39 #   port
40 #
41 # Legal protocol identifiers are
42 #   pop2 (or POP2)
43 #   pop3 (or POP3)
44 #   imap (or IMAP)
45 #   apop (or APOP)
46 #   rpop (or RPOP)
47 #
48 # Basic format is
49 # server SERVERNAME protocol PROTOCOL username NAME password PASSWORD 
50 # Example:
51 #
52 server pop.provider.net protocol pop3 username jsmith password secret1
53
54 # Or, using some abbreviations:
55 #
56 server pop.provider.net proto pop3 user jsmith password secret1
57
58 # Multiple servers may be listed
59 #
60 server pop.provider.net proto pop3 user jsmith password secret1
61 server other.provider.net proto pop2 user John.Smith password My^Hat
62
63 # Other possibilities (note use of \ to escape newline -- this is all 
64 # one server definition.
65 server pop.provider.net         \
66         proto pop3              \
67         user jsmith             \
68         pass secret1            \
69         localfolder ~/mbox