Pileus Git - ~andy/fetchmail/blob - 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------- (0600), 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 #   poll                      -- must be followed by a mailserver name or label
  23 #   skip                      -- must be followed by a mailserver name or label
  24 #   via                       -- must be followed by true name of host to poll
  25 #   interval                  -- must be followed by an interval skip count
  26 #   protocol (or proto)       -- must be followed by a protocol ID
  27 #   uidl
  28 #   no uidl
  29 #   port                      -- must be followed by a TCP/IP port number
  30 #   authenticate (or auth)    -- must be followed by an authentication type
  31 #   timeout                   -- must be followed by a numeric timeout value
  32 #   envelope                  -- must be followed by an envelope header name
  33 #   no envelope
  34 #   aka                       -- must be followed by one or more server aliases
  35 #   localdomains              -- must be followed by one or more domain names
  36 #   interface                 -- must be followed by device/IP address/mask
  37 #   monitor                   -- must be followed by device
  38 #   no dns
  39 #   dns
  40 #
  41 #   username (or user)        -- must be followed by a name
  42 #   is                        -- must be followed by one or more names
  43 #   folder                    -- must be followed by remote folder names
  44 #   password (or pass)        -- must be followed by a password string
  45 #   smtphost (or smtp)        -- must be followed by host names
  46 #   mda                       -- must be followed by an MDA command string
  47 #   preconnect (or pre)       -- must be followed by an executable command
  48 #   postconnect (or post)     -- must be followed by an executable command
  49 #
  50 #   keep
  51 #   flush
  52 #   fetchall
  53 #   rewrite
  54 #   forcecr
  55 #   stripcr
  56 #   pass8bits
  57 #   dropstatus
  58 #   no keep
  59 #   no flush
  60 #   no fetchall
  61 #   no rewrite
  62 #   no forcecr
  63 #   no stripcr
  64 #   no pass8bits
  65 #   no dropstatus
  66 #   limit                     -- must be followed by numeric size limit
  67 #   fetchlimit                -- must be followed by numeric msg fetch limit
  68 #   batchlimit                -- must be followed by numeric SMTP batch limit
  69 #   expunge                   -- must be followed by numeric delete count
  70 #
  71 # Legal protocol identifiers are
  72 #   pop2 (or POP2)
  73 #   pop3 (or POP3)
  74 #   imap (or IMAP)
  75 #   imap-k4 (or IMAP-K4)
  76 #   apop (or APOP)
  77 #   rpop (or RPOP)
  78 #   kpop (or KPOP)
  79 #   etrn (or ETRN)
  80 #
  81 # Legal authentication types are
  82 #   login
  83 #   kerberos
  84 #
  85 # Legal global option statements are
  86 #
  87 #   set logfile =               -- must be followed by a string
  88 #   set daemon                  -- must be followed by a number
  89 #   set syslog
  90 #
  91 # The noise keywords `and', `with', `has', `wants', and `options' are ignored
  92 # anywhere in an entry; they can be used to make it resemble English.  The
  93 # punctuation characters `,' `:' `;' are also ignored.
  94 #
  95 # The run control file format is fully described (with more examples) on the
  96 # fetchmail manual page.
  97 #
  98 # This is what the developer's .fetchmailrc looks like:
  99
 100 set daemon 300  # Poll at 5-minute intervals
 101
 102 defaults
 103         interface "sl0/10.0.2.15"       # SLIRP standard address
 104         user esr is esr fetchmail-friends magic-numbers here
 105         fetchall
 106
 107 # Use this for production
 108 poll imap.ccil.org protocol IMAP:
 109         no dns, aka snark.thyrsus.com thyrsus.com locke.ccil.org ccil.org
 110         password my_remote_password;
 111
 112 # Use this to test POP3
 113 skip pop3.ccil.org with protocol APOP:
 114         no dns, aka snark.thyrsus.com thyrsus.com locke.ccil.org ccil.org
 115         password my_apop_secret;
 116
 117 # Use this to test against a different server
 118 skip pop3.netaxs.com:
 119         password my_netaxs.password;