Count messages all messages in current box
Return type: | int number of messages |
---|---|
Throws : | ZendMailStorageExceptionExceptionInterface |
Get a list of messages with number and size
Parameters: | int|null – number of message or null for all messages |
---|---|
Return type: | int|array size of given message of list with all messages as array(num => size) |
Get positions for mail message or throw exception if id is invalid
Parameters: | int – number of message |
---|---|
Throws ExceptionInvalidArgumentException: | |
Return type: | array positions as in positions |
Fetch a message
Parameters: | int – number of message |
---|---|
Return type: | ZendMailStorageMessageFile |
Throws : | ZendMailStorageExceptionExceptionInterface |
Create instance with parameters Supported parameters are:
- filename filename of mbox file
Parameters: | $params – mail reader specific parameters |
---|---|
Throws ExceptionInvalidArgumentException: | |
check if given file is a mbox file
if $file is a resource its file pointer is moved after the first line
Parameters: |
|
---|---|
Return type: | bool file is mbox file |
open given file as current mbox file
Parameters: | string – filename of mbox file |
---|---|
Throws ExceptionRuntimeException: | |
Throws ExceptionInvalidArgumentException: | |
Close resource for mail lib. If you need to control, when the resource is closed. Otherwise the destructor would call this.
Waste some CPU cycles doing nothing.
Return type: | bool always return true |
---|
stub for not supported message deletion
Parameters: | $id – |
---|---|
Throws ExceptionRuntimeException: | |
get unique id for one or all messages
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: | int|null – message number |
---|---|
Return type: | array|string message number for given message or all messages as array |
Throws : | ZendMailStorageExceptionExceptionInterface |
get a message number from a unique id
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: | string – unique id |
---|---|
Return type: | int message number |
Throws : | ZendMailStorageExceptionExceptionInterface |