REST Resource: users.messages

资源：邮件

电子邮件。

JSON 表示法 
{
  "id": string,
  "threadId": string,
  "labelIds": [
    string
  ],
  "snippet": string,
  "historyId": string,
  "internalDate": string,
  "payload": {
    object (MessagePart)
  },
  "sizeEstimate": integer,
  "raw": string,
  "classificationLabelValues": [
    {
      object (ClassificationLabelValue)
    }
  ]
}
字段
id

string

邮件的不可变 ID。
threadId

string

邮件所属的会话的 ID。如需向会话添加邮件或草稿，必须满足以下条件：

  1. 您在请求中提供的 Message 或 Draft.Message 必须指定所请求的 threadId。
  2. 必须按照 RFC 2822 标准设置 References 和 In-Reply-To 标头。
  3. Subject 标头必须匹配。
labelIds[]

string

应用于此邮件的标签的 ID 列表。
snippet

string

邮件文本的一小部分。
historyId

string

修改此邮件的最后一个历史记录的 ID。
internalDate

string (int64 format)

内部邮件创建时间戳（纪元毫秒），用于确定邮件在收件箱中的排序。对于通过 SMTP 收到的普通电子邮件，此时间戳表示 Google 最初接受邮件的时间，比 Date 标头更可靠。不过，对于通过 API 迁移的邮件，客户端可以将其配置为基于 Date 标头。
payload

object (MessagePart)

邮件部分中经过解析的电子邮件结构。
sizeEstimate

integer

邮件的估计大小（以字节为单位）。
raw

string (bytes format)

采用 RFC 2822 格式且经过 base64url 编码的字符串形式的完整电子邮件。当提供 format=RAW 参数时，会在 messages.get 和 drafts.get 响应中返回。

使用 base64 编码的字符串。
classificationLabelValues[]

object (ClassificationLabelValue)

邮件上的分类标签值。您可以使用 Google 云端硬盘 Labels API 查询可用的分类标签架构。每个分类标签 ID 都必须是唯一的。如果提供的 ID 重复，则系统只会保留一个，并且选择是任意的。仅适用于 Google Workspace 账号。每个请求最多只能有 20 个分类标签值。如果分类标签值超过允许的最大数量，请求就会失败。

MessagePart

单个 MIME 邮件部分。

JSON 表示法 
{
  "partId": string,
  "mimeType": string,
  "filename": string,
  "headers": [
    {
      object (Header)
    }
  ],
  "body": {
    object (MessagePartBody)
  },
  "parts": [
    {
      object (MessagePart)
    }
  ]
}
字段
partId

string

邮件部分的不可变 ID。
mimeType

string

邮件部分的 MIME 类型。
filename

string

附件的文件名。仅当此邮件部分表示附件时才会显示。
headers[]

object (Header)

此邮件部分中的标头列表。对于表示整个邮件载荷的顶级邮件部分，它将包含标准 RFC 2822 电子邮件标头，例如 To、From 和 Subject。
body

object (MessagePartBody)

此部分的邮件部分正文，对于容器 MIME 邮件部分，此部分可能为空。
parts[]

object (MessagePart)

此部分的子 MIME 邮件部分。这仅适用于容器 MIME 邮件部分，例如 multipart/*。对于非容器 MIME 邮件部分类型（例如 text/plain），此字段为空。如需了解详情，请参阅 RFC 1521。
JSON 表示法 
{
  "name": string,
  "value": string
}
字段
name

string

分隔符 : 之前的标头名称。例如，To。
value

string

分隔符 : 之后的标头值。例如，someuser@example.com。

ClassificationLabelValue

应用于电子邮件的分类标签。分类标签不同于 Gmail 收件箱标签。仅适用于 Google Workspace 账号。详细了解分类标签。

JSON 表示法 
{
  "labelId": string,
  "fields": [
    {
      object (ClassificationLabelFieldValue)
    }
  ]
}
字段
labelId

string

必需。规范或原始字母数字分类标签 ID。映射到 Google 云端硬盘标签资源的 ID 字段。
fields[]

object (ClassificationLabelFieldValue)

给定分类标签 ID 的字段值。

ClassificationLabelFieldValue

分类标签的字段值。

JSON 表示法 
{
  "fieldId": string,
  "selection": string
}
字段
fieldId

string

必需。分类标签值的字段 ID。映射到 Google 云端硬盘 Label.Field 对象的 ID 字段。
selection

string

选择选项的选择 ID。仅当 Google 云端硬盘 Label.Field 对象中的字段类型为 SELECTION 时，才应设置此字段。映射到 Google 云端硬盘 Label.Field.SelectionOptions 资源的 ID 字段。

方法

batchDelete

 按邮件 ID 删除多封邮件。

batchModify

 修改指定邮件上的标签和分类标签值。

delete

 立即永久删除指定的邮件。

get

 获取指定的邮件。

import

 将邮件导入到此用户的邮箱中，并进行标准电子邮件递送扫描和分类，类似于通过 SMTP 接收邮件。

insert

 直接将邮件插入到此用户的邮箱中，类似于 IMAP APPEND，绕过大多数扫描和分类。

list

 列出用户邮箱中的邮件。

modify

 修改指定邮件上的标签和分类标签值。

send

 将指定的邮件发送给 To、Cc 和 Bcc 标头中的收件人。

trash

 将指定的邮件移至“回收站”。

untrash

 从“已删除邮件”文件夹中移除指定的邮件。