method public

Smtp::authenticate()

Сигнатура

public authenticate(array<string|int, mixed> &$error) : bool

Описание

Аутентифицируется на сервере отправки.

Параметры

$error array<string|int, mixed>

Будет заполнено ошибками аутентификации.

Возвращаемое значение

bool

Как применяется в Smtp

Smtp::authenticate() — метод класса \Bitrix\Mail\Smtp модуля «Почта».

Метод объекта: сначала нужен экземпляр Smtp.

use Bitrix\Main\Loader;
use Bitrix\Mail\Smtp;

Loader::includeModule('mail');

/** @var Smtp $object */
$error = [];
$result = $object->authenticate($error);
// $result: bool

Другие методы Smtp

__destruct() Отключается от сервера отправки.
connect() Подключается к серверу отправки.
decodeError() Возвращает сообщение об ошибке по коду.
getErrors() Возвращает все ошибки SMTP-клиента.
setIsOauth() Задаёт флаг необходимости подключения через OAuth

authenticate() есть и у других классов модуля «Почта»: Imap.

Исходный файл: source/mail/lib/smtp.php:248