method public

Imap::singin()

Сигнатура

public singin(string &$error) : bool

Описание

Подключается к серверу и аутентифицирует клиента

Параметры

$error string

Сообщение об ошибке.

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

bool

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

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

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

use Bitrix\Main\Loader;
use Bitrix\Mail\Imap;

Loader::includeModule('mail');

/** @var Imap $object */
$error = '';
$result = $object->singin($error);
// $result: bool

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

__destruct()
addMessage() Добавляет сообщение
append()
authenticate()
connect()
copyMailToFolder()
decodeError() Возвращает сообщение об ошибке
delete()
ensureEmpty()
examine()
fetch()
getErrors()

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