< Back
Remove-MgaMailFolder
Post
NAME Remove-MgaMailFolder
SYNOPSIS
Remove folder(s) in Exchange Online using the graph api.
SYNTAX
Remove-MgaMailFolder [-Folder] <FolderParameter[]> [-Force] [-User <String>] [-Token <AzureAccessToken>]
[-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Remove folder(s) in Exchange Online using the graph api.
ATTENTION! The command does what it is name to!
The folder will not be moved to 'deletedObjects', it will be deleted.
PARAMETERS
-Folder <FolderParameter[]>
The folder to be removed.
This can be a name of the folder, it can be the Id of the folder or it can be a folder object passed in.
Tab completion is available on this parameter for a list of well known folders.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-Force [<SwitchParameter>]
If specified the user will not prompted on confirmation.
Required? false
Position? named
Default value False
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.Folder
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Remove-MgaMailFolder -Name 'MyFolder'
Removes folder named "MyFolder".
The folder has to be on the root level of the mailbox to be specified by individual name.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Remove-MgaMailFolder -Name $folder
Removes folder represented by the variable $folder.
You will be prompted for confirmation.
The variable $folder can be represent:
PS C:\\> $folder = Get-MgaMailFolder -Folder "MyFolder"
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>$folder | Remove-MgaMailFolder -Force
Removes folder represented by the variable $folder.
ATTENTION, There will be NO prompt for confirmation!
The variable $folder can be represent:
PS C:\\> $folder = Get-MgaMailFolder -Folder "MyFolder"
RELATED LINKS
SYNOPSIS
Remove folder(s) in Exchange Online using the graph api.
SYNTAX
Remove-MgaMailFolder [-Folder] <FolderParameter[]> [-Force] [-User <String>] [-Token <AzureAccessToken>]
[-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Remove folder(s) in Exchange Online using the graph api.
ATTENTION! The command does what it is name to!
The folder will not be moved to 'deletedObjects', it will be deleted.
PARAMETERS
-Folder <FolderParameter[]>
The folder to be removed.
This can be a name of the folder, it can be the Id of the folder or it can be a folder object passed in.
Tab completion is available on this parameter for a list of well known folders.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-Force [<SwitchParameter>]
If specified the user will not prompted on confirmation.
Required? false
Position? named
Default value False
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.Folder
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Remove-MgaMailFolder -Name 'MyFolder'
Removes folder named "MyFolder".
The folder has to be on the root level of the mailbox to be specified by individual name.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Remove-MgaMailFolder -Name $folder
Removes folder represented by the variable $folder.
You will be prompted for confirmation.
The variable $folder can be represent:
PS C:\\> $folder = Get-MgaMailFolder -Folder "MyFolder"
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>$folder | Remove-MgaMailFolder -Force
Removes folder represented by the variable $folder.
ATTENTION, There will be NO prompt for confirmation!
The variable $folder can be represent:
PS C:\\> $folder = Get-MgaMailFolder -Folder "MyFolder"
RELATED LINKS