CoremailXT高级API使用手册(Java版).doc
文本预览下载声明
Nx
版权声明
本文档版权归盈世信息科技（北京）有限公司所有，并保留一切权利。未经书面许可，任何公司和个人不得将此文档中的任何部分公开、转载或以其他方式散发给第三方。否则，必将追究其法律责任。
免责声明
如因文档使用不当造成的直接或间接损失，本公司不承担任何责任。文档更新
本文档由盈世信息科技（北京）有限公司于200年月最后修订。
销售咨询热线 800-830-7652 技术支持热线 800-830-5422 联系方式广州 地址：广州市中山大道科韵路16号广州信息港网易大厦3楼 邮编：510665 联系电话：+86(20传真：+86(20 北京 地址：北京市东城区安定门东大街28号雍和大厦B座1208室 邮编：100013 联系电话：+86(10传真：+86(10 上海 地址：上海市徐汇区斜土路2601弄嘉汇广场T3座6G室 邮编：200030 联系电话：+86(21传真：+86(21 目录
1 Coremail XT API通用函数说明 1
1.1 getClient(连接APIServer使用的socket) 1
1.2 getRetCode（获取操作的返回值） 1
1.3 getResult（操作的返回结果） 2
1.4 getResultEx（返回操作的返回结果） 2
1.5 getErrorInfo（描述操作失败原因） 2
1.6 toString（返回操作结果的字符串表示） 2
1.7 close（释放连接与资源） 3
2 API函数的使用步骤 3
3 Coremail XT API具体功能应用 4
3.1 登录 4
3.1.1 用户登录 4
3.1.2 检查用户是否存在 5
3.1.3 验证用户密码 6
3.1.4 检查用户的session，返回用户信息 6
3.1.5 检查用户的session，并刷新访问时间 7
3.1.6 获取用户session中的变量 7
3.1.7 用户退出 8
3.2 组织维护 8
3.2.1 创建组织 8
3.2.2 获取组织属性 9
3.2.3 修改组织属性 10
3.2.4 组织域名分配(添加/删除) 11
3.2.5 组织COS分配（添加/修改/删除） 11
3.2.6 根据COS获取用户列表 12
3.2.7 获取站点所有组织标识列表 13
3.3 部门维护 13
3.3.1 创建部门 13
3.3.2 删除部门 14
3.3.3 获取部门属性 14
3.3.4 设置部门属性 14
3.4 用户维护 15
3.4.1 创建用户 15
3.4.2 删除用户 16
3.4.3 用户属性获取 16
3.4.4 用户属性变更 17
3.4.5 用户是否存在判定 17
3.4.6 别名维护（添加/删除/获取） 18
3.4.7 把用户设置为管理员 19
3.4.8 修改用户主标识 19
3.4.9 用户跨组织移动 19
3.5 域名维护 20
3.5.1 检查域名或者域名别名是否存在 20
3.5.2 列出系统所有域名 20
3.5.3 增加域名 21
3.5.4 删除域名 21
3.5.5 增加域别名 21
3.5.6 删除域别名 22
4 附录 22
4.1 API配置文件说明 22
4.2 返回信息表 23
4.3 用户属性表 24
Coremail XT API通用函数说明
APIContext类提供一个工厂方法，产生一个的客户端连接IClient类型的实例，即API客户端对象。客户端对象可以进行多次调用APIServer的方法，进行操作，操作完成后客户端请求对象 IClient使用close方法关闭连接。
同时，IClient类型的实例操作通常返回一个APIContext类型的对象，它记录客户端与API Server之间的连接信息。可以通过APIContext.getRetCode以及APIContext.getResult等方法，获取IClient调用APIServer所得的结果。
以下为APIContext所提供的方法：
getClient(连接APIServer使用的socket)
public static final IClient getClient(.Socket socket)
throws java.io.IOException
功能： 根据socket获取API客户对象，客户对象可以进行多次API操作，
操作完成后请使用 IClient.close() 来关闭连接。
请注意, 每个client(socket)只能在一个thread中使用, 如果需要并发请
显示全部