Count messages all messages in current box
| Parameters: | mixed – |
|---|---|
| Return type: | int number of messages |
Get one or all fields from file structure. Also checks if message is valid
| Parameters: |
|
|---|---|
| Throws ExceptionInvalidArgumentException: | |
| Return type: | string|array wanted field or all fields as array |
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) |
Fetch a message
| Parameters: | int – number of message |
|---|---|
| Return type: | ZendMailStorageMessageFile |
| Throws : | ZendMailStorageExceptionExceptionInterface |
Create instance with parameters Supported parameters are:
- dirname dirname of mbox file
| Parameters: | $params – mail reader specific parameters |
|---|---|
| Throws ExceptionInvalidArgumentException: | |
check if a given dir is a valid maildir
| Parameters: | string – name of dir |
|---|---|
| Return type: | bool dir is valid maildir |
open given dir as current maildir
| Parameters: | string – name of maildir |
|---|---|
| Throws ExceptionRuntimeException: | |
find all files in opened dir handle and add to maildir files
| Parameters: |
|
|---|
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
if storage does not support unique ids it’s the same as the message number
| Parameters: | int|null – message number |
|---|---|
| Return type: | array|string message number for given message or all messages as array |
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 |
|---|---|
| Throws ExceptionInvalidArgumentException: | |
| Return type: | int message number |