API Documentation

Zend/Mail/Message.php

Show: inherited
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 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Mail_Message

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

Propertyprotectedarray  $_flags= 'array()'

flags for this message

Default valuearray()Details
Type
array

Methods

methodpublic__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
methodpublicgetFlags( ) : array

get all set flags

Returns
Type Description
array array with flags, key and value are the same for easy lookup
methodpublicgetTopLines( ) : string

return toplines as found after headers

Returns
Type Description
string toplines
methodpublichasFlag( 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
Documentation was generated by DocBlox 0.15.1.