__construct()
__destruct()
__get()
__sleep()
__wakeup()
close()
count()
countMessages()
current()
getCapabilities()
getMessage()
getNumberByUniqueId()
getRawContent()
getRawHeader()
getSize()
getUniqueId()
key()
next()
noop()
offsetExists()
offsetGet()
offsetSet()
offsetUnset()
removeMessage()
rewind()
seek()
valid()
getPos()
isMboxFile()
openMboxFile()
$fh
$filemtime
$filename
$has
$iterationMax
$iterationPos
$messageClass
$messageEOL
$positions
__construct(\Zend\Mail\Storage\$params $params)
\Zend\Mail\Storage\$paramsarray mail reader specific parameters
\Zend\Mail\Storage\Exception\InvalidArgumentException |
|---|
__destruct()
| inherited_from | \Zend\Mail\Storage\AbstractStorage::__destruct() |
|---|
__get(string $var) : bool
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
| inherited_from | \Zend\Mail\Storage\AbstractStorage::__get() |
|---|
stringproperty name
\Zend\Mail\Storage\Exception\InvalidArgumentException |
|---|
boolsupported or not__sleep() : array
with this method you can cache the mbox class
arrayname of variables__wakeup()
with this method you can cache the mbox class for cache validation the mtime of the mbox file is used
\Zend\Mail\Storage\Exception\RuntimeException |
|---|
close()
If you need to control, when the resource is closed. Otherwise the destructor would call this.
count() : int
| inherited_from | \Zend\Mail\Storage\AbstractStorage::count() |
|---|
intcountMessages() : int
current() : \Zend\Mail\Storage\Message
| inherited_from | \Zend\Mail\Storage\AbstractStorage::current() |
|---|
\Zend\Mail\Storage\Messagecurrent messagegetCapabilities() : array
| inherited_from | \Zend\Mail\Storage\AbstractStorage::getCapabilities() |
|---|
arraylist of features as array(feature_name => true|false[|null])getMessage(int $id) : \Zend\Mail\Storage\Message\File
intnumber of message
\Zend\Mail\Storage\Exception\ExceptionInterface |
|---|
getNumberByUniqueId(string $id) : int
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\ExceptionInterface |
|---|
intmessage numbergetRawContent(int $id, null | array | string $part) : string
intnumber of message
nullarraystringpath to part or null for message content
stringraw contentgetRawHeader(int $id, null | array | string $part, int $topLines) : string
intnumber of message
nullarraystringpath to part or null for message header
intinclude this many lines with header (after an empty line)
stringraw headergetSize(int | null $id) : int | array
intnullnumber of message or null for all messages
intarraysize of given message of list with all messages as array(num => size)getUniqueId(int | null $id) : array | string
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.
intnullmessage number
\Zend\Mail\Storage\Exception\ExceptionInterface |
|---|
arraystringmessage number for given message or all messages as arraykey() : int
| inherited_from | \Zend\Mail\Storage\AbstractStorage::key() |
|---|
intid of current positionnext()
| inherited_from | \Zend\Mail\Storage\AbstractStorage::next() |
|---|
noop() : bool
boolalways return trueoffsetExists(int $id) : bool
| inherited_from | \Zend\Mail\Storage\AbstractStorage::offsetExists() |
|---|
int
booloffsetGet(int $id) : \Zend\Mail\Storage\Message
| inherited_from | \Zend\Mail\Storage\AbstractStorage::offsetGet() |
|---|
int
\Zend\Mail\Storage\Messagemessage objectoffsetSet(mixed $id, mixed $value)
| inherited_from | \Zend\Mail\Storage\AbstractStorage::offsetSet() |
|---|
mixed
mixed
\Zend\Mail\Storage\Exception\RuntimeException |
|---|
offsetUnset(int $id) : bool
| inherited_from | \Zend\Mail\Storage\AbstractStorage::offsetUnset() |
|---|
int
boolsuccessremoveMessage($id)
rewind()
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.
| inherited_from | \Zend\Mail\Storage\AbstractStorage::rewind() |
|---|
seek(int $pos)
| inherited_from | \Zend\Mail\Storage\AbstractStorage::seek() |
|---|
int
\Zend\Mail\Storage\Exception\OutOfBoundsException |
|---|
valid() : bool
| inherited_from | \Zend\Mail\Storage\AbstractStorage::valid() |
|---|
boolgetPos(int $id) : array
intnumber of message
\Zend\Mail\Storage\Exception\InvalidArgumentException |
|---|
arraypositions as in positionsisMboxFile(resource | string $file, bool $fileIsString) : bool
if $file is a resource its file pointer is moved after the first line
resourcestringstream resource of name of file
boolfile is string or resource
boolfile is mbox fileopenMboxFile(string $filename)
stringfilename of mbox file
\Zend\Mail\Storage\Exception\RuntimeException |
|
|---|---|
\Zend\Mail\Storage\Exception\InvalidArgumentException |
$fh : null | resource
$filemtime : int
$filename : string
$has : array
| inherited_from | \Zend\Mail\Storage\AbstractStorage::$$has |
|---|
$iterationMax : null | int
| inherited_from | \Zend\Mail\Storage\AbstractStorage::$$iterationMax |
|---|
$iterationPos : int
| inherited_from | \Zend\Mail\Storage\AbstractStorage::$$iterationPos |
|---|
$positions : array