Zm_User
Zm_User is a class which allows a Kerio user to manage its own account via SOAP
You may change password, modify and get the attributes of a Kerio user using this class
For the usage examples of all class methods check the source code of test.php
Table of Contents
- $auth : Zm_Auth
- $auth
- __construct() : mixed
- Constructor
- changeUserPassword() : array<string|int, mixed>
- changeUserPassword
- getUserAttrs() : string
- getUserAttrs
- getUserInfo() : array<string|int, mixed>
- getUserInfo
- getUserPrefs() : array<string|int, mixed>
- getUserPrefs
- modifyUserPrefs() : array<string|int, mixed>
- modifyUserPrefs
- userExists() : bool
- userExists
Properties
$auth
$auth
private
Zm_Auth
$auth
Methods
__construct()
Constructor
public
__construct(Zm_Auth $auth) : mixed
Parameters
- $auth : Zm_Auth
-
soap authentication
Return values
mixed —changeUserPassword()
changeUserPassword
public
changeUserPassword(string $userName, string $oldPassword, string $newPassword) : array<string|int, mixed>
Parameters
- $userName : string
-
user name
- $oldPassword : string
-
old password
- $newPassword : string
-
new password
Return values
array<string|int, mixed> —informations
getUserAttrs()
getUserAttrs
public
getUserAttrs(string $userName) : string
Parameters
- $userName : string
-
user name
Return values
string —option
getUserInfo()
getUserInfo
public
getUserInfo(string $userName) : array<string|int, mixed>
Parameters
- $userName : string
-
user name
Return values
array<string|int, mixed> —informations
getUserPrefs()
getUserPrefs
public
getUserPrefs(string $userName) : array<string|int, mixed>
Parameters
- $userName : string
-
user name
Return values
array<string|int, mixed> —prefs
modifyUserPrefs()
modifyUserPrefs
public
modifyUserPrefs(string $userName[, array<string|int, mixed> $prefs = array() ]) : array<string|int, mixed>
Parameters
- $userName : string
-
user name
- $prefs : array<string|int, mixed> = array()
-
an array containing the user prefs to be set
Return values
array<string|int, mixed> —informations
userExists()
userExists
public
userExists(string $userName) : bool
Parameters
- $userName : string
-
user name
Return values
bool —exists