moveEmails

Переносит письма в другую папку — из одной или из разных. В ответе — новые номера писем в папке назначения, если сервер их сообщает. idMessage письма при переносе не меняется.

Параметры

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

Два письма из «Входящих» — в папку «Заявки»:

curl

curl -X POST "$GRATIO_URL/v1/instances/$GRATIO_ID/moveEmails" \
  -H "Authorization: Bearer $GRATIO_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{"folder": "inbox", "uids": [1532, 1540], "to": "Заявки"}'

Python

import os
import requests

BASE = f"{os.environ['GRATIO_URL']}/v1/instances/{os.environ['GRATIO_ID']}"
HEADERS = {"Authorization": f"Bearer {os.environ['GRATIO_TOKEN']}"}

url = f"{BASE}/moveEmails"
payload = {"folder": "inbox", "uids": [1532, 1540], "to": "Заявки"}
response = requests.post(url, json=payload, headers=HEADERS, timeout=60)
print(response.status_code, response.json())

Node.js

const { GRATIO_URL, GRATIO_ID, GRATIO_TOKEN } = process.env;
const base = `${GRATIO_URL}/v1/instances/${GRATIO_ID}`;
const auth = { Authorization: `Bearer ${GRATIO_TOKEN}` };

const url = `${base}/moveEmails`;
const payload = { folder: "inbox", uids: [1532, 1540], to: "Заявки" };
const response = await fetch(url, {
  method: "POST",
  headers: { ...auth, "Content-Type": "application/json" },
  body: JSON.stringify(payload),
});
console.log(response.status, await response.json());

PHP

<?php
$base = getenv('GRATIO_URL') . '/v1/instances/' . getenv('GRATIO_ID');
$auth = 'Authorization: Bearer ' . getenv('GRATIO_TOKEN');
$url = $base . '/moveEmails';
$payload = ['folder' => 'inbox', 'uids' => [1532, 1540], 'to' => 'Заявки'];

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => [$auth, '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": "&BBcEMARPBDIEOgQ4-",
  "moved": [
    {"folder": "INBOX", "uid": 1532, "newUid": 57},
    {"folder": "INBOX", "uid": 1540, "newUid": 58}
  ]
}

Поля ответа

Письма, которые уже лежат в папке to, остаются на месте и в moved не попадают.

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

• newUid сообщает сервер с возможностью UIDPLUS. Без неё указывайте перенесённое письмо по idMessage или messageId.
• Без возможности MOVE Gratio копирует письма, помечает их \Deleted и удаляет в старой папке. Если у сервера нет и UIDPLUS, вместе с ними удалятся другие письма этой папки, уже помеченные \Deleted в почтовой программе.

Что умеет сервер — serverCapabilities в getMailboxInfo.

Ошибки

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

Что дальше

• copyEmails — скопировать, оставив письма на месте.
• deleteEmails — удалить письма.
• createFolder — создать папку назначения.