Coremail XT V2.0 标准API使用手册(Java版)

Coremail XT V2.0 标准API（Java）使用手册

盈世信息科技（北京）有限公司

Coremail. Copyright 2000-2009 Mailtech.

盈世信息科技（北京）有限公司

版权声明

本文档版权归盈世信息科技（北京）有限公司所有，并保留一切权利。未经书面许可，任何公司和个人不得将此文档中的任何部分公开、转载或以其他方式散发给第三方。否则，必将追究其法律责任。

免责声明

本文档仅提供阶段性信息，所含内容可根据产品的实际情况随时更新，恕不另行通知。如因文档使用不当造成的直接或间接损失，本公司不承担任何责任。

文档更新

本文档由盈世信息科技（北京）有限公司于2009年9月最后修订。

公司网站

销售咨询热线800-830-7652

技术支持热线800-830-5422

联系方式

广州地址：广州市中山大道科韵路16号广州信息港网易大厦3楼

邮编：510665 联系电话：+86(20)85106566 传真：+86(20)85106595

北京地址：北京市西城区西外大街1号院西环广场T3座7层B7-B8

邮编：100044 联系电话：+86(10)58301930 传真：+86(10)58302888

上海地址：上海市静安区长乐路672弄33号B幢3楼

邮编：200040 联系电话：+86(21)61103951 传真：+86(21)61107756

成都地址：成都市高新区永丰路47号玉林商务港5楼518室

邮编：610041 联系电话：+86(28)66252331 传真：+86(28)66252332

盈世信息科技（北京）有限公司

目录

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 检查用户是否存在 (6)

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 用户属性获取 (9)

3.2.4 用户属性变更 (10)

3.2.5 用户是否存在判定 (10)

4 附录 (11)

4.1 API配置文件说明 (11)

4.2 返回信息表 (12)

4.3 用户属性表 (13)

盈世信息科技（北京）有限公司1Coremail XT API通用函数说明

APIContext类提供一个工厂方法，产生一个的客户端连接IClient类型的实例，即API 客户端对象。客户端对象可以进行多次调用APIServer的方法，进行操作，操作完成后客户端请求对象IClient使用close方法关闭连接。

同时，IClient类型的实例操作通常返回一个APIContext类型的对象，它记录客户端与API Server之间的连接信息。可以通过APIContext.getRetCode以及APIContext.getResult等方法，获取IClient调用APIServer所得的结果。

以下为APIContext所提供的方法：

1.1 getClient(连接APIServer使用的socket)

public static final IClient getClient(.Socket socket)

throws java.io.IOException

功能：根据socket获取API客户对象，客户对象可以进行多次API操作，

操作完成后请使用IClient.close() 来关闭连接。

请注意, 每个client(socket)只能在一个thread中使用, 如果需要

并发请为每个thread申请单独的连接

入口参数：

socket 连接APIServer使用的socket

返回值类型：

客户对象

抛出异常类型：

ng.NullPointerException：当传入的socket为null

java.io.IOException

1.2 getRetCode（获取操作的返回值）

public final int getRetCode()

功能：获取操作的返回值

返回值类型：

使用类的静态常量定义（例如：public static final int RC_NORMAL），各自的含义为：

盈世信息科技（北京）有限公司RC_NORMAL：操作成功

RC_ASSWORD_ERR：用户密码错误

RC_SES_ERROR Session：错误

RC_SESID_NOT_FOUND：Session ID 不存在或已经过时

RC_USER_EXIST：用户已存在

RC_USER_NOT_FOUND ：用户不存在

1.3 getResult（操作的返回结果）

public final ng.String getResult()

功能：操作的返回结果（只对有返回结果的操作才有意义）

返回值类型：

请参考各个API函数调用的说明

1.4 getResultEx（返回操作的返回结果）

public final Object getResultEx()

功能：返回操作的返回结果. 和getResult不同的是, 此方法可以返回其它数据类型.

返回值类型：

操作的返回结果.

1.5 getErrorInfo（描述操作失败原因）

public final ng.String getErrorInfo()

功能：操作失败时对操作失败原因的描述字符串

返回值类型：

失败原因的描述字符串

1.6 toString（返回操作结果的字符串表示）

public final String toString()

功能：返回操作结果的字符串表示

返回值类型：

操作结果的字符串表示