class MailchimpTransactional::RejectsApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

add(body = {}) click to toggle source

Add email to denylist Adds an email to your email rejection denylist. Addresses that you add manually will never expire and there is no reputation penalty for removing them from your denylist. Attempting to denylist an address that has been added to the allowlist will have no effect. @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20037, Fixnum, Hash)>] InlineResponse20037 data, response status code and response headers

# File lib/MailchimpTransactional/api/rejects_api.rb, line 28
def add(body = {})
  data = @api_client.call_api(:POST, '/rejects/add', body)
  data
end
delete(body = {}) click to toggle source

Delete email from denylist Deletes an email rejection. There is no limit to how many rejections you can remove from your denylist, but keep in mind that each deletion has an affect on your reputation. @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20039, Fixnum, Hash)>] InlineResponse20039 data, response status code and response headers

# File lib/MailchimpTransactional/api/rejects_api.rb, line 38
def delete(body = {})
  data = @api_client.call_api(:POST, '/rejects/delete', body)
  data
end
list(body = {}) click to toggle source

List denylisted emails Retrieves your email rejection denylist. You can provide an email address to limit the results. Returns up to 1000 results. By default, entries that have expired are excluded from the results; set include_expired to true to include them. @param body @param [Hash] opts the optional parameters @return [Array<(Array<InlineResponse20038>, Fixnum, Hash)>] Array<InlineResponse20038> data, response status code and response headers

# File lib/MailchimpTransactional/api/rejects_api.rb, line 48
def list(body = {})
  data = @api_client.call_api(:POST, '/rejects/list', body)
  data
end