Merge pull request #1 from stackkit/development

2.0.0

Author: marickvantuil

.travis.yml

@@ -1,12 +1,11 @@
 language: php
 
 php:
-  - 5.6
   - 7.0
   - 7.1
 
 sudo: false
 
 install: travis_retry composer install --no-interaction --prefer-source
 
-script: vendor/bin/phpunit --verbose
+script: vendor/bin/phpunit --verbose

README.md

@@ -9,7 +9,7 @@
 
 ## Introduction
 
-This is a package that stores and queues e-mails using a database table. Easily send e-mails using a cronjob or schedule e-mails that should be sent at a specific date and time.
+This is a package that stores and queues e-mails using a database table. Easily send e-mails using a cronjob and schedule e-mails that should be sent at a specific date and time.
 ## Installation
 
 First, require the package using composer.
@@ -24,16 +24,15 @@ If you're running Laravel 5.5 or later you may skip this step. Add the service p
 Buildcode\LaravelDatabaseEmails\LaravelDatabaseEmailsServiceProvider::class,
 ```
 
-Publish the configuration file.
+Publish the configuration files.
 
 ```bash
 $ php artisan vendor:publish --provider=Buildcode\\LaravelDatabaseEmails\\LaravelDatabaseEmailsServiceProvider
 ```
 
-Create the e-mails database table migration.
+Create the database table required for this package.
 
 ```bash
-$ php artisan email:table
 $ php artisan migrate
 ```
 
@@ -57,7 +56,7 @@ protected function schedule(Schedule $schedule)
 ### Create An Email
 
 ```php
-Buildcode\LaravelDatabaseEmails\Email::compose()
+Email::compose()
     ->label('welcome-mail-1.0')
     ->recipient('[email protected]')
     ->subject('This is a test')
@@ -68,20 +67,53 @@ Buildcode\LaravelDatabaseEmails\Email::compose()
     ->send();
 ```
 
+### Specify Recipients
+
+```php
+$one = '[email protected]';
+$multiple = ['[email protected]', '[email protected]'];
+
+Email::compose()->recipient($one);
+Email::compose()->recipient($multiple);
+
+Email::compose()->cc($one);
+Email::compose()->cc($multiple);
+
+Email::compose()->bcc($one);
+Email::compose()->bcc($multiple);
+```
+
+### Mailables
+
+You may also pass a mailable to the e-mail composer.
+
+```php
+Email::compose()
+	->mailable(new OrderShipped())
+	->send();
+```
+
+### Attachments
+
+```php
+Email::compose()
+	->attach('/path/to/file');
+```
+
+Or for in-memory attachments...
+
+```php
+Email::compose()
+	->attachData('<p>Your order has shipped!</p>', 'order.html');
+```
+
 ### Schedule An Email
 
-You may schedule an e-mail by calling `schedule` instead of `send` at the end of the chain. You must provide a Carbon instance or a strtotime valid date.
+You may schedule an e-mail by calling `later` instead of `send` at the end of the chain. You must provide a Carbon instance or a strtotime valid date.
 
 ```php
-Buildcode\LaravelDatabaseEmails\Email::compose()
-  ->label('welcome-mail-1.0')
-  ->recipient('[email protected]')
-  ->subject('This is a test')
-  ->view('emails.welcome')
-  ->variables([
-      'name' => 'John Doe',
-  ])
-  ->schedule('+2 hours');
+Email::compose()
+  ->later('+2 hours');
 ```
 
 ### Manually Sending E-mails
@@ -112,11 +144,6 @@ If you wish to encrypt your e-mails, please enable the `encrypt` option in the c
 
 ### Testing Address
 
-If you wish to send e-mails to a test address but don't necessarily want to use a service like mailtrap, please take a look at the `testing` configuration. This is turned on by default.
+If you wish to send e-mails to a test address but don't necessarily want to use a service like mailtrap, please take a look at the `testing` configuration. This is turned off by default.
 
 During the creation of an e-mail, the recipient will be replaced by the test e-mail. This is useful for local development or testing on a staging server.
-
-## Todo
-
-- Add support for attachments
-- Add support for Mailables

composer.json

@@ -8,11 +8,6 @@
             "email": "[email protected]"
         }
     ],
-    "require": {
-        "illuminate/database": "^5.2",
-        "illuminate/console": "^5.2",
-        "illuminate/validation": "^5.2"
-    },
     "autoload": {
         "psr-4": {
             "Buildcode\\LaravelDatabaseEmails\\": "src/"
@@ -31,8 +26,13 @@
         }
     },
     "require-dev": {
-        "orchestra/testbench": "~3.4",
-        "phpunit/phpunit": "^5.7",
-        "orchestra/database": "~3.4"
+        "illuminate/database": "^5.5",
+        "illuminate/console": "^5.5",
+        "illuminate/validation": "^5.5",
+        "orchestra/testbench": "^3.5",
+        "orchestra/database": "^3.5",
+        "phpunit/phpunit": "^6.0",
+        "mockery/mockery": "^1.0",
+        "dompdf/dompdf": "^0.8.2"
     }
 }

config/laravel-database-emails.php

@@ -48,7 +48,9 @@
         'email' => '[email protected]',
 
         'enabled' => function () {
-            return app()->environment('local', 'staging');
+            return false;
+            // ...or...
+            // return app()->environment('local', 'staging');
         }
 
     ],

database/migrations/emails.stub renamed to database/migrations/2017_12_14_151403_create_emails_table.php

@@ -4,7 +4,7 @@
 use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Database\Migrations\Migration;
 
-class Create{{tableClassName}}Table extends Migration
+class CreateEmailsTable extends Migration
 {
     /**
      * Run the migrations.
@@ -13,7 +13,11 @@ class Create{{tableClassName}}Table extends Migration
      */
     public function up()
     {
-        Schema::create('{{table}}', function (Blueprint $table) {
+        if (Schema::hasTable('emails')) {
+            return;
+        }
+
+        Schema::create('emails', function (Blueprint $table) {
             $table->increments('id');
             $table->string('label')->nullable();
             $table->binary('recipient');
@@ -43,6 +47,6 @@ public function up()
      */
     public function down()
     {
-        Schema::dropIfExists('{{table}}');
+        //
     }
 }

database/migrations/2017_12_14_151421_add_attachments_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 AddAttachmentsToEmailsTable extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        if (Schema::hasColumn('emails', 'attachments')) {
+            return;
+        }
+
+        Schema::table('emails', function (Blueprint $table) {
+            $table->binary('attachments')->after('body')->default('');
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        //
+    }
+}

src/Config.php

@@ -9,7 +9,7 @@ class Config
      *
      * @return int
      */
-    public static function maxRetryCount()
+    public static function maxAttemptCount()
     {
         return max(config('laravel-database-emails.retry.attempts', 1), 3);
     }
@@ -59,4 +59,4 @@ public static function cronjobEmailLimit()
     {
         return config('laravel-database-emails.limit', 20);
     }
-}
+}