Horde_Mail_Mbox_Parse
in package
implements
ArrayAccess, Countable, Iterator
This object allows easy access to parsing mbox data (RFC 4155).
See: http://homepage.ntlworld.com/jonathan.deboynepollard/FGA/mail-mbox-formats
Tags
Interfaces, Classes, Traits and Enums
- ArrayAccess
- Countable
- Iterator
Table of Contents
- $_data : resource
- Data stream.
- $_parsed : array<string|int, mixed>
- 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.
- __construct() : mixed
- Constructor.
- __toString() : string
- String representation of the object.
- count() : int
- Index count.
- current() : mixed
- key() : mixed
- next() : mixed
- offsetExists() : mixed
- offsetGet() : mixed
- offsetSet() : mixed
- offsetUnset() : mixed
- rewind() : mixed
- valid() : mixed
Properties
$_data
Data stream.
protected
resource
$_data
$_parsed
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.
protected
array<string|int, mixed>
$_parsed
= array()
- start: (integer) Start boundary.
Methods
__construct()
Constructor.
public
__construct(mixed $data[, int $limit = null ]) : mixed
Parameters
- $data : mixed
-
The mbox data. Either a resource or a filename as interpreted by fopen() (string).
- $limit : int = null
-
Limit to this many messages; additional messages will throw an exception.
Tags
Return values
mixed —__toString()
String representation of the object.
public
__toString() : string
Return values
string —String representation.
count()
Index count.
public
count() : int
Return values
int —The number of messages.
current()
public
current() : mixed
Return values
mixed —key()
public
key() : mixed
Return values
mixed —next()
public
next() : mixed
Return values
mixed —offsetExists()
public
offsetExists(mixed $offset) : mixed
Parameters
- $offset : mixed
Return values
mixed —offsetGet()
public
offsetGet(mixed $offset) : mixed
Parameters
- $offset : mixed
Return values
mixed —offsetSet()
public
offsetSet(mixed $offset, mixed $value) : mixed
Parameters
- $offset : mixed
- $value : mixed
Return values
mixed —offsetUnset()
public
offsetUnset(mixed $offset) : mixed
Parameters
- $offset : mixed
Return values
mixed —rewind()
public
rewind() : mixed
Return values
mixed —valid()
public
valid() : mixed