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

SUBMAIL Node.js SDK

 

   概览

 

支持node版本:v0.10.0 以上

代码编码格式:utf-8

 

   下载
SUBMAIL_NODE_JS_SDK
邮件、短信和地址薄
下载

 

   文件目录索引
config.js
处理用户的配置信息,包括 appidappkey 的配置信息
 
addressbookMailSubscribeDemo.js
邮件地址薄,订阅和添加联系人到目标地址薄
 
addressbookMailUnSubscribeDemo.js
邮件地址薄,退订和从目标地址薄移除联系人
addressbookMessageSubscribeDemo.js
短信地址薄,订阅和添加联系人到目标地址薄
addressbookMessageUnSubscribeDemo.js
短信地址薄,退订和从目标地址薄移除联系人
mailSendDemo.js
mail/send API 代码示例和使用指引
 
mailXSendDemo.js
mail/xsend API 代码示例和使用指引
 
MailSendDemo.swift
mail/send API 代码示例和使用指引
messageXSendDemo.js
message/xsend API 代码示例和使用指引
 
addressbookMail.js
邮件地址薄 API
 
addressbookMessage.js
短信地址薄 API
 
mail.js
邮件 API
mailSend.js
mail/send API
mailXSend.js
mail/xsend API
message.js
短信 API
messageXSend.js
message/xsend API

 

   开始使用

 

引入文件

在SDK目录中执行 npm install,安装 request(https://github.com/request/request)第三方库。

 

 

SDK Class 索引

 

mailSend.js
mail/send API
mailXSend.js
mail/xsend API
messageXSend.js
message/xsend API
addressbookMail.js
邮件地址簿 API
addressbookMessage.js
短信地址簿 API

 

   mailSend

 

初始化类

 

var MainSend = require('./mailSend.js')
var submail = new MailSend()

 

使用指引

方法
描述
示例
add_to
添加邮件地址到 To 数组
submail.add_to("leo@submail.cn")
add_to_name
添加收件人名称
submail.add_to_name("Leo")
add_addressbook
添加地址薄标识到 addressbook 数组
submail.add_addressbook("subscribe")
set_from
设置发件人
submail.set_from("leo@submail.cn")
set_from_name
设置显示名称
submail.set_from_name("SUBMAIL")
set_reply
设置回复地址
submail.set_reply("leo@submail.cn")
add_cc
添加抄送地址
submail.add_cc("leo@submail.cn")
add_bcc
添加密送地址
submail.add_bcc("leo@submail.cn")
set_subject
设置邮件标题
submail.set_subject("test SDK")
set_text
设置文本邮件内容
submail.set_text("test SDK text")
set_html
设置 HTML 邮件内容
submail.set_html("test SDK html")
add_var
添加文本变量到 vars 数组
submail.add_var("name","leo")
add_link
添加超链接变量到 links 数组
submail.add_link("developer","http://submail.cn/chs/developer")
add_headers
添加自定义邮件头指令到 headers 数组
submail.add_headers("X-Mailer","My App")
add_attachment
添加附件到 attachments 数组
submail.add_attachment("//path//to//file.txt")
send()
发送邮件
submail.send()

 

代码示例

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


var MailSend = require('./mailSend.js');
var mailSend = new MailSend();

mailSend.add_to('leo@submail.cn');
mailSend.set_from('no-reply@submail.cn');
mailSend.set_subject('test subject');
mailSend.set_text('test text');
mailSend.set_html('test html');
mailSend.send();
   mailXSend

 

初始化类

 

var MainXSend = require('./mailXSend.js')
var submail = new MailXSend()

 

使用指引

方法
描述
示例
add_to
添加邮件地址到 To 数组
submail.add_to("leo@submail.cn")
add_to_name
添加收件人名称
submail.add_to_name("Leo")
add_addressbook
添加地址薄标识到 addressbook 数组
submail.add_addressbook("subscribe")
set_from
设置发件人邮件地址
submail.set_from("leo@submail.cn")
set_from_name
设置发件人显示名称
submail.set_from("SUBMAIL")
set_reply
设置回复地址
submail.set_reply("leo@submail.cn")
add_cc
添加抄送地址
submail.add_cc("leo@submail.cn")
add_bcc
添加密送地址
submail.add_bcc("leo@submail.cn")
set_subject
设置邮件标题
submail.set_subject("test SDK");
set_project
设置邮件项目标识
submail.set_project ("THJBE4")
add_var
添加文本变量到 vars 数组
submail.add_var("name", "leo")
add_link
添加超链接变量到 links 数组
submail.add_link("developer","http://submail.cn/chs/developer")
add_headers
添加自定义邮件头指令到 headers 数组
submail.add_headers("X-Mailer","My App")
xsend()
发送邮件
submail.xsend()

 

代码示例

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


var MailXSend = require('./mailXSend.js');
var mailXSend = new MailXSend();

mailXSend.add_to('jseanj@126.com');
mailXSend.add_toName('jseanj');
mailXSend.set_from('no-reply@insight.submail.me');
mailXSend.set_project('ZvNGo');
mailXSend.xsend();

 

   messageXSend

 

初始化类

 

var MessageXSend = require('./messageXSend.js')
var submail = new MessageXSend()

 

使用指引

方法
描述
示例
add_to
添加11位手机号码到 To 数组
submail.add_to("138xxxxxxxx")
add_addressbook
添加地址薄标识到 addressbook 数组
submail.add_addressbook("subscribe")
set_project
设置短信项目标记
submail.set_project("THJBE4")
add_var
添加文本变量到 vars 数组
submail.add_var("name", "leo")
xsend()
发送短信
submail.xsend()

 

代码示例

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


var MessageXSend = require('./messageXSend.js');
var messageXSend = new MessageXSend();

messageXSend.add_to('138xxxxxxx');
messageXSend.set_project('qagsN');
messageXSend.add_var('code','5322');
messageXSend.xsend();
   addressbookMail

 

初始化类

 

var AddressbookMail = require('./addressbookMail.js')
var addressbook = new AddressbookMail()

 

使用指引

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

 

代码示例

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


var AddressbookMail = require('./addressbookMail.js');
var addressbookMail = new AddressbookMail();

addressbookMail.set_address('leo@submail.cn');
addressbookMail.subscribe();

 

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


var AddressbookMail = require('./addressbookMail.js');
var addressbookMail = new AddressbookMail();

addressbookMail.set_address('leo@submail.cn');
addressbookMail.unsubscribe();

 

   addressbookMessage

 

初始化类

 

var AddressbookMessage = require('./addressbookMessage.js')
var addressbook = new AddressbookMessage()

 

使用指引

方法
描述
示例
set_address
设置联系人11位手机号码
submail.set_address("138xxxxxxxx")
set_addressbook
设置目标地址薄标识
submail.add_addressbook("subscribe")
subscribe()
订阅或添加联系人
submail.subscribe()
unsubscribe()
退订或移除联系人
submail.unsubscribe()

 

代码示例

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


var AddressbookMessage = require('./addressbookMessage.js');
var addressbookMessage = new AddressbookMessage();
addressbookMessage.set_address('138xxxxxxx');
addressbookMessage.subscribe();

 

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


var AddressbookMessage = require('./addressbookMessage.js');
var addressbookMessage = new AddressbookMessage();
addressbookMessage.set_address('138xxxxxxx');
addressbookMessage.unsubscribe();