Network.Google.Resource.Gmail.Users.Drafts.List

Lists the drafts in the user's mailbox.

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

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

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

Creating a Request

usersDraftsList :: UsersDraftsList

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:

• udlQ
• udlUserId
• udlIncludeSpamTrash
• udlPageToken
• udlMaxResults

data UsersDraftsList

Lists the drafts in the user's mailbox.

See: usersDraftsList smart constructor.

Instances

Eq UsersDraftsList

Methods

(==) :: UsersDraftsList -> UsersDraftsList -> Bool

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

Data UsersDraftsList

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

Methods

showsPrec :: Int -> UsersDraftsList -> ShowS

show :: UsersDraftsList -> String

showList :: [UsersDraftsList] -> ShowS

Generic UsersDraftsList

Associated Types

type Rep UsersDraftsList :: * -> *

Methods

from :: UsersDraftsList -> Rep UsersDraftsList x

to :: Rep UsersDraftsList x -> UsersDraftsList

GoogleRequest UsersDraftsList

Associated Types

type Rs UsersDraftsList :: *

type Scopes UsersDraftsList :: [Symbol]

Methods

requestClient :: UsersDraftsList -> Client (Rs UsersDraftsList)

type Rep UsersDraftsList

type Rep UsersDraftsList = D1 (MetaData "UsersDraftsList" "Network.Google.Resource.Gmail.Users.Drafts.List" "gogol-gmail-0.3.0-LsjK5jY5aBO3wn73Gztk4i" False) (C1 (MetaCons "UsersDraftsList'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_udlQ") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_udlUserId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) ((:*:) (S1 (MetaSel (Just Symbol "_udlIncludeSpamTrash") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool)) ((:*:) (S1 (MetaSel (Just Symbol "_udlPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_udlMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Word32)))))))

type Scopes UsersDraftsList

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

type Rs UsersDraftsList

type Rs UsersDraftsList = ListDraftsResponse

Request Lenses

udlQ :: Lens' UsersDraftsList (Maybe Text)

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

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

udlIncludeSpamTrash :: Lens' UsersDraftsList Bool

Include drafts from SPAM and TRASH in the results.

udlPageToken :: Lens' UsersDraftsList (Maybe Text)

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

udlMaxResults :: Lens' UsersDraftsList Word32

Maximum number of drafts to return.