Skip to content

Set GAdminSettingsEmailGateway

Spencer Varney edited this page Dec 9, 2016 · 2 revisions

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-GAdminSettingsEmailGateway

SYNOPSIS

Update outbound email gateway settings.

SYNTAX

Set-GAdminSettingsEmailGateway [-SmartHost] <String> [-SmtpMode] <GatewaySmtpModeEnum> [-Domain <String>]
 [-GAuthId <String>] [-WhatIf] [-Confirm]

DESCRIPTION

Update outbound email gateway settings.

EXAMPLES

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

PS C:\> Set-GAdminSettingsEmailGateway -SmartHost $SomeSmartHostString -SmtpMode SMTP

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

-SmartHost

Either the IP address or hostname of your SMTP server. Google Apps routes outgoing mail to this server.

Type: String
Parameter Sets: (All)
Aliases: 

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

-SmtpMode

The default value is SMTP. Another value, SMTP_TLS, secures a connection with TLS when delivering the message.

Possible values: SMTP, SMTP_TLS

Type: GatewaySmtpModeEnum
Parameter Sets: (All)
Aliases: 
Accepted values: SMTP, SMTP_TLS

Required: True
Position: 0
Default value: SMTP
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

The target domain for this admin settings cmdlet.

OUTPUTS

NOTES

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

RELATED LINKS

[Wiki page for this Cmdlet]

[Getting started with gShell]

Clone this wiki locally