概览

mail/send 是 SUBMAIL 的邮件 API。 mail/send API 不仅提供强大的邮件发送功能, 并在 API 中集成了地址簿发送功能。你可以通过设定一些参数来确定 API 以哪种模式发送。

mail/send API 可以使用变量动态的控制每封邮件的内容。 了解如何使用文本变量和超链接变量。

URL

<主> https://api.mysubmail.com/mail/send

<备> https://api.submail.cn/mail/send

支持格式

格式URLjsonhttps://api.mysubmail.com/mail/send.json（默认）xmlhttps://api.mysubmail.com/mail/send.xml

http 请求方式

请求方式content-type设置http postmultipart/form-data、x-www-form-urlencoded、application/json

是否需要授权

是

参阅 API 授权和验证机制

请求参数

参数类型必需/可选默认描述appidstring必需无在 SUBMAIL 应用集成中创建的邮件应用IDtostring可选无收件人地址 (多个联系人用半角“,”隔开： e.g. "leo <leo>, <retro>, service@submail.cn",SUBMAIL 支持完整的 RFC 822 收件人标准，请确保您的邮件地址的有效性。请参见 维基百科 EMAIL ADDRESS RFC822 文档)frome-mail必需无发件人地址 ，标准的发件人地址 e.g. leo@submail.cnfrom_namestring可选无发件人称呼，显示名称 e.g. Submail （50个字符以内）replye-mail可选无回复地址(标准的回复邮件地址 e.g. leo@submail.cn)ccstring可选无抄送地址 (多个抄送地址请用 “ , ”_半角逗__号_区分，请将抄送联系人控制在 5 个以内)。bccstring可选无密送地址(多个密送地址请用 “ ,”_半角逗__号_或区分，请将密送联系人控制在 5 个以内)。subjectstring必需无邮件标题（200个字符以内）textstring可选无纯文本邮件正文（5000个字符以内）htmlstring可选无HTML 邮件正文（60 KB以内）varsjson string可选无使用文本变量动态控制邮件中的文本，参阅 了解如何创建和使用文本变量linksjson string可选无使用超链接变量动态控制邮件中的超链接，参阅 了解如何创建和使用超链接变量attachments文件可选无附件（文件数量不超过10个，文件总大小应小于5 MB，此参数不参与加密计算）headersjson string可选无自定义 EMAIL 头文件指令，headers 是一个标准的 JSON 字符串，headers 参数可以让开发者在 EMAIL 的标头部分插入自定义指令（500个字符以内）。如： {"X-Accept-Language": "zh-cn", "X-Priority":"3","X-Mailer": "My Application"}asynchronousstring可选false异步选项，该值设为 true 时启用异步发送模式tagstring可选无自定义标签功能，该标签可用作SUBHOOK追踪（32 个字符以内）timestampUNIX 时间戳可选无参阅 API 授权与验证机制 > Timestamp UNIX 时间戳sign_typestring可选normalAPI 授权模式（ md5 or sha1 or normal ）
参阅 API 授权与验证机制 > 授权和验证方式sign_versionstring可选无signature加密计算方式(当sign_version传2时，text，html，vars，links，attachments参数不参与加密计算)signaturestring必需无应用密匙 _或 _数字签名

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.mysubmail.com/mail/send.json

POST DATA

appid=your_app_id
&to=leo <leo>
&subject=testing_Subject
&text=testing_text_body
&from=no-reply@submail.cn
&signature=your_app_key

返回

{
   "status":"success",
   "return": [
       {
         "send_id": "HstDN4",
         "to": "eg@eg.com"
       }
     ]
}

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

POST URL

https://api.mysubmail.com/mail/send.json

POST DATA

appid=your_app_id
&to=leo <leo>,retro@submail.cn
&subject=testing_Subject
&text=testing_text_body
&from=no-reply@submail.cn
&signature=your_app_key

返回

{
    "status":"success",
    "return": [
       {
         "send_id": "HstDN4",
         "to": "eg@eg.com"
       }
     ]
}

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

POST URL

https://api.mysubmail.com/mail/send.json

POST DATA

appid=your_app_id
&addressbook=subscribe
&subject=testing_Subject
&text=testing_text_body
&from=no-reply@submail.cn
&signature=your_app_key

返回

{
    "status":"success",
    "return": [
       {
         "send_id": "HstDN4",
         "to": "eg@eg.com"
       }
     ]
}

发送一封带附件的测试邮件

POST URL

https://api.mysubmail.com/mail/send.json

POST DATA

appid=your_app_id
&to=leo <leo>,retro@submail.cn
&subject=testing_Subject
&text=testing_text_body
&from=no-reply@submail.cn
&attachments[]=/path/to/file1.txt
&signature=your_app_key

返回

{
    "status":"success",
    "return": [
       {
         "send_id": "HstDN4",
         "to": "eg@eg.com"
       }
     ]
}

使用 CURL 发送一封测试邮件

发送 CURL

curl -d 'appid=your_app_id&to=leo<leo> &subject=testing Subject&text=testing text body&from=no-reply@submail.cn&signature=your_app_key' https://api.mysubmail.com/mail/send.json

返回

{
    "status":"success",
    "return": [
       {
         "send_id": "HstDN4",
         "to": "eg@eg.com"
       }
     ]
}

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

发送 CURL

curl -d 'appid=your_app_id&to=leo<leo> ,retro@submail.cn&subject=testing Subject&text=testing text body&from=no-reply@submail.cn&signature=your_app_key' https://api.mysubmail.com/mail/send.json

返回

{
      "status":"success",
      "return": [
       {
         "send_id": "HstDN4",
         "to": "eg@eg.com"
       }
     ]
}

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

发送 CURL

curl -d 'appid=your_app_id&addressbook=subscribe&subject=testing Subject&text=testing text body&from=no-reply@submail.cn&signature=your_app_key' https://api.mysubmail.com/mail/send.json

返回

{
      "status":"success",
      "return": [
       {
         "send_id": "HstDN4",
         "to": "eg@eg.com"
       }
     ]
}

使用 CURL 发送一封带附件的测试邮件

发送 CURL

curl https://api.mysubmail.com/mail/send.json \
-F appid=your_app_id \
-F to=leo\<leo> \
-F subject="testing subject" \
-F text="testing text body" \
--form-string html="<strong>testing html body</strong>" \
-F from=no-reply@submail.cn \
-F from_name=SUBMAIL \
-F attachments[]=@/path/to/file1.txt \
-F attachments[]=@/path/to/file2.txt \
-F signature=your_app_key \

返回

{
      "status":"success",
      "return": [
       {
         "send_id": "HstDN4",
         "to": "eg@eg.com"
       }
     ]
}

返回值

请求成功

{
      "status":"success",
      "return": [
       {
         "send_id": "HstDN4",
         "to": "eg@eg.com"
       }
     ]
}

请求失败

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

错误代码

参阅 API 错误代码

有需要了解的可以随时私聊我