Documentation

Google_Service_Gmail_Resource_Users extends Google_Service_Resource
in package

The "users" collection of methods.

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

Table of Contents

$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.
getProfile()  : Google_Service_Gmail_Profile
Gets the current user's Gmail profile. (users.getProfile)
stop()  : mixed
Stop receiving push notifications for the given user mailbox. (users.stop)
watch()  : Google_Service_Gmail_WatchResponse
Set up or update a push notification watch on the given user mailbox.
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$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'))

Methods

__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
Tags
throws
Google_Exception
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>
Tags
static
Return values
string —

$requestUrl

getProfile()

Gets the current user's Gmail profile. (users.getProfile)

public getProfile(string $userId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Gmail_Profile
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_Profile —

stop()

Stop receiving push notifications for the given user mailbox. (users.stop)

public stop(string $userId[, 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.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
mixed —

watch()

Set up or update a push notification watch on the given user mailbox.

public watch(string $userId, Google_Service_Gmail_WatchRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Gmail_WatchResponse

(users.watch)

Parameters
$userId : string

The user's email address. The special value me can be used to indicate the authenticated user.

$postBody : Google_Service_Gmail_WatchRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Gmail_WatchResponse —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results