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

API: Mail/xsend

 

   概览

 

mail/xsend 是邮件 API 的升级版本。与 mail/send API 一样,mail/xsend 提供强大的邮件发送功能,区别于 mail/send API,mail/xsend 无需提交 html 源码或邮件文本内容,甚至无需提交邮件标题或发件人,仅需提交你在 SUBMAIL MAIL 应用程序中创建的邮件项目的标记(ID),并可以使用变量动态的控制每封邮件的内容。 了解如何使用文本变量超链接变量

使用 mail/xsend API 你将可以使用 SUBMAIL MAIL EDITOR 高效、可视化地创建你的触发邮件,无需管理邮件中的一切静态资源或编码(如图片,html 代码兼容等问题),甚至移动设备兼容问题, SUBMAIL MAIL EDITOR 已为你做好了一切。

 

   URL
<主> https://api.mysubmail.com/mail/xsend
<备> https://api.submail.cn/mail/xsend
   支持格式
json
https://api.mysubmail.com/mail/xsend.json
默认
xml
https://api.mysubmail.com/mail/xsend.xml
 
   请求参数
参数
类型
必需/可选
默认
描述

appid

string

必需

在 SUBMAIL 应用集成中创建的应用 ID

to

string

可选

收件人地址

多个联系人,请用 “,” 半角逗号区分  e.g. "leo <leo@submail.cn>, <retro@submail.cn>, service@submail.cn";

SUBMAIL 支持完整的 RFC 822 收件人标准,请确保您的邮件地址的有效性。请参见 维基百科 EMAIL ADDRESS RFC822 文档

请注意:当你的  TO 参数和地址薄中的联系人总和大于 50 个联系人时,将自动被转入推广邮件通道,且本次发送不计算为触发类邮件,to 参数单次请求上限为 5000 个联系人

addressbook

string

可选

添加地址薄中的联系人

多个地址薄请用 “,” 半角逗区分 e.g.  "subscribe,WbRfn3,j5lVv1"

例中 WbRfn3 和 j5lVv1 是指该地址薄的开发者标识,请参见 获取项目或地址薄的开发者标识

请注意:当你的地址薄和 TO 参数中的联系人总和大于 50 个联系人时,将自动被转入推广邮件通道,且本次发送不计算为触发类邮件,地址薄 addressbook 参数:单次请求上限为50个地址薄,且所请求的地址薄中包含不超过15万联系人

from

e-mail

可选

发件人地址 ,标准的发件人地址 e.g. leo@submail.cn

from_name

string

可选

发件人称呼,显示名称 e.g. Submail (50个字符以内)

reply

e-mail 可选

回复地址,标准的回复邮件地址 e.g. leo@submail.cn

cc

e-mail 可选

抄送地址

多个抄送地址请用 “ , ”半角逗区分,请将抄送联系人控制在 5 个以内。

bcc

e-mai 可选

密送地址

多个抄送地址请用 “ , ”半角逗区分,请将密送联系人控制在 5 个以内。

subject

string

可选

邮件标题 (200个字符以内)

不提交邮件标题,此标题将读取项目标题

project

string

必需

项目标记(ID),在SUBMAIL > MAIL >项目中,(如果您的账户已开通应用集成,提交并验证了您的开发者身份后)你将可以查看你所创建的邮件项目标记。此参数将根据你提交的标记来确定该发送的项目。

vars

json string

可选

使用文本变量动态控制邮件中的文本

参阅 了解如何创建和使用文本变量

links

json string

可选

使用超链接变量动态控制邮件中的超链接

参阅 了解如何创建和使用超链接变量

headers

json string

可选

自定义 EMAIL 头文件指令,headers 是一个标准的 JSON 字符串,headers 参数可以让开发者在 EMAIL 的标头部分插入自定义指令。(500个字符以内)

如: {"X-Accept-Language": "zh-cn", "X-Priority":"3","X-Mailer": "My Application"}

请注意:

Submail 保留 x-submail-smtp-api 指令,请务必不要在邮件标头中使用此指令

自定义的 EMAIL headers 指令通常以字母 X- 开头,请将此规范应用到你的指令

vars,  links 和 headers 参数要求严格的 JSON 格式,以下是将参数转换为 JSON 格式的注意事项

  1. json 字符串必须以双引号包含
  2. json 字符串必须是 utf8 编码
  3. 不能有多余的逗号 如:[1,2,]
  4.  json 字符串首尾必须被大括号{}包含 

 

PS:大多数的语言都有专属的JSON解析器( ENCODING 和 DECODEING 方法)。如 PHP,首先将需要的变量以数组形式(如 $var[‘key’]=value) 创建后,使用 json_encode($var)方法创建 JSON 字符串;

asynchronous

bool

可选 false

异步选项,该值设为 true 时启用异步发送模式

tag

string

可选

自定义标签功能,该标签可用作SUBHOOK追踪(32 个字符以内)

timestamp

UNIX 时间戳

可选 参阅 API 授权与验证机制  >  Timestamp UNIX 时间戳

sign_type

string

可选

normal

API 授权模式(  md5 or sha1 or normal )

参阅 API 授权与验证机制  >  授权和验证方式

signature

string

必需

应用密匙 或 数字签名

参阅 API 授权与验证机制  >  授权和验证方式

   代码示例

发送一封测试邮件


 

 


发送一封测试邮件,多收件人


 

 


使用地址薄发送一封测试邮件


 

 


使用 CURL 发送一封测试邮件


 

使用 CURL 发送一封测试邮件,多收件人


 

使用 CURL 发送一封测试邮件,使用地址薄中的收件人


 

 

   返回码