Class: Mandrill::Rejects
- Inherits:
-
Object
- Object
- Mandrill::Rejects
- Defined in:
- lib/mandrill/api.rb
Instance Attribute Summary collapse
-
#master ⇒ Object
Returns the value of attribute master.
Instance Method Summary collapse
-
#add(email, comment = nil, subaccount = nil) ⇒ Hash
Adds an email to your email rejection blacklist.
-
#delete(email, subaccount = nil) ⇒ Hash
Deletes an email rejection.
-
#initialize(master) ⇒ Rejects
constructor
A new instance of Rejects.
-
#list(email = nil, include_expired = false, subaccount = nil) ⇒ Array
Retrieves your email rejection blacklist.
Constructor Details
#initialize(master) ⇒ Rejects
Returns a new instance of Rejects.
410 411 412 |
# File 'lib/mandrill/api.rb', line 410 def initialize(master) @master = master end |
Instance Attribute Details
#master ⇒ Object
Returns the value of attribute master.
408 409 410 |
# File 'lib/mandrill/api.rb', line 408 def master @master end |
Instance Method Details
#add(email, comment = nil, subaccount = nil) ⇒ Hash
Adds an email to your email rejection blacklist. Addresses that you add manually will never expire and there is no reputation penalty for removing them from your blacklist. Attempting to blacklist an address that has been whitelisted will have no effect.
421 422 423 424 |
# File 'lib/mandrill/api.rb', line 421 def add(email, comment=nil, subaccount=nil) _params = {:email => email, :comment => comment, :subaccount => subaccount} return @master.call 'rejects/add', _params end |
#delete(email, subaccount = nil) ⇒ Hash
Deletes an email rejection. There is no limit to how many rejections you can remove from your blacklist, but keep in mind that each deletion has an affect on your reputation.
465 466 467 468 |
# File 'lib/mandrill/api.rb', line 465 def delete(email, subaccount=nil) _params = {:email => email, :subaccount => subaccount} return @master.call 'rejects/delete', _params end |
#list(email = nil, include_expired = false, subaccount = nil) ⇒ Array
Retrieves your email rejection blacklist. You can provide an email address to limit the results. Returns up to 1000 results. By default, entries that have expired are excluded from the results; set include_expired to true to include them.
453 454 455 456 |
# File 'lib/mandrill/api.rb', line 453 def list(email=nil, include_expired=false, subaccount=nil) _params = {:email => email, :include_expired => include_expired, :subaccount => subaccount} return @master.call 'rejects/list', _params end |