imap_fetchstructure

(PHP 4, PHP 5, PHP 7)

imap_fetchstructureLeer la estructura de un mensaje en particular

Descripción

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

Obtiene toda la información de la estructura de un mensaje dado.

Parámetros

imap_stream

IMAP stream devuelto por imap_open().

msg_number

El número de mensaje.

options

Este parámetro opcional sólo puede tener una única opción, FT_UID, que indica a la función que trate el argumento msg_number como un UID.

Valores devueltos

Devuelve un objeto que incluye la envoltura, información interna, tamaño, banderas y cuerpo de la estructura además de un objeto similar para cada adjunto mime. La estructura de los objetos devueltos es como sigue:

Objetos devueltos para imap_fetchstructure()
type Tipo de cuerpo principal
encoding Codificación de la transferencia del cuerpo
ifsubtype TRUE si hay una cadena subtipo
subtype Subtipo MIME
ifdescription TRUE si hay una cadena de descripción
description Contenido de la cadena de descripción
ifid TRUE si hay una cadena de identificación
id Cadena de identificación
lines Número de líneas
bytes Número de bytes
ifdisposition TRUE si hay una cadena de disposición
disposition Cadena de disposición
ifdparameters TRUE si el array dparameters existe
dparameters Un array de objetos donde cada objeto tiene una propiedad "attribute" y "value" correspondientes a los parámetros de la cabecera MIME Content-disposition.
ifparameters TRUE si el array de parámetros existe
parameters Una array de objetos donde cada objeto tiene una propiedad "attribute" y "value".
parts Un array de objetos idéntico en estructura al objeto de más alto nivel, cada uno correspondiendo una parte del cuerpo MIME.

Tipo principal del cuerpo (el valor podría variar con la biblioteca empleada; se recomienda el uso de constantes)
ValorTipoConstante
0textTYPETEXT
1multipartTYPEMULTIPART
2messageTYPEMESSAGE
3applicationTYPEAPPLICATION
4audioTYPEAUDIO
5imageTYPEIMAGE
6videoTYPEVIDEO
7modelTYPEMODEL
8otherTYPEOTHER

Codificaciones de transferencia (el valor podría cambiar con la biblioteca empleada; se recomienda el uso de constantes)
ValorTipoConstante
07bitENC7BIT
18bitENC8BIT
2BinaryENCBINARY
3Base64ENCBASE64
4Quoted-PrintableENCQUOTEDPRINTABLE
5otherENCOTHER

Ver también

  • imap_fetchbody() - Traer una sección en particular del cuerpo del mensaje
  • imap_bodystruct() - Leer la estructura de una sección del cuerpo especificado de un mensaje especificado