imap_setflag_full

Function • Removed in PHP 8.4

Sets flags on messages.

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

imap_setflag_full(
    IMAP\Connection $imap,
    string $sequence,
    string $flag,
    int $options = 0
  ): true

Parameters

$imap

TypeIMAP\Connection

$sequence

Typestring

A sequence of message numbers. You can enumerate desired messages with the X,Y syntax, or retrieve all messages within an interval with the X:Y syntax

$flag

Typestring

The flags which you can set are \Seen, \Answered, \Flagged, \Deleted, and \Draft as defined by RFC2060.

$options

OptionalTypeintDefault value0

A bit mask that may contain the single option:

Return value

Typetrue

Always returns true

Changes to the imap_setflag_full Function

PHP 8.4

  • Function removed

PHP 8.3

  • Return type changed: bool to true
  imap_setflag_full(
      IMAP\Connection $imap,
      string $sequence,
      string $flag,
      int $options = 0
-   ): bool
+   ): true

PHP 8.1

  • Parameter type added for parameter #1 ($imap): IMAP\Connection
  imap_setflag_full(
-     $imap,
+     IMAP\Connection $imap,
      string $sequence,
      string $flag,
      int $options = 0
    ): bool

PHP 8.0

  • Return type added: bool
  • Parameter name of parameter #1 changed: $stream_id to $imap
  • Parameter type added for parameter #2 ($sequence): string
  • Parameter type added for parameter #3 ($flag): string
  • Parameter type added for parameter #4 ($options): int
  • Parameter default value added for position #4 ($options): 0
  imap_setflag_full(
-     $stream_id,
+     $imap,
-     $sequence,
+     string $sequence,
-     $flag,
+     string $flag,
-     $options
+     int $options = 0
-   )
+   ): bool

imap_setflag_full 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