imap_body

FunctionRemoved in PHP 8.4

Read the message body.

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_body Function synopsis

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

Parameters

$imap

TypeIMAP\Connection

$message_num

Typeint

The message number

$flags

OptionalTypeintDefault value0

The optional $flags are a bit mask with one or more of the following:

Return value

Typestring|false

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

Changes to the imap_body Function

PHP 8.4

  • Function removed

PHP 8.1

  • Parameter type added for parameter #1 ($imap): IMAP\Connection
  imap_body(
-     $imap,
+     IMAP\Connection $imap,
      int $message_num,
      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 name of parameter #3 changed: $options to $flags
  • Parameter type added for parameter #3 ($flags): int
  • Parameter default value added for position #3 ($flags): 0
  imap_body(
-     $stream_id,
+     $imap,
-     $msg_no,
+     int $message_num,
-     $options
+     int $flags = 0
-   )
+   ): string|false

imap_body 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