API接口文檔(精編版)_第1頁
API接口文檔(精編版)_第2頁
API接口文檔(精編版)_第3頁
已閱讀5頁,還剩45頁未讀, 繼續(xù)免費閱讀

下載本文檔

版權(quán)說明:本文檔由用戶提供并上傳,收益歸屬內(nèi)容提供方,若內(nèi)容存在侵權(quán),請進行舉報或認領(lǐng)

文檔簡介

1、api 接口文檔最后更新日期:2013-05-16一、添加域名接口. 6 1、接口調(diào)用地址. 6 2、傳入?yún)?shù) . 6 3、輸出數(shù)據(jù) . 6 二、刪除域名接口. 7 1、接口調(diào)用地址. 7 2、傳入?yún)?shù) . 7 3、輸出數(shù)據(jù) . 7 三、添加用戶接口. 8 1、接口調(diào)用地址. 8 2、傳入?yún)?shù) . 8 3、輸出數(shù)據(jù) . 8 四、獲取用戶信息接口. 9 1、接口調(diào)用地址. 9 2、傳入?yún)?shù) . 9 3、輸出數(shù)據(jù) . 9 五、搜索用戶接口. 10 1、接口調(diào)用地址. 10 2、傳入?yún)?shù) . 10 3、輸出數(shù)據(jù) . 10 六、修改用戶接口. 11 1、接口調(diào)用地址. 11 2、傳入?yún)?shù) . 11 3

2、、輸出數(shù)據(jù) . 12 七、刪除用戶接口. 13 1、接口調(diào)用地址. 13 2、傳入?yún)?shù) . 13 3、輸出數(shù)據(jù) . 13 八、獲取郵箱別名接口. 14 1、接口調(diào)用地址. 14 2、傳入?yún)?shù) . 14 3、輸出數(shù)據(jù) . 14 九、獲取部門列表接口. 15 1、接口調(diào)用地址. 15 2、傳入?yún)?shù) . 15 3、輸出數(shù)據(jù) . 15 十、添加部門接口. 17 1、接口調(diào)用地址. 17 2、傳入?yún)?shù) . 17 3、輸出數(shù)據(jù) . 17 十一、修改部門接口. 18 1、接口調(diào)用地址. 18 2、傳入?yún)?shù) . 18 3、輸出數(shù)據(jù) . 18 十二、刪除部門接口. 19 1、接口調(diào)用地址. 19 2、傳入?yún)?shù)

3、. 19 3、輸出數(shù)據(jù) . 19 十三、獲取部門成員接口. 20 1、接口調(diào)用地址. 20 2、傳入?yún)?shù) . 20 3、輸出數(shù)據(jù) . 20 十四、添加部門成員接口. 21 1、接口調(diào)用地址. 21 2、傳入?yún)?shù) . 21 3、輸出數(shù)據(jù) . 21 十五、刪除部門成員接口. 22 1、接口調(diào)用地址. 22 2、傳入?yún)?shù) . 22 3、輸出數(shù)據(jù) . 22 十六、添加別名接口. 23 1、接口調(diào)用地址. 23 2、傳入?yún)?shù) . 23 3、輸出數(shù)據(jù) . 23 十七、修改別名接口. 24 1、接口調(diào)用地址. 24 2、傳入?yún)?shù) . 24 3、輸出數(shù)據(jù) . 24 十八、刪除別名接口. 25 1、接口調(diào)用地址

4、. 25 2、傳入?yún)?shù) . 25 3、輸出數(shù)據(jù) . 25 十九、獲取pop接收郵件接口. 26 1、接口調(diào)用地址. 26 2、傳入?yún)?shù) . 26 3、輸出數(shù)據(jù) . 26 二十、添加pop接收郵件接口. 27 1、接口調(diào)用地址. 27 2、傳入?yún)?shù) . 27 3、輸出數(shù)據(jù) . 27 二十一、修改pop接收郵件接口. 28 1、接口調(diào)用地址. 28 2、傳入?yún)?shù) . 28 3、輸出數(shù)據(jù) . 28 二十二、刪除pop接收郵件接口. 29 1、接口調(diào)用地址. 29 2、傳入?yún)?shù) . 29 3、輸出數(shù)據(jù) . 29 二十三、獲取郵件列表接口. 30 1、接口調(diào)用地址. 30 2、傳入?yún)?shù) . 30 3、輸

5、出格式 . 30 二十四、查看郵件接口. 31 1、調(diào)用方式 . 31 2、傳入?yún)?shù) . 31 3、輸出格式 . 31 二十五、客戶端連機檢測接口. 32 1、接口調(diào)用地址. 32 2、傳入?yún)?shù) . 32 3、輸出數(shù)據(jù) . 32 二十六、單點登錄. 33 1、登錄方法 . 33 2、傳入?yún)?shù) . 34 二十七、凍結(jié)/解凍用戶帳號接口. 36 1、接口調(diào)用地址. 36 2、傳入?yún)?shù) . 36 3、輸出數(shù)據(jù) . 36 二十八、獲取凍結(jié)用戶帳號接口. 37 1、調(diào)用方式 . 37 2、傳入?yún)?shù) . 37 3、輸出格式 . 37 二十九、獲取顯示已存在的郵件列表接口. 37 1、調(diào)用方式 . 37 2

6、、傳入?yún)?shù) . 37 3、輸出格式 . 37 三十、添加郵件列表接口. 38 1、調(diào)用方式 . 38 2、傳入?yún)?shù) . 38 3、輸出格式 . 38 三十一、修改郵件列表接口. 38 1、調(diào)用方式 . 38 2、傳入?yún)?shù) . 39 3、輸出格式 . 39 三十二、刪除郵件列表接口. 39 1、調(diào)用方式 . 39 3、輸出格式 . 39 三十三、顯示郵件列表成員接口. 40 1、調(diào)用方式 . 40 3、輸出格式 . 40 三十四、添加郵件列表成員接口. 40 1、調(diào)用方式 . 40 2、傳入?yún)?shù) . 41 3、輸出格式 . 41 三十五、刪除郵件列表成員接口. 41 1、調(diào)用方式 . 41 2、

7、傳入?yún)?shù) . 41 3、輸出格式 . 41 三十六、更新郵件列表成員屬性接口. 42 1、調(diào)用方式 . 42 2、傳入?yún)?shù) . 42 3、輸出格式 . 42 三十七、獲取個人通訊錄分組列表*. 42 1、調(diào)用方式 . 42 2、傳入?yún)?shù) . 42 3、輸出格式 . 43 三十八、獲取個人通訊錄指定分組下的聯(lián)系人列表* . 43 1、調(diào)用方式 . 43 2、傳入?yún)?shù) . 43 3、輸出格式 . 44 三十九、獲取個人通訊錄聯(lián)系人信息* . 44 1、調(diào)用方式 . 44 2、傳入?yún)?shù) . 45 3、輸出格式 . 45 四十、添加個人通訊錄分組* . 46 1、調(diào)用方式 . 46 2、傳入?yún)?shù) .

8、46 3、輸出格式 . 46 四十一、修改個人通訊錄分組* . 47 1、調(diào)用方式 . 47 2、傳入?yún)?shù) . 47 3、輸出格式 . 47 四十二、刪除個人通訊錄分組* . 48 1、調(diào)用方式 . 48 2、傳入?yún)?shù) . 48 3、輸出格式 . 48 四十三、添加聯(lián)系人* . 48 1、調(diào)用方式 . 49 2、傳入?yún)?shù) . 49 3、輸出格式 . 49 四十四、修改聯(lián)系人* . 50 1、調(diào)用方式 . 50 2、傳入?yún)?shù) . 50 3、輸出格式 . 51 四十五、刪除聯(lián)系人* . 51 1、調(diào)用方式 . 51 2、傳入?yún)?shù) . 51 3、輸出格式 . 52 四十六、添加聯(lián)系人分組信息* .

9、52 1、調(diào)用方式 . 52 2、傳入?yún)?shù) . 52 3、輸出格式 . 53 四十七、刪除聯(lián)系人分組信息* . 53 1、調(diào)用方式 . 53 2、傳入?yún)?shù) . 53 3、輸出格式 . 54 一、添加域名接口1、接口調(diào)用地址 :/domain/webmail/api/adddomain.php?adminpass=xxx&domain=abc &quota=15000&userlimit=150&userquota=100&netfilequota=50&allowreg=on&created=2009-04-23&ended=20

10、13-01-01&password=123456 2、傳入?yún)?shù)需要以 get 方式傳遞以下參數(shù):adminpass: 超級管理員md5 后的密碼domain: 要添加的域名,例如“abc ”quota: 此域的空間限額,單位為m。只能為數(shù)字,例如“15000”userlimit: 限制的用戶數(shù),只能為數(shù)字,例如“150”userquota: 默認用戶空間限額,單位為m。只能為數(shù)字,例如“100”netfilequota: 默認網(wǎng)絡文件柜限額,單位為m。只能為數(shù)字,例如“50”allowreg: 是否允許自由注冊, “on”為允許,“off ”為不允許created: 域開通時間,格式為

11、“2009-04-23”ended: 域到期時間,格式為“2013-01-01”password: 此域的域管理員密碼,如沒有此項密碼默認為“12345678”pwd_encode: 新增此域的域管理員密碼,如沒有此項密碼默認為“12345678”(base64 加密 )。password,pwd_encode兩個參數(shù),優(yōu)先取pwd_encode3、輸出數(shù)據(jù)輸出內(nèi)容及含義如下:param_error: 傳遞的參數(shù)錯誤verify_error: 驗證超級管理員密碼錯誤domain_exist: 已存在此域名add_error: 添加域名出錯ok: 成功添加域名二、刪除域名接口1、接口調(diào)用地址 :

12、/domain/webmail/api/deldomain.php?adminpass=xxx&domain=abc 2、傳入?yún)?shù)需要以 get 方式傳遞以下參數(shù):adminpass: 超級管理員md5 后的密碼domain: 要刪除的域名,例如“abc ”3、輸出數(shù)據(jù)輸出內(nèi)容及含義如下:param_error: 傳遞的參數(shù)錯誤verify_error: 驗證超級管理員密碼錯誤domain_not_exist: 不存在此域名del_error: 刪除域名出錯ok: 成功刪除域名三、添加用戶接口1、接口調(diào)用地址 :/domain/webmail/api/adduser.php?admin

13、name=admin&adminpass=xxx&mailbox=userabc &password=11111&fullname=name&mailquota=100&filequota=50 2、傳入?yún)?shù)需要以 get 方式傳遞以下參數(shù):adminname: 域管理員名稱adminpass: 域管理員md5 后的密碼mailbox: 要添加的郵箱帳戶全稱,例如userabc customdata: 自定義字段數(shù)據(jù),如” 10001”password: 此帳戶要設置的密碼pwd_encode: 新增此帳戶要設置的密碼(base64 加密 )。p

14、assword,pwd_encode兩個參數(shù),優(yōu)先取pwd_encodefullname: 用戶如果為中文字符請使用utf-8 格式,并進行url 編碼mailquota: 郵件空間限額,單位為“m” ,只能為數(shù)字filequota: 網(wǎng)絡文件柜空間限額,單位為“m” ,只能為數(shù)字3、輸出數(shù)據(jù)輸出內(nèi)容及含義如下:param_error: 傳遞的參數(shù)錯誤verify_error: 域管理員驗證錯誤mailbox_exist: 已存在此郵箱add_error: 添加郵箱錯誤數(shù)字 : 成功添加郵箱返回用戶id 值四、獲取用戶信息接口1、接口調(diào)用地址使用郵箱名稱調(diào)用未開啟自定義用戶字段功能: :/do

15、main/webmail/api/userinfo.php?adminname=admin&adminpass=xxx&mailbox=userabc 使用自定義字段調(diào)用: :/domain/webmail/api/userinfo.php?adminname=admin&adminpass=xxx&domain=abc &cfv=xxx 2、傳入?yún)?shù)需要以 get 方式傳遞以下參數(shù):adminname: 域管理員名稱adminpass: 域管理員md5 后的密碼mailbox: 取得信息的郵箱帳戶全稱,例如“userabc ”cfv: 自定義字段對應值

16、,例如學號“100001”domain: 自定義字段對應用戶所在的域名名稱,例如“abc ”3、輸出數(shù)據(jù)正常情況下輸出的信息為xml ,其格式如下: userabc 用戶密碼 出現(xiàn)錯誤的時候輸出內(nèi)容為字符串,輸出類型及其含義如下:param_error: 傳遞的參數(shù)錯誤verify_error: 域管理員驗證錯誤mailbox_not_exist: 不存在此郵箱五、搜索用戶接口1、接口調(diào)用地址 :/domain/webmail/api/searchuser.php?domain=test &adminname=admin&adminpass=xxx&keyword=us

17、er 2、傳入?yún)?shù)需要以 get 方式傳遞以下參數(shù):domain: 要搜索用戶的郵箱域adminname: 域管理員名稱adminpass: 域管理員md5 后的密碼keyword: 搜索關(guān)鍵字,為utf-8 編碼,需進行url encode 轉(zhuǎn)換。系統(tǒng)會根據(jù)此關(guān)鍵字對郵箱名、用戶名、自定義用戶字段進行查詢。3、輸出數(shù)據(jù)正常情況下輸出的信息為xml ,其格式如下: 123 userabc 出現(xiàn)錯誤的時候輸出內(nèi)容為字符串,輸出類型及其含義如下:param_error: 傳遞的參數(shù)錯誤verify_error: 域管理員驗證錯誤六、修改用戶接口1、接口調(diào)用地址 :/domain/webmail/a

18、pi/updateuser.php?adminname=admin&adminpass=xxx&mailbox=userabc &password=11111&fullname=name&mailquota=100&filequota=50 2、傳入?yún)?shù)需要以 get 方式傳遞以下參數(shù):adminname : 域管理員名稱adminpass : 域管理員md5 后的密碼mailbox : 要修改的郵箱帳戶全稱,例如“userabc ”customdata: 自定義字段數(shù)據(jù),如” 10001”password: 如修改此帳戶密碼請使用此參數(shù)pwd_

19、encode: 新 增 如 修 改 此 帳 戶 密 碼 請 使 用 此 參 數(shù) (base64 加 密 ) 。password,pwd_encode 兩個參數(shù),優(yōu)先取pwd_encode fullname: 如修改用戶請使用此參數(shù)如果為中文字符請使用utf-8 格式,并進行url 編碼mailquota: 如修改郵件空間限額請使用此參數(shù),單位為“m” ,只能為數(shù)字filequota: 如修改網(wǎng)絡文件柜空間限額請使用此參數(shù),單位為“m” ,只能為數(shù)字dept_old: 原部門 iddept_new: 新部門 id。如果 dept_old 和 dept_new 都存在,則是將原部門刪除,添加新部門

20、,即修改部門如果存在dept_old,dept_new=0,則表示刪除原部門。如果存在dept_new, dept_old=0,則表示添加新部門。如果兩個都不存在,無操作。status :郵箱狀態(tài) ,1 啟用, -1 禁用intra_only:只允許內(nèi)網(wǎng)登陸,1 為是, -1 為否english_name :英文名order_no :權(quán)重,數(shù)字越大越靠前顯示sex :性別, 1 為男, 2 為女position :職位worknum: 工號birthday:出生日期,格式為2012-01-01mobile :tel :extnum : 分機號groupnum :集團號qqmsn :qq/msn

21、 is_hidden : 不在企業(yè)通訊錄中顯示,1 為是, -1 為否memo :備注3、輸出數(shù)據(jù)輸出內(nèi)容及含義如下:verify_error: 域管理員驗證錯誤mailbox_not_exist: 不存在此郵箱update_error: 更新郵箱錯誤ok: 成功更新郵箱七、刪除用戶接口1、接口調(diào)用地址 :/domain/webmail/api/deluser.php?adminname=admin&adminpass=xxx&mailbox=userabc 2、傳入?yún)?shù)需要以 get 方式傳遞以下參數(shù):adminname: 域管理員名稱adminpass: 域管理員md5 后

22、的密碼mailbox: 要刪除的郵箱帳戶全稱,例如“userabc ”3、輸出數(shù)據(jù)輸出內(nèi)容及含義如下:verify_error: 域管理員驗證錯誤mailbox_not_exist: 不存在此郵箱del_error: 刪除郵箱錯誤ok: 成功更新郵箱八、獲取郵箱別名接口1、接口調(diào)用地址 :/domain/webmail/api/alias.php?adminname=admin&adminpass=xxx&mailbox=userabc &act=get 2、傳入?yún)?shù)需要以 get 方式傳遞以下參數(shù):adminname: 域管理員名稱adminpass: 域管理員md5

23、 后的密碼mailbox: 要查看別名的郵箱帳戶全稱,例如“userabc ”act: 操作類型,獲取別名時為“get”3、輸出數(shù)據(jù)出錯時的輸出內(nèi)容:param_error: 參數(shù)錯誤verify_error: 域管理員驗證錯誤mailbox_not_exist: 不存在此郵箱正常時輸出的內(nèi)容為xml 格式,其格式如下: alias1abc alias2abc 九、獲取部門列表接口1、接口調(diào)用地址 :/domain/webmail/api/getdept.php?domain=test &adminname=admin&adminpass=xxx 2、傳入?yún)?shù)需要以 get 方

24、式傳遞以下參數(shù):domain: 要獲取部門列表的域名adminname: 域管理員名稱adminpass: 域管理員md5 后的密碼3、輸出數(shù)據(jù)出錯時的輸出內(nèi)容:param_error: 參數(shù)錯誤verify_error: 域管理員驗證錯誤正常時輸出的內(nèi)容為xml 格式,其格式如下: 123 -1 1234567 7654321 testtest “department”段結(jié)構(gòu)說明:id: 部門 idparent_id: 上級部門id ,如果為“ -1”則表示無上級部門name: 部門名稱tel: 部門fax: 部門linkman: 聯(lián)系人名稱manager: 負責人名稱email: 郵件地址

25、address: 十、添加部門接口1、接口調(diào)用地址 :/domain/webmail/api/adddept.php?domain=test &adminname=admin&adminpass=xxx&dept_name=部門名稱&parent_id=-1&tel=123456&fax=654321&linkname=張三 &manager=李四 &email=testtest &address=通信地址2、傳入?yún)?shù)需要以 get 方式傳遞以下參數(shù):domain: 要添加部門的域名必填adminname: 域管理

26、員名稱必填adminpass: 域管理員md5 后的密碼必填dept_name: 部門名稱必填如果為中文字符請使用utf-8 格式,并進行url 編碼parent_id: 上級部門id ,如無上級部門則需填寫為“-1”必填tel: 部門名稱fax: 部門linkman: 聯(lián)系人名稱 如果為中文字符請使用utf-8 格式,并進行url 編碼manager: 負責人名稱 如果為中文字符請使用utf-8 格式,并進行url 編碼email: 郵件地址address: 如果為中文字符請使用utf-8 格式,并進行url 編碼3、輸出數(shù)據(jù)輸出內(nèi)容及含義如下:param_error: 參數(shù)錯誤verify

27、_error: 域管理員驗證錯誤add_error: 添加部門錯誤ok: 添加部門成功十一、修改部門接口1、接口調(diào)用地址 :/domain/webmail/api/updatedept.php?domain=test &adminname=admin&adminpass=xxx&dept_id=12345&dept_name=departmentname&parent_id=-1&tel=123456&fax=654321&linkname=張三&manager=李四&email=testtest &add

28、ress=通信地址2、傳入?yún)?shù)需要以 get 方式傳遞以下參數(shù):domain: 要更新部門信息的域名必填adminname: 域管理員名稱必填adminpass: 域管理員md5 后的密碼必填dept_id: 部門 id必填dept_name: 部門名稱必填如果為中文字符請使用utf-8 格式,并進行url 編碼parent_id: 上級部門id ,如無上級部門則需填寫為“-1”必填tel: 部門名稱fax: 部門linkman: 聯(lián)系人名稱 如果為中文字符請使用utf-8 格式,并進行url 編碼manager: 負責人名稱 如果為中文字符請使用utf-8 格式,并進行url 編碼email

29、: 郵件地址address: 如果為中文字符請使用utf-8 格式,并進行url 編碼3、輸出數(shù)據(jù)輸出內(nèi)容及含義如下:param_error: 參數(shù)錯誤verify_error: 域管理員驗證錯誤department_not_exist: 不存在指定部門update_error: 修改部門信息出錯ok: 修改部門信息成功十二、刪除部門接口1、接口調(diào)用地址 :/domain/webmail/api/deldept.php?domain=test &adminname=admin&adminpass=xxx&dept_id=1234 2、傳入?yún)?shù)需要以 get 方式傳遞以下

30、參數(shù):domain: 要刪除部門的域名adminname: 域管理員名稱adminpass: 域管理員md5 后的密碼dept_id: 要刪除的部門id3、輸出數(shù)據(jù)輸出內(nèi)容及含義如下:param_error: 參數(shù)錯誤verify_error: 域管理員驗證錯誤department_not_exist: 不存在指定部門existing_child:存在下級部門,需要先刪除下級部門后才能刪除此部門del_error: 刪除部門出錯ok: 刪除部門成功十三、獲取部門成員接口1、接口調(diào)用地址 :/domain/webmail/api/getdeptmember.php?domain=test &am

31、p;adminname=admin&adminpass=xxx&dept_id=1234 2、傳入?yún)?shù)需要以 get 方式傳遞以下參數(shù):domain: 要取得部門成員的域名adminname: 域管理員名稱adminpass: 域管理員md5 后的密碼dept_id: 要獲取成員的部門id3、輸出數(shù)據(jù)出錯時的輸出內(nèi)容:param_error: 參數(shù)錯誤verify_error: 域管理員驗證錯誤department_not_exist: 不存在指定部門正常時輸出的內(nèi)容為xml 格式,其格式如下: 123 testtest “member”段結(jié)構(gòu)說明:id: 部門 idemail

32、: 用戶郵件地址fullname: 用戶名稱十四、添加部門成員接口1、接口調(diào)用地址 :/domain/webmail/api/adddeptmember.php?domain=test &adminname=admin&adminpass=xxx&dept_id=1234&user_id=4321 2、傳入?yún)?shù)需要以 get 方式傳遞以下參數(shù):domain: 要添加部門成員的域名adminname: 域管理員名稱adminpass: 域管理員md5 后的密碼dept_id: 要添加成員的部門iduser_id: 要添加的成員id3、輸出數(shù)據(jù)輸出內(nèi)容及含義如下:p

33、aram_error: 參數(shù)錯誤verify_error: 域管理員驗證錯誤department_not_exist: 不存在指定部門user_not_exist: 不存在指定用戶add_error: 添加部門成員出錯ok: 添加成功十五、刪除部門成員接口1、接口調(diào)用地址 :/domain/webmail/api/deldeptmember.php?domain=test &adminname=admin&adminpass=xxx&dept_id=1234&user_id=4321 2、傳入?yún)?shù)需要以 get 方式傳遞以下參數(shù):domain: 要刪除部門成員的

34、域名adminname: 域管理員名稱adminpass: 域管理員md5 后的密碼dept_id: 要刪除成員的部門iduser_id: 要刪除的成員id3、輸出數(shù)據(jù)輸出內(nèi)容及含義如下:param_error: 參數(shù)錯誤verify_error: 域管理員驗證錯誤del_error: 刪除部門成員出錯ok: 刪除成功十六、添加別名接口1、接口調(diào)用地址 :/domain/webmail/api/alias.php?adminname=admin&adminpass=xxx&mailbox=userabc &act=add&alias=aliasabc 2、傳入?yún)?/p>

35、數(shù)需要以 get 方式傳遞以下參數(shù):adminname: 域管理員名稱adminpass: 域管理員md5 后的密碼mailbox: 要添加別名的郵箱帳戶全稱,例如“userabc ”act: 操作類型,添加別名時為“add”alias: 要添加的別名3、輸出數(shù)據(jù)輸出內(nèi)容及含義如下:param_error: 參數(shù)錯誤verify_error: 域管理員驗證錯誤mailbox_not_exist: 不存在此郵箱error: 添加別名時發(fā)生錯誤ok: 添加別名成功十七、修改別名接口1、接口調(diào)用地址 :/domain/webmail/api/alias.php?adminname=admin&

36、;adminpass=xxx&mailbox=userabc &act=edit&alias=aliasabc &alias_new=alias-newabc 2、傳入?yún)?shù)需要以 get 方式傳遞以下參數(shù):adminname: 域管理員名稱adminpass: 域管理員md5 后的密碼mailbox: 要修改別名的郵箱帳戶全稱,例如“userabc ”act: 操作類型,修改別名時為“edit”alias: 要修改的舊別名如果為中文字符請使用utf-8 格式,并進行url 編碼alias_new: 要修改的新別名 如果為中文字符請使用utf-8 格式, 并進行

37、url 編碼3、輸出數(shù)據(jù)輸出內(nèi)容及含義如下:param_error: 參數(shù)錯誤verify_error: 域管理員驗證錯誤mailbox_not_exist: 不存在此郵箱error: 修改別名時發(fā)生錯誤ok: 修改別名成功十八、刪除別名接口1、接口調(diào)用地址 :/domain/webmail/api/alias.php?adminname=admin&adminpass=xxx&mailbox=userabc &act=del&alias=aliasabc 2、傳入?yún)?shù)需要以 get 方式傳遞以下參數(shù):adminname: 域管理員名稱adminpass: 域管

38、理員md5 后的密碼mailbox: 要刪除別名的郵箱帳戶全稱,例如“userabc ”act: 操作類型,刪除別名時為“del”alias: 要刪除的別名如果為中文字符請使用utf-8 格式,并進行url 編碼3、輸出數(shù)據(jù)輸出內(nèi)容及含義如下:param_error: 參數(shù)錯誤verify_error: 域管理員驗證錯誤mailbox_not_exist: 不存在此郵箱error: 刪除別名時發(fā)生錯誤ok: 刪除別名成功十九、獲取 pop接收郵件接口1、接口調(diào)用地址 :/domain/webmail/api/popmail.php?adminname=admin&adminpass=x

39、xx&mailbox=userabc &act=get 2、傳入?yún)?shù)需要以 get 方式傳遞以下參數(shù):adminname: 域管理員名稱adminpass: 域管理員md5 后的密碼mailbox: 要獲取 pop 接收設置的郵箱帳戶全稱,例如“userabc ”act: 操作類型,獲取pop 接收設置時為“get”3、輸出數(shù)據(jù)出錯時輸出的內(nèi)容及含義如下:param_error: 參數(shù)錯誤verify_error: 域管理員驗證錯誤mailbox_not_exist: 不存在此郵箱正常時輸出的內(nèi)容為xml 格式,其格式如下: pop服務地址 pop帳號名稱 pop收取后是否刪除

40、郵件 是否啟用此條目 pop服務地址 pop帳號名稱 pop收取后是否刪除郵件 是否啟用此條目 二十、添加 pop接收郵件接口1、接口調(diào)用地址 :/domain/webmail/api/popmail.php?adminname=admin&adminpass=xxx&mailbox=userabc &act=add&rhost=pop.163 &ruser=username&rpass=xxx&rdel=0&enable=1 2、傳入?yún)?shù)需要以 get 方式傳遞以下參數(shù):adminname: 域管理員名稱adminpass: 域

41、管理員md5 后的密碼mailbox: 要添加 pop 接收設置的郵箱帳戶全稱,例如“userabc ”act: 操作類型,添加pop 接收設置時為“add”rhost: pop 服務器地址ruser: pop 帳號名稱rpass: pop 帳號密碼rdel: pop 收取后是否刪除郵件, “1”為刪除,“0”為不刪除enable: 是否啟用此項pop 設置3、輸出數(shù)據(jù)輸出內(nèi)容及含義如下:param_error: 參數(shù)錯誤verify_error: 域管理員驗證錯誤mailbox_not_exist: 不存在此郵箱error: 添加 pop 接收設置時發(fā)生錯誤ok: 添加 pop 接收成功二十

42、一、修改pop 接收郵件接口1、接口調(diào)用地址 :/domain/webmail/api/popmail.php?adminname=admin&adminpass=xxx&mailbox=userabc &act=edit&rhost=pop.163 &ruser=username&rpass=xxxx&rdel=1&enable=1 2、傳入?yún)?shù)需要以 get 方式傳遞以下參數(shù):adminname: 域管理員名稱adminpass: 域管理員md5 后的密碼mailbox: 要修改 pop 接收設置的郵箱帳戶全稱,例如“user

43、abc ”act: 操作類型,修改pop 接收設置時為“edit”rhost: pop 服務器地址,為原來添加的服務器地址,不能改變ruser: pop 帳號名稱,為原來添加帳號名稱,不能改變rpass: pop 帳號密碼rdel: pop 收取后是否刪除郵件, “1”為刪除,“0”為不刪除enable: 是否啟用此項pop 設置3、輸出數(shù)據(jù)輸出內(nèi)容及含義如下:param_error: 參數(shù)錯誤verify_error: 域管理員驗證錯誤mailbox_not_exist: 不存在此郵箱error: 修改 pop 接收設置時發(fā)生錯誤ok: 修改 pop 接收成功二十二、刪除pop 接收郵件接口

44、1、接口調(diào)用地址 :/domain/webmail/api/popmail.php?adminname=admin&adminpass=xxx&mailbox=userabc &act=del&rhost=pop.163 &ruser=username 2、傳入?yún)?shù)需要以 get 方式傳遞以下參數(shù):adminname: 域管理員名稱adminpass: 域管理員md5 后的密碼mailbox: 要刪除 pop 接收設置的郵箱帳戶全稱,例如“userabc ”act: 操作類型,刪除pop 接收設置時為“del”rhost: pop 服務器地址,為原來添加

45、的服務器地址,不能改變ruser: pop 帳號名稱,為原來添加帳號名稱,不能改變3、輸出數(shù)據(jù)輸出內(nèi)容及含義如下:param_error: 參數(shù)錯誤verify_error: 域管理員驗證錯誤mailbox_not_exist: 不存在此郵箱error: 刪除 pop 接收設置時發(fā)生錯誤ok: 刪除 pop 接收成功二十三、獲取郵件列表接口1、接口調(diào)用地址 :/domain/webmail/api/showmessage.php?mailbox=郵箱帳戶 &password=帳戶密碼2、傳入?yún)?shù)需要通過 url 的 get 方式傳遞以下參數(shù):mailbox:郵箱帳戶,格式為郵箱地址。如

46、“userdomain ”password:與郵箱帳戶相對應的密碼pwd_encode: 新增郵箱帳戶相對應的密碼(base64 加密 )。password,pwd_encode兩個參數(shù),優(yōu)先取pwd_encode3、輸出格式輸出內(nèi)容以xml 方式顯示, xml 文件結(jié)構(gòu)如下: 郵件總數(shù) 未讀郵件數(shù) 最新郵件數(shù) 已使用的郵箱容量 郵件主題 發(fā)件人 發(fā)件日期 郵件內(nèi)容接口地址 郵件大小 是否包含附件 二十四、查看郵件接口1、調(diào)用方式 :/domain/webmail/api/showmessage.php?mailbox=郵箱帳戶 &password=帳戶密碼 &id=郵件 id

47、 2、傳入?yún)?shù)需要通過 url 的 get 方式傳遞以下參數(shù):mailbox: 郵箱帳戶,格式為郵箱地址。如“userdomain ”password: 與郵箱帳戶相對應的密碼pwd_encode: 新增郵箱帳戶相對應的密碼(base64 加密 )。password,pwd_encode兩個參數(shù),優(yōu)先取pwd_encodeid: 郵件 id3、輸出格式輸出內(nèi)容以xml 方式顯示, xml 文件結(jié)構(gòu)如下: 郵件主題 發(fā)件人 發(fā)件日期 郵件內(nèi)容 郵件大小 是否包含附件 二十五、客戶端連機檢測接口1、接口調(diào)用地址 :/domain/webmail/api/popcheck.php?domain=te

48、st &adminname=admin&adminpass=xxx 2、傳入?yún)?shù)需要以 get 方式傳遞以下參數(shù):domain: 所要檢測的域名adminname: 域管理員名稱adminpass: 域管理員md5 后的密碼3、輸出數(shù)據(jù)輸出內(nèi)容及含義如下:param_error: 參數(shù)錯誤verify_error: 域管理員驗證錯誤郵件地址列表: 當檢測到有客戶端連機下載郵件時,會將所檢測到的郵件地址列出,一行一個郵件地址。當沒有檢測到客戶連機時,輸出為空二十六、單點登錄1、登錄方法在 html文件中建立一個表單,此表單將以post 方式將數(shù)據(jù)提交至郵件服務器的登錄程序“ /w

49、ebmail/client/index.php?module=operate&action=login” 。表單基本格式如下:登 錄 快 速 簡 潔 版請 將 表 單 數(shù) 據(jù) 提 交 到 “:/mail.your_domain /webmail/worldclient.dll?view=main&theme=fast”a. 使用郵箱名登錄: 帳號: 域名: 密碼: 語言: 簡體中文 繁體中文 english function show_code() var img = document.getelementbyid(imgcode); img.src= :/mail.your_

50、domain /webmail/captcha.php?t=+new date().gettime(); function jsoncall(data) var captcha_div = document.getelementbyid(captcha_div); if(data = 3) var html = 驗證碼:; html += ; captcha_div.innerhtml = html; b. 使用自定義用戶字段登錄需要在后臺開啟“用戶自定義字段功能” : 自定義字段名稱: 域名: 密碼: 語言: 簡體中文 繁體中文 english 2、傳入?yún)?shù)表單中的參數(shù)及含意如下:user:

51、 用戶登錄名稱,即“usernamedomain ”中的“ username” 。customfieldvalue: 用戶“自定義字段”對應內(nèi)容。例如自定義字段名稱為“工號”,用戶的工號為“10001” ,即可使用“10001”登錄。domain: 登錄的郵箱域名,即“usernamedomain ”中的“ domain ” 。此參數(shù)可省略,省略時默認使用表單“action”參數(shù)中的域名password: 用戶登錄密碼pwd_encode:新增 用戶登錄密碼(base64 加密 )。password,pwd_encode兩個參數(shù),優(yōu)先取 pwd_encodelanguage: 語言選擇框ent

52、er: 登錄標識符,其值為真ssl: 使用 ssl 安全連接訪問webmailreurl: 登錄頁面地址全稱如: :/domain /ulogin.php二十七、凍結(jié) / 解凍用戶帳號接口1、接口調(diào)用地址 :/domain/webmail/api/freeze.php? adminname=admin&adminpass=xxx&mailbox=userdomain &act=action 2、傳入?yún)?shù)需要以 get 方式傳遞以下參數(shù):adminname: 域管理員名稱adminpass: 域管理員md5 后的密碼mailbox: 要凍結(jié) /解凍的郵箱帳號act: 要進

53、行的操作,凍結(jié)帳號時將填寫為“freeze” ,解凍時請?zhí)顚憺椤皍nfreeze ”3、輸出數(shù)據(jù)輸出內(nèi)容及含義如下:param_error: 參數(shù)錯誤verify_error: 域管理員驗證錯誤mailbox_not_exist: 不存在此郵箱error: 凍結(jié) /解凍帳號失敗ok: 凍結(jié) /解凍帳號成功二十八、獲取凍結(jié)用戶帳號接口1、調(diào)用方式 :/domain/webmail/api/getfreeze.php?domain=domain &adminname=admin&adminpass=xxx 2、傳入?yún)?shù)需要通過 url 的 get 方式傳遞以下參數(shù):domain:

54、要獲取的域名adminname: 域管理員名稱adminpass: 域管理員md5 后的密碼3、輸出格式輸出內(nèi)容以xml 方式顯示, xml 文件結(jié)構(gòu)如下: user1domain user2domain user3domain 二十九、獲取顯示已存在的郵件列表接口1、調(diào)用方式 :/domain/webmail/api/maillist.php?act=get &adminname=admin&adminpass=xxx&domain=domain 2、傳入?yún)?shù)需要通過 url 的 get 方式傳遞以下參數(shù):domain: 要獲取的域名adminname: 域管理員名稱

55、adminpass: 域管理員md5 后的密碼act: 獲取的方式, get 表示顯示3、輸出格式輸出內(nèi)容以xml 方式顯示, xml 文件結(jié)構(gòu)如下: 1 描述 1 y 三十、添加郵件列表接口1、調(diào)用方式 :/domain/webmail/api/maillist.php?adminname=admin&adminpass=xxx&domain=domain &act=add&listname=testmaillist&note=desc&isprivate=n2、傳入?yún)?shù)需要通過 url 的 get 方式傳遞以下參數(shù):domain: 要獲取的域

56、名adminname: 域管理員名稱adminpass: 域管理員md5 后的密碼act: 獲取的方式, add 表示添加listname: 郵件列表名稱note: 郵件列表描述isprivate: 私有,只能取y 或 n3、輸出格式輸出內(nèi)容及含義如下:param_error: 參數(shù)錯誤verify_error: 域管理員驗證錯誤maillist_exist: 郵件列表已存在add_error: 添加郵件列表失敗ok: 添加郵件列表成功三十一、修改郵件列表接口1、調(diào)用方式 :/domain/webmail/api/maillist.php?adminname=admin&adminpa

57、ss=xxx&domain=test &act=modify&oldname=testmaillist&listname=maillist&note=desc&isprivate=n2、傳入?yún)?shù)需要通過 url 的 get 方式傳遞以下參數(shù):domain: 要獲取的域名adminname: 域管理員名稱adminpass: 域管理員md5 后的密碼act: 獲取的方式, modify 表示修改oldname: 需要更新的郵件列表名稱listname: 更改后的郵件列表名稱note: 更改后的郵件列表描述如果為中文字符請使用utf-8 格式,并進行

58、 url 編碼isprivate: 私有,只能取y 或 n3、輸出格式輸出內(nèi)容及含義如下:param_error: 參數(shù)錯誤verify_error: 域管理員驗證錯誤maillist_exist: 郵件列表已存在maillist_not_exist:郵件列表不存在modify_error: 修改郵件列表失敗ok: 修改郵件列表成功三十二、刪除郵件列表接口1、調(diào)用方式 :/domain/webmail/api/maillist.php?adminname=admin&adminpass=xxx&domain=test &act=del&listname=mail

59、list 2、傳入?yún)?shù)需要通過 url 的 get 方式傳遞以下參數(shù):domain: 要獲取的域名adminname: 域管理員名稱adminpass: 域管理員md5 后的密碼act: 獲取的方式,del 表示刪除listname: 刪除的郵件列表名稱3、輸出格式輸出內(nèi)容及含義如下:param_error: 參數(shù)錯誤verify_error: 域管理員驗證錯誤delete_error: 刪除郵件列表失敗ok: 刪除郵件列表成功三十三、顯示郵件列表成員接口1、調(diào)用方式 :/domain/webmail/api/getmaillistmember.php?adminname=admin&

60、adminpass=xxx&domain=domain &list_id=2 2、傳入?yún)?shù)需要通過 url 的 get 方式傳遞以下參數(shù):domain: 要獲取的域名adminname: 域管理員名稱adminpass: 域管理員md5 后的密碼list_id: 顯示郵件列表id3、輸出格式輸出內(nèi)容及含義如下:param_error: 參數(shù)錯誤verify_error: 域管理員驗證錯誤輸出內(nèi)容以xml 方式顯示, xml 文件結(jié)構(gòu)如下: 2 abc3sina s . 三十四、添加郵件列表成員接口1、調(diào)用方式 :/domain/webmail/api/addmaillistme

61、mber.php?adminname=admin&adminpass=xxx&domain=test &list_id=2&email=justdotest &mode=rs2、傳入?yún)?shù)需要通過 url 的 get 方式傳遞以下參數(shù):domain: 要獲取的域名adminname: 域管理員名稱adminpass: 域管理員md5 后的密碼list_id: 郵件列表idemail: 郵箱帳號mode: 權(quán)限,只能取r 或 rs 或 s3、輸出格式輸出內(nèi)容及含義如下:param_error: 參數(shù)錯誤verify_error: 域管理員驗證錯誤member

62、_exist: 成員已存在add_error: 添加郵件列表成員失敗ok: 添加郵件列表成員成功三十五、刪除郵件列表成員接口1、調(diào)用方式 :/domain/webmail/api/delmaillistmember.php?adminname=admin&adminpass=xxx&domain=test &list_id=2&email=justdotest 2、傳入?yún)?shù)需要通過 url 的 get 方式傳遞以下參數(shù):domain: 要獲取的域名adminname: 域管理員名稱adminpass: 域管理員md5 后的密碼list_id: 郵件列表idemail: 郵箱帳號3、輸出格式輸出內(nèi)容及含義如下:param_error: 參數(shù)錯誤

溫馨提示

  • 1. 本站所有資源如無特殊說明,都需要本地電腦安裝OFFICE2007和PDF閱讀器。圖紙軟件為CAD,CAXA,PROE,UG,SolidWorks等.壓縮文件請下載最新的WinRAR軟件解壓。
  • 2. 本站的文檔不包含任何第三方提供的附件圖紙等,如果需要附件,請聯(lián)系上傳者。文件的所有權(quán)益歸上傳用戶所有。
  • 3. 本站RAR壓縮包中若帶圖紙,網(wǎng)頁內(nèi)容里面會有圖紙預覽,若沒有圖紙預覽就沒有圖紙。
  • 4. 未經(jīng)權(quán)益所有人同意不得將文件中的內(nèi)容挪作商業(yè)或盈利用途。
  • 5. 人人文庫網(wǎng)僅提供信息存儲空間,僅對用戶上傳內(nèi)容的表現(xiàn)方式做保護處理,對用戶上傳分享的文檔內(nèi)容本身不做任何修改或編輯,并不能對任何下載內(nèi)容負責。
  • 6. 下載文件中如有侵權(quán)或不適當內(nèi)容,請與我們聯(lián)系,我們立即糾正。
  • 7. 本站不保證下載資源的準確性、安全性和完整性, 同時也不承擔用戶因使用這些下載資源對自己和他人造成任何形式的傷害或損失。

評論

0/150

提交評論