├── .gitignore
├── README.md
├── composer.json
└── src
    ├── SparkpostServiceProvider.php
    └── Transport
        ├── SparkPostTransport.php
        ├── SparkPostTransportFiveFive.php
        ├── SparkPostTransportFiveZero.php
        └── SparkPostTransportTrait.php


/.gitignore:
--------------------------------------------------------------------------------
1 | *.DS_store
2 | .idea/*


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | ### No Longer Maintained
2 | 
3 | Please use:
4 | https://github.com/vemcogroup/laravel-sparkpost-driver
5 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "clarification/sparkpost-laravel-driver",
 3 |     "type": "library",
 4 |     "description" : "Sparkpost mail driver for Laravel",
 5 |     "keywords": ["laravel", "mail", "driver", "sparkpost"],
 6 |     "license": "MIT",
 7 |     "homepage" : "http://clarification.io",
 8 |     "authors": [
 9 |         {
10 |             "name" : "Robin Lidbetter",
11 |             "role" : "Developer"
12 |         }
13 |     ],
14 |     "abandoned": "vemcogroup/laravel-sparkpost-driver",
15 |     "require": {
16 |         "guzzlehttp/guzzle": ">=5.0",
17 |         "illuminate/container": ">=5.0",
18 |         "swiftmailer/swiftmailer": "~5.1||~6.0"
19 |     },
20 |     "extra": {
21 |         "laravel": {
22 |             "providers": [
23 |                 "Clarification\\MailDrivers\\Sparkpost\\SparkpostServiceProvider"
24 |             ]
25 |         }
26 |     },
27 |     "autoload": {
28 |         "psr-4": {
29 |             "Clarification\\MailDrivers\\Sparkpost\\": "src"
30 |         }
31 |     }
32 | }
33 | 


--------------------------------------------------------------------------------
/src/SparkpostServiceProvider.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Clarification\MailDrivers\Sparkpost;
 4 | 
 5 | use GuzzleHttp\Client;
 6 | use Swift_Mime_Message;
 7 | use Illuminate\Mail\TransportManager;
 8 | use Illuminate\Support\ServiceProvider;
 9 | use Illuminate\Mail\Transport\Transport as AbstractTransport;
10 | use Clarification\MailDrivers\Sparkpost\Transport\SparkPostTransport;
11 | use Clarification\MailDrivers\Sparkpost\Transport\SparkPostTransportFiveZero;
12 | use Clarification\MailDrivers\Sparkpost\Transport\SparkPostTransportFiveFive;
13 | use Illuminate\Mail\Transport\SparkPostTransport as LaravelSparkPostTransport;
14 | 
15 | class SparkpostServiceProvider extends ServiceProvider
16 | {
17 |     /**
18 |      * After register is called on all service providers, then boot is called
19 |      */
20 |     public function boot()
21 |     {
22 |         //
23 |     }
24 | 
25 |     /**
26 |      * Register is called on all service providers first.
27 |      *
28 |      * We must register the extension before anything tries to use the mailing functionality.
29 |      * None of the closures are executed until someone tries to send an email.
30 |      *
31 |      * This will register a closure which will be run when 'swift.transport' (the transport manager) is first resolved.
32 |      * Then we extend the transport manager, by adding the spark post transport object as the 'sparkpost' driver.
33 |      */
34 |     public function register()
35 |     {
36 |         // Don't need to register our driver if the current laravel install already has the spark post transport
37 |         if(class_exists(LaravelSparkPostTransport::class)) {
38 |             return;
39 |         }
40 | 
41 |         $this->app->extend('swift.transport', function(TransportManager $manager) {
42 | 
43 |             $manager->extend('sparkpost', function() {
44 | 
45 |                 $config = $this->app['config']->get('services.sparkpost', []);
46 |                 $sparkpostOptions = isset($config['options']) ? $config['options'] : [];
47 |                 $guzzleOptions = isset($config['guzzle']) ? $config['guzzle'] : [];
48 |                 $client = new Client($guzzleOptions);
49 | 
50 |                 if(class_exists(AbstractTransport::class)) {
51 |                     // version 6 of swiftmailer removed this class in favor of Swift_Mime_SimpleMessage
52 |                     // https://github.com/swiftmailer/swiftmailer/blob/5a90a13527e955f2d6e8fcc8876d087a89d37da3/CHANGES#L64-L78
53 |                     // larvel version 5.5 requires version 6 of swiftmailer and has updated method signatures
54 |                     if(!interface_exists(Swift_Mime_Message::class)) {
55 |                         return new SparkPostTransportFiveFive($client, $config['secret'], $sparkpostOptions);
56 |                     }
57 | 
58 |                     return new SparkPostTransport($client, $config['secret'], $sparkpostOptions);
59 |                 }
60 | 
61 |                 // Fallback to implementation which only depends on Swift_Transport
62 |                 return new SparkPostTransportFiveZero($client, $config['secret'], $sparkpostOptions);
63 |             });
64 | 
65 |             return $manager;
66 |         });
67 |     }
68 | }
69 | 


--------------------------------------------------------------------------------
/src/Transport/SparkPostTransport.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Clarification\MailDrivers\Sparkpost\Transport;
 4 | 
 5 | use Illuminate\Mail\Transport\Transport;
 6 | 
 7 | 
 8 | /**
 9 |  * This is almost a direct copy past of the driver included in Laravel 5.2.23+
10 |  * https://github.com/laravel/framework/blob/5.2/src/Illuminate/Mail/Transport/SparkPostTransport.php
11 |  *
12 |  * You should only need this package if you are using laravel 5.0.0 to 5.2.22
13 |  */
14 | class SparkPostTransport extends Transport
15 | {
16 |     use SparkPostTransportTrait;
17 | }
18 | 


--------------------------------------------------------------------------------
/src/Transport/SparkPostTransportFiveFive.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Clarification\MailDrivers\Sparkpost\Transport;
 4 | 
 5 | use Illuminate\Mail\Transport\Transport;
 6 | use Swift_Mime_SimpleMessage;
 7 | 
 8 | class SparkPostTransportFiveFive extends Transport
 9 | {
10 |     use SparkPostTransportTrait;
11 | 
12 |     public function send(Swift_Mime_SimpleMessage $message, &$failedRecipients = null)
13 |     {
14 |         $this->beforeSendPerformed($message);
15 | 
16 |         $recipients = $this->getRecipients($message);
17 | 
18 |         $message->setBcc([]);
19 | 
20 |         $options = [
21 |             'headers' => [
22 |                 'Authorization' => $this->key,
23 |             ],
24 |             'json' => [
25 |                 'recipients' => $recipients,
26 |                 'content' => [
27 |                     'email_rfc822' => $message->toString(),
28 |                 ],
29 |             ],
30 |         ];
31 | 
32 |         if ($this->options) {
33 |             $options['json']['options'] = $this->options;
34 |         }
35 | 
36 |         return $this->client->post($this->getEndpoint(), $options);
37 |     }
38 | 
39 |     /**
40 |      * Get all the addresses this message should be sent to.
41 |      *
42 |      * Note that SparkPost still respects CC, BCC headers in raw message itself.
43 |      *
44 |      * @param  Swift_Mime_SimpleMessage $message
45 |      * @return array
46 |      */
47 |     protected function getRecipients(Swift_Mime_SimpleMessage $message)
48 |     {
49 |         $to = [];
50 |         if ($getTo = $message->getTo()) {
51 |             $to = array_merge($to, array_keys($getTo));
52 |         }
53 | 
54 |         if ($getCc = $message->getCc()) {
55 |             $to = array_merge($to, array_keys($getCc));
56 |         }
57 | 
58 |         if ($getBcc = $message->getBcc()) {
59 |             $to = array_merge($to, array_keys($getBcc));
60 |         }
61 | 
62 |         $recipients = array_map(function ($address) {
63 |             return compact('address');
64 |         }, $to);
65 | 
66 |         return $recipients;
67 |     }
68 | }
69 | 


--------------------------------------------------------------------------------
/src/Transport/SparkPostTransportFiveZero.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Clarification\MailDrivers\Sparkpost\Transport;
 4 | 
 5 | use Swift_Transport;
 6 | use Swift_Mime_Message;
 7 | use Swift_Events_SendEvent;
 8 | use Swift_Events_EventListener;
 9 | 
10 | class SparkPostTransportFiveZero implements Swift_Transport
11 | {
12 |     use SparkPostTransportTrait;
13 | 
14 |     /**
15 |      * The plug-ins registered with the transport.
16 |      *
17 |      * @var array
18 |      */
19 |     public $plugins = [];
20 | 
21 |     /**
22 |      * {@inheritdoc}
23 |      */
24 |     public function isStarted()
25 |     {
26 |         return true;
27 |     }
28 |     /**
29 |      * {@inheritdoc}
30 |      */
31 |     public function start()
32 |     {
33 |         return true;
34 |     }
35 |     /**
36 |      * {@inheritdoc}
37 |      */
38 |     public function stop()
39 |     {
40 |         return true;
41 |     }
42 |     /**
43 |      * Register a plug-in with the transport.
44 |      *
45 |      * @param  \Swift_Events_EventListener  $plugin
46 |      * @return void
47 |      */
48 |     public function registerPlugin(Swift_Events_EventListener $plugin)
49 |     {
50 |         array_push($this->plugins, $plugin);
51 |     }
52 |     /**
53 |      * Iterate through registered plugins and execute plugins' methods.
54 |      *
55 |      * @param  \Swift_Mime_Message  $message
56 |      * @return void
57 |      */
58 |     protected function beforeSendPerformed(Swift_Mime_Message $message)
59 |     {
60 |         $event = new Swift_Events_SendEvent($this, $message);
61 |         foreach ($this->plugins as $plugin) {
62 |             if (method_exists($plugin, 'beforeSendPerformed')) {
63 |                 $plugin->beforeSendPerformed($event);
64 |             }
65 |         }
66 |     }
67 | }
68 | 


--------------------------------------------------------------------------------
/src/Transport/SparkPostTransportTrait.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace Clarification\MailDrivers\Sparkpost\Transport;
  4 | 
  5 | use Swift_Mime_Message;
  6 | use GuzzleHttp\ClientInterface;
  7 | 
  8 | trait SparkPostTransportTrait
  9 | {
 10 |     /**
 11 |      * Guzzle client instance.
 12 |      *
 13 |      * @var ClientInterface
 14 |      */
 15 |     protected $client;
 16 | 
 17 |     /**
 18 |      * The SparkPost API key.
 19 |      *
 20 |      * @var string
 21 |      */
 22 |     protected $key;
 23 | 
 24 |     /**
 25 |      * Create a new SparkPost transport instance.
 26 |      *
 27 |      * @param  ClientInterface $client
 28 |      * @param  string $key
 29 |      * @param  array $options
 30 |      */
 31 |     public function __construct(ClientInterface $client, $key, $options = [])
 32 |     {
 33 |         $this->client = $client;
 34 |         $this->key = $key;
 35 |         $this->options = $options;
 36 |     }
 37 | 
 38 |     /**
 39 |      * {@inheritdoc}
 40 |      */
 41 |     public function send(Swift_Mime_Message $message, &$failedRecipients = null)
 42 |     {
 43 |         $this->beforeSendPerformed($message);
 44 | 
 45 |         $recipients = $this->getRecipients($message);
 46 | 
 47 |         $message->setBcc([]);
 48 | 
 49 |         $options = [
 50 |             'headers' => [
 51 |                 'Authorization' => $this->key,
 52 |             ],
 53 |             'json' => [
 54 |                 'recipients' => $recipients,
 55 |                 'content' => [
 56 |                     'email_rfc822' => $message->toString(),
 57 |                 ],
 58 |             ],
 59 |         ];
 60 | 
 61 |         if ($this->options) {
 62 |             $options['json']['options'] = $this->options;
 63 |         }
 64 | 
 65 |         return $this->client->post($this->getEndpoint(), $options);
 66 |     }
 67 | 
 68 |     /**
 69 |      * Get all the addresses this message should be sent to.
 70 |      *
 71 |      * Note that SparkPost still respects CC, BCC headers in raw message itself.
 72 |      *
 73 |      * @param  Swift_Mime_Message $message
 74 |      * @return array
 75 |      */
 76 |     protected function getRecipients(Swift_Mime_Message $message)
 77 |     {
 78 |         $to = [];
 79 |         if ($getTo = $message->getTo()) {
 80 |             $to = array_merge($to, array_keys($getTo));
 81 |         }
 82 | 
 83 |         if ($getCc = $message->getCc()) {
 84 |             $to = array_merge($to, array_keys($getCc));
 85 |         }
 86 | 
 87 |         if ($getBcc = $message->getBcc()) {
 88 |             $to = array_merge($to, array_keys($getBcc));
 89 |         }
 90 | 
 91 |         $recipients = array_map(function ($address) {
 92 |             return compact('address');
 93 |         }, $to);
 94 | 
 95 |         return $recipients;
 96 |     }
 97 | 
 98 |     /**
 99 |      * Get the endpoint used by transport, depends if option endpoint is specified
100 |      * Maybe https://api.sparkpost.com/api/v1/transmissions (default) or https://api.eu.sparkpost.com/api/v1/transmissions
101 |      *
102 |      * @return string
103 |      */
104 |     public function getEndpoint()
105 |     {
106 |         $endpoint = 'https://api.sparkpost.com/api/v1/transmissions';
107 |         if ($this->options && !empty($this->options['endpoint'])) {
108 |             $endpoint = $this->options['endpoint'];
109 |         }
110 |         return $endpoint;
111 |     }
112 | 
113 |     /**
114 |      * Get the API key being used by the transport.
115 |      *
116 |      * @return string
117 |      */
118 |     public function getKey()
119 |     {
120 |         return $this->key;
121 |     }
122 | 
123 |     /**
124 |      * Set the API key being used by the transport.
125 |      *
126 |      * @param  string  $key
127 |      * @return string
128 |      */
129 |     public function setKey($key)
130 |     {
131 |         return $this->key = $key;
132 |     }
133 | }
134 | 


--------------------------------------------------------------------------------