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