Path

ez components / documentation / api reference / 2007.2alpha1 / mail

eZ Components 2007.2alpha1

Mail: ezcMailParserOptions

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

Class: ezcMailParserOptions

Class containing the basic options for the mail parser. [source]
Example of how to use the parser options: 
1.  $options = new ezcMailParserOptions();
2.  $options->mailClass = 'ezcMail';
3.  
4.  $parser = new ezcMailParser( $options );

Parents

ezcBaseOptions
   |
   --ezcMailParserOptions

Properties

int read/write  $mailClass
Specifies a class descending from ezcMail which can be returned by the parser if you plan to use another class instead of ezcMail.

Inherited Member Variables

From ezcBaseOptions:
protected  ezcBaseOptions::$properties

Method Summary

public ezcMailParserOptions __construct( [$options = array()] )
Constructs an object with the specified values.

Inherited Methods

From ezcBaseOptions :
public ezcBaseOptions ezcBaseOptions::__construct()
Construct a new options object.
public void ezcBaseOptions::merge()
Merge an array into the actual options object.
public bool ezcBaseOptions::offsetExists()
Returns if an option exists.
public mixed ezcBaseOptions::offsetGet()
Returns an option value.
public void ezcBaseOptions::offsetSet()
Set an option.
public void ezcBaseOptions::offsetUnset()
Unset an option.

Methods

__construct

ezcMailParserOptions __construct( [ $options = array()] )
Constructs an object with the specified values.

Parameters

Name Type Description
$options array(string=>mixed)  

Throws

ClassDescription
ezcBasePropertyNotFoundException if $options contains a property not defined
ezcBaseValueException if $options contains a property with a value not allowed

Redefinition of

Method Description
ezcBaseOptions::__construct() Construct a new options object.

Last updated: Mon, 12 Nov 2007