Add Wrapper for Symfony SentMessage (#38803)

* Create SentMessage wrapper for Symfony's SentMessage * Wrap Symfony SentMessage * Update Docblocks to Illuminate\Mail\SentMessage * Fix sendMailable * Update SentMessage.php Co-authored-by: Dries Vints <dries@vints.io>
laravel · taylorotwell · Sep 14, 2021 · Aug 20, 2021 · Aug 20, 2021 · Aug 21, 2021
commit c8d16545df39de602d61998bdeb9326521e0bd9c
diff --git a/src/Illuminate/Mail/Mailable.php b/src/Illuminate/Mail/Mailable.php
@@ -167,7 +167,7 @@ class Mailable implements MailableContract, Renderable
      * Send the message using the given mailer.
      *
      * @param  \Illuminate\Contracts\Mail\Factory|\Illuminate\Contracts\Mail\Mailer  $mailer
-     * @return \Symfony\Component\Mailer\SentMessage|null
+     * @return \Illuminate\Mail\SentMessage|null
      */
     public function send($mailer)
     {

diff --git a/src/Illuminate/Mail/Mailer.php b/src/Illuminate/Mail/Mailer.php
@@ -188,7 +188,7 @@ public function bcc($users)
      *
      * @param  string  $html
      * @param  mixed  $callback
-     * @return \Symfony\Component\Mailer\SentMessage|null
+     * @return \Illuminate\Mail\SentMessage|null
      */
     public function html($html, $callback)
     {
@@ -200,7 +200,7 @@ public function html($html, $callback)
      *
      * @param  string  $text
      * @param  mixed  $callback
-     * @return \Symfony\Component\Mailer\SentMessage|null
+     * @return \Illuminate\Mail\SentMessage|null
      */
     public function raw($text, $callback)
     {
@@ -213,7 +213,7 @@ public function raw($text, $callback)
      * @param  string  $view
      * @param  array  $data
      * @param  mixed  $callback
-     * @return \Symfony\Component\Mailer\SentMessage|null
+     * @return \Illuminate\Mail\SentMessage|null
      */
     public function plain($view, array $data, $callback)
     {
@@ -245,7 +245,7 @@ public function render($view, array $data = [])
      * @param  \Illuminate\Contracts\Mail\Mailable|string|array  $view
      * @param  array  $data
      * @param  \Closure|string|null  $callback
-     * @return \Symfony\Component\Mailer\SentMessage|null
+     * @return \Illuminate\Mail\SentMessage|null
      */
     public function send($view, array $data = [], $callback = null)
     {
@@ -286,15 +286,15 @@ public function send($view, array $data = [], $callback = null)
 
             $this->dispatchSentEvent($message, $data);
 
-            return $sentMessage;
+            return $sentMessage === null ? null : new SentMessage($sentMessage);
         }
     }
 
     /**
      * Send the given mailable.
      *
      * @param  \Illuminate\Contracts\Mail\Mailable  $mailable
-     * @return mixed
+     * @return \Illuminate\Mail\SentMessage|null
      */
     protected function sendMailable(MailableContract $mailable)
     {

diff --git a/src/Illuminate/Mail/SentMessage.php b/src/Illuminate/Mail/SentMessage.php
@@ -0,0 +1,54 @@
+<?php
+
+namespace Illuminate\Mail;
+
+use Illuminate\Support\Traits\ForwardsCalls;
+use Symfony\Component\Mailer\SentMessage as SymfonySentMessage;
+
+/**
+ * @mixin \Symfony\Component\Mailer\SentMessage
+ */
+class SentMessage
+{
+    use ForwardsCalls;
+
+    /**
+     * The Symfony SentMessage instance.
+     *
+     * @var \Symfony\Component\Mailer\SentMessage
+     */
+    protected $sentMessage;
+
+    /**
+     * Create a new SentMessage instance.
+     *
+     * @param  \Symfony\Component\Mailer\SentMessage  $sentMessage
+     * @return void
+     */
+    public function __construct(SymfonySentMessage $sentMessage)
+    {
+        $this->sentMessage = $sentMessage;
+    }
+
+    /**
+     * Get the underlying Symfony Email instance.
+     *
+     * @return \Symfony\Component\Mailer\SentMessage
+     */
+    public function getSymfonySentMessage()
+    {
+        return $this->sentMessage;
+    }
+
+    /**
+     * Dynamically pass missing methods to the Symfony instance.
+     *
+     * @param  string  $method
+     * @param  array  $parameters
+     * @return mixed
+     */
+    public function __call($method, $parameters)
+    {
+        return $this->forwardCallTo($this->sentMessage, $method, $parameters);
+}
diff --git a/src/Illuminate/Support/Facades/Mail.php b/src/Illuminate/Support/Facades/Mail.php
@@ -10,10 +10,10 @@
  * @method static \Illuminate\Mail\PendingMail to($users)
  * @method static \Illuminate\Support\Collection queued(string $mailable, \Closure|string $callback = null)
  * @method static \Illuminate\Support\Collection sent(string $mailable, \Closure|string $callback = null)
- * @method static \Symfony\Component\Mailer\SentMessage|null raw(string $text, $callback)
- * @method static \Symfony\Component\Mailer\SentMessage|null plain(string $view, array $data, $callback)
- * @method static \Symfony\Component\Mailer\SentMessage|null html(string $html, $callback)
- * @method static \Symfony\Component\Mailer\SentMessage|null send(\Illuminate\Contracts\Mail\Mailable|string|array $view, array $data = [], \Closure|string $callback = null)
+ * @method static \Illuminate\Mail\SentMessage|null raw(string $text, $callback)
+ * @method static \Illuminate\Mail\SentMessage|null plain(string $view, array $data, $callback)
+ * @method static \Illuminate\Mail\SentMessage|null html(string $html, $callback)
+ * @method static \Illuminate\Mail\SentMessage|null send(\Illuminate\Contracts\Mail\Mailable|string|array $view, array $data = [], \Closure|string $callback = null)
  * @method static array failures()
  * @method static bool hasQueued(string $mailable)
  * @method static bool hasSent(string $mailable)