target.apidocs.com.google.api.services.gmail.Gmail.Users.Settings.Delegates.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-gmail Show documentation

There is a newer version: v1-rev20240520-2.0.0

Show newest version







Gmail.Users.Settings.Delegates (Gmail API v1-rev20230925-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.gmail
Class Gmail.Users.Settings.Delegates



java.lang.Object


com.google.api.services.gmail.Gmail.Users.Settings.Delegates







Enclosing class:
Gmail.Users.Settings




public class Gmail.Users.Settings.Delegates
extends Object
The "delegates" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
Gmail.Users.Settings.Delegates.Create 


class 
Gmail.Users.Settings.Delegates.Delete 


class 
Gmail.Users.Settings.Delegates.Get 


class 
Gmail.Users.Settings.Delegates.List 









Constructor Summary

Constructors 

Constructor and Description


Delegates() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


Gmail.Users.Settings.Delegates.Create
create(String userId,
      Delegate content)
Adds a delegate with its verification status set directly to `accepted`, without sending any
 verification email.



Gmail.Users.Settings.Delegates.Delete
delete(String userId,
      String delegateEmail)
Removes the specified delegate (which can be of any verification status), and revokes any
 verification that may have been required for using it.



Gmail.Users.Settings.Delegates.Get
get(String userId,
   String delegateEmail)
Gets the specified delegate.



Gmail.Users.Settings.Delegates.List
list(String userId)
Lists the delegates for the specified account.







Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait














Constructor Detail





Delegates
public Delegates()









Method Detail





create
public Gmail.Users.Settings.Delegates.Create create(String userId,
                                                    Delegate content)
                                             throws IOException
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.

 Create a request for the method "delegates.create".

 This request holds the parameters needed by the gmail server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
userId - User's email address. The special value "me" can be used to indicate the authenticated user.
        [default: me]
content - the Delegate
Returns:
the request
Throws:
IOException








delete
public Gmail.Users.Settings.Delegates.Delete delete(String userId,
                                                    String delegateEmail)
                                             throws IOException
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.

 Create a request for the method "delegates.delete".

 This request holds the parameters needed by the gmail server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
userId - User's email address. The special value "me" can be used to indicate the authenticated user.
        [default: me]
delegateEmail - The email address of the user to be removed as a delegate.
Returns:
the request
Throws:
IOException








get
public Gmail.Users.Settings.Delegates.Get get(String userId,
                                              String delegateEmail)
                                       throws IOException
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.

 Create a request for the method "delegates.get".

 This request holds the parameters needed by the gmail server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
userId - User's email address. The special value "me" can be used to indicate the authenticated user.
        [default: me]
delegateEmail - The email address of the user whose delegate relationship is to be retrieved.
Returns:
the request
Throws:
IOException








list
public Gmail.Users.Settings.Delegates.List list(String userId)
                                         throws IOException
Lists the delegates for the specified account. This method is only available to service account
 clients that have been delegated domain-wide authority.

 Create a request for the method "delegates.list".

 This request holds the parameters needed by the gmail server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
userId - User's email address. The special value "me" can be used to indicate the authenticated user.
        [default: me]
Returns:
the request
Throws:
IOException














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2023 Google. All rights reserved.

Modifier and Type	Class and Description
`class`	`Gmail.Users.Settings.Delegates.Create`
`class`	`Gmail.Users.Settings.Delegates.Delete`
`class`	`Gmail.Users.Settings.Delegates.Get`
`class`	`Gmail.Users.Settings.Delegates.List`

Modifier and Type	Method and Description
`Gmail.Users.Settings.Delegates.Create`	`create(String userId, Delegate content)` Adds a delegate with its verification status set directly to `accepted`, without sending any verification email.
`Gmail.Users.Settings.Delegates.Delete`	`delete(String userId, String delegateEmail)` Removes the specified delegate (which can be of any verification status), and revokes any verification that may have been required for using it.
`Gmail.Users.Settings.Delegates.Get`	`get(String userId, String delegateEmail)` Gets the specified delegate.
`Gmail.Users.Settings.Delegates.List`	`list(String userId)` Lists the delegates for the specified account.