Google_Service_Gmail_UsersThreads_Resource Class Reference

The "threads" collection of methods. More...

Inheritance diagram for Google_Service_Gmail_UsersThreads_Resource:

Public Member Functions
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.
	delete ($userId, $id, $optParams=array())
	Immediately and permanently deletes the specified thread.
	get ($userId, $id, $optParams=array())
	Gets the specified thread.
	listUsersThreads ($userId, $optParams=array())
	Lists the threads in the user's mailbox.
	modify ($userId, $id, Google_Service_Gmail_ModifyThreadRequest $postBody, $optParams=array())
	Modifies the labels applied to the thread.
	trash ($userId, $id, $optParams=array())
	Moves the specified thread to the trash.
	untrash ($userId, $id, $optParams=array())
	Removes the specified thread from the trash.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "threads" collection of methods.

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

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

delete()

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

Immediately and permanently deletes the specified thread.

This operation cannot be undone. Prefer threads.trash instead. (threads.delete)

Parameters

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

get()

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

Gets the specified thread.

(threads.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 thread to retrieve.
array	$optParams	Optional parameters.

@opt_param string metadataHeaders When given and format is METADATA, only include headers specified. @opt_param string format The format to return the messages in.

Return values

Google_Service_Gmail_Thread

listUsersThreads()

Google_Service_Gmail_UsersThreads_Resource::listUsersThreads	(		$userId,
			$optParams = array() )

Lists the threads in the user's mailbox.

(threads.listUsersThreads)

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 maxResults Maximum number of threads to return. @opt_param string q Only return threads matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread". @opt_param string pageToken Page token to retrieve a specific page of results in the list. @opt_param bool includeSpamTrash Include threads from SPAM and TRASH in the results. @opt_param string labelIds Only return threads with labels that match all of the specified label IDs.

Return values

Google_Service_Gmail_ListThreadsResponse

modify()

Google_Service_Gmail_UsersThreads_Resource::modify	(		$userId,
			$id,
		Google_Service_Gmail_ModifyThreadRequest	$postBody,
			$optParams = array() )

Modifies the labels applied to the thread.

This applies to all messages in the thread. (threads.modify)

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 thread to modify.
Google_ModifyThreadRequest	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Gmail_Thread

trash()

Google_Service_Gmail_UsersThreads_Resource::trash	(		$userId,
			$id,
			$optParams = array() )

Moves the specified thread to the trash.

(threads.trash)

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 thread to Trash.
array	$optParams	Optional parameters.

Return values

Google_Service_Gmail_Thread

untrash()

Google_Service_Gmail_UsersThreads_Resource::untrash	(		$userId,
			$id,
			$optParams = array() )

Removes the specified thread from the trash.

(threads.untrash)

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 thread to remove from Trash.
array	$optParams	Optional parameters.

Return values

Google_Service_Gmail_Thread

---

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

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