eZ Components 2009.2

Getting Started

Components

Archive (1.4)
Authentication (1.3.1)
AuthenticationDatabaseTiein (1.1)
Base (1.8)
Cache (1.5)
Configuration (1.3.5)
ConsoleTools (1.6)
Database (1.4.6)
DatabaseSchema (1.4.3)
Debug (1.2.1)
Document (1.3)
EventLog (1.4)
EventLogDatabaseTiein (1.0.2)
Execution (1.1.1)
Feed (1.3)
File (1.2)
Graph (1.5)
GraphDatabaseTiein (1.0.1)
ImageAnalysis (1.1.3)
ImageConversion (1.3.7)
Mail (1.7)
MvcTools (1.1.2)
MvcAuthenticationTiein (1.0)
MvcFeedTiein (1.0)
MvcMailTiein (1.0.1)
MvcTemplateTiein (1.0)
PersistentObject (1.7)
PersistentObjectDatabaseSchemaTiein (1.3)
PhpGenerator (1.0.5)
Search (1.0.8)
SignalSlot (1.1.1)
SystemInformation (1.0.8)
Template (1.4.2)
TemplateTranslationTiein (1.1)
Translation (1.3.2)
TranslationCacheTiein (1.1.2)
Tree (1.1.3)
TreeDatabaseTiein (1.1.1)
TreePersistentObjectTiein (1.0)
Url (1.2.2)
UserInput (1.4)
Webdav (1.1.3)
Workflow (1.4)
WorkflowDatabaseTiein (1.4)
WorkflowEventLogTiein (1.1)
WorkflowSignalSlotTiein (1.0)

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 = 'myCustomMailClass'; // extends ezcMail
 3.  $options->fileClass = 'myCustomFileClass'; // extends ezcMailFile
 4.  $options->parseTextAttachmentsAsFiles = true; // to get the text attachments in ezcMailFile objects
 5.  
 6.  $parser = new ezcMailParser( $options );

Another way to specify the options is:

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

Parents

ezcBaseOptions
   |
   --ezcMailParserOptions

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()] )