Unified Messaging 2007 Provider::GetUMMailbox

This produres gets the Unified Messaging (UM) properties for a UM enabled mailbox, returning all properties.

Arguments

Input Arguments	Required	Description
<preferredDomainController>	Yes	The domain controller to use for Active Directory actions.
<identity>	No	The identifier for the user. This can be in the form of an Active Directory Object path, GUID, DN, Domain/SamAccountName, UPN, LegacyExchangeDN, SMTPAddress or Alias. Note sAMAccountName cannot be longer than 20 characters. See SAM-Account-Name Attribute for more information.
<anr>	No	A name on which to perform Ambiguous Name resolution. This can be in the form of CN, displayName, FirstName, LastName or Alias.
<filter>	No	This parameter is used to filter the results list.
<organizationalUnit>	No	The CN of the organizational unit from which to retrieve mailboxes.
<resultSize>	No	This parameter specifies the number of results that may be returned.
<sortBy>	No	The field used to sort by. It can be Alias, DisplayName, or Name.
<readFromDomainController>	No	This parameter specifies to read directly from the domain controller not the global catalog as it may be out of date.

Remarks

Security

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

Sample Code

Example XML Request

<request> 
        <data/> 
        <procedure> 
                <execute namespace='Unified Messaging 2007 Provider' procedure='GetUMMailbox'> 
                        <executeData> 
                                <identity>Fabrikam\user1</indentity> 
                                <anr>user1</anr> 
                                <credential> 
                                        <username>fabrikam\administrator</username> 
                                        <password>Pass1word</password> 
                                </credential> 
                                <preferredDomainController>dc01.fabrikam.local</preferredDomainController> 
                                <filter>(&(objectClass=user)(cn=smith*))</filter> 
                                <organizationalUnit>OU=alpineskihouse,OU=consolidatedmessenger,OU=hosting,DC=fabrikam,DC=local</orgainzationalUnit> 
                                <resultSize>100</resultSize> 
                                <sortBy>displayName</sortBy> 
                                <readFromDomainController>true</ readFromDomainController > 
                                <umEnabled>true</umEnabled> 
                        </executeData> 
                </execute> 
        </procedure> 
</request> 

Example XML Response

<response> 
        <data> 
                <mailboxes> 
                <mailbox name="mailboxname"> 
                                <properties> 
                                        <property name="propertyName"> 
                                                <value>return value</value> 
                                                . 
                                        </property> 
                                        . 
                                        </ properties> 
                </mailbox> 
                        <mailbox> 
                        . 
                </mailboxes> 
        </data> 
</response>

Applies To

• Hosted Messaging and Collaboration version 4.5

• Hosted Messaging and Collaboration version 4.0