IMP_Ftree_Account
in package
implements
Serializable
AbstractYes
Abstract class definining an account source for the IMP folder tree.
Tags
Table of Contents
Interfaces
- Serializable
Constants
- DELETE_ELEMENT = 1
- DELETE_ELEMENT_QUICK = 2
- DELETE_RECURSIVE = 4
- INIT = 1
- UNSUB = 2
Properties
- $_id : string
- Account ID.
Methods
- __construct() : mixed
- Constructor.
- __serialize() : array<string|int, mixed>
- __toString() : string
- __unserialize() : void
- delete() : int
- Return the mailbox selction to delete.
- getList() : array<string|int, mixed>
- Return a list of mailbox to attribute pairs.
- serialize() : mixed
- unserialize() : mixed
Constants
DELETE_ELEMENT
public
mixed
DELETE_ELEMENT
= 1
DELETE_ELEMENT_QUICK
public
mixed
DELETE_ELEMENT_QUICK
= 2
DELETE_RECURSIVE
public
mixed
DELETE_RECURSIVE
= 4
INIT
public
mixed
INIT
= 1
UNSUB
public
mixed
UNSUB
= 2
Properties
$_id
Account ID.
protected
string
$_id
Methods
__construct()
Constructor.
public
__construct([string $id = IMP_Ftree::BASE_ELT ]) : mixed
Parameters
- $id : string = IMP_Ftree::BASE_ELT
-
Account ID.
__serialize()
public
__serialize() : array<string|int, mixed>
Return values
array<string|int, mixed>__toString()
public
__toString() : string
Return values
string —Account ID.
__unserialize()
public
__unserialize(array<string|int, mixed> $data) : void
Parameters
- $data : array<string|int, mixed>
delete()
Return the mailbox selction to delete.
public
abstract delete(IMP_Ftree_Element $elt) : int
Parameters
- $elt : IMP_Ftree_Element
-
Element to delete.
Return values
int —Mask of mailboxes to delete.
getList()
Return a list of mailbox to attribute pairs.
public
abstract getList([array<string|int, mixed> $query = array() ][, mixed $mask = 0 ]) : array<string|int, mixed>
Parameters
- $query : array<string|int, mixed> = array()
-
Array of search queries.
- $mask : mixed = 0
-
Integer mask (INIT and UNSUB constants).
Return values
array<string|int, mixed> —Array of elements to be added via IMP_Ftree#_insertElt().
serialize()
public
serialize() : mixed
unserialize()
public
unserialize(mixed $data) : mixed
Parameters
- $data : mixed