当前位置:文档之家› API接口文档

API接口文档

API接口文档最后更新日期:2013-05-16一、添加域名接口 (6)1、接口调用地址 (6)2、传入参数 (6)3、输出数据 (6)二、删除域名接口 (7)1、接口调用地址 (7)2、传入参数 (7)3、输出数据 (7)三、添加用户接口 (8)1、接口调用地址 (8)2、传入参数 (8)3、输出数据 (8)四、获取用户信息接口 (9)1、接口调用地址 (9)2、传入参数 (9)3、输出数据 (9)五、搜索用户接口 (10)1、接口调用地址 (10)2、传入参数 (10)3、输出数据 (10)六、修改用户接口 (11)1、接口调用地址 (11)2、传入参数 (11)3、输出数据 (12)七、删除用户接口 (13)1、接口调用地址 (13)2、传入参数 (13)3、输出数据 (13)八、获取邮箱别名接口 (14)1、接口调用地址 (14)2、传入参数 (14)3、输出数据 (14)九、获取部门列表接口 (15)1、接口调用地址 (15)2、传入参数 (15)3、输出数据 (15)十、添加部门接口 (17)1、接口调用地址 (17)3、输出数据 (17)十一、修改部门接口 (18)1、接口调用地址 (18)2、传入参数 (18)3、输出数据 (18)十二、删除部门接口 (19)1、接口调用地址 (19)2、传入参数 (19)3、输出数据 (19)十三、获取部门成员接口 (20)1、接口调用地址 (20)2、传入参数 (20)3、输出数据 (20)十四、添加部门成员接口 (21)1、接口调用地址 (21)2、传入参数 (21)3、输出数据 (21)十五、删除部门成员接口 (22)1、接口调用地址 (22)2、传入参数 (22)3、输出数据 (22)十六、添加别名接口 (23)1、接口调用地址 (23)2、传入参数 (23)3、输出数据 (23)十七、修改别名接口 (24)1、接口调用地址 (24)2、传入参数 (24)3、输出数据 (24)十八、删除别名接口 (25)1、接口调用地址 (25)2、传入参数 (25)3、输出数据 (25)十九、获取POP接收邮件接口 (26)1、接口调用地址 (26)2、传入参数 (26)3、输出数据 (26)二十、添加POP接收邮件接口 (27)1、接口调用地址 (27)2、传入参数 (27)3、输出数据 (27)二十一、修改POP接收邮件接口 (28)1、接口调用地址 (28)3、输出数据 (28)二十二、删除POP接收邮件接口 (29)1、接口调用地址 (29)2、传入参数 (29)3、输出数据 (29)二十三、获取邮件列表接口 (30)1、接口调用地址 (30)2、传入参数 (30)3、输出格式 (30)二十四、查看邮件接口 (31)1、调用方式 (31)2、传入参数 (31)3、输出格式 (31)二十五、客户端连机检测接口 (32)1、接口调用地址 (32)2、传入参数 (32)3、输出数据 (32)二十六、单点登录 (33)1、登录方法 (33)2、传入参数 (34)二十七、冻结/解冻用户帐号接口 (36)1、接口调用地址 (36)2、传入参数 (36)3、输出数据 (36)二十八、获取冻结用户帐号接口 (37)1、调用方式 (37)2、传入参数 (37)3、输出格式 (37)二十九、获取显示已存在的邮件列表接口 (37)1、调用方式 (37)2、传入参数 (37)3、输出格式 (37)三十、添加邮件列表接口 (38)1、调用方式 (38)2、传入参数 (38)3、输出格式 (38)三十一、修改邮件列表接口 (38)1、调用方式 (38)2、传入参数 (39)3、输出格式 (39)三十二、删除邮件列表接口 (39)1、调用方式 (39)3、输出格式 (39)三十三、显示邮件列表成员接口 (40)1、调用方式 (40)3、输出格式 (40)三十四、添加邮件列表成员接口 (40)1、调用方式 (40)2、传入参数 (41)3、输出格式 (41)三十五、删除邮件列表成员接口 (41)1、调用方式 (41)2、传入参数 (41)3、输出格式 (41)三十六、更新邮件列表成员属性接口 (42)1、调用方式 (42)2、传入参数 (42)3、输出格式 (42)三十七、获取个人通讯录分组列表* (42)1、调用方式 (42)2、传入参数 (42)3、输出格式 (43)三十八、获取个人通讯录指定分组下的联系人列表* (43)1、调用方式 (43)2、传入参数 (43)3、输出格式 (44)三十九、获取个人通讯录联系人信息* (44)1、调用方式 (44)2、传入参数 (45)3、输出格式 (45)四十、添加个人通讯录分组* (46)1、调用方式 (46)2、传入参数 (46)3、输出格式 (46)四十一、修改个人通讯录分组* (47)1、调用方式 (47)2、传入参数 (47)3、输出格式 (47)四十二、删除个人通讯录分组* (48)1、调用方式 (48)2、传入参数 (48)3、输出格式 (48)四十三、添加联系人* (48)1、调用方式 (48)2、传入参数 (49)3、输出格式 (49)四十四、修改联系人* (50)1、调用方式 (50)2、传入参数 (50)3、输出格式 (51)四十五、删除联系人* (51)1、调用方式 (51)2、传入参数 (51)3、输出格式 (51)四十六、添加联系人分组信息* (52)1、调用方式 (52)2、传入参数 (52)3、输出格式 (53)四十七、删除联系人分组信息* (53)1、调用方式 (53)2、传入参数 (53)3、输出格式 (54)一、添加域名接口1、接口调用地址http://domain/webmail/api/addDomain.php?adminpass=xxx&domain=&quota=1 5000&userlimit=150&userquota=100&netfilequota=50&allowreg=on&created=2009-04 -23&ended=2013-01-01&password=1234562、传入参数需要以GET方式传递以下参数:●adminpass: 超级管理员MD5后的密码●domain: 要添加的域名,例如“”●quota: 此域的空间限额,单位为M。

只能为数字,例如“15000”●userlimit: 限制的用户数,只能为数字,例如“150”●userquota: 默认用户空间限额,单位为M。

只能为数字,例如“100”●netfilequota: 默认网络文件柜限额,单位为M。

只能为数字,例如“50”●allowreg: 是否允许自由注册,“on”为允许,“off”为不允许●created: 域开通时间,格式为“2009-04-23”●ended: 域到期时间,格式为“2013-01-01”●password: 此域的域管理员密码,如没有此项密码默认为“12345678”●pwd_encode:(新增)此域的域管理员密码,如没有此项密码默认为“12345678”(base64加密)。

password,pwd_encode两个参数,优先取pwd_encode3、输出数据输出内容及含义如下:●param_error: 传递的参数错误●verify_error: 验证超级管理员密码错误●domain_exist: 已存在此域名●add_error: 添加域名出错●ok: 成功添加域名二、删除域名接口1、接口调用地址http://domain/webmail/api/delDomain.php?adminpass=xxx&domain= 2、传入参数需要以GET方式传递以下参数:●adminpass: 超级管理员MD5后的密码●domain: 要删除的域名,例如“”3、输出数据输出内容及含义如下:●param_error: 传递的参数错误●verify_error: 验证超级管理员密码错误●domain_not_exist: 不存在此域名●del_error: 删除域名出错●ok: 成功删除域名三、添加用户接口1、接口调用地址http://domain/webmail/api/addUser.php?adminname=admin&adminpass=xxx&mailbox= ************&password=11111&fullname=name&mailquota=100&filequota=502、传入参数需要以GET方式传递以下参数:●adminname: 域管理员名称●adminpass: 域管理员MD5后的密码●mailbox: 要添加的邮箱帐户全称,例如************●customdata: 自定义字段数据,如”10001”●password: 此帐户要设置的密码●pwd_encode:(新增)此帐户要设置的密码(base64加密)。

password,pwd_encode两个参数,优先取pwd_encode●fullname: 用户姓名(如果为中文字符请使用UTF-8格式,并进行URL 编码)●mailquota: 邮件空间限额,单位为“M”,只能为数字●filequota: 网络文件柜空间限额,单位为“M”,只能为数字3、输出数据输出内容及含义如下:●param_error: 传递的参数错误●verify_error: 域管理员验证错误●mailbox_exist: 已存在此邮箱●add_error: 添加邮箱错误●数字: 成功添加邮箱返回用户id值四、获取用户信息接口1、接口调用地址使用邮箱名称调用(未开启自定义用户字段功能):http://domain/webmail/api/userInfo.php?adminname=admin&adminpass=xxx&mai lbox=************使用自定义字段调用:http://domain/webmail/api/userInfo.php?adminname=admin&adminpass=xxx&dom ain=&cfv=xxx2、传入参数需要以GET方式传递以下参数:●adminname: 域管理员名称●adminpass: 域管理员MD5后的密码●mailbox: 取得信息的邮箱帐户全称,例如“************”●cfv: 自定义字段对应值,例如学号“100001”●domain: 自定义字段对应用户所在的域名名称,例如“”3、输出数据正常情况下输出的信息为XML,其格式如下:<?xml version="1.0" encoding="UTF-8" ?><user><email>************</email><name><![CDATA[用户姓名]]></name><password>用户密码</password><custom_value><![CDATA[自定义用户字段对应值]]></custom_value></user>出现错误的时候输出内容为字符串,输出类型及其含义如下:●param_error: 传递的参数错误●verify_error: 域管理员验证错误●mailbox_not_exist: 不存在此邮箱五、搜索用户接口1、接口调用地址http://domain/webmail/api/searchUser.php?domain=&adminname=admin&adm inpass=xxx&keyword=user2、传入参数需要以GET方式传递以下参数:●domain: 要搜索用户的邮箱域●adminname: 域管理员名称●adminpass: 域管理员MD5后的密码●keyword: 搜索关键字,为UTF-8编码,需进行URL Encode转换。

相关主题