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)

Unused Use Statements -4 removed lines

@@ -20,18 +20,14 @@
 use Charcoal\Factory\FactoryInterface;
 
 // Module 'charcoal-view'
-use Charcoal\View\GenericView;
 use Charcoal\View\ViewableInterface;
 use Charcoal\View\ViewableTrait;
 
 // Module 'charcoal-queue'
 use Charcoal\Queue\QueueableInterface;
 use Charcoal\Queue\QueueableTrait;
-
-
 use Charcoal\Email\EmailInterface;
 use Charcoal\Email\EmailConfig;
-use Charcoal\Email\EmailLog;
 use Charcoal\Email\EmailQueueItem;
 
 /**

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

@@ -265,7 +265,7 @@
     }
 
     /**
-     * @param  null|string|DateTime $ts The "send date" datetime value.
+     * @param  string $ts The "send date" datetime value.
      * @throws InvalidArgumentException If the ts is not a valid datetime value.
      * @return self
      */