Skip to content
Spencer Varney edited this page Dec 27, 2016 · 3 revisions

Watch-GGmail

SYNOPSIS

Set up or update a push notification watch on the given user mailbox.

SYNTAX

Watch-GGmail [-UserId] <String> [[-WatchRequestBody] <WatchRequest>] [-TargetUserEmail <String>]
 [-StandardQueryParams <StandardQueryParameters>] [-GAuthId <String>] [-WhatIf] [-Confirm]

DESCRIPTION

Set up or update a push notification watch on the given user mailbox.

EXAMPLES

---------- EXAMPLE 1 ----------

PS C:\> Watch-GGmail -UserId $SomeUserIdString -WatchRequestBody $SomeWatchRequestObj

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.

PARAMETERS

-UserId

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: False

-WatchRequestBody

Set up or update a new push notification watch on this user's mailbox.

Type: WatchRequest
Parameter Sets: (All)
Aliases: 

Required: False
Position: 1
Default value: 
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-TargetUserEmail

The 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: False

-StandardQueryParams

A Standard Query Parameters Object.

Type: StandardQueryParameters
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: 
Accept pipeline input: False
Accept wildcard characters: False

-GAuthId

The 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: False

INPUTS

System.String

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

Google.Apis.Gmail.v1.Data.WatchRequest

Set up or update a new push notification watch on this user's mailbox.

OUTPUTS

NOTES

Part of the gShell Project, relating to the Google Gmail API; see Related Links or use the -Online parameter.

RELATED LINKS

[Wiki page for this Cmdlet]

[Getting started with gShell]

Clone this wiki locally