Class UsersResource.MessagesResource.ListRequest

Lists the messages in the user's mailbox.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<ListMessagesResponse>
GmailBaseServiceRequest<ListMessagesResponse>
UsersResource.MessagesResource.ListRequest
Implements
Inherited Members
Namespace: Google.Apis.Gmail.v1
Assembly: Google.Apis.Gmail.v1.dll
Syntax
public class UsersResource.MessagesResource.ListRequest : GmailBaseServiceRequest<ListMessagesResponse>, IClientServiceRequest<ListMessagesResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService, string)

Constructs a new List request.

Declaration
public ListRequest(IClientService service, string userId)
Parameters
Type Name Description
IClientService service
string userId

Properties

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

IncludeSpamTrash

Include messages from SPAM and TRASH in the results.

Declaration
[RequestParameter("includeSpamTrash", RequestParameterType.Query)]
public virtual bool? IncludeSpamTrash { get; set; }
Property Value
Type Description
bool?

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.

Declaration
[RequestParameter("labelIds", RequestParameterType.Query)]
public virtual Repeatable<string> LabelIds { get; set; }
Property Value
Type Description
Repeatable<string>

MaxResults

Maximum number of messages to return. This field defaults to 100. The maximum allowed value for this field is 500.

Declaration
[RequestParameter("maxResults", RequestParameterType.Query)]
public virtual long? MaxResults { get; set; }
Property Value
Type Description
long?

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

PageToken

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

Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type Description
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.

Declaration
[RequestParameter("q", RequestParameterType.Query)]
public virtual string Q { get; set; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

UserId

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

Declaration
[RequestParameter("userId", RequestParameterType.Path)]
public virtual string UserId { get; }
Property Value
Type Description
string

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements