Overview

Classes

  • Google_Service_Gmail
  • Google_Service_Gmail_AutoForwarding
  • Google_Service_Gmail_BatchDeleteMessagesRequest
  • Google_Service_Gmail_BatchModifyMessagesRequest
  • Google_Service_Gmail_Delegate
  • Google_Service_Gmail_Draft
  • Google_Service_Gmail_Filter
  • Google_Service_Gmail_FilterAction
  • Google_Service_Gmail_FilterCriteria
  • Google_Service_Gmail_ForwardingAddress
  • Google_Service_Gmail_History
  • Google_Service_Gmail_HistoryLabelAdded
  • Google_Service_Gmail_HistoryLabelRemoved
  • Google_Service_Gmail_HistoryMessageAdded
  • Google_Service_Gmail_HistoryMessageDeleted
  • Google_Service_Gmail_ImapSettings
  • Google_Service_Gmail_Label
  • Google_Service_Gmail_LabelColor
  • Google_Service_Gmail_LanguageSettings
  • Google_Service_Gmail_ListDelegatesResponse
  • Google_Service_Gmail_ListDraftsResponse
  • Google_Service_Gmail_ListFiltersResponse
  • Google_Service_Gmail_ListForwardingAddressesResponse
  • Google_Service_Gmail_ListHistoryResponse
  • Google_Service_Gmail_ListLabelsResponse
  • Google_Service_Gmail_ListMessagesResponse
  • Google_Service_Gmail_ListSendAsResponse
  • Google_Service_Gmail_ListSmimeInfoResponse
  • Google_Service_Gmail_ListThreadsResponse
  • Google_Service_Gmail_Message
  • Google_Service_Gmail_MessagePart
  • Google_Service_Gmail_MessagePartBody
  • Google_Service_Gmail_MessagePartHeader
  • Google_Service_Gmail_ModifyMessageRequest
  • Google_Service_Gmail_ModifyThreadRequest
  • Google_Service_Gmail_PopSettings
  • Google_Service_Gmail_Profile
  • Google_Service_Gmail_SendAs
  • Google_Service_Gmail_SmimeInfo
  • Google_Service_Gmail_SmtpMsa
  • Google_Service_Gmail_Thread
  • Google_Service_Gmail_Users_Resource
  • Google_Service_Gmail_UsersDrafts_Resource
  • Google_Service_Gmail_UsersHistory_Resource
  • Google_Service_Gmail_UsersLabels_Resource
  • Google_Service_Gmail_UsersMessages_Resource
  • Google_Service_Gmail_UsersMessagesAttachments_Resource
  • Google_Service_Gmail_UsersSettings_Resource
  • Google_Service_Gmail_UsersSettingsDelegates_Resource
  • Google_Service_Gmail_UsersSettingsFilters_Resource
  • Google_Service_Gmail_UsersSettingsForwardingAddresses_Resource
  • Google_Service_Gmail_UsersSettingsSendAs_Resource
  • Google_Service_Gmail_UsersSettingsSendAsSmimeInfo_Resource
  • Google_Service_Gmail_UsersThreads_Resource
  • Google_Service_Gmail_VacationSettings
  • Google_Service_Gmail_WatchRequest
  • Google_Service_Gmail_WatchResponse
  • Overview
  • Class
  • Tree

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
Extended by 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

Google_Service_Gmail_Thread
Google_Service_Gmail_Thread

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

Google_Service_Gmail_ListThreadsResponse
Google_Service_Gmail_ListThreadsResponse

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

Google_Service_Gmail_Thread
Google_Service_Gmail_Thread
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

Google_Service_Gmail_Thread
Google_Service_Gmail_Thread
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

Google_Service_Gmail_Thread
Google_Service_Gmail_Thread
© 2020 Google Inc.
Gmail API documentation generated by ApiGen 2.8.0