-
Notifications
You must be signed in to change notification settings - Fork 10
Get GGmailHistory
Lists the history of all changes to the given mailbox. History results are returned in chronological order (increasing historyId).
Get-GGmailHistory [-UserId] <String> [[-LabelId] <String>] [[-MaxResults] <Int32>] [[-StartHistoryId] <UInt64>]
[-TargetUserEmail <String>] [-StandardQueryParams <StandardQueryParameters>] [-GAuthId <String>] [-WhatIf]
[-Confirm]
Lists the history of all changes to the given mailbox. History results are returned in chronological order (increasing historyId).
PS C:\> Get-GGmailHistory -UserId $SomeUserIdString
This automatically generated example serves to show the bare minimum required to call this Cmdlet.
Additional examples may be added, viewed and edited by users on the community wiki at the URL found in the related links.
The user's email address. The special value me can be used to indicate the authenticated user.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseOnly return messages with a label matching the ID.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThe maximum number of history records to return.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseRequired. 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.
Type: UInt64
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThe email account to be targeted by the service account.
Type: String
Parameter Sets: (All)
Aliases: ServiceAccountTarget
Required: False
Position: Named
Default value:
Accept pipeline input: False
Accept wildcard characters: FalseA Standard Query Parameters Object.
Type: StandardQueryParameters
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value:
Accept pipeline input: False
Accept wildcard characters: FalseThe GAuthId representing the gShell auth credentials this cmdlet should use to run.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value:
Accept pipeline input: False
Accept wildcard characters: FalseThe user's email address. The special value me can be used to indicate the authenticated user.
Only return messages with a label matching the ID.
The maximum number of history records to return.
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.
Part of the gShell Project, relating to the Google Gmail API; see Related Links or use the -Online parameter.
News - Get Started - Cmdlet Index - FAQ - Discussion - Downloads