REST Resource: users.messages

资源:消息

电子邮件。

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

string

消息的不可变 ID。

threadId

string

消息所属会话的 ID。如要向会话添加邮件或草稿,必须满足以下条件:

  1. 必须在您在请求中提供的 MessageDraft.Message 中指定请求的 threadId
  2. ReferencesIn-Reply-To 标头的设置必须符合 RFC 2822 标准。
  3. Subject 标头必须一致。

labelIds[]

string

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

snippet

string

消息文字的简短部分。

historyId

string

上次修改此消息的历史记录的 ID。

internalDate

string (int64 format)

内部邮件创建时间戳(纪元 ms),用于确定收件箱中的排序方式。对于通过 SMTP 接收的普通电子邮件,这表示 Google 最初接受邮件的时间,比 Date 标头更可靠。不过,对于通过 API 迁移的邮件,客户端可以将其配置为基于 Date 标头。

payload

object (MessagePart)

邮件部分中已解析的电子邮件结构。

sizeEstimate

integer

消息的估算大小(以字节为单位)。

raw

string (bytes format)

采用 RFC 2822 格式且采用 base64url 编码的字符串中的整封电子邮件。当提供了 format=RAW 参数时,在 messages.getdrafts.get 响应中返回。

使用 base64 编码的字符串。

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 电子邮件标头,如 ToFromSubject

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

方法

batchDelete

根据邮件 ID 删除多封邮件。

batchModify

修改指定邮件的标签。

delete

立即永久删除指定消息。

get

获取指定的消息。

import

采用标准电子邮件递送扫描和分类方法(与通过 SMTP 接收邮件类似)仅将邮件导入此用户的邮箱中。

insert

直接将邮件插入该用户的邮箱(类似于 IMAP APPEND),从而绕过大多数扫描和分类。

list

列出用户邮箱中的邮件。

modify

修改指定邮件的标签。

send

将指定邮件发送给 ToCcBcc 标头中的收件人。

trash

将指定邮件移至“已删除邮件”。

untrash

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