Set-EmailAddressPolicy — usage, script and reference

Quick start script

# Set-EmailAddressPolicy — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-ExchangeOnline -CertificateThumbprint $thumb -AppId $appId -Organization $org

# 2. Capture the current state first — you cannot roll back what you never recorded
$before = Get-EmailAddressPolicy
$before | Format-List

# 3. Make the change (dry run first)
Set-EmailAddressPolicy -Identity <EmailAddressPolicyIdParameter> -WhatIf
Set-EmailAddressPolicy -Identity <EmailAddressPolicyIdParameter>

# 4. Verify and diff
$after = Get-EmailAddressPolicy
Compare-Object ($before | Out-String) ($after | Out-String)

Syntax

Set-EmailAddressPolicy [-Identity] <EmailAddressPolicyIdParameter>
 [-ConditionalCompany <MultiValuedProperty>]
 [-ConditionalCustomAttribute1 <MultiValuedProperty>]
 [-ConditionalCustomAttribute10 <MultiValuedProperty>]
 [-ConditionalCustomAttribute11 <MultiValuedProperty>]
 [-ConditionalCustomAttribute12 <MultiValuedProperty>]
 [-ConditionalCustomAttribute13 <MultiValuedProperty>]
 [-ConditionalCustomAttribute14 <MultiValuedProperty>]
 [-ConditionalCustomAttribute15 <MultiValuedProperty>]
 [-ConditionalCustomAttribute2 <MultiValuedProperty>]
 [-ConditionalCustomAttribute3 <MultiValuedProperty>]
 [-ConditionalCustomAttribute4 <MultiValuedProperty>]
 [-ConditionalCustomAttribute5 <MultiValuedProperty>]
 [-ConditionalCustomAttribute6 <MultiValuedProperty>]
 [-ConditionalCustomAttribute7 <MultiValuedProperty>]
 [-ConditionalCustomAttribute8 <MultiValuedProperty>]
 [-ConditionalCustomAttribute9 <MultiValuedProperty>]
 [-ConditionalDepartment <MultiValuedProperty>]
 [-ConditionalStateOrProvince <MultiValuedProperty>]
 [-Confirm]
 [-DisabledEmailAddressTemplates <ProxyAddressTemplateCollection>]
 [-DomainController <Fqdn>]
 [-EnabledEmailAddressTemplates <ProxyAddressTemplateCollection>]
 [-EnabledPrimarySMTPAddressTemplate <String>]
 [-ForceUpgrade]
 [-IncludedRecipients <WellKnownRecipientType>]
 [-Name <String>]
 [-Priority <EmailAddressPolicyPriority>]
 [-RecipientContainer <OrganizationalUnitIdParameter>]
 [-RecipientFilter <String>]
 [-WhatIf]
 [<CommonParameters>]

Parameters (31)

Parameter	Type	Required	What it controls
-Identity	EmailAddressPolicyIdParameter	yes	The Identity parameter specifies the email address policy that you want to modify. You can use any value that uniquely identifies the policy. For example:
-ConditionalCompany	MultiValuedProperty		This parameter is available only in on-premises Exchange.
-ConditionalCustomAttribute1	MultiValuedProperty		This parameter is available only in on-premises Exchange.
-ConditionalCustomAttribute10	MultiValuedProperty		This parameter is available only in on-premises Exchange.
-ConditionalCustomAttribute11	MultiValuedProperty		This parameter is available only in on-premises Exchange.
-ConditionalCustomAttribute12	MultiValuedProperty		This parameter is available only in on-premises Exchange.
-ConditionalCustomAttribute13	MultiValuedProperty		This parameter is available only in on-premises Exchange.
-ConditionalCustomAttribute14	MultiValuedProperty		This parameter is available only in on-premises Exchange.
-ConditionalCustomAttribute15	MultiValuedProperty		This parameter is available only in on-premises Exchange.
-ConditionalCustomAttribute2	MultiValuedProperty		This parameter is available only in on-premises Exchange.
-ConditionalCustomAttribute3	MultiValuedProperty		This parameter is available only in on-premises Exchange.
-ConditionalCustomAttribute4	MultiValuedProperty		This parameter is available only in on-premises Exchange.
-ConditionalCustomAttribute5	MultiValuedProperty		This parameter is available only in on-premises Exchange.
-ConditionalCustomAttribute6	MultiValuedProperty		This parameter is available only in on-premises Exchange.
-ConditionalCustomAttribute7	MultiValuedProperty		This parameter is available only in on-premises Exchange.
-ConditionalCustomAttribute8	MultiValuedProperty		This parameter is available only in on-premises Exchange.
-ConditionalCustomAttribute9	MultiValuedProperty		This parameter is available only in on-premises Exchange.
-ConditionalDepartment	MultiValuedProperty		This parameter is available only in on-premises Exchange.
-ConditionalStateOrProvince	MultiValuedProperty		This parameter is available only in on-premises Exchange.
-Confirm	SwitchParameter		The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on whether the cmdlet requires confirmation before proceeding.
-DisabledEmailAddressTemplates	ProxyAddressTemplateCollection		This parameter is available only in on-premises Exchange.
-DomainController	Fqdn		This parameter is available only in on-premises Exchange.
-EnabledEmailAddressTemplates	ProxyAddressTemplateCollection		The EnabledEmailAddressTemplates parameter specifies the rules in the email address policy that are used to generate email addresses for recipients.
-EnabledPrimarySMTPAddressTemplate	String		The EnabledPrimarySMTPAddressTemplate parameter specifies the rule in the email address policy that's used to generate the primary SMTP email addresses for recipients. You can use this parameter instead of the...
-ForceUpgrade	SwitchParameter		The ForceUpgrade switch suppresses the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch.
-IncludedRecipients	WellKnownRecipientType		This parameter is available only in on-premises Exchange.
-Name	String		The Name parameter specifies the unique name for the email address policy. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks (").
-Priority	EmailAddressPolicyPriority		The Priority parameter specifies the order that the email address policies are evaluated. By default, every time that you add a new email address policy, the policy is assigned a priority of N+1, where N is the...
-RecipientContainer	OrganizationalUnitIdParameter		This parameter is available only in on-premises Exchange.
-RecipientFilter	String		This parameter is available only in on-premises Exchange.
-WhatIf	SwitchParameter		The WhatIf switch shows what the command does without making any changes. You don't need to specify a value with this switch.