com.google.api.services.gmail

Class Gmail.Users.Messages.Trash

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

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Gmail.Users.Messages

public class Gmail.Users.Messages.Trash
extends GmailRequest<Message>

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	Trash(String userId, String id) Moves the specified message to the trash.

Method Summary

Modifier and Type	Method and Description
String	getId() The ID of the message to Trash.
String	getUserId() The user's email address.
Gmail.Users.Messages.Trash	set(String parameterName, Object value)
Gmail.Users.Messages.Trash	set$Xgafv(String $Xgafv) V1 error format.
Gmail.Users.Messages.Trash	setAccessToken(String accessToken) OAuth access token.
Gmail.Users.Messages.Trash	setAlt(String alt) Data format for response.
Gmail.Users.Messages.Trash	setCallback(String callback) JSONP
Gmail.Users.Messages.Trash	setFields(String fields) Selector specifying which fields to include in a partial response.
Gmail.Users.Messages.Trash	setId(String id) The ID of the message to Trash.
Gmail.Users.Messages.Trash	setKey(String key) API key.
Gmail.Users.Messages.Trash	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Gmail.Users.Messages.Trash	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Gmail.Users.Messages.Trash	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Gmail.Users.Messages.Trash	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Gmail.Users.Messages.Trash	setUploadType(String uploadType) Legacy upload protocol for media (e.g.
Gmail.Users.Messages.Trash	setUserId(String userId) The 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, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, 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

Trash

protected Trash(String userId,
                String id)

Moves the specified message to the trash. Create a request for the method "messages.trash". 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]

id - The ID of the message to Trash.

Since:

1.13

Method Detail

set$Xgafv

public Gmail.Users.Messages.Trash set$Xgafv(String $Xgafv)

Description copied from class: GmailRequest

V1 error format.

Overrides:

set$Xgafv in class GmailRequest<Message>

setAccessToken

public Gmail.Users.Messages.Trash setAccessToken(String accessToken)

Description copied from class: GmailRequest

OAuth access token.

Overrides:

setAccessToken in class GmailRequest<Message>

setAlt

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

Description copied from class: GmailRequest

Data format for response.

Overrides:

setAlt in class GmailRequest<Message>

setCallback

public Gmail.Users.Messages.Trash setCallback(String callback)

Description copied from class: GmailRequest

JSONP

Overrides:

setCallback in class GmailRequest<Message>

setFields

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

Description copied from class: GmailRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class GmailRequest<Message>

setKey

public Gmail.Users.Messages.Trash 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<Message>

setOauthToken

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

Description copied from class: GmailRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class GmailRequest<Message>

setPrettyPrint

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

Description copied from class: GmailRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class GmailRequest<Message>

setQuotaUser

public Gmail.Users.Messages.Trash 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<Message>

setUploadType

public Gmail.Users.Messages.Trash setUploadType(String uploadType)

Description copied from class: GmailRequest

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

Overrides:

setUploadType in class GmailRequest<Message>

setUploadProtocol

public Gmail.Users.Messages.Trash setUploadProtocol(String uploadProtocol)

Description copied from class: GmailRequest

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

Overrides:

setUploadProtocol in class GmailRequest<Message>

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

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

getId

public String getId()

The ID of the message to Trash.

setId

public Gmail.Users.Messages.Trash setId(String id)

The ID of the message to Trash.

set

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

Overrides:

set in class GmailRequest<Message>