imap_fetchstructure

(PHP 4, PHP 5, PHP 7)

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

Описание

object imap_fetchstructure ( resource $imap_stream , int $msg_number [, int $options = 0 ] )

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

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

imap_stream

Поток IMAP, полученный из imap_open().

msg_number

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

options

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

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

Возвращает объект, содержащий обертку, внутреннюю дату, размер, флаги и структуру тела сообщения, а также аналогичную информацию по каждому MIME-вложению. Объект имеет следующую структуру:

Объект, возвращаемый 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

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

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