create(userId, body=None, x__xgafv=None)
Adds a delegate with its verification status set directly to
delete(userId, delegateEmail, x__xgafv=None)
Removes the specified delegate (which can be of any verification status),
get(userId, delegateEmail, x__xgafv=None)
Gets the specified delegate.
Lists the delegates for the specified account.
create(userId, body=None, x__xgafv=None)
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.
Args:
userId: string, User's email address. The special value "me"
can be used to indicate the authenticated user. (required)
body: object, The request body.
The object takes the form of:
{ # Settings for a delegate. Delegates can read, send, and delete messages, as
# well as view and add contacts, for the delegator's account. See
# <a href="https://support.google.com/mail/answer/138350">"Set up
# mail delegation"</a> for more information about delegates.
"delegateEmail": "A String", # The email address of the delegate.
"verificationStatus": "A String", # Indicates whether this address has been verified and can act as a delegate
# for the account. Read-only.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Settings for a delegate. Delegates can read, send, and delete messages, as
# well as view and add contacts, for the delegator's account. See
# <a href="https://support.google.com/mail/answer/138350">"Set up
# mail delegation"</a> for more information about delegates.
"delegateEmail": "A String", # The email address of the delegate.
"verificationStatus": "A String", # Indicates whether this address has been verified and can act as a delegate
# for the account. Read-only.
}
delete(userId, delegateEmail, x__xgafv=None)
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.
Args:
userId: string, User's email address. The special value "me"
can be used to indicate the authenticated user. (required)
delegateEmail: string, The email address of the user to be removed as a delegate. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
get(userId, delegateEmail, x__xgafv=None)
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.
Args:
userId: string, User's email address. The special value "me"
can be used to indicate the authenticated user. (required)
delegateEmail: string, The email address of the user whose delegate relationship is to be
retrieved. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Settings for a delegate. Delegates can read, send, and delete messages, as
# well as view and add contacts, for the delegator's account. See
# <a href="https://support.google.com/mail/answer/138350">"Set up
# mail delegation"</a> for more information about delegates.
"delegateEmail": "A String", # The email address of the delegate.
"verificationStatus": "A String", # Indicates whether this address has been verified and can act as a delegate
# for the account. Read-only.
}
list(userId, x__xgafv=None)
Lists the delegates for the specified account.
This method is only available to service account clients that have been
delegated domain-wide authority.
Args:
userId: string, User's email address. The special value "me"
can be used to indicate the authenticated user. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for the ListDelegates method.
"delegates": [ # List of the user's delegates (with any verification status).
{ # Settings for a delegate. Delegates can read, send, and delete messages, as
# well as view and add contacts, for the delegator's account. See
# <a href="https://support.google.com/mail/answer/138350">"Set up
# mail delegation"</a> for more information about delegates.
"delegateEmail": "A String", # The email address of the delegate.
"verificationStatus": "A String", # Indicates whether this address has been verified and can act as a delegate
# for the account. Read-only.
},
],
}