locomotivemtl / charcoal-email

src/Charcoal/Email/Email.php

Doc Comments +2 added lines, -2 removed lines

@@ -750,7 +750,7 @@ 
     /**
      * Send the email to all recipients
      *
-     * @return boolean Success / Failure.
+     * @return boolean|null Success / Failure.
      * @todo Implement methods and property for toggling rich-text vs. plain-text
      *       emails (`$mail->isHTML(true)`).
      */
@@ -887,7 +887,7 @@ 
      * Log the send event for each recipient.
      *
      * @param  boolean $result Success or failure.
-     * @param  mixed   $mailer The raw mailer.
+     * @param  PHPMailer   $mailer The raw mailer.
      * @return void
      */
     protected function logSend($result, $mailer)

Spacing +3 added lines, -3 removed lines

@@ -237,7 +237,7 @@ 
     public function setTo($email)
     {
         if (is_string($email)) {
-            $email = [ $email ];
+            $email = [$email];
         }
 
         if (!is_array($email)) {
@@ -303,7 +303,7 @@ 
     public function setCc($email)
     {
         if (is_string($email)) {
-            $email = [ $email ];
+            $email = [$email];
         }
 
         if (!is_array($email)) {
@@ -370,7 +370,7 @@ 
     {
         if (is_string($email)) {
             // Means we have a straight email
-            $email = [ $email ];
+            $email = [$email];
         }
 
         if (!is_array($email)) {

Unused Use Statements -2 removed lines

@@ -21,7 +21,6 @@ 
 use Charcoal\Factory\FactoryInterface;
 
 // Module `charcoal-view` dependencies
-use Charcoal\View\GenericView;
 use Charcoal\View\ViewableInterface;
 use Charcoal\View\ViewableTrait;
 
@@ -32,7 +31,6 @@ 
 // Intra module (`charcoal-email`) dependencies
 use Charcoal\Email\EmailInterface;
 use Charcoal\Email\EmailConfig;
-use Charcoal\Email\EmailLog;
 use Charcoal\Email\EmailQueueItem;
 
 /**

src/Charcoal/Email/EmailConfig.php

Spacing +1 added lines, -1 removed lines

@@ -285,7 +285,7 @@
     public function setSmtpSecurity($security)
     {
         $security = strtoupper($security);
-        $validSecurity = [ '', 'TLS', 'SSL' ];
+        $validSecurity = ['', 'TLS', 'SSL'];
 
         if (!in_array($security, $validSecurity)) {
             throw new InvalidArgumentException(

src/Charcoal/Email/ServiceProvider/EmailServiceProvider.php

Spacing +3 added lines, -3 removed lines

@@ -36,7 +36,7 @@ 
          * @param Container $container Pimple DI container.
          * @return \Charcoal\Email\EmailConfig
          */
-        $container['email/config'] = function (Container $container) {
+        $container['email/config'] = function(Container $container) {
             $appConfig = $container['config'];
             $emailConfig = new EmailConfig($appConfig['email']);
             return $emailConfig;
@@ -46,7 +46,7 @@ 
          * @param Container $container Pimple DI container.
          * @return \Charcoal\View\ViewInterface
          */
-        $container['email/view'] = function (Container $container) {
+        $container['email/view'] = function(Container $container) {
             return $container['view'];
         };
 
@@ -75,7 +75,7 @@ 
          * @param Container $container Pimple DI container.
          * @return \Charcoal\Email\EmailInterface
          */
-        $container['email'] = $container->factory(function (Container $container) {
+        $container['email'] = $container->factory(function(Container $container) {
             return $container['email/factory']->create('email');
         });
     }

src/Charcoal/Email/EmailAwareTrait.php

Doc Comments +1 added lines, -1 removed lines

@@ -33,7 +33,7 @@
     /**
      * Convert an email address (RFC822) into a proper array notation.
      *
-     * @param  mixed $var An email array (containing an "email" key and optionally a "name" key).
+     * @param  string $var An email array (containing an "email" key and optionally a "name" key).
      * @throws InvalidArgumentException If the email is invalid.
      * @return array|null
      */

src/Charcoal/Email/EmailLog.php

Doc Comments +1 added lines, -1 removed lines

@@ -388,7 +388,7 @@
     }
 
     /**
-     * @return mixed
+     * @return string
      */
     public function ip()
     {