Class: Purelymail::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/purelymail/client.rb

Constant Summary collapse

BASE_URL = 
"https://purelymail.com/api/v0/"

Instance Method Summary collapse

Constructor Details

#initialize(api_token: nil) ⇒ Client

Returns a new instance of Client.



10
11
12
 
# File 'lib/purelymail/client.rb', line 10

def initialize(api_token: nil)
  @api_token = api_token || Purelymail.configuration.api_token
end

Instance Method Details

#change_password(name:, domain:, password:) ⇒ Object 



22
23
24
 
# File 'lib/purelymail/client.rb', line 22

def change_password(name:, domain:, password:)
  post("changePassword", { userName: name, domainName: domain, password: password })
end

#configured? ⇒ Boolean

Returns:

  • (Boolean) 


36
37
38
 
# File 'lib/purelymail/client.rb', line 36

def configured?
  !api_token.nil? && api_token.to_s.strip != ""
end

#create_domain(name:) ⇒ Object 



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

def create_domain(name:)
  post("addDomain", { domainName: name })
end

#create_routing_rule(domain_name:, match_user:, target_addresses:, prefix: false, catchall: false) ⇒ Object 



26
27
28
29
30
31
32
33
34
 
# File 'lib/purelymail/client.rb', line 26

def create_routing_rule(domain_name:, match_user:, target_addresses:, prefix: false, catchall: false)
  post("createRoutingRule", {
    domainName: domain_name,
    matchUser: match_user,
    targetAddresses: Array(target_addresses),
    prefix: prefix,
    catchall: catchall
  })
end

#create_user(name:, domain:, password:) ⇒ Object 



18
19
20
 
# File 'lib/purelymail/client.rb', line 18

def create_user(name:, domain:, password:)
  post("createUser", { userName: name, domainName: domain, password: password })
end