Methods
Public constructor
__construct(array $params)
In addition to the parameters of Part::__construct() this constructor supports:
- file filename or file handle of a file with raw message content
- flags array with flags for message, keys are ignored, use constants defined in \Zend\Mail\Storage
Parameters
$params
array
Exceptions
Getter for mail headers - name is matched in lowercase
__get(string $name) : string
Inherited
This getter is short for Part::getHeader($name, 'string')
see |
\Zend\Mail\Storage\Part::getHeader() |
inherited_from |
\Zend\Mail\Storage\Part::__get() |
Parameters
Exceptions
Returns
string
value of header
Isset magic method proxy to hasHeader
__isset($name) : bool
Inherited
This method is short syntax for Part::hasHeader($name);
see |
\Zend\Mail\Storage\Part::hasHeader |
inherited_from |
\Zend\Mail\Storage\Part::__isset() |
Parameters
Returns
bool
magic method to get content of part
__toString() : string
Inherited
inherited_from |
\Zend\Mail\Storage\Part::__toString() |
Returns
string
content
Count parts of a multipart part
countParts() : int
Inherited
inherited_from |
\Zend\Mail\Storage\Part::countParts() |
Returns
int
number of sub-parts
implements Iterator::current()
current() : \Zend\Mail\Storage\Part
Inherited
inherited_from |
\Zend\Mail\Storage\Part::current() |
Returns
implements RecursiveIterator::getChildren()
getChildren() : \Zend\Mail\Storage\Part
Inherited
inherited_from |
\Zend\Mail\Storage\Part::getChildren() |
Returns
Body of part
getContent() : string
Inherited
If part is multipart the raw content of this part with all sub parts is returned
inherited_from |
\Zend\Mail\Storage\Part::getContent() |
Exceptions
Returns
string
body
get all set flags
getFlags() : array
Returns
array
array with flags, key and value are the same for easy lookup
Get part of multipart message
getPart(int $num) : \Zend\Mail\Storage\Part
Inherited
inherited_from |
\Zend\Mail\Storage\Part::getPart() |
Parameters
$num
int
number of part starting with 1 for first part
Exceptions
Returns
Return size of part
getSize() : int
Inherited
Quite simple implemented currently (not decoding). Handle with care.
inherited_from |
\Zend\Mail\Storage\Part::getSize() |
Returns
int
size
return toplines as found after headers
getTopLines() : string
implements RecursiveIterator::hasChildren()
hasChildren() : bool
Inherited
inherited_from |
\Zend\Mail\Storage\Part::hasChildren() |
Returns
bool
current element has children/is multipart
check if flag is set
hasFlag(mixed $flag) : bool
Parameters
$flag
mixed
a flag name, use constants defined in \Zend\Mail\Storage
Returns
bool
true if set, otherwise false
Check if part is a multipart message
isMultipart() : bool
Inherited
inherited_from |
\Zend\Mail\Storage\Part::isMultipart() |
Returns
bool
if part is multipart
implements Iterator::key()
key() : string
Inherited
inherited_from |
\Zend\Mail\Storage\Part::key() |
Returns
string
key/number of current part
implements Iterator::next()
next()
Inherited
inherited_from |
\Zend\Mail\Storage\Part::next() |
implements Iterator::rewind()
rewind()
Inherited
inherited_from |
\Zend\Mail\Storage\Part::rewind() |
implements Iterator::valid()
valid() : bool
Inherited
inherited_from |
\Zend\Mail\Storage\Part::valid() |
Returns
bool
check if there's a current element
Cache content and split in parts if multipart
_cacheContent() : null
Inherited
inherited_from |
\Zend\Mail\Storage\Part::_cacheContent() |
Exceptions
Returns
null
Properties
raw part body
$content : null | string
Inherited
inherited_from |
\Zend\Mail\Storage\Part::$$content |
count of parts of a multipart message
$countParts : null | int
Inherited
inherited_from |
\Zend\Mail\Storage\Part::$$countParts |
flags for this message
$flags : array
current position of iterator
$iterationPos : int
Inherited
inherited_from |
\Zend\Mail\Storage\Part::$$iterationPos |
message number for mail handler
$messageNum : int
Inherited
inherited_from |
\Zend\Mail\Storage\Part::$$messageNum |
parts of multipart message
$parts : array
Inherited
inherited_from |
\Zend\Mail\Storage\Part::$$parts |
toplines as fetched with headers
$topLines : string
Inherited
inherited_from |
\Zend\Mail\Storage\Part::$$topLines |