Quota Usage                                                 version 0.4


* ABOUT *

This plugin retrieve the currect quota usage from the IMAP server using the 
IMAP4 QUOTA extension.  Right now, it only parses the STORAGE part.  If you
also have a quota on the number of messages, it won't display it.  I don't use
it, so it'll probably be up to someone else to write it.


* REQUIREMENTS *

- IMAP server with QUOTA Extension support
- Quota set for user.  (if it's not set, nothing is displayed)

I've only tested this with Courier-IMAP 1.4.0 (first version to support this 
extension).  Courier-IMAP only deals with maildirquotas, as far as I know.  So
it might not work with file system quotas.  I use it successfully with
Vpopmail 5.1.4, a virtual domain package for Qmail.

As of version 0.2, it should work with Cyrus IMAP as well.


* INSTALL *

Should work just by turning the plugin on in conf.pl, assuming you have an IMAP
server that supports the IMAP4 Quota extension.  There are no options to 
configure, but you can obviously customize it however you want.  Please me 
send me any enhancements or success stories!


* CREDITS *

Most of the code (for establishing the IMAP stream) is taken directly from
the Filters plugin by Brent Bice.  The rest is just based on examples from the
SquirrelMail source, plus some formatting of the results by me.


* TODO *

- Add warning message just after login if user is over a certain percent 
(80 by default).


* LINKS *

Courier-IMAP        http://www.inter7.com/courierimap
RFC 2087            http://www.cis.ohio-state.edu/cgi-bin/rfc/rfc2087.html
Maildir++           http://www.inter7.com/courierimap/README.maildirquota.html
Vpopmail            http://www.inter7.com/vpopmail       


* Changes *

0.4 12/31/2001 - Added color based warning (turns red if over 80 percent) - (me)

0.3 12/31/2001 - Fixed check for QUOTA capability to work on Courier
               - Updated README, FAQ

0.2 12/31/2001 - Added check for QUOTA capability (Daniel Holdren)
               - switched to "GETQUOTAROOT" so Cyrus works. (Daniel Holdren)
               - Percentage now shows one decimal.

0.1 12/27/2001 - Initial Release


Enjoy!

Bill Shupp
hostmaster@shupp.org
