当前位置:文档之家› 远程java接口说明

远程java接口说明

远程java接口说明
远程java接口说明

远程java API接口说明

2011-8-2 修改yhl

一、设置接口访问用户名和密码 (2)

设置接口访问用户名和密码 (2)

二、需要引入的jar包 (2)

三、API 调用环境类 (2)

类名:turbomail.api.remote. Env (2)

四、帐号操作类 (3)

类名:https://www.doczj.com/doc/9012671158.html,er. R_UserAccount (3)

五、文件夹操作类 (11)

类名:turbomail.api.remote.message.R_FolderAdmin (11)

六、邮件操作类 (12)

类名:turbomail.api.remote.message.R_MessageAdmin (12)

七、系统默认参数值 (15)

系统默认文件夹编号 (15)

八、地址本操作 (15)

类名:turbomail.api.remote.addressbook. R_Addressbook (15)

九、组织结构 (20)

类名:https://www.doczj.com/doc/9012671158.html,anization. R_Organization (20)

十、域操作 (24)

类名:turbomail.api.remote.domain. R_Domain (24)

十一、一般操作 (25)

类名:turbomail.api.remote.action. R_Action (25)

附件(TestApi.java): (27)

一、设置接口访问用户名和密码

设置接口访问用户名和密码

配置位置:系统管理――》参数设置――》一般参数

例子如下图:

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

二、需要引入的jar包

为了调用turbomail接口,在二次开发环境和运行环境需要引入以下jar 包:

https://www.doczj.com/doc/9012671158.html,mons-codec-1.3.jar

https://www.doczj.com/doc/9012671158.html,mons-httpclient-

3.1.jar

https://www.doczj.com/doc/9012671158.html,mons-logging-1.1.jar

4.turbomail.jar

以上jar 文件在turbomail\web\webapps\ROOT\WEB-INF\lib 目录下可以找到。

三、API 调用环境类

类名:turbomail.api.remote. Env

说明:Env 类提供整个API 与服务器的通讯和配置管理。

方法:

public static Env getEnv(String url, String username, String password);

说明:通过该方法可获取一个类实例。

参数说明:

url:webmail服务器根url,即webmail 的mailmain Servlet 访问访问路径,

如: http://localhost:8080/mailmain

username:API访问用户名

password:API访问密码

返回值:

Env 对象:成功:Env 对象

null:失败

四、帐号操作类

类名:https://www.doczj.com/doc/9012671158.html,er. R_UserAccount

说明:UserAccount类提供所有用户管理相关功能,包括新增,删除,修改用户,和获取用户相关信息。

属性:

public UserAccount m_useraccount

m_useraccount 提供用户帐号的详细信息。

方法:

1.public static int createUserAccount(Env env, R_UserAccount ua);

说明:用于建立新用户。

参数说明:

env : Env 对象

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);

说明:用于更改用户密码。

参数说明:

env : Env 对象

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);

说明:用于删除用户。

参数说明:

env : Env 对象

ua:R_UserAccount 对象,R_UserAccount对象通过m_useraccount 属性传递用户帐号详细信息。

返回值:

0:成功

1:不存在

2:其他失败原因

例子:

参考附件的:public static int deleteUserAccount (Env env);

4.public static int auth(Env env, String username,String domain,String

password);

说明:用于验证用户。

参数说明:

env : Env 对象

username:用户名。

domain:域名

password:密码

返回值:

0:成功

1:失败

例子:

参考附件的:public static int testAuth (Env env);

5.public static int getNewMsgNum(Env env, R_UserAccount ua);

说明:用于删除用户。

参数说明:

env : Env 对象

ua:R_UserAccount 对象,R_UserAccount对象通过m_useraccount 属性传递用户帐号详细信息。

返回值:

>= 0 :新邮件数

-1:失败

例子:

参考附件的:public static int getNewMsgNum (Env env);

6.public static String getPassword(Env env,String username,String domain);

说明:用于获取用户密码,本方法只对采用“内置”加密方法保存密码的帐号有用。参数说明:

env : Env 对象

username:用户名。

domain:域名

返回值:

用户密码

例子:

参考附件的:public static int getPassword (Env env);

7.public static UserAccount getUserAccount(Env env, String username,String

domain);

说明:用于获取用户帐号(https://www.doczj.com/doc/9012671158.html,erAccount),帐号的附件信息(如单位,地址,手机号)可通过useraccount.m_Profile (https://www.doczj.com/doc/9012671158.html,erProfile)对象获取。

参数说明:

env : Env 对象

username:用户名。

domain:域名

返回值:

用户帐号对象

例子:

参考附件的:public static void testGetUserAccount(Env env);

8.public static int setUserOrganization_id(Env env, String domain,String

username,String orgid);

说明:用于设置用户所属组织部门。

参数说明:

env : Env 对象

username:用户名。

domain:域名

orgid:部门全路径id

返回值:

0 表示成功,其他值表示失败

9.public static int setUserOrganization_sort_byid(Env env, String domain,String

username,String orgid,int iSortno);

说明:用于设置用户所属组织部门,并指定排序号,排序号越大,排位越靠前。

参数说明:

env : Env 对象

username:用户名。

domain:域名

orgid:部门全路径id

iSortno: 排序号

返回值:

0 表示成功,其他值表示失败

10.public static int setUserOrganization_sort_byuid(Env env, String

enterprisename,String domain,String username,String uid,int iSortno);

说明:用于设置用户所属组织部门,并指定排序号,排序号越大,排位越靠前。

参数说明:

env : Env 对象

enterprisename: 组织名称

username:用户名。

domain:域名

uid:部门id

iSortno: 排序号

返回值:

0 表示成功,其他值表示失败

11.public static int setUserOrganization_sort_byfullname(Env env,String

enterprisename String domain,String username,String orgid,int iSortno);

说明:用于设置用户所属组织部门,并指定排序号,排序号越大,排位越靠前。

参数说明:

env : Env 对象

enterprisename: 组织名称

username:用户名。

domain:域名

fullname:部门全路径名称

iSortno: 排序号

返回值:

0 表示成功,其他值表示失败

12.public static int setUserOrganization_name(Env env, String domain,String

username,String orgname)

说明:用于设置用户所属组织部门。

参数说明:

env : Env 对象

username:用户名。

domain:域名

orgname:部门全路径名称,如“/某公司/销售部”

返回值:

0 表示成功,其他值表示失败

13.public static int changeProfile(Env env, R_UserAccount ua,String actiontype) 说明:用于更改用户属性

参数说明:

env:Env对象

ua:用户帐号,必须设置ua.m_https://www.doczj.com/doc/9012671158.html,ername ,

ua.m_useraccount.m_domain 两个属性,以指明修改的用户,可通过

ua.m_UserProfile 中的属性设定新属性

actiontype:指定要修改的属性,可通过ACTION_PROFILE_×常量指定一个或多个修改属性。比如:要修改昵称和手机,可设置为

R_UserAccount.ACTION_PROFILE_FIRSTNAME +

R_UserAccount.ACTION_PROFILE_MOBILE

可用属性说明:

/**修改昵称*/

public static String ACTION_PROFILE_FIRSTNAME = "A";

/**修改姓*/

public static String ACTION_PROFILE_LASTNAME = "B";

/**修改单位*/

public static String ACTION_PROFILE_ORGANIZATION = "C";

/**修改部门*/

public static String ACTION_PROFILE_DEPARTMENT = "D";

/**修改地址*/

public static String ACTION_PROFILE_ADDRESS = "E";

/**修改城市*/

public static String ACTION_PROFILE_CITY = "F";

/**修改邮票*/

public static String ACTION_PROFILE_POSTALCODE= "G";

/**修改电话*/

public static String ACTION_PROFILE_TELEPHONE = "H";

/**修改省*/

public static String ACTION_PROFILE_PROVINCE = "I";

/**修改国家*/

public static String ACTION_PROFILE_COUNTRY = "J";

/**修改每页显示邮件数*/

public static String ACTION_PROFILE_ITEMS = "K";

/**修改手机*/

public static String ACTION_PROFILE_MOBILE = "L";

/**修改排序号*/

public static String ACTION_PROFILE_SORTNO = "M";

/**启动服务*/

public static String ACTION_PROFILE_ENABLE = "1";

/**启用SMTP服务*/

public static String ACTION_PROFILE_ENABLE_SMTP = "2";

/**启用POP3服务*/

public static String ACTION_PROFILE_ENABLE_POP3 = "3";

/**启用IMAP4服务*/

public static String ACTION_PROFILE_ENABLE_IMAP4 = "4";

/**启用WEB服务*/

public static String ACTION_PROFILE_ENABLE_WEBACCESS = "5";

/**只能发邮件到本域*/

public static String ACTION_PROFILE_ENABLE_LOCALMAIL = "6";

/**只能接收本域发的邮件*/

public static String ACTION_PROFILE_ENABLE_RCPT_LOCALDOMAIN = "7";

/**禁止POP3删除邮件*/

public static String ACTION_PROFILE_DISABLE_POP3_DELETE = "8";

/**保存邮件客户端发送的邮件*/

public static String ACTION_PROFILE_SA VE_CLIENT_SENTMAIL = "9";

/**启用短信服务*/

public static String ACTION_PROFILE_ENABLE_SMS = "a";

/**启动彩信服务*/

public static String ACTION_PROFILE_ENABLE_MMS = "b";

/**别名*/

public static String ACTION_PROFILE_ALIAS = "c";

/**用户有效期*/

public static String ACTION_PROFILE_EXPIREDTIME = "d";

/**最大空间*/

public static String ACTION_PROFILE_MAX_MAILBOX_SIZE = "e";

/**最多邮件数*/

public static String ACTION_PROFILE_MAX_MAILBOX_MSGS = "f";

/**启用网络硬盘*/

public static String ACTION_PROFILE_FM_ENABLE = "g";

/**最大分配网络硬盘空间*/

public static String ACTION_PROFILE_FM_SIZE = "h";

/**网络硬盘允许上传最大的文件大小*/

public static String ACTION_PROFILE_FM_UPLOAD_SIZE = "i";

/**允许用户查看邮件原文*/

public static String ACTION_PROFILE_WM_VIEWSRC = "j";

/**发送邮件频率*/

public static String ACTION_PROFILE_SENDMAIL_FREQ = "k";

/**发送短信频率*/

public static String ACTION_PROFILE_SENDSMS_FREQ = "l";

/**发送彩信频率*/

public static String ACTION_PROFILE_SENDMMS_FREQ = "m";

/**允许发送最大邮件*/

public static String ACTION_PROFILE_MAX_SENDMAIL_SIZE = "n";

/**允许Web上传最大的附件大小*/

public static String ACTION_PROFILE_WM_MAX_ATTACHMENT_SIZE = "o";

/**默认语言*/

public static String ACTION_PROFILE_DEFAULT_LANGUAGE = "p";

/**禁用修改个人密码*/

public static String ACTION_PROFILE_DISABLE_CHANGEPWD = "q";

/**禁用修改个人信息*/

public static String ACTION_PROFILE_DISABLE_PROFILE = "x";

/**禁用外部POP3 邮箱*/

public static String ACTION_PROFILE_DISABLE_POP3AGENT = "y";

/**禁用自动转发*/

public static String ACTION_PROFILE_DISABLE_AUTOFORWARD = "z";

/**禁用自动回复*/

public static String ACTION_PROFILE_DISABLE_AUTOREPL Y = "w";

/**禁用公共地址本*/

public static String ACTION_PROFILE_DISABLE_PUBLICADDRESSBOOK = "s";

/**禁用通过Webmail删除邮件*/

public static String ACTION_PROFILE_DISABLE_WEBMAIL_DELETE = "v";

14.public static int changeUserName(Env env, R_UserAccount ua,String

actiontype)

说明:用于更改用户名

参数说明:

env:Env对象

ua:用户帐号,必须设置https://www.doczj.com/doc/9012671158.html,ername ,ua.newusername、 ua..m_domain 三个属性,以指明修改的用户.

actiontype:指定要修改的属性:R_UserAccount.ACTION_ChangeUserName 返回值:

0:成功

-1:用户不存在

-2:新用户已经存在

-3:新用户名不合法

-4,失败

例子:

参考附件的:public static int changeUserName (Env env);

15.public static int addUserGroupMember(Env env, R_UserAccount ua,String

actiontype)

说明:用于维护用户组,增加用户组成员

参数说明:

env:Env对象

ua:用户帐号,必须设置https://www.doczj.com/doc/9012671158.html,ername ,ua.newusername、 ua..m_domain 三个属性,以指明修改的用户. Ua.m_https://www.doczj.com/doc/9012671158.html,ers指明用户组成员(在系统范

围内指定)

actiontype:指定要修改的属性:R_UserAccount.

ACTION_AddUserGroupMember

返回值:

0:成功

-1:操作用户不是用户组账号

-2:操作用户不存在

-3:用户组成员不是系统用户

-4,失败

例子:

参考附件的:public static int addUserGroupMember (Env env);

16.public static int delUserGroupMember(Env env, R_UserAccount ua,String

actiontype)

说明:用于维护用户组,删除用户组成员

参数说明:

env:Env对象

ua:用户帐号,必须设置https://www.doczj.com/doc/9012671158.html,ername ,ua.newusername、 ua..m_domain 三个属性,以指明修改的用户. Ua.m_https://www.doczj.com/doc/9012671158.html,ers指明用户组成员(在系统范

围内指定)

actiontype:指定要修改的属性:R_UserAccount.

ACTION_DelUserGroupMember

返回值:

0:成功

-1:操作用户不是用户组账号

-2:操作用户不存在

-3:用户组成员不是系统用户

-4,失败

例子:

参考附件的:public static int delUserGroupMember (Env env);

17.public static String getUserGroupMember(Env env, R_UserAccount

ua,String actiontype)

说明:用于维护用户组,获取用户组成员列表

参数说明:

env:Env 对象

ua:用户帐号,必须设置https://www.doczj.com/doc/9012671158.html,ername ,ua.newusername、 ua..m_domain 三个属性,以指明修改的用户. Ua.m_https://www.doczj.com/doc/9012671158.html,ers指明用户组成员(在系统范

围内指定)

actiontype:指定要修改的属性:R_UserAccount.

ACTION_GetUserGroupMember

返回值:

-1:操作用户不是用户组账号

-2:操作用户不是系统用户

返回用户组成员列表

例子:

参考附件的:public static String get UserGroupMember (Env env);

18.public static String g etUserOrgList(Env env, R_UserAccount ua,String

actiontype)

说明:用于获取用户所属组织机构列表

参数说明:

env:Env 对象

ua:用户帐号,必须设置https://www.doczj.com/doc/9012671158.html,ername 、ua..m_domain 属性,以指明修改的用户。

actiontype:指定要修改的属性:R_UserAccount. ACTION_GetUserOrgList

返回值:返回用户所属组织机构列表

例子:

参考附件的:public static String g etUserOrgList (Env env);

五、文件夹操作类

类名:turbomail.api.remote.message.R_Fol derAdmin

说明:R_FolderAdmin类提供与文件夹相关的操作功能。

方法:

public static int getFolderList(Env env, String username,String domain ,ArrayList alRet);

说明:用于返回指定用户的文件夹列表。

参数说明:

env : Env 对象

username:用户名

domain:域名

alRet: 用于保存返回文件夹列表的java.util.ArrayList 对象。

返回值:

0:成功

-1:失败

-2:该用户不存在

例子:

参考附件的:public static int testGetFolderList(Env env);

六、邮件操作类

类名:turbomail.api.remote.message.R_MessageAdmin

说明:R_MessageAdmin类提供与用户邮件相关的操作功能。

方法:

1.public static int getMessageCount(Env env, String username,String domain,

String foldername);

说明:用于获取用户的指定文件夹的邮件数。

参数说明:

env : Env 对象

username:用户名

domain:域名

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)

说明:用于获取用户的指定文件夹的邮件编号列表。

参数说明:

env : Env 对象

username:用户名

domain:域名

foldername: 文件夹编号。

iFrom:起始邮件序号,注意:本方法是于倒数计算邮件,所以要获取所有邮件,应该是iFrom 值与getMessageCount 返回值相同。

iCount:指定要获取的邮件数

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 turbomail.mime 内相关类对邮件内容进行分析。

参数说明:

env : Env 对象

username:用户名

domain:域名

foldername: 文件夹编号。

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);

说明:用于发送邮件。

参数说明:

env : Env 对象

username:用户名

domain:域名

to: 收件人

subject:主题

body: 邮件正文

返回值:

0:成功

-1:失败

例子:

参考附件:public static int sendMail (Env env);

5.public static int getRMessageList(Env env, String username,String

domainname, String foldername, int iFrom, int iCount,ArrayList alRet);

说明:用于获取用户的指定文件夹的邮件列表。

参数说明:

env : Env 对象

username:用户名

domain:域名

foldername: 文件夹编号。

iFrom:起始邮件序号,注意:本方法是于倒数计算邮件,所以要获取所有邮件,应该是iFrom 值与getMessageCount 返回值相同。

iCount:指定要获取的邮件数

alRet:用于保存返回文件夹列表的java.util.ArrayList 对象。

返回值:

>=0:邮件数

-1:失败

说明:

返回列表alRet 中保存着turbomail.api.remote.message. R_Message 对象。

R_Message 说明:

R_Message 类用于表示用户邮件明细,包含以下属性:

public String Id; // 邮件Id

public String Subject; // 邮件标题

public String MessageDate; // 邮件发出时间

public String ReceviceDate; // 邮件接收时间

public String From; //发件人

public String To; // 收件人

public int Size; //邮件大小,以byte 为单位

public int Flag; // 邮件状态,0 表示新邮件1 表示已读邮件

例子:

参考附件:public static int getRMessageList (Env env);

6.public static R_Message getRMessage(Env env, String username, String

domainname, String foldername, String messageID);

说明:用于获取指定邮件。

参数说明:

env : Env 对象

username:用户名

domain:域名

foldername: 文件夹编号。

messageID:邮件Id

返回值:

如果成功获取,则返回R_Message Object。

失败,则返回null

例子:

参考附件:public static int getRMessage (Env env);

7.public static String getRMessageContent(Env env, String

username,Strindomainname, String foldername, String messageID);

说明:用于获取指定邮件的显示正文。

参数说明:

env : Env 对象

username:用户名

domain:域名

foldername: 文件夹编号。

messageID:邮件Id

返回值:

如果成功获取,则返回邮件正文。

失败,则返回null

例子:

参考附件:public static int getRMessageContent (Env env);

七、系统默认参数值

系统默认文件夹编号

new 收件箱

del 已删除邮件

draft 草稿箱

send 已发送邮件

spam 垃圾邮件

virus 病毒邮件

八、地址本操作

类名:turbomail.api.remote.ad dressbook. R_Ad dressbook

说明:R_Addressbook类提供邮件系统地址本的操作功能。

方法:

1.public static AddressFolder getPublicAddressFolder(Env env);

说明:用于获取公共地址本。

参数说明:

env : Env 对象

返回值:

如果成功获取,则返回公共地址本。

失败,则返回null

2.public static int deletePublicAddress(Env env,String addressId)

说明:删除公共地址本里的地址项

参数说明:

env : Env 对象

addressid: 地址项唯一标识

返回值:

成功返回0

失败返回>0

1 客户端错误

2 网络错误

3 地址不存在

4 一般错误

3.public static int deletePublicFolder(Env env,String folderId)

说明:删除公共地址本里的文件夹项

参数说明:

env : Env 对象

folderId: 文件夹唯一标识

返回值:

成功返回0

失败返回>0

1 客户端错误

2 网络错误

3 目录不存在

4 一般错误

4.public static int deletePublicFolder_ref(Env env,String parentFolderId,String

folderId)

说明:删除公共地址本里的引用文件夹项

参数说明:

env : Env 对象

parentfolderId: 父级文件夹全路径标识

folderid: 引用文件夹全路径标识

返回值:

成功返回0

失败返回>0

1 客户端错误

2 网络错误

3 目录不存在

4 一般错误

5.public static int addPublicAddress(Env env,String folderId,Address addr)

说明:往地址本新增地址项

参数说明:

env : Env 对象

folderId:地址项所在的文件夹id,如为null ,表示为第一级目录

addr: 地址项,如果设置了addr.m_id 则系统不自动生成地址编号

返回值:

成功返回0

失败返回>0

1 客户端错误

2 网络错误

3 地址项已存在

4 一般错误

6.public static int addPublicAddressList(Env env,String folderId,ArrayList

alAddr ,boolean bPassexist)

说明:往地址本新增地址项

参数说明:

env : Env 对象

folderId:地址项所在的文件夹id,如为null ,表示为第一级目录

alAddr: alAddr 地址列表,包含的的是Address 对象

bPassexist 是否忽略已存在地址

返回值:

成功返回0

失败返回>0

1 客户端错误

2 网络错误

3 地址项已存在

4 一般错误

7.public static int addPublicFolder(Env env,String folderId,AddressFolder

folder)

说明:新增地址本目录

参数说明:

env : Env 对象

folderId:地址项所在的文件夹id,如为null ,表示为第一级目录

folder 文件夹,如果设置了folder.m_id 则系统不自动生成目录编号,如果设定folder.m_reffolderid 为现有目录的全路径,则引用一个现有目录

返回值:

成功返回0

失败返回> 0

1 客户端错误

2 网络错误

3 -- 目录编号已存在

4 -- 一般错误

8.public static int updatePublicAddress(Env env,String addressId,Address addr) 说明:修改地址项

参数说明:

env : Env 对象

addressId 要修改的地址项

addr 新地址项内容

返回值:

成功返回0

失败返回>0

1 客户端错误

2 网络错误

3 地址项不存在

4 一般错误

9.public static int updatePublicFolder(Env env,String folderId,AddressFolder

folder)

说明:修改文件夹

参数说明:

env : Env 对象

folderId 要修改的文件夹Id

folder 文件夹内容

返回值:

成功返回0

失败返回>0

1 客户端错误

2 网络错误

3 目录项不存在

4 一般错误

10.public static int addPublicAddress_sid(Env env,String sid,Address addr)

说明:往地址本新增地址项

参数说明:

env : Env 对象

sid文件夹的唯一id,如为null ,表示为第一级目录

addr 地址项

返回值:

成功返回0

失败返回>0

1 客户端错误

2 网络错误

3 地址项已存在

4 一般错误

11.public static int addPublicAddressList_sid(Env env,String sid,ArrayList

alAddr,boolean bPassexist)

说明:往地址本新增地址项,一次增加多个地址(Sid 版本)

参数说明:

env : Env 对象

sid文件夹的唯一id,如为null ,表示为第一级目录

alAddr 地址列表,包含的的是Address 对象

bPassexist 是否忽略已存在地址

返回值:

成功返回0

失败返回>0

1 客户端错误

2 网络错误

3 地址项已存在

4 一般错误

5 部分错误

12.public static int addPublicFolder_sid(Env env,String parentSid,AddressFolder

folder)

说明:往地址本新增地址项,一次增加多个地址(Sid 版本)

参数说明:

env : Env 对象

sid文件夹的唯一id,如为null ,表示为第一级目录

parentSid 地址项所在的文件夹sid,如为null ,表示为第一级目录

folder 文件夹

返回值:

成功返回0

失败返回>0

1 客户端错误

2 网络错误

3 目录编号已存在

4 一般错误

13.public static int deletePublicFolder_sid(Env env,String sid)

说明:删除公共地址本里的文件夹项

参数说明:

env : Env 对象

sid文件夹的唯一id

返回值:

成功返回0

失败返回>0

1 客户端错误

2 网络错误

3 目录不存在

4 一般错误

14.public static int deletePublicAddress_sid(Env env,String addressSid)

说明:删除公共地址本里的地址项

参数说明:

env : Env 对象

addressSid 地址项唯一标识

返回值:

成功返回0

失败返回>0

1 客户端错误

2 网络错误

3地址不存在

4 一般错误

九、组织结构

类名:https://www.doczj.com/doc/9012671158.html,anization. R_Organization

说明:R_ Organization类提供邮件系统组织结构的操作功能。

方法:

1.public static int addEnterprise(Env env,Enterprise e)

说明:用于增加企业(组织)。

参数说明:

env : Env 对象

e: 企业(组织)对象

返回值:

0 表示成功,其他值表示失败

2.Public static int addDepartment(Env env,String enterpriseName,String

parentDepartmentName, Department d);

说明:用于增加部门。

参数说明:

env : Env 对象

enterpriseName: 部门所属企业(组织)

parentDepartmentName: 部门所属父级部门,如果是顶层部门,则为null d:需要增加的部门对象

返回值:

0 表示成功,其他值表示失败

3.public static int addDepartment_byParentUid(Env env,String

enterpriseName,String parentUid,Department d)

说明:通过指定父级部门id,增加部门。

参数说明:

env : Env 对象

enterpriseName: 部门所属企业(组织)

parentUid: 部门所属父级ID,如果是顶层部门,则为null

相关主题
文本预览
相关文档 最新文档