Google.Apis.Gmail.v1.UsersResource.MessagesResource.ListRequest Class Reference

Lists the messages in the user's mailbox. More...

Inheritance diagram for Google.Apis.Gmail.v1.UsersResource.MessagesResource.ListRequest:

Public Member Functions
	ListRequest (Google.Apis.Services.IClientService service, string userId)
	Constructs a new List request. More...

Protected Member Functions
override void	InitParameters ()
	Initializes List parameter list. More...
Protected Member Functions inherited from Google.Apis.Gmail.v1.GmailBaseServiceRequest< Google.Apis.Gmail.v1.Data.ListMessagesResponse >
	GmailBaseServiceRequest (Google.Apis.Services.IClientService service)
	Constructs a new GmailBaseServiceRequest instance. More...
override void	InitParameters ()
	Initializes Gmail parameter list. More...

Properties
virtual string	UserId [get]
	The user's email address. The special value me can be used to indicate the authenticated user. More...
virtual System.Nullable< bool >	IncludeSpamTrash [get, set]
	Include messages from SPAM and TRASH in the results. More...
virtual Google.Apis.Util.Repeatable< string >	LabelIds [get, set]
	Only return messages with labels that match all of the specified label IDs. More...
virtual System.Nullable< long >	MaxResults [get, set]
	Maximum number of messages to return. More...
virtual string	PageToken [get, set]
	Page token to retrieve a specific page of results in the list. More...
virtual string	Q [get, set]
	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. More...
override string	MethodName [get]
	summary>Gets the HTTP method. More...
override string	HttpMethod [get]
	summary>Gets the REST path. More...
override string	RestPath [get]
Properties inherited from Google.Apis.Gmail.v1.GmailBaseServiceRequest< Google.Apis.Gmail.v1.Data.ListMessagesResponse >
virtual System.Nullable< AltEnum >	Alt [get, set]
	Data format for the response. More...
virtual string	Fields [get, set]
	Selector specifying which fields to include in a partial response. More...
virtual string	Key [get, set]
	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. More...
virtual string	OauthToken [get, set]
	OAuth 2.0 token for the current user. More...
virtual System.Nullable< bool >	PrettyPrint [get, set]
	Returns response with indentations and line breaks. More...
virtual string	QuotaUser [get, set]
	An opaque string that represents a user for quota purposes. Must not exceed 40 characters. More...
virtual string	UserIp [get, set]
	Deprecated. Please use quotaUser instead. More...

Detailed Description

Lists the messages in the user's mailbox.

Constructor & Destructor Documentation

ListRequest()

Google.Apis.Gmail.v1.UsersResource.MessagesResource.ListRequest.ListRequest ( Google.Apis.Services.IClientService  service, string  userId  )

inline

Constructs a new List request.

Member Function Documentation

InitParameters()

override void Google.Apis.Gmail.v1.UsersResource.MessagesResource.ListRequest.InitParameters ( )

inlineprotected

Initializes List parameter list.

Property Documentation

HttpMethod

override string Google.Apis.Gmail.v1.UsersResource.MessagesResource.ListRequest.HttpMethod

get

summary>Gets the REST path.

IncludeSpamTrash

virtual System.Nullable<bool> Google.Apis.Gmail.v1.UsersResource.MessagesResource.ListRequest.IncludeSpamTrash

getset

Include messages from SPAM and TRASH in the results.

[default: false]

LabelIds

virtual Google.Apis.Util.Repeatable<string> Google.Apis.Gmail.v1.UsersResource.MessagesResource.ListRequest.LabelIds

getset

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

MaxResults

virtual System.Nullable<long> Google.Apis.Gmail.v1.UsersResource.MessagesResource.ListRequest.MaxResults

getset

Maximum number of messages to return.

[default: 100]

MethodName

override string Google.Apis.Gmail.v1.UsersResource.MessagesResource.ListRequest.MethodName

get

summary>Gets the HTTP method.

PageToken

virtual string Google.Apis.Gmail.v1.UsersResource.MessagesResource.ListRequest.PageToken

getset

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

Q

virtual string Google.Apis.Gmail.v1.UsersResource.MessagesResource.ListRequest.Q

getset

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.

summary>Gets the method name.

UserId

virtual string Google.Apis.Gmail.v1.UsersResource.MessagesResource.ListRequest.UserId

get

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

[default: me]

---

The documentation for this class was generated from the following file:

• Google.Apis.Gmail.v1.cs