Mail/Storage/Folder/Maildir.php
- category
- Zend
- copyright
- Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
- license
- http://framework.zend.com/license/new-bsd New BSD License
- package
- Zend_Mail
- subpackage
- Storage
- version
- $Id: Maildir.php 20096 2010-01-06 02:05:09Z bkarwin $
- Classes
- Zend_Mail_Storage_Folder_Maildir
Description
Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
Zend_Mail_Storage_Folder_Maildir
- Extends from
- Zend_Mail_Storage_Maildir
- Implements
- Zend_Mail_Storage_Folder_Interface
- category
- Zend
- copyright
- Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
- license
- http://framework.zend.com/license/new-bsd New BSD License
- package
- Zend_Mail
- subpackage
- Storage
- Properties
- $_rootFolder
- $_rootdir
- $_currentFolder
- $_delim
- Methods
- __construct
- _buildFolderTree
- getFolders
- selectFolder
- getCurrentFolder
Description
Properties
$_currentFolder
string $_currentFolder = ''name of current folder
Details
- $_currentFolder
- string
- visibility
- protected
- default
- final
- false
- static
- false
$_delim
string $_delim = ''delim char for subfolders
Details
- $_delim
- string
- visibility
- protected
- default
- final
- false
- static
- false
$_rootFolder
Zend_Mail_Storage_Folder $_rootFolder = ''Zend_Mail_Storage_Folder root folder for folder structure
Details
- $_rootFolder
-
Zend_Mail_Storage_Folder
- visibility
- protected
- default
- final
- false
- static
- false
$_rootdir
string $_rootdir = ''rootdir of folder structure
Details
- $_rootdir
- string
- visibility
- protected
- default
- final
- false
- static
- false
Methods
__construct
__construct(
$params $params
)
:
Create instance with parameters Supported parameters are: - dirname rootdir of maildir structure - delim delim char for folder structur, default is '.' - folder intial selected folder, default is 'INBOX'
Arguments
- $params
- $params
array mail reader specific parameters
Details
- visibility
- public
- final
- false
- static
- false
- throws
_buildFolderTree
_buildFolderTree(
)
:
nullfind all subfolders and mbox files for folder structure
Result is save in Zend_Mail_Storage_Folder instances with the root in $this->_rootFolder. $parentFolder and $parentGlobalName are only used internally for recursion.
Output
- null
Details
- visibility
- protected
- final
- false
- static
- false
- throws
getCurrentFolder
getCurrentFolder(
)
:
Zend_Mail_Storage_Folderget Zend_Mail_Storage_Folder instance for current folder
Output
- Zend_Mail_Storage_Folder
- instance of current folder
Details
- visibility
- public
- final
- false
- static
- false
- throws
getFolders
getFolders(
string $rootFolder
=
null
)
:
Zend_Mail_Storage_Folderget root folder or given folder
Arguments
- $rootFolder
- string
get folder structure for given folder, else root
Output
- Zend_Mail_Storage_Folder
- root or wanted folder
Details
- visibility
- public
- final
- false
- static
- false
- throws
selectFolder
selectFolder(
Zend_Mail_Storage_Folder|string $globalName
)
:
nullselect given folder
folder must be selectable!
Arguments
- $globalName
- Zend_Mail_Storage_Folderstring
global name of folder or instance for subfolder
Output
- null
Details
- visibility
- public
- final
- false
- static
- false
- throws