Mail Manager - GetMailboxProperties

Version: 7C

HC7 Build: 7.00.0012 and later

API Build: 1.00.0001 and later

Mail Manager - GetMailboxProperties  retrieves properties of a specified mailbox. This web service call can be made as http://your-domain.com/HC7API/MailManager.asmx?op=GetMailboxProperties.

Input Parameters

• HostUserName

• HostPassword

• OwnerName

• MailboxName - name of mailbox for which you want to retrieve properties

• MailDomainName - name of mail domain under which mailbox was created

• OptionalParam

• Language
   

Output Parameters

• ForwardAddress - redirection address

• MailboxPassword - new password

Sample Optional Parameters

<Parameters>

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

</Parameters>

Sample SOAP Request

POST /HC7API/MailManager.asmx HTTP/1.1

Host: your-domain.com

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

Content-Length: length

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

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

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

      <HostUserName>host</HostUserName>

      <HostPassword>host123</HostPassword>

      <OwnerName>david</OwnerName>

      <MailboxName>mymailbox</MailboxName>

      <MailDomainName>MyMailDomain.com</MailDomainName>

      <OptionalParam>xml</OptionalParam>

    </GetMailboxProperties>

  </soap:Body>

</soap:Envelope>

Sample HTTP Request

POST /HC7API/MailManager.asmx/GetMailboxProperties HTTP/1.1

Host: your-domain.com

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

Content-Length: length

HostUserName=host&HostPassword=host123&OwnerName=david&MailboxName=mymailbox&
MailDomainName=HC7API.com&OptionalParam=xml

Sample C# Code

public MailManager.Response GetMailboxProperties(string strHostUserName, string strHostPassword, string strOwnerName, string strMailboxName, string strMailDomainName)

{

         try

         {

                    MailManager.MailManager oMail = new MailManager.MailManager();

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

                    oResponse = oMail.GetMailboxProperties(strHostUserName, strHostPassword, strOwnerName,

                    strMailboxName, strMailDomainName, null);

         }

         catch

         {

         }

         return oResponse;

}

Sample Response

<Response>

    <Method>GetMailboxProperties</ Method>

    <Status>true</Status>

    <ErrorCode>74900001</ErrorCode>

    <ErrorDescription>Operation completed successfully.</ErrorDescription>

    <Result>

       <MailboxProperties xmlns="">

          <ForwardAddress>john@host.com</ForwardAddress>

          <AccounType>Admin</AccountType>

       </MailboxProperties>

    </Result>

</Response>