Winmail OpenAPI 开放接口说明文档
版本号： 1.3
苏州华兆科技有限公司
2025/07
一、开放协议介绍¶
1.1 功能简介¶
Winmail 邮件系统内置开放协议，包括管理端和用户邮件端两方面操作接口。其中，管理端接口提供对系统的域名、邮箱用户和邮件组等进行增删改操作；用户邮件端接口提供对用户邮箱的邮件夹，邮件列表，阅读邮件，地址簿等方面进行操作。
-
v1.0-v1.1 适用于 Winmail 6.x 版本
-
v1.2 适用于 Winmail 6.6 及以后版本
-
v1.3 适用于 Winmail 7.3 及以后版本
通过协议接口，企业用户可以实现：
1) 单点登录
可以从公司 OA 系统、门户网站一键进入企业邮箱，免去登录过程。
2) 新邮件提醒
新邮件即时在 OA 等办公系统提醒。
3) 数据同步
数据同步可以帮助你同步用户信息，你还可以创建、删除、修改邮箱帐号等。
1.2 协议格式¶
协议采用 HTTP 通信协议，返回结果 JSON 格式，请求采用 GET/POST 方式。
1.3 安全机制¶
-
管理员需要先设置 ApiKey 和 ApiSecret（修改后台配置文件），才可以使用接口。默认 ApiKey 为空，不能使用此功能。
-
接口操作邮箱账号和域名信息，需要管理员账号和管理员密码进行身份验证，就是要先调用管理员登录接口取得 sessid。
-
接口操作邮件，需要邮箱用户名和邮箱密码进行身份验证，就是要先调用用户登录接口取得 sessid。
1.4 协议编码¶
均用 UTF-8 编码。