ResourcesAPI documentation

mailkit.email.delete

Function mailkit.email.delete is used to delete recipient from mailing list. Notice - all related recipient's data and reports will be deleted as well.

API call example:

XML

<?xml version="1.0"?>
<methodCall>
  <methodName>mailkit.email.delete</methodName>
  <params>
    <param>
      <value>
        <int>client_id</int>
      </value>
    </param>
    <param>
      <value>
        <string>client_md5</string>
      </value>
    </param>
    <param>
      <value>
        <int>email_id</int>
      </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.

email_id * = may contain ID of e-mail address, (returned by mailkit.mailinglist.adduser), or e-mail address. If an email address is provided a list of all deleted records will be returned.

* required value

Successful call response:

XML

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
  <params>
    <param>
      <value>
        <i4>123456789</i4>
      </value>
    </param>
  </params>
</methodResponse>
		

Values

ID of successful deleted e-mail..

Unsuccessful call response:

XML

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
  <params>
    <param>
      <value>
        <string></string>
      </value>
    </param>
  </params>
</methodResponse>
		

Values

Empty response

  • email ID does not exist
  • e-mail address does not exist