Zeta Components - high quality PHP components

Zeta Components Manual :: Docs For Class ezcMailPartWalkContext

Use this class to create a context to be passed to the walkParts() method from ezcMail.

Example:

class App
{
public static function saveMailPart( $context, $mailPart )
{
// code to save the $mailPart object to disk
}
}
// use the saveMailPart() function as a callback in walkParts()
// where $mail is an ezcMail object.
$context = new ezcMailPartWalkContext( array( 'App', 'saveMailPart' ) );
$context->includeDigests = true; // if you want to go through the digests in the mail
$mail->walkParts( $context, $mail );

Version:

//autogentag//

callback	read/write	`$callbackFunction` Name of a function or array( 'class_name', 'function_name' )
array(string)	read/write	`$filter` Used to restrict processing only to the specified mail part names. If empty or null, then ezcMailText, ezcMailFile and ezcMailRfc822Digest parts are processed. Usage e.g.: array( 'ezcMailFile' )
bool	read/write	`$includeDigests` If true then then ezcMailRfc822Digest parts are not processed by the callback function, instead the mail parts inside the digests will be available for processing.
int	read/write	`$level` The current level in the mail part walk (0 = first level).

protected array(ezcMailPart)


              $parts
               = array()

An array of mail parts (retrieved recursively from a mail object).

public ezcMailPartWalkContext	`__construct( $callbackFunction )` Constructs a new ezcMailPartWalkContext object.
public void	`appendPart( $part )` Appends a part to the list of mail parts.
public array(ezcMailPart)	`getParts( )` Returns the mail parts.

ezcMailPartWalkContext __construct( callback $callbackFunction )

Constructs a new ezcMailPartWalkContext object.

The parameter $callbackFunction must be a function name as string or as array( 'class_name', 'function_name' ).

Name	Type	Description
`$callbackFunction`	callback

void appendPart( ezcMailPart $part )

Appends a part to the list of mail parts.

Name	Type	Description
`$part`	ezcMailPart

array(ezcMailPart) getParts( )

Returns the mail parts.

Documentation generated by phpDocumentor 1.4.3