Zeta Components Manual :: Docs For Class ezcMailPop3Set
Mail::ezcMailPop3Set
Class ezcMailPop3Set
ezcMailPop3Set is an internal class that fetches a series of mail from the pop3 server.
The POP3 set works on an existing connection and a list of the messages that the user wants to fetch. The user must accept all the data for each mail for correct behaviour.
The set can be parsed with ezcMailParser.
Source for this file: /Mail/src/transports/pop3/pop3_set.php
Implements interfaces:
| Version: | //autogen// |
Method Summary
| public ezcMailPop3Set |
__construct(
$connection
, $messages
, [ $deleteFromServer
= false] )
Constructs a new POP3 parser set that will fetch the messages $messages. |
| public array(int) |
getMessageNumbers(
)
Returns message numbers from the current set. |
| public string |
getNextLine(
)
Returns one line of data from the current mail in the set. |
| public bool |
hasData(
)
Returns whether the set has 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. |
Methods
__construct
Constructs a new POP3 parser set that will fetch the messages $messages.
$connection must hold a valid connection to a POP3 server that is ready to retrieve the messages.
If $deleteFromServer is set to true the messages will be deleted after retrieval.
Parameters:
| Name | Type | Description |
|---|---|---|
$connection |
ezcMailTransportConnection | |
$messages |
array(ezcMail) | |
$deleteFromServer |
bool |
Exceptions:
| Type | Description |
|---|---|
ezcMailTransportException |
if the server sent a negative response |
getMessageNumbers
Returns message numbers from the current set.
getNextLine
Returns one line of data from the current mail in the set.
Null is returned if there is no current mail in the set or the end of the mail is reached.
Implementation of:
| Method | Description |
|---|---|
ezcMailParserSet::getNextLine() |
Returns one line of data from the current mail in the set including the ending linebreak. |
hasData
Returns whether the set has mails.
Implementation of:
| Method | Description |
|---|---|
ezcMailParserSet::hasData() |
Returns true if mail data is available for parsing. |
isFinished
Returns true if all the data has been fetched from this set.
nextMail
Moves the set to the next mail and returns true upon success.
False is returned if there are no more mail in the set.
Exceptions:
| Type | Description |
|---|---|
ezcMailTransportException |
if the server sent a negative response |
Implementation of:
| Method | Description |
|---|---|
ezcMailParserSet::nextMail() |
Moves the set to the next mail and returns true upon success. |