Google_Service_Gmail_UsersHistory_Resource Class Reference

The "history" collection of methods. More...

Inheritance diagram for Google_Service_Gmail_UsersHistory_Resource:

Public Member Functions
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.
	listUsersHistory ($userId, $optParams=array())
	Lists the history of all changes to the given mailbox.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "history" collection of methods.

Typical usage is: $gmailService = new Google_Service_Gmail(...); $history = $gmailService->history;

Member Function Documentation

call()

Google_Service_Resource::call ( $name, $arguments, $expected_class = null )

inherited

TODO: This function needs simplifying.

Parameters

$name
$arguments
$expected_class	- optional, the expected class name

Return values

Google_Http_Request|expected_class

Exceptions

Google_Exception

listUsersHistory()

Google_Service_Gmail_UsersHistory_Resource::listUsersHistory	(		$userId,
			$optParams = array() )

Lists the history of all changes to the given mailbox.

History results are returned in chronological order (increasing historyId). (history.listUsersHistory)

Parameters

string	$userId	The user's email address. The special value me can be used to indicate the authenticated user.
array	$optParams	Optional parameters.

@opt_param string pageToken Page token to retrieve a specific page of results in the list. @opt_param string maxResults The maximum number of history records to return. @opt_param string labelId Only return messages with a label matching the ID. @opt_param string 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.

Return values

Google_Service_Gmail_ListHistoryResponse

---

The documentation for this class was generated from the following file:

• lib/google/src/Google/Service/Gmail.php