]> Pileus Git - ~andy/fetchmail/blob - README
ea26b76b2db0ba6fea8ebdb2e584d896dff7fc8a
[~andy/fetchmail] / README
1                 The fetchmail announcement 
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>. I, Eric S. Raymond,
17 <esr@thyrsus.com> took over development in June 1996.  I 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 Here are fetchmail's main features.  Those unique to fetchmail are marked
31 with **.
32
33         *  **POP2, POP3, **APOP, **IMAP support.
34
35         ** Support for Kerberos user authentication.
36
37         ** Host is auto-probed for a working server if no protocol is
38            specified for the connection.  Thus you don't need to know
39            what servers are running on your mail host in advance; the
40            verbose option will tell you which one succeeds.
41
42         ** Delivery via via SMTP to the client machine's port 25.  This
43            means the retrieved mail automatically goes to the system
44            default MDA as if it were normal sender-initiated SMTP mail.
45
46         ** Timeout if server connection is dropped.
47
48         *  Easy control via command line or free-format run control file.
49
50         *  Daemon mode -- fetchmail can be run in background to poll
51            one or more hosts at a specified interval.
52
53         *  From:, To:, Cc:, and Reply-To: headers are rewritten so that 
54            usernames relative to the fetchmail host become fully-qualified
55            Internet addresses.  This enables replies to work correctly.
56            (Would be unique to fetchmail if I hadn't added it to fetchpop.)
57
58         *  Strict conformance to relevant RFCs and good debugging options.
59            You could use fetchmail to test and debug server implementatations.
60
61         *  Carefully written, comprehensive and up-to-date man page describing
62            not only modes of operation but also (**) how to interpret the most
63            common kinds of problems and what to do about deficient servers
64
65         *  Rugged, simple, and well-tested code -- the author relies on it
66            every day and it has never lost mail, not even in experimental
67            versions.
68
69         *  Large user community -- fetchmail has inherited a significant
70            user base from Carl Harris's popclient community.   This means
71            feedback is rapid, bugs get found and fixed rapidly.
72
73 At this point, the fetchmail code appears to be stable and bug-free.
74 It will probably undergo substantial change only if and when support
75 for a new retrieval protocol or IMAP extensions are added.
76
77 You can easily find the latest version of fetchmail from Eric's home page:
78
79         http://www.ccil.org/~esr
80
81 Just chase the link to Eric's Freeware Collection.  Besides fetchmail, it
82 includes a tasty selection of Web authoring tools, programmer's aids,
83 graphics libraries, compilers for bizarre languages, games, and 
84 miscellaneous interesting hacks.  Enjoy!
85
86                                                         -- esr
87