Set GAdminSettingsEmailRouting

Deprectiation Notice: The Admin Settings API is deprecated and is scheduled to be sunset on August 16, 2017. See the following URL for more information: https://developers.google.com/admin-sdk/admin-settings/

Set-GAdminSettingsEmailRouting

SYNOPSIS

Update the Email Routing Settings.

SYNTAX

Set-GAdminSettingsEmailRouting [-RouteDestination] <String> [-RouteRewriteTo] <Boolean>
 [-RouteEnabled] <Boolean> [-BounceNotifications] <Boolean> [-AccountHandling] <RouteAccountHandlingEnum>
 [-Domain <String>] [-GAuthId <String>] [-WhatIf] [-Confirm]

DESCRIPTION

Update the Email Routing Settings.

EXAMPLES

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

PS C:\> Set-GAdminSettingsEmailRouting -RouteDestination $SomeRouteDestinationString -RouteRewriteTo $SomeRouteRewriteToBool
                -RouteEnabled $SomeRouteEnabledBool -BounceNotifications $SomeBounceNotificationsBool -AccountHandling allAccounts

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

-RouteDestination

This destination is the hostname or IP address of the SMTP-In mail server where the email is being routed. The hostname or IP address must resolve for Google.

Type: String
Parameter Sets: (All)
Aliases: 

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

-RouteRewriteTo

If true, the message's SMTP envelope's to: field is changed to the destination hostname (user@destination's hostname), and the message is delivered to this user address on the destination mail server. If false, the email is delivered to the original message's to: email address (user@original hostname) on the destination mail server. This is similar to the Admin console's 'Change SMTP envelope' setting.

Type: Boolean
Parameter Sets: (All)
Aliases: 

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

-RouteEnabled

If true, the email routing functionality is enabled. If false, the functionality is disabled.

Type: Boolean
Parameter Sets: (All)
Aliases: 

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

-BounceNotifications

If true, Google Apps is enabled to send bounce notifications to the sender when a delivery fails.

Type: Boolean
Parameter Sets: (All)
Aliases: 

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

-AccountHandling

This setting determines how different types of users in the domain are affected by email routing: * allAccounts -- Deliver all email to this destination.

provisionedAccounts -- Deliver mail to this destination if the user exists in Google Apps.
unknownAccounts -- Deliver mail to this destination if the user does not exist in Google Apps. This is similar to the Admin console's 'Delivery email for' setting.

Possible values: allAccounts, provisionedAccounts, unknownAccounts

Type: RouteAccountHandlingEnum
Parameter Sets: (All)
Aliases: 
Accepted values: allAccounts, provisionedAccounts, unknownAccounts

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

-Domain

The target domain for this admin 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