mailservice.update
Изменить почтовый сервис
Описание
Метод mailservice.update изменяет параметры существующего почтового сервиса.
Параметры
ID
integer
обязательный
Идентификатор почтового сервиса.
Получить идентификатор можно методом mailservice.list
ACTIVE
string
необязательный
Признак активности сервиса. Допустимые значения:
- Y — да
- N — нет
NAME
string
необязательный
Название сервиса
SERVER
string
необязательный
Адрес IMAP-сервера. В базе сохраняется в нижнем регистре
PORT
integer
необязательный
Порт IMAP-сервера
ENCRYPTION
string
необязательный
Признак защищенного подключения. Допустимые значения:
- Y — да
- N — нет
LINK
string
необязательный
Адрес веб-интерфейса сервиса
ICON
file
необязательный
Логотип сервиса. Можно передать файл или существующий идентификатор файла
SORT
integer
необязательный
Индекс сортировки
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"ID": 31,
"NAME": "Обновленный почтовый сервис",
"ACTIVE": "N",
"SERVER": "imap.my2-mail.ru",
"PORT": 993,
"ENCRYPTION": "Y",
"LINK": "https://mail.my2-mail.ru/",
"SORT": 600
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/mailservice.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"ID": 31,
"NAME": "Обновленный почтовый сервис",
"ACTIVE": "N",
"SERVER": "imap.my2-mail.ru",
"PORT": 993,
"ENCRYPTION": "Y",
"LINK": "https://mail.my2-mail.ru/",
"SORT": 600,
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/mailservice.update
// 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<boolean>({
method: 'mailservice.update',
params: {
ID: 31,
NAME: 'Updated mail service',
ACTIVE: 'N',
SERVER: 'imap.my2-mail.ru',
PORT: 993,
ENCRYPTION: 'Y',
LINK: 'https://mail.my2-mail.ru/',
SORT: 600,
},
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 service updated:', result)
}
} 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 updateMailService() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'mailservice.update',
params: {
ID: 31,
NAME: 'Updated mail service',
ACTIVE: 'N',
SERVER: 'imap.my2-mail.ru',
PORT: 993,
ENCRYPTION: 'Y',
LINK: 'https://mail.my2-mail.ru/',
SORT: 600,
},
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 service updated:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', updateMailService)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.mailservice.update(
bitrix_id=31,
active=True,
name="SDK Mail Service Updated",
server="imap-updated.example.com",
port=993,
encryption=True,
link="https://mail-updated.example.com",
sort=300,
).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(
'mailservice.update',
[
'ID' => 31,
'NAME' => 'Обновленный почтовый сервис',
'ACTIVE' => 'N',
'SERVER' => 'imap.my2-mail.ru',
'PORT' => 993,
'ENCRYPTION' => 'Y',
'LINK' => 'https://mail.my2-mail.ru/',
'SORT' => 600,
]
);
$result = $response->getResponseData()->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
BX24.callMethod(
'mailservice.update',
{
ID: 31,
NAME: 'Обновленный почтовый сервис',
ACTIVE: 'N',
SERVER: 'imap.my2-mail.ru',
PORT: 993,
ENCRYPTION: 'Y',
LINK: 'https://mail.my2-mail.ru/',
SORT: 600
},
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'mailservice.update',
[
'ID' => 31,
'NAME' => 'Обновленный почтовый сервис',
'ACTIVE' => 'N',
'SERVER' => 'imap.my2-mail.ru',
'PORT' => 993,
'ENCRYPTION' => 'Y',
'LINK' => 'https://mail.my2-mail.ru/',
'SORT' => 600,
]
);
print_r($result);
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "mailservice.update", b24.Params{
"ID": 31,
"NAME": "Обновленный почтовый сервис",
"ACTIVE": "N",
"SERVER": "imap.my2-mail.ru",
"PORT": 993,
"ENCRYPTION": "Y",
"LINK": "https://mail.my2-mail.ru/",
"SORT": 600,
})
if err != nil {
return fmt.Errorf("mailservice.update: %w", err)
}
var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("выполнено:", ok)
Ответ
HTTP-статус: 200
{
"result": true,
"time": {
"start": 1774008238,
"finish": 1774008238.539154,
"duration": 0.539154052734375,
"processing": 0,
"date_start": "2026-03-20T15:03:58+03:00",
"date_finish": "2026-03-20T15:03:58+03:00",
"operating_reset_at": 1774008838,
"operating": 0
}
}
Возвращаемые данные
result
boolean
true, если сервис успешно обновлен
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": "ERROR_CORE",
"error_description": "Не найден почтовый сервис"
}
| Код | Описание | Значение |
|---|---|---|
400 |
ERROR_CORE |
Доступ запрещен |
400 |
ERROR_CORE |
Не указан ID почтового сервиса |
400 |
ERROR_CORE |
Не найден почтовый сервис |
400 |
ERROR_CORE |
Неправильное значение для "*название_поля*" |

