getFolders

Возвращает все папки ящика: имя на сервере, название, роль, флаги. С withCounts — ещё сколько в папке писем и непрочитанных.

Параметры

Пример запроса

Папки со счётчиками:

curl

curl -X POST "$GRATIO_URL/waInstance$GRATIO_ID/getFolders/$GRATIO_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{"withCounts": true}'

Python

import os
import requests

BASE = f"{os.environ['GRATIO_URL']}/waInstance{os.environ['GRATIO_ID']}"
TOKEN = os.environ["GRATIO_TOKEN"]

url = f"{BASE}/getFolders/{TOKEN}"
payload = {"withCounts": True}
response = requests.post(url, json=payload, timeout=60)
print(response.status_code, response.json())

Node.js

const { GRATIO_URL, GRATIO_ID, GRATIO_TOKEN } = process.env;
const base = `${GRATIO_URL}/waInstance${GRATIO_ID}`;

const url = `${base}/getFolders/${GRATIO_TOKEN}`;
const payload = { withCounts: true };
const response = await fetch(url, {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify(payload),
});
console.log(response.status, await response.json());

PHP

<?php
$base = getenv('GRATIO_URL') . '/waInstance' . getenv('GRATIO_ID');
$url = $base . '/getFolders/' . getenv('GRATIO_TOKEN');
$payload = ['withCounts' => true];

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => ['Content-Type: application/json'],
    CURLOPT_POSTFIELDS => json_encode($payload, JSON_UNESCAPED_UNICODE),
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 60,
]);
$response = json_decode(curl_exec($ch), true);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), PHP_EOL;
print_r($response);

Пример ответа

Ответ 200 OK — массив папок:

[
  {"folder": "INBOX", "title": "INBOX", "role": "inbox", "flags": ["\\hasnochildren"], "delimiter": "/", "selectable": true,
   "messages": 1532, "unseen": 14, "uidNext": 1541, "uidValidity": 1700000000},
  {"folder": "Sent", "title": "Sent", "role": "sent", "flags": ["\\hasnochildren", "\\sent"], "delimiter": "/", "selectable": true,
   "messages": 611, "unseen": 0, "uidNext": 612, "uidValidity": 1700000001},
  {"folder": "Drafts", "title": "Drafts", "role": "drafts", "flags": ["\\drafts", "\\hasnochildren"], "delimiter": "/", "selectable": true,
   "messages": 3, "unseen": 0, "uidNext": 89, "uidValidity": 1700000002},
  {"folder": "Trash", "title": "Trash", "role": "trash", "flags": ["\\hasnochildren", "\\trash"], "delimiter": "/", "selectable": true,
   "messages": 40, "unseen": 0, "uidNext": 301, "uidValidity": 1700000003},
  {"folder": "Spam", "title": "Spam", "role": "spam", "flags": ["\\hasnochildren", "\\junk"], "delimiter": "/", "selectable": true,
   "messages": 7, "unseen": 7, "uidNext": 95, "uidValidity": 1700000004},
  {"folder": "Archive", "title": "Archive", "role": "archive", "flags": ["\\archive", "\\haschildren"], "delimiter": "/", "selectable": true,
   "messages": 820, "unseen": 0, "uidNext": 821, "uidValidity": 1700000005},
  {"folder": "Archive/&BBcEMARPBDIEOgQ4-", "title": "Archive/Заявки", "role": null, "flags": ["\\hasnochildren"], "delimiter": "/", "selectable": true,
   "messages": 56, "unseen": 2, "uidNext": 57, "uidValidity": 1700000006}
]

Поля ответа

Без withCounts полей messages, unseen, uidNext и uidValidity в ответе нет.

В запросах папку указывают ролью, именем folder или названием title — см. Почта через API.

Ошибки

Общие правила — в статье Ответы и ошибки.

Что дальше

• getMessages — письма папки.
• createFolder — создать папку.
• getMailboxInfo — роли папок и возможности сервера.