SesClient (tencentcloud-sdk-java-intl-en 3.0.488 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractClient
- - com.tencentcloudapi.ses.v20201002.SesClient

public class SesClient
extends AbstractClient

字段概要
- 从类继承的字段 com.tencentcloudapi.common.AbstractClient
  gson, HTTP_RSP_OK, SDK_VERSION

构造器概要

构造器
构造器和说明

SesClient(Credential credential, String region)

SesClient(Credential credential, String region, ClientProfile profile)

构造器
构造器和说明
`SesClient(Credential credential, String region)`
`SesClient(Credential credential, String region, ClientProfile profile)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`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 100,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 a TEXT or HTML email triggered for authentication or transaction.
`UpdateEmailIdentityResponse`	`UpdateEmailIdentity(UpdateEmailIdentityRequest req)` This API is used to verify whether your DNS configuration is correct.
`UpdateEmailTemplateResponse`	`UpdateEmailTemplate(UpdateEmailTemplateRequest req)` This API is used to update an email template.

从类继承的方法 com.tencentcloudapi.common.AbstractClient
call, getClientProfile, getCredential, getRegion, internalRequest, setClientProfile, setCredential, setRegion

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - SesClient
```
public SesClient(Credential credential,
                 String region)
```
  - SesClient
```
public SesClient(Credential credential,
                 String region,
                 ClientProfile profile)
```
- 方法详细资料
  - 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. To send custom content, please contact your sales rep to enable this feature. 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.
    
    参数:
    
    req - BatchSendEmailRequest
    
    返回:
    
    BatchSendEmailResponse
    
    抛出:
    
    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.
    
    参数:
    
    req - CreateEmailAddressRequest
    
    返回:
    
    CreateEmailAddressResponse
    
    抛出:
    
    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.
    
    参数:
    
    req - CreateEmailIdentityRequest
    
    返回:
    
    CreateEmailIdentityResponse
    
    抛出:
    
    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.
    
    参数:
    
    req - CreateEmailTemplateRequest
    
    返回:
    
    CreateEmailTemplateResponse
    
    抛出:
    
    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.
    
    参数:
    
    req - CreateReceiverRequest
    
    返回:
    
    CreateReceiverResponse
    
    抛出:
    
    TencentCloudSDKException
  - CreateReceiverDetail
```
public CreateReceiverDetailResponse CreateReceiverDetail(CreateReceiverDetailRequest req)
                                                  throws TencentCloudSDKException
```
    This API is used to add recipient email addresses (up to 100,000 at a time) to a recipient group. This will be processed asynchronously. You can upload recipient email addresses only once. If the data volume is large, it may take some time to upload. You can check the recipient group to learn the upload status and upload quantity.
    
    参数:
    
    req - CreateReceiverDetailRequest
    
    返回:
    
    CreateReceiverDetailResponse
    
    抛出:
    
    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.
    
    参数:
    
    req - DeleteBlackListRequest
    
    返回:
    
    DeleteBlackListResponse
    
    抛出:
    
    TencentCloudSDKException
  - DeleteEmailAddress
```
public DeleteEmailAddressResponse DeleteEmailAddress(DeleteEmailAddressRequest req)
                                              throws TencentCloudSDKException
```
    This API is used to delete a sender address.
    
    参数:
    
    req - DeleteEmailAddressRequest
    
    返回:
    
    DeleteEmailAddressResponse
    
    抛出:
    
    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.
    
    参数:
    
    req - DeleteEmailIdentityRequest
    
    返回:
    
    DeleteEmailIdentityResponse
    
    抛出:
    
    TencentCloudSDKException
  - DeleteEmailTemplate
```
public DeleteEmailTemplateResponse DeleteEmailTemplate(DeleteEmailTemplateRequest req)
                                                throws TencentCloudSDKException
```
    This API is used to delete an email template.
    
    参数:
    
    req - DeleteEmailTemplateRequest
    
    返回:
    
    DeleteEmailTemplateResponse
    
    抛出:
    
    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.
    
    参数:
    
    req - DeleteReceiverRequest
    
    返回:
    
    DeleteReceiverResponse
    
    抛出:
    
    TencentCloudSDKException
  - GetEmailIdentity
```
public GetEmailIdentityResponse GetEmailIdentity(GetEmailIdentityRequest req)
                                          throws TencentCloudSDKException
```
    This API is used to get the configuration details of a sender domain.
    
    参数:
    
    req - GetEmailIdentityRequest
    
    返回:
    
    GetEmailIdentityResponse
    
    抛出:
    
    TencentCloudSDKException
  - GetEmailTemplate
```
public GetEmailTemplateResponse GetEmailTemplate(GetEmailTemplateRequest req)
                                          throws TencentCloudSDKException
```
    This API is used to get the details of a template.
    
    参数:
    
    req - GetEmailTemplateRequest
    
    返回:
    
    GetEmailTemplateResponse
    
    抛出:
    
    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.
    
    参数:
    
    req - GetSendEmailStatusRequest
    
    返回:
    
    GetSendEmailStatusResponse
    
    抛出:
    
    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.
    
    参数:
    
    req - GetStatisticsReportRequest
    
    返回:
    
    GetStatisticsReportResponse
    
    抛出:
    
    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.
    
    参数:
    
    req - ListBlackEmailAddressRequest
    
    返回:
    
    ListBlackEmailAddressResponse
    
    抛出:
    
    TencentCloudSDKException
  - ListEmailAddress
```
public ListEmailAddressResponse ListEmailAddress(ListEmailAddressRequest req)
                                          throws TencentCloudSDKException
```
    This API is used to get the list of sender addresses.
    
    参数:
    
    req - ListEmailAddressRequest
    
    返回:
    
    ListEmailAddressResponse
    
    抛出:
    
    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.
    
    参数:
    
    req - ListEmailIdentitiesRequest
    
    返回:
    
    ListEmailIdentitiesResponse
    
    抛出:
    
    TencentCloudSDKException
  - ListEmailTemplates
```
public ListEmailTemplatesResponse ListEmailTemplates(ListEmailTemplatesRequest req)
                                              throws TencentCloudSDKException
```
    This API is used to get the list of email templates.
    
    参数:
    
    req - ListEmailTemplatesRequest
    
    返回:
    
    ListEmailTemplatesResponse
    
    抛出:
    
    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.
    
    参数:
    
    req - ListReceiversRequest
    
    返回:
    
    ListReceiversResponse
    
    抛出:
    
    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.
    
    参数:
    
    req - ListSendTasksRequest
    
    返回:
    
    ListSendTasksResponse
    
    抛出:
    
    TencentCloudSDKException
  - SendEmail
```
public SendEmailResponse SendEmail(SendEmailRequest req)
                            throws TencentCloudSDKException
```
    This API is used to send a TEXT or HTML email triggered for authentication or transaction. By default, you can send emails using a template only. To send custom content, please contact your sales rep to enable this feature.
    
    参数:
    
    req - SendEmailRequest
    
    返回:
    
    SendEmailResponse
    
    抛出:
    
    TencentCloudSDKException
  - UpdateEmailIdentity
```
public UpdateEmailIdentityResponse UpdateEmailIdentity(UpdateEmailIdentityRequest req)
                                                throws TencentCloudSDKException
```
    This API is used to verify whether your DNS configuration is correct.
    
    参数:
    
    req - UpdateEmailIdentityRequest
    
    返回:
    
    UpdateEmailIdentityResponse
    
    抛出:
    
    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.
    
    参数:
    
    req - UpdateEmailTemplateRequest
    
    返回:
    
    UpdateEmailTemplateResponse
    
    抛出:
    
    TencentCloudSDKException

类 SesClient

字段概要

从类继承的字段 com.tencentcloudapi.common.AbstractClient

构造器概要

方法概要

从类继承的方法 com.tencentcloudapi.common.AbstractClient

从类继承的方法 java.lang.Object

构造器详细资料

SesClient

SesClient

方法详细资料

BatchSendEmail

CreateEmailAddress

CreateEmailIdentity

CreateEmailTemplate

CreateReceiver

CreateReceiverDetail

DeleteBlackList

DeleteEmailAddress

DeleteEmailIdentity

DeleteEmailTemplate

DeleteReceiver

GetEmailIdentity

GetEmailTemplate

GetSendEmailStatus

GetStatisticsReport

ListBlackEmailAddress

ListEmailAddress

ListEmailIdentities

ListEmailTemplates

ListReceivers

ListSendTasks

SendEmail

UpdateEmailIdentity

UpdateEmailTemplate