Set GEmailSettingsForwarding

Deprectiation Notice: The Email Settings API is deprecated and will be turned off on July 7, 2017. Migrate to the Gmail API as soon as possible to avoid disruptions to your application. See the following URL for more information: https://developers.google.com/admin-sdk/email-settings/

Set-GEmailSettingsForwarding

SYNOPSIS

Update Google Mail forwarding settings

SYNTAX

Set-GEmailSettingsForwarding [-UserName] <String> [-Enable] <Boolean> [-ForwardTo] <String>
 [-Action] <ForwardingActionEnum> [-Domain <String>] [-GAuthId <String>] [-WhatIf] [-Confirm]

DESCRIPTION

Update Google Mail forwarding settings

EXAMPLES

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

PS C:\> Set-GEmailSettingsForwarding -UserName $SomeUserNameString

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

-UserName

The target Google Apps user.

Type: String
Parameter Sets: (All)
Aliases: 

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

-Enable

Whether to enable forwarding of incoming mail.

Type: Boolean
Parameter Sets: (All)
Aliases: 

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

-ForwardTo

The email will be forwarded to this address.

Type: String
Parameter Sets: (All)
Aliases: 

Required: True
Position: 3
Default value: 
Accept pipeline input: False
Accept wildcard characters: False

-Action

What Google Mail should do with its copy of the email after forwarding it on. "KEEP" (in inbox), "ARCHIVE", or "DELETE" (send to spam), or "MARK_READ" (marked as read),

Possible values: KEEP, ARCHIVE, DELETE, MARK_READ

Type: ForwardingActionEnum
Parameter Sets: (All)
Aliases: 
Accepted values: KEEP, ARCHIVE, DELETE, MARK_READ

Required: True
Position: 4
Default value: KEEP
Accept pipeline input: False
Accept wildcard characters: False

-Domain

The target domain for this email settings cmdlet.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: 
Accept pipeline input: True (ByPropertyName)
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