class MailchimpTransactional::SendersApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/MailchimpTransactional/api/senders_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

add_domain(body = {}) click to toggle source

Add sender 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 body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20042, Fixnum, Hash)>] InlineResponse20042 data, response status code and response headers

# File lib/MailchimpTransactional/api/senders_api.rb, line 28
def add_domain(body = {})
  data = @api_client.call_api(:POST, '/senders/add-domain', body)
  data
end
check_domain(body = {}) click to toggle source

Check domain settings Checks the SPF and DKIM settings for a domain. If you haven&#39;t already added this domain to your account, it will be added automatically. @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20043, Fixnum, Hash)>] InlineResponse20043 data, response status code and response headers

# File lib/MailchimpTransactional/api/senders_api.rb, line 38
def check_domain(body = {})
  data = @api_client.call_api(:POST, '/senders/check-domain', body)
  data
end
domains(body = {}) click to toggle source

List sender domains Returns the sender domains that have been added to this account. @param body @param [Hash] opts the optional parameters @return [Array<(Array<InlineResponse20041>, Fixnum, Hash)>] Array<InlineResponse20041> data, response status code and response headers

# File lib/MailchimpTransactional/api/senders_api.rb, line 48
def domains(body = {})
  data = @api_client.call_api(:POST, '/senders/domains', body)
  data
end
info(body = {}) click to toggle source

Get sender info Return more detailed information about a single sender, including aggregates of recent stats. @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20045, Fixnum, Hash)>] InlineResponse20045 data, response status code and response headers

# File lib/MailchimpTransactional/api/senders_api.rb, line 58
def info(body = {})
  data = @api_client.call_api(:POST, '/senders/info', body)
  data
end
list(body = {}) click to toggle source

List account senders Return the senders that have tried to use this account. @param body @param [Hash] opts the optional parameters @return [Array<(Array<InlineResponse20040>, Fixnum, Hash)>] Array<InlineResponse20040> data, response status code and response headers

# File lib/MailchimpTransactional/api/senders_api.rb, line 68
def list(body = {})
  data = @api_client.call_api(:POST, '/senders/list', body)
  data
end
time_series(body = {}) click to toggle source

View sender history Return the recent history (hourly stats for the last 30 days) for a sender. @param body @param [Hash] opts the optional parameters @return [Array<(Array<InlineResponse20046>, Fixnum, Hash)>] Array<InlineResponse20046> data, response status code and response headers

# File lib/MailchimpTransactional/api/senders_api.rb, line 78
def time_series(body = {})
  data = @api_client.call_api(:POST, '/senders/time-series', body)
  data
end
verify_domain(body = {}) click to toggle source

Verify domain 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 Transactional API account, other accounts may not have their messages signed by that domain unless they also verify the domain. This prevents other Transactional API accounts from sending mail signed by your domain. @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20044, Fixnum, Hash)>] InlineResponse20044 data, response status code and response headers

# File lib/MailchimpTransactional/api/senders_api.rb, line 88
def verify_domain(body = {})
  data = @api_client.call_api(:POST, '/senders/verify-domain', body)
  data
end