Переместить письма в папку mail.message.movetofolder
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
Кто может выполнять метод: пользователь с доступом к почтовому ящику, где находятся письма. Для
action: "delete"дополнительно нужно право на удаление писем
Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.
Метод mail.message.movetofolder перемещает письма в папку, спам или корзину почтового ящика.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
messageIds* |
Непустой массив идентификаторов писем, не больше 100 элементов. Все письма в запросе должны лежать в одной папке. Для Идентификаторы можно получить методом mail.message.list |
|
action* |
Действие с письмами. Регистр важен. Возможные значения:
|
|
folder |
Папка, в которую нужно переместить письма. Обязателен, если Передайте имя папки или полный путь к ней на почтовом сервере, например Если указана папка спама или корзины, метод работает как |
Примеры кода
Как использовать примеры в документации
Вызов нового API отличается добавлением параметра /api/ в запросе:
https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/mail.message.movetofolder
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"messageIds":[15,16],"action":"spam"}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/mail.message.movetofolder
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"messageIds":[15,16],"action":"spam","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/mail.message.movetofolder
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type MoveToFolderResult = {
success: boolean
movedCount: number
action: string
}
try {
const response = await $b24.actions.v3.call.make<MoveToFolderResult>({
method: 'mail.message.movetofolder',
params: {
messageIds: [15, 16],
action: 'spam',
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Обработано писем:', result.movedCount, 'Действие:', result.action)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function moveToFolder() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v3.call.make({
method: 'mail.message.movetofolder',
params: {
messageIds: [15, 16],
action: 'spam',
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Обработано писем:', result.movedCount, 'Действие:', result.action)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', moveToFolder)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.mail.message.movetofolder(
message_ids=[
15,
16,
],
action='spam',
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.
try {
$response = $b24Service
->core
->call(
'mail.message.movetofolder',
[
'messageIds' => [15, 16],
'action' => 'spam'
]
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.
BX24.callMethod(
'mail.message.movetofolder',
{
messageIds: [15, 16],
action: 'spam'
},
result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.
require_once('crest.php');
$result = CRest::call(
'mail.message.movetofolder',
[
'messageIds' => [15, 16],
'action' => 'spam'
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "mail.message.movetofolder", b24.Params{
"messageIds": []int{15, 16},
"action": "spam",
})
if err != nil {
return fmt.Errorf("mail.message.movetofolder: %w", err)
}
var item struct {
Success bool `json:"success"`
MovedCount int `json:"movedCount"`
Action string `json:"action"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.Success, item.MovedCount)
Обработка ответа
HTTP-статус: 200
{
"result": {
"success": true,
"movedCount": 2,
"action": "spam"
},
"time": {
"start": 1779819678,
"finish": 1779819678.84803,
"duration": 0.8480300903320312,
"processing": 0,
"date_start": "2026-05-26T21:21:18+03:00",
"date_finish": "2026-05-26T21:21:18+03:00",
"operating_reset_at": 1779820278,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Объект с результатом операции |
|
success |
Результат операции. В успешном ответе всегда |
|
movedCount |
Количество обработанных писем. В счет входят только письма, к которым у пользователя есть доступ: недоступные и несуществующие идентификаторы метод пропускает |
|
action |
Выполненное действие: |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400, 403
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
"message": "Ошибка при валидации объекта запроса",
"validation": [
{
"message": "Parameter \"action\" must be \"move\", \"spam\", or \"delete\".",
"field": "INVALID_ACTION"
}
]
}
}
|
Название |
Описание |
|
error.code |
Строковый код ошибки. Используйте для идентификации типа исключения |
|
error.message |
Текстовое описание ошибки |
|
error.validation |
Массив c деталями ошибки. Присутствует только в ошибках валидации данных |
|
error.validation[].field |
Название поля, в котором возникла ошибка валидации |
|
error.validation[].message |
Описание ошибки, связанной с указанным полем |
Возможные коды ошибок
Ошибки валидации запроса
HTTP-статус: 400
Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION
В ответе с этим кодом поле field содержит не имя параметра, а код причины ошибки. У части ошибок поля field нет. Тексты ошибок, которые возвращает почтовый модуль, приходят на языке Битрикс24.
|
Значение field |
Описание ошибки |
Как исправить |
|
|
Parameter "messageIds" is required and must be a non-empty array. |
Передайте |
|
|
Parameter "action" is required. |
Передайте |
|
|
Parameter "action" must be "move", "spam", or "delete". |
Передайте |
|
|
Parameter "folder" is required when action is "move". |
Передайте |
|
нет |
No accessible messages found. |
Ни одно письмо из |
|
нет |
All messages must belong to the same mailbox. |
Для |
|
|
Выберите письма из одной папки |
Письма лежат в разных папках. Разделите запрос по папкам |
|
|
Письмо уже находится в указанной папке |
Письма уже лежат в папке |
|
|
Ящик не найден |
Папка |
|
|
Archive не является папкой |
Папка |
|
|
Не указано, в какую папку перемещать спам |
В настройках почтового ящика не выбрана папка спама. Выберите ее в настройках ящика |
|
|
Не указано, в какую папку перемещать удаленные письма |
В настройках почтового ящика не выбрана папка корзины. Выберите ее в настройках ящика |
|
|
Письма синхронизируются. Попробуйте выполнить это действие позже. |
Письма еще синхронизируются с почтовым сервером. Так бывает с письмами, которые только что отправлены методами |
|
|
Ошибка при синхронизации данных |
Почтовый сервер не выполнил операцию. Повторите запрос позже |
|
|
The mailbox action is unavailable while its migration is active |
Почтовый ящик переносится. Повторите запрос после завершения переноса |
|
|
The mailbox migration status is temporarily unavailable |
Статус переноса ящика временно недоступен. Повторите запрос позже |
Если в messageIds больше 100 элементов, Битрикс24 возвращает HTTP-статус 500 и ошибку INTERNAL_SERVER_ERROR. Разделите письма на несколько запросов.
Ошибка доступа
HTTP-статус: 403
Код ошибки: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Доступ запрещен |
Для |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Приложение Маркетплейса заблокировано, потому что число установленных приложений превышает лимит тарифа. События такому приложению не доставляются. Приложения, освобожденные от лимита, не блокируются |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |