Google_Service_Gmail_Users_Resource Class Reference

The "users" collection of methods. More...

Inheritance diagram for Google_Service_Gmail_Users_Resource:

Public Member Functions
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.
	getProfile ($userId, $optParams=array())
	Gets the current user's Gmail profile.
	stop ($userId, $optParams=array())
	Stop receiving push notifications for the given user mailbox.
	watch ($userId, Google_Service_Gmail_WatchRequest $postBody, $optParams=array())
	Set up or update a push notification watch on the given user mailbox.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "users" collection of methods.

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

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

getProfile()

Google_Service_Gmail_Users_Resource::getProfile	(		$userId,
			$optParams = array() )

Gets the current user's Gmail profile.

(users.getProfile)

Parameters

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

Return values

Google_Service_Gmail_Profile

stop()

Google_Service_Gmail_Users_Resource::stop	(		$userId,
			$optParams = array() )

Stop receiving push notifications for the given user mailbox.

(users.stop)

Parameters

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

watch()

Google_Service_Gmail_Users_Resource::watch	(		$userId,
		Google_Service_Gmail_WatchRequest	$postBody,
			$optParams = array() )

Set up or update a push notification watch on the given user mailbox.

(users.watch)

Parameters

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

Return values

Google_Service_Gmail_WatchResponse

---

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

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