v20201002

package
v3.0.563+incompatible Latest Latest
Warning

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

 Go to latest Published: Oct 28, 2022 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source 
const (

	// Operation failed.
	FAILEDOPERATION = "FailedOperation"

	// 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"

	// Incorrect sender format. Follow the sample in this document.
	FAILEDOPERATION_INCORRECTSENDER = "FailedOperation.IncorrectSender"

	// 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"

	// Missing email content (`TemplateData` and `Simple` cannot be both empty).
	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"

	// You 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 recipient has unsubscribed.
	FAILEDOPERATION_RECEIVERHASUNSUBSCRIBED = "FailedOperation.ReceiverHasUnsubscribed"

	// The message was rejected by the recipient.
	FAILEDOPERATION_REJECTEDBYRECIPIENTS = "FailedOperation.RejectedByRecipients"

	// Email sending error. Please submit a ticket to us for troubleshooting.
	FAILEDOPERATION_SENDEMAILERR = "FailedOperation.SendEmailErr"

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

	// The template size is too large. Reduce the size.
	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"

	// You can only send emails by using a template.
	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"

	// The start time cannot be earlier than the current time.
	INVALIDPARAMETERVALUE_BEGINTIMEBEFORENOW = "InvalidParameterValue.BeginTimeBeforeNow"

	// 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"

	// Invalid recipient group description. The description cannot contain special characters and must contain 1 to 300 characters.
	INVALIDPARAMETERVALUE_RECEIVERDESCILLEGAL = "InvalidParameterValue.ReceiverDescIllegal"

	// Invalid recipient group name. Check the name and its size.
	INVALIDPARAMETERVALUE_RECEIVERNAMEILLEGAL = "InvalidParameterValue.ReceiverNameIllegal"

	// 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"

	// Duplicate recipient group name.
	INVALIDPARAMETERVALUE_REPEATRECEIVERNAME = "InvalidParameterValue.RepeatReceiverName"

	// The email subject must contain 1 to 100 characters.
	INVALIDPARAMETERVALUE_SUBJECTLENGTHERROR = "InvalidParameterValue.SubjectLengthError"

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

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

	// Template parameters must be in JSON format.
	INVALIDPARAMETERVALUE_TEMPLATEDATAERROR = "InvalidParameterValue.TemplateDataError"

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

	// The template name cannot be empty.
	INVALIDPARAMETERVALUE_TEMPLATENAMEISNULL = "InvalidParameterValue.TemplateNameIsNULL"

	// The template does not exist. Please create a template.
	INVALIDPARAMETERVALUE_TEMPLATENOTEXIST = "InvalidParameterValue.TemplateNotExist"

	// Template variables do not match recipient list parameters.
	INVALIDPARAMETERVALUE_TEMPLATENOTMATCHDATA = "InvalidParameterValue.TemplateNotMatchData"

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

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

	// The number of recipient email addresses exceeded the limit.
	LIMITEXCEEDED_EXCEEDRECEIVERDETAILLIMIT = "LimitExceeded.ExceedReceiverDetailLimit"

	// The number of recipient groups exceeded the limit.
	LIMITEXCEEDED_EXCEEDRECEIVERLIMIT = "LimitExceeded.ExceedReceiverLimit"

	// Missing parameter.
	MISSINGPARAMETER = "MissingParameter"

	// For a recurring sending task, you must select the start time and recurrence.
	MISSINGPARAMETER_CYCLEPARAMNECESSARY = "MissingParameter.CycleParamNecessary"

	// The recipient email address is required.
	MISSINGPARAMETER_EMAILSNECESSARY = "MissingParameter.EmailsNecessary"

	// The recipient group ID is required.
	MISSINGPARAMETER_RECEIVERIDNECESSARY = "MissingParameter.ReceiverIdNecessary"

	// Sender address, recipient group, and email template are required.
	MISSINGPARAMETER_SENDPARAMNECESSARY = "MissingParameter.SendParamNecessary"

	// For a scheduled sending task, you must select the start time.
	MISSINGPARAMETER_TIMEDPARAMNECESSARY = "MissingParameter.TimedParamNecessary"

	// 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 recipient group is being operated. Try again later.
	OPERATIONDENIED_RECEIVERISOPERATING = "OperationDenied.ReceiverIsOperating"

	// The recipient group does not exist.
	OPERATIONDENIED_RECEIVERNOTEXIST = "OperationDenied.ReceiverNotExist"

	// The recipient group is empty or hasn’t been completely uploaded.
	OPERATIONDENIED_RECEIVERSTATUSERROR = "OperationDenied.ReceiverStatusError"

	// The sender address does not exist or hasn’t been approved.
	OPERATIONDENIED_SENDADDRESSSTATUSERROR = "OperationDenied.SendAddressStatusError"

	// The email template does not exist or hasn’t been approved.
	OPERATIONDENIED_TEMPLATESTATUSERROR = "OperationDenied.TemplateStatusError"

	// 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 4 MB. Note: Tencent Cloud APIs require that a request packet should not exceed 8 MB. If you are sending multiple attachments, the total size of these attachments cannot exceed 8 MB.
	Content *string `json:"Content,omitempty" name:"Content"`
}

type BatchSendEmailRequest 

type BatchSendEmailRequest 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 <email address>, for example:
	// Tencent Cloud team <noreply@mail.qcloud.com>
	FromEmailAddress *string `json:"FromEmailAddress,omitempty" name:"FromEmailAddress"`

	// Recipient group ID
	ReceiverId *uint64 `json:"ReceiverId,omitempty" name:"ReceiverId"`

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

	// Task type. `1`: immediate; `2`: scheduled; `3`: recurring
	TaskType *uint64 `json:"TaskType,omitempty" name:"TaskType"`

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

	// Template when emails are sent using a template
	Template *Template `json:"Template,omitempty" name:"Template"`

	// Disused
	Simple *Simple `json:"Simple,omitempty" name:"Simple"`

	// Attachment parameters to set when you need to send attachments. This parameter is currently unavailable.
	Attachments []*Attachment `json:"Attachments,omitempty" name:"Attachments"`

	// Parameter required for a recurring sending task
	CycleParam *CycleEmailParam `json:"CycleParam,omitempty" name:"CycleParam"`

	// Parameter required for a scheduled sending task
	TimedParam *TimedEmailParam `json:"TimedParam,omitempty" name:"TimedParam"`

	// Unsubscribe option. `1`: provides an unsubscribe link; `0`: does not provide an unsubscribe link
	Unsubscribe *string `json:"Unsubscribe,omitempty" name:"Unsubscribe"`

	// Whether to add an ad tag. `0`: Add no tag; `1`: Add before the subject; `2`: Add after the subject.
	ADLocation *uint64 `json:"ADLocation,omitempty" name:"ADLocation"`
}

func NewBatchSendEmailRequest 

func NewBatchSendEmailRequest() (request *BatchSendEmailRequest)

func (*BatchSendEmailRequest) FromJsonString 

func (r *BatchSendEmailRequest) 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 (*BatchSendEmailRequest) ToJsonString 

func (r *BatchSendEmailRequest) ToJsonString() string

type BatchSendEmailRequestParams 

type BatchSendEmailRequestParams struct {
	// 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 <email address>, for example:
	// Tencent Cloud team <noreply@mail.qcloud.com>
	FromEmailAddress *string `json:"FromEmailAddress,omitempty" name:"FromEmailAddress"`

	// Recipient group ID
	ReceiverId *uint64 `json:"ReceiverId,omitempty" name:"ReceiverId"`

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

	// Task type. `1`: immediate; `2`: scheduled; `3`: recurring
	TaskType *uint64 `json:"TaskType,omitempty" name:"TaskType"`

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

	// Template when emails are sent using a template
	Template *Template `json:"Template,omitempty" name:"Template"`

	// Disused
	Simple *Simple `json:"Simple,omitempty" name:"Simple"`

	// Attachment parameters to set when you need to send attachments. This parameter is currently unavailable.
	Attachments []*Attachment `json:"Attachments,omitempty" name:"Attachments"`

	// Parameter required for a recurring sending task
	CycleParam *CycleEmailParam `json:"CycleParam,omitempty" name:"CycleParam"`

	// Parameter required for a scheduled sending task
	TimedParam *TimedEmailParam `json:"TimedParam,omitempty" name:"TimedParam"`

	// Unsubscribe option. `1`: provides an unsubscribe link; `0`: does not provide an unsubscribe link
	Unsubscribe *string `json:"Unsubscribe,omitempty" name:"Unsubscribe"`

	// Whether to add an ad tag. `0`: Add no tag; `1`: Add before the subject; `2`: Add after the subject.
	ADLocation *uint64 `json:"ADLocation,omitempty" name:"ADLocation"`
}

Predefined struct for user

type BatchSendEmailResponse 

type BatchSendEmailResponse struct {
	*tchttp.BaseResponse
	Response *BatchSendEmailResponseParams `json:"Response"`
}

func NewBatchSendEmailResponse 

func NewBatchSendEmailResponse() (response *BatchSendEmailResponse)

func (*BatchSendEmailResponse) FromJsonString 

func (r *BatchSendEmailResponse) 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 (*BatchSendEmailResponse) ToJsonString 

func (r *BatchSendEmailResponse) ToJsonString() string

type BatchSendEmailResponseParams 

type BatchSendEmailResponseParams struct {
	// Sending task ID
	TaskId *uint64 `json:"TaskId,omitempty" name:"TaskId"`

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

Predefined struct for user

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) BatchSendEmail 

func (c *Client) BatchSendEmail(request *BatchSendEmailRequest) (response *BatchSendEmailResponse, err error)

BatchSendEmail This API is used to send a TEXT or HTML email to multiple recipients at a time for marketing or notification purposes. By default, you can send emails using a template only. You need to create a recipient group with email addresses first and then send emails by group ID. SES supports scheduled and recurring email sending tasks. You need to pass in `TimedParam` for a scheduled task and `CycleParam` for a recurring one.

error code that may be returned: 

FAILEDOPERATION_EMAILCONTENTTOOLARGE = "FailedOperation.EmailContentToolarge"
INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE_BEGINTIMEBEFORENOW = "InvalidParameterValue.BeginTimeBeforeNow"
INVALIDPARAMETERVALUE_EMAILCONTENTISWRONG = "InvalidParameterValue.EmailContentIsWrong"
INVALIDPARAMETERVALUE_SUBJECTLENGTHERROR = "InvalidParameterValue.SubjectLengthError"
INVALIDPARAMETERVALUE_TEMPLATEDATAERROR = "InvalidParameterValue.TemplateDataError"
INVALIDPARAMETERVALUE_TEMPLATENOTMATCHDATA = "InvalidParameterValue.TemplateNotMatchData"
MISSINGPARAMETER_CYCLEPARAMNECESSARY = "MissingParameter.CycleParamNecessary"
MISSINGPARAMETER_SENDPARAMNECESSARY = "MissingParameter.SendParamNecessary"
MISSINGPARAMETER_TIMEDPARAMNECESSARY = "MissingParameter.TimedParamNecessary"
OPERATIONDENIED_RECEIVERNOTEXIST = "OperationDenied.ReceiverNotExist"
OPERATIONDENIED_RECEIVERSTATUSERROR = "OperationDenied.ReceiverStatusError"
OPERATIONDENIED_SENDADDRESSSTATUSERROR = "OperationDenied.SendAddressStatusError"
OPERATIONDENIED_TEMPLATESTATUSERROR = "OperationDenied.TemplateStatusError"

func (*Client) BatchSendEmailWithContext 

func (c *Client) BatchSendEmailWithContext(ctx context.Context, request *BatchSendEmailRequest) (response *BatchSendEmailResponse, err error)

BatchSendEmail This API is used to send a TEXT or HTML email to multiple recipients at a time for marketing or notification purposes. By default, you can send emails using a template only. You need to create a recipient group with email addresses first and then send emails by group ID. SES supports scheduled and recurring email sending tasks. You need to pass in `TimedParam` for a scheduled task and `CycleParam` for a recurring one.

error code that may be returned: 

FAILEDOPERATION_EMAILCONTENTTOOLARGE = "FailedOperation.EmailContentToolarge"
INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE_BEGINTIMEBEFORENOW = "InvalidParameterValue.BeginTimeBeforeNow"
INVALIDPARAMETERVALUE_EMAILCONTENTISWRONG = "InvalidParameterValue.EmailContentIsWrong"
INVALIDPARAMETERVALUE_SUBJECTLENGTHERROR = "InvalidParameterValue.SubjectLengthError"
INVALIDPARAMETERVALUE_TEMPLATEDATAERROR = "InvalidParameterValue.TemplateDataError"
INVALIDPARAMETERVALUE_TEMPLATENOTMATCHDATA = "InvalidParameterValue.TemplateNotMatchData"
MISSINGPARAMETER_CYCLEPARAMNECESSARY = "MissingParameter.CycleParamNecessary"
MISSINGPARAMETER_SENDPARAMNECESSARY = "MissingParameter.SendParamNecessary"
MISSINGPARAMETER_TIMEDPARAMNECESSARY = "MissingParameter.TimedParamNecessary"
OPERATIONDENIED_RECEIVERNOTEXIST = "OperationDenied.ReceiverNotExist"
OPERATIONDENIED_RECEIVERSTATUSERROR = "OperationDenied.ReceiverStatusError"
OPERATIONDENIED_SENDADDRESSSTATUSERROR = "OperationDenied.SendAddressStatusError"
OPERATIONDENIED_TEMPLATESTATUSERROR = "OperationDenied.TemplateStatusError"

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) CreateEmailAddressWithContext 

func (c *Client) CreateEmailAddressWithContext(ctx context.Context, 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) CreateEmailIdentityWithContext 

func (c *Client) CreateEmailIdentityWithContext(ctx context.Context, 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) CreateEmailTemplateWithContext 

func (c *Client) CreateEmailTemplateWithContext(ctx context.Context, 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) CreateReceiver 

func (c *Client) CreateReceiver(request *CreateReceiverRequest) (response *CreateReceiverResponse, err error)

CreateReceiver This API is used to create a recipient group, which is the list of target email addresses for batch sending emails. After creating a group, you need to upload recipient email addresses. Then, you can create a sending task and select the group to batch send emails.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE_RECEIVERDESCILLEGAL = "InvalidParameterValue.ReceiverDescIllegal"
INVALIDPARAMETERVALUE_RECEIVERNAMEILLEGAL = "InvalidParameterValue.ReceiverNameIllegal"
INVALIDPARAMETERVALUE_REPEATRECEIVERNAME = "InvalidParameterValue.RepeatReceiverName"
LIMITEXCEEDED_EXCEEDRECEIVERLIMIT = "LimitExceeded.ExceedReceiverLimit"

func (*Client) CreateReceiverDetail 

func (c *Client) CreateReceiverDetail(request *CreateReceiverDetailRequest) (response *CreateReceiverDetailResponse, err error)

CreateReceiverDetail This API is used to add recipient email addresses (up to 100,000 at a time) to a recipient group. This will be processed asynchronously. You can upload recipient email addresses only once. If the data volume is large, it may take some time to upload. You can check the recipient group to learn the upload status and upload quantity.

error code that may be returned: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_SERVICENOTAVAILABLE = "FailedOperation.ServiceNotAvailable"
INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE_TEMPLATEDATAERROR = "InvalidParameterValue.TemplateDataError"
LIMITEXCEEDED_EXCEEDRECEIVERDETAILLIMIT = "LimitExceeded.ExceedReceiverDetailLimit"
MISSINGPARAMETER_EMAILSNECESSARY = "MissingParameter.EmailsNecessary"
MISSINGPARAMETER_RECEIVERIDNECESSARY = "MissingParameter.ReceiverIdNecessary"
OPERATIONDENIED_RECEIVERISOPERATING = "OperationDenied.ReceiverIsOperating"
OPERATIONDENIED_RECEIVERNOTEXIST = "OperationDenied.ReceiverNotExist"

func (*Client) CreateReceiverDetailWithContext 

func (c *Client) CreateReceiverDetailWithContext(ctx context.Context, request *CreateReceiverDetailRequest) (response *CreateReceiverDetailResponse, err error)

CreateReceiverDetail This API is used to add recipient email addresses (up to 100,000 at a time) to a recipient group. This will be processed asynchronously. You can upload recipient email addresses only once. If the data volume is large, it may take some time to upload. You can check the recipient group to learn the upload status and upload quantity.

error code that may be returned: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_SERVICENOTAVAILABLE = "FailedOperation.ServiceNotAvailable"
INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE_TEMPLATEDATAERROR = "InvalidParameterValue.TemplateDataError"
LIMITEXCEEDED_EXCEEDRECEIVERDETAILLIMIT = "LimitExceeded.ExceedReceiverDetailLimit"
MISSINGPARAMETER_EMAILSNECESSARY = "MissingParameter.EmailsNecessary"
MISSINGPARAMETER_RECEIVERIDNECESSARY = "MissingParameter.ReceiverIdNecessary"
OPERATIONDENIED_RECEIVERISOPERATING = "OperationDenied.ReceiverIsOperating"
OPERATIONDENIED_RECEIVERNOTEXIST = "OperationDenied.ReceiverNotExist"

func (*Client) CreateReceiverWithContext 

func (c *Client) CreateReceiverWithContext(ctx context.Context, request *CreateReceiverRequest) (response *CreateReceiverResponse, err error)

CreateReceiver This API is used to create a recipient group, which is the list of target email addresses for batch sending emails. After creating a group, you need to upload recipient email addresses. Then, you can create a sending task and select the group to batch send emails.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE_RECEIVERDESCILLEGAL = "InvalidParameterValue.ReceiverDescIllegal"
INVALIDPARAMETERVALUE_RECEIVERNAMEILLEGAL = "InvalidParameterValue.ReceiverNameIllegal"
INVALIDPARAMETERVALUE_REPEATRECEIVERNAME = "InvalidParameterValue.RepeatReceiverName"
LIMITEXCEEDED_EXCEEDRECEIVERLIMIT = "LimitExceeded.ExceedReceiverLimit"

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) DeleteBlackListWithContext 

func (c *Client) DeleteBlackListWithContext(ctx context.Context, 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) DeleteEmailAddressWithContext 

func (c *Client) DeleteEmailAddressWithContext(ctx context.Context, 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) DeleteEmailIdentityWithContext 

func (c *Client) DeleteEmailIdentityWithContext(ctx context.Context, 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) DeleteEmailTemplateWithContext 

func (c *Client) DeleteEmailTemplateWithContext(ctx context.Context, 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) DeleteReceiver 

func (c *Client) DeleteReceiver(request *DeleteReceiverRequest) (response *DeleteReceiverResponse, err error)

DeleteReceiver This API is used to delete a recipient group and all recipient email addresses in the group based on the recipient group ID.

error code that may be returned: 

INTERNALERROR = "InternalError"
MISSINGPARAMETER_RECEIVERIDNECESSARY = "MissingParameter.ReceiverIdNecessary"
OPERATIONDENIED_RECEIVERNOTEXIST = "OperationDenied.ReceiverNotExist"

func (*Client) DeleteReceiverWithContext 

func (c *Client) DeleteReceiverWithContext(ctx context.Context, request *DeleteReceiverRequest) (response *DeleteReceiverResponse, err error)

DeleteReceiver This API is used to delete a recipient group and all recipient email addresses in the group based on the recipient group ID.

error code that may be returned: 

INTERNALERROR = "InternalError"
MISSINGPARAMETER_RECEIVERIDNECESSARY = "MissingParameter.ReceiverIdNecessary"
OPERATIONDENIED_RECEIVERNOTEXIST = "OperationDenied.ReceiverNotExist"

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) GetEmailIdentityWithContext 

func (c *Client) GetEmailIdentityWithContext(ctx context.Context, 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) GetEmailTemplateWithContext 

func (c *Client) GetEmailTemplateWithContext(ctx context.Context, 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 30 days can be queried.

Default API request rate limit: 1 request/sec.

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) GetSendEmailStatusWithContext 

func (c *Client) GetSendEmailStatusWithContext(ctx context.Context, request *GetSendEmailStatusRequest) (response *GetSendEmailStatusResponse, err error)

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

Default API request rate limit: 1 request/sec.

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.

error code that may be returned: 

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

func (*Client) GetStatisticsReportWithContext 

func (c *Client) GetStatisticsReportWithContext(ctx context.Context, 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.

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) ListBlackEmailAddressWithContext 

func (c *Client) ListBlackEmailAddressWithContext(ctx context.Context, 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) ListEmailAddressWithContext 

func (c *Client) ListEmailAddressWithContext(ctx context.Context, 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) ListEmailIdentitiesWithContext 

func (c *Client) ListEmailIdentitiesWithContext(ctx context.Context, 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) ListEmailTemplatesWithContext 

func (c *Client) ListEmailTemplatesWithContext(ctx context.Context, 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) ListReceivers 

func (c *Client) ListReceivers(request *ListReceiversRequest) (response *ListReceiversResponse, err error)

ListReceivers This API is used to query recipient groups. It supports pagination, fuzzy query, and query by status.

error code that may be returned: 

FAILEDOPERATION_INVALIDLIMIT = "FailedOperation.InvalidLimit"
INTERNALERROR = "InternalError"

func (*Client) ListReceiversWithContext 

func (c *Client) ListReceiversWithContext(ctx context.Context, request *ListReceiversRequest) (response *ListReceiversResponse, err error)

ListReceivers This API is used to query recipient groups. It supports pagination, fuzzy query, and query by status.

error code that may be returned: 

FAILEDOPERATION_INVALIDLIMIT = "FailedOperation.InvalidLimit"
INTERNALERROR = "InternalError"

func (*Client) ListSendTasks 

func (c *Client) ListSendTasks(request *ListSendTasksRequest) (response *ListSendTasksResponse, err error)

ListSendTasks This API is used to query batch email sending tasks (including immediate, scheduled, and recurring tasks) by page. You can query task data including the number of emails requested to be sent, the number of sent emails, the number of cached emails, and task status.

error code that may be returned: 

FAILEDOPERATION_INVALIDLIMIT = "FailedOperation.InvalidLimit"

func (*Client) ListSendTasksWithContext 

func (c *Client) ListSendTasksWithContext(ctx context.Context, request *ListSendTasksRequest) (response *ListSendTasksResponse, err error)

ListSendTasks This API is used to query batch email sending tasks (including immediate, scheduled, and recurring tasks) by page. You can query task data including the number of emails requested to be sent, the number of sent emails, the number of cached emails, and task status.

error code that may be returned: 

FAILEDOPERATION_INVALIDLIMIT = "FailedOperation.InvalidLimit"

func (*Client) SendEmail 

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

SendEmail This API is used to send an HTML or TEXT email triggered for authentication or transaction. By default, you can send emails using a template only.

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_INCORRECTSENDER = "FailedOperation.IncorrectSender"
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_RECEIVERHASUNSUBSCRIBED = "FailedOperation.ReceiverHasUnsubscribed"
FAILEDOPERATION_REJECTEDBYRECIPIENTS = "FailedOperation.RejectedByRecipients"
FAILEDOPERATION_SENDEMAILERR = "FailedOperation.SendEmailErr"
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"
INVALIDPARAMETERVALUE_INVALIDEMAILIDENTITY = "InvalidParameterValue.InvalidEmailIdentity"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) SendEmailWithContext 

func (c *Client) SendEmailWithContext(ctx context.Context, request *SendEmailRequest) (response *SendEmailResponse, err error)

SendEmail This API is used to send an HTML or TEXT email triggered for authentication or transaction. By default, you can send emails using a template only.

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_INCORRECTSENDER = "FailedOperation.IncorrectSender"
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_RECEIVERHASUNSUBSCRIBED = "FailedOperation.ReceiverHasUnsubscribed"
FAILEDOPERATION_REJECTEDBYRECIPIENTS = "FailedOperation.RejectedByRecipients"
FAILEDOPERATION_SENDEMAILERR = "FailedOperation.SendEmailErr"
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"
INVALIDPARAMETERVALUE_INVALIDEMAILIDENTITY = "InvalidParameterValue.InvalidEmailIdentity"
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) UpdateEmailIdentityWithContext 

func (c *Client) UpdateEmailIdentityWithContext(ctx context.Context, 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"

func (*Client) UpdateEmailTemplateWithContext 

func (c *Client) UpdateEmailTemplateWithContext(ctx context.Context, 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 CreateEmailAddressRequestParams 

type CreateEmailAddressRequestParams struct {
	// 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"`
}

Predefined struct for user

type CreateEmailAddressResponse 

type CreateEmailAddressResponse struct {
	*tchttp.BaseResponse
	Response *CreateEmailAddressResponseParams `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 CreateEmailAddressResponseParams 

type CreateEmailAddressResponseParams 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"`
}

Predefined struct for user

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 CreateEmailIdentityRequestParams 

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

Predefined struct for user

type CreateEmailIdentityResponse 

type CreateEmailIdentityResponse struct {
	*tchttp.BaseResponse
	Response *CreateEmailIdentityResponseParams `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 CreateEmailIdentityResponseParams 

type CreateEmailIdentityResponseParams 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"`
}

Predefined struct for user

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 CreateEmailTemplateRequestParams 

type CreateEmailTemplateRequestParams struct {
	// Template name.
	TemplateName *string `json:"TemplateName,omitempty" name:"TemplateName"`

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

Predefined struct for user

type CreateEmailTemplateResponse 

type CreateEmailTemplateResponse struct {
	*tchttp.BaseResponse
	Response *CreateEmailTemplateResponseParams `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 CreateEmailTemplateResponseParams 

type CreateEmailTemplateResponseParams struct {
	// Template ID
	TemplateID *uint64 `json:"TemplateID,omitempty" name:"TemplateID"`

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

Predefined struct for user

type CreateReceiverDetailRequest 

type CreateReceiverDetailRequest struct {
	*tchttp.BaseRequest

	// Recipient group ID
	ReceiverId *uint64 `json:"ReceiverId,omitempty" name:"ReceiverId"`

	// Email address
	Emails []*string `json:"Emails,omitempty" name:"Emails"`
}

func NewCreateReceiverDetailRequest 

func NewCreateReceiverDetailRequest() (request *CreateReceiverDetailRequest)

func (*CreateReceiverDetailRequest) FromJsonString 

func (r *CreateReceiverDetailRequest) 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 (*CreateReceiverDetailRequest) ToJsonString 

func (r *CreateReceiverDetailRequest) ToJsonString() string

type CreateReceiverDetailRequestParams 

type CreateReceiverDetailRequestParams struct {
	// Recipient group ID
	ReceiverId *uint64 `json:"ReceiverId,omitempty" name:"ReceiverId"`

	// Email address
	Emails []*string `json:"Emails,omitempty" name:"Emails"`
}

Predefined struct for user

type CreateReceiverDetailResponse 

type CreateReceiverDetailResponse struct {
	*tchttp.BaseResponse
	Response *CreateReceiverDetailResponseParams `json:"Response"`
}

func NewCreateReceiverDetailResponse 

func NewCreateReceiverDetailResponse() (response *CreateReceiverDetailResponse)

func (*CreateReceiverDetailResponse) FromJsonString 

func (r *CreateReceiverDetailResponse) 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 (*CreateReceiverDetailResponse) ToJsonString 

func (r *CreateReceiverDetailResponse) ToJsonString() string

type CreateReceiverDetailResponseParams 

type CreateReceiverDetailResponseParams 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"`
}

Predefined struct for user

type CreateReceiverRequest 

type CreateReceiverRequest struct {
	*tchttp.BaseRequest

	// Recipient group name
	ReceiversName *string `json:"ReceiversName,omitempty" name:"ReceiversName"`

	// Recipient group description
	Desc *string `json:"Desc,omitempty" name:"Desc"`
}

func NewCreateReceiverRequest 

func NewCreateReceiverRequest() (request *CreateReceiverRequest)

func (*CreateReceiverRequest) FromJsonString 

func (r *CreateReceiverRequest) 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 (*CreateReceiverRequest) ToJsonString 

func (r *CreateReceiverRequest) ToJsonString() string

type CreateReceiverRequestParams 

type CreateReceiverRequestParams struct {
	// Recipient group name
	ReceiversName *string `json:"ReceiversName,omitempty" name:"ReceiversName"`

	// Recipient group description
	Desc *string `json:"Desc,omitempty" name:"Desc"`
}

Predefined struct for user

type CreateReceiverResponse 

type CreateReceiverResponse struct {
	*tchttp.BaseResponse
	Response *CreateReceiverResponseParams `json:"Response"`
}

func NewCreateReceiverResponse 

func NewCreateReceiverResponse() (response *CreateReceiverResponse)

func (*CreateReceiverResponse) FromJsonString 

func (r *CreateReceiverResponse) 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 (*CreateReceiverResponse) ToJsonString 

func (r *CreateReceiverResponse) ToJsonString() string

type CreateReceiverResponseParams 

type CreateReceiverResponseParams struct {
	// Recipient group ID, by which recipient email addresses are uploaded
	ReceiverId *uint64 `json:"ReceiverId,omitempty" name:"ReceiverId"`

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

Predefined struct for user

type CycleEmailParam 

type CycleEmailParam struct {
	// Start time of the task
	BeginTime *string `json:"BeginTime,omitempty" name:"BeginTime"`

	// Task recurrence in hours
	IntervalTime *uint64 `json:"IntervalTime,omitempty" name:"IntervalTime"`
}

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 DeleteBlackListRequestParams 

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

Predefined struct for user

type DeleteBlackListResponse 

type DeleteBlackListResponse struct {
	*tchttp.BaseResponse
	Response *DeleteBlackListResponseParams `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 DeleteBlackListResponseParams 

type DeleteBlackListResponseParams 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"`
}

Predefined struct for user

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 DeleteEmailAddressRequestParams 

type DeleteEmailAddressRequestParams struct {
	// Sender address.
	EmailAddress *string `json:"EmailAddress,omitempty" name:"EmailAddress"`
}

Predefined struct for user

type DeleteEmailAddressResponse 

type DeleteEmailAddressResponse struct {
	*tchttp.BaseResponse
	Response *DeleteEmailAddressResponseParams `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 DeleteEmailAddressResponseParams 

type DeleteEmailAddressResponseParams 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"`
}

Predefined struct for user

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 DeleteEmailIdentityRequestParams 

type DeleteEmailIdentityRequestParams struct {
	// Sender domain.
	EmailIdentity *string `json:"EmailIdentity,omitempty" name:"EmailIdentity"`
}

Predefined struct for user

type DeleteEmailIdentityResponse 

type DeleteEmailIdentityResponse struct {
	*tchttp.BaseResponse
	Response *DeleteEmailIdentityResponseParams `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 DeleteEmailIdentityResponseParams 

type DeleteEmailIdentityResponseParams 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"`
}

Predefined struct for user

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 DeleteEmailTemplateRequestParams 

type DeleteEmailTemplateRequestParams struct {
	// Template ID
	TemplateID *uint64 `json:"TemplateID,omitempty" name:"TemplateID"`
}

Predefined struct for user

type DeleteEmailTemplateResponse 

type DeleteEmailTemplateResponse struct {
	*tchttp.BaseResponse
	Response *DeleteEmailTemplateResponseParams `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 DeleteEmailTemplateResponseParams 

type DeleteEmailTemplateResponseParams 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"`
}

Predefined struct for user

type DeleteReceiverRequest 

type DeleteReceiverRequest struct {
	*tchttp.BaseRequest

	// Recipient group ID, which is returned when a recipient group is created.
	ReceiverId *uint64 `json:"ReceiverId,omitempty" name:"ReceiverId"`
}

func NewDeleteReceiverRequest 

func NewDeleteReceiverRequest() (request *DeleteReceiverRequest)

func (*DeleteReceiverRequest) FromJsonString 

func (r *DeleteReceiverRequest) 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 (*DeleteReceiverRequest) ToJsonString 

func (r *DeleteReceiverRequest) ToJsonString() string

type DeleteReceiverRequestParams 

type DeleteReceiverRequestParams struct {
	// Recipient group ID, which is returned when a recipient group is created.
	ReceiverId *uint64 `json:"ReceiverId,omitempty" name:"ReceiverId"`
}

Predefined struct for user

type DeleteReceiverResponse 

type DeleteReceiverResponse struct {
	*tchttp.BaseResponse
	Response *DeleteReceiverResponseParams `json:"Response"`
}

func NewDeleteReceiverResponse 

func NewDeleteReceiverResponse() (response *DeleteReceiverResponse)

func (*DeleteReceiverResponse) FromJsonString 

func (r *DeleteReceiverResponse) 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 (*DeleteReceiverResponse) ToJsonString 

func (r *DeleteReceiverResponse) ToJsonString() string

type DeleteReceiverResponseParams 

type DeleteReceiverResponseParams 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"`
}

Predefined struct for user

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"`

	// Current reputation level
	CurrentReputationLevel *uint64 `json:"CurrentReputationLevel,omitempty" name:"CurrentReputationLevel"`

	// Maximum number of messages sent per day
	DailyQuota *uint64 `json:"DailyQuota,omitempty" name:"DailyQuota"`
}

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 GetEmailIdentityRequestParams 

type GetEmailIdentityRequestParams struct {
	// Sender domain.
	EmailIdentity *string `json:"EmailIdentity,omitempty" name:"EmailIdentity"`
}

Predefined struct for user

type GetEmailIdentityResponse 

type GetEmailIdentityResponse struct {
	*tchttp.BaseResponse
	Response *GetEmailIdentityResponseParams `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 GetEmailIdentityResponseParams 

type GetEmailIdentityResponseParams 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"`
}

Predefined struct for user

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 GetEmailTemplateRequestParams 

type GetEmailTemplateRequestParams struct {
	// Template ID.
	TemplateID *uint64 `json:"TemplateID,omitempty" name:"TemplateID"`
}

Predefined struct for user

type GetEmailTemplateResponse 

type GetEmailTemplateResponse struct {
	*tchttp.BaseResponse
	Response *GetEmailTemplateResponseParams `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 GetEmailTemplateResponseParams 

type GetEmailTemplateResponseParams struct {
	// Template content.
	TemplateContent *TemplateContent `json:"TemplateContent,omitempty" name:"TemplateContent"`

	// Template status. Valid values: `0` (approved); `1` (pending approval); `2` (rejected).
	TemplateStatus *uint64 `json:"TemplateStatus,omitempty" name:"TemplateStatus"`

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

Predefined struct for user

type GetSendEmailStatusRequest 

type GetSendEmailStatusRequest struct {
	*tchttp.BaseRequest

	// Date sent. 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. Maximum value: `100`.
	Limit *uint64 `json:"Limit,omitempty" name:"Limit"`

	// The `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 GetSendEmailStatusRequestParams 

type GetSendEmailStatusRequestParams struct {
	// Date sent. 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. Maximum value: `100`.
	Limit *uint64 `json:"Limit,omitempty" name:"Limit"`

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

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

Predefined struct for user

type GetSendEmailStatusResponse 

type GetSendEmailStatusResponse struct {
	*tchttp.BaseResponse
	Response *GetSendEmailStatusResponseParams `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 GetSendEmailStatusResponseParams 

type GetSendEmailStatusResponseParams struct {
	// Status of sent emails
	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"`
}

Predefined struct for user

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 GetStatisticsReportRequestParams 

type GetStatisticsReportRequestParams struct {
	// 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"`
}

Predefined struct for user

type GetStatisticsReportResponse 

type GetStatisticsReportResponse struct {
	*tchttp.BaseResponse
	Response *GetStatisticsReportResponseParams `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 GetStatisticsReportResponseParams 

type GetStatisticsReportResponseParams 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"`
}

Predefined struct for user

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 ListBlackEmailAddressRequestParams 

type ListBlackEmailAddressRequestParams struct {
	// 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"`
}

Predefined struct for user

type ListBlackEmailAddressResponse 

type ListBlackEmailAddressResponse struct {
	*tchttp.BaseResponse
	Response *ListBlackEmailAddressResponseParams `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 ListBlackEmailAddressResponseParams 

type ListBlackEmailAddressResponseParams 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"`
}

Predefined struct for user

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 ListEmailAddressRequestParams 

type ListEmailAddressRequestParams struct {
}

Predefined struct for user

type ListEmailAddressResponse 

type ListEmailAddressResponse struct {
	*tchttp.BaseResponse
	Response *ListEmailAddressResponseParams `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 ListEmailAddressResponseParams 

type ListEmailAddressResponseParams 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"`
}

Predefined struct for user

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 ListEmailIdentitiesRequestParams 

type ListEmailIdentitiesRequestParams struct {
}

Predefined struct for user

type ListEmailIdentitiesResponse 

type ListEmailIdentitiesResponse struct {
	*tchttp.BaseResponse
	Response *ListEmailIdentitiesResponseParams `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 ListEmailIdentitiesResponseParams 

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

	// Maximum reputation level
	MaxReputationLevel *uint64 `json:"MaxReputationLevel,omitempty" name:"MaxReputationLevel"`

	// Maximum number of emails sent per domain name
	MaxDailyQuota *uint64 `json:"MaxDailyQuota,omitempty" name:"MaxDailyQuota"`

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

Predefined struct for user

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 ListEmailTemplatesRequestParams 

type ListEmailTemplatesRequestParams struct {
	// 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"`
}

Predefined struct for user

type ListEmailTemplatesResponse 

type ListEmailTemplatesResponse struct {
	*tchttp.BaseResponse
	Response *ListEmailTemplatesResponseParams `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 ListEmailTemplatesResponseParams 

type ListEmailTemplatesResponseParams 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"`
}

Predefined struct for user

type ListReceiversRequest 

type ListReceiversRequest struct {
	*tchttp.BaseRequest

	// Offset, starting from 0. The value is an integer.
	Offset *uint64 `json:"Offset,omitempty" name:"Offset"`

	// Number of records to query. The value is an integer not exceeding 100.
	Limit *uint64 `json:"Limit,omitempty" name:"Limit"`

	// Group status (`1`: to be uploaded; `2` uploading; `3` uploaded). To query groups in all states, do not pass in this parameter.
	Status *uint64 `json:"Status,omitempty" name:"Status"`

	// Group name keyword for fuzzy query
	KeyWord *string `json:"KeyWord,omitempty" name:"KeyWord"`
}

func NewListReceiversRequest 

func NewListReceiversRequest() (request *ListReceiversRequest)

func (*ListReceiversRequest) FromJsonString 

func (r *ListReceiversRequest) 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 (*ListReceiversRequest) ToJsonString 

func (r *ListReceiversRequest) ToJsonString() string

type ListReceiversRequestParams 

type ListReceiversRequestParams struct {
	// Offset, starting from 0. The value is an integer.
	Offset *uint64 `json:"Offset,omitempty" name:"Offset"`

	// Number of records to query. The value is an integer not exceeding 100.
	Limit *uint64 `json:"Limit,omitempty" name:"Limit"`

	// Group status (`1`: to be uploaded; `2` uploading; `3` uploaded). To query groups in all states, do not pass in this parameter.
	Status *uint64 `json:"Status,omitempty" name:"Status"`

	// Group name keyword for fuzzy query
	KeyWord *string `json:"KeyWord,omitempty" name:"KeyWord"`
}

Predefined struct for user

type ListReceiversResponse 

type ListReceiversResponse struct {
	*tchttp.BaseResponse
	Response *ListReceiversResponseParams `json:"Response"`
}

func NewListReceiversResponse 

func NewListReceiversResponse() (response *ListReceiversResponse)

func (*ListReceiversResponse) FromJsonString 

func (r *ListReceiversResponse) 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 (*ListReceiversResponse) ToJsonString 

func (r *ListReceiversResponse) ToJsonString() string

type ListReceiversResponseParams 

type ListReceiversResponseParams struct {
	// Total number
	TotalCount *uint64 `json:"TotalCount,omitempty" name:"TotalCount"`

	// Data record
	Data []*ReceiverData `json:"Data,omitempty" name:"Data"`

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

Predefined struct for user

type ListSendTasksRequest 

type ListSendTasksRequest struct {
	*tchttp.BaseRequest

	// Offset, starting from 0. The value is an integer. `0` means to skip 0 entries.
	Offset *uint64 `json:"Offset,omitempty" name:"Offset"`

	// Number of records to query. The value is an integer not exceeding 100.
	Limit *uint64 `json:"Limit,omitempty" name:"Limit"`

	// Task status. `1`: to start; `5`: sending; `6`: sending suspended today; `7`: sending error; `10`: sent. To query tasks in all states, do not pass in this parameter.
	Status *uint64 `json:"Status,omitempty" name:"Status"`

	// Recipient group ID
	ReceiverId *uint64 `json:"ReceiverId,omitempty" name:"ReceiverId"`

	// Task type. `1`: immediate; `2`: scheduled; `3`: recurring. To query tasks of all types, do not pass in this parameter.
	TaskType *uint64 `json:"TaskType,omitempty" name:"TaskType"`
}

func NewListSendTasksRequest 

func NewListSendTasksRequest() (request *ListSendTasksRequest)

func (*ListSendTasksRequest) FromJsonString 

func (r *ListSendTasksRequest) 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 (*ListSendTasksRequest) ToJsonString 

func (r *ListSendTasksRequest) ToJsonString() string

type ListSendTasksRequestParams 

type ListSendTasksRequestParams struct {
	// Offset, starting from 0. The value is an integer. `0` means to skip 0 entries.
	Offset *uint64 `json:"Offset,omitempty" name:"Offset"`

	// Number of records to query. The value is an integer not exceeding 100.
	Limit *uint64 `json:"Limit,omitempty" name:"Limit"`

	// Task status. `1`: to start; `5`: sending; `6`: sending suspended today; `7`: sending error; `10`: sent. To query tasks in all states, do not pass in this parameter.
	Status *uint64 `json:"Status,omitempty" name:"Status"`

	// Recipient group ID
	ReceiverId *uint64 `json:"ReceiverId,omitempty" name:"ReceiverId"`

	// Task type. `1`: immediate; `2`: scheduled; `3`: recurring. To query tasks of all types, do not pass in this parameter.
	TaskType *uint64 `json:"TaskType,omitempty" name:"TaskType"`
}

Predefined struct for user

type ListSendTasksResponse 

type ListSendTasksResponse struct {
	*tchttp.BaseResponse
	Response *ListSendTasksResponseParams `json:"Response"`
}

func NewListSendTasksResponse 

func NewListSendTasksResponse() (response *ListSendTasksResponse)

func (*ListSendTasksResponse) FromJsonString 

func (r *ListSendTasksResponse) 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 (*ListSendTasksResponse) ToJsonString 

func (r *ListSendTasksResponse) ToJsonString() string

type ListSendTasksResponseParams 

type ListSendTasksResponseParams struct {
	// Total number
	TotalCount *uint64 `json:"TotalCount,omitempty" name:"TotalCount"`

	// Data record
	Data []*SendTaskData `json:"Data,omitempty" name:"Data"`

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

Predefined struct for user

type ReceiverData 

type ReceiverData struct {
	// Recipient group ID
	ReceiverId *uint64 `json:"ReceiverId,omitempty" name:"ReceiverId"`

	// Recipient group name
	ReceiversName *string `json:"ReceiversName,omitempty" name:"ReceiversName"`

	// Total number of recipient email addresses
	Count *uint64 `json:"Count,omitempty" name:"Count"`

	// Recipient group description
	// Note: This field may return `null`, indicating that no valid value can be found.
	Desc *string `json:"Desc,omitempty" name:"Desc"`

	// Group status (`1`: to be uploaded; `2` uploading; `3` uploaded)
	// Note: This field may return `null`, indicating that no valid value can be found.
	ReceiversStatus *uint64 `json:"ReceiversStatus,omitempty" name:"ReceiversStatus"`

	// Creation time, such as 2021-09-28 16:40:35
	CreateTime *string `json:"CreateTime,omitempty" name:"CreateTime"`
}

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 <email address>
	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 parameter is left empty, reply emails will fail to be sent.
	ReplyToAddresses *string `json:"ReplyToAddresses,omitempty" name:"ReplyToAddresses"`

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

	// Disused
	Simple *Simple `json:"Simple,omitempty" name:"Simple"`

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

	// Unsubscribe option. `1`: provides an unsubscribe link; `0`: does not provide an unsubscribe link
	Unsubscribe *string `json:"Unsubscribe,omitempty" name:"Unsubscribe"`

	// Email triggering type. `0` (default): non-trigger-based, suitable for marketing emails and non-immediate emails; `1`: trigger-based, suitable for immediate emails such as emails containing verification codes. If the size of an email exceeds a specified value, the system will automatically choose the non-trigger-based type.
	TriggerType *uint64 `json:"TriggerType,omitempty" name:"TriggerType"`
}

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 SendEmailRequestParams 

type SendEmailRequestParams struct {
	// 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 <email address>
	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 parameter is left empty, reply emails will fail to be sent.
	ReplyToAddresses *string `json:"ReplyToAddresses,omitempty" name:"ReplyToAddresses"`

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

	// Disused
	Simple *Simple `json:"Simple,omitempty" name:"Simple"`

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

	// Unsubscribe option. `1`: provides an unsubscribe link; `0`: does not provide an unsubscribe link
	Unsubscribe *string `json:"Unsubscribe,omitempty" name:"Unsubscribe"`

	// Email triggering type. `0` (default): non-trigger-based, suitable for marketing emails and non-immediate emails; `1`: trigger-based, suitable for immediate emails such as emails containing verification codes. If the size of an email exceeds a specified value, the system will automatically choose the non-trigger-based type.
	TriggerType *uint64 `json:"TriggerType,omitempty" name:"TriggerType"`
}

Predefined struct for user

type SendEmailResponse 

type SendEmailResponse struct {
	*tchttp.BaseResponse
	Response *SendEmailResponseParams `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 SendEmailResponseParams 

type SendEmailResponseParams 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"`
}

Predefined struct for user

type SendEmailStatus 

type SendEmailStatus struct {
	// The `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 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.
	// 1009: Internal system exception.
	// 1010: The daily email sending limit is exceeded.
	// 1011: You have no permission to send custom content. Use a template.
	// 2001: No results were found.
	// 3007: The template ID is invalid or the template is unavailable.
	// 3008: Template status exception.
	// 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 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 the email 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 SendTaskData 

type SendTaskData struct {
	// Task ID
	TaskId *uint64 `json:"TaskId,omitempty" name:"TaskId"`

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

	// Recipient group ID
	ReceiverId *uint64 `json:"ReceiverId,omitempty" name:"ReceiverId"`

	// Task status. `1`: to start; `5`: sending; `6`: sending suspended today; `7`: sending error; `10`: sent
	TaskStatus *uint64 `json:"TaskStatus,omitempty" name:"TaskStatus"`

	// Task type. `1`: immediate; `2`: scheduled; `3`: recurring
	TaskType *uint64 `json:"TaskType,omitempty" name:"TaskType"`

	// Number of emails requested to be sent
	RequestCount *uint64 `json:"RequestCount,omitempty" name:"RequestCount"`

	// Number of emails sent
	SendCount *uint64 `json:"SendCount,omitempty" name:"SendCount"`

	// Number of emails cached
	CacheCount *uint64 `json:"CacheCount,omitempty" name:"CacheCount"`

	// Task creation time
	CreateTime *string `json:"CreateTime,omitempty" name:"CreateTime"`

	// Task update time
	UpdateTime *string `json:"UpdateTime,omitempty" name:"UpdateTime"`

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

	// Template and template data
	// Note: This field may return `null`, indicating that no valid value can be found.
	Template *Template `json:"Template,omitempty" name:"Template"`

	// Parameters of a recurring task
	// Note: This field may return `null`, indicating that no valid value can be found.
	CycleParam *CycleEmailParam `json:"CycleParam,omitempty" name:"CycleParam"`

	// Parameters of a scheduled task
	// Note: This field may return `null`, indicating that no valid value can be found.
	TimedParam *TimedEmailParam `json:"TimedParam,omitempty" name:"TimedParam"`

	// Task exception information
	// Note: This field may return `null`, indicating that no valid value can be found.
	ErrMsg *string `json:"ErrMsg,omitempty" name:"ErrMsg"`

	// Recipient group name
	ReceiversName *string `json:"ReceiversName,omitempty" name:"ReceiversName"`
}

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.
	// Note: The parameter value cannot be data of a complex type such as HTML.
	// Example: {"name":"xxx","age":"xx"}
	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 TimedEmailParam 

type TimedEmailParam struct {
	// Start time of a scheduled sending task
	BeginTime *string `json:"BeginTime,omitempty" name:"BeginTime"`
}

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 UpdateEmailIdentityRequestParams 

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

Predefined struct for user

type UpdateEmailIdentityResponse 

type UpdateEmailIdentityResponse struct {
	*tchttp.BaseResponse
	Response *UpdateEmailIdentityResponseParams `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 UpdateEmailIdentityResponseParams 

type UpdateEmailIdentityResponseParams 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"`
}

Predefined struct for user

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 UpdateEmailTemplateRequestParams 

type UpdateEmailTemplateRequestParams struct {
	// 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"`
}

Predefined struct for user

type UpdateEmailTemplateResponse 

type UpdateEmailTemplateResponse struct {
	*tchttp.BaseResponse
	Response *UpdateEmailTemplateResponseParams `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 UpdateEmailTemplateResponseParams 

type UpdateEmailTemplateResponseParams 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"`
}

Predefined struct for user

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.