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.
1804 1805 1806 |
# File 'lib/mandrill/api.rb', line 1804 def initialize(master) @master = master end |
Instance Attribute Details
#master ⇒ Object
Returns the value of attribute master.
1802 1803 1804 |
# File 'lib/mandrill/api.rb', line 1802 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.
1865 1866 1867 1868 |
# File 'lib/mandrill/api.rb', line 1865 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.
1886 1887 1888 1889 |
# File 'lib/mandrill/api.rb', line 1886 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.
1844 1845 1846 1847 |
# File 'lib/mandrill/api.rb', line 1844 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
1972 1973 1974 1975 |
# File 'lib/mandrill/api.rb', line 1972 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.
1823 1824 1825 1826 |
# File 'lib/mandrill/api.rb', line 1823 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
1991 1992 1993 1994 |
# File 'lib/mandrill/api.rb', line 1991 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.
1898 1899 1900 1901 |
# File 'lib/mandrill/api.rb', line 1898 def verify_domain(domain, mailbox) _params = {:domain => domain, :mailbox => mailbox} return @master.call 'senders/verify-domain', _params end |