class MailchimpTransactional::InboundApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/MailchimpTransactional/api/inbound_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 inbound domain Add an inbound domain to your account. @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse2006, Fixnum, Hash)>] InlineResponse2006 data, response status code and response headers

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

Add mailbox route Add a new mailbox route to an inbound domain. @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20010, Fixnum, Hash)>] InlineResponse20010 data, response status code and response headers

# File lib/MailchimpTransactional/api/inbound_api.rb, line 38
def add_route(body = {})
  data = @api_client.call_api(:POST, '/inbound/add-route', body)
  data
end
check_domain(body = {}) click to toggle source

Check domain settings Check the MX settings for an inbound domain. The domain must have already been added with the add-domain call. @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse2007, Fixnum, Hash)>] InlineResponse2007 data, response status code and response headers

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

Delete inbound domain Delete an inbound domain from the account. All mail will stop routing for this domain immediately. @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse2008, Fixnum, Hash)>] InlineResponse2008 data, response status code and response headers

# File lib/MailchimpTransactional/api/inbound_api.rb, line 58
def delete_domain(body = {})
  data = @api_client.call_api(:POST, '/inbound/delete-domain', body)
  data
end
delete_route(body = {}) click to toggle source

Delete mailbox route Delete an existing inbound mailbox route. @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20012, Fixnum, Hash)>] InlineResponse20012 data, response status code and response headers

# File lib/MailchimpTransactional/api/inbound_api.rb, line 68
def delete_route(body = {})
  data = @api_client.call_api(:POST, '/inbound/delete-route', body)
  data
end
domains(body = {}) click to toggle source

List inbound domains List the domains that have been configured for inbound delivery. @param body @param [Hash] opts the optional parameters @return [Array<(Array<InlineResponse2005>, Fixnum, Hash)>] Array<InlineResponse2005> data, response status code and response headers

# File lib/MailchimpTransactional/api/inbound_api.rb, line 78
def domains(body = {})
  data = @api_client.call_api(:POST, '/inbound/domains', body)
  data
end
routes(body = {}) click to toggle source

List mailbox routes List the mailbox routes defined for an inbound domain. @param body @param [Hash] opts the optional parameters @return [Array<(Array<InlineResponse2009>, Fixnum, Hash)>] Array<InlineResponse2009> data, response status code and response headers

# File lib/MailchimpTransactional/api/inbound_api.rb, line 88
def routes(body = {})
  data = @api_client.call_api(:POST, '/inbound/routes', body)
  data
end
send_raw(body = {}) click to toggle source

Send mime document Take a raw MIME document destined for a domain with inbound domains set up, and send it to the inbound hook exactly as if it had been sent over SMTP. @param body @param [Hash] opts the optional parameters @return [Array<(Array<InlineResponse20013>, Fixnum, Hash)>] Array<InlineResponse20013> data, response status code and response headers

# File lib/MailchimpTransactional/api/inbound_api.rb, line 98
def send_raw(body = {})
  data = @api_client.call_api(:POST, '/inbound/send-raw', body)
  data
end
update_route(body = {}) click to toggle source

Update mailbox route Update the pattern or webhook of an existing inbound mailbox route. If null is provided for any fields, the values will remain unchanged. @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20011, Fixnum, Hash)>] InlineResponse20011 data, response status code and response headers

# File lib/MailchimpTransactional/api/inbound_api.rb, line 108
def update_route(body = {})
  data = @api_client.call_api(:POST, '/inbound/update-route', body)
  data
end