# mailservice.list

URL: https://chugunov.pro/api-bitrix24/mailservice/mailservice-list/
Проверено на Битрикс24 REST API, обновлено 11.09.2026 (ревизия источника fb39d6c).
Источник: официальная документация Битрикс24 (bitrix-tools/b24-rest-docs, лицензия MIT, © Bitrix). Справочник независимый, официальной документацией не является.

Получить список почтовых сервисов
Scope: `mailservice`
Кто может выполнять метод: любой пользователь

## Описание

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

## Ответ

HTTP-статус: 200

```json
{
    "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[]`. Массив объектов с информацией о почтовых сервисах. 
  Структура объекта почтового сервиса подробно описана [ниже](#mail-services)
- `time` `time`. Информация о времени выполнения запроса

## Ошибки

HTTP-статус: 400

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

- `400` — ERROR_CORE. Не найдены почтовые сервисы

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

### cURL (Webhook)

```bash
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 (OAuth)

```bash
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
```

### JS (TS)

```ts
// 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 each mail service item returned in result[]
type MailServiceItem = {
  ID: string
  SITE_ID: string
  ACTIVE: string
  SORT: string
  NAME: string
  SERVER: string
  PORT: string
  ENCRYPTION: string
  LINK: string
  ICON: string
  SMTP_SERVER: string | null
  SMTP_PORT: string | null
  SMTP_LOGIN_AS_IMAP: string
  SMTP_PASSWORD_AS_IMAP: string
  SMTP_ENCRYPTION: string | null
  UPLOAD_OUTGOING: string | null
}

try {
  // mailservice.list returns a single page (max 50 records). For the whole result set
  // use a list helper: $b24.actions.v2.callList.make() returns every record as one
  // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
  // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
  // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
  const response = await $b24.actions.v2.call.make<MailServiceItem[]>({
    method: 'mailservice.list',
    params: {
      start: 0,
    },
    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('Mail services:', result.length, result)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
```

### JS (UMD)

```html
<!-- 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 listMailServices() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      // mailservice.list returns a single page (max 50 records). For the whole result set
      // use a list helper: $b24.actions.v2.callList.make() returns every record as one
      // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
      // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
      // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
      const response = await $b24.actions.v2.call.make({
        method: 'mailservice.list',
        params: {
          start: 0,
        },
        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('Mail services:', result.length, result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', listMailServices)
</script>
```

### Python

```python
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.mailservice.list().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}")
```

### PHP

```php
try {
    $response = $b24Service
        ->core
        ->call('mailservice.list', []);

    $result = $response->getResponseData()->getResult();
    print_r($result);
} catch (Throwable $e) {
    echo $e->getMessage();
}
```

### BX24.js

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

### PHP CRest

```php
require_once('crest.php');

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

### Go

```go
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "mailservice.list", nil, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("mailservice.list: %w", err)
}

// Ответ приходит как json.RawMessage — разберите его
// в структуру под форму ответа, показанную ниже на этой странице.
fmt.Printf("%s\n", res.Result)
```

Оригинал в официальной документации: https://apidocs.bitrix24.ru/api-reference/mailservice/mailservice-list.html