Exchange Manager - GetExchangeMailDomains

Version: 7C

HC7 Build: 7.00.0012 and later

API Build: 1.00.0001 and later

Exchange Manager - GetExchangeMailDomains  retrieves all exchange mail domains under a specified owner. This web service call can be made as http://your-domain.com/HC7API/ExchangeManager.asmx?op=GetExchangeMailDomains.

Input Parameters

• HostUserName

• HostPassword

• OwnerName - user name whose exchange mail domains you want to retrieve, can be set to Host Name for getting all records

• OptionalParam

• WebsiteName - sent when you want to get mail domains under a particular website

• MailDomainName - search filter

• Language
   

Output Parameters

• MailDomainName

• IPAddress - IPAddress of associated website in case of IP Based and "Virtual" in case of NameBased

• MailAccessURL - OWA (Outlook Web Access) of mail domain

Sample Optional Parameters

<Parameters>

<Parameter Name = "WebsiteName">MyDomain.com</Parameter>

<Parameter Name = "MailDomainName">MyMailDomain</Parameter>

<Parameter Name = "Language">French</Parameter>

</Parameters>

Sample SOAP Request

POST /HC7API/ExchangeManager.asmx HTTP/1.1

Host: your-domain.com

Content-Type: text/xml; charset=utf-8

Content-Length: length

SOAPAction: "http://tempuri.org/GetExchangeMailDomains"

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

  <soap:Body>

    <GetExchangeMailDomains xmlns="http://tempuri.org/">

      <HostUserName>host</HostUserName>

      <HostPassword>host123</HostPassword>

      <OwnerName>david</OwnerName>

      <OptionalParam>xml</OptionalParam>

    </GetExchangeMailDomains>

  </soap:Body>

</soap:Envelope>

Sample HTTP Request

POST /HC7API/ExchangeManager.asmx/GetExchangeMailDomains HTTP/1.1

Host: your-domain.com

Content-Type: application/x-www-form-urlencoded

Content-Length: length

HostUserName=host&HostPassword=host123&OwnerName=david&OptionalParam=xml

Sample C# Code

public ExchangeManager.Response GetExchangeMailDomains(string strHostUserName, string strHostPassword, string strOwnerName)

{

         try

         {

                    ExchangeManager.ExchangeManager oExchange = new ExchangeManager.ExchangeManager();

                    ExchangeManager.Response oResponse = new ExchangeManager.Response();

                    XmlDocument oDoc = new XmlDocument();

  //Adding root node

  XmlNode xOptionalParam = oDoc.CreateNode(XmlNodeType.Element,"Parameters","");

  //Adding sub nodes

  XmlNode xParameter = oDoc.CreateNode(XmlNodeType.Element,"Parameter","");

  XmlAttribute xAttribute = oDoc.CreateAttribute("Name");

  xAttribute.Value = "WebsiteName";

  xParameter.Attributes.Append(xAttribute);

  xParameter.InnerText = "MyMailDomain";

  xOptionalParam.AppendChild(xParameter);

  .......

  .......

  .......

                    oResponse = oExchange.GetExchangeMailDomains(strHostUserName, strHostPassword,

                    strOwnerName, OptionalParam); 

        }

        catch

        {

        }

        return oResponse;

}

Sample Response

<Response>

    <Method>GetExchangeMailDomains</Method>

    <Status>true</Status>

    <ErrorCode>74900001</ErrorCode>

    <ErrorDescription>Operation completed successfully.</ErrorDescription>

    <Result>

        <ExchangeMailDomains xmlns="">

        <RecordCount>1</RecordCount>

            <RecordRow>

                <MailDomainName>MyMailDomain.com</MailDomainName>

                <IPAddress>127.0.0.1</IPAddress>

                <MailAccessURL>http://MyDomain.com/OWA</MailAccessURL>

            </RecordRow>

  .......

  .......

  .......

        </ExchangeMailDomains>

    </Result>

</Response>