发送邮件

最近更新时间:2021-03-05 08:16:20

我的收藏

1. 接口描述

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

您可以通过此API发送TEXT或者HTML邮件,默认仅支持使用模板发送邮件,如需发送自定义内容,请单独联系商务开通此功能。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:SendEmail。
Version String 公共参数,本接口取值:2020-10-02。
Region String 公共参数,详见产品支持的 地域列表
FromEmailAddress String 发信邮件地址。请填写发件人邮箱地址,例如:noreply@mail.qcloud.com。如需填写发件人说明,请按照
发信人 <邮件地址> 的方式填写,例如:
腾讯云团队 <noreply@mail.qcloud.com>
Destination.N Array of String 收信人邮箱地址,最多支持群发50人。注意:邮件内容会显示所有收件人地址,非群发邮件请多次调用API发送。
Subject String 邮件主题
ReplyToAddresses String 邮件的“回复”电子邮件地址。可以填写您能收到邮件的邮箱地址,可以是个人邮箱。如果不填,收件人将会回复到腾讯云。
Template Template 使用模板发送时,填写的模板相关参数
Simple Simple 使用API直接发送内容时,填写的邮件内容
Attachments.N Array of Attachment 需要发送附件时,填写附件相关参数。

3. 输出参数

参数名称 类型 描述
MessageId String 接受消息生成的唯一消息标识符。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 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"
    ],
    "Simple": {
        "Text": "aGVsbG8gd29ybGQ="
    },
    "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"
    ],
    "Template": {
        "TemplateID": "100091",
        "TemplateData": "{\"code\":\"1234\"}"
    },
    "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.IncorrectEmail 邮箱地址错误。
FailedOperation.IncorrectSender 发件人格式不正确。请参考文档示例填写。
FailedOperation.InsufficientBalance 余额不足,账号欠费等。
FailedOperation.InsufficientQuota 套餐包额度不足。
FailedOperation.InvalidAttachName 不支持的附件名称,请检查附件名称是否含有特殊字符,详情请参考附录附件说明。
FailedOperation.InvalidTemplateID 模板ID无效或者不可用。
FailedOperation.MissingEmailContent 缺少发信内容(TemplateData和Simple不能同时为空)。
FailedOperation.NoAttachPermission 没有附件发送权限,请检查。
FailedOperation.NotAuthenticatedSender 发件sender没有经过认证,无法发送。
FailedOperation.ProtocolCheckErr 协议检查错误,请检查协议是否正确。
FailedOperation.SendEmailErr 您的发送遇到问题,请联系腾讯云提交工单沟通原因并解决。
FailedOperation.TemporaryBlocked 因触发了某些规则导致临时Block。
FailedOperation.TooManyAttachments 附件数量太多,单封邮件最多支持10个附件。
FailedOperation.TooManyRecipients 收件人数太多,最多支持同时发送50人。
FailedOperation.UnsupportMailType 不支持的邮箱类型。
FailedOperation.WithOutPermission 未开通自定义发送权限,必须使用模版发送。
FailedOperation.WrongContentJson TemplateData字段格式不正确,请保持为json格式。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.AttachContentIsWrong 附件内容错误,请检查base64内容是否正确。
InvalidParameterValue.EmailAddressIsNULL 收件或者发件地址为空,请检查邮件地址。
InvalidParameterValue.EmailContentIsWrong 邮件内容错误,请检查TEXT/HTML base64是否正确。
LimitExceeded 超过配额限制。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
RequestLimitExceeded 请求的次数超过了频率限制。
ResourceInsufficient 资源不足。
ResourceUnavailable 资源不可用。
UnknownParameter 未知参数错误。
UnsupportedOperation 操作不支持。
目录