ezcMailMboxSet is an internal class that fetches a series of mail from an mbox file.
The mbox set is constructed from a file pointer and iterates over all the messages in an mbox file.
Source for this file: /Mail/src/transports/mbox/mbox_set.php
Version: | //autogen// |
public ezcMailMboxSet |
__construct(
$fh
, $messages
)
Constructs a new mbox parser set. |
public array(int=>int) |
getMessageNumbers(
)
Returns message numbers for current set. |
public string |
getNextLine(
)
Returns one line of data from the current mail in the set including the ending linebreak. |
public bool |
hasData(
)
Returns whether the set contains mails. |
public bool |
isFinished(
)
Returns true if all the data has been fetched from this set. |
public bool |
nextMail(
)
Moves the set to the next mail and returns true upon success. |
Constructs a new mbox parser set.
Name | Type | Description |
---|---|---|
$fh |
resource(filepointer) | |
$messages |
array(int=>int) |
Type | Description |
---|---|
ezcBaseFileIoException |
if $fh is not a filepointer resource. |
Returns message numbers for current set.
Returns one line of data from the current mail in the set including the ending linebreak.
Null is returned if there is no current mail in the set or the end of the mail is reached.
Method | Description |
---|---|
ezcMailParserSet::getNextLine() |
Returns one line of data from the current mail in the set including the ending linebreak. |
Returns whether the set contains mails.
Method | Description |
---|---|
ezcMailParserSet::hasData() |
Returns true if mail data is available for parsing. |
Returns true if all the data has been fetched from this set.
Moves the set to the next mail and returns true upon success.
False is returned if there are no more mail in the set.
Method | Description |
---|---|
ezcMailParserSet::nextMail() |
Moves the set to the next mail and returns true upon success. |