mailkit.filemanager.list

Funkce mailkit.filemanager.list vrátí seznam souborů a adresářů uložených ve správci souborů.

Ukázka API volání

JSON 

{
   "function": "mailkit.filemanager.list",
   "id":"client_id",
   "md5":"client_md5",
   "parameters": {
      "ID_folder": "12345"
   }
}

XML 

<?xml version="1.0" encoding="UTF-8"?>
<methodCall>
  <methodName>mailkit.filemanager.list</methodName>
  <params>
    <param>
      <value>
        <int>client_id</int>
      </value>
    </param>
    <param>
      <value>
        <string>client_md5</string>
      </value>
    </param>
    <param>
      <value>
        <string>ID_folder</string>
      </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_folder = ID složky, z níž bude vypsán seznam souborů a složek, které obsahuje. V případě nevyplnění tohoto parametru se vrátí seznam všech souborů a složek z kořenového adresáře.

* povinný parametr

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

JSON 

{
    "data": [
        {
            "ID_FILE": 466775,
            "TYPE": "FILE",
            "LENGTH": 3146,
            "NAME": "picture_1.png",
            "PARENT": "pictures",
            "DATE": "2024-09-05 08:52:05"
        },
        {
            "DATE": "2024-09-05 08:52:05",
            "PARENT": "pictures",
            "NAME": "picture_2.png",
            "TYPE": "FILE",
            "LENGTH": 3893,
            "ID_FILE": 466773
        },
        {
            "PARENT": "pictures",
            "NAME": "picture_4.png",
            "TYPE": "FILE",
            "LENGTH": 3893,
            "ID_FILE": 466774,
            "DATE": "2024-09-05 08:52:05"
        }
    ],
    "error_status": 0
}

XML 

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
  <params>
    <param>
      <value>
        <array>
          <data>
            <value>
              <struct>
                <member>
                  <name>NAME</name>
                  <value>
                    <string>untitled folder</string>
                  </value>
                </member>
                <member>
                  <name>DATE</name>
                  <value>
                    <string>yyyy-mm-dd hh:mm:ss</string>
                  </value>
                </member>
                <member>
                  <name>ID_FOLDER</name>
                  <value>
                    <i4>123456</i4>
                  </value>
                </member>
                <member>
                  <name>PARENT</name>
                  <value>
                    <string>parent folder</string>
                  </value>
                </member>
                <member>
                  <name>TYPE</name>
                  <value>
                    <string>DIR</string>
                  </value>
                </member>
              </struct>
            </value>
            <value>
              <struct>
                <member>
                  <name>NAME</name>
                  <value>
                    <string>abcdefg.gif</string>
                  </value>
                </member>
                <member>
                  <name>LENGTH</name>
                  <value>
                    <i4>1012135</i4>
                  </value>
                </member>
                <member>
                  <name>DATE</name>
                  <value>
                    <string>yyyy-mm-dd hh:mm:ss</string>
                  </value>
                </member>
                <member>
                  <name>PARENT</name>
                  <value>
                    <string>parent folder</string>
                  </value>
                </member>
                <member>
                  <name>TYPE</name>
                  <value>
                    <string>FILE</string>
                  </value>
                </member>
                <member>
                  <name>ID_FILE</name>
                  <value>
                    <i4>98765432</i4>
                  </value>
                </member>
              </struct>
            </value>
          </data>
        </array>
      </value>
    </param>
  </params>
</methodResponse>

Hodnoty

NAME = jméno souboru / složky
DATE = datum vložení souboru / založení složky
ID_FOLDER = ID složky
PARENT = nadřazená složka. ROOT v případě kořenového adresáře.

TYPE

  • DIR = složka
  • FILE = soubor

LENGTH = velikost souboru (v bajtech)
ID_FILE = ID souboru

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

JSON 

{
    "error": "Invalid ID_folder",
    "error_status": 1
}

XML 

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

Hodnoty

Prázdná odpověď = složka je prázdná
Invalid ID_folder = vloženo neplatné ID složky