com.google.api.services.gmail

Class Gmail

java.lang.Object

com.google.api.client.googleapis.services.AbstractGoogleClient

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClient

com.google.api.services.gmail.Gmail

public class Gmail
extends com.google.api.client.googleapis.services.json.AbstractGoogleJsonClient

Service definition for Gmail (v1).

Access Gmail mailboxes including sending user email.

For more information about this service, see the API Documentation

This service uses GmailRequestInitializer to initialize global parameters via its Gmail.Builder.

Since:

1.3

Author:

Google, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Gmail.Builder Builder for Gmail.
class	Gmail.Users The "users" collection of methods.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_BASE_URL The default encoded base URL of the service.
static String	DEFAULT_BATCH_PATH The default encoded batch path of the service.
static String	DEFAULT_ROOT_URL The default encoded root URL of the service.
static String	DEFAULT_SERVICE_PATH The default encoded service path of the service.

Constructor Summary

Constructors

Constructor and Description
Gmail(com.google.api.client.http.HttpTransport transport, com.google.api.client.json.JsonFactory jsonFactory, com.google.api.client.http.HttpRequestInitializer httpRequestInitializer) Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest<?> httpClientRequest)
Gmail.Users	users() An accessor for creating requests from the Users collection.

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClient

getJsonFactory, getObjectParser

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClient

batch, batch, getApplicationName, getBaseUrl, getGoogleClientRequestInitializer, getRequestFactory, getRootUrl, getServicePath, getSuppressPatternChecks, getSuppressRequiredParameterChecks

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ROOT_URL

public static final String DEFAULT_ROOT_URL

The default encoded root URL of the service. This is determined when the library is generated and normally should not be changed.

Since:

1.7

See Also:

Constant Field Values

DEFAULT_SERVICE_PATH

public static final String DEFAULT_SERVICE_PATH

The default encoded service path of the service. This is determined when the library is generated and normally should not be changed.

Since:

1.7

See Also:

Constant Field Values

DEFAULT_BATCH_PATH

public static final String DEFAULT_BATCH_PATH

The default encoded batch path of the service. This is determined when the library is generated and normally should not be changed.

Since:

1.23

See Also:

Constant Field Values

DEFAULT_BASE_URL

public static final String DEFAULT_BASE_URL

The default encoded base URL of the service. This is determined when the library is generated and normally should not be changed.

See Also:

Constant Field Values

Constructor Detail

Gmail

public Gmail(com.google.api.client.http.HttpTransport transport,
             com.google.api.client.json.JsonFactory jsonFactory,
             com.google.api.client.http.HttpRequestInitializer httpRequestInitializer)

Constructor.

Use Gmail.Builder if you need to specify any of the optional parameters.

Parameters:

transport - HTTP transport, which should normally be:

• Google App Engine: com.google.api.client.extensions.appengine.http.UrlFetchTransport
• Android: newCompatibleTransport from com.google.api.client.extensions.android.http.AndroidHttp
• Java: com.google.api.client.googleapis.javanet.GoogleNetHttpTransport#newTrustedTransport()

jsonFactory - JSON factory, which may be:

• Jackson: com.google.api.client.json.jackson2.JacksonFactory
• Google GSON: com.google.api.client.json.gson.GsonFactory
• Android Honeycomb or higher: com.google.api.client.extensions.android.json.AndroidJsonFactory

httpRequestInitializer - HTTP request initializer or null for none

Since:

1.7

Method Detail

initialize

protected void initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest<?> httpClientRequest)
                   throws IOException

Overrides:

initialize in class com.google.api.client.googleapis.services.AbstractGoogleClient

Throws:

IOException

users

public Gmail.Users users()

An accessor for creating requests from the Users collection.

The typical use is:

    Gmail gmail = new Gmail(...);
    Gmail.Users.List request = gmail.users().list(parameters ...)
 

Returns:

the resource collection