GoogleApi.Gmail.V1.Api.Users.gmail_users_history_list

You're seeing just the function gmail_users_history_list, go back to GoogleApi.Gmail.V1.Api.Users module for more information.
Link to this function

gmail_users_history_list(connection, user_id, optional_params \\ [], opts \\ [])

View Source

Specs

gmail_users_history_list(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Gmail.V1.Model.ListHistoryResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
  • user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :historyTypes (type: list(String.t)) - History types to be returned by the function
    • :labelId (type: String.t) - Only return messages with a label matching the ID.
    • :maxResults (type: integer()) - The maximum number of history records to return.
    • :pageToken (type: String.t) - Page token to retrieve a specific page of results in the list.
    • :startHistoryId (type: String.t) - 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.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Gmail.V1.Model.ListHistoryResponse{}} on success
  • {:error, info} on failure