imap_fetchheader

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

imap_fetchheader — Returns header for a message

Опис

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.

Параметри

imap

Примірник 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)

Значення, що повертаються

Returns the header of the specified message as a text string, або false в разі помилки.

Журнал змін

Версія	Опис
8.1.0	Тепер параметр `imap` має бути примірником IMAP\Connection; раніше очікувався дійсний resource `imap`.

Прогляньте також

imap_fetch_overview() - Read an overview of the information in the headers of the given message

Improve This Page

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 2 notes

down

rgagnon24 dot nospam at gmail dot com ¶

14 years ago

Interesting that imap_headerinfo() does not allow a UID for the $msg_number field like all other fetching functions seem to allow.



If you want to use a UID to fetch the headers, use this two-step process:



<?php

/*

 * assumes $mbox is your stream, and $uid is set 

 * properly. Proper error checking is up to you.

 */

$hText = imap_fetchbody($mbox, $uid, '0', FT_UID);

$headers = imap_rfc822_parse_headers($hText);

?>



The result is the same as the output of imap_headerinfo(), but you get to use the UID.

down

Jille at nomorecrap dot quis dot cx ¶

16 years ago

<?PHP
$headers=imap_fetchheader($imap, $msgid);
preg_match_all('/([^: ]+): (.+?(?:\r\n\s(?:.+?))*)\r\n/m', $headers, $matches);
?>

Works quite well for splitting headers,
$matches will contain 3 arrays:
$matches[0] are the full-lines (To: Jille@devnull.quis.cx\r\n)
$matches[1] will be the header (To)
$matches[2] will be the value (Jille@devnull.quis.cx)

In multi-line values the 'multilining is not stripped!'
this could be achieved with something like:
<?PHP
preg_replace('/\r\n\s+/m', '', $matches[2]);
?>

＋add a note