Public Member Functions |
|
| __construct ($quotasObj, $parentObj) | |
| __get ($varName) | |
| __set ($varName, $varValue) | |
| getQuotasObj () | |
| getSessionObj () | |
| inherit ($varName) | |
| isInherited ($varName) | |
| listMboxes () | |
| save () | |
| setMboxQuota ($name, $messageCount, $messageSize) | |
| showMboxQuota ($name) | |
Member Function Documentation
| Quotas::__get | ( | $ | varName | ) |
Get member.
|
member |
description |
|---|---|
|
mboxCount |
the maximum number of folders |
|
totalMessageCount |
the maximum number of messages in all folders |
|
totalMessageSize |
the maximum size (in KB) of all messages in all folders |
|
messageCount |
the default maximum number of messages in a folder |
|
messageSize |
the default maximum size (in KB) of messages in a folder |
|
limitThreshold |
percent of quota which triggers an alert |
|
limitNotificationInterval |
the minimum interval (in minutes) between two quota limit notifications |
|
limitNotificationEnabled |
the quota limit notification as enabled/disabled |
|
limitNotificationSubject |
email subject of quota limit notification message |
|
limitNotificationBody |
email body of quota limit notification message |
|
quotaSendMessageThreshold |
percent of quota which blocks user from message sending |
| Quotas::__set | ( | $ | varName, | |
| $ | varValue | |||
| ) |
Set member.
|
member |
description |
|---|---|
|
mboxCount |
the maximum number of folders |
|
totalMessageCount |
the maximum number of messages in all folders |
|
totalMessageSize |
the maximum size (in KB) of all messages in all folders |
|
messageCount |
the default maximum number of messages in a folder |
|
messageSize |
the default maximum size (in KB) of messages in a folder |
|
limitThreshold |
percent of quota which triggers an alert |
|
limitNotificationInterval |
the minimum interval (in minutes) between two quota limit notifications |
|
limitNotificationEnabled |
the quota limit notification as enabled/disabled |
|
limitNotificationSubject |
email subject of quota limit notification message |
|
limitNotificationBody |
email body of quota limit notification message |
|
quotaSendMessageThreshold |
percent of quota which blocks user from message sending |
| Quotas::inherit | ( | $ | varName | ) |
sets the variable to inherit from the selected source
- Returns:
- bool
- Parameters:
-
$varName string the variable
| Quotas::isInherited | ( | $ | varName | ) |
check if the variable is inherited
- Returns:
- int (1 if the value is inherited, 0 if not, or -1 if this does not apply to the current quota object)
- Parameters:
-
$varName string the variable
| Quotas::listMboxes | ( | ) |
this method returns an array with all the mboxes and their quotas
- Returns:
- array
| Quotas::save | ( | ) |
this method must be called if one of the members has been changed
- Returns:
- bool
| Quotas::setMboxQuota | ( | $ | name, | |
| $ | messageCount, | |||
| $ | messageSize | |||
| ) |
this method sets quota on a mbox
- Returns:
- bool
- Parameters:
-
$name string the mbox name where you want to change quotas $messageCount double the new message count quota $messageSize double the new message size quota
| Quotas::showMboxQuota | ( | $ | name | ) |
this method returns an array with selected mbox quota
- Returns:
- array
- Parameters:
-
$name string the mbox name from where you want to retrieve quotas