Mail/Storage/Folder/Mbox.php

Show: PublicProtectedPrivateinherited
Table of Contents
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.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Mail  
Subpackage
Storage  
Version
$Id: Mbox.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Mail_Storage_Folder_Mbox

Package: Zend\Mail\Storage
Implements
\Zend_Mail_Storage_Folder_Interface
Parent(s)
\Zend_Mail_Storage_Mbox < \Zend_Mail_Storage_Abstract
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotectedstring $_currentFolder
name of current folder
Details
Type
string
>VPropertyprotectednull|resource $_fh
inherited
file handle to mbox file
Inherited from: \Zend_Mail_Storage_Mbox::$$_fh
Details
Type
null | resource
Inherited_from
\Zend_Mail_Storage_Mbox::$$_fh  
>VPropertyprotectedint $_filemtime
inherited
modification date of mbox file for __wakeup
Inherited from: \Zend_Mail_Storage_Mbox::$$_filemtime
Details
Type
int
Inherited_from
\Zend_Mail_Storage_Mbox::$$_filemtime  
>VPropertyprotectedstring $_filename
inherited
filename of mbox file for __wakeup
Inherited from: \Zend_Mail_Storage_Mbox::$$_filename
Details
Type
string
Inherited_from
\Zend_Mail_Storage_Mbox::$$_filename  
>VPropertyprotectedarray $_has = array('uniqueid' => true, 'delete' => false, 'create' => false, 'top' => false, 'fetchPart' => true, 'flags' => false)
inherited
class capabilities with default values
Inherited from: \Zend_Mail_Storage_Abstract::$$_has\Zend_Mail_Storage_Mbox::$$_has
Default valuearray('uniqueid' => true, 'delete' => false, 'create' => false, 'top' => false, 'fetchPart' => true, 'flags' => false)Details
Type
array
Inherited_from
\Zend_Mail_Storage_Abstract::$$_has  
Inherited_from
\Zend_Mail_Storage_Mbox::$$_has  
>VPropertyprotectednull|int $_iterationMax = null
inherited
maximum iteration position (= message count)
Inherited from: \Zend_Mail_Storage_Abstract::$$_iterationMax\Zend_Mail_Storage_Mbox::$$_iterationMax
Default valuenullDetails
Type
null | int
Inherited_from
\Zend_Mail_Storage_Abstract::$$_iterationMax  
Inherited_from
\Zend_Mail_Storage_Mbox::$$_iterationMax  
>VPropertyprotectedint $_iterationPos = 0
Default value0Details
Type
int
Inherited_from
\Zend_Mail_Storage_Abstract::$$_iterationPos  
Inherited_from
\Zend_Mail_Storage_Mbox::$$_iterationPos  
>VPropertyprotectedstring $_messageClass = 'Zend_Mail_Message_File'
inherited
used message class, change it in an extened class to extend the returned message class
Inherited from: \Zend_Mail_Storage_Mbox::$$_messageClass
Default value'Zend_Mail_Message_File'Details
Type
string
Inherited_from
\Zend_Mail_Storage_Mbox::$$_messageClass  
>VPropertyprotectedarray $_positions
inherited
start and end position of messages as array('start' => start, 'seperator' => headersep, 'end' => end)
Inherited from: \Zend_Mail_Storage_Mbox::$$_positions
Details
Type
array
Inherited_from
\Zend_Mail_Storage_Mbox::$$_positions  
>VPropertyprotected\Zend_Mail_Storage_Folder $_rootFolder
Zend_Mail_Storage_Folder root folder for folder structure
>VPropertyprotectedstring $_rootdir
rootdir of folder structure
Details
Type
string

Methods

methodpublic__construct(array $params) : void

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'

Parameters
NameTypeDescription
$paramsarray

mail reader specific parameters

Throws
ExceptionDescription
\Zend_Mail_Storage_Exception
methodpublic__destruct() : void
inherited

Destructor calls close() and therefore closes the resource.

Inherited from: \Zend_Mail_Storage_Abstract::__destruct()\Zend_Mail_Storage_Mbox::__destruct()
methodpublic__get(string $var) : bool
inherited

Getter for has-properties.

Inherited from: \Zend_Mail_Storage_Abstract::__get()\Zend_Mail_Storage_Mbox::__get()

The standard has properties are: hasFolder, hasUniqueid, hasDelete, hasCreate, hasTop

The valid values for the has-properties are: - true if a feature is supported - false if a feature is not supported - null is it's not yet known or it can't be know if a feature is supported

Parameters
NameTypeDescription
$varstring

property name

Returns
TypeDescription
boolsupported or not
Throws
ExceptionDescription
\Zend_Mail_Storage_Exception
methodpublic__sleep() : array

magic method for serialize()

with this method you can cache the mbox class

Returns
TypeDescription
arrayname of variables
methodpublic__wakeup() : null

magic method for unserialize()

with this method you can cache the mbox class

Returns
TypeDescription
null
Throws
ExceptionDescription
\Zend_Mail_Storage_Exception
methodprotected_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.

Parameters
NameTypeDescription
$currentDirstring

call with root dir, also used for recursion.

$parentFolder\Zend_Mail_Storage_Folder | null

used for recursion

$parentGlobalNamestring

used for rescursion

Returns
TypeDescription
null
Throws
ExceptionDescription
\Zend_Mail_Storage_Exception
methodprotected_getPos(int $id) : array
inherited

Get positions for mail message or throw exeption if id is invalid

Inherited from: \Zend_Mail_Storage_Mbox::_getPos()
Parameters
NameTypeDescription
$idint

number of message

Returns
TypeDescription
arraypositions as in _positions
Throws
ExceptionDescription
\Zend_Mail_Storage_Exception
methodprotected_isMboxFile(resource | string $file, bool $fileIsString = true) : bool
inherited

check if given file is a mbox file

Inherited from: \Zend_Mail_Storage_Mbox::_isMboxFile()

if $file is a resource its file pointer is moved after the first line

Parameters
NameTypeDescription
$fileresource | string

stream resource of name of file

$fileIsStringbool

file is string or resource

Returns
TypeDescription
boolfile is mbox file
methodprotected_openMboxFile(string $filename) : null
inherited

open given file as current mbox file

Inherited from: \Zend_Mail_Storage_Mbox::_openMboxFile()
Parameters
NameTypeDescription
$filenamestring

filename of mbox file

Returns
TypeDescription
null
Throws
ExceptionDescription
\Zend_Mail_Storage_Exception
methodpublicclose() : void
inherited

Close resource for mail lib.

Inherited from: \Zend_Mail_Storage_Mbox::close()

If you need to control, when the resource is closed. Otherwise the destructor would call this.

methodpubliccount() : int
Returns
TypeDescription
int
methodpubliccountMessages() : int
inherited

Count messages all messages in current box

Inherited from: \Zend_Mail_Storage_Mbox::countMessages()
Returns
TypeDescription
intnumber of messages
Throws
ExceptionDescription
\Zend_Mail_Storage_Exception
methodpubliccurrent() : \Zend_Mail_Message
Returns
TypeDescription
\Zend_Mail_Messagecurrent message
methodpublicgetCapabilities() : array
inherited

Get a full list of features supported by the specific mail lib and the server

Inherited from: \Zend_Mail_Storage_Abstract::getCapabilities()\Zend_Mail_Storage_Mbox::getCapabilities()
Returns
TypeDescription
arraylist of features as array(featurename => true|false[|null])
methodpublicgetCurrentFolder() : \Zend_Mail_Storage_Folder

get Zend_Mail_Storage_Folder instance for current folder

Returns
TypeDescription
\Zend_Mail_Storage_Folderinstance of current folder
Throws
ExceptionDescription
\Zend_Mail_Storage_Exception
methodpublicgetFolders(string $rootFolder = null) : \Zend_Mail_Storage_Folder

get root folder or given folder

Parameters
NameTypeDescription
$rootFolderstring

get folder structure for given folder, else root

Returns
TypeDescription
\Zend_Mail_Storage_Folderroot or wanted folder
Throws
ExceptionDescription
\Zend_Mail_Storage_Exception
methodpublicgetMessage(int $id) : \Zend_Mail_Message_File
inherited

Fetch a message

Inherited from: \Zend_Mail_Storage_Mbox::getMessage()
Parameters
NameTypeDescription
$idint

number of message

Returns
TypeDescription
\Zend_Mail_Message_File
Throws
ExceptionDescription
\Zend_Mail_Storage_Exception
methodpublicgetNumberByUniqueId(string $id) : int
inherited

get a message number from a unique id

Inherited from: \Zend_Mail_Storage_Mbox::getNumberByUniqueId()

I.e. if you have a webmailer that supports deleting messages you should use unique ids as parameter and use this method to translate it to message number right before calling removeMessage()

Parameters
NameTypeDescription
$idstring

unique id

Returns
TypeDescription
intmessage number
Throws
ExceptionDescription
\Zend_Mail_Storage_Exception
methodpublicgetRawContent(int $id, null | array | string $part = null) : string
inherited

Get raw content of message or part

Inherited from: \Zend_Mail_Storage_Mbox::getRawContent()
Parameters
NameTypeDescription
$idint

number of message

$partnull | array | string

path to part or null for messsage content

Returns
TypeDescription
stringraw content
methodpublicgetRawHeader(int $id, null | array | string $part = null, int $topLines = 0) : string
inherited

Get raw header of message or part

Inherited from: \Zend_Mail_Storage_Mbox::getRawHeader()
Parameters
NameTypeDescription
$idint

number of message

$partnull | array | string

path to part or null for messsage header

$topLinesint

include this many lines with header (after an empty line)

Returns
TypeDescription
stringraw header
methodpublicgetSize(int | null $id = 0) : int | array
inherited

Get a list of messages with number and size

Inherited from: \Zend_Mail_Storage_Mbox::getSize()
Parameters
NameTypeDescription
$idint | null

number of message or null for all messages

Returns
TypeDescription
int | arraysize of given message of list with all messages as array(num => size)
methodpublicgetUniqueId(int | null $id = null) : array | string
inherited

get unique id for one or all messages

Inherited from: \Zend_Mail_Storage_Mbox::getUniqueId()

Mbox does not support unique ids (yet) - it's always the same as the message number. That shouldn't be a problem, because we can't change mbox files. Therefor the message number is save enough.

Parameters
NameTypeDescription
$idint | null

message number

Returns
TypeDescription
array | stringmessage number for given message or all messages as array
Throws
ExceptionDescription
\Zend_Mail_Storage_Exception
methodpublickey() : int
Returns
TypeDescription
intid of current position
methodpublicnext() : void
methodpublicnoop() : void
inherited

Waste some CPU cycles doing nothing.

Inherited from: \Zend_Mail_Storage_Mbox::noop()
methodpublicoffsetExists(int $id) : boolean
Parameters
NameTypeDescription
$idint
Returns
TypeDescription
boolean
methodpublicoffsetGet(int $id) : \Zend_Mail_Message
Parameters
NameTypeDescription
$idint
Returns
TypeDescription
\Zend_Mail_Messagemessage object
methodpublicoffsetSet(\id $id, mixed $value) : void
Parameters
NameTypeDescription
$id\id
$valuemixed
Throws
ExceptionDescription
\Zend_Mail_Storage_Exception
methodpublicoffsetUnset(int $id) : boolean
Parameters
NameTypeDescription
$idint
Returns
TypeDescription
booleansuccess
methodpublicremoveMessage( $id) : null
inherited

stub for not supported message deletion

Inherited from: \Zend_Mail_Storage_Mbox::removeMessage()
Parameters
NameTypeDescription
$id
Returns
TypeDescription
null
Throws
ExceptionDescription
\Zend_Mail_Storage_Exception
methodpublicrewind() : void

Rewind always gets the new count from the storage. Thus if you use the interfaces and your scripts take long you should use reset() from time to time.

methodpublicseek(int $pos) : void
inherited

SeekableIterator::seek()

Inherited from: \Zend_Mail_Storage_Abstract::seek()\Zend_Mail_Storage_Mbox::seek()
Parameters
NameTypeDescription
$posint
Throws
ExceptionDescription
\OutOfBoundsException
methodpublicselectFolder(\Zend_Mail_Storage_Folder | string $globalName) : null

select given folder

folder must be selectable!

Parameters
NameTypeDescription
$globalName\Zend_Mail_Storage_Folder | string

global name of folder or instance for subfolder

Returns
TypeDescription
null
Throws
ExceptionDescription
\Zend_Mail_Storage_Exception
methodpublicvalid() : boolean
Returns
TypeDescription
boolean
Documentation was generated by phpDocumentor 2.0.0a12.