target.apidocs.com.google.api.services.gmail.Gmail.Users.Settings.Cse.Identities.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.Cse.Identities (Gmail API v1-rev20240422-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.Cse.Identities



java.lang.Object


com.google.api.services.gmail.Gmail.Users.Settings.Cse.Identities







Enclosing class:
Gmail.Users.Settings.Cse




public class Gmail.Users.Settings.Cse.Identities
extends Object
The "identities" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
Gmail.Users.Settings.Cse.Identities.Create 


class 
Gmail.Users.Settings.Cse.Identities.Delete 


class 
Gmail.Users.Settings.Cse.Identities.Get 


class 
Gmail.Users.Settings.Cse.Identities.List 


class 
Gmail.Users.Settings.Cse.Identities.Patch 









Constructor Summary

Constructors 

Constructor and Description


Identities() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


Gmail.Users.Settings.Cse.Identities.Create
create(String userId,
      CseIdentity content)
Creates and configures a client-side encryption identity that's authorized to send mail from the
 user account.



Gmail.Users.Settings.Cse.Identities.Delete
delete(String userId,
      String cseEmailAddress)
Deletes a client-side encryption identity.



Gmail.Users.Settings.Cse.Identities.Get
get(String userId,
   String cseEmailAddress)
Retrieves a client-side encryption identity configuration.



Gmail.Users.Settings.Cse.Identities.List
list(String userId)
Lists the client-side encrypted identities for an authenticated user.



Gmail.Users.Settings.Cse.Identities.Patch
patch(String userId,
     String emailAddress,
     CseIdentity content)
Associates a different key pair with an existing client-side encryption identity.







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














Constructor Detail





Identities
public Identities()









Method Detail





create
public Gmail.Users.Settings.Cse.Identities.Create create(String userId,
                                                         CseIdentity content)
                                                  throws IOException
Creates and configures a client-side encryption identity that's authorized to send mail from the
 user account. Google publishes the S/MIME certificate to a shared domain-wide directory so that
 people within a Google Workspace organization can encrypt and send mail to the identity.

 Create a request for the method "identities.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 - The requester's primary email address. To indicate the authenticated user, you can use the special
        value `me`.
          [default: me]
content - the CseIdentity
Returns:
the request
Throws:
IOException








delete
public Gmail.Users.Settings.Cse.Identities.Delete delete(String userId,
                                                         String cseEmailAddress)
                                                  throws IOException
Deletes a client-side encryption identity. The authenticated user can no longer use the identity
 to send encrypted messages. You cannot restore the identity after you delete it. Instead, use the
 CreateCseIdentity method to create another identity with the same configuration.

 Create a request for the method "identities.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 - The requester's primary email address. To indicate the authenticated user, you can use the special
        value `me`.
          [default: me]
cseEmailAddress - The primary email address associated with the client-side encryption identity configuration that's
        removed.
Returns:
the request
Throws:
IOException








get
public Gmail.Users.Settings.Cse.Identities.Get get(String userId,
                                                   String cseEmailAddress)
                                            throws IOException
Retrieves a client-side encryption identity configuration.

 Create a request for the method "identities.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 - The requester's primary email address. To indicate the authenticated user, you can use the special
        value `me`.
          [default: me]
cseEmailAddress - The primary email address associated with the client-side encryption identity configuration that's
        retrieved.
Returns:
the request
Throws:
IOException








list
public Gmail.Users.Settings.Cse.Identities.List list(String userId)
                                              throws IOException
Lists the client-side encrypted identities for an authenticated user.

 Create a request for the method "identities.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 - The requester's primary email address. To indicate the authenticated user, you can use the special
        value `me`.
          [default: me]
Returns:
the request
Throws:
IOException








patch
public Gmail.Users.Settings.Cse.Identities.Patch patch(String userId,
                                                       String emailAddress,
                                                       CseIdentity content)
                                                throws IOException
Associates a different key pair with an existing client-side encryption identity. The updated key
 pair must validate against Google's [S/MIME certificate
 profiles](https://support.google.com/a/answer/7300887).

 Create a request for the method "identities.patch".

 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 - The requester's primary email address. To indicate the authenticated user, you can use the special
        value `me`.
          [default: me]
emailAddress - The email address of the client-side encryption identity to update.
content - the CseIdentity
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–2024 Google. All rights reserved.

Modifier and Type	Class and Description
`class`	`Gmail.Users.Settings.Cse.Identities.Create`
`class`	`Gmail.Users.Settings.Cse.Identities.Delete`
`class`	`Gmail.Users.Settings.Cse.Identities.Get`
`class`	`Gmail.Users.Settings.Cse.Identities.List`
`class`	`Gmail.Users.Settings.Cse.Identities.Patch`

Modifier and Type	Method and Description
`Gmail.Users.Settings.Cse.Identities.Create`	`create(String userId, CseIdentity content)` Creates and configures a client-side encryption identity that's authorized to send mail from the user account.
`Gmail.Users.Settings.Cse.Identities.Delete`	`delete(String userId, String cseEmailAddress)` Deletes a client-side encryption identity.
`Gmail.Users.Settings.Cse.Identities.Get`	`get(String userId, String cseEmailAddress)` Retrieves a client-side encryption identity configuration.
`Gmail.Users.Settings.Cse.Identities.List`	`list(String userId)` Lists the client-side encrypted identities for an authenticated user.
`Gmail.Users.Settings.Cse.Identities.Patch`	`patch(String userId, String emailAddress, CseIdentity content)` Associates a different key pair with an existing client-side encryption identity.