IMP_Imap_PermanentFlags
in package
implements
IteratorAggregate
Provides an interface to query a mailbox's settable permanent flags.
Tags
Table of Contents
Interfaces
- IteratorAggregate
Constants
- CREATE = "\\*"
Properties
- $_nocreate : bool
- Can new flags NOT be created?
- $_noset : array<string|int, mixed>
- List of unsettable flags.
- $_set : array<string|int, mixed>
- List of settable flags.
Methods
- __construct() : mixed
- Constructor.
- allowed() : bool
- Determines if the given flag is allowed to be changed permanently.
- getIterator() : ArrayIterator
Constants
CREATE
public
mixed
CREATE
= "\\*"
Properties
$_nocreate
Can new flags NOT be created?
protected
bool
$_nocreate
= \false
$_noset
List of unsettable flags.
protected
array<string|int, mixed>
$_noset
= array()
$_set
List of settable flags.
protected
array<string|int, mixed>
$_set
= array()
Methods
__construct()
Constructor.
public
__construct([array<string|int, mixed> $permflags = array() ][, array<string|int, mixed> $flags = array() ]) : mixed
Parameters
- $permflags : array<string|int, mixed> = array()
-
List of permanent flags in mailbox.
- $flags : array<string|int, mixed> = array()
-
List of flags in mailbox.
allowed()
Determines if the given flag is allowed to be changed permanently.
public
allowed(string $flag) : bool
Parameters
- $flag : string
-
The flag to query.
Return values
bool —True if flag can be set permanently.
getIterator()
public
getIterator() : ArrayIterator