tencent cloud



Last updated: 2023-05-12 16:36:22

1. API Description

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

This API is used to set the SMTP password. Initially, no SMTP password is set for your email address, so emails cannot be sent over SMTP. To send emails over SMTP, you must set the SMTP password. The set password can be changed subsequently.

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: UpdateEmailSmtpPassWord.
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.
Password Yes String SMTP password. Length limit: 64.
EmailAddress Yes String Email address. Length limit: 128.

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 Setting the SMTP password

This example shows you how to set or modify the SMTP password.

Input Example

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

    "Password": "123",
    "EmailAddress": "abc@ef.com"

Output Example

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

5. Developer Resources


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.
InvalidParameterValue.InvalidSmtpPassWord The password can contain 10-20 characters and must contain at least 2 unique digits, lowercase letters, and uppercase letters.
InvalidParameterValue.NoSuchSender You don’t have the sender address. Check if it exists.
OperationDenied.RepeatPassWord The password cannot be the same as the last set password.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support