Pileus Git - ~andy/fetchmail/blob - sample.rcfile

   1 # fetchmail control file sample (remove this header comment from yours!)
   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 #   qvirtual                  -- must be followed by a name prefix
  34 #   no envelope
  35 #   aka                       -- must be followed by one or more server aliases
  36 #   localdomains              -- must be followed by one or more domain names
  37 #   interface                 -- must be followed by device/IP address/mask
  38 #   monitor                   -- must be followed by device
  39 #   plugin                    -- must be followed by a string command name
  40 #   plugout                   -- must be followed by a string command name
  41 #   dns
  42 #   no dns
  43 #   checkalias                -- do multidrop address comparison by IP address
  44 #   no checkalias             -- do multidrop address comparison by name
  45 #
  46 #   username (or user)        -- must be followed by a name
  47 #   is                        -- must be followed by one or more names
  48 #   folder                    -- must be followed by remote folder names
  49 #   password (or pass)        -- must be followed by a password string
  50 #   smtphost (or smtp)        -- must be followed by host names
  51 #   smtpaddress               -- must be followed by a host name
  52 #   antispam                  -- must be followed by a numeric response value
  53 #   mda                       -- must be followed by an MDA command string
  54 #   bsmtp                     -- must be followed by a filename or -
  55 #   lmtp
  56 #   preconnect (or pre)       -- must be followed by an executable command
  57 #   postconnect (or post)     -- must be followed by an executable command
  58 #
  59 #   keep
  60 #   flush
  61 #   fetchall
  62 #   rewrite
  63 #   forcecr
  64 #   stripcr
  65 #   pass8bits
  66 #   dropstatus
  67 #   mimedecode
  68 #   no keep
  69 #   no flush
  70 #   no fetchall
  71 #   no rewrite
  72 #   no forcecr
  73 #   no stripcr
  74 #   no pass8bits
  75 #   no dropstatus
  76 #   no mimedecode
  77 #   limit                     -- must be followed by numeric size limit
  78 #   warnings                  -- must be followed by numeric size limit
  79 #   fetchlimit                -- must be followed by numeric msg fetch limit
  80 #   batchlimit                -- must be followed by numeric SMTP batch limit
  81 #   expunge                   -- must be followed by numeric delete count
  82 #   properties                -- must be followed by a string
  83 #
  84 # Legal protocol identifiers are
  85 #   pop2 (or POP2)
  86 #   pop3 (or POP3)
  87 #   imap (or IMAP)
  88 #   imap-k4 (or IMAP-K4)
  89 #   apop (or APOP)
  90 #   rpop (or RPOP)
  91 #   kpop (or KPOP)
  92 #   etrn (or ETRN)
  93 #
  94 # Legal authentication types are
  95 #   login
  96 #   kerberos
  97 #   kerberos_v5
  98 #
  99 # Legal global option statements are
 100 #
 101 #   set logfile                 -- must be followed by a string
 102 #   set idfile                  -- must be followed by a string
 103 #   set postmaster              -- must be followed by a string
 104 #   set daemon                  -- must be followed by a number
 105 #   set syslog
 106 #   set invisible
 107 #
 108 # The noise keywords `and', `with', `has', `wants', and `options' are ignored
 109 # anywhere in an entry; they can be used to make it resemble English.  The
 110 # punctuation characters `,' `:' `;' are also ignored.
 111 #
 112 # The run control file format is fully described (with more examples) on the
 113 # fetchmail manual page.
 114 #
 115 # This is what the developer's .fetchmailrc looks like:
 116
 117 set daemon 300  # Poll at 5-minute intervals
 118
 119 defaults
 120         interface "sl0/10.0.2.15"       # SLIRP standard address
 121         user esr is esr fetchmail-friends magic-numbers here
 122         fetchall
 123
 124 # Use this for production
 125 poll imap.ccil.org protocol IMAP:
 126         no dns, aka snark.thyrsus.com thyrsus.com locke.ccil.org ccil.org
 127         password my_remote_password;
 128
 129 # Use this to test POP3
 130 skip pop3.ccil.org with protocol APOP:
 131         no dns, aka snark.thyrsus.com thyrsus.com locke.ccil.org ccil.org
 132         password my_apop_secret;
 133
 134 # Use this to test against a different server
 135 skip pop3.netaxs.com:
 136         password my_netaxs.password;