wip

Author: marickvantuil

README.md

@@ -1,22 +1,13 @@
-<p align="center">
-  <img src="/logo.png">
-</p>
 <p align="center">
 <img src="https://github.com/stackkit/laravel-database-emails/workflows/Run%20tests/badge.svg?branch=master" alt="Build Status">
 <a href="https://packagist.org/packages/stackkit/laravel-database-emails"><img src="https://poser.pugx.org/stackkit/laravel-database-emails/v/stable.svg" alt="Latest Stable Version"></a>
 <a href="https://packagist.org/packages/stackkit/laravel-database-emails"><img src="https://poser.pugx.org/stackkit/laravel-database-emails/license.svg" alt="License"></a>
 </p>
 
-# Package Documentation
+# Introduction
 
 This package allows you to store and send e-mails using a database. 
 
-## Contribution
-
-The package is MIT licenced, meaning it's open source and you are free to copy or fork it and modify it any way you wish.
-
-We feel the package is currently feature complete, but feel free to send a pull request or help improve existing code.
-
 # Requirements
 
 This package requires Laravel 10 or 11.
@@ -188,6 +179,17 @@ Email::compose()
 Note: `fromData()` and `fromStorage()` are not supported as the work with raw data.
 </small>
 
+### Attaching models to e-mails
+
+You may attach models to your e-mails.
+
+```php
+
+Email::compose()
+    ->model(User::find(1));
+
+```
+
 ### Scheduling
 
 You may schedule an e-mail by calling `later` instead of `send`. You must provide a Carbon instance or a strtotime valid date.

database/migrations/2024_03_16_151608_change_binary_to_text.php renamed to database/migrations/2024_03_16_151608_create_new_table.php

@@ -4,7 +4,7 @@
 use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\Schema;
 
-class ChangeBinaryToText extends Migration
+class CreateNewTable extends Migration
 {
     /**
      * Run the migrations.
@@ -31,6 +31,7 @@ public function up()
             $table->text('error')->nullable();
             $table->json('attachments')->nullable();
             $table->json('from')->nullable();
+            $table->nullableMorphs('model');
             $table->json('reply_to')->nullable();
             $table->timestamp('queued_at')->nullable();
             $table->timestamp('scheduled_at')->nullable();

logo.png

@@ -9,6 +9,7 @@
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\MassPrunable;
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\MorphTo;
 use Throwable;
 
 /**
@@ -79,11 +80,9 @@ public function markAsSending(): void
 
     public function markAsSent(): void
     {
-        $now = Carbon::now()->toDateTimeString();
-
         $this->update([
             'sending' => 0,
-            'sent_at' => $now,
+            'sent_at' => now(),
             'failed' => 0,
             'error' => '',
         ]);
@@ -116,4 +115,9 @@ public function prunable(): Builder
 
         return $this->where('created_at', '<', now()->subMonths(6));
     }
+
+    public function model(): MorphTo
+    {
+        return $this->morphTo();
+    }
 }

src/Email.php

@@ -6,6 +6,7 @@
 
 use Closure;
 use Illuminate\Contracts\Translation\HasLocalePreference;
+use Illuminate\Database\Eloquent\Model;
 use Illuminate\Foundation\Auth\User;
 use Illuminate\Mail\Mailable;
 use Illuminate\Mail\Mailables\Content;
@@ -102,6 +103,13 @@ public function user(User $user)
         });
     }
 
+    public function model(Model $model)
+    {
+        $this->setData('model', $model);
+
+        return $this;
+    }
+
     /**
      * Get the e-mail that is being composed.
      */
@@ -110,24 +118,13 @@ public function getEmail(): Email
         return $this->email;
     }
 
-    /**
-     * Set a data value.
-     *
-     * @param  mixed  $value
-     */
     public function setData(string $key, $value): self
     {
         $this->data[$key] = $value;
 
         return $this;
     }
 
-    /**
-     * Get a data value.
-     *
-     * @param  mixed  $default
-     * @return mixed
-     */
     public function getData(string $key, $default = null)
     {
         if (! is_null($default) && ! $this->hasData($key)) {
@@ -137,41 +134,25 @@ public function getData(string $key, $default = null)
         return $this->data[$key];
     }
 
-    /**
-     * Determine if the given data value was set.
-     */
     public function hasData(string $key): bool
     {
         return isset($this->data[$key]);
     }
 
-    /**
-     * Set the e-mail label.
-     */
     public function label(string $label): self
     {
         $this->email->label = $label;
 
         return $this;
     }
 
-    /**
-     * Schedule the e-mail.
-     *
-     * @param  mixed  $scheduledAt
-     */
     public function later($scheduledAt): Email
     {
         $this->email->scheduled_at = Carbon::parse($scheduledAt);
 
         return $this->send();
     }
 
-    /**
-     * Queue the e-mail.
-     *
-     * @param  \DateTimeInterface|\DateInterval|int|null  $delay
-     */
     public function queue(?string $connection = null, ?string $queue = null, $delay = null): Email
     {
         $connection = $connection ?: config('queue.default');
@@ -187,9 +168,6 @@ public function queue(?string $connection = null, ?string $queue = null, $delay
         return $this->send();
     }
 
-    /**
-     * Set the Mailable.
-     */
     public function mailable(Mailable $mailable): self
     {
         $this->setData('mailable', $mailable);
@@ -199,33 +177,6 @@ public function mailable(Mailable $mailable): self
         return $this;
     }
 
-    /**
-     * Attach a file to the e-mail.
-     */
-    //    public function attach(string $file, array $options = []): self
-    //    {
-    //        $attachments = $this->hasData('attachments') ? $this->getData('attachments') : [];
-    //
-    //        $attachments[] = compact('file', 'options');
-    //
-    //        return $this->setData('attachments', $attachments);
-    //    }
-    //
-    //    /**
-    //     * Attach in-memory data as an attachment.
-    //     */
-    //    public function attachData(string $data, string $name, array $options = []): self
-    //    {
-    //        $attachments = $this->hasData('rawAttachments') ? $this->getData('rawAttachments') : [];
-    //
-    //        $attachments[] = compact('data', 'name', 'options');
-    //
-    //        return $this->setData('rawAttachments', $attachments);
-    //    }
-
-    /**
-     * Send the e-mail.
-     */
     public function send(): Email
     {
         if ($this->envelope && $this->content) {

src/EmailComposer.php

@@ -65,6 +65,8 @@ public function attachments(): array
         $this->readBody($composer);
 
         $this->readAttachments($composer);
+
+        $this->readModel($composer);
     }
 
     /**
@@ -176,6 +178,13 @@ private function readAttachments(EmailComposer $composer): void
         }, $mailable->attachments);
     }
 
+    public function readModel(EmailComposer $composer): void
+    {
+        if ($composer->hasData('model')) {
+            $composer->getEmail()->model()->associate($composer->getData('model'));
+        }
+    }
+
     private function prepareAddressForDatabaseStorage(array $addresses): array
     {
         return collect($addresses)->mapWithKeys(function ($recipient) {

src/HasEncryptedAttributes.php

@@ -10,9 +10,6 @@
 
 class Sender
 {
-    /**
-     * Send the given e-mail.
-     */
     public function send(Email $email): void
     {
         if ($email->isSent()) {
@@ -25,17 +22,11 @@ public function send(Email $email): void
             $this->buildMessage($message, $email);
         });
 
-        // $sentMessage is null when mocking (Mail::shouldReceive('send')->once())
-        if (! is_null($sentMessage)) {
-            event(new MessageSent($sentMessage));
-        }
+        event(new MessageSent($sentMessage));
 
         $email->markAsSent();
     }
 
-    /**
-     * Build the e-mail message.
-     */
     private function buildMessage(Message $message, Email $email): void
     {
         $message->to($email->recipient)