com.google.api.services.gmail

Class Gmail.Users.Threads.List

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

com.google.api.services.gmail.Gmail.Users.Threads.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Gmail.Users.Threads

public class Gmail.Users.Threads.List
extends GmailRequest<ListThreadsResponse>

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

USER_AGENT_SUFFIX

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
Boolean	getIncludeSpamTrash() Include threads from SPAM and TRASH in the results.
List<String>	getLabelIds() Only return threads with labels that match all of the specified label IDs.
Long	getMaxResults() Maximum number of threads to return.
String	getPageToken() Page token to retrieve a specific page of results in the list.
String	getQ() Only return threads 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.Threads.List	set(String parameterName, Object value)
Gmail.Users.Threads.List	setAlt(String alt) Data format for the response.
Gmail.Users.Threads.List	setFields(String fields) Selector specifying which fields to include in a partial response.
Gmail.Users.Threads.List	setIncludeSpamTrash(Boolean includeSpamTrash) Include threads from SPAM and TRASH in the results.
Gmail.Users.Threads.List	setKey(String key) API key.
Gmail.Users.Threads.List	setLabelIds(List<String> labelIds) Only return threads with labels that match all of the specified label IDs.
Gmail.Users.Threads.List	setMaxResults(Long maxResults) Maximum number of threads to return.
Gmail.Users.Threads.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Gmail.Users.Threads.List	setPageToken(String pageToken) Page token to retrieve a specific page of results in the list.
Gmail.Users.Threads.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Gmail.Users.Threads.List	setQ(String q) Only return threads matching the specified query.
Gmail.Users.Threads.List	setQuotaUser(String quotaUser) An opaque string that represents a user for quota purposes.
Gmail.Users.Threads.List	setUserId(String userId) The user's email address.
Gmail.Users.Threads.List	setUserIp(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

List

protected List(String userId)

Lists the threads in the user's mailbox. Create a request for the method "threads.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<ListThreadsResponse>

Throws:

IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

IOException

setAlt

public Gmail.Users.Threads.List setAlt(String alt)

Description copied from class: GmailRequest

Data format for the response.

Overrides:

setAlt in class GmailRequest<ListThreadsResponse>

setFields

public Gmail.Users.Threads.List setFields(String fields)

Description copied from class: GmailRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class GmailRequest<ListThreadsResponse>

setKey

public Gmail.Users.Threads.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<ListThreadsResponse>

setOauthToken

public Gmail.Users.Threads.List setOauthToken(String oauthToken)

Description copied from class: GmailRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class GmailRequest<ListThreadsResponse>

setPrettyPrint

public Gmail.Users.Threads.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: GmailRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class GmailRequest<ListThreadsResponse>

setQuotaUser

public Gmail.Users.Threads.List setQuotaUser(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<ListThreadsResponse>

setUserIp

public Gmail.Users.Threads.List setUserIp(String userIp)

Description copied from class: GmailRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class GmailRequest<ListThreadsResponse>

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.Threads.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 threads from SPAM and TRASH in the results. [default: false]

setIncludeSpamTrash

public Gmail.Users.Threads.List setIncludeSpamTrash(Boolean includeSpamTrash)

Include threads 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 threads from SPAM and TRASH in the results.

getLabelIds

public List<String> getLabelIds()

Only return threads with labels that match all of the specified label IDs.

setLabelIds

public Gmail.Users.Threads.List setLabelIds(List<String> labelIds)

Only return threads with labels that match all of the specified label IDs.

getMaxResults

public Long getMaxResults()

Maximum number of threads to return. [default: 100]

setMaxResults

public Gmail.Users.Threads.List setMaxResults(Long maxResults)

Maximum number of threads to return.

getPageToken

public String getPageToken()

Page token to retrieve a specific page of results in the list.

setPageToken

public Gmail.Users.Threads.List setPageToken(String pageToken)

Page token to retrieve a specific page of results in the list.

getQ

public String getQ()

Only return threads 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.Threads.List setQ(String q)

Only return threads 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.Threads.List set(String parameterName,
                                    Object value)

Overrides:

set in class GmailRequest<ListThreadsResponse>