
		Maildir Module for the c-client library


About the Maildir Module
------------------------
Maildir is a directory structure for storing mail messages used by qmail,
designed to solve some of the reliability problems of mbox files and mh
folders. This module is used by the c-client library to enable any program
(such as Pine and IMAP2) which uses this library to read Maildir formated
mailboxes. The INSTALL file included in the package describes how to install
the module.

This module is compatible with the c-client library distributed with
Pine 3.96 and IMAP2bis toolkit 3.6. It will not work with the library
included with the IMAP4 toolkit.  IMAP4 support is planned, but won't
be done until this module stabilizes a little more (and i have free time).


Using the Module
----------------
When this module is installed, the default incoming mailbox is ~/Maildir,
if that directory exists.  The program will continue to read other mailbox
types, and can transfer mail between them.

If your incoming Maildir is someplace other than ~/Maildir and you need to
set inbox-path, point it to the Maildir directory.  The subdirectories are
determined relative to this.

If you want all new mailboxes to be created in Maildir format, you need to
add a line

	set empty-folder-format maildir

in /etc/imap.conf or ~/.imaprc.  If you don't want maildir to the the
default format but want to create a maildir format mailbox, you can
prepend your mailbox name with "#md/".  Use two '/' if you are specifying
an absolute path.  If you want to create a maildir mailbox using this
method in your ~/mail/ directory (the directory where new mailboxes are
created by default), you must specify it as #md/mail/newfolder, and then
either restart pine or enter a folder and return to the folder list screen.


Important Changes
-----------------
The maildir format for non-inboxes has changed from the 970603 and earlier
versions of this module.  Previously, the mailbox was simply a directory
with all the mail stored in it, and now it is a directory with the
cur, new, and tmp directories used as the inbox is.  If you have used
maildir with previous versions of this module, you need to create
the cur, new, and tmp subdirectories and move all your old messages into
the cur subdirectory.

Version 970603 and earlier required inbox-path to point to the Maildir/cur
directory.  This version and future versions should point to the Maildir
directory.


Feedback and Bugs
-----------------
This module is still in testing stages, so please make a backup
of your mail before using.  If you find any bugs or have suggestions
(including bugs found in previous versions and not fixed in this version),
please mail them to thrytis@imaxx.net.

The latest version of this module can be found at
	o http://www.imaxx.net/bh/utils.html

For more information about c-client, Pine, and IMAP, please see
	o http://www.washington.edu/pine.

For more information about qmail and the maildir format, please see
	o http://qmail.org
	o ftp://koobera.math.uic.edu/www/qmail.html


Eric Green
Bloodhounds International Inc.
thrytis@imaxx.net
