Add Exim and Qmail support to Action Mailbox

1 files changed, 18 insertions, 12 deletions

diff --git a/actionmailbox/app/controllers/action_mailbox/ingresses/postfix/inbound_emails_controller.rb b/actionmailbox/app/controllers/action_mailbox/ingresses/relay/inbound_emails_controller.rb
index c0d5002a12..2d91c968c8 100644
--- a/actionmailbox/app/controllers/action_mailbox/ingresses/postfix/inbound_emails_controller.rb
+++ b/actionmailbox/app/controllers/action_mailbox/ingresses/relay/inbound_emails_controller.rb
@@ -1,31 +1,31 @@
 # frozen_string_literal: true
 
 module ActionMailbox
-  # Ingests inbound emails relayed from Postfix.
+  # Ingests inbound emails relayed from an SMTP server.
   #
   # Authenticates requests using HTTP basic access authentication. The username is always +actionmailbox+, and the
   # password is read from the application's encrypted credentials or an environment variable. See the Usage section below.
   #
   # Note that basic authentication is insecure over unencrypted HTTP. An attacker that intercepts cleartext requests to
-  # the Postfix ingress can learn its password. You should only use the Postfix ingress over HTTPS.
+  # the ingress can learn its password. You should only use this ingress over HTTPS.
   #
   # Returns:
   #
   # - <tt>204 No Content</tt> if an inbound email is successfully recorded and enqueued for routing to the appropriate mailbox
   # - <tt>401 Unauthorized</tt> if the request could not be authenticated
-  # - <tt>404 Not Found</tt> if Action Mailbox is not configured to accept inbound emails from Postfix
+  # - <tt>404 Not Found</tt> if Action Mailbox is not configured to accept inbound emails relayed from an SMTP server
   # - <tt>415 Unsupported Media Type</tt> if the request does not contain an RFC 822 message
   # - <tt>500 Server Error</tt> if the ingress password is not configured, or if one of the Active Record database,
   #   the Active Storage service, or the Active Job backend is misconfigured or unavailable
   #
   # == Usage
   #
-  # 1. Tell Action Mailbox to accept emails from Postfix:
+  # 1. Tell Action Mailbox to accept emails from an SMTP relay:
   #
   #        # config/environments/production.rb
-  #        config.action_mailbox.ingress = :postfix
+  #        config.action_mailbox.ingress = :relay
   #
-  # 2. Generate a strong password that Action Mailbox can use to authenticate requests to the Postfix ingress.
+  # 2. Generate a strong password that Action Mailbox can use to authenticate requests to the ingress.
   #
   #    Use <tt>rails credentials:edit</tt> to add the password to your application's encrypted credentials under
   #    +action_mailbox.ingress_password+, where Action Mailbox will automatically find it:
@@ -35,14 +35,20 @@ module ActionMailbox
   #
   #    Alternatively, provide the password in the +RAILS_INBOUND_EMAIL_PASSWORD+ environment variable.
   #
-  # 3. {Configure Postfix}[https://serverfault.com/questions/258469/how-to-configure-postfix-to-pipe-all-incoming-email-to-a-script]
-  #    to pipe inbound emails to <tt>bin/rails action_mailbox:ingress:postfix</tt>, providing the +URL+ of the Postfix
-  #    ingress and the +INGRESS_PASSWORD+ you previously generated.
+  # 3. Configure your SMTP server to pipe inbound emails to the appropriate ingress command, providing the +URL+ of the
+  #    relay ingress and the +INGRESS_PASSWORD+ you previously generated.
   #
-  #    If your application lived at <tt>https://example.com</tt>, the full command would look like this:
+  #    If your application lives at <tt>https://example.com</tt>, you would configure the Postfix SMTP server to pipe
+  #    inbound emails to the following command:
   #
-  #        URL=https://example.com/rails/action_mailbox/postfix/inbound_emails INGRESS_PASSWORD=... bin/rails action_mailbox:ingress:postfix
-  class Ingresses::Postfix::InboundEmailsController < ActionMailbox::BaseController
+  #        bin/rails action_mailbox:ingress:postfix URL=https://example.com/rails/action_mailbox/postfix/inbound_emails INGRESS_PASSWORD=...
+  #
+  #    Built-in ingress commands are available for these popular SMTP servers:
+  #
+  #    - Exim (<tt>bin/rails action_mailbox:ingress:exim)
+  #    - Postfix (<tt>bin/rails action_mailbox:ingress:postfix)
+  #    - Qmail (<tt>bin/rails action_mailbox:ingress:qmail)
+  class Ingresses::Relay::InboundEmailsController < ActionMailbox::BaseController
     before_action :authenticate_by_password, :require_valid_rfc822_message
 
     def create