Documentation

Google_Service_Gmail_Resource_UsersThreads extends Google_Service_Resource
in package

Application

The "threads" collection of methods.

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

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : mixed: Immediately and permanently deletes the specified thread. This operation cannot be undone. Prefer `threads.trash` instead. (threads.delete)
get() : Google_Service_Gmail_Thread: Gets the specified thread. (threads.get)
listUsersThreads() : Google_Service_Gmail_ListThreadsResponse: Lists the threads in the user's mailbox. (threads.listUsersThreads)
modify() : Google_Service_Gmail_Thread: Modifies the labels applied to the thread. This applies to all messages in the thread. (threads.modify)
trash() : Google_Service_Gmail_Thread: Moves the specified thread to the trash. (threads.trash)
untrash() : Google_Service_Gmail_Thread: Removes the specified thread from the trash. (threads.untrash)
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$serviceName


    private
        string
    $serviceName

$servicePath


    private
        string
    $servicePath

$stackParameters


    private
        mixed
    $stackParameters
     = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

call()

TODO: This function needs simplifying.


    public
                call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass

Parameters

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.


    public
                createRequestUri(string $restPath, array<string|int, mixed> $params) : string

Parameters

$restPath : string
$params : array<string|int, mixed>

Return values

string —

$requestUrl

delete()

Immediately and permanently deletes the specified thread. This operation cannot be undone. Prefer `threads.trash` instead. (threads.delete)


    public
                delete(string $userId, string $id[, array<string|int, mixed> $optParams = array() ]) : mixed

Parameters

$userId : string: The user's email address. The special value me can be used to indicate the authenticated user.
$id : string: ID of the Thread to delete.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

mixed —

get()

Gets the specified thread. (threads.get)


    public
                get(string $userId, string $id[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Gmail_Thread

Parameters

$userId : string: The user's email address. The special value me can be used to indicate the authenticated user.
$id : string: The ID of the thread to retrieve.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Gmail_Thread —

listUsersThreads()

Lists the threads in the user's mailbox. (threads.listUsersThreads)


    public
                listUsersThreads(string $userId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Gmail_ListThreadsResponse

Parameters

$userId : string: The user's email address. The special value me can be used to indicate the authenticated user.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Gmail_ListThreadsResponse —

modify()

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


    public
                modify(string $userId, string $id, Google_Service_Gmail_ModifyThreadRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Gmail_Thread

Parameters

$userId : string: The user's email address. The special value me can be used to indicate the authenticated user.
$id : string: The ID of the thread to modify.
$postBody : Google_Service_Gmail_ModifyThreadRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Gmail_Thread —

trash()

Moves the specified thread to the trash. (threads.trash)


    public
                trash(string $userId, string $id[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Gmail_Thread

Parameters

$userId : string: The user's email address. The special value me can be used to indicate the authenticated user.
$id : string: The ID of the thread to Trash.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Gmail_Thread —

untrash()

Removes the specified thread from the trash. (threads.untrash)


    public
                untrash(string $userId, string $id[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Gmail_Thread

Parameters

$userId : string: The user's email address. The special value me can be used to indicate the authenticated user.
$id : string: The ID of the thread to remove from Trash.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Gmail_Thread —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —