Google_Service_Gmail_UsersLabels_Resource Class Reference

The "labels" collection of methods. More...

Inheritance diagram for Google_Service_Gmail_UsersLabels_Resource:

Public Member Functions
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.
	create ($userId, Google_Service_Gmail_Label $postBody, $optParams=array())
	Creates a new label.
	delete ($userId, $id, $optParams=array())
	Immediately and permanently deletes the specified label and removes it from any messages and threads that it is applied to.
	get ($userId, $id, $optParams=array())
	Gets the specified label.
	listUsersLabels ($userId, $optParams=array())
	Lists all labels in the user's mailbox.
	patch ($userId, $id, Google_Service_Gmail_Label $postBody, $optParams=array())
	Updates the specified label.
	update ($userId, $id, Google_Service_Gmail_Label $postBody, $optParams=array())
	Updates the specified label.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "labels" collection of methods.

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

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

create()

Google_Service_Gmail_UsersLabels_Resource::create	(		$userId,
		Google_Service_Gmail_Label	$postBody,
			$optParams = array() )

Creates a new label.

(labels.create)

Parameters

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

Return values

Google_Service_Gmail_Label

delete()

Google_Service_Gmail_UsersLabels_Resource::delete	(		$userId,
			$id,
			$optParams = array() )

Immediately and permanently deletes the specified label and removes it from any messages and threads that it is applied to.

(labels.delete)

Parameters

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

get()

Google_Service_Gmail_UsersLabels_Resource::get	(		$userId,
			$id,
			$optParams = array() )

Gets the specified label.

(labels.get)

Parameters

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

Return values

Google_Service_Gmail_Label

listUsersLabels()

Google_Service_Gmail_UsersLabels_Resource::listUsersLabels	(		$userId,
			$optParams = array() )

Lists all labels in the user's mailbox.

(labels.listUsersLabels)

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_ListLabelsResponse

patch()

Google_Service_Gmail_UsersLabels_Resource::patch	(		$userId,
			$id,
		Google_Service_Gmail_Label	$postBody,
			$optParams = array() )

Updates the specified label.

This method supports patch semantics. (labels.patch)

Parameters

string	$userId	The user's email address. The special value me can be used to indicate the authenticated user.
string	$id	The ID of the label to update.
Google_Label	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Gmail_Label

update()

Google_Service_Gmail_UsersLabels_Resource::update	(		$userId,
			$id,
		Google_Service_Gmail_Label	$postBody,
			$optParams = array() )

Updates the specified label.

(labels.update)

Parameters

string	$userId	The user's email address. The special value me can be used to indicate the authenticated user.
string	$id	The ID of the label to update.
Google_Label	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Gmail_Label

---

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

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