imap_body

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

imap_bodyLê o corpo da mensagem

Descrição

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

imap_body() retorna o corpo da mensagem, de número message_num, na caixa de correio atual.

imap_body() retornará apenas uma cópia literal do corpo da mensagem. Para extrair um único componente de uma mensagem multipartes codificada em MIME, é necessário usar imap_fetchstructure() para analisar sua estrutura e imap_fetchbody() para extrair uma cópia de um único componente do corpo.

Parâmetros

imap

Uma instância de IMAP\Connection.

message_num

O número da mensagem

flags

Os sinalizadores opcionais em flags são uma máscara de bits com uma ou mais das seguintes constantes:

  • FT_UID - O número da mensagem em message_num é um UID
  • FT_PEEK - Não define o sinalizador \Seen se ainda não estiver definido
  • FT_INTERNAL - A string de retorno está em formato interno, não será canonizada para CRLF.

Valor Retornado

Retorna o corpo da mensagem especificada, como uma string, ou false em caso de falha.

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.