Documentation | Tencent Cloud

Recent Pages

Data Types

Last updated: 2021-02-03 19:10:59

Attachment

Attachment structure, including attachment name and content after base64 encoding.

Used by actions: SendEmail.

Name	Type	Required	Description
FileName	String	Yes	Attachment name, which cannot exceed 255 characters. Some attachment types are not supported. For details, see Attachment Types.
Content	String	Yes	Attachment content after base64 encoding. A single attachment cannot exceed 5 MB. Note: Tencent Cloud APIs require that a request packet should not exceed 10 MB. If you are sending multiple attachments, the total size of these attachments cannot exceed 10 MB.

BlackEmailAddress

Email address blocklist structure, including the blocklisted address and the time when it is blocklisted.

Used by actions: ListBlackEmailAddress.

Name	Type	Description
BounceTime	Timestamp	Time when the email address is blocklisted.
EmailAddress	String	Blocklisted email address.

DNSAttributes

Describes the domain name, record type, expected value, and currently configured value of DNS records.

Used by actions: CreateEmailIdentity, GetEmailIdentity, UpdateEmailIdentity.

Name	Type	Description
Type	String	Record types: CNAME, A, TXT, and MX.
SendDomain	String	Domain name.
ExpectedValue	String	Expected value.
CurrentValue	String	Currently configured value.
Status	Boolean	Approved or not. The default value is `false`.

EmailIdentity

Sender domain verification list structure

Used by actions: ListEmailIdentities.

Name	Type	Description
IdentityName	String	Sender domain.
IdentityType	String	Verification type. The value is fixed to `DOMAIN`.
SendingEnabled	Boolean	Verification passed or not.

EmailSender

Describes sender information.

Used by actions: ListEmailAddress.

Name	Type	Description
EmailAddress	String	Sender address.
EmailSenderName	String	Sender name. Note: this field may return `null`, indicating that no valid values can be obtained.
CreatedTimestamp	Integer	Creation time. Note: this field may return `null`, indicating that no valid values can be obtained.

SendEmailStatus

Describes the email sending status.

Used by actions: GetSendEmailStatus.

Name	Type	Description
MessageId	String	`MessageId` field returned by the `SendEmail` API
ToEmailAddress	String	Recipient email address
FromEmailAddress	String	Sender email address
SendStatus	Integer	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 timeout. 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. 1009: internal system exception. 1010: daily email sending limit exceeded. 1011: no permission to send custom content. Use a template. 2001: no results found. 3007: invalid template ID or unavailable template. 3008: template status exception. 3009: no permission to use this template. 3010: the format of the `TemplateData` field is incorrect. 3014: unable to send the email because the sender domain is not verified. 3020: the recipient email address is in the blocklist. 3024: failed to pre-check the email address format. 3030: email sending is restricted temporarily due to high bounce rate. 3033: the account has insufficient balance or overdue payment.
DeliverStatus	Integer	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.
DeliverMessage	String	Description of the recipient processing status
RequestTime	Integer	Timestamp when the request arrives at Tencent Cloud
DeliverTime	Integer	Timestamp when Tencent Cloud delivers the email
UserOpened	Boolean	Whether the recipient has opened the email
UserClicked	Boolean	Whether the recipient has clicked the links in the email
UserUnsubscribed	Boolean	Whether the recipient has unsubscribed from emails sent by the sender
UserComplainted	Boolean	Whether the recipient has reported the sender

Simple

Email content, which can be plain text (TEXT), pure code (HTML), or a combination of TEXT and HTML (recommended).

Used by actions: SendEmail.

Name	Type	Required	Description
Html	String	No	HTML code after base64 encoding. To ensure correct display, this parameter should include all code information and cannot contain external CSS.
Text	String	No	Plain text content after base64 encoding. If HTML is not involved, the plain text will be displayed in the email. Otherwise, this parameter represents the plain text style of the email.

Template

Template information, including template ID, template variable parameters, etc.

Used by actions: SendEmail.

Name	Type	Required	Description
TemplateID	Integer	Yes	Template ID. If you don’t have any template, please create one.
TemplateData	String	Yes	Variable parameters in the template. Please use `json.dump` to format the JSON object into a string type. The object is a set of key-value pairs. Each key denotes a variable, which is represented by {{key}}. The key will be replaced with the corresponding value (represented by {{value}}) when sending the email.

TemplateContent

Template content, which must include at least one of TEXT and HTML. A combination of TEXT and HTML is recommended.

Used by actions: CreateEmailTemplate, GetEmailTemplate, UpdateEmailTemplate.

Name	Type	Required	Description
Html	String	No	HTML code after base64 encoding.
Text	String	No	Text content after base64 encoding.

TemplatesMetadata

Template list structure.

Used by actions: ListEmailTemplates.

Name	Type	Description
CreatedTimestamp	Integer	Creation time.
TemplateName	String	Template name.
TemplateStatus	Integer	Template status. 1: under review; 0: approved; 2: rejected; other values: unavailable.
TemplateID	Integer	Template ID.
ReviewReason	String	Review reply

Volume

Statistics structure.

Used by actions: GetStatisticsReport.

Name	Type	Description
SendDate	Date	Date Note: this field may return `null`, indicating that no valid values can be obtained.
RequestCount	Integer	Number of email requests.
AcceptedCount	Integer	Number of email requests accepted by Tencent Cloud.
DeliveredCount	Integer	Number of delivered emails.
OpenedCount	Integer	Number of users (deduplicated) who opened emails.
ClickedCount	Integer	Number of recipients who clicked on links in emails.
BounceCount	Integer	Number of bounced emails.
UnsubscribeCount	Integer	Number of users who canceled subscriptions. Note: this field may return `null`, indicating that no valid values can be obtained.