Gmail.Users.Messages.List (Gmail API v1-rev20240520-2.0.0)

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<ListMessagesResponse>
        
        com.google.api.services.gmail.Gmail.Users.Messages.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Gmail.Users.Messages
```
public class Gmail.Users.Messages.List
extends GmailRequest<ListMessagesResponse>
```

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 List(String userId)
Lists the messages in the user's mailbox.

Constructors
Modifier	Constructor and Description
`protected`	`List(String userId)` Lists the messages in the user's mailbox.

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()`
`Boolean`	`getIncludeSpamTrash()` Include messages from `SPAM` and `TRASH` in the results.
`List<String>`	`getLabelIds()` Only return messages with labels that match all of the specified label IDs.
`Long`	`getMaxResults()` Maximum number of messages to return.
`String`	`getPageToken()` Page token to retrieve a specific page of results in the list.
`String`	`getQ()` Only return messages matching the specified query.
`String`	`getUserId()` The user's email address.
`boolean`	`isIncludeSpamTrash()` Convenience method that returns only `Boolean.TRUE` or `Boolean.FALSE`.
`Gmail.Users.Messages.List`	`set(String parameterName, Object value)`
`Gmail.Users.Messages.List`	`set$Xgafv(String $Xgafv)` V1 error format.
`Gmail.Users.Messages.List`	`setAccessToken(String accessToken)` OAuth access token.
`Gmail.Users.Messages.List`	`setAlt(String alt)` Data format for response.
`Gmail.Users.Messages.List`	`setCallback(String callback)` JSONP
`Gmail.Users.Messages.List`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Gmail.Users.Messages.List`	`setIncludeSpamTrash(Boolean includeSpamTrash)` Include messages from `SPAM` and `TRASH` in the results.
`Gmail.Users.Messages.List`	`setKey(String key)` API key.
`Gmail.Users.Messages.List`	`setLabelIds(List<String> labelIds)` Only return messages with labels that match all of the specified label IDs.
`Gmail.Users.Messages.List`	`setMaxResults(Long maxResults)` Maximum number of messages to return.
`Gmail.Users.Messages.List`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Gmail.Users.Messages.List`	`setPageToken(String pageToken)` Page token to retrieve a specific page of results in the list.
`Gmail.Users.Messages.List`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Gmail.Users.Messages.List`	`setQ(String q)` Only return messages matching the specified query.
`Gmail.Users.Messages.List`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`Gmail.Users.Messages.List`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`Gmail.Users.Messages.List`	`setUploadType(String uploadType)` Legacy upload protocol for media (e.g.
`Gmail.Users.Messages.List`	`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, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, 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
  - List
```
protected List(String userId)
```
    Lists the messages in the user's mailbox. Create a request for the method "messages.list". 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]
    
    Since:
    
    1.13
- Method Detail
  - executeUsingHead
```
public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws IOException
```
    Overrides:
    
    executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListMessagesResponse>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListMessagesResponse>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public Gmail.Users.Messages.List set$Xgafv(String $Xgafv)
```
    Description copied from class: GmailRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class GmailRequest<ListMessagesResponse>
  - setAccessToken
```
public Gmail.Users.Messages.List setAccessToken(String accessToken)
```
    Description copied from class: GmailRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class GmailRequest<ListMessagesResponse>
  - setAlt
```
public Gmail.Users.Messages.List setAlt(String alt)
```
    Description copied from class: GmailRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class GmailRequest<ListMessagesResponse>
  - setCallback
```
public Gmail.Users.Messages.List setCallback(String callback)
```
    Description copied from class: GmailRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class GmailRequest<ListMessagesResponse>
  - setFields
```
public Gmail.Users.Messages.List setFields(String fields)
```
    Description copied from class: GmailRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class GmailRequest<ListMessagesResponse>
  - setKey
```
public Gmail.Users.Messages.List 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<ListMessagesResponse>
  - setOauthToken
```
public Gmail.Users.Messages.List setOauthToken(String oauthToken)
```
    Description copied from class: GmailRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class GmailRequest<ListMessagesResponse>
  - setPrettyPrint
```
public Gmail.Users.Messages.List setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: GmailRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class GmailRequest<ListMessagesResponse>
  - setQuotaUser
```
public Gmail.Users.Messages.List 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<ListMessagesResponse>
  - setUploadType
```
public Gmail.Users.Messages.List setUploadType(String uploadType)
```
    Description copied from class: GmailRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class GmailRequest<ListMessagesResponse>
  - setUploadProtocol
```
public Gmail.Users.Messages.List setUploadProtocol(String uploadProtocol)
```
    Description copied from class: GmailRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class GmailRequest<ListMessagesResponse>
  - 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.List setUserId(String userId)
```
    The user's email address. The special value `me` can be used to indicate the authenticated user.
  - getIncludeSpamTrash
```
public Boolean getIncludeSpamTrash()
```
    Include messages from `SPAM` and `TRASH` in the results. [default: false]
  - setIncludeSpamTrash
```
public Gmail.Users.Messages.List setIncludeSpamTrash(Boolean includeSpamTrash)
```
    Include messages from `SPAM` and `TRASH` in the results.
  - isIncludeSpamTrash
```
public boolean isIncludeSpamTrash()
```
    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.
    
    Include messages from `SPAM` and `TRASH` in the results.
  - getLabelIds
```
public List<String> getLabelIds()
```
    Only return messages with labels that match all of the specified label IDs. Messages in a thread might have labels that other messages in the same thread don't have. To learn more, see [Manage labels on messages and threads](https://developers.google.com/gmail/api/guides/labels#manage_labels_on_messages_threads).
  - setLabelIds
```
public Gmail.Users.Messages.List setLabelIds(List<String> labelIds)
```
    Only return messages with labels that match all of the specified label IDs. Messages in a thread might have labels that other messages in the same thread don't have. To learn more, see [Manage labels on messages and threads](https://developers.google.com/gmail/api /guides/labels#manage_labels_on_messages_threads).
  - getMaxResults
```
public Long getMaxResults()
```
    Maximum number of messages to return. This field defaults to 100. The maximum allowed value for this field is 500. [default: 100]
  - setMaxResults
```
public Gmail.Users.Messages.List setMaxResults(Long maxResults)
```
    Maximum number of messages to return. This field defaults to 100. The maximum allowed value for this field is 500.
  - getPageToken
```
public String getPageToken()
```
    Page token to retrieve a specific page of results in the list.
  - setPageToken
```
public Gmail.Users.Messages.List setPageToken(String pageToken)
```
    Page token to retrieve a specific page of results in the list.
  - getQ
```
public String getQ()
```
    Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, `"from:someuser@example.com rfc822msgid: is:unread"`. Parameter cannot be used when accessing the api using the gmail.metadata scope.
  - setQ
```
public Gmail.Users.Messages.List setQ(String q)
```
    Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, `"from:someuser@example.com rfc822msgid: is:unread"`. Parameter cannot be used when accessing the api using the gmail.metadata scope.
  - set
```
public Gmail.Users.Messages.List set(String parameterName,
                                     Object value)
```
    Overrides:
    
    set in class GmailRequest<ListMessagesResponse>

Class Gmail.Users.Messages.List

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

List

Method Detail

executeUsingHead

buildHttpRequestUsingHead

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getUserId

setUserId

getIncludeSpamTrash

setIncludeSpamTrash

isIncludeSpamTrash

getLabelIds

setLabelIds

getMaxResults

setMaxResults

getPageToken

setPageToken

getQ

setQ

set