com.google.api.services.gmail

Class Gmail.Users

java.lang.Object

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

Enclosing class:

Gmail

public class Gmail.Users
extends Object

The "users" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Gmail.Users.Drafts The "drafts" collection of methods.
class	Gmail.Users.GetProfile
class	Gmail.Users.History The "history" collection of methods.
class	Gmail.Users.Labels The "labels" collection of methods.
class	Gmail.Users.Messages The "messages" collection of methods.
class	Gmail.Users.Settings The "settings" collection of methods.
class	Gmail.Users.Stop
class	Gmail.Users.Threads The "threads" collection of methods.
class	Gmail.Users.Watch

Constructor Summary

Constructors

Constructor and Description
Users()

Method Summary

Modifier and Type	Method and Description
Gmail.Users.Drafts	drafts() An accessor for creating requests from the Drafts collection.
Gmail.Users.GetProfile	getProfile(String userId) Gets the current user's Gmail profile.
Gmail.Users.History	history() An accessor for creating requests from the History collection.
Gmail.Users.Labels	labels() An accessor for creating requests from the Labels collection.
Gmail.Users.Messages	messages() An accessor for creating requests from the Messages collection.
Gmail.Users.Settings	settings() An accessor for creating requests from the Settings collection.
Gmail.Users.Stop	stop(String userId) Stop receiving push notifications for the given user mailbox.
Gmail.Users.Threads	threads() An accessor for creating requests from the Threads collection.
Gmail.Users.Watch	watch(String userId, WatchRequest content) Set up or update a push notification watch on the given user mailbox.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Users

public Users()

Method Detail

getProfile

public Gmail.Users.GetProfile getProfile(String userId)
                                  throws IOException

Gets the current user's Gmail profile. Create a request for the method "users.getProfile". 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 user's email address. The special value `me` can be used to indicate the authenticated user. [default: me]

Returns:

the request

Throws:

IOException

stop

public Gmail.Users.Stop stop(String userId)
                      throws IOException

Stop receiving push notifications for the given user mailbox. Create a request for the method "users.stop". 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 user's email address. The special value `me` can be used to indicate the authenticated user. [default: me]

Returns:

the request

Throws:

IOException

watch

public Gmail.Users.Watch watch(String userId,
                               WatchRequest content)
                        throws IOException

Set up or update a push notification watch on the given user mailbox. Create a request for the method "users.watch". 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 user's email address. The special value `me` can be used to indicate the authenticated user. [default: me]

content - the WatchRequest

Returns:

the request

Throws:

IOException

drafts

public Gmail.Users.Drafts drafts()

An accessor for creating requests from the Drafts collection.

The typical use is:

    Gmail gmail = new Gmail(...);
    Gmail.Drafts.List request = gmail.drafts().list(parameters ...)
 

Returns:

the resource collection

history

public Gmail.Users.History history()

An accessor for creating requests from the History collection.

The typical use is:

    Gmail gmail = new Gmail(...);
    Gmail.History.List request = gmail.history().list(parameters ...)
 

Returns:

the resource collection

labels

public Gmail.Users.Labels labels()

An accessor for creating requests from the Labels collection.

The typical use is:

    Gmail gmail = new Gmail(...);
    Gmail.Labels.List request = gmail.labels().list(parameters ...)
 

Returns:

the resource collection

messages

public Gmail.Users.Messages messages()

An accessor for creating requests from the Messages collection.

The typical use is:

    Gmail gmail = new Gmail(...);
    Gmail.Messages.List request = gmail.messages().list(parameters ...)
 

Returns:

the resource collection

settings

public Gmail.Users.Settings settings()

An accessor for creating requests from the Settings collection.

The typical use is:

    Gmail gmail = new Gmail(...);
    Gmail.Settings.List request = gmail.settings().list(parameters ...)
 

Returns:

the resource collection

threads

public Gmail.Users.Threads threads()

An accessor for creating requests from the Threads collection.

The typical use is:

    Gmail gmail = new Gmail(...);
    Gmail.Threads.List request = gmail.threads().list(parameters ...)
 

Returns:

the resource collection