(PHP 4, PHP 5, PHP 7)
imap_fetchstructure — Leer la estructura de un mensaje en particular
$imap_stream
, int $msg_number
[, int $options = 0
] ) : objectObtiene toda la información de la estructura de un mensaje dado.
imap_streamIMAP stream devuelto por imap_open().
msg_numberEl 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.
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:
| 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. |
| Valor | Tipo | Constante |
|---|---|---|
| 0 | text | TYPETEXT |
| 1 | multipart | TYPEMULTIPART |
| 2 | message | TYPEMESSAGE |
| 3 | application | TYPEAPPLICATION |
| 4 | audio | TYPEAUDIO |
| 5 | image | TYPEIMAGE |
| 6 | video | TYPEVIDEO |
| 7 | model | TYPEMODEL |
| 8 | other | TYPEOTHER |
| Valor | Tipo | Constante |
|---|---|---|
| 0 | 7bit | ENC7BIT |
| 1 | 8bit | ENC8BIT |
| 2 | Binary | ENCBINARY |
| 3 | Base64 | ENCBASE64 |
| 4 | Quoted-Printable | ENCQUOTEDPRINTABLE |
| 5 | other | ENCOTHER |