Class CApiMailFolder

CApiMailFolder class is used for operations with a folder.

Package: Mail\Classes
Located at mail/classes/folder.php

Methods summary

`protected`	# `__construct( MailSo\Imap\Folder $oImapFolder, boolean $bSubscribed = true, boolean $bExists = true )` Fills in the required data first. Fills in the required data first. 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 MailSo\Base\Exceptions\InvalidArgumentException
`public static CApiMailFolder`	# `createInstance( MailSo\Imap\Folder $oImapFolder, boolean $bSubscribed = true, boolean $bExists = true )` 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. Returns `CApiMailFolder` Throws MailSo\Base\Exceptions\InvalidArgumentException
`public static CApiMailFolder`	# `createNonexistentInstance( string $sFullNameRaw, string $sDelimiter )` 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. Returns `CApiMailFolder` Throws MailSo\Base\Exceptions\InvalidArgumentException MailSo\Base\Exceptions\InvalidArgumentException
`public integer`	# `getType( )` Returns type of the folder. Returns type of the folder. Returns integer 1 = Inbox; 2 = Sent; 3 = Drafts; 4 = Spam; 5 = Trash; 6 = Quarantine; 9 = System; 10 = Custom; 0 = generic folder.
`public integer`	# `getNestingLevel( )` Returns the depth value of the folder in the folders tree. Returns the depth value of the folder in the folders tree. Returns integer
`public CApiMailFolder`	# `setType( integer $iType )` 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. Returns `CApiMailFolder`
`public string`	# `getName( )` Returns name of the folder. Returns name of the folder. Returns string
`public string`	# `getFullName( )` Returns full name of the folder. Returns full name of the folder. Returns string
`public string`	# `getRawName( )` Returns name of the folder with encoding used on IMAP level. Returns name of the folder with encoding used on IMAP level. Returns string
`public string`	# `getRawFullName( )` Returns full name of the folder with encoding used on IMAP level. Returns full name of the folder with encoding used on IMAP level. Returns string
`public string`	# `getDelimiter( )` Returns a character used as delimiter in full names of IMAP folders. Returns a character used as delimiter in full names of IMAP folders. Returns string
`public CApiMailFolderCollection`	# `getSubFolders( boolean $bCreateIfNull = false )` 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. Returns `CApiMailFolderCollection`
`public boolean`	# `hasSubFolders( )` 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. Returns boolean
`public mixed`	# `getStatus( )` 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. Returns mixed
`public boolean`	# `isSubscribed( )` 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. Returns boolean
`public boolean`	# `exists( )` Returns true if the folder exists on IMAP. Returns true if the folder exists on IMAP. Returns boolean
`public boolean`	# `isSelectable( )` Returns true if the folder can be selected. Returns true if the folder can be selected. Returns boolean
`public integer`	# `getFolderXListType( )` 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 integer 1 = Inbox; 2 = Sent; 3 = Drafts; 4 = Spam; 5 = Trash; 6 = Quarantine; 9 = System; 10 = Custom; 0 = generic

Properties summary

`protected integer`	`$iNestingLevel` Level of depth at which the folder is located. Level of depth at which the folder is located.	#
`protected integer`	`$iType` Type of folder: 1 = Inbox; 2 = Sent; 3 = Drafts; 4 = Spam; 5 = Trash; 6 = Quarantine; 9 = System; 10 = Custom; 0 = generic folder. Type of folder: 1 = Inbox; 2 = Sent; 3 = Drafts; 4 = Spam; 5 = Trash; 6 = Quarantine; 9 = System; 10 = Custom; 0 = generic folder.	#
`protected boolean`	`$bExists` If true the folder exists on IMAP server. If true the folder exists on IMAP server.	#
`protected boolean`	`$bSubscribed` If true the folder is subscribed on IMAP server. If true the folder is subscribed on IMAP server.	#
`protected MailSo\Imap\Folder`	`$oImapFolder` ImapFolder object. ImapFolder object.	#
`protected CApiMailFolderCollection`	`$oSubFolders` Collection of subfolders belonging to the folder. Collection of subfolders belonging to the folder.	#