Hosted Exchange::GetPlanDetail

This procedure retrieves the details of a specified service plan.

Arguments

Input Argument	Required	Description
planName	Yes	Valid service plan name.
preferredDomainController	Yes

Remarks

Method Syntax

public string GetPlanDetail( 
                        string planName,  
                string preferredDomainController, 
                string statusTypeName, 
bool sendCredentials) 
        

Sample Code

Example XML Response

Shown for format only; content may vary.

<response> 
  <data> 
    <planName>BasicMail</planName> 
    <preferredDomainController>AD01.fabrikam.Com</preferredDomainController> 
    <planDescription>Basic Web Mail</planDescription> 
    <planTypeName>ExchMailbox</planTypeName> 
    <planSettings> 
      <mail> 
        <disablePOP>0</disablePOP> 
        <size>10000</size> 
        <disableIMAP>0</disableIMAP> 
        <disableHTTP>0</disableHTTP> 
      </mail> 
      <properties> 
        <property name="msExchMailboxFolderSet"> 
          <value>98821</value> 
        </property> 
      </properties> 
    </planSettings> 
    <planFeatures> 
      <feature> 
        <featureName>OwaSegment</featureName> 
        <featureDescription>Basic Outlook Web Access Features</featureDescription> 
        <featureValue>98821</featureValue> 
        <nativeAttribute>msExchMailboxFolderSet</nativeAttribute> 
        <parentNode>properties</parentNode> 
      </feature> 
      <feature> 
        <featureName>POP</featureName> 
        <featureDescription>POP Mail Access</featureDescription> 
        <featureValue>0</featureValue> 
        <nativeAttribute>disablePOP</nativeAttribute> 
        <parentNode>mail</parentNode> 
      </feature> 
      <feature> 
        <featureName>MailboxSize</featureName> 
        <featureDescription>Mailbox size in kilobytes</featureDescription> 
        <featureValue>10000</featureValue> 
        <unitDescription>kb</unitDescription> 
        <nativeAttribute>size</nativeAttribute> 
        <parentNode>mail</parentNode> 
      </feature> 
      <feature> 
        <featureName>NoOutlookClient</featureName> 
        <featureDescription>Full Outlook Client Access disabled</featureDescription> 
        <nativeAttribute>hideInAddressLists</nativeAttribute> 
      </feature> 
      <feature> 
        <featureName>IMAP</featureName> 
        <featureDescription>IMAP Mail Access</featureDescription> 
        <featureValue>0</featureValue> 
        <nativeAttribute>disableIMAP</nativeAttribute> 
        <parentNode>mail</parentNode> 
      </feature> 
      <feature> 
        <featureName>OWA</featureName> 
        <featureDescription>Outlook Web Access</featureDescription> 
        <featureValue>0</featureValue> 
        <nativeAttribute>disableHTTP</nativeAttribute> 
        <parentNode>mail</parentNode> 
      </feature> 
    </planFeatures> 
  </data> 
</response> 
                

Typical C# Usage

//Get user name and password. 
        string userName = this.Request.ServerVariables.Get("AUTH_USER"); 
        string pass = this.Request.ServerVariables.Get("AUTH_PASSWORD"); 
        //Set credentials. 
        hostedExch.PreAuthenticate = true; 
        hostedExch.Credentials = new NetworkCredential(userName,pass); 
 
        lblMsg.InnerHtml = mpsResponseHeaderLabel; 
        //Display response. 
        this.mpsResponse.DocumentSource = ""; 
        response = hostedExch. GetPlanDetail(planName, preferredDomainController,statusTypeName, sendCredentials); 
                         
        // set the response XML to match the return from MPF 
        responseXml.LoadXml(response); 
        this.mpsResponse.Document = responseXml; 
lblDone.InnerText = successMsg; 
        

Applies To

Hosted Exchange Web Service for:

• Hosted Messaging and Collaboration version 3.5

• Hosted Messaging and Collaboration version 3.0

See also

Tasks

Hosted Exchange::AddAvailablePlans
Hosted Exchange::CreatePlanFeatureTypes
Hosted Exchange::GetAvailablePlans
Hosted Exchange::GetPlans
Hosted Exchange::RemoveAvailablePlans