Class: Lumberg::Cpanel::BoxTrapper

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

Instance Attribute Summary

Attributes inherited from Base

#api_username

Attributes inherited from Whm::Base

#server

Instance Method Summary collapse

Methods inherited from Base

api_module, #initialize, #perform_request

Methods inherited from Whm::Base

#initialize, #setup_server

Constructor Details

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

Instance Method Details

#list(options = {}) ⇒ Object

Public: Get list of email accounts and their BoxTrapper statuses.

options - Hash options for API call params (default: {}):

:regex - String regular expression to filter search results
         (optional).

Returns Hash API response.



11
12
13
14
15
 
# File 'lib/lumberg/cpanel/box_trapper.rb', line 11

def list(options = {})
  perform_request({
    api_function: "accountmanagelist"
  }.merge(options))
end