Class Google_Service_Gmail_UsersSettingsDelegates_Resource
The "delegates" collection of methods. Typical usage is:
$gmailService = new Google_Service_Gmail(...);
$delegates = $gmailService->delegates;
-
Google_Service_Resource
-
Google_Service_Gmail_UsersSettingsDelegates_Resource
Located at Gmail.php
Methods summary
public
Google_Service_Gmail_Delegate
|
#
create( string $userId, Google_Service_Gmail_Delegate $postBody, array $optParams = array() )
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.
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.
This method is only available to service account clients that have been
delegated domain-wide authority. (delegates.create)
Parameters
- $userId
- User's email address. The special value "me" can be used to indicate the
authenticated user.
- $postBody
- $optParams
- Optional parameters.
Returns
|
public
|
#
delete( string $userId, string $delegateEmail, array $optParams = array() )
Removes the specified delegate (which can be of any verification status), and
revokes any verification that may have been required for using it.
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)
Parameters
- $userId
- User's email address. The special value "me" can be used to indicate the
authenticated user.
- $delegateEmail
- The email address of the user to be removed as a delegate.
- $optParams
- Optional parameters.
|
public
Google_Service_Gmail_Delegate
|
#
get( string $userId, string $delegateEmail, array $optParams = array() )
Gets the specified 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)
Parameters
- $userId
- User's email address. The special value "me" can be used to indicate the
authenticated user.
- $delegateEmail
- The email address of the user whose delegate relationship is to be retrieved.
- $optParams
- Optional parameters.
Returns
|