vendor/zendframework/zend-mail/src/Header/Received.php

   1 <?php
   2 /**
   3  * @see       https://github.com/zendframework/zend-mail for the canonical source repository
   4  * @copyright Copyright (c) 2005-2018 Zend Technologies USA Inc. (https://www.zend.com)
   5  * @license   https://github.com/zendframework/zend-mail/blob/master/LICENSE.md New BSD License
   6  */
   7
   8 namespace Zend\Mail\Header;
   9
  10 use Zend\Mail\Headers;
  11
  12 /**
  13  * @todo       Allow setting date from DateTime, Zend\Date, or string
  14  */
  15 class Received implements HeaderInterface, MultipleHeadersInterface
  16 {
  17     /**
  18      * @var string
  19      */
  20     protected $value;
  21
  22     public static function fromString($headerLine)
  23     {
  24         list($name, $value) = GenericHeader::splitHeaderLine($headerLine);
  25         $value = HeaderWrap::mimeDecodeValue($value);
  26
  27         // check to ensure proper header type for this factory
  28         if (strtolower($name) !== 'received') {
  29             throw new Exception\InvalidArgumentException('Invalid header line for Received string');
  30         }
  31
  32         $header = new static($value);
  33
  34         return $header;
  35     }
  36
  37     public function __construct($value = '')
  38     {
  39         if (! HeaderValue::isValid($value)) {
  40             throw new Exception\InvalidArgumentException('Invalid Received value provided');
  41         }
  42         $this->value = $value;
  43     }
  44
  45     public function getFieldName()
  46     {
  47         return 'Received';
  48     }
  49
  50     public function getFieldValue($format = HeaderInterface::FORMAT_RAW)
  51     {
  52         return $this->value;
  53     }
  54
  55     public function setEncoding($encoding)
  56     {
  57         // This header must be always in US-ASCII
  58         return $this;
  59     }
  60
  61     public function getEncoding()
  62     {
  63         return 'ASCII';
  64     }
  65
  66     public function toString()
  67     {
  68         return 'Received: ' . $this->getFieldValue();
  69     }
  70
  71     /**
  72      * Serialize collection of Received headers to string
  73      *
  74      * @param  array $headers
  75      * @throws Exception\RuntimeException
  76      * @return string
  77      */
  78     public function toStringMultipleHeaders(array $headers)
  79     {
  80         $strings = [$this->toString()];
  81         foreach ($headers as $header) {
  82             if (! $header instanceof Received) {
  83                 throw new Exception\RuntimeException(
  84                     'The Received multiple header implementation can only accept an array of Received headers'
  85                 );
  86             }
  87             $strings[] = $header->toString();
  88         }
  89         return implode(Headers::EOL, $strings);
  90     }
  91 }