售前咨询
4008-753-365 , (021) 6695-7999
* 在线交谈可咨询售前、售后等问题,在您开始接入 SUBMAIL 产品时,售前顾问和售后技术支持工程师可帮助您解决遇到的任何使用问题
售前顾问咨询 09:00 - 20:00 (24x7)
购物车
在线商务咨询
咨询热线:4008 753 365 (021) 6695 7999
返回顶部

SUBMAIL JAVA SDK

 

   概览

 

SUBMAIL JAVA SDK
开发版本:jdk1.6
代码编码格式:utf-8
需导入 json 包和 http 请求处理包

 

   文件目录索引
Config 包 
处理用户的配置信息
 
AppConfig.java
MailConfigMessageConfig 的父类
MailConfig
邮件配置类
MessageConfig
短信配置类
Demo 包
代码示例目录
 
AddressBookMailSubscribe.java
邮件地址薄,订阅和添加联系人到目标地址薄 
 
AddressBookMailUnSubscribe.java
邮件地址薄,退订和从目标地址薄移除联系人
AddressBookMessageSubscribe.java
短信地址薄,订阅和添加联系人到目标地址薄 
 
AddressBookMessageUnSubscribe.java
短信地址薄,退订和从目标地址薄移除联系人
 
MailSendDemo.java
mail/send API 代码示例和使用指引
 
MailXSendDemo.java
mail/xsend API 代码示例和使用指引
MessageXSendDemo.java
message/xsend API 代码示例和使用指引
Entity 包
实体类
DataStore.java
封装请求数据
Lib 包
SDK 资源目录
ADDRESSBOOKMail.java
邮件地址薄 API
ADDRESSBOOKMessage.java
短信地址薄 API

Mail.java

邮件 API

MAILSend.java

mail/send API

MAILXSend.java

mail/xsend API

Message.java

短信 API

MESSAGEXsend.java

message/xsend API

lib.base 包

接口及 lib 父类包

Isender.java

接口,定义了 send,xsend,subscribe,unsubscribe

Sender.java

Mail 和 Message 的父类

SenderWapper.java

包装类,ADDRESSBOOKMail、ADDRESSBOOKMessage、MAILSend、MAILXSend、MESSAGEXsend父类

Utils 包

工具类

ConfigLoader.java

从配置文件中读取数据到配置对象

StringUtil.java

字符串的处理类

RequestEncoder.java

处理请求数据

配置文件

 

app_config.properties

邮件和短信配置数据

 

   开始使用

 

引入文件

导入以下包
 
 

commons-beanutils-1.7.0.ja

   

commons-collections-3.2.1.jar

   

commons-lang-2.3.jar

   

commons-logging-1.1.1.jar

   

ezmorph-1.0.3.jar

   

json-lib-2.2.3-jdk15.jar

   

org.apache.httpcomponents.httpclient_4.3.5.jar

   

 

 

SDK Class 索引

 

MAILSend.java
mail/send API
MAILXSend.java
mail/xsend API
MESSAGEXsend.java
message/xsend API
ADDRESSBOOKMail.java
邮件地址簿 API
ADDRESSBOOKMessage.java
短信地址簿 API

 

   MAILSend 类

 

初始化类

 

MAILSend submail = new MAILSend(config);

 

使用指引

方法
描述
示例
addTo
添加邮件地址到 To 数组,第一个必选参数:邮件地址。第二个可选参数:收件人姓名
submail.addTo("leo@submail.cn","Leo");
addAddressbook
添加地址薄标识到 addressbook 数组
submail.addAddressbook('subscribe');
setSender
设置发件人,第一个必选参数:邮件地址。第二个可选参数:显示名称
submail.setSender('leo@submail.cn','Leo');
setReply
设置回复地址
submail.setReply('leo@submail.cn');
addCc
添加抄送地址
submail.addCc('leo@submail.cn');
addBcc
添加密送地址
submail.addBcc('leo@submail.cn');
setSubject
设置邮件标题
submail.setSubject('test SDK');
setText
设置文本邮件内容
submail.setText('test SDK text');
setHtml
设置 HTML 邮件内容
submail.setHtml('test SDK html ');
addVar
添加文本变量到 vars 数组
submail.addVar('name','leo');
addLink
添加超链接变量到 links 数组
submail.addLink('developer','http://submail.cn/chs/developer');
addHeaders
添加自定义邮件头指令到 headers 数组
submail.addHeaders('X-Mailer','My App');
addAttachment
添加附件到 attachments 数组
submail.addAttachment('/path/to/file.txt');
getSender()
获取发送方式
return new Mail(this.config);
send()
发送邮件
submail.send()

 

代码示例

使用 MAILSend 类提交 mail/send 发送一封简单的邮件


package demo;

import lib.AppConfig;
import lib.ConfigLoader;
import lib.MAILSend;

public class MailSendDemo {

public static void main(String[] args) {

AppConfig config = ConfigLoader.load(ConfigLoader.ConfigType.Mail);
MAILSend submail = new MAILSend(config);
submail.addTo("leo@submail.cn","leo");
submail.setSender("no-reply@submail.cn","SUBMAIL");
submail.setSubject("test SDK");
submail.setText("test SDK text");
submail.setHtml("test SDK html");
submail.send();
}
}

 

   MAILXsend 

 

初始化类

 

MAILXSend submail = new MAILXSend(config)

 

使用指引

方法
描述
示例
addTo
添加邮件地址到 To 数组,第一个必选参数:邮件地址。第二个可选参数:收件人姓名
submail.AddTo("leo@submail.cn","Leo");
addAddressbook
添加地址薄标识到 addressbook 数组
submail.AddAddressbook('subscribe');
setSender
设置发件人,第一个必选参数:邮件地址。第二个可选参数:显示名称
submail.SetSender('leo@submail.cn','Leo');
setReply
设置回复地址
submail.SetReply('leo@submail.cn');
addCc
添加抄送地址
submail.AddCc('leo@submail.cn');
addBcc
添加密送地址
submail.AddBcc('leo@submail.cn');
setSubject
设置邮件标题
submail.SetSubject('test SDK');
setProject
设置邮件项目标识
submail.SetProject('ThJBE4');
addVar
添加文本变量到 vars 数组
submail.AddVar('name','leo');
addLink
添加超链接变量到 links 数组
submail.AddLink('developer','http://submail.cn/chs/developer');
addHeaders
添加自定义邮件头指令到 headers 数组
submail.AddHeaders('X-Mailer','My App');
getSender()
获取发送方式
return new Mail(this.config);
xsend()
发送邮件
submail.xsend()

 

代码示例

使用 MAILXsend 类提交 mail/xsend 发送一封邮件。


package demo;

import utils.ConfigLoader;
import config.AppConfig;
import lib.MAILXSend;

public class MailXSendDemo {

public static void main(String[] args) {

AppConfig config = ConfigLoader.load(ConfigLoader.ConfigType.Mail);
MAILXSend submail = new MAILXSend(config);
submail.addTo("leo@submail.cn","leo");
submail.setProject("uigGk1");
submail.xsend();
}
}

 

   MESSAGEXsend 类

 

初始化类

 

MESSAGEXsend submail = new MESSAGEXsend(config);

 

使用指引

方法
描述
示例
addTo
添加11位手机号码到 To 数组
submail.addTo('138xxxxxxxx');
addAddressbook
添加地址薄标识到 addressbook 数组
submail.addAddressbook('subscribe');
setProject
设置短信项目标记
submail.setSender('leo@submail.cn','Leo');
addVar
添加文本变量到 vars 数组
submail.addVar('name','leo');
getSender()
获取发送方式
return new Message(this.config);
xsend
发送短信
submail.xsend();

 

代码示例

使用 MESSAGEXsend 类提交 message/xsend 发送一条触发短信。


package demo;

import utils.ConfigLoader;
import config.AppConfig;
import lib.MESSAGEXsend;

public class MessageXSendDemo {

public static void main(String[] args) {

AppConfig config = ConfigLoader.load(ConfigLoader.ConfigType.Message);
MESSAGEXsend submail = new MESSAGEXsend(config);
submail.addTo("138xxxxxxxx");
submail.setProject("kZ9Ky3");
submail.addVar("code", "198276");
submail.xsend();
}
}

 

   ADDRESSBOOKMail 类

 

初始化类

 

ADDRESSBOOKMail addressbook = new ADDRESSBOOKMail(config);

 

使用指引

方法
描述
示例
setAddress
设置邮件地址,第一个必选参数:邮件地址。第二个可选参数:收件人姓名
addressbook.SetAddress("leo@submail.cn","Leo");
setAddressbook
设置目标地址薄标识
addressbook.SetAddressbook('subscribe')
subscribe
订阅或添加联系人
addressbook.subscribe()
unsubscribe
退订或移除联系人
addressbook.unsubscribe()

getSender()

获取发送方式

return new Mail(this.config);

 

代码示例

使用 ADDRESSBOOKMail 类提交 addressbook/mail/subscribe 请求,添加订阅联系人或向目标地址薄中添加联系人


package demo;

import utils.ConfigLoader;
import config.AppConfig;
import lib.ADDRESSBOOKMail;

public class AddressBookMailSubscribe {

public static void main(String[] args) {

AppConfig config = ConfigLoader.load(ConfigLoader.ConfigType.Mail);
ADDRESSBOOKMail addressbook = new ADDRESSBOOKMail(config);
addressbook.setAddress("leo@submail.cn", "leo");
addressbook.subscribe();
}
}

 

使用 ADDRESSBOOKMail 类 发送 addressbook/mail/unsubscribe 请求,添加退订联系人或从目标地址薄中移除联系人


package demo;

import utils.ConfigLoader;
import config.AppConfig;
import lib.ADDRESSBOOKMail;

public class AddressBookMailUnSubscribe {

public static void main(String[] args) {

AppConfig config = ConfigLoader.load(ConfigLoader.ConfigType.Mail);
ADDRESSBOOKMail addressbook = new ADDRESSBOOKMail(config);
addressbook.setAddress("leo@submail.cn", "leo");
addressbook.unsubscribe();
}
}

 

   ADDRESSBOOKMessage

 

初始化类

 

ADDRESSBOOKMessage addressbook = new ADDRESSBOOKMessage(config);

 

使用指引

方法
描述
示例
setAddress
设置联系人11位手机号码
addressbook.SetAddress('138xxxxxxxx');
setAddressbook
设置目标地址薄标识
addressbook.SetAddressbook('subscribe')
subscribe
订阅或添加联系人
addressbook.subscribe()
unsubscribe
退订或移除联系人
addressbook.unsubscribe()
getSender()
获取发送方式
return new Message(this.config);

 

代码示例

使用 ADDRESSBOOKMessage 类 发送 addressbook/message/subscribe 请求,添加订阅联系人或向目标地址薄中添加联系人


package demo;

import utils.ConfigLoader;
import config.AppConfig;
import lib.ADDRESSBOOKMessage;

public class AddressBookMessageSubscribe {

public static void main(String[] args) {

AppConfig config = ConfigLoader.load(ConfigLoader.ConfigType.Message);
ADDRESSBOOKMessage addressbook = new ADDRESSBOOKMessage(config);
addressbook.setAddress("138xxxxxxxx");
addressbook.subscribe();
}
}

 

使用 ADDRESSBOOKMessage 类 发送 addressbook/message/unsubscribe 请求,添加退订联系人或从目标地址薄中移除联系人


package demo;

import utils.ConfigLoader;
import config.AppConfig;
import lib.ADDRESSBOOKMessage;

public class AddressBookMessageUnSubscribe {

public static void main(String[] args) {

AppConfig config = ConfigLoader.load(ConfigLoader.ConfigType.Message);
ADDRESSBOOKMessage addressbook = new ADDRESSBOOKMessage(config);
addressbook.setAddress("138xxxxxxxx");
addressbook.unsubscribe();
}
}