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 Here are fetchmail's main features.  Those unique to fetchmail
  17 (relative to fetchpop1.9, PopTart-0.9.3, get-mail, gwpop, pimp-1.0,
  18 pop-perl5-1.2, popc, popmail-1.6 and upop) are marked with **.
  19
  20 Since 3.0:
  21
  22         ** Support for ESMTP 8BITMIME and SIZE options.
  23
  24         ** The stripcr option to explicitly control carriage-return
  25            stripping before mail forwarding.
  26
  27 Since 2.0:
  28
  29         ** Support for secure use with ssh.
  30
  31         ** Mailserver passwords can be parsed out of your .netrc file.
  32
  33         ** When forwarding mail via SMTP, fetchmail respects the 571
  34            "spam filter" response and discards any mail that triggers it.
  35
  36         ** Transaction and error logging may optionally be done via syslog.
  37
  38         ** (Linux only) Security option to permit fetchmail to poll a host
  39            only when a point-to-point link to a particular IP address is up.
  40
  41         ** RPOP support (restored; had been removed in 1.8).
  42
  43 2.0 and earlier versions:
  44
  45         *  **POP2, POP3, **APOP, **RPOP, **IMAP2bis, **IMAP4 support.
  46
  47         ** Support for Kerberos user authentication (either MIT or Cygnus).
  48
  49         ** Host is auto-probed for a working server if no protocol is
  50            specified for the connection.  Thus you don't need to know
  51            what servers are running on your mail host in advance; the
  52            verbose option will tell you which one succeeds.
  53
  54         ** Delivery via via SMTP to the client machine's port 25.  This
  55            means the retrieved mail automatically goes to the system
  56            default MDA as if it were normal sender-initiated SMTP mail.
  57
  58         ** Configurable timeout to detect if server connection is dropped.
  59
  60         ** Support for retrieving and forwarding from multi-drop mailboxes
  61            that is guaranteed not to cause mail loops.
  62
  63         *  Easy control via command line or free-format run control file.
  64
  65         *  Daemon mode -- fetchmail can be run in background to poll
  66            one or more hosts at a specified interval.
  67
  68         *  From:, To:, Cc:, and Reply-To: headers are rewritten so that
  69            usernames relative to the fetchmail host become fully-qualified
  70            Internet addresses.  This enables replies to work correctly.
  71            (Would be unique to fetchmail if I hadn't added it to fetchpop.)
  72
  73         *  Strict conformance to relevant RFCs and good debugging options.
  74            You could use fetchmail to test and debug server implementatations.
  75
  76         *  Message and header processing are 8-bit clean.
  77
  78         *  Carefully written, comprehensive and up-to-date man page describing
  79            not only modes of operation but also (**) how to diagnose the most
  80            common kinds of problems and what to do about deficient servers
  81
  82         *  Rugged, simple, and well-tested code -- the author relies on it
  83            every day and it has never lost mail, not even in experimental
  84            versions.
  85
  86         *  Large user community -- fetchmail has a large user base (the
  87            author's beta list includes about two hundred people).  This
  88            means feedback is rapid, bugs get found and fixed rapidly.
  89
  90 The fetchmail code appears to be stable and free of bugs affecting
  91 normal operation (that is, retrieving from POP3 or IMAP in single-drop
  92 mode and forwarding via SMTP to sendmail).  It will probably undergo
  93 substantial change only if and when support for a new retrieval
  94 protocol or authentication mode is added.  See the distribution files
  95 NEWS for detailed information on recent changes and NOTES for design
  96 notes.
  97
  98 You can easily fetch the latest version of fetchmail via FTP from the
  99 following FTP directory:
 100
 101         ftp://ftp.ccil.org/pub/esr/fetchmail
 102
 103 Or you can get it from Eric's home page:
 104
 105         http://www.ccil.org/~esr
 106
 107 Just chase the link to Eric's Freeware Collection.  Besides fetchmail, it
 108 includes a tasty selection of Web authoring tools, programmer's aids,
 109 graphics libraries, compilers for bizarre languages, games, and
 110 miscellaneous interesting hacks.  Enjoy!
 111
 112                                                         -- esr
 113