* What's this?

msgcab is an easy-to-use and extensible mailing list archive system.

NOTE: msgcab is currently in early development stage, please use at
your own risk.

* Features

  - Installation is easy (actually not needed.)

  - Can import mails from typical mailbox formats.
    e.g. MH, mbox, Maildir

  - Allows users to keep track of discussion across multiple mailing
    lists.

  - Provides built-in mail filter.

  - Can be dynamically extended by Ruby plugins.

  - Provides JavaScript based friendly user interface.

* Requirements

  - Ruby 1.8.0 or later
    http://www.ruby-lang.org

  - htree
    http://cvs.m17n.org/~akr/htree/

  - webapp
    http://cvs.m17n.org/~akr/webapp/

  - RubyMail
    http://www.lickey.com/rubymail/

  - Ruby/DBI
    http://ruby-dbi.rubyforge.org

    NOTE: You will need some extra libraries to build database
    drivers.  By default, msgcab uses the SQLite driver which depends
    on SQLite version 2.xx.

* Quick start

  (0) if you are using MySQL driver, you will need to load schema.sql by hand:

    $ mysql -u msgcab msgcab -p '\. msgcab/schema.sql'

  (1) import mails from ~/Maildir, type:

    $ ./msgcab-import ~/Maildir

  (2) run the WEBrick servlet:

    $ ruby index.cgi server 12345

  (3) point your web browser to http://localhost:12345.

* Install CGI stub

If you would like to run msgcab as CGI, it is safe to use a CGI stub
created by:

  $ make # use GNU make

and copy it to your cgi-bin directory:

  $ cp cgi-bin/index.cgi <your cgi-bin directory>

* License

msgcab is distributed under the terms of the GNU General Public License.
See the COPYING file for more information.

Copyright (C) 2004, 2005  National Institute of Advanced Industrial Science and Technology

AIST copyright registration number: H16PRO 241

* Contact

If you have any questions about this program, please contact:
Daiki Ueno <ueno@unixuser.org>
