Gmail.Users.Messages.Get (Gmail API v1 (Rev. 110) 1.25.0)

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

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.Get
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 Get(java.lang.String userId, java.lang.String id)
Gets the specified message.

Constructors
Modifier	Constructor and Description
`protected`	`Get(java.lang.String userId, java.lang.String id)` Gets the specified message.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.google.api.client.http.HttpRequest`	`buildHttpRequestUsingHead()`
`com.google.api.client.http.HttpResponse`	`executeUsingHead()`
`java.lang.String`	`getFormat()` The format to return the message in.
`java.lang.String`	`getId()` The ID of the message to retrieve.
`java.util.List<java.lang.String>`	`getMetadataHeaders()` When given and format is METADATA, only include headers specified.
`java.lang.String`	`getUserId()` The user's email address.
`Gmail.Users.Messages.Get`	`set(java.lang.String parameterName, java.lang.Object value)`
`Gmail.Users.Messages.Get`	`setAlt(java.lang.String alt)` Data format for the response.
`Gmail.Users.Messages.Get`	`setFields(java.lang.String fields)` Selector specifying which fields to include in a partial response.
`Gmail.Users.Messages.Get`	`setFormat(java.lang.String format)` The format to return the message in.
`Gmail.Users.Messages.Get`	`setId(java.lang.String id)` The ID of the message to retrieve.
`Gmail.Users.Messages.Get`	`setKey(java.lang.String key)` API key.
`Gmail.Users.Messages.Get`	`setMetadataHeaders(java.util.List<java.lang.String> metadataHeaders)` When given and format is METADATA, only include headers specified.
`Gmail.Users.Messages.Get`	`setOauthToken(java.lang.String oauthToken)` OAuth 2.0 token for the current user.
`Gmail.Users.Messages.Get`	`setPrettyPrint(java.lang.Boolean prettyPrint)` Returns response with indentations and line breaks.
`Gmail.Users.Messages.Get`	`setQuotaUser(java.lang.String quotaUser)` An opaque string that represents a user for quota purposes.
`Gmail.Users.Messages.Get`	`setUserId(java.lang.String userId)` The user's email address.
`Gmail.Users.Messages.Get`	`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, 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

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Get
```
protected Get(java.lang.String userId,
              java.lang.String id)
```
    Gets the specified message. Create a request for the method "messages.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]
    
    id - The ID of the message to retrieve.
    
    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<Message>
    
    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<Message>
    
    Throws:
    
    java.io.IOException
  - setAlt
```
public Gmail.Users.Messages.Get 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.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<Message>
  - setKey
```
public Gmail.Users.Messages.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<Message>
  - setOauthToken
```
public Gmail.Users.Messages.Get 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.Get 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.Get 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.Get 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.Get setUserId(java.lang.String userId)
```
    The user's email address. The special value me can be used to indicate the authenticated user.
  - getId
```
public java.lang.String getId()
```
    The ID of the message to retrieve.
  - setId
```
public Gmail.Users.Messages.Get setId(java.lang.String id)
```
    The ID of the message to retrieve.
  - getFormat
```
public java.lang.String getFormat()
```
    The format to return the message in. [default: full]
  - setFormat
```
public Gmail.Users.Messages.Get setFormat(java.lang.String format)
```
    The format to return the message in.
  - getMetadataHeaders
```
public java.util.List<java.lang.String> getMetadataHeaders()
```
    When given and format is METADATA, only include headers specified.
  - setMetadataHeaders
```
public Gmail.Users.Messages.Get setMetadataHeaders(java.util.List<java.lang.String> metadataHeaders)
```
    When given and format is METADATA, only include headers specified.
  - set
```
public Gmail.Users.Messages.Get set(java.lang.String parameterName,
                                    java.lang.Object value)
```
    Overrides:
    
    set in class GmailRequest<Message>

Gmail API v1 (revision 110)

Class Gmail.Users.Messages.Get

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Constructor Summary

Method Summary

Methods inherited from class com.google.api.services.gmail.GmailRequest

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Get

Method Detail

executeUsingHead

buildHttpRequestUsingHead

setAlt

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUserIp

getUserId

setUserId

getId

setId

getFormat

setFormat

getMetadataHeaders

setMetadataHeaders

set