| Methods |
public
|
init()
|
#
|
public
|
getManager(string $sManager): object
|
#
|
public
|
onAfterSignup(array $aArgs, type &$mResult)
Creates account with credentials specified in registration form
Creates account with credentials specified in registration form
Parameters
| $aArgs |
New account credentials.
|
| $mResult |
Is passed by reference.
|
|
#
|
public
|
onBeforeCreateAccount(array $aArgs, mixed &$mResult)
Creates cPanel account before mail account will be created in the system.
Creates cPanel account before mail account will be created in the system.
Throws
|
#
|
public
|
onBeforeDeleteEntities(array $aArgs, mixed &$mResult)
Sets flag that allows to delete mail account on cPanel.
Sets flag that allows to delete mail account on cPanel.
|
#
|
public
|
onBeforeDeleteAccount(array $aArgs, mixed &$mResult)
Deletes cPanel account, its aliases, forward, autoresponder and filters.
Deletes cPanel account, its aliases, forward, autoresponder and filters.
|
#
|
public
|
onUpdateQuota(array $aArgs, mixed &$mResult)
Updates mail quota on cPanel.
Updates mail quota on cPanel.
|
#
|
public
|
onBeforeSendOrSaveMessage(&$aArgs, &$mResult)
|
#
|
public
|
onMailAccountToResponseArray(array $aArguments, mixed &$mResult)
Adds to account response array information about if it is allowed to change the password for this account.
Adds to account response array information about if it is allowed to change the password for this account.
|
#
|
public
|
onChangeAccountPassword(array $aArguments, mixed &$mResult)
Tries to change password for account if it is allowed.
Tries to change password for account if it is allowed.
|
#
|
public
|
onBeforeUpdateForward(array $aArgs, mixed &$mResult): boolean
Updates forward for specified account.
Updates forward for specified account.
Throws
|
#
|
public
|
onBeforeGetForward(array $aArgs, mixed &$mResult): boolean
Obtains forward data for specified account.
Obtains forward data for specified account.
|
#
|
public
|
onBeforeGetAutoresponder(array $aArgs, mixed &$mResult): boolean
Obtains autoresponder for specified account.
Obtains autoresponder for specified account.
|
#
|
public
|
onBeforeUpdateAutoresponder(array $aArgs, mixed &$mResult): boolean
Updates autoresponder data.
Updates autoresponder data.
Throws
|
#
|
public
|
onBeforeGetFilters(array $aArgs, mixed &$mResult): boolean
Obtains filters for specified account.
Obtains filters for specified account.
|
#
|
public
|
onBeforeUpdateFilters(array $aArgs, mixed &$mResult): boolean
Updates filters.
|
#
|
public
|
onAfterIsEmailAllowedForCreation($aArgs, &$mResult)
|
#
|
public
|
GetSettings($TenantId = null): array
Obtains list of module settings for authenticated user.
Obtains list of module settings for authenticated user.
Overrides
|
#
|
public
|
UpdateSettings($CpanelHost, $CpanelPort, $CpanelUser, $CpanelPassword, $TenantId = null): boolean
Updates module's settings - saves them to config.json file or to user settings in db.
Updates module's settings - saves them to config.json file or to user settings in db.
|
#
|
public
|
GetAliases(int $UserId): array|boolean
Obtains all aliases for specified user.
Obtains all aliases for specified user.
Parameters
|
#
|
public
|
AddNewAlias(int $UserId, string $AliasName, string $AliasDomain): boolean|int
Creates new alias with specified name and domain.
Creates new alias with specified name and domain.
Parameters
| $UserId |
User identifier.
|
| $AliasName |
Alias name.
|
| $AliasDomain |
Alias domain.
|
|
#
|
public
|
UpdateAlias(int $UserId, int $AccountID, stryng $FriendlyName, int $EntityId): bool
Update existing Alias
|
#
|
public
|
DeleteAliases(int $UserId, array $Aliases): boolean
Deletes aliases with specified emails.
Deletes aliases with specified emails.
Parameters
| $UserId |
User identifier
|
| $Aliases |
Aliases emails.
|
|
#
|
public
|
UpdateSignature($UserId, $AliasId = null, $UseSignature = null, $Signature = null)
|
#
|
public
|
GetScriptForward($AccountID)
|
#
|
public
|
CreateScriptForward($AccountID)
|
#
|
public
|
RemoveScriptForward($AccountID)
|
#
|