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

Contents

REST Resource
Creating a Request
Request Lenses

Description

Gets the specified message.

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

Synopsis

type UsersMessagesGetResource = "gmail" :> ("v1" :> ("users" :> (Capture "userId" Text :> ("messages" :> (Capture "id" Text :> (QueryParam "format" UsersMessagesGetFormat :> (QueryParams "metadataHeaders" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] Message))))))))
usersMessagesGet :: Text -> UsersMessagesGet
data UsersMessagesGet
umgFormat :: Lens' UsersMessagesGet UsersMessagesGetFormat
umgUserId :: Lens' UsersMessagesGet Text
umgId :: Lens' UsersMessagesGet Text
umgMetadataHeaders :: Lens' UsersMessagesGet [Text]

REST Resource

type UsersMessagesGetResource = "gmail" :> ("v1" :> ("users" :> (Capture "userId" Text :> ("messages" :> (Capture "id" Text :> (QueryParam "format" UsersMessagesGetFormat :> (QueryParams "metadataHeaders" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] Message)))))))) Source #

A resource alias for gmail.users.messages.get method which the UsersMessagesGet request conforms to.

Creating a Request

usersMessagesGet Source #

Arguments

:: Text	`umgId`
-> UsersMessagesGet

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

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

data UsersMessagesGet Source #

Gets the specified message.

See: usersMessagesGet smart constructor.

Instances

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

Request Lenses

umgFormat :: Lens' UsersMessagesGet UsersMessagesGetFormat Source #

The format to return the message in.

umgUserId :: Lens' UsersMessagesGet Text Source #

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

umgId :: Lens' UsersMessagesGet Text Source #

The ID of the message to retrieve.

umgMetadataHeaders :: Lens' UsersMessagesGet [Text] Source #

When given and format is METADATA, only include headers specified.