REST Resource: users.messages

资源：Message

电子邮件。

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. References 和 In-Reply-To 标头必须按照 RFC 2822 标准进行设置。
  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 Drive Labels API 查询可用的分类标签架构。每个分类标签 ID 都必须是唯一的。如果提供了重复的 ID，则只会保留一个，并且选择是任意的。仅适用于 Google Workspace 账号。

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

 从回收站中移除指定邮件。