Mail/Message/Interface.php

0001 <?php
0002 /**
0003  * Zend Framework
0004  *
0005  * LICENSE
0006  *
0007  * This source file is subject to the new BSD license that is bundled
0008  * with this package in the file LICENSE.txt.
0009  * It is also available through the world-wide-web at this URL:
0010  * http://framework.zend.com/license/new-bsd
0011  * If you did not receive a copy of the license and are unable to
0012  * obtain it through the world-wide-web, please send an email
0013  * to license@zend.com so we can send you a copy immediately.
0014  *
0015  * @category   Zend
0016  * @package    Zend_Mail
0017  * @subpackage Storage
0018  * @copyright  Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
0019  * @license    http://framework.zend.com/license/new-bsd     New BSD License
0020  * @version    $Id$
0021  */
0022
0023
0024 /**
0025  * @category   Zend
0026  * @package    Zend_Mail
0027  * @subpackage Storage
0028  * @copyright  Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
0029  * @license    http://framework.zend.com/license/new-bsd     New BSD License
0030  */
0031
0032 interface Zend_Mail_Message_Interface
0033 {
0034     /**
0035      * return toplines as found after headers
0036      *
0037      * @return string toplines
0038      */
0039     public function getTopLines();
0040
0041     /**
0042      * check if flag is set
0043      *
0044      * @param mixed $flag a flag name, use constants defined in Zend_Mail_Storage
0045      * @return bool true if set, otherwise false
0046      */
0047     public function hasFlag($flag);
0048
0049     /**
0050      * get all set flags
0051      *
0052      * @return array array with flags, key and value are the same for easy lookup
0053      */
0054     public function getFlags();
0055 }