发送单条邮件。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| dm:SingleSendMail | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| AccountName | string | 是 | 管理控制台中配置的发信地址。 | test***@example.net |
| AddressType | integer | 是 | 地址类型。取值： 0：为随机账号 1：为发信地址 | 1 |
| TagName | string | 否 | 在邮件推送控制台创建的标签，用于分类所发送的邮件批次，可以通过标签来查询每批邮件的发送情况，另外如果开启邮件跟踪功能，发信必须使用邮件标签。 | test |
| ReplyToAddress | boolean | 是 | 是否启用管理控制台中配置好回信地址（状态须验证通过），取值范围是字符串 true 或者 false（不是 bool 值）。 | true |
| ToAddress | string | 是 | 目标地址，多个 email 地址可以用逗号分隔，最多 100 个地址（支持邮件组）。 | test1***@example.net |
| Subject | string | 是 | 邮件主题，长度不大于 100 个字符。 | Subject |
| HtmlBody | string | 否 | 邮件 html 正文，SDK 限制 80K。注意：HtmlBody 和 TextBody 是针对不同类型的邮件内容，两者必须传其一。 | body |
| TextBody | string | 否 | 邮件 text 正文，SDK 限制 80K。注意：HtmlBody 和 TextBody 是针对不同类型的邮件内容，两者必须传其一。 | body |
| FromAlias | string | 否 | 发信人昵称，长度小于 15 个字符。 例如：发信人昵称设置为”小红”，发信地址为 test***@example.net，收信人看到的发信地址为“小红”test***@example.net。 | 小红 |
| 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 |
返回参数
示例
正常返回示例
JSON格式
{
"EnvId": "600000xxxxxxxxxx642",
"RequestId": "2D086F6-xxxx-xxxx-xxxx-006DED011A85"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 404 | InvalidMailAddress.NotFound | The specified mail address is not found. | 发信地址未找到 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-02-20 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |