com.tencentcloudapi.ses.v20201002

Class SesClient

java.lang.Object

com.tencentcloudapi.common.AbstractClient

com.tencentcloudapi.ses.v20201002.SesClient

public class SesClient
extends AbstractClient

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractClient

gson, HTTP_RSP_OK, SDK_VERSION

Constructor Summary

Constructors

Constructor and Description
SesClient(Credential credential, String region)
SesClient(Credential credential, String region, ClientProfile profile)

Method Summary

Modifier and Type	Method and Description
BatchSendEmailResponse	BatchSendEmail(BatchSendEmailRequest req) This API is used to send a TEXT or HTML email to multiple recipients at a time for marketing or notification purposes.
CreateEmailAddressResponse	CreateEmailAddress(CreateEmailAddressRequest req) After the sender domain is verified, you need a sender address to send emails.
CreateEmailIdentityResponse	CreateEmailIdentity(CreateEmailIdentityRequest req) This API is used to create a sender domain.
CreateEmailTemplateResponse	CreateEmailTemplate(CreateEmailTemplateRequest req) This API is used to create a TEXT or HTML email template.
CreateReceiverResponse	CreateReceiver(CreateReceiverRequest req) This API is used to create a recipient group, which is the list of target email addresses for batch sending emails.
CreateReceiverDetailResponse	CreateReceiverDetail(CreateReceiverDetailRequest req) This API is used to add recipient email addresses (up to 20,000 at a time) to a recipient group.
DeleteBlackListResponse	DeleteBlackList(DeleteBlackListRequest req) This API is used to unblocklist email addresses.
DeleteEmailAddressResponse	DeleteEmailAddress(DeleteEmailAddressRequest req) This API is used to delete a sender address.
DeleteEmailIdentityResponse	DeleteEmailIdentity(DeleteEmailIdentityRequest req) This API is used to delete a sender domain.
DeleteEmailTemplateResponse	DeleteEmailTemplate(DeleteEmailTemplateRequest req) This API is used to delete an email template.
DeleteReceiverResponse	DeleteReceiver(DeleteReceiverRequest req) This API is used to delete a recipient group and all recipient email addresses in the group based on the recipient group ID.
GetEmailIdentityResponse	GetEmailIdentity(GetEmailIdentityRequest req) This API is used to get the configuration details of a sender domain.
GetEmailTemplateResponse	GetEmailTemplate(GetEmailTemplateRequest req) This API is used to get the details of a template.
GetSendEmailStatusResponse	GetSendEmailStatus(GetSendEmailStatusRequest req) This API is used to get email sending status.
GetStatisticsReportResponse	GetStatisticsReport(GetStatisticsReportRequest req) This API is used to get the email sending statistics over a recent period, including data on sent emails, delivery success rate, open rate, bounce rate, and so on.
ListBlackEmailAddressResponse	ListBlackEmailAddress(ListBlackEmailAddressRequest req) The API is used to get blocklisted addresses.
ListEmailAddressResponse	ListEmailAddress(ListEmailAddressRequest req) This API is used to get the list of sender addresses.
ListEmailIdentitiesResponse	ListEmailIdentities(ListEmailIdentitiesRequest req) This API is used to get the list of sender domains, including verified and unverified domains.
ListEmailTemplatesResponse	ListEmailTemplates(ListEmailTemplatesRequest req) This API is used to get the list of email templates.
ListReceiversResponse	ListReceivers(ListReceiversRequest req) This API is used to query recipient groups.
ListSendTasksResponse	ListSendTasks(ListSendTasksRequest req) This API is used to query batch email sending tasks (including immediate, scheduled, and recurring tasks) by page.
SendEmailResponse	SendEmail(SendEmailRequest req) This API is used to send an HTML or TEXT email triggered for authentication or transaction.
UpdateEmailIdentityResponse	UpdateEmailIdentity(UpdateEmailIdentityRequest req) This API is used to verify whether your DNS configuration is correct.
UpdateEmailSmtpPassWordResponse	UpdateEmailSmtpPassWord(UpdateEmailSmtpPassWordRequest req) This API is used to set the SMTP password.
UpdateEmailTemplateResponse	UpdateEmailTemplate(UpdateEmailTemplateRequest req) This API is used to update an email template.

Methods inherited from class com.tencentcloudapi.common.AbstractClient

call, callOctetStream, getClientProfile, getCredential, getRegion, getRegionBreaker, internalRequest, internalRequest, internalRequestRaw, processResponseJson, processResponseSSE, retry, setClientProfile, setCredential, setRegion, setRegionBreaker

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SesClient

public SesClient(Credential credential,
                 String region)

SesClient

public SesClient(Credential credential,
                 String region,
                 ClientProfile profile)

Method Detail

BatchSendEmail

public BatchSendEmailResponse BatchSendEmail(BatchSendEmailRequest req)
                                      throws TencentCloudSDKException

This API is used to send a TEXT or HTML email to multiple recipients at a time for marketing or notification purposes. By default, you can send emails using a template only. You need to create a recipient group with email addresses first and then send emails by group ID. SES supports scheduled and recurring email sending tasks. You need to pass in `TimedParam` for a scheduled task and `CycleParam` for a recurring one.

Parameters:

req - BatchSendEmailRequest

Returns:

BatchSendEmailResponse

Throws:

TencentCloudSDKException

CreateEmailAddress

public CreateEmailAddressResponse CreateEmailAddress(CreateEmailAddressRequest req)
                                              throws TencentCloudSDKException

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 [email protected]. 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 `. Please note that there must be a space between your name and the first angle bracket.

Parameters:

req - CreateEmailAddressRequest

Returns:

CreateEmailAddressResponse

Throws:

TencentCloudSDKException

CreateEmailIdentity

public CreateEmailIdentityResponse CreateEmailIdentity(CreateEmailIdentityRequest req)
                                                throws TencentCloudSDKException

This API is used to create a sender domain. Before you can send an email using Tencent Cloud SES, you must create a sender domain as your identity. It can be the domain of your website or mobile app. You must verify the domain to prove that you own it and authorize Tencent Cloud SES to use it to send emails.

Parameters:

req - CreateEmailIdentityRequest

Returns:

CreateEmailIdentityResponse

Throws:

TencentCloudSDKException

CreateEmailTemplate

public CreateEmailTemplateResponse CreateEmailTemplate(CreateEmailTemplateRequest req)
                                                throws TencentCloudSDKException

This API is used to create a TEXT or HTML email template. To create an HTML template, ensure that it does not include external CSS files. You can use {{variable name}} to specify a variable in the template. Note: Only an approved template can be used to send emails.

Parameters:

req - CreateEmailTemplateRequest

Returns:

CreateEmailTemplateResponse

Throws:

TencentCloudSDKException

CreateReceiver

public CreateReceiverResponse CreateReceiver(CreateReceiverRequest req)
                                      throws TencentCloudSDKException

This API is used to create a recipient group, which is the list of target email addresses for batch sending emails. After creating a group, you need to upload recipient email addresses. Then, you can create a sending task and select the group to batch send emails.

Parameters:

req - CreateReceiverRequest

Returns:

CreateReceiverResponse

Throws:

TencentCloudSDKException

CreateReceiverDetail

public CreateReceiverDetailResponse CreateReceiverDetail(CreateReceiverDetailRequest req)
                                                  throws TencentCloudSDKException

This API is used to add recipient email addresses (up to 20,000 at a time) to a recipient group. This will be processed asynchronously. If the data volume is large, it may take some time to upload. You can check the recipient group for the upload status and upload quantity. This API has basically the same feature as that of `CreateReceiverDetailWithData` except that it doesn't support uploading template parameters for email sending. You need to first call the `CreateReceiver` API to create a recipient group, then call this API to pass in recipient addresses, and finally call the `BatchSendEmail` API to batch send emails. This API supports adding more recipient addresses during upload but not address deduplication, so you need to make sure that the recipient addresses are not duplicate by yourself. This API can request up to 20,000 recipient addresses at a time, but the recipient group can contain up to 50,000 addresses currently.

Parameters:

req - CreateReceiverDetailRequest

Returns:

CreateReceiverDetailResponse

Throws:

TencentCloudSDKException

DeleteBlackList

public DeleteBlackListResponse DeleteBlackList(DeleteBlackListRequest req)
                                        throws TencentCloudSDKException

This API is used to unblocklist email addresses. If you confirm that a blocklisted recipient address is valid and active, you can remove it from Tencent Cloud’s address blocklist database.

Parameters:

req - DeleteBlackListRequest

Returns:

DeleteBlackListResponse

Throws:

TencentCloudSDKException

DeleteEmailAddress

public DeleteEmailAddressResponse DeleteEmailAddress(DeleteEmailAddressRequest req)
                                              throws TencentCloudSDKException

This API is used to delete a sender address.

Parameters:

req - DeleteEmailAddressRequest

Returns:

DeleteEmailAddressResponse

Throws:

TencentCloudSDKException

DeleteEmailIdentity

public DeleteEmailIdentityResponse DeleteEmailIdentity(DeleteEmailIdentityRequest req)
                                                throws TencentCloudSDKException

This API is used to delete a sender domain. After deleted, the sender domain can no longer be used to send emails.

Parameters:

req - DeleteEmailIdentityRequest

Returns:

DeleteEmailIdentityResponse

Throws:

TencentCloudSDKException

DeleteEmailTemplate

public DeleteEmailTemplateResponse DeleteEmailTemplate(DeleteEmailTemplateRequest req)
                                                throws TencentCloudSDKException

This API is used to delete an email template.

Parameters:

req - DeleteEmailTemplateRequest

Returns:

DeleteEmailTemplateResponse

Throws:

TencentCloudSDKException

DeleteReceiver

public DeleteReceiverResponse DeleteReceiver(DeleteReceiverRequest req)
                                      throws TencentCloudSDKException

This API is used to delete a recipient group and all recipient email addresses in the group based on the recipient group ID.

Parameters:

req - DeleteReceiverRequest

Returns:

DeleteReceiverResponse

Throws:

TencentCloudSDKException

GetEmailIdentity

public GetEmailIdentityResponse GetEmailIdentity(GetEmailIdentityRequest req)
                                          throws TencentCloudSDKException

This API is used to get the configuration details of a sender domain.

Parameters:

req - GetEmailIdentityRequest

Returns:

GetEmailIdentityResponse

Throws:

TencentCloudSDKException

GetEmailTemplate

public GetEmailTemplateResponse GetEmailTemplate(GetEmailTemplateRequest req)
                                          throws TencentCloudSDKException

This API is used to get the details of a template.

Parameters:

req - GetEmailTemplateRequest

Returns:

GetEmailTemplateResponse

Throws:

TencentCloudSDKException

GetSendEmailStatus

public GetSendEmailStatusResponse GetSendEmailStatus(GetSendEmailStatusRequest req)
                                              throws TencentCloudSDKException

This API is used to get email sending status. Only data within 30 days can be queried. Default API request rate limit: 1 request/sec.

Parameters:

req - GetSendEmailStatusRequest

Returns:

GetSendEmailStatusResponse

Throws:

TencentCloudSDKException

GetStatisticsReport

public GetStatisticsReportResponse GetStatisticsReport(GetStatisticsReportRequest req)
                                                throws TencentCloudSDKException

This API is used to get the email sending statistics over a recent period, including data on sent emails, delivery success rate, open rate, bounce rate, and so on.

Parameters:

req - GetStatisticsReportRequest

Returns:

GetStatisticsReportResponse

Throws:

TencentCloudSDKException

ListBlackEmailAddress

public ListBlackEmailAddressResponse ListBlackEmailAddress(ListBlackEmailAddressRequest req)
                                                    throws TencentCloudSDKException

The API is used to get blocklisted addresses. In the case of a hard bounce, Tencent Cloud will blocklist the recipient address and do not allow any user to send emails to this address. If you confirm that this is a misjudgment, you can remove it from the blocklist.

Parameters:

req - ListBlackEmailAddressRequest

Returns:

ListBlackEmailAddressResponse

Throws:

TencentCloudSDKException

ListEmailAddress

public ListEmailAddressResponse ListEmailAddress(ListEmailAddressRequest req)
                                          throws TencentCloudSDKException

This API is used to get the list of sender addresses.

Parameters:

req - ListEmailAddressRequest

Returns:

ListEmailAddressResponse

Throws:

TencentCloudSDKException

ListEmailIdentities

public ListEmailIdentitiesResponse ListEmailIdentities(ListEmailIdentitiesRequest req)
                                                throws TencentCloudSDKException

This API is used to get the list of sender domains, including verified and unverified domains.

Parameters:

req - ListEmailIdentitiesRequest

Returns:

ListEmailIdentitiesResponse

Throws:

TencentCloudSDKException

ListEmailTemplates

public ListEmailTemplatesResponse ListEmailTemplates(ListEmailTemplatesRequest req)
                                              throws TencentCloudSDKException

This API is used to get the list of email templates.

Parameters:

req - ListEmailTemplatesRequest

Returns:

ListEmailTemplatesResponse

Throws:

TencentCloudSDKException

ListReceivers

public ListReceiversResponse ListReceivers(ListReceiversRequest req)
                                    throws TencentCloudSDKException

This API is used to query recipient groups. It supports pagination, fuzzy query, and query by status.

Parameters:

req - ListReceiversRequest

Returns:

ListReceiversResponse

Throws:

TencentCloudSDKException

ListSendTasks

public ListSendTasksResponse ListSendTasks(ListSendTasksRequest req)
                                    throws TencentCloudSDKException

This API is used to query batch email sending tasks (including immediate, scheduled, and recurring tasks) by page. You can query task data including the number of emails requested to be sent, the number of sent emails, the number of cached emails, and task status.

Parameters:

req - ListSendTasksRequest

Returns:

ListSendTasksResponse

Throws:

TencentCloudSDKException

SendEmail

public SendEmailResponse SendEmail(SendEmailRequest req)
                            throws TencentCloudSDKException

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.

Parameters:

req - SendEmailRequest

Returns:

SendEmailResponse

Throws:

TencentCloudSDKException

UpdateEmailIdentity

public UpdateEmailIdentityResponse UpdateEmailIdentity(UpdateEmailIdentityRequest req)
                                                throws TencentCloudSDKException

This API is used to verify whether your DNS configuration is correct.

Parameters:

req - UpdateEmailIdentityRequest

Returns:

UpdateEmailIdentityResponse

Throws:

TencentCloudSDKException

UpdateEmailSmtpPassWord

public UpdateEmailSmtpPassWordResponse UpdateEmailSmtpPassWord(UpdateEmailSmtpPassWordRequest req)
                                                        throws TencentCloudSDKException

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.

Parameters:

req - UpdateEmailSmtpPassWordRequest

Returns:

UpdateEmailSmtpPassWordResponse

Throws:

TencentCloudSDKException

UpdateEmailTemplate

public UpdateEmailTemplateResponse UpdateEmailTemplate(UpdateEmailTemplateRequest req)
                                                throws TencentCloudSDKException

This API is used to update an email template. An updated template must be approved again before it can be used.

Parameters:

req - UpdateEmailTemplateRequest

Returns:

UpdateEmailTemplateResponse

Throws:

TencentCloudSDKException