Получить список почтовых сервисов mailservice.list

Scope: mailservice

Кто может выполнять метод: любой пользователь

Метод mailservice.list возвращает список активных почтовых сервисов.

Параметры метода

Без параметров.

Примеры кода

Как использовать примеры в документации

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/mailservice.list

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"auth": "**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/mailservice.list

try
        {
        	const response = await $b24.callMethod('mailservice.list', {});
        	console.log(response.getData().result);
        }
        catch (error)
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call('mailservice.list', []);
        
            $result = $response->getResponseData()->getResult();
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }

BX24.callMethod(
            'mailservice.list',
            {},
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call('mailservice.list', []);
        print_r($result);

Обработка ответа

HTTP-статус: 200

{
            "result": [
                {
                    "ID": "1",
                    "SITE_ID": "s1",
                    "ACTIVE": "Y",
                    "SORT": "100",
                    "NAME": "gmail",
                    "SERVER": "imap.gmail.com",
                    "PORT": "993",
                    "ENCRYPTION": "Y",
                    "LINK": "https://mail.google.com/",
                    "ICON": "https://cdn-ru.bitrix24.ru/b17053/mail/mailservices/icon/ac0/ac08d334f35100d98c1a628f4f57f25c/post_gmail_icon.png",
                    "SMTP_SERVER": "smtp.gmail.com",
                    "SMTP_PORT": "465",
                    "SMTP_LOGIN_AS_IMAP": "Y",
                    "SMTP_PASSWORD_AS_IMAP": "Y",
                    "SMTP_ENCRYPTION": "Y",
                    "UPLOAD_OUTGOING": "N"
                },
                ... // описание для каждого почтового сервиса
            ],
            "time": {
                "start": 1774009798,
                "finish": 1774009798.248488,
                "duration": 0.2484879493713379,
                "processing": 0,
                "date_start": "2026-03-20T15:29:58+03:00",
                "date_finish": "2026-03-20T15:29:58+03:00",
                "operating_reset_at": 1774010398,
                "operating": 0
            }
        }

Возвращаемые данные

Название
тип

Описание

result
object[]

Массив объектов с информацией о почтовых сервисах.

Структура объекта почтового сервиса подробно описана ниже

time
time

Информация о времени выполнения запроса

Объект mailservice

Название `тип`	Описание
ID `integer`	Идентификатор почтового сервиса
SITE_ID `string`	Идентификатор сайта в Битрикс24
ACTIVE `string`	Активность сервиса, значения `Y` или `N`
SORT `integer`	Индекс сортировки
NAME `string`	Название сервиса
SERVER `string`	Адрес IMAP-сервера в нижнем регистре
PORT `integer`	Порт IMAP-сервера
ENCRYPTION `string`	Признак защищенного подключения, значения `Y` или `N`
LINK `string`	Адрес веб-интерфейса сервиса
ICON `string`	Путь к изображению логотипа сервиса
SMTP_SERVER `string`\|`null`	SMTP-сервер, если он настроен
SMTP_PORT `integer`\|`null`	SMTP-порт, если он настроен
SMTP_LOGIN_AS_IMAP `string`	Использовать IMAP-логин для SMTP, значения `Y` или `N`
SMTP_PASSWORD_AS_IMAP `string`	Использовать IMAP-пароль для SMTP, значения `Y` или `N`
SMTP_ENCRYPTION `string`\|`null`	Признак защищенного SMTP-подключения, значения `Y` или `N`
UPLOAD_OUTGOING `string`\|`null`	Признак загрузки исходящих писем, значения `Y` или `N`

Обработка ошибок

HTTP-статус: 400

{
            "error": "ERROR_CORE",
            "error_description": "Не найдены почтовые сервисы"
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Статус	Код	Описание	Значение
`400`	ERROR_CORE	Не найдены почтовые сервисы	Нет активных почтовых сервисов

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	Текущий метод не разрешен для вызова с помощью batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	Превышена максимальная длина параметров, переданных в метод batch
`401`	`NO_AUTH_FOUND` Wrong authorization data	Неверный access-токен или код вебхука
`400`	`INVALID_REQUEST` Https required	Для вызовов методов требуется использовать протокол HTTPS
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	REST API доступен только на коммерческих планах
`403`	`INVALID_CREDENTIALS` Invalid request credentials	У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	Манифест недоступен
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более высоких привилегий, чем предоставляет токен вебхука
`401`	`expired_token` The access token provided has expired	Предоставленный access-токен доступа истек
`403`	`user_access_error` The user does not have access to the application	Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям
`500`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Получить параметры почтового сервиса

Удалить почтовый сервис

Получить список почтовых сервисов mailservice.list

Параметры методаПараметры метода

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

Возвращаемые данныеВозвращаемые данные

Объект mailserviceОбъект mailservice

Обработка ошибокОбработка ошибок

Возможные коды ошибокВозможные коды ошибок

Статусы и коды системных ошибокСтатусы и коды системных ошибок

Продолжите изучениеПродолжите изучение