Module: Mailroute

Defined in:
lib/mailroute/version.rb,
lib/mailroute/models/base.rb,
lib/mailroute/models/admin.rb,
lib/mailroute/configuration.rb,
lib/mailroute/models/domain.rb,
lib/mailroute/models/wblist.rb,
lib/mailroute/models/customer.rb,
lib/mailroute/models/reseller.rb,
lib/mailroute/models/timezone.rb,
lib/mailroute/check_connection.rb,
lib/mailroute/models/mail_server.rb,
lib/mailroute/models/policy_user.rb,
lib/mailroute/models/domain_alias.rb,
lib/mailroute/models/branding_info.rb,
lib/mailroute/models/email_account.rb,
lib/mailroute/models/policy_domain.rb,
lib/mailroute/models/policy_filter.rb,
lib/mailroute/models/domain_contact.rb,
lib/mailroute/models/anti_spam_modes.rb,
lib/mailroute/models/localpart_alias.rb,
lib/mailroute/models/outbound_server.rb,
lib/mailroute/models/customer_contact.rb,
lib/mailroute/models/reseller_contact.rb,
lib/mailroute/models/email_account_contact.rb,
lib/mailroute/models/notification_domain_task.rb,
lib/mailroute/models/notification_account_task.rb

Defined Under Namespace

Modules: AntiSpamModes, PolicyFilter, Timezone Classes: Admin, Base, BrandingInfo, Client, Customer, CustomerContact, Domain, DomainAlias, DomainContact, EmailAccount, EmailAccountContact, LocalpartAlias, MailServer, NotificationAccountTask, NotificationDomainTask, OutboundServer, PolicyDomain, PolicyUser, Relation, Reseller, ResellerContact, WBList

Constant Summary collapse

VERSION = 
"0.0.6"

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.apikey ⇒ Object (readonly)

Returns the value of attribute apikey.



3
4
5
 
# File 'lib/mailroute/configuration.rb', line 3

def apikey
  @apikey
end

.url ⇒ Object (readonly)

Returns the value of attribute url.



3
4
5
 
# File 'lib/mailroute/configuration.rb', line 3

def url
  @url
end

.username ⇒ Object (readonly)

Returns the value of attribute username.



3
4
5
 
# File 'lib/mailroute/configuration.rb', line 3

def username
  @username
end

Class Method Details

.check_connection ⇒ Object 



18
19
20
 
# File 'lib/mailroute/check_connection.rb', line 18

def self.check_connection
  Client.new(username, apikey).check_connection
end

.configure(options) ⇒ Object 



5
6
7
8
9
10
11
12
13
14
 
# File 'lib/mailroute/configuration.rb', line 5

def configure(options)
  options = default_options.merge(options)

  @username = options[:username]
  @apikey = options[:apikey]
  @url = options[:url]

  Mailroute::Base.headers['Authorization'] = "ApiKey #@username:#@apikey"
  Mailroute::Base.site = @url
end

.default_options ⇒ Object 



16
17
18
19
20
21
22
 
# File 'lib/mailroute/configuration.rb', line 16

def default_options
  {
    :username => ENV['MAILROUTE_USERNAME'],
    :apikey   => ENV['MAILROUTE_API_KEY'],
    :url      => ENV['MAILROUTE_URL']
  }.dup
end