com.google.api.services.gmail

Class Gmail.Users.Settings.UpdatePop

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.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<PopSettings>

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

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

Enclosing class:

Gmail.Users.Settings

public class Gmail.Users.Settings.UpdatePop
extends GmailRequest<PopSettings>

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

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

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

java.util.Map.Entry<K,V>

Field Summary

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

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UpdatePop(java.lang.String userId, PopSettings content) Updates POP settings.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getUserId() User's email address.
Gmail.Users.Settings.UpdatePop	set(java.lang.String parameterName, java.lang.Object value)
Gmail.Users.Settings.UpdatePop	setAlt(java.lang.String alt) Data format for the response.
Gmail.Users.Settings.UpdatePop	setFields(java.lang.String fields) Selector specifying which fields to include in a partial response.
Gmail.Users.Settings.UpdatePop	setKey(java.lang.String key) API key.
Gmail.Users.Settings.UpdatePop	setOauthToken(java.lang.String oauthToken) OAuth 2.0 token for the current user.
Gmail.Users.Settings.UpdatePop	setPrettyPrint(java.lang.Boolean prettyPrint) Returns response with indentations and line breaks.
Gmail.Users.Settings.UpdatePop	setQuotaUser(java.lang.String quotaUser) An opaque string that represents a user for quota purposes.
Gmail.Users.Settings.UpdatePop	setUserId(java.lang.String userId) User's email address.
Gmail.Users.Settings.UpdatePop	setUserIp(java.lang.String userIp) Deprecated.

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, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, 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

Methods inherited from interface java.util.Map

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

Constructor Detail

UpdatePop

protected UpdatePop(java.lang.String userId,
                    PopSettings content)

Updates POP settings. Create a request for the method "settings.updatePop". 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]

content - the PopSettings

Since:

1.13

Method Detail

setAlt

public Gmail.Users.Settings.UpdatePop setAlt(java.lang.String alt)

Description copied from class: GmailRequest

Data format for the response.

Overrides:

setAlt in class GmailRequest<PopSettings>

setFields

public Gmail.Users.Settings.UpdatePop setFields(java.lang.String fields)

Description copied from class: GmailRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class GmailRequest<PopSettings>

setKey

public Gmail.Users.Settings.UpdatePop setKey(java.lang.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<PopSettings>

setOauthToken

public Gmail.Users.Settings.UpdatePop setOauthToken(java.lang.String oauthToken)

Description copied from class: GmailRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class GmailRequest<PopSettings>

setPrettyPrint

public Gmail.Users.Settings.UpdatePop setPrettyPrint(java.lang.Boolean prettyPrint)

Description copied from class: GmailRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class GmailRequest<PopSettings>

setQuotaUser

public Gmail.Users.Settings.UpdatePop setQuotaUser(java.lang.String quotaUser)

Description copied from class: GmailRequest

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Overrides:

setQuotaUser in class GmailRequest<PopSettings>

setUserIp

public Gmail.Users.Settings.UpdatePop setUserIp(java.lang.String userIp)

Description copied from class: GmailRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class GmailRequest<PopSettings>

getUserId

public java.lang.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.UpdatePop setUserId(java.lang.String userId)

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

set

public Gmail.Users.Settings.UpdatePop set(java.lang.String parameterName,
                                          java.lang.Object value)

Overrides:

set in class GmailRequest<PopSettings>