gogol-gmail-0.4.0: Google Gmail SDK.

Copyright(c) 2015-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Resource.Gmail.Users.History.List

Contents

Description

Lists the history of all changes to the given mailbox. History results are returned in chronological order (increasing historyId).

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

Synopsis

REST Resource

type UsersHistoryListResource = "gmail" :> ("v1" :> ("users" :> (Capture "userId" Text :> ("history" :> (QueryParams "historyTypes" UsersHistoryListHistoryTypes :> (QueryParam "startHistoryId" (Textual Word64) :> (QueryParam "pageToken" Text :> (QueryParam "labelId" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] ListHistoryResponse)))))))))) Source #

A resource alias for gmail.users.history.list method which the UsersHistoryList request conforms to.

Creating a Request

usersHistoryList :: UsersHistoryList Source #

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

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

data UsersHistoryList Source #

Lists the history of all changes to the given mailbox. History results are returned in chronological order (increasing historyId).

See: usersHistoryList smart constructor.

Instances
Eq UsersHistoryList Source # 
Instance details

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

Data UsersHistoryList Source # 
Instance details

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

Methods

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

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

toConstr :: UsersHistoryList -> Constr #

dataTypeOf :: UsersHistoryList -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> UsersHistoryList -> UsersHistoryList #

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

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

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

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

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

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

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

Show UsersHistoryList Source # 
Instance details

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

Generic UsersHistoryList Source # 
Instance details

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

Associated Types

type Rep UsersHistoryList :: Type -> Type #

GoogleRequest UsersHistoryList Source # 
Instance details

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

Associated Types

type Rs UsersHistoryList :: Type #

type Scopes UsersHistoryList :: [Symbol] #

type Rep UsersHistoryList Source # 
Instance details

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

type Rep UsersHistoryList = D1 (MetaData "UsersHistoryList" "Network.Google.Resource.Gmail.Users.History.List" "gogol-gmail-0.4.0-EDJmLuxza63I9QV4rXNgT4" False) (C1 (MetaCons "UsersHistoryList'" PrefixI True) ((S1 (MetaSel (Just "_uhlHistoryTypes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [UsersHistoryListHistoryTypes])) :*: (S1 (MetaSel (Just "_uhlUserId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_uhlStartHistoryId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Word64))))) :*: (S1 (MetaSel (Just "_uhlPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_uhlLabelId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_uhlMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Word32))))))
type Scopes UsersHistoryList Source # 
Instance details

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

type Scopes UsersHistoryList = "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 UsersHistoryList Source # 
Instance details

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

Request Lenses

uhlHistoryTypes :: Lens' UsersHistoryList [UsersHistoryListHistoryTypes] Source #

History types to be returned by the function

uhlUserId :: Lens' UsersHistoryList Text Source #

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

uhlStartHistoryId :: Lens' UsersHistoryList (Maybe Word64) Source #

Required. Returns history records after the specified startHistoryId. The supplied startHistoryId should be obtained from the historyId of a message, thread, or previous list response. History IDs increase chronologically but are not contiguous with random gaps in between valid IDs. Supplying an invalid or out of date startHistoryId typically returns an HTTP 404 error code. A historyId is typically valid for at least a week, but in some rare circumstances may be valid for only a few hours. If you receive an HTTP 404 error response, your application should perform a full sync. If you receive no nextPageToken in the response, there are no updates to retrieve and you can store the returned historyId for a future request.

uhlPageToken :: Lens' UsersHistoryList (Maybe Text) Source #

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

uhlLabelId :: Lens' UsersHistoryList (Maybe Text) Source #

Only return messages with a label matching the ID.

uhlMaxResults :: Lens' UsersHistoryList Word32 Source #

The maximum number of history records to return.