| Methods |
public
|
user_service_enabled(string $user, string $service): bool
bool user_service_enabled(string, string)
bool user_service_enabled(string, string)
|
#
|
public
|
get_bandwidth_usage(int $type = null): array|bool
array get_bandwidth_usage(string)
array get_bandwidth_usage(string)
Parameters
| $type |
type of bandwidth usage to retrieve
|
Returns
indexes begin, rollover, and threshold
|
#
|
public
|
get_bandwidth_rollover(): int
Retrieve day on which banwidth rolls over to 0
Retrieve day on which banwidth rolls over to 0
|
#
|
public
|
set_admin_email(string $email): bool
bool set_admin_email(string email)
bool set_admin_email(string email)
Parameters
| $email |
e-mail address to update the record to
Backend PostgreSQL operation to update it in the db
|
Returns
true on success, false on failure
|
#
|
public
|
kill_user(string $user): bool
Destroy all processes matching user
Destroy all processes matching user
|
#
|
public
|
get_admin_email(): string
Get admin email
|
#
|
public
|
ip_address(): string
Get IP address attached to account
Get IP address attached to account
|
#
|
public
|
get_account_quota(): array
Get quota for an account
Get quota for an account
qused: disk quota used in KB
qsoft: disk quota soft limit in KB
qhard: disk quota hard limit in KB
fused: files used
fsoft: files soft limit
fhard: files hard limit
|
#
|
public
|
get_port_range(): array
Get port range allocated to account
Get port range allocated to account
Deprecated
|
#
|
public
|
bless(string $site, string $admin, array $newcfg): bool
|
#
|
public
|
wipe(string $token = ''): bool|string
Wipe an account, reinitializing it to its pristine state
Wipe an account, reinitializing it to its pristine state
Parameters
| $token |
confirmation token
|
Returns
wipe status or confirmation token
|
#
|
public
|
storage_amnesty(): bool
Request a temporary bump to account storage
Request a temporary bump to account storage
|
#
|
public
|
amnesty_active(): bool
Account is under amnesty
|
#
|
public
|
hijack(string $user): string
Assume the role of a secondary user
Assume the role of a secondary user
Parameters
| $user |
username or domain if parentage supported
|
|
#
|
public
|
_create()
|
#
|
public
|
_delete()
|
#
|
public
|
_edit()
|
#
|
public
|
_verify_conf(ConfigurationContext $ctx): bool
Configuration verification
Configuration verification
|
#
|
public
|
_edit_user(string $userold, string $usernew, array $oldpwd)
|
#
|
public
|
_create_user(string $user)
|
#
|
public
|
_delete_user(string $user)
|
#
|