Skip to content

New GGmailImapSettingsObj

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

New-GGmailImapSettingsObj

SYNOPSIS

Creates a new Gmail API ImapSettings object.

SYNTAX

New-GGmailImapSettingsObj [[-AutoExpunge] <Boolean>] [[-Enabled] <Boolean>] [[-ExpungeBehavior] <String>]
 [[-MaxFolderSize] <Int32>] [-WhatIf] [-Confirm]

DESCRIPTION

This provides a Cmdlet-Based approach to creating a ImapSettings 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.ImapSettings

EXAMPLES

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

PS C:\>New-GGmailImapSettingsObj

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

-AutoExpunge

If this value is true, Gmail will immediately expunge a message when it is marked as deleted in IMAP. Otherwise, Gmail will wait for an update from the client before expunging messages marked as deleted.

Type: Boolean
Parameter Sets: (All)
Aliases: 

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

-Enabled

Whether IMAP is enabled for the account.

Type: Boolean
Parameter Sets: (All)
Aliases: 

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

-ExpungeBehavior

The action that will be executed on a message when it is marked as deleted and expunged from the last visible IMAP folder.

Type: String
Parameter Sets: (All)
Aliases: 

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

-MaxFolderSize

An optional limit on the number of messages that an IMAP folder may contain. Legal values are 0, 1000, 2000, 5000 or 10000. A value of zero is interpreted to mean that there is no limit.

Type: Int32
Parameter Sets: (All)
Aliases: 

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

INPUTS

System.Boolean

If this value is true, Gmail will immediately expunge a message when it is marked as deleted in IMAP. Otherwise, Gmail will wait for an update from the client before expunging messages marked as deleted.

System.Boolean

Whether IMAP is enabled for the account.

System.String

The action that will be executed on a message when it is marked as deleted and expunged from the last visible IMAP folder.

System.Int32

An optional limit on the number of messages that an IMAP folder may contain. Legal values are 0, 1000, 2000, 5000 or 10000. A value of zero is interpreted to mean that there is no limit.

OUTPUTS

Google.Apis.Gmail.v1.Data.ImapSettings

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