]> Pileus Git - ~andy/fetchmail/blobdiff - sample.rcfile
Credit John Beck's fixes.
[~andy/fetchmail] / sample.rcfile
index a6973156e832786a5e7768a90084ab6a481e4888..1d0b09a29aa3482d1a1064f3c731f2e9cbccab8f 100644 (file)
@@ -1,47 +1,16 @@
-# .poprc sample
-#
-#    $Log: sample.rcfile,v $
-#    Revision 1.2  1996/06/26 19:09:01  esr
-#    This is what I sent Harris.
-#
-#    Revision 1.1  1996/06/25 16:50:31  esr
-#    Initial revision
-#
-#    Revision 1.2  1995/08/10 00:32:46  ceharris
-#    Preparation for 3.0b3 beta release:
-#    - added code for --kill/--keep, --limit, --protocol, --flush
-#      options; --pop2 and --pop3 options now obsoleted by --protocol.
-#    -         added support for APOP authentication, including --with-APOP
-#      argument for configure.
-#    - provisional and broken support for RPOP
-#    - added buffering to SockGets and SockRead functions.
-#    - fixed problem of command-line options not being correctly
-#      carried into the merged options record.
-#
-#    Revision 1.1  1995/08/09 01:33:04  ceharris
-#    Version 3.0 beta 2 release.
-#    Added
-#    - .poprc functionality
-#    - GNU long options
-#    - multiple servers on the command line.
-#    Fixed
-#    - Passwords showing up in ps output.
-#
+# 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 .poprc.  Permissions on this
-# file may be no greater than -rw-------, or popclient will refuse to
+# in your home directory with the name .fetchmailrc.  Permissions on this
+# file may be no greater than -rw------- (0600), or fetchmail will refuse to
 # use it.
 #
-# I'd like to point out here that I do not, repeat DO NOT, endorse
-# the use of plaintext passwords in the .poprc file.  I include the
-# password option because SO MANY people asked me about having such
-# an option.  I don't use it myself.  And I recommend that you don't
-# use it.  
+# To see what effect your ~/.fetchmailrc file has, do 
 #
-# I'd also like to point out that the syntax of this file is still
-# under development (during the 3.0 beta series of releases).  If you
-# would like to suggest revisions, please do.
+#      fetchmail --version
+#
+# This will display the fetchmail version number and an explanation
+# in English of what the currently set options and defaults mean.
 #
 # Comments begin with a '#' and extend through the end of the line.
 # Blank lines between server entries are ignored.
 # 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)
-#   mda
-#   keep
-#   flush
-#   fetchall
-#   nokeep
-#   noflush
-#   nofetchall
-#
-# Legal protocol identifiers are
-#   pop2 (or POP2)
-#   pop3 (or POP3)
-#   imap (or IMAP)
-#   apop (or APOP)
-#   rpop (or RPOP)
+# The run control file format is fully described (with more examples) on the
+# fetchmail manual page.
 #
-# Basic format is
-server SERVERNAME protocol PROTOCOL username NAME password PASSWORD 
-# Example
-server pop.provider.net protocol pop3 username jsmith password secret1
-# Or, using some abbreviations
-server pop.provider.net proto pop3 user jsmith password secret1
+# This is what the former developer's .fetchmailrc looks like:
+
+set daemon 300 # Sleep 300 seconds after the poll, then poll again.
+
+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;
 
-# Multiple servers may be listed
-server pop.provider.net proto pop3 user jsmith password secret1
-server other.provider.net proto pop2 user John.Smith password My^Hat
+# 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 (note use of \ to escape newline -- this is all 
-# one server definition.
-server pop.provider.net        \
-       proto pop3              \
-       user jsmith             \
-       pass secret1            \
-       localfolder ~/mbox
+# 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;