New-AddressList

  • Article

 

Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3

Use the New-AddressList cmdlet to create a new address list and apply it to recipients.

Syntax

New-AddressList -Name <String> [-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 [<SwitchParameter>]] [-Container <AddressListIdParameter>] [-DisplayName <String>] [-DomainController <Fqdn>] [-IncludedRecipients <Nullable>] [-TemplateInstance <PSObject>] [-UseRusServer <String>] [-WhatIf [<SwitchParameter>]]

New-AddressList -Name <String> [-Confirm [<SwitchParameter>]] [-Container <AddressListIdParameter>] [-DisplayName <String>] [-DomainController <Fqdn>] [-RecipientFilter <String>] [-TemplateInstance <PSObject>] [-UseRusServer <String>] [-WhatIf [<SwitchParameter>]]

Detailed Description

To run the New-AddressList cmdlet, the account you use must be delegated the following:

  • Exchange Organization Administrator role

For more information about permissions, delegating roles, and the rights that are required to administer Microsoft Exchange Server 2007, see Permission Considerations.

Parameters

Parameter Required Type Description

Name

Required

System.String

The Name parameter specifies the desired name for the new address list. The name cannot exceed 64 characters, and it cannot include a carriage return or a backslash (\).

ConditionalCompany

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ConditionalCompany parameter is a filter to specify a company. All recipients with a company attribute that matches the value that you input for this parameter will be included in the address list. You can use multiple values as a comma-delimited list. You cannot use this parameter if you use the RecipientFilter parameter. You must use either the RecipientFilter parameter or one of these filter parameters:

  • ConditionalCompany

  • ConditionalDepartment

  • ConditionalStateOrProvince

  • IncludedRecipients

ConditionalCustomAttribute1

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ConditionalCustomAttribute1 parameter specifies custom attributes. You can use these attributes to store additional information.

ConditionalCustomAttribute10

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ConditionalCustomAttribute10 parameter specifies custom attributes. You can use these attributes to store additional information.

ConditionalCustomAttribute11

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ConditionalCustomAttribute11 parameter specifies custom attributes. You can use these attributes to store additional information.

ConditionalCustomAttribute12

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ConditionalCustomAttribute12 parameter specifies custom attributes. You can use these attributes to store additional information.

ConditionalCustomAttribute13

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ConditionalCustomAttribute13 parameter specifies custom attributes. You can use these attributes to store additional information.

ConditionalCustomAttribute14

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ConditionalCustomAttribute14 parameter specifies custom attributes. You can use these attributes to store additional information.

ConditionalCustomAttribute15

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ConditionalCustomAttribute15 parameter specifies custom attributes. You can use these attributes to store additional information.

ConditionalCustomAttribute2

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ConditionalCustomAttribute2 parameter specifies custom attributes. You can use these attributes to store additional information.

ConditionalCustomAttribute3

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ConditionalCustomAttribute3 parameter specifies custom attributes. You can use these attributes to store additional information.

ConditionalCustomAttribute4

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ConditionalCustomAttribute4 parameter specifies custom attributes. You can use these attributes to store additional information.

ConditionalCustomAttribute5

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ConditionalCustomAttribute5 parameter specifies custom attributes. You can use these attributes to store additional information.

ConditionalCustomAttribute6

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ConditionalCustomAttribute6 parameter specifies custom attributes. You can use these attributes to store additional information.

ConditionalCustomAttribute7

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ConditionalCustomAttribute7 parameter specifies custom attributes. You can use these attributes to store additional information.

ConditionalCustomAttribute8

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ConditionalCustomAttribute8 parameter specifies custom attributes. You can use these attributes to store additional information.

ConditionalCustomAttribute9

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ConditionalCustomAttribute9 parameter specifies custom attributes. You can use these attributes to store additional information.

ConditionalDepartment

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ConditionalDepartment parameter is a filter to specify a department. All recipients with a department attribute that matches the value that you input for this parameter will be included in the address list. You can use multiple values as a comma-delimited list. You cannot use this parameter if you use the RecipientFilter parameter. You must use either the RecipientFilter parameter or one of these filter parameters:

  • ConditionalCompany

  • ConditionalDepartment

  • ConditionalStateOrProvince

  • IncludedRecipients

ConditionalStateOrProvince

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ConditionalStateOrProvince parameter is a filter to specify a state or province. All recipients with a ConditionalStateOrProvince attribute that matches the value that you input for this parameter will be included in the address list. You can use multiple values as a comma-delimited list. You cannot use this parameter if you use the RecipientFilter parameter. You must use either the RecipientFilter parameter or one of these filter parameters:

  • ConditionalCompany

  • ConditionalDepartment

  • ConditionalStateOrProvince

  • IncludedRecipients

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 don't have to specify a value with the Confirm parameter.

Container

Optional

Microsoft.Exchange.Configuration.Tasks.AddressListIdParameter

The Container parameter specifies the identity of the parent address list where this new address list will be created. If no parent address list is specified, the address list will be created under the root "All Address Lists."

DisplayName

Optional

System.String

The DisplayName parameter specifies the desired display name of the address list. If no display name is provided, the name of the address list will also be the display name.

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.

IncludedRecipients

Optional

System.Nullable

The IncludedRecipients parameter is a filter to specify the type of recipient to include in the address list. You can use one or more of the following types:

  • None

  • UserMail

  • Resources

  • MailGroups

  • MailContacts

  • AllRecipients

You cannot use this parameter if you use the RecipientFilter parameter. You must use either the RecipientFilter parameter or one of these filter parameters:

  • ConditionalCompany

  • ConditionalDepartment

  • ConditionalStateOrProvince

  • IncludedRecipients

RecipientFilter

Optional

System.String

The RecipientFilter parameter specifies a filter for recipients to include in the address list. You cannot use this parameter if you use any of the following filter parameters:

  • ConditionalCompany

  • ConditionalDepartment

  • ConditionalStateOrProvince

  • IncludedRecipients

You must use either this parameter, or one of the preceding filter parameters.

For more information about the filterable properties, see Filterable Properties for the -RecipientFilter parameter.

TemplateInstance

Optional

System.Management.Automation.PSObject

When an existing object is supplied to the TemplateInstance parameter, the command will use that object's configuration to create an exact duplicate of the object on a local or target server.

UseRusServer

Optional

System.String
noteNote:
This parameter is available only in Exchange Server 2007 SP2.

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 don't have to specify a value with the WhatIf parameter.

Input Types

Return Types

Errors

Error Description

 

 

Exceptions

Exceptions Description

 

 

Example

The first example shows how to create a new address list called MyAddressList. The address list includes recipients that are mailbox users and have StateOrProvince set to Washington or Oregon.

The second example shows how to create a new address list called MyAddressList2 that includes mailboxes that have the ConditionalStateOrProvince parameter set to Washington.

New-AddressList -Name MyAddressList -RecipientFilter {((RecipientType -eq 'UserMailbox') -and ((StateOrProvince -eq 'Washington') -or (StateOrProvince -eq 'Oregon')))}
New-AddressList -Name MyAddressList2 -ConditionalStateOrProvince Washington -IncludedRecipients MailboxUsers