Hosted Email 2007::MailEnableGroup

  • Article

This procedure Mail-enables an existing universal group.

Arguments

Input Arguments Required Description

<preferredDomainController>

Yes

The domain controller to use for Active Directory actions.

<group>

Yes

The Lightweight Directory Access Protocol (LDAP) path of an existing universal group.

<alias>

Yes

The e-mail alias of the group.

<emailAddresses>

Yes

The collection of emailAddress instances.

<emailAddresses/value>

Yes

The e-mail alias of the distribution group. All valid Exchange Server 2007 e-mail address types may be used. One or more instances can be supplied.

<displayName>

No

This parameter can be used to specify the distribution group's name in the Exchange Management Console and in the Exchange global address list (GAL).

<hiddenFromAddressListEnabled>

No

This parameter specifies whether this mailbox is hidden from other address lists.

<owningOrganization>

No

This parameter specifies the path of the hosted organization that contains the AL, GAL, and OAB as well-known-objects. By default, it is the LDAP parent container of the object.

Remarks

Security

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

Schema Definition

Input

<executeData>  
<preferredDomainController>1..1 </preferredDomainController> 
<group>1..1 </group> 
<alias>1..1 </alias> 
<emailAddresses>1..1  
<value>1..unbounded </value> 
</emailAddresses> 
<displayName>0..1 </displayName> 
<hiddenFromAddressListsEnabled>0..1 </hiddenFromAddressListsEnabled> 
<owningOrganization>0..1 </owningOrganization> 
</executeData>

Output

<executeData>1..1 </executeData>

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 an existing universal group.--> 
    <group>LDAP://CN=Sales@alpineskihouse,OU=AlpineSkiHouse,OU=ConsolidatedMessenger,DC=Fabrikam,DC=Com</group> 
    <!--The e-mail alias of the group.--> 
    <alias>Sales</alias> 
    <!--Collection of emailAddress instances.--> 
    <emailAddresses> 
      <!--Specifies the e-mail alias of the distribution group. All valid Exchange Server 2007 e-mail address types may be used. One or more instances can be supplied.--> 
      <value>Sales@alpineskihouse.com</value> 
    </emailAddresses> 
    <!--This parameter can be used to specify the distribution group's name in the Exchange Management Console and in the Exchange global address list (GAL).--> 
    <displayName>AlpineSkiHouse - Sales</displayName> 
    <!--Specifies whether this mailbox is hidden from other address lists.--> 
    <hiddenFromAddressListsEnabled>false</hiddenFromAddressListsEnabled> 
    <!--Specifies the path of the hosted organization that contains the AL, GAL, and OAB as well-known-objects.  By default it is the LDAP parent container of the object.--> 
    <owningOrganization>LDAP://OU=AlpineSkiHouse,OU=ConsolidatedMessenger,OU=Hosting,DC=Fabrikam,DC=Com</owningOrganization> 
  </data> 
  <procedure> 
    <execute namespace="Hosted Email 2007" procedure="MailEnableGroup" impersonate="1"> 
      <before source="data" sourcePath="preferredDomainController" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="group" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="alias" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="emailAddresses" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="displayName" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="hiddenFromAddressListsEnabled" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="owningOrganization" destination="executeData" mode="move" /> 
      <after source="executeData" destination="data" mode="merge" /> 
    </execute> 
  </procedure> 
</request>

Example XML Response

<response>  
        <data /> 
</response>

Applies To

Hosted Email 2007 Namespace for:

  • Hosted Messaging and Collaboration version 4.5

  • Hosted Messaging and Collaboration version 4.0

See also

Tasks

Hosted Email 2007::ModifyDistributionList
Hosted Email 2007::CreateDistributionList
Hosted Email 2007::DeleteDistributionList
Hosted Email 2007::MailDisableGroup