com.google.api.services.gmail

Class Gmail.Users.Messages.Attachments.Get

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

com.google.api.services.gmail.Gmail.Users.Messages.Attachments.Get

All Implemented Interfaces:

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

Enclosing class:

Gmail.Users.Messages.Attachments

public class Gmail.Users.Messages.Attachments.Get
extends GmailRequest<MessagePartBody>

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>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Gmail.Users.Messages.Attachments.Get(java.lang.String userId, java.lang.String messageId, java.lang.String id) Gets the specified message attachment.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
java.lang.String	getId() The ID of the attachment.
java.lang.String	getMessageId() The ID of the message containing the attachment.
java.lang.String	getUserId() The user's email address.
Gmail.Users.Messages.Attachments.Get	set(java.lang.String parameterName, java.lang.Object value)
Gmail.Users.Messages.Attachments.Get	setAlt(java.lang.String alt) Data format for the response.
Gmail.Users.Messages.Attachments.Get	setFields(java.lang.String fields) Selector specifying which fields to include in a partial response.
Gmail.Users.Messages.Attachments.Get	setId(java.lang.String id) The ID of the attachment.
Gmail.Users.Messages.Attachments.Get	setKey(java.lang.String key) API key.
Gmail.Users.Messages.Attachments.Get	setMessageId(java.lang.String messageId) The ID of the message containing the attachment.
Gmail.Users.Messages.Attachments.Get	setOauthToken(java.lang.String oauthToken) OAuth 2.0 token for the current user.
Gmail.Users.Messages.Attachments.Get	setPrettyPrint(java.lang.Boolean prettyPrint) Returns response with indentations and line breaks.
Gmail.Users.Messages.Attachments.Get	setQuotaUser(java.lang.String quotaUser) Available to use for quota purposes for server-side applications.
Gmail.Users.Messages.Attachments.Get	setUserId(java.lang.String userId) The user's email address.
Gmail.Users.Messages.Attachments.Get	setUserIp(java.lang.String userIp) IP address of the site where the request originates.

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, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, 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

Constructor Detail

Gmail.Users.Messages.Attachments.Get

protected Gmail.Users.Messages.Attachments.Get(java.lang.String userId,
                                    java.lang.String messageId,
                                    java.lang.String id)

Gets the specified message attachment. Create a request for the method "attachments.get". 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]

messageId - The ID of the message containing the attachment.

id - The ID of the attachment.

Since:

1.13

Method Detail

executeUsingHead

public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws java.io.IOException

Overrides:

executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<MessagePartBody>

Throws:

java.io.IOException

buildHttpRequestUsingHead

public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws java.io.IOException

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<MessagePartBody>

Throws:

java.io.IOException

setAlt

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

Description copied from class: GmailRequest

Data format for the response.

Overrides:

setAlt in class GmailRequest<MessagePartBody>

setFields

public Gmail.Users.Messages.Attachments.Get 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<MessagePartBody>

setKey

public Gmail.Users.Messages.Attachments.Get 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<MessagePartBody>

setOauthToken

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

Description copied from class: GmailRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class GmailRequest<MessagePartBody>

setPrettyPrint

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

Description copied from class: GmailRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class GmailRequest<MessagePartBody>

setQuotaUser

public Gmail.Users.Messages.Attachments.Get setQuotaUser(java.lang.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 userIp if both are provided.

Overrides:

setQuotaUser in class GmailRequest<MessagePartBody>

setUserIp

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

Description copied from class: GmailRequest

IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Overrides:

setUserIp in class GmailRequest<MessagePartBody>

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

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

getMessageId

public java.lang.String getMessageId()

The ID of the message containing the attachment.

setMessageId

public Gmail.Users.Messages.Attachments.Get setMessageId(java.lang.String messageId)

The ID of the message containing the attachment.

getId

public java.lang.String getId()

The ID of the attachment.

setId

public Gmail.Users.Messages.Attachments.Get setId(java.lang.String id)

The ID of the attachment.

set

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

Overrides:

set in class GmailRequest<MessagePartBody>