Zeta Components Manual :: Docs For Class ezcMailVariableSet
Mail::ezcMailVariableSet
Class ezcMailVariableSet
ezcMailVariableSet is an internal class that can be used to parse mail directly from a string variable in your script.
The variable should contain the complete mail message in RFC822 format.
Example:
- $mail = "To: user@example.com\r\nSubject: Test mail .....";
- $mail = $parser->parseMail( $set );
Source for this file: /Mail/src/transports/variable/var_set.php
Implements interfaces:
| Version: | //autogen// |
Method Summary
| public ezcMailVariableSet |
__construct(
$mail
)
Constructs a new set that contains one mail from $mail. |
| public string |
getNextLine(
)
Returns one line of data from the current mail in the set. |
| public bool |
hasData(
)
Returns whether the variable set contains mails. |
| public bool |
nextMail(
)
Moves the set to the next mail and returns true upon success. |
Methods
__construct
ezcMailVariableSet
__construct(
string
$mail
)
Constructs a new set that contains one mail from $mail.
Parameters:
| Name | Type | Description |
|---|---|---|
$mail |
string |
getNextLine
string
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
bool
hasData(
)
Returns whether the variable set contains mails.
Implementation of:
| Method | Description |
|---|---|
ezcMailParserSet::hasData() |
Returns true if mail data is available for parsing. |
nextMail
bool
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 (always).
Implementation of:
| Method | Description |
|---|---|
ezcMailParserSet::nextMail() |
Moves the set to the next mail and returns true upon success. |
Documentation generated by phpDocumentor 1.4.3