Pileus Git - ~andy/fetchmail/blob - README

   1                          fetchmail README
   2
   3 fetchmail is a full-featured, robust, well-documented POP2, POP3,
   4 APOP, and IMAP batch mail retrieval/forwarding utility intended to be
   5 used over on-demand TCP/IP links (such as SLIP or PPP connections).
   6 It retrieves mail from remote mail servers and forwards it to your
   7 local (client) machine's delivery system, so it can then be be read by
   8 normal mail user agents such as elm(1) or Mail(1).
   9
  10 The fetchmail code was developed under Linux, but should be readily
  11 portable to other Unix variants (it uses GNU autoconf).  It has also
  12 been ported to QNX; to build under QNX, see the header comments in the
  13 Makefile.
  14
  15 The fetchmail program was originally authored (under the name
  16 popclient) by Carl Harris <ceharris@mal.com>. Eric S. Raymond,
  17 <esr@thyrsus.com> took over development in June 1996 and subsequently
  18 renamed the program `fetchmail' to reflect the addition of IMAP
  19 support.  See the distribution files NEWS for detailed information on
  20 recent changes and NOTES for design notes.
  21
  22 Before accepting responsibility for the popclient sources from Carl, I
  23 had investigated and used and tinkered with every other UNIX
  24 remote-mail forwarder I could find, including fetchpop1.9,
  25 PopTart-0.9.3, get-mail, gwpop, pimp-1.0, pop-perl5-1.2, popc,
  26 popmail-1.6 and upop.  I learned from all of them, and fetchmail is a
  27 carefully-thought-out attempt to render obsolete every other program
  28 in its class.
  29
  30 The fetchmail code appears to be stable and free of bugs affecting
  31 normal operation (that is, retrieving from POP3 or IMAP and forwarding
  32 via SMTP to sendmail).  It will probably undergo substantial change
  33 only if and when support for a new retrieval protocol or authentication
  34 is added.
  35
  36 Here are fetchmail's main features.  Those unique to fetchmail are marked
  37 with **.
  38
  39         *  **POP2, POP3, **APOP, **IMAP support.
  40
  41         ** Support for Kerberos user authentication.
  42
  43         ** Host is auto-probed for a working server if no protocol is
  44            specified for the connection.  Thus you don't need to know
  45            what servers are running on your mail host in advance; the
  46            verbose option will tell you which one succeeds.
  47
  48         ** Delivery via via SMTP to the client machine's port 25.  This
  49            means the retrieved mail automatically goes to the system
  50            default MDA as if it were normal sender-initiated SMTP mail.
  51
  52         ** Timeout if server connection is dropped.
  53
  54         ** Support for retrieving and forwarding from multi-drop mailboxes
  55            that is guaranteed not to cause mail loops.
  56
  57         *  Easy control via command line or free-format run control file.
  58
  59         *  Daemon mode -- fetchmail can be run in background to poll
  60            one or more hosts at a specified interval.
  61
  62         *  From:, To:, Cc:, and Reply-To: headers are rewritten so that
  63            usernames relative to the fetchmail host become fully-qualified
  64            Internet addresses.  This enables replies to work correctly.
  65            (Would be unique to fetchmail if I hadn't added it to fetchpop.)
  66
  67         *  Strict conformance to relevant RFCs and good debugging options.
  68            You could use fetchmail to test and debug server implementatations.
  69
  70         *  Carefully written, comprehensive and up-to-date man page describing
  71            not only modes of operation but also (**) how to diagnose the most
  72            common kinds of problems and what to do about deficient servers
  73
  74         *  Rugged, simple, and well-tested code -- the author relies on it
  75            every day and it has never lost mail, not even in experimental
  76            versions.
  77
  78         *  Large user community -- fetchmail has inherited a significant
  79            user base from Carl Harris's popclient community.   This means
  80            feedback is rapid, bugs get found and fixed rapidly.
  81
  82 You can easily fetch the latest version of fetchmail  via FTP from:
  83
  84         ftp://ftp.ccil.org/pub/esr/fetchmail-1.9.tar.gz
  85
  86 Or you can get it from Eric's home page:
  87
  88         http://www.ccil.org/~esr
  89
  90 Just chase the link to Eric's Freeware Collection.  Besides fetchmail, it
  91 includes a tasty selection of Web authoring tools, programmer's aids,
  92 graphics libraries, compilers for bizarre languages, games, and
  93 miscellaneous interesting hacks.  Enjoy!
  94
  95                                                         -- esr
  96