Skip to content
Spencer Varney edited this page Dec 27, 2016 · 3 revisions

Set-GGmailMessage

SYNOPSIS

Modifies the labels on the specified message.

SYNTAX

modify (Default)

Set-GGmailMessage [-UserId] <String> [-Id] <String> [[-AddLabelIds] <String[]>] [[-RemoveLabelIds] <String[]>]
 [-TargetUserEmail <String>] [-StandardQueryParams <StandardQueryParameters>] [-GAuthId <String>] [-WhatIf]
 [-Confirm]

trash

Set-GGmailMessage [-UserId] <String> [-Id] <String> [-Trash] [-TargetUserEmail <String>]
 [-StandardQueryParams <StandardQueryParameters>] [-GAuthId <String>] [-WhatIf] [-Confirm]

untrash

Set-GGmailMessage [-UserId] <String> [-Id] <String> [-Untrash] [-TargetUserEmail <String>]
 [-StandardQueryParams <StandardQueryParameters>] [-GAuthId <String>] [-WhatIf] [-Confirm]

DESCRIPTION

Modifies the labels on the specified message.

EXAMPLES

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

PS C:\> Set-GGmailMessage -UserId $SomeUserIdString -Id $SomeIdString -AddLabelIds $SomeAddLabelIds{ get; set; }

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.

---------- EXAMPLE 2 ----------

PS C:\> Set-GGmailMessage -UserId $SomeUserIdString -Id $SomeIdString -Trash

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.

---------- EXAMPLE 3 ----------

PS C:\> Set-GGmailMessage -UserId $SomeUserIdString -Id $SomeIdString -Untrash

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

-UserId

The user's email address. The special value me can be used to indicate the authenticated user.

Type: String
Parameter Sets: (All)
Aliases: 

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

-Id

The ID of the message to modify.

Type: String
Parameter Sets: (All)
Aliases: 

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

-AddLabelIds

A list of IDs of labels to add to this message.

Type: String[]
Parameter Sets: modify
Aliases: 

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

-RemoveLabelIds

A list IDs of labels to remove from this message.

Type: String[]
Parameter Sets: modify
Aliases: 

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

-Trash

Moves the specified message to the trash.

Type: SwitchParameter
Parameter Sets: trash
Aliases: 

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

-Untrash

Removes the specified message from the trash.

Type: SwitchParameter
Parameter Sets: untrash
Aliases: 

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

-TargetUserEmail

The email account to be targeted by the service account.

Type: String
Parameter Sets: (All)
Aliases: ServiceAccountTarget

Required: False
Position: Named
Default value: 
Accept pipeline input: False
Accept wildcard characters: False

-StandardQueryParams

A Standard Query Parameters Object.

Type: StandardQueryParameters
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: 
Accept pipeline input: False
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 user's email address. The special value me can be used to indicate the authenticated user.

System.String

The ID of the message to modify.

System.String[]

A list of IDs of labels to add to this message.

System.String[]

A list IDs of labels to remove from this message.

System.Management.Automation.SwitchParameter

Moves the specified message to the trash.

System.Management.Automation.SwitchParameter

Removes the specified message from the trash.

OUTPUTS

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