check_smtp_settings
Чтобы проверить настройки SMTP-сервера перед их применением к тарифному плану, используйте метод account/check_smtp_settings.
Этот метод доступен только пользователям верхнего уровня. Для субпользователей возвращается ошибка.
Конечная точка
svc=account/check_smtp_settings¶ms={
"send_from": <text>,
"send_to": <text>,
"smtp_host": <text>,
"smtp_port": <uint>,
"smtp_login": <text>,
"smtp_password": <text>,
"subject": <text>,
"body": <text>
}
Параметры
Запрос должен содержать следующие параметры:
| Параметр | Описание |
|---|---|
| send_from | Адрес электронной почты отправителя. |
| send_to | Адрес электронной почты получателя тестового сообщения. |
| smtp_host | Адрес SMTP-сервера с указанием протокола (например, smtps://smtp.gmail.com или smtp://smtp.example.com). |
| smtp_port | Номер порта SMTP-сервера (например, 465 для SMTPS, 587 для SMTP с STARTTLS). |
| smtp_login | Логин для аутентификации на SMTP-сервере. |
| smtp_password | Пароль для аутентификации на SMTP-сервере. Вместо этого параметра можно использовать параметр plan с названием тарифного плана. Необходимо указать один из этих двух параметров. |
| plan | Название тарифного плана, из которого нужно получить сохраненный пароль SMTP. Вместо этого параметра можно использовать параметр smtp_password. Если указаны оба параметра, используется plan. |
| subject | Тема тестового письма. |
| body | Текст тестового письма. |
Примеры
Ниже приведены примеры запросов account/check_smtp_settings.
Запрос с паролем
svc=account/check_smtp_settings¶ms={
"send_from": "notifications@example.com",
"send_to": "admin@example.com",
"smtp_host": "smtps://smtp.gmail.com",
"smtp_port": 465,
"smtp_login": "notifications@example.com",
"smtp_password": "your_app_password",
"subject": "Test SMTP Connection",
"body": "This is a test email to validate SMTP settings."
}
Запрос с тарифным планом
svc=account/check_smtp_settings¶ms={
"send_from": "notifications@example.com",
"send_to": "admin@example.com",
"smtp_host": "smtps://smtp.gmail.com",
"smtp_port": 465,
"smtp_login": "notifications@example.com",
"plan": "my_billing_plan",
"subject": "Test SMTP Connection",
"body": "This is a test email to validate SMTP settings."
}
Ответ
Если запрос выполнен успешно и тестовое письмо отправлено, в ответе в поле error возвращается код 250:
{
"error": 250
}
Если запрос не выполнен, возвращается код ошибки.
Коды ошибок
| Код ошибки | Описание |
|---|---|
| 600 | Общая ошибка проверки или конфигурации. Этот код может означать одно из следующего:
|
| 800 | Текущий пользователь не является пользователем верхнего уровня или не авторизован. |
| 6 | Не удалось разрешить имя хоста SMTP-сервера. |
| 28 | Истекло время ожидания соединения. Это может произойти, если указан неверный порт. |
| 56 | Не удалось получить данные с сервера. Это может произойти при попытке подключиться к серверу SMTPS по протоколу SMTP. |
| 535 | Неверные учетные данные SMTP (логин или пароль). |
| 555 | Неверный формат адреса электронной почты или нераспознанный символ в поле send_from или send_to. |