| [ Index ] |
|
Code source de IMP H3 (4.1.5) |
[Code source] [Imprimer] [Statistiques]
(pas de description)
| Poids: | 688 lignes (27 kb) |
| Inclus ou requis: | 17 fois |
| Référencé: | 0 fois |
| Nécessite: | 3 fichiers lib/IMAP/Sort.php lib/IMAP.php lib/IMAP/Tree.php |
IMP_Folder:: (12 méthodes):
singleton()
flist()
flist_IMP()
delete()
create()
exists()
rename()
subscribe()
unsubscribe()
generateMbox()
importMbox()
_listFolders()
Classe: IMP_Folder - X-Ref
The IMP_Folder:: class provides a set of methods for dealing with folders,| singleton() X-Ref |
| Returns a reference to the global IMP_Folder object, only creating it if it doesn't already exist. This ensures that only one IMP_Folder instance is instantiated for any given session. This method must be invoked as:<code> $imp_folder = &IMP_Folder::singleton(); </code> return: IMP_Folder The IMP_Folder instance. |
| flist($sub = false, $filter = array() X-Ref |
| Lists folders. param: boolean $sub Should we list only subscribed folders? param: array $filter An list of mailboxes that should be left out of return: array An array of folders, where each array alement is an |
| flist_IMP($filter = array() X-Ref |
| Returns an array of folders. This is a wrapper around the flist() function which reduces the number of arguments needed if we can assume that IMP's full environment is present. param: array $filter An array of mailboxes to ignore. param: boolean $sub If set, will be used to determine if we should return: array The array of mailboxes returned by flist(). |
| delete($folder_array, $subscribe) X-Ref |
| Deletes one or more folders. param: array $folder_array An array of full utf encoded folder names param: boolean $subscribe A boolean describing whether or not to use return: boolean Whether or not the folders were successfully deleted. |
| create($folder, $subscribe) X-Ref |
| Create a new IMAP folder if it does not already exist, and subcribe to it as well if requested. param: string $folder The full utf encoded folder to be created. param: boolean $subscribe A boolean describing whether or not to use return: boolean Whether or not the folder was successfully created. |
| exists($folder) X-Ref |
| Finds out if a specific folder exists or not. param: string $folder The full utf encoded folder name to be checked. return: boolean Whether or not the folder exists. |
| rename($old, $new) X-Ref |
| Renames an IMAP folder. The subscription status remains the same. All subfolders will also be renamed. param: string $old The old utf encoded folder name. param: string $new The new utf encoded folder name. return: boolean Whether or not all folder(s) were successfully renamed. |
| subscribe($folder_array) X-Ref |
| Subscribes to one or more IMAP folders. param: array $folder_array An array of full utf encoded folder names return: boolean Whether or not the folders were successfully |
| unsubscribe($folder_array) X-Ref |
| Unsubscribes from one or more IMAP folders. param: array $folder_array An array of full utf encoded folder names return: boolean Whether or not the folders were successfully |
| generateMbox($folder_list, $recursive = false) X-Ref |
| Generates a string that can be saved out to an mbox format mailbox file for a folder or set of folders, optionally including all subfolders of the selected folders as well. All folders will be put into the same string. author: Didi Rieder <adrieder@sbox.tugraz.at> param: array $folder_list A list of full utf encoded folder names to param: boolean $recursive Include subfolders? return: string An mbox format mailbox file. |
| importMbox($folder, $mbox) X-Ref |
| Imports messages into a given folder from a mbox format mailbox file. param: string $folder The folder to put the messages into. param: string $mbox String containing the mbox filename. return: mixed False (boolean) on fail or the number of messages |
| _listFolders($sub = false) X-Ref |
| Get a list of all folders on the server (including any folders in hidden namespaces). param: boolean $sub List only subscribed folders? return: array An array of folders names. |
| Généré le : Thu Nov 29 12:30:07 2007 | par Balluche grâce à PHPXref 0.7 |
|
|