]> Pileus Git - ~andy/fetchmail/blob - README
Mods to George Sipe's interface option.
[~andy/fetchmail] / 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 Here are fetchmail's main features.  Those unique to fetchmail
16 (relative to fetchpop1.9, PopTart-0.9.3, get-mail, gwpop, pimp-1.0,
17 pop-perl5-1.2, popc, popmail-1.6 and upop) are marked with **.
18
19         *  **POP2, POP3, **APOP, **IMAP2bis, **IMAP4 support.
20
21         ** Support for Kerberos user authentication (either MIT or Cygnus).
22
23         ** Host is auto-probed for a working server if no protocol is
24            specified for the connection.  Thus you don't need to know
25            what servers are running on your mail host in advance; the
26            verbose option will tell you which one succeeds.
27
28         ** Delivery via via SMTP to the client machine's port 25.  This
29            means the retrieved mail automatically goes to the system
30            default MDA as if it were normal sender-initiated SMTP mail.
31
32         ** Timeout if server connection is dropped.
33
34         ** Support for retrieving and forwarding from multi-drop mailboxes
35            that is guaranteed not to cause mail loops.
36
37         ** (Linux only) Security option to permit fetchmail to run only
38            when an interface to a particular IP address is up.
39
40         *  Easy control via command line or free-format run control file.
41
42         *  Daemon mode -- fetchmail can be run in background to poll
43            one or more hosts at a specified interval.
44
45         *  From:, To:, Cc:, and Reply-To: headers are rewritten so that 
46            usernames relative to the fetchmail host become fully-qualified
47            Internet addresses.  This enables replies to work correctly.
48            (Would be unique to fetchmail if I hadn't added it to fetchpop.)
49
50         *  Strict conformance to relevant RFCs and good debugging options.
51            You could use fetchmail to test and debug server implementatations.
52
53         *  Carefully written, comprehensive and up-to-date man page describing
54            not only modes of operation but also (**) how to diagnose the most
55            common kinds of problems and what to do about deficient servers
56
57         *  Rugged, simple, and well-tested code -- the author relies on it
58            every day and it has never lost mail, not even in experimental
59            versions.
60
61         *  Large user community -- fetchmail has a large user base (the
62            author's beta list includes over a hundred people).  This means
63            feedback is rapid, bugs get found and fixed rapidly.
64
65 The fetchmail code appears to be stable and free of bugs affecting
66 normal operation (that is, retrieving from POP3 or IMAP in single-drop
67 mode and forwarding via SMTP to sendmail).  It will probably undergo
68 substantial change only if and when support for a new retrieval
69 protocol or authentication is added.  See the distribution files NEWS
70 for detailed information on recent changes and NOTES for design notes.
71
72 You can easily fetch the latest version of fetchmail  via FTP from the
73 following FTP directory:
74
75         ftp://ftp.ccil.org/pub/esr/fetchmail
76
77 Or you can get it 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