Path

ez components / documentation / api reference / 1.1.2 / mail


eZ Components 1.1.2

Mail: ezcMailParser

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

Class: ezcMailParser

Parses a mail in RFC822 format to an ezcMail structure. [source]
File attachments will be written to disk in a temporary directory. This temporary directory and the file attachment will be removed when PHP ends execution. If you want to keep the file you should move it to another directory.

Method Summary

public ezcMailParser __construct( )
Constructs a new ezcMailParser.
public static string getTmpDir( )
Returns the temporary directory.
public array(ezcMail) parseMail( $set )
Returns an array of ezcMail objects parsed from the mail set $set.
public static void setTmpDir( $dir )
Sets the temporary directory.

Methods

__construct

ezcMailParser __construct( )
Constructs a new ezcMailParser.

getTmpDir

string getTmpDir( )
Returns the temporary directory.
If no temporary directory has been set this method defaults to /tmp/ for linux and c:\tmp\ for windows.

parseMail

array(ezcMail) parseMail( ezcMailParserSet $set )
Returns an array of ezcMail objects parsed from the mail set $set.

Parameters

Name Type Description
$set ezcMailParserSet  

Throws

ClassDescription
ezcBaseFileNotFoundException if a neccessary temporary file could not be openened.

setTmpDir

void setTmpDir( string $dir )
Sets the temporary directory.
The temporary directory must be writeable by PHP. It will be used to store file attachments.

Parameters

Name Type Description
$dir string  

Last updated: Thu, 01 Nov 2007