initial commit

Author: Lidbetter

.gitignore

@@ -0,0 +1,2 @@
+*.DS_store
+.idea/*

README.md

@@ -0,0 +1,45 @@
+### Install
+
+Require this package with composer using the following command:
+```bash
+composer require clarification/sparkpost-laravel-driver
+```
+
+After updating composer, add the service provider to the `providers` array in `config/app.php`
+```php
+Clarification\MailDrivers\Sparkpost\SparkpostServiceProvider::class,
+```
+
+You will also need to add the sparkpost API Key settings to the array in `config/services.php` and set up the environment key
+```php
+'sparkpost' => [
+    'secret' => env('SPARKPOST_SECRET'),
+],
+```
+```bash
+SPARKPOST_SECRET=__Your_key_here__
+```
+
+Finally you need to set your mail driver to `sparkpost`. You can do this by changing the driver in `config/mail.php`
+```php
+'driver' => env('MAIL_DRIVER', 'sparkpost'),
+```
+
+Or by setting the environment variable `MAIL_DRIVER` in your .env file
+```bash
+MAIL_DRIVER=sparkpost
+```
+
+If you need to pass any options to the guzzle client instance which is making the request to the Send Grid API, you can do so by setting the 'guzzle' options in `config/services.php`
+```php
+'sparkpost' => [
+    'secret' => env('SPARKPOST_SECRET'),
+    'guzzle' => [
+        'verify' => true,
+        'decode_content' => true,
+    ]
+],
+```
+
+**This is only needed if you are using Laravel 5.1.* or older, the sparkpost driver is included in 5.2**
+If the Laravel Sparkpost driver is present (you are running >=5.2), The service provider will not load this packages Sparkpost driver.

composer.json

@@ -0,0 +1,23 @@
+{
+  "name": "clarification/sparkpost-laravel-driver",
+  "type": "library",
+  "description" : "Sparkpost mail driver for Laravel",
+  "keywords": ["laravel", "mail", "driver", "sparkpost"],
+  "license": "MIT",
+  "homepage" : "http://clarification.io",
+  "authors": [
+    {
+      "name" : "Robin Lidbetter",
+      "role" : "Developer"
+    }
+  ],
+  "require": {
+    "illuminate/container": ">=4.2",
+    "swiftmailer/swiftmailer": "~5.1"
+  },
+  "autoload": {
+    "psr-4": {
+      "Clarification\\MailDrivers\\Sparkpost\\": "src"
+    }
+  }
+}

src/SparkpostServiceProvider.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace Clarification\MailDrivers\Sparkpost;
+
+use GuzzleHttp\Client;
+use Illuminate\Support\Arr;
+use Illuminate\Mail\TransportManager;
+use Illuminate\Support\ServiceProvider;
+use Clarification\MailDrivers\Sparkpost\Transport\SparkpostTransport;
+use Illuminate\Mail\Transport\SparkPostTransport as LaravelSparkPostTransport;
+
+class SparkpostServiceProvider extends ServiceProvider
+{
+    /**
+     * After register is called on all service providers, then boot is called
+     */
+    public function boot()
+    {
+        //
+    }
+
+    /**
+     * Register is called on all service providers first.
+     *
+     * We must register the extension before anything tries to use the mailing functionality.
+     * None of the closures are executed until someone tries to send an email.
+     *
+     * This will register a closure which will be run when 'swift.transport' (the transport manager) is first resolved.
+     * Then we extend the transport manager, by adding the spark post transport object as the 'sparkpost' driver.
+     */
+    public function register()
+    {
+        // Don't need to register our driver if the current laravel install already has the spark post transport
+        if(class_exists(LaravelSparkPostTransport::class, false)) {
+            return;
+        }
+
+        $this->app->extend('swift.transport', function(TransportManager $manager) {
+            $manager->extend('sparkpost', function() {
+                $config = $this->app['config']->get('services.sparkpost', []);
+                $client = new Client(Arr::get($config, 'guzzle', []));
+                return new SparkpostTransport($client, $config['secret']);
+            });
+            return $manager;
+        });
+    }
+}

src/Transport/SparkpostTransport.php

@@ -0,0 +1,120 @@
+<?php
+
+namespace Clarification\MailDrivers\Sparkpost\Transport;
+
+use Swift_Mime_Message;
+use GuzzleHttp\ClientInterface;
+use Illuminate\Mail\Transport\Transport;
+
+class SparkpostTransport extends Transport
+{
+    /**
+     * Guzzle client instance.
+     *
+     * @var \GuzzleHttp\ClientInterface
+     */
+    protected $client;
+
+    /**
+     * The SparkPost API key.
+     *
+     * @var string
+     */
+    protected $key;
+
+    /**
+     * Create a new SparkPost transport instance.
+     *
+     * @param  \GuzzleHttp\ClientInterface  $client
+     * @param  string  $key
+     */
+    public function __construct(ClientInterface $client, $key)
+    {
+        $this->client = $client;
+        $this->key = $key;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function send(Swift_Mime_Message $message, &$failedRecipients = null)
+    {
+        $this->beforeSendPerformed($message);
+        $recipients = $this->getRecipients($message);
+        $message->setBcc([]);
+        $options = [
+            'headers' => [
+                'Authorization' => $this->key,
+            ],
+            'json' => [
+                'recipients' => $recipients,
+                'content' => [
+                    'html' => $message->getBody(),
+                    'from' => $this->getFrom($message),
+                    'subject' => $message->getSubject(),
+                ],
+            ],
+        ];
+        return $this->client->post('https://api.sparkpost.com/api/v1/transmissions', $options);
+    }
+
+    /**
+     * Get all the addresses this message should be sent to.
+     *
+     * Note that SparkPost still respects CC, BCC headers in raw message itself.
+     *
+     * @param  \Swift_Mime_Message $message
+     * @return array
+     */
+    protected function getRecipients(Swift_Mime_Message $message)
+    {
+        $to = $bcc = [];
+        if ($message->getTo()) {
+            $to = array_merge($to, array_keys($message->getTo()));
+        }
+        if ($message->getCc()) {
+            $to = array_merge($to, array_keys($message->getCc()));
+        }
+        if ($message->getBcc()) {
+            $to = array_merge($bcc, array_keys($message->getBcc()));
+        }
+        $recipients = array_map(function ($address) {
+            return ['address' => ['email' => $address, 'header_to' => $address]];
+        }, $to);
+        return $recipients;
+    }
+
+    /**
+     * Get the "from" contacts in the format required by SparkPost.
+     *
+     * @param  Swift_Mime_Message  $message
+     * @return array
+     */
+    protected function getFrom(Swift_Mime_Message $message)
+    {
+        return array_map(function ($email, $name) {
+            return compact('name', 'email');
+        }, array_keys($message->getFrom()), $message->getFrom())[0];
+    }
+
+    /**
+     * Get the API key being used by the transport.
+     *
+     * @return string
+     */
+    public function getKey()
+    {
+        return $this->key;
+    }
+
+    /**
+     * Set the API key being used by the transport.
+     *
+     * @param  string  $key
+     * @return string
+     */
+    public function setKey($key)
+    {
+        return $this->key = $key;
+    }
+}