v20201002

package
v3.0.312+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 27, 2021 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

View Source 
const (

	// The attachments are too large. Make sure they do not exceed the size limit for a single attachment and the overall limit for all attachments.
	FAILEDOPERATION_ATTACHCONTENTTOOLARGE = "FailedOperation.AttachContentToolarge"

	// The email address is in the blocklist.
	FAILEDOPERATION_EMAILADDRINBLACKLIST = "FailedOperation.EmailAddrInBlacklist"

	// The email is too large. Remove some content.
	FAILEDOPERATION_EMAILCONTENTTOOLARGE = "FailedOperation.EmailContentToolarge"

	// The number of emails exceeds the daily sending limit.
	FAILEDOPERATION_EXCEEDSENDLIMIT = "FailedOperation.ExceedSendLimit"

	// The number of templates exceeds the upper limit.
	FAILEDOPERATION_EXCEEDTEMPLATELIMIT = "FailedOperation.ExceedTemplateLimit"

	// You have sent too many emails to the same address in a short period.
	FAILEDOPERATION_FREQUENCYLIMIT = "FailedOperation.FrequencyLimit"

	// The email has been blocked temporarily due to high rejection rate.
	FAILEDOPERATION_HIGHREJECTIONRATE = "FailedOperation.HighRejectionRate"

	// Incorrect email address.
	FAILEDOPERATION_INCORRECTEMAIL = "FailedOperation.IncorrectEmail"

	// Insufficient balance or account in arrears.
	FAILEDOPERATION_INSUFFICIENTBALANCE = "FailedOperation.InsufficientBalance"

	// Insufficient emails in plans.
	FAILEDOPERATION_INSUFFICIENTQUOTA = "FailedOperation.InsufficientQuota"

	// Unsupported attachment name. Make sure it does not contain special characters. For details, see the attachment description.
	FAILEDOPERATION_INVALIDATTACHNAME = "FailedOperation.InvalidAttachName"

	// Reached the query limit (100).
	FAILEDOPERATION_INVALIDLIMIT = "FailedOperation.InvalidLimit"

	// Invalid template ID or unavailable template.
	FAILEDOPERATION_INVALIDTEMPLATEID = "FailedOperation.InvalidTemplateID"

	//
	FAILEDOPERATION_MISSINGEMAILCONTENT = "FailedOperation.MissingEmailContent"

	// No permission to send an email with attachments.
	FAILEDOPERATION_NOATTACHPERMISSION = "FailedOperation.NoAttachPermission"

	// Unable to send because the sender is not verified.
	FAILEDOPERATION_NOTAUTHENTICATEDSENDER = "FailedOperation.NotAuthenticatedSender"

	// Cannot query email records for this date. Only data within 90 days can be queried.
	FAILEDOPERATION_NOTSUPPORTDATE = "FailedOperation.NotSupportDate"

	// Incorrect protocol. Make sure the protocol is correct.
	FAILEDOPERATION_PROTOCOLCHECKERR = "FailedOperation.ProtocolCheckErr"

	// The request has not taken effect. Try again.
	FAILEDOPERATION_SERVICENOTAVAILABLE = "FailedOperation.ServiceNotAvailable"

	// The template is too large. Remove some content.
	FAILEDOPERATION_TEMPLATECONTENTTOOLARGE = "FailedOperation.TemplateContentToolarge"

	// The email has been blocked temporarily due to violations of rules.
	FAILEDOPERATION_TEMPORARYBLOCKED = "FailedOperation.TemporaryBlocked"

	// Too many attachments. A single email supports up to 10 attachments.
	FAILEDOPERATION_TOOMANYATTACHMENTS = "FailedOperation.TooManyAttachments"

	// Too many recipients. Set a maximum of 50 recipients at a time.
	FAILEDOPERATION_TOOMANYRECIPIENTS = "FailedOperation.TooManyRecipients"

	// Unsupported email type.
	FAILEDOPERATION_UNSUPPORTMAILTYPE = "FailedOperation.UnsupportMailType"

	// The feature of sending custom emails is not enabled. Use a template to send emails.
	FAILEDOPERATION_WITHOUTPERMISSION = "FailedOperation.WithOutPermission"

	// The format of the `TemplateData` field is incorrect. Make sure it is in JSON format.
	FAILEDOPERATION_WRONGCONTENTJSON = "FailedOperation.WrongContentJson"

	// Internal error.
	INTERNALERROR = "InternalError"

	// Incorrect parameter.
	INVALIDPARAMETER = "InvalidParameter"

	// Invalid parameter value.
	INVALIDPARAMETERVALUE = "InvalidParameterValue"

	// Incorrect attachment content. Make sure the base64 content is correct.
	INVALIDPARAMETERVALUE_ATTACHCONTENTISWRONG = "InvalidParameterValue.AttachContentIsWrong"

	// This sender domain has been created by another Tencent Cloud account.
	INVALIDPARAMETERVALUE_CREATEDBYOTHER = "InvalidParameterValue.CreatedByOther"

	// The recipient or sender address is empty. Please check.
	INVALIDPARAMETERVALUE_EMAILADDRESSISNULL = "InvalidParameterValue.EmailAddressIsNULL"

	// Incorrect email content. Make sure TEXT/HTML base64 is correct.
	INVALIDPARAMETERVALUE_EMAILCONTENTISWRONG = "InvalidParameterValue.EmailContentIsWrong"

	// Invalid email address. Make sure the address format is correct.
	INVALIDPARAMETERVALUE_ILLEGALEMAILADDRESS = "InvalidParameterValue.IllegalEmailAddress"

	// Invalid domain value.
	INVALIDPARAMETERVALUE_INVALIDEMAILIDENTITY = "InvalidParameterValue.InvalidEmailIdentity"

	// You don’t have the sender address. Check if it exists.
	INVALIDPARAMETERVALUE_NOSUCHSENDER = "InvalidParameterValue.NoSuchSender"

	// This sender domain does not exist. Create it first.
	INVALIDPARAMETERVALUE_NOTEXISTDOMAIN = "InvalidParameterValue.NotExistDomain"

	// This sender domain already exists. Do not create it again.
	INVALIDPARAMETERVALUE_REPEATCREATION = "InvalidParameterValue.RepeatCreation"

	// This email address already exists. Do not create it again.
	INVALIDPARAMETERVALUE_REPEATEMAILADDRESS = "InvalidParameterValue.RepeatEmailAddress"

	// The template resource is empty.
	INVALIDPARAMETERVALUE_TEMPLATECONTENTISNULL = "InvalidParameterValue.TemplateContentIsNULL"

	// Incorrect template content. Make sure the base64 content is correct.
	INVALIDPARAMETERVALUE_TEMPLATECONTENTISWRONG = "InvalidParameterValue.TemplateContentIsWrong"

	// Invalid template name. Make sure the characters and length of the template name are valid.
	INVALIDPARAMETERVALUE_TEMPLATENAMEILLEGAL = "InvalidParameterValue.TemplateNameIllegal"

	// Template name cannot be empty.
	INVALIDPARAMETERVALUE_TEMPLATENAMEISNULL = "InvalidParameterValue.TemplateNameIsNULL"

	// This template does not exist. Create one first.
	INVALIDPARAMETERVALUE_TEMPLATENOTEXIST = "InvalidParameterValue.TemplateNotExist"

	// Incorrect search date. Make sure the date and its format are valid.
	INVALIDPARAMETERVALUE_WRONGDATE = "InvalidParameterValue.WrongDate"

	// The quota limit is exceeded.
	LIMITEXCEEDED = "LimitExceeded"

	// Missing parameter.
	MISSINGPARAMETER = "MissingParameter"

	// Operation denied.
	OPERATIONDENIED = "OperationDenied"

	// Domain verification failed. Check whether the domain has passed verification.
	OPERATIONDENIED_DOMAINNOTVERIFIED = "OperationDenied.DomainNotVerified"

	// The number of sender domains exceeds the upper limit.
	OPERATIONDENIED_EXCEEDDOMAINLIMIT = "OperationDenied.ExceedDomainLimit"

	// The number of sender addresses exceeds the upper limit.
	OPERATIONDENIED_EXCEEDSENDERLIMIT = "OperationDenied.ExceedSenderLimit"

	// The number of requests exceeds the frequency limit.
	REQUESTLIMITEXCEEDED = "RequestLimitExceeded"

	// Insufficient resources.
	RESOURCEINSUFFICIENT = "ResourceInsufficient"

	// The resource does not exist.
	RESOURCENOTFOUND = "ResourceNotFound"

	// The resource is unavailable.
	RESOURCEUNAVAILABLE = "ResourceUnavailable"

	// Unknown parameter error.
	UNKNOWNPARAMETER = "UnknownParameter"

	// Unsupported operation.
	UNSUPPORTEDOPERATION = "UnsupportedOperation"
)
View Source 
const APIVersion = "2020-10-02"

Variables

This section is empty.

Functions

This section is empty.

Types

type Attachment 

type Attachment struct {

	// Attachment name, which cannot exceed 255 characters. Some attachment types are not supported. For details, see [Attachment Types](https://intl.cloud.tencent.com/document/product/1288/51951?from_cn_redirect=1).
	FileName *string `json:"FileName,omitempty" name:"FileName"`

	// 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.
	Content *string `json:"Content,omitempty" name:"Content"`
}

type BlackEmailAddress 

type BlackEmailAddress struct {

	// Time when the email address is blocklisted.
	BounceTime *string `json:"BounceTime,omitempty" name:"BounceTime"`

	// Blocklisted email address.
	EmailAddress *string `json:"EmailAddress,omitempty" name:"EmailAddress"`
}

type Client 

type Client struct {
	common.Client
}

func NewClient 

func NewClient(credential common.CredentialIface, region string, clientProfile *profile.ClientProfile) (client *Client, err error)

func NewClientWithSecretId 

func NewClientWithSecretId(secretId, secretKey, region string) (client *Client, err error)

Deprecated

func (*Client) CreateEmailAddress 

func (c *Client) CreateEmailAddress(request *CreateEmailAddressRequest) (response *CreateEmailAddressResponse, err error)

CreateEmailAddress 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 service@mail.qcloud.com. 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 <email address>`. Please note that there must be a space between your name and the first angle bracket.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_ILLEGALEMAILADDRESS = "InvalidParameterValue.IllegalEmailAddress"
INVALIDPARAMETERVALUE_REPEATEMAILADDRESS = "InvalidParameterValue.RepeatEmailAddress"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_DOMAINNOTVERIFIED = "OperationDenied.DomainNotVerified"
OPERATIONDENIED_EXCEEDSENDERLIMIT = "OperationDenied.ExceedSenderLimit"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"

func (*Client) CreateEmailIdentity 

func (c *Client) CreateEmailIdentity(request *CreateEmailIdentityRequest) (response *CreateEmailIdentityResponse, err error)

CreateEmailIdentity 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.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_CREATEDBYOTHER = "InvalidParameterValue.CreatedByOther"
INVALIDPARAMETERVALUE_INVALIDEMAILIDENTITY = "InvalidParameterValue.InvalidEmailIdentity"
INVALIDPARAMETERVALUE_REPEATCREATION = "InvalidParameterValue.RepeatCreation"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_EXCEEDDOMAINLIMIT = "OperationDenied.ExceedDomainLimit"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"

func (*Client) CreateEmailTemplate 

func (c *Client) CreateEmailTemplate(request *CreateEmailTemplateRequest) (response *CreateEmailTemplateResponse, err error)

CreateEmailTemplate 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.

error code that may be returned: 

FAILEDOPERATION_EXCEEDTEMPLATELIMIT = "FailedOperation.ExceedTemplateLimit"
FAILEDOPERATION_TEMPLATECONTENTTOOLARGE = "FailedOperation.TemplateContentToolarge"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_TEMPLATECONTENTISNULL = "InvalidParameterValue.TemplateContentIsNULL"
INVALIDPARAMETERVALUE_TEMPLATECONTENTISWRONG = "InvalidParameterValue.TemplateContentIsWrong"
INVALIDPARAMETERVALUE_TEMPLATENAMEILLEGAL = "InvalidParameterValue.TemplateNameIllegal"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"

func (*Client) DeleteBlackList 

func (c *Client) DeleteBlackList(request *DeleteBlackListRequest) (response *DeleteBlackListResponse, err error)

DeleteBlackList 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.

error code that may be returned: 

INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"

func (*Client) DeleteEmailAddress 

func (c *Client) DeleteEmailAddress(request *DeleteEmailAddressRequest) (response *DeleteEmailAddressResponse, err error)

DeleteEmailAddress This API is used to delete a sender address.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_NOSUCHSENDER = "InvalidParameterValue.NoSuchSender"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"

func (*Client) DeleteEmailIdentity 

func (c *Client) DeleteEmailIdentity(request *DeleteEmailIdentityRequest) (response *DeleteEmailIdentityResponse, err error)

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

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"

func (*Client) DeleteEmailTemplate 

func (c *Client) DeleteEmailTemplate(request *DeleteEmailTemplateRequest) (response *DeleteEmailTemplateResponse, err error)

DeleteEmailTemplate This API is used to delete an email template.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"

func (*Client) GetEmailIdentity 

func (c *Client) GetEmailIdentity(request *GetEmailIdentityRequest) (response *GetEmailIdentityResponse, err error)

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

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_NOTEXISTDOMAIN = "InvalidParameterValue.NotExistDomain"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"

func (*Client) GetEmailTemplate 

func (c *Client) GetEmailTemplate(request *GetEmailTemplateRequest) (response *GetEmailTemplateResponse, err error)

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

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_TEMPLATENOTEXIST = "InvalidParameterValue.TemplateNotExist"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) GetSendEmailStatus 

func (c *Client) GetSendEmailStatus(request *GetSendEmailStatusRequest) (response *GetSendEmailStatusResponse, err error)

GetSendEmailStatus This API is used to get email sending status. Only data within 90 days can be queried.

error code that may be returned: 

FAILEDOPERATION_EMAILADDRINBLACKLIST = "FailedOperation.EmailAddrInBlacklist"
FAILEDOPERATION_EMAILCONTENTTOOLARGE = "FailedOperation.EmailContentToolarge"
FAILEDOPERATION_EXCEEDSENDLIMIT = "FailedOperation.ExceedSendLimit"
FAILEDOPERATION_FREQUENCYLIMIT = "FailedOperation.FrequencyLimit"
FAILEDOPERATION_HIGHREJECTIONRATE = "FailedOperation.HighRejectionRate"
FAILEDOPERATION_INCORRECTEMAIL = "FailedOperation.IncorrectEmail"
FAILEDOPERATION_INSUFFICIENTBALANCE = "FailedOperation.InsufficientBalance"
FAILEDOPERATION_INSUFFICIENTQUOTA = "FailedOperation.InsufficientQuota"
FAILEDOPERATION_INVALIDLIMIT = "FailedOperation.InvalidLimit"
FAILEDOPERATION_INVALIDTEMPLATEID = "FailedOperation.InvalidTemplateID"
FAILEDOPERATION_NOTAUTHENTICATEDSENDER = "FailedOperation.NotAuthenticatedSender"
FAILEDOPERATION_NOTSUPPORTDATE = "FailedOperation.NotSupportDate"
FAILEDOPERATION_PROTOCOLCHECKERR = "FailedOperation.ProtocolCheckErr"
FAILEDOPERATION_TEMPORARYBLOCKED = "FailedOperation.TemporaryBlocked"
FAILEDOPERATION_TOOMANYRECIPIENTS = "FailedOperation.TooManyRecipients"
FAILEDOPERATION_UNSUPPORTMAILTYPE = "FailedOperation.UnsupportMailType"
FAILEDOPERATION_WITHOUTPERMISSION = "FailedOperation.WithOutPermission"
FAILEDOPERATION_WRONGCONTENTJSON = "FailedOperation.WrongContentJson"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_EMAILADDRESSISNULL = "InvalidParameterValue.EmailAddressIsNULL"
INVALIDPARAMETERVALUE_EMAILCONTENTISWRONG = "InvalidParameterValue.EmailContentIsWrong"
INVALIDPARAMETERVALUE_WRONGDATE = "InvalidParameterValue.WrongDate"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) GetStatisticsReport 

func (c *Client) GetStatisticsReport(request *GetStatisticsReportRequest) (response *GetStatisticsReportResponse, err error)

GetStatisticsReport 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. The maximum time span is 14 days.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_WRONGDATE = "InvalidParameterValue.WrongDate"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"

func (*Client) ListBlackEmailAddress 

func (c *Client) ListBlackEmailAddress(request *ListBlackEmailAddressRequest) (response *ListBlackEmailAddressResponse, err error)

ListBlackEmailAddress 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.

error code that may be returned: 

FAILEDOPERATION_INVALIDLIMIT = "FailedOperation.InvalidLimit"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_WRONGDATE = "InvalidParameterValue.WrongDate"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"

func (*Client) ListEmailAddress 

func (c *Client) ListEmailAddress(request *ListEmailAddressRequest) (response *ListEmailAddressResponse, err error)

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

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"

func (*Client) ListEmailIdentities 

func (c *Client) ListEmailIdentities(request *ListEmailIdentitiesRequest) (response *ListEmailIdentitiesResponse, err error)

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

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"

func (*Client) ListEmailTemplates 

func (c *Client) ListEmailTemplates(request *ListEmailTemplatesRequest) (response *ListEmailTemplatesResponse, err error)

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

error code that may be returned: 

FAILEDOPERATION_INVALIDLIMIT = "FailedOperation.InvalidLimit"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"

func (*Client) SendEmail 

func (c *Client) SendEmail(request *SendEmailRequest) (response *SendEmailResponse, err error)

SendEmail This API is used to send a TEXT or HTML email. By default, you can only send emails using a template. To send custom content, please contact your sales rep to enable this feature.

error code that may be returned: 

FAILEDOPERATION_ATTACHCONTENTTOOLARGE = "FailedOperation.AttachContentToolarge"
FAILEDOPERATION_EMAILADDRINBLACKLIST = "FailedOperation.EmailAddrInBlacklist"
FAILEDOPERATION_EMAILCONTENTTOOLARGE = "FailedOperation.EmailContentToolarge"
FAILEDOPERATION_EXCEEDSENDLIMIT = "FailedOperation.ExceedSendLimit"
FAILEDOPERATION_FREQUENCYLIMIT = "FailedOperation.FrequencyLimit"
FAILEDOPERATION_HIGHREJECTIONRATE = "FailedOperation.HighRejectionRate"
FAILEDOPERATION_INCORRECTEMAIL = "FailedOperation.IncorrectEmail"
FAILEDOPERATION_INSUFFICIENTBALANCE = "FailedOperation.InsufficientBalance"
FAILEDOPERATION_INSUFFICIENTQUOTA = "FailedOperation.InsufficientQuota"
FAILEDOPERATION_INVALIDATTACHNAME = "FailedOperation.InvalidAttachName"
FAILEDOPERATION_INVALIDTEMPLATEID = "FailedOperation.InvalidTemplateID"
FAILEDOPERATION_MISSINGEMAILCONTENT = "FailedOperation.MissingEmailContent"
FAILEDOPERATION_NOATTACHPERMISSION = "FailedOperation.NoAttachPermission"
FAILEDOPERATION_NOTAUTHENTICATEDSENDER = "FailedOperation.NotAuthenticatedSender"
FAILEDOPERATION_PROTOCOLCHECKERR = "FailedOperation.ProtocolCheckErr"
FAILEDOPERATION_TEMPORARYBLOCKED = "FailedOperation.TemporaryBlocked"
FAILEDOPERATION_TOOMANYATTACHMENTS = "FailedOperation.TooManyAttachments"
FAILEDOPERATION_TOOMANYRECIPIENTS = "FailedOperation.TooManyRecipients"
FAILEDOPERATION_UNSUPPORTMAILTYPE = "FailedOperation.UnsupportMailType"
FAILEDOPERATION_WITHOUTPERMISSION = "FailedOperation.WithOutPermission"
FAILEDOPERATION_WRONGCONTENTJSON = "FailedOperation.WrongContentJson"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_ATTACHCONTENTISWRONG = "InvalidParameterValue.AttachContentIsWrong"
INVALIDPARAMETERVALUE_EMAILADDRESSISNULL = "InvalidParameterValue.EmailAddressIsNULL"
INVALIDPARAMETERVALUE_EMAILCONTENTISWRONG = "InvalidParameterValue.EmailContentIsWrong"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) UpdateEmailIdentity 

func (c *Client) UpdateEmailIdentity(request *UpdateEmailIdentityRequest) (response *UpdateEmailIdentityResponse, err error)

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

error code that may be returned: 

FAILEDOPERATION_SERVICENOTAVAILABLE = "FailedOperation.ServiceNotAvailable"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_NOTEXISTDOMAIN = "InvalidParameterValue.NotExistDomain"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"

func (*Client) UpdateEmailTemplate 

func (c *Client) UpdateEmailTemplate(request *UpdateEmailTemplateRequest) (response *UpdateEmailTemplateResponse, err error)

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

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_TEMPLATECONTENTISNULL = "InvalidParameterValue.TemplateContentIsNULL"
INVALIDPARAMETERVALUE_TEMPLATECONTENTISWRONG = "InvalidParameterValue.TemplateContentIsWrong"
INVALIDPARAMETERVALUE_TEMPLATENAMEILLEGAL = "InvalidParameterValue.TemplateNameIllegal"
INVALIDPARAMETERVALUE_TEMPLATENAMEISNULL = "InvalidParameterValue.TemplateNameIsNULL"
INVALIDPARAMETERVALUE_TEMPLATENOTEXIST = "InvalidParameterValue.TemplateNotExist"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"

type CreateEmailAddressRequest 

type CreateEmailAddressRequest struct {
	*tchttp.BaseRequest

	// Your sender address. (You can create up to 10 sender addresses for each domain.)
	EmailAddress *string `json:"EmailAddress,omitempty" name:"EmailAddress"`

	// Sender name.
	EmailSenderName *string `json:"EmailSenderName,omitempty" name:"EmailSenderName"`
}

func NewCreateEmailAddressRequest 

func NewCreateEmailAddressRequest() (request *CreateEmailAddressRequest)

func (*CreateEmailAddressRequest) FromJsonString 

func (r *CreateEmailAddressRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateEmailAddressRequest) ToJsonString 

func (r *CreateEmailAddressRequest) ToJsonString() string

type CreateEmailAddressResponse 

type CreateEmailAddressResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewCreateEmailAddressResponse 

func NewCreateEmailAddressResponse() (response *CreateEmailAddressResponse)

func (*CreateEmailAddressResponse) FromJsonString 

func (r *CreateEmailAddressResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateEmailAddressResponse) ToJsonString 

func (r *CreateEmailAddressResponse) ToJsonString() string

type CreateEmailIdentityRequest 

type CreateEmailIdentityRequest struct {
	*tchttp.BaseRequest

	// Your sender domain. You are advised to use a third-level domain, for example, mail.qcloud.com.
	EmailIdentity *string `json:"EmailIdentity,omitempty" name:"EmailIdentity"`
}

func NewCreateEmailIdentityRequest 

func NewCreateEmailIdentityRequest() (request *CreateEmailIdentityRequest)

func (*CreateEmailIdentityRequest) FromJsonString 

func (r *CreateEmailIdentityRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateEmailIdentityRequest) ToJsonString 

func (r *CreateEmailIdentityRequest) ToJsonString() string

type CreateEmailIdentityResponse 

type CreateEmailIdentityResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Verification type. The value is fixed to `DOMAIN`.
		IdentityType *string `json:"IdentityType,omitempty" name:"IdentityType"`

		// Verification passed or not.
		VerifiedForSendingStatus *bool `json:"VerifiedForSendingStatus,omitempty" name:"VerifiedForSendingStatus"`

		// DNS information that needs to be configured.
		Attributes []*DNSAttributes `json:"Attributes,omitempty" name:"Attributes"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewCreateEmailIdentityResponse 

func NewCreateEmailIdentityResponse() (response *CreateEmailIdentityResponse)

func (*CreateEmailIdentityResponse) FromJsonString 

func (r *CreateEmailIdentityResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateEmailIdentityResponse) ToJsonString 

func (r *CreateEmailIdentityResponse) ToJsonString() string

type CreateEmailTemplateRequest 

type CreateEmailTemplateRequest struct {
	*tchttp.BaseRequest

	// Template name.
	TemplateName *string `json:"TemplateName,omitempty" name:"TemplateName"`

	// Template content.
	TemplateContent *TemplateContent `json:"TemplateContent,omitempty" name:"TemplateContent"`
}

func NewCreateEmailTemplateRequest 

func NewCreateEmailTemplateRequest() (request *CreateEmailTemplateRequest)

func (*CreateEmailTemplateRequest) FromJsonString 

func (r *CreateEmailTemplateRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateEmailTemplateRequest) ToJsonString 

func (r *CreateEmailTemplateRequest) ToJsonString() string

type CreateEmailTemplateResponse 

type CreateEmailTemplateResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewCreateEmailTemplateResponse 

func NewCreateEmailTemplateResponse() (response *CreateEmailTemplateResponse)

func (*CreateEmailTemplateResponse) FromJsonString 

func (r *CreateEmailTemplateResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateEmailTemplateResponse) ToJsonString 

func (r *CreateEmailTemplateResponse) ToJsonString() string

type DNSAttributes 

type DNSAttributes struct {

	// Record types: CNAME, A, TXT, and MX.
	Type *string `json:"Type,omitempty" name:"Type"`

	// Domain name.
	SendDomain *string `json:"SendDomain,omitempty" name:"SendDomain"`

	// Expected value.
	ExpectedValue *string `json:"ExpectedValue,omitempty" name:"ExpectedValue"`

	// Currently configured value.
	CurrentValue *string `json:"CurrentValue,omitempty" name:"CurrentValue"`

	// Approved or not. The default value is `false`.
	Status *bool `json:"Status,omitempty" name:"Status"`
}

type DeleteBlackListRequest 

type DeleteBlackListRequest struct {
	*tchttp.BaseRequest

	// List of email addresses to be unblocklisted. Enter at least one address.
	EmailAddressList []*string `json:"EmailAddressList,omitempty" name:"EmailAddressList"`
}

func NewDeleteBlackListRequest 

func NewDeleteBlackListRequest() (request *DeleteBlackListRequest)

func (*DeleteBlackListRequest) FromJsonString 

func (r *DeleteBlackListRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteBlackListRequest) ToJsonString 

func (r *DeleteBlackListRequest) ToJsonString() string

type DeleteBlackListResponse 

type DeleteBlackListResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDeleteBlackListResponse 

func NewDeleteBlackListResponse() (response *DeleteBlackListResponse)

func (*DeleteBlackListResponse) FromJsonString 

func (r *DeleteBlackListResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteBlackListResponse) ToJsonString 

func (r *DeleteBlackListResponse) ToJsonString() string

type DeleteEmailAddressRequest 

type DeleteEmailAddressRequest struct {
	*tchttp.BaseRequest

	// Sender address.
	EmailAddress *string `json:"EmailAddress,omitempty" name:"EmailAddress"`
}

func NewDeleteEmailAddressRequest 

func NewDeleteEmailAddressRequest() (request *DeleteEmailAddressRequest)

func (*DeleteEmailAddressRequest) FromJsonString 

func (r *DeleteEmailAddressRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteEmailAddressRequest) ToJsonString 

func (r *DeleteEmailAddressRequest) ToJsonString() string

type DeleteEmailAddressResponse 

type DeleteEmailAddressResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDeleteEmailAddressResponse 

func NewDeleteEmailAddressResponse() (response *DeleteEmailAddressResponse)

func (*DeleteEmailAddressResponse) FromJsonString 

func (r *DeleteEmailAddressResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteEmailAddressResponse) ToJsonString 

func (r *DeleteEmailAddressResponse) ToJsonString() string

type DeleteEmailIdentityRequest 

type DeleteEmailIdentityRequest struct {
	*tchttp.BaseRequest

	// Sender domain.
	EmailIdentity *string `json:"EmailIdentity,omitempty" name:"EmailIdentity"`
}

func NewDeleteEmailIdentityRequest 

func NewDeleteEmailIdentityRequest() (request *DeleteEmailIdentityRequest)

func (*DeleteEmailIdentityRequest) FromJsonString 

func (r *DeleteEmailIdentityRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteEmailIdentityRequest) ToJsonString 

func (r *DeleteEmailIdentityRequest) ToJsonString() string

type DeleteEmailIdentityResponse 

type DeleteEmailIdentityResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDeleteEmailIdentityResponse 

func NewDeleteEmailIdentityResponse() (response *DeleteEmailIdentityResponse)

func (*DeleteEmailIdentityResponse) FromJsonString 

func (r *DeleteEmailIdentityResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteEmailIdentityResponse) ToJsonString 

func (r *DeleteEmailIdentityResponse) ToJsonString() string

type DeleteEmailTemplateRequest 

type DeleteEmailTemplateRequest struct {
	*tchttp.BaseRequest

	// Template ID
	TemplateID *uint64 `json:"TemplateID,omitempty" name:"TemplateID"`
}

func NewDeleteEmailTemplateRequest 

func NewDeleteEmailTemplateRequest() (request *DeleteEmailTemplateRequest)

func (*DeleteEmailTemplateRequest) FromJsonString 

func (r *DeleteEmailTemplateRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteEmailTemplateRequest) ToJsonString 

func (r *DeleteEmailTemplateRequest) ToJsonString() string

type DeleteEmailTemplateResponse 

type DeleteEmailTemplateResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDeleteEmailTemplateResponse 

func NewDeleteEmailTemplateResponse() (response *DeleteEmailTemplateResponse)

func (*DeleteEmailTemplateResponse) FromJsonString 

func (r *DeleteEmailTemplateResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteEmailTemplateResponse) ToJsonString 

func (r *DeleteEmailTemplateResponse) ToJsonString() string

type EmailIdentity 

type EmailIdentity struct {

	// Sender domain.
	IdentityName *string `json:"IdentityName,omitempty" name:"IdentityName"`

	// Verification type. The value is fixed to `DOMAIN`.
	IdentityType *string `json:"IdentityType,omitempty" name:"IdentityType"`

	// Verification passed or not.
	SendingEnabled *bool `json:"SendingEnabled,omitempty" name:"SendingEnabled"`
}

type EmailSender 

type EmailSender struct {

	// Sender address.
	EmailAddress *string `json:"EmailAddress,omitempty" name:"EmailAddress"`

	// Sender name.
	// Note: this field may return `null`, indicating that no valid values can be obtained.
	EmailSenderName *string `json:"EmailSenderName,omitempty" name:"EmailSenderName"`

	// Creation time.
	// Note: this field may return `null`, indicating that no valid values can be obtained.
	CreatedTimestamp *uint64 `json:"CreatedTimestamp,omitempty" name:"CreatedTimestamp"`
}

type GetEmailIdentityRequest 

type GetEmailIdentityRequest struct {
	*tchttp.BaseRequest

	// Sender domain.
	EmailIdentity *string `json:"EmailIdentity,omitempty" name:"EmailIdentity"`
}

func NewGetEmailIdentityRequest 

func NewGetEmailIdentityRequest() (request *GetEmailIdentityRequest)

func (*GetEmailIdentityRequest) FromJsonString 

func (r *GetEmailIdentityRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetEmailIdentityRequest) ToJsonString 

func (r *GetEmailIdentityRequest) ToJsonString() string

type GetEmailIdentityResponse 

type GetEmailIdentityResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Verification type. The value is fixed to `DOMAIN`.
		IdentityType *string `json:"IdentityType,omitempty" name:"IdentityType"`

		// Verification passed or not.
		VerifiedForSendingStatus *bool `json:"VerifiedForSendingStatus,omitempty" name:"VerifiedForSendingStatus"`

		// DNS configuration details.
		Attributes []*DNSAttributes `json:"Attributes,omitempty" name:"Attributes"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewGetEmailIdentityResponse 

func NewGetEmailIdentityResponse() (response *GetEmailIdentityResponse)

func (*GetEmailIdentityResponse) FromJsonString 

func (r *GetEmailIdentityResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetEmailIdentityResponse) ToJsonString 

func (r *GetEmailIdentityResponse) ToJsonString() string

type GetEmailTemplateRequest 

type GetEmailTemplateRequest struct {
	*tchttp.BaseRequest

	// Template ID.
	TemplateID *uint64 `json:"TemplateID,omitempty" name:"TemplateID"`
}

func NewGetEmailTemplateRequest 

func NewGetEmailTemplateRequest() (request *GetEmailTemplateRequest)

func (*GetEmailTemplateRequest) FromJsonString 

func (r *GetEmailTemplateRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetEmailTemplateRequest) ToJsonString 

func (r *GetEmailTemplateRequest) ToJsonString() string

type GetEmailTemplateResponse 

type GetEmailTemplateResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Template content.
		TemplateContent *TemplateContent `json:"TemplateContent,omitempty" name:"TemplateContent"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewGetEmailTemplateResponse 

func NewGetEmailTemplateResponse() (response *GetEmailTemplateResponse)

func (*GetEmailTemplateResponse) FromJsonString 

func (r *GetEmailTemplateResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetEmailTemplateResponse) ToJsonString 

func (r *GetEmailTemplateResponse) ToJsonString() string

type GetSendEmailStatusRequest 

type GetSendEmailStatusRequest struct {
	*tchttp.BaseRequest

	// Sent date. This parameter is required. You can only query the sending status for a single date at a time.
	RequestDate *string `json:"RequestDate,omitempty" name:"RequestDate"`

	// Offset. Default value: `0`
	Offset *uint64 `json:"Offset,omitempty" name:"Offset"`

	// Maximum number of pulled entries. The maximum value is `100`.
	Limit *uint64 `json:"Limit,omitempty" name:"Limit"`

	// `MessageId` field returned by the `SendMail` API
	MessageId *string `json:"MessageId,omitempty" name:"MessageId"`

	// Recipient email address
	ToEmailAddress *string `json:"ToEmailAddress,omitempty" name:"ToEmailAddress"`
}

func NewGetSendEmailStatusRequest 

func NewGetSendEmailStatusRequest() (request *GetSendEmailStatusRequest)

func (*GetSendEmailStatusRequest) FromJsonString 

func (r *GetSendEmailStatusRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetSendEmailStatusRequest) ToJsonString 

func (r *GetSendEmailStatusRequest) ToJsonString() string

type GetSendEmailStatusResponse 

type GetSendEmailStatusResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Email sending status list
		EmailStatusList []*SendEmailStatus `json:"EmailStatusList,omitempty" name:"EmailStatusList"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewGetSendEmailStatusResponse 

func NewGetSendEmailStatusResponse() (response *GetSendEmailStatusResponse)

func (*GetSendEmailStatusResponse) FromJsonString 

func (r *GetSendEmailStatusResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetSendEmailStatusResponse) ToJsonString 

func (r *GetSendEmailStatusResponse) ToJsonString() string

type GetStatisticsReportRequest 

type GetStatisticsReportRequest struct {
	*tchttp.BaseRequest

	// Start date.
	StartDate *string `json:"StartDate,omitempty" name:"StartDate"`

	// End date.
	EndDate *string `json:"EndDate,omitempty" name:"EndDate"`

	// Sender domain.
	Domain *string `json:"Domain,omitempty" name:"Domain"`

	// Recipient address type, for example, gmail.com.
	ReceivingMailboxType *string `json:"ReceivingMailboxType,omitempty" name:"ReceivingMailboxType"`
}

func NewGetStatisticsReportRequest 

func NewGetStatisticsReportRequest() (request *GetStatisticsReportRequest)

func (*GetStatisticsReportRequest) FromJsonString 

func (r *GetStatisticsReportRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetStatisticsReportRequest) ToJsonString 

func (r *GetStatisticsReportRequest) ToJsonString() string

type GetStatisticsReportResponse 

type GetStatisticsReportResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Daily email sending statistics.
		DailyVolumes []*Volume `json:"DailyVolumes,omitempty" name:"DailyVolumes"`

		// Overall email sending statistics.
		OverallVolume *Volume `json:"OverallVolume,omitempty" name:"OverallVolume"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewGetStatisticsReportResponse 

func NewGetStatisticsReportResponse() (response *GetStatisticsReportResponse)

func (*GetStatisticsReportResponse) FromJsonString 

func (r *GetStatisticsReportResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetStatisticsReportResponse) ToJsonString 

func (r *GetStatisticsReportResponse) ToJsonString() string

type ListBlackEmailAddressRequest 

type ListBlackEmailAddressRequest struct {
	*tchttp.BaseRequest

	// Start date in the format of `YYYY-MM-DD`
	StartDate *string `json:"StartDate,omitempty" name:"StartDate"`

	// End date in the format of `YYYY-MM-DD`
	EndDate *string `json:"EndDate,omitempty" name:"EndDate"`

	// Common parameter. It must be used with `Offset`.
	Limit *uint64 `json:"Limit,omitempty" name:"Limit"`

	// Common parameter. It must be used with `Limit`. Maximum value of `Limit`: `100`.
	Offset *uint64 `json:"Offset,omitempty" name:"Offset"`

	// You can specify an email address to query.
	EmailAddress *string `json:"EmailAddress,omitempty" name:"EmailAddress"`

	// You can specify a task ID to query.
	TaskID *string `json:"TaskID,omitempty" name:"TaskID"`
}

func NewListBlackEmailAddressRequest 

func NewListBlackEmailAddressRequest() (request *ListBlackEmailAddressRequest)

func (*ListBlackEmailAddressRequest) FromJsonString 

func (r *ListBlackEmailAddressRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ListBlackEmailAddressRequest) ToJsonString 

func (r *ListBlackEmailAddressRequest) ToJsonString() string

type ListBlackEmailAddressResponse 

type ListBlackEmailAddressResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// List of blocklisted addresses.
		BlackList []*BlackEmailAddress `json:"BlackList,omitempty" name:"BlackList"`

		// Total number of blocklisted addresses.
		TotalCount *uint64 `json:"TotalCount,omitempty" name:"TotalCount"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewListBlackEmailAddressResponse 

func NewListBlackEmailAddressResponse() (response *ListBlackEmailAddressResponse)

func (*ListBlackEmailAddressResponse) FromJsonString 

func (r *ListBlackEmailAddressResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ListBlackEmailAddressResponse) ToJsonString 

func (r *ListBlackEmailAddressResponse) ToJsonString() string

type ListEmailAddressRequest 

type ListEmailAddressRequest struct {
	*tchttp.BaseRequest
}

func NewListEmailAddressRequest 

func NewListEmailAddressRequest() (request *ListEmailAddressRequest)

func (*ListEmailAddressRequest) FromJsonString 

func (r *ListEmailAddressRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ListEmailAddressRequest) ToJsonString 

func (r *ListEmailAddressRequest) ToJsonString() string

type ListEmailAddressResponse 

type ListEmailAddressResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Details of sender addresses.
		// Note: this field may return `null`, indicating that no valid values can be obtained.
		EmailSenders []*EmailSender `json:"EmailSenders,omitempty" name:"EmailSenders"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewListEmailAddressResponse 

func NewListEmailAddressResponse() (response *ListEmailAddressResponse)

func (*ListEmailAddressResponse) FromJsonString 

func (r *ListEmailAddressResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ListEmailAddressResponse) ToJsonString 

func (r *ListEmailAddressResponse) ToJsonString() string

type ListEmailIdentitiesRequest 

type ListEmailIdentitiesRequest struct {
	*tchttp.BaseRequest
}

func NewListEmailIdentitiesRequest 

func NewListEmailIdentitiesRequest() (request *ListEmailIdentitiesRequest)

func (*ListEmailIdentitiesRequest) FromJsonString 

func (r *ListEmailIdentitiesRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ListEmailIdentitiesRequest) ToJsonString 

func (r *ListEmailIdentitiesRequest) ToJsonString() string

type ListEmailIdentitiesResponse 

type ListEmailIdentitiesResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// List of sender domains.
		EmailIdentities []*EmailIdentity `json:"EmailIdentities,omitempty" name:"EmailIdentities"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewListEmailIdentitiesResponse 

func NewListEmailIdentitiesResponse() (response *ListEmailIdentitiesResponse)

func (*ListEmailIdentitiesResponse) FromJsonString 

func (r *ListEmailIdentitiesResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ListEmailIdentitiesResponse) ToJsonString 

func (r *ListEmailIdentitiesResponse) ToJsonString() string

type ListEmailTemplatesRequest 

type ListEmailTemplatesRequest struct {
	*tchttp.BaseRequest

	// Number of templates to get. This parameter is used for pagination.
	Limit *uint64 `json:"Limit,omitempty" name:"Limit"`

	// Template offset to get. This parameter is used for pagination.
	Offset *uint64 `json:"Offset,omitempty" name:"Offset"`
}

func NewListEmailTemplatesRequest 

func NewListEmailTemplatesRequest() (request *ListEmailTemplatesRequest)

func (*ListEmailTemplatesRequest) FromJsonString 

func (r *ListEmailTemplatesRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ListEmailTemplatesRequest) ToJsonString 

func (r *ListEmailTemplatesRequest) ToJsonString() string

type ListEmailTemplatesResponse 

type ListEmailTemplatesResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// List of email templates.
		TemplatesMetadata []*TemplatesMetadata `json:"TemplatesMetadata,omitempty" name:"TemplatesMetadata"`

		// Total number of templates.
		TotalCount *uint64 `json:"TotalCount,omitempty" name:"TotalCount"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewListEmailTemplatesResponse 

func NewListEmailTemplatesResponse() (response *ListEmailTemplatesResponse)

func (*ListEmailTemplatesResponse) FromJsonString 

func (r *ListEmailTemplatesResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ListEmailTemplatesResponse) ToJsonString 

func (r *ListEmailTemplatesResponse) ToJsonString() string

type SendEmailRequest 

type SendEmailRequest struct {
	*tchttp.BaseRequest

	// Sender address. Enter a sender address, for example, noreply@mail.qcloud.com. To display the sender name, enter the address in the following format:
	// sender &lt;email address&gt;. For example:
	// Tencent Cloud team &lt;noreply@mail.qcloud.com&gt;
	FromEmailAddress *string `json:"FromEmailAddress,omitempty" name:"FromEmailAddress"`

	// Recipient email addresses. You can send an email to up to 50 recipients at a time. Note: the email content will display all recipient addresses. To send one-to-one emails to several recipients, please call the API multiple times to send the emails.
	Destination []*string `json:"Destination,omitempty" name:"Destination"`

	// Email subject.
	Subject *string `json:"Subject,omitempty" name:"Subject"`

	// Reply-to address. You can enter a valid personal email address that can receive emails. If this field is left empty, reply emails will be sent to Tencent Cloud.
	ReplyToAddresses *string `json:"ReplyToAddresses,omitempty" name:"ReplyToAddresses"`

	// Template when sending emails using a template.
	Template *Template `json:"Template,omitempty" name:"Template"`

	// Email content when sending emails by calling the API.
	Simple *Simple `json:"Simple,omitempty" name:"Simple"`

	// Email attachments
	Attachments []*Attachment `json:"Attachments,omitempty" name:"Attachments"`
}

func NewSendEmailRequest 

func NewSendEmailRequest() (request *SendEmailRequest)

func (*SendEmailRequest) FromJsonString 

func (r *SendEmailRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*SendEmailRequest) ToJsonString 

func (r *SendEmailRequest) ToJsonString() string

type SendEmailResponse 

type SendEmailResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Unique ID generated when receiving the message
		MessageId *string `json:"MessageId,omitempty" name:"MessageId"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewSendEmailResponse 

func NewSendEmailResponse() (response *SendEmailResponse)

func (*SendEmailResponse) FromJsonString 

func (r *SendEmailResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*SendEmailResponse) ToJsonString 

func (r *SendEmailResponse) ToJsonString() string

type SendEmailStatus 

type SendEmailStatus struct {

	// `MessageId` field returned by the `SendEmail` API
	MessageId *string `json:"MessageId,omitempty" name:"MessageId"`

	// Recipient email address
	ToEmailAddress *string `json:"ToEmailAddress,omitempty" name:"ToEmailAddress"`

	// Sender email address
	FromEmailAddress *string `json:"FromEmailAddress,omitempty" name:"FromEmailAddress"`

	// 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.
	SendStatus *int64 `json:"SendStatus,omitempty" name:"SendStatus"`

	// 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.
	DeliverStatus *int64 `json:"DeliverStatus,omitempty" name:"DeliverStatus"`

	// Description of the recipient processing status
	DeliverMessage *string `json:"DeliverMessage,omitempty" name:"DeliverMessage"`

	// Timestamp when the request arrives at Tencent Cloud
	RequestTime *int64 `json:"RequestTime,omitempty" name:"RequestTime"`

	// Timestamp when Tencent Cloud delivers the email
	DeliverTime *int64 `json:"DeliverTime,omitempty" name:"DeliverTime"`

	// Whether the recipient has opened the email
	UserOpened *bool `json:"UserOpened,omitempty" name:"UserOpened"`

	// Whether the recipient has clicked the links in the email
	UserClicked *bool `json:"UserClicked,omitempty" name:"UserClicked"`

	// Whether the recipient has unsubscribed from emails sent by the sender
	UserUnsubscribed *bool `json:"UserUnsubscribed,omitempty" name:"UserUnsubscribed"`

	// Whether the recipient has reported the sender
	UserComplainted *bool `json:"UserComplainted,omitempty" name:"UserComplainted"`
}

type Simple 

type Simple struct {

	// HTML code after base64 encoding. To ensure correct display, this parameter should include all code information and cannot contain external CSS.
	Html *string `json:"Html,omitempty" name:"Html"`

	// 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.
	Text *string `json:"Text,omitempty" name:"Text"`
}

type Template 

type Template struct {

	// Template ID. If you don’t have any template, please create one.
	TemplateID *uint64 `json:"TemplateID,omitempty" name:"TemplateID"`

	// 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.
	TemplateData *string `json:"TemplateData,omitempty" name:"TemplateData"`
}

type TemplateContent 

type TemplateContent struct {

	// HTML code after base64 encoding.
	Html *string `json:"Html,omitempty" name:"Html"`

	// Text content after base64 encoding.
	Text *string `json:"Text,omitempty" name:"Text"`
}

type TemplatesMetadata 

type TemplatesMetadata struct {

	// Creation time.
	CreatedTimestamp *uint64 `json:"CreatedTimestamp,omitempty" name:"CreatedTimestamp"`

	// Template name.
	TemplateName *string `json:"TemplateName,omitempty" name:"TemplateName"`

	// Template status. 1: under review; 0: approved; 2: rejected; other values: unavailable.
	TemplateStatus *int64 `json:"TemplateStatus,omitempty" name:"TemplateStatus"`

	// Template ID.
	TemplateID *uint64 `json:"TemplateID,omitempty" name:"TemplateID"`

	// Review reply
	ReviewReason *string `json:"ReviewReason,omitempty" name:"ReviewReason"`
}

type UpdateEmailIdentityRequest 

type UpdateEmailIdentityRequest struct {
	*tchttp.BaseRequest

	// Domain to be verified.
	EmailIdentity *string `json:"EmailIdentity,omitempty" name:"EmailIdentity"`
}

func NewUpdateEmailIdentityRequest 

func NewUpdateEmailIdentityRequest() (request *UpdateEmailIdentityRequest)

func (*UpdateEmailIdentityRequest) FromJsonString 

func (r *UpdateEmailIdentityRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*UpdateEmailIdentityRequest) ToJsonString 

func (r *UpdateEmailIdentityRequest) ToJsonString() string

type UpdateEmailIdentityResponse 

type UpdateEmailIdentityResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Verification type. The value is fixed to `DOMAIN`.
		IdentityType *string `json:"IdentityType,omitempty" name:"IdentityType"`

		// Verification passed or not.
		VerifiedForSendingStatus *bool `json:"VerifiedForSendingStatus,omitempty" name:"VerifiedForSendingStatus"`

		// DNS information that needs to be configured.
		Attributes []*DNSAttributes `json:"Attributes,omitempty" name:"Attributes"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewUpdateEmailIdentityResponse 

func NewUpdateEmailIdentityResponse() (response *UpdateEmailIdentityResponse)

func (*UpdateEmailIdentityResponse) FromJsonString 

func (r *UpdateEmailIdentityResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*UpdateEmailIdentityResponse) ToJsonString 

func (r *UpdateEmailIdentityResponse) ToJsonString() string

type UpdateEmailTemplateRequest 

type UpdateEmailTemplateRequest struct {
	*tchttp.BaseRequest

	// Template content.
	TemplateContent *TemplateContent `json:"TemplateContent,omitempty" name:"TemplateContent"`

	// Template ID.
	TemplateID *uint64 `json:"TemplateID,omitempty" name:"TemplateID"`

	// Template name.
	TemplateName *string `json:"TemplateName,omitempty" name:"TemplateName"`
}

func NewUpdateEmailTemplateRequest 

func NewUpdateEmailTemplateRequest() (request *UpdateEmailTemplateRequest)

func (*UpdateEmailTemplateRequest) FromJsonString 

func (r *UpdateEmailTemplateRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*UpdateEmailTemplateRequest) ToJsonString 

func (r *UpdateEmailTemplateRequest) ToJsonString() string

type UpdateEmailTemplateResponse 

type UpdateEmailTemplateResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewUpdateEmailTemplateResponse 

func NewUpdateEmailTemplateResponse() (response *UpdateEmailTemplateResponse)

func (*UpdateEmailTemplateResponse) FromJsonString 

func (r *UpdateEmailTemplateResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*UpdateEmailTemplateResponse) ToJsonString 

func (r *UpdateEmailTemplateResponse) ToJsonString() string

type Volume 

type Volume struct {

	// Date
	// Note: this field may return `null`, indicating that no valid values can be obtained.
	SendDate *string `json:"SendDate,omitempty" name:"SendDate"`

	// Number of email requests.
	RequestCount *uint64 `json:"RequestCount,omitempty" name:"RequestCount"`

	// Number of email requests accepted by Tencent Cloud.
	AcceptedCount *uint64 `json:"AcceptedCount,omitempty" name:"AcceptedCount"`

	// Number of delivered emails.
	DeliveredCount *uint64 `json:"DeliveredCount,omitempty" name:"DeliveredCount"`

	// Number of users (deduplicated) who opened emails.
	OpenedCount *uint64 `json:"OpenedCount,omitempty" name:"OpenedCount"`

	// Number of recipients who clicked on links in emails.
	ClickedCount *uint64 `json:"ClickedCount,omitempty" name:"ClickedCount"`

	// Number of bounced emails.
	BounceCount *uint64 `json:"BounceCount,omitempty" name:"BounceCount"`

	// Number of users who canceled subscriptions.
	// Note: this field may return `null`, indicating that no valid values can be obtained.
	UnsubscribeCount *uint64 `json:"UnsubscribeCount,omitempty" name:"UnsubscribeCount"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.