| 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.Messages.List
Description
Lists the messages in the user's mailbox.
See: Gmail API Reference for gmail.users.messages.list.
- type UsersMessagesListResource = "gmail" :> ("v1" :> ("users" :> (Capture "userId" Text :> ("messages" :> (QueryParam "q" Text :> (QueryParam "includeSpamTrash" Bool :> (QueryParams "labelIds" Text :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get `[JSON]` ListMessagesResponse))))))))))
- usersMessagesList :: Text -> UsersMessagesList
- data UsersMessagesList
- umlQ :: Lens' UsersMessagesList (Maybe Text)
- umlUserId :: Lens' UsersMessagesList Text
- umlIncludeSpamTrash :: Lens' UsersMessagesList Bool
- umlLabelIds :: Lens' UsersMessagesList [Text]
- umlPageToken :: Lens' UsersMessagesList (Maybe Text)
- umlMaxResults :: Lens' UsersMessagesList Word32
REST Resource
type UsersMessagesListResource = "gmail" :> ("v1" :> ("users" :> (Capture "userId" Text :> ("messages" :> (QueryParam "q" Text :> (QueryParam "includeSpamTrash" Bool :> (QueryParams "labelIds" Text :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get `[JSON]` ListMessagesResponse)))))))))) Source
A resource alias for gmail.users.messages.list method which the
UsersMessagesList request conforms to.
Creating a Request
usersMessagesList :: Text -> UsersMessagesList Source
Creates a value of UsersMessagesList with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data UsersMessagesList Source
Lists the messages in the user's mailbox.
See: usersMessagesList smart constructor.
Request Lenses
umlQ :: Lens' UsersMessagesList (Maybe Text) Source
Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser'example.com rfc822msgid: is:unread".
umlUserId :: Lens' UsersMessagesList Text Source
The user's email address. The special value me can be used to indicate the authenticated user.
umlIncludeSpamTrash :: Lens' UsersMessagesList Bool Source
Include messages from SPAM and TRASH in the results.
umlLabelIds :: Lens' UsersMessagesList [Text] Source
Only return messages with labels that match all of the specified label IDs.
umlPageToken :: Lens' UsersMessagesList (Maybe Text) Source
Page token to retrieve a specific page of results in the list.
umlMaxResults :: Lens' UsersMessagesList Word32 Source
Maximum number of messages to return.