Imap::listMailboxes() — параметры и описание

Сигнатура

public listMailboxes(string $pattern, string &$error[, mixed $flat = false ]) : array<string|int, mixed>|false

Описание

Возвращает список почтовых ящиков

Параметры

$pattern string

Шаблон имени почтового ящика.

$error string

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

$flat mixed = false

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

array<string|int, mixed>|false

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

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

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

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

Loader::includeModule('mail');

/** @var Imap $object */
$pattern = '';
$error = '';
$result = $object->listMailboxes($pattern, $error);
// $result: array<string|int, mixed>|false

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

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