- HTTP 请求
- 路径参数
- 查询参数
- 请求正文
- 响应正文
- 授权范围
- HistoryType
- 历史记录
- MessageAdded
- MessageDeleted
- LabelAdded
- LabelRemoved
- 试试看!
列出给定邮箱的所有更改历史记录。系统会按时间顺序(historyId
递增)返回历史记录结果。
HTTP 请求
GET https://gmail.googleapis.com/gmail/v1/users/{userId}/history
网址采用 gRPC 转码语法。
路径参数
参数 | |
---|---|
userId |
用户的电子邮件地址。特殊值 |
查询参数
参数 | |
---|---|
maxResults |
要返回的历史记录数上限。此字段的默认值为 100。此字段的允许最大值为 500。 |
pageToken |
用于检索列表中特定页面结果的页面令牌。 |
startHistoryId |
必需。返回指定 |
labelId |
仅返回标签与 ID 匹配的消息。 |
historyTypes[] |
函数要返回的历史记录类型 |
请求正文
请求正文必须为空。
响应正文
如果成功,响应正文将包含结构如下的数据:
JSON 表示法 |
---|
{
"history": [
{
object ( |
字段 | |
---|---|
history[] |
历史记录列表。响应中包含的任何 |
nextPageToken |
获取列表中下一页结果的网页令牌。 |
historyId |
邮箱的当前历史记录的 ID。 |
授权范围
需要以下 OAuth 范围之一:
https://mail.google.com/
https://www.googleapis.com/auth/gmail.modify
https://www.googleapis.com/auth/gmail.readonly
https://www.googleapis.com/auth/gmail.metadata
如需了解详情,请参阅授权指南。
HistoryType
枚举 | |
---|---|
messageAdded |
|
messageDeleted |
|
labelAdded |
|
labelRemoved |
历史记录
记录用户邮箱的更改。每项聊天记录更改都可能会以多种方式影响多条消息。
JSON 表示法 |
---|
{ "id": string, "messages": [ { object ( |
字段 | |
---|---|
id |
邮箱序列 ID。 |
messages[] |
此历史记录中更改过的消息的列表。特定更改类型(例如 |
messagesAdded[] |
在此历史记录中添加到邮箱中的消息。 |
messagesDeleted[] |
此历史记录中从邮箱中删除(而非移至回收站)的消息。 |
labelsAdded[] |
在此历史记录中向邮件添加的标签。 |
labelsRemoved[] |
从此历史记录中的消息中移除的标签。 |
MessageAdded
JSON 表示法 |
---|
{
"message": {
object ( |
字段 | |
---|---|
message |
|
MessageDeleted
JSON 表示法 |
---|
{
"message": {
object ( |
字段 | |
---|---|
message |
|
LabelAdded
JSON 表示法 |
---|
{
"message": {
object ( |
字段 | |
---|---|
message |
|
labelIds[] |
添加到消息中的标签 ID。 |
LabelRemoved
JSON 表示法 |
---|
{
"message": {
object ( |
字段 | |
---|---|
message |
|
labelIds[] |
从邮件中移除的标签 ID。 |