Merge pull request #57 from stackkit/feature/reply-to

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,26 @@ Email::compose()
     ->bcc(['[email protected]', '[email protected]']);
 ```
 
+### Reply-To
+
+```php
+<?php
+
+use Stackkit\LaravelDatabaseEmails\Email;
+
+Email::compose()
+    ->replyTo(['[email protected]', '[email protected]']);
+
+Email::compose()
+    ->replyTo(new Address('[email protected]', 'John Doe'));
+
+Email::compose()
+    ->replyTo([
+        new Address('[email protected]', 'John Doe'),
+        new Address('[email protected]', 'Jane Doe'),
+    ]);
+```
+
 ### Using mailables
 
 You may also pass a mailable to the e-mail composer.
@@ -232,3 +252,28 @@ To enable, set the following environment variable:
 ```
 LARAVEL_DATABASE_EMAILS_SEND_IMMEDIATELY=true
 ```
+
+### Pruning models
+
+```php
+use Stackkit\LaravelDatabaseEmails\Email;
+
+$schedule->command('model:prune', [
+    '--model' => [Email::class],
+])->everyMinute();
+```
+
+By default, e-mails are pruned when they are older than 6 months.
+
+You may change that by adding the following to the AppServiceProvider.php:
+
+```php
+use Stackkit\LaravelDatabaseEmails\Email;
+
+public function register(): void
+{
+    Email::pruneWhen(function (Email $email) {
+        return $email->where(...);
+    });
+}
+```

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/2023_12_28_140000_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

@@ -4,9 +4,12 @@
 
 namespace Stackkit\LaravelDatabaseEmails;
 
+use Closure;
 use Exception;
 use Carbon\Carbon;
+use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Prunable;
 
 /**
  * @property $id
@@ -15,6 +18,7 @@
  * @property $from
  * @property $cc
  * @property $bcc
+ * @property $reply_to
  * @property $subject
  * @property $view
  * @property $variables
@@ -33,6 +37,7 @@
 class Email extends Model
 {
     use HasEncryptedAttributes;
+    use Prunable;
 
     /**
      * The table in which the e-mails are stored.
@@ -48,6 +53,8 @@ class Email extends Model
      */
     protected $guarded = [];
 
+    public static ?Closure $pruneQuery = null;
+
     /**
      * Compose a new e-mail.
      *
@@ -190,6 +197,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 +415,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.
      *
@@ -520,4 +557,25 @@ public function getRawDatabaseValue(string $key = null, $default = null)
 
         return $this->getOriginal($key, $default);
     }
+
+    /**
+     * @param Closure $closure
+     * @return void
+     */
+    public static function pruneWhen(Closure $closure)
+    {
+        static::$pruneQuery = $closure;
+    }
+
+    /**
+     * @return Builder
+     */
+    public function prunable()
+    {
+        if (static::$pruneQuery) {
+            return (static::$pruneQuery)($this);
+        }
+
+        return $this->where('created_at', '<', now()->subMonths(6));
+    }
 }

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.
      *
@@ -137,7 +153,7 @@ private function readBody(EmailComposer $composer): void
 
         $mailable = $composer->getData('mailable');
 
-        $composer->setData('body', view($mailable->view, $mailable->buildViewData()));
+        $composer->setData('body', view($mailable->view, $mailable->buildViewData())->render());
     }
 
     /**

src/Preparer.php

@@ -5,6 +5,7 @@
 namespace Stackkit\LaravelDatabaseEmails;
 
 use Carbon\Carbon;
+use Illuminate\Mail\Mailables\Address;
 
 class Preparer
 {
@@ -25,6 +26,8 @@ public function prepare(EmailComposer $composer): void
 
         $this->prepareBcc($composer);
 
+        $this->prepareReplyTo($composer);
+
         $this->prepareSubject($composer);
 
         $this->prepareView($composer);
@@ -118,6 +121,33 @@ private function prepareBcc(EmailComposer $composer): void
         ]);
     }
 
+    /**
+     * Prepare the reply-to for database storage.
+     *
+     * @param EmailComposer $composer
+     */
+    private function prepareReplyTo(EmailComposer $composer): void
+    {
+        $value = $composer->getData('reply_to', []);
+
+        if (! is_array($value)) {
+            $value = [$value];
+        }
+
+        foreach ($value as $i => $v) {
+            if ($v instanceof Address) {
+                $value[$i] = [
+                    'address' => $v->address,
+                    'name' => $v->name,
+                ];
+            }
+        }
+
+        $composer->getEmail()->fill([
+            'reply_to' => json_encode($value),
+        ]);
+    }
+
     /**
      * 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());