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

Сигнатура

public getMessage(string $mailbox, int $id, string $section, string &$error) : string|false

Описание

Возвращает сообщение

Параметры

$mailbox string

Имя почтового ящика.

$id int

Идентификатор сообщения.

$section string

Раздел сообщения.

$error string

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

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

string|false

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

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

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

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

Loader::includeModule('mail');

/** @var Imap $object */
$mailbox = '';
$id = 1;
$section = '';
$error = '';
$result = $object->getMessage($mailbox, $id, $section, $error);
// $result: string|false

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

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