__construct()
__destruct()
__get()
close()
count()
countMessages()
current()
getCapabilities()
getMessage()
getNumberByUniqueId()
getRawContent()
getRawHeader()
getSize()
getUniqueId()
key()
next()
noop()
offsetExists()
offsetGet()
offsetSet()
offsetUnset()
removeMessage()
rewind()
seek()
valid()
$has
$iterationMax
$iterationPos
$messageClass
__construct(array $params)
arraymail reader specific parameters
\Zend\Mail\Storage\Exception\ExceptionInterface |
|---|
__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
stringproperty name
\Zend\Mail\Storage\Exception\InvalidArgumentException |
|---|
boolsupported or notclose()
If you need to control, when the resource is closed. Otherwise the destructor would call this.
count() : int
intcountMessages() : int
current() : \Zend\Mail\Storage\Message
\Zend\Mail\Storage\Messagecurrent messagegetCapabilities() : array
arraylist of features as array(feature_name => true|false[|null])getMessage(\Zend\Mail\Storage\$id $id) : \Zend\Mail\Storage\Message
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 $id) : int | array
intnumber of message
intarraysize of given message of list with all messages as array(num => size)getUniqueId(int | null $id) : array | string
if storage does not support unique ids it's the same as the message number
intnullmessage number
\Zend\Mail\Storage\Exception\ExceptionInterface |
|---|
arraystringmessage number for given message or all messages as arraykey() : int
intid of current positionnext()
noop()
offsetExists(int $id) : bool
int
booloffsetSet(mixed $id, mixed $value)
offsetUnset(int $id) : bool
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.
seek(int $pos)
valid() : bool
bool$has : array
$iterationMax : null | int
$iterationPos : int