New-AddressList

Reference

Module:: ExchangePowerShell

Applies to:: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the New-AddressList cmdlet to create address lists and apply them to recipients.

In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see Add a role to a role group.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Syntax

New-AddressList
   [-Name] <String>
   -IncludedRecipients <WellKnownRecipientType>
   [-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]
   [-Container <AddressListIdParameter>]
   [-DisplayName <String>]
   [-DomainController <Fqdn>]
   [-RecipientContainer <OrganizationalUnitIdParameter>]
   [-WhatIf]
   [<CommonParameters>]

New-AddressList
   [-Name] <String>
   -RecipientFilter <String>
   [-Confirm]
   [-Container <AddressListIdParameter>]
   [-DisplayName <String>]
   [-DomainController <Fqdn>]
   [-RecipientContainer <OrganizationalUnitIdParameter>]
   [-WhatIf]
   [<CommonParameters>]

Description

The Conditional parameters that are used with the IncludedRecipients parameter are subject to the following limitations:

The EQV operator is used for every property value, as in "Department equals Sales". Wildcards and partial matches aren't supported.
The OR operator is always used for multiple values of the same property, as in "Department equals Sales OR Marketing".
The AND operator is always used for multiple properties, as in "Department equals Sales AND Company equals Contoso".

To create flexible filters that use any available recipient property and that aren't subject to these limitations, you can use the RecipientFilter parameter to create an OPATH filter.

You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet.

Examples

Example 1

New-AddressList -Name MyAddressList -RecipientFilter "((RecipientTypeDetails -eq 'UserMailbox') -and ((StateOrProvince -eq 'Washington') -or (StateOrProvince -eq 'Oregon')))"

This example creates the address list MyAddressList. The address list includes recipients that are mailbox users and have the StateOrProvince property set to Washington or Oregon.

Example 2

New-AddressList -Name MyAddressList2 -ConditionalStateOrProvince Washington -IncludedRecipients MailboxUsers

This example creates the address list MyAddressList2 that includes mailboxes that have the ConditionalStateOrProvince parameter set to Washington.

Example 3

New-AddressList -Name "AL_AgencyB" -RecipientFilter "((RecipientTypeDetails -eq 'UserMailbox') -and (CustomAttribute15 -like 'AgencyB*'))"

This example creates the address list AL_AgencyB that includes mailboxes that have the value of the CustomAttribute15 parameter contains AgencyB.

Parameters

-ConditionalCompany

The ConditionalCompany parameter specifies a precanned filter that's based on the value of the recipient's Company property. You can specify multiple values separated by commas.