远程java接口说明

设置接口访问用户名和密码
配置位置:系统管理==>>参数设置==>>一般参数

例子如下图:

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

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:失败
帐号操作类
  • 类名:turbomail.api.remote.user. R_UserAccount;
  • 说明:UserAccount类提供所有用户管理相关功能,包括新增,删除,修改用户,和获取用户相关信息;
  • 属性:public UserAccount m_useraccount m_useraccount 提供用户帐号的详细信息;
  • 方法: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); 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); public static int deleteUserAccount(Env env, R_UserAccount ua);
  • 说明:用于删除用户。
  • 参数说明:
  • env : Env 对象
    ua:R_UserAccount 对象,R_UserAccount对象通过m_useraccount 属性传递 用户帐号详细信息。

    返回值:

    0:成功

    -1:失败

  • 例子: 参考附件的:public static int deleteUserAccount (Env env); public static int auth(Env env, String username,String domain,String password);
  • 说明:用于验证用户
  • 参数说明:
  • env : Env 对象
    username:用户名
    domain:域名
    password:密码

 

网站首页 产品介绍 下载中心 技术文档 售后服务 典型客户 代理合作 关于拓波 联系我们
粤ICP:06105496号 | Copyright:广州拓波软件科技有限公司