跳到主要内容

批量更新邮件

POST/v2/users/:email/messages/batchUpdate

批量更新指定用户的邮件属性，单次最多处理 100 封邮件。通过 action 字段指定操作类型。

支持的操作​

  • markRead：将邮件标记为已读。
  • markUnread：将邮件标记为未读。
  • addTags：为邮件添加标签，标签 ID 列表通过 message.tags 传入。
  • removeTags：从邮件中移除标签，标签 ID 列表通过 message.tags 传入。

请求示例​

将邮件标记为已读：

{
  "action": "markRead"
}

为邮件添加标签：

{
  "action": "addTags",
  "message": {
    "tags": [
      "103",
      "104"
    ]
  }
}

Request​

Path parameters

    email stringrequired

    用户的邮箱地址

请求体参数

    ids string[]

    邮件列表

    message object

    需要更新的邮件信息，未填写的字段保持不变, 只支持单一属性的修改。

    internetMessageId string

    由RFC2822指定格式的邮件消息Id（可选字段：在URL中增加$select=internetMessageId查询参数后返回，如需多个字段使用英文逗号分隔）

    subject string

    邮件主题

    summary string

    邮件摘要信息

    priority enum

    邮件的重要性, 值可以是 HIGH、NORMAL、LOW，默认为NORMAL

    • PRY_HIGH:
    • PRY_NORMAL:

    Possible values: [PRY_HIGH, PRY_NORMAL]

    isReadReceiptRequested boolean

    是否需要已读回执，默认为false（可选字段：在URL中增加$select=isReadReceiptRequested查询参数后返回，如需多个字段使用英文逗号分隔）

    from object

    发送邮件邮箱的所有者，在多数情况中，此数值与“sender”属性相同

    email string

    人员或实体的电子邮件地址

    name string

    人员或实体的显示名称

    toRecipients object[]

    邮件的收件人（可选字段：在URL中增加$select=toRecipients查询参数后返回，如需多个字段使用英文逗号分隔）

    email string

    人员或实体的电子邮件地址

    name string

    人员或实体的显示名称

    ccRecipients object[]

    邮件的抄送收件人（可选字段：在URL中增加$select=ccRecipients查询参数后返回，如需多个字段使用英文逗号分隔）

    email string

    人员或实体的电子邮件地址

    name string

    人员或实体的显示名称

    bccRecipients object[]

    邮件的密送收件人（可选字段：在URL中增加$select=bccRecipients查询参数后返回，如需多个字段使用英文逗号分隔）

    email string

    人员或实体的电子邮件地址

    name string

    人员或实体的显示名称

    replyTo object[]

    在答复时使用的邮件地址（可选字段：在URL中增加$select=replyTo查询参数后返回，如需多个字段使用英文逗号分隔）

    email string

    人员或实体的电子邮件地址

    name string

    人员或实体的显示名称

    body object

    邮件正文，可以是html格式和文本格式的组合（可选字段：在URL中增加$select=body查询参数后返回，如需多个字段使用英文逗号分隔）

    bodyText string

    邮件文本格式正文

    bodyHtml string

    邮件html格式正文

    internetMessageHeaders object

    由RFC5322定义的邮件头集合

    property name* string

    由RFC5322定义的邮件头集合

    tags string[]

    邮件标签列表（可选字段：在URL中增加$select=tags查询参数后返回，如需多个字段使用英文逗号分隔）

    action string

    操作类型，所有新调用方都应通过 action 指定操作。支持的值:- "markRead": 标记邮件为已读- "markUnread": 标记邮件为未读- "addTags": 给邮件增加标签，标签ID列表通过 message.tags 传入- "removeTags": 从邮件移除标签，标签ID列表通过 message.tags 传入不填写时，fallback 到 message.fieldMask.paths 判断（仅兼容老调用方的 isRead 场景）

响应

无响应字段成功响应中没有已定义的字段。

错误

401

访问未授权，请检查是否传递了正确的授权token

403

无API访问权限，请在域管的应用管理页面完成相关授权