Managed Email 2007::CreateAddressList
Creates a new address list.
Arguments
Input Arguments | Required | Description |
---|---|---|
<preferredDomainController> |
Yes |
The domain controller to use for Active Directory actions. |
<organization> |
Yes |
The 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 |
Specifies a filter for recipients to include in the address list. |
<displayName> |
No |
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 |
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 |
LDAP path of a user or group that will be granted read access to the new address list. |
Remarks
Security
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.-->
<organization>LDAP://OU=AlpineSkiHouse,OU=ConsolidatedMessenger,OU=Hosting,DC=fabrikam,DC=com</organization>
<!--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="Managed Email 2007" procedure="CreateAddressList" impersonate="1">
<before source="data" sourcePath="preferredDomainController" destination="executeData" mode="move" />
<before source="data" sourcePath="organization" 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
Hosted Messaging and Collaboration version 4.5
Hosted Messaging and Collaboration version 4.0
See also
Other Resources
API Name [HMC SDK]
API Name [HMC SDK]