PodporaAPI dokumentace

mailkit.email.move

Funkce mailkit.email.move přesune příjemce do jiného seznamu příjemců.

Ukázka API volání:

XML

<?xml version="1.0"?>
<methodCall>
  <methodName>mailkit.email.move</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>
    <param>
      <value>
        <int>ID_user_list</int>
      </value>
    </param>
  </params>
</methodCall>
		

JSON

{  
   "function":"mailkit.email.move",
   "id":"client_id",
   "md5":"client_md5",
   "parameters":{  
      "ID_email":ID_email,
      "ID_user_list":ID_user_list
   }
}

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* = ID e-mailu (vrací funkce mailkit.mailinglist.adduser)
ID_user_list = ID seznamu příjemců, kam má být příjemce přesunut (vrací funkce mailkit.mailinglist.list)
* povinný parametr

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

XML

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

JSON

{  
   "ID_user_list_source":"123456",
   "email":"email",
   "ID_email":"123456789",
   "move_response":1,
   "error_status":"0",
   "ID_user_list":"123457"
}

Hodnoty

1 = e-mail byl v pořádku přesunut do jiného seznamu příjemců (pro XML)

ID_user_list_source = ID seznamu příjemců, odkud byl příjemce přesunut
ID_user_list = ID seznamu příjemců, kam byl e-mail přesunut
email = e-mailová adresa
ID_email = ID e-mailu
move_response = stav přesunutí
error_status = chybový stav

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

XML

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

JSON

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

Hodnoty

0 = e-mail nebyl přesunut, byl zadán neplatný e-mail či ID e-mailu, nebo daný e-mail v seznamu již existuje (pro XML)

error_status = chybový stav
error = popis chybového stavu