ResourcesAPI documentation

mailkit.mailinglist.list

Function mailkit.mailinglist.list is used to get an overview of the available mailing lists.

XML-RPC request must be sent in the format displayed below. Example in PHP here.

API call example:

XML

<?xml version="1.0"?>
<methodCall>
<methodName>mailkit.mailinglist.list</methodName>
<params>
 <param>
  <value>
   <int>client_id</int>
  </value>
 </param>
 <param>
  <value>
   <string>client_md5</string>
  </value>
 </param>
</params>
</methodCall>
		

Values

client_id * = client ID can be found in your Mailkit account's menu Profile / Integration / API settings.

client_md5 * = MD5 code can be found in your Mailkit account's menu Profile / Integration / API settings.

* required value

Successful call response:

XML

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
<params>
 <param>
  <value>
   <array>
    <data>
     <value>
      <struct>
       <member>
        <name>NAME</name>
        <value>
         <string>mailinglist's name</string>
        </value>
       </member>
       <member>
        <name>ID_USER_LIST</name>
        <value>
         <i4>12345</i4>
        </value>
       </member>
       <member>
        <name>STATUS</name>
        <value>
         <string>enabled</string>
        </value>
       </member>
       <member>
        <name>DESCRIPTION</name>
        <value>
         <string>mailingslist's description</string>
        </value>
       </member>
      </struct>
     </value>
    </data>
   </array>
  </value>
 </param>
</params>
</methodResponse>
		

Values

NAME = name of mailing list

ID_USER_LIST = ID of mailing list

STATUS = status of mailing list. Possible values: enabled or disabled.

DESCRIPTION = description of mailing list