远程java API接口说明

[rxy]

一． 设置接口访问用户名和密码
配置位置：系统管理――》参数设置――》一般参数
例子如下图：

为了保证系统的安全性，每次调用接口都需要提供正确的用户名和密码。


二． API 调用环境类
类名：jdmail.api.remote. Env
说明：Env 类提供整个API 与服务器的通讯和配置管理。
方法：
1. public static Env getEnv(String url, String username, String password)；
说明：通过该方法可获取一个类实例。
参数说明：
1） url： webmail服务器根url
2） username：API访问用户名
3） password：API访问密码
返回值：
Env 对象：成功：Env 对象
Null：失败

三． 帐号操作类
类名：jdmail.api.remote.user. R_UserAccount
说明：UserAccount类提供所有用户管理相关功能，包括新增，删除，修改用户，和获取用户相关信息。
属性：
1. public UserAccount m_useraccount
m_useraccount 提供用户帐号的详细信息。

方法：
1. public static int createUserAccount(Env env, R_UserAccount ua);
说明：用于建立新用户。
参数说明：
1) env : Env 对象
2）ua：R_UserAccount 对象，R_UserAccount对象通过m_useraccount 属性传递 用户帐号详细信息。

返回值：
0：成功
-1：超出分配空间
-2：用户已存在
-3：失败
-4：超出分配用户数

例子：
参考附件的：public static int createUserAccount(Env env)；

2. public static int changeUserPassword(Env env, R_UserAccount ua);
说明：用于更改用户密码。
参数说明：
1) env : Env 对象
2）ua：R_UserAccount 对象，R_UserAccount对象通过m_useraccount 属性传递 用户帐号详细信息。

返回值：
0：成功
-1：失败

例子：
参考附件的：public static int changeUserPassword (Env env)；

3. public static int deleteUserAccount(Env env, R_UserAccount ua);
说明：用于删除用户。
参数说明：
1) env : Env 对象
2）ua：R_UserAccount 对象，R_UserAccount对象通过m_useraccount 属性传递 用户帐号详细信息。

返回值：
0：成功
-1：失败

例子：
参考附件的：public static int deleteUserAccount (Env env)；

4. public static int auth(Env env, String username,String domain,String password);
说明：用于验证用户。
参数说明：
1) env : Env 对象
2）username：用户名。
3）domain：域名
4）password：密码

返回值：
0：成功
1：失败

例子：
参考附件的：public static int testAuth (Env env)；

5. public static int getNewMsgNum(Env env, R_UserAccount ua);
说明：用于删除用户。
参数说明：
1) env : Env 对象
2）ua：R_UserAccount 对象，R_UserAccount对象通过m_useraccount 属性传递 用户帐号详细信息。

返回值：
>= 0 ：新邮件数
-1：失败

例子：
参考附件的：public static int getNewMsgNum (Env env)；

四． 文件夹操作类
类名：jdmail.api.remote.message.R_FolderAdmin
说明：R_FolderAdmin类提供与文件夹相关的操作功能。
方法：
1. public static int getFolderList(Env env, String username,String domain ,ArrayList alRet);
说明：用于返回指定用户的文件夹列表。
参数说明：
1) env : Env 对象
2）username：用户名
3）domain：域名
4）alRet: 用于保存返回文件夹列表的 java.util.ArrayList 对象。

返回值：
0：成功
-1：失败
-2：该用户不存在

例子：
参考附件的：public static int testGetFolderList(Env env)；

五． 邮件操作类
类名：jdmail.api.remote.message.R_MessageAdmin
说明：R_MessageAdmin类提供与用户邮件相关的操作功能。
方法：
1. public static int getMessageCount(Env env, String username,String domain, String foldername);
说明：用于获取用户的指定文件夹的邮件数。
参数说明：
1) env : Env 对象
2）username：用户名
3）domain：域名
4）foldername: 文件夹编号。

返回值：
>=0：邮件数
-1：失败

例子：
参考附件：public static int testGetMessageCount(Env env)；

2. public static int getMessageIDList(Env env, String username,
String domain, String foldername, int iFrom, int iCount,
ArrayList alRet)
说明：用于获取用户的指定文件夹的邮件编号列表。
参数说明：
1) env : Env 对象
2）username：用户名
3）domain：域名
4）foldername: 文件夹编号。
5）iFrom：起始邮件序号，注意：本方法是于倒数计算邮件，所以要获取所有邮件，应该是 iFrom 值与getMessageCount 返回值相同。
6）iCount：指定要获取的邮件数
7）alRet：用于保存返回文件夹列表的 java.util.ArrayList 对象。

返回值：
>=0：邮件数
-1：失败

例子：
参考附件：public static int testGetMessageIDList (Env env)；

3. public static byte[] getMessage(Env env, String username,
String domain, String foldername, String messageID)
说明：用于获取用户的指定邮件原文，然后可用package jdmail.mime 内相关类对邮件内容进行分析。
参数说明：
1) env : Env 对象
2）username：用户名
3）domain：域名
4）foldername: 文件夹编号。
5）messageID：邮件编号，该邮件编号可通过getMessageIDList 获取。

返回值：
byte[] 对象：邮件原文
null：失败

例子：
参考附件：public static int testGetMessage(Env env)；

4. public static int sendMessage(Env env, String username, String domain,
String to, String subject, String body);
说明：用于发送邮件。
参数说明：
1) env : Env 对象
2）username：用户名
3）domain：域名
4）to: 收件人
5）subject：主题
6）body: 邮件正文

返回值：
0：成功
-1：失败

例子：
参考附件：public static int sendMail (Env env)；