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 has also been
  11 extensively tested under 4.4BSD, Solaris and NEXTSTEP.  It should be
  12 readily portable to other Unix variants (it uses GNU autoconf).  It
  13 has also been ported to QNX; to build under QNX, see the header
  14 comments in the Makefile.
  15
  16 For those of you already familiar with previous versions, here are the
  17 major new features since 2.0:
  18
  19         ** Support for secure use with ssh.
  20
  21         ** Mailserver passwords can be parsed out of your .netrc file.
  22
  23         ** When forwarding mail via SMTP, fetchmail respects the 571
  24            "spam filter" response and discards any mail that triggers it.
  25
  26         ** Transaction and error logging may optionally be done via syslog.
  27
  28         ** (Linux only) Security option to permit fetchmail to poll a host
  29            only when a point-to-point link to a particular IP address is up.
  30
  31 There have also been numerous improvements in multidrop mailbox handling.
  32 Under many circumstances fetchmail can now determine a mail message's
  33 envelope address from its headers, making multidrop forwarding more reliable.
  34
  35 Here are fetchmail's main features.  Those unique to fetchmail
  36 (relative to fetchpop1.9, PopTart-0.9.3, get-mail, gwpop, pimp-1.0,
  37 pop-perl5-1.2, popc, popmail-1.6 and upop) are marked with **.
  38
  39         *  **POP2, POP3, **APOP, **IMAP2bis, **IMAP4 support.
  40
  41         ** Support for Kerberos user authentication (either MIT or Cygnus).
  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         ** Configurable timeout to detect 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 a large user base (the
  79            author's beta list includes over a hundred fifty people).  This
  80            means feedback is rapid, bugs get found and fixed rapidly.
  81
  82 The fetchmail code appears to be stable and free of bugs affecting
  83 normal operation (that is, retrieving from POP3 or IMAP in single-drop
  84 mode and forwarding via SMTP to sendmail).  It will probably undergo
  85 substantial change only if and when support for a new retrieval
  86 protocol or authentication mode is added.  See the distribution files
  87 NEWS for detailed information on recent changes and NOTES for design
  88 notes.
  89
  90 You can easily fetch the latest version of fetchmail via FTP from the
  91 following FTP directory:
  92
  93         ftp://ftp.ccil.org/pub/esr/fetchmail
  94
  95 Or you can get it from Eric's home page:
  96
  97         http://www.ccil.org/~esr
  98
  99 Just chase the link to Eric's Freeware Collection.  Besides fetchmail, it
 100 includes a tasty selection of Web authoring tools, programmer's aids,
 101 graphics libraries, compilers for bizarre languages, games, and
 102 miscellaneous interesting hacks.  Enjoy!
 103
 104                                                         -- esr
 105