PodporaAPI dokumentace

mailkit.email.delete

Funkce mailkit.email.delete odstraní příjemce ze seznamu příjemců. Pozor - společně s příjemcem budou odstraněny i veškeré jeho reporty.

Ukázka API volání:

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>ID_email</int>
      </value>
    </param>
  </params>
</methodCall>
		

JSON

Tato funkce není v JSON API zatím dostupná

Hodnoty

client_id * = API ID naleznete ve svém Mailkit účtu v menu Profil / Integrace / Nastavení API.
client_md5 * = MD5 kód naleznete ve svém Mailkit účtu v menu Profil / Integrace / Nastavení API.
ID_email * = může obsahovat buď konkrétní ID_emailu, nebo e-mailovou adresu, a v tom případě se vrací seznam ID všech smazaných záznamů
* povinný parametr

Po úspěšném volání se vrací:

XML

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

JSON

Tato funkce není v JSON API zatím dostupná

Hodnoty

Při úspěšném smazání e-mailu se vrací ID e-mailu.

Příklad neúspěšného volání:

XML

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

JSON

Tato funkce není v JSON API zatím dostupná

Hodnoty

prázdný záznam

  • vloženo neexistující ID e-mailu
  • vložena neexistující e-mailová adresa