# mailservice.add

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

Создать почтовый сервис
Scope: `mailservice`
Кто может выполнять метод: администратор

## Описание

Метод `mailservice.add` создает почтовый сервис для текущего Битрикс24.

## Параметры

- `NAME` `string` — обязательный. Название почтового сервиса
- `ACTIVE` `string` — необязательный. Признак активности сервиса. Допустимые значения:
  - `Y` — да
  - `N` — нет
  Значение по умолчанию: `Y`
- `SERVER` `string` — необязательный. Адрес IMAP-сервера. В базе сохраняется в нижнем регистре
- `PORT` `integer` — необязательный. Порт IMAP-сервера
- `ENCRYPTION` `string` — необязательный. Признак защищенного подключения. Допустимые значения:
  - `Y` — да
  - `N` — нет
- `LINK` `string` — необязательный. Адрес веб-интерфейса почтового сервиса
- `ICON` `file` — необязательный. Логотип сервиса. Можно передать файл или существующий идентификатор файла
- `SORT` `integer` — необязательный. Индекс сортировки. Значение по умолчанию: `100`

## Ответ

HTTP-статус: 200

```json
{
    "result": 31,
    "time": {
        "start": 1774005930,
        "finish": 1774005930.256403,
        "duration": 0.25640296936035156,
        "processing": 0,
        "date_start": "2026-03-20T14:25:30+03:00",
        "date_finish": "2026-03-20T14:25:30+03:00",
        "operating_reset_at": 1774006530,
        "operating": 0
    }
}
```

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

- `result` `integer`. Идентификатор созданного почтового сервиса
- `time` `time`. Информация о времени выполнения запроса

## Ошибки

HTTP-статус: 400

```json
{
    "error": "ERROR_CORE",
    "error_description": "Доступ запрещен"
}
```

- `400` — `ERROR_CORE`. Доступ запрещен
- `400` — `ERROR_CORE`. Не заполнено обязательное поле "Название"
- `400` — `ERROR_CORE`. Неправильное значение для "*название_поля*"

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

### cURL (Webhook)

```bash
curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "NAME": "Мой почтовый сервис",
    "ACTIVE": "Y",
    "SERVER": "imap.my-mail.ru",
    "PORT": 993,
    "ENCRYPTION": "Y",
    "LINK": "https://mail.my-mail.ru/",
    "SORT": 500
  }' \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/mailservice.add
```

### cURL (OAuth)

```bash
curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "NAME": "Мой почтовый сервис",
    "ACTIVE": "Y",
    "SERVER": "imap.my-mail.ru",
    "PORT": 993,
    "ENCRYPTION": "Y",
    "LINK": "https://mail.my-mail.ru/",
    "SORT": 500,
    "auth": "**put_access_token_here**"
  }' \
  https://**put_your_bitrix24_address**/rest/mailservice.add
```

### 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

try {
  const response = await $b24.actions.v2.call.make<number>({
    method: 'mailservice.add',
    params: {
      NAME: 'My mail service',
      ACTIVE: 'Y',
      SERVER: 'imap.my-mail.ru',
      PORT: 993,
      ENCRYPTION: 'Y',
      LINK: 'https://mail.my-mail.ru/',
      SORT: 500,
    },
    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('Created mail service ID:', 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 addMailService() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'mailservice.add',
        params: {
          NAME: 'My mail service',
          ACTIVE: 'Y',
          SERVER: 'imap.my-mail.ru',
          PORT: 993,
          ENCRYPTION: 'Y',
          LINK: 'https://mail.my-mail.ru/',
          SORT: 500,
        },
        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('Created mail service ID:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

### Python

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

try:
    bitrix_response = client.mailservice.add(
        name="SDK Mail Service",
        encryption=True,
        active=True,
        server="imap.example.com",
        port=993,
        link="https://mail.example.com",
        sort=200,
    ).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.add',
            [
                'NAME' => 'Мой почтовый сервис',
                'ACTIVE' => 'Y',
                'SERVER' => 'imap.my-mail.ru',
                'PORT' => 993,
                'ENCRYPTION' => 'Y',
                'LINK' => 'https://mail.my-mail.ru/',
                'SORT' => 500,
            ]
        );

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

### BX24.js

```js
BX24.callMethod(
    'mailservice.add',
    {
        NAME: 'Мой почтовый сервис',
        ACTIVE: 'Y',
        SERVER: 'imap.my-mail.ru',
        PORT: 993,
        ENCRYPTION: 'Y',
        LINK: 'https://mail.my-mail.ru/',
        SORT: 500
    },
    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.add',
    [
        'NAME' => 'Мой почтовый сервис',
        'ACTIVE' => 'Y',
        'SERVER' => 'imap.my-mail.ru',
        'PORT' => 993,
        'ENCRYPTION' => 'Y',
        'LINK' => 'https://mail.my-mail.ru/',
        'SORT' => 500,
    ]
);

print_r($result);
```

### Go

```go
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "mailservice.add", b24.Params{
	"NAME":       "Мой почтовый сервис",
	"ACTIVE":     "Y",
	"SERVER":     "imap.my-mail.ru",
	"PORT":       993,
	"ENCRYPTION": "Y",
	"LINK":       "https://mail.my-mail.ru/",
	"SORT":       500,
})
if err != nil {
	return fmt.Errorf("mailservice.add: %w", err)
}

var newID b24.ID
if err := json.Unmarshal(res.Result, &newID); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("идентификатор:", newID)
```

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