mailbin 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 97c16b480b7973ca30ed864cceaa479e79457a4d8a6e35bec60a139e00233bf7
+  data.tar.gz: 704b7096ef4eaee23689ea7e5e4a1e9b46f61d3feacfed545ff9a3fa7da3b641
+SHA512:
+  metadata.gz: c77e8c567e0244ac54027311adef7e0ccc9dda560405e6a188a85ff7c3d2876e5fcec9d59c317f6b924bf6a8109cb96a30e3dc0e97f19ebcd868c80ddd9048fd
+  data.tar.gz: 6813cd20e6dd13a3781f4fd48e3326f3d7cdd125bb7ef540bca6bf672e76196d51b85711bc58b85ff31ec6c752983a199546a505716042f1e7f85f84e5d5a8ab

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Chris Oliver
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,47 @@
+# 📬 Mailbin
+Preview emails sent from ActionMailer in the browser.
+
+Mailbin writes emails to `tmp/mailbin` for easy access and testing.
+
+## 📦 Installation
+
+Add Mailbin to your Gemfile:
+
+```ruby
+bundle add "mailbin"
+```
+
+Configure Rails to send emails to MailDrop:
+
+```ruby
+# config/environments/development.rb
+config.action_mailer.delivery_method = :mailbin
+config.action_mailer.perform_deliveries = true
+```
+
+Add the routes to view emails with MailBin:
+
+```ruby
+Rails.application.routes.draw do
+  mount Mailbin::Engine => :mailbin if Rails.env.development?
+end
+```
+
+## Usage
+
+Open http://localhost:3000/mailbin to view your emails in development.
+
+## Contributing
+
+If you have an issue you'd like to submit, please do so using the issue tracker in GitHub. In order for us to help you in the best way possible, please be as detailed as you can.
+
+If you'd like to open a PR please make sure the following things pass:
+
+```bash
+bin/rails db:test:prepare
+bin/rails test
+bin/rubocop -A
+```
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,18 @@
+require "bundler/setup"
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+load "rails/tasks/statistics.rake"
+
+desc "Run tests"
+Rake::TestTask.new(:test) do |t|
+  t.libs << "lib"
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = true
+  t.warning = false
+end
+
+task default: :test

data/app/assets/config/mailbin_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../stylesheets/mailbin .css
+//= link_directory ../../javascript/mailbin .js

data/app/assets/stylesheets/mailbin/application.css

@@ -0,0 +1,57 @@
+html, body, iframe {
+  height: 100%;
+}
+
+body {
+  margin: 0;
+}
+
+header {
+  width: 100%;
+  padding: 10px 0 0 0;
+  margin: 0;
+  background: white;
+  font: 12px "Lucida Grande", sans-serif;
+  border-bottom: 1px solid #dedede;
+  overflow: hidden;
+}
+
+dl {
+  margin: 0 0 10px 0;
+  padding: 0;
+}
+
+dt {
+  width: 80px;
+  padding: 1px;
+  float: left;
+  clear: left;
+  text-align: right;
+  color: #7f7f7f;
+}
+
+dd {
+  margin-left: 90px; /* 80px + 10px */
+  padding: 1px;
+}
+
+dd:empty:before {
+  content: "\00a0"; //  
+}
+
+th {
+  font-weight: inherit;
+  color: #7f7f7f;
+  text-align: right;
+  white-space: nowrap;
+}
+
+iframe {
+  border: 0;
+  width: 100%;
+}
+
+nav {
+  padding: 8px;
+}
+

data/app/controllers/mailbin/application_controller.rb

@@ -0,0 +1,2 @@
+class Mailbin::ApplicationController < ActionController::Base
+end

data/app/controllers/mailbin/clears_controller.rb

@@ -0,0 +1,8 @@
+module Mailbin
+  class ClearsController < ApplicationController
+    def destroy
+      Mailbin.destroy_all
+      redirect_to root_path
+    end
+  end
+end

data/app/controllers/mailbin/messages_controller.rb

@@ -0,0 +1,85 @@
+module Mailbin
+  class MessagesController < ApplicationController
+    around_action :set_locale, only: [ :show ]
+
+    helper_method :attachment_url, :part_query, :locale_query
+
+    content_security_policy(false)
+
+    rescue_from Errno::ENOENT do
+      redirect_to root_path
+    end
+
+    def index
+      @emails = Mailbin.all
+    end
+
+    def show
+      @email = Mailbin.find(params[:id])
+      @attachments = attachments_for(@email).reject { |filename, attachment| attachment.inline? }
+      @inline_attachments = attachments_for(@email).select { |filename, attachment| attachment.inline? }
+
+      if params[:part]
+        part_type = Mime::Type.lookup(params[:part])
+
+        if part = find_part(part_type)
+          response.content_type = part_type
+          render plain: part.respond_to?(:decoded) ? part.decoded : part
+        else
+          raise AbstractController::ActionNotFound, "Email part '#{part_type}' not found in #{@preview.name}##{@email_action}"
+        end
+      else
+        @part = find_preferred_part(request.format, Mime[:html], Mime[:text])
+      end
+    end
+
+    def destroy
+      Mailbin.destroy(params[:id])
+      redirect_to root_path
+    end
+
+    private
+
+    def find_preferred_part(*formats) # :doc:
+      formats.each do |format|
+        if part = @email.find_first_mime_type(format)
+          return part
+        end
+      end
+
+      if formats.any? { |f| @email.mime_type == f }
+        @email
+      end
+    end
+
+    def find_part(format) # :doc:
+      if part = @email.find_first_mime_type(format)
+        part
+      elsif @email.mime_type == format
+        @email
+      end
+    end
+
+    def attachments_for(email)
+      email.all_parts.to_a.select(&:attachment?).index_by do |attachment|
+        attachment.respond_to?(:original_filename) ? attachment.original_filename : attachment.filename
+      end
+    end
+
+    def attachment_url(attachment)
+      "data:application/octet-stream;charset=utf-8;base64,#{Base64.encode64(attachment.body.to_s)}"
+    end
+
+    def part_query(mime_type)
+      request.query_parameters.merge(part: mime_type).to_query
+    end
+
+    def locale_query(locale)
+      request.query_parameters.merge(locale: locale).to_query
+    end
+
+    def set_locale(&block)
+      I18n.with_locale(params[:locale] || I18n.default_locale, &block)
+    end
+  end
+end

data/app/javascript/mailbin/application.js

@@ -0,0 +1 @@
+import "@hotwired/turbo-rails"

data/app/views/layouts/mailbin/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Mailbin</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <%= stylesheet_link_tag "mailbin/application", "data-turbo-track": "reload" %>
+  <%= javascript_importmap_tags "application-mailbin" %>
+</head>
+<body>
+  <%= yield %>
+</body>
+</html>

data/app/views/mailbin/messages/index.html.erb

@@ -0,0 +1,14 @@
+<%= link_to "Back to app", main_app.root_path if main_app.respond_to?(:root_path) %>
+
+<h1>Sent Emails</h1>
+<%= button_to "Clear all", clear_path, method: :delete, data: {turbo_confirm: "Are you sure?"} %>
+
+<% if @emails.any? %>
+  <ul>
+    <% @emails.each do |email| %>
+      <li><%= link_to email.subject, message_path(email.message_id) %> - <%= l email.date, format: :long %></li>
+    <% end %>
+  </ul>
+<% else %>
+  <p>You have not sent any emails.</p>
+<% end %>

data/app/views/mailbin/messages/show.html.erb

@@ -0,0 +1,143 @@
+<nav>
+  <%= link_to "Back to emails", messages_path %>
+</nav>
+
+<header>
+  <dl>
+    <dt>Actions</dt>
+    <dd><%= button_to "Delete", message_path(@email.message_id), method: :delete, data: {turbo_confirm: "Are you sure?"} %> </dd>
+
+    <% if Array(@email.from) != Array(@email.smtp_envelope_from) %>
+      <dt>SMTP-From:</dt>
+      <dd id="smtp_from"><%= @email.smtp_envelope_from %></dd>
+    <% end %>
+
+    <% if Set[*@email.to, *@email.cc, *@email.bcc] != Set[*@email.smtp_envelope_to] %>
+      <dt>SMTP-To:</dt>
+      <dd id="smtp_to"><%= @email.smtp_envelope_to.join(", ") %></dd>
+    <% end %>
+
+    <dt>From:</dt>
+    <dd id="from"><%= @email.header['from'] %></dd>
+
+    <% if @email.reply_to %>
+      <dt>Reply-To:</dt>
+      <dd id="reply_to"><%= @email.header['reply-to'] %></dd>
+    <% end %>
+
+    <dt>To:</dt>
+    <dd id="to"><%= @email.header['to'] %></dd>
+
+    <% if @email.cc %>
+      <dt>CC:</dt>
+      <dd id="cc"><%= @email.header['cc'] %></dd>
+    <% end %>
+
+    <% if @email.bcc %>
+      <dt>BCC:</dt>
+      <dd id="bcc"><%= @email.header['bcc'] %></dd>
+    <% end %>
+
+    <dt>Date:</dt>
+    <dd id="date"><%= @email.header['date'] || Time.current.rfc2822 %></dd>
+
+    <dt>Subject:</dt>
+    <dd><strong id="subject"><%= @email.subject %></strong></dd>
+
+    <% if @attachments.any? || @inline_attachments.any? %>
+      <dt>Attachments:</dt>
+      <dd>
+        <% @attachments.each do |filename, attachment| %>
+          <%= link_to filename, attachment_url(attachment), download: filename %>
+        <% end %>
+
+        <% if @inline_attachments.any? %>
+          (Inline: <% @inline_attachments.each do |filename, attachment| %>
+            <%= link_to filename, attachment_url(attachment), download: filename %><% end %>)
+        <% end %>
+      </dd>
+    <% end %>
+
+    <dt>Format:</dt>
+    <% if @email.html_part && @email.text_part %>
+      <dd>
+        <select id="part" onchange="refreshBody(false);">
+          <option <%= request.format == Mime[:html] ? 'selected' : '' %> value="<%= part_query('text/html') %>">View as HTML email</option>
+          <option <%= request.format == Mime[:text] ? 'selected' : '' %> value="<%= part_query('text/plain') %>">View as plain-text email</option>
+        </select>
+      </dd>
+    <% elsif @part %>
+      <dd id="mime_type" data-mime-type="<%= part_query(@part.mime_type) %>"><%= @part.mime_type == 'text/html' ? 'HTML email' : 'plain-text email' %></dd>
+    <% else %>
+      <dd id="mime_type" data-mime-type=""></dd>
+    <% end %>
+
+    <% if I18n.available_locales.count > 1 %>
+      <dt>Locale:</dt>
+      <dd>
+        <select id="locale" onchange="refreshBody(true);">
+          <% I18n.available_locales.each do |locale| %>
+            <option <%= I18n.locale == locale ? 'selected' : '' %> value="<%= locale_query(locale) %>"><%= locale %></option>
+          <% end %>
+        </select>
+      </dd>
+    <% end %>
+
+    <% unless @email.header_fields.nil? || @email.header_fields.empty? %>
+      <dt>Headers:</dt>
+      <dd>
+        <details>
+          <summary>Show all headers</summary>
+          <table>
+          <% @email.header_fields.each do |field| %>
+            <tr>
+              <th><%= field.name %>:</th>
+              <td><%= field.value %></td>
+            </tr>
+          <% end %>
+          </table>
+        </details>
+      </dd>
+    <% end %>
+
+    <dt>EML File:</dt>
+    <dd><%= Mailbin.location_for(params[:id]) %></dd>
+  </dl>
+</header>
+
+<% if @part && @part.mime_type %>
+  <iframe name="messageBody" src="?<%= part_query(@part.mime_type) %>"></iframe>
+<% else %>
+  <p>
+    You are trying to preview an email that does not have any content.
+  </p>
+<% end %>
+
+<script>
+  function refreshBody(reload) {
+    var part_select = document.querySelector('select#part');
+    var locale_select = document.querySelector('select#locale');
+    var iframe = document.getElementsByName('messageBody')[0];
+    var part_param = part_select ?
+      part_select.options[part_select.selectedIndex].value :
+      document.querySelector('#mime_type').dataset.mimeType;
+    var locale_param = locale_select ? locale_select.options[locale_select.selectedIndex].value : null;
+    var fresh_location;
+    if (locale_param) {
+      fresh_location = '?' + part_param + '&' + locale_param;
+    } else {
+      fresh_location = '?' + part_param;
+    }
+    iframe.contentWindow.location = fresh_location;
+
+    var url = location.pathname.replace(/\.(txt|html)$/, '');
+    var format = /html/.test(part_param) ? '.html' : '.txt';
+    var state_to_replace = locale_param ? (url + format + '?' + locale_param) : (url + format);
+
+    if (reload) {
+      location.href = state_to_replace;
+    } else if (history.replaceState) {
+      window.history.replaceState({}, '', state_to_replace);
+    }
+  }
+</script>

data/config/importmap.rb

@@ -0,0 +1,2 @@
+pin "application-mailbin", to: "mailbin/application.js", preload: true
+pin "@hotwired/turbo-rails", to: "turbo.min.js", preload: true

data/config/routes.rb

@@ -0,0 +1,9 @@
+Mailbin::Engine.routes.draw do
+  resources :messages do
+    collection do
+      resource :clear
+    end
+  end
+
+  root to: "messages#index"
+end

data/lib/mailbin/delivery_method.rb

@@ -0,0 +1,24 @@
+module Mailbin
+  class DeliveryMethod
+    attr_accessor :settings
+
+    def initialize(options = {})
+      self.settings = options
+    end
+
+    def deliver!(mail)
+      mail.message_id = SecureRandom.uuid
+
+      FileUtils.mkdir_p(settings[:location])
+      File.open(location_for(mail), "w") do |file|
+        file.write(mail.encoded)
+      end
+    end
+
+    private
+
+    def location_for(mail)
+      File.join(settings[:location], mail.message_id + ".eml")
+    end
+  end
+end

data/lib/mailbin/engine.rb

@@ -0,0 +1,28 @@
+require "importmap-rails"
+require "turbo-rails"
+
+module Mailbin
+  class Engine < ::Rails::Engine
+    isolate_namespace Mailbin
+
+    initializer "mailbin.add_delivery_method" do
+      ActiveSupport.on_load :action_mailer do
+        ActionMailer::Base.add_delivery_method(
+          :mailbin,
+          Mailbin::DeliveryMethod,
+          location: Rails.root.join("tmp", "mailbin")
+        )
+      end
+    end
+
+    initializer "mailbin.assets" do |app|
+      app.config.assets.paths << root.join("app/javascript")
+      app.config.assets.precompile += %w[ mailbin_manifest ]
+    end
+
+    initializer "mailbin.importmap", before: "importmap" do |app|
+      app.config.importmap.paths << Engine.root.join("config/importmap.rb")
+      app.config.importmap.cache_sweepers << Engine.root.join("app/javascript")
+    end
+  end
+end

data/lib/mailbin/inline_preview_interceptor.rb

@@ -0,0 +1,10 @@
+module Mailbin
+  class InlinePreviewInterceptor < ActionMailer::InlinePreviewInterceptor
+    private
+      # Convert to base64 unless it's already done
+      def data_url(part)
+        source = part.body.encoding == "base64" ? part.body.raw_source : strict_encode64(part.body.raw_source)
+        "data:#{part.mime_type};base64,#{source}"
+      end
+  end
+end

data/lib/mailbin/version.rb

@@ -0,0 +1,3 @@
+module Mailbin
+  VERSION = "0.1.0"
+end

data/lib/mailbin.rb

@@ -0,0 +1,38 @@
+require "mailbin/version"
+require "mailbin/engine"
+
+module Mailbin
+  autoload :DeliveryMethod, "mailbin/delivery_method"
+  autoload :InlinePreviewInterceptor, "mailbin/inline_preview_interceptor"
+
+  class << self
+    def all
+      Dir.glob("*.eml", base: settings[:location]).map do |message_id|
+        find(message_id)
+      end.sort_by(&:date).reverse!
+    end
+
+    def find(message_id)
+      InlinePreviewInterceptor.previewing_email Mail.read(location_for(message_id))
+    end
+
+    def destroy(message_id)
+      File.delete location_for(message_id)
+    end
+
+    def destroy_all
+      Dir.glob("*.eml", base: settings[:location]).map do |message_id|
+        destroy(message_id)
+      end
+    end
+
+    def location_for(message_id)
+      message_id += ".eml" unless message_id.end_with?(".eml")
+      File.join(settings[:location], message_id)
+    end
+
+    def settings
+      ActionMailer::Base.mailbin_settings
+    end
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: mailbin
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Oliver
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-07-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.0
+- !ruby/object:Gem::Dependency
+  name: importmap-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: turbo-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Mailbin collects emails from Rails ActionMailer in development for testing.
+email:
+- excid3@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/mailbin_manifest.js
+- app/assets/stylesheets/mailbin/application.css
+- app/controllers/mailbin/application_controller.rb
+- app/controllers/mailbin/clears_controller.rb
+- app/controllers/mailbin/messages_controller.rb
+- app/javascript/mailbin/application.js
+- app/views/layouts/mailbin/application.html.erb
+- app/views/mailbin/messages/index.html.erb
+- app/views/mailbin/messages/show.html.erb
+- config/importmap.rb
+- config/routes.rb
+- lib/mailbin.rb
+- lib/mailbin/delivery_method.rb
+- lib/mailbin/engine.rb
+- lib/mailbin/inline_preview_interceptor.rb
+- lib/mailbin/version.rb
+homepage: https://github.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com
+  source_code_uri: https://github.com
+  changelog_uri: https://github.com
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: Mailbin collects emails from Rails ActionMailer in development for testing.
+test_files: []