1. class
  2. TencentMail
  3. \
  4. Service
  5. \
  6. Department
  7. \
  8. Client

Client

class Client

Traits

RequestTrait

Properties

protected $app
protected $http
protected $access_token
protected $endpoint

Methods

__construct(TencentMail $app)

Client constructor.

string
create(string $name, int $parentid = 1, int $order = 0)

创建部门.

string
update(int $id, string $name, int $parentid = 1, int $order = 0)

更新部门.

string
delete(int $id)

删除部门.

string
list(int $id = 1)

获取部门列表.

string
find(string $name, bool $fuzzy = true)

查找部门.

Details

at line 30
__construct(TencentMail $app)

Client constructor.

Parameters

TencentMail $app

Exceptions

GuzzleException

at line 50
string create(string $name, int $parentid = 1, int $order = 0)

创建部门.

Parameters

string $name 部门名称。长度限制为1~64个字节，字符不能包括:*?"<>｜
int $parentid 父部门 ID。id为1可表示根部门
int $order 在父部门中次序值。值小的排序靠前，1-10000为保留值，若使用保留值，将被强制重置为0。

Return Value

string

Exceptions

TencentMailException

See also

https://exmail.qq.com/qy_mng_logic/doc#10008

at line 72
string update(int $id, string $name, int $parentid = 1, int $order = 0)

更新部门.

Parameters

int $id 部门 id
string $name 更新的部门名称
int $parentid 父部门 id。id 为 1 表示根部门
int $order 在父部门中次序值。值小的排序靠前，1-10000为保留值，若使用保留值，将被强制重置为0。

Return Value

string

Exceptions

TencentMailException

See also

https://exmail.qq.com/qy_mng_logic/doc#10009

at line 91
string delete(int $id)

删除部门.

Parameters

int $id 部门id。不能删除根部门；不能删除含有子部门、成员的部门

Return Value

string

Exceptions

TencentMailException

See also

https://exmail.qq.com/qy_mng_logic/doc#10010

at line 109
string list(int $id = 1)

获取部门列表.

Parameters

int $id 部门id。获取指定部门及其下的子部门。id为1时可获取根部门下的子部门。

Return Value

string

Exceptions

TencentMailException

See also

https://exmail.qq.com/qy_mng_logic/doc#10011

at line 128
string find(string $name, bool $fuzzy = true)

查找部门.

Parameters

string $name 查找的部门名字，必须合法
bool $fuzzy 是否模糊匹配

Return Value

string

Exceptions

TencentMailException

See also

https://exmail.qq.com/qy_mng_logic/doc#10012