From b848d0f6387c0e43e3850fd463ecf188574ff041 Mon Sep 17 00:00:00 2001
From: Frederik Bosch <f.bosch@genkgo.nl>
Date: Tue, 28 Jan 2025 14:44:18 +0100
Subject: [PATCH] add class for Return-Path header

---
 src/Header/ReturnPath.php           | 39 +++++++++++++++++++++++++++++
 test/Unit/Header/ReturnPathTest.php | 32 +++++++++++++++++++++++
 2 files changed, 71 insertions(+)
 create mode 100644 src/Header/ReturnPath.php
 create mode 100644 test/Unit/Header/ReturnPathTest.php

diff --git a/src/Header/ReturnPath.php b/src/Header/ReturnPath.php
new file mode 100644
index 0000000..bd8b068
--- /dev/null
+++ b/src/Header/ReturnPath.php
@@ -0,0 +1,39 @@
+<?php
+declare(strict_types=1);
+
+namespace Genkgo\Mail\Header;
+
+use Genkgo\Mail\EmailAddress;
+use Genkgo\Mail\HeaderInterface;
+
+final class ReturnPath implements HeaderInterface
+{
+    /**
+     * @var EmailAddress
+     */
+    private $reversePath;
+
+    /**
+     * @param EmailAddress $reversePath
+     */
+    public function __construct(EmailAddress $reversePath)
+    {
+        $this->reversePath = $reversePath;
+    }
+
+    /**
+     * @return HeaderName
+     */
+    public function getName(): HeaderName
+    {
+        return new HeaderName('Return-Path');
+    }
+
+    /**
+     * @return HeaderValue
+     */
+    public function getValue(): HeaderValue
+    {
+        return HeaderValue::fromEncodedString((string)$this->reversePath);
+    }
+}
diff --git a/test/Unit/Header/ReturnPathTest.php b/test/Unit/Header/ReturnPathTest.php
new file mode 100644
index 0000000..e57b4fe
--- /dev/null
+++ b/test/Unit/Header/ReturnPathTest.php
@@ -0,0 +1,32 @@
+<?php
+declare(strict_types=1);
+
+namespace Genkgo\TestMail\Unit\Header;
+
+use Genkgo\Mail\Header\ReturnPath;
+use Genkgo\TestMail\AbstractTestCase;
+use Genkgo\Mail\EmailAddress;
+
+final class ReturnPathTest extends AbstractTestCase
+{
+    /**
+     * @test
+     * @dataProvider provideValues
+     */
+    public function it_produces_correct_values($recipientEmail, $headerName, $headerValue): void
+    {
+        $header = new ReturnPath(new EmailAddress($recipientEmail));
+        $this->assertEquals($headerName, (string)$header->getName());
+        $this->assertEquals($headerValue, (string)$header->getValue());
+    }
+
+    /**
+     * @return array
+     */
+    public function provideValues(): array
+    {
+        return [
+            ['me@example.com', 'Return-Path', 'me@example.com'],
+        ];
+    }
+}