class Mandrill::Senders

Defined in:

mandrill/api.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(master) #

[View source]

Instance Method Detail

def add_domain(domain) #

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. @param [String] domain a domain name @return [Hash] information about the domain

- [String] domain the sender domain name
- [String] created_at the date and time that the sending domain was first seen as a UTC string in YYYY-MM-DD HH:MM:SS format
- [String] last_tested_at when the domain

[View source]
def check_domain(domain) #

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. @param [String] domain a domain name @return [Hash] information about the sender domain

- [String] domain the sender domain name
- [String] created_at the date and time that the sending domain was first seen as a UTC string in YYYY-MM-DD HH:MM:SS format
- [String] last_tested_at when the domain

[View source]
def domains #

Returns the sender domains that have been added to this account. @return [Array] an array of sender domain data, one for each sending domain used by the account

- [Hash] return[] the information on each sending domain for the account
    - [String] domain the sender domain name
    - [String] created_at the date and time that the sending domain was first seen as a UTC string in YYYY-MM-DD HH:MM:SS format
    - [String] last_tested_at when the domain

[View source]
def info(address) #

Return more detailed information about a single sender, including aggregates of recent stats @param [String] address the email address of the sender @return [Hash] the detailed information on the sender

- [String] address the sender

[View source]
def list #

Return the senders that have tried to use this account. @return [Array] an array of sender data, one for each sending addresses used by the account

- [Hash] return[] the information on each sending address in the account
    - [String] address the sender

[View source]
def time_series(address) #

Return the recent history (hourly stats for the last 30 days) for a sender @param [String] address the email address of the sender @return [Array] the array of history information

- [Hash] return[] the stats for a single hour
    - [String] time the hour as a UTC date string in YYYY-MM-DD HH:MM:SS format
    - [Integer] sent the number of emails that were sent during the hour
    - [Integer] hard_bounces the number of emails that hard bounced during the hour
    - [Integer] soft_bounces the number of emails that soft bounced during the hour
    - [Integer] rejects the number of emails that were rejected during the hour
    - [Integer] complaints the number of spam complaints received during the hour
    - [Integer] opens the number of emails opened during the hour
    - [Integer] unique_opens the number of unique opens generated by messages sent during the hour
    - [Integer] clicks the number of tracked URLs clicked during the hour
    - [Integer] unique_clicks the number of unique clicks generated by messages sent during the hour

[View source]
def verify_domain(domain, mailbox) #

Sends a verification email in order to verify ownership of a domain. Domain verification is a required 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. @param [String] domain a domain name at which you can receive email @param [String] mailbox a mailbox at the domain where the verification email should be sent @return [Hash] information about the verification that was sent

- [String] status "sent" indicates that the verification has been sent, "already_verified" indicates that the domain has already been verified with your account
- [String] domain the domain name you provided
- [String] email the email address the verification email was sent to

[View source]