调用BatchSendMail API批量发送邮件-邮件推送-阿里云

批量发送邮件。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dm:BatchSendMail

none

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
TemplateName	string	是	预先创建且通过审核的模板名称。	test1
AccountName	string	是	管理控制台中配置的发信地址。	test@example.com
ReceiversName	string	是	预先创建且上传了收件人的收件人列表名称，注意：收信人列表需要在触发任务之后至少 10 分钟后再删除，否则容易引起发信失败	test2
AddressType	integer	是	0：为随机账号 1：为发信地址	1
TagName	string	否	邮件标签名称。	test3
ReplyAddress	string	否	回信地址	test2***@example.net
ReplyAddressAlias	string	否	回信地址别称	小红
ClickTrace	string	否	1：为打开数据跟踪功能 0（默认）：为关闭数据跟踪功能	0
UnSubscribeLinkType	string	否	生成的退订链接类型。参照退订功能生成链接和过滤机制文档 disabled: 不生成 default: 采用默认策略：对批量类型的发信地址发给特定域名时会生成退订链接，如带有关键字"gmail", "yahoo", "google", "aol.com", "hotmail", "outlook", "ymail.com"等 zh-cn: 生成，给将来埋点到内容准备 en-us: 生成，给将来埋点到内容准备	default
UnSubscribeFilterLevel	string	否	过滤级别。参照退订功能生成链接和过滤机制文档 disabled: 不过滤 default: 采用默认策略，批量地址采用发信地址级别过滤 mailfrom: 发信地址级别过滤 mailfrom_domain: 发信域名级别过滤 edm_id: 账号级别过滤	mailfrom_domain
Headers	string	否	邮件头目前可以添加的标准字段是 Message-ID，List-Unsubscribe，List-Unsubscribe-Post。标准字段会覆盖掉邮件头中原有的值，非标准字段需要以 X-User- 开头，会被追加到邮件头中。目前支持 JSON 传入的邮件头最多 10 个，标准字段和非标准字段都需要符合标准中对头的语法要求。	{ "Message-ID": "", "X-User-UID1": "UID-1-000001", "X-User-UID2": "UID-2-000001" }
IpPoolId	string	否	独立 IP 地址池 ID。购买了独立 IP 的用户可以通过这个参数指定本次发信出口 IP。	xxx
DomainAuth	boolean	否

返回参数

名称	类型	描述	示例值
	object
EnvId	string	事件 ID	xxx
RequestId	string	请求 ID	12D086F6-8F31-4658-84C1-006DED011A85

示例

正常返回示例

JSON格式

{
  "EnvId": "xxx",
  "RequestId": "12D086F6-8F31-4658-84C1-006DED011A85"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。