array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'pt_BR', ), 'this' => array ( 0 => 'function.imap-fetchstructure.php', 1 => 'imap_fetchstructure', 2 => 'Lê a estrutura de uma mensagem específica', ), 'up' => array ( 0 => 'ref.imap.php', 1 => 'Funções de IMAP', ), 'prev' => array ( 0 => 'function.imap-fetchmime.php', 1 => 'imap_fetchmime', ), 'next' => array ( 0 => 'function.imap-fetchtext.php', 1 => 'imap_fetchtext', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'pt_BR', 'path' => 'reference/imap/functions/imap-fetchstructure.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

imap_fetchstructure

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

imap_fetchstructure — Lê a estrutura de uma mensagem específica

Descrição

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

Busca todas as informações estruturadas para uma determinada mensagem.

Parâmetros

imap

Uma instância de IMAP\Connection.

message_num

O número da mensagem

flags

Este parâmetro opcional tem apenas uma única opção, FT_UID, que diz à função para tratar o argumento message_num como um UID.

Valor Retornado

Retorna um objeto com propriedades listadas na tabela abaixo, ou false em caso de falha.

Objeto retornado para imap_fetchstructure()
type Tipo de corpo primário
encoding Codificação de transferência de corpo
ifsubtype true se houver uma string de subtipo
subtype Subtipo MIME
ifdescription true se houver uma string de descrição
description String de descrição do conteúdo
ifid true se houver uma string de identificação
id String de identificação
lines Número de linhas
bytes Número de bytes
ifdisposition true se houver uma string de disposição
disposition String de disposição
ifdparameters true se o array dparameters existir
dparameters Um array de objetos onde cada objeto tem uma propriedade "attribute" e uma propriedade "value" correspondente aos parâmetros no cabeçalho MIME Content-disposition.
ifparameters true se o array de parâmetros existir
parameters Um array de objetos onde cada objeto tem uma propriedade "attribute" e uma propriedade "value".
parts Um array de objetos idênticos em estrutura ao objeto de nível superior, cada um dos quais corresponde a uma parte do corpo MIME.

Tipo de corpo primário (o valor pode variar com a biblioteca usada, o uso de constantes é recomendado)
ValorTipoConstante
0textoTYPETEXT
1multipartesTYPEMULTIPART
2mensagemTYPEMESSAGE
3aplicaçãoTYPEAPPLICATION
4áudioTYPEAUDIO
5imagemTYPEIMAGE
6vídeoTYPEVIDEO
7modeloTYPEMODEL
8outroTYPEOTHER

Codificações de transferência (o valor pode variar com a biblioteca usada, o uso de constantes é recomendado)
ValorTipoConstante
07 bitsENC7BIT
18 bitsENC8BIT
2BináriaENCBINARY
3Base64ENCBASE64
4Escapada-ImprimívelENCQUOTEDPRINTABLE
5OutraENCOTHER

Registro de Alterações

Versão Descrição
8.1.0 O parâmetro imap agora espera uma instância de IMAP\Connection; anteriormente, um resource imap válido era esperado.

Veja Também