Class: Mandrill::Whitelists
- Inherits:
-
Object
- Object
- Mandrill::Whitelists
- Defined in:
- lib/mandrill/api.rb
Instance Attribute Summary collapse
-
#master ⇒ Object
Returns the value of attribute master.
Instance Method Summary collapse
-
#add(email) ⇒ Hash
Adds an email to your email rejection whitelist.
-
#delete(email) ⇒ Hash
Removes an email address from the whitelist.
-
#initialize(master) ⇒ Whitelists
constructor
A new instance of Whitelists.
-
#list(email = nil) ⇒ Array
Retrieves your email rejection whitelist.
Constructor Details
#initialize(master) ⇒ Whitelists
Returns a new instance of Whitelists.
880 881 882 |
# File 'lib/mandrill/api.rb', line 880 def initialize(master) @master = master end |
Instance Attribute Details
#master ⇒ Object
Returns the value of attribute master.
878 879 880 |
# File 'lib/mandrill/api.rb', line 878 def master @master end |
Instance Method Details
#add(email) ⇒ Hash
Adds an email to your email rejection whitelist. If the address is currently on your blacklist, that blacklist entry will be removed automatically.
889 890 891 892 |
# File 'lib/mandrill/api.rb', line 889 def add(email) _params = {:email => email} return @master.call 'whitelists/add', _params end |
#delete(email) ⇒ Hash
Removes an email address from the whitelist.
911 912 913 914 |
# File 'lib/mandrill/api.rb', line 911 def delete(email) _params = {:email => email} return @master.call 'whitelists/delete', _params end |
#list(email = nil) ⇒ Array
Retrieves your email rejection whitelist. You can provide an email address or search prefix to limit the results. Returns up to 1000 results.
901 902 903 904 |
# File 'lib/mandrill/api.rb', line 901 def list(email=nil) _params = {:email => email} return @master.call 'whitelists/list', _params end |