category | Zend |
---|---|
package | Zend_Mail |
subpackage | Storage |
copyright | Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) |
license | New BSD License |
inherited_from | \Zend_Mail_Storage_Mbox |
__construct(array $params)
Disallowed parameters are:
inherited_from | \Zend_Mail_Storage_Mbox::__construct() |
---|
array
mail reader specific parameters
\Zend_Mail_Storage_Exception |
---|
__construct(array $params)
array
mail reader specific parameters
\Zend_Mail_Storage_Exception |
---|
__destruct()
__get(string $var) : boolean
The valid values for the has-properties are:
string
property name
\Zend_Mail_Storage_Exception |
---|
boolean
supported or not__sleep() : array
with this method you can cache the mbox class
inherited_from | \Zend_Mail_Storage_Mbox::__sleep() |
---|
array
name of variables__sleep() : array
with this method you can cache the mbox class
array
name of variables__wakeup() : null
with this method you can cache the mbox class
inherited_from | \Zend_Mail_Storage_Mbox::__wakeup() |
---|
null
__wakeup() : null
with this method you can cache the mbox class for cache validation the mtime of the mbox file is used
\Zend_Mail_Storage_Exception |
---|
null
close() : null
null
count() : integer
integer
countMessages() : integer
\Zend_Mail_Storage_Exception |
---|
integer
number of messagescurrent() : \Zend_Mail_Message
\Zend_Mail_Message
current messagegetCapabilities() : array
array
list of features as array(featurename => true|false[|null])getCurrentFolder() : \Zend_Mail_Storage_Folder
inherited_from | \Zend_Mail_Storage_Folder_Interface::getCurrentFolder() |
---|
\Zend_Mail_Storage_Exception |
---|
\Zend_Mail_Storage_Folder
instance of current foldergetFolders(string $rootFolder = null
) : \Zend_Mail_Storage_Folder
inherited_from | \Zend_Mail_Storage_Folder_Interface::getFolders() |
---|
string
get folder structure for given folder, else root
\Zend_Mail_Storage_Exception |
---|
\Zend_Mail_Storage_Folder
root or wanted foldergetMessage(integer $id) : \Zend_Mail_Message
integer
number of message
\Zend_Mail_Message
getNumberByUniqueId(string $id) : integer
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()
string
unique id
\Zend_Mail_Storage_Exception |
---|
integer
message numbergetRawContent(integer $id, null|array|string $part = null
) : string
integer
number of message
null
array
string
path to part or null for messsage content
string
raw contentgetRawHeader(integer $id, null|array|string $part= null
, integer $topLines= 0
) : string
integer
number of message
null
array
string
path to part or null for messsage header
integer
include this many lines with header (after an empty line)
string
raw headergetSize(integer $id = 0
) : integer | array
integer
number of message
integer
array
size of given message of list with all messages as array(num => size)getUniqueId(integer|null $id = null
) : array | string
if storage does not support unique ids it's the same as the message number
integer
null
message number
\Zend_Mail_Storage_Exception |
---|
array
string
message number for given message or all messages as arraykey() : integer
integer
id of current positionnext() : void
noop() : null
null
offsetExists(integer $id) : boolean
integer
boolean
offsetGet(integer $id) : \Zend_Mail_Message
integer
\Zend_Mail_Message
message objectoffsetSet(\id $id, mixed $value) : void
\id
mixed
\Zend_Mail_Storage_Exception |
---|
offsetUnset(integer $id) : boolean
integer
boolean
successremoveMessage($id) : null
null
rewind() : 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.
seek(integer $pos) : void
integer
\OutOfBoundsException |
---|
selectFolder(\Zend_Mail_Storage_Folder|string $globalName) : null
folder must be selectable!
inherited_from | \Zend_Mail_Storage_Folder_Interface::selectFolder() |
---|
\Zend_Mail_Storage_Folder
string
global name of folder or instance for subfolder
\Zend_Mail_Storage_Exception |
---|
null
valid() : boolean
boolean
_buildFolderTree(string $currentDir, \Zend_Mail_Storage_Folder|null $parentFolder= null
, string $parentGlobalName= ''
) : null
Result is save in Zend_Mail_Storage_Folder instances with the root in $this->_rootFolder. $parentFolder and $parentGlobalName are only used internally for recursion.
string
call with root dir, also used for recursion.
\Zend_Mail_Storage_Folder
null
used for recursion
string
used for rescursion
\Zend_Mail_Storage_Exception |
---|
null
_getPos(integer $id) : array
integer
number of message
\Zend_Mail_Storage_Exception |
---|
array
positions as in _positions_isMboxFile(resource|string $file, boolean $fileIsString = true
) : boolean
if $file is a resource its file pointer is moved after the first line
resource
string
stream resource of name of file
boolean
file is string or resource
boolean
file is mbox file_openMboxFile(string $filename) : null
string
filename of mbox file
\Zend_Mail_Storage_Exception |
---|
null
$_currentFolder : string
$_fh : null | resource
$_filemtime : integer
$_filename : string
$_has : array
array('uniqueid' => true, 'delete' => false, 'create' => false, 'top' => false, 'fetchPart' => true, 'flags' => false)
$_iterationMax : null | integer
null
$_iterationPos : integer
0
$_positions : array
$_rootFolder : \Zend_Mail_Storage_Folder
$_rootdir : string