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. 您请求的 threadId 必须在您随请求提供的 MessageDraft.Message 中指定。
  2. 必须按照 RFC 2822 标准设置 ReferencesIn-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.getdrafts.get 响应中返回。

使用 base64 编码的字符串。

消息部分

单个 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

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