imap_delete

Function • Removed in PHP 8.4

Mark a message for deletion from current mailbox.

PHP 5

PHP 7

Improved

Improved

PHP 8.2-8.3

Removed

PHP 8.5

PHP 8.6

imap_delete(
    IMAP\Connection $imap,
    string $message_nums,
    int $flags = 0
  ): true

TypeIMAP\Connection

Typestring

A string representing one or more messages in IMAP4-style sequence format ("n", "n:m", or combination of these delimited by commas).

OptionalTypeintDefault value0

You can set the FT_UID which tells the function to treat the $message_nums argument as a UID.

Typetrue

Always returns true

Changes to the `imap_delete` Function

  imap_delete(
      IMAP\Connection $imap,
      string $message_nums,
      int $flags = 0
-   ): bool
+   ): true

  imap_delete(
-     $imap,
+     IMAP\Connection $imap,
      string $message_nums,
      int $flags = 0
    ): bool

  imap_delete(
-     $stream_id,
+     $imap,
-     $msg_no,
+     string $message_nums,
-     $options
+     int $flags = 0
-   )
+   ): bool