Class: Mandrill::Senders
- Inherits:
-
Object
- Object
- Mandrill::Senders
- Defined in:
- lib/mandrill/api.rb
Instance Attribute Summary collapse
-
#master ⇒ Object
Returns the value of attribute master.
Instance Method Summary collapse
-
#add_domain(domain) ⇒ Hash
Adds a sender domain to your account.
-
#check_domain(domain) ⇒ Hash
Checks the SPF and DKIM settings for a domain.
-
#domains ⇒ Array
Returns the sender domains that have been added to this account.
-
#info(address) ⇒ Hash
Return more detailed information about a single sender, including aggregates of recent stats.
-
#initialize(master) ⇒ Senders
constructor
A new instance of Senders.
-
#list ⇒ Array
Return the senders that have tried to use this account.
-
#time_series(address) ⇒ Array
Return the recent history (hourly stats for the last 30 days) for a sender.
-
#verify_domain(domain, mailbox) ⇒ Hash
Sends a verification email in order to verify ownership of a domain.
Constructor Details
#initialize(master) ⇒ Senders
Returns a new instance of Senders.
1390 1391 1392 |
# File 'lib/mandrill/api.rb', line 1390 def initialize(master) @master = master end |
Instance Attribute Details
#master ⇒ Object
Returns the value of attribute master.
1388 1389 1390 |
# File 'lib/mandrill/api.rb', line 1388 def master @master end |
Instance Method Details
#add_domain(domain) ⇒ Hash
Adds a sender domain to your account. Sender domains are added automatically as you send, but you can use this call to add them ahead of time.
1451 1452 1453 1454 |
# File 'lib/mandrill/api.rb', line 1451 def add_domain(domain) _params = {:domain => domain} return @master.call 'senders/add-domain', _params end |
#check_domain(domain) ⇒ Hash
Checks the SPF and DKIM settings for a domain. If you haven’t already added this domain to your account, it will be added automatically.
1472 1473 1474 1475 |
# File 'lib/mandrill/api.rb', line 1472 def check_domain(domain) _params = {:domain => domain} return @master.call 'senders/check-domain', _params end |
#domains ⇒ Array
Returns the sender domains that have been added to this account.
1430 1431 1432 1433 |
# File 'lib/mandrill/api.rb', line 1430 def domains() _params = {} return @master.call 'senders/domains', _params end |
#info(address) ⇒ Hash
Return more detailed information about a single sender, including aggregates of recent stats
1558 1559 1560 1561 |
# File 'lib/mandrill/api.rb', line 1558 def info(address) _params = {:address => address} return @master.call 'senders/info', _params end |
#list ⇒ Array
Return the senders that have tried to use this account.
1409 1410 1411 1412 |
# File 'lib/mandrill/api.rb', line 1409 def list() _params = {} return @master.call 'senders/list', _params end |
#time_series(address) ⇒ Array
Return the recent history (hourly stats for the last 30 days) for a sender
1577 1578 1579 1580 |
# File 'lib/mandrill/api.rb', line 1577 def time_series(address) _params = {:address => address} return @master.call 'senders/time-series', _params end |
#verify_domain(domain, mailbox) ⇒ Hash
Sends a verification email in order to verify ownership of a domain. Domain verification is an optional step to confirm ownership of a domain. Once a domain has been verified in a Mandrill account, other accounts may not have their messages signed by that domain unless they also verify the domain. This prevents other Mandrill accounts from sending mail signed by your domain.
1484 1485 1486 1487 |
# File 'lib/mandrill/api.rb', line 1484 def verify_domain(domain, mailbox) _params = {:domain => domain, :mailbox => mailbox} return @master.call 'senders/verify-domain', _params end |