| 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_Abstract |
__construct(array $params)
| inherited_from | \Zend_Mail_Storage_Abstract::__construct() |
|---|
arraymail reader specific parameters
\Zend_Mail_Storage_Exception |
|---|
__construct(array $params)
arraymail reader specific parameters
\Zend_Mail_Storage_Exception |
|---|
__destruct()
__get(string $var) : boolean
The valid values for the has-properties are:
stringproperty name
\Zend_Mail_Storage_Exception |
|---|
booleansupported or notclose() : void
| inherited_from | \Zend_Mail_Storage_Abstract::close() |
|---|
close() : null
nullcount() : integer
integercountMessages($flags = null) : integer
| inherited_from | \Zend_Mail_Storage_Abstract::countMessages() |
|---|
\Zend_Mail_Storage_Exception |
|---|
integernumber of messagescountMessages() : integer
\Zend_Mail_Storage_Exception |
|---|
integernumber of messagescurrent() : \Zend_Mail_Message
\Zend_Mail_Messagecurrent messagegetCapabilities() : array
arraylist of features as array(featurename => true|false[|null])getMessage(integer $id) : \Zend_Mail_Message_File
| inherited_from | \Zend_Mail_Storage_Abstract::getMessage() |
|---|
integernumber of message
\Zend_Mail_Storage_Exception |
|---|
\Zend_Mail_Message_FilegetMessage(integer $id) : \Zend_Mail_Message
integernumber of message
\Zend_Mail_MessagegetNumberByUniqueId(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()
| inherited_from | \Zend_Mail_Storage_Abstract::getNumberByUniqueId() |
|---|
stringunique id
\Zend_Mail_Storage_Exception |
|---|
integermessage numbergetNumberByUniqueId(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()
stringunique id
\Zend_Mail_Storage_Exception |
|---|
integermessage numbergetRawContent(integer $id, null|array|string $part = null)
| inherited_from | \Zend_Mail_Storage_Abstract::getRawContent() |
|---|
getRawContent(integer $id, null|array|string $part = null) : string
integernumber of message
nullarraystringpath to part or null for messsage content
stringraw contentgetRawHeader(integer $id, null|array|string $part= null, integer $topLines= 0)
| inherited_from | \Zend_Mail_Storage_Abstract::getRawHeader() |
|---|
getRawHeader(integer $id, null|array|string $part= null, integer $topLines= 0) : string
integernumber of message
nullarraystringpath to part or null for messsage header
integerinclude this many lines with header (after an empty line)
stringraw headergetSize(integer|null $id = null) : integer | array
| inherited_from | \Zend_Mail_Storage_Abstract::getSize() |
|---|
integernullnumber of message or null for all messages
\Zend_Mail_Storage_Exception |
|---|
integerarraysize of given message of list with all messages as array(num => size)getSize(integer $id = 0) : integer | array
integernumber of message
integerarraysize 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
| inherited_from | \Zend_Mail_Storage_Abstract::getUniqueId() |
|---|
integernullmessage number
\Zend_Mail_Storage_Exception |
|---|
arraystringmessage number for given message or all messages as arraygetUniqueId(integer|null $id = null) : array | string
if storage does not support unique ids it's the same as the message number
integernullmessage number
\Zend_Mail_Storage_Exception |
|---|
arraystringmessage number for given message or all messages as arraykey() : integer
integerid of current positionnext() : void
noop() : void
| inherited_from | \Zend_Mail_Storage_Abstract::noop() |
|---|
noop() : null
nulloffsetExists(integer $id) : boolean
integer
booleanoffsetGet(integer $id) : \Zend_Mail_Message
integer
\Zend_Mail_Messagemessage objectoffsetSet(\id $id, mixed $value) : void
\id
mixed
\Zend_Mail_Storage_Exception |
|---|
offsetUnset(integer $id) : boolean
integer
booleansuccessremoveMessage($id) : null
| inherited_from | \Zend_Mail_Storage_Abstract::removeMessage() |
|---|
\Zend_Mail_Storage_Exception |
|---|
nullremoveMessage($id) : null
nullrewind() : 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 |
|---|
valid() : boolean
boolean_getFileData(integer $id, string|null $field = null) : string | array
integermessage number
stringnullwanted field
\Zend_Mail_Storage_Exception |
|---|
stringarraywanted field or all fields as array_getMaildirFiles(resource $dh, string $dirname, array $default_flags = array()) : null
resourcedir handle used for search
stringdirname of dir in $dh
arraydefault flags for given dir
null_isMaildir(string $dirname) : boolean
stringname of dir
booleandir is valid maildir_openMaildir(string $dirname) : null
stringname of maildir
\Zend_Mail_Storage_Exception |
|---|
null$_files : array
array()$_has : array
array('uniqueid' => true, 'delete' => false, 'create' => false, 'top' => false, 'fetchPart' => true, 'flags' => false)$_iterationMax : null | integer
null$_iterationPos : integer
0$_knownFlags : array
array('D' => \Zend_Mail_Storage::FLAG_DRAFT, 'F' => \Zend_Mail_Storage::FLAG_FLAGGED, 'P' => \Zend_Mail_Storage::FLAG_PASSED, 'R' => \Zend_Mail_Storage::FLAG_ANSWERED, 'S' => \Zend_Mail_Storage::FLAG_SEEN, 'T' => \Zend_Mail_Storage::FLAG_DELETED)This list has to be in alphabetical order for setFlags()