imap_mail_copy

FunctionRemoved in PHP 8.4

Copy specified messages to a 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_mail_copy Function synopsis

imap_mail_copy(
    IMAP\Connection $imap,
    string $message_nums,
    string $mailbox,
    int $flags = 0
  ): bool

Parameters

$imap

TypeIMAP\Connection

$message_nums

Typestring

$message_nums is a range not just message numbers (as described in RFC2060).

$mailbox

Typestring

The mailbox name, see imap_open for more information

$flags

OptionalTypeintDefault value0

$flags is a bitmask of one or more of

Return value

Typebool

Returns true on success, false on failure

Changes to the imap_mail_copy Function

PHP 8.4

  • Function removed

PHP 8.1

  • Parameter type added for parameter #1 ($imap): IMAP\Connection
  imap_mail_copy(
-     $imap,
+     IMAP\Connection $imap,
      string $message_nums,
      string $mailbox,
      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 #2 changed: $msglist to $message_nums
  • Parameter type added for parameter #2 ($message_nums): string
  • Parameter type added for parameter #3 ($mailbox): 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_mail_copy(
-     $stream_id,
+     $imap,
-     $msglist,
+     string $message_nums,
-     $mailbox,
+     string $mailbox,
-     $options
+     int $flags = 0
-   )
+   ): bool

imap_mail_copy 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