API: Mail/XSend - 邮件模板发送

概览

mail/xsend 是邮件 API 的升级版本。与 mail/send API 一样，mail/xsend 提供强大的邮件发送功能，区别于 mail/send API，mail/xsend 无需提交 html 源码或邮件文本内容，甚至无需提交邮件标题或发件人，仅需提交你在 SUBMAIL MAIL 中创建的邮件项目模板ID，并可以使用变量动态的控制每封邮件的内容。


项目模版ID：

了解如何使用文本变量和超链接变量。


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

URL

https://api-v4.mysubmail.com/mail/xsend

支持格式

http 请求方式

是否需要授权

是

参阅 API 授权和验证机制

请求参数

注意：

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

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

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

json 字符串必须以双引号包含
json 字符串必须是 utf8 编码
不能有多余的逗号 如：[1,2,]
json 字符串首尾必须被大括号{}包含 
 
PS:大多数的语言都有专属的JSON解析器（ ENCODING 和 DECODEING 方法）。如 PHP，首先将需要的变量以数组形式(如 $var[‘key’]=value) 创建后，使用 json_encode($var)方法创建 JSON 字符串；

代码示例

发送一封测试邮件

POST URL

https://api-v4.mysubmail.com/mail/xsend.json

POST Data

appid=your_app_id
&to=leo@submail.cn
&project=ThJBE4
&signature=your_app_key

返回

{
    "status": "success",
    "return": [
        {
            "to": "leo@submail.cn",
            "send_id": "e6243d12875942204e757a08c6487e24"
        }
    ]
}

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

POST URL

https://api-v4.mysubmail.com/mail/xsend.json

POST DATA

appid=your_app_id
&to=leo@submail.cn,retro@submail.cn
&project=ThJBE4
&signature=your_app_key

返回

{
    "status": "success",
    "return": [
        {
            "send_id": "adda40cbd0f226c92960e70662859efe",
            "to": "leo@submail.cn"
        },
        {
            "send_id": "850a4d5022c47aeab18d466575555f0e",
            "to": "retro@submail.cn"
        }
    ]
}

使用 CURL 发送一封测试邮件

发送 CURL

curl -d 'appid=your_app_id&to=leo@submail.cn&project=ThJBE4&signature=your_app_key' https://api-v4.mysubmail.com/mail/xsend.json

返回

{
    "status": "success",
    "return": [
        {
            "to": "leo@submail.cn",
            "send_id": "e6243d12875942204e757a08c6487e24"
        }
    ]
}

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

发送 CURL

curl -d 'appid=your_app_id&to=leo@submail.cn,retro@submail.cn&&project=ThJBE4&signature=your_app_key' https://api-v4.mysubmail.com/mail/xsend.json

返回

{
    "status": "success",
    "return": [
        {
            "send_id": "adda40cbd0f226c92960e70662859efe",
            "to": "leo@submail.cn"
        },
        {
            "send_id": "850a4d5022c47aeab18d466575555f0e",
            "to": "retro@submail.cn"
        }
    ]
}

请求成功

{
    "status": "success",
    "return": [
        {
            "to": "leo@submail.cn",
            "send_id": "e6243d12875942204e757a08c6487e24"
        }
    ]
}

请求失败

{
      "status":"error",
      "code":"1xx",
      "msg":"error message"
}

错误代码

参阅 [API 错误代码](