added the Mailer component

Author: fabpot

.gitignore

@@ -0,0 +1,3 @@
+vendor/
+composer.lock
+phpunit.xml

AbstractApiTransport.php

@@ -0,0 +1,68 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Mailer\Transport\Http\Api;
+
+use Psr\Log\LoggerInterface;
+use Symfony\Component\EventDispatcher\EventDispatcherInterface;
+use Symfony\Component\HttpClient\HttpClient;
+use Symfony\Component\Mailer\Exception\RuntimeException;
+use Symfony\Component\Mailer\SentMessage;
+use Symfony\Component\Mailer\SmtpEnvelope;
+use Symfony\Component\Mailer\Transport\AbstractTransport;
+use Symfony\Component\Mime\Address;
+use Symfony\Component\Mime\Email;
+use Symfony\Component\Mime\MessageConverter;
+use Symfony\Contracts\HttpClient\HttpClientInterface;
+
+/**
+ * @author Fabien Potencier <[email protected]>
+ *
+ * @experimental in 4.3
+ */
+abstract class AbstractApiTransport extends AbstractTransport
+{
+    protected $client;
+
+    public function __construct(HttpClientInterface $client = null, EventDispatcherInterface $dispatcher = null, LoggerInterface $logger = null)
+    {
+        $this->client = $client;
+        if (null === $client) {
+            if (!class_exists(HttpClient::class)) {
+                throw new \LogicException(sprintf('You cannot use "%s" as the HttpClient component is not installed. Try running "composer require symfony/http-client".', __CLASS__));
+            }
+
+            $this->client = HttpClient::create();
+        }
+
+        parent::__construct($dispatcher, $logger);
+    }
+
+    abstract protected function doSendEmail(Email $email, SmtpEnvelope $envelope): void;
+
+    protected function doSend(SentMessage $message): void
+    {
+        try {
+            $email = MessageConverter::toEmail($message->getOriginalMessage());
+        } catch (\Exception $e) {
+            throw new RuntimeException(sprintf('Unable to send message with the "%s" transport: %s', __CLASS__, $e->getMessage()), 0, $e);
+        }
+
+        $this->doSendEmail($email, $message->getEnvelope());
+    }
+
+    protected function getRecipients(Email $email, SmtpEnvelope $envelope): array
+    {
+        return \array_filter($envelope->getRecipients(), function (Address $address) use ($email) {
+            return false === \in_array($address, \array_merge($email->getCc(), $email->getBcc()), true);
+        });
+    }
+}

AbstractStream.php

@@ -0,0 +1,119 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Mailer\Transport\Smtp\Stream;
+
+use Symfony\Component\Mailer\Exception\TransportException;
+
+/**
+ * A stream supporting remote sockets and local processes.
+ *
+ * @author Fabien Potencier <[email protected]>
+ * @author Nicolas Grekas <[email protected]>
+ * @author Chris Corbyn
+ *
+ * @internal
+ *
+ * @experimental in 4.3
+ */
+abstract class AbstractStream
+{
+    protected $stream;
+    protected $in;
+    protected $out;
+
+    public function write(string $bytes): void
+    {
+        $bytesToWrite = \strlen($bytes);
+        $totalBytesWritten = 0;
+        while ($totalBytesWritten < $bytesToWrite) {
+            $bytesWritten = fwrite($this->in, substr($bytes, $totalBytesWritten));
+            if (false === $bytesWritten || 0 === $bytesWritten) {
+                throw new TransportException('Unable to write bytes on the wire.');
+            }
+
+            $totalBytesWritten += $bytesWritten;
+        }
+    }
+
+    /**
+     * Flushes the contents of the stream (empty it) and set the internal pointer to the beginning.
+     */
+    public function flush(): void
+    {
+        fflush($this->in);
+    }
+
+    /**
+     * Performs any initialization needed.
+     */
+    abstract public function initialize(): void;
+
+    public function terminate(): void
+    {
+        $this->stream = $this->out = $this->in = null;
+    }
+
+    public function readLine(): string
+    {
+        if (feof($this->out)) {
+            return '';
+        }
+
+        $line = fgets($this->out);
+        if (0 === \strlen($line)) {
+            $metas = stream_get_meta_data($this->out);
+            if ($metas['timed_out']) {
+                throw new TransportException(sprintf('Connection to "%s" timed out.', $this->getReadConnectionDescription()));
+            }
+        }
+
+        return $line;
+    }
+
+    public static function replace(string $from, string $to, iterable $chunks): \Generator
+    {
+        if ('' === $from) {
+            yield from $chunks;
+
+            return;
+        }
+
+        $carry = '';
+        $fromLen = \strlen($from);
+
+        foreach ($chunks as $chunk) {
+            if ('' === $chunk = $carry.$chunk) {
+                continue;
+            }
+
+            if (false !== strpos($chunk, $from)) {
+                $chunk = explode($from, $chunk);
+                $carry = array_pop($chunk);
+
+                yield implode($to, $chunk).$to;
+            } else {
+                $carry = $chunk;
+            }
+
+            if (\strlen($carry) > $fromLen) {
+                yield substr($carry, 0, -$fromLen);
+                $carry = substr($carry, -$fromLen);
+            }
+        }
+
+        if ('' !== $carry) {
+            yield $carry;
+        }
+    }
+
+    abstract protected function getReadConnectionDescription(): string;
+}

AbstractStreamTest.php

@@ -0,0 +1,38 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Mailer\Tests\Transport\Smtp\Stream;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Mailer\Transport\Smtp\Stream\AbstractStream;
+
+class AbstractStreamTest extends TestCase
+{
+    /**
+     * @dataProvider provideReplace
+     */
+    public function testReplace(string $expected, string $from, string $to, array $chunks)
+    {
+        $result = '';
+        foreach (AbstractStream::replace($from, $to, $chunks) as $chunk) {
+            $result .= $chunk;
+        }
+
+        $this->assertSame($expected, $result);
+    }
+
+    public function provideReplace()
+    {
+        yield ['ca', 'ab', 'c', ['a', 'b', 'a']];
+        yield ['ac', 'ab', 'c', ['a', 'ab']];
+        yield ['cbc', 'aba', 'c', ['ababa', 'ba']];
+    }
+}

AbstractTransport.php

@@ -0,0 +1,118 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Mailer\Transport;
+
+use Psr\Log\LoggerInterface;
+use Psr\Log\NullLogger;
+use Symfony\Component\EventDispatcher\EventDispatcher;
+use Symfony\Component\EventDispatcher\EventDispatcherInterface;
+use Symfony\Component\Mailer\Event\MessageEvent;
+use Symfony\Component\Mailer\Exception\TransportException;
+use Symfony\Component\Mailer\SentMessage;
+use Symfony\Component\Mailer\SmtpEnvelope;
+use Symfony\Component\Mime\Address;
+use Symfony\Component\Mime\RawMessage;
+
+/**
+ * @author Fabien Potencier <[email protected]>
+ *
+ * @experimental in 4.3
+ */
+abstract class AbstractTransport implements TransportInterface
+{
+    private $dispatcher;
+    private $logger;
+    private $rate = 0;
+    private $lastSent = 0;
+
+    public function __construct(EventDispatcherInterface $dispatcher = null, LoggerInterface $logger = null)
+    {
+        $this->dispatcher = $dispatcher ?: new EventDispatcher();
+        $this->logger = $logger ?: new NullLogger();
+    }
+
+    /**
+     * Sets the maximum number of messages to send per second (0 to disable).
+     */
+    public function setMaxPerSecond(float $rate): self
+    {
+        if (0 >= $rate) {
+            $rate = 0;
+        }
+
+        $this->rate = $rate;
+        $this->lastSent = 0;
+
+        return $this;
+    }
+
+    public function send(RawMessage $message, SmtpEnvelope $envelope = null): ?SentMessage
+    {
+        $message = clone $message;
+        if (null !== $envelope) {
+            $envelope = clone $envelope;
+        } else {
+            try {
+                $envelope = SmtpEnvelope::create($message);
+            } catch (\Exception $e) {
+                throw new TransportException('Cannot send message without a valid envelope.', 0, $e);
+            }
+        }
+
+        $event = new MessageEvent($message, $envelope);
+        $this->dispatcher->dispatch($event);
+        $envelope = $event->getEnvelope();
+        if (!$envelope->getRecipients()) {
+            return null;
+        }
+
+        $message = new SentMessage($event->getMessage(), $envelope);
+        $this->doSend($message);
+
+        $this->checkThrottling();
+
+        return $message;
+    }
+
+    abstract protected function doSend(SentMessage $message): void;
+
+    /**
+     * @param Address[] $addresses
+     *
+     * @return string[]
+     */
+    protected function stringifyAddresses(array $addresses): array
+    {
+        return \array_map(function (Address $a) {
+            return $a->toString();
+        }, $addresses);
+    }
+
+    protected function getLogger(): LoggerInterface
+    {
+        return $this->logger;
+    }
+
+    private function checkThrottling()
+    {
+        if (0 == $this->rate) {
+            return;
+        }
+
+        $sleep = (1 / $this->rate) - (microtime(true) - $this->lastSent);
+        if (0 < $sleep) {
+            $this->logger->debug(sprintf('Email transport "%s" sleeps for %.2f seconds', __CLASS__, $sleep));
+            usleep($sleep * 1000000);
+        }
+        $this->lastSent = microtime(true);
+    }
+}