* $gmailService = new Google_Service_Gmail(...); * $threads = $gmailService->threads; * */ class Google_Service_Gmail_Resource_UsersThreads extends Google_Service_Resource { /** * Immediately and permanently deletes the specified thread. This operation * cannot be undone. Prefer `threads.trash` instead. (threads.delete) * * @param string $userId The user's email address. The special value `me` can be * used to indicate the authenticated user. * @param string $id ID of the Thread to delete. * @param array $optParams Optional parameters. */ public function delete($userId, $id, $optParams = array()) { $params = array('userId' => $userId, 'id' => $id); $params = array_merge($params, $optParams); return $this->call('delete', array($params)); } /** * Gets the specified thread. (threads.get) * * @param string $userId The user's email address. The special value `me` can be * used to indicate the authenticated user. * @param string $id The ID of the thread to retrieve. * @param array $optParams Optional parameters. * * @opt_param string format The format to return the messages in. * @opt_param string metadataHeaders When given and format is METADATA, only * include headers specified. * @return Google_Service_Gmail_Thread */ public function get($userId, $id, $optParams = array()) { $params = array('userId' => $userId, 'id' => $id); $params = array_merge($params, $optParams); return $this->call('get', array($params), "Google_Service_Gmail_Thread"); } /** * Lists the threads in the user's mailbox. (threads.listUsersThreads) * * @param string $userId The user's email address. The special value `me` can be * used to indicate the authenticated user. * @param array $optParams Optional parameters. * * @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 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. * @opt_param string maxResults Maximum number of threads to return. * @opt_param string labelIds Only return threads with labels that match all of * the specified label IDs. * @return Google_Service_Gmail_ListThreadsResponse */ public function listUsersThreads($userId, $optParams = array()) { $params = array('userId' => $userId); $params = array_merge($params, $optParams); return $this->call('list', array($params), "Google_Service_Gmail_ListThreadsResponse"); } /** * Modifies the labels applied to the thread. This applies to all messages in * the thread. (threads.modify) * * @param string $userId The user's email address. The special value `me` can be * used to indicate the authenticated user. * @param string $id The ID of the thread to modify. * @param Google_Service_Gmail_ModifyThreadRequest $postBody * @param array $optParams Optional parameters. * @return Google_Service_Gmail_Thread */ public function modify($userId, $id, Google_Service_Gmail_ModifyThreadRequest $postBody, $optParams = array()) { $params = array('userId' => $userId, 'id' => $id, 'postBody' => $postBody); $params = array_merge($params, $optParams); return $this->call('modify', array($params), "Google_Service_Gmail_Thread"); } /** * Moves the specified thread to the trash. (threads.trash) * * @param string $userId The user's email address. The special value `me` can be * used to indicate the authenticated user. * @param string $id The ID of the thread to Trash. * @param array $optParams Optional parameters. * @return Google_Service_Gmail_Thread */ public function trash($userId, $id, $optParams = array()) { $params = array('userId' => $userId, 'id' => $id); $params = array_merge($params, $optParams); return $this->call('trash', array($params), "Google_Service_Gmail_Thread"); } /** * Removes the specified thread from the trash. (threads.untrash) * * @param string $userId The user's email address. The special value `me` can be * used to indicate the authenticated user. * @param string $id The ID of the thread to remove from Trash. * @param array $optParams Optional parameters. * @return Google_Service_Gmail_Thread */ public function untrash($userId, $id, $optParams = array()) { $params = array('userId' => $userId, 'id' => $id); $params = array_merge($params, $optParams); return $this->call('untrash', array($params), "Google_Service_Gmail_Thread"); } }