Merge pull request #2 from Dudelisius/development

Custom sender per e-mail

Author: marickvantuil

database/migrations/2017_12_14_151421_add_attachments_to_emails_table.php

@@ -18,7 +18,7 @@ public function up()
         }
 
         Schema::table('emails', function (Blueprint $table) {
-            $table->binary('attachments')->after('body')->default('');
+            $table->binary('attachments')->nullable()->after('body');
         });
     }
 

database/migrations/2017_12_22_114011_add_from_to_emails_table.php

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

src/Email.php

@@ -10,6 +10,7 @@
  * @property $id
  * @property $label
  * @property $recipient
+ * @property $from
  * @property $cc
  * @property $bcc
  * @property $subject
@@ -84,6 +85,36 @@ public function getRecipient()
         return $this->recipient;
     }
 
+    /**
+     * Get the e-mail from.
+     *
+     * @return array
+     */
+    public function getFrom()
+    {
+        return $this->from;
+    }
+
+    /**
+     * Get the e-mail from address.
+     *
+     * @return string|null
+     */
+    public function getFromAddress()
+    {
+        return $this->from['address'] ?? config('mail.from.address');
+    }
+
+    /**
+     * Get the e-mail from address.
+     *
+     * @return string|null
+     */
+    public function getFromName()
+    {
+        return $this->from['name'] ?? config('mail.from.name');
+    }
+
     /**
      * Get the e-mail recipient(s) as string.
      *
@@ -231,6 +262,16 @@ public function getError()
         return $this->error;
     }
 
+    /**
+     * Determine if the e-mail should be sent with custom from values.
+     *
+     * @return bool
+     */
+    public function hasFrom()
+    {
+        return is_array($this->from) && count($this->from) > 0;
+    }
+
     /**
      * Determine if the e-mail should be sent as a carbon copy.
      *

src/EmailComposer.php

@@ -92,6 +92,18 @@ public function label($label)
         return $this->setData('label', $label);
     }
 
+    /**
+     * Set the e-mail from address and aname.
+     *
+     * @param array $address
+     * @param array $name
+     * @return static
+     */
+    public function from($address = null, $name = null)
+    {
+        return $this->setData('from', compact('address', 'name'));
+    }
+
     /**
      * Set the e-mail recipient(s).
      *

src/Encrypter.php

@@ -15,6 +15,8 @@ public function encrypt(EmailComposer $composer)
 
         $this->encryptRecipients($composer);
 
+        $this->encryptFrom($composer);
+
         $this->encryptSubject($composer);
 
         $this->encryptVariables($composer);
@@ -48,6 +50,20 @@ private function encryptRecipients(EmailComposer $composer)
         ]);
     }
 
+    /**
+     * Encrypt the e-mail addresses for the from field.
+     *
+     * @param EmailComposer $composer
+     */
+    private function encryptFrom(EmailComposer $composer)
+    {
+        $email = $composer->getEmail();
+
+        $email->fill([
+            'from' => encrypt($email->from),
+        ]);
+    }
+
     /**
      * Encrypt the e-mail subject.
      *

src/HasEncryptedAttributes.php

@@ -13,6 +13,7 @@ trait HasEncryptedAttributes
      */
     private $encrypted = [
         'recipient',
+        'from',
         'cc',
         'bcc',
         'subject',
@@ -27,6 +28,7 @@ trait HasEncryptedAttributes
      */
     private $encoded = [
         'recipient',
+        'from',
         'cc',
         'bcc',
         'variables',

src/MailableReader.php

@@ -16,6 +16,8 @@ public function read(EmailComposer $composer)
     {
         $this->readRecipient($composer);
 
+        $this->readFrom($composer);
+
         $this->readCc($composer);
 
         $this->readBcc($composer);
@@ -54,6 +56,21 @@ private function readRecipient(EmailComposer $composer)
         $composer->recipient($to);
     }
 
+    /**
+     * Read the mailable from field to the email composer.
+     *
+     * @param EmailComposer $composer
+     */
+    private function readFrom(EmailComposer $composer)
+    {
+        $from = reset($composer->getData('mailable')->from);
+
+        $composer->from(
+            $from['address'],
+            $from['name']
+        );
+    }
+
     /**
      * Read the mailable cc to the email composer.
      *

src/Preparer.php

@@ -17,6 +17,8 @@ public function prepare(EmailComposer $composer)
 
         $this->prepareRecipient($composer);
 
+        $this->prepareFrom($composer);
+
         $this->prepareCc($composer);
 
         $this->prepareBcc($composer);
@@ -66,6 +68,18 @@ private function prepareRecipient(EmailComposer $composer)
         ]);
     }
 
+    /**
+     * Prepare the from values for database storage.
+     *
+     * @param EmailComposer $composer
+     */
+    private function prepareFrom(EmailComposer $composer)
+    {
+        $composer->getEmail()->fill([
+            'from' => json_encode($composer->getData('from', '')),
+        ]);
+    }
+
     /**
      * Prepare the carbon copies for database storage.
      *

src/Sender.php

@@ -49,7 +49,7 @@ private function buildMessage(Message $message, Email $email)
             ->cc($email->hasCc() ? $email->getCc() : [])
             ->bcc($email->hasBcc() ? $email->getBcc() : [])
             ->subject($email->getSubject())
-            ->from(config('mail.from.address'), config('mail.from.name'))
+            ->from($email->getFromAddress(), $email->getFromName())
             ->setBody($email->getBody(), 'text/html');
 
         $attachmentMap = [

tests/DatabaseInteractionTest.php

@@ -101,6 +101,22 @@ function the_body_should_be_saved_correctly()
         $this->assertSame($expectedBody, $email->getBody());
     }
 
+    /** @test */
+    function from_should_be_saved_correctly()
+    {
+        $email = $this->composeEmail()->send();
+
+        $this->assertFalse($email->hasFrom());
+        $this->assertEquals(config('mail.from.address'), $email->getFromAddress());
+        $this->assertEquals(config('mail.from.name'), $email->getFromName());
+
+        $email = $this->composeEmail()->from('[email protected]', 'Marick')->send();
+
+        $this->assertTrue($email->hasFrom());
+        $this->assertEquals('[email protected]', $email->getFromAddress());
+        $this->assertEquals('Marick', $email->getFromName());
+    }
+
     /** @test */
     function variables_should_be_saved_correctly()
     {