Module: Mailtruck

Defined in:
lib/mailtruck.rb,
lib/mailtruck/version.rb

Defined Under Namespace

Classes: Configuration, Email, EmailAddress, Receiver, Timeout, Truck

Constant Summary collapse

VERSION =
"0.1.1"

Class Method Summary collapse

Class Method Details

.configurationMailtruck::Configuration

Returns the Mailtruck configuration.

Returns:



25
26
27
# File 'lib/mailtruck.rb', line 25

def self.configuration
  @configuration ||= Configuration.new
end

.configure {|configuration| ... } ⇒ Object

Configure Mailtruck.

Capybara.configure do |config|
  config.timeout = 60
end

Options

email_host = String

Host where emails will be sent, defaults to mailtruck.bruzilla.com

receiver_url = String

Mailtruck server, defaults to mailtruck.herokuapp.com/faye

timeout = Integer

Timeout in seconds when waiting for email, defaults to 30

Yields:



20
21
22
# File 'lib/mailtruck.rb', line 20

def self.configure
  yield configuration
end

.startMailtruck::Truck

Returns a mailtruck instance.

Returns:



30
31
32
# File 'lib/mailtruck.rb', line 30

def self.start
  Mailtruck::Truck.new
end