package gapi-ocaml

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type
module HistoryTypes : sig ... end
val list : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?maxResults:int -> ?historyTypes:HistoryTypes.t list -> ?labelId:string -> ?pageToken:string -> ?startHistoryId:string -> userId:string -> GapiConversation.Session.t -> GapiGmailV1Model.ListHistoryResponse.t * GapiConversation.Session.t

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

  • parameter base_url

    Service endpoint base URL (defaults to "https://www.googleapis.com/gmail/v1/users/").

  • parameter std_params

    Optional standard parameters.

  • parameter maxResults

    The maximum number of history records to return.

  • parameter historyTypes

    History types to be returned by the function

  • parameter labelId

    Only return messages with a label matching the ID.

  • parameter pageToken

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

  • parameter startHistoryId

    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.

  • parameter userId

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