Skip to content

New GGmailFilterActionObj

Spencer Varney edited this page Dec 14, 2016 · 1 revision

New-GGmailFilterActionObj

SYNOPSIS

Creates a new Gmail API FilterAction object.

SYNTAX

New-GGmailFilterActionObj [[-AddLabelIds] <String[]>] [[-Forward] <String>] [[-RemoveLabelIds] <String[]>]
 [-WhatIf] [-Confirm]

DESCRIPTION

This provides a Cmdlet-Based approach to creating a FilterAction object which may be required as a parameter for some other Cmdlets in the Gmail API category.

You could alternately create this object by calling New-Object -TypeName Google.Apis.Gmail.v1.Data.FilterAction

EXAMPLES

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

PS C:\>New-GGmailFilterActionObj

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

-AddLabelIds

List of labels to add to the message.

Type: String[]
Parameter Sets: (All)
Aliases: 

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

-Forward

Email address that the message should be forwarded to.

Type: String
Parameter Sets: (All)
Aliases: 

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

-RemoveLabelIds

List of labels to remove from the message.

Type: String[]
Parameter Sets: (All)
Aliases: 

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

INPUTS

System.String[]

List of labels to add to the message.

System.String

Email address that the message should be forwarded to.

System.String[]

List of labels to remove from the message.

OUTPUTS

Google.Apis.Gmail.v1.Data.FilterAction

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