Get-MailPublicFolder (RTM)
Microsoft Exchange Server 2007 will reach end of support on April 11, 2017. To stay supported, you will need to upgrade. For more information, see Resources to help you upgrade your Office 2007 servers and clients.
Applies to: Exchange Server 2007
Use the Get-MailPublicFolder cmdlet to retrieve mail-related information about mail-enabled public folders. If you want information about the basic (not mail related) settings of mail-enabled public folders, use the Get-PublicFolder cmdlet instead.
Syntax
Get-MailPublicFolder [-Identity <MailPublicFolderIdParameter>] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-OrganizationalUnit <OrganizationalUnitIdParameter>] [-ReadFromDomainController <SwitchParameter>] [-ResultSize <Unlimited>] [-Server <ServerIdParameter>] [-SortBy <String>]
Get-MailPublicFolder [-Credential <PSCredential>] [-DomainController <Fqdn>] [-Filter <String>] [-OrganizationalUnit <OrganizationalUnitIdParameter>] [-ReadFromDomainController <SwitchParameter>] [-ResultSize <Unlimited>] [-Server <ServerIdParameter>] [-SortBy <String>]
Get-MailPublicFolder [-Anr <String>] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-OrganizationalUnit <OrganizationalUnitIdParameter>] [-ReadFromDomainController <SwitchParameter>] [-ResultSize <Unlimited>] [-Server <ServerIdParameter>] [-SortBy <String>]
Detailed Description
To run the Get-MailPublicFolder cmdlet, the account you use must be delegated the following:
- Exchange View-Only Administrator role
For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Anr |
Optional |
System.String |
The Anr parameter takes a set of characters as parameter values with which to do an ambiguous name resolution (ANR) search. The Active Directory directory service uses the specified value and searches according to its configuration. Some of the default attributes searched are common name (CN) and alias (mailNickname). |
Credential |
Optional |
System.Management.Automation.PSCredential |
The Credential parameter specifies the account to use to read Active Directory. This is especially useful when specifying the global catalog. The password should be prompted for in a secure way. |
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
To specify the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory, include the DomainController parameter in the command. |
Filter |
Optional |
System.String |
The Filter parameter specifies a set of attributes used to construct a query to retrieve a set of mailboxes. For more information about the filterable properties, see Filterable Properties for the -Filter Parameter in Exchange 2007 RTM. |
Identity |
Optional |
Microsoft.Exchange.Configuration.Tasks.MailPublicFolderIdParameter |
Use the Identity parameter to specify 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. |
OrganizationalUnit |
Optional |
Microsoft.Exchange.Configuration.Tasks.OrganizationalUnitIdParameter |
The OrganizationalUnit parameter specifies an organizational unit (OU) to which to limit the search. The OU or the domain can be specified. The canonical name of the OU should be specified. |
ReadFromDomainController |
Optional |
System.Management.Automation.SwitchParameter |
The ReadFromDomainController parameter specifies that the user information is read from a domain controller in the user's domain. If you set the recipient scope to include all recipients in the forest, and if you do not use this parameter, it is possible that the user information is read from a global catalog with outdated information. If you use this parameter, multiple reads might be necessary to get the information. Note By default, the recipient scope is set to the domain that hosts your Exchange servers. |
ResultSize |
Optional |
Microsoft.Exchange.Data.Unlimited |
The ResultSize parameter specifies the maximum number of results to return. |
SortBy |
Optional |
System.String |
The SortBy parameter specifies the attribute by which to sort the results. Sorting is done one attribute at a time. The sorted result set is given in ascending order. |
Server |
Optional |
Microsoft.Exchange.Configuration.Tasks.ServerIdParameter |
The Server parameter specifies the identity of the server to perform the operation from. If a server is not specified, the command checks if the local server is a Mailbox server that is running Microsoft Exchange 2007 with a public folder store. If it is, the folder will be created locally. If it is not, the command finds the closest (by site cost) Exchange 2007 Mailbox server that has a mounted public folder store. |
Input Types
Return Types
Errors
| Error | Description |
|---|---|
|
Exceptions
| Exceptions | Description |
|---|---|
|
Example
This example returns all mail-enabled public folders. In this example, the output of the Get-MailPublicFolder command is piped to the Format-List command so that all the available information is displayed in the result.
Get-MailPublicFolder | Format-List