Module: Mailclerk

Defined in:
lib/client.rb,
lib/errors.rb,
lib/outbox.rb,
lib/mailclerk.rb

Defined Under Namespace

Modules: Identity Classes: Client, MailclerkAPIError, MailclerkError, Outbox, OutboxEmail

Constant Summary collapse

DEFAULT_API_URL = 
"https://api.mailclerk.app"

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.api_key ⇒ Object

Returns the value of attribute api_key.



14
15
16
 
# File 'lib/mailclerk.rb', line 14

def api_key
  @api_key
end

.api_url ⇒ Object

Returns the value of attribute api_url.



15
16
17
 
# File 'lib/mailclerk.rb', line 15

def api_url
  @api_url
end

Class Method Details

.deliver(*args) ⇒ Object

Syntax intended to emulate ActionMailer



38
39
40
41
42
43
 
# File 'lib/mailclerk.rb', line 38

def self.deliver(*args)
  api_key = self.api_key || ENV['MAILCLERK_API_KEY']
  
  client = Mailclerk::Client.new(api_key, self.api_url)
  return client.deliver(*args)
end

.outbox ⇒ Object 



45
46
47
 
# File 'lib/mailclerk.rb', line 45

def self.outbox
  @outbox ||= Mailclerk::Outbox.new
end

.outbox_enabled? ⇒ Boolean

Returns:

  • (Boolean) 


49
50
51
 
# File 'lib/mailclerk.rb', line 49

def self.outbox_enabled?
  !!(@outbox && @outbox.enabled)
end