com.google.api.services.gmail

Class Gmail.Users.Settings.GetAutoForwarding

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.gmail.GmailRequest<AutoForwarding>

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Gmail.Users.Settings

public class Gmail.Users.Settings.GetAutoForwarding
extends GmailRequest<AutoForwarding>

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Gmail.Users.Settings.GetAutoForwarding(String userId) Gets the auto-forwarding setting for the specified account.

Method Summary

Methods

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
String	getUserId() User's email address.
Gmail.Users.Settings.GetAutoForwarding	set(String parameterName, Object value)
Gmail.Users.Settings.GetAutoForwarding	setAlt(String alt) Data format for the response.
Gmail.Users.Settings.GetAutoForwarding	setFields(String fields) Selector specifying which fields to include in a partial response.
Gmail.Users.Settings.GetAutoForwarding	setKey(String key) API key.
Gmail.Users.Settings.GetAutoForwarding	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Gmail.Users.Settings.GetAutoForwarding	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Gmail.Users.Settings.GetAutoForwarding	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Gmail.Users.Settings.GetAutoForwarding	setUserId(String userId) User's email address.
Gmail.Users.Settings.GetAutoForwarding	setUserIp(String userIp) IP address of the site where the request originates.

Methods inherited from class com.google.api.services.gmail.GmailRequest

getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, setDisableGZipContent, setRequestHeaders

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

getJsonContent, newExceptionOnError, queue

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

buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

Methods inherited from class com.google.api.client.util.GenericData

clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Gmail.Users.Settings.GetAutoForwarding

protected Gmail.Users.Settings.GetAutoForwarding(String userId)

Gets the auto-forwarding setting for the specified account. Create a request for the method "settings.getAutoForwarding". This request holds the parameters needed by the the gmail server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

GetAutoForwarding#initialize(com.google.api.client.googleapis.services.AbstractGoogl eClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

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

Since:

1.13

Method Detail

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<AutoForwarding>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<AutoForwarding>

Throws:

IOException

setAlt

public Gmail.Users.Settings.GetAutoForwarding setAlt(String alt)

Description copied from class: GmailRequest

Data format for the response.

Overrides:

setAlt in class GmailRequest<AutoForwarding>

setFields

public Gmail.Users.Settings.GetAutoForwarding setFields(String fields)

Description copied from class: GmailRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class GmailRequest<AutoForwarding>

setKey

public Gmail.Users.Settings.GetAutoForwarding setKey(String key)

Description copied from class: GmailRequest

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Overrides:

setKey in class GmailRequest<AutoForwarding>

setOauthToken

public Gmail.Users.Settings.GetAutoForwarding setOauthToken(String oauthToken)

Description copied from class: GmailRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class GmailRequest<AutoForwarding>

setPrettyPrint

public Gmail.Users.Settings.GetAutoForwarding setPrettyPrint(Boolean prettyPrint)

Description copied from class: GmailRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class GmailRequest<AutoForwarding>

setQuotaUser

public Gmail.Users.Settings.GetAutoForwarding setQuotaUser(String quotaUser)

Description copied from class: GmailRequest

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

Overrides:

setQuotaUser in class GmailRequest<AutoForwarding>

setUserIp

public Gmail.Users.Settings.GetAutoForwarding setUserIp(String userIp)

Description copied from class: GmailRequest

IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Overrides:

setUserIp in class GmailRequest<AutoForwarding>

getUserId

public String getUserId()

User's email address. The special value "me" can be used to indicate the authenticated user. [default: me]

setUserId

public Gmail.Users.Settings.GetAutoForwarding setUserId(String userId)

User's email address. The special value "me" can be used to indicate the authenticated user.

set

public Gmail.Users.Settings.GetAutoForwarding set(String parameterName,
                                         Object value)

Overrides:

set in class GmailRequest<AutoForwarding>