Module: Rapidmail

Defined in:
lib/rapidmail.rb,
lib/rapidmail/client.rb,
lib/rapidmail/version.rb,
lib/rapidmail/configuration.rb,
lib/rapidmail/resources/job.rb,
lib/rapidmail/resources/base.rb,
lib/rapidmail/resources/mailing.rb,
lib/rapidmail/utils/placeholder.rb,
lib/rapidmail/utils/zip_encoder.rb,
lib/rapidmail/resources/recipient.rb,
lib/rapidmail/utils/config_loader.rb,
lib/rapidmail/resources/recipient_list.rb,
lib/generators/rapidmail/install/install_generator.rb

Defined Under Namespace

Modules: Generators, Resources, Utils Classes: Client, Configuration, Error

Constant Summary collapse

VERSION = 
"0.2.2"

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.online=(value) ⇒ Object (writeonly)

Updates the connection status to the Rapidmail service. Set to false when connection fails, true when connection succeeds.

Parameters:

  • status (Boolean) —

    new connection status



66
67
68
 
# File 'lib/rapidmail.rb', line 66

def online=(value)
  @online = value
end

Class Method Details

.client ⇒ Rapidmail::Client

Returns a new client instance.

Returns:



24
25
26
 
# File 'lib/rapidmail.rb', line 24

def client(...)
  Client.new(...)
end

.configuration ⇒ Rapidmail::Configuration

Returns the configuration instance.

Returns:



42
43
44
 
# File 'lib/rapidmail.rb', line 42

def configuration
  @configuration ||= Configuration.new
end

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

Yields the configuration instance for configuration.

Yields:



47
48
49
 
# File 'lib/rapidmail.rb', line 47

def configure
  yield(configuration)
end

.method_missing(method, *args, &block) ⇒ Object

Forwards missing methods to the client instance.



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

def method_missing(method, *args, &block)
  return super unless client.respond_to?(method)
  client.send(method, *args, &block)
end

.online? ⇒ Boolean

Returns or sets the connection status to the Rapidmail service. Defaults to online == true. If status is false, attempts to reconnect via ping.

Returns:

  • (Boolean) —

    Current connection status



56
57
58
59
60
 
# File 'lib/rapidmail.rb', line 56

def online?
  @online = true if @online.nil?
  @online = client.ping if @online == false
  @online
end

.respond_to_missing?(method, include_all = false) ⇒ Boolean

Checks if the client instance responds to a missing method.

Returns:

  • (Boolean) 


35
36
37
 
# File 'lib/rapidmail.rb', line 35

def respond_to_missing?(method, include_all = false)
  client.respond_to?(method, include_all) || super
end