Zend_Mail_Message Class Reference

Inheritance diagram for Zend_Mail_Message:

Public Member Functions
	__construct (array $params)
	getTopLines ()
	hasFlag ($flag)
	getFlags ()
Public Member Functions inherited from Zend_Mail_Part
	__construct (array $params)
	setPartClass ($class)
	getPartClass ()
	isMultipart ()
	getContent ()
	getSize ()
	getPart ($num)
	countParts ()
	getHeaders ()
	getHeader ($name, $format=null)
	headerExists ($name)
	getHeaderField ($name, $wantedPart=0, $firstName=0)
	__get ($name)
	__isset ($name)
	__toString ()
	hasChildren ()
	getChildren ()
	valid ()
	next ()
	key ()
	current ()
	rewind ()

Protected Attributes
	$_flags = array()
Protected Attributes inherited from Zend_Mail_Part
	$_headers
	$_content
	$_topLines = ''
	$_parts = array()
	$_countParts
	$_iterationPos = 1
	$_mail
	$_messageNum = 0
	$_partClass

Additional Inherited Members
Protected Member Functions inherited from Zend_Mail_Part
	_cacheContent ()
	_validateHeaders (array $headers, $assertNames=true)

Detailed Description

Definition at line 39 of file Message.php.

Constructor & Destructor Documentation

__construct()

__construct

(

array

$params

)

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

string

$rawMessage

full message with or without headers

Exceptions

Zend_Mail_Exception

See also

Zend_Mail_Exception

Definition at line 57 of file Message.php.

    {
        if (isset($params['file'])) {
            if (!is_resource($params['file'])) {
                $params['raw'] = @file_get_contents($params['file']);
                if ($params['raw'] === false) {
                    #require_once 'Zend/Mail/Exception.php';
                    throw new Zend_Mail_Exception('could not open file');
                }
            } else {
                $params['raw'] = stream_get_contents($params['file']);
            }
            $params['raw'] = preg_replace("/(?<!\r)\n/", "\r\n", $params['raw']);
        }

        if (!empty($params['flags'])) {
            // set key and value to the same value for easy lookup
            $this->_flags = array_merge($this->_flags, array_combine($params['flags'],$params['flags']));
        }

        parent::__construct($params);
    }

Member Function Documentation

getFlags()

getFlags

(

)

get all set flags

Returns

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

Implements Zend_Mail_Message_Interface.

Definition at line 109 of file Message.php.

    {
        return $this->_flags;
    }

getTopLines()

getTopLines

(

)

return toplines as found after headers

Returns

string toplines

Implements Zend_Mail_Message_Interface.

Definition at line 88 of file Message.php.

    {
        return $this->_topLines;
    }

hasFlag()

hasFlag

(

$flag

)

check if flag is set

Parameters

mixed

$flag

a flag name, use constants defined in Zend_Mail_Storage

Returns

bool true if set, otherwise false

Implements Zend_Mail_Message_Interface.

Definition at line 99 of file Message.php.

    {
        return isset($this->_flags[$flag]);
    }

Field Documentation

$_flags

$_flags = array()

protected

Definition at line 45 of file Message.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/Mail/Message.php