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.
1031 1032 1033 |
# File 'lib/mandrill/api.rb', line 1031 def initialize(master) @master = master end |
Instance Attribute Details
#master ⇒ Object
Returns the value of attribute master.
1029 1030 1031 |
# File 'lib/mandrill/api.rb', line 1029 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.
1040 1041 1042 1043 |
# File 'lib/mandrill/api.rb', line 1040 def add(email) _params = {:email => email} return @master.call 'whitelists/add', _params end |
#delete(email) ⇒ Hash
Removes an email address from the whitelist.
1062 1063 1064 1065 |
# File 'lib/mandrill/api.rb', line 1062 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.
1052 1053 1054 1055 |
# File 'lib/mandrill/api.rb', line 1052 def list(email=nil) _params = {:email => email} return @master.call 'whitelists/list', _params end |