Update-EmailAddressPolicy
Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3
Use the Update-EmailAddressPolicy cmdlet to apply an e-mail address policy to all recipients.
Syntax
update-EmailAddressPolicy -Identity <EmailAddressPolicyIdParameter> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-FixMissingAlias <SwitchParameter>] [-UseRusServer <String>] [-WhatIf [<SwitchParameter>]]
Detailed Description
The Update-EmailAddressPolicy cmdlet allows administrators to apply an e-mail address policy to all recipients. This command queries for all recipients that match the specified e-mail address policy and saves the objects to the Active Directory directory service. Use the Update-EmailAddressPolicy cmdlet after you use the Set-EmailAddressPolicy cmdlet to apply all changes.
To run the Update-EmailAddressPolicy cmdlet, the account you use must be delegated the following:
- Exchange Server Administrator role and local Administrators group for the target server
For more information about permissions, delegating roles, and the rights that are required to administer Microsoft Exchange Server 2007, see Permission Considerations.
For more information about the Set-EmailAddressPolicy cmdlet, see Set-EmailAddressPolicy.
Parameters
Parameter | Required | Type | Description | ||
---|---|---|---|---|---|
Identity |
Required |
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 by using the format Path\EmailAddressPolicy. You can omit the parameter label Identity so that only the e-mail address policy name or GUID is supplied. |
||
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
The Confirm parameter causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You do not have to specify a value with the Confirm parameter. |
||
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
To specify the fully qualified domain name (FQDN) of the domain controller that retrieves data from Active Directory, include the DomainController parameter in the command. |
||
FixMissingAlias |
Optional |
System.Management.Automation.SwitchParameter |
Use the FixMissingAlias parameter to repair recipients that do not have an alias. The alias is generated based upon the name of the recipient. You will need to use the FixMissingAlias parameter if you receive an error message when you attempt to update an e-mail address policy, global address list, or address list. |
||
UseRusServer |
Optional |
System.String |
The UseRusServer parameter instructs the command to use the specified Mailbox server on which the Address List service is running to obtain and then set mailbox and Active Directory user attributes. The Address List service is a component in the Exchange System Attendant service. The Address List service creates and maintains Exchange-specific attribute values in Active Directory. You can use the Address List service to update recipient objects in a domain by using specific information, such as address list membership and e-mail addresses. |
||
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
The WhatIf parameter instructs the command to simulate the actions that it would take on the object. By using the WhatIf parameter, you can view what changes would occur without having to apply any of those changes. You do not have to specify a value with the WhatIf parameter. |
Input Types
Return Types
Errors
Error | Description |
---|---|
Exceptions
Exceptions | Description |
---|---|
Example
The following code is an example of the Update-EmailAddressPolicy command. This example applies the e-mail address policy named EMAIL_ADDRESS_POLICY01 to all affected recipients.
Update-EmailAddressPolicy -Identity EMAIL_ADDRESS_POLICY01