imap_headerinfo

Function • Removed in PHP 8.4

Read the header of the message.

PHP 5
PHP 7
PHP 8.0
Improved
PHP 8.1
Improved
PHP 8.2-8.3
PHP 8.4
Removed
PHP 8.5
PHP 8.6

imap_headerinfo Function synopsis

imap_headerinfo(
    IMAP\Connection $imap,
    int $message_num,
    int $from_length = 0,
    int $subject_length = 0
  ): stdClass|false

Parameters

$imap

TypeIMAP\Connection

$message_num

Typeint

The message number

$from_length

OptionalTypeintDefault value0

Number of characters for the fetchfrom property. Must be greater than or equal to zero.

$subject_length

OptionalTypeintDefault value0

Number of characters for the fetchsubject property Must be greater than or equal to zero.

Return value

TypestdClass|false

Returns false on error or, if successful, the information in an object with following properties:

Changes to the imap_headerinfo Function

PHP 8.4

  • Function removed

PHP 8.1

  • Parameter type added for parameter #1 ($imap): IMAP\Connection
  imap_headerinfo(
-     $imap,
+     IMAP\Connection $imap,
      int $message_num,
      int $from_length = 0,
      int $subject_length = 0
    ): stdClass|false

PHP 8.0

  • Return type added: stdClass|false
  • Parameter count changed: 5 to 4
  • Optional parameter removed - #5: $default_host
 imap_headerinfo(
-    $stream_id,
-    $msg_no,
-    $from_length,
-    $subject_length,
-    $default_host
-  )
+    $imap,
+    int $message_num,
+    int $from_length = 0,
+    int $subject_length = 0
+  ): stdClass|false

imap_headerinfo Function Availability

PHP VersionAvailability
PHP 8.6Upcoming Release No
PHP 8.5Supported (Latest) No
PHP 8.4Supported No
PHP 8.3Security-Fixes Only Yes
PHP 8.2Security-Fixes Only Yes
PHP 8.1Unsupported Yes
PHP 8.0Unsupported Yes
PHP 7.4Unsupported Yes
PHP 7.3Unsupported Yes
PHP 7.2Unsupported Yes
PHP 7.1Unsupported Yes
PHP 7.0Unsupported Yes
PHP 5.6Unsupported Yes
PHP 5.5Unsupported Yes
PHP 5.4Unsupported Yes
PHP 5.3Unsupported Yes