Get GGmailFilter

Get-GGmailFilter

SYNOPSIS

Gets one or all filters for the specified account.

SYNTAX

One (Default)

Get-GGmailFilter [-UserId] <String> [-Id] <String> [-TargetUserEmail <String>]
 [-StandardQueryParams <StandardQueryParameters>] [-GAuthId <String>] [-WhatIf] [-Confirm]

List

Get-GGmailFilter [-UserId] <String> [-All] [-TargetUserEmail <String>]
 [-StandardQueryParams <StandardQueryParameters>] [-GAuthId <String>] [-WhatIf] [-Confirm]

DESCRIPTION

Gets one or all filters for the specified account.

EXAMPLES

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

PS C:\>Get-GGmailFilter -UserId $SomeUserIdString -Id $SomeIdString

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.

---------- EXAMPLE 2 ----------

PS C:\>Get-GGmailFilter -UserId $SomeUserIdString -All

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

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

-Id

The ID of the filter to be fetched.

Type: String
Parameter Sets: One
Aliases: 

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

-All

A switch to list all results.

Type: SwitchParameter
Parameter Sets: List
Aliases: 

Required: True
Position: 1
Default value: False
Accept pipeline input: False
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

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

System.String

The ID of the filter to be fetched.

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]