mail.mailbox.get
Получить почтовый ящик
Описание
Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.
Метод mail.mailbox.get возвращает почтовый ящик по идентификатору.
Параметры
id
integer
обязательный
Идентификатор почтового ящика.
Идентификатор можно получить методом mail.mailbox.list
select
array
необязательный
Список полей почтового ящика, которые нужно вернуть.
Доступные поля:
- id — идентификатор почтового ящика
- name — имя почтового ящика
- email — электронная почта
- senderName — имя отправителя
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":1,"select":["id","name","email","senderName"]}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/mail.mailbox.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":1,"select":["id","name","email","senderName"],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/mail.mailbox.get
// 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 MailboxGetResult = {
item: {
id: number
name: string
email: string
senderName: string
}
}
try {
const response = await $b24.actions.v3.call.make<MailboxGetResult>({
method: 'mail.mailbox.get',
params: {
id: 1,
select: [
'id',
'name',
'email',
'senderName',
],
},
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(result.item.id, result.item.name, result.item.email, result.item.senderName)
}
} 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 getMailbox() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v3.call.make({
method: 'mail.mailbox.get',
params: {
id: 1,
select: [
'id',
'name',
'email',
'senderName',
],
},
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(result.item.id, result.item.name, result.item.email, result.item.senderName)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getMailbox)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
select = [
"id",
"name",
"email",
"senderName",
]
try:
bitrix_response = client.mail.mailbox.get(
bitrix_id=1,
select=select,
).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.mailbox.get',
[
'id' => 1,
'select' => [
'id',
'name',
'email',
'senderName'
]
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error: ' . $e->getMessage();
}
BX24.callMethod(
'mail.mailbox.get',
{
id: 1,
select: [
'id',
'name',
'email',
'senderName'
]
},
function(result){
console.info(result.data());
console.log(result);
}
);
require_once('crest.php');
$result = CRest::call(
'mail.mailbox.get',
[
'id' => 1,
'select' => [
'id',
'name',
'email',
'senderName'
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "mail.mailbox.get", b24.Params{
"id": 1,
"select": []string{"id", "name", "email", "senderName"},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("mail.mailbox.get: %w", err)
}
// Метод заворачивает ответ в объект с ключом "item".
raw, ok := b24.Unwrap(res.Result, "item")
if !ok {
return fmt.Errorf("в ответе нет ключа item")
}
var item struct {
ID b24.ID `json:"id"`
Name string `json:"name"`
Email string `json:"email"`
SenderName string `json:"senderName"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.Name)
Ответ
HTTP-статус: 200
{
"result": {
"item": {
"id": 1,
"name": "Рабочая почта",
"email": "user@example.com",
"senderName": "Иван Петров"
}
},
"time": {
"start": 1779819427,
"finish": 1779819427.356922,
"duration": 0.356921911239624,
"processing": 0,
"date_start": "2026-05-26T21:17:07+03:00",
"date_finish": "2026-05-26T21:17:07+03:00",
"operating_reset_at": 1779820027,
"operating": 0
}
}
Возвращаемые данные
result
object
Объект с данными ответа
item
object
Объект почтового ящика. Структура ответа зависит от select
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION",
"message": "Запись с ID = `1` не найдена"
}
}
| Код | Описание | Значение |
|---|---|---|
Поле |
Описание ошибки | Как исправить |
id |
Обязательное поле id не указано |
Добавьте id в тело запроса |

