# Imap::listMailboxes()

URL: https://chugunov.pro/api-bitrix/mail/imap/listmailboxes/
Проверено на 1С-Битрикс 25.x, обновлено 03.08.2026.
Источник: независимый русскоязычный справочник chugunov.pro. Не является официальной документацией 1С-Битрикс.

Класс: [`\Bitrix\Mail\Imap`](https://chugunov.pro/api-bitrix/mail/imap/)
Модуль: Mail.
Свойства элемента: method, public.

## Сигнатура

```php
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`

Оригинал в официальной документации: https://docs.1c-bitrix.ru/api/classes/Bitrix-Mail-Imap.html
