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. 必须根据 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 编码的字符串。

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

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