UsersSettingsDelegates
class UsersSettingsDelegates extends Resource (View source)
The "delegates" collection of methods.
Typical usage is:
$gmailService = new Google\Service\Gmail(...);
$delegates = $gmailService->users_settings_delegates;Methods
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 Google Workspace organization as the delegator user. Gmail imposes
limitations on the number of delegates and delegators each user in a Google
Workspace 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.
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)
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)
Lists the delegates for the specified account. This method is only available to service account clients that have been delegated domain-wide authority.
Details
Delegate
create(string $userId, Delegate $postBody, array $optParams = [])
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 Google Workspace organization as the delegator user. Gmail imposes
limitations on the number of delegates and delegators each user in a Google
Workspace 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)
delete(string $userId, string $delegateEmail, array $optParams = [])
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)
Delegate
get(string $userId, string $delegateEmail, array $optParams = [])
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)
ListDelegatesResponse
listUsersSettingsDelegates(string $userId, array $optParams = [])
Lists the delegates for the specified account. This method is only available to service account clients that have been delegated domain-wide authority.
(delegates.listUsersSettingsDelegates)