ABOUT
-----

  dkimap4 is copyright Daniel Kroening.

  dkimap4 is a free (see file GPL) IMAP4 (RFC 2060) server package.
  It provides:
   * easy installation
   * it is fast
   * ACL (RFC 2086)
   * Quotas (RFC 2087)
   * Literal+ (RFC 2088)
   * Uidplus (RFC 2359)
   * support for passwd, shadow, and PAM authentication

  Not implemented yet:
   * some search commands
   * set acl

  dkimap4 is developed for Linux/Intel on a Suse distribution. However, it
  is reported to run out-of-the box on the following architectures:
   * Linux/Alpha on a Redhat 4.2
   * Solaris/Intel
   * Solaris/Sparc

  The following people maintain ports to other operating systems:
   * FreeBSD: Anders Nordby <anders@fix.no>
   * Debian: Philippe Troin <phil@fifi.org>

  Tested with the following IMAP Clients:
   * Netscape
   * Outlook
   * Outlook Express
   * Eurdora
   * kmail (KDE)
   * pine
   * Mulberry

  dkimap4 is a spin-off of DBOX available at http://www.dbox.handshake.de/
  You will also find the most recent version of dkimap4 there.
  If you want to contribute, send mail to kroening@handshake.de.


HOW DKIMAP GETS ITS MAIL
------------------------

  dkimap4 uses movemail in order to get the user's mail from /var/mail.
  E.g., Netscape uses the same tool. You do not have to change your MTA or
  any other mail configuration of your system.

  dkimap4 calls movemail automatically if appropriate. You do not have to
  run it manually or within a crontab entry.


INSTALLATION
------------

  0. dkimap checks for PAM. If you do not have PAM, shadow passwords
     are assumed. IMPORTANT: PAM is no longer default. If you need PAM, then
     add -DPAM in config before compiling.

  1. Compile it. You will need a C/C++ complier for this. Depending on your
     distribution, you will have to install the C++ compiler first, even if
     your C compiler works. Furthermore, you need GNU make. To compile
     dkimap4, type:

       ./configure
       make

     If this fails, try "gmake" instead of "make".

  2. Install the files. Just drop dkimap4 (in the subdirectory dkimap4)
     and movemail (in the subdirectory movemail) in /usr/bin. Type:

       cp dkimap4/dkimap4 movemail/movemail /usr/bin

  3. Add an appropriate line to your /etc/inetd.conf, such as

     imap2 stream tcp nowait root /usr/bin/dkimap4 dkimap4

     Check "man inetd" for more information.

  4. In order to make it work, restart inetd. If you do not know how to
     do this, do a reboot.

  You are done, no more configuration needed. If you want SSL encryption,
  have a look at openssl/stunnel, this combination is tested with success
  with dkimap4.


MAINTAINANCE
------------

  dkimap4 keeps its mail in /var/spool/dkimap4. You might want to delete old
  user directories from time to time since IMAP mail folders tend to get
  large. In the DBOX package, further tools are included:

   * onews can expire mail in folders depending on number of messages,
     quota (folder size), message size, and message age

   * webonline displays the mails in a web browser (HTTP/HTML gateway)

  However, it is not easy to set up.
  The DBOX package is available at http://www.dbox.handshake.de/


CONTRIBUTING
------------

  The following stuff is on the TODO list:
   * Make it more stable, esp. with respect to the lock files
   * Make it even faster (one can cache the UID positions within a fetch
     command)
   * Implement missing commands
   * Finish web interface
   * Security audit
   * More ports (esp. Solaris)
