]> Pileus Git - ~andy/fetchmail/blob - sample.rcfile
7d16d238468c7484edf5a08cf2f75b79d29ea460
[~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 .fetchmailrc.  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 ~/.fetchmailrc 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 #   remotefolder (or remote)
27 #   localfolder (or local)
28 #   mda
29 #   smtphost (or smtp)
30 #   keep
31 #   flush
32 #   fetchall
33 #   rewrite
34 #   skip
35 #   nokeep
36 #   noflush
37 #   nofetchall
38 #   norewrite
39 #   noskip
40 #   port
41 #
42 # Legal protocol identifiers are
43 #   pop2 (or POP2)
44 #   pop3 (or POP3)
45 #   imap (or IMAP)
46 #   apop (or APOP)
47 #   rpop (or RPOP)
48 #
49 # Basic format is
50 # server SERVERNAME protocol PROTOCOL username NAME password PASSWORD 
51 # Example:
52 #
53 server pop.provider.net protocol pop3 username jsmith password secret1
54
55 # Or, using some abbreviations:
56 #
57 server pop.provider.net proto pop3 user jsmith password secret1
58
59 # Multiple servers may be listed
60 #
61 server pop.provider.net proto pop3 user jsmith password secret1
62 server other.provider.net proto pop2 user John.Smith password My^Hat
63
64 # Other possibilities (note use of \ to escape newline -- this is all 
65 # one server definition.
66 server pop.provider.net         \
67         proto pop3              \
68         user jsmith             \
69         pass secret1            \
70         localfolder ~/mbox