Share via

Exchange 2007 Provider::CreateAddressList

  • Article

This method creates an address list for a customer.

Arguments

Input Arguments Required Description

<preferredDomainController>

Yes

The domain controller to use for Active Directory actions.

<path>

Yes

The Lightweight directory access protocol (LDAP) path of the organization object that is associated with the address list.

<name>

Yes

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

<recipientFilter>

No

This parameter specifies a filter for recipients to include in the address list.

<displayName>

No

This 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.

<readAccess>

No

The container for a collection of LDAP path of groups or users that will be granted read access to the new Address List.

<readAccess/ value>

Yes

The LDAP path of a user or group that will be granted read access to the new address list.

Remarks

Rollback Method: DeleteAddressList

The distinguishedName of the Address List will be stamped as an otherWellKnowObjects entry on the organization using WKGUID=9E444526CB6F4D5C9A59C9A84E26B627.

Security

The caller must be at least a member of role: OrgCreators.

Sample Code

Example XML Request

<request> 
  <data> 
    <!--The domain controller to use for Active Directory actions.--> 
    <preferredDomainController>AD01.Fabrikam.Com</preferredDomainController> 
    <!--The LDAP path of the organization object that is associated with the address list.--> 
    <path>LDAP://OU=AlpineSkiHouse,OU=ConsolidatedMessenger,OU=Hosting,DC=fabrikam,DC=com</path> 
    <!--The desired name for the new address list. The name cannot exceed 64 characters, and it cannot include a carriage return or a backslash (\).--> 
    <name>AlpineSkiHouse AL</name> 
    <!--Specifies a filter for recipients to include in the address list.--> 
    <recipientFilter>((RecipientType -eq 'UserMailbox') -and ((StateOrProvince -eq 'Washington') -or (StateOrProvince -eq 'Oregon')))</recipientFilter> 
    <!--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.--> 
    <displayName>AlpineSkiHouseAL</displayName> 
    <!--Container for a collection of LDAP path of groups or users that will be granted read access to the new Address List.--> 
    <readAccess> 
      <!--LDAP path of a user or group that will be granted read access to the new address list.--> 
      <value>LDAP://CN=Admins@AlpineSkiHouse,OU=AlpineSkiHouse,OU=ConsolidatedMessenger,OU=Hosting,DC=fabrikam,DC=com</value> 
    </readAccess> 
  </data> 
  <procedure> 
    <execute namespace="Exchange 2007 Provider" procedure="CreateAddressList" impersonate="1"> 
      <before source="data" sourcePath="preferredDomainController" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="path" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="name" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="recipientFilter" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="displayName" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="readAccess" destination="executeData" mode="move" /> 
      <after source="executeData" destination="data" mode="merge" /> 
    </execute> 
  </procedure> 
</request>

Applies To

Exchange 2007 Provider Namespace for:

  • Hosted Messaging and Collaboration version 4.5

  • Hosted Messaging and Collaboration version 4.0

See also

Tasks

Exchange 2007 Provider::DeleteAddressList