imap_headerinfo()

imap_headerinfo - Read the header of the message

Syntax

object imap_headerinfo (resource $imap_stream, int $msg_number, int $fromlength, int $subjectlength, string $defaulthost)

Arguments

• imap_stream - An IMAP stream returned by imap_open().
• msg_number - The message number
• fromlength - Number of characters for the fetchfromproperty. Must be greater than or equal to zero.
• subjectlength - Number of characters for the fetchsubjectproperty Must be greater than or equal to zero.
• defaulthost

Description

Gets information about the given message number by reading its headers.

Version

PHP 4, 5

Return value

Returns the information in an object with following properties: toaddress - full to: line, up to 1024 characters to - an array of objects from the To: line, with the following properties: personal, adl, mailbox, and host fromaddress - full from: line, up to 1024 characters from - an array of objects from the From: line, with the following properties: personal, adl, mailbox, and host ccaddress - full cc: line, up to 1024 characters cc - an array of objects from the Cc: line, with the following properties: personal, adl, mailbox, and host bccaddress - full bcc: line, up to 1024 characters bcc - an array of objects from the Bcc: line, with the following properties: personal, adl, mailbox, and host reply_toaddress - full Reply-To: line, up to 1024 characters reply_to - an array of objects from the Reply-To: line, with the following properties: personal, adl, mailbox, and host senderaddress - full sender: line, up to 1024 characters sender - an array of objects from the Sender: line, with the following properties: personal, adl, mailbox, and host return_pathaddress - full Return-Path: line, up to 1024 characters return_path - an array of objects from the Return-Path: line, with the following properties: personal, adl, mailbox, and host remail - date - The message date as found in its headers Date - Same as date subject - The message subject Subject - Same a subject in_reply_to - message_id - newsgroups - followup_to - references - Recent - Rif recent and seen, Nif recent and not seen, ' ' if not recent. Unseen - Uif not seen AND not recent, ' ' if seen OR not seen and recent Flagged - Fif flagged, ' ' if not flagged Answered - Aif answered, ' ' if unanswered Deleted - Dif deleted, ' ' if not deleted Draft - Xif draft, ' ' if not draft Msgno - The message number MailDate - Size - The message size udate - mail message date in Unix time fetchfrom - from line formatted to fit fromlength characters fetchsubject - subject line formatted to fit subjectlength characters