批量发送邮件。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
dm:BatchSendMail |
none |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| TemplateName |
string |
是 |
预先创建且通过审核的模板名称。 |
test1 |
| AccountName |
string |
是 |
管理控制台中配置的发信地址。 |
test@example.com |
| ReceiversName |
string |
是 |
预先创建且上传了收件人的收件人列表名称。 注意: 收件人列表人数不得高于剩余日额度,否则会发信失败。 收信人列表需要在触发任务之后至少 10 分钟后再删除,否则容易引起发信失败。 |
test2 |
| AddressType |
integer |
是 |
|
1 |
| TagName |
string |
否 |
邮件标签名称。 |
test3 |
| ReplyAddress |
string |
否 |
回信地址 |
test2***@example.net |
| ReplyAddressAlias |
string |
否 |
回信地址别称 |
小红 |
| ClickTrace |
string |
否 |
|
0 |
| UnSubscribeLinkType |
string |
否 |
生成的退订链接类型。参照退订功能生成链接和过滤机制文档
显示语言根据收件人的浏览器设置自动识别 |
default |
| UnSubscribeFilterLevel |
string |
否 |
过滤级别。参照退订功能生成链接和过滤机制文档
|
mailfrom_domain |
| Headers |
string |
否 |
邮件头设置 标准字段和非标准字段都需要符合标准中对头的语法要求,API 发信最多可通过 headers 字段传入 10 个标头,超出限制会被忽略,SMTP 没有限制。 1、标准字段 Message-ID,List-Unsubscribe,List-Unsubscribe-Post 标准字段会覆盖掉邮件头中原有的值。 2、非标准字段 不区分大小写 a、以 X-User- 开头(不推送到事件总线 EB、消息服务 MNS。仅 API 要求,SMTP 任意自定义) b、以 X-User-Notify- 开头(推送到事件总线 EB、消息服务 MNS。API 和 SMTP 都支持) 推动到 EB 或 MNS 时,header 字段下会包含这些字段 |
{
"Message-ID": " |
| IpPoolId |
string |
否 |
独立 IP 地址池 ID。购买了独立 IP 的用户可以通过这个参数指定本次发信出口 IP。 |
e4xxxxxe-4xx0-4xx3-8xxa-74cxxxxx1cef |
| DomainAuth |
boolean |
否 |
启用域级别认证
仅在域级别认证时使用,发信地址级别认证请忽略。 1、domain-auth-created-by-system@example.com 控制台创建这个地址,@前缀保持固定不变,后缀用自己域名。 2、 API 场景 AccountName 填域名,收件人看到的发件人是 domain-auth-created-by-system@example.com。 SMTP 场景 a.通过 ModifyPWByDomain 接口设置域名密码。 b.使用域名和设置的密码认证,真实发件人 mailfrom 传自定义的地址,如 user@example.com,收件人看到的发件人是 user@example.com。 |
true |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| EnvId |
string |
事件 ID |
xxx |
| RequestId |
string |
请求 ID |
12D086F6-8F31-4658-84C1-006DED011A85 |
示例
正常返回示例
JSON格式
{
"EnvId": "xxx",
"RequestId": "12D086F6-8F31-4658-84C1-006DED011A85"
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。