]> Pileus Git - ~andy/fetchmail/blobdiff - sample.rcfile
Better error return reporting from the MDA.
[~andy/fetchmail] / sample.rcfile
index 1f2f58fcc1b0036e125481b13ef8967a8a8b8be6..865b3a1891fd27fcbacb59dcc80fd8ca750b667d 100644 (file)
@@ -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 
 # arguments in this file, the command-line arguments take precedence.
 #
 # Legal keywords are
-#   poll                      -- must be followed by a mailserver name
-#   skip                      -- must be followed by a mailserver name
+#   poll                      -- must be followed by a mailserver name or label
+#   skip                      -- must be followed by a mailserver name or label
+#   via                       -- must be followed by true name of host to poll
+#   interval                  -- must be followed by an interval skip count
 #   protocol (or proto)       -- must be followed by a protocol ID
+#   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 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
-#   remotefolder (or remote)  -- must be followed by a filename
+#   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 a host name
+#   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
+#   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
 #   fetchall
 #   rewrite
-#   nokeep
-#   noflush
-#   nofetchall
-#   norewrite
+#   forcecr
+#   stripcr
+#   pass8bits
+#   dropstatus
+#   mimedecode
+#   idle
+#   no keep
+#   no flush
+#   no fetchall
+#   no rewrite
+#   no forcecr
+#   no stripcr
+#   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)
 #   pop3 (or POP3)
 #   imap (or IMAP)
+#   imap-k4 (or IMAP-K4)
 #   apop (or APOP)
+#   rpop (or RPOP)
 #   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 batchlimit =           -- must be followed by a number
+#   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
-# punctuation charactes `,' `:' `;' are also ignored. 
+# punctuation characters `,' `:' `;' are also ignored. 
 #
 # The run control file format is fully described (with more examples) on the
 # fetchmail manual page.
 # 
 # This is what the developer's .fetchmailrc looks like:
 
-set batchlimit 0       # I forward to sendmail
+set daemon 300 # Poll at 5-minute intervals
 
-defaults password not_blowing_my_cover;
+defaults
+       interface "sl0/10.0.2.15"       # SLIRP standard address
+       user esr is esr fetchmail-friends magic-numbers here
+       fetchall
 
 # Use this for production
-poll locke.ccil.org with protocol APOP:
-       user esr there with password my_apop_secret is esr here;
+poll imap.ccil.org protocol IMAP:
+       no dns, aka snark.thyrsus.com thyrsus.com locke.ccil.org ccil.org 
+       password my_remote_password;
 
-# Use this to test IMAP
-skip locke protocol IMAP:
-       user esr here is esr there;
+# Use this to test POP3
+skip pop3.ccil.org with protocol APOP:
+       no dns, aka snark.thyrsus.com thyrsus.com locke.ccil.org ccil.org 
+       password my_apop_secret;
 
-# Use this to test against POP2 using a local server
-skip localhost protocol pop2:
-       user esr here is esr there;
+# Use this to test against a different server
+skip pop3.netaxs.com:
+       password my_netaxs.password;