imap_savebody

Function • Removed in PHP 8.4

Save a specific body section to a file.

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

imap_savebody(
    IMAP\Connection $imap,
    $file,
    int $message_num,
    string $section = "",
    int $flags = 0
  ): bool

Parameters

$imap

TypeIMAP\Connection

$file

The path to the saved file as a string, or a valid file descriptor returned by fopen.

$message_num

Typeint

The message number

$section

OptionalTypestringDefault value""

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

Typebool

Returns true on success, false on failure

Changes to the imap_savebody Function

PHP 8.4

  • Function removed

PHP 8.1

  • Parameter type added for parameter #1 ($imap): IMAP\Connection
  imap_savebody(
-     $imap,
+     IMAP\Connection $imap,
      $file,
      int $message_num,
      string $section = "",
      int $flags = 0
    ): bool

PHP 8.0

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

imap_savebody 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