instance method `assert_emails`

Ruby on Rails 7.1.6

Since v2.2.3

Available in: v2.2.3 v2.3.18 v3.0.20 v3.1.12 v3.2.22.5 v4.0.13 v4.1.16 v4.2.9 v5.2.8.1 v6.0.6 v6.1.7.10 v7.0.10 v7.1.6 v7.2.3 v8.0.4 v8.1.2

Compare with:

assert_emails(number, &block)

Asserts that the number of emails sent matches the given number.

def test_emails
  assert_emails 0
  ContactMailer.welcome.deliver_now
  assert_emails 1
  ContactMailer.welcome.deliver_now
  assert_emails 2
end

If a block is passed, that block should cause the specified number of emails to be sent.

def test_emails_again
  assert_emails 1 do
    ContactMailer.welcome.deliver_now
  end

  assert_emails 2 do
    ContactMailer.welcome.deliver_now
    ContactMailer.welcome.deliver_later
  end
end

Parameters

number req
block block

Source

# File actionmailer/lib/action_mailer/test_helper.rb, line 35
    def assert_emails(number, &block)
      if block_given?
        diff = capture_emails(&block).length
        assert_equal number, diff, "#{number} emails expected, but #{diff} were sent"
      else
        assert_equal number, ActionMailer::Base.deliveries.size
      end
    end

Defined in actionmailer/lib/action_mailer/test_helper.rb line 35 · View on GitHub · Improve this page · Find usages on GitHub

Defined in ActionMailer::TestHelper

Signature

Parameters