ResourcesAPI documentation

mailkit.filemanager.delete

Function mailkit.filemanager.delete allows delete file or empty folder from file manager.

XML-RPC call example:

XML-RPC call

<?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>
		

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_file/ID_folder * = ID of file or folder

file/dir * = delete file or folder (deleted unempty folders is disabled)

  • file = file
  • dir = folder

* required value

Successful call response:

XML-RPC response

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

Values

DELETED = file or folder was succesfully deleted

Unsuccessful call response:

XML-RPC response

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

Values

Invalid ID_file

Invalid ID_folder

Directory is not empty = the folder can not be deleted