Share via

Managed Email 2007::ModifyOfflineAddressBook

  • Article

This procedure modifies an offline address book for a business organization.

Arguments

Input Arguments Type Required Description

<preferredDomainController>

string

Yes

The name of the Active Directory domain controller.

<organization>

string

Yes

The organization of the specified OAB.

<versions>

complexType

No

This parameter specifies the version list of supported OAB.

<versions/ version>

enum

No

This parameter specifies which version of OAB to generate. The value can be one of the following:

  • Version2

  • Version3

  • Verison4

Web-based OAB only supports Version4.

<publicFolderDistributionEnabled>

boolean

No

If the value is true, the OAB will be distributed via public folders.

<webDistributionEnabled>

boolean

No

If the value is True, the OAB will be distributed via web distribution points.

<MBXGenSvr>

string

No

This parameter specifies the mail server on which the OAB is generated.

<OABCASPool>

string

No

Name of the OABCASPool. If WebDistributionEanbled is True, a value must exist in either OABCASPool or OABCASPoolTag.

If this value is not null, ignore the input schema for OABCASPoolTag.

<OABCASPoolTag>

string

No

A tag name representing the pool.

If OABCASPool is not specified and a tag value is not null, filter the list of available pools with the tag value, and then select one pool.

If multiple pools match the tag value and are returned, use the first returned pool.

Remarks

Security

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

Schema Definition

Input

<executeData> 
        <preferredDomainController>1..1</preferredDomainController> 
        <organization>1..1</organization> 
        <versions> 
        0..1 
                  <version>0..unbounded</version> 
        </versions> 
        <publicFolderDistributionEnabled>0..1</publicFolderDistributionEnabled> 
        <webDistributionEnabled>0..1</webDistributionEnabled> 
        <mbxGenSvr>0..1</mbxGenSvr> 
        <oabCASPool>0..1</oabCASPool> 
        <oabCASPoolTag>0..1</oabCASPoolTag> 
</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 the organization object that is associated with the address list.--> 
    <organization>LDAP://OU=AlpineSkiHouse,OU=ConsolidatedMessenger,OU=Hosting,DC=fabrikam,DC=com</organization> 
    <!--Specifies what version of OAB to generate.--> 
    <versions> 
      <!--Specifies a version of OAB to generate.--> 
      <version>Version4</version> 
    </versions> 
    <!--If the value is true, the OAB will be distributed via public folders.--> 
    <publicFolderDistributionEnabled>true</publicFolderDistributionEnabled> 
    <!--If the value is true, the OAB will be distributed via web distribution point.--> 
    <webDistributionEnabled>true</webDistributionEnabled> 
    <!--Specify the mail server on which the OAB is generated.--> 
    <mbxGenSvr>EXMBXOAB01</mbxGenSvr> 
    <!--Name of the OABCASPool. If WebDistributionEanbled = True, then a value must exist in either OABCASPool or OABCASPoolTag. If this value is not null, ignore the input schema for OABCASPoolTag.--> 
    <oabCASPool>CasOABPool001</oabCASPool> 
    <!--A tag name representing the pool. If OABCASPool is not specified, and a tag value is not null, filter the list of available pools with the tag value, and select one pool. If multiple pools match the tag value and are returned, use the first pool returned.--> 
    <oabCASPoolTag>Non HA</oabCASPoolTag> 
  </data> 
  <procedure> 
    <execute namespace="Managed Email 2007" procedure="ModifyOfflineAddressBook" impersonate="1"> 
      <before source="data" sourcePath="preferredDomainController" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="organization" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="versions" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="publicFolderDistributionEnabled" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="webDistributionEnabled" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="allocateType" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="mbxGenSvr" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="oabCASPool" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="oabCASPoolTag" destination="executeData" mode="move" /> 
      <after source="executeData" destination="data" mode="merge" /> 
    </execute> 
  </procedure> 
</request>

Applies To

  • Hosted Messaging and Collaboration version 4.5

See also

Tasks

Managed Email 2007::CreateOfflineAddressBook
Managed Email 2007::RebuildOfflineAddressBook