Add support for categories, clean code and updated doc (#8)

* Clean code

* Add support for multipart/alternative, support categories from sendmail, add logs & update service configuration + README

* Maj README

Author: Maxime Hermouet

Controller/DefaultController.php

@@ -20,14 +20,19 @@ public function getConfigTreeBuilder()
         $treeBuilder = new TreeBuilder();
         $rootNode = $treeBuilder->root('expert_coder_swiftmailer_send_grid');
 
-		$rootNode->isRequired()->cannotBeEmpty()
-			->children()
-				->scalarNode('api_key')
-					->isRequired()
-					->cannotBeEmpty()
-				->end()
-			->end()
-		;
+        $rootNode->isRequired()->cannotBeEmpty()
+            ->fixXmlConfig('category')
+            ->children()
+                ->scalarNode('api_key')
+                    ->isRequired()
+                    ->cannotBeEmpty()
+                ->end()
+                ->arrayNode('categories')
+                    ->scalarPrototype()->end()
+                ->end()
+            ->end()
+        ;
+
         return $treeBuilder;
     }
 }

DependencyInjection/Configuration.php

@@ -10,7 +10,7 @@
 /**
  * This is the class that loads and manages your bundle configuration.
  *
- * @link http://symfony.com/doc/current/cookbook/bundles/extension.html
+ * @see http://symfony.com/doc/current/cookbook/bundles/extension.html
  */
 class ExpertCoderSwiftmailerSendGridExtension extends Extension
 {
@@ -22,16 +22,10 @@ public function load(array $configs, ContainerBuilder $container)
         $configuration = new Configuration();
         $config = $this->processConfiguration($configuration, $configs);
 
-		$loader = new Loader\XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
+        $loader = new Loader\XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
         $loader->load('services.xml');
 
-		$container->setParameter('expertcoder_swiftmailer_sendgrid.api_key', $config['api_key']);
-
-		/*
-		 Swiftmailer Bundle seems to prepend "swiftmailer.mailer.transport." to "swiftmailer.transport" specified
-		 in config.yml to determine the name of the service to use, hence the need for this alias
-		 */
-		$container->setAlias('swiftmailer.mailer.transport.sendgrid', 'expertcoder_swift_mailer.send_grid.transport');
-
-	}
+        $container->setParameter('expertcoder_swiftmailer_sendgrid.api_key', $config['api_key']);
+        $container->setParameter('expertcoder_swiftmailer_sendgrid.categories', $config['categories']);
+    }
 }

DependencyInjection/ExpertCoderSwiftmailerSendGridExtension.php

@@ -14,10 +14,11 @@ parameters:
 config.yml
 ```
 swiftmailer:
-    transport: sendgrid
+    transport: expertcoder_swift_mailer.send_grid.transport
     
 expert_coder_swiftmailer_send_grid:
-    api_key: %sendgrid_api_key%    
+    api_key: %sendgrid_api_key%
+    categories: [my_app] # optional, will be added to all mails sent
 ```
 
 AppKernel.php
@@ -36,3 +37,10 @@ composer.json
 }
 
 ```
+
+## Important !
+
+Following RFC 1341, section 7.2, if either `text/html` or `text/plain` are to be sent in your email: `text/plain` needs to be first, followed by `text/html`, followed by any other content.
+
+
+For more informations, please see [SwiftMailer](https://swiftmailer.symfony.com/docs/messages.html#quick-reference) and [RFC 1341](https://www.w3.org/Protocols/rfc1341/7_2_Multipart.html)

README.md

@@ -9,6 +9,8 @@
                 id="expertcoder_swift_mailer.send_grid.transport"
                 class="ExpertCoder\Swiftmailer\SendGridBundle\Services\SendGridTransport" >
             <argument>%expertcoder_swiftmailer_sendgrid.api_key%</argument>
+            <argument>%expertcoder_swiftmailer_sendgrid.categories%</argument>
+            <argument type="service" id="logger" />
         </service>
     </services>
 </container>

Resources/config/routing.xml

@@ -8,9 +8,10 @@
 use Swift_Mime_Attachment;
 use Swift_Mime_Message;
 use Swift_Transport;
+use Psr\Log\LoggerInterface;
 
-class SendGridTransport implements Swift_Transport {
-
+class SendGridTransport implements Swift_Transport
+{
     /**
      * @see https://sendgrid.com/docs/API_Reference/Web_API_v3/Mail/errors.html
      * 2xx responses indicate a successful request. The request that you made is valid and successful.
@@ -36,60 +37,84 @@ class SendGridTransport implements Swift_Transport {
      */
     private $sendGridApiKey;
 
-    public function __construct($sendGridApiKey) {
+    /**
+     * Sendgrid mails categories.
+     *
+     * @var array
+     */
+    private $sendGridCategories;
+
+    /**
+     * Logger.
+     *
+     * @var LoggerInterface
+     */
+    private $logger;
+
+    public function __construct($sendGridApiKey, $sendGridCategories, LoggerInterface $logger)
+    {
         $this->sendGridApiKey = $sendGridApiKey;
+        $this->sendGridCategories = $sendGridCategories;
+        $this->logger = $logger;
     }
 
-    public function isStarted() {
+    public function isStarted()
+    {
         //Not used
         return true;
     }
 
-    public function start() {
+    public function start()
+    {
         //Not used
     }
 
-    public function stop() {
+    public function stop()
+    {
         //Not used
     }
 
     /**
-     * WARNING : $failedRecipients and return value are faked
+     * WARNING : $failedRecipients and return value are faked.
      *
      * @param Swift_Mime_Message $message
-     * @param array $failedRecipients
+     * @param array              $failedRecipients
+     *
      * @return int
      */
-    public function send(Swift_Mime_Message $message, &$failedRecipients = null) {
-
+    public function send(Swift_Mime_Message $message, &$failedRecipients = null)
+    {
         // prepare fake data.
-        $sent                    = 0;
+        $sent = 0;
         $prepareFailedRecipients = [];
 
-
         //Get the first from email (SendGrid PHP library only seems to support one)
         $fromArray = $message->getFrom();
-        $fromName  = reset($fromArray);
+        $fromName = reset($fromArray);
         $fromEmail = key($fromArray);
 
         $mail = new SendGrid\Mail(); //Intentionally not using constructor arguments as they are tedious to work with
 
+        // categories can be useful if you use them like tags to, for example, distinguish different applications.
+        foreach ($this->sendGridCategories as $category) {
+            $mail->addCategory($category);
+        }
+
         $mail->setFrom(new SendGrid\Email($fromName, $fromEmail));
         $mail->setSubject($message->getSubject());
 
         // extract content type from body to prevent multi-part content-type error
         $finfo = new finfo(FILEINFO_MIME_TYPE);
         $contentType = $finfo->buffer($message->getBody());
-        $mail->addContent(new SendGrid\Content($contentType,
-                                               $message->getBody()));
+        $mail->addContent(new SendGrid\Content($contentType, $message->getBody()));
 
         $personalization = new SendGrid\Personalization();
 
         // process TO
         if ($toArr = $message->getTo()) {
             foreach ($toArr as $email => $name) {
                 $personalization->addTo(new SendGrid\Email($name, $email));
-                $sent++;
+                ++$sent;
                 $prepareFailedRecipients[] = $email;
             }
         }
@@ -98,7 +123,7 @@ public function send(Swift_Mime_Message $message, &$failedRecipients = null) {
         if ($ccArr = $message->getCc()) {
             foreach ($ccArr as $email => $name) {
                 $personalization->addCc(new SendGrid\Email($name, $email));
-                $sent++;
+                ++$sent;
                 $prepareFailedRecipients[] = $email;
             }
         }
@@ -107,12 +132,12 @@ public function send(Swift_Mime_Message $message, &$failedRecipients = null) {
         if ($bccArr = $message->getBcc()) {
             foreach ($bccArr as $email => $name) {
                 $personalization->addBcc(new SendGrid\Email($name, $email));
-                $sent++;
+                ++$sent;
                 $prepareFailedRecipients[] = $email;
             }
         }
 
-        // process attachment (not inline)
+        // process attachment
         if ($attachments = $message->getChildren()) {
             foreach ($attachments as $attachment) {
                 if ($attachment instanceof Swift_Mime_Attachment) {
@@ -123,6 +148,9 @@ public function send(Swift_Mime_Message $message, &$failedRecipients = null) {
                     $sAttachment->setDisposition($attachment->getDisposition());
                     $sAttachment->setContentId($attachment->getId());
                     $mail->addAttachment($sAttachment);
+                } elseif (in_array($attachment->getContentType(), ['text/plain', 'text/html'])) {
+                    // add part if any is defined, to avoid error please set body as text and part as html
+                    $mail->addContent(new SendGrid\Content($attachment->getContentType(), $attachment->getBody()));
                 }
             }
         }
@@ -134,12 +162,11 @@ public function send(Swift_Mime_Message $message, &$failedRecipients = null) {
         $response = $sendGrid->client->mail()->send()->post($mail);
 
         // only 2xx status are ok
-        if (
-                $response->statusCode() < self::STATUS_OK_SUCCESSFUL_MIN_RANGE ||
-                self::STATUS_SUCCESSFUL_MAX_RANGE < $response->statusCode()) {
-
+        if ($response->statusCode() < self::STATUS_OK_SUCCESSFUL_MIN_RANGE ||
+            self::STATUS_SUCCESSFUL_MAX_RANGE < $response->statusCode()) {
             // to force big boom error uncomment this line
             //throw new \Swift_TransportException("Error when sending message. Return status :".$response->statusCode());
+            $this->logger->error($response->statusCode().': '.$response->body());
 
             // copy failed recipients
             foreach ($prepareFailedRecipients as $recipient) {
@@ -151,8 +178,8 @@ public function send(Swift_Mime_Message $message, &$failedRecipients = null) {
         return $sent;
     }
 
-    public function registerPlugin(Swift_Events_EventListener $plugin) {
+    public function registerPlugin(Swift_Events_EventListener $plugin)
+    {
         // unused
     }
-
 }

Resources/config/services.xml

@@ -2,7 +2,7 @@
   "name": "expertcoder/swiftmailer-send-grid-bundle",
   "type": "symfony-bundle",
   "description": "Swiftmailer Transport and Symfony bundle for Sendgrid",
-  "homepage": "https://github.com/expertcoder/TwigRendererBundle",
+  "homepage": "https://github.com/expertcoder/SwiftmailerSendGridBundle",
   "authors": [
     {
       "name": "Samual Anthony",