Documentation

Google_Service_Gmail_Resource_UsersLabels extends Google_Service_Resource
in package

Application

The "labels" collection of methods.

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

$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.
create() : Google_Service_Gmail_Label: Creates a new label. (labels.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : mixed: Immediately and permanently deletes the specified label and removes it from any messages and threads that it is applied to. (labels.delete)
get() : Google_Service_Gmail_Label: Gets the specified label. (labels.get)
listUsersLabels() : Google_Service_Gmail_ListLabelsResponse: Lists all labels in the user's mailbox. (labels.listUsersLabels)
patch() : Google_Service_Gmail_Label: Patch the specified label. (labels.patch)
update() : Google_Service_Gmail_Label: Updates the specified label. (labels.update)
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 —

create()

Creates a new label. (labels.create)


    public
                create(string $userId, Google_Service_Gmail_Label $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Gmail_Label

Parameters

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

Return values

Google_Service_Gmail_Label —

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 label and removes it from any messages and threads that it is applied to. (labels.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: The ID of the label to delete.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

mixed —

get()

Gets the specified label. (labels.get)


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

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 label to retrieve.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Gmail_Label —

listUsersLabels()

Lists all labels in the user's mailbox. (labels.listUsersLabels)


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

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_ListLabelsResponse —

patch()

Patch the specified label. (labels.patch)


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

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 label to update.
$postBody : Google_Service_Gmail_Label
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Gmail_Label —

update()

Updates the specified label. (labels.update)


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

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 label to update.
$postBody : Google_Service_Gmail_Label
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Gmail_Label —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —