Compatibility update for Laravel 9

wouterdeberg · wouterdeberg · commit c4e3ae366e9b · 2022-09-23T10:00:32.000+02:00
diff --git a/README.md b/README.md
@@ -3,10 +3,9 @@
 Laravel Elastic Email is a wrapper for Elastic Email.
 You can send e-mails in your project just like you usually do with Laravel's native mailers, the package makes sure the e-mails are send via the Elastic Email API using your Elastic Email account.
 
-
-
 ## Requires
-Laravel version 8.12 or higher.
+V1 - Laravel version 8.12 or higher.
+V2 - Laravel version 9.0 or higher.
 
 ### Installation ###
 
@@ -18,7 +17,6 @@ composer require flexflux/laravel-elastic-email
 
 * Step 2: Add your account and API keys to your **.env file**.
 ```
-ELASTIC_ACCOUNT=<Your public account key>
 ELASTIC_KEY=<Your API key>
 ```
 
@@ -33,8 +31,7 @@ MAIL_MAILER=elastic_email
     ...
     'elastic_email' => [
         'transport' => 'elasticemail',
-        'key' => env('ELASTIC_KEY'),
-        'account' => env('ELASTIC_ACCOUNT')
+        'key' => env('ELASTIC_KEY')
     ],  
     ...
 ],
@@ -47,7 +44,6 @@ MAIL_MAILER=elastic_email
      * Laravel Framework Service Providers...
      */
     ...
-//    Illuminate\Mail\MailServiceProvider::class,
       \FlexFlux\LaravelElasticEmail\LaravelElasticEmailServiceProvider::class,
     ...
 ],
@@ -57,4 +53,10 @@ MAIL_MAILER=elastic_email
 
 Read Laravels documentation on how to send E-mails with the Laravel Framework.
 
-https://laravel.com/docs/8.x/mail
+https://laravel.com/docs/8.x/mail
+
+### Upgrade Guide from V1 to V2 ###
+Upgrade guide from V1 to V2:
+- Turn the MailServiceProvider back on in your app.php config file.
+- Remove your account ID environment variable.
+- Update your elastic_email mailer attribute in your mail.php configuration.
diff --git a/src/ElasticTransport.php b/src/ElasticTransport.php
@@ -3,129 +3,99 @@
 
 namespace FlexFlux\LaravelElasticEmail;
 
-use GuzzleHttp\ClientInterface;
-use Illuminate\Mail\Transport\Transport;
+use Symfony\Component\Mime\Email;
 use Illuminate\Support\Facades\Storage;
-use Swift_Mime_SimpleMessage;
+use Symfony\Component\Mailer\SentMessage;
+use Symfony\Component\Mime\Part\DataPart;
+use Symfony\Component\Mime\MessageConverter;
+use Symfony\Component\Mailer\Transport\AbstractTransport;
 
-class ElasticTransport extends Transport
+class ElasticTransport extends AbstractTransport
 {
-    protected $client;
     protected $key;
-    protected $account;
     protected $url = "https://api.elasticemail.com/v2/email/send";
 
-    public function __construct(ClientInterface $client, $key, $account)
+    public function __construct($key)
     {
-        $this->client = $client;
         $this->key = $key;
-        $this->account = $account;
     }
 
-    public function send(Swift_Mime_SimpleMessage $message, &$failedRecipients = null)
+    public function __toString(): string
     {
-        $this->beforeSendPerformed($message);
+        return 'elasticemail';
+    }
+
+     /**
+     * {@inheritdoc}
+     */
+    public function doSend(SentMessage $message) : void
+    {
+        $email = MessageConverter::toEmail($message->getOriginalMessage());
 
         $data = [
             'apikey' => $this->key,
-            'account' => $this->account,
-            'msgTo' => $this->getEmailAddresses($message),
-            'msgCC' => $this->getEmailAddresses($message, 'getCc'),
-            'msgBcc' => $this->getEmailAddresses($message, 'getBcc'),
-            'msgFrom' => $this->getFromAddress($message)['email'],
-            'msgFromName' => $this->getFromAddress($message)['name'],
-            'from' => $this->getFromAddress($message)['email'],
-            'fromName' => $this->getFromAddress($message)['name'],
-            'to' => $this->getEmailAddresses($message),
-            'subject' => $message->getSubject(),
-            'bodyHtml' => $message->getBody(),
-            'bodyText' => $this->getText($message),
-            'isTransactional' => true,
+            'msgTo' => $this->getEmailAddresses($email),
+            'msgCC' => $this->getEmailAddresses($email, 'getCc'),
+            'msgBcc' => $this->getEmailAddresses($email, 'getBcc'),
+            'msgFrom' => $email->getFrom()[0]->getAddress(),
+            'msgFromName' => $email->getFrom()[0]->getName(),
+            'from' => $email->getFrom()[0]->getAddress(),
+            'fromName' => $email->getFrom()[0]->getName(),
+            'replyTo' => $this->getEmailAddresses($email, 'getReplyTo'),
+            'to' => $this->getEmailAddresses($email),
+            'subject' => $email->getSubject(),
+            'bodyHtml' => $email->getHtmlBody(),
+            'bodyText' => $email->getTextBody(),
+            'isTransactional' => $email->getHeaders()->getHeaderBody('x-metadata-transactional') ? true : false,
         ];
 
-        $attachments = $message->getChildren();
-        $attachmentCount = $this->checkAttachmentCount($attachments);
+        $attachments = $email->getAttachments();
+        $attachmentCount = count($attachments);
 
         if ($attachmentCount > 0) {
             $data = $this->attach($attachments, $data);
         }
+
         $ch = curl_init();
 
-        curl_setopt_array($ch, array(
+        curl_setopt_array($ch, [
             CURLOPT_URL => $this->url,
             CURLOPT_POST => true,
             CURLOPT_POSTFIELDS => $data,
             CURLOPT_RETURNTRANSFER => true,
             CURLOPT_HEADER => false,
-            CURLOPT_SSL_VERIFYPEER => false
-        ));
+            CURLOPT_SSL_VERIFYPEER => false,
+        ]);
 
-        $result = curl_exec($ch);
+        curl_exec($ch);
         curl_close($ch);
 
         if ($attachmentCount > 0) {
             $this->deleteTempAttachmentFiles($data, $attachmentCount);
         }
-
-        return $result;
-    }
-
-    protected function getEmailAddresses(Swift_Mime_SimpleMessage $message, $method = 'getTo')
-    {
-        $data = call_user_func([$message, $method]);
-
-        if (is_array($data)) {
-            return implode(',', array_keys($data));
-        }
-        return '';
-    }
-
-    protected function getFromAddress(Swift_Mime_SimpleMessage $message)
-    {
-        return [
-            'email' => array_keys($message->getFrom())[0],
-            'name' => array_values($message->getFrom())[0],
-        ];
-    }
-
-    protected function getText(Swift_Mime_SimpleMessage $message)
-    {
-        $text = null;
-
-        foreach ($message->getChildren() as $child) {
-            if ($child->getContentType() == 'text/plain') {
-                $text = $child->getBody();
-            }
-        }
-
-        return $text;
     }
 
-    public function checkAttachmentCount($attachments)
-    {
-        $count = 0;
-        foreach ($attachments AS $attachment) {
-            if ($attachment instanceof \Swift_Attachment) {
-                $count++;
-            }
-        }
-        return $count;
-    }
+    /**
+     * Add attachments to post data array.
+     * @param $attachments
+     * @param $data
+     * @return mixed
+     */
 
     public function attach($attachments, $data)
     {
         if (is_array($attachments) && count($attachments) > 0) {
             $i = 1;
-            foreach ($attachments AS $attachment) {
-                if ($attachment instanceof \Swift_Attachment) {
+            foreach ($attachments as $attachment) {
+                if ($attachment instanceof DataPart) {
                     $attachedFile = $attachment->getBody();
-                    $fileName = $attachment->getFilename();
+                    $fileName = $attachment->getPreparedHeaders()->getHeaderParameter('Content-Disposition', 'filename');
                     $ext = pathinfo($fileName, PATHINFO_EXTENSION);
-                    $tempName = uniqid() . '.' . $ext;
+                    $tempName = uniqid().'.'.$ext;
                     Storage::put($tempName, $attachedFile);
-                    $type = $attachment->getContentType();
+                    $type = $attachment->getMediaType().'/'.$attachment->getMediaSubtype();
                     $attachedFilePath = storage_path($tempName);
-                    $data['file_' . $i] = new \CURLFile($attachedFilePath, $type, $fileName);
+                    $data['file_'.$i] = new \CurlFile($attachedFilePath, $type, $fileName);
                     $i++;
                 }
             }
@@ -134,10 +104,37 @@ public function attach($attachments, $data)
         return $data;
     }
 
-    protected function deleteTempAttachmentFiles($data, $count)
+    /**
+     * Retrieve requested emailaddresses from email.
+     * @param Email $email
+     * @param string $method
+     * @return string
+     */
+
+    protected function getEmailAddresses(Email $email, $method = 'getTo')
+    {
+        $data = call_user_func([$email, $method]);
+
+        $addresses = [];
+        if (is_array($data)) {
+            foreach ($data as $address) {
+                $addresses[] = $address->getAddress();
+            }
+        }
+
+        return implode(',', $addresses);
+    }
+
+    /**
+     * Delete temporary attachment files.
+     * @param $data
+     * @param $count
+     */
+
+    protected function deleteTempAttachmentFiles($data, $count) : void
     {
         for ($i = 1; $i <= $count; $i++) {
-            $file = $data['file_' . $i]->name;
+            $file = $data['file_'.$i]->name;
             if (file_exists($file)) {
                 unlink($file);
             }
diff --git a/src/LaravelElasticEmailServiceProvider.php b/src/LaravelElasticEmailServiceProvider.php
@@ -1,20 +1,22 @@
 <?php
 
-
 namespace FlexFlux\LaravelElasticEmail;
 
-use Illuminate\Mail\MailServiceProvider as LaravelMailServiceProvider;
+use Illuminate\Mail\MailManager;
+use Illuminate\Support\ServiceProvider;
 
-class LaravelElasticEmailServiceProvider extends LaravelMailServiceProvider
+class LaravelElasticEmailServiceProvider extends ServiceProvider
 {
-    protected function registerIlluminateMailer()
+    public function register()
     {
-        $this->app->singleton('mail.manager', function ($app) {
-            return new MailManager($app);
-        });
+        $this->app->afterResolving(MailManager::class, function (MailManager $manager) {
+            $manager->extend('elastic_email', function () {
+                $config = $this->app['config']->get('mail.mailers.elastic_email', []);
 
-        $this->app->bind('mailer', function ($app) {
-            return $app->make('mail.manager')->mailer();
+                return new ElasticTransport(
+                    $config['key'],
+                );
+            });
         });
     }
 }
diff --git a/src/MailManager.php b/src/MailManager.php
