Share via

Exchange 2007 Provider::ModifyOfflineAddressBook

  • Article

This method modifies an offline address book (OAB) for a business organization.

Arguments

Input Arguments Type Required Description

<preferredDomainController>

string

Yes

The name of the Active Directory domain controller.

<name>

string

Yes

The name that describes the OAB object in Exchange System Manager. The name cannot exceed 64 characters, and it cannot include a carriage return or a backslash (\).

<schedule>

string

No

This parameter specifies the interval scheduled for generating the new OAB. The value can be: Never|Always|Mon.01:00-Mon.02:00, Wed.01:00-Wed.02:00.

In the provisioning system, OAB update will be performed by a stand-alone tool. So managed layer will always set the schedule parameter to "Never" during calls into this procedure.

<versions>

complexType

No

This parameter specifies the version list of supported OAB.

<versions/ version>

enum

No

This parameter specifies a version of OAB to generate.

The value can be one of the following:

  • Version2

  • Version3

  • Verison4

<publicFolderDatabase>

string

No

This parameter specifies the identity of a public folder database.

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

<virtualDirectories>

complexType

No

This parameter specifies the distribution point list of the web-based OAB.

<virtualDirectories / virtualDirectory>

string

No

A combination of the CAS server name and the virtual directory path on it.

Remarks

Security

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

Schema Definition

Input

<executeData> 
    <preferredDomainController>1..1</preferredDomainController> 
    <name>1..1</name> 
    <schedule>0..1</schedule> 
    <versions> 
        0..1 
        <version>0..unbounded</version> 
    </versions> 
    <publicFolderDatabase>0..1</publicFolderDatabase> 
    <publicFolderDistributionEnabled>0..1</publicFolderDistributionEnabled> 
    <webDistributionEnabled>0..1</webDistributionEnabled> 
    <virtualDirectories> 
        0..1 
        <virtualDirectory>1..unbounded</virtualDirectory> 
    </virtualDirectories> 
</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 name for the specified OAB. The name cannot exceed 64 characters, and it cannot include a carriage return or a backslash (\).--> 
    <name>AlpineSkiHouse OAL</name> 
    <!--Specifies the interval scheduled for generating the new OAB.  values: Never|Always|Mon.01:00-Mon.02:00, Wed.01:00-Wed.02:00--> 
    <schedule>Never</schedule> 
    <!--Specifies what version of OAB to generate.--> 
    <versions> 
      <!--Specifies a version of OAB to generate.--> 
      <version>Version4</version> 
    </versions> 
    <!--This parameter specifies the identity of a public folder database.--> 
    <publicFolderDatabase>EXMBXOAB01\SG03\PublicFolderStore01</publicFolderDatabase> 
    <!--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 points specified by the virtual directories.--> 
    <webDistributionEnabled>true</webDistributionEnabled> 
    <!--Specifiy the distribution point list of the web based OAB.--> 
    <virtualDirectories> 
      <!--A combination of the CAS server name and the virtual directory path on it.--> 
      <virtualDirectory>EXCASOAB01\OAB (Default Web Site)</virtualDirectory> 
    </virtualDirectories> 
  </data> 
  <procedure> 
    <execute namespace="Exchange 2007 Provider" procedure="ModifyOfflineAddressBook" impersonate="1"> 
      <before source="data" sourcePath="preferredDomainController" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="name" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="schedule" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="versions" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="publicFolderDatabase" 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="virtualDirectories" destination="executeData" mode="move" /> 
      <after source="executeData" destination="data" mode="merge" /> 
    </execute> 
  </procedure> 
</request>

Example XML Response

<response>  
        <data /> 
</response>

Applies To

Exchange 2007 Provider Namespace for:

  • Hosted Messaging and Collaboration version 4.5

See also

Tasks

Managed Email 2007::CreateOfflineAddressBook
Exchange 2007 Provider::DeleteOfflineAddressBook
Managed Email 2007::RebuildOfflineAddressBook