TencentMail\Service\User\Client

class Client

Traits

RequestTrait

Properties

protected	$http
protected	$access_token
protected	$endpoint

Methods

__construct(TencentMail $app)

Client constructor.

string

create(User $user)

创建成员.

string

update(User $user)

更新成员.

string

delete(string $userId)

删除成员.

string

get(string $userId)

获取成员.

string

list(int $department_id = 1, bool $fetch_child = false)

获取部门成员.

string

listDetails(int $department_id = 1, bool $fetch_child = false)

获取部门成员（详情）.

string

check(array $userlist)

批量检查帐号.

Details

at line 28
`__construct(TencentMail $app)`

Client constructor.

Parameters

TencentMail

$app

Exceptions

GuzzleException

at line 45
`string create(User $user)`

创建成员.

Parameters

User

$user

Return Value

string

Exceptions

TencentMailException

at line 64
`string update(User $user)`

更新成员.

Parameters

User

$user

Return Value

string

Exceptions

TencentMailException

at line 83
`string delete(string $userId)`

删除成员.

Parameters

string

$userId

成员UserID。企业邮帐号名，邮箱格式

Return Value

string

Exceptions

TencentMailException

at line 102
`string get(string $userId)`

获取成员.

Parameters

string

$userId

成员 UserID

Return Value

string

Exceptions

TencentMailException

at line 122
`string list(int $department_id = 1, bool $fetch_child = false)`

获取部门成员.

Parameters

int	$department_id	获取的部门id。id 为 1 时可获取根部门下的成员
bool	$fetch_child	是否递归获取子部门下面的成员

Return Value

string

Exceptions

TencentMailException

at line 146
`string listDetails(int $department_id = 1, bool $fetch_child = false)`

获取部门成员（详情）.

Parameters

int	$department_id	获取的部门 id。id 为 1 时可获取根部门下的成员
bool	$fetch_child	是否递归获取子部门下面的成员

Return Value

string

Exceptions

TencentMailException

at line 169
`string check(array $userlist)`

批量检查帐号.

Parameters

array

$userlist

成员帐号，每次检查不得超过20个

Return Value

string

Exceptions

TencentMailException

Client

Traits

Properties

Methods

Details

at line 28 __construct(TencentMail $app)

Parameters

Exceptions

at line 45 string create(User $user)

Parameters

Return Value

Exceptions

See also

at line 64 string update(User $user)

Parameters

Return Value

Exceptions

See also

at line 83 string delete(string $userId)

Parameters

Return Value

Exceptions

See also

at line 102 string get(string $userId)

Parameters

Return Value

Exceptions

See also

at line 122 string list(int $department_id = 1, bool $fetch_child = false)

Parameters

Return Value

Exceptions

See also

at line 146 string listDetails(int $department_id = 1, bool $fetch_child = false)

Parameters

Return Value

Exceptions

See also

at line 169 string check(array $userlist)

Parameters

Return Value

Exceptions

See also

at line 28
`__construct(TencentMail $app)`

at line 45
`string create(User $user)`

at line 64
`string update(User $user)`

at line 83
`string delete(string $userId)`

at line 102
`string get(string $userId)`

at line 122
`string list(int $department_id = 1, bool $fetch_child = false)`

at line 146
`string listDetails(int $department_id = 1, bool $fetch_child = false)`

at line 169
`string check(array $userlist)`