Mail/Storage/Folder/Mbox.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: Mbox.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Mail_Storage_Folder_Mbox

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_Mbox
jump to top

Extends from: Zend_Mail_Storage_Mbox
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
Methods: __construct; _buildFolderTree; getFolders; selectFolder; getCurrentFolder; __sleep; __wakeup

Description

Properties

$_currentFolder
jump to class

string $_currentFolder = ''

name of current folder

Details

$_currentFolder: string
visibility: protected
default
final: false
static: false

$_rootFolder
jump to class

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
jump to class

string $_rootdir = ''

rootdir of folder structure

Details

$_rootdir: string
visibility: protected
default
final: false
static: false

Methods

__construct
jump to class

__construct(
          $params $params
          )
        
        :

Create instance with parameters

Disallowed parameters are: - filename use Zend_Mail_Storage_Mbox for a single file Supported parameters are: - dirname rootdir of mbox structure - folder intial selected folder, default is 'INBOX'

Arguments

$params: $params
array mail reader specific parameters

Details

visibility: public
final: false
static: false
throws

__sleep
jump to class

__sleep(
          
          )
        
        :
        array

magic method for serialize()

with this method you can cache the mbox class

Output

array: name of variables

Details

visibility: public
final: false
static: false

__wakeup
jump to class

__wakeup(
          
          )
        
        :
        null

magic method for unserialize()

with this method you can cache the mbox class

Output

null

Details

visibility: public
final: false
static: false

_buildFolderTree
jump to class

_buildFolderTree(
          string $currentDir, Zend_Mail_Storage_Folder|null $parentFolder
              =
              null, string $parentGlobalName
          )
        
        :
        null

find 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.

Arguments

$currentDir: string
call with root dir, also used for recursion.
$parentFolder: Zend_Mail_Storage_Foldernull
used for recursion
$parentGlobalName: string
used for rescursion

Output

null

Details

visibility: protected
final: false
static: false
throws

getCurrentFolder
jump to class

getCurrentFolder(
          
          )
        
        :
        Zend_Mail_Storage_Folder

get 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
jump to class

getFolders(
          string $rootFolder
              =
              null
          )
        
        :
        Zend_Mail_Storage_Folder

get 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
jump to class

selectFolder(
          Zend_Mail_Storage_Folder|string $globalName
          )
        
        :
        null

select 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

API Documentation

Mail/Storage/Folder/Mbox.php

Description

Zend_Mail_Storage_Folder_Mboxjump to top

Description

Properties

$_currentFolderjump to class

Details

$_rootFolderjump to class

Details

$_rootdirjump to class

Details

Methods

__constructjump to class

Arguments

Details

__sleepjump to class

Output

Details

__wakeupjump to class

Output

Details

_buildFolderTreejump to class

Arguments

Output

Details

getCurrentFolderjump to class

Output

Details

getFoldersjump to class

Arguments

Output

Details

selectFolderjump to class

Arguments

Output

Details

Zend_Mail_Storage_Folder_Mbox
jump to top

$_currentFolder
jump to class

$_rootFolder
jump to class

$_rootdir
jump to class

__construct
jump to class

__sleep
jump to class

__wakeup
jump to class

_buildFolderTree
jump to class

getCurrentFolder
jump to class

getFolders
jump to class

selectFolder
jump to class