SUBMAIL群发邮件API接口-Mail/send
2024-06-27 13:01:15
API: Mail/send
原文链接
概览
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
支持格式
| 格式 | URL |
|---|---|
json
|
https://api.mysubmail.com/mail/send.json（默认）
|
xml
|
https://api.mysubmail.com/mail/send.xml
|
http 请求方式
| 请求方式 | content-type设置 |
|---|---|
http post
|
multipart/form-data、x-www-form-urlencoded、application/json
|
是否需要授权
是
参阅 API 授权和验证机制
请求参数
| 参数 | 类型 | 必需/可选 | 默认 | 描述 |
|---|---|---|---|---|
appid
|
string
|
必需
|
无 | 在 SUBMAIL 应用集成中创建的邮件应用ID |
to
|
string
|
可选 | 无 |
收件人地址 (多个联系人用半角“,”隔开： e.g. "leo <leo>, <retro>, service@submail.cn",单次请求提交邮箱数量控制在100个以内，SUBMAIL 支持完整的 RFC 822 收件人标准，请确保您的邮件地址的有效性。请参见 维基百科EMAIL ADDRESS RFC822 文档)
|
from
|
e-mail
|
必需
|
无 | 发件人地址 ，标准的发件人地址 e.g. leo@submail.cn |
from_name
|
string
|
可选 | 无 | 发件人称呼，显示名称 e.g. Submail （50个字符以内） |
reply
|
e-mail
|
可选 | 无 |
回复地址(标准的回复邮件地址 e.g. leo@submail.cn)
|
cc
|
string
|
可选 | 无 |
抄送地址 (多个抄送地址请用 “ , ”_半角逗__号_区分，请将抄送联系人控制在 5 个以内)。
|
bcc
|
string
|
可选 | 无 |
密送地址(多个密送地址请用 “ ,”_半角逗__号_或区分，请将密送联系人控制在 5 个以内)。
|
subject
|
string
|
必需
|
无 | 邮件标题（200个字符以内） |
text
|
string
|
可选 | 无 | 纯文本邮件正文（5000个字符以内） |
html
|
string
|
可选 | 无 | HTML 邮件正文（60 KB以内） |
vars
|
json string
|
可选 | 无 | 使用文本变量动态控制邮件中的文本，参阅 了解如何创建和使用文本变量 |
links
|
json string
|
可选 | 无 | 使用超链接变量动态控制邮件中的超链接，参阅 了解如何创建和使用超链接变量 |
attachments
|
文件 | 可选 | 无 | 附件（文件数量不超过10个，文件总大小应小于5 MB，此参数不参与加密计算） |
atta
|
json array
|
可选 | 无 | 附件 base64格式文件附件，eg: atta= [{“name”:“测试.zip”,“data”:“base64”},{“name”:“2”,“data”:“base64 file”},…]（atta参数可用于base64格式的附件传输，此参数为jason array格式，每组数据需包含 name 和 data 参数，name 为文件名，data 为 附件的base 64数据；文件数量不超过10个，文件总大小应小于5 MB，此参数不参与加密计算 ） |
headers
|
json string
|
可选 | 无 |
自定义 EMAIL 头文件指令，headers 是一个标准的 JSON 字符串，headers 参数可以让开发者在 EMAIL 的标头部分插入自定义指令（500个字符以内）。如：{"X-Accept-Language": "zh-cn", "X-Priority":"3","X-Mailer": "My Application"}
|
asynchronous
|
string
|
可选 | false | 异步选项，该值设为 true 时启用异步发送模式 |
tag
|
string
|
可选 | 无 | 自定义标签功能，该标签可用作SUBHOOK追踪（32 个字符以内） |
timestamp
|
UNIX 时间戳 | 可选 | 无 |
参阅 API 授权与验证机制 > Timestamp UNIX 时间戳
|
sign_type
|
string
|
可选 |
normal
|
API 授权模式（ md5 or sha1 or normal ）参阅 API 授权与验证机制 > 授权和验证方式 |
sign_version
|
string
|
可选 | 无 | signature加密计算方式(当sign_version传2时，text，html，vars，links，attachments参数不参与加密计算) |
signature
|
string
|
必需 | 无 | 应用密匙 _或 _数字签名 |
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 错误代码
SUBMAIL群发邮件API接口-Mail/send相关推荐
- SUBMAIL邮件平台API接口-Mail/xsend
API: Mail/xsend 原文链接 概览 mail/xsend 是邮件 API 的升级版本.与 mail/send API 一样,mail/xsend 提供强大的邮件发送功能,区别于 mail/ ...
- 短信平台API接口调用-SUBMAIL
一.下载SDK开发包 前往文档中心 ->SDK 开发包下载页面,下载对应语言的SDK开发包. SUBMAIL 提供多种语言的开发包,SDK 集成了 SUBMAIL 的 API 请求方法,并将 A ...
- taobao.logistics.dummy.send( 无需物流发货处理 )接口，淘宝店铺发货API接口，淘宝r2接口，淘宝oAu2.0接口，淘宝订单发货接口
taobao.logistics.dummy.send( 无需物流发货处理 )接口,淘宝店铺发货API接口,淘宝r2接口,淘宝oAu2.0接口,淘宝订单发货接口,接口可适用于,店铺发货,店铺订单同步, ...
- 设计一个处理两种类型地址的地址簿程序_短信平台的API接口都有哪些类型？
在这里以 SUBMAIL API 接口为例,解读下接口短信的分类和特点: SUBMAIL 的API 功能是基于云端的通信接口,用户通过接入和集成 API 就可以方便.高效地使用云通信功能,不需要先投入 ...
- 使用Node.js写一个简单的api接口
引入Http模块 默认你已经安装了Node.js Node当中内置了Http模块: 可以使用 var http= require("http"); 复制代码 引入http模块: H ...
- python有道api-python 调用有道api接口的方法
初学python ,研究了几天,写了一个python 调用 有道api接口程序 效果看下图: 申明:代码仅供和我一样的初学者学习交流 申请很简单的 ps:审核不用花时间的,请勿滥用!! #-*- co ...
- php 动态彩码辨色 接口的调用_好用的云函数！后端低代码接口开发，零基础编写API接口...
前言 在开发项目过程中,经常需要用到API接口,实现对数据库的CURD等操作. 不管你是专业的PHP开发工程师,还是客户端开发工程师,或者是不懂编程但懂得数据库SQL查询,又或者是完全不太懂技术的人, ...
- 支付宝服务窗API接口开发php版本
支付宝服务窗API接口的开发对于许多网站要充值的朋友来讲是非常的重要的,今天我们就一起来看一篇关于php版本的支付宝服务窗API接口的开发例子. 这两天没事要接入支付宝服务窗,看支付宝的DEMO,我的 ...
- 利用api接口来实现web网页登陆
因为公司的所有链接数据库的都是用的api接口 最近做了一个用api接口登陆 function Login() { if (!Validate()) { return false; } var par ...
- 聊一聊对外API接口的存活检查可以怎么做
背景 公司内部的API接口一般会分为两大类,一类是直接暴露在公网可以访问的,一类是只能在局域网内访问的. 暴露在公网的一般就是业务网关以及一些和第三方公司有着某些合作,从而进行数据交互的接口. 检查A ...
最新文章
- CSS实现网页图片预加载
- python comprehensions_python 列表生成式 List Comprehensions
- 【推荐】Redhat 5配置YUM服务器【利用DVD盘做yum源】
- [luoguP2331] [SCOI2005]最大子矩阵（DP）
- Beetlex之tcp/tls服务压测工具
- 4g内存 堆内存分配多少_我需要多少内存
- linux命令基本格式教程,Linux命令基本格式（详解版）
- arcgis拆分多部件要素
- 智能手机前景 光芒万丈
- 使用Visual Studio开发游戏——微软宣布与Unity、Unreal Engine和Cocos展开全新合作
- php session 跨子域,PHP session 跨子域问题总结
- python seo 外链_百度链接提交-主动推送程序Python版
- 用IntelliJ IDEA自带的代码对比
- JSP+MySQL基于ssm的物理竞赛管理系统
- MySQL闪退解决办法
- 思维导图c语言java区别_C语言基本数据类型的思维导图
- Atitit 代理解决方案proxy solu attilax总结 1. 为什么需要代理 1 1.1. Ajax跨域 1 1.2. Nginx反向代理 1 2. 分类 2 2.1. 普通vs隧道 2
- 服务器信号切换机,KH1508Ai-远程KVM多电脑切换器-南京明高——MOXA工业互联网全系列产品销售服务平台 工业交换机，串口服务器，工业无线，嵌入式计算机，现场总线网关，接口转换器...
- 论文阅读之《CrowdPose: Efficient Crowded Scenes Pose Estimation and A new Benchmark》
- 公众号数据全面分析解读（上篇）