Copyright	(c) 2015-2016 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

Contents

REST Resource
Creating a Request
Request Lenses

Description

Lists the messages in the user's mailbox.

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

Synopsis

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 :: 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 :: 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.

Instances

Eq UsersMessagesList Source #
Instance details Defined in Network.Google.Resource.Gmail.Users.Messages.List Methods (==) :: UsersMessagesList -> UsersMessagesList -> Bool # (/=) :: UsersMessagesList -> UsersMessagesList -> Bool #
Data UsersMessagesList Source #
Instance details Defined in Network.Google.Resource.Gmail.Users.Messages.List Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UsersMessagesList -> c UsersMessagesList # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UsersMessagesList # toConstr :: UsersMessagesList -> Constr # dataTypeOf :: UsersMessagesList -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UsersMessagesList) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UsersMessagesList) # gmapT :: (forall b. Data b => b -> b) -> UsersMessagesList -> UsersMessagesList # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UsersMessagesList -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UsersMessagesList -> r # gmapQ :: (forall d. Data d => d -> u) -> UsersMessagesList -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> UsersMessagesList -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> UsersMessagesList -> m UsersMessagesList # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UsersMessagesList -> m UsersMessagesList # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UsersMessagesList -> m UsersMessagesList #
Show UsersMessagesList Source #
Instance details Defined in Network.Google.Resource.Gmail.Users.Messages.List Methods showsPrec :: Int -> UsersMessagesList -> ShowS # show :: UsersMessagesList -> String # showList :: [UsersMessagesList] -> ShowS #
Generic UsersMessagesList Source #
Instance details Defined in Network.Google.Resource.Gmail.Users.Messages.List Associated Types type Rep UsersMessagesList :: Type -> Type # Methods from :: UsersMessagesList -> Rep UsersMessagesList x # to :: Rep UsersMessagesList x -> UsersMessagesList #
GoogleRequest UsersMessagesList Source #
Instance details Defined in Network.Google.Resource.Gmail.Users.Messages.List Associated Types type Rs UsersMessagesList :: Type # type Scopes UsersMessagesList :: [Symbol] # Methods requestClient :: UsersMessagesList -> GClient (Rs UsersMessagesList) #
type Rep UsersMessagesList Source #
Instance details Defined in Network.Google.Resource.Gmail.Users.Messages.List type Rep UsersMessagesList = D1 (MetaData "UsersMessagesList" "Network.Google.Resource.Gmail.Users.Messages.List" "gogol-gmail-0.4.0-EDJmLuxza63I9QV4rXNgT4" False) (C1 (MetaCons "UsersMessagesList'" PrefixI True) ((S1 (MetaSel (Just "_umlQ") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_umlUserId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_umlIncludeSpamTrash") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool))) :: (S1 (MetaSel (Just "_umlLabelIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 (MetaSel (Just "_umlPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_umlMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Word32))))))
type Scopes UsersMessagesList Source #
Instance details Defined in Network.Google.Resource.Gmail.Users.Messages.List type Scopes UsersMessagesList = "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 UsersMessagesList Source #
Instance details Defined in Network.Google.Resource.Gmail.Users.Messages.List type Rs UsersMessagesList = ListMessagesResponse

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

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.