Mail/Message.php
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
- 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|\Zend_Mail_Storage_Abstract $_mail
- Type
- null | \Zend_Mail_Storage_Abstract
- Inherited_from
- \Zend_Mail_Part::$$_mail
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
Name | Type | Description |
---|---|---|
$params |
Exception | Description |
---|---|
\Zend_Mail_Exception |


__get(string $name) : string
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')
Name | Type | Description |
---|---|---|
$name | string | header name |
Type | Description |
---|---|
string | value of header |
Exception | Description |
---|---|
\Zend_Mail_Exception |


__isset(string $name) : boolean
This method is short syntax for Zend_Mail_Part::hasHeader($name);
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
boolean |


_cacheContent() : null
Cache content and split in parts if multipart
Inherited from: \Zend_Mail_Part::_cacheContent()Type | Description |
---|---|
null |
Exception | Description |
---|---|
\Zend_Mail_Exception |


getContent() : string
If part is multipart the raw content of this part with all sub parts is returned
Type | Description |
---|---|
string | body |
Exception | Description |
---|---|
\Zend_Mail_Exception |


getFlags() : array
get all set flags
Type | Description |
---|---|
array | array with flags, key and value are the same for easy lookup |


getHeader(string $name, string $format = null) : string | array
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).
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' |
Type | Description |
---|---|
string | array | value of header in wanted or internal format |
Exception | Description |
---|---|
\Zend_Mail_Exception |


getHeaderField(string $name, string $wantedPart = 0, string $firstName = 0) : string | array
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.
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 |
Type | Description |
---|---|
string | array | wanted part or all parts as array($firstName => firstPart, partname => value) |
Exception | Description |
---|---|
\Zend_Exception, | Zend_Mail_Exception |


getHeaders() : array
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.
Type | Description |
---|---|
array | headers as array(name => value) |


getPart(int $num) : \Zend_Mail_Part
Name | Type | Description |
---|---|---|
$num | int | number of part starting with 1 for first part |
Type | Description |
---|---|
\Zend_Mail_Part | wanted part |
Exception | Description |
---|---|
\Zend_Mail_Exception |


getPartClass() : string
Retrieve the class name used to encapsulate message parts
Inherited from: \Zend_Mail_Part::getPartClass()Type | Description |
---|---|
string |


getSize() : int
Quite simple implemented currently (not decoding). Handle with care.
Type | Description |
---|---|
int | size |


hasFlag(mixed $flag) : bool
check if flag is set
Name | Type | Description |
---|---|---|
$flag | mixed | a flag name, use constants defined in Zend_Mail_Storage |
Type | Description |
---|---|
bool | true if set, otherwise false |


headerExists(string $name) : boolean
Check wheater the Mail part has a specific header.
Inherited from: \Zend_Mail_Part::headerExists()Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
boolean |


setPartClass(string $class) : \Zend_Mail_Part
Set name pf class used to encapsulate message parts
Inherited from: \Zend_Mail_Part::setPartClass()Name | Type | Description |
---|---|---|
$class | string |
Type | Description |
---|---|
\Zend_Mail_Part |