Methods

Create instance with parameters Supported parameters are: - filename filename of mbox file

__construct(\Zend\Mail\Storage\$params $params) 

Parameters

$params

\Zend\Mail\Storage\$params

array mail reader specific parameters

Exceptions

\Zend\Mail\Storage\Exception\InvalidArgumentException

Destructor calls close() and therefore closes the resource.

__destruct() 
Inherited

inherited_from \Zend\Mail\Storage\AbstractStorage::__destruct()

Getter for has-properties.

__get(string $var) : bool
Inherited

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

inherited_from \Zend\Mail\Storage\AbstractStorage::__get()

Parameters

$var

string

property name

Exceptions

\Zend\Mail\Storage\Exception\InvalidArgumentException

Returns

boolsupported or not

magic method for serialize()

__sleep() : array

with this method you can cache the mbox class

Returns

arrayname of variables

magic method for unserialize()

__wakeup() 

with this method you can cache the mbox class for cache validation the mtime of the mbox file is used

Exceptions

\Zend\Mail\Storage\Exception\RuntimeException

Close resource for mail lib.

close() 

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

Countable::count()

count() : int
Inherited

inherited_from \Zend\Mail\Storage\AbstractStorage::count()

Returns

int

Count messages all messages in current box

countMessages() : int

Exceptions

\Zend\Mail\Storage\Exception\ExceptionInterface

Returns

intnumber of messages

Iterator::current()

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

inherited_from \Zend\Mail\Storage\AbstractStorage::current()

Returns

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

getCapabilities() : array
Inherited

inherited_from \Zend\Mail\Storage\AbstractStorage::getCapabilities()

Returns

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

Fetch a message

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

Parameters

$id

int

number of message

Exceptions

\Zend\Mail\Storage\Exception\ExceptionInterface

Returns

get a message number from a unique id

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()

Parameters

$id

string

unique id

Exceptions

\Zend\Mail\Storage\Exception\ExceptionInterface

Returns

intmessage number

Get raw content of message or part

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

Parameters

$id

int

number of message

$part

nullarraystring

path to part or null for message content

Returns

stringraw content

Get raw header of message or part

getRawHeader(int $id, null | array | string $part, int $topLines) : string

Parameters

$id

int

number of message

$part

nullarraystring

path to part or null for message header

$topLines

int

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

Returns

stringraw header

Get a list of messages with number and size

getSize(int | null $id) : int | array

Parameters

$id

intnull

number of message or null for all messages

Returns

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

get unique id for one or all messages

getUniqueId(int | null $id) : array | string

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

$id

intnull

message number

Exceptions

\Zend\Mail\Storage\Exception\ExceptionInterface

Returns

arraystringmessage number for given message or all messages as array

Iterator::key()

key() : int
Inherited

inherited_from \Zend\Mail\Storage\AbstractStorage::key()

Returns

intid of current position

Waste some CPU cycles doing nothing.

noop() : bool

Returns

boolalways return true

ArrayAccess::offsetExists()

offsetExists(int $id) : boolean
Inherited

inherited_from \Zend\Mail\Storage\AbstractStorage::offsetExists()

Parameters

$id

int

Returns

boolean

ArrayAccess::offsetGet()

offsetGet(int $id) : \Zend\Mail\Storage\Message
Inherited

inherited_from \Zend\Mail\Storage\AbstractStorage::offsetGet()

Parameters

$id

int

Returns

ArrayAccess::offsetSet()

offsetSet(mixed $id, mixed $value) 
Inherited

inherited_from \Zend\Mail\Storage\AbstractStorage::offsetSet()

Parameters

$id

mixed

$value

mixed

Exceptions

\Zend\Mail\Storage\Exception\RuntimeException

ArrayAccess::offsetUnset()

offsetUnset(int $id) : boolean
Inherited

inherited_from \Zend\Mail\Storage\AbstractStorage::offsetUnset()

Parameters

$id

int

Returns

booleansuccess

stub for not supported message deletion

removeMessage($id) 

Iterator::rewind()

rewind() 
Inherited

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.

inherited_from \Zend\Mail\Storage\AbstractStorage::rewind()

SeekableIterator::seek()

seek(int $pos) 
Inherited

inherited_from \Zend\Mail\Storage\AbstractStorage::seek()

Parameters

$pos

int

Exceptions

\Zend\Mail\Storage\Exception\OutOfBoundsException

Iterator::valid()

valid() : bool
Inherited

inherited_from \Zend\Mail\Storage\AbstractStorage::valid()

Returns

bool

Get positions for mail message or throw exception if id is invalid

getPos(int $id) : array

Parameters

$id

int

number of message

Exceptions

\Zend\Mail\Storage\Exception\InvalidArgumentException

Returns

arraypositions as in positions

check if given file is a mbox file

isMboxFile(resource | string $file, bool $fileIsString) : bool

if $file is a resource its file pointer is moved after the first line

Parameters

$file

resourcestring

stream resource of name of file

$fileIsString

bool

file is string or resource

Returns

boolfile is mbox file

open given file as current mbox file

openMboxFile(string $filename) 

 Properties

 

file handle to mbox file

$fh : null | resource

 

modification date of mbox file for __wakeup

$filemtime : int

 

filename of mbox file for __wakeup

$filename : string

 

class capabilities with default values

$has : array
Inherited

inherited_from \Zend\Mail\Storage\AbstractStorage::$$has
 

maximum iteration position (= message count)

$iterationMax : null | int
Inherited

inherited_from \Zend\Mail\Storage\AbstractStorage::$$iterationMax
 

current iteration position

$iterationPos : int
Inherited

inherited_from \Zend\Mail\Storage\AbstractStorage::$$iterationPos
 

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

$messageClass : string

 

start and end position of messages as array('start' => start, 'separator' => headersep, 'end' => end)

$positions : array