Table of Contents

Class UsersResource.HistoryResource.ListRequest

Namespace
Google.Apis.Gmail.v1
Assembly
Google.Apis.Gmail.v1.dll

Lists the history of all changes to the given mailbox. History results are returned in chronological order (increasing historyId).

public class UsersResource.HistoryResource.ListRequest : GmailBaseServiceRequest<ListHistoryResponse>
Inheritance
UsersResource.HistoryResource.ListRequest
Inherited Members

Constructors

ListRequest(IClientService, string)

Constructs a new List request.

public ListRequest(IClientService service, string userId)

Parameters

service IClientService
userId string

Properties

HistoryTypes

History types to be returned by the function

public virtual UsersResource.HistoryResource.ListRequest.HistoryTypesEnum? HistoryTypes { get; set; }

Property Value

UsersResource.HistoryResource.ListRequest.HistoryTypesEnum?

HttpMethod

Gets the HTTP method.

public override string HttpMethod { get; }

Property Value

string

LabelId

Only return messages with a label matching the ID.

public virtual string LabelId { get; set; }

Property Value

string

MaxResults

The maximum number of history records to return.

public virtual long? MaxResults { get; set; }

Property Value

long?

MethodName

Gets the method name.

public override string MethodName { get; }

Property Value

string

PageToken

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

public virtual string PageToken { get; set; }

Property Value

string

RestPath

Gets the REST path.

public override string RestPath { get; }

Property Value

string

StartHistoryId

Required. Returns history records after the specified startHistoryId. The supplied startHistoryId should be obtained from the historyId of a message, thread, or previous list response. History IDs increase chronologically but are not contiguous with random gaps in between valid IDs. Supplying an invalid or out of date startHistoryId typically returns an HTTP 404 error code. A historyId is typically valid for at least a week, but in some rare circumstances may be valid for only a few hours. If you receive an HTTP 404 error response, your application should perform a full sync. If you receive no nextPageToken in the response, there are no updates to retrieve and you can store the returned historyId for a future request.

public virtual ulong? StartHistoryId { get; set; }

Property Value

ulong?

UserId

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

public virtual string UserId { get; }

Property Value

string

Methods

InitParameters()

Initializes List parameter list.

protected override void InitParameters()