com.google.api.services.gmail

Class Gmail.Users.Messages.BatchDelete

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<java.lang.Void>

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

All Implemented Interfaces:

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

Enclosing class:

Gmail.Users.Messages

public class Gmail.Users.Messages.BatchDelete
extends GmailRequest<java.lang.Void>

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	BatchDelete(java.lang.String userId, BatchDeleteMessagesRequest content) Deletes many messages by message ID.

Method Summary

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

BatchDelete

protected BatchDelete(java.lang.String userId,
                      BatchDeleteMessagesRequest content)

Deletes many messages by message ID. Provides no guarantees that messages were not already deleted or even existed at all. Create a request for the method "messages.batchDelete". 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 BatchDeleteMessagesRequest

Since:

1.13

Method Detail

setAlt

public Gmail.Users.Messages.BatchDelete setAlt(java.lang.String alt)

Description copied from class: GmailRequest

Data format for the response.

Overrides:

setAlt in class GmailRequest<java.lang.Void>

setFields

public Gmail.Users.Messages.BatchDelete 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<java.lang.Void>

setKey

public Gmail.Users.Messages.BatchDelete 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<java.lang.Void>

setOauthToken

public Gmail.Users.Messages.BatchDelete setOauthToken(java.lang.String oauthToken)

Description copied from class: GmailRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class GmailRequest<java.lang.Void>

setPrettyPrint

public Gmail.Users.Messages.BatchDelete setPrettyPrint(java.lang.Boolean prettyPrint)

Description copied from class: GmailRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class GmailRequest<java.lang.Void>

setQuotaUser

public Gmail.Users.Messages.BatchDelete 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<java.lang.Void>

setUserIp

public Gmail.Users.Messages.BatchDelete setUserIp(java.lang.String userIp)

Description copied from class: GmailRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class GmailRequest<java.lang.Void>

getUserId

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

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

set

public Gmail.Users.Messages.BatchDelete set(java.lang.String parameterName,
                                            java.lang.Object value)

Overrides:

set in class GmailRequest<java.lang.Void>