| Methods |
public
static
|
createInstance(Folder $oImapFolder, bool $bSubscribed = true, bool $bExists = true): Folder
Creates new instance of the object.
Creates new instance of the object.
Parameters
| $oImapFolder |
ImapFolder object.
|
| $bSubscribed |
= true. If true the folder is subscribed on IMAP server.
|
| $bExists |
= true. If true the folder exists on IMAP server.
|
Throws
|
#
|
public
static
|
createNonexistentInstance(string $sFullNameRaw, string $sDelimiter): Folder
Creates new instance of the object which represents folder not present on IMAP.
Creates new instance of the object which represents folder not present on IMAP.
Parameters
| $sFullNameRaw |
Raw full name of the folder.
|
| $sDelimiter |
Symbol wich is used as delimiter in folder full name on IMAP server.
|
Throws
|
#
|
public
|
getType(): int
Returns type of the folder.
Returns type of the folder.
Returns
1 = Inbox; 2 = Sent; 3 = Drafts; 4 = Spam; 5 = Trash; 6 = Quarantine; 9 = System; 10 = Custom; 0 = generic folder.
|
#
|
public
|
getNestingLevel(): int
Returns the depth value of the folder in the folders tree.
Returns the depth value of the folder in the folders tree.
|
#
|
public
|
setType(int $iType): Folder
Changes type of the folder.
Changes type of the folder.
Parameters
| $iType |
1 = Inbox; 2 = Sent; 3 = Drafts; 4 = Spam; 5 = Trash; 6 = Quarantine; 9 = System; 10 = Custom; 0 = generic folder.
|
|
#
|
public
|
getName(): string
Returns name of the folder.
Returns name of the folder.
|
#
|
public
|
getFullName(): string
Returns full name of the folder.
Returns full name of the folder.
|
#
|
public
|
getRawName(): string
Returns name of the folder with encoding used on IMAP level.
Returns name of the folder with encoding used on IMAP level.
|
#
|
public
|
getRawFullName(): string
Returns full name of the folder with encoding used on IMAP level.
Returns full name of the folder with encoding used on IMAP level.
|
#
|
public
|
getDelimiter(): string
Returns a character used as delimiter in full names of IMAP folders.
Returns a character used as delimiter in full names of IMAP folders.
|
#
|
public
|
getSubFolders(bool $bCreateIfNull = false): FolderCollection
Return list of subfolders belonging to the folder.
Return list of subfolders belonging to the folder.
Parameters
| $bCreateIfNull |
= false. If true the collection will be created even if there are no subfolders present.
|
|
#
|
public
|
hasSubFolders(): bool
Returns **true** if the folder has at least one subfolder and **false** otherwise.
Returns true if the folder has at least one subfolder and false otherwise.
|
#
|
public
|
getStatus(): mixed
Returns imap folder status - information about total messages count, unseen messages count and value of uidnext.
Returns imap folder status - information about total messages count, unseen messages count and value of uidnext.
|
#
|
public
|
isSubscribed(): bool
Returns **true** if the folder is subscribed and thus visible in folders tree.
Returns true if the folder is subscribed and thus visible in folders tree.
|
#
|
public
|
exists(): bool
Returns **true** if the folder exists on IMAP.
Returns true if the folder exists on IMAP.
|
#
|
public
|
isSelectable(): bool
Returns **true** if the folder can be selected.
Returns true if the folder can be selected.
|
#
|
public
|
getFolderXListType(): int
Returns a number which denotes folder type. The value is retrieved using IMAP XLIST extension.
Returns a number which denotes folder type. The value is retrieved using IMAP XLIST extension.
Returns
1 = Inbox; 2 = Sent; 3 = Drafts; 4 = Spam; 5 = Trash; 6 = Quarantine; 9 = System; 10 = Custom; 0 = generic
|
#
|
public
|
toResponseArray($aParameters = [])
|
#
|