List Gmail History
Lists the history of all changes to the given mailbox. History results are returned in chronological order (increasing historyId
).
External Documentation
To learn more, visit the Gmail documentation.
Basic Parameters
Parameter | Description |
---|---|
Start History ID | Required. Returns history records after the specified startHistoryId . The supplied startHistoryId should be obtained from the historyId of a message, thread, or previous list response. History IDs increase chronologically but are not contiguous with random gaps in between valid IDs. Supplying an invalid or out of date startHistoryId typically returns an HTTP 404 error code. A historyId is typically valid for at least a week, but in some rare circumstances may be valid for only a few hours. If you receive an HTTP 404 error response, your application should perform a full sync. If you receive no nextPageToken in the response, there are no updates to retrieve and you can store the returned historyId for a future request. |
User ID | The user's email address. The special value me can be used to indicate the authenticated user. |
Advanced Parameters
Parameter | Description |
---|---|
Delegated User Override | Perform the action on behalf of another user, overriding the delegated user defined in the connection. If not specified, the delegated user is the one provided in the connection. Has no effect when using an OAuth connection. NOTE: the connection details are not edited by this input. |
History Types | History types to be returned by the function. |
Example Output
{
"history": [
{
"id": "62882",
"messages": [
{
"id": "184766da3f22aab8",
"threadId": "184766da3f22aab8"
}
],
"messagesAdded": [
{
"message": {
"id": "184766da3f22aab8",
"threadId": "184766da3f22aab8",
"labelIds": [
"UNREAD",
"SENT",
"INBOX"
]
}
}
]
}
],
"historyId": "63365"
}
Workflow Library Example
List Gmail History and Send Results Via Email