| 1 |
fetchmail README |
| 2 |
================ |
| 3 |
|
| 4 |
Introduction |
| 5 |
------------ |
| 6 |
|
| 7 |
Fetchmail is a free, full-featured, robust, well-documented remote mail |
| 8 |
retrieval and forwarding utility intended to be used over on-demand TCP/IP |
| 9 |
links (such as SLIP or PPP connections). It retrieves mail from remote mail |
| 10 |
servers and forwards it to your local (client) machine's delivery system, so it |
| 11 |
can then be be read by normal mail user agents such as mutt(1), elm(1) or |
| 12 |
Mail(1). |
| 13 |
|
| 14 |
Fetchmail supports all standard mail-retrieval protocols in use on the |
| 15 |
Internet: POP3 (including some variants such as RPOP, APOP, KPOP), IMAP4rev1 |
| 16 |
(also IMAP4, IMAP2bis), POP2, IMAP4, ETRN, and ODMR. On the output side, |
| 17 |
fetchmail supports ESMTP/SMTP, LMTP, and invocation of a local delivery agent. |
| 18 |
|
| 19 |
Fetchmail also fully supports authentication via GSSAPI, Kerberos 4 and 5, |
| 20 |
RFC1938 one-time passwords, Compuserve's POP3 with RPA, Microsoft's NTLM, Demon |
| 21 |
Internet's SDPS, or CRAM-MD5 authentication a la RFC2195. |
| 22 |
|
| 23 |
Fetchmail supports end-to-end encryption with OpenSSL, do read README.SSL for |
| 24 |
details on fetchmail's configuration and README.SSL-SERVER for server-side |
| 25 |
requirements. NOTE! To be compatible with earlier releases, fetchmail 6.3's |
| 26 |
default behaviour is more relaxed than dictated by the standard - add options |
| 27 |
such as --sslcertck to tighten certificate checking. |
| 28 |
|
| 29 |
Portability |
| 30 |
----------- |
| 31 |
|
| 32 |
The fetchmail code was developed under Linux, but has also been extensively |
| 33 |
tested under the BSD variants, AIX, HP-UX versions 9 and 10, SunOS, Solaris, |
| 34 |
NEXTSTEP, OSF 3.2, IRIX, and Rhapsody. |
| 35 |
|
| 36 |
It should be readily portable to other Unix variants and Unix-like operating |
| 37 |
systems (it uses GNU autoconf). It has been ported to Cygwin, LynxOS and BeOS |
| 38 |
and will build there without special action. It has also been ported to QNX; |
| 39 |
to build under QNX, see the header comments in the Makefile. It is reported to |
| 40 |
build and run under AmigaOS. |
| 41 |
|
| 42 |
Further reading |
| 43 |
--------------- |
| 44 |
|
| 45 |
The INSTALL file describes how to configure and install fetchmail. |
| 46 |
|
| 47 |
See the distribution files FEATURES for a full list of features, NEWS for |
| 48 |
detailed information on recent changes, NOTES for design notes, and TODO for |
| 49 |
a list of things that still need doing. If you want to hack on this code, |
| 50 |
a list of known bugs and to-do items can be found in the file todo.html. |
| 51 |
|
| 52 |
Status, source code |
| 53 |
------------------- |
| 54 |
|
| 55 |
The fetchmail code appears to be stable and free of bugs affecting normal |
| 56 |
operation (that is, retrieving from POP3 or IMAP in single-drop mode and |
| 57 |
forwarding via SMTP to sendmail). |
| 58 |
|
| 59 |
You can get the code from the fetchmail home page: |
| 60 |
|
| 61 |
http://www.fetchmail.info/ |
| 62 |
|
| 63 |
http://fetchmail.berlios.de/ |
| 64 |
|
| 65 |
Enjoy! |
| 66 |
|
| 67 |
-- esr, ma |