< Back

Move-MgaMailMessage

Sat Jan 18, 2020 4:41 pm

NAME Move-MgaMailMessage



SYNOPSIS

Move message(s) to a folder





SYNTAX

Move-MgaMailMessage [-Message] <MessageParameter[]> [-DestinationFolder] <FolderParameter> [-User <String>]

[-Token <AzureAccessToken>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]





DESCRIPTION

Move message(s) to a folder in Exchange Online using the graph api.





PARAMETERS

-Message <MessageParameter[]>

Carrier object for Pipeline input. Accepts messages and strings.



Required? true

Position? 1

Default value

Accept pipeline input? true (ByValue, ByPropertyName)

Accept wildcard characters? false



-DestinationFolder <FolderParameter>

The destination folder where to move the message to



Required? true

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-User <String>

The user-account to access. Defaults to the main user connected as.

Can be any primary email name of any user the connected token has access to.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Token <AzureAccessToken>

The token representing an established connection to the Microsoft Graph Api.

Can be created by using New-MgaAccessToken.

Can be omitted if a connection has been registered using the -Register parameter on New-MgaAccessToken.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-PassThru [<SwitchParameter>]

Outputs the token to the console



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

If this switch is enabled, no actions are performed but informational messages will be displayed that explain

what would happen if the command were to run.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

If this switch is enabled, you will be prompted for confirmation before executing any operations that change

state.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS

MSGraph.Exchange.Mail.Message





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



PS C:\\>$mails | Move-MgaMailMessage -DestinationFolder $destinationFolder



Moves messages in variable $mails to the folder in the variable $destinationFolder.

also possible:

PS C:\\> Move-MgaMailMessage -Message $mails -DestinationFolder $destinationFolder



The variable $mails can be represent:

PS C:\\> $mails = Get-MgaMailMessage -Folder Inbox -ResultSize 1



The variable $destinationFolder can be represent:

PS C:\\> $destinationFolder = Get-MgaMailFolder -Name "Archive"









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



PS C:\\>Move-MgaMailMessage -Id $mails.id -DestinationFolder $destinationFolder



Moves messages into the folder $destinationFolder.



The variable $mails can be represent:

PS C:\\> $mails = Get-MgaMailMessage -Folder Inbox -ResultSize 1



The variable $destinationFolder can be represent:

PS C:\\> $destinationFolder = Get-MgaMailFolder -Name "Archive"









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



PS C:\\>Get-MgaMailMessage -Folder Inbox | Move-MgaMailMessage -DestinationFolder $destinationFolder



Moves ALL messages from your inbox into the folder $destinationFolder.

The variable $destinationFolder can be represent:

PS C:\\> $destinationFolder = Get-MgaMailFolder -Name "Archive"











RELATED LINKS