Mail Manager - GetMailLists

Version: 7C

HC7 Build: 7.00.0012 and later

API Build: 1.00.0001 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/HC7API/MailManager.asmx?op=GetMailLists

 

Input Parameters

 

Output Parameters

 

 

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/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 /HC7API/MailManager.asmx/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 C# Code

 

 

public MailManager.Response GetMailLists(string strHostUserName, string strHostPassword, string strOwnerName)

{

         try

         {

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

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

                               

                   oResponse = oMail.GetMailLists(strHostUserName, strHostPassword, strOwnerName, null);

                    

         }

         catch

         {

         }

         return oResponse;

}

 

 

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>