Class IMP_Quota_Maildir

Description

Implementation of the Quota API for servers using Maildir++ quota files on the local filesystem. Currently only supports storage limit, but should be expanded to be configurable to support storage or message limits in the configuration array.

Requires the following parameter settings in imp/servers.php: 'quota' => array( 'driver' => 'maildir', 'params' => array( 'path' => '/path/to/users/Maildir' // TODO: Add config param for storage vs message quota ) );

path -- The path to the user's Maildir directory. You may use the two-character sequence "~U" to represent the user's account name, and the actual username will be substituted in that location. E.g., '/home/~U/Maildir/' or '/var/mail/~U/Maildir/'

$Horde: imp/lib/Quota/maildir.php,v 1.1.2.7 2008/07/09 22:56:26 jan Exp $

See the enclosed file COPYING for license information (GPL). If you did not receive this file, see http://www.fsf.org/copyleft/gpl.html.

  • author: Eric Rostetter

Located in /lib/Quota/maildir.php (line 30)

IMP_Quota
   |
   --IMP_Quota_Maildir
Method Summary
 IMP_Quota_Maildir IMP_Quota_Maildir ([array $params = array()])
 mixed getQuota ()
Variables

Inherited Variables

Inherited from IMP_Quota

IMP_Quota::$_params
Methods
Constructor IMP_Quota_Maildir (line 37)

Constructor.

IMP_Quota_Maildir IMP_Quota_Maildir ([array $params = array()])
  • array $params: Hash containing connection parameters.
getQuota (line 51)

Returns quota information (used/allocated), in bytes.

  • return: An associative array. 'limit' = Maximum quota allowed 'usage' = Currently used portion of quota (in bytes) Returns PEAR_Error on failure.
mixed getQuota ()

Redefinition of:
IMP_Quota::getQuota()
Get quota information (used/allocated), in bytes.

Inherited Methods

Inherited From IMP_Quota

 IMP_Quota::IMP_Quota()
 IMP_Quota::factory()
 IMP_Quota::getMessages()
 IMP_Quota::getQuota()
 IMP_Quota::singleton()

Documentation generated on Sun, 30 Jan 2011 05:28:14 +0000 by phpDocumentor 1.4.3