Winmail OpenAPI 1.0 说明文档.pdf
31页
1 Winmail 开放接口说明文档开放接口说明文档开放接口说明文档开放接口说明文档 版本版本版本版本号号号号：：：：1.0 华美科技华美科技华美科技华美科技(苏州苏州苏州苏州)有限公司有限公司有限公司有限公司 2016,2 2 目目目目 录录录录 一、开放协议介绍 ........................................................................................................................... 4 1.1 功能简介............................................................................................................................ 4 1.2 协议格式............................................................................................................................. 4 1.3 安全机制............................................................................................................................ 4 1.4 协议编码............................................................................................................................ 4 二、接入流程 ................................................................................................................................... 4 2.1 设置 Winmail 开放接口 .................................................................................................. 4 2.2 数据交互............................................................................................................................ 5 三、基本参数说明 ........................................................................................................................... 6 3.1 请求 URL ............................................................................................................................ 6 3.1.1 基本参数 ................................................................................................................. 6 3.1.2 样例......................................................................................................................... 6 3.2 返回结果............................................................................................................................ 6 3.2.1 含义......................................................................................................................... 6 3.2.2 样例......................................................................................................................... 7 3.3 签名机制............................................................................................................................ 7 3.3.1 签名算法 ................................................................................................................. 7 3.3.2 调用示例 .................................................................................................................. 7 四、管理端接口 ............................................................................................................................... 8 4.1 管理员登录 ........................................................................................................................ 8 4.2 域名管理............................................................................................................................ 9 4.2.1 域名列表 ................................................................................................................. 9 4.2.2 新增域名 ............................................................................................................... 10 4.2.3 修改域名 ............................................................................................................... 10 4.2.4 删除域名 ............................................................................................................... 11 4.3 用户管理.......................................................................................................................... 11 4.3.1 用户列表 ............................................................................................................... 11 4.3.2 新增用户 ............................................................................................................... 12 4.3.3 修改用户 ............................................................................................................... 13 4.3.4 删除邮箱 ............................................................................................................... 14 4.4 组管理.............................................................................................................................. 14 4.4.1 组列表................................................................................................................... 14 4.4.2 新增组................................................................................................................... 15 4.4.3 修改组................................................................................................................... 16 4.4.4 删除组................................................................................................................... 17 4.5 管理员管理 ...................................................................................................................... 17 4.4.1 管理员列表 ........................................................................................................... 17 4.4.2 新增管理员 ........................................................................................................... 17 4.4.3 修改组................................................................................................................... 18 3 4.4.4 删除组................................................................................................................... 18 五、用户邮件接口 ......................................................................................................................... 20 5.1 用户登录.......................................................................................................................... 20 5.2 邮件夹操作 ...................................................................................................................... 21 5.2.1 列邮件夹 ............................................................................................................... 21 5.2.2 新建邮件夹 ........................................................................................................... 21 5.2.3 重命名邮件夹 ....................................................................................................... 21 5.2.4 删除邮件夹 ........................................................................................................... 22 5.2.5 清空邮件夹 ........................................................................................................... 22 5.3 邮件列表.......................................................................................................................... 22 5.3.1 列邮件夹的邮件 ................................................................................................... 22 5.3.2 删除邮件 ............................................................................................................... 23 5.3.3 移动邮件 ............................................................................................................... 23 5.3.4 置顶邮件 ............................................................................................................... 24 5.3.5 取消置顶邮件 ....................................................................................................... 24 5.3.6 设置已读标记 ....................................................................................................... 24 5.3.7 设置未读标记 ........................................................................................................ 25 5.3.8 设置星标邮件 ....................................................................................................... 25 5.3.9 取消星标邮件 ........................................................................................................ 25 5.4 邮件数.............................................................................................................................. 26 5.5 阅读邮件.......................................................................................................................... 26 5.6 发送邮件.......................................................................................................................... 27 5.7 个人地址簿 ...................................................................................................................... 27 5.7.1 列地址簿 ............................................................................................................... 27 5.7.2 增加联系人 ........................................................................................................... 28 5.7.3 修改联系人 ........................................................................................................... 29 5.7.4 删除联系人 ........................................................................................................... 29 5.7.5 增加地址组 ........................................................................................................... 30 5.7.6 修改地址组 ........................................................................................................... 30 5.7.7 删除地址组 ........................................................................................................... 30 4 一一一一、、、、开放协议介绍开放协议介绍开放协议介绍开放协议介绍 1.1 功能简介功能简介功能简介功能简介 Winmail 邮箱开放协议，包括管理端和用户邮件端两方面操作接口。
其中，管理端接口提供对系统的域名、 邮箱用户和邮件组等进行增删改管理； 用户邮件端接口提供对用户邮箱的邮件夹，邮件列表，阅读邮件，地址簿等方面进行操作 1.0 适用于适用于适用于适用于 Winmail 6.0 版本版本版本版本 通过协议接口，企业用户可以实现： 1) 单点登录 可以从公司 OA 系统、网站一键进入企业邮箱，免去登录过程 2) 新邮件提醒 新邮件将即时在 OA 等办公系统提醒你 3) 数据同步 数据同步可以帮助你同步部门成员信息，你还可以创建、删除、修改帐号，同步部门信息等 1.2 协议格式协议格式协议格式协议格式 协议采用 HTTP 通信协议，返结果 JSON 格式，请求采用 GET/POST 方式 1.3 安全机制安全机制安全机制安全机制 1）管理员需要先设置 AppKey 和 AppSecret ，才可以使用接口默认 AppKey 为空，不能使用此功能 2）接口操作前需要用户名和密码进行身份验证 1.4 协议编码协议编码协议编码协议编码 均用 UTF-8 编码 二二二二、、、、接入流程接入流程接入流程接入流程 2.1 设置设置设置设置 Winmail 开放接口开放接口开放接口开放接口 要使用 Winmail 开放接口首先要设置 AppKey 和 AppSecret， 作为下一步验证授权传递的参数。
5 用记事本打开 ~\server\webmail\inc\config.apikey.php 要设置 API 和 Secret , Secret 必须超过 20 个字符 注意注意注意注意：：：：为了为了为了为了安全安全安全安全，，，，请请请请不用不用不用不用直接直接直接直接使用使用使用使用本本本本文档文档文档文档和和和和示例示例示例示例文件文件文件文件里里里里的的的的 AppKey 和和和和 AppSecret 2.2 数据交互数据交互数据交互数据交互 1）构造请求参数：调用请求方根据 Winmail API 提供的接口规则，通过程序生成得到签名结果及要传输给 API 平台的请求的数据结合； 2）发送请求数据：把构造完成的数据结合，通过 GET 或者 POS 提交的方式，传递给Winmail API 平 台； 3） Winmail API 平台对请求数据进行处理合后， 会先进行安全校验等验证， 一系列验 证通过后便会处理完成本次发送过来的数据请求； 4）Winmail API 平台把处理完成的结果数据按 JSON 格式，返回请求方； 5）请求方解析 JSON 结果后，可以结合自身的业务逻辑进行数据处理。
6 三三三三、、、、基本参数说明基本参数说明基本参数说明基本参数说明 3.1 请求请求请求请求 URL 3.1.1 基本参数基本参数基本参数基本参数 参数参数参数参数 参数名称参数名称参数名称参数名称 参数说明参数说明参数说明参数说明 必须必须必须必须 样例样例样例样例 系统参数系统参数系统参数系统参数 – 每次调用都必须包含这些参数 appkey AppKey API 平台分配请求方的唯一编号 Y ec880a9d4b sign 签名 请求方根据 http 请求的参数通过 md5 生成的签名 Y 5c5f3b87357750a3f6 dd23e59d1089f1 timestamp 时间戳 客户端的当前 UNIX 时间戳 Y 当前时间: 2016-01-20 12:05:00 timestamp 值 1453219500 应用应用应用应用参数参数参数参数– 参考各个接口参数的说明 method 方法名 需要请求的方法名 Y msglist fields 请求参数 双方约定的各方法的调用参数 3.1.2 样例样例样例样例 http://winmailserver/admin/openapi.php?apikey=ec880a9d4b&domain=&method=user.delete&name=abc&sessid=efd24f9f63d69d6f6f169b235822ca5875eb2bae×tamp=1455759653&sign=0ce5b7cdeca218e2dd0ca0fe9e8c5665 3.2 返回返回返回返回结果结果结果结果 3.2.1 含义含义含义含义 Winmail API 平台对请求方提供的请求数据进行验证处理后，返回给请求方处理结果，以便请求方根据这些数据进一步处理。
响应返回处理成功或者失败信息， 需要请求方对相关错误进行处理 7 3.2.2 样例样例样例样例 请求成功返回数据如下 { "result": "ok", "info": { “sessid”: "efd24f9f63d69d6f6f169b235822ca5875eb2bae", “user”: "admin" } } 请求错误返回数据如下 { "result": "error", "error": "url sign invalid" } 3.3 签名机制签名机制签名机制签名机制 3.3.1 签名算法签名算法签名算法签名算法 1）所有请求参数按参数名升序排序； 2）按请求参数名及参数值相互连接组成一个字符串； 3）将应用密钥分别添加到以上请求参数串的头部和尾部； 4）对该字符串进行 MD5 运算，得到一个 32 位小写字串； 5）该字符串即是本次请求参数对应的签名； 6）该签名值使用 sign 系统级参数一起和其它请求参数一起发送给服务 API 平台 sign = md5(appsecret+k1+v1+k2+v2+...+kn+vn+appsecret) 3.3.2 调用示例调用示例调用示例调用示例 调用 API：login 应用参数: user,pass AppKey: ec880a9d4b AppSecret: aff54e78f6871aea3714a3916eb35199b7affb19 因为各语言语法不一致，以下实例只体现逻辑。
8 输入参数为 method= login appkey= ec880a9d4b timestamp=1455764753 user=test pass=123456 按照参数名称升序排列 appkey= ec880a9d4b method= login pass=123456 timestamp=1455764753 user=test 连接字符串 连接参数名与参数值，并在首尾加上 secret，如下： aff54e78f6871aea3714a3916eb35199b7affb19apikeyec880a9d4bmethodloginpass123456timestamp1455764753usertestaff54e78f6871aea3714a3916eb35199b7affb19 生成签名 32 位小写 MD5 值->496c4156bc32ca11fe81899e1b6a242c 拼装 Http 请求 将所有参数值，然后拼装，通过浏览器访问该地址，即成功调用一次接口， 如下 ： http://magicwinmailserver/openapi.php?apikey=ec880a9d4b&method=login&pass=123456×tamp=1455764753&user=test&sign=496c4156bc32ca11fe81899e1b6a242c 四四四四、、、、管理端接口管理端接口管理端接口管理端接口 4.1 管理管理管理管理员员员员登录登录登录登录 参数参数参数参数 参数名称参数名称参数名称参数名称 参数说明参数说明参数说明参数说明 必须必须必须必须 样例样例样例样例 应用应用应用应用参数参数参数参数 method 方法名 login Y user 用户名 管理员用户名 Y admin pass 登录密码 箮理员密码 Y 123456 成功返回值 { "result": "ok", "info": { “sessid”: "efd24f9f63d69d6f6f169b235822ca5875eb2bae", 9 “user”: "admin" } } 登录成返回 sessid , 这是一个会话 token，以下所有操作接口都需要携带此 sessid 参数 登录成功后，开发者一直可以使用此 sessid 进行操作其他接口。
会话是有效期的，长时间不操作会过期，生存时间与 Webmail 的会话时间一致（默认是 30 分钟） 开发者可以在有效期内定时更新 session 保持一直有效 参数参数参数参数 参数名称参数名称参数名称参数名称 参数说明参数说明参数说明参数说明 必须必须必须必须 样例样例样例样例 应用应用应用应用参数参数参数参数 method 方法名 updatesesion Y sessid 登录 session 登录成返回 sessid Y 参考 “4.1 管理员登录” 成功返回值 { "result": "ok"} 4.2 域名域名域名域名管理管理管理管理 4.2.1 域名域名域名域名列表列表列表列表 参数参数参数参数 参数名称参数名称参数名称参数名称 参数说明参数说明参数说明参数说明 必须必须必须必须 样例样例样例样例 应用应用应用应用参数参数参数参数 method 方法名 domain Y sessid 登录 session 登录成返回 sessid Y 参考 “4.1 管理员登录” pageno 页码 分页序号，以 0 开始 N 成功返回值 { "result": "ok", "info": { “domains”: 域名列表, “totalcount”: 域名总数 “pagecount”: 分页总数 } } 10 4.2.2 新增新增新增新增域名域名域名域名 参数参数参数参数 参数名称参数名称参数名称参数名称 参数说明参数说明参数说明参数说明 必须必须必须必须 样例样例样例样例 应用应用应用应用参数参数参数参数 method 方法名 domain.added Y sessid 登录 session 登录成返回 sessid Y 参考 “4.1 管理员登录” domain 域名 Y type 域名类型 1-主域 0-普通域 N description 描述 N mailquota 新邮箱默认空间大小 单位 MB N mailcount 新邮箱默认最多邮件数 N ftpquota 新邮箱默认网络磁盘空间大小 单位 MB N ftpcount 新邮箱默认网络磁盘最多文件数 N 成功返回值 { "result": "ok"} 4.2.3 修改修改修改修改域名域名域名域名 参数参数参数参数 参数名称参数名称参数名称参数名称 参数说明参数说明参数说明参数说明 必须必须必须必须 样例样例样例样例 应用应用应用应用参数参数参数参数 method 方法名 domain.edited Y sessid 登录 session 登录成返回 sessid Y 参考 “4.1 管理员登录” domain 域名 Y type 域名类型 1-主域 0-普通域 N description 描述 N mailquota 新邮箱默认空间大小 单位 MB N mailcount 新邮箱默认最多邮件数 N ftpquota 新邮箱默认网络磁盘空间大小 单位 MB N ftpcount 新邮箱默认网络磁盘最多文件数 N 11 成功返回值 { "result": "ok"} 4.2.4 删除域名删除域名删除域名删除域名 参数参数参数参数 参数名称参数名称参数名称参数名称 参数说明参数说明参数说明参数说明 必须必须必须必须 样例样例样例样例 应用应用应用应用参数参数参数参数 method 方法名 domain.delete Y sessid 登录 session 登录成返回 sessid Y 参考 “4.1 管理员登录” domain 域名 Y 成功返回值 { "result": "ok"} 4.3 用户管理用户管理用户管理用户管理 4.3.1 用户用户用户用户列表列表列表列表 参数参数参数参数 参数名称参数名称参数名称参数名称 参数说明参数说明参数说明参数说明 必须必须必须必须 样例样例样例样例 应用应用应用应用参数参数参数参数 method 方法名 user Y sessid 登录 session 登录成返回 sessid Y 参考 “4.1 管理员登录” domain 域名 列出此域名下的用户 Y pageno 页码 分页序号，以 0 开始 N 成功返回值 { "result": "ok", "info": { “users”: 邮箱用户列表, “totalcount”: 用户总数 “pagecount”: 分页总数 “domain”: 所属域名 } } 12 4.3.2 新增新增新增新增用户用户用户用户 参数参数参数参数 参数名称参数名称参数名称参数名称 参数说明参数说明参数说明参数说明 必须必须必须必须 样例样例样例样例 应用应用应用应用参数参数参数参数 method 方法名 user.added Y sessid 登录 session 登录成返回 sessid Y 参考 “4.1 管理员登录” name 邮箱用户名 Y domain 域名 Y password 邮箱密码 Y authtype 认证方式 0 - 本系统认证； 1 - NT 域认证； 2 - 第三方认证 N status 状态 0 - 正常； 1 - 禁止； 2 - 等待审核 N fullname 用户姓名 N description 描述 N homeaddress 家庭地址 N homephone 家庭 N mobile N company 工作单位 N jobtitle 职位 N office 办公室 N officephone 办公 N mailquota 邮箱空间大小 单位 MB N mailcount 邮箱最多邮件数 N ftpquota 网络磁盘空间大小 单位 MB N ftpcount 网络磁盘最多文件数 N 成功返回值 { "result": "ok"} 13 4.3.3 修改修改修改修改用户用户用户用户 参数参数参数参数 参数名称参数名称参数名称参数名称 参数说明参数说明参数说明参数说明 必须必须必须必须 样例样例样例样例 应用应用应用应用参数参数参数参数 method 方法名 user.edited Y sessid 登录 session 登录成返回 sessid Y 参考 “4.1 管理员登录” name 邮箱用户名 Y domain 域名 Y password 邮箱密码 Y authtype 认证方式 0 - 本系统认证； 1 - NT 域认证； 2 - 第三方认证 N status 状态 0 - 正常； 1 - 禁止； 2 - 等待审核 N fullname 用户姓名 N description 描述 N homeaddress 家庭地址 N homephone 家庭 N mobile N company 工作单位 N jobtitle 职位 N office 办公室 N officephone 办公 N mailquota 邮箱空间大小 单位 MB N mailcount 邮箱最多邮件数 N ftpquota 网络磁盘空间大小 单位 MB N ftpcount 网络磁盘最多文件数 N 成功返回值 { "result": "ok"} 14 4.3.4 删除删除删除删除邮箱邮箱邮箱邮箱 参数参数参数参数 参数名称参数名称参数名称参数名称 参数说明参数说明参数说明参数说明 必须必须必须必须 样例样例样例样例 应用应用应用应用参数参数参数参数 method 方法名 user.delete Y sessid 登录 session 登录成返回 sessid Y 参考 “4.1 管理员登录” name 邮箱用户名 Y domain 域名 Y 成功返回值 { "result": "ok"} 4.4 组管理组管理组管理组管理 4.4.1 组组组组列表列表列表列表 参数参数参数参数 参数名称参数名称参数名称参数名称 参数说明参数说明参数说明参数说明 必须必须必须必须 样例样例样例样例 应用应用应用应用参数参数参数参数 method 方法名 group Y sessid 登录 session 登录成返回 sessid Y 参考 “4.1 管理员登录” domain 域名 列出此域名下的用户 Y pageno 页码 分页序号，以 0 开始 N 成功返回值 { "result": "ok", "info": { “groups”: 邮箱用户列表, “totalcount”: 用户总数 “pagecount”: 分页总数 “domain”: 所属域名 } } 15 4.4.2 新增新增新增新增组组组组 参数参数参数参数 参数名称参数名称参数名称参数名称 参数说明参数说明参数说明参数说明 必须必须必须必须 样例样例样例样例 应用应用应用应用参数参数参数参数 method 方法名 group.added Y sessid 登录 session 登录成返回 sessid Y 参考“4.1 管理员登录” name 组名 Y domain 域名 Y fullname 组名称 N description 描述 N subgroup 子分组 以分号(;)分隔 N members 组成员 以分号(;)分隔 N sendmailright 发信权限 0 - 任何人都可以给组员发信； 1 - 只有组员可以发信； 2 - 仅指定成员可以发信； 3 - 本域下用户可以发信 N sendmailmembers 发信成员 以分号(;)分隔 N managers 组管理员 以分号(;)分隔 N visibleright 可见权限 0 - 任何人可以看到此通讯组及其成员； 1 - 任何人可以看到此通讯组； 2 - 本域用户可以看到此通讯组及其成员； 3 - 域用户可以看到此通讯组； 4 - 组成员可以看到此通讯组及其成员； 5 - 组成员可以看到此通讯组； 6 - 只有管理员可以看到此通讯组及成员 N sendervisible 发信成员可见 0 - 没有特别可见权限； 1 - 发信成员有相同的可见度。
N 成功返回值 { "result": "ok"} 16 4.4.3 修改修改修改修改组组组组 参数参数参数参数 参数名称参数名称参数名称参数名称 参数说明参数说明参数说明参数说明 必须必须必须必须 样例样例样例样例 应用应用应用应用参数参数参数参数 method 方法名 group.edited Y sessid 登录 session 登录成返回 sessid Y 参考“4.1 管理员登录” name 组名 Y domain 域名 Y fullname 组名称 N description 描述 N subgroup 子分组 以分号(;)分隔 N members 组成员 以分号(;)分隔 N sendmailright 发信权限 0 - 任何人都可以给组员发信； 1 - 只有组员可以发信； 2 - 仅指定成员可以发信； 3 - 本域下用户可以发信 N sendmailmembers 发信成员 以分号(;)分隔 N managers 组管理员 以分号(;)分隔 N visibleright 可见权限 0 - 任何人可以看到此通讯组及其成员； 1 - 任何人可以看到此通讯组； 2 - 本域用户可以看到此通讯组及其成员； 3 - 域用户可以看到此通讯组； 4 - 组成员可以看到此通讯组及其成员； 5 - 组成员可以看到此通讯组； 6 - 只有管理员可以看到此通讯组及成员 N sendervisible 发信成员可见 0 - 没有特别可见权限； 1 - 发信成员有相同的可见度。
N 成功返回值 { "result": "ok"} 17 4.4.4 删除删除删除删除组组组组 参数参数参数参数 参数名称参数名称参数名称参数名称 参数说明参数说明参数说明参数说明 必须必须必须必须 样例样例样例样例 应用应用应用应用参数参数参数参数 method 方法名 group.delete Y sessid 登录 session 登录成返回 sessid Y 参考 “4.1 管理员登录” name 组名 Y domain 域名 Y 成功返回值 { "result": "ok"} 4.5 管理员管理员管理员管理员管理管理管理管理 4.4.1 管理员管理员管理员管理员列表列表列表列表 参数参数参数参数 参数名称参数名称参数名称参数名称 参数说明参数说明参数说明参数说明 必须必须必须必须 样例样例样例样例 应用应用应用应用参数参数参数参数 method 方法名 adminuser Y sessid 登录 session 登录成返回 sessid Y 参考 “4.1 管理员登录” pageno 页码 分页序号，以 0 开始 N 成功返回值 { "result": "ok", "info": { “users”: 邮箱用户列表, “totalcount”: 用户总数 “pagecount”: 分页总数 } } 4.4.2 新增新增新增新增管理员管理员管理员管理员 参数参数参数参数 参数名称参数名称参数名称参数名称 参数说明参数说明参数说明参数说明 必须必须必须必须 样例样例样例样例 18 应用应用应用应用参数参数参数参数 method 方法名 adminuser.added Y sessid 登录 session 登录成返回 sessid Y 参考“4.1 管理员登录” username 管理员用户名 Y password 管理员密码 Y description 描述 N usertype 管理员类型 0 - 超级管理员； 1 - 域管理员 N adminrange 允许管理的域 多个域名之间用分号(;)分隔 N 成功返回值 { "result": "ok"} 4.4.3 修改组修改组修改组修改组 参数参数参数参数 参数名称参数名称参数名称参数名称 参数说明参数说明参数说明参数说明 必须必须必须必须 样例样例样例样例 应用应用应用应用参数参数参数参数 method 方法名 adminuser.edited Y sessid 登录 session 登录成返回 sessid Y 参考“4.1 管理员登录” username 管理员用户名 Y password 管理员密码 Y description 描述 N usertype 管理员类型 0 - 超级管理员； 1 - 域管理员 N adminrange 允许管理的域 多个域名之间用分号(;)分隔 N 成功返回值 { "result": "ok"} 4.4.4 删除组删除组删除组删除组 参数参数参数参数 参数名称参数名称参数名称参数名称 参数说明参数说明参数说明参数说明 必须必须必须必须 样例样例样例样例 应用应用应用应用参数参数参数参数 method 方法名 adminuser.delete Y 19 sessid 登录 session 登录成返回 sessid Y 参考 “4.1 管理员登录” username 管理员用户名 Y 成功返回值 { "result": "ok"} 20 五五五五、、、、用户邮件接口用户邮件接口用户邮件接口用户邮件接口 5.1 用户用户用户用户登录登录登录登录 参数参数参数参数 参数名称参数名称参数名称参数名称 参数说明参数说明参数说明参数说明 必须必须必须必须 样例样例样例样例 应用应用应用应用参数参数参数参数 method 方法名 login Y user 用户名 登录用户名 Y test pass 登录密码 登录密码 Y 123456 登录成返回 sessid , 这是一个会话 token，以下所有操作接口都需要携带此 sessid 参数 登录成功返回值 { "result": "ok", "info": { “sessid”: "1a2db1b0edda735295508723d8c6a962", “user”: "test" } } 登录成功后，开发者一直可以使用此 sessid 进行操作其他接口。
会话是有效期的，长时间不操作会过期，生存时间与 Webmail 的会话时间一致（默认是 30 分钟） 开发者可以在有效期内定时更新 session 保持一直有效 参数参数参数参数 参数名称参数名称参数名称参数名称 参数说明参数说明参数说明参数说明 必须必须必须必须 样例样例样例样例 应用应用应用应用参数参数参数参数 method 方法名 updatesesion Y sessid 登录 session 登录成返回 sessid Y 参考 “5.1 管理员登录” 成功返回值 { "result": "ok"} 21 5.2 邮件邮件邮件邮件夹夹夹夹操作操作操作操作 5.2.1 列列列列邮件夹邮件夹邮件夹邮件夹 参数参数参数参数 参数名称参数名称参数名称参数名称 参数说明参数说明参数说明参数说明 必须必须必须必须 样例样例样例样例 应用应用应用应用参数参数参数参数 method 方法名 folders Y sessid 登录 session 登录成返回 sessid Y 参考“5.1 用户登录” 成功返回值 { "result": "ok", "info": { “private”: 个人邮件夹, “public”: 公共邮件夹 “archive”: 归档邮件夹 “label”: 标签 } } 5.2.2 新建新建新建新建邮件夹邮件夹邮件夹邮件夹 参数参数参数参数 参数名称参数名称参数名称参数名称 参数说明参数说明参数说明参数说明 必须必须必须必须 样例样例样例样例 应用应用应用应用参数参数参数参数 method 方法名 folders.newfolder Y sessid 登录 session 登录成返回 sessid Y 参考“5.1 用户登录” newfolder 新邮件夹名 Y 成功返回值 { "result": "ok"} 5.2.3 重命名重命名重命名重命名邮件夹邮件夹邮件夹邮件夹 参数参数参数参数 参数名称参数名称参数名称参数名称 参数说明参数说明参数说明参数说明 必须必须必须必须 样例样例样例样例 应用应用应用应用参数参数参数参数 method 方法名 folders.renamefolder Y 22 sessid 登录 session 登录成返回 sessid Y 参考“5.1 用户登录” optfolder 要操作的邮件夹名 Y newfolder 新邮件夹名 Y 成功返回值 { "result": "ok"} 5.2.4 删除邮件删除邮件删除邮件删除邮件夹夹夹夹 参数参数参数参数 参数名称参数名称参数名称参数名称 参数说明参数说明参数说明参数说明 必须必须必须必须 样例样例样例样例 应用应用应用应用参数参数参数参数 method 方法名 folders.delfolder Y sessid 登录 session 登录成返回 sessid Y 参考“5.1 用户登录” optfolder 要操作的邮件夹名 Y 成功返回值 { "result": "ok"} 5.2.5 清空清空清空清空邮件夹邮件夹邮件夹邮件夹 参数参数参数参数 参数名称参数名称参数名称参数名称 参数说明参数说明参数说明参数说明 必须必须必须必须 样例样例样例样例 应用应用应用应用参数参数参数参数 method 方法名 folders.emptyfolder Y sessid 登录 session 登录成返回 sessid Y 参考“5.1 用户登录” optfolder 要操作的邮件夹名 Y 成功返回值 { "result": "ok"} 5.3 邮件列表邮件列表邮件列表邮件列表 5.3.1 列列列列邮件夹的邮件夹的邮件夹的邮件夹的邮件邮件邮件邮件 参数参数参数参数 参数名称参数名称参数名称参数名称 参数说明参数说明参数说明参数说明 必须必须必须必须 样例样例样例样例 应用应用应用应用参数参数参数参数 23 method 方法名 msglist Y sessid 登录 session 登录成返回 sessid Y 参考“5.1 用户登录” folder 文件夹 Y pag 页码 分页序号，以 0 开始 N 成功返回值 { "result": "ok", "info": { “messagelist”: 邮件列表信息, “totalpage”: 总分页数 “newmsg”: 新邮件数 “msgtotal”: 邮件总数 } } 5.3.2 删除删除删除删除邮件邮件邮件邮件 参数参数参数参数 参数名称参数名称参数名称参数名称 参数说明参数说明参数说明参数说明 必须必须必须必须 样例样例样例样例 应用应用应用应用参数参数参数参数 method 方法名 msglist.delete Y sessid 登录 session 登录成返回 sessid Y 参考“5.1 用户登录” folder 文件夹 Y msgid 邮件标识 Y 成功返回值 { "result": "ok"} 5.3.3 移动移动移动移动邮件邮件邮件邮件 参数参数参数参数 参数名称参数名称参数名称参数名称 参数说明参数说明参数说明参数说明 必须必须必须必须 样例样例样例样例 应用应用应用应用参数参数参数参数 method 方法名 msglist.delete Y sessid 登录 session 登录成返回 sessid Y 参考“5.1 用户登录” folder 文件夹 Y msgid 邮件标识 Y tofolder 目标邮件夹 Y 24 成功返回值 { "result": "ok"} 5.3.4 置顶置顶置顶置顶邮件邮件邮件邮件 参数参数参数参数 参数名称参数名称参数名称参数名称 参数说明参数说明参数说明参数说明 必须必须必须必须 样例样例样例样例 应用应用应用应用参数参数参数参数 method 方法名 msglist.top Y sessid 登录 session 登录成返回 sessid Y 参考“5.1 用户登录” folder 文件夹 Y msgid 邮件标识 Y 成功返回值 { "result": "ok"} 5.3.5 取消取消取消取消置顶邮件置顶邮件置顶邮件置顶邮件 参数参数参数参数 参数名称参数名称参数名称参数名称 参数说明参数说明参数说明参数说明 必须必须必须必须 样例样例样例样例 应用应用应用应用参数参数参数参数 method 方法名 msglist.untop Y sessid 登录 session 登录成返回 sessid Y 参考“5.1 用户登录” folder 文件夹 Y msgid 邮件标识 Y 成功返回值 { "result": "ok"} 5.3.6 设置已读标记设置已读标记设置已读标记设置已读标记 参数参数参数参数 参数名称参数名称参数名称参数名称 参数说明参数说明参数说明参数说明 必须必须必须必须 样例样例样例样例 应用应用应用应用参数参数参数参数 method 方法名 msglist.read Y sessid 登录 session 登录成返回 sessid Y 参考“5.1 用户登录” folder 文件夹 Y msgid 邮件标识 Y 25 成功返回值 { "result": "ok"} 5.3.7 设置设置设置设置未未未未读标记读标记读标记读标记 参数参数参数参数 参数名称参数名称参数名称参数名称 参数说明参数说明参数说明参数说明 必须必须必须必须 样例样例样例样例 应用应用应用应用参数参数参数参数 method 方法名 msglist.unread Y sessid 登录 session 登录成返回 sessid Y 参考“5.1 用户登录” folder 文件夹 Y msgid 邮件标识 Y 成功返回值 { "result": "ok"} 5.3.8 设置设置设置设置星星星星标标标标邮件邮件邮件邮件 参数参数参数参数 参数名称参数名称参数名称参数名称 参数说明参数说明参数说明参数说明 必须必须必须必须 样例样例样例样例 应用应用应用应用参数参数参数参数 method 方法名 msglist.flag Y sessid 登录 session 登录成返回 sessid Y 参考“5.1 用户登录” folder 文件夹 Y msgid 邮件标识 Y 成功返回值 { "result": "ok"} 5.3.9 取消星标邮件取消星标邮件取消星标邮件取消星标邮件 参数参数参数参数 参数名称参数名称参数名称参数名称 参数说明参数说明参数说明参数说明 必须必须必须必须 样例样例样例样例 应用应用应用应用参数参数参数参数 method 方法名 msglist.unflag Y sessid 登录 session 登录成返回 sessid Y 参考“5.1 用户登录” folder 文件夹 Y msgid 邮件标识 Y 成功返回值 26 { "result": "ok"} 5.4 文件夹文件夹文件夹文件夹未读未读未读未读邮件邮件邮件邮件数数数数 参数参数参数参数 参数名称参数名称参数名称参数名称 参数说明参数说明参数说明参数说明 必须必须必须必须 样例样例样例样例 应用应用应用应用参数参数参数参数 method 方法名 msgnum Y sessid 登录 session 登录成返回 sessid Y 参考“5.1 用户登录” 成功返回值 { "result": "ok", "info": 各文件夹的未读邮件数 } 5.5 阅阅阅阅读邮件读邮件读邮件读邮件 参数参数参数参数 参数名称参数名称参数名称参数名称 参数说明参数说明参数说明参数说明 必须必须必须必须 样例样例样例样例 应用应用应用应用参数参数参数参数 method 方法名 readmsg Y sessid 登录 session 登录成返回 sessid Y 参考“5.1 用户登录” folder 文件夹 Y msgid 邮件标识 N 成功返回值 { "result": "ok", "info": { “from”: 发件人信息, “reply-to”: 回复信息 “to”: 收件人信息 “cc”: 抄送信息 “subject”: 主题 “date”: 发件日期 “body”: 信体内容 “attachment”: 邮件附件 “memo”: 邮件备注信息 } 27 } 5.6 发送发送发送发送邮件邮件邮件邮件 参数参数参数参数 参数名称参数名称参数名称参数名称 参数说明参数说明参数说明参数说明 必须必须必须必须 样例样例样例样例 应用应用应用应用参数参数参数参数 method 方法名 newmsg Y sessid 登录 session 登录成返回 sessid Y 参考“5.1 用户登录” to 收件人 多个地址用分号(;)分隔 Y cc 抄送 多个地址用分号(;)分隔 N subject 邮件主题 Y msgbody 邮件信体 Y ishtml Html 邮件 0 - 文本邮件； 1 – HTML 邮件 N priority 优先级 0 - 正常；1 - 优先 N requestnotify 请求阅读回条 0 - 不需要；1 - 需要 N 成功返回值 { "result": "ok"} 5.7 个人个人个人个人地址簿地址簿地址簿地址簿 5.7.1 列列列列地址簿地址簿地址簿地址簿 参数参数参数参数 参数名称参数名称参数名称参数名称 参数说明参数说明参数说明参数说明 必须必须必须必须 样例样例样例样例 应用应用应用应用参数参数参数参数 method 方法名 addressbook Y sessid 登录 session 登录成返回 sessid Y 参考“5.1 用户登录” pag 页码 分页序号，以 0 开始 N 成功返回值 { "result": "ok", "info": { “group”: 地址组列表, 28 “address”: 联系人列表 “totalpage”: 总页数 “addresscount”: 邮件总数 } } 5.7.2 增加联系人增加联系人增加联系人增加联系人 参数参数参数参数 参数名称参数名称参数名称参数名称 参数说明参数说明参数说明参数说明 必须必须必须必须 样例样例样例样例 应用应用应用应用参数参数参数参数 method 方法名 addressbook.addcontact Y sessid 登录 session 登录成返回 sessid Y 参考“5.1 用户登录” name 姓名 Y email 邮件地址 Y mobile N phone N fax N address 联系地址 N zipcode 区号 N company 工作单位 N depart 部门 N jobtitle 职位 N homephone 家庭 N homeaddress 家庭地址 N homezipcode 家庭区号 N im 即时通信 N url 个人网址 N email1 备份邮箱地址 N birthday 生日 N memo 备注 N 成功返回值 { "result": "ok"} 29 5.7.3 修改修改修改修改联系人联系人联系人联系人 参数参数参数参数 参数名称参数名称参数名称参数名称 参数说明参数说明参数说明参数说明 必须必须必须必须 样例样例样例样例 应用应用应用应用参数参数参数参数 method 方法名 addressbook.savecontact Y sessid 登录 session 登录成返回 sessid Y 参考“5.1 用户登录” id 联系人标识 Y name 姓名 Y email 邮件地址 Y mobile N phone N fax N address 联系地址 N zipcode 区号 N company 工作单位 N depart 部门 N jobtitle 职位 N homephone 家庭 N homeaddress 家庭地址 N homezipcode 家庭区号 N im 即时通信 N url 个人网址 N email1 备份邮箱地址 N birthday 生日 N memo 备注 N 成功返回值 { "result": "ok"} 5.7.4 删除删除删除删除联系人联系人联系人联系人 参数参数参数参数 参数名称参数名称参数名称参数名称 参数说明参数说明参数说明参数说明 必须必须必须必须 样例样例样例样例 应用应用应用应用参数参数参数参数 method 方法名 addressbook.delecontact Y 30 sessid 登录 session 登录成返回 sessid Y 参考“5.1 用户登录” id 联系人标识 Y 成功返回值 { "result": "ok"} 5.7.5 增加地址组增加地址组增加地址组增加地址组 参数参数参数参数 参数名称参数名称参数名称参数名称 参数说明参数说明参数说明参数说明 必须必须必须必须 样例样例样例样例 应用应用应用应用参数参数参数参数 method 方法名 addressbook.addgroup Y sessid 登录 session 登录成返回 sessid Y 参考“5.1 用户登录” name 分组名称 Y member 组成员 多个联系人地址用分号(;)分隔 Y 成功返回值 { "result": "ok"} 5.7.6 修改地址组修改地址组修改地址组修改地址组 参数参数参数参数 参数名称参数名称参数名称参数名称 参数说明参数说明参数说明参数说明 必须必须必须必须 样例样例样例样例 应用应用应用应用参数参数参数参数 method 方法名 addressbook.savegroup Y sessid 登录 session 登录成返回 sessid Y 参考“5.1 用户登录” id 组标识 Y name 分组名称 Y member 组成员 多个联系人地址用分号(;)分隔 Y 成功返回值 { "result": "ok"} 5.7.7 删除删除删除删除地址组地址组地址组地址组 参数参数参数参数 参数名称参数名称参数名称参数名称 参数说明参数说明参数说明参数说明 必须必须必须必须 样例样例样例样例 31 应用应用应用应用参数参数参数参数 method 方法名 addressbook.delegroup Y sessid 登录 session 登录成返回 sessid Y 参考“5.1 用户登录” id 组标识 Y 成功返回值 { "result": "ok"} 。
