Pileus Git - ~andy/fetchmail/blob - 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 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.4
  26 default behaviour is more relaxed than dictated by recommendations - while it
  27 does away with SSLv2, only negotiates SSLv3 if forced to, it will by default
  28 still negotiate TLS v1.0.
  29
  30 Portability
  31 -----------
  32
  33 The fetchmail code was developed under Linux, but has also been extensively
  34 tested under the BSD variants, AIX, HP-UX versions 9 and 10, SunOS, Solaris,
  35 NEXTSTEP, OSF 3.2, IRIX, and Rhapsody once upon a time.
  36
  37 The current maintainer does not have access to these systems, and assumes that
  38 the system is at least Single-Unix-Specification V3 compatible, and that
  39 will also require a C99 compiler.
  40
  41 Fetchmail should be able to be compiled with C99, C11, C++98, C++03,
  42 C++11, C++14 compilers, but not C++17 because the "register" keyword is
  43 used in some parts of the code.
  44
  45 Future fetchmail releases will require modern language features such as
  46 "long long" and others, so this release is the last to support C89.
  47
  48 Further reading
  49 ---------------
  50
  51 The INSTALL file describes how to configure and install fetchmail.
  52
  53 See the distribution files FEATURES for a full list of features, NEWS for
  54 detailed information on recent changes, NOTES for design notes, and TODO for
  55 a list of things that still need doing.  If you want to hack on this code,
  56 a list of known bugs and to-do items can be found in the file todo.html.
  57
  58 Status, source code
  59 -------------------
  60
  61 The fetchmail code appears to be stable and free of bugs affecting normal
  62 operation (that is, retrieving from POP3 or IMAP in single-drop mode and
  63 forwarding via SMTP to a local mail transfer agent).
  64
  65 You can get the code from the fetchmail home page:
  66
  67         http://www.fetchmail.info/
  68         http://fetchmail.sourceforge.net/
  69
  70 Enjoy!
  71
  72                                                         -- esr, ma