tencent cloud

SendEmail
Last updated:2026-01-27 16:34:35
SendEmail
Last updated: 2026-01-27 16:34:35

1. API Description

Domain name for API request: ses.intl.tencentcloudapi.com.

This API is used to send an HTML or TEXT email triggered for authentication or transaction. By default, you can send emails using a template only.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: SendEmail.
Version Yes String Common Params. The value used for this API: 2020-10-02.
Region Yes String Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-singapore.
FromEmailAddress Yes String Sender'S email address. when not using an alias, enter the sender's email address directly, for example: noreply@mail.qcloud.com. to enter a sender alias, follow this format (note that a space must separate the alias and email address): alias+space+. the alias cannot contain a colon (:).
Destination.N Yes Array of String Recipient email address, supports up to 50 recipients in mass sending. note: the email content displays all recipient addresses. for non-mass sending, call the API multiple times to send.
Subject Yes String Email subject.
ReplyToAddresses No String The "reply" email address of the mail. can be filled with an email address where you can receive mail, which can be a personal mailbox. if left empty, the recipient's reply mail will fail to send.
Cc.N No Array of String Cc recipient email address, supports up to 20 carbon copies.
Bcc.N No Array of String Bcc email address, supports up to 20 carbon copies. Bcc and Destination must be unique.
Template No Template Use template for sending and fill in related parameters.
this field must be specified if you have not applied for special configuration..
Simple No Simple This parameter has been deprecated.
only customers who have applied for special configuration in the past need to use this. if you have not applied for special configuration, this field does not exist..
Attachments.N No Array of Attachment When sending an attachment, fill in the related parameters. the tencent cloud API request supports a maximum of 8M request packet. the attachment content transits Base64 and is expected to expand by 1.5 times. you should control the total size of all attachments within 4M. the API will return an error if the overall request exceeds 8M.
Unsubscribe No String Unsubscription link options 0: do not add unsubscription link 1: english 2: simplified chinese 3: traditional chinese 4: spanish 5: french 6: german 7: japanese 8: korean 9: arabic 10: thai.
TriggerType No Integer Mail trigger type. 0: non-trigger class, default type, select this type for marketing emails and non-instant emails. 1: trigger class, instant delivery emails such as captcha-intl. if the mail exceeds a certain size, the system will automatically select the non-trigger class channel.
SmtpMessageId No String Message-Id field in the smtp header.
SmtpHeaders No String Other fields that can be set in the smtp header.
HeaderFrom No String from field in the smtp header. the domain name should be consistent with FromEmailAddress.

3. Output Parameters

Parameter Name Type Description
MessageId String Uniquely generated message identifier for receive message.
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Sending a Rich Text Email

Input Example

POST / HTTP/1.1
Host: ses.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SendEmail
<Common request parameters>

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

Output Example

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

Example2 Send Template Email

Input Example

POST / HTTP/1.1
Host: ses.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SendEmail
<Common request parameters>

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

Output Example

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

Example3 Send Plain Text Email

Input Example

POST / HTTP/1.1
Host: ses.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SendEmail
<Common request parameters>

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

Output Example

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

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation.AttachContentToolarge The attachments are too large. Make sure they do not exceed the size limit for a single attachment and the overall limit for all attachments.
FailedOperation.EmailAddrInBlacklist The email address is in the blocklist.
FailedOperation.EmailContentToolarge The email is too large. Remove some content.
FailedOperation.ExceedSendLimit The number of emails exceeds the daily sending limit.
FailedOperation.FrequencyLimit You have sent too many emails to the same address in a short period.
FailedOperation.HighRejectionRate The email has been blocked temporarily due to high rejection rate.
FailedOperation.IllegalURL Mail contains non-compliant link.
FailedOperation.IncorrectEmail Incorrect email address.
FailedOperation.IncorrectSender Incorrect sender format. Follow the sample in this document.
FailedOperation.InsufficientBalance Insufficient balance or account in arrears.
FailedOperation.InsufficientQuota Insufficient emails in plans.
FailedOperation.InvalidAttachName Unsupported attachment name. please check whether the attachment name contains special characters. for details, see the appendix attachment description (https://www.tencentcloud.comom/document/product/1288/51951?from_cn_redirect=1).
FailedOperation.InvalidTemplateID Invalid template ID or unavailable template.
FailedOperation.MissingEmailContent Missing email content (TemplateData and Simple cannot be both empty).
FailedOperation.NoAttachPermission No permission to send an email with attachments.
FailedOperation.NotAuthenticatedSender Unable to send because the sender is not verified.
FailedOperation.ProtocolCheckErr Incorrect protocol. Make sure the protocol is correct.
FailedOperation.ReceiverHasUnsubscribed The recipient has unsubscribed.
FailedOperation.RejectedByRecipients The message was rejected by the recipient.
FailedOperation.SendEmailErr Email sending error. Please submit a ticket to us for troubleshooting.
FailedOperation.TemporaryBlocked The email push platform will suspend sending emails to the service provider for 10 minutes due to the corresponding recipient service provider's limit. it will be automatically released after 10 minutes.
FailedOperation.TooManyAttachments Too many attachments. A single email supports up to 10 attachments.
FailedOperation.TooManyRecipients Too many recipients. Set a maximum of 50 recipients at a time.
FailedOperation.URLForbidden Forbid users with low delivery rate to include URL webpage links in email content.
FailedOperation.UnsupportMailType Unsupported email type.
FailedOperation.WithOutPermission You can only send emails by using a template.
FailedOperation.WrongContentJson The format of the TemplateData field is incorrect. Make sure it is in JSON format.
InternalError Internal error.
InvalidParameter Incorrect parameter.
InvalidParameterValue Invalid parameter value.
InvalidParameterValue.AttachContentIsWrong Incorrect attachment content. Make sure the base64 content is correct.
InvalidParameterValue.EmailAddressIsNULL The recipient or sender address is empty. Please check.
InvalidParameterValue.EmailContentIsWrong Incorrect email content. Make sure TEXT/HTML base64 is correct.
InvalidParameterValue.InvalidEmailIdentity Invalid domain value.
InvalidParameterValue.ReceiverEmailInvalid The recipient address is incorrect.
LimitExceeded The quota limit is exceeded.
MissingParameter Missing parameter.
OperationDenied Operation denied.
RequestLimitExceeded The number of requests exceeds the frequency limit.
ResourceInsufficient Insufficient resources.
ResourceUnavailable The resource is unavailable.
UnknownParameter Unknown parameter error.
UnsupportedOperation Unsupported operation.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback