Public Member Functions |
|
| __construct ($accountObj, $parentObj) | |
| __get ($varName) | |
| __set ($varName, $varValue) | |
| addAlias ($name) | |
| configContactInfo () | |
| configFilters () | |
| configLimits () | |
| configQuotas () | |
| configSendRecvRestrictions () | |
| configWebmailAdvertising () | |
| configWebmailData () | |
| getAccountObj () | |
| getSessionObj () | |
| inheritSettingsFromAccountClass ($accountClass) | |
| inheritSettingsFromDomainDefaults () | |
| listAliases () | |
| purgeAccountFolders ($folders, $condition=null) | |
| registryInformation () | |
| removeAlias ($name) | |
| resetLdapAssociation () | |
| save () | |
| uploadWmFilter ($filterData) | |
Member Function Documentation
| Account::__get | ( | $ | varName | ) |
Get members.
|
member |
description |
|---|---|
|
name |
account name |
|
password |
account password |
|
customerReference |
the customer reference for use with external billing like systems |
|
publishContactInfo |
the enabled/disabled publish contact info |
|
accountType |
the account type |
|
senderNotInAddressBookAction |
this is the action selected by the user in Webmail to be executed if the email sender is not in his/her address book |
| Account::__set | ( | $ | varName, | |
| $ | varValue | |||
| ) |
Set members.
|
member |
description |
|---|---|
|
name |
account name |
|
password |
account password |
|
customerReference |
the customer reference for use with external billing like systems |
|
publishContactInfo |
the enabled/disabled publish contact info |
|
accountType |
the account type |
|
senderNotInAddressBookAction |
this is the action selected by the user in Webmail to be executed if the email sender is not in his/her address book |
| Account::addAlias | ( | $ | name | ) |
Adds a new alias to the selected account
- Returns:
- bool
- Parameters:
-
$name string the new alias name
| Account::configContactInfo | ( | ) |
Returns an object pertaining to Contact Info for the selected account
- Returns:
- object ContactInfo
| Account::configFilters | ( | ) |
| Account::configLimits | ( | ) |
| Account::configQuotas | ( | ) |
| Account::configSendRecvRestrictions | ( | ) |
Returns an object of SendRecvRestrictions type for the selected account
- Returns:
- object SendRecvRestrictions
| Account::configWebmailAdvertising | ( | ) |
Returns an object pertaining to WebmailAdvertising for the selected account
- Returns:
- object WebmailAdvertising
| Account::configWebmailData | ( | ) |
Returns an object pertaining to WebmailData for the selected account
- Returns:
- object WebmailData
| Account::inheritSettingsFromAccountClass | ( | $ | accountClass | ) |
Sets the account settings' inheritance from the account class
- Returns:
- bool
- Parameters:
-
$accountClass string the account class name that you want to set for the selected user
| Account::inheritSettingsFromDomainDefaults | ( | ) |
Sets the account settings' inheritance from the domain's defaults
- Returns:
- bool
| Account::listAliases | ( | ) |
Returns an array with all the aliases of the selected account
- Returns:
- array
| Account::registryInformation | ( | ) |
Returns an array with all the account registry information
- Returns:
- array
| Account::removeAlias | ( | $ | name | ) |
Removes an alias from the selected account
- Returns:
- bool
- Parameters:
-
$name string the name of the alias that you want to remove from the selected account
| Account::resetLdapAssociation | ( | ) |
resets the ldap associations
- Returns:
- bool
| Account::save | ( | ) |
this method must be called if one of the members has been changed
- Returns:
- bool
| Account::uploadWmFilter | ( | $ | filterData | ) |
Uploads a Webmail Filter to the account
- Returns:
- bool
- Parameters:
-
$filterData string the filter data that you want to upload
