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 #   server
  23 #   protocol (or proto) -- nuat be followed by a protocol ID
  24 #   port
  25 #   authenticate (or auth) -- must be followed by an authentication type
  26 #   timeout
  27 #
  28 #   username (or user)
  29 #   is
  30 #   remotefolder (or remote)
  31 #   password (or pass)
  32 #   smtphost (or smtp)
  33 #   mda
  34 #   keep
  35 #   flush
  36 #   fetchall
  37 #   rewrite
  38 #   skip
  39 #   nokeep
  40 #   noflush
  41 #   nofetchall
  42 #   norewrite
  43 #   noskip
  44 #
  45 # Legal protocol identifiers are
  46 #   pop2 (or POP2)
  47 #   pop3 (or POP3)
  48 #   imap (or IMAP)
  49 #   apop (or APOP)
  50 #   kpop (or KPOP)
  51 #
  52 # Legal authentication types are
  53 #   login
  54 #   kerberos
  55 #
  56 # Basic format is
  57 # server SERVERNAME protocol PROTOCOL username NAME password PASSWORD
  58 # Example:
  59 #
  60 server pop.provider.net protocol pop3 username jsmith password secret1
  61
  62 # Or, using some abbreviations:
  63 #
  64 server pop.provider.net proto pop3 user jsmith password secret1
  65
  66 # Multiple servers may be listed
  67 #
  68 server pop.provider.net proto pop3 user jsmith password secret1
  69 server other.provider.net proto pop2 user John.Smith password My^Hat
  70
  71 # Other possibilities (note optional use of \ to escape newline -- this is all
  72 # one server definition.
  73 server pop.provider.net         \
  74         proto pop3              \
  75         user jsmith             \
  76         pass secret1