imap_fetchstructure

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

imap_fetchstructureLee la estructura de un mensaje

Descripción

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

imap_fetchstructure() lee la estructura del mensaje msg_number.

Parámetros

imap

An IMAP\Connection instance.

message_num

El número del mensaje

flags

Este parámetro opcional tiene una sola opción, FT_UID, que solicita a la función tratar el argumento message_num como un UID.

Valores devueltos

Devuelve un objeto cuyas propiedades se listan en la tabla siguiente, o false en caso de error.

Objeto devuelto por imap_fetchstructure()
type Tipo primario de cuerpo
encoding Codificación de transferencia del cuerpo
ifsubtype true si hay una cadena de subtipo
subtype subtipo MIME
ifdescription true si hay una cadena de descripción
description Cadena de descripción del contenido
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 hay un array de parámetros dparameters
dparameters array de objetos donde cada objeto tiene una propiedad "attribute" y una propiedad "value" correspondiente a los parámetros de encabezado Content-disposition MIME.
ifparameters true si el array de parámetros existe
parameters Array de objetos donde cada uno tiene una propiedad "attribute" y una propiedad "value".
parts Array de objetos que describen cada parte MIME del mensaje

Tipo primario de cuerpo (puede variar según la biblioteca utilizada)
ValorTipoConstante
0textoTYPETEXT
1multipartTYPEMULTIPART
2mensajeTYPEMESSAGE
3aplicaciónTYPEAPPLICATION
4audioTYPEAUDIO
5imagenTYPEIMAGE
6videoTYPEVIDEO
7modeloTYPEMODEL
8otroTYPEOTHER

Codificación de transferencia (puede variar según la biblioteca utilizada)
ValorTipoConstante
07 bitENC7BIT
18 bitENC8BIT
2BinarioENCBINARY
3Base 64ENCBASE64
4Citado imprimibleENCQUOTEDPRINTABLE
5OtroENCOTHER

Historial de cambios

Versión Descripción
8.1.0 The imap parameter expects an IMAP\Connection instance now; previously, a valid imap recurso was expected.

Ver también

  • imap_fetchbody() - Devuelve una sección extraída del cuerpo de un mensaje
  • imap_bodystruct() - Lee la estructura de una sección del cuerpo de un correo electrónico