| Methods |
public
|
__construct(AbstractModule $oModule)
|
#
|
public
|
getUser(int|string $mUserId): User|false
Retrieves information on particular WebMail Pro user.
Retrieves information on particular WebMail Pro user.
Parameters
| $mUserId |
User identifier or UUID.
|
|
#
|
public
|
getUserByPublicId($UserPublicId)
|
#
|
public
|
getUsersCount(string $sSearchDesc = '', Builder $oFilters = null, $iGroupId = 0): int
|
#
|
public
|
getUserList(
int $iOffset = 0,
int $iLimit = 0,
string $sOrderBy = 'Name',
int $iOrderType = SortOrder::ASC,
string $sSearchDesc = '',
Builder $oFilters = null,
$iGroupId = 0,
): array|false
Obtains list of information about users.
Obtains list of information about users.
Parameters
| $sOrderBy |
= 'Email'. Field by which to sort.
|
| $iOrderType |
= 0
|
| $sSearchDesc |
= ''. If specified, the search goes on by substring in the name and email of default account.
|
| $oFilters |
= []
|
|
#
|
public
|
getUsersCountForTenant(int $iTenantId): int|false
Determines how many users are in particular tenant. Tenant identifier is used for look up.
Determines how many users are in particular tenant. Tenant identifier is used for look up.
Parameters
| $iTenantId |
Tenant identifier.
|
|
#
|
public
|
getTotalUsersCount(): int
Calculates total number of users registered in WebMail Pro.
Calculates total number of users registered in WebMail Pro.
|
#
|
public
|
isExists(User $oUser): bool
|
#
|
public
|
createUser(User &$oUser): bool
|
#
|
public
|
updateUser(User &$oUser): bool
|
#
|
public
|
deleteUser(User &$oUser): bool
|
#
|
public
|
deleteUserById($id)
|
#
|