API Documentation
\

\Horde_Mail_Mbox_Parse

This object allows easy access to parsing mbox data (RFC 4155).

See: http://homepage.ntlworld.com/jonathan.deboynepollard/FGA/mail-mbox-formats

Summary

Methods
Properties
Constants
__construct()
offsetExists()
offsetGet()
offsetSet()
offsetUnset()
count()
__toString()
current()
key()
next()
rewind()
valid()
No public properties found
No constants found
No protected methods found
$_data
$_parsed
N/A
No private methods found
No private properties found
N/A

Properties

$_data

$_data : resource

Data stream.

Type

resource

$_parsed

$_parsed : array

Parsed data. Each entry is an array containing 3 keys: - date: (mixed) Date information, in DateTime object. Null if date cannot be parsed. False if message is not MBOX data.

  • start: (integer) Start boundary.

Type

array

Methods

__construct()

__construct(mixed  $data, integer  $limit = null)

Constructor.

Parameters

mixed $data

The mbox data. Either a resource or a filename as interpreted by fopen() (string).
integer $limit

Limit to this many messages; additional messages will throw an exception.

Throws

\Horde_Mail_Parse_Exception

offsetExists()

offsetExists(  $offset)

Parameters

$offset

offsetGet()

offsetGet(  $offset)

Parameters

$offset

offsetSet()

offsetSet(  $offset,   $value)

Parameters

$offset
$value

offsetUnset()

offsetUnset(  $offset)

Parameters

$offset

count()

count() : integer

Index count.

Returns

integer —

The number of messages.

__toString()

__toString() : string

String representation of the object.

Returns

string —

String representation.

current()

current()

key()

key()

next()

next()

rewind()

rewind()

valid()

valid()