Mail Manager - GetMailLists

Version: 1

HCnix Build: 3.00 and later

API Build: 1.00 and later

 

Mail Manager - GetMailLists  retrieves all mail lists under a specified mail domain. This web service call can be made as http://your-domain.com/HCnixAPI/MailManager.php?op=GetMailLists.

 

Input Parameters

 

Output Parameters

 

 

Sample Optional Parameters

 

<Parameters>

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

</Parameters>

 

Sample SOAP Request

 

 

POST /HCnixAPI/MailManager.php HTTP/1.1

Host: your-domain.com

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

Content-Length: length

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

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

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

      <HostUserName>host</HostUserName>

      <HostPassword>host123</HostPassword>

      <OwnerName>david</OwnerName>

      <MailDomainName>MyMailDomain.com</MailDomainName>

      <OptionalParam>xml</OptionalParam>

    </GetMailLists>

  </soap:Body>

</soap:Envelope>

 

 

Sample HTTP Request

 

 

POST /HCnixAPI/MailManager.php/GetMailLists HTTP/1.1

Host: your-domain.com

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

Content-Length: length

HostUserName=host&HostPassword=host123&OwnerName=david&MailDomainName=MyMailDomain.com

&OptionalParam=xml

 

 

Sample PHP Code

 

 

function GetMailLists($strHostUserName, $strHostPassword, $strOwnerName, $MailDomainName, $OptionalParam)

{

        $response="";

        $soapPacket = "<?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>

                 <GetMailLists xmlns=\"http://tempuri.org/\">

                  <HostUserName>$strHostUserName</HostUserName>

                  <HostPassword>$strHostPassword</HostPassword>

                  <OwnerName>$strOwnerName</OwnerName>

                  <MailDomainName>$strMailDomainName</MailDomainName>

                  <OptionalParam>$OptionalParam</OptionalParam>

                 </GetMailLists>

            </soap:Body>

        </soap:Envelope>";

        // where $domain_name is where HCnix APIs are installed

        $fp = fsockopen($domain_name, 80, $errNo, $errString, 90);

        if($fp)  

        {

             // where $name is the Virtual Directory name for HCnix APIs

             $header = "POST /$name/UserManager.php HTTP/1.1\r\n";

             $header .= "HOST: $domain_name\n";

             $header .= "Content-Type: text/xml;charset=\"utf-8\"\r\n";

             $header .= "Content-Length: ".strlen($soapPacket)."\r\n\r\n";

             fwrite($fp, $header.$soapPacket);

        

             while (true)

             {  

                  $buffer = fread($fp, 1000);

                  if( $buffer != "" )

                      $response .= $buffer;  

                  if(strstr($response, '</SOAP-ENV:Envelope>') || $buffer == "" )  

                      break;

                  $buffer = "";  

              }

            fclose($fp);

            $result = explode("<?xml",$response);

            return "<?xml".$result[1];

        }

}

 

 

Sample Response

 

 

<Response>

    <Method>GetMailLists</Method>

    <Status>true</Status>

    <ErrorCode>74900001</ErrorCode>

    <ErrorDescription>Operation completed successfully.</ErrorDescription>

    <Result>

        <MailLists xmlns="">

            <RecordRow>

                <ListName>MyList</ListName>

                <Members>member1@MyMailDomain.com,member2@MyMailDomain.com</Members>

            </RecordRow>

        </MailLists>

    </Result>

</Response>