imap_fetchheader

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

imap_fetchheaderReturns header for a message

Descrição

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

This function causes a fetch of the complete, unfiltered » RFC2822 format header of the specified message.

Parâmetros

imap

Uma instância de IMAP\Connection.

message_num

The message number

flags

The possible flags are:

  • FT_UID - The message_num argument is a UID
  • FT_INTERNAL - The return string is in "internal" format, without any attempt to canonicalize to CRLF newlines
  • FT_PREFETCHTEXT - The RFC822.TEXT should be pre-fetched at the same time. This avoids an extra RTT on an IMAP connection if a full message text is desired (e.g. in a "save to local file" operation)

Valor Retornado

Returns the header of the specified message as a text 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.

Veja Também