Various cleanup patches.

[~andy/fetchmail] / sample.rcfile

diff --git a/sample.rcfile b/sample.rcfile
index 089657720f4f64c3d7a04858e5df341c0a4fc099..865b3a1891fd27fcbacb59dcc80fd8ca750b667d 100644 (file)
--- a/sample.rcfile
+++ b/sample.rcfile
@@ -1,4 +1,4 @@
-# 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
@@ -27,21 +27,38 @@
 #   uidl
 #   no uidl
 #   port                      -- must be followed by a TCP/IP port number
+#   principal                 -- must be followed by a principal name
+#   ssl
+#   sslkeyfile                -- must be followed by path to private key file
+#   sslcertfile               -- must be followed by path to certificate file
 #   authenticate (or auth)    -- must be followed by an authentication type
 #   timeout                   -- must be followed by a numeric timeout value
 #   envelope                  -- must be followed by an envelope header name
+#   qvirtual                  -- must be followed by a name prefix
+#   no envelope
 #   aka                       -- must be followed by one or more server aliases
 #   localdomains              -- must be followed by one or more domain names
 #   interface                 -- must be followed by device/IP address/mask
-#   monitor                   -- must be followed by IP address
+#   monitor                   -- must be followed by device
+#   plugin                    -- must be followed by a string command name
+#   plugout                   -- must be followed by a string command name
+#   dns
+#   no dns
+#   checkalias                -- do multidrop address comparison by IP address
+#   no checkalias             -- do multidrop address comparison by name
 #
 #   username (or user)        -- must be followed by a name
 #   is                        -- must be followed by one or more names
 #   folder                    -- must be followed by remote folder names
 #   password (or pass)        -- must be followed by a password string
 #   smtphost (or smtp)        -- must be followed by host names
+#   smtpaddress               -- must be followed by a host name
+#   antispam                  -- must be followed by a numeric response value
 #   mda                       -- must be followed by an MDA command string
-#   preconnect (or pre)       -- must be followed by an initialization command
+#   bsmtp                     -- must be followed by a filename or -
+#   lmtp
+#   preconnect (or pre)       -- must be followed by an executable command
+#   postconnect (or post)     -- must be followed by an executable command
 #
 #   keep
 #   flush
@@ -51,20 +68,24 @@
 #   stripcr
 #   pass8bits
 #   dropstatus
-#   dns
+#   mimedecode
+#   idle
 #   no keep
 #   no flush
 #   no fetchall
 #   no rewrite
 #   no forcecr
 #   no stripcr
-#   no dns
-#   no envelope
 #   no pass8bits
 #   no dropstatus
+#   no mimedecode
+#   no idle
 #   limit                     -- must be followed by numeric size limit
+#   warnings                  -- must be followed by numeric size limit
 #   fetchlimit                -- must be followed by numeric msg fetch limit
 #   batchlimit                -- must be followed by numeric SMTP batch limit
+#   expunge                   -- must be followed by numeric delete count
+#   properties                -- must be followed by a string
 #
 # Legal protocol identifiers are
 #   pop2 (or POP2)
@@ -76,15 +97,25 @@
 #   kpop (or KPOP)
 #   etrn (or ETRN)
 #
+# Add ssl for protocols operating over an SSL connection (POP3 and IMAP)
+#   Default port for IMAPS (IMAP over SSL) is 993
+#   Default port for POP3S (POP3 over SSL) is 995
+#      Taken from assigned numbers and compatible with netscape/outlook usage.
+#
 # Legal authentication types are
 #   login
 #   kerberos
+#   kerberos_v5
 #
 # Legal global option statements are
 #
-#   set logfile =              -- must be followed by a string
+#   set logfile                        -- must be followed by a string
+#   set idfile                 -- must be followed by a string
+#   set postmaster             -- must be followed by a string
 #   set daemon                 -- must be followed by a number   
 #   set syslog
+#   set invisible
+#   set showdots
 #
 # The noise keywords `and', `with', `has', `wants', and `options' are ignored
 # anywhere in an entry; they can be used to make it resemble English.  The