Applies to: Exchange Server 2007
Topic Last Modified: 2007-06-05
Use the New-AddressList cmdlet to create a new address list and apply it to recipients.
Syntax
New-AddressList -Name <String> [-ConditionalCompany
<MultiValuedProperty>] [-ConditionalCustomAttribute1
<String>] [-ConditionalCustomAttribute10 <String>]
[-ConditionalCustomAttribute11 <String>]
[-ConditionalCustomAttribute12 <String>]
[-ConditionalCustomAttribute13 <String>]
[-ConditionalCustomAttribute14 <String>]
[-ConditionalCustomAttribute15 <String>]
[-ConditionalCustomAttribute2 <String>]
[-ConditionalCustomAttribute3 <String>]
[-ConditionalCustomAttribute4 <String>]
[-ConditionalCustomAttribute5 <String>]
[-ConditionalCustomAttribute6 <String>]
[-ConditionalCustomAttribute7 <String>]
[-ConditionalCustomAttribute8 <String>]
[-ConditionalCustomAttribute9 <String>]
[-ConditionalDepartment <MultiValuedProperty>]
[-ConditionalStateOrProvince <MultiValuedProperty>]
[-Container <AddressListIdParameter>] [-DisplayName
<String>] [-DomainController <Fqdn>]
[-IncludedRecipients <Nullable>] [-TemplateInstance
<PSObject>]
|
New-AddressList -Name <String> [-Container
<AddressListIdParameter>] [-DisplayName <String>]
[-DomainController <Fqdn>] [-RecipientFilter <String>]
[-TemplateInstance <PSObject>]
|
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:
|
ConditionalCustomAttribute1 |
Optional |
System.String |
The ConditionalCustomAttribute1 parameter specifies custom attributes. You can use these attributes to store additional information. |
ConditionalCustomAttribute10 |
Optional |
System.String |
The ConditionalCustomAttribute10 parameter specifies custom attributes. You can use these attributes to store additional information. |
ConditionalCustomAttribute11 |
Optional |
System.String |
The ConditionalCustomAttribute11 parameter specifies custom attributes. You can use these attributes to store additional information. |
ConditionalCustomAttribute12 |
Optional |
System.String |
The ConditionalCustomAttribute12 parameter specifies custom attributes. You can use these attributes to store additional information. |
ConditionalCustomAttribute13 |
Optional |
System.String |
The ConditionalCustomAttribute13 parameter specifies custom attributes. You can use these attributes to store additional information. |
ConditionalCustomAttribute14 |
Optional |
System.String |
The ConditionalCustomAttribute14 parameter specifies custom attributes. You can use these attributes to store additional information. |
ConditionalCustomAttribute15 |
Optional |
System.String |
The ConditionalCustomAttribute15 parameter specifies custom attributes. You can use these attributes to store additional information. |
ConditionalCustomAttribute2 |
Optional |
System.String |
The ConditionalCustomAttribute2 parameter specifies custom attributes. You can use these attributes to store additional information. |
ConditionalCustomAttribute3 |
Optional |
System.String |
The ConditionalCustomAttribute3 parameter specifies custom attributes. You can use these attributes to store additional information. |
ConditionalCustomAttribute4 |
Optional |
System.String |
The ConditionalCustomAttribute4 parameter specifies custom attributes. You can use these attributes to store additional information. |
ConditionalCustomAttribute5 |
Optional |
System.String |
The ConditionalCustomAttribute5 parameter specifies custom attributes. You can use these attributes to store additional information. |
ConditionalCustomAttribute6 |
Optional |
System.String |
The ConditionalCustomAttribute6 parameter specifies custom attributes. You can use these attributes to store additional information. |
ConditionalCustomAttribute7 |
Optional |
System.String |
The ConditionalCustomAttribute7 parameter specifies custom attributes. You can use these attributes to store additional information. |
ConditionalCustomAttribute8 |
Optional |
System.String |
The ConditionalCustomAttribute8 parameter specifies custom attributes. You can use these attributes to store additional information. |
ConditionalCustomAttribute9 |
Optional |
System.String |
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:
|
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:
|
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:
You cannot use this parameter if you use the RecipientFilter parameter. You must use either the RecipientFilter parameter or one of these filter parameters:
|
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:
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. |
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.
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.
Copy Code | |
---|---|
New-AddressList -Name MyAddressList -RecipientFilter {((RecipientType -eq 'UserMailbox') -and ((StateOrProvince -eq 'Washington') -or (StateOrProvince -eq 'Oregon')))} New-AddressList -Name MyAddressList2 -ConditionalStateOrProvince Washington -IncludedRecipients MailboxUsers |