Export (0) Print
Expand All
Related Help Topics
Loading
No resources found.
Related Blog Articles
Loading
No resources found.
Expand Minimize

Get-PublicFolder

 

Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2

Topic Last Modified: 2012-11-15

Use the Get-PublicFolder cmdlet to retrieve the attributes of a public folder or a set of public folders.


Get-PublicFolder [-Identity <PublicFolderIdParameter>] [-DomainController <Fqdn>] [-Organization <OrganizationIdParameter>] [-Server <ServerIdParameter>]


Get-PublicFolder [-Identity <PublicFolderIdParameter>] -Recurse <SwitchParameter> [-DomainController <Fqdn>] [-Organization <OrganizationIdParameter>] [-ResultSize <Unlimited>] [-Server <ServerIdParameter>]


Get-PublicFolder [-Identity <PublicFolderIdParameter>] -GetChildren <SwitchParameter> [-DomainController <Fqdn>] [-Organization <OrganizationIdParameter>] [-ResultSize <Unlimited>] [-Server <ServerIdParameter>]

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 Mailbox Permissions topic.

 

Parameter Required Type Description

GetChildren

Required

System.Management.Automation.SwitchParameter

The GetChildren parameter specifies whether to retrieve only the children of the folder specified by the Identity parameter. You can't use the GetChildren parameter with the Recurse parameter.

Recurse

Required

System.Management.Automation.SwitchParameter

The Recurse parameter specifies that the command must return the specified public folder and all its children. You don't need to specify a value with this parameter.

You can't use the GetChildren parameter with the Recurse parameter.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that retrieves data from Active Directory.

Identity

Optional

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 Identity so that only the public folder name or GUID is supplied.

Organization

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter

The Organization parameter is reserved for internal Microsoft use.

ResultSize

Optional

Microsoft.Exchange.Data.Unlimited

The ResultSize parameter specifies the maximum number of results to return. The default maximum is 10,000. For no limit on the returned results, set this parameter to Unlimited. This parameter can only be passed in combination with the Recurse or GetChildren parameters.

Server

Optional

Microsoft.Exchange.Configuration.Tasks.ServerIdParameter

The Server parameter specifies the server on which to perform the selected operations.

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.

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.

This example uses the Get-PublicFolder command without parameters to return the root public folder object (IPM_SUBTREE).

Get-PublicFolder 

This example returns the names of all the system folders (which aren't shown by default), starting at the system folder root (\NON_IPM_SUBTREE).

Get-PublicFolder -Identity \NON_IPM_SUBTREE -Recurse | Format-List Name  

This example returns the public folder with the specified long-term entry identifier.

Get-PublicFolder -Identity <long-term entry identifier of a public folder>

This example returns the Pending Litigation public folder from \Legal\Documents\.

Get-PublicFolder -Identity "\Legal\Documents\Pending Litigation"

This example returns the Pending Litigation public folder from \Legal\Documents\ under the Pending Litigation public folder. Because the result size isn't specified, the command returns up to the maximum number of public folders, which is 10,000.

Get-PublicFolder -Identity "\Legal\Documents\Pending Litigation" -Recurse

This example returns the Pending Litigation public folder from \Legal\Documents\ and all the public folders under it, without a limit on the number returned.

Get-PublicFolder -Identity "\Legal\Documents\Pending Litigation" -Recurse -ResultSize Unlimited
 © 2010 Microsoft Corporation. All rights reserved.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft