Documentation

Google_Service_Gmail_Resource_UsersSettingsDelegates extends Google_Service_Resource
in package

The "delegates" collection of methods.

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

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.
create()  : Google_Service_Gmail_Delegate
Adds a delegate with its verification status set directly to `accepted`, without sending any verification email. The delegate user must be a member of the same G Suite organization as the delegator user. Gmail imposes limitations on the number of delegates and delegators each user in a G Suite organization can have. These limits depend on your organization, but in general each user can have up to 25 delegates and up to 10 delegators. Note that a delegate user must be referred to by their primary email address, and not an email alias. Also note that when a new delegate is created, there may be up to a one minute delay before the new delegate is available for use.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : mixed
Removes the specified delegate (which can be of any verification status), and revokes any verification that may have been required for using it. Note that a delegate user must be referred to by their primary email address, and not an email alias. This method is only available to service account clients that have been delegated domain-wide authority. (delegates.delete)
get()  : Google_Service_Gmail_Delegate
Gets the specified delegate. Note that a delegate user must be referred to by their primary email address, and not an email alias. This method is only available to service account clients that have been delegated domain-wide authority. (delegates.get)
listUsersSettingsDelegates()  : Google_Service_Gmail_ListDelegatesResponse
Lists the delegates for the specified account. This method is only available to service account clients that have been delegated domain-wide authority.
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 —

create()

Adds a delegate with its verification status set directly to `accepted`, without sending any verification email. The delegate user must be a member of the same G Suite organization as the delegator user. Gmail imposes limitations on the number of delegates and delegators each user in a G Suite organization can have. These limits depend on your organization, but in general each user can have up to 25 delegates and up to 10 delegators. Note that a delegate user must be referred to by their primary email address, and not an email alias. Also note that when a new delegate is created, there may be up to a one minute delay before the new delegate is available for use.

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

This method is only available to service account clients that have been delegated domain-wide authority. (delegates.create)

Parameters
$userId : string

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

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

Optional parameters.

Return values
Google_Service_Gmail_Delegate —

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

delete()

Removes the specified delegate (which can be of any verification status), and revokes any verification that may have been required for using it. Note that a delegate user must be referred to by their primary email address, and not an email alias. This method is only available to service account clients that have been delegated domain-wide authority. (delegates.delete)

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

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

$delegateEmail : string

The email address of the user to be removed as a delegate.

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

Optional parameters.

Return values
mixed —

get()

Gets the specified delegate. Note that a delegate user must be referred to by their primary email address, and not an email alias. This method is only available to service account clients that have been delegated domain-wide authority. (delegates.get)

public get(string $userId, string $delegateEmail[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Gmail_Delegate
Parameters
$userId : string

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

$delegateEmail : string

The email address of the user whose delegate relationship is to be retrieved.

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

Optional parameters.

Return values
Google_Service_Gmail_Delegate —

listUsersSettingsDelegates()

Lists the delegates for the specified account. This method is only available to service account clients that have been delegated domain-wide authority.

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

(delegates.listUsersSettingsDelegates)

Parameters
$userId : string

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

convertToArrayAndStripNulls()

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

Search results