| Methods |
public
static
|
createInstance(): FolderCollection
Creates new instance of the object.
Creates new instance of the object.
|
#
|
public
&
|
getFolder(string $sFullNameRaw, bool $bRec = false): Folder|null
Locates folder within the collection by its full name.
Locates folder within the collection by its full name.
Parameters
| $sFullNameRaw |
Raw full name of the folder.
|
| $bRec |
= false. If true, full recursive search is performed.
|
|
#
|
public
|
getNamespace(): string
Returns namespace of folders.
Returns namespace of folders.
|
#
|
public
|
setNamespace(string $sNamespace): FolderCollection
Modifies namespace information of folders.
Modifies namespace information of folders.
Parameters
| $sNamespace |
New namespace string.
|
|
#
|
public
|
getCollectionFullFlag(): boolean
Returns flag if the collection contains full structure.
Returns flag if the collection contains full structure.
|
#
|
public
|
setCollectionFullFlag(boolean $bFlag)
Modifies flag that shows if the collection contains full structure.
Modifies flag that shows if the collection contains full structure.
Parameters
| $bFlag |
bFullCollection flag value.
|
|
#
|
public
|
initialize(array $aUnsortedMailFolders): void
Initializes collection by unsorted mail folders.
Initializes collection by unsorted mail folders.
Parameters
| $aUnsortedMailFolders |
Unsorted mail folder list.
|
|
#
|
public
|
sort(callable $fCallback): void
Sorts folders of the collection using custom callback function.
Sorts folders of the collection using custom callback function.
Parameters
| $fCallback |
Custom callback function for sorting.
|
|
#
|
public
|
addFolder(Folder $oMailFolder): bool
Searches suitable position in collection and adds mail folder.
Searches suitable position in collection and adds mail folder.
Parameters
| $oMailFolder |
Mail folder for adding to collection.
|
Returns
Returns true if folder was added.
|
#
|
public
|
foreachWithSubFolders(mixed $mCallback): void
Iterates through list of folders including all the subfolders.
Iterates through list of folders including all the subfolders.
Parameters
| $mCallback |
Callback function which can be run on each loop iteration.
|
|
#
|
public
|
foreachOnlyRoot(mixed $mCallback): void
Iterates through list of folders including only root folders, first childs of Inbox and first childs of special GMail…
Iterates through list of folders including only root folders, first childs of Inbox and first childs of special GMail account root folder.
Parameters
| $mCallback |
Callback function which can be run on each loop iteration.
|
|
#
|