Credit John Beck's fixes.

[~andy/fetchmail] / sample.rcfile

diff --git a/sample.rcfile b/sample.rcfile
index f1e72a4401bf1a145d01a8763410c6b6d9a98915..1d0b09a29aa3482d1a1064f3c731f2e9cbccab8f 100644 (file)
--- a/sample.rcfile
+++ b/sample.rcfile
@@ -1,8 +1,8 @@
-# fetchmail control file sample
+# fetchmail control file sample (remove this header comment from yours!)
 #
 # This file (or one of your own creation, rather) should be located 
 # in your home directory with the name .fetchmailrc.  Permissions on this
-# file may be no greater than -rw-------, or fetchmail will refuse to
+# file may be no greater than -rw------- (0600), or fetchmail will refuse to
 # use it.
 #
 # To see what effect your ~/.fetchmailrc file has, do 
@@ -18,56 +18,37 @@
 # 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) -- nuat be followed by a protocol ID
-#   port
-#   authenticate (or auth) -- must be followed by an authentication type
-#   timeout
+# The run control file format is fully described (with more examples) on the
+# fetchmail manual page.
 #
-#   username (or user)
-#   is
-#   remotefolder (or remote)
-#   password (or pass)
-#   smtphost (or smtp)
-#   mda
-#   keep
-#   flush
-#   fetchall
-#   rewrite
-#   nokeep
-#   noflush
-#   nofetchall
-#   norewrite
-#
-# Legal protocol identifiers are
-#   pop2 (or POP2)
-#   pop3 (or POP3)
-#   imap (or IMAP)
-#   apop (or APOP)
-#   kpop (or KPOP)
-#
-# Legal authentication types are
-#   login
-#   kerberos
-#
-# Basic format is
-# poll SERVERNAME protocol PROTOCOL username NAME password PASSWORD 
-# Example:
-#
-poll pop.provider.net protocol pop3 username jsmith password secret1
+# This is what the former developer's .fetchmailrc looks like:
 
-# Or, using some abbreviations:
-#
-poll pop.provider.net proto pop3 user jsmith password secret1
+set daemon 300 # Sleep 300 seconds after the poll, then poll again.
 
-# Multiple servers may be listed
-#
-poll pop.provider.net proto pop3 user jsmith password secret1
-poll other.provider.net proto pop2 user John.Smith password My^Hat
+defaults
+       # only poll when the sl0 interface is up (only available on some systems)
+       interface "sl0/10.0.2.15"       # SLIRP standard address
+       # log in with name "esr" and do multidrop fetch for the users
+       # esr, fetchmail-friends, and magic-numbers
+       user esr is esr fetchmail-friends magic-numbers here
+       # fetch (and delete after retrieval) all messages
+       fetchall
+
+# Use this for production
+poll imap.example.org protocol IMAP:
+       # do not use MX lookups to check of server aliases, but pass
+       # them explicitly:
+       no dns, aka snark.thyrsus.com thyrsus.com locke.example.org example.org 
+       password my_remote_password;
+
+# Use this to test POP3
+skip pop3.example.org with protocol APOP:
+       # do not use MX lookups to check of server aliases, but pass
+       # them explicitly:
+       no dns, aka snark.thyrsus.com thyrsus.com locke.example.org example.org 
+       password my_apop_secret;
 
-# Other possibilities
-poll pop.provider.net
-       proto pop3
-       user jsmith
-       pass secret1
+# Use this to test against a different server - it is skipped unless
+# you give its name on fetchmail's command line.
+skip pop3.netaxs.com:
+       password my_netaxs.password;