have_enqueued_mail matcher

The have_enqueued_mail (also aliased as enqueue_mail) matcher is used to check if given mailer was enqueued.

Background

Given active job is available.

Checking mailer class and method name

Given a file named “spec/mailers/usermailerspec.rb” with:

require "rails_helper"

RSpec.describe NotificationsMailer do
  it "matches with enqueued mailer" do
    ActiveJob::Base.queue_adapter = :test
    expect {
      NotificationsMailer.signup.deliver_later
    }.to have_enqueued_mail(NotificationsMailer, :signup)
  end
end

When I run rspec spec/mailers/user_mailer_spec.rb

Then the examples should all pass.

Checking mailer enqueued time

Given a file named “spec/mailers/usermailerspec.rb” with:

require "rails_helper"

RSpec.describe NotificationsMailer do
  it "matches with enqueued mailer" do
    ActiveJob::Base.queue_adapter = :test
    expect {
      NotificationsMailer.signup.deliver_later(wait_until: Date.tomorrow.noon)
    }.to have_enqueued_mail.at(Date.tomorrow.noon)
  end
end

When I run rspec spec/mailers/user_mailer_spec.rb

Then the examples should all pass.

Checking mailer arguments

Given a file named “app/mailers/my_mailer.rb” with:

class MyMailer < ApplicationMailer

  def signup(user = nil)
    @user = user

    mail to: "to@example.org"
  end
end

Given a file named “spec/mailers/mymailerspec.rb” with:

require "rails_helper"

RSpec.describe MyMailer do
  it "matches with enqueued mailer" do
    ActiveJob::Base.queue_adapter = :test
    # Works with plain args
    expect {
      MyMailer.signup('user').deliver_later
    }.to have_enqueued_mail(MyMailer, :signup).with('user')
  end
end

When I run rspec spec/mailers/my_mailer_spec.rb

Then the examples should all pass.

Parameterize the mailer

Given a file named “app/mailers/my_mailer.rb” with:

class MyMailer < ApplicationMailer

  def signup
    @foo = params[:foo]

    mail to: "to@example.org"
  end
end

Given a file named “spec/mailers/mymailerspec.rb” with:

require "rails_helper"

RSpec.describe MyMailer do
  it "matches with enqueued mailer" do
    ActiveJob::Base.queue_adapter = :test
    # Works with named parameters
    expect {
      MyMailer.with(foo: 'bar').signup.deliver_later
    }.to have_enqueued_mail(MyMailer, :signup).with(a_hash_including(params: {foo: 'bar'}))
  end
end

When I run rspec spec/mailers/my_mailer_spec.rb

Then the examples should all pass.

Parameterize and pass an argument to the mailer

Given a file named “app/mailers/my_mailer.rb” with:

class MyMailer < ApplicationMailer

  def signup(user)
    @user = user
    @foo = params[:foo]

    mail to: "to@example.org"
  end
end

Given a file named “spec/mailers/mymailerspec.rb” with:

require "rails_helper"

RSpec.describe MyMailer do
  it "matches with enqueued mailer" do
    ActiveJob::Base.queue_adapter = :test
    # Works also with both, named parameters match first argument
    expect {
      MyMailer.with(foo: 'bar').signup('user').deliver_later
    }.to have_enqueued_mail(MyMailer, :signup).with(params: {foo: 'bar'}, args: ['user'])
  end
end

When I run rspec spec/mailers/my_mailer_spec.rb

Then the examples should all pass.