Path

ez components / documentation / api reference / 2009.2.1 / mail


eZ Components 2009.2.1

Mail: ezcMailImapSet

[ Tutorial ] [ Display example ] [ Mail listing example ] [ Rfcs ] [ Class tree ] [ Element index ] [ ChangeLog ] [ Credits ]

Class: ezcMailImapSet

ezcMailImapSet is an internal class that fetches a series of mail from the IMAP server. [source]

Implemented Interfaces

The IMAP 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.

Method Summary

public ezcMailImapSet __construct( $connection, $messages, [$deleteFromServer = false], [$options = array()] )
Constructs a new IMAP 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

ezcMailImapSet __construct( $connection, $messages, [bool $deleteFromServer = false], [ezcMailImapSetOptions|array(string=>mixed) $options = array()] )
Constructs a new IMAP parser set that will fetch the messages $messages.
$connection must hold a valid connection to a IMAP server that is ready to retrieve the messages.
If $deleteFromServer is set to true the messages will be deleted after retrieval.
See ezcMailImapSetOptions for options you can set to IMAP sets.

Parameters

Name Type Description
$connection ezcMailTransportConnection  
$messages array(int)  
$deleteFromServer bool  
$options ezcMailImapSetOptions|array(string=>mixed)  

Throws

ClassDescription
ezcMailTransportException if the server sent a negative response

getMessageNumbers

array(int) getMessageNumbers( )
Returns message numbers from the current set.

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,

hasData

bool hasData( )
Returns whether the set has mails.

isFinished

bool isFinished( )
Returns true if all the data has been fetched from this set.

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.

Throws

ClassDescription
ezcMailTransportException if the server sent a negative response

Last updated: Tue, 23 Mar 2010