Mail API (1.0.0)

Download OpenAPI specification:Download

Mail API

Mail

Show version of server

Show version of server

Responses

Response samples

Content type
application/json
{
  • "version": "13.1.0.0 (2021-03-10)",
  • "id": "24213sdafasdfsadf234234sadf",
  • "ok": true
}

Return the list of uploaded items

Return the list of uploaded items

Request Body schema: application/json

Parameters for uploads.list

token
required
string

Auth token

Responses

Request samples

Content type
application/json
{
  • "token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df"
}

Response samples

Content type
application/json
{
  • "list": [
    ],
  • "ok": true
}

Upload a new file

Upload a new file

Request Body schema: application/json

Parameters for uploads.add

token
required
string

Auth token

file
string

File contents via multipart/form-data. (If omitting this parameter, you must provide a content)

content
string

File contents via a POST variable. (If omitting this parameter, you must provide a file)

filename
string

New name of the file

filetype
string

Type of the file, if not present filetype is recognized from extension

Responses

Request samples

Content type
application/json
{
  • "token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
  • "file": "sample_value",
  • "content": "sample_value",
  • "filename": "Sample Name",
  • "filetype": "sample_value"
}

Response samples

Content type
application/json
{
  • "item": {
    },
  • "ok": true
}

Delete an uploaded file

Delete an uploaded file

Request Body schema: application/json

Parameters for uploads.delete

token
required
string

Auth token

upload_id
required
string

Upload id

Responses

Request samples

Content type
application/json
{
  • "token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
  • "upload_id": "sample-id-12345"
}

Response samples

Content type
application/json
{
  • "ok": true
}

List group roots

List group roots

Request Body schema: application/json

Parameters for groups.list

token
required
string

Auth token

Responses

Request samples

Content type
application/json
{
  • "token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df"
}

Response samples

Content type
application/json
{
  • "ok": true
}

List folders

List folders

Request Body schema: application/json

Parameters for folders.list

token
required
string

Auth token

folder
string

Root folder to list folders from

level
string

Level type, "one" - one level, "*" - all levels

Responses

Request samples

Content type
application/json
{
  • "token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
  • "folder": "Group",
  • "level": "one"
}

Response samples

Content type
application/json
{
  • "ok": true
}

Create a new folder

Create a new folder

Request Body schema: application/json

Parameters for folders.add

token
required
string

Auth token

folder
required
string

Root folder to create the new folder under

name
required
string

New folder name

Responses

Request samples

Content type
application/json
{
  • "token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
  • "folder": "Group",
  • "name": "Test"
}

Response samples

Content type
application/json
{
  • "ok": true
}

Delete a folder

Delete a folder

Request Body schema: application/json

Parameters for folders.delete

token
required
string

Auth token

folder
required
string

Folder to delete

Responses

Request samples

Content type
application/json
{
  • "token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
  • "folder": "Group"
}

Response samples

Content type
application/json
{
  • "ok": true
}

Rename a folder

Rename a folder

Request Body schema: application/json

Parameters for folders.rename

token
required
string

Auth token

folder
required
string

Folder to rename

name
required
string

New folder name

Responses

Request samples

Content type
application/json
{
  • "token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
  • "folder": "Group/Test",
  • "name": "Ahoj"
}

Response samples

Content type
application/json
{
  • "ok": true
}

Move a folder

Move a folder

Request Body schema: application/json

Parameters for folders.move

token
required
string

Auth token

folder
required
string

Folder to move

parent
required
string

New folder parent

Responses

Request samples

Content type
application/json
{
  • "token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
  • "folder": "Test/BBB",
  • "parent": "sample_value"
}

Response samples

Content type
application/json
{
  • "ok": true
}

Get folder information

Get folder information

Request Body schema: application/json

Parameters for folders.info

token
required
string

Auth token

folder
required
string

Folder

Responses

Request samples

Content type
application/json
{
  • "token": "xoxp-fb5de88c55c15614bf30fdb031260274529115e6ab2fe8ab8bb20a6234c3a9df",
  • "folder": "Test/BBB"
}

Response samples

Content type
application/json
{
  • "ok": true
}