com.google.api.services.gmail

Class Gmail.Users.Messages.BatchModify

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

com.google.api.services.gmail.Gmail.Users.Messages.BatchModify

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Gmail.Users.Messages

public class Gmail.Users.Messages.BatchModify
extends GmailRequest<Void>

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.Messages.BatchModify(String userId, BatchModifyMessagesRequest content) Modifies the labels on the specified messages.

Method Summary

Methods

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

Constructor Detail

Gmail.Users.Messages.BatchModify

protected Gmail.Users.Messages.BatchModify(String userId,
                                BatchModifyMessagesRequest content)

Modifies the labels on the specified messages. Create a request for the method "messages.batchModify". 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 - The user's email address. The special value me can be used to indicate the authenticated user. [default: me]

content - the BatchModifyMessagesRequest

Since:

1.13

Method Detail

setAlt

public Gmail.Users.Messages.BatchModify setAlt(String alt)

Description copied from class: GmailRequest

Data format for the response.

Overrides:

setAlt in class GmailRequest<Void>

setFields

public Gmail.Users.Messages.BatchModify setFields(String fields)

Description copied from class: GmailRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class GmailRequest<Void>

setKey

public Gmail.Users.Messages.BatchModify 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<Void>

setOauthToken

public Gmail.Users.Messages.BatchModify setOauthToken(String oauthToken)

Description copied from class: GmailRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class GmailRequest<Void>

setPrettyPrint

public Gmail.Users.Messages.BatchModify setPrettyPrint(Boolean prettyPrint)

Description copied from class: GmailRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class GmailRequest<Void>

setQuotaUser

public Gmail.Users.Messages.BatchModify 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<Void>

setUserIp

public Gmail.Users.Messages.BatchModify 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<Void>

getUserId

public String getUserId()

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

setUserId

public Gmail.Users.Messages.BatchModify setUserId(String userId)

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

set

public Gmail.Users.Messages.BatchModify set(String parameterName,
                                   Object value)

Overrides:

set in class GmailRequest<Void>