IMP_Quota_Ui
in package
Common code dealing with quota UI display.
Tags
Table of Contents
Constants
- SESSION_INTERVAL_KEY = 'quota_interval'
- Session key for interval data.
Methods
- quota() : array<string|int, mixed>|bool
- Returns data needed to output quota.
Constants
SESSION_INTERVAL_KEY
Session key for interval data.
public
mixed
SESSION_INTERVAL_KEY
= 'quota_interval'
Methods
quota()
Returns data needed to output quota.
public
quota([string $mailbox = null ][, bool $force = true ]) : array<string|int, mixed>|bool
Parameters
- $mailbox : string = null
-
Mailbox to query.
- $force : bool = true
-
If true, ignore 'interval' config option and force quota display.
Return values
array<string|int, mixed>|bool —Array with these keys: class, message, percent. Returns false if no updated quota information.