Coremail 高级API使用手册(C版).doc

版权声明 本文档版权归盈世信息科技（北京）有限公司所有，并保留一切权利。未经书面许可，任何公司和个人不得将此文档中的任何部分公开、转载或以其他方式散发给第三方。否则，必将追究其法律责任。 免责声明 本文档仅提供阶段性信息，所含内容可根据产品的实际情况随时更新，恕不另行通知。如因文档使用不当造成的直接或间接损失，本公司不承担任何责任。 文档更新 本文档由盈世信息科技（北京）有限公司于2012年9月最后修订。 公司网站 销售咨询热线 800-830-7652 技术支持热线 800-830-5422 联系方式 广州 地址：广州市海珠区新港东路1000号保利世界贸易中心西塔1505-1506 邮编：510305 联系电话：+86(20传真：+86(20 北京 地址：北京市西城区西外大街1号院西环广场T3座7层B7-B8 邮编：100044 联系电话：+86(10传真：+86(10 上海 地址：上海市静安区武宁南路488号智慧广场1609-1610 邮编：200042 联系电话：+86(21传真：+86(21 成都 地址：成都市高新区永丰路47号玉林商务港5楼518室 邮编：610041 联系电话：+86(28传真：+86(28 目录 1 Coremail 4.0 API结构与通用函数说明 1 1.1 Coremail 4.0 API结构 1 1.2 通用函数说明 1 1.2.1 Connect（连接 API Server） 1 1.2.2 Close（释放连接） 2 1.2.3 SetSocketTimeout（设置Socket的超时时限） 2 1.2.4 GetErrorCode（获取返回的失败信息代码） 2 1.2.5 GetErrorMessage（获取返回的失败信息字符串） 3 1.2.6 GetResultContent（获取请求的返回结果） 3 1.2.7 StrUnesscape（处理字符串） 4 1.2.8 StrEscape（处理字符串） 4 2 API函数的使用步骤 5 3 Coremail 4.0 API具体功能应用 8 3.1 登录 8 3.1.1 检查用户密码 8 3.1.2 用户退出登录 9 3.1.3 检查session是否过期 9 3.1.4 刷新session防止过期 10 3.1.5 获取临时变量的值 10 3.1.6 在session中保存字符串 11 3.2 组织维护 12 3.2.1 添加组织 12 3.2.2 获取组织属性 15 3.2.3 修改组织属性 16 3.2.4 域名分配(添加/删除) 17 3.2.5 COS分配（删除/修改/添加） 18 3.2.6 根据域名和COS获取用户列表 20 3.2.7 获取站点所有组织标识列表 21 3.3 用户维护 22 3.3.1 创建用户 22 3.3.2 删除用户 24 3.3.3 用户属性获取 25 3.3.4 用户属性变更 26 3.3.5 用户是否存在判定 26 3.3.6 别名维护（获取/添加/删除） 27 3.3.7 读取用户的管理员身份 29 3.3.8 修改用户主标识 29 3.3.9 用户跨组织移动 30 3.4 域名维护 31 3.4.1 检查域名是否存在 31 3.4.2 列出系统所有域名 31 3.4.3 列出某个域名的使用别名 32 3.4.4 增加域名 33 3.4.5 删除域名 33 3.4.6 增加域别名 34 3.4.7 删除域别名 34 4 附录 35 4.1 返回信息表 35 4.2 用户属性表 36 Coremail 4.0 API结构与通用函数说明 Coremail 4.0 API结构 有关NULL： 在Coremail 4.0中，我们指定空字符串（字符串长度为零）和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： APISe