mail.message.movetofolder
Переместить письма в папку
Описание
Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.
Метод mail.message.movetofolder перемещает письма в папку, спам или корзину.
Параметры
messageIds
array
обязательный
Массив идентификаторов писем.
Идентификаторы можно получить методом mail.message.list.
Передавайте в одном запросе письма только из одной папки и одного почтового ящика
action
string
обязательный
Действие для писем:
move— переместить в папку, указанную вfolderspam— переместить в спамdelete— переместить в корзину
folder
string
необязательный
Имя или путь существующей папки в этом почтовом ящике.
Обязательно для действия move
Примеры запроса
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('Moved count:', result.movedCount, 'Action:', result.action, 'Success:', result.success)
}
} 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('Moved count:', result.movedCount, 'Action:', result.action, 'Success:', result.success)
} 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}")
try {
$response = $b24Service
->core
->call(
'mail.message.movetofolder',
[
'messageIds' => [15, 16],
'action' => 'spam'
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error: ' . $e->getMessage();
}
BX24.callMethod(
'mail.message.movetofolder',
{
messageIds: [15, 16],
action: 'spam'
},
function(result){
console.info(result.data());
console.log(result);
}
);
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
object
Объект с результатом перемещения
success
boolean
Признак успешного выполнения операции
movedCount
integer
Количество обработанных писем
action
string
Выполненное действие
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
"message": "Ошибка при валидации объекта запроса",
"validation": [
{
"message": "Обязательное поле не указано",
"field": "messageIds"
}
]
}
}
| Код | Описание | Значение |
|---|---|---|
Поле |
Описание ошибки | Как исправить |
messageIds |
Обязательное поле не указано | Передайте messageIds в теле запроса |
messageIds |
Выберите письма из одной папки | Передавайте в одном запросе письма только из одной папки |
folder |
Параметр folder обязателен при action=move |
Передайте folder или используйте action=spam / action=delete |
action |
Параметр action должен быть move, spam или delete |
Передайте одно из допустимых значений |
messageIds |
No accessible messages found | Передайте существующие идентификаторы писем, к которым у пользователя есть доступ |
messageIds |
All messages must belong to the same mailbox | Передавайте в запросе письма только из одного почтового ящика |

