[Mime] add DraftEmail

kbond · fabpot · commit 5d6b4a049c61 · 2021-12-22T07:40:58.000+01:00
diff --git a/src/Symfony/Component/Mime/DraftEmail.php b/src/Symfony/Component/Mime/DraftEmail.php
@@ -0,0 +1,45 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Mime;
+
+use Symfony\Component\Mime\Header\Headers;
+use Symfony\Component\Mime\Part\AbstractPart;
+
+/**
+ * @author Kevin Bond <kevinbond@gmail.com>
+ */
+class DraftEmail extends Email
+{
+    public function __construct(Headers $headers = null, AbstractPart $body = null)
+    {
+        parent::__construct($headers, $body);
+
+        $this->getHeaders()->addTextHeader('X-Unsent', '1');
+    }
+
+    /**
+     * Override default behavior as draft emails do not require From/Sender/Date/Message-ID headers.
+     * These are added by the client that actually sends the email.
+     */
+    public function getPreparedHeaders(): Headers
+    {
+        $headers = clone $this->getHeaders();
+
+        if (!$headers->has('MIME-Version')) {
+            $headers->addTextHeader('MIME-Version', '1.0');
+        }
+
+        $headers->remove('Bcc');
+
+        return $headers;
+    }
+}
diff --git a/src/Symfony/Component/Mime/Email.php b/src/Symfony/Component/Mime/Email.php
@@ -386,13 +386,22 @@ public function getBody(): AbstractPart
 
     public function ensureValidity()
     {
-        if (null === $this->text && null === $this->html && !$this->attachments) {
-            throw new LogicException('A message must have a text or an HTML part or attachments.');
+        $this->ensureBodyValid();
+
+        if ('1' === $this->getHeaders()->getHeaderBody('X-Unsent')) {
+            throw new LogicException('Cannot send messages marked as "draft".');
         }
 
         parent::ensureValidity();
     }
 
+    private function ensureBodyValid(): void
+    {
+        if (null === $this->text && null === $this->html && !$this->attachments) {
+            throw new LogicException('A message must have a text or an HTML part or attachments.');
+        }
+    }
+
     /**
      * Generates an AbstractPart based on the raw body of a message.
      *
@@ -415,7 +424,7 @@ public function ensureValidity()
      */
     private function generateBody(): AbstractPart
     {
-        $this->ensureValidity();
+        $this->ensureBodyValid();
 
         [$htmlPart, $attachmentParts, $inlineParts] = $this->prepareParts();
 
diff --git a/src/Symfony/Component/Mime/Tests/DraftEmailTest.php b/src/Symfony/Component/Mime/Tests/DraftEmailTest.php
@@ -0,0 +1,58 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Mime\Tests;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Mime\DraftEmail;
+use Symfony\Component\Mime\Exception\LogicException;
+
+/**
+ * @author Kevin Bond <kevinbond@gmail.com>
+ */
+final class DraftEmailTest extends TestCase
+{
+    public function testCanHaveJustBody()
+    {
+        $email = (new DraftEmail())->text('some text')->toString();
+
+        $this->assertStringContainsString('some text', $email);
+        $this->assertStringContainsString('MIME-Version: 1.0', $email);
+        $this->assertStringContainsString('X-Unsent: 1', $email);
+    }
+
+    public function testBccIsRemoved()
+    {
+        $email = (new DraftEmail())->text('some text')->bcc('sam@example.com')->toString();
+
+        $this->assertStringNotContainsString('sam@example.com', $email);
+    }
+
+    public function testMustHaveBody()
+    {
+        $this->expectException(LogicException::class);
+
+        (new DraftEmail())->toString();
+    }
+
+    public function testEnsureValidityAlwaysFails()
+    {
+        $email = (new DraftEmail())
+            ->to('alice@example.com')
+            ->from('webmaster@example.com')
+            ->text('some text')
+        ;
+
+        $this->expectException(LogicException::class);
+
+        $email->ensureValidity();
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -386,13 +386,22 @@ public function getBody(): AbstractPart`
`386`	`386`
`387`	`387`	`public function ensureValidity()`
`388`	`388`	`{`
`389`		`- if (null === $this->text && null === $this->html && !$this->attachments) {`
`390`		`- throw new LogicException('A message must have a text or an HTML part or attachments.');`
	`389`	`+ $this->ensureBodyValid();`
	`390`	`+`
	`391`	`+ if ('1' === $this->getHeaders()->getHeaderBody('X-Unsent')) {`
	`392`	`+ throw new LogicException('Cannot send messages marked as "draft".');`
`391`	`393`	`}`
`392`	`394`
`393`	`395`	`parent::ensureValidity();`
`394`	`396`	`}`
`395`	`397`
	`398`	`+ private function ensureBodyValid(): void`
	`399`	`+ {`
	`400`	`+ if (null === $this->text && null === $this->html && !$this->attachments) {`
	`401`	`+ throw new LogicException('A message must have a text or an HTML part or attachments.');`
	`402`	`+ }`
	`403`	`+ }`
	`404`	`+`
`396`	`405`	`/**`
`397`	`406`	`* Generates an AbstractPart based on the raw body of a message.`
`398`	`407`	`*`
`@@ -415,7 +424,7 @@ public function ensureValidity()`
`415`	`424`	`*/`
`416`	`425`	`private function generateBody(): AbstractPart`
`417`	`426`	`{`
`418`		`- $this->ensureValidity();`
	`427`	`+ $this->ensureBodyValid();`
`419`	`428`
`420`	`429`	`[$htmlPart, $attachmentParts, $inlineParts] = $this->prepareParts();`
`421`	`430`