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.
1608 1609 1610 |
# File 'lib/mandrill/api.rb', line 1608 def initialize(master) @master = master end |
Instance Attribute Details
#master ⇒ Object
Returns the value of attribute master.
1606 1607 1608 |
# File 'lib/mandrill/api.rb', line 1606 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.
1669 1670 1671 1672 |
# File 'lib/mandrill/api.rb', line 1669 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.
1690 1691 1692 1693 |
# File 'lib/mandrill/api.rb', line 1690 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.
1648 1649 1650 1651 |
# File 'lib/mandrill/api.rb', line 1648 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
1776 1777 1778 1779 |
# File 'lib/mandrill/api.rb', line 1776 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.
1627 1628 1629 1630 |
# File 'lib/mandrill/api.rb', line 1627 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
1795 1796 1797 1798 |
# File 'lib/mandrill/api.rb', line 1795 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.
1702 1703 1704 1705 |
# File 'lib/mandrill/api.rb', line 1702 def verify_domain(domain, mailbox) _params = {:domain => domain, :mailbox => mailbox} return @master.call 'senders/verify-domain', _params end |