CreateEmailAddress

Last updated: 2021-02-02 11:44:43

1. API Description

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

After the sender domain is verified, you need a sender address to send emails. For example, if your sender domain is mail.qcloud.com, your sender address can be service@mail.qcloud.com. If you want to display your name (such as "Tencent Cloud") in the inbox list of the recipients, the sender address should be in the format of Tencent Cloud <email address>. Please note that there must be a space between your name and the first angle bracket.

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 parameter. The value used for this API: CreateEmailAddress.
Version Yes String Common parameter. The value used for this API: 2020-10-02.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
EmailAddress Yes String Your sender address. (You can create up to 10 sender addresses for each domain.)
EmailSenderName No String Sender name.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating a sender address

Input Example

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

{"EmailAddress":"service@mail.qcloud.com","EmailSenderName":"Tencent Cloud"}

Output Example

{
  "Response": {
    "RequestId": "8979fc1e-9564-4fc9-bf7d-2958ce679b72"
  }
}

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
InternalError Internal error.
InvalidParameter Incorrect parameter.
InvalidParameterValue Invalid parameter value.
InvalidParameterValue.IllegalEmailAddress Invalid email address. Make sure the address format is correct.
InvalidParameterValue.RepeatEmailAddress This email address already exists. Do not create it again.
LimitExceeded The quota limit is exceeded.
MissingParameter Missing parameter.
OperationDenied Operation denied.
OperationDenied.DomainNotVerified Domain verification failed. Check whether the domain has passed verification.
OperationDenied.ExceedSenderLimit The number of sender addresses exceeds the upper limit.
RequestLimitExceeded The number of requests exceeds the frequency limit.