Add initial draft of ReplyTo feature

Author: marickvantuil

.gitignore

@@ -2,4 +2,5 @@
 vendor/
 .DS_Store
 composer.lock
-.phpunit.result.cache
+.phpunit.result.cache
+.phpunit.cache

README.md

@@ -109,6 +109,17 @@ Email::compose()
     ->bcc(['[email protected]', '[email protected]']);
 ```
 
+### Reply-To
+
+```php
+<?php
+
+use Stackkit\LaravelDatabaseEmails\Email;
+
+Email::compose()
+    ->replyTo(['[email protected]', '[email protected]']);
+```
+
 ### Using mailables
 
 You may also pass a mailable to the e-mail composer.

composer.json

@@ -54,6 +54,9 @@
         "l6": [
             "composer require laravel/framework:8.* orchestra/testbench:6.* --no-interaction --no-update",
             "composer update --prefer-stable --prefer-dist --no-interaction"
+        ],
+        "test": [
+            "CI_DB_DRIVER=sqlite CI_DB_DATABASE=:memory: phpunit"
         ]
     }
 }

database/migrations/2021_12_02_21000_add_reply_to_to_emails_table.php

@@ -0,0 +1,30 @@
+<?php
+
+use Illuminate\Support\Facades\Schema;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Database\Migrations\Migration;
+
+class AddReplyToToEmailsTable extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::table('emails', function (Blueprint $table) {
+            $table->binary('reply_to')->nullable()->after('bcc');
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        //
+    }
+}

src/Email.php

@@ -15,6 +15,7 @@
  * @property $from
  * @property $cc
  * @property $bcc
+ * @property $reply_to
  * @property $subject
  * @property $view
  * @property $variables
@@ -190,6 +191,26 @@ public function getBccAttribute()
         return $this->bcc;
     }
 
+    /**
+     * Get the e-mail reply-to addresses.
+     *
+     * @return array|string
+     */
+    public function getReplyTo()
+    {
+        return $this->reply_to;
+    }
+
+    /**
+     * Get the e-mail reply-to addresses.
+     *
+     * @return array|string
+     */
+    public function getReplyToAttribute()
+    {
+        return $this->reply_to;
+    }
+
     /**
      * Get the e-mail subject.
      *
@@ -388,6 +409,16 @@ public function hasBcc(): bool
         return strlen($this->getRawDatabaseValue('bcc')) > 0;
     }
 
+    /**
+     * Determine if the e-mail should sent with reply-to.
+     *
+     * @return bool
+     */
+    public function hasReplyTo(): bool
+    {
+        return strlen($this->getRawDatabaseValue('reply_to') ?: '') > 0;
+    }
+
     /**
      * Determine if the e-mail is scheduled to be sent later.
      *

src/EmailComposer.php

@@ -139,6 +139,17 @@ public function bcc($bcc): self
         return $this->setData('bcc', $bcc);
     }
 
+    /**
+     * Define the reply-to address(es).
+     *
+     * @param string|array $replyTo
+     * @return self
+     */
+    public function replyTo($replyTo): self
+    {
+        return $this->setData('reply_to', $replyTo);
+    }
+
     /**
      * Set the e-mail subject.
      *

src/Encrypter.php

@@ -17,6 +17,8 @@ public function encrypt(EmailComposer $composer): void
 
         $this->encryptRecipients($composer);
 
+        $this->encryptReplyTo($composer);
+
         $this->encryptFrom($composer);
 
         $this->encryptSubject($composer);
@@ -36,6 +38,20 @@ private function setEncrypted(EmailComposer $composer): void
         $composer->getEmail()->setAttribute('encrypted', 1);
     }
 
+    /**
+     * Encrypt the e-mail reply-to.
+     *
+     * @param EmailComposer $composer
+     */
+    private function encryptReplyTo(EmailComposer $composer): void
+    {
+        $email = $composer->getEmail();
+
+        $email->fill([
+            'reply_to' => $composer->hasData('reply_to') ? encrypt($email->reply_to) : '',
+        ]);
+    }
+
     /**
      * Encrypt the e-mail addresses of the recipients.
      *

src/HasEncryptedAttributes.php

@@ -18,6 +18,7 @@ trait HasEncryptedAttributes
         'from',
         'cc',
         'bcc',
+        'reply_to',
         'subject',
         'variables',
         'body',
@@ -33,6 +34,7 @@ trait HasEncryptedAttributes
         'from',
         'cc',
         'bcc',
+        'reply_to',
         'variables',
     ];
 

src/MailableReader.php

@@ -34,6 +34,8 @@ public function read(EmailComposer $composer): void
 
         $this->readBcc($composer);
 
+        $this->readReplyTo($composer);
+
         $this->readSubject($composer);
 
         $this->readBody($composer);
@@ -115,6 +117,20 @@ private function readBcc(EmailComposer $composer): void
         $composer->bcc($bcc);
     }
 
+    /**
+     * Read the mailable reply-to to the email composer.
+     *
+     * @param EmailComposer $composer
+     */
+    private function readReplyTo(EmailComposer $composer): void
+    {
+        $replyTo = $this->convertMailableAddresses(
+            $composer->getData('mailable')->replyTo
+        );
+
+        $composer->replyTo($replyTo);
+    }
+
     /**
      * Read the mailable subject to the email composer.
      *

src/Preparer.php

@@ -25,6 +25,8 @@ public function prepare(EmailComposer $composer): void
 
         $this->prepareBcc($composer);
 
+        $this->prepareReplyTo($composer);
+
         $this->prepareSubject($composer);
 
         $this->prepareView($composer);
@@ -118,6 +120,18 @@ private function prepareBcc(EmailComposer $composer): void
         ]);
     }
 
+    /**
+     * Prepare the reply-to for database storage.
+     *
+     * @param EmailComposer $composer
+     */
+    private function prepareReplyTo(EmailComposer $composer): void
+    {
+        $composer->getEmail()->fill([
+            'reply_to' => json_encode($composer->getData('reply_to', [])),
+        ]);
+    }
+
     /**
      * Prepare the subject for database storage.
      *

src/Sender.php

@@ -46,6 +46,7 @@ private function buildMessage(Message $message, Email $email): void
         $message->to($email->getRecipient())
             ->cc($email->hasCc() ? $email->getCc() : [])
             ->bcc($email->hasBcc() ? $email->getBcc() : [])
+            ->replyTo($email->hasReplyTo() ? $email->getReplyTo() : [])
             ->subject($email->getSubject())
             ->from($email->getFromAddress(), $email->getFromName());
 

src/SentMessage.php

@@ -13,6 +13,7 @@ class SentMessage
     public $to = [];
     public $cc = [];
     public $bcc = [];
+    public $replyTo = [];
     public $subject = '';
     public $body = '';
     public $attachments = [];
@@ -38,6 +39,10 @@ public static function createFromSymfonyMailer(\Symfony\Component\Mime\Email $em
             $sentMessage->bcc[$address->getAddress()] = $address->getName();
         }
 
+        foreach ($email->getReplyTo() as $address) {
+            $sentMessage->replyTo[$address->getAddress()] = $address->getName();
+        }
+
         $sentMessage->subject = $email->getSubject();
         $sentMessage->body = $email->getHtmlBody();
         $sentMessage->attachments = array_map(function (DataPart $dataPart) {
@@ -58,6 +63,7 @@ public static function createFromSwiftMailer(\Swift_Mime_SimpleMessage $message)
         $sentMessage->to = $message->getTo();
         $sentMessage->cc = $message->getCc();
         $sentMessage->bcc = $message->getBcc();
+        $sentMessage->replyTo = $message->getReplyTo();
         $sentMessage->subject = $message->getSubject();
         $sentMessage->body = $message->getBody();
         $sentMessage->attachments = array_map(function(Swift_Mime_SimpleMimeEntity $entity) {

src/Validator.php

@@ -7,6 +7,7 @@
 use Exception;
 use Carbon\Carbon;
 use InvalidArgumentException;
+use const FILTER_VALIDATE_EMAIL;
 
 class Validator
 {
@@ -33,6 +34,8 @@ public function validate(EmailComposer $composer): void
 
         $this->validateBcc($composer);
 
+        $this->validateReplyTo($composer);
+
         $this->validateSubject($composer);
 
         $this->validateView($composer);
@@ -118,6 +121,25 @@ private function validateBcc(EmailComposer $composer): void
         }
     }
 
+    /**
+     * Validate the reply-to addresses.
+     *
+     * @param EmailComposer $composer
+     * @throws InvalidArgumentException
+     */
+    private function validateReplyTo(EmailComposer $composer): void
+    {
+        if (! $composer->hasData('reply_to')) {
+            return;
+        }
+
+        foreach ((array) $composer->getData('reply_to') as $replyTo) {
+            if (! filter_var($replyTo, FILTER_VALIDATE_EMAIL)) {
+                throw new InvalidargumentException('E-mail address [' . $replyTo . '] is invalid');
+            }
+        }
+    }
+
     /**
      * Validate the e-mail subject.
      *

tests/DatabaseInteractionTest.php

@@ -44,6 +44,20 @@ public function cc_and_bcc_should_be_saved_correctly()
         $this->assertEquals(['[email protected]'], $email->getBcc());
     }
 
+    /** @test */
+    public function reply_to_should_be_saved_correctly()
+    {
+        $email = $this->sendEmail([
+            'reply_to' => $replyTo = [
+                '[email protected]',
+            ],
+        ]);
+
+        $this->assertEquals(json_encode($replyTo), DB::table('emails')->find(1)->reply_to);
+        $this->assertTrue($email->hasReplyTo());
+        $this->assertEquals(['[email protected]'], $email->getReplyTo());
+    }
+
     /** @test */
     public function subject_should_be_saved_correclty()
     {

tests/EncryptionTest.php

@@ -46,6 +46,18 @@ public function cc_and_bb_should_be_encrypted_and_decrypted()
         $this->assertEquals($bcc, $email->getBcc());
     }
 
+    /** @test */
+    public function reply_to_should_be_encrypted_and_decrypted()
+    {
+        $email = $this->sendEmail([
+            'reply_to'  => $replyTo = ['[email protected]', '[email protected]'],
+        ]);
+
+        $this->assertEquals($replyTo, decrypt($email->getRawDatabaseValue('reply_to')));
+
+        $this->assertEquals($replyTo, $email->getReplyTo());
+    }
+
     /** @test */
     public function the_subject_should_be_encrypted_and_decrypted()
     {

tests/MailableReaderTest.php

@@ -54,6 +54,14 @@ public function it_extracts_bcc_addresses()
         $this->assertEquals(['[email protected]', '[email protected]'], $composer->getData('bcc'));
     }
 
+    /** @test */
+    public function it_extracts_reply_to_addresses()
+    {
+        $composer = Email::compose()->mailable($this->mailable());
+
+        $this->assertEquals(['[email protected]', '[email protected]'], $composer->getData('reply_to'));
+    }
+
     /** @test */
     public function it_extracts_the_subject()
     {
@@ -137,6 +145,7 @@ public function build()
         return $this->to('[email protected]')
             ->cc(['[email protected]', '[email protected]'])
             ->bcc(['[email protected]', '[email protected]'])
+            ->replyTo(['[email protected]', '[email protected]'])
             ->subject('Your order has shipped!')
             ->attach(__DIR__ . '/files/pdf-sample.pdf', [
                 'mime' => 'application/pdf',
@@ -168,7 +177,7 @@ public function envelope(): Envelope
             ],
             ['[email protected]', '[email protected]'],
             ['[email protected]', '[email protected]'],
-            [],
+            ['[email protected]', '[email protected]'],
             'Your order has shipped!'
         );
     }