package Default

 Methods

Create instance with parameters

__construct(array $params) 

Parameters

$params

array

mail reader specific parameters

Exceptions

\Zend\Mail\Storage\Exception\ExceptionInterface

Destructor calls close() and therefore closes the resource.

__destruct() 

Getter for has-properties. The standard has properties are: hasFolder, hasUniqueid, hasDelete, hasCreate, hasTop

__get(string $var) : boolean

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

Parameters

$var

string

property name

Exceptions

\Zend\Mail\Storage\Exception\InvalidArgumentException

Returns

booleansupported or not

Close resource for mail lib. If you need to control, when the resource is closed. Otherwise the destructor would call this.

close() 

Countable::count()

count() : integer

Returns

integer

Count messages messages in current box/folder

countMessages() : integer

Exceptions

\Zend\Mail\Storage\Exception\ExceptionInterface

Returns

integernumber of messages

Iterator::current()

current() : \Zend\Mail\Storage\Message

Returns

\Zend\Mail\Storage\Messagecurrent message

Get a full list of features supported by the specific mail lib and the server

getCapabilities() : array

Returns

arraylist of features as array(feature_name => true|false[|null])

Get a message with headers and body

getMessage($id) : \Zend\Mail\Storage\Message

Parameters

$id

int number of message

Returns

\Zend\Mail\Storage\Message

get a message number from a unique id

getNumberByUniqueId(string $id) : integer

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

$id

string

unique id

Exceptions

\Zend\Mail\Storage\Exception\ExceptionInterface

Returns

integermessage number

Get raw content of message or part

getRawContent(integer $id, null|array|string $part = null) : string

Parameters

$id

integer

number of message

$part

nullarraystring

path to part or null for message content

Returns

stringraw content

Get raw header of message or part

getRawHeader(integer $id, null|array|string $part = null, integer $topLines = 0) : string

Parameters

$id

integer

number of message

$part

nullarraystring

path to part or null for message header

$topLines

integer

include this many lines with header (after an empty line)

Returns

stringraw header

Get a list of messages with number and size

getSize(integer $id = 0) : integer | array

Parameters

$id

integer

number of message

Returns

integerarraysize of given message of list with all messages as array(num => size)

get unique id for one or all messages

getUniqueId(integer|null $id = null) : array | string

if storage does not support unique ids it's the same as the message number

Parameters

$id

integernull

message number

Exceptions

\Zend\Mail\Storage\Exception\ExceptionInterface

Returns

arraystringmessage number for given message or all messages as array

Iterator::key()

key() : integer

Returns

integerid of current position

Iterator::next()

next() 

Keep the resource alive.

noop() 

ArrayAccess::offsetExists()

offsetExists(integer $id) : boolean

Parameters

$id

integer

Returns

boolean

ArrayAccess::offsetGet()

offsetGet(integer $id) : \Zend\Mail\Storage\Message

Parameters

$id

integer

Returns

\Zend\Mail\Storage\Messagemessage object

ArrayAccess::offsetSet()

offsetSet(mixed $id, mixed $value) 

Parameters

$id

mixed

$value

mixed

Exceptions

\Zend\Mail\Storage\Exception\RuntimeException

ArrayAccess::offsetUnset()

offsetUnset(integer $id) : boolean

Parameters

$id

integer

Returns

booleansuccess

delete a message from current box/folder

removeMessage($id) 

Parameters

$id

Iterator::rewind()

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.

SeekableIterator::seek()

seek(integer $pos) 

Parameters

$pos

integer

Exceptions

\Zend\Mail\Storage\Exception\OutOfBoundsException

Iterator::valid()

valid() : boolean

Returns

boolean

 Properties

 

class capabilities with default values

$has : array

Default

array('uniqueid' => true, 'delete' => false, 'create' => false, 'top' => false, 'fetchPart' => true, 'flags' => false)
 

maximum iteration position (= message count)

$iterationMax : null | integer

Default

null
 

current iteration position

$iterationPos : integer

Default

0
 

used message class, change it in an extended class to extend the returned message class

$messageClass : string

Default

'Zend\Mail\Storage\Message'