Mail/Message.php

Show:

inherited

Classes
- \Zend_Mail_Message

Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Mail
Version: $Id: Message.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Mail_Message
jump to top

Package: Zend\Mail

Implements: \Zend_Mail_Message_Interface
Parent(s): \Zend_Mail_Part
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

null|string $_content

inherited

raw part body

Inherited from: \Zend_Mail_Part::$$_content

Details

Type: null | string
Inherited_from: \Zend_Mail_Part::$$_content

null|int $_countParts

inherited

count of parts of a multipart message

Inherited from: \Zend_Mail_Part::$$_countParts

Details

Type: null | int
Inherited_from: \Zend_Mail_Part::$$_countParts

array $_flags = array()

flags for this message

Default valuearray()Details

Type: array

null|array $_headers

inherited

headers of part as array

Inherited from: \Zend_Mail_Part::$$_headers

Details

Type: null | array
Inherited_from: \Zend_Mail_Part::$$_headers

int $_iterationPos = 1

inherited

current position of iterator

Inherited from: \Zend_Mail_Part::$$_iterationPos

Default value1Details

Type: int
Inherited_from: \Zend_Mail_Part::$$_iterationPos

null|\Zend_Mail_Storage_Abstract $_mail

inherited

mail handler, if late fetch is active

Inherited from: \Zend_Mail_Part::$$_mail

Details

Type: null | \Zend_Mail_Storage_Abstract
Inherited_from: \Zend_Mail_Part::$$_mail

int $_messageNum = 0

inherited

message number for mail handler

Inherited from: \Zend_Mail_Part::$$_messageNum

Default value0Details

Type: int
Inherited_from: \Zend_Mail_Part::$$_messageNum

string $_partClass

inherited

Class to use when creating message parts

Inherited from: \Zend_Mail_Part::$$_partClass

Details

Type: string
Inherited_from: \Zend_Mail_Part::$$_partClass

array $_parts = array()

inherited

parts of multipart message

Inherited from: \Zend_Mail_Part::$$_parts

Default valuearray()Details

Type: array
Inherited_from: \Zend_Mail_Part::$$_parts

string $_topLines = ''

inherited

toplines as fetched with headers

Inherited from: \Zend_Mail_Part::$$_topLines

Default value''Details

Type: string
Inherited_from: \Zend_Mail_Part::$$_topLines

Methods

__construct( $params) : void

Public constructor

In addition to the parameters of Zend_Mail_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

Name	Type	Description
$params

Throws

Exception	Description
\Zend_Mail_Exception

__get(string $name) : string

inherited

Getter for mail headers - name is matched in lowercase

Inherited from: \Zend_Mail_Part::__get()

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

Parameters

Name	Type	Description
$name	string	header name

Returns

Type	Description
string	value of header

Throws

Exception	Description
\Zend_Mail_Exception

Details

See: \Zend_Mail_Part::getHeader()

__isset(string $name) : boolean

inherited

Isset magic method proxy to hasHeader

Inherited from: \Zend_Mail_Part::__isset()

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

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
boolean

Details

See: \Zend_Mail_Part::hasHeader

__toString() : string

inherited

magic method to get content of part

Inherited from: \Zend_Mail_Part::__toString()

Returns

Type	Description
string	content

_cacheContent() : null

inherited

Cache content and split in parts if multipart

Inherited from: \Zend_Mail_Part::_cacheContent()

Returns

Type	Description
null

Throws

Exception	Description
\Zend_Mail_Exception

countParts() : int

inherited

Count parts of a multipart part

Inherited from: \Zend_Mail_Part::countParts()

Returns

Type	Description
int	number of sub-parts

current() : \Zend_Mail_Part

inherited

implements Iterator::current()

Inherited from: \Zend_Mail_Part::current()

Returns

Type	Description
\Zend_Mail_Part	current part

getChildren() : \Zend_Mail_Part

inherited

implements RecursiveIterator::getChildren()

Inherited from: \Zend_Mail_Part::getChildren()

Returns

Type	Description
\Zend_Mail_Part	same as self::current()

getContent() : string

inherited

Body of part

Inherited from: \Zend_Mail_Part::getContent()

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

Returns

Type	Description
string	body

Throws

Exception	Description
\Zend_Mail_Exception

getFlags() : array

get all set flags

Returns

Type	Description
array	array with flags, key and value are the same for easy lookup

getHeader(string $name, string $format = null) : string | array

inherited

Get a header in specificed format

Inherited from: \Zend_Mail_Part::getHeader()

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

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

Returns

Type	Description
string \| array	value of header in wanted or internal format

Throws

Exception	Description
\Zend_Mail_Exception

getHeaderField(string $name, string $wantedPart = 0, string $firstName = 0) : string | array

inherited

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

Inherited from: \Zend_Mail_Part::getHeaderField()

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

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

Returns

Type	Description
string \| array	wanted part or all parts as array($firstName => firstPart, partname => value)

Throws

Exception	Description
\Zend_Exception,	Zend_Mail_Exception

getHeaders() : array

inherited

Get all headers

Inherited from: \Zend_Mail_Part::getHeaders()

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

Type	Description
array	headers as array(name => value)

getPart(int $num) : \Zend_Mail_Part

inherited

Get part of multipart message

Inherited from: \Zend_Mail_Part::getPart()

Parameters

Name	Type	Description
$num	int	number of part starting with 1 for first part

Returns

Type	Description
\Zend_Mail_Part	wanted part

Throws

Exception	Description
\Zend_Mail_Exception

getPartClass() : string

inherited

Retrieve the class name used to encapsulate message parts

Inherited from: \Zend_Mail_Part::getPartClass()

Returns

Type	Description
string

getSize() : int

inherited

Return size of part

Inherited from: \Zend_Mail_Part::getSize()

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

Returns

Type	Description
int	size

getTopLines() : string

return toplines as found after headers

Returns

Type	Description
string	toplines

hasChildren() : bool

inherited

implements RecursiveIterator::hasChildren()

Inherited from: \Zend_Mail_Part::hasChildren()

Returns

Type	Description
bool	current element has children/is multipart

hasFlag(mixed $flag) : bool

check if flag is set

Parameters

Name	Type	Description
$flag	mixed	a flag name, use constants defined in Zend_Mail_Storage

Returns

Type	Description
bool	true if set, otherwise false

headerExists(string $name) : boolean

inherited

Check wheater the Mail part has a specific header.

Inherited from: \Zend_Mail_Part::headerExists()

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
boolean

isMultipart() : bool

inherited

Check if part is a multipart message

Inherited from: \Zend_Mail_Part::isMultipart()

Returns

Type	Description
bool	if part is multipart

key() : string

inherited

implements Iterator::key()

Inherited from: \Zend_Mail_Part::key()

Returns

Type	Description
string	key/number of current part

next() : null

inherited

implements Iterator::next()

Inherited from: \Zend_Mail_Part::next()

Returns

Type	Description
null

rewind() : null

inherited

implements Iterator::rewind()

Inherited from: \Zend_Mail_Part::rewind()

Returns

Type	Description
null

setPartClass(string $class) : \Zend_Mail_Part

inherited

Set name pf class used to encapsulate message parts

Inherited from: \Zend_Mail_Part::setPartClass()

Parameters

Name	Type	Description
$class	string

Returns

Type	Description
\Zend_Mail_Part

valid() : bool

inherited

implements Iterator::valid()

Inherited from: \Zend_Mail_Part::valid()

Returns

Type	Description
bool	check if there's a current element

Mail/Message.php

\Zend_Mail_Messagejump to top

Properties

Methods

\Zend_Mail_Message
jump to top