Module: MailCapture

Defined in:
lib/mailcapture.rb,
lib/mailcapture/inbox.rb,
lib/mailcapture/client.rb,
lib/mailcapture/errors.rb,
lib/mailcapture/models.rb,
lib/mailcapture/version.rb

Overview

MailCapture — real email capture for integration tests.

Examples:

Quick start

mc = MailCapture.new(api_key: ENV['MAILCAPTURE_API_KEY'])
mc.ping

mc.delete('signup')
MyApp.register(mc.address('signup'))   # "alice-signup@mailcapture.app"
email = mc.wait_for('signup', timeout: 15)
email.otp  # => "123456"

With Inbox (recommended for test suites)

inbox = mc.inbox('signup')
inbox.clear
MyApp.register(inbox.address)
email = inbox.wait_for(timeout: 15)

Defined Under Namespace

Classes: ApiError, AuthError, Capture, CaptureList, Client, Error, GenerateResult, Inbox, NetworkError, NotFoundError, PingResult, TimeoutError

Constant Summary collapse

VERSION = 
'1.0.0'

Class Method Summary collapse

Class Method Details

.new(**kwargs) ⇒ Client

Convenience constructor — equivalent to MailCapture::Client.new.

Returns:



27
28
29
 
# File 'lib/mailcapture.rb', line 27

def self.new(**kwargs)
  Client.new(**kwargs)
end