Skip to content

Get GEmailSettingsImap

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

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/

Get-GEmailSettingsImap

SYNOPSIS

Retrieve Google Mail IMAP settings.

SYNTAX

Get-GEmailSettingsImap [-UserName] <String> [-Domain <String>] [-GAuthId <String>] [-WhatIf] [-Confirm]

DESCRIPTION

Retrieve Google Mail IMAP settings.

EXAMPLES

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

PS C:\> Get-GEmailSettingsImap -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

-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

The target domain for this email settings cmdlet.

OUTPUTS

NOTES

Part of the gShell Project, relating to the Google Email 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