Merge pull request #36 from railsware/iy/reply_to

Add `reply_to`

Author: i7an

CHANGELOG.md

@@ -1,3 +1,7 @@
+## [2.2.0] - 2024-12-18
+
+- Added `reply_to` parameter support
+
 ## [2.1.2] - 2024-12-13
 
 - Improved handling of invalid `from`, `to`, `cc`, `bcc` headers when sending

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mailtrap (2.1.2)
+    mailtrap (2.2.0)
 
 GEM
   remote: https://rubygems.org/

README.md

@@ -52,6 +52,7 @@ mail = Mailtrap::Mail::Base.new(
   to: [
     { email: 'your@email.com' }
   ],
+  reply_to: { email: 'support@example.com', name: 'Mailtrap Reply-To' },
   subject: 'You are awesome!',
   text: "Congrats for sending test email with Mailtrap!"
 )

examples/action_mailer.rb

@@ -18,6 +18,7 @@
 # To add `category` and `custom_variables`, add them to the mail generation:
 mail(
   to: 'your@email.com',
+  reply_to: 'Mailtrap Reply-To <support@example.com>',
   subject: 'You are awesome!',
   category: 'Test category',
   custom_variables: { test_variable: 'abc' }

examples/email_template.rb

@@ -6,6 +6,7 @@
   to: [
     { email: 'your@email.com' }
   ],
+  reply_to: { email: 'support@example.com', name: 'Mailtrap Reply-To' },
   template_uuid: '2f45b0aa-bbed-432f-95e4-e145e1965ba2',
   template_variables: {
     'user_name' => 'John Doe'

examples/full.rb

@@ -6,6 +6,7 @@
   to: [
     { email: 'your@email.com', name: 'Your name' }
   ],
+  reply_to: { email: 'support@example.com', name: 'Mailtrap Reply-To' },
   cc: [
     { email: 'cc@email.com', name: 'Copy To' }
   ],

lib/mailtrap/mail/base.rb

@@ -5,12 +5,13 @@
 module Mailtrap
   module Mail
     class Base
-      attr_accessor :from, :to, :cc, :bcc, :headers, :custom_variables, :subject, :text, :html, :category
+      attr_accessor :from, :to, :reply_to, :cc, :bcc, :headers, :custom_variables, :subject, :text, :html, :category
       attr_reader :attachments
 
       def initialize( # rubocop:disable Metrics/ParameterLists, Metrics/MethodLength
         from: nil,
         to: [],
+        reply_to: nil,
         cc: [],
         bcc: [],
         subject: nil,
@@ -23,6 +24,7 @@ def initialize( # rubocop:disable Metrics/ParameterLists, Metrics/MethodLength
       )
         @from = from
         @to = to
+        @reply_to = reply_to
         @cc = cc
         @bcc = bcc
         @subject = subject
@@ -38,6 +40,7 @@ def as_json # rubocop:disable Metrics/MethodLength
         {
           'from' => from,
           'to' => to,
+          'reply_to' => reply_to,
           'cc' => cc,
           'bcc' => bcc,
           'subject' => subject,

lib/mailtrap/mail/from_template.rb

@@ -8,6 +8,7 @@ class FromTemplate < Base
       def initialize( # rubocop:disable Metrics/ParameterLists, Metrics/MethodLength
         from: nil,
         to: [],
+        reply_to: nil,
         cc: [],
         bcc: [],
         attachments: [],
@@ -19,6 +20,7 @@ def initialize( # rubocop:disable Metrics/ParameterLists, Metrics/MethodLength
         super(
           from: from,
           to: to,
+          reply_to: reply_to,
           cc: cc,
           bcc: bcc,
           attachments: attachments,

lib/mailtrap/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mailtrap
-  VERSION = '2.1.2'
+  VERSION = '2.2.0'
 end

spec/mailtrap/mail/base_spec.rb

@@ -8,6 +8,7 @@
     described_class.new(
       from: from,
       to: to,
+      reply_to: reply_to,
       cc: cc,
       bcc: bcc,
       subject: mail_subject,
@@ -22,6 +23,7 @@
 
   let(:from) { nil }
   let(:to) { [] }
+  let(:reply_to) { nil }
   let(:cc) { [] }
   let(:bcc) { [] }
   let(:mail_subject) { nil }
@@ -80,6 +82,7 @@
     end
 
     context 'when all values set' do
+      let(:reply_to) { { email: 'reply-to@railsware.com' } }
       let(:cc) { [{ email: 'cc@example.com' }] }
       let(:bcc) { [{ email: 'bcc@example.com' }] }
       let(:html) { '<div>Test HTML</div>' }
@@ -91,6 +94,7 @@
         {
           'from' => { email: 'test@example.com', name: 'Mailtrap User' },
           'to' => [{ email: 'to@example.com' }, { email: 'to2@example.com', name: 'To Two' }],
+          'reply_to' => { email: 'reply-to@railsware.com' },
           'cc' => [{ email: 'cc@example.com' }],
           'bcc' => [{ email: 'bcc@example.com' }],
           'subject' => 'This is subject',
@@ -114,6 +118,7 @@
 
     let(:from) { { email: 'test@example.com', name: 'Mailtrap User' } }
     let(:to) { [{ email: 'to@example.com' }, { email: 'to2@example.com', name: 'To Two' }] }
+    let(:reply_to) { { email: 'reply-to@railsware.com', name: 'Reply To' } }
     let(:mail_subject) { 'This is subject' }
     let(:text) { 'This is text' }
     let(:cc) { [{ email: 'cc@example.com' }] }
@@ -126,6 +131,7 @@
       '{' \
         '"from":{"email":"test@example.com","name":"Mailtrap User"},' \
         '"to":[{"email":"to@example.com"},{"email":"to2@example.com","name":"To Two"}],' \
+        '"reply_to":{"email":"reply-to@railsware.com","name":"Reply To"},' \
         '"cc":[{"email":"cc@example.com"}],' \
         '"bcc":[{"email":"bcc@example.com"}],' \
         '"subject":"This is subject",' \