com.tencentcloudapi.ses.v20201002.models

Class SendEmailStatus

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.ses.v20201002.models.SendEmailStatus

public class SendEmailStatus
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
SendEmailStatus()
SendEmailStatus(SendEmailStatus source) NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Summary

Modifier and Type	Method and Description
String	getDeliverMessage() Get Description of the recipient processing status
Long	getDeliverStatus() Get Recipient processing status 0: Tencent Cloud has accepted the request and added it to the send queue.
Long	getDeliverTime() Get Timestamp when Tencent Cloud delivers the email
String	getFromEmailAddress() Get Sender email address
String	getMessageId() Get The `MessageId` field returned by the `SendEmail` API
Long	getRequestTime() Get Timestamp when the request arrives at Tencent Cloud
Long	getSendStatus() Get Tencent Cloud processing status 0: Successful.
String	getToEmailAddress() Get Recipient email address
Boolean	getUserClicked() Get Whether the recipient has clicked the links in the email
Boolean	getUserComplainted() Get Whether the recipient has reported the sender
Boolean	getUserOpened() Get Whether the recipient has opened the email
Boolean	getUserUnsubscribed() Get Whether the recipient has unsubscribed from the email sent by the sender
void	setDeliverMessage(String DeliverMessage) Set Description of the recipient processing status
void	setDeliverStatus(Long DeliverStatus) Set Recipient processing status 0: Tencent Cloud has accepted the request and added it to the send queue.
void	setDeliverTime(Long DeliverTime) Set Timestamp when Tencent Cloud delivers the email
void	setFromEmailAddress(String FromEmailAddress) Set Sender email address
void	setMessageId(String MessageId) Set The `MessageId` field returned by the `SendEmail` API
void	setRequestTime(Long RequestTime) Set Timestamp when the request arrives at Tencent Cloud
void	setSendStatus(Long SendStatus) Set Tencent Cloud processing status 0: Successful.
void	setToEmailAddress(String ToEmailAddress) Set Recipient email address
void	setUserClicked(Boolean UserClicked) Set Whether the recipient has clicked the links in the email
void	setUserComplainted(Boolean UserComplainted) Set Whether the recipient has reported the sender
void	setUserOpened(Boolean UserOpened) Set Whether the recipient has opened the email
void	setUserUnsubscribed(Boolean UserUnsubscribed) Set Whether the recipient has unsubscribed from the email sent by the sender
void	toMap(HashMap<String,String> map, String prefix) Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel

any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString

Methods inherited from class java.lang.Object

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

Constructor Detail

SendEmailStatus

public SendEmailStatus()

SendEmailStatus

public SendEmailStatus(SendEmailStatus source)

NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Detail

getMessageId

public String getMessageId()

Get The `MessageId` field returned by the `SendEmail` API

Returns:

MessageId The `MessageId` field returned by the `SendEmail` API

setMessageId

public void setMessageId(String MessageId)

Set The `MessageId` field returned by the `SendEmail` API

Parameters:

MessageId - The `MessageId` field returned by the `SendEmail` API

getToEmailAddress

public String getToEmailAddress()

Get Recipient email address

Returns:

ToEmailAddress Recipient email address

setToEmailAddress

public void setToEmailAddress(String ToEmailAddress)

Set Recipient email address

Parameters:

ToEmailAddress - Recipient email address

getFromEmailAddress

public String getFromEmailAddress()

Get Sender email address

Returns:

FromEmailAddress Sender email address

setFromEmailAddress

public void setFromEmailAddress(String FromEmailAddress)

Set Sender email address

Parameters:

FromEmailAddress - Sender email address

getSendStatus

public Long getSendStatus()

Get Tencent Cloud processing status 0: Successful. 1001: Internal system exception. 1002: Internal system exception. 1003: Internal system exception. 1003: Internal system exception. 1004: Email sending timed out. 1005: Internal system exception. 1006: You have sent too many emails to the same address in a short period. 1007: The email address is in the blocklist. 1008: The sender domain is rejected by the recipient. 1009: Internal system exception. 1010: The daily email sending limit is exceeded. 1011: You have no permission to send custom content. Use a template. 1013: The sender domain is unsubscribed from by the recipient. 2001: No results were found. 3007: The template ID is invalid or the template is unavailable. 3008: The sender domain is temporarily blocked by the recipient domain. 3009: You have no permission to use this template. 3010: The format of the `TemplateData` field is incorrect. 3014: The email cannot be sent because the sender domain is not verified. 3020: The recipient email address is in the blocklist. 3024: Failed to precheck the email address format. 3030: Email sending is restricted temporarily due to a high bounce rate. 3033: The account has insufficient balance or overdue payment.

Returns:

SendStatus Tencent Cloud processing status 0: Successful. 1001: Internal system exception. 1002: Internal system exception. 1003: Internal system exception. 1003: Internal system exception. 1004: Email sending timed out. 1005: Internal system exception. 1006: You have sent too many emails to the same address in a short period. 1007: The email address is in the blocklist. 1008: The sender domain is rejected by the recipient. 1009: Internal system exception. 1010: The daily email sending limit is exceeded. 1011: You have no permission to send custom content. Use a template. 1013: The sender domain is unsubscribed from by the recipient. 2001: No results were found. 3007: The template ID is invalid or the template is unavailable. 3008: The sender domain is temporarily blocked by the recipient domain. 3009: You have no permission to use this template. 3010: The format of the `TemplateData` field is incorrect. 3014: The email cannot be sent because the sender domain is not verified. 3020: The recipient email address is in the blocklist. 3024: Failed to precheck the email address format. 3030: Email sending is restricted temporarily due to a high bounce rate. 3033: The account has insufficient balance or overdue payment.

setSendStatus

public void setSendStatus(Long SendStatus)

Set Tencent Cloud processing status 0: Successful. 1001: Internal system exception. 1002: Internal system exception. 1003: Internal system exception. 1003: Internal system exception. 1004: Email sending timed out. 1005: Internal system exception. 1006: You have sent too many emails to the same address in a short period. 1007: The email address is in the blocklist. 1008: The sender domain is rejected by the recipient. 1009: Internal system exception. 1010: The daily email sending limit is exceeded. 1011: You have no permission to send custom content. Use a template. 1013: The sender domain is unsubscribed from by the recipient. 2001: No results were found. 3007: The template ID is invalid or the template is unavailable. 3008: The sender domain is temporarily blocked by the recipient domain. 3009: You have no permission to use this template. 3010: The format of the `TemplateData` field is incorrect. 3014: The email cannot be sent because the sender domain is not verified. 3020: The recipient email address is in the blocklist. 3024: Failed to precheck the email address format. 3030: Email sending is restricted temporarily due to a high bounce rate. 3033: The account has insufficient balance or overdue payment.

Parameters:

SendStatus - Tencent Cloud processing status 0: Successful. 1001: Internal system exception. 1002: Internal system exception. 1003: Internal system exception. 1003: Internal system exception. 1004: Email sending timed out. 1005: Internal system exception. 1006: You have sent too many emails to the same address in a short period. 1007: The email address is in the blocklist. 1008: The sender domain is rejected by the recipient. 1009: Internal system exception. 1010: The daily email sending limit is exceeded. 1011: You have no permission to send custom content. Use a template. 1013: The sender domain is unsubscribed from by the recipient. 2001: No results were found. 3007: The template ID is invalid or the template is unavailable. 3008: The sender domain is temporarily blocked by the recipient domain. 3009: You have no permission to use this template. 3010: The format of the `TemplateData` field is incorrect. 3014: The email cannot be sent because the sender domain is not verified. 3020: The recipient email address is in the blocklist. 3024: Failed to precheck the email address format. 3030: Email sending is restricted temporarily due to a high bounce rate. 3033: The account has insufficient balance or overdue payment.

getDeliverStatus

public Long getDeliverStatus()

Get Recipient processing status 0: Tencent Cloud has accepted the request and added it to the send queue. 1: The email is delivered successfully. `DeliverTime` indicates the time when the email is delivered successfully. 2: The email is discarded. `DeliverMessage` indicates the reason for discarding. 3: The recipient's ESP rejects the email, probably because the email address does not exist or due to other reasons. 8: The email is delayed by the ESP. `DeliverMessage` indicates the reason for delay.

Returns:

DeliverStatus Recipient processing status 0: Tencent Cloud has accepted the request and added it to the send queue. 1: The email is delivered successfully. `DeliverTime` indicates the time when the email is delivered successfully. 2: The email is discarded. `DeliverMessage` indicates the reason for discarding. 3: The recipient's ESP rejects the email, probably because the email address does not exist or due to other reasons. 8: The email is delayed by the ESP. `DeliverMessage` indicates the reason for delay.

setDeliverStatus

public void setDeliverStatus(Long DeliverStatus)

Set Recipient processing status 0: Tencent Cloud has accepted the request and added it to the send queue. 1: The email is delivered successfully. `DeliverTime` indicates the time when the email is delivered successfully. 2: The email is discarded. `DeliverMessage` indicates the reason for discarding. 3: The recipient's ESP rejects the email, probably because the email address does not exist or due to other reasons. 8: The email is delayed by the ESP. `DeliverMessage` indicates the reason for delay.

Parameters:

DeliverStatus - Recipient processing status 0: Tencent Cloud has accepted the request and added it to the send queue. 1: The email is delivered successfully. `DeliverTime` indicates the time when the email is delivered successfully. 2: The email is discarded. `DeliverMessage` indicates the reason for discarding. 3: The recipient's ESP rejects the email, probably because the email address does not exist or due to other reasons. 8: The email is delayed by the ESP. `DeliverMessage` indicates the reason for delay.

getDeliverMessage

public String getDeliverMessage()

Get Description of the recipient processing status

Returns:

DeliverMessage Description of the recipient processing status

setDeliverMessage

public void setDeliverMessage(String DeliverMessage)

Set Description of the recipient processing status

Parameters:

DeliverMessage - Description of the recipient processing status

getRequestTime

public Long getRequestTime()

Get Timestamp when the request arrives at Tencent Cloud

Returns:

RequestTime Timestamp when the request arrives at Tencent Cloud

setRequestTime

public void setRequestTime(Long RequestTime)

Set Timestamp when the request arrives at Tencent Cloud

Parameters:

RequestTime - Timestamp when the request arrives at Tencent Cloud

getDeliverTime

public Long getDeliverTime()

Get Timestamp when Tencent Cloud delivers the email

Returns:

DeliverTime Timestamp when Tencent Cloud delivers the email

setDeliverTime

public void setDeliverTime(Long DeliverTime)

Set Timestamp when Tencent Cloud delivers the email

Parameters:

DeliverTime - Timestamp when Tencent Cloud delivers the email

getUserOpened

public Boolean getUserOpened()

Get Whether the recipient has opened the email

Returns:

UserOpened Whether the recipient has opened the email

setUserOpened

public void setUserOpened(Boolean UserOpened)

Set Whether the recipient has opened the email

Parameters:

UserOpened - Whether the recipient has opened the email

getUserClicked

public Boolean getUserClicked()

Get Whether the recipient has clicked the links in the email

Returns:

UserClicked Whether the recipient has clicked the links in the email

setUserClicked

public void setUserClicked(Boolean UserClicked)

Set Whether the recipient has clicked the links in the email

Parameters:

UserClicked - Whether the recipient has clicked the links in the email

getUserUnsubscribed

public Boolean getUserUnsubscribed()

Get Whether the recipient has unsubscribed from the email sent by the sender

Returns:

UserUnsubscribed Whether the recipient has unsubscribed from the email sent by the sender

setUserUnsubscribed

public void setUserUnsubscribed(Boolean UserUnsubscribed)

Set Whether the recipient has unsubscribed from the email sent by the sender

Parameters:

UserUnsubscribed - Whether the recipient has unsubscribed from the email sent by the sender

getUserComplainted

public Boolean getUserComplainted()

Get Whether the recipient has reported the sender

Returns:

UserComplainted Whether the recipient has reported the sender

setUserComplainted

public void setUserComplainted(Boolean UserComplainted)

Set Whether the recipient has reported the sender

Parameters:

UserComplainted - Whether the recipient has reported the sender

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel