deleteMessages

Удаляет письма из ящика: переносит в «Корзину», как почтовая программа. Насовсем — письма из «Корзины», с permanent: true и в ящике без «Корзины». У собеседника письмо остаётся: удаления у адресата у почты нет.

Параметры

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

Письмо — в «Корзину»:

curl

curl -X POST "$GRATIO_URL/waInstance$GRATIO_ID/deleteMessages/$GRATIO_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{"folder": "inbox", "uids": [1537]}'

Python

import os
import requests

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

url = f"{BASE}/deleteMessages/{TOKEN}"
payload = {"folder": "inbox", "uids": [1537]}
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}/deleteMessages/${GRATIO_TOKEN}`;
const payload = { folder: "inbox", uids: [1537] };
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 . '/deleteMessages/' . getenv('GRATIO_TOKEN');
$payload = ['folder' => 'inbox', 'uids' => [1537]];

$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:

{"deleted": 1}

Поля ответа

Ещё примеры

Насовсем

Письмо удаляется без «Корзины», вернуть его нельзя:

curl -X POST "$GRATIO_URL/waInstance$GRATIO_ID/deleteMessages/$GRATIO_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{"folder": "spam", "uids": [94, 95], "permanent": true}'

Особенности серверов

Удаление насовсем помечает письма \Deleted и стирает их. Если у сервера нет возможности UIDPLUS, вместе с ними сотрутся другие письма этой папки, которые уже помечены \Deleted в почтовой программе. Что умеет сервер — serverCapabilities в getMailboxInfo.

Ошибки

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

Что дальше

• moveMessages — перенести письма в архив вместо удаления.
• deleteFolder — удалить папку целиком.