| Copyright | (c) 2015 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.Google.Resource.Gmail.Users.History.List
Description
Lists the history of all changes to the given mailbox. History results are returned in chronological order (increasing historyId).
See: Gmail API Reference for gmail.users.history.list.
- type UsersHistoryListResource = "gmail" :> ("v1" :> ("users" :> (Capture "userId" Text :> ("history" :> (QueryParam "startHistoryId" (Textual Word64) :> (QueryParam "pageToken" Text :> (QueryParam "labelId" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get `[JSON]` ListHistoryResponse)))))))))
- usersHistoryList :: Text -> UsersHistoryList
- data UsersHistoryList
- uhlUserId :: Lens' UsersHistoryList Text
- uhlStartHistoryId :: Lens' UsersHistoryList (Maybe Word64)
- uhlPageToken :: Lens' UsersHistoryList (Maybe Text)
- uhlLabelId :: Lens' UsersHistoryList (Maybe Text)
- uhlMaxResults :: Lens' UsersHistoryList Word32
REST Resource
type UsersHistoryListResource = "gmail" :> ("v1" :> ("users" :> (Capture "userId" Text :> ("history" :> (QueryParam "startHistoryId" (Textual Word64) :> (QueryParam "pageToken" Text :> (QueryParam "labelId" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get `[JSON]` ListHistoryResponse))))))))) Source
A resource alias for gmail.users.history.list method which the
UsersHistoryList request conforms to.
Creating a Request
usersHistoryList :: Text -> UsersHistoryList Source
Creates a value of UsersHistoryList with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data UsersHistoryList Source
Lists the history of all changes to the given mailbox. History results are returned in chronological order (increasing historyId).
See: usersHistoryList smart constructor.
Request Lenses
uhlUserId :: Lens' UsersHistoryList Text Source
The user's email address. The special value me can be used to indicate the authenticated user.
uhlStartHistoryId :: Lens' UsersHistoryList (Maybe Word64) Source
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.
uhlPageToken :: Lens' UsersHistoryList (Maybe Text) Source
Page token to retrieve a specific page of results in the list.
uhlLabelId :: Lens' UsersHistoryList (Maybe Text) Source
Only return messages with a label matching the ID.
uhlMaxResults :: Lens' UsersHistoryList Word32 Source
The maximum number of history records to return.