Add to_symfony_emails() helper

dmitry-ivanov · dmitry-ivanov · commit ec906bf9f519 · 2022-03-10T21:34:41.000+02:00
diff --git a/README.md b/README.md
@@ -75,6 +75,7 @@ Laravel-specific and pure PHP Helper Functions.
     - [is_email](#is_email)
     - [to_rfc2822_email](#to_rfc2822_email)
     - [to_swiftmailer_emails](#to_swiftmailer_emails)
+    - [to_symfony_emails](#to_symfony_emails)
 
 - [Filesystem](#filesystem)
     - [relative_path](#relative_path)
@@ -330,6 +331,27 @@ to_swiftmailer_emails(['address' => 'john.doe@example.com', 'name' => 'John Doe'
 // ["john.doe@example.com" => "John Doe"]
 ```
 
+#### `to_symfony_emails()`
+
+Convert addresses data to [Symfony-suitable format](https://symfony.com/doc/current/mailer.html#email-addresses):
+
+```php
+to_symfony_emails([
+    ['address' => 'john.doe@example.com', 'name' => 'John Doe'],
+    ['address' => 'jane.smith@example.com'],
+]);
+
+// ["John Doe <john.doe@example.com>", "jane.smith@example.com"]
+```
+
+Also, it supports simplified syntax for a single address:
+
+```php
+to_symfony_emails(['address' => 'john.doe@example.com', 'name' => 'John Doe']);
+
+// ["John Doe <john.doe@example.com>"]
+```
+
 ## Filesystem
 
 #### `relative_path()`
diff --git a/src/email.php b/src/email.php
@@ -21,7 +21,6 @@ function is_email(mixed $string): bool
      */
     function to_rfc2822_email(array $addresses): string
     {
-        // Check if we're dealing with one address, without multiarray
         $addresses = !empty($addresses['address']) ? [$addresses] : $addresses;
 
         return collect($addresses)
@@ -48,7 +47,6 @@ function to_rfc2822_email(array $addresses): string
      */
     function to_swiftmailer_emails(array $addresses): array
     {
-        // Check if we're dealing with one address, without multiarray
         $addresses = !empty($addresses['address']) ? [$addresses] : $addresses;
 
         return collect($addresses)
@@ -66,3 +64,30 @@ function to_swiftmailer_emails(array $addresses): array
             ->toArray();
     }
 }
+
+if (!function_exists('to_symfony_emails')) {
+    /**
+     * Convert addresses data to Symfony-suitable format.
+     *
+     * @see https://symfony.com/doc/current/mailer.html#email-addresses
+     */
+    function to_symfony_emails(array $addresses): array
+    {
+        $addresses = !empty($addresses['address']) ? [$addresses] : $addresses;
+
+        return collect($addresses)
+            ->map(function (array $item) {
+                $name = Arr::get($item, 'name');
+                $address = Arr::get($item, 'address');
+
+                if (!is_email($address)) {
+                    return false;
+                }
+
+                return $name ? "{$name} <{$address}>" : $address;
+            })
+            ->filter()
+            ->values()
+            ->toArray();
+    }
+}
diff --git a/tests/email/ToSymfonyEmailsTest.php b/tests/email/ToSymfonyEmailsTest.php
@@ -0,0 +1,86 @@
+<?php
+
+namespace Illuminated\Helpers\Tests\Email;
+
+use Illuminated\Helpers\Tests\TestCase;
+
+class ToSymfonyEmailsTest extends TestCase
+{
+    /** @test */
+    public function it_returns_an_empty_array_for_an_empty_array()
+    {
+        $this->assertEquals([], to_symfony_emails([]));
+    }
+
+    /** @test */
+    public function it_supports_simplified_syntax_for_one_email()
+    {
+        $this->assertEquals(
+            ['John Doe <john.doe@example.com>'],
+            to_symfony_emails(['address' => 'john.doe@example.com', 'name' => 'John Doe']),
+        );
+    }
+
+    /** @test */
+    public function it_supports_multiple_emails()
+    {
+        $this->assertEquals(
+            ['John Doe <john.doe@example.com>', 'Jane Doe <jane.doe@example.com>', 'Mary Doe <mary.doe@example.com>'],
+            to_symfony_emails([
+                ['address' => 'john.doe@example.com', 'name' => 'John Doe'],
+                ['address' => 'jane.doe@example.com', 'name' => 'Jane Doe'],
+                ['address' => 'mary.doe@example.com', 'name' => 'Mary Doe'],
+            ]),
+        );
+    }
+
+    /** @test */
+    public function it_skips_items_with_empty_addresses()
+    {
+        $this->assertEquals(
+            ['John Doe <john.doe@example.com>', 'Mary Doe <mary.doe@example.com>'],
+            to_symfony_emails([
+                ['address' => 'john.doe@example.com', 'name' => 'John Doe'],
+                ['address' => null, 'name' => 'Jane Doe'],
+                ['address' => false, 'name' => 'Jane Doe'],
+                ['address' => '', 'name' => 'Jane Doe'],
+                ['name' => 'Fake Doe'],
+                ['address' => 'mary.doe@example.com', 'name' => 'Mary Doe'],
+            ]),
+        );
+    }
+
+    /** @test */
+    public function it_skips_items_with_invalid_addresses()
+    {
+        $this->assertEquals(
+            ['John Doe <john.doe@example.com>', 'Vicky Doe <vicky.doe@example.com>'],
+            to_symfony_emails([
+                ['address' => 'john.doe@example.com', 'name' => 'John Doe'],
+                ['address' => 'jane@', 'name' => 'Jane Doe'],
+                ['address' => 'jane@example', 'name' => 'Jane Doe'],
+                ['address' => 'vicky.doe@example.com', 'name' => 'Vicky Doe'],
+                ['address' => null, 'name' => 'Jane Doe'],
+            ]),
+        );
+    }
+
+    /** @test */
+    public function name_is_optional_for_one_email()
+    {
+        $this->assertEquals(['john.doe@example.com'], to_symfony_emails(['address' => 'john.doe@example.com']));
+    }
+
+    /** @test */
+    public function name_is_optional_for_multiple_emails()
+    {
+        $this->assertEquals(
+            ['John Doe <john.doe@example.com>', 'jane.doe@example.com', 'mary.doe@example.com'],
+            to_symfony_emails([
+                ['address' => 'john.doe@example.com', 'name' => 'John Doe'],
+                ['address' => 'jane.doe@example.com'],
+                ['address' => 'mary.doe@example.com'],
+            ]),
+        );
+    }
+}
