Remove-MgBetaUserMailFolderPermanent

Module:: Microsoft.Graph.Beta.Mail

Permanently delete a mail folder and remove its items from the user's mailbox. For more information about item retention, see Configure Deleted Item retention and Recoverable Items quotas.

Note

To view the v1.0 release of this cmdlet, view Remove-MgUserMailFolderPermanent

Syntax

Remove-MgBetaUserMailFolderPermanent
      -MailFolderId <String>
      -UserId <String>
      [-ResponseHeadersVariable <String>]
      [-Headers <IDictionary>]
      [-PassThru]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-MgBetaUserMailFolderPermanent
      -InputObject <IMailIdentity>
      [-ResponseHeadersVariable <String>]
      [-Headers <IDictionary>]
      [-PassThru]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Permanently delete a mail folder and remove its items from the user's mailbox. For more information about item retention, see Configure Deleted Item retention and Recoverable Items quotas.

Permissions

Permission type	Permissions (from least to most privileged)
Delegated (work or school account)	Mail.ReadWrite,
Delegated (personal Microsoft account)	Mail.ReadWrite,
Application	Mail.ReadWrite,

Examples

Example 1: Code snippet

Import-Module Microsoft.Graph.Beta.Mail

Remove-MgBetaUserMailFolderPermanent -UserId $userId -MailFolderId $mailFolderId

This example shows how to use the Remove-MgBetaUserMailFolderPermanent Cmdlet.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Headers

Optional headers that will be added to the request.

Type:	IDictionary
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:	IMailIdentity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-MailFolderId

The unique identifier of mailFolder

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-PassThru

Returns true when the command succeeds

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

-ProgressAction

Type:	ActionPreference
Aliases:	proga
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResponseHeadersVariable

Optional Response Headers Variable.

Type:	String
Aliases:	RHV
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-UserId

The unique identifier of user

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

Microsoft.Graph.Beta.PowerShell.Models.IMailIdentity

System.Collections.IDictionary

Outputs

System.Boolean

Notes

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

INPUTOBJECT <IMailIdentity>: Identity Parameter

[AttachmentId <String>]: The unique identifier of attachment
[ExtensionId <String>]: The unique identifier of extension
[InferenceClassificationOverrideId <String>]: The unique identifier of inferenceClassificationOverride
[MailFolderId <String>]: The unique identifier of mailFolder
[MailFolderId1 <String>]: The unique identifier of mailFolder
[MailFolderOperationId <String>]: The unique identifier of mailFolderOperation
[MentionId <String>]: The unique identifier of mention
[MessageId <String>]: The unique identifier of message
[MessageRuleId <String>]: The unique identifier of messageRule
[UserConfigurationId <String>]: The unique identifier of userConfiguration
[UserId <String>]: The unique identifier of user

Share via