imap_append

Function • Removed in PHP 8.4

Append a string message to a specified mailbox.

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

imap_append(
    IMAP\Connection $imap,
    string $folder,
    string $message,
    ?string $options = null,
    ?string $internal_date = null
  ): bool

Parameters

$imap

TypeIMAP\Connection

$folder

Typestring

The mailbox name, see imap_open for more information

$message

Typestring

The message to be append, as a string

$options

OptionalType?stringDefault valuenull

If provided, the $options will also be written to the $folder

$internal_date

OptionalType?stringDefault valuenull

If this parameter is set, it will set the INTERNALDATE on the appended message. The parameter should be a date string that conforms to the rfc2060 specifications for a date_time value.

Return value

Typebool

Returns true on success, false on failure

Changes to the imap_append Function

PHP 8.4

  • Function removed

PHP 8.1

  • Parameter type added for parameter #1 ($imap): IMAP\Connection
  imap_append(
-     $imap,
+     IMAP\Connection $imap,
      string $folder,
      string $message,
      ?string $options = null,
      ?string $internal_date = null
    ): bool

PHP 8.0

  • Return type added: bool
  • Parameter name of parameter #1 changed: $stream_id to $imap
  • Parameter type added for parameter #2 ($folder): string
  • Parameter type added for parameter #3 ($message): string
  • Parameter type added for parameter #4 ($options): ?string
  • Parameter default value added for position #4 ($options): null
  • Parameter name of parameter #5 changed: $date to $internal_date
  • Parameter type added for parameter #5 ($internal_date): ?string
  • Parameter default value added for position #5 ($internal_date): null
  imap_append(
-     $stream_id,
+     $imap,
-     $folder,
+     string $folder,
-     $message,
+     string $message,
-     $options,
+     ?string $options = null,
-     $date
+     ?string $internal_date = null
-   )
+   ): bool

imap_append 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