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