interface/modules/zend_modules/library/Zend/Mail/Header/Sender.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;
  13 use Zend\Mime\Mime;
  14
  15 /**
  16  * Sender header class methods.
  17  *
  18  * @see https://tools.ietf.org/html/rfc2822 RFC 2822
  19  * @see https://tools.ietf.org/html/rfc2047 RFC 2047
  20  */
  21 class Sender implements HeaderInterface
  22 {
  23     /**
  24      * @var \Zend\Mail\Address\AddressInterface
  25      */
  26     protected $address;
  27
  28     /**
  29      * Header encoding
  30      *
  31      * @var null|string
  32      */
  33     protected $encoding;
  34
  35     public static function fromString($headerLine)
  36     {
  37         list($name, $value) = GenericHeader::splitHeaderLine($headerLine);
  38         $value = HeaderWrap::mimeDecodeValue($value);
  39
  40         // check to ensure proper header type for this factory
  41         if (strtolower($name) !== 'sender') {
  42             throw new Exception\InvalidArgumentException('Invalid header line for Sender string');
  43         }
  44
  45         $header      = new static();
  46         $senderName  = '';
  47         $senderEmail = '';
  48
  49         // Check for address, and set if found
  50         if (preg_match('/^(?P<name>.*?)<(?P<email>[^>]+)>$/', $value, $matches)) {
  51             $senderName = trim($matches['name']);
  52             if (empty($senderName)) {
  53                 $senderName = null;
  54             }
  55             $senderEmail = $matches['email'];
  56         } else {
  57             $senderEmail = $value;
  58         }
  59
  60         $header->setAddress($senderEmail, $senderName);
  61
  62         return $header;
  63     }
  64
  65     public function getFieldName()
  66     {
  67         return 'Sender';
  68     }
  69
  70     public function getFieldValue($format = HeaderInterface::FORMAT_RAW)
  71     {
  72         if (! $this->address instanceof Mail\Address\AddressInterface) {
  73             return '';
  74         }
  75
  76         $email = sprintf('<%s>', $this->address->getEmail());
  77         $name  = $this->address->getName();
  78
  79         if (!empty($name)) {
  80             if ($format == HeaderInterface::FORMAT_ENCODED) {
  81                 $encoding = $this->getEncoding();
  82                 if ('ASCII' !== $encoding) {
  83                     $name  = HeaderWrap::mimeEncodeValue($name, $encoding);
  84                 }
  85             }
  86             $email = sprintf('%s %s', $name, $email);
  87         }
  88
  89         return $email;
  90     }
  91
  92     public function setEncoding($encoding)
  93     {
  94         $this->encoding = $encoding;
  95         return $this;
  96     }
  97
  98     public function getEncoding()
  99     {
 100         if (! $this->encoding) {
 101             $this->encoding = Mime::isPrintable($this->getFieldValue(HeaderInterface::FORMAT_RAW))
 102                 ? 'ASCII'
 103                 : 'UTF-8';
 104         }
 105
 106         return $this->encoding;
 107     }
 108
 109     public function toString()
 110     {
 111         return 'Sender: ' . $this->getFieldValue(HeaderInterface::FORMAT_ENCODED);
 112     }
 113
 114     /**
 115      * Set the address used in this header
 116      *
 117      * @param  string|\Zend\Mail\Address\AddressInterface $emailOrAddress
 118      * @param  null|string $name
 119      * @throws Exception\InvalidArgumentException
 120      * @return Sender
 121      */
 122     public function setAddress($emailOrAddress, $name = null)
 123     {
 124         if (is_string($emailOrAddress)) {
 125             $emailOrAddress = new Mail\Address($emailOrAddress, $name);
 126         } elseif (!$emailOrAddress instanceof Mail\Address\AddressInterface) {
 127             throw new Exception\InvalidArgumentException(sprintf(
 128                 '%s expects a string or AddressInterface object; received "%s"',
 129                 __METHOD__,
 130                 (is_object($emailOrAddress) ? get_class($emailOrAddress) : gettype($emailOrAddress))
 131             ));
 132         }
 133         $this->address = $emailOrAddress;
 134         return $this;
 135     }
 136
 137     /**
 138      * Retrieve the internal address from this header
 139      *
 140      * @return \Zend\Mail\Address\AddressInterface|null
 141      */
 142     public function getAddress()
 143     {
 144         return $this->address;
 145     }
 146 }