com.google.api.services.gmail

Class Gmail.Users.Messages.Insert

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

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

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

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	Insert(java.lang.String userId, Message content) Directly inserts a message into only this user's mailbox similar to IMAP APPEND, bypassing most scanning and classification.
protected	Insert(java.lang.String userId, Message content, com.google.api.client.http.AbstractInputStreamContent mediaContent) Directly inserts a message into only this user's mailbox similar to IMAP APPEND, bypassing most scanning and classification.

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	getDeleted() Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator.
java.lang.String	getInternalDateSource() Source for Gmail's internal date of the message.
java.lang.String	getUserId() The user's email address.
boolean	isDeleted() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
Gmail.Users.Messages.Insert	set(java.lang.String parameterName, java.lang.Object value)
Gmail.Users.Messages.Insert	setAlt(java.lang.String alt) Data format for the response.
Gmail.Users.Messages.Insert	setDeleted(java.lang.Boolean deleted) Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator.
Gmail.Users.Messages.Insert	setFields(java.lang.String fields) Selector specifying which fields to include in a partial response.
Gmail.Users.Messages.Insert	setInternalDateSource(java.lang.String internalDateSource) Source for Gmail's internal date of the message.
Gmail.Users.Messages.Insert	setKey(java.lang.String key) API key.
Gmail.Users.Messages.Insert	setOauthToken(java.lang.String oauthToken) OAuth 2.0 token for the current user.
Gmail.Users.Messages.Insert	setPrettyPrint(java.lang.Boolean prettyPrint) Returns response with indentations and line breaks.
Gmail.Users.Messages.Insert	setQuotaUser(java.lang.String quotaUser) An opaque string that represents a user for quota purposes.
Gmail.Users.Messages.Insert	setUserId(java.lang.String userId) The user's email address.
Gmail.Users.Messages.Insert	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

Insert

protected Insert(java.lang.String userId,
                 Message content)

Directly inserts a message into only this user's mailbox similar to IMAP APPEND, bypassing most scanning and classification. Does not send a message. Create a request for the method "messages.insert". 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 Message

Since:

1.13

Insert

protected Insert(java.lang.String userId,
                 Message content,
                 com.google.api.client.http.AbstractInputStreamContent mediaContent)

Directly inserts a message into only this user's mailbox similar to IMAP APPEND, bypassing most scanning and classification. Does not send a message. Create a request for the method "messages.insert". 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.

This constructor should be used for uploading media content.

Parameters:

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

content - the Message media metadata or null if none

mediaContent - The media HTTP content or null if none.

Since:

1.13

Method Detail

setAlt

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

Description copied from class: GmailRequest

Data format for the response.

Overrides:

setAlt in class GmailRequest<Message>

setFields

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

setKey

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

setOauthToken

public Gmail.Users.Messages.Insert setOauthToken(java.lang.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.Insert setPrettyPrint(java.lang.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.Insert 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<Message>

setUserIp

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

Description copied from class: GmailRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class GmailRequest<Message>

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

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

getDeleted

public java.lang.Boolean getDeleted()

Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for G Suite accounts. [default: false]

setDeleted

public Gmail.Users.Messages.Insert setDeleted(java.lang.Boolean deleted)

Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for G Suite accounts.

isDeleted

public boolean isDeleted()

Convenience method that returns only Boolean.TRUE or Boolean.FALSE.

Boolean properties can have four possible values: null, Data.NULL_BOOLEAN, Boolean.TRUE or Boolean.FALSE.

This method returns Boolean.TRUE if the default of the property is Boolean.TRUE and it is null or Data.NULL_BOOLEAN. Boolean.FALSE is returned if the default of the property is Boolean.FALSE and it is null or Data.NULL_BOOLEAN.

Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for G Suite accounts.

getInternalDateSource

public java.lang.String getInternalDateSource()

Source for Gmail's internal date of the message. [default: receivedTime]

setInternalDateSource

public Gmail.Users.Messages.Insert setInternalDateSource(java.lang.String internalDateSource)

Source for Gmail's internal date of the message.

set

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

Overrides:

set in class GmailRequest<Message>