Class UsersResource.MessagesResource.ListRequest

Lists the messages in the user's mailbox.

Inheritance

System.Object

Google.Apis.Requests.ClientServiceRequest

Google.Apis.Requests.ClientServiceRequest<ListMessagesResponse>

GmailBaseServiceRequest<ListMessagesResponse>

UsersResource.MessagesResource.ListRequest

Implements

Google.Apis.Requests.IClientServiceRequest<ListMessagesResponse>

Google.Apis.Requests.IClientServiceRequest

Inherited Members

GmailBaseServiceRequest<ListMessagesResponse>.Xgafv

GmailBaseServiceRequest<ListMessagesResponse>.AccessToken

GmailBaseServiceRequest<ListMessagesResponse>.Alt

GmailBaseServiceRequest<ListMessagesResponse>.Callback

GmailBaseServiceRequest<ListMessagesResponse>.Fields

GmailBaseServiceRequest<ListMessagesResponse>.Key

GmailBaseServiceRequest<ListMessagesResponse>.OauthToken

GmailBaseServiceRequest<ListMessagesResponse>.PrettyPrint

GmailBaseServiceRequest<ListMessagesResponse>.QuotaUser

GmailBaseServiceRequest<ListMessagesResponse>.UploadType

GmailBaseServiceRequest<ListMessagesResponse>.UploadProtocol

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Gmail.v1.Data.ListMessagesResponse>.Execute()

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Gmail.v1.Data.ListMessagesResponse>.ExecuteAsStream()

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Gmail.v1.Data.ListMessagesResponse>.ExecuteAsync()

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Gmail.v1.Data.ListMessagesResponse>.ExecuteAsync(System.Threading.CancellationToken)

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Gmail.v1.Data.ListMessagesResponse>.ExecuteAsStreamAsync()

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Gmail.v1.Data.ListMessagesResponse>.ExecuteAsStreamAsync(System.Threading.CancellationToken)

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Gmail.v1.Data.ListMessagesResponse>.CreateRequest(System.Nullable<System.Boolean>)

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Gmail.v1.Data.ListMessagesResponse>.GenerateRequestUri()

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Gmail.v1.Data.ListMessagesResponse>.GetBody()

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Gmail.v1.Data.ListMessagesResponse>.GetDefaultETagAction(System.String)

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Gmail.v1.Data.ListMessagesResponse>.ETagAction

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Gmail.v1.Data.ListMessagesResponse>.ModifyRequest

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Gmail.v1.Data.ListMessagesResponse>.ValidateParameters

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Gmail.v1.Data.ListMessagesResponse>.RequestParameters

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Gmail.v1.Data.ListMessagesResponse>.Service

Google.Apis.Requests.ClientServiceRequest._unsuccessfulResponseHandlers

Google.Apis.Requests.ClientServiceRequest._exceptionHandlers

Google.Apis.Requests.ClientServiceRequest._executeInterceptors

Google.Apis.Requests.ClientServiceRequest.AddUnsuccessfulResponseHandler(Google.Apis.Http.IHttpUnsuccessfulResponseHandler)

Google.Apis.Requests.ClientServiceRequest.AddExceptionHandler(Google.Apis.Http.IHttpExceptionHandler)

Google.Apis.Requests.ClientServiceRequest.AddExecuteInterceptor(Google.Apis.Http.IHttpExecuteInterceptor)

Google.Apis.Requests.ClientServiceRequest.Credential

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Google.Apis.Gmail.v1

Assembly: Google.Apis.Gmail.v1.dll

Syntax

public class 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
Google.Apis.Services.IClientService	service
System.String	userId

Properties

HttpMethod

Gets the HTTP method.

Declaration

public override string HttpMethod { get; }

Property Value

Type	Description
System.String

Overrides

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Gmail.v1.Data.ListMessagesResponse>.HttpMethod

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
System.Nullable<System.Boolean>

LabelIds

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

Declaration

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

Property Value

Type	Description
Google.Apis.Util.Repeatable<System.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
System.Nullable<System.Int64>

MethodName

Gets the method name.

Declaration

public override string MethodName { get; }

Property Value

Type	Description
System.String

Overrides

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Gmail.v1.Data.ListMessagesResponse>.MethodName

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
System.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
System.String

RestPath

Gets the REST path.

Declaration

public override string RestPath { get; }

Property Value

Type	Description
System.String

Overrides

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Gmail.v1.Data.ListMessagesResponse>.RestPath

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
System.String

Methods

InitParameters()

Initializes List parameter list.

Declaration

protected override void InitParameters()

Overrides

Google.Apis.Gmail.v1.GmailBaseServiceRequest<Google.Apis.Gmail.v1.Data.ListMessagesResponse>.InitParameters()

Implements

Google.Apis.Requests.IClientServiceRequest<TResponse>

Google.Apis.Requests.IClientServiceRequest