Summary

Fully Qualified Name:	Laminas\Mail\Storage\Mbox
Extends:	AbstractStorage

Description

Methods

Name	Description	Defined By
__construct()	Create instance with parameters Supported parameters are: - filename filename of mbox file	Mbox
__destruct()	Destructor calls close() and therefore closes the resource.	AbstractStorage
__get()	Getter for has-properties. The standard has properties are: hasFolder, hasUniqueid, hasDelete, hasCreate, hasTop	AbstractStorage
__sleep()	magic method for serialize()	Mbox
__wakeup()	magic method for unserialize()	Mbox
close()	Close resource for mail lib. If you need to control, when the resource is closed. Otherwise the destructor would call this.	Mbox
count()	Countable::count()	AbstractStorage
countMessages()	Count messages all messages in current box	Mbox
current()	Iterator::current()	AbstractStorage
getCapabilities()	Get a full list of features supported by the specific mail lib and the server	AbstractStorage
getMessage()	Fetch a message	Mbox
getNumberByUniqueId()	get a message number from a unique id	Mbox
getRawContent()		Mbox
getRawHeader()		Mbox
getSize()	Get a list of messages with number and size	Mbox
getUniqueId()	get unique id for one or all messages	Mbox
key()	Iterator::key()	AbstractStorage
next()	Iterator::next()	AbstractStorage
noop()	Waste some CPU cycles doing nothing.	Mbox
offsetExists()	ArrayAccess::offsetExists()	AbstractStorage
offsetGet()	ArrayAccess::offsetGet()	AbstractStorage
offsetSet()	ArrayAccess::offsetSet()	AbstractStorage
offsetUnset()	ArrayAccess::offsetUnset()	AbstractStorage
removeMessage()	stub for not supported message deletion	Mbox
rewind()	Iterator::rewind()	AbstractStorage
seek()	SeekableIterator::seek()	AbstractStorage
valid()	Iterator::valid()	AbstractStorage

Method Details

__construct()

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

Parameter Name	Type	Description
	$params	mail
$params

Returns:

__destruct()

Destructor calls close() and therefore closes the resource.

Returns:

__get()

Getter for has-properties. 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

Parameter Name	Type	Description
$var	string	property

Returns: bool supported or not

__sleep()

magic method for serialize()

with this method you can cache the mbox class

Returns: array name of variables

__wakeup()

magic method for unserialize()

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

Returns:

close()

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

Returns:

count()

Countable::count()

Returns: int

countMessages()

Count messages all messages in current box

Returns: int number of messages

current()

Iterator::current()

Returns: \Message current message

getCapabilities()

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

Returns: array list of features as array(feature_name => true|false[|null])

getMessage()

Fetch a message

Parameter Name	Type	Description
$id	int	number

Returns: \Laminas\Mail\Storage\Message\File

getNumberByUniqueId()

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

Parameter Name	Type	Description
$id	string	unique

Returns: int message number

getRawContent()

Parameter Name	Type	Description
$id
$part

Returns: void

getRawHeader()

Parameter Name	Type	Description
$id
$part
$topLines

Returns: void

getSize()

Get a list of messages with number and size

Parameter Name	Type	Description
$id	int|null	number

Returns: int|array size of given message of list with all messages as array(num => size)

getUniqueId()

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.

Parameter Name	Type	Description
$id	int|null	message

Returns: array|string message number for given message or all messages as array

key()

Iterator::key()

Returns: int id of current position

next()

Iterator::next()

Returns:

noop()

Waste some CPU cycles doing nothing.

Returns: bool always return true

offsetExists()

ArrayAccess::offsetExists()

Parameter Name	Type	Description
$id	int

Returns: bool

offsetGet()

ArrayAccess::offsetGet()

Parameter Name	Type	Description
$id	int

Returns: \Laminas\Mail\Storage\Message message object

offsetSet()

ArrayAccess::offsetSet()

Parameter Name	Type	Description
$id	mixed
$value	mixed

Returns:

offsetUnset()

ArrayAccess::offsetUnset()

Parameter Name	Type	Description
$id	int

Returns: bool success

removeMessage()

stub for not supported message deletion

Parameter Name	Type	Description
	$id
$id

Returns:

rewind()

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.

Returns:

seek()

SeekableIterator::seek()

Parameter Name	Type	Description
$pos	int

Returns:

valid()

Iterator::valid()

Returns: bool