library/Zend/Mail/Message/Interface.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  * @subpackage Storage
  18  * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
  19  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  20  * @version    $Id: Interface.php 16971 2009-07-22 18:05:45Z mikaelkael $
  21  */
  22
  23
  24 /**
  25  * @category   Zend
  26  * @package    Zend_Mail
  27  * @subpackage Storage
  28  * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
  29  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  30  */
  31
  32 interface Zend_Mail_Message_Interface
  33 {
  34     /**
  35      * return toplines as found after headers
  36      *
  37      * @return string toplines
  38      */
  39     public function getTopLines();
  40
  41     /**
  42      * check if flag is set
  43      *
  44      * @param mixed $flag a flag name, use constants defined in Zend_Mail_Storage
  45      * @return bool true if set, otherwise false
  46      */
  47     public function hasFlag($flag);
  48
  49     /**
  50      * get all set flags
  51      *
  52      * @return array array with flags, key and value are the same for easy lookup
  53      */
  54     public function getFlags();
  55 }