public class Gmail.Users.Messages.List extends GmailRequest<ListMessagesResponse>
com.google.api.client.util.GenericData.Flags
Modifier | Constructor and Description |
---|---|
protected |
List(java.lang.String userId)
Lists the messages in the user's mailbox.
|
Modifier and Type | Method and Description |
---|---|
com.google.api.client.http.HttpRequest |
buildHttpRequestUsingHead() |
com.google.api.client.http.HttpResponse |
executeUsingHead() |
java.lang.Boolean |
getIncludeSpamTrash()
Include messages from SPAM and TRASH in the results.
|
java.util.List<java.lang.String> |
getLabelIds()
Only return messages with labels that match all of the specified label IDs.
|
java.lang.Long |
getMaxResults()
Maximum number of messages to return.
|
java.lang.String |
getPageToken()
Page token to retrieve a specific page of results in the list.
|
java.lang.String |
getQ()
Only return messages matching the specified query.
|
java.lang.String |
getUserId()
The user's email address.
|
boolean |
isIncludeSpamTrash()
Convenience method that returns only
Boolean.TRUE or Boolean.FALSE . |
Gmail.Users.Messages.List |
set(java.lang.String parameterName,
java.lang.Object value) |
Gmail.Users.Messages.List |
setAlt(java.lang.String alt)
Data format for the response.
|
Gmail.Users.Messages.List |
setFields(java.lang.String fields)
Selector specifying which fields to include in a partial response.
|
Gmail.Users.Messages.List |
setIncludeSpamTrash(java.lang.Boolean includeSpamTrash)
Include messages from SPAM and TRASH in the results.
|
Gmail.Users.Messages.List |
setKey(java.lang.String key)
API key.
|
Gmail.Users.Messages.List |
setLabelIds(java.util.List<java.lang.String> labelIds)
Only return messages with labels that match all of the specified label IDs.
|
Gmail.Users.Messages.List |
setMaxResults(java.lang.Long maxResults)
Maximum number of messages to return.
|
Gmail.Users.Messages.List |
setOauthToken(java.lang.String oauthToken)
OAuth 2.0 token for the current user.
|
Gmail.Users.Messages.List |
setPageToken(java.lang.String pageToken)
Page token to retrieve a specific page of results in the list.
|
Gmail.Users.Messages.List |
setPrettyPrint(java.lang.Boolean prettyPrint)
Returns response with indentations and line breaks.
|
Gmail.Users.Messages.List |
setQ(java.lang.String q)
Only return messages matching the specified query.
|
Gmail.Users.Messages.List |
setQuotaUser(java.lang.String quotaUser)
An opaque string that represents a user for quota purposes.
|
Gmail.Users.Messages.List |
setUserId(java.lang.String userId)
The user's email address.
|
Gmail.Users.Messages.List |
setUserIp(java.lang.String userIp)
Deprecated.
|
getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, setDisableGZipContent, setRequestHeaders
getJsonContent, newExceptionOnError, queue
buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue
clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, values
protected List(java.lang.String userId)
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.
userId
- The user's email address. The special value me can be used to indicate the authenticated user.
[default: me]public com.google.api.client.http.HttpResponse executeUsingHead() throws java.io.IOException
executeUsingHead
in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListMessagesResponse>
java.io.IOException
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead() throws java.io.IOException
buildHttpRequestUsingHead
in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListMessagesResponse>
java.io.IOException
public Gmail.Users.Messages.List setAlt(java.lang.String alt)
GmailRequest
setAlt
in class GmailRequest<ListMessagesResponse>
public Gmail.Users.Messages.List setFields(java.lang.String fields)
GmailRequest
setFields
in class GmailRequest<ListMessagesResponse>
public Gmail.Users.Messages.List setKey(java.lang.String key)
GmailRequest
setKey
in class GmailRequest<ListMessagesResponse>
public Gmail.Users.Messages.List setOauthToken(java.lang.String oauthToken)
GmailRequest
setOauthToken
in class GmailRequest<ListMessagesResponse>
public Gmail.Users.Messages.List setPrettyPrint(java.lang.Boolean prettyPrint)
GmailRequest
setPrettyPrint
in class GmailRequest<ListMessagesResponse>
public Gmail.Users.Messages.List setQuotaUser(java.lang.String quotaUser)
GmailRequest
setQuotaUser
in class GmailRequest<ListMessagesResponse>
public Gmail.Users.Messages.List setUserIp(java.lang.String userIp)
GmailRequest
setUserIp
in class GmailRequest<ListMessagesResponse>
public java.lang.String getUserId()
public Gmail.Users.Messages.List setUserId(java.lang.String userId)
public java.lang.Boolean getIncludeSpamTrash()
public Gmail.Users.Messages.List setIncludeSpamTrash(java.lang.Boolean includeSpamTrash)
public boolean isIncludeSpamTrash()
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.
public java.util.List<java.lang.String> getLabelIds()
public Gmail.Users.Messages.List setLabelIds(java.util.List<java.lang.String> labelIds)
public java.lang.Long getMaxResults()
public Gmail.Users.Messages.List setMaxResults(java.lang.Long maxResults)
public java.lang.String getPageToken()
public Gmail.Users.Messages.List setPageToken(java.lang.String pageToken)
public java.lang.String getQ()
public Gmail.Users.Messages.List setQ(java.lang.String q)
public Gmail.Users.Messages.List set(java.lang.String parameterName, java.lang.Object value)
set
in class GmailRequest<ListMessagesResponse>