interface/modules/zend_modules/library/Zend/Mail/Header/HeaderWrap.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-2015 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 use Zend\Mail\Headers;
  13 use Zend\Mime\Mime;
  14
  15 /**
  16  * Utility class used for creating wrapped or MIME-encoded versions of header
  17  * values.
  18  */
  19 abstract class HeaderWrap
  20 {
  21     /**
  22      * Wrap a long header line
  23      *
  24      * @param  string          $value
  25      * @param  HeaderInterface $header
  26      * @return string
  27      */
  28     public static function wrap($value, HeaderInterface $header)
  29     {
  30         if ($header instanceof UnstructuredInterface) {
  31             return static::wrapUnstructuredHeader($value, $header);
  32         } elseif ($header instanceof StructuredInterface) {
  33             return static::wrapStructuredHeader($value, $header);
  34         }
  35         return $value;
  36     }
  37
  38     /**
  39      * Wrap an unstructured header line
  40      *
  41      * Wrap at 78 characters or before, based on whitespace.
  42      *
  43      * @param string          $value
  44      * @param HeaderInterface $header
  45      * @return string
  46      */
  47     protected static function wrapUnstructuredHeader($value, HeaderInterface $header)
  48     {
  49         $encoding = $header->getEncoding();
  50         if ($encoding == 'ASCII') {
  51             return wordwrap($value, 78, Headers::FOLDING);
  52         }
  53         return static::mimeEncodeValue($value, $encoding, 78);
  54     }
  55
  56     /**
  57      * Wrap a structured header line
  58      *
  59      * @param  string              $value
  60      * @param  StructuredInterface $header
  61      * @return string
  62      */
  63     protected static function wrapStructuredHeader($value, StructuredInterface $header)
  64     {
  65         $delimiter = $header->getDelimiter();
  66
  67         $length = strlen($value);
  68         $lines  = array();
  69         $temp   = '';
  70         for ($i = 0; $i < $length; $i++) {
  71             $temp .= $value[$i];
  72             if ($value[$i] == $delimiter) {
  73                 $lines[] = $temp;
  74                 $temp    = '';
  75             }
  76         }
  77         return implode(Headers::FOLDING, $lines);
  78     }
  79
  80     /**
  81      * MIME-encode a value
  82      *
  83      * Performs quoted-printable encoding on a value, setting maximum
  84      * line-length to 998.
  85      *
  86      * @param  string $value
  87      * @param  string $encoding
  88      * @param  int    $lineLength maximum line-length, by default 998
  89      * @return string Returns the mime encode value without the last line ending
  90      */
  91     public static function mimeEncodeValue($value, $encoding, $lineLength = 998)
  92     {
  93         return Mime::encodeQuotedPrintableHeader($value, $encoding, $lineLength, Headers::EOL);
  94     }
  95
  96     /**
  97      * MIME-decode a value
  98      *
  99      * Performs quoted-printable decoding on a value.
 100      *
 101      * @param  string $value
 102      * @return string Returns the mime encode value without the last line ending
 103      */
 104     public static function mimeDecodeValue($value)
 105     {
 106         $decodedValue = iconv_mime_decode($value, ICONV_MIME_DECODE_CONTINUE_ON_ERROR, 'UTF-8');
 107
 108         return $decodedValue;
 109     }
 110
 111     /**
 112      * Test if is possible apply MIME-encoding
 113      *
 114      * @param string $value
 115      * @return bool
 116      */
 117     public static function canBeEncoded($value)
 118     {
 119         $encoded = iconv_mime_encode('x-test', $value, array('scheme' => 'Q'));
 120
 121         return (false !== $encoded);
 122     }
 123 }