Applies to: Exchange Server 2013
Topic Last Modified: 2012-09-18
Use the Remove-PublicFolder cmdlet to remove an existing public folder.
 Caution: |
|---|
| The Remove-PublicFolder cmdlet removes the public folder data from all servers in your organization. |
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Remove-PublicFolder -Identity
<PublicFolderIdParameter> [-Confirm
[<SwitchParameter>]] [-DomainController <Fqdn>]
[-Recurse <SwitchParameter>] [-WhatIf
[<SwitchParameter>]]
|
Examples
EXAMPLE 1
This example deletes the public folder My Public Folder from the \Test\Directory tree.
 Copy Code |
|
|---|---|
Remove-PublicFolder -Identity "\Test\Directory\My Public Folder" |
|
EXAMPLE 2
This example deletes the public folder Directory Folder and all its child public folders by using the Recurse switch.
| Copy Code |
|
|---|---|
Remove-PublicFolder -Identity "\Test\Directory Folder" -Recurse |
|
Detailed Description
You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Public folders" entry in the Sharing and Collaboration Permissions topic.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
Microsoft.Exchange.Configuration.Tasks.PublicFolderIdParameter |
The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path using the format \TopLevelPublicFolder\PublicFolder. You can omit the parameter label so that only the public folder name or GUID is supplied. |
|
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
The Confirm switch can be used to suppress the
confirmation prompt that appears by default when this cmdlet is
run. To suppress the confirmation prompt, use the syntax
|
|
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory. |
|
Recurse |
Optional |
System.Management.Automation.SwitchParameter |
The Recurse switch specifies whether all subfolders of the specified folder should be removed. If the Recurse switch isn't specified and the public folder has subfolders, the command doesn't run and an error message is returned. |
|
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch. |
Input Types
To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.
Return Types
To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.