Initial commit

Author: seinoxygen

.gitignore

@@ -0,0 +1,8 @@
+/vendor
+/.idea
+vendor/
+composer.phar
+composer.lock
+.DS_Store
+.vscode
+.env

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,145 @@
+# Laravel Elastic Email #
+
+[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/donate/?hosted_button_id=6CYVR8U4VDMAA)
+
+A Laravel wrapper for sending emails via Elastic Email service and API capabilities that allows you to check the status of every email sent.
+It provides a basic email log table to store all outbound emails where you can link to a model.
+
+## Installation
+
+Add Laravel Elastic Email as a dependency using the composer CLI:
+
+```bash
+composer require seinoxygen/laravel-elastic-email
+```
+
+## Mail Service Usage
+
+This package works exactly like Laravel's native mailers. Refer to Laravel's Mail documentation.
+
+Add the following to your config/services.php and add the correct values to your .env file
+
+```php
+'elastic_email' => [
+	'key' => env('ELASTIC_KEY'),
+	'account' => env('ELASTIC_ACCOUNT')
+]
+```
+
+Add the following to your config/mail.php
+
+```php
+'elastic_email' => [
+	'transport' => 'elasticemail'
+]
+```
+
+Next, in config/app.php, comment out Laravel's default MailServiceProvider. If using < Laravel 5.5, add the MailServiceProvider and ApiServiceProvider to the providers array
+
+```php
+'providers' => [
+    ...
+    SeinOxygen\ElasticEmail\MailServiceProvider::class,
+    SeinOxygen\ElasticEmail\ApiServiceProvider::class,
+    ...
+],
+```
+
+Next, in config/app.php, add the ElasticEmail to the aliases array
+
+```php
+'aliases' => [
+    ...
+    'ElasticEmail' => SeinOxygen\ElasticEmail\Facades\ElasticEmail::class,
+    ...
+],
+```
+
+Finally switch your default mail provider to elastic email in your .env file by setting **MAIL_DRIVER=elastic_email**
+
+## Outbound Email Tracking
+
+To keep track of all emails sent by the driver you'll need to publish the migrations and the configuration files:
+
+```bash
+php artisan vendor:publish --provider="SeinOxygen\ElasticEmail\ApiServiceProvider" --tag="migrations"
+```
+
+```bash
+php artisan migrate
+```
+
+```bash
+php artisan vendor:publish --provider="SeinOxygen\ElasticEmail\ApiServiceProvider" --tag="config"
+```
+
+By default all outgoing emails will be stored with the Elastic Email **message_id** and **transaction_id**.
+
+Check **config/elasticemail.php** for more options.
+
+### Linking Outgoing Emails To Your Models ###
+
+In your mailable be sure to set the with array the following way.
+
+```php
+public function build()
+{
+    // You can set ad many models you want to relate with the outgoing email
+    $models = [
+        [$yourmodel->id, get_class($yourmodel)],
+    ];
+
+    return $this
+        ->subject("My Subject")
+        ->view('my-view')
+        ->with([
+            'models' => $models
+        ]);
+}
+```
+
+Sorry if it looks ugly. I haven't found a better way to do this...yet.
+
+### Capturing Webhook Events ###
+
+You will need to set a webhook in Elastic Email service pointing to **yourappurl.com/webhook/elasticemail**
+
+There is an event being fired when data is sent to the webhook url.
+
+```php
+<?php
+
+namespace app\Listeners;
+
+use SeinOxygen\ElasticEmail\Events\WebhookCallReceived;
+
+class WebhookCallListerner
+{
+    public function handle(WebhookCallReceived $event)
+    {
+        $request = $event->request;
+    }
+}
+```
+
+## Api Usage
+
+For documentation visit https://api.elasticemail.com/public/help
+
+```php
+
+    //For contact
+    ElasticEmail::Contact()
+
+    //For emails
+    ElasticEmail::Email()
+
+```
+
+## Credits
+
+This package is based on [ZanySoft](https://github.com/zanysoft/laravel-elastic-email)
+
+## License
+
+The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

composer.json

@@ -0,0 +1,41 @@
+{
+  "name": "seinoxygen/laravel-elastic-email",
+  "description": "A Laravel wrapper for Elastic Email",
+  "keywords": [
+    "laravel",
+    "email",
+    "elastic email"
+  ],
+  "license": "MIT",
+  "authors": [
+    {
+      "company": "",
+      "email": "seinoxygen@hotmail.com",
+      "url": ""
+    }
+  ],
+  "support": {
+    "email": "seinoxygen@hotmail.com"
+  },
+  "require": {
+    "php": "^7.1|^8.0",
+    "laravel/framework": "^6.0|^7.0|^8.0|^9.0",
+    "guzzlehttp/guzzle": "^6.3|^7.0"
+  },
+  "autoload": {
+    "psr-4": {
+      "SeinOxygen\\ElasticEmail\\": "src/"
+    }
+  },
+  "extra": {
+    "laravel": {
+      "providers": [
+        "SeinOxygen\\ElasticEmail\\MailServiceProvider"
+      ],
+      "aliases": {
+        "ElasticEmail": "SeinOxygen\\ElasticEmail\\Facades\\ElasticEmail"
+      }
+    }
+  },
+  "minimum-stability": "stable"
+}

config/elasticemail.php

@@ -0,0 +1,55 @@
+<?php
+
+return [
+    /*
+    |--------------------------------------------------------------------------
+    | Elastic Email API Key
+    |--------------------------------------------------------------------------
+    |
+    | This value is the API key provided by Elastic Email.
+    |
+    */
+    'key' => env('ELASTIC_KEY'),
+
+    /*
+    |--------------------------------------------------------------------------
+    | Elastic Email Account Email
+    |--------------------------------------------------------------------------
+    |
+    | This value is the account email provided by Elastic Email.
+    |
+    */
+    'account' => env('ELASTIC_ACCOUNT'),
+
+    /*
+    |--------------------------------------------------------------------------
+    | Elastic Email Webhook Secret
+    |--------------------------------------------------------------------------
+    |
+    | This value is the webhook secret provided by Elastic Email.
+    |
+    */
+    'webhook_secret' => env('ELASTIC_WEBHOOK_SECRET'),
+
+     /*
+    |--------------------------------------------------------------------------
+    | Save Webhook Hits
+    |--------------------------------------------------------------------------
+    |
+    | Keep track of all webhooks received from Elastic Email in the elatic_email_hits table. 
+    |
+    */
+    'save_hits' => false,
+
+    /*
+    |--------------------------------------------------------------------------
+    | Save Webhook Hits For 30 Days
+    |--------------------------------------------------------------------------
+    |
+    | This will delete all records older than 30 days.
+    | Use null to disable this funtionality.
+    |
+    */
+    'delete_after_days' => null,
+
+];

database/migrations/create_elastic_email_hits_table.php.stub

@@ -0,0 +1,61 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+class CreateElasticEmailHitsTable extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::create('elastic_email_hits', function (Blueprint $table) {
+            $table->id();
+            $table->uuid('transaction_id')->index();
+            $table->string('message_id')->index();
+            $table->string('status');
+            $table->json('data');
+            $table->timestamps();
+        });
+
+        Schema::create('elastic_email_outbound', function (Blueprint $table) {
+            $table->id();
+            $table->string('message_id')->unique();
+            $table->uuid('transaction_id')->unique();
+            $table->string('from');
+            $table->string('to');
+            $table->string('cc')->nullable();
+            $table->string('subject');
+            $table->longText('body');
+            $table->string('attachments')->nullable();
+            $table->integer('created_by')->nullable();
+            $table->timestamp('delivered_at')->nullable();
+            $table->timestamp('opened_at')->nullable();
+            $table->timestamps();
+        });
+
+        Schema::create('model_has_elastic_email_outbound', function (Blueprint $table) {
+            $table->id();
+            $table->integer('elastic_email_outbound_id')->index();
+            $table->integer('model_id')->index();
+            $table->string('model_type')->index();
+            $table->timestamps();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::dropIfExists('elastic_email_hits');
+        Schema::dropIfExists('elastic_email_outbound');
+        Schema::dropIfExists('model_has_elastic_email_outbound');
+    }
+}

routes/web.php

@@ -0,0 +1,5 @@
+<?php
+use Illuminate\Support\Facades\Route;
+use SeinOxygen\ElasticEmail\Http\Controllers\WebhookController;
+
+Route::get('/webhook/elasticemail', [WebhookController::class, 'store']);