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.Drafts.List

Contents

REST Resource
Creating a Request
Request Lenses

Description

Lists the drafts in the user's mailbox.

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

Synopsis

type UsersDraftsListResource = "gmail" :> ("v1" :> ("users" :> (Capture "userId" Text :> ("drafts" :> (QueryParam "q" Text :> (QueryParam "includeSpamTrash" Bool :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] ListDraftsResponse)))))))))
usersDraftsList :: UsersDraftsList
data UsersDraftsList
udlQ :: Lens' UsersDraftsList (Maybe Text)
udlUserId :: Lens' UsersDraftsList Text
udlIncludeSpamTrash :: Lens' UsersDraftsList Bool
udlPageToken :: Lens' UsersDraftsList (Maybe Text)
udlMaxResults :: Lens' UsersDraftsList Word32

REST Resource

type UsersDraftsListResource = "gmail" :> ("v1" :> ("users" :> (Capture "userId" Text :> ("drafts" :> (QueryParam "q" Text :> (QueryParam "includeSpamTrash" Bool :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] ListDraftsResponse))))))))) Source #

A resource alias for gmail.users.drafts.list method which the UsersDraftsList request conforms to.

Creating a Request

usersDraftsList :: UsersDraftsList Source #

Creates a value of UsersDraftsList with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data UsersDraftsList Source #

Lists the drafts in the user's mailbox.

See: usersDraftsList smart constructor.

Instances

Eq UsersDraftsList Source #
Instance details Defined in Network.Google.Resource.Gmail.Users.Drafts.List Methods (==) :: UsersDraftsList -> UsersDraftsList -> Bool # (/=) :: UsersDraftsList -> UsersDraftsList -> Bool #
Data UsersDraftsList Source #
Instance details Defined in Network.Google.Resource.Gmail.Users.Drafts.List Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UsersDraftsList -> c UsersDraftsList # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UsersDraftsList # toConstr :: UsersDraftsList -> Constr # dataTypeOf :: UsersDraftsList -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UsersDraftsList) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UsersDraftsList) # gmapT :: (forall b. Data b => b -> b) -> UsersDraftsList -> UsersDraftsList # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UsersDraftsList -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UsersDraftsList -> r # gmapQ :: (forall d. Data d => d -> u) -> UsersDraftsList -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> UsersDraftsList -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> UsersDraftsList -> m UsersDraftsList # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UsersDraftsList -> m UsersDraftsList # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UsersDraftsList -> m UsersDraftsList #
Show UsersDraftsList Source #
Instance details Defined in Network.Google.Resource.Gmail.Users.Drafts.List Methods showsPrec :: Int -> UsersDraftsList -> ShowS # show :: UsersDraftsList -> String # showList :: [UsersDraftsList] -> ShowS #
Generic UsersDraftsList Source #
Instance details Defined in Network.Google.Resource.Gmail.Users.Drafts.List Associated Types type Rep UsersDraftsList :: Type -> Type # Methods from :: UsersDraftsList -> Rep UsersDraftsList x # to :: Rep UsersDraftsList x -> UsersDraftsList #
GoogleRequest UsersDraftsList Source #
Instance details Defined in Network.Google.Resource.Gmail.Users.Drafts.List Associated Types type Rs UsersDraftsList :: Type # type Scopes UsersDraftsList :: [Symbol] # Methods requestClient :: UsersDraftsList -> GClient (Rs UsersDraftsList) #
type Rep UsersDraftsList Source #
Instance details Defined in Network.Google.Resource.Gmail.Users.Drafts.List type Rep UsersDraftsList = D1 (MetaData "UsersDraftsList" "Network.Google.Resource.Gmail.Users.Drafts.List" "gogol-gmail-0.4.0-EDJmLuxza63I9QV4rXNgT4" False) (C1 (MetaCons "UsersDraftsList'" PrefixI True) ((S1 (MetaSel (Just "_udlQ") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_udlUserId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :: (S1 (MetaSel (Just "_udlIncludeSpamTrash") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool) :: (S1 (MetaSel (Just "_udlPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_udlMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Word32))))))
type Scopes UsersDraftsList Source #
Instance details Defined in Network.Google.Resource.Gmail.Users.Drafts.List type Scopes UsersDraftsList = "https://mail.google.com/" ': ("https://www.googleapis.com/auth/gmail.compose" ': ("https://www.googleapis.com/auth/gmail.modify" ': ("https://www.googleapis.com/auth/gmail.readonly" ': ([] :: [Symbol]))))
type Rs UsersDraftsList Source #
Instance details Defined in Network.Google.Resource.Gmail.Users.Drafts.List type Rs UsersDraftsList = ListDraftsResponse

Request Lenses

udlQ :: Lens' UsersDraftsList (Maybe Text) Source #

Only return draft messages matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser'example.com rfc822msgid: is:unread".

udlUserId :: Lens' UsersDraftsList Text Source #

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

udlIncludeSpamTrash :: Lens' UsersDraftsList Bool Source #

Include drafts from SPAM and TRASH in the results.

udlPageToken :: Lens' UsersDraftsList (Maybe Text) Source #

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

udlMaxResults :: Lens' UsersDraftsList Word32 Source #

Maximum number of drafts to return.