feat: add reply to list support

lib/mail/Mail.php

@@ -78,6 +78,9 @@ class Mail implements \JsonSerializable
     /** @var $reply_to ReplyTo Email to be use when replied to */
     private $reply_to;
 
+     /** @var $reply_to_list ReplyToList Email to be use when replied to */
+    private $reply_to_list;
+
     /** @var $personalization Personalization[] Messages and their metadata */
     private $personalization;
 
@@ -982,6 +985,57 @@ public function getReplyTo()
         return $this->reply_to;
     }
 
+    /**
+     * Set a list of ReplyTo email addresses. The following input formats are supported:
+     *
+     * 1. only email addresses
+     * [
+     *     '[email protected]',
+     *     '[email protected]',
+     * ]
+     * 2. items with email address and name
+     * [
+     *     'email' => '[email protected]',
+     *     'name' => 'John Doe',
+     * ], [
+     *     'email' => '[email protected]',
+     *     'name' => '',
+     * ]
+     *
+     * @param array $replyToList
+     * @throws \InvalidArgumentException
+     */
+    public function setReplyToList(array $replyToList)
+    {
+        Assert::minItems($replyToList, 'replyToList', 1);
+        Assert::maxItems($replyToList, 'replyToList', 1000);
+
+        foreach ($replyToList as $replyTo) {
+            if ($replyTo instanceof ReplyTo ) {
+                $this->reply_to_list[] = $replyTo;
+            } elseif (is_array($replyTo)) {
+                if (! isset($replyTo['email'])) {
+                    throw new \InvalidArgumentException('Email is mandatory on ReplyToList array.');
+                }
+                $replyTo['name'] = isset($replyTo['name']) ? $replyTo['name'] : null;
+                $this->reply_to_list[] = new ReplyTo($replyTo['email'], $replyTo['name']);
+            } else {
+                $this->reply_to_list[] = new ReplyTo($replyTo);
+            }
+        }
+    }
+
+    /**
+     * Retrieve the reply to list to information attached to a Mail object
+     *
+     * @return ReplyToList
+     */
+
+    public function getReplyToList()
+    {
+        return $this->reply_to_list;
+    }
+
     /**
      * Add a subject to a Mail object
      *
@@ -1970,6 +2024,7 @@ static function ($value) {
                 )),
                 'from' => $this->getFrom(),
                 'reply_to' => $this->getReplyTo(),
+                'reply_to_list' => $this->getReplyToList(),
                 'subject' => $this->getGlobalSubject(),
                 'content' => $this->getContents(),
                 'attachments' => $this->getAttachments(),

test/unit/ReplyToListTest.php

@@ -0,0 +1,86 @@
+<?php
+
+namespace SendGrid\Tests\Unit;
+
+use PHPUnit\Framework\TestCase;
+use SendGrid\Mail\Mail;
+use SendGrid\Mail\ReplyTo;
+
+class ReplyToListTest extends TestCase
+{
+    public function testSetReplyToListWithValidReplyToObjects()
+    {
+        $emailObject = new Mail();
+        $replyToList = [
+            new ReplyTo('[email protected]', 'Test1'),
+            new ReplyTo('[email protected]', 'Test2'),
+        ];
+
+        $emailObject->setReplyToList($replyToList);
+
+        $this->assertCount(2, $emailObject->getReplyToList());
+        $this->assertEquals('[email protected]', $emailObject->getReplyToList()[0]->getEmail());
+        $this->assertEquals('Test1', $emailObject->getReplyToList()[0]->getName());
+        $this->assertEquals('[email protected]', $emailObject->getReplyToList()[1]->getEmail());
+        $this->assertEquals('Test2', $emailObject->getReplyToList()[1]->getName());
+    }
+
+    public function testSetReplyToListWithValidReplyToArray()
+    {
+        $emailObject = new Mail();
+        $replyToList = [
+            ['email' => '[email protected]', 'name' => 'Test1'],
+            ['email' => '[email protected]'],
+        ];
+
+        $emailObject->setReplyToList($replyToList);
+
+        $this->assertCount(2, $emailObject->getReplyToList());
+        $this->assertEquals('[email protected]', $emailObject->getReplyToList()[0]->getEmail());
+        $this->assertEquals('Test1', $emailObject->getReplyToList()[0]->getName());
+        $this->assertEquals('[email protected]', $emailObject->getReplyToList()[1]->getEmail());
+        $this->assertNull($emailObject->getReplyToList()[1]->getName());
+    }
+
+    public function testSetReplyToListWithInvalidReplyToArray()
+    {
+        $emailObject = new Mail();
+
+        $this->expectException(\InvalidArgumentException::class);
+        $this->expectExceptionMessage('Email is mandatory on ReplyToList array.');
+
+        $replyToList = [
+            ['name' => 'Test1'],
+        ];
+
+        $emailObject->setReplyToList($replyToList);
+    }
+
+    public function testSetReplyToListWithSingleEmailString()
+    {
+        $emailObject = new Mail();
+        $replyToList = [
+            '[email protected]',
+        ];
+
+        $emailObject->setReplyToList($replyToList);
+
+        $this->assertCount(1, $emailObject->getReplyToList());
+        $this->assertEquals('[email protected]', $emailObject->getReplyToList()[0]->getEmail());
+        $this->assertNull($emailObject->getReplyToList()[0]->getName());
+    }
+
+    public function testSetReplyToListWithMoreThanMaxItems()
+    {
+        $emailObject = new \SendGrid\Mail\Mail();
+        // Create a replyToList with 1001 items
+        $replyToList = array_fill(0, 1001, '[email protected]');
+
+        // Update to expect the correct exception type
+        $this->expectException(\SendGrid\Mail\TypeException::class);
+        $this->expectExceptionMessage('Number of elements in "$replyToList" can not be more than 1000.');
+
+        // Call the method that is expected to throw the exception
+        $emailObject->setReplyToList($replyToList);
+    }
+}