IMAP_FETCHHEADER(3) 1 IMAP_FETCHHEADER(3)
imap_fetchheader - Returns header for a message
SYNOPSIS
string imap_fetchheader (resource $imap_stream, int $msg_number, [int $options])
DESCRIPTION
This function causes a fetch of the complete, unfiltered RFC2822 format header of the specified message.
PARAMETERS
o $
imap_stream -An IMAP stream returned by imap_open(3).
o $msg_number
- The message number
o $options
- The possible $options are:
o FT_UID - The $msgno argument is a UID
o FT_INTERNAL - The return string is in "internal" format, without any attempt to canonicalize to CRLF newlines
o 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.
SEE ALSO
imap_fetch_overview(3).
PHP Documentation Group IMAP_FETCHHEADER(3)
