Public Member Functions
	__construct (array $params)
	Public constructor.

	setPartClass ($class)
	Set name pf class used to encapsulate message parts.

	getPartClass ()
	Retrieve the class name used to encapsulate message parts.

	isMultipart ()
	Check if part is a multipart message.

	getContent ()
	Body of part.

	getSize ()
	Return size of part.

	getPart ($num)
	Get part of multipart message.

	countParts ()
	Count parts of a multipart part.

	getHeaders ()
	Get all headers.

	getHeader ($name, $format=null)
	Get a header in specificed format.

	headerExists ($name)
	Check wheater the Mail part has a specific header.

	getHeaderField ($name, $wantedPart=0, $firstName=0)
	Get a specific field from a header like content type or all fields as array.

	__get ($name)
	Getter for mail headers - name is matched in lowercase.

	__isset ($name)
	Isset magic method proxy to hasHeader.

	__toString ()
	magic method to get content of part

	hasChildren ()
	implements RecursiveIterator::hasChildren()

	getChildren ()
	implements RecursiveIterator::getChildren()

	valid ()
	implements Iterator::valid()

	next ()
	implements Iterator::next()

	key ()
	implements Iterator::key()

	current ()
	implements Iterator::current()

	rewind ()
	implements Iterator::rewind()

Protected Member Functions
	_cacheContent ()
	Cache content and split in parts if multipart.

Protected Attributes
	$_headers

	$_content

	$_topLines = ''

	$_parts = array()

	$_countParts

	$_iterationPos = 1

	$_mail

	$_messageNum = 0

	$_partClass

Constructor & Destructor Documentation

__construct ( array $params )

Public constructor.

Zend_Mail_Part supports different sources for content. The possible params are:

handler a instance of Zend_Mail_Storage_Abstract for late fetch
id number of message for handler
raw raw content with header and body as string
headers headers as array (name => value) or string, if a content part is found it's used as toplines
noToplines ignore content found after headers in param 'headers'
content content as string

Parameters

array $params full message with or without headers

Exceptions

Zend_Mail_Exception

See Also: Zend_Mail_Exception; Zend_Mail_Exception

Member Function Documentation

__get ( $name )

Getter for mail headers - name is matched in lowercase.

This getter is short for Zend_Mail_Part::getHeader($name, 'string')

See Also: Zend_Mail_Part::getHeader()

Parameters

string $name header name

Returns: string value of header

Exceptions

Zend_Mail_Exception

Implements Zend_Mail_Part_Interface.

__isset ( $name )

Isset magic method proxy to hasHeader.

This method is short syntax for Zend_Mail_Part::hasHeader($name);

See Also: Zend_Mail_Part::hasHeader

Parameters

string

Returns: boolean

__toString ( )

magic method to get content of part

Returns: string content

Implements Zend_Mail_Part_Interface.

_cacheContent ( )

protected

Cache content and split in parts if multipart.

Returns: null

Exceptions

Zend_Mail_Exception

See Also: Zend_Mail_Exception

countParts ( )

Count parts of a multipart part.

Returns: int number of sub-parts

Implements Zend_Mail_Part_Interface.

current ( )

implements Iterator::current()

Returns: Zend_Mail_Part current part

getChildren ( )

implements RecursiveIterator::getChildren()

Returns: Zend_Mail_Part same as self::current()

getContent ( )

Body of part.

If part is multipart the raw content of this part with all sub parts is returned

Returns: string body

Exceptions

Zend_Mail_Exception

See Also: Zend_Mail_Exception

Implements Zend_Mail_Part_Interface.

getHeader	(	$name,
		$format = `null`
	)

Get a header in specificed format.

Internally headers that occur more than once are saved as array, all other as string. If $format is set to string implode is used to concat the values (with Zend_Mime::LINEEND as delim).

Parameters

string	$name	name of header, matches case-insensitive, but camel-case is replaced with dashes
string	$format	change type of return value to 'string' or 'array'

Returns: string|array value of header in wanted or internal format

Exceptions

Zend_Mail_Exception

See Also: Zend_Mail_Exception

Implements Zend_Mail_Part_Interface.

getHeaderField	(	$name,
		$wantedPart = `0`,
		$firstName = `0`
	)

Get a specific field from a header like content type or all fields as array.

If the header occurs more than once, only the value from the first header is returned.

Throws a Zend_Mail_Exception if the requested header does not exist. If the specific header field does not exist, returns null.

Parameters

string	$name	name of header, like in getHeader()
string	$wantedPart	the wanted part, default is first, if null an array with all parts is returned
string	$firstName	key name for the first part

Returns: string|array wanted part or all parts as array($firstName => firstPart, partname => value)

Exceptions

Zend_Exception,Zend_Mail_Exception

Implements Zend_Mail_Part_Interface.

getHeaders ( )

Get all headers.

The returned headers are as saved internally. All names are lowercased. The value is a string or an array if a header with the same name occurs more than once.

Returns: array headers as array(name => value)

Implements Zend_Mail_Part_Interface.

getPart ( $num )

Get part of multipart message.

Parameters

int $num number of part starting with 1 for first part

Returns: Zend_Mail_Part wanted part

Exceptions

Zend_Mail_Exception

See Also: Zend_Mail_Exception; Zend_Mail_Exception

Implements Zend_Mail_Part_Interface.

getPartClass ( )

Retrieve the class name used to encapsulate message parts.

Returns: string

getSize ( )

Return size of part.

Quite simple implemented currently (not decoding). Handle with care.

Returns: int size

Implements Zend_Mail_Part_Interface.

hasChildren ( )

implements RecursiveIterator::hasChildren()

Returns: bool current element has children/is multipart

headerExists ( $name )

Check wheater the Mail part has a specific header.

Parameters

string $name

Returns: boolean

isMultipart ( )

Check if part is a multipart message.

Returns: bool if part is multipart

Implements Zend_Mail_Part_Interface.

key ( )

implements Iterator::key()

Returns: string key/number of current part

next ( )

implements Iterator::next()

Returns: null

rewind ( )

implements Iterator::rewind()

Returns: null

setPartClass ( $class )

Set name pf class used to encapsulate message parts.

Parameters

string $class

Returns: Zend_Mail_Part

See Also: Zend_Mail_Exception; Zend_Mail_Exception

valid ( )

implements Iterator::valid()

Returns: bool check if there's a current element

Member Data Documentation

$_content

protected

$_countParts

protected

$_headers

protected

$_iterationPos = 1

protected

$_mail

protected

$_messageNum = 0

protected

$_partClass

protected

$_parts = array()

protected

$_topLines = ''

protected

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation