midi-smtp-server 3.1.2 → 3.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c84077c17fd5b68cffd37292da0e473245f16662041fb9a17218cd897961730
-  data.tar.gz: 299e676ad777d512b53d6c81a2a3b696eca00fb2d11adcaf2a3f24b6075c5fe1
+  metadata.gz: c8ae466dfca7a6bde0fcc780096da505a675ac4d703641097aa9980423c4976d
+  data.tar.gz: 92be87d1e1f857ba910a53f357519dc9a97edf0c89747d875c394f270d587d0b
 SHA512:
-  metadata.gz: 68446f6bb248f579689091fa094752f95db702ca6fc9f6de5588b68c1c564ee45499d71acee7b674b8784b78403a275e15afb5249e867571542e96c93ae608bd
-  data.tar.gz: 65c78a6d3ec2241756befc2a80a03691e74b37eed18093c0796ebd5a420f522b44f514e77b904f1a2ab7a97fb5862daaf7da2bcc3a5c2ba20000079111c3e994
+  metadata.gz: 6b57ce0eb75d4c6cdfde8e417e0a93214834c811937dbe093aed941285dc577c4d96e65ee4dfa2639db8349199e1de70d19de14609d423e914cee16a6ee36868
+  data.tar.gz: 9aee1d4d53f0b3878022a44ed267a3b9f3b9e570cf3eb96fd2ace0e598c8cb6fc7eb6ca1446948be01e3fa4d12170c9b3d91aade46d826c307e92c3ae6e2c479

data/CHANGELOG.md

@@ -5,6 +5,21 @@ We suggest everybody using MidiSmtpServer to switch at least to latest 2.3.y. or
 For upgrades from previous versions or outdated _MiniSmtpServer_ gem you may follow the guides at [Appendix Upgrade](https://midi-smtp-server.readthedocs.io/appendix_upgrade/) to get your code ready for the latest releases.
 
 
+#### 3.3.1 (2026-09-16)
+
+1. Updates and fixes for Ruby versions 3.3, 3.4 and 4.0
+2. New feature and optimization for [IO wait](https://midi-smtp-server.readthedocs.io/feature_load_balancing) by event mode
+3. Deprecate `io_waitreadable_sleep` in favor of `io_wait_mode` and `io_wait_available`
+4. Test fixes for newer Ruby (3.3+) and OS-specific socket behaviour
+5. mkdocs update for readthedocs
+
+
+#### 3.2.1 (2023-08-15)
+
+1. New feature [proxy](https://midi-smtp-server.readthedocs.io/feature_proxy) ([check issue 49](https://github.com/4commerce-technologies-AG/midi-smtp-server/issues/49))
+2. mkdocs update for readthedocs
+
+
 #### 3.1.2 (2023-05-06)
 
 1. Minor fix for backwards compatibility to method `start` when not using pre_fork options.

data/README.md

@@ -76,7 +76,11 @@ This source code shows the example to receive messages via SMTP and store them t
 
 ## Installation
 
-MidiSmtpServer is packaged as a RubyGem so that you can easily install by entering following at your command line:
+MidiSmtpServer is packaged as a RubyGem and hosted on rubygems.
+
+#### CLI
+
+You can easily install the package by entering following at your command line:
 
   `gem install midi-smtp-server`
 
@@ -84,6 +88,14 @@ Use the component in your project sources by:
 
   `require 'midi-smtp-server'`
 
+#### Gemfile
+
+When a `Gemfile` handles your dependencies, please consider to use the [pessimistic operator](https://thoughtbot.com/blog/rubys-pessimistic-operator) at least:
+
+  `gem 'midi-smtp-server', '~> 3.1.2''`
+
+All changes by PATCH versions are always functional and compatible with no issues on update!
+
 <br>
 
 
@@ -147,9 +159,13 @@ We suggest everybody using MidiSmtpServer to switch at least to latest 2.3.y. or
 For upgrades from previous versions or outdated _MiniSmtpServer_ gem you may follow the guides (see appendix) how to change your existing code to be compatible with the latest releases.
 
 
-#### Latest release: 3.1.2 (2023-05-06)
+#### Latest release: 3.3.1 (2026-09-16)
 
-1. Minor fix for backwards compatibility to method `start` when not using pre_fork options.
+1. Updates and fixes for Ruby versions 3.3, 3.4 and 4.0
+2. New feature and optimization for [IO wait](https://midi-smtp-server.readthedocs.io/feature_load_balancing) by event mode
+3. Deprecate `io_waitreadable_sleep` in favor of `io_wait_mode` and `io_wait_available`
+4. Test fixes for newer Ruby (3.3+) and OS-specific socket behaviour
+5. mkdocs update for readthedocs
 
 
 #### Changelog history
@@ -192,4 +208,4 @@ Author: [Tom Freudenberg](http://about.me/tom.freudenberg)
 
 [MidiSmtpServer Class](https://github.com/4commerce-technologies-AG/midi-smtp-server/) is inspired from [MiniSmtpServer Class](https://github.com/aarongough/mini-smtp-server) and code written by [Aaron Gough](https://github.com/aarongough) and [Peter Cooper](https://github.com/4commerce-technologies-AG/midi-smtp-server#author--credits)
 
-Copyright (c) 2014-2023 [Tom Freudenberg](https://github.com/TomFreudenberg), [4commerce technologies AG](https://www.4commerce.de/), released under the MIT license
+Copyright (c) 2014-2026 [Tom Freudenberg](https://github.com/TomFreudenberg), [4commerce technologies AG](https://www.4commerce.de/), released under the MIT license

data/lib/midi-smtp-server/exceptions.rb

@@ -38,7 +38,7 @@ module MidiSmtpServer
       @smtpd_return_code = smtpd_return_code
       @smtpd_return_text = smtpd_return_text
       # call inherited constructor
-      super msg
+      super(msg)
     end
 
     def smtpd_result
@@ -52,7 +52,7 @@ module MidiSmtpServer
 
     def initialize(msg = nil)
       # call inherited constructor
-      super msg, 421, 'Service too busy or not available, closing transmission channel'
+      super(msg, 421, 'Service too busy or not available, closing transmission channel')
     end
 
   end
@@ -63,7 +63,7 @@ module MidiSmtpServer
 
     def initialize(msg = nil)
       # call inherited constructor
-      super msg, 450, 'Requested mail action not taken: mailbox unavailable'
+      super(msg, 450, 'Requested mail action not taken: mailbox unavailable')
     end
 
   end
@@ -73,7 +73,7 @@ module MidiSmtpServer
 
     def initialize(msg = nil)
       # call inherited constructor
-      super msg, 451, 'Requested action aborted: local error in processing'
+      super(msg, 451, 'Requested action aborted: local error in processing')
     end
 
   end
@@ -83,7 +83,7 @@ module MidiSmtpServer
 
     def initialize(msg = nil)
       # call inherited constructor
-      super msg, 452, 'Requested action not taken: insufficient system storage'
+      super(msg, 452, 'Requested action not taken: insufficient system storage')
     end
 
   end
@@ -94,7 +94,7 @@ module MidiSmtpServer
 
     def initialize(msg = nil)
       # call inherited constructor
-      super msg, 500, 'Syntax error, command unrecognised or error in parameters or arguments'
+      super(msg, 500, 'Syntax error, command unrecognised or error in parameters or arguments')
     end
 
   end
@@ -104,7 +104,7 @@ module MidiSmtpServer
 
     def initialize(msg = nil)
       # call inherited constructor
-      super msg, 501, 'Syntax error in parameters or arguments'
+      super(msg, 501, 'Syntax error in parameters or arguments')
     end
 
   end
@@ -114,7 +114,7 @@ module MidiSmtpServer
 
     def initialize(msg = nil)
       # call inherited constructor
-      super msg, 502, 'Command not implemented'
+      super(msg, 502, 'Command not implemented')
     end
 
   end
@@ -124,7 +124,7 @@ module MidiSmtpServer
 
     def initialize(msg = nil)
       # call inherited constructor
-      super msg, 503, 'Bad sequence of commands'
+      super(msg, 503, 'Bad sequence of commands')
     end
 
   end
@@ -134,7 +134,7 @@ module MidiSmtpServer
 
     def initialize(msg = nil)
       # call inherited constructor
-      super msg, 504, 'Command parameter not implemented'
+      super(msg, 504, 'Command parameter not implemented')
     end
 
   end
@@ -144,7 +144,7 @@ module MidiSmtpServer
 
     def initialize(msg = nil)
       # call inherited constructor
-      super msg, 521, 'Service does not accept mail'
+      super(msg, 521, 'Service does not accept mail')
     end
 
   end
@@ -155,7 +155,7 @@ module MidiSmtpServer
 
     def initialize(msg = nil)
       # call inherited constructor
-      super msg, 550, 'Requested action not taken: mailbox unavailable'
+      super(msg, 550, 'Requested action not taken: mailbox unavailable')
     end
 
   end
@@ -165,7 +165,7 @@ module MidiSmtpServer
 
     def initialize(msg = nil)
       # call inherited constructor
-      super msg, 552, 'Requested mail action aborted: exceeded storage allocation'
+      super(msg, 552, 'Requested mail action aborted: exceeded storage allocation')
     end
 
   end
@@ -175,7 +175,7 @@ module MidiSmtpServer
 
     def initialize(msg = nil)
       # call inherited constructor
-      super msg, 553, 'Requested action not taken: mailbox name not allowed'
+      super(msg, 553, 'Requested action not taken: mailbox name not allowed')
     end
 
   end
@@ -185,7 +185,7 @@ module MidiSmtpServer
 
     def initialize(msg = nil)
       # call inherited constructor
-      super msg, 554, 'Transaction failed'
+      super(msg, 554, 'Transaction failed')
     end
 
   end
@@ -197,7 +197,7 @@ module MidiSmtpServer
 
     def initialize(msg = nil)
       # call inherited constructor
-      super msg, 432, 'Password transition is needed'
+      super(msg, 432, 'Password transition is needed')
     end
 
   end
@@ -207,7 +207,7 @@ module MidiSmtpServer
 
     def initialize(msg = nil)
       # call inherited constructor
-      super msg, 454, 'Temporary authentication failure'
+      super(msg, 454, 'Temporary authentication failure')
     end
 
   end
@@ -217,7 +217,7 @@ module MidiSmtpServer
 
     def initialize(msg = nil)
       # call inherited constructor
-      super msg, 530, 'Authentication required'
+      super(msg, 530, 'Authentication required')
     end
 
   end
@@ -227,7 +227,7 @@ module MidiSmtpServer
 
     def initialize(msg = nil)
       # call inherited constructor
-      super msg, 534, 'Authentication mechanism is too weak'
+      super(msg, 534, 'Authentication mechanism is too weak')
     end
 
   end
@@ -237,7 +237,7 @@ module MidiSmtpServer
 
     def initialize(msg = nil)
       # call inherited constructor
-      super msg, 535, 'Authentication credentials invalid'
+      super(msg, 535, 'Authentication credentials invalid')
     end
 
   end
@@ -247,7 +247,7 @@ module MidiSmtpServer
 
     def initialize(msg = nil)
       # call inherited constructor
-      super msg, 538, 'Encryption required for requested authentication mechanism'
+      super(msg, 538, 'Encryption required for requested authentication mechanism')
     end
 
   end
@@ -259,7 +259,7 @@ module MidiSmtpServer
 
     def initialize(msg = nil)
       # call inherited constructor
-      super msg, 454, 'TLS not available'
+      super(msg, 454, 'TLS not available')
     end
 
   end
@@ -269,7 +269,7 @@ module MidiSmtpServer
 
     def initialize(msg = nil)
       # call inherited constructor
-      super msg, 530, 'Encryption required, must issue STARTTLS command first'
+      super(msg, 530, 'Encryption required, must issue STARTTLS command first')
     end
 
   end
@@ -281,7 +281,7 @@ module MidiSmtpServer
 
     def initialize(msg = nil)
       # call inherited constructor
-      super msg, 500, 'Bad input, PIPELINING is not allowed'
+      super(msg, 500, 'Bad input, PIPELINING is not allowed')
     end
 
   end
@@ -293,7 +293,7 @@ module MidiSmtpServer
 
     def initialize(msg = nil)
       # call inherited constructor
-      super msg, 500, 'Bad input, Lines must be terminated by CRLF sequence'
+      super(msg, 500, 'Bad input, Lines must be terminated by CRLF sequence')
     end
 
   end

data/lib/midi-smtp-server/version.rb

@@ -6,12 +6,12 @@ module MidiSmtpServer
   module VERSION
 
     MAJOR = 3
-    MINOR = 1
-    TINY = 2
+    MINOR = 3
+    TINY = 1
 
     STRING = [MAJOR, MINOR, TINY].compact.join('.')
 
-    DATE = '2023-05-06'
+    DATE = '2026-09-16'
 
   end
 

data/lib/midi-smtp-server.rb

@@ -2,6 +2,7 @@
 
 require 'logger'
 require 'socket'
+require 'io/wait'
 require 'resolv'
 require 'base64'
 
@@ -27,12 +28,15 @@ module MidiSmtpServer
   DEFAULT_CRLF_MODE = :CRLF_ENSURE
 
   # default values for IO operations
-  DEFAULT_IO_WAITREADABLE_SLEEP = 0.1
+  IO_WAIT_MODES = [:IO_WAIT_SLEEP, :IO_WAIT_EVENT].freeze
+  DEFAULT_IO_WAIT_MODE = :IO_WAIT_EVENT
+  DEFAULT_IO_WAIT_AVAILABLE = 0.1
   DEFAULT_IO_CMD_TIMEOUT = 30
   DEFAULT_IO_BUFFER_CHUNK_SIZE = 4 * 1024
   DEFAULT_IO_BUFFER_MAX_SIZE = 1 * 1024 * 1024
 
   # default value for SMTPD extensions support
+  DEFAULT_PROXY_EXTENSION_ENABLED = false
   DEFAULT_PIPELINING_EXTENSION_ENABLED = false
   DEFAULT_INTERNATIONALIZATION_EXTENSIONS_ENABLED = false
 
@@ -196,8 +200,10 @@ module MidiSmtpServer
     attr_reader :max_connections
     # CRLF handling based on conformity to RFC(2)822
     attr_reader :crlf_mode
-    # Time in seconds to sleep on IO::WaitReadable exception
-    attr_reader :io_waitreadable_sleep
+    # how to wait on IO::WaitReadable exception
+    attr_reader :io_wait_mode
+    # Time in fraction of a second to wait on IO::WaitReadable exception
+    attr_reader :io_wait_available
     # Maximum time in seconds to wait for a complete incoming data line, as a FixNum
     attr_reader :io_cmd_timeout
     # Bytes to read non-blocking from socket into buffer, as a FixNum
@@ -214,6 +220,8 @@ module MidiSmtpServer
     attr_reader :pipelining_extension
     # handle SMTP 8BITMIME and SMTPUTF8 extension
     attr_reader :internationalization_extensions
+    # handle PROXY connections
+    attr_reader :proxy_extension
 
     # logging object, may be overridden by special loggers like YELL or others
     attr_reader :logger
@@ -227,12 +235,14 @@ module MidiSmtpServer
     # +max_connections+:: maximum number of connections, this does limit the number of concurrent TCP connections (not set or nil => unlimited)
     # +crlf_mode+:: CRLF handling support (:CRLF_ENSURE [default], :CRLF_LEAVE, :CRLF_STRICT)
     # +do_dns_reverse_lookup+:: flag if this smtp server should do reverse DNS lookups on incoming connections
-    # +io_waitreadable_sleep+:: seconds to sleep in loop when no input data is available (DEFAULT_IO_WAITREADABLE_SLEEP)
+    # +io_wait_mode+:: how to wait when no input data is available (DEFAULT_IO_WAIT_MODE)
+    # +io_wait_available+:: fraction of a second to wait in loop when no input data is available (DEFAULT_IO_WAIT_AVAILABLE)
     # +io_cmd_timeout+:: time in seconds to wait until complete line of data is expected (DEFAULT_IO_CMD_TIMEOUT, nil => disabled test)
     # +io_buffer_chunk_size+:: size of chunks (bytes) to read non-blocking from socket (DEFAULT_IO_BUFFER_CHUNK_SIZE)
     # +io_buffer_max_size+:: max size of buffer (max line length) until \lf ist expected (DEFAULT_IO_BUFFER_MAX_SIZE, nil => disabled test)
     # +pipelining_extension+:: set to true for support of SMTP PIPELINING extension (DEFAULT_PIPELINING_EXTENSION_ENABLED)
     # +internationalization_extensions+:: set to true for support of SMTP 8BITMIME and SMTPUTF8 extensions (DEFAULT_INTERNATIONALIZATION_EXTENSIONS_ENABLED)
+    # +proxy_extension+:: set to true for supporting PROXY connections (DEFAULT_PROXY_EXTENSION_ENABLED)
     # +auth_mode+:: enable builtin authentication support (:AUTH_FORBIDDEN [default], :AUTH_OPTIONAL, :AUTH_REQUIRED)
     # +tls_mode+:: enable builtin TLS support (:TLS_FORBIDDEN [default], :TLS_OPTIONAL, :TLS_REQUIRED)
     # +tls_cert_path+:: path to tls certificate chain file
@@ -251,12 +261,15 @@ module MidiSmtpServer
       max_connections: nil,
       crlf_mode: nil,
       do_dns_reverse_lookup: nil,
-      io_waitreadable_sleep: nil,
+      io_wait_mode: nil,
+      io_wait_available: nil,
+      io_waitreadable_sleep: nil, # deprecated, but for compatibility
       io_cmd_timeout: nil,
       io_buffer_chunk_size: nil,
       io_buffer_max_size: nil,
       pipelining_extension: nil,
       internationalization_extensions: nil,
+      proxy_extension: nil,
       auth_mode: nil,
       tls_mode: nil,
       tls_cert_path: nil,
@@ -338,7 +351,7 @@ module MidiSmtpServer
             # test for all local valid ipv4 and ipv6 ip_addresses
             # check question on stackoverflow for details
             # https://stackoverflow.com/questions/59770803/identify-all-relevant-ip-addresses-from-ruby-socket-ip-address-list
-            ip_addresses_for_host << a.ip_address if \
+            ip_addresses_for_host << a.ip_address if
               (a.ipv4? &&
                 (a.ipv4_loopback? || a.ipv4_private? ||
                  !(a.ipv4_loopback? || a.ipv4_private? || a.ipv4_multicast?)
@@ -386,10 +399,21 @@ module MidiSmtpServer
       # always prevent auto resolving hostnames to prevent a delay on socket connect
       BasicSocket.do_not_reverse_lookup = true
       # do reverse lookups manually if enabled by io.addr and io.peeraddr
+      # rubocop: disable-next Style/RedundantCondition
       @do_dns_reverse_lookup = do_dns_reverse_lookup.nil? ? true : do_dns_reverse_lookup
 
+      # deprecated compatibility
+      raise 'Not allowed to use io_wait_available and deprecated io_waitreadable_sleep at the same time!' unless io_waitreadable_sleep.nil? || io_wait_available.nil?
+      unless io_waitreadable_sleep.nil?
+        io_wait_available = io_waitreadable_sleep
+        io_wait_mode = :IO_WAIT_SLEEP
+        @logger_protected.warn('Deprecated: "io_waitreadable_sleep" was replaced! Please use "io_wait_available" and "io_wait_mode" instead.')
+      end
       # io and buffer settings
-      @io_waitreadable_sleep = io_waitreadable_sleep.nil? ? DEFAULT_IO_WAITREADABLE_SLEEP : io_waitreadable_sleep
+      @io_wait_mode = io_wait_mode.nil? ? DEFAULT_IO_WAIT_MODE : io_wait_mode
+      raise "Unknown io wait mode #{@io_wait_mode} was given!" unless IO_WAIT_MODES.include?(@io_wait_mode)
+      @io_wait_available = io_wait_available.nil? ? DEFAULT_IO_WAIT_AVAILABLE : io_wait_available
+      raise 'Value of time must be positive (io_wait_available)' unless @io_wait_available.positive?
       @io_cmd_timeout = io_cmd_timeout.nil? ? DEFAULT_IO_CMD_TIMEOUT : io_cmd_timeout
       @io_buffer_chunk_size = io_buffer_chunk_size.nil? ? DEFAULT_IO_BUFFER_CHUNK_SIZE : io_buffer_chunk_size
       @io_buffer_max_size = io_buffer_max_size.nil? ? DEFAULT_IO_BUFFER_MAX_SIZE : io_buffer_max_size
@@ -397,6 +421,8 @@ module MidiSmtpServer
       # smtp extensions
       @pipelining_extension = pipelining_extension.nil? ? DEFAULT_PIPELINING_EXTENSION_ENABLED : pipelining_extension
       @internationalization_extensions = internationalization_extensions.nil? ? DEFAULT_INTERNATIONALIZATION_EXTENSIONS_ENABLED : internationalization_extensions
+      @proxy_extension = proxy_extension.nil? ? DEFAULT_PROXY_EXTENSION_ENABLED : proxy_extension
+      require 'ipaddr' if @proxy_extension
 
       # check for authentication
       @auth_mode = auth_mode.nil? ? DEFAULT_AUTH_MODE : auth_mode
@@ -482,6 +508,13 @@ module MidiSmtpServer
     # the value is not allowed to return CR nor LF chars and will be stripped
     def on_helo_event(ctx, helo_data) end
 
+    # event on PROXY
+    # you may raise an exception if you want to block some addresses
+    # you also may change or add any value of the hash:
+    # {proto, source_ip, source_host, source_port, dest_ip, dest_host, dest_port}
+    # a returned value hash is set as ctx[:server][:proxy]
+    def on_proxy_event(ctx, proxy_data) end
+
     # check the authentication on AUTH
     # if any value returned, that will be used for ongoing processing
     # otherwise the original value will be used for authorization_id
@@ -755,10 +788,25 @@ module MidiSmtpServer
                 io_buffer_line_lf = io_buffer.index("\n")
               end
 
-            # ignore exception when no input data is available yet
+            # handle no input data is available yet
             rescue IO::WaitReadable
-              # but wait a few moment to slow down system utilization
-              sleep @io_waitreadable_sleep
+              if @io_wait_mode == :IO_WAIT_SLEEP
+                # reduce the processing speed and thereby the system
+                # utilization by sleeping the configured time
+                sleep @io_wait_available
+              else
+                # block on the underlying socket until new data has arrived,
+                # but wake up at least after wait time so that the loop
+                # keeps checking shutdown? and io_cmd_timeout
+                # (io.to_io resolves the plain socket behind an
+                # OpenSSL::SSL::SSLSocket, otherwise wait_readable is not defined
+                io.to_io.wait_readable(@io_wait_available)
+              end
+
+            # during TLS (re)negotiation a read may require the socket
+            # to become writable first. this always waits by event
+            rescue IO::WaitWritable
+              io.to_io.wait_writable(@io_wait_available)
             end
 
             # check if io_buffer is filled and contains already a line-feed
@@ -772,7 +820,7 @@ module MidiSmtpServer
               # process commands and handle special SmtpdExceptions
               begin
                 # check for pipelining extension or violation
-                raise Smtpd500PipeliningException unless @pipelining_extension || !io_buffer_line_lf || (session[:cmd_sequence] == :CMD_DATA)
+                raise Smtpd500PipeliningException unless !io_buffer_line_lf || @pipelining_extension || (proxy_extension && (session[:cmd_sequence] == :CMD_HELO)) || (session[:cmd_sequence] == :CMD_DATA)
 
                 # handle input line based on @crlf_mode
                 case crlf_mode
@@ -932,8 +980,8 @@ module MidiSmtpServer
             # check whether to answer as HELO or EHLO
             case line
               when (/^EHLO/i)
-                # rubocop:disable Style/StringConcatenation
                 # reply supported extensions
+                # rubocop: disable-next Style/StringConcatenation
                 return "250-#{session[:ctx][:server][:helo_response].to_s.strip}\r\n" +
                        # respond with 8BITMIME extension
                        (@internationalization_extensions ? "250-8BITMIME\r\n" : '') +
@@ -946,12 +994,93 @@ module MidiSmtpServer
                        # respond with STARTTLS if available and not already enabled
                        (@encrypt_mode == :TLS_FORBIDDEN || encrypted?(session[:ctx]) ? '' : "250-STARTTLS\r\n") +
                        '250 OK'
-                # rubocop:enable all
               else
                 # reply ok only
                 return "250 OK #{session[:ctx][:server][:helo_response].to_s.strip}".strip
             end
 
+          when @proxy_extension && (/^PROXY(\s+)/i)
+            # PROXY
+            # 250 Requested mail action okay, completed
+            # 421 <domain> Service not available, closing transmission channel
+            # 500 Syntax error, command unrecognised
+            # 501 Syntax error in parameters or arguments
+            # ---------
+            # Documentation at https://github.com/haproxy/haproxy/blob/master/doc/proxy-protocol.txt
+            # syntax
+            # PROXY PROTO source-ip dest-ip source-port dest-port
+            # supported commands:
+            # PROXY TCP4 255.255.255.255 255.255.255.255 65535 65535
+            # PROXY TCP6 ffff:f...f:ffff ffff:f...f:ffff 65535 65535
+            # PROXY UNKNOWN
+            # PROXY UNKNOWN ffff:f...f:ffff ffff:f...f:ffff 65535 65535
+            # ---------
+            # check valid command sequence
+            raise Smtpd503Exception if session[:cmd_sequence] != :CMD_HELO
+            # check valid command
+            raise Smtpd421Exception, 'Abort connection while illegal PROXY command!' unless line.match?(/^PROXY(\s+)(UNKNOWN(|(\s+).*)|TCP(4|6)(\s+)([0-9a-f.:]+)(\s+)([0-9a-f.:]+)(\s+)([0-9]+)(\s+)([0-9]+)(\s*))$/i)
+            # check command usage is allowed only once
+            raise Smtpd421Exception, 'Abort connection while PROXY already set!' if session[:ctx][:server][:proxy]
+            # get values from proxy command
+            cmd_data = line.gsub(/^PROXY\ /i, '').strip.gsub(/\s+/, ' ').split
+            # create an empty hash to inspect by event
+            proxy_data = {
+              proto: cmd_data[0].upcase,
+              source_ip: nil,
+              source_host: nil,
+              source_port: nil,
+              dest_ip: nil,
+              dest_host: nil,
+              dest_port: nil
+            }
+            # test proto
+            unless proxy_data[:proto] == 'UNKNOWN'
+              begin
+                # try to build valid addresses from given strings
+                proxy_data[:source_ip] = IPAddr.new(cmd_data[1])
+                proxy_data[:source_port] = cmd_data[3].to_i
+                proxy_data[:dest_ip] = IPAddr.new(cmd_data[2])
+                proxy_data[:dest_port] = cmd_data[4].to_i
+                # check that given addresses correct by type
+                if proxy_data[:proto] == 'TCP4'
+                  raise unless proxy_data[:source_ip].ipv4?
+                  raise unless proxy_data[:dest_ip].ipv4?
+                else
+                  raise unless proxy_data[:source_ip].ipv6?
+                  raise unless proxy_data[:dest_ip].ipv6?
+                end
+                # check that ports within valid ranges
+                raise unless proxy_data[:source_port].between?(1, 65_535)
+                raise unless proxy_data[:dest_port].between?(1, 65_535)
+
+                # update hash to inspect by event
+                # normalize ip addresses
+                proxy_data[:source_ip] = proxy_data[:source_ip].to_s
+                proxy_data[:source_host] = proxy_data[:source_ip]
+                proxy_data[:dest_ip] = proxy_data[:dest_ip].to_s
+                proxy_data[:dest_host] = proxy_data[:dest_ip]
+
+              rescue StandardError
+                # change exception into Smtpd exception and drop connection
+                raise Smtpd421Exception, 'Abort connection for unsupported PROXY parameters!'
+              end
+            end
+
+            # call event to handle data
+            return_value = on_proxy_event(session[:ctx], proxy_data)
+            if return_value
+              # overwrite data with returned value
+              proxy_data = return_value
+            end
+            # if no error raised, append to server hash
+            session[:ctx][:server][:proxy] = proxy_data
+
+            # reply nothing
+            # otherwise on buffering clients or enabled feature pipelining
+            # the original client will receive unhandleable responses
+            # and gets interrupted
+            return ''
+
           when /^STARTTLS\s*$/i
             # STARTTLS
             # 220 Ready to start TLS
@@ -1206,7 +1335,7 @@ module MidiSmtpServer
         # If we are in date mode then ...
 
         # call event to signal beginning of message data transfer
-        on_message_data_start_event(session[:ctx]) unless session[:ctx][:message][:data][0]
+        on_message_data_start_event(session[:ctx]) if session[:ctx][:message][:data].empty?
 
         # ... and the entire new message data (line) does NOT consists
         # solely of a period (.) on a line by itself then we are being
@@ -1294,6 +1423,7 @@ module MidiSmtpServer
             remote_host: +'',
             remote_ip: +'',
             remote_port: +'',
+            proxy: nil,
             helo: +'',
             helo_response: +'',
             connected: +'',

metadata

@@ -1,15 +1,42 @@
 --- !ruby/object:Gem::Specification
 name: midi-smtp-server
 version: !ruby/object:Gem::Version
-  version: 3.1.2
+  version: 3.3.1
 platform: ruby
 authors:
 - Tom Freudenberg
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-06 00:00:00.000000000 Z
-dependencies: []
+date: 2026-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
 description: MidiSmtpServer is the highly customizable ruby SMTP-Server and SMTP-Service
   library with builtin support for AUTH and SSL/STARTTLS, 8BITMIME and SMTPUTF8, IPv4
   and IPv6 and additional features.
@@ -34,9 +61,9 @@ metadata:
   source_code_uri: https://github.com/4commerce-technologies-AG/midi-smtp-server
   changelog_uri: https://github.com/4commerce-technologies-AG/midi-smtp-server#changes-and-updates
   bug_tracker_uri: https://github.com/4commerce-technologies-AG/midi-smtp-server/issues
-  documentation_uri: https://www.rubydoc.info/gems/midi-smtp-server/3.1.2
+  documentation_uri: https://www.rubydoc.info/gems/midi-smtp-server/3.3.1
   wiki_uri: https://midi-smtp-server.readthedocs.io/
-post_install_message:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -44,15 +71,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: MidiSmtpServer Class
 test_files: []