mailkit.email.delete

Funkce mailkit.email.delete odstraní příjemce ze seznamu příjemců.

Ukázka API volání:

JSON 

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

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>

Hodnoty

client_id * = API ID naleznete ve svém Mailkit účtu v menu Profil/Integrace.
client_md5 * = MD5 kód naleznete ve svém Mailkit účtu v menu Profil/Integrace.
ID_email * = může obsahovat buď konkrétní ID e-mailu, 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í:

JSON 

{
    "error": "OK",
    "error_status": 0,
    "emails": "1234567890,1236547898"
}

XML 

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

Hodnoty

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

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

JSON 

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

XML 

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

Hodnoty

Invalid ID_email or email = neplatné ID e-mailu nebo neplatná e-mailová adresa (JSON)
Invalid ID_email = neplatné ID e-mailu/Neplatná e-mailová adresa (XML)