Download the PHP package leo108/qq-exmail without Composer
On this page you can find all versions of the php package leo108/qq-exmail. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package qq-exmail
qq-exmail
新版 QQ 企业邮箱接口 SDK,接口文档 https://exmail.qq.com/qy_mng_logic/doc#10001
安装
composer require leo108/qq-exmail -vvv
快速开始
构造函数
- 第一个参数为配置项。
- 第二个参数是一个符合 PSR-16 规范的缓存对象,用于保存各个应用的 access token,如果不传则默认使用内存缓存,即每次生命周期的各个应用第一次请求都会先通过 api 获得对应的 access token。Laravel 项目可以使用这个类 SimpleCacheBridge.php
- 第三个参数是一个 GuzzleHttp 对象,没有特殊需求可以保持
null
。 - 第四个参数是一个符合 PSR-3 规范的日志对象,用于打印日志,如果留空则不答应任何日志。
配置项
corp_id
可以在企业邮箱的"工具箱"->"应用中心"页面最下方找到。corp_secrets
从"应用中心"页面进入各个应用,可以找到对应的 secret。对于用不到的应用,可以不配置对应的 secret。log.format
定义日志格式,各个字段可以参考 https://github.com/guzzle/guzzle/blob/master/src/MessageFormatter.phplog.hide_access_token
如果设定为true
则会隐藏日志中 access token 的值,避免 token 泄露。
异常
本项目中所有的异常均继承自 Leo108\QQExmail\Core\Exceptions\QQExmailException
Leo108\QQExmail\Core\Exceptions\GetAccessTokenException
使用 corp id 和 corp secret 换取 access token 失败Leo108\QQExmail\Core\Exceptions\MissingSecretException
使用应用却没有配置该应用的 secretLeo108\QQExmail\Core\Exceptions\InvalidArgumentException
初始化时传入的配置有误Leo108\QQExmail\Core\Exceptions\ApiException
当 API 接口返回的 errcode 字段不为 0 时抛出
API 列表
- 部门管理
- 成员管理
- 邮件群组管理
- 功能设置
- 系统日志
- 新邮件提醒
- 单点登录
部门管理
创建部门 https://exmail.qq.com/qy_mng_logic/doc#10008
更新部门 https://exmail.qq.com/qy_mng_logic/doc#10009
删除部门 https://exmail.qq.com/qy_mng_logic/doc#10010
获取部门列表 https://exmail.qq.com/qy_mng_logic/doc#10011
查找部门 https://exmail.qq.com/qy_mng_logic/doc#10012
成员管理
创建成员 https://exmail.qq.com/qy_mng_logic/doc#10014
更新成员 https://exmail.qq.com/qy_mng_logic/doc#10015
删除成员 https://exmail.qq.com/qy_mng_logic/doc#10016
获取成员 https://exmail.qq.com/qy_mng_logic/doc#10017
获取部门成员 https://exmail.qq.com/qy_mng_logic/doc#10018
获取部门成员(详情) https://exmail.qq.com/qy_mng_logic/doc#10019
批量检查帐号 https://exmail.qq.com/qy_mng_logic/doc#10020
邮件群组管理
创建邮件群组 https://exmail.qq.com/qy_mng_logic/doc#10022
更新邮件群组 https://exmail.qq.com/qy_mng_logic/doc#10023
删除邮件群组 https://exmail.qq.com/qy_mng_logic/doc#10024
获取邮件群组信息 https://exmail.qq.com/qy_mng_logic/doc#10025
功能设置
获取功能属性 https://exmail.qq.com/qy_mng_logic/doc#10047
更改功能属性 https://exmail.qq.com/qy_mng_logic/doc#10048
系统日志
查询邮件概况 https://exmail.qq.com/qy_mng_logic/doc#10027
查询邮件 https://exmail.qq.com/qy_mng_logic/doc#10028
查询成员登录 https://exmail.qq.com/qy_mng_logic/doc#10029
查询批量任务 https://exmail.qq.com/qy_mng_logic/doc#10030
查询操作记录 https://exmail.qq.com/qy_mng_logic/doc#10031
新邮件提醒
获取邮件未读数 https://exmail.qq.com/qy_mng_logic/doc#10033
获取邮件未读数(回调模式)尚未实现
单点登录
获取登录企业邮的url https://exmail.qq.com/qy_mng_logic/doc#10036
其他
本项目是基于我的另外一个开源项目 php_sdk_skeleton 开发的。 通过 php_sdk_skeleton 可以快速构建基于 Http API 的 SDK。
License
MIT.
All versions of qq-exmail with dependencies
psr/simple-cache Version ^1.0
cache/array-adapter Version ^1.0