SesClient (tencentcloud-sdk-java 3.1.898 API)

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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BatchSendEmailResponse`	`BatchSendEmail(BatchSendEmailRequest req)` 您可以通过此API批量发送TEXT或者HTML邮件，适用于营销类、通知类邮件。默认仅支持使用模板发送邮件。批量发送之前，需先创建收件人列表，和收件人地址，并通过收件人列表id来进行发送。批量发送任务支持定时发送和周期重复发送，定时发送需传TimedParam，周期重复发送需传CycleParam
`CreateEmailAddressResponse`	`CreateEmailAddress(CreateEmailAddressRequest req)` 在验证了发信域名之后，您需要一个发信地址来发送邮件。例如发信域名是mail.qcloud.com，那么发信地址可以为 [email protected]。如果您想要收件人在收件箱列表中显示您的别名，例如"腾讯云邮件通知"。那么发信地址为：别名空格尖括号邮箱地址。请注意中间需要有空格
`CreateEmailIdentityResponse`	`CreateEmailIdentity(CreateEmailIdentityRequest req)` 在使用身份发送电子邮件之前，您需要有一个电子邮件域名，该域名可以是您的网站或者移动应用的域名。您首先必须进行验证，证明自己是该域名的所有者，并且授权给腾讯云SES发送许可，才可以从该域名发送电子邮件。
`CreateEmailTemplateResponse`	`CreateEmailTemplate(CreateEmailTemplateRequest req)` 创建模板，该模板可以是TXT或者HTML，请注意如果HTML不要包含外部文件的CSS。模板中的变量使用 {{变量名}} 表示。注意：模板需要审核通过才可以使用。
`CreateReceiverResponse`	`CreateReceiver(CreateReceiverRequest req)` 创建收件人列表，收件人列表是发送批量邮件的目标邮件地址列表。创建列表后，需要上传收件人邮箱地址。之后创建发送任务，关联列表，便可以实现批量发送邮件的功能
`CreateReceiverDetailResponse`	`CreateReceiverDetail(CreateReceiverDetailRequest req)` 在创建完收件人列表后，向这个收件人列表中批量增加收件人邮箱地址，一次最大支持2万，异步完成处理。数据量比较大的时候，上传可能需要一点时间，可以通过查询收件人列表了解上传状态和上传数量。本接口与接口CreateReceiverDetailWithData的功能特性基本一致，只是不支持上传发信时的模板参数。用户首先调用创建收件人列表接口-CreateReceiver后，然后调用本接口传入收件人地址，最后使用批量发送邮件接口-BatchSendEmail，即可完成批量发信。本接口也支持追加收件人地址，也不支持去重，需要用户自己保证收件人地址不重复。本接口一次请求的收件人地址数量限制为2W条，但收件人列表中收件人地址的总量不能超过一定的数量，目前是限制5万条。
`CreateReceiverDetailWithDataResponse`	`CreateReceiverDetailWithData(CreateReceiverDetailWithDataRequest req)` 添加收件人地址附带模板参数，使用本接口在添加收件人地址的同时传入模板参数，使每一个收件人地址在发信的时候使用的模板变量取值不同。用户首先调用创建收件人列表接口-CreateReceiver后，然后调用本接口传入收件人地址和发信时的模板参数，最后使用批量发送邮件接口-BatchSendEmail，即可完成批量发信。需要注意的是在使用本接口后BatchSendEmail接口中的Template参数不需再传。用户也可以在控制台上邮件发送-收件人列表菜单中，通过导入文件的方式，导入收件人地址和模板变量和参数值。本接口一次请求的收件人地址数量限制为2W条，本接口同时也可以用来向已经上传完成的收件人列表追加收件人地址，但收件人列表中收件人地址的总量不能超过一定的数量，目前是限制5万条。本接口不支持去除重复的收件人地址，用户需要自己保证上传和追加地址不重复，不与之前上传的地址重复。
`DeleteBlackListResponse`	`DeleteBlackList(DeleteBlackListRequest req)` 邮箱被拉黑之后，用户如果确认收件邮箱有效或者已经处于激活状态，可以从腾讯云地址库中删除该黑名单之后继续投递。
`DeleteEmailAddressResponse`	`DeleteEmailAddress(DeleteEmailAddressRequest req)` 删除发信人地址
`DeleteEmailIdentityResponse`	`DeleteEmailIdentity(DeleteEmailIdentityRequest req)` 删除发信域名，删除后，将不可再使用该域名进行发信
`DeleteEmailTemplateResponse`	`DeleteEmailTemplate(DeleteEmailTemplateRequest req)` 删除发信模板
`DeleteReceiverResponse`	`DeleteReceiver(DeleteReceiverRequest req)` 根据收件id删除收件人列表,同时删除列表中的所有收件邮箱
`GetEmailIdentityResponse`	`GetEmailIdentity(GetEmailIdentityRequest req)` 获取某个发信域名的配置详情
`GetEmailTemplateResponse`	`GetEmailTemplate(GetEmailTemplateRequest req)` 根据模板ID获取模板详情
`GetSendEmailStatusResponse`	`GetSendEmailStatus(GetSendEmailStatusRequest req)` 获取邮件发送状态。仅支持查询30天之内的数据默认接口请求频率限制：1次/秒
`GetStatisticsReportResponse`	`GetStatisticsReport(GetStatisticsReportRequest req)` 获取近期发送的统计情况，包含发送量、送达率、打开率、退信率等一系列数据。
`ListBlackEmailAddressResponse`	`ListBlackEmailAddress(ListBlackEmailAddressRequest req)` 腾讯云发送的邮件一旦被收件方判断为硬退(Hard Bounce)，腾讯云会拉黑该地址，并不允许所有用户向该地址发送邮件。成为邮箱黑名单。如果业务方确认是误判，可以从黑名单中删除。
`ListEmailAddressResponse`	`ListEmailAddress(ListEmailAddressRequest req)` 获取发信地址列表
`ListEmailIdentitiesResponse`	`ListEmailIdentities(ListEmailIdentitiesRequest req)` 获取当前发信域名列表，包含已验证通过与未验证的域名
`ListEmailTemplatesResponse`	`ListEmailTemplates(ListEmailTemplatesRequest req)` 获取当前邮件模板列表
`ListReceiverDetailsResponse`	`ListReceiverDetails(ListReceiverDetailsRequest req)` 根据收件人列表id查询收件人列表中的所有收件人邮箱地址，分页查询，可以根据收件邮箱地址来过滤查询
`ListReceiversResponse`	`ListReceivers(ListReceiversRequest req)` 根据条件查询收件人列表，支持分页，模糊查询，状态查询
`ListSendTasksResponse`	`ListSendTasks(ListSendTasksRequest req)` 分页查询批量发送邮件任务，包含即时发送任务，定时发送任务，周期重复发送任务，查询发送情况，包括请求数量，已发数量，缓存数量，任务状态等信息
`SendEmailResponse`	`SendEmail(SendEmailRequest req)` 您可以通过此API发送HTML或者TEXT邮件，适用于触发类邮件（验证码、交易类）。默认仅支持使用模板发送邮件。
`UpdateEmailIdentityResponse`	`UpdateEmailIdentity(UpdateEmailIdentityRequest req)` 您已经成功配置好了您的DNS，接下来请求腾讯云验证您的DNS配置是否正确
`UpdateEmailSmtpPassWordResponse`	`UpdateEmailSmtpPassWord(UpdateEmailSmtpPassWordRequest req)` 设置邮箱的smtp密码。若要通过smtp发送邮件，必须为邮箱设置smtp密码。初始时，邮箱没有设置smtp密码，不能使用smtp的方式发送邮件。设置smtp密码后，可以修改密码。
`UpdateEmailTemplateResponse`	`UpdateEmailTemplate(UpdateEmailTemplateRequest req)` 更新邮件模板，更新后需再次审核

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
```
    您可以通过此API批量发送TEXT或者HTML邮件，适用于营销类、通知类邮件。默认仅支持使用模板发送邮件。批量发送之前，需先创建收件人列表，和收件人地址，并通过收件人列表id来进行发送。批量发送任务支持定时发送和周期重复发送，定时发送需传TimedParam，周期重复发送需传CycleParam
    
    Parameters:
    
    req - BatchSendEmailRequest
    
    Returns:
    
    BatchSendEmailResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateEmailAddress
```
public CreateEmailAddressResponse CreateEmailAddress(CreateEmailAddressRequest req)
                                              throws TencentCloudSDKException
```
    在验证了发信域名之后，您需要一个发信地址来发送邮件。例如发信域名是mail.qcloud.com，那么发信地址可以为 [email protected]。如果您想要收件人在收件箱列表中显示您的别名，例如"腾讯云邮件通知"。那么发信地址为：别名空格尖括号邮箱地址。请注意中间需要有空格
    
    Parameters:
    
    req - CreateEmailAddressRequest
    
    Returns:
    
    CreateEmailAddressResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateEmailIdentity
```
public CreateEmailIdentityResponse CreateEmailIdentity(CreateEmailIdentityRequest req)
                                                throws TencentCloudSDKException
```
    在使用身份发送电子邮件之前，您需要有一个电子邮件域名，该域名可以是您的网站或者移动应用的域名。您首先必须进行验证，证明自己是该域名的所有者，并且授权给腾讯云SES发送许可，才可以从该域名发送电子邮件。
    
    Parameters:
    
    req - CreateEmailIdentityRequest
    
    Returns:
    
    CreateEmailIdentityResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateEmailTemplate
```
public CreateEmailTemplateResponse CreateEmailTemplate(CreateEmailTemplateRequest req)
                                                throws TencentCloudSDKException
```
    创建模板，该模板可以是TXT或者HTML，请注意如果HTML不要包含外部文件的CSS。模板中的变量使用 {{变量名}} 表示。注意：模板需要审核通过才可以使用。
    
    Parameters:
    
    req - CreateEmailTemplateRequest
    
    Returns:
    
    CreateEmailTemplateResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateReceiver
```
public CreateReceiverResponse CreateReceiver(CreateReceiverRequest req)
                                      throws TencentCloudSDKException
```
    创建收件人列表，收件人列表是发送批量邮件的目标邮件地址列表。创建列表后，需要上传收件人邮箱地址。之后创建发送任务，关联列表，便可以实现批量发送邮件的功能
    
    Parameters:
    
    req - CreateReceiverRequest
    
    Returns:
    
    CreateReceiverResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateReceiverDetail
```
public CreateReceiverDetailResponse CreateReceiverDetail(CreateReceiverDetailRequest req)
                                                  throws TencentCloudSDKException
```
    在创建完收件人列表后，向这个收件人列表中批量增加收件人邮箱地址，一次最大支持2万，异步完成处理。数据量比较大的时候，上传可能需要一点时间，可以通过查询收件人列表了解上传状态和上传数量。本接口与接口CreateReceiverDetailWithData的功能特性基本一致，只是不支持上传发信时的模板参数。用户首先调用创建收件人列表接口-CreateReceiver后，然后调用本接口传入收件人地址，最后使用批量发送邮件接口-BatchSendEmail，即可完成批量发信。本接口也支持追加收件人地址，也不支持去重，需要用户自己保证收件人地址不重复。本接口一次请求的收件人地址数量限制为2W条，但收件人列表中收件人地址的总量不能超过一定的数量，目前是限制5万条。
    
    Parameters:
    
    req - CreateReceiverDetailRequest
    
    Returns:
    
    CreateReceiverDetailResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateReceiverDetailWithData
```
public CreateReceiverDetailWithDataResponse CreateReceiverDetailWithData(CreateReceiverDetailWithDataRequest req)
                                                                  throws TencentCloudSDKException
```
    添加收件人地址附带模板参数，使用本接口在添加收件人地址的同时传入模板参数，使每一个收件人地址在发信的时候使用的模板变量取值不同。用户首先调用创建收件人列表接口-CreateReceiver后，然后调用本接口传入收件人地址和发信时的模板参数，最后使用批量发送邮件接口-BatchSendEmail，即可完成批量发信。需要注意的是在使用本接口后BatchSendEmail接口中的Template参数不需再传。用户也可以在控制台上邮件发送-收件人列表菜单中，通过导入文件的方式，导入收件人地址和模板变量和参数值。本接口一次请求的收件人地址数量限制为2W条，本接口同时也可以用来向已经上传完成的收件人列表追加收件人地址，但收件人列表中收件人地址的总量不能超过一定的数量，目前是限制5万条。本接口不支持去除重复的收件人地址，用户需要自己保证上传和追加地址不重复，不与之前上传的地址重复。
    
    Parameters:
    
    req - CreateReceiverDetailWithDataRequest
    
    Returns:
    
    CreateReceiverDetailWithDataResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteBlackList
```
public DeleteBlackListResponse DeleteBlackList(DeleteBlackListRequest req)
                                        throws TencentCloudSDKException
```
    邮箱被拉黑之后，用户如果确认收件邮箱有效或者已经处于激活状态，可以从腾讯云地址库中删除该黑名单之后继续投递。
    
    Parameters:
    
    req - DeleteBlackListRequest
    
    Returns:
    
    DeleteBlackListResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteEmailAddress
```
public DeleteEmailAddressResponse DeleteEmailAddress(DeleteEmailAddressRequest req)
                                              throws TencentCloudSDKException
```
    删除发信人地址
    
    Parameters:
    
    req - DeleteEmailAddressRequest
    
    Returns:
    
    DeleteEmailAddressResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteEmailIdentity
```
public DeleteEmailIdentityResponse DeleteEmailIdentity(DeleteEmailIdentityRequest req)
                                                throws TencentCloudSDKException
```
    删除发信域名，删除后，将不可再使用该域名进行发信
    
    Parameters:
    
    req - DeleteEmailIdentityRequest
    
    Returns:
    
    DeleteEmailIdentityResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteEmailTemplate
```
public DeleteEmailTemplateResponse DeleteEmailTemplate(DeleteEmailTemplateRequest req)
                                                throws TencentCloudSDKException
```
    删除发信模板
    
    Parameters:
    
    req - DeleteEmailTemplateRequest
    
    Returns:
    
    DeleteEmailTemplateResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteReceiver
```
public DeleteReceiverResponse DeleteReceiver(DeleteReceiverRequest req)
                                      throws TencentCloudSDKException
```
    根据收件id删除收件人列表,同时删除列表中的所有收件邮箱
    
    Parameters:
    
    req - DeleteReceiverRequest
    
    Returns:
    
    DeleteReceiverResponse
    
    Throws:
    
    TencentCloudSDKException
  - GetEmailIdentity
```
public GetEmailIdentityResponse GetEmailIdentity(GetEmailIdentityRequest req)
                                          throws TencentCloudSDKException
```
    获取某个发信域名的配置详情
    
    Parameters:
    
    req - GetEmailIdentityRequest
    
    Returns:
    
    GetEmailIdentityResponse
    
    Throws:
    
    TencentCloudSDKException
  - GetEmailTemplate
```
public GetEmailTemplateResponse GetEmailTemplate(GetEmailTemplateRequest req)
                                          throws TencentCloudSDKException
```
    根据模板ID获取模板详情
    
    Parameters:
    
    req - GetEmailTemplateRequest
    
    Returns:
    
    GetEmailTemplateResponse
    
    Throws:
    
    TencentCloudSDKException
  - GetSendEmailStatus
```
public GetSendEmailStatusResponse GetSendEmailStatus(GetSendEmailStatusRequest req)
                                              throws TencentCloudSDKException
```
    获取邮件发送状态。仅支持查询30天之内的数据默认接口请求频率限制：1次/秒
    
    Parameters:
    
    req - GetSendEmailStatusRequest
    
    Returns:
    
    GetSendEmailStatusResponse
    
    Throws:
    
    TencentCloudSDKException
  - GetStatisticsReport
```
public GetStatisticsReportResponse GetStatisticsReport(GetStatisticsReportRequest req)
                                                throws TencentCloudSDKException
```
    获取近期发送的统计情况，包含发送量、送达率、打开率、退信率等一系列数据。
    
    Parameters:
    
    req - GetStatisticsReportRequest
    
    Returns:
    
    GetStatisticsReportResponse
    
    Throws:
    
    TencentCloudSDKException
  - ListBlackEmailAddress
```
public ListBlackEmailAddressResponse ListBlackEmailAddress(ListBlackEmailAddressRequest req)
                                                    throws TencentCloudSDKException
```
    腾讯云发送的邮件一旦被收件方判断为硬退(Hard Bounce)，腾讯云会拉黑该地址，并不允许所有用户向该地址发送邮件。成为邮箱黑名单。如果业务方确认是误判，可以从黑名单中删除。
    
    Parameters:
    
    req - ListBlackEmailAddressRequest
    
    Returns:
    
    ListBlackEmailAddressResponse
    
    Throws:
    
    TencentCloudSDKException
  - ListEmailAddress
```
public ListEmailAddressResponse ListEmailAddress(ListEmailAddressRequest req)
                                          throws TencentCloudSDKException
```
    获取发信地址列表
    
    Parameters:
    
    req - ListEmailAddressRequest
    
    Returns:
    
    ListEmailAddressResponse
    
    Throws:
    
    TencentCloudSDKException
  - ListEmailIdentities
```
public ListEmailIdentitiesResponse ListEmailIdentities(ListEmailIdentitiesRequest req)
                                                throws TencentCloudSDKException
```
    获取当前发信域名列表，包含已验证通过与未验证的域名
    
    Parameters:
    
    req - ListEmailIdentitiesRequest
    
    Returns:
    
    ListEmailIdentitiesResponse
    
    Throws:
    
    TencentCloudSDKException
  - ListEmailTemplates
```
public ListEmailTemplatesResponse ListEmailTemplates(ListEmailTemplatesRequest req)
                                              throws TencentCloudSDKException
```
    获取当前邮件模板列表
    
    Parameters:
    
    req - ListEmailTemplatesRequest
    
    Returns:
    
    ListEmailTemplatesResponse
    
    Throws:
    
    TencentCloudSDKException
  - ListReceiverDetails
```
public ListReceiverDetailsResponse ListReceiverDetails(ListReceiverDetailsRequest req)
                                                throws TencentCloudSDKException
```
    根据收件人列表id查询收件人列表中的所有收件人邮箱地址，分页查询，可以根据收件邮箱地址来过滤查询
    
    Parameters:
    
    req - ListReceiverDetailsRequest
    
    Returns:
    
    ListReceiverDetailsResponse
    
    Throws:
    
    TencentCloudSDKException
  - ListReceivers
```
public ListReceiversResponse ListReceivers(ListReceiversRequest req)
                                    throws TencentCloudSDKException
```
    根据条件查询收件人列表，支持分页，模糊查询，状态查询
    
    Parameters:
    
    req - ListReceiversRequest
    
    Returns:
    
    ListReceiversResponse
    
    Throws:
    
    TencentCloudSDKException
  - ListSendTasks
```
public ListSendTasksResponse ListSendTasks(ListSendTasksRequest req)
                                    throws TencentCloudSDKException
```
    分页查询批量发送邮件任务，包含即时发送任务，定时发送任务，周期重复发送任务，查询发送情况，包括请求数量，已发数量，缓存数量，任务状态等信息
    
    Parameters:
    
    req - ListSendTasksRequest
    
    Returns:
    
    ListSendTasksResponse
    
    Throws:
    
    TencentCloudSDKException
  - SendEmail
```
public SendEmailResponse SendEmail(SendEmailRequest req)
                            throws TencentCloudSDKException
```
    您可以通过此API发送HTML或者TEXT邮件，适用于触发类邮件（验证码、交易类）。默认仅支持使用模板发送邮件。
    
    Parameters:
    
    req - SendEmailRequest
    
    Returns:
    
    SendEmailResponse
    
    Throws:
    
    TencentCloudSDKException
  - UpdateEmailIdentity
```
public UpdateEmailIdentityResponse UpdateEmailIdentity(UpdateEmailIdentityRequest req)
                                                throws TencentCloudSDKException
```
    您已经成功配置好了您的DNS，接下来请求腾讯云验证您的DNS配置是否正确
    
    Parameters:
    
    req - UpdateEmailIdentityRequest
    
    Returns:
    
    UpdateEmailIdentityResponse
    
    Throws:
    
    TencentCloudSDKException
  - UpdateEmailSmtpPassWord
```
public UpdateEmailSmtpPassWordResponse UpdateEmailSmtpPassWord(UpdateEmailSmtpPassWordRequest req)
                                                        throws TencentCloudSDKException
```
    设置邮箱的smtp密码。若要通过smtp发送邮件，必须为邮箱设置smtp密码。初始时，邮箱没有设置smtp密码，不能使用smtp的方式发送邮件。设置smtp密码后，可以修改密码。
    
    Parameters:
    
    req - UpdateEmailSmtpPassWordRequest
    
    Returns:
    
    UpdateEmailSmtpPassWordResponse
    
    Throws:
    
    TencentCloudSDKException
  - UpdateEmailTemplate
```
public UpdateEmailTemplateResponse UpdateEmailTemplate(UpdateEmailTemplateRequest req)
                                                throws TencentCloudSDKException
```
    更新邮件模板，更新后需再次审核
    
    Parameters:
    
    req - UpdateEmailTemplateRequest
    
    Returns:
    
    UpdateEmailTemplateResponse
    
    Throws:
    
    TencentCloudSDKException

Class SesClient

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractClient

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractClient

Methods inherited from class java.lang.Object

Constructor Detail

SesClient

SesClient

Method Detail

BatchSendEmail

CreateEmailAddress

CreateEmailIdentity

CreateEmailTemplate

CreateReceiver

CreateReceiverDetail

CreateReceiverDetailWithData

DeleteBlackList

DeleteEmailAddress

DeleteEmailIdentity

DeleteEmailTemplate

DeleteReceiver

GetEmailIdentity

GetEmailTemplate

GetSendEmailStatus

GetStatisticsReport

ListBlackEmailAddress

ListEmailAddress

ListEmailIdentities

ListEmailTemplates

ListReceiverDetails

ListReceivers

ListSendTasks

SendEmail

UpdateEmailIdentity

UpdateEmailSmtpPassWord

UpdateEmailTemplate