PodporaAPI dokumentace

mailkit.filemanager.upload

Funkce mailkit.filemanager.upload vloží soubor do správce souborů.

Ukázka XML-RPC volání:

XML-RPC volání

<?xml version="1.0" encoding="UTF-8"?>
<methodCall>
  <methodName>mailkit.filemanager.upload</methodName>
  <params>
    <param>
      <value>
        <int>client_id</int>
      </value>
    </param>
    <param>
      <value>
        <string>client_md5</string>
      </value>
    </param>
    <param>
      <value>
        <array>
          <data>
            <value>
              <struct>
                <member>
                  <name>folder_name</name>
                  <value>
                    <string></string>
                  </value>
                </member>
                <member>
                  <name>name</name>
                  <value>
                    <string>soubor.gif</string>
                  </value>
                </member>
                <member>
                  <name>data</name>
                  <value>
                    <string>YXNhc2FzYXN=</string>
                  </value>
                </member>
                <member>
                  <name>description</name>
                  <value>
                    <string>popis</string>
                  </value>
                </member>
              </struct>
            </value>
          </data>
        </array>
      </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.

folder_name = jméno adresáře. Při nevyplnění se soubor ukládá do kořenového adresáře.

name * = jméno vkládaného souboru (max. 50 znaků)

data * = data souboru (v Base 64)

description = popis souboru

* povinný parametr

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

XML-RPC odpověď

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
  <params>
    <param>
      <value>
        <array>
          <data>
            <value>
              <struct>
                <member>
                  <name>ERROR</name>
                  <value>
                    <i4>0</i4>
                  </value>
                </member>
                <member>
                  <name>NAME</name>
                  <value>
                    <string>soubor.gif</string>
                  </value>
                </member>
                <member>
                  <name>NAME_ORIG</name>
                  <value>
                    <string>soubor.gif</string>
                  </value>
                </member>
                <member>
                  <name>ID_FOLDER</name>
                  <value>
                    <i4>0</i4>
                  </value>
                </member>
                <member>
                  <name>ID_FILE</name>
                  <value>
                    <i4>12345</i4>
                  </value>
                </member>
              </struct>
            </value>
          </data>
        </array>
      </value>
    </param>
  </params>
</methodResponse>
		

Hodnoty

ERROR = nabývá hodnot 0 až 5:

  • 0 = bez chyby
  • 1 = nepovolená přípona souboru (exe, com, bat, pif, reg, dll)
  • 2 = nenalezen ID_folder podle folder_name (Soubor se uloží do kořenového adresáře.)
  • 3 = chybí data souboru
  • 4 = chybí jméno souboru
  • 5 = došlo k přejmenování souboru v důsledku duplicitního názvu. 

NAME = jméno souboru (v případě ERROR = 5 jedná se o nové jméno souboru

NAME_ORIG = jméno souboru (původní)

ID_FOLDER = ID složky, kam byl soubor uložen. 0 = kořenový adresář

ID_FILE = ID uloženého souboru