Beget.API: почтовые ящики

by Beget

Получайте список ящиков заданного домена и проверяйте для каждого состояние спам-фильтра и пересылки.

⚙️ Администрирование
Компания
Beget
Сайт компании
beget.com ↗
Адрес API
https://api.beget.com/api ↗

Что делает API

Раздел mail управляет почтовыми ящиками на доменах аккаунта. Метод getMailboxList принимает domain и возвращает локальное имя ящика, домен, состояние спам-фильтра и режим пересылки. Отдельные методы раздела могут менять пароль, настройки переадресации и сами ящики; этот API не является SMTP-интерфейсом для отправки почты.

Когда использовать

  • Показывать администратору список почтовых адресов домена и состояние их фильтрации.
  • Сверять, какие ящики перенаправляют письма, перед миграцией почтовой конфигурации.
  • Автоматизировать инвентаризацию почты по доменам аккаунта без чтения содержимого сообщений.

Подключение и ограничения

Авторизация
Требуются login аккаунта и отдельный пароль Beget.API; включите API в панели. IP-фильтр аккаунта распространяется на API. Передавайте запрос по HTTPS; для метода используйте input_format=json, output_format=json и URL-кодированный input_data. POST рекомендуется общей документацией API.
Что учесть
getMailboxList требует domain и возвращает массив ящиков с mailbox, domain, spam_filter_status и forward_mail_status. Изменяющие методы, включая смену пароля, не подходят для проверки интеграции. Общий лимит Beget.API — не более 60 запросов в минуту на пользователя; распределите его между всеми разделами интеграции.

Пример использования

Подготовьте доступ по инструкции выше и замените параметры своими. Пример не выполняется на этой странице.

# Замените example.com на домен своего аккаунта.
# Задайте BEGET_LOGIN и BEGET_API_PASSWORD в окружении.
curl --silent --show-error --fail-with-body --request POST 'https://api.beget.com/api/mail/getMailboxList' \
  --data-urlencode "login=${BEGET_LOGIN:?Укажите логин аккаунта}" \
  --data-urlencode "passwd=${BEGET_API_PASSWORD:?Укажите пароль API}" \
  --data-urlencode 'input_format=json' \
  --data-urlencode 'output_format=json' \
  --data-urlencode 'input_data={"domain":"example.com"}'
Результат
Сначала проверьте status и answer.status: оба должны быть success. Поле answer.result содержит список объектов ящиков: mailbox, domain, spam_filter_status и forward_mail_status. В примере документации состояния пересылки — no_forward, forward и forward_and_delete; сами письма не возвращаются.
Ошибки
При status=error проверьте error_code и error_text: AUTH_ERROR означает ошибку доступа, INCORRECT_REQUEST — некорректный запрос, NO_SUCH_METHOD — неверный путь метода. При answer.status=error разберите answer.errors; LIMIT_ERROR может означать лимит ресурсов или частоты запросов, поэтому одного повторения запроса недостаточно.

Сверено с документацией: .

Порядок интеграции

  1. Включить Beget.API и использовать отдельный пароль API.
  2. Вызвать mail/getMailboxList с domain в JSON-параметре input_data.
  3. Обработать mailbox, domain, spam_filter_status и forward_mail_status.
  4. Если потребуется изменение пароля или пересылки, использовать соответствующий метод документации после проверки адреса и домена.

Что проверить перед запуском

  • Список запрашивается для одного домена, который передаётся в domain.
  • forward_mail_status имеет строковые состояния, включая no_forward, forward и forward_and_delete; не приводите их к boolean без сохранения исходного значения.
  • Раздел управляет ящиками, но не предоставляет в описанном методе чтение писем или отправку SMTP.
О компании

Хостинг-провайдер, предлагающий услуги по размещению сайтов и их обслуживанию. Компания обеспечивает стабильную работу серверов, предоставляет различные тарифные планы и помогает клиентам с настройкой и оптимизацией сайтов.

Связанные API