Class IMP_Quota_logfile

Description

Implementation of the Quota API for servers where IMAP Quota is not supported, but it appears in the servers messages log for the IMAP server.

Requires the following parameter settings in imp/servers.php: 'quota' => array( 'driver' => 'logfile', 'params' => array( 'logfile' => '/path/to/log/file', 'taillines' => 10, 'FTPmail' => 'FTP', 'beginocc' => 'usage = ', 'midocc' => ' of ', 'endocc' => ' bytes' ) );

logfile -- The path/to/filename of the log file to use. taillines -- The number of lines to look at in the tail of the logfile. FTPmail -- If you want to show what FTP space is available (IMAP folder) or what mail space is available (INBOX). Defines the search string to username: FTPmail to identify the line with QUOTA info. beginocc -- String that designates the characters before the usage number. midocc -- String between usage and total storage space. endocc -- String after the storage number.

$Horde: imp/lib/Quota/logfile.php,v 1.5.10.6 2008/07/02 09:31:14 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.

Located in /lib/Quota/logfile.php (line 39)

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

Inherited Variables

Inherited from IMP_Quota

IMP_Quota::$_params
Methods
Constructor IMP_Quota_logfile (line 46)

Constructor

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

Get 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