email.md

Email Delivery Method

Sends an email to each recipient.

deliver_by :email do |config|
  config.mailer = "UserMailer"
  config.method = :invoice_paid
  config.params = ->{ params }
  config.args = ->{ [1, 2, 3] }
  config.kwargs = ->{ {body: "Hey there", subject: "Thanks for joining"} }

  # Enqueues a separate job for sending the email using deliver_later.
  # Deliveries already happen in jobs so this is typically unnecessary.
  # config.enqueue = false
end

Options

• mailer - Required

  The mailer that should send the email

• method: :invoice_paid - Required

  Used to customize the method on the mailer that is called

• params - Optional

  Use a custom method to define the params sent to the mailer. recipient and record will be merged into the params.

• args - Optional

  The arguments for the method if it uses positional arguments (eg: def hello(a, b, c=1))

• kwargs - Optional

  The arguments for the method if it uses keyword arguments (eg: def hello(a:, b:, c: 1))

• enqueue: false - Optional

  Use deliver_later to queue email delivery with ActiveJob. This is false by default as each delivery method is already a separate job.

ActionMailer::Preview

Use YourMailer.with({ recipient: user }).mailer_method_name to set up a ActionMailer::Preview. And you can pass any number of params into the Hash but you will need the recipient key.

# test/mailers/previews/comment_mailer_preview.rb
class CommentMailerPreview < ActionMailer::Preview
  def mailer_method_name
    CommentMailer.with({ recipient: User.first }).mailer_method_name
  end
end