Get-EmailAddressPolicy
Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3
Use the Get-EmailAddressPolicy cmdlet to return all of the attributes on a policy or set of policies.
Syntax
Get-EmailAddressPolicy [-Identity <EmailAddressPolicyIdParameter>] [-DomainController <Fqdn>] [-IncludeMailboxSettingOnlyPolicy <SwitchParameter>]
Detailed Description
Use the Get-EmailAddressPolicy cmdlet to return e-mail address policy objects that match the identity specified or return all existing E-mail Address Policy objects.
To run the Get-EmailAddressPolicy 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 |
|---|---|---|---|
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
To specify the fully qualified domain name (FQDN) of the domain controller that retrieves data from the Active Directory directory service, include the DomainController parameter in the command. The DomainController parameter is not supported on computers that run the Edge Transport server role. The Edge Transport server role writes only to the local Active Directory Application Mode (ADAM) instance. |
Identity |
Optional |
Microsoft.Exchange.Configuration.Tasks.EmailAddressPolicyIdParameter |
Use the Identity parameter to specify the GUID, distinguished name or e-mail address policy name that represents a specific e-mail address policy. You can also include the path using the format Path\EmailAddressPolicy. You can omit the parameter label Identity so that only the e-mail address policy name or GUID |
IncludeMailboxSettingOnlyPolicy |
Optional |
System.Management.Automation.SwitchParameter |
The IncludeMailboxSettingOnlyPolicy parameter retrieves Microsoft Exchange Server 2003 e-mail address policies that contain only mailbox management configuration. Exchange Server 2007 supports both policies that contain only e-mail address policy settings, and policies that contain e-mail address policy settings and mailbox management configuration. Exchange 2007 does not support policies that contain only mailbox management configuration, but Exchange 2003 policies that contain only mailbox management configuration are, by default, preserved and not upgraded. The IncludeMailboxSettingOnlyPolicy parameter is needed to retrieve these policies. The attributes of e-mail address policies that contain only mailbox management configuration cannot be modified in Exchange 2007. These policies can only be removed. |
Input Types
Return Types
Errors
| Error | Description |
|---|---|
|
Exceptions
| Exceptions | Description |
|---|---|
|
|
Example
The following code is an example of the Get-EmailAddressPolicy command that is used to retrieve the attributes for "Email Address Policy 1".
Get-EmailAddressPolicy -Identity "Email Address Policy 1"