CoremailAPI.docVIP

免责声明 本文档仅提供阶段性信息，所含内容可根据产品的实际情况随时更新，恕不另行通知。如因文档使用不当造成的直接或间接损失，本公司不承担任何责任。 文档更新 本文档由盈世信息科技（北京）有限公司于2009年1月最后修订。 公司网站 销售咨询热线 800-830-7652 技术支持热线 800-830-5422 联系方式 广州 地址：广州市中山大道科韵路16号广州信息港网易大厦3楼 邮编：510665 联系电话：+86(20传真：+86(20 北京 地址：北京市海淀区中关村东路1号院清华科技园8号楼启迪科技大厦D座27层 邮编：联系电话：+86(10)传真：+86(10) 上海 地址：上海市浦东新区张江碧波路690号张江微电子港9号楼502室 邮编：2联系电话：+86(21)传真：+86(21) 成都 地址：成都市高新区永丰路47号玉林商务港5楼518室 邮编：联系电话：+86(2传真：+86(2 目录 1 Coremail XT API结构与通用函数说明 1 1.1 Coremail XT API结构 1 1.2 通用函数说明 1 1.2.1 Connect（连接 API Server） 1 1.2.2 SetsocketTimeout（设置Socket的超时时限） 1 1.2.3 GetResultContent（获取请求的返回结果） 2 1.2.4 GetErrormessage（获取返回的失败信息字符串） 2 1.2.5 GetErrorCode（获取返回的失败信息代码） 2 1.2.6 StrUnescape（处理字符串） 2 1.2.7 StrEscape（处理字符串） 3 1.2.8 Close（释放连接和资源） 3 2 API函数的使用步骤 3 3 Coremail API具体功能应用 6 3.1 用户登录 6 3.1.1 密码校验 6 3.1.2 用户登录 6 3.1.3 用户登出 7 3.1.4 检查session ID是否过期 7 3.1.5 刷新session ID防止过期 8 3.1.6 在session中保存变量 8 3.1.7 获取session 中的变量 8 3.2 用户维护 9 3.2.1 创建用户 9 3.2.2 删除用户 10 3.2.3 用户属性获取 11 3.2.4 用户属性变更 11 3.2.5 用户是否存在判定 12 4 附录 12 4.1 API配置文件说明 12 4.2 返回信息表 13 4.3 用户属性表 14 Coremail XT API结构与通用函数说明 Coremail XT API结构 有关NULL： 在Coremail XT中，我们指定空字符串（字符串长度为零）和NULL值是等价的。只有字符串类型的属性才允许使用NULL值 上下文结构APIContext: APIContext是记录了与 API Server 之间连接信息的变量。在 API_Connect 成功以后，客户端和Server端通过这个结构维持上下文环境，开发人员一般不需要处理该结构。 通用函数说明 Connect（连接 API Server） API_RTCODE API_Connect(const char * szHost, unsigned short uPort, APIContext *pContext) 功能： 连接 API Server，并建立连接信息，初始化APIContext上下文结构 入口参数： szHost： APIServer 所在的主机IP uPort： APIServer 采用的端口号 pContext:： 会话上下文结构 返回值类型： API_RTCODE： 表示是否成功，成功返回API_OK，参考附录“返回信息” SetsocketTimeout（设置Socket的超时时限） void API_SetSocketTimeout(int nTimeoutSec, APIContext * pContext ); 功能： 设置Socket的超时时限（TimeOut） 入口参数： nTimeoutSec： Socket的超时时限（以秒为单位） pContext： API_Connect连接时建立的上下文 GetResultContent（获取请求的返回结果） const char * API_GetResultContent( APIContext * pContext ); 功能： 当调用功能函数成功时，获取请求的返回结果 入口参数： pContext： API_Connect连接时建立的上下文 返回值类型： 字符串： 获取请求的返回