Getter for has-properties. The standard has properties are: hasFolder, hasUniqueid, hasDelete, hasCreate, hasTop
| Parameters: | string – property name |
|---|---|
| Throws ExceptionInvalidArgumentException: | |
| Return type: | bool supported or not |
Count messages messages in current box/folder
| Return type: | int number of messages |
|---|---|
| Throws : | ExceptionExceptionInterface |
Get a list of messages with number and size
| Parameters: | int – number of message |
|---|---|
| Return type: | int|array size of given message of list with all messages as array(num => size) |
Get a message with headers and body
| Parameters: | $id – number of message |
|---|---|
| Return type: | Message |
Get raw header of message or part
| Parameters: |
|
|---|---|
| Return type: | string raw header |
Get raw content of message or part
| Parameters: |
|
|---|---|
| Return type: | string raw content |
Create instance with parameters
| Parameters: | array – mail reader specific parameters |
|---|---|
| Throws ExceptionExceptionInterface: | |
Close resource for mail lib. If you need to control, when the resource is closed. Otherwise the destructor would call this.
Keep the resource alive.
delete a message from current box/folder
| Parameters: | $id – |
|---|
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 |
| Throws : | ExceptionExceptionInterface |
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 : | ExceptionExceptionInterface |
Countable::count()
| Return type: | int |
|---|
ArrayAccess::offsetExists()
| Parameters: | int – |
|---|---|
| Return type: | boolean |
ArrayAccess::offsetGet()
| Parameters: | int – |
|---|---|
| Return type: | ZendMailStorageMessage message object |
ArrayAccess::offsetSet()
| Parameters: |
|
|---|---|
| Throws ExceptionRuntimeException: | |
ArrayAccess::offsetUnset()
| Parameters: | int – |
|---|---|
| Return type: | boolean success |
Iterator::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.
Iterator::current()
| Return type: | Message current message |
|---|
Iterator::key()
| Return type: | int id of current position |
|---|
Iterator::next()
Iterator::valid()
| Return type: | bool |
|---|
SeekableIterator::seek()
| Parameters: | int – |
|---|---|
| Throws ExceptionOutOfBoundsException: | |