PodporaAPI dokumentace

mailkit.filemanager.delete

Funkce mailkit.filemanager.delete smaže soubor nebo prázdnou složku ze správce souborů.

Ukázka XML-RPC volání:

XML-RPC volání

<?xml version="1.0" encoding="UTF-8"?>
<methodCall>
  <methodName>mailkit.filemanager.delete</methodName>
  <params>
    <param>
      <value>
        <int>client_id</int>
      </value>
    </param>
    <param>
      <value>
        <string>client_md5</string>
      </value>
    </param>
    <param>
      <value>
        <i4>ID_file/ID_folder</i4>
      </value>
    </param>
    <param>
      <value>
        <string>file/dir</string>
      </value>
    </param>
  </params>
</methodCall>

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_file/ID_folder * = ID souboru nebo složky, která má být smazána.

file/dir * = zda má být smazána složka nebo soubor (nelze mazat neprázdné složky)

  • file = soubor
  • dir = složka

* povinný parametr

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

XML-RPC odpověď

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

Hodnoty

DELETED = soubor nebo prázdná složka byla úspěšně smazána

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

XML-RPC odpověď

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

Hodnoty

Invalid ID_file = vloženo neplatné ID souboru

Invalid ID_folder = vloženo neplatné ID složky

Directory is not empty = složka není prázdná, a proto nelze smazat