]> Pileus Git - ~andy/fetchmail/blob - README
Fix typo repsonsible -> responsible.
[~andy/fetchmail] / README
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 APOP, KPOP), IMAP4rev1 
16 (also IMAP4, IMAP2bis), 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 tested under
33 Cygwin, FreeBSD, NetBSD, Solaris.  It should be readily portable to other IEEE
34 Std 1003.1 (2001 or later) compliant operating systems.
35
36 Further reading
37 ---------------
38
39 The INSTALL file describes how to configure and install fetchmail.
40
41 See the distribution files FEATURES for a full list of features, NEWS for 
42 detailed information on recent changes, NOTES for design notes, and TODO for 
43 a list of things that still need doing.  If you want to hack on this code, 
44 a list of known bugs and to-do items can be found in the file todo.html.
45
46 Status, source code
47 -------------------
48
49 The fetchmail code appears to be stable and free of bugs affecting normal 
50 operation (that is, retrieving from POP3 or IMAP in single-drop mode and 
51 forwarding via SMTP to sendmail).
52
53 You can get the code from the fetchmail home page:
54
55         http://www.fetchmail.info/
56
57         http://fetchmail.berlios.de/
58
59 Enjoy!
60
61                                                         -- esr, ma
62