imap_fetchstructure

(PHP 4, PHP 5, PHP 7, PHP 8)

imap_fetchstructureЧитает структуру указанного сообщения

Описание

imap_fetchstructure(IMAP\Connection $imap, int $message_num, int $flags = 0): stdClass|false

Извлекает информацию о структуре указанного сообщения.

Список параметров

imap

Экземпляр класса IMAP\Connection.

message_num

Номер сообщения

flags

Если задано как FT_UID, то в message_num должны быть UID сообщений, а не их номера.

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

Возвращает объект со свойствами, перечисленными в таблице ниже или false, если возникла ошибка.

Объект, возвращаемый imap_fetchstructure()
type Первичный тип тела
encoding Кодировка тела
ifsubtype true, если есть строка подтипа
subtype MIME-подтип
ifdescription true, если есть строка описания
description Контент строки описания
ifid true, если есть строка идентификатор
id Строка идентификатор
lines Количество строк
bytes Количество байт
ifdisposition true, если есть строка расположения
disposition Строка расположения
ifdparameters true, если есть массив dparameters
dparameters Массив объектов, каждый из которых имеет свойства "attribute" и "value", соответствующие параметрам Content-disposition заголовка MIME.
ifparameters true, если есть массив параметров
parameters Массив объектов, каждый из которых имеет свойства "attribute" и "value".
parts Массив объектов идентичных по структуре с верхнеуровневым объектом, каждый из которых соответствует MIME части тела.

Первичный тип тела (значения могут отличаться в зависимости от используемой библиотеки, так что рекомендуется использовать константы)
ЗначениеТипКонстанта
0textTYPETEXT
1multipartTYPEMULTIPART
2messageTYPEMESSAGE
3applicationTYPEAPPLICATION
4audioTYPEAUDIO
5imageTYPEIMAGE
6videoTYPEVIDEO
7modelTYPEMODEL
8otherTYPEOTHER

Кодировка (значения могут отличаться в зависимости от используемой библиотеки, так что рекомендуется использовать константы)
ЗначениеТипКонстанта
07bitENC7BIT
18bitENC8BIT
2BinaryENCBINARY
3Base64ENCBASE64
4Quoted-PrintableENCQUOTEDPRINTABLE
5otherENCOTHER

Список изменений

Версия Описание
8.1.0 Параметр imap теперь ожидает экземпляр класса IMAP\Connection; раньше параметр ждал ресурс (resource) imap.

Смотрите также

  • imap_fetchbody() - Извлекает конкретную секцию тела сообщения
  • imap_bodystruct() - Читает структуру указанной секции тела заданного сообщения