Module: Hanami::Mailer

Overview

Defined Under Namespace

Modules: ClassMethods, Dsl Classes: Configuration, Error, MissingDeliveryDataError

Constant Summary

VERSION =

Since:

• 0.1.0

"1.3.3"

Instance Attribute Summary collapse

• #mail ⇒ Object readonly protected

Class Method Summary collapse

• .configure(&blk) ⇒ Object

  Configure the framework.

• .deliveries ⇒ Array

  Test deliveries.

Instance Method Summary collapse

• #build ⇒ Object private

  rubocop:disable Metrics/MethodLength rubocop:disable Metrics/AbcSize.

• #initialize(locals = {}) ⇒ Object

  Initialize a mailer.

• #prepare ⇒ Object protected

  Prepare the email message when a new mailer is initialized.

def method_missing(method_name)
  @locals.fetch(method_name) { super }
end

def mail
  @mail
end

require 'hanami/mailer'

Hanami::Mailer.configure do
  root '/path/to/root'
end

def self.configure(&blk)
  configuration.instance_eval(&blk)
  self
end

require 'hanami/mailer'

Hanami::Mailer.configure do
  delivery_method :test
end.load!

# In testing code
Signup::Welcome.deliver
Hanami::Mailer.deliveries.count # => 1

def self.deliveries
  Mail::TestMailer.deliveries
end

def build
  Mail.new.tap do |m|
    m.from     = __dsl(:from)
    m.to       = __dsl(:to)
    m.cc       = __dsl(:cc)
    m.bcc      = __dsl(:bcc)
    m.reply_to = __dsl(:reply_to)
    m.subject  = __dsl(:subject)

    m.charset   = charset
    m.html_part = __part(:html)
    m.text_part = __part(:txt)

    m.delivery_method(*Hanami::Mailer.configuration.delivery_method)
  end
end

def initialize(locals = {})
  @locals  = locals
  @format  = locals.fetch(:format, nil)
  @charset = locals.fetch(:charset, self.class.configuration.default_charset)
  @mail    = build
  prepare
end

require 'hanami/mailer'

module Billing
  class Invoice
    include Hanami::Mailer

    subject 'Invoice'
    from    'noreply@example.com'
    to      ''

    def prepare
      mail.attachments['invoice.pdf'] = File.read('/path/to/invoice.pdf')
    end

    private

    def recipient
      user.email
    end
  end
end

invoice = Invoice.new
user    = User.new(name: 'L', email: 'user@example.com')

def prepare
end