Network.Google.Resource.Gmail.Users.Threads.List

Lists the threads in the user's mailbox.

See: Gmail API Reference for gmail.users.threads.list.

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))))))))))

A resource alias for gmail.users.threads.list method which the UsersThreadsList request conforms to.

Creating a Request

usersThreadsList :: UsersThreadsList

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:

• utlQ
• utlUserId
• utlIncludeSpamTrash
• utlLabelIds
• utlPageToken
• utlMaxResults

data UsersThreadsList

Lists the threads in the user's mailbox.

See: usersThreadsList smart constructor.

Instances

Eq UsersThreadsList

Defined in Network.Google.Resource.Gmail.Users.Threads.List

Methods

(==) :: UsersThreadsList -> UsersThreadsList -> Bool

(/=) :: UsersThreadsList -> UsersThreadsList -> Bool

Data UsersThreadsList

Defined in Network.Google.Resource.Gmail.Users.Threads.List

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UsersThreadsList -> c UsersThreadsList

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UsersThreadsList

toConstr :: UsersThreadsList -> Constr

dataTypeOf :: UsersThreadsList -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UsersThreadsList)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UsersThreadsList)

gmapT :: (forall b. Data b => b -> b) -> UsersThreadsList -> UsersThreadsList

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UsersThreadsList -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UsersThreadsList -> r

gmapQ :: (forall d. Data d => d -> u) -> UsersThreadsList -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UsersThreadsList -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UsersThreadsList -> m UsersThreadsList

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UsersThreadsList -> m UsersThreadsList

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UsersThreadsList -> m UsersThreadsList

Show UsersThreadsList

Defined in Network.Google.Resource.Gmail.Users.Threads.List

Methods

showsPrec :: Int -> UsersThreadsList -> ShowS

show :: UsersThreadsList -> String

showList :: [UsersThreadsList] -> ShowS

Generic UsersThreadsList

Defined in Network.Google.Resource.Gmail.Users.Threads.List

Associated Types

type Rep UsersThreadsList :: Type -> Type

Methods

from :: UsersThreadsList -> Rep UsersThreadsList x

to :: Rep UsersThreadsList x -> UsersThreadsList

GoogleRequest UsersThreadsList

Defined in Network.Google.Resource.Gmail.Users.Threads.List

Associated Types

type Rs UsersThreadsList :: Type

type Scopes UsersThreadsList :: [Symbol]

Methods

requestClient :: UsersThreadsList -> GClient (Rs UsersThreadsList)

type Rep UsersThreadsList

Defined in Network.Google.Resource.Gmail.Users.Threads.List

type Rep UsersThreadsList = D1 (MetaData "UsersThreadsList" "Network.Google.Resource.Gmail.Users.Threads.List" "gogol-gmail-0.5.0-48uFK4VONYULgv1idP6U1t" False) (C1 (MetaCons "UsersThreadsList'" PrefixI True) ((S1 (MetaSel (Just "_utlQ") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_utlUserId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_utlIncludeSpamTrash") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool))) :*: (S1 (MetaSel (Just "_utlLabelIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 (MetaSel (Just "_utlPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_utlMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Word32))))))

type Scopes UsersThreadsList

Defined in Network.Google.Resource.Gmail.Users.Threads.List

type Scopes UsersThreadsList = "https://mail.google.com/" ': ("https://www.googleapis.com/auth/gmail.metadata" ': ("https://www.googleapis.com/auth/gmail.modify" ': ("https://www.googleapis.com/auth/gmail.readonly" ': ([] :: [Symbol]))))

type Rs UsersThreadsList

Defined in Network.Google.Resource.Gmail.Users.Threads.List

type Rs UsersThreadsList = ListThreadsResponse

Request Lenses

utlQ :: Lens' UsersThreadsList (Maybe Text)

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". Parameter cannot be used when accessing the api using the gmail.metadata scope.

utlUserId :: Lens' UsersThreadsList Text

The user's email address. The special value me can be used to indicate the authenticated user.

utlIncludeSpamTrash :: Lens' UsersThreadsList Bool

Include threads from SPAM and TRASH in the results.

utlLabelIds :: Lens' UsersThreadsList [Text]

Only return threads with labels that match all of the specified label IDs.

utlPageToken :: Lens' UsersThreadsList (Maybe Text)

Page token to retrieve a specific page of results in the list.

utlMaxResults :: Lens' UsersThreadsList Word32

Maximum number of threads to return.