Attachment
附件结构，包含附件名和base64之后的附件内容。
被如下接口引用：BatchSendEmail, SendEmail。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| FileName | String | 是 | 附件名称，最大支持255个字符长度，不支持部分附件类型，详情请参考附件类型。 示例值：example.txt |
| Content | String | 是 | Base64之后的附件内容，您可以发送的附件大小上限为4M。注意：腾讯云接口请求最大支持 8M 的请求包，附件内容经过 Base64 预期扩大1.5倍。应该控制所有附件的总大小最大在 4M 以内，整体请求超出 8M 接口会返回错误。 示例值：dGhpcyBpcyBhIGV4YW1wbGU= |
BlackAddressDetail
黑名单详情
被如下接口引用：ListCustomBlacklist。
| 名称 | 类型 | 描述 |
|---|---|---|
| Id | Integer | 黑名单地址id 示例值：1 |
| String | 邮箱地址 示例值：example@mail.com |
|
| CreateTime | String | 创建时间 示例值：2024-06-26 16:46:30 |
| ExpireDate | String | 过期时间 示例值：2024-06-19 |
| Status | Integer | 黑名单状态，0:已过期，1:生效中 示例值：1 |
BlackEmailAddress
邮箱黑名单结构，包含被拉黑的邮箱地址和被拉黑时间，以及被拉黑的理由
被如下接口引用：ListBlackEmailAddress。
| 名称 | 类型 | 描述 |
|---|---|---|
| BounceTime | Timestamp | 邮箱被拉黑时间 示例值：2024-12-24 02:09:33 |
| EmailAddress | String | 被拉黑的邮箱地址 示例值：block@example.com |
| IspDesc | String | 被拉黑的理由 示例值：552 1 Requested mail action aborted, mailbox not found |
CycleEmailParam
创建重复周期发送邮件任务的参数
被如下接口引用：BatchSendEmail, ListSendTasks。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| BeginTime | String | 是 | 任务开始时间 示例值：2021-09-11 09:10:11 |
| IntervalTime | Integer | 是 | 任务周期 小时维度 示例值：1 |
| TermCycle | Integer | 否 | 是否终止周期，用于任务更新 0否1是 示例值：0 |
DNSAttributes
用于描述DNS记录的域名、记录类型、期望得到的值、目前配置的值
被如下接口引用：CreateEmailIdentity, GetEmailIdentity, UpdateEmailIdentity。
| 名称 | 类型 | 描述 |
|---|---|---|
| Type | String | 记录类型 CNAME | A | TXT | MX 示例值：TXT |
| SendDomain | String | 域名 示例值：example.com |
| ExpectedValue | String | 需要配置的值 示例值：v=spf1 include:qcloudmail.com ~all |
| CurrentValue | String | 腾讯云目前检测到的值 示例值：v=spf1 include:qcloudmail.com ~all |
| Status | Boolean | 检测是否通过，创建时默认为false 示例值：true |
EmailIdentity
发信域名验证列表结构体
被如下接口引用：ListEmailIdentities。
| 名称 | 类型 | 描述 |
|---|---|---|
| IdentityName | String | 发信域名 示例值：mail.qcloud.com |
| IdentityType | String | 验证类型，固定为DOMAIN 示例值：DOMAIN |
| SendingEnabled | Boolean | 是否已通过验证 示例值：false |
| CurrentReputationLevel | Integer | 当前信誉等级 示例值：10 |
| DailyQuota | Integer | 当日最高发信量 示例值：10000 |
| SendIp | Array of String | 域名配置的独立ip 示例值：["0.0.0.0","1.1.1.1"] |
EmailSender
用于描述发件人相关信息
被如下接口引用：ListEmailAddress。
| 名称 | 类型 | 描述 |
|---|---|---|
| EmailAddress | String | 发信地址 示例值：sender@example.com |
| EmailSenderName | String | 发信人别名 示例值：name |
| CreatedTimestamp | Integer | 创建时间 示例值：2024-12-10 16:44:16 |
| SmtpPwdType | Integer | smtp密码类型,0=没有设置密码,1=已经设置了密码 示例值：0 |
ReceiverData
收件人列表数据类型
被如下接口引用：ListReceivers。
| 名称 | 类型 | 描述 |
|---|---|---|
| ReceiverId | Integer | 收件人列表ID 示例值：1 |
| ReceiversName | String | 收件人列表名称 示例值：收件人列表 |
| Count | Integer | 收件人地址总数 示例值：1 |
| Desc | String | 收件人列表描述 示例值：收件人列表描述 |
| ReceiversStatus | Integer | 列表状态(1 待上传 2 上传中 3 上传完成) 示例值：1 |
| CreateTime | String | 创建时间,如:2021-09-28 16:40:35 示例值：2021-09-28 16:40:35 |
| InvalidCount | Integer | 无效收件人数量 示例值：1 |
ReceiverDetail
收件人列表详情
被如下接口引用：ListReceiverDetails。
| 名称 | 类型 | 描述 |
|---|---|---|
| String | 收件人地址 示例值：123@abc.com |
|
| CreateTime | String | 创建时间 示例值：2021-09-09 12:13:14 |
| TemplateData | String | 模板参数 示例值：{"name":"xxx","age":"xx"} |
| Reason | String | 无效原因 示例值：无效原因 |
| Status | Integer | 1:有效，2:无效 示例值：1 |
| EmailId | Integer | 收件人地址id 示例值：1 |
ReceiverInputData
收件人明细输入参数，包含收件人邮箱，以及模板参数
被如下接口引用：CreateReceiverDetailWithData。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| String | 是 | 收件人邮箱 示例值：abc@ef.com |
|
| TemplateData | String | 是 | 模板中的变量参数，请使用json.dump将json对象格式化为string类型。该对象是一组键值对，每个Key代表模板中的一个变量，模板中的变量使用{{键}}表示，相应的值在发送时会被替换为{{值}}。 注意：参数值不能是html等复杂类型的数据。TemplateData (整个 JSON 结构) 总长度限制为 800 bytes。 示例值：{"name":"xxx","age":"xx"} |
SendEmailStatus
描述邮件发送状态
被如下接口引用：GetSendEmailStatus。
| 名称 | 类型 | 描述 |
|---|---|---|
| MessageId | String | SendEmail返回的MessageId 示例值：qcloudses-30-4123414323-date-20210101094334-syNARhMTbKI1 |
| ToEmailAddress | String | 收件人邮箱 示例值：address@example.com |
| FromEmailAddress | String | 发件人邮箱 示例值：address@example.com |
| SendStatus | Integer | 腾讯云处理状态 0: 处理成功 1001: 内部系统异常 1002: 内部系统异常 1003: 内部系统异常 1003: 内部系统异常 1004: 发信超时 1005: 内部系统异常 1006: 触发频率控制，短时间内对同一地址发送过多邮件 1007: 邮件地址在黑名单中 1008: 域名被收件人拒收 1009: 内部系统异常 1010: 超出了每日发送限制 1011: 无发送自定义内容权限，必须使用模板 1013: 域名被收件人取消订阅 2001: 找不到相关记录 3007: 模板ID无效或者不可用 3008: 被收信域名临时封禁 3009: 无权限使用该模板 3010: TemplateData字段格式不正确 3014: 发件域名没有经过认证，无法发送 3020: 收件方邮箱类型在黑名单 3024: 邮箱地址格式预检查失败 3030: 退信率过高，临时限制发送 3033: 余额不足，账号欠费等 示例值：0 |
| DeliverStatus | Integer | 收件方处理状态 0: 请求成功被腾讯云接受，进入发送队列 1: 邮件递送成功，DeliverTime表示递送成功的时间 2: 邮件因某种原因被丢弃，DeliverMessage表示丢弃原因 3: 收件方ESP拒信，一般原因为邮箱地址不存在，或其它原因 8: 邮件被ESP因某些原因延迟递送，DeliverMessage表示延迟原因 示例值：0 |
| DeliverMessage | String | 收件方处理状态描述 示例值：550 Mailbox unavailable or access denied |
| RequestTime | Integer | 请求到达腾讯云时间戳 示例值：1609831698 |
| DeliverTime | Integer | 腾讯云执行递送时间戳 示例值：1609831698 |
| UserOpened | Boolean | 用户是否打开该邮件 示例值：true |
| UserClicked | Boolean | 用户是否点击该邮件中的链接 示例值：true |
| UserUnsubscribed | Boolean | 用户是否取消该发送者的订阅 示例值：true |
| UserComplainted | Boolean | 用户是否举报该发送者 示例值：true |
SendTaskData
发送任务数据
被如下接口引用：ListSendTasks。
| 名称 | 类型 | 描述 |
|---|---|---|
| TaskId | Integer | 任务id 示例值：1 |
| FromEmailAddress | String | 发信地址 示例值：address@example.com |
| ReceiverId | Integer | 收件人列表Id 示例值：1 |
| TaskStatus | Integer | 任务状态 1 待开始 5 发送中 6 今日暂停发送 7 发信异常 10 发送完成 示例值：1 |
| TaskType | Integer | 任务类型 1 即时 2 定时 3 周期 示例值：1 |
| RequestCount | Integer | 任务请求发信数量 示例值：1 |
| SendCount | Integer | 已经发送数量 示例值：1 |
| CacheCount | Integer | 缓存数量 示例值：1 |
| CreateTime | String | 任务创建时间 示例值：2021-09-09 12:12:13 |
| UpdateTime | String | 任务更新时间 示例值：2021-09-09 12:12:13 |
| Subject | String | 邮件主题 示例值：邮件主题 |
| Template | Template | 模板和模板数据 注意：此字段可能返回 null，表示取不到有效值。 |
| CycleParam | CycleEmailParam | 周期任务参数 注意：此字段可能返回 null，表示取不到有效值。 |
| TimedParam | TimedEmailParam | 定时任务参数 注意：此字段可能返回 null，表示取不到有效值。 |
| ErrMsg | String | 任务异常信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：余额不足 |
| ReceiversName | String | 收件人列表名称 示例值：收件人列表名称 |
Simple
邮件发送的内容，可以是纯文本(TEXT)，也可以是纯代码(HTML)，或者纯文本+HTML的组合(建议方式)
被如下接口引用：BatchSendEmail, SendEmail。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Html | String | 否 | base64之后的Html代码。需要包含所有的代码信息，不要包含外部css，否则会导致显示格式错乱 示例值：PGh0bWw+PGhlYWQ+PHRpdGxlPkV4YW1wbGUgSFRNTDwvdGl0bGU+PC9oZWFkPjxib2R5PjxwPkhlbGxvLCB3b3JsZDwvcD48L2JvZHk+PC9odG1sPg== |
| Text | String | 否 | base64之后的纯文本信息，如果没有Html，邮件中会直接显示纯文本；如果有Html，它代表邮件的纯文本样式 示例值：SGVsbG8sIHdvcmxkIQ== |
Template
模板发送相关信息，包含模板ID，模板变量参数等信息
被如下接口引用：BatchSendEmail, ListSendTasks, SendEmail。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| TemplateID | Integer | 是 | 模板ID。如果没有模板，请先新建一个 示例值：1 |
| TemplateData | String | 是 | 模板中的变量参数，请使用json.dump将json对象格式化为string类型。该对象是一组键值对，每个Key代表模板中的一个变量，模板中的变量使用{{键}}表示，相应的值在发送时会被替换为{{值}}。 注意：参数值不能是html等复杂类型的数据。 示例：{"name":"xxx","age":"xx"} 示例值：{"name":"andy","age":"24"} |
TemplateContent
模板内容，TEXT和HTML必须至少存在一项，建议使用TEXT和HTML的组合
被如下接口引用：CreateEmailTemplate, GetEmailTemplate, UpdateEmailTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Html | String | 否 | base64之后的Html代码 示例值：PGh0bWw+PGhlYWQ+PHRpdGxlPkV4YW1wbGUgSFRNTDwvdGl0bGU+PC9oZWFkPjxib2R5PjxwPkhlbGxvLCB3b3JsZDwvcD48L2JvZHk+PC9odG1sPg== |
| Text | String | 否 | base64之后的文本内容 示例值：SGVsbG8sIHdvcmxkIQ== |
TemplatesMetadata
模板列表结构
被如下接口引用：ListEmailTemplates。
| 名称 | 类型 | 描述 |
|---|---|---|
| CreatedTimestamp | Integer | 创建时间 示例值：1724757008 |
| TemplateName | String | 模板名称 示例值：exampleTemplate |
| TemplateStatus | Integer | 模板状态。1-审核中|0-已通过|2-拒绝|其它-不可用 示例值：1 |
| TemplateID | Integer | 模板ID 示例值：251252329 |
| ReviewReason | String | 审核原因 示例值：禁止发送未经收件人许可的电子邮件。 |
TimedEmailParam
创建定时发送邮件任务时，设置的定时参数，比如开始时间之类
被如下接口引用：BatchSendEmail, ListSendTasks。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| BeginTime | String | 是 | 定时发送邮件的开始时间 示例值：2021-09-11 09:10:11 |
Volume
统计数据的结构体
被如下接口引用：GetStatisticsReport。
| 名称 | 类型 | 描述 |
|---|---|---|
| SendDate | Date | 日期 注意：此字段可能返回 null，表示取不到有效值。 示例值：2024-08-08 |
| RequestCount | Integer | 邮件请求数量 示例值：2 |
| AcceptedCount | Integer | 腾讯云通过数量 示例值：1 |
| DeliveredCount | Integer | 送达数量 示例值：1 |
| OpenedCount | Integer | 打开邮件的用户数量，根据收件人去重 示例值：0 |
| ClickedCount | Integer | 点击了邮件中的链接数量用户数量 示例值：0 |
| BounceCount | Integer | 退信数量 示例值：0 |
| UnsubscribeCount | Integer | 取消订阅的用户数量 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
