com.google.api.services.gmail

Class Gmail.Users.Settings.ForwardingAddresses.List

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<ListForwardingAddressesResponse>

com.google.api.services.gmail.Gmail.Users.Settings.ForwardingAddresses.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Gmail.Users.Settings.ForwardingAddresses

public class Gmail.Users.Settings.ForwardingAddresses.List
extends GmailRequest<ListForwardingAddressesResponse>

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.ForwardingAddresses.List(String userId) Lists the forwarding addresses 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.ForwardingAddresses.List	set(String parameterName, Object value)
Gmail.Users.Settings.ForwardingAddresses.List	setAlt(String alt) Data format for the response.
Gmail.Users.Settings.ForwardingAddresses.List	setFields(String fields) Selector specifying which fields to include in a partial response.
Gmail.Users.Settings.ForwardingAddresses.List	setKey(String key) API key.
Gmail.Users.Settings.ForwardingAddresses.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Gmail.Users.Settings.ForwardingAddresses.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Gmail.Users.Settings.ForwardingAddresses.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Gmail.Users.Settings.ForwardingAddresses.List	setUserId(String userId) User's email address.
Gmail.Users.Settings.ForwardingAddresses.List	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.ForwardingAddresses.List

protected Gmail.Users.Settings.ForwardingAddresses.List(String userId)

Lists the forwarding addresses for the specified account. Create a request for the method "forwardingAddresses.list". 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.

Gmail.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) 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<ListForwardingAddressesResponse>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<ListForwardingAddressesResponse>

Throws:

IOException

setAlt

public Gmail.Users.Settings.ForwardingAddresses.List setAlt(String alt)

Description copied from class: GmailRequest

Data format for the response.

Overrides:

setAlt in class GmailRequest<ListForwardingAddressesResponse>

setFields

public Gmail.Users.Settings.ForwardingAddresses.List setFields(String fields)

Description copied from class: GmailRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class GmailRequest<ListForwardingAddressesResponse>

setKey

public Gmail.Users.Settings.ForwardingAddresses.List 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<ListForwardingAddressesResponse>

setOauthToken

public Gmail.Users.Settings.ForwardingAddresses.List setOauthToken(String oauthToken)

Description copied from class: GmailRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class GmailRequest<ListForwardingAddressesResponse>

setPrettyPrint

public Gmail.Users.Settings.ForwardingAddresses.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: GmailRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class GmailRequest<ListForwardingAddressesResponse>

setQuotaUser

public Gmail.Users.Settings.ForwardingAddresses.List 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<ListForwardingAddressesResponse>

setUserIp

public Gmail.Users.Settings.ForwardingAddresses.List 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<ListForwardingAddressesResponse>

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.ForwardingAddresses.List setUserId(String userId)

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

set

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

Overrides:

set in class GmailRequest<ListForwardingAddressesResponse>