interface/modules/zend_modules/library/Zend/Mail/Header/HeaderInterface.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\Mail\Header;
  11
  12 interface HeaderInterface
  13 {
  14     /**
  15      * Format value in Mime-Encoding if not US-ASCII encoding is used
  16      *
  17      * @var bool
  18      */
  19     const FORMAT_ENCODED = true;
  20
  21     /**
  22      * Return value with the interval ZF2 value (UTF-8 non-encoded)
  23      *
  24      * @var bool
  25      */
  26     const FORMAT_RAW     = false;
  27
  28
  29     /**
  30      * Factory to generate a header object from a string
  31      *
  32      * @param string $headerLine
  33      * @return self
  34      * @throws Exception\InvalidArgumentException If the header does not match with RFC 2822 definition.
  35      * @see http://tools.ietf.org/html/rfc2822#section-2.2
  36      */
  37     public static function fromString($headerLine);
  38
  39     /**
  40      * Retrieve header name
  41      *
  42      * @return string
  43      */
  44     public function getFieldName();
  45
  46     /**
  47      * Retrieve header value
  48      *
  49      * @param  bool $format Return the value in Mime::Encoded or in Raw format
  50      * @return string
  51      */
  52     public function getFieldValue($format = HeaderInterface::FORMAT_RAW);
  53
  54     /**
  55      * Set header encoding
  56      *
  57      * @param  string $encoding
  58      * @return self
  59      */
  60     public function setEncoding($encoding);
  61
  62     /**
  63      * Get header encoding
  64      *
  65      * @return string
  66      */
  67     public function getEncoding();
  68
  69     /**
  70      * Cast to string
  71      *
  72      * Returns in form of "NAME: VALUE"
  73      *
  74      * @return string
  75      */
  76     public function toString();
  77 }