Zeta Components - high quality PHP components

Zeta Components Manual :: Docs For Class ezcMailParserOptions

Mail::ezcMailParserOptions

Class ezcMailParserOptions

Class containing the basic options for the mail parser.

Example of how to use the parser options:

$options = new ezcMailParserOptions();
$options->mailClass = 'myCustomMailClass'; // extends ezcMail
$options->fileClass = 'myCustomFileClass'; // extends ezcMailFile
$options->parseTextAttachmentsAsFiles = true; // to get the text attachments in ezcMailFile objects
$parser = new ezcMailParser( $options );

Another way to specify the options is:

$parser = new ezcMailParser();
$parser->options->mailClass = 'myCustomMailClass'; // extends ezcMail
$parser->options->fileClass = 'myCustomFileClass'; // extends ezcMailFile
$parser->options->parseTextAttachmentsAsFiles = true;

Source for this file: /Mail/src/options/parser_options.php

ezcBaseOptions
   |
   --ezcMailParserOptions

Version:

//autogen//

Properties

string	read/write	`$fileClass` Specifies a class descending from ezcMailFile which can be instanciated by the parser to handle file attachments. The default value is ezcMailFile.
string	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. The default value is ezcMail.
string	read/write	`$parseTextAttachmentsAsFiles` Specifies whether to parse the text attachments in an ezcMailTextPart (default) or in an ezcMailFile (by setting the option to true).

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)

Exceptions:

Type	Description
`ezcBaseValueException`	if $options contains a property with a value not allowed
`ezcBasePropertyNotFoundException`	if $options contains a property not defined

Redefinition of:

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

Documentation generated by phpDocumentor 1.4.3