Applies to: Exchange Server 2007
Topic Last Modified: 2007-10-23
Use the Set-AddressList cmdlet to modify an existing address list.
Syntax
Set-AddressList -Identity <AddressListIdParameter>
[-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>]
[-DisplayName <String>] [-DomainController <Fqdn>]
[-ForceUpgrade <SwitchParameter>] [-IncludedRecipients
<Nullable>] [-Name <String>] [-RecipientFilter
<String>]
|
Set-AddressList [-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>]
[-DisplayName <String>] [-DomainController <Fqdn>]
[-ForceUpgrade <SwitchParameter>] [-IncludedRecipients
<Nullable>] [-Instance <AddressList>] [-Name
<String>] [-RecipientFilter <String>]
|
Parameters
Parameter | Required | Type | Description |
---|---|---|---|
Identity |
Required |
Microsoft.Exchange.Configuration.Tasks.AddressListIdParameter |
Use the Identity parameter to specify the GUID, distinguished name or address list name that represents a specific address list. You can also include the path using the format Path\AddressListName. You can omit the parameter label Identity so that only the address list name or GUID is supplied. |
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 that you are modifying. You can use multiple values as a comma-delimited list. You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter. |
ConditionalCustomAttribute1 |
Optional |
System.String |
The ConditionalCustomAttribute1 parameter specifies custom attributes. Custom attributes allow you to add additional information to the address list by which you can sort or group address lists. You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter. |
ConditionalCustomAttribute10 |
Optional |
System.String |
The ConditionalCustomAttribute10 parameter specifies custom attributes. Custom attributes allow you to add additional information to the address list by which you can sort or group address lists. You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter. |
ConditionalCustomAttribute11 |
Optional |
System.String |
The ConditionalCustomAttribute11 parameter specifies custom attributes. Custom attributes allow you to add additional information to the address list by which you can sort or group address lists. You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter. |
ConditionalCustomAttribute12 |
Optional |
System.String |
The ConditionalCustomAttribute12 parameter specifies custom attributes. Custom attributes allow you to add additional information to the address list by which you can sort or group address lists. You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter. |
ConditionalCustomAttribute13 |
Optional |
System.String |
The ConditionalCustomAttribute13 parameter specifies custom attributes. Custom attributes allow you to add additional information to the address list by which you can sort or group address lists. You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter. |
ConditionalCustomAttribute14 |
Optional |
System.String |
The ConditionalCustomAttribute14 parameter specifies custom attributes. Custom attributes allow you to add additional information to the address list by which you can sort or group address lists. You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter. |
ConditionalCustomAttribute15 |
Optional |
System.String |
The ConditionalCustomAttribute15 parameter specifies custom attributes. Custom attributes allow you to add additional information to the address list by which you can sort or group address lists. You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter. |
ConditionalCustomAttribute2 |
Optional |
System.String |
The ConditionalCustomAttribute2 parameter specifies custom attributes. Custom attributes allow you to add additional information to the address list by which you can sort or group address lists. You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter. |
ConditionalCustomAttribute3 |
Optional |
System.String |
The ConditionalCustomAttribute3 parameter specifies custom attributes. Custom attributes allow you to add additional information to the address list by which you can sort or group address lists. You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter. |
ConditionalCustomAttribute4 |
Optional |
System.String |
The ConditionalCustomAttribute4 parameter specifies custom attributes. Custom attributes allow you to add additional information to the address list by which you can sort or group address lists. You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter. |
ConditionalCustomAttribute5 |
Optional |
System.String |
The ConditionalCustomAttribute5 parameter specifies custom attributes. Custom attributes allow you to add additional information to the address list by which you can sort or group address lists. You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter. |
ConditionalCustomAttribute6 |
Optional |
System.String |
The ConditionalCustomAttribute6 parameter specifies custom attributes. Custom attributes allow you to add additional information to the address list by which you can sort or group address lists. You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter. |
ConditionalCustomAttribute7 |
Optional |
System.String |
The ConditionalCustomAttribute7 parameter specifies custom attributes. Custom attributes allow you to add additional information to the address list by which you can sort or group address lists. You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter. |
ConditionalCustomAttribute8 |
Optional |
System.String |
The ConditionalCustomAttribute8 parameter specifies custom attributes. Custom attributes allow you to add additional information to the address list by which you can sort or group address lists. You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter. |
ConditionalCustomAttribute9 |
Optional |
System.String |
The ConditionalCustomAttribute9 parameter specifies custom attributes. Custom attributes allow you to add additional information to the address list by which you can sort or group address lists. You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter. |
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 must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter. |
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 must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter. |
DisplayName |
Optional |
System.String |
The DisplayName parameter specifies the desired display name of the address list. |
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
To specify the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to the Active Directory directory service, include the DomainController parameter in the command. |
ForceUpgrade |
Optional |
System.Management.Automation.SwitchParameter |
The ForceUpgrade parameter suppresses the following confirmation: "To save changes on object, the object must be upgraded to the current Exchange version. After upgrade, this object cannot be managed by a previous version of Exchange System Manager. Do you want to continue to upgrade and save the object?" This confirmation occurs when you upgrade an address list that was created in Microsoft Exchange Server 2003 or Exchange 2000 Server. You cannot manage an Exchange 2003 or Exchange 2000 address list by using the Exchange Management Console until you update the object's version and change the recipient filter by using either the RecipientFilter, or the IncludedRecipients parameters. |
IncludedRecipients |
Optional |
System.Nullable |
The IncludedRecipients parameter filters the recipient types that are used to build the global address list (GAL). The available values for the IncludedRecipients parameter are AllRecipients, MailboxUsers, Resources, Contacts, and MailGroups. The AllRecipients value can be used only by itself. When multiple values of the IncludedRecipients parameter are separated by commas, the OR Boolean operator is applied. You must use this parameter if you are using any of the Conditional parameters. You cannot use this parameter if you use the RecipientFilter parameter. |
Instance |
Optional |
Microsoft.Exchange.Data.Directory.Management.AddressList |
The Instance parameter is rarely used by administrators who use the command line. It is included in the parameters table for developer reference. |
Name |
Optional |
System.String |
The Name parameter specifies a new name for the address list. The name cannot exceed 64 characters, and it cannot include a carriage return or a backslash (\). |
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:
For more information about the filterable properties, see Filterable Properties for the -RecipientFilter parameter. |
Detailed Description
To run the Set-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.
If you want to use the Exchange Management Console to manage address lists that were created in Exchange Server 2003 or Exchange 2000 Server, you must do the following:
- Update the version attribute of the address list using the
ForceUpgrade parameter.
- Change the recipient filter using either the
RecipientFilter parameter or one of the following filter
parameters:
- ConditionalCompany
- ConditionalDepartment
- ConditionalStateOrProvince
- IncludedRecipients
- ConditionalCompany
Input Types
Return Types
Errors
Error | Description |
---|---|
|
|
Exceptions
Exceptions | Description |
---|---|
|
|
Example
The first example shows how to modify the name of an existing address list.
The second example shows how to modify the type of recipients and the department of the recipients that will be included in the existing address list named MyAddressList2. MyAddressList2 is an address list from Exchange 2003, so this command also upgrades this address list.
Copy Code | |
---|---|
Set-AddressList -Identity "All Users\Sales\building4" -Name building9 Set-Addresslist -Identity c3fffd8e-026b-41b9-88c4-8c21697ac8ac -IncludedRecipients UserMailbox -ConditionalDepartment Sales -ForceUpgrade:$true |
Use the Get-AddressList command, piped to Format-List, to get the GUID, distinguished name, or path and name of an existing address list. Or, use Get-AddressList to get a specific existing address list, and then pipe the output directly to Set-AddressList.