/framework/vendor/zend/Zend/Mail/Message/File.php

 1<?php
 2/**
 3 * Zend Framework
 4 *
 5 * LICENSE
 6 *
 7 * This source file is subject to the new BSD license that is bundled
 8 * with this package in the file LICENSE.txt.
 9 * It is also available through the world-wide-web at this URL:
10 * http://framework.zend.com/license/new-bsd
11 * If you did not receive a copy of the license and are unable to
12 * obtain it through the world-wide-web, please send an email
13 * to license@zend.com so we can send you a copy immediately.
14 *
15 * @category   Zend
16 * @package    Zend_Mail
17 * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
18 * @license    http://framework.zend.com/license/new-bsd     New BSD License
19 * @version    $Id: File.php 20096 2010-01-06 02:05:09Z bkarwin $
20 */
21
22
23/**
24 * Zend_Mail_Part
25 */
26require_once 'Zend/Mail/Part/File.php';
27
28/**
29 * Zend_Mail_Message_Interface
30 */
31require_once 'Zend/Mail/Message/Interface.php';
32
33/**
34 * @category   Zend
35 * @package    Zend_Mail
36 * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
37 * @license    http://framework.zend.com/license/new-bsd     New BSD License
38 */
39class Zend_Mail_Message_File extends Zend_Mail_Part_File implements Zend_Mail_Message_Interface
40{
41    /**
42     * flags for this message
43     * @var array
44     */
45    protected $_flags = array();
46
47    /**
48     * Public constructor
49     *
50     * In addition to the parameters of Zend_Mail_Part::__construct() this constructor supports:
51     * - flags array with flags for message, keys are ignored, use constants defined in Zend_Mail_Storage
52     *
53     * @param  string $rawMessage  full message with or without headers
54     * @throws Zend_Mail_Exception
55     */
56    public function __construct(array $params)
57    {
58        if (!empty($params['flags'])) {
59            // set key and value to the same value for easy lookup
60            $this->_flags = array_combine($params['flags'], $params['flags']);
61        }
62
63        parent::__construct($params);
64    }
65
66    /**
67     * return toplines as found after headers
68     *
69     * @return string toplines
70     */
71    public function getTopLines()
72    {
73        return $this->_topLines;
74    }
75
76    /**
77     * check if flag is set
78     *
79     * @param mixed $flag a flag name, use constants defined in Zend_Mail_Storage
80     * @return bool true if set, otherwise false
81     */
82    public function hasFlag($flag)
83    {
84        return isset($this->_flags[$flag]);
85    }
86
87    /**
88     * get all set flags
89     *
90     * @return array array with flags, key and value are the same for easy lookup
91     */
92    public function getFlags()
93    {
94        return $this->_flags;
95    }
96}