/** * 发送任务数据 */ export interface SendTaskData { /** * 任务id */ TaskId?: number; /** * 发信地址 */ FromEmailAddress?: string; /** * 收件人列表Id */ ReceiverId?: number; /** * 任务状态 1 待开始 5 发送中 6 今日暂停发送 7 发信异常 10 发送完成 */ TaskStatus?: number; /** * 任务类型 1 即时 2 定时 3 周期 */ TaskType?: number; /** * 任务请求发信数量 */ RequestCount?: number; /** * 已经发送数量 */ SendCount?: number; /** * 缓存数量 */ CacheCount?: number; /** * 任务创建时间 */ CreateTime?: string; /** * 任务更新时间 */ UpdateTime?: string; /** * 邮件主题 */ Subject?: string; /** * 模板和模板数据 */ Template?: Template; /** * 周期任务参数 注意:此字段可能返回 null,表示取不到有效值。 */ CycleParam?: CycleEmailParam; /** * 定时任务参数 注意:此字段可能返回 null,表示取不到有效值。 */ TimedParam?: TimedEmailParam; /** * 任务异常信息 */ ErrMsg?: string; /** * 收件人列表名称 */ ReceiversName?: string; } /** * 模板发送相关信息,包含模板ID,模板变量参数等信息 */ export interface Template { /** * 模板ID。如果没有模板,请先新建一个 */ TemplateID: number; /** * 模板中的变量参数,请使用json.dump将json对象格式化为string类型。该对象是一组键值对,每个Key代表模板中的一个变量,模板中的变量使用{{键}}表示,相应的值在发送时会被替换为{{值}}。 注意:参数值不能是html等复杂类型的数据。 示例:{"name":"xxx","age":"xx"} */ TemplateData: string; } /** * ListAddressUnsubscribeConfig请求参数结构体 */ export interface ListAddressUnsubscribeConfigRequest { /** * 偏移量 */ Offset?: number; /** * 拉取最大条数,不超过100 */ Limit?: string; } /** * 用于描述发件人相关信息 */ export interface EmailSender { /** * 发信地址 */ EmailAddress?: string; /** * 发信人别名 */ EmailSenderName?: string; /** * 创建时间 */ CreatedTimestamp?: number; /** * smtp密码类型,0=没有设置密码,1=已经设置了密码 */ SmtpPwdType?: number; } /** * BatchSendEmail返回参数结构体 */ export interface BatchSendEmailResponse { /** *
发送任务ID
*/ TaskId?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteEmailIdentity请求参数结构体 */ export interface DeleteEmailIdentityRequest { /** * 发信域名 */ EmailIdentity: string; } /** * CreateCustomBlacklist返回参数结构体 */ export interface CreateCustomBlacklistResponse { /** * 收件人总数 */ TotalCount?: number; /** * 实际上传数量 */ ValidCount?: number; /** * 数据过长数量 */ TooLongCount?: number; /** * 重复数量 */ RepeatCount?: number; /** * 格式不正确数量 */ InvalidCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * UpdateAddressUnsubscribeConfig返回参数结构体 */ export interface UpdateAddressUnsubscribeConfigResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateReceiver请求参数结构体 */ export interface CreateReceiverRequest { /** * 收件人列表名称 */ ReceiversName: string; /** * 收件人列表描述 */ Desc?: string; } /** * 模板内容,TEXT和HTML必须至少存在一项,建议使用TEXT和HTML的组合 */ export interface TemplateContent { /** * base64之后的Html代码 */ Html?: string; /** * base64之后的文本内容 */ Text?: string; } /** * 邮箱黑名单结构,包含被拉黑的邮箱地址和被拉黑时间,以及被拉黑的理由 */ export interface BlackEmailAddress { /** * 邮箱被拉黑时间 */ BounceTime?: string; /** * 被拉黑的邮箱地址 */ EmailAddress?: string; /** * 被拉黑的理由 */ IspDesc?: string; } /** * 邮件发送的内容,可以是纯文本(TEXT),也可以是纯代码(HTML),或者纯文本+HTML的组合(建议方式) */ export interface Simple { /** * base64之后的Html代码。需要包含所有的代码信息,不要包含外部css,否则会导致显示格式错乱 */ Html?: string; /** * base64之后的纯文本信息,如果没有Html,邮件中会直接显示纯文本;如果有Html,它代表邮件的纯文本样式 */ Text?: string; } /** * CreateEmailAddress请求参数结构体 */ export interface CreateEmailAddressRequest { /** * 您的发信地址(发信地址总数上限为10个) */ EmailAddress: string; /** * 发件人别名 */ EmailSenderName?: string; } /** * CreateReceiverDetail请求参数结构体 */ export interface CreateReceiverDetailRequest { /** * 收件人列表ID */ ReceiverId: number; /** * 邮箱 */ Emails: Array发件人邮箱地址。不使用别名时请直接填写发件人邮箱地址,例如:noreply@mail.qcloud.com如需填写发件人别名时,请按照如下方式(注意别名与邮箱地址之间必须使用一个空格隔开):别名+一个空格+<邮箱地址>,别名中不能带有冒号(:)。
*/ FromEmailAddress: string; /** *邮件主题
*/ Subject: string; /** *收信人邮箱地址,最多支持群发50人。注意:邮件内容会显示所有收件人地址,非群发邮件请多次调用API发送。
Destination/Cc/Bcc三个参数必须至少存在一个。
邮件的“回复”电子邮件地址。可以填写您能收到邮件的邮箱地址,可以是个人邮箱。如果不填,收件人的回复邮件将会发送失败。
*/ ReplyToAddresses?: string; /** *抄送人邮箱地址,最多支持抄送20人。
*/ Cc?: Array密送人邮箱地址,最多支持抄送20人,Bcc和Destination不能重复。
*/ Bcc?: Array使用模板发送时,填写模板相关参数。
*/ Template?: Template; /** *注意如您未申请过特殊配置,则该字段为必填
已废弃
*/ Simple?: Simple; /** *说明仅部分历史上申请了特殊配置的客户需要使用。如您未申请过特殊配置,则不存在该字段。
需要发送附件时,填写附件相关参数。腾讯云接口请求最大支持 8M 的请求包,附件内容经过 Base64 预期扩大1.5倍,应该控制所有附件的总大小最大在 4M 以内,整体请求超出 8M 时接口会返回错误
*/ Attachments?: Array退订链接选项
枚举值:
邮件触发类型 0:非触发类,默认类型,营销类邮件、非即时类邮件等选择此类型 1:触发类,验证码等即时发送类邮件,若邮件超过一定大小,系统会自动选择非触发类型通道
*/ TriggerType?: number; /** *smtp头中的Message-Id字段
*/ SmtpMessageId?: string; /** *smtp头中可以设置的其它字段
*/ SmtpHeaders?: string; /** *smtp头中的from字段,建议域名与FromEmailAddress保持一致
*/ HeaderFrom?: string; } /** * UpdateEmailIdentity请求参数结构体 */ export interface UpdateEmailIdentityRequest { /** * 请求验证的域名 */ EmailIdentity: string; } /** * DeleteEmailIdentity返回参数结构体 */ export interface DeleteEmailIdentityResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteBlackList请求参数结构体 */ export interface DeleteBlackListRequest { /** * 需要清除的黑名单邮箱列表,数组长度至少为1 */ EmailAddressList: Array接受消息生成的唯一消息标识符。
*/ MessageId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 模板列表结构 */ export interface TemplatesMetadata { /** * 创建时间 */ CreatedTimestamp?: number; /** * 模板名称 */ TemplateName?: string; /** * 模板状态。1-审核中|0-已通过|2-拒绝|其它-不可用 */ TemplateStatus?: number; /** * 模板ID */ TemplateID?: number; /** * 审核原因 */ ReviewReason?: string; } /** * 黑名单详情 */ export interface BlackAddressDetail { /** * 黑名单地址id */ Id?: number; /** * 邮箱地址 */ Email?: string; /** * 创建时间 */ CreateTime?: string; /** * 过期时间 */ ExpireDate?: string; /** * 黑名单状态,0:已过期,1:生效中 */ Status?: number; } /** * GetStatisticsReport返回参数结构体 */ export interface GetStatisticsReportResponse { /** * 发信统计报告,按天 */ DailyVolumes: Array发信邮件地址。请填写发件人邮箱地址,例如:noreply@mail.qcloud.com。如需填写发件人说明,请按照
发信人 <邮件地址> 的方式填写,例如:
腾讯云团队 <noreply@mail.qcloud.com>
收件人列表ID
*/ ReceiverId: number; /** *邮件主题
*/ Subject: string; /** *任务类型 1: 立即发送 2: 定时发送 3: 周期(频率)发送
*/ TaskType: number; /** *邮件的“回复”电子邮件地址。可以填写您能收到邮件的邮箱地址,可以是个人邮箱。如果不填,收件人的回复邮件将会发送失败。
*/ ReplyToAddresses?: string; /** *使用模板发送时,填写的模板相关参数
*/ Template?: Template; /** *注意如您未申请过特殊配置,则该字段为必填
已废弃
*/ Simple?: Simple; /** *说明仅部分历史上申请了特殊配置的客户需要使用。如您未申请过特殊配置,则不存在该字段。
需要发送附件时,填写附件相关参数(暂未支持)
*/ Attachments?: Array周期发送任务的必要参数
*/ CycleParam?: CycleEmailParam; /** *定时发送任务的必要参数
*/ TimedParam?: TimedEmailParam; /** *退订链接选项
枚举值:
是否添加广告标识 0:不添加 1:添加到subject前面,2:添加到subject后面
*/ ADLocation?: number; } /** * CreateCustomBlacklist请求参数结构体 */ export interface CreateCustomBlacklistRequest { /** * 添加到黑名单的邮件地址 */ Emails: Array