com.google.api.services.gmail

Class Gmail.Users.Messages.GmailImport

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Gmail.Users.Messages

public class Gmail.Users.Messages.GmailImport
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	GmailImport(String userId, Message content) Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP.
protected	GmailImport(String userId, Message content, com.google.api.client.http.AbstractInputStreamContent mediaContent) Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP.

Method Summary

Modifier and Type	Method and Description
Boolean	getDeleted() Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator.
String	getInternalDateSource() Source for Gmail's internal date of the message.
Boolean	getNeverMarkSpam() Ignore the Gmail spam classifier decision and never mark this email as SPAM in the mailbox.
Boolean	getProcessForCalendar() Process calendar invites in the email and add any extracted meetings to the Google Calendar for this user.
String	getUserId() The user's email address.
boolean	isDeleted() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
boolean	isNeverMarkSpam() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
boolean	isProcessForCalendar() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
Gmail.Users.Messages.GmailImport	set(String parameterName, Object value)
Gmail.Users.Messages.GmailImport	set$Xgafv(String $Xgafv) V1 error format.
Gmail.Users.Messages.GmailImport	setAccessToken(String accessToken) OAuth access token.
Gmail.Users.Messages.GmailImport	setAlt(String alt) Data format for response.
Gmail.Users.Messages.GmailImport	setCallback(String callback) JSONP
Gmail.Users.Messages.GmailImport	setDeleted(Boolean deleted) Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator.
Gmail.Users.Messages.GmailImport	setFields(String fields) Selector specifying which fields to include in a partial response.
Gmail.Users.Messages.GmailImport	setInternalDateSource(String internalDateSource) Source for Gmail's internal date of the message.
Gmail.Users.Messages.GmailImport	setKey(String key) API key.
Gmail.Users.Messages.GmailImport	setNeverMarkSpam(Boolean neverMarkSpam) Ignore the Gmail spam classifier decision and never mark this email as SPAM in the mailbox.
Gmail.Users.Messages.GmailImport	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Gmail.Users.Messages.GmailImport	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Gmail.Users.Messages.GmailImport	setProcessForCalendar(Boolean processForCalendar) Process calendar invites in the email and add any extracted meetings to the Google Calendar for this user.
Gmail.Users.Messages.GmailImport	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Gmail.Users.Messages.GmailImport	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Gmail.Users.Messages.GmailImport	setUploadType(String uploadType) Legacy upload protocol for media (e.g.
Gmail.Users.Messages.GmailImport	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

GmailImport

protected GmailImport(String userId,
                      Message content)

Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP. This method doesn't perform SPF checks, so it might not work for some spam messages, such as those attempting to perform domain spoofing. This method does not send a message. Create a request for the method "messages.import". 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

GmailImport

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

Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP. This method doesn't perform SPF checks, so it might not work for some spam messages, such as those attempting to perform domain spoofing. This method does not send a message. Create a request for the method "messages.import". 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.

Since:

1.13

Method Detail

set$Xgafv

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

Description copied from class: GmailRequest

V1 error format.

Overrides:

set$Xgafv in class GmailRequest<Message>

setAccessToken

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

Description copied from class: GmailRequest

OAuth access token.

Overrides:

setAccessToken in class GmailRequest<Message>

setAlt

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

Description copied from class: GmailRequest

Data format for response.

Overrides:

setAlt in class GmailRequest<Message>

setCallback

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

Description copied from class: GmailRequest

JSONP

Overrides:

setCallback in class GmailRequest<Message>

setFields

public Gmail.Users.Messages.GmailImport 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.GmailImport 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.GmailImport 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.GmailImport 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.GmailImport 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.GmailImport 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.GmailImport 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.GmailImport setUserId(String userId)

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

getDeleted

public Boolean getDeleted()

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

setDeleted

public Gmail.Users.Messages.GmailImport setDeleted(Boolean deleted)

Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for Google Workspace 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 Google Workspace accounts.

getInternalDateSource

public String getInternalDateSource()

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

setInternalDateSource

public Gmail.Users.Messages.GmailImport setInternalDateSource(String internalDateSource)

Source for Gmail's internal date of the message.

getNeverMarkSpam

public Boolean getNeverMarkSpam()

Ignore the Gmail spam classifier decision and never mark this email as SPAM in the mailbox. [default: false]

setNeverMarkSpam

public Gmail.Users.Messages.GmailImport setNeverMarkSpam(Boolean neverMarkSpam)

Ignore the Gmail spam classifier decision and never mark this email as SPAM in the mailbox.

isNeverMarkSpam

public boolean isNeverMarkSpam()

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.

Ignore the Gmail spam classifier decision and never mark this email as SPAM in the mailbox.

getProcessForCalendar

public Boolean getProcessForCalendar()

Process calendar invites in the email and add any extracted meetings to the Google Calendar for this user. [default: false]

setProcessForCalendar

public Gmail.Users.Messages.GmailImport setProcessForCalendar(Boolean processForCalendar)

Process calendar invites in the email and add any extracted meetings to the Google Calendar for this user.

isProcessForCalendar

public boolean isProcessForCalendar()

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.

Process calendar invites in the email and add any extracted meetings to the Google Calendar for this user.

set

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

Overrides:

set in class GmailRequest<Message>