ResourcesAPI documentation

mailkit.email.wipe

Function mailkit.email.wipe is used to fully anonymize and delete all recipient data (including all history) of a recipient that requested to be removed from any data processing (right to be forgotten). After processing the request recipient data will be deleted and report data will be anonymized by replacing the email address with a random hash to preserve data consistency.

Data wipe requests are stored in a queue and processed once a day.

API call example:

XML

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

JSON

{
  "function": "mailkit.email.wipe",
  "id": "client_id",
  "md5": "client_md5",
  "parameters": {
	"email": "example@example.com", nebo
	"ID_email":"12345678"
  }
}

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.

ID_email * = may contain ID of e-mail address, (returned by mailkit.mailinglist.adduser), or e-mail address.

email = email address of the recipient.

* required value

Successful call response:

XML

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
    <params>
        <param>
            <value>
                <struct>
                    <member>
                        <name>email</name>
                        <value>
                            <string>example@example.com</string>
                        </value>
                    </member>
                    <member>
                        <name>error_status</name>
                        <value>
                            <i4>0</i4>
                        </value>
                    </member>
                    <member>
                        <name>ID_email</name>
                        <value>
                            <i4>12345678</i4>
                        </value>
                    </member>
                    <member>
                        <name>error</name>
                        <value>
                            <string>OK</string>
                        </value>
                    </member>
                </struct>
            </value>
        </param>
    </params>
</methodResponse>

JSON

{
	"ID_email": 12345678,
	"email": "example@example.eu",
	"error_status": 0,
	"error": "OK"
}

Values:

ID_email = ID of the email address
email = email address
error = OK - no errors
error_status = 0 - no errors

Sample unsuccesfull call:

XML

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
    <params>
        <param>
            <value>
                <string>Email has already been inserted</string>
            </value>
        </param>
    </params>
</methodResponse>

JSON

{
	"error_status": 1,
	"error": "Invalid ID_email or email"
}

Values:

Missing ID_email = missing email address ID
Invalid_ID_email or email = invalid email address or email address ID
Email has already been inserted = this email address has already been added to the wipe queue