邮件推送
视频服务与安全产品捉虫活动邀您参加！> HOT
文档中心>邮件推送>API 文档>邮件相关接口>发送邮件

发送邮件

最近更新时间：2024-07-15 01:18:36

我的收藏

本页目录：

1. 接口描述

接口请求域名： ses.tencentcloudapi.com 。

您可以通过此API发送HTML或者TEXT邮件，适用于触发类邮件（验证码、交易类）。默认仅支持使用模板发送邮件。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：SendEmail。
Version 是 String 公共参数，本接口取值：2020-10-02。
Region 是 String 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-guangzhou, ap-hongkong 。
FromEmailAddress 是 String 发件人邮箱地址。不使用别名时请直接填写发件人邮箱地址，例如：noreply@mail.qcloud.com如需填写发件人别名时，请按照如下方式（注意别名与邮箱地址之间必须使用一个空格隔开）：别名+一个空格+<邮箱地址>，别名中不能带有冒号(:)。
示例值：QCLOUDTEAM <noreply@mail.qcloud.com>
Destination.N 是 Array of String 收信人邮箱地址，最多支持群发50人。注意：邮件内容会显示所有收件人地址，非群发邮件请多次调用API发送。
Subject 是 String 邮件主题
示例值：YourTestSubject
ReplyToAddresses 否 String 邮件的“回复”电子邮件地址。可以填写您能收到邮件的邮箱地址，可以是个人邮箱。如果不填，收件人的回复邮件将会发送失败。
示例值：noreply@mail.qcloud.com
Cc.N 否 Array of String 抄送人邮箱地址，最多支持抄送20人。
Bcc.N 否 Array of String 密送人邮箱地址，最多支持抄送20人。
Template 否 Template 使用模板发送时，填写模板相关参数。
注意

如您未申请过特殊配置，则该字段为必填
Simple 否 Simple 已废弃
说明

仅部分历史上申请了特殊配置的客户需要使用。如您未申请过特殊配置，则不存在该字段。
Attachments.N 否 Array of Attachment 需要发送附件时，填写附件相关参数。腾讯云接口请求最大支持 8M 的请求包，附件内容经过 Base64 预期扩大1.5倍，应该控制所有附件的总大小最大在 4M 以内，整体请求超出 8M 时接口会返回错误
Unsubscribe 否 String 退订链接选项 0: 不加入退订链接 1: 简体中文 2: 英文 3: 繁体中文 4: 西班牙语 5: 法语 6: 德语 7: 日语 8: 韩语 9: 阿拉伯语 10: 泰语
示例值：1
TriggerType 否 Integer 邮件触发类型 0:非触发类，默认类型，营销类邮件、非即时类邮件等选择此类型 1:触发类，验证码等即时发送类邮件，若邮件超过一定大小，系统会自动选择非触发类型通道
示例值：1
SmtpMessageId 否 String smtp头中的Message-Id字段
示例值：<2SNZPF1T2NU4.5OB8TNNRVRYM3@qcloudmail.com>
SmtpHeaders 否 String smtp头中可以设置的其它字段
示例值：{"header1": "value1", "header2": "value2"}

3. 输出参数

参数名称 类型 描述
MessageId String 接受消息生成的唯一消息标识符。
示例值：qcloud-ses-messageid
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 发送模板邮件

输入示例

POST / HTTP/1.1
Host: ses.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SendEmail
<公共请求参数>

{
    "FromEmailAddress": "QCLOUDTEAM <noreply@mail.qcloud.com>",
    "ReplyToAddresses": "qcloud@tencent.com",
    "Destination": [
        "user@example.com"
    ],
    "Template": {
        "TemplateID": "100091",
        "TemplateData": "{\"code\":\"1234\"}"
    },
    "Subject": "YourTestSubject"
}

输出示例

{
    "Response": {
        "RequestId": "8979fc1e-9564-4fc9-bf7d-2958ce679b72",
        "MessageId": "qcloud-ses-messageid"
    }
}

示例2 发送富文本邮件

输入示例

POST / HTTP/1.1
Host: ses.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SendEmail
<公共请求参数>

{
    "FromEmailAddress": "QCLOUDTEAM <noreply@mail.qcloud.com>",
    "ReplyToAddresses": "qcloud@tencent.com",
    "Destination": [
        "user@example.com"
    ],
    "Simple": {
        "Html": "PGh0bWw+PGRpdj5IZWxsb1dvcmxkPC9kaXY+PC9odG1sPg==",
        "Text": "aGVsbG8gd29ybGQ="
    },
    "Subject": "YourTestSubject"
}

输出示例

{
    "Response": {
        "RequestId": "8979fc1e-9564-4fc9-bf7d-2958ce679b72",
        "MessageId": "qcloud-ses-messageid"
    }
}

示例3 发送纯文本邮件

输入示例

POST / HTTP/1.1
Host: ses.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SendEmail
<公共请求参数>

{
    "FromEmailAddress": "QCLOUDTEAM <noreply@mail.qcloud.com>",
    "ReplyToAddresses": "qcloud@tencent.com",
    "Destination": [
        "user@example.com"
    ],
    "Simple": {
        "Text": "aGVsbG8gd29ybGQ="
    },
    "Subject": "YourTestSubject"
}

输出示例

{
    "Response": {
        "RequestId": "8979fc1e-9564-4fc9-bf7d-2958ce679b72",
        "MessageId": "qcloud-ses-messageid"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
FailedOperation.AttachContentToolarge 附件太大，请参考单个附件以及附件总量大小限制。
FailedOperation.EmailAddrInBlacklist 邮件地址在黑名单中。
FailedOperation.EmailContentToolarge 邮件内容太大，请减少发送邮件内容。
FailedOperation.ExceedSendLimit 超出当日总量发送限制。
FailedOperation.FrequencyLimit 触发频率控制，短时间内对同一地址发送过多邮件。
FailedOperation.HighRejectionRate 拒信率过高，被临时block。
FailedOperation.IllegalURL 邮件包含不合规链接
FailedOperation.IncorrectEmail 邮箱地址错误。
FailedOperation.IncorrectSender 发件人格式不正确。请参考文档示例填写。
FailedOperation.InsufficientBalance 余额不足，账号欠费等。
FailedOperation.InsufficientQuota 套餐包额度不足。
FailedOperation.InvalidAttachName 不支持的附件名称，请检查附件名称是否含有特殊字符，详情请参考附录附件说明。
FailedOperation.InvalidTemplateID 模板ID无效或者不可用。
FailedOperation.MissingEmailContent 缺少发信内容（TemplateData和Simple不能同时为空)。
FailedOperation.NoAttachPermission 没有附件发送权限，请检查。
FailedOperation.NotAuthenticatedSender 发件sender没有经过认证，无法发送。
FailedOperation.ProtocolCheckErr 协议检查错误，请检查协议是否正确。
FailedOperation.ReceiverHasUnsubscribed 收件人已退订。
FailedOperation.RejectedByRecipients 邮件被收信人拒绝。
FailedOperation.SendEmailErr 您的发送遇到问题，请联系腾讯云提交工单沟通原因并解决。
FailedOperation.TemporaryBlocked 因触发了对应的收件服务商限制，邮件推送平台会对该服务商发信暂停10分钟，10分钟后自动解除。
FailedOperation.TooManyAttachments 附件数量太多，单封邮件最多支持10个附件。
FailedOperation.TooManyRecipients 收件人数太多，最多支持同时发送50人。
FailedOperation.URLForbidden 禁止到达率低用户在邮件内容中带有URL 网页链接
FailedOperation.UnsupportMailType 不支持的邮箱类型。
FailedOperation.WithOutPermission 仅支持使用模板发送邮件。
FailedOperation.WrongContentJson TemplateData字段格式不正确，请保持为json格式。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.AttachContentIsWrong 附件内容错误，请检查base64内容是否正确。
InvalidParameterValue.EmailAddressIsNULL 收件或者发件地址为空，请检查邮件地址。
InvalidParameterValue.EmailContentIsWrong 邮件内容错误，请检查TEXT/HTML base64是否正确。
InvalidParameterValue.InvalidEmailIdentity 域名取值错误。
InvalidParameterValue.ReceiverEmailInvalid 收件人地址错误。
LimitExceeded 超过配额限制。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
RequestLimitExceeded 请求的次数超过了频率限制。
ResourceInsufficient 资源不足。
ResourceUnavailable 资源不可用。
UnknownParameter 未知参数错误。
UnsupportedOperation 操作不支持。
中国站
文档反馈
文档活动
message-icon联系我们
目录