遠(yuǎn)程java接口說(shuō)明

例子如下圖：

為了保證系統(tǒng)的安全性，每次調(diào)用接口都需要提供正確的用戶(hù)名和密碼。

• 類(lèi)名：turbomail.api.remote. Env；
• 說(shuō)明：Env 類(lèi)提供整個(gè)API 與服務(wù)器的通訊和配置管理；
• 方法:public static Env getEnv(String url, String username, String password)；
• 說(shuō)明：通過(guò)該方法可獲取一個(gè)類(lèi)實(shí)例；
• 參數(shù)說(shuō)明：url:webmail服務(wù)器根url，即webmail 的 mailmain Servlet 訪問(wèn)訪問(wèn)路徑，如: http://localhost:8080/mailmain；
• username：API訪問(wèn)用戶(hù)名；
• password：API訪問(wèn)密碼
• 返回值：Env 對(duì)象：成功：Env 對(duì)象
• null：失敗

• 類(lèi)名：turbomail.api.remote.user. R_UserAccount；
• 說(shuō)明：UserAccount類(lèi)提供所有用戶(hù)管理相關(guān)功能，包括新增，刪除，修改用戶(hù)，和獲取用戶(hù)相關(guān)信息；
• 屬性：public UserAccount m_useraccount m_useraccount 提供用戶(hù)帳號(hào)的詳細(xì)信息；
• 方法：public static int createUserAccount(Env env, R_UserAccount ua);
• 說(shuō)明：用于建立新用戶(hù)；
• 參數(shù)說(shuō)明：
1) env : Env 對(duì)象
2）ua：R_UserAccount 對(duì)象，R_UserAccount對(duì)象通過(guò)m_useraccount 屬性傳遞 用戶(hù)帳號(hào)詳細(xì)信息。 返回值：

0：成功

-1：超出分配空間

-2：用戶(hù)已存在

-3：失敗

-4：超出分配用戶(hù)數(shù)

• 例子：參考附件的：public static int createUserAccount(Env env)； public static int changeUserPassword(Env env, R_UserAccount ua);
• 說(shuō)明：用于更改用戶(hù)密碼。
• 參數(shù)說(shuō)明：
env : Env 對(duì)象
ua：R_UserAccount 對(duì)象，R_UserAccount對(duì)象通過(guò)m_useraccount 屬性傳遞 用戶(hù)帳號(hào)詳細(xì)信息。

返回值：

0：成功

-1：失敗

• 例子：參考附件的：public static int changeUserPassword (Env env)； public static int deleteUserAccount(Env env, R_UserAccount ua);
• 說(shuō)明：用于刪除用戶(hù)。
• 參數(shù)說(shuō)明：
env : Env 對(duì)象
ua：R_UserAccount 對(duì)象，R_UserAccount對(duì)象通過(guò)m_useraccount 屬性傳遞 用戶(hù)帳號(hào)詳細(xì)信息。

返回值：

0：成功

-1：失敗

• 例子： 參考附件的：public static int deleteUserAccount (Env env)； public static int auth(Env env, String username,String domain,String password);
• 說(shuō)明：用于驗(yàn)證用戶(hù)
• 參數(shù)說(shuō)明：
env : Env 對(duì)象
username：用戶(hù)名
domain：域名
password：密碼