]> Pileus Git - ~andy/fetchmail/blob - README
9f31303e9827b3fa66b652e03f1db8dbc3b7ed1b
[~andy/fetchmail] / README
1                          fetchmail README
2
3 Fetchmail is a free, full-featured, robust, well-documented remote
4 mail retrieval and forwarding utility intended to be used over
5 on-demand TCP/IP links (such as SLIP or PPP connections).  It
6 retrieves mail from remote mail servers and forwards it to your local
7 (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 Fetchmail supports all standard mail-retrieval protocols in use on the
11 Internet: POP2, POP3, RPOP, APOP, KPOP, IMAP2bis, IMAP4, IMAP4rev1
12 ESMTP ETRN, and ODMR.  Fetchmail also fully supports authentication
13 via GSSAPI, Kerberos 4 and 5, RFC1938 one-time passwords, Compuserve's
14 POP3 with RPA, Microsoft's NTLM, Demon Internet's SDPS, or CRAM-MD5
15 authentication a la RFC2195.  Fetchmail also supports end-to-end
16 encryption with OpenSSL.
17
18 The fetchmail code was developed under Linux, but has also been
19 extensively tested under the BSD variants, AIX, HP-UX versions 9 and
20 10, SunOS, Solaris, NEXTSTEP, OSF 3.2, IRIX, and Rhapsody.
21
22 It should be readily portable to other Unix variants (it uses GNU
23 autoconf).  It has been ported to LynxOS and BeOS and will build there
24 without special action.  It has also been ported to QNX; to build
25 under QNX, see the header comments in the Makefile.  It is reported to
26 build and run under AmigaOS.
27
28 See the distribution files FEATURES for a full list of features, NEWS
29 for detailed information on recent changes, NOTES for design notes, and
30 TODO for a list of things that still need doing.
31
32 The fetchmail code appears to be stable and free of bugs affecting
33 normal operation (that is, retrieving from POP3 or IMAP in single-drop
34 mode and forwarding via SMTP to sendmail).  It will probably undergo
35 substantial change only if and when support for a new retrieval
36 protocol or authentication mode is added.
37
38 If you want to hack on this code, a list of known bugs and to-do items
39 can be found in the file todo.html.
40
41 You can get the code from the fetchmail home page:
42
43         http://www.catb.org/~esr/fetchmail
44
45 Enjoy!
46
47                                                         -- esr
48