actionmailbox 0.1.0 → 6.0.0.beta1

data/app/models/action_mailbox/inbound_email/routable.rb

@@ -1,7 +1,9 @@
-# A newly received `InboundEmail` will not be routed synchronously as part of ingress controller's receival.
-# Instead, the routing will be done asynchronously, using a `RoutingJob`, to ensure maximum parallel capacity.
+# frozen_string_literal: true
+
+# A newly received +InboundEmail+ will not be routed synchronously as part of ingress controller's receival.
+# Instead, the routing will be done asynchronously, using a +RoutingJob+, to ensure maximum parallel capacity.
 #
-# By default, all newly created `InboundEmail` records that have the status of `pending`, which is the default,
+# By default, all newly created +InboundEmail+ records that have the status of +pending+, which is the default,
 # will be scheduled for automatic, deferred routing.
 module ActionMailbox::InboundEmail::Routable
   extend ActiveSupport::Concern
@@ -10,12 +12,12 @@ module ActionMailbox::InboundEmail::Routable
     after_create_commit :route_later, if: :pending?
   end
 
-  # Enqueue a `RoutingJob` for this `InboundEmail`.
+  # Enqueue a +RoutingJob+ for this +InboundEmail+.
   def route_later
     ActionMailbox::RoutingJob.perform_later self
   end
 
-  # Route this `InboundEmail` using the routing rules declared on the `ApplicationMailbox`.
+  # Route this +InboundEmail+ using the routing rules declared on the +ApplicationMailbox+.
   def route
     ApplicationMailbox.route self
   end

data/app/views/rails/conductor/action_mailbox/inbound_emails/new.html.erb

@@ -38,5 +38,10 @@
     <%= form.text_area :body, size: "40x20" %>
   </div>
 
+  <div>
+    <%= form.label :attachments, "Attachments" %><br>
+    <%= form.file_field :attachments, multiple: true %>
+  </div>
+
   <%= form.submit "Deliver inbound email" %>
 <% end %>

data/config/routes.rb

@@ -4,7 +4,8 @@ Rails.application.routes.draw do
   scope "/rails/action_mailbox", module: "action_mailbox/ingresses" do
     post "/amazon/inbound_emails"   => "amazon/inbound_emails#create",   as: :rails_amazon_inbound_emails
     post "/mandrill/inbound_emails" => "mandrill/inbound_emails#create", as: :rails_mandrill_inbound_emails
-    post "/postfix/inbound_emails"  => "postfix/inbound_emails#create",  as: :rails_postfix_inbound_emails
+    post "/postmark/inbound_emails" => "postmark/inbound_emails#create", as: :rails_postmark_inbound_emails
+    post "/relay/inbound_emails"    => "relay/inbound_emails#create",    as: :rails_relay_inbound_emails
     post "/sendgrid/inbound_emails" => "sendgrid/inbound_emails#create", as: :rails_sendgrid_inbound_emails
 
     # Mailgun requires that a webhook's URL end in 'mime' for it to receive the raw contents of emails.

data/db/migrate/20180917164000_create_action_mailbox_tables.rb

@@ -1,11 +1,17 @@
-class CreateActionMailboxTables < ActiveRecord::Migration[5.2]
+class CreateActionMailboxTables < ActiveRecord::Migration[6.0]
   def change
     create_table :action_mailbox_inbound_emails do |t|
       t.integer :status, default: 0, null: false
-      t.string  :message_id
+      t.string  :message_id, null: false
+      t.string  :message_checksum, null: false
 
-      t.datetime :created_at, precision: 6
-      t.datetime :updated_at, precision: 6
+      if supports_datetime_with_precision?
+        t.timestamps precision: 6
+      else
+        t.timestamps
+      end
+
+      t.index [ :message_id, :message_checksum ], name: "index_action_mailbox_inbound_emails_uniqueness", unique: true
     end
   end
 end

data/lib/action_mailbox.rb

@@ -1,4 +1,5 @@
-require "action_mailbox/engine"
+# frozen_string_literal: true
+
 require "action_mailbox/mail_ext"
 
 module ActionMailbox

data/lib/action_mailbox/base.rb

@@ -1,111 +1,118 @@
+# frozen_string_literal: true
+
 require "active_support/rescuable"
 
 require "action_mailbox/callbacks"
 require "action_mailbox/routing"
 
-# The base class for all application mailboxes. Not intended to be inherited from directly. Inherit from
-# `ApplicationMailbox` instead, as that's where the app-specific routing is configured. This routing
-# is specified in the following ways:
-#
-#   class ApplicationMailbox < ActionMailbox::Base
-#     # Any of the recipients of the mail (whether to, cc, bcc) are matched against the regexp.
-#     route /^replies@/i => :replies
-#
-#     # Any of the recipients of the mail (whether to, cc, bcc) needs to be an exact match for the string.
-#     route "help@example.com" => :help
-#
-#     # Any callable (proc, lambda, etc) object is passed the inbound_email record and is a match if true.
-#     route ->(inbound_email) { inbound_email.mail.to.size > 2 } => :multiple_recipients
-#
-#     # Any object responding to #match? is called with the inbound_email record as an argument. Match if true.
-#     route CustomAddress.new => :custom
-#
-#     # Any inbound_email that has not been already matched will be sent to the BackstopMailbox.
-#     route :all => :backstop
-#   end
-#
-# Application mailboxes need to overwrite the `#process` method, which is invoked by the framework after
-# callbacks have been run. The callbacks available are: `before_processing`, `after_processing`, and
-# `around_processing`. The primary use case is ensure certain preconditions to processing are fulfilled
-# using `before_processing` callbacks.
-#
-# If a precondition fails to be met, you can halt the processing using the `#bounced!` method, 
-# which will silently prevent any further processing, but not actually send out any bounce notice. You
-# can also pair this behavior with the invocation of an Action Mailer class responsible for sending out
-# an actual bounce email. This is done using the `#bounce_with` method, which takes the mail object returned
-# by an Action Mailer method, like so:
-#
-#   class ForwardsMailbox < ApplicationMailbox
-#     before_processing :ensure_sender_is_a_user
-#
-#     private
-#       def ensure_sender_is_a_user
-#         unless User.exist?(email_address: mail.from)
-#           bounce_with UserRequiredMailer.missing(inbound_email)
-#         end
-#       end
-#   end
-#
-# During the processing of the inbound email, the status will be tracked. Before processing begins,
-# the email will normally have the `pending` status. Once processing begins, just before callbacks 
-# and the `#process` method is called, the status is changed to `processing`. If processing is allowed to
-# complete, the status is changed to `delivered`. If a bounce is triggered, then `bounced`. If an unhandled
-# exception is bubbled up, then `failed`.
-#
-# Exceptions can be handled at the class level using the familiar `Rescuable` approach:
-#
-#   class ForwardsMailbox < ApplicationMailbox
-#    rescue_from(ApplicationSpecificVerificationError) { bounced! }
-#   end
-class ActionMailbox::Base
-  include ActiveSupport::Rescuable
-  include ActionMailbox::Callbacks, ActionMailbox::Routing
+module ActionMailbox
+  # The base class for all application mailboxes. Not intended to be inherited from directly. Inherit from
+  # +ApplicationMailbox+ instead, as that's where the app-specific routing is configured. This routing
+  # is specified in the following ways:
+  #
+  #   class ApplicationMailbox < ActionMailbox::Base
+  #     # Any of the recipients of the mail (whether to, cc, bcc) are matched against the regexp.
+  #     routing /^replies@/i => :replies
+  #
+  #     # Any of the recipients of the mail (whether to, cc, bcc) needs to be an exact match for the string.
+  #     routing "help@example.com" => :help
+  #
+  #     # Any callable (proc, lambda, etc) object is passed the inbound_email record and is a match if true.
+  #     routing ->(inbound_email) { inbound_email.mail.to.size > 2 } => :multiple_recipients
+  #
+  #     # Any object responding to #match? is called with the inbound_email record as an argument. Match if true.
+  #     routing CustomAddress.new => :custom
+  #
+  #     # Any inbound_email that has not been already matched will be sent to the BackstopMailbox.
+  #     routing :all => :backstop
+  #   end
+  #
+  # Application mailboxes need to overwrite the +#process+ method, which is invoked by the framework after
+  # callbacks have been run. The callbacks available are: +before_processing+, +after_processing+, and
+  # +around_processing+. The primary use case is ensure certain preconditions to processing are fulfilled
+  # using +before_processing+ callbacks.
+  #
+  # If a precondition fails to be met, you can halt the processing using the +#bounced!+ method,
+  # which will silently prevent any further processing, but not actually send out any bounce notice. You
+  # can also pair this behavior with the invocation of an Action Mailer class responsible for sending out
+  # an actual bounce email. This is done using the +#bounce_with+ method, which takes the mail object returned
+  # by an Action Mailer method, like so:
+  #
+  #   class ForwardsMailbox < ApplicationMailbox
+  #     before_processing :ensure_sender_is_a_user
+  #
+  #     private
+  #       def ensure_sender_is_a_user
+  #         unless User.exist?(email_address: mail.from)
+  #           bounce_with UserRequiredMailer.missing(inbound_email)
+  #         end
+  #       end
+  #   end
+  #
+  # During the processing of the inbound email, the status will be tracked. Before processing begins,
+  # the email will normally have the +pending+ status. Once processing begins, just before callbacks
+  # and the +#process+ method is called, the status is changed to +processing+. If processing is allowed to
+  # complete, the status is changed to +delivered+. If a bounce is triggered, then +bounced+. If an unhandled
+  # exception is bubbled up, then +failed+.
+  #
+  # Exceptions can be handled at the class level using the familiar +Rescuable+ approach:
+  #
+  #   class ForwardsMailbox < ApplicationMailbox
+  #     rescue_from(ApplicationSpecificVerificationError) { bounced! }
+  #   end
+  class Base
+    include ActiveSupport::Rescuable
+    include ActionMailbox::Callbacks, ActionMailbox::Routing
 
-  attr_reader :inbound_email
-  delegate :mail, :delivered!, :bounced!, to: :inbound_email
+    attr_reader :inbound_email
+    delegate :mail, :delivered!, :bounced!, to: :inbound_email
 
-  delegate :logger, to: ActionMailbox
+    delegate :logger, to: ActionMailbox
 
-  def self.receive(inbound_email)
-    new(inbound_email).perform_processing
-  end
+    def self.receive(inbound_email)
+      new(inbound_email).perform_processing
+    end
 
-  def initialize(inbound_email)
-    @inbound_email = inbound_email
-  end
+    def initialize(inbound_email)
+      @inbound_email = inbound_email
+    end
 
-  def perform_processing
-    track_status_of_inbound_email do
-      run_callbacks :process do
-        process
+    def perform_processing #:nodoc:
+      track_status_of_inbound_email do
+        run_callbacks :process do
+          process
+        end
       end
+    rescue => exception
+      # TODO: Include a reference to the inbound_email in the exception raised so error handling becomes easier
+      rescue_with_handler(exception) || raise
     end
-  rescue => exception
-    # TODO: Include a reference to the inbound_email in the exception raised so error handling becomes easier
-    rescue_with_handler(exception) || raise
-  end
-
-  def process
-    # Overwrite in subclasses
-  end
 
-  def finished_processing?
-    inbound_email.delivered? || inbound_email.bounced?
-  end
+    def process
+      # Overwrite in subclasses
+    end
 
+    def finished_processing? #:nodoc:
+      inbound_email.delivered? || inbound_email.bounced?
+    end
 
-  def bounce_with(message)
-    inbound_email.bounced!
-    message.deliver_later
-  end
 
-  private
-    def track_status_of_inbound_email
-      inbound_email.processing!
-      yield
-      inbound_email.delivered! unless inbound_email.bounced?
-    rescue
-      inbound_email.failed!
-      raise
+    # Enqueues the given +message+ for delivery and changes the inbound email's status to +:bounced+.
+    def bounce_with(message)
+      inbound_email.bounced!
+      message.deliver_later
     end
+
+    private
+      def track_status_of_inbound_email
+        inbound_email.processing!
+        yield
+        inbound_email.delivered! unless inbound_email.bounced?
+      rescue
+        inbound_email.failed!
+        raise
+      end
+  end
 end
+
+ActiveSupport.run_load_hooks :action_mailbox, ActionMailbox::Base

data/lib/action_mailbox/callbacks.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "active_support/callbacks"
 
 module ActionMailbox
@@ -15,7 +17,7 @@ module ActionMailbox
       define_callbacks :process, terminator: TERMINATOR, skip_after_callbacks_if_terminated: true
     end
 
-    module ClassMethods
+    class_methods do
       def before_processing(*methods, &block)
         set_callback(:process, :before, *methods, &block)
       end

data/lib/action_mailbox/engine.rb

@@ -1,4 +1,12 @@
-require "rails/engine"
+# frozen_string_literal: true
+
+require "rails"
+require "action_controller/railtie"
+require "active_job/railtie"
+require "active_record/railtie"
+require "active_storage/engine"
+
+require "action_mailbox"
 
 module ActionMailbox
   class Engine < Rails::Engine

data/lib/action_mailbox/gem_version.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ActionMailbox
+  # Returns the currently-loaded version of Action Mailbox as a <tt>Gem::Version</tt>.
+  def self.gem_version
+    Gem::Version.new VERSION::STRING
+  end
+
+  module VERSION
+    MAJOR = 6
+    MINOR = 0
+    TINY  = 0
+    PRE   = "beta1"
+
+    STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
+  end
+end

data/lib/action_mailbox/mail_ext.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "mail"
 
 # The hope is to upstream most of these basic additions to the Mail gem's Mail object. But until then, here they lay!

data/lib/action_mailbox/mail_ext/address_equality.rb

@@ -1,5 +1,9 @@
-class Mail::Address
-  def ==(other_address)
-    other_address.is_a?(Mail::Address) && to_s == other_address.to_s
+# frozen_string_literal: true
+
+module Mail
+  class Address
+    def ==(other_address)
+      other_address.is_a?(Mail::Address) && to_s == other_address.to_s
+    end
   end
 end

data/lib/action_mailbox/mail_ext/address_wrapping.rb

@@ -1,5 +1,9 @@
-class Mail::Address
-  def self.wrap(address)
-    address.is_a?(Mail::Address) ? address : Mail::Address.new(address)
+# frozen_string_literal: true
+
+module Mail
+  class Address
+    def self.wrap(address)
+      address.is_a?(Mail::Address) ? address : Mail::Address.new(address)
+    end
   end
 end

data/lib/action_mailbox/mail_ext/addresses.rb

@@ -1,25 +1,29 @@
-class Mail::Message
-  def from_address
-    header[:from]&.address_list&.addresses&.first
-  end
+# frozen_string_literal: true
 
-  def recipients_addresses
-    to_addresses + cc_addresses + bcc_addresses + x_original_to_addresses
-  end
+module Mail
+  class Message
+    def from_address
+      header[:from]&.address_list&.addresses&.first
+    end
 
-  def to_addresses
-    Array(header[:to]&.address_list&.addresses)
-  end
+    def recipients_addresses
+      to_addresses + cc_addresses + bcc_addresses + x_original_to_addresses
+    end
 
-  def cc_addresses
-    Array(header[:cc]&.address_list&.addresses)
-  end
+    def to_addresses
+      Array(header[:to]&.address_list&.addresses)
+    end
 
-  def bcc_addresses
-    Array(header[:bcc]&.address_list&.addresses)
-  end
+    def cc_addresses
+      Array(header[:cc]&.address_list&.addresses)
+    end
+
+    def bcc_addresses
+      Array(header[:bcc]&.address_list&.addresses)
+    end
 
-  def x_original_to_addresses
-    Array(header[:x_original_to]).collect { |header| Mail::Address.new header.to_s }
+    def x_original_to_addresses
+      Array(header[:x_original_to]).collect { |header| Mail::Address.new header.to_s }
+    end
   end
 end

data/lib/action_mailbox/mail_ext/from_source.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mail
   def self.from_source(source)
     Mail.new Mail::Utilities.binary_unsafe_to_crlf(source.to_s)

data/lib/action_mailbox/mail_ext/recipients.rb

@@ -1,5 +1,9 @@
-class Mail::Message
-  def recipients
-    Array(to) + Array(cc) + Array(bcc) + Array(header[:x_original_to]).map(&:to_s)
+# frozen_string_literal: true
+
+module Mail
+  class Message
+    def recipients
+      Array(to) + Array(cc) + Array(bcc) + Array(header[:x_original_to]).map(&:to_s)
+    end
   end
 end

data/lib/action_mailbox/{postfix_relayer.rb → relayer.rb}

@@ -5,19 +5,27 @@ require "net/http"
 require "uri"
 
 module ActionMailbox
-  class PostfixRelayer
-    class Result < Struct.new(:output)
+  class Relayer
+    class Result < Struct.new(:status_code, :message)
       def success?
         !failure?
       end
 
       def failure?
-        output.match?(/\A[45]\.\d{1,3}\.\d{1,3}(\s|\z)/)
+        transient_failure? || permanent_failure?
+      end
+
+      def transient_failure?
+        status_code.start_with?("4.")
+      end
+
+      def permanent_failure?
+        status_code.start_with?("5.")
       end
     end
 
     CONTENT_TYPE = "message/rfc822"
-    USER_AGENT   = "Action Mailbox Postfix relayer v#{ActionMailbox::VERSION}"
+    USER_AGENT   = "Action Mailbox relayer v#{ActionMailbox.version}"
 
     attr_reader :uri, :username, :password
 
@@ -28,18 +36,18 @@ module ActionMailbox
     def relay(source)
       case response = post(source)
       when Net::HTTPSuccess
-        Result.new "2.0.0 Successfully relayed message to Postfix ingress"
+        Result.new "2.0.0", "Successfully relayed message to ingress"
       when Net::HTTPUnauthorized
-        Result.new "4.7.0 Invalid credentials for Postfix ingress"
+        Result.new "4.7.0", "Invalid credentials for ingress"
       else
-        Result.new "4.0.0 HTTP #{response.code}"
+        Result.new "4.0.0", "HTTP #{response.code}"
       end
     rescue IOError, SocketError, SystemCallError => error
-      Result.new "4.4.2 Network error relaying to Postfix ingress: #{error.message}"
+      Result.new "4.4.2", "Network error relaying to ingress: #{error.message}"
     rescue Timeout::Error
-      Result.new "4.4.2 Timed out relaying to Postfix ingress"
+      Result.new "4.4.2", "Timed out relaying to ingress"
     rescue => error
-      Result.new "4.0.0 Error relaying to Postfix ingress: #{error.message}"
+      Result.new "4.0.0", "Error relaying to ingress: #{error.message}"
     end
 
     private