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