Class: Lumberg::Cpanel::DomainKeys

Inherits:
Base show all
Defined in:
lib/lumberg/cpanel/domain_keys.rb

Overview

Public: Allows users to edit domain keys

Instance Attribute Summary

Attributes inherited from Base

#api_username

Attributes inherited from Whm::Base

#server

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#initialize, #perform_request

Methods inherited from Whm::Base

#initialize, #setup_server

Constructor Details

This class inherits a constructor from Lumberg::Cpanel::Base

Class Method Details

.api_moduleObject


5
# File 'lib/lumberg/cpanel/domain_keys.rb', line 5

def self.api_module ; "DKIMUI" ; end

Instance Method Details

#addObject

Public: Install DomainKeys for your cPanel account

Returns Hash API response


10
11
12
# File 'lib/lumberg/cpanel/domain_keys.rb', line 10

def add
  perform_request({ api_function: "install" })
end

#availableObject

Public: Check to see if DomainKeys are available on the server

Returns Hash API response


31
32
33
# File 'lib/lumberg/cpanel/domain_keys.rb', line 31

def available
  perform_request({ api_function: "available" })
end

#installedObject

Public: Check to see if your domain has DomainKeys installed

Returns Hash API response


24
25
26
# File 'lib/lumberg/cpanel/domain_keys.rb', line 24

def installed
  perform_request({ api_function: "installed" })
end

#removeObject

Public: Remove DomainKeys corresponding to your domain

Returns Hash API response


17
18
19
# File 'lib/lumberg/cpanel/domain_keys.rb', line 17

def remove
  perform_request({ api_function: "uninstall" })
end