Class Google_Service_Gmail_UsersThreads_Resource
The "threads" collection of methods. Typical usage is:
$gmailService = new Google_Service_Gmail(...);
$threads = $gmailService->threads;
-
Google_Service_Resource
-
Google_Service_Gmail_UsersThreads_Resource
Located at Gmail.php
Methods summary
public
|
#
delete( string $userId, string $id, array $optParams = array() )
Immediately and permanently deletes the specified thread. This operation
cannot be undone. Prefer threads.trash instead. (threads.delete)
Immediately and permanently deletes the specified thread. This operation
cannot be undone. Prefer threads.trash instead. (threads.delete)
Parameters
- $userId
- The user's email address. The special value me can be used to indicate the
authenticated user.
- $id
- ID of the Thread to delete.
- $optParams
- Optional parameters.
|
public
Google_Service_Gmail_Thread
|
#
get( string $userId, string $id, array $optParams = array() )
Gets the specified thread. (threads.get)
Gets the specified thread. (threads.get)
Parameters
- $userId
- The user's email address. The special value me can be used to indicate the
authenticated user.
- $id
- The ID of the thread to retrieve.
- $optParams
- Optional parameters.
Returns
Opt_param
string metadataHeaders When given and format is METADATA, only include headers
specified.
string format The format to return the messages in.
|
public
Google_Service_Gmail_ListThreadsResponse
|
#
listUsersThreads( string $userId, array $optParams = array() )
Lists the threads in the user's mailbox. (threads.listUsersThreads)
Lists the threads in the user's mailbox. (threads.listUsersThreads)
Parameters
- $userId
- The user's email address. The special value me can be used to indicate the
authenticated user.
- $optParams
- Optional parameters.
Returns
Opt_param
string pageToken Page token to retrieve a specific page of results in the list.
string labelIds Only return threads with labels that match all of the specified
label IDs.
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". Parameter cannot be used when accessing the api using
the gmail.metadata scope.
string maxResults Maximum number of threads to return.
bool includeSpamTrash Include threads from SPAM and TRASH in the results.
|
public
Google_Service_Gmail_Thread
|
#
modify( string $userId, string $id, Google_Service_Gmail_ModifyThreadRequest $postBody, array $optParams = array() )
Modifies the labels applied to the thread. This applies to all messages in
the thread. (threads.modify)
Modifies the labels applied to the thread. This applies to all messages in
the thread. (threads.modify)
Parameters
- $userId
- The user's email address. The special value me can be used to indicate the
authenticated user.
- $id
- The ID of the thread to modify.
- $postBody
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_Gmail_Thread
|
#
trash( string $userId, string $id, array $optParams = array() )
Moves the specified thread to the trash. (threads.trash)
Moves the specified thread to the trash. (threads.trash)
Parameters
- $userId
- The user's email address. The special value me can be used to indicate the
authenticated user.
- $id
- The ID of the thread to Trash.
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_Gmail_Thread
|
#
untrash( string $userId, string $id, array $optParams = array() )
Removes the specified thread from the trash. (threads.untrash)
Removes the specified thread from the trash. (threads.untrash)
Parameters
- $userId
- The user's email address. The special value me can be used to indicate the
authenticated user.
- $id
- The ID of the thread to remove from Trash.
- $optParams
- Optional parameters.
Returns
|