com.google.api.services.gmail

Class Gmail.Users.Messages.Delete

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.Delete

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Gmail.Users.Messages

public class Gmail.Users.Messages.Delete
extends GmailRequest<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

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

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Delete(String userId, String id) Immediately and permanently deletes the specified message.

Method Summary

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

Delete

protected Delete(String userId,
                 String id)

Immediately and permanently deletes the specified message. This operation cannot be undone. Prefer messages.trash instead. Create a request for the method "messages.delete". 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 delete.

Since:

1.13

Method Detail

setAlt

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

Description copied from class: GmailRequest

Data format for the response.

Overrides:

setAlt in class GmailRequest<Void>

setFields

public Gmail.Users.Messages.Delete 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.Delete 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.Delete 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.Delete 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.Delete setQuotaUser(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<Void>

setUserIp

public Gmail.Users.Messages.Delete setUserIp(String userIp)

Description copied from class: GmailRequest

Deprecated. Please use quotaUser instead.

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.Delete 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 delete.

setId

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

The ID of the message to delete.

set

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

Overrides:

set in class GmailRequest<Void>