imap_fetchheader

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

imap_fetchheader — Returns header for a message

Description

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.

Parameters

imap

An IMAP\Connection instance.

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)

Return Values

Returns the header of the specified message as a text string, or false on failure.

Changelog

Version	Description
8.1.0	The `imap` parameter expects an IMAP\Connection instance now; previously, a valid `imap` resource was expected.

Found A Problem?

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.