com.google.api.services.gmail

Class Gmail.Users.Settings.GetImap

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

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Gmail.Users.Settings

public class Gmail.Users.Settings.GetImap
extends GmailRequest<ImapSettings>

Nested Class Summary

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

com.google.api.client.util.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>

Field Summary

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

API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GetImap(String userId) Gets IMAP settings.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
String	getUserId() User's email address.
Gmail.Users.Settings.GetImap	set(String parameterName, Object value)
Gmail.Users.Settings.GetImap	set$Xgafv(String $Xgafv) V1 error format.
Gmail.Users.Settings.GetImap	setAccessToken(String accessToken) OAuth access token.
Gmail.Users.Settings.GetImap	setAlt(String alt) Data format for response.
Gmail.Users.Settings.GetImap	setCallback(String callback) JSONP
Gmail.Users.Settings.GetImap	setFields(String fields) Selector specifying which fields to include in a partial response.
Gmail.Users.Settings.GetImap	setKey(String key) API key.
Gmail.Users.Settings.GetImap	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Gmail.Users.Settings.GetImap	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Gmail.Users.Settings.GetImap	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Gmail.Users.Settings.GetImap	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Gmail.Users.Settings.GetImap	setUploadType(String uploadType) Legacy upload protocol for media (e.g.
Gmail.Users.Settings.GetImap	setUserId(String userId) User's email address.

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

get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, 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, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

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

clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

GetImap

protected GetImap(String userId)

Gets IMAP settings. Create a request for the method "settings.getImap". 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 com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws IOException

Overrides:

executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ImapSettings>

Throws:

IOException

buildHttpRequestUsingHead

public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ImapSettings>

Throws:

IOException

set$Xgafv

public Gmail.Users.Settings.GetImap set$Xgafv(String $Xgafv)

Description copied from class: GmailRequest

V1 error format.

Overrides:

set$Xgafv in class GmailRequest<ImapSettings>

setAccessToken

public Gmail.Users.Settings.GetImap setAccessToken(String accessToken)

Description copied from class: GmailRequest

OAuth access token.

Overrides:

setAccessToken in class GmailRequest<ImapSettings>

setAlt

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

Description copied from class: GmailRequest

Data format for response.

Overrides:

setAlt in class GmailRequest<ImapSettings>

setCallback

public Gmail.Users.Settings.GetImap setCallback(String callback)

Description copied from class: GmailRequest

JSONP

Overrides:

setCallback in class GmailRequest<ImapSettings>

setFields

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

Description copied from class: GmailRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class GmailRequest<ImapSettings>

setKey

public Gmail.Users.Settings.GetImap 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<ImapSettings>

setOauthToken

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

Description copied from class: GmailRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class GmailRequest<ImapSettings>

setPrettyPrint

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

Description copied from class: GmailRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class GmailRequest<ImapSettings>

setQuotaUser

public Gmail.Users.Settings.GetImap 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:

setQuotaUser in class GmailRequest<ImapSettings>

setUploadType

public Gmail.Users.Settings.GetImap setUploadType(String uploadType)

Description copied from class: GmailRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class GmailRequest<ImapSettings>

setUploadProtocol

public Gmail.Users.Settings.GetImap setUploadProtocol(String uploadProtocol)

Description copied from class: GmailRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class GmailRequest<ImapSettings>

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

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

set

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

Overrides:

set in class GmailRequest<ImapSettings>