imap_fetchbody

Function • Removed in PHP 8.4

Fetch a particular section of the body 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_fetchbody Function synopsis

imap_fetchbody(
    IMAP\Connection $imap,
    int $message_num,
    string $section,
    int $flags = 0
  ): string|false

Parameters

$imap

TypeIMAP\Connection

$message_num

Typeint

The message number

$section

Typestring

The part number. It is a string of integers delimited by period which index into a body part list as per the IMAP4 specification

$flags

OptionalTypeintDefault value0

A bitmask with one or more of the following:

Return value

Typestring|false

Returns a particular section of the body of the specified messages as a text string, or false on failure.

Changes to the imap_fetchbody Function

PHP 8.4

  • Function removed

PHP 8.1

  • Parameter type added for parameter #1 ($imap): IMAP\Connection
  imap_fetchbody(
-     $imap,
+     IMAP\Connection $imap,
      int $message_num,
      string $section,
      int $flags = 0
    ): string|false

PHP 8.0

  • Return type added: string|false
  • Parameter name of parameter #1 changed: $stream_id to $imap
  • Parameter name of parameter #2 changed: $msg_no to $message_num
  • Parameter type added for parameter #2 ($message_num): int
  • Parameter type added for parameter #3 ($section): string
  • Parameter name of parameter #4 changed: $options to $flags
  • Parameter type added for parameter #4 ($flags): int
  • Parameter default value added for position #4 ($flags): 0
  imap_fetchbody(
-     $stream_id,
+     $imap,
-     $msg_no,
+     int $message_num,
-     $section,
+     string $section,
-     $options
+     int $flags = 0
-   )
+   ): string|false

imap_fetchbody 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