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

例子如下圖：

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

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

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

0：成功

-1：超出分配空間

-2：用戶已存在

-3：失敗

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

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

返回值：

0：成功

-1：失敗

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

返回值：

0：成功

-1：失敗

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