interface/modules/zend_modules/library/Zend/Mail/Transport/Sendmail.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\Transport;
  11
  12 use Traversable;
  13 use Zend\Mail;
  14 use Zend\Mail\Address\AddressInterface;
  15 use Zend\Mail\Exception;
  16 use Zend\Mail\Header\HeaderInterface;
  17
  18 /**
  19  * Class for sending email via the PHP internal mail() function
  20  */
  21 class Sendmail implements TransportInterface
  22 {
  23     /**
  24      * Config options for sendmail parameters
  25      *
  26      * @var string
  27      */
  28     protected $parameters;
  29
  30     /**
  31      * Callback to use when sending mail; typically, {@link mailHandler()}
  32      *
  33      * @var callable
  34      */
  35     protected $callable;
  36
  37     /**
  38      * error information
  39      * @var string
  40      */
  41     protected $errstr;
  42
  43     /**
  44      * @var string
  45      */
  46     protected $operatingSystem;
  47
  48     /**
  49      * Constructor.
  50      *
  51      * @param  null|string|array|Traversable $parameters OPTIONAL (Default: null)
  52      */
  53     public function __construct($parameters = null)
  54     {
  55         if ($parameters !== null) {
  56             $this->setParameters($parameters);
  57         }
  58         $this->callable = array($this, 'mailHandler');
  59     }
  60
  61     /**
  62      * Set sendmail parameters
  63      *
  64      * Used to populate the additional_parameters argument to mail()
  65      *
  66      * @param  null|string|array|Traversable $parameters
  67      * @throws \Zend\Mail\Exception\InvalidArgumentException
  68      * @return Sendmail
  69      */
  70     public function setParameters($parameters)
  71     {
  72         if ($parameters === null || is_string($parameters)) {
  73             $this->parameters = $parameters;
  74             return $this;
  75         }
  76
  77         if (!is_array($parameters) && !$parameters instanceof Traversable) {
  78             throw new Exception\InvalidArgumentException(sprintf(
  79                 '%s expects a string, array, or Traversable object of parameters; received "%s"',
  80                 __METHOD__,
  81                 (is_object($parameters) ? get_class($parameters) : gettype($parameters))
  82             ));
  83         }
  84
  85         $string = '';
  86         foreach ($parameters as $param) {
  87             $string .= ' ' . $param;
  88         }
  89         trim($string);
  90
  91         $this->parameters = $string;
  92         return $this;
  93     }
  94
  95     /**
  96      * Set callback to use for mail
  97      *
  98      * Primarily for testing purposes, but could be used to curry arguments.
  99      *
 100      * @param  callable $callable
 101      * @throws \Zend\Mail\Exception\InvalidArgumentException
 102      * @return Sendmail
 103      */
 104     public function setCallable($callable)
 105     {
 106         if (!is_callable($callable)) {
 107             throw new Exception\InvalidArgumentException(sprintf(
 108                 '%s expects a callable argument; received "%s"',
 109                 __METHOD__,
 110                 (is_object($callable) ? get_class($callable) : gettype($callable))
 111             ));
 112         }
 113         $this->callable = $callable;
 114         return $this;
 115     }
 116
 117     /**
 118      * Send a message
 119      *
 120      * @param  \Zend\Mail\Message $message
 121      */
 122     public function send(Mail\Message $message)
 123     {
 124         $to      = $this->prepareRecipients($message);
 125         $subject = $this->prepareSubject($message);
 126         $body    = $this->prepareBody($message);
 127         $headers = $this->prepareHeaders($message);
 128         $params  = $this->prepareParameters($message);
 129
 130         // On *nix platforms, we need to replace \r\n with \n
 131         // sendmail is not an SMTP server, it is a unix command - it expects LF
 132         if (!$this->isWindowsOs()) {
 133             $to      = str_replace("\r\n", "\n", $to);
 134             $subject = str_replace("\r\n", "\n", $subject);
 135             $body    = str_replace("\r\n", "\n", $body);
 136             $headers = str_replace("\r\n", "\n", $headers);
 137         }
 138
 139         call_user_func($this->callable, $to, $subject, $body, $headers, $params);
 140     }
 141
 142     /**
 143      * Prepare recipients list
 144      *
 145      * @param  \Zend\Mail\Message $message
 146      * @throws \Zend\Mail\Exception\RuntimeException
 147      * @return string
 148      */
 149     protected function prepareRecipients(Mail\Message $message)
 150     {
 151         $headers = $message->getHeaders();
 152
 153         if (!$headers->has('to')) {
 154             throw new Exception\RuntimeException('Invalid email; contains no "To" header');
 155         }
 156
 157         $to   = $headers->get('to');
 158         $list = $to->getAddressList();
 159         if (0 == count($list)) {
 160             throw new Exception\RuntimeException('Invalid "To" header; contains no addresses');
 161         }
 162
 163         // If not on Windows, return normal string
 164         if (!$this->isWindowsOs()) {
 165             return $to->getFieldValue(HeaderInterface::FORMAT_ENCODED);
 166         }
 167
 168         // Otherwise, return list of emails
 169         $addresses = array();
 170         foreach ($list as $address) {
 171             $addresses[] = $address->getEmail();
 172         }
 173         $addresses = implode(', ', $addresses);
 174         return $addresses;
 175     }
 176
 177     /**
 178      * Prepare the subject line string
 179      *
 180      * @param  \Zend\Mail\Message $message
 181      * @return string
 182      */
 183     protected function prepareSubject(Mail\Message $message)
 184     {
 185         $headers = $message->getHeaders();
 186         if (!$headers->has('subject')) {
 187             return null;
 188         }
 189         $header = $headers->get('subject');
 190         return $header->getFieldValue(HeaderInterface::FORMAT_ENCODED);
 191     }
 192
 193     /**
 194      * Prepare the body string
 195      *
 196      * @param  \Zend\Mail\Message $message
 197      * @return string
 198      */
 199     protected function prepareBody(Mail\Message $message)
 200     {
 201         if (!$this->isWindowsOs()) {
 202             // *nix platforms can simply return the body text
 203             return $message->getBodyText();
 204         }
 205
 206         // On windows, lines beginning with a full stop need to be fixed
 207         $text = $message->getBodyText();
 208         $text = str_replace("\n.", "\n..", $text);
 209         return $text;
 210     }
 211
 212     /**
 213      * Prepare the textual representation of headers
 214      *
 215      * @param  \Zend\Mail\Message $message
 216      * @return string
 217      */
 218     protected function prepareHeaders(Mail\Message $message)
 219     {
 220         // On Windows, simply return verbatim
 221         if ($this->isWindowsOs()) {
 222             return $message->getHeaders()->toString();
 223         }
 224
 225         // On *nix platforms, strip the "to" header
 226         $headers = clone $message->getHeaders();
 227         $headers->removeHeader('To');
 228         $headers->removeHeader('Subject');
 229         return $headers->toString();
 230     }
 231
 232     /**
 233      * Prepare additional_parameters argument
 234      *
 235      * Basically, overrides the MAIL FROM envelope with either the Sender or
 236      * From address.
 237      *
 238      * @param  \Zend\Mail\Message $message
 239      * @return string
 240      */
 241     protected function prepareParameters(Mail\Message $message)
 242     {
 243         if ($this->isWindowsOs()) {
 244             return null;
 245         }
 246
 247         $parameters = (string) $this->parameters;
 248
 249         $sender = $message->getSender();
 250         if ($sender instanceof AddressInterface) {
 251             $parameters .= ' -f ' . $sender->getEmail();
 252             return $parameters;
 253         }
 254
 255         $from = $message->getFrom();
 256         if (count($from)) {
 257             $from->rewind();
 258             $sender      = $from->current();
 259             $parameters .= ' -f ' . $sender->getEmail();
 260             return $parameters;
 261         }
 262
 263         return $parameters;
 264     }
 265
 266     /**
 267      * Send mail using PHP native mail()
 268      *
 269      * @param  string $to
 270      * @param  string $subject
 271      * @param  string $message
 272      * @param  string $headers
 273      * @param  $parameters
 274      * @throws \Zend\Mail\Exception\RuntimeException
 275      */
 276     public function mailHandler($to, $subject, $message, $headers, $parameters)
 277     {
 278         set_error_handler(array($this, 'handleMailErrors'));
 279         if ($parameters === null) {
 280             $result = mail($to, $subject, $message, $headers);
 281         } else {
 282             $result = mail($to, $subject, $message, $headers, $parameters);
 283         }
 284         restore_error_handler();
 285
 286         if ($this->errstr !== null || !$result) {
 287             $errstr = $this->errstr;
 288             if (empty($errstr)) {
 289                 $errstr = 'Unknown error';
 290             }
 291             throw new Exception\RuntimeException('Unable to send mail: ' . $errstr);
 292         }
 293     }
 294
 295     /**
 296      * Temporary error handler for PHP native mail().
 297      *
 298      * @param int    $errno
 299      * @param string $errstr
 300      * @param string $errfile
 301      * @param string $errline
 302      * @param array  $errcontext
 303      * @return bool always true
 304      */
 305     public function handleMailErrors($errno, $errstr, $errfile = null, $errline = null, array $errcontext = null)
 306     {
 307         $this->errstr = $errstr;
 308         return true;
 309     }
 310
 311     /**
 312      * Is this a windows OS?
 313      *
 314      * @return bool
 315      */
 316     protected function isWindowsOs()
 317     {
 318         if (!$this->operatingSystem) {
 319             $this->operatingSystem = strtoupper(substr(PHP_OS, 0, 3));
 320         }
 321         return ($this->operatingSystem == 'WIN');
 322     }
 323 }