README
1Quota Usage plugin for SquirrelMail
2===================================
3Ver 1.3, 07/11/04
4
5
6Original author: Bill Shupp <hostmaster@shupp.org>
7Modifications by: Paul Lesneiwski <pdontthink@angrynerds.com>
8
9
10
11Description
12===========
13
14This plugin retrieves the currect quota usage from the IMAP
15server using the IMAP4 QUOTA extension. It displays size-
16based quotas and/or message-count quotas, as given by the IMAP
17server.
18
19The quota is displayed above the folder listing, and optionally
20as a warning in the Message Of The Day if the quota is above
21a configurable "yellow alert" or "critial" level.
22
23
24
25Requirements
26============
27
28- IMAP server with QUOTA Extension support
29- Quota set for user. (if it's not set, nothing is displayed).
30 NOTE: Courier-IMAP may not report the quota if usage is 0%.
31 Try sending a message to the user if this is the case.
32- Should work with versions of SquirrelMail as far back as 1.2.7
33 at least as well as version 1.5.1. Please report problems and
34 incompatibilities with these and other SquirrelMail versions.
35
36I've tested this with Courier-IMAP 1.4.0 and above . Courier-IMAP only deals
37with maildirquotas, as far as I know. So it might not work with file system
38quotas. I use it successfully with Vpopmail 5.1.4 and above, a virtual domain
39package for Qmail.
40
41As of version 0.2, it should work with Cyrus IMAP as well.
42
43
44
45Installation
46============
47
48Please read the INSTALL file.
49
50
51
52Configuration
53=============
54
55There are just a few optional configuration items:
56
57 $fontsize -- Change this if you want to increase or decrease
58 the size of the text and bar graph shown
59 $use_fancy -- Set this to 1 to use PHP's built-in image
60 generation functionality to create quota
61 displays images on the fly (which aren't
62 currently any fancier than normal HTML-based
63 quota display). To use this, you must have
64 PHP compiled with GD support. See:
65 http://php.net/manual/ref.image.php
66 Also, NOTE that although the plugin attempts
67 to prevent the browser from caching these images,
68 they are unintentionally cached sometimes, and
69 as such, using this option is not recommended.
70 $warn_percent -- Change this to match the warning level of your
71 system. It turns the bar graph to a red color
72 when a user gets to the specified level
73 $yellow_alert_percent -- Set this to a percentage lower than $warn_percent
74 if you want the graph to turn yellow at the
75 specified level. Set to zero or an empty string
76 to disable.
77 $show_quota_intro_text -- Turns the introductory text on or off
78 $show_quota_count_intro_text -- Turns the introductory text for message count
79 quotas on or off
80 $show_yellow_alert_MOTD_warning -- Turns the yellow alert login warning on
81 or off
82 $show_critical_alert_MOTD_warning -- Turns the critical alert login warning
83 on or off
84 $intro_text -- This is an override for the text that shows up
85 above the quota report; change as desired or
86 leave it blank to use the default value. Only
87 works if $show_quota_intro_text is turned on.
88 $intro_text_count -- This is an override for the text that shows up
89 above the message count quota report (which only
90 is displayed if such a quota exists); change as
91 desired or leave it blank to use the default
92 value. Only works if $show_quota_count_intro_text
93 is turned on.
94 $yellow_alert_quota_MOTD -- This is an override for the warning message that
95 is shown upon login if the user's quota usage is
96 over the $yellow_alert_percent. Change as desired
97 or leave it blank to use the default value. Only
98 works if $show_yellow_alert_MOTD_warning is turned on.
99 $critical_alert_quota_MOTD -- This is an override for the warning message that
100 is shown upon login if the user's quota usage is
101 over $warn_percent. Change as desired or leave
102 it blank to use the default value. Only works if
103 $show_critical_alert_MOTD_warning is turned on.
104 $use_1000KB_MB -- Allows you to override how Megabytes are
105 calculated: by default a Megabyte is 1024
106 Kilobytes, but turn this setting to 1 if
107 you want to base Megabytes off of 1000
108 Kilobyte calculations
109 $quota_usage_debug -- Helps diagnose problems by dumping QUOTA
110 response from IMAP server to the screen
111
112These are all found in the config.php file.
113
114
115
116Useful Links
117============
118
119Courier-IMAP http://www.inter7.com/courierimap
120RFC 2087 http://www.cis.ohio-state.edu/cgi-bin/rfc/rfc2087.html
121Maildir++ http://www.inter7.com/courierimap/README.maildirquota.html
122Vpopmail http://www.inter7.com/vpopmail
123
124
125
126Help Requests
127=============
128
129Help requests are welcome at my personal email address, but I
130request that you first post to the SquirrelMail Plugins mailing
131list, where you'll get faster help from more people and other
132people with the same problem will be able to see how your issue
133was resolved. If you don't get good answers that way, you may
134try emailing me directly.
135
136Info about the SquirrelMail Plugins mailing list can be found
137on the SquirrelMail web site. It is currently located at:
138
139http://lists.sourceforge.net/mailman/listinfo/squirrelmail-plugins
140squirrelmail-plugins@lists.sourceforge.net
141
142
143
144Change Log
145==========
146
1471.3 07/11/2004 - Added MOTD warning functionality
148 - Added message count quota display (Thanks to Curtis V.
149 Schleich <cvs@ccaonline.com>)
150 - Fixed MB calculation problems (Thanks to Robin Breathe
151 <rbreathe@brookes.ac.uk> and Adam Henry <hank@marinar.com>)
152 - Added debug flag (see config.php)
153 - Internationalization
154 - Added auto-created quota images (requires GD) (Thanks
155 to Mike Smith <mike@ftl.com>)
156 - XHTML fixes
157 - Code cleanup
158 - Please note that the configuration file for this version
159 contains numerous changes and additions
160
1611.2 12/23/2003 - Now works with SquirrelMail 1.5
162 - Split out configuration items into separate file
163
1641.1 05/20/2003 - New setup.php format for better overall SquirrelMail performance
165 - Smaller graph size (matches font size of text)
166 - Internationalized all output
167 - Option to turn off (or change) the "current usage" text
168 - Updated for SquirrelMail plugin version reporting APIs
169 - "Yellow alert" option added
170
1711.0 12/19/2002 - Updated version to 1.0 (since I never get complaints anymore)
172 - verified that it works with register_globals off
173 - Minor updates to documentation
174 - added screen.jpg so people can see what it looks like
1750.5 4/29/2002 - Added HTML graph of usage - (me)
176 - Added Over Quota message- (Daniel Holdren)
177
1780.4 12/31/2001 - Added color based warning (turns red if over 80 percent) - (me)
179
1800.3 12/31/2001 - Fixed check for QUOTA capability to work on Courier
181 - Updated README, FAQ
182
1830.2 12/31/2001 - Added check for QUOTA capability (Daniel Holdren)
184 - switched to "GETQUOTAROOT" so Cyrus works. (Daniel Holdren)
185 - Percentage now shows one decimal.
186
1870.1 12/27/2001 - Initial Release
188
189
