< Back
Rename-MgaMailFolder
Post
NAME Rename-MgaMailFolder
SYNOPSIS
Rename folder(s) in Exchange Online using the graph api.
SYNTAX
Rename-MgaMailFolder [-NewName] <String> [-User <String>] [-Token <AzureAccessToken>] [-PassThru] [-WhatIf]
[-Confirm] [<CommonParameters>]
Rename-MgaMailFolder [-Folder] <FolderParameter[]> [-NewName] <String> [-User <String>] [-Token
<AzureAccessToken>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Change the displayname of folder(s) in Exchange Online using the graph api.
PARAMETERS
-Folder <FolderParameter[]>
The folder to be renamed. 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.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-NewName <String>
The name to be set as new name.
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.Folder
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Rename-MgaMailFolder -Folder 'Inbox' -NewName 'MyPersonalInbox'
Rename the "wellknown" folder inbox (regardless of it's current name), to 'MyPersonalInbox'.
RELATED LINKS
SYNOPSIS
Rename folder(s) in Exchange Online using the graph api.
SYNTAX
Rename-MgaMailFolder [-NewName] <String> [-User <String>] [-Token <AzureAccessToken>] [-PassThru] [-WhatIf]
[-Confirm] [<CommonParameters>]
Rename-MgaMailFolder [-Folder] <FolderParameter[]> [-NewName] <String> [-User <String>] [-Token
<AzureAccessToken>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Change the displayname of folder(s) in Exchange Online using the graph api.
PARAMETERS
-Folder <FolderParameter[]>
The folder to be renamed. 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.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-NewName <String>
The name to be set as new name.
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.Folder
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Rename-MgaMailFolder -Folder 'Inbox' -NewName 'MyPersonalInbox'
Rename the "wellknown" folder inbox (regardless of it's current name), to 'MyPersonalInbox'.
RELATED LINKS