mailslurp_client 17.2.0 → 17.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/mailslurp_client/api/campaign_probe_controller_api.rb +138 -0
- data/lib/mailslurp_client/api/domain_monitor_controller_api.rb +264 -0
- data/lib/mailslurp_client/api/email_audit_controller_api.rb +334 -0
- data/lib/mailslurp_client/api/email_controller_api.rb +124 -0
- data/lib/mailslurp_client/api/inbox_controller_api.rb +4 -4
- data/lib/mailslurp_client/api/phone_controller_api.rb +1312 -81
- data/lib/mailslurp_client/api/sms_controller_api.rb +125 -0
- data/lib/mailslurp_client/api/tools_controller_api.rb +806 -0
- data/lib/mailslurp_client/models/abstract_webhook_payload.rb +15 -15
- data/lib/mailslurp_client/models/acquire_phone_pool_lease_options.rb +233 -0
- data/lib/mailslurp_client/models/add_phone_pool_numbers_options.rb +213 -0
- data/lib/mailslurp_client/models/ai_transform_mapping_projection.rb +27 -27
- data/lib/mailslurp_client/models/ai_transform_projection.rb +28 -28
- data/lib/mailslurp_client/models/alias_projection.rb +45 -45
- data/lib/mailslurp_client/models/alias_thread_projection.rb +42 -42
- data/lib/mailslurp_client/models/analyze_dmarc_report_options.rb +248 -0
- data/lib/mailslurp_client/models/analyze_dmarc_report_results.rb +386 -0
- data/lib/mailslurp_client/models/analyze_email_headers_options.rb +240 -0
- data/lib/mailslurp_client/models/analyze_email_headers_results.rb +275 -0
- data/lib/mailslurp_client/models/attachment_projection.rb +50 -50
- data/lib/mailslurp_client/models/available_phone_number_dto.rb +325 -0
- data/lib/mailslurp_client/models/available_phone_numbers_result.rb +236 -0
- data/lib/mailslurp_client/models/bounce_projection.rb +28 -28
- data/lib/mailslurp_client/models/bounce_recipient_projection.rb +10 -10
- data/lib/mailslurp_client/models/campaign_probe_run_comparison_dto.rb +397 -0
- data/lib/mailslurp_client/models/check_campaign_probe_options.rb +371 -0
- data/lib/mailslurp_client/models/check_campaign_probe_results.rb +482 -0
- data/lib/mailslurp_client/models/check_dns_propagation_options.rb +297 -0
- data/lib/mailslurp_client/models/check_dns_propagation_results.rb +361 -0
- data/lib/mailslurp_client/models/check_domain_monitor_options.rb +243 -0
- data/lib/mailslurp_client/models/check_domain_monitor_results.rb +398 -0
- data/lib/mailslurp_client/models/check_email_audit_options.rb +405 -0
- data/lib/mailslurp_client/models/check_email_auth_stack_options.rb +248 -0
- data/lib/mailslurp_client/models/check_email_auth_stack_results.rb +462 -0
- data/lib/mailslurp_client/models/check_email_blacklist_options.rb +241 -0
- data/lib/mailslurp_client/models/check_email_blacklist_results.rb +366 -0
- data/lib/mailslurp_client/models/connector_event_projection.rb +42 -42
- data/lib/mailslurp_client/models/connector_projection.rb +42 -42
- data/lib/mailslurp_client/models/contact_projection.rb +15 -15
- data/lib/mailslurp_client/models/create_email_audit_options.rb +394 -0
- data/lib/mailslurp_client/models/create_phone_number_options.rb +25 -4
- data/lib/mailslurp_client/models/create_phone_pool_options.rb +220 -0
- data/lib/mailslurp_client/models/create_phone_provisioning_job_item_options.rb +256 -0
- data/lib/mailslurp_client/models/create_phone_provisioning_job_options.rb +284 -0
- data/lib/mailslurp_client/models/dmarc_report_metadata.rb +308 -0
- data/lib/mailslurp_client/models/dmarc_report_source_summary.rb +274 -0
- data/lib/mailslurp_client/models/dns_propagation_resolver_result.rb +252 -0
- data/lib/mailslurp_client/models/domain_monitor_run_comparison_dto.rb +369 -0
- data/lib/mailslurp_client/models/domain_monitor_summary_dto.rb +248 -0
- data/lib/mailslurp_client/models/email_audit_analysis_result.rb +620 -0
- data/lib/mailslurp_client/models/email_audit_comparison_dto.rb +411 -0
- data/lib/mailslurp_client/models/email_audit_dto.rb +308 -0
- data/lib/mailslurp_client/models/email_audit_spelling_issue.rb +276 -0
- data/lib/mailslurp_client/models/email_audit_url_issue.rb +236 -0
- data/lib/mailslurp_client/models/email_blacklist_ip_result.rb +242 -0
- data/lib/mailslurp_client/models/email_blacklist_listing_result.rb +258 -0
- data/lib/mailslurp_client/models/email_header_analysis_summary.rb +242 -0
- data/lib/mailslurp_client/models/email_header_received_hop.rb +242 -0
- data/lib/mailslurp_client/models/email_projection.rb +88 -88
- data/lib/mailslurp_client/models/email_thread_projection.rb +54 -54
- data/lib/mailslurp_client/models/entity_automation_item_projection.rb +33 -33
- data/lib/mailslurp_client/models/entity_event_item_projection.rb +42 -42
- data/lib/mailslurp_client/models/entity_favourite_item_projection.rb +29 -29
- data/lib/mailslurp_client/models/expired_inbox_record_projection.rb +27 -27
- data/lib/mailslurp_client/models/generate_spf_record_options.rb +357 -0
- data/lib/mailslurp_client/models/generate_spf_record_results.rb +318 -0
- data/lib/mailslurp_client/models/get_or_create_phone_pool_options.rb +220 -0
- data/lib/mailslurp_client/models/group_projection.rb +15 -15
- data/lib/mailslurp_client/models/guest_portal_user_projection.rb +47 -47
- data/lib/mailslurp_client/models/imap_email_projection.rb +18 -18
- data/lib/mailslurp_client/models/inbox_forwarder_event_projection.rb +21 -21
- data/lib/mailslurp_client/models/inbox_replier_event_projection.rb +33 -33
- data/lib/mailslurp_client/models/list_unsubscribe_recipient_projection.rb +19 -19
- data/lib/mailslurp_client/models/lookup_dkim_domain_options.rb +275 -0
- data/lib/mailslurp_client/models/lookup_dkim_domain_results.rb +304 -0
- data/lib/mailslurp_client/models/lookup_ptr_options.rb +241 -0
- data/lib/mailslurp_client/models/lookup_ptr_results.rb +305 -0
- data/lib/mailslurp_client/models/lookup_spf_domain_options.rb +240 -0
- data/lib/mailslurp_client/models/lookup_spf_domain_results.rb +305 -0
- data/lib/mailslurp_client/models/missed_email_projection.rb +28 -28
- data/lib/mailslurp_client/models/missed_sms_projection.rb +32 -32
- data/lib/mailslurp_client/models/opt_in_identity_projection.rb +18 -18
- data/lib/mailslurp_client/models/page_ai_transform_mapping_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_ai_transform_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_ai_transform_result_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_alias.rb +19 -19
- data/lib/mailslurp_client/models/page_alias_thread_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_attachment_entity.rb +19 -19
- data/lib/mailslurp_client/models/page_bounced_email.rb +19 -19
- data/lib/mailslurp_client/models/page_bounced_recipients.rb +19 -19
- data/lib/mailslurp_client/models/page_complaint.rb +19 -19
- data/lib/mailslurp_client/models/page_connector.rb +19 -19
- data/lib/mailslurp_client/models/page_connector_events.rb +19 -19
- data/lib/mailslurp_client/models/page_contact_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_delivery_status.rb +19 -19
- data/lib/mailslurp_client/models/page_device_preview_run_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_email_preview.rb +19 -19
- data/lib/mailslurp_client/models/page_email_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_email_thread_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_email_validation_request.rb +19 -19
- data/lib/mailslurp_client/models/page_entity_automation_items.rb +19 -19
- data/lib/mailslurp_client/models/page_entity_event_items.rb +19 -19
- data/lib/mailslurp_client/models/page_entity_favourite_items.rb +19 -19
- data/lib/mailslurp_client/models/page_expired_inbox_record_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_group_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_guest_portal_users.rb +19 -19
- data/lib/mailslurp_client/models/page_inbox_forwarder_dto.rb +19 -19
- data/lib/mailslurp_client/models/page_inbox_forwarder_events.rb +19 -19
- data/lib/mailslurp_client/models/page_inbox_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_inbox_replier_dto.rb +19 -19
- data/lib/mailslurp_client/models/page_inbox_replier_events.rb +19 -19
- data/lib/mailslurp_client/models/page_inbox_tags.rb +19 -19
- data/lib/mailslurp_client/models/page_list_unsubscribe_recipients.rb +19 -19
- data/lib/mailslurp_client/models/page_missed_email_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_missed_sms_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_opt_in_identity_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_organization_inbox_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_phone_message_thread_item_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_phone_message_thread_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_phone_number_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_phone_number_release_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_plus_address_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_reputation_items.rb +19 -19
- data/lib/mailslurp_client/models/page_ruleset_dto.rb +19 -19
- data/lib/mailslurp_client/models/page_scheduled_jobs.rb +19 -19
- data/lib/mailslurp_client/models/page_sent_email_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_sent_email_with_queue_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_sent_sms_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_sms_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_template_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_tracking_pixel_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_unknown_missed_email_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_webhook_endpoint_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_webhook_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_webhook_result.rb +19 -19
- data/lib/mailslurp_client/models/pageable_object.rb +22 -22
- data/lib/mailslurp_client/models/phone_message_thread_item_projection.rb +18 -18
- data/lib/mailslurp_client/models/phone_number_dto.rb +49 -4
- data/lib/mailslurp_client/models/phone_number_line_type_intelligence_dto.rb +242 -0
- data/lib/mailslurp_client/models/phone_number_line_type_lookup_dto.rb +286 -0
- data/lib/mailslurp_client/models/phone_number_projection.rb +80 -35
- data/lib/mailslurp_client/models/phone_number_release_projection.rb +39 -39
- data/lib/mailslurp_client/models/phone_pool_detail_dto.rb +334 -0
- data/lib/mailslurp_client/models/phone_pool_dto.rb +318 -0
- data/lib/mailslurp_client/models/phone_pool_lease_dto.rb +351 -0
- data/lib/mailslurp_client/models/phone_pool_member_dto.rb +333 -0
- data/lib/mailslurp_client/models/phone_provider_capabilities_result.rb +284 -0
- data/lib/mailslurp_client/models/phone_provisioning_job_dto.rb +434 -0
- data/lib/mailslurp_client/models/phone_provisioning_job_item_dto.rb +336 -0
- data/lib/mailslurp_client/models/phone_sms_prepaid_credit_dto.rb +340 -0
- data/lib/mailslurp_client/models/phone_sms_prepaid_credits_dto.rb +241 -0
- data/lib/mailslurp_client/models/plus_address_projection.rb +27 -27
- data/lib/mailslurp_client/models/recipient_projection.rb +13 -13
- data/lib/mailslurp_client/models/reputation_item_projection.rb +41 -41
- data/lib/mailslurp_client/models/search_available_phone_numbers_options.rb +377 -0
- data/lib/mailslurp_client/models/sender_projection.rb +13 -13
- data/lib/mailslurp_client/models/sent_email_projection.rb +63 -63
- data/lib/mailslurp_client/models/sent_sms_projection.rb +18 -18
- data/lib/mailslurp_client/models/sms_projection.rb +18 -18
- data/lib/mailslurp_client/models/smtp_auth_diagnostic_result.rb +235 -0
- data/lib/mailslurp_client/models/smtp_diagnostic_step.rb +236 -0
- data/lib/mailslurp_client/models/smtp_tls_diagnostic_result.rb +245 -0
- data/lib/mailslurp_client/models/sort_object.rb +10 -10
- data/lib/mailslurp_client/models/spf_mechanism_result.rb +229 -0
- data/lib/mailslurp_client/models/template_projection.rb +41 -41
- data/lib/mailslurp_client/models/test_smtp_server_options.rb +337 -0
- data/lib/mailslurp_client/models/test_smtp_server_results.rb +297 -0
- data/lib/mailslurp_client/models/tracking_pixel_projection.rb +27 -27
- data/lib/mailslurp_client/models/unknown_missed_email_projection.rb +27 -27
- data/lib/mailslurp_client/models/update_phone_pool_options.rb +215 -0
- data/lib/mailslurp_client/models/validation_dto.rb +1 -5
- data/lib/mailslurp_client/models/webhook_projection.rb +45 -45
- data/lib/mailslurp_client/version.rb +1 -1
- data/lib/mailslurp_client.rb +67 -0
- metadata +69 -2
|
@@ -19,6 +19,502 @@ module MailSlurpClient
|
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
|
+
# Parse and summarize a DMARC aggregate XML report
|
|
23
|
+
# @param analyze_dmarc_report_options [AnalyzeDmarcReportOptions]
|
|
24
|
+
# @param [Hash] opts the optional parameters
|
|
25
|
+
# @return [AnalyzeDmarcReportResults]
|
|
26
|
+
def analyze_dmarc_report(analyze_dmarc_report_options, opts = {})
|
|
27
|
+
data, _status_code, _headers = analyze_dmarc_report_with_http_info(analyze_dmarc_report_options, opts)
|
|
28
|
+
data
|
|
29
|
+
end
|
|
30
|
+
|
|
31
|
+
# Parse and summarize a DMARC aggregate XML report
|
|
32
|
+
# @param analyze_dmarc_report_options [AnalyzeDmarcReportOptions]
|
|
33
|
+
# @param [Hash] opts the optional parameters
|
|
34
|
+
# @return [Array<(AnalyzeDmarcReportResults, Integer, Hash)>] AnalyzeDmarcReportResults data, response status code and response headers
|
|
35
|
+
def analyze_dmarc_report_with_http_info(analyze_dmarc_report_options, opts = {})
|
|
36
|
+
if @api_client.config.debugging
|
|
37
|
+
@api_client.config.logger.debug 'Calling API: ToolsControllerApi.analyze_dmarc_report ...'
|
|
38
|
+
end
|
|
39
|
+
# verify the required parameter 'analyze_dmarc_report_options' is set
|
|
40
|
+
if @api_client.config.client_side_validation && analyze_dmarc_report_options.nil?
|
|
41
|
+
fail ArgumentError, "Missing the required parameter 'analyze_dmarc_report_options' when calling ToolsControllerApi.analyze_dmarc_report"
|
|
42
|
+
end
|
|
43
|
+
# resource path
|
|
44
|
+
local_var_path = '/tools/analyze-dmarc-report'
|
|
45
|
+
|
|
46
|
+
# query parameters
|
|
47
|
+
query_params = opts[:query_params] || {}
|
|
48
|
+
|
|
49
|
+
# header parameters
|
|
50
|
+
header_params = opts[:header_params] || {}
|
|
51
|
+
# HTTP header 'Accept' (if needed)
|
|
52
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
|
53
|
+
# HTTP header 'Content-Type'
|
|
54
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
55
|
+
|
|
56
|
+
# form parameters
|
|
57
|
+
form_params = opts[:form_params] || {}
|
|
58
|
+
|
|
59
|
+
# http body (model)
|
|
60
|
+
post_body = opts[:body] || @api_client.object_to_http_body(analyze_dmarc_report_options)
|
|
61
|
+
|
|
62
|
+
# return_type
|
|
63
|
+
return_type = opts[:return_type] || 'AnalyzeDmarcReportResults'
|
|
64
|
+
|
|
65
|
+
# auth_names
|
|
66
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
|
67
|
+
|
|
68
|
+
new_options = opts.merge(
|
|
69
|
+
:header_params => header_params,
|
|
70
|
+
:query_params => query_params,
|
|
71
|
+
:form_params => form_params,
|
|
72
|
+
:body => post_body,
|
|
73
|
+
:auth_names => auth_names,
|
|
74
|
+
:return_type => return_type
|
|
75
|
+
)
|
|
76
|
+
|
|
77
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
78
|
+
if @api_client.config.debugging
|
|
79
|
+
@api_client.config.logger.debug "API called: ToolsControllerApi#analyze_dmarc_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
80
|
+
end
|
|
81
|
+
return data, status_code, headers
|
|
82
|
+
end
|
|
83
|
+
|
|
84
|
+
# Analyze email headers for auth results and delivery path
|
|
85
|
+
# @param analyze_email_headers_options [AnalyzeEmailHeadersOptions]
|
|
86
|
+
# @param [Hash] opts the optional parameters
|
|
87
|
+
# @return [AnalyzeEmailHeadersResults]
|
|
88
|
+
def analyze_email_headers(analyze_email_headers_options, opts = {})
|
|
89
|
+
data, _status_code, _headers = analyze_email_headers_with_http_info(analyze_email_headers_options, opts)
|
|
90
|
+
data
|
|
91
|
+
end
|
|
92
|
+
|
|
93
|
+
# Analyze email headers for auth results and delivery path
|
|
94
|
+
# @param analyze_email_headers_options [AnalyzeEmailHeadersOptions]
|
|
95
|
+
# @param [Hash] opts the optional parameters
|
|
96
|
+
# @return [Array<(AnalyzeEmailHeadersResults, Integer, Hash)>] AnalyzeEmailHeadersResults data, response status code and response headers
|
|
97
|
+
def analyze_email_headers_with_http_info(analyze_email_headers_options, opts = {})
|
|
98
|
+
if @api_client.config.debugging
|
|
99
|
+
@api_client.config.logger.debug 'Calling API: ToolsControllerApi.analyze_email_headers ...'
|
|
100
|
+
end
|
|
101
|
+
# verify the required parameter 'analyze_email_headers_options' is set
|
|
102
|
+
if @api_client.config.client_side_validation && analyze_email_headers_options.nil?
|
|
103
|
+
fail ArgumentError, "Missing the required parameter 'analyze_email_headers_options' when calling ToolsControllerApi.analyze_email_headers"
|
|
104
|
+
end
|
|
105
|
+
# resource path
|
|
106
|
+
local_var_path = '/tools/analyze-email-headers'
|
|
107
|
+
|
|
108
|
+
# query parameters
|
|
109
|
+
query_params = opts[:query_params] || {}
|
|
110
|
+
|
|
111
|
+
# header parameters
|
|
112
|
+
header_params = opts[:header_params] || {}
|
|
113
|
+
# HTTP header 'Accept' (if needed)
|
|
114
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
|
115
|
+
# HTTP header 'Content-Type'
|
|
116
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
117
|
+
|
|
118
|
+
# form parameters
|
|
119
|
+
form_params = opts[:form_params] || {}
|
|
120
|
+
|
|
121
|
+
# http body (model)
|
|
122
|
+
post_body = opts[:body] || @api_client.object_to_http_body(analyze_email_headers_options)
|
|
123
|
+
|
|
124
|
+
# return_type
|
|
125
|
+
return_type = opts[:return_type] || 'AnalyzeEmailHeadersResults'
|
|
126
|
+
|
|
127
|
+
# auth_names
|
|
128
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
|
129
|
+
|
|
130
|
+
new_options = opts.merge(
|
|
131
|
+
:header_params => header_params,
|
|
132
|
+
:query_params => query_params,
|
|
133
|
+
:form_params => form_params,
|
|
134
|
+
:body => post_body,
|
|
135
|
+
:auth_names => auth_names,
|
|
136
|
+
:return_type => return_type
|
|
137
|
+
)
|
|
138
|
+
|
|
139
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
140
|
+
if @api_client.config.debugging
|
|
141
|
+
@api_client.config.logger.debug "API called: ToolsControllerApi#analyze_email_headers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
142
|
+
end
|
|
143
|
+
return data, status_code, headers
|
|
144
|
+
end
|
|
145
|
+
|
|
146
|
+
# Run a one-shot free campaign probe preflight check
|
|
147
|
+
# @param check_campaign_probe_options [CheckCampaignProbeOptions]
|
|
148
|
+
# @param [Hash] opts the optional parameters
|
|
149
|
+
# @return [CheckCampaignProbeResults]
|
|
150
|
+
def check_campaign_probe(check_campaign_probe_options, opts = {})
|
|
151
|
+
data, _status_code, _headers = check_campaign_probe_with_http_info(check_campaign_probe_options, opts)
|
|
152
|
+
data
|
|
153
|
+
end
|
|
154
|
+
|
|
155
|
+
# Run a one-shot free campaign probe preflight check
|
|
156
|
+
# @param check_campaign_probe_options [CheckCampaignProbeOptions]
|
|
157
|
+
# @param [Hash] opts the optional parameters
|
|
158
|
+
# @return [Array<(CheckCampaignProbeResults, Integer, Hash)>] CheckCampaignProbeResults data, response status code and response headers
|
|
159
|
+
def check_campaign_probe_with_http_info(check_campaign_probe_options, opts = {})
|
|
160
|
+
if @api_client.config.debugging
|
|
161
|
+
@api_client.config.logger.debug 'Calling API: ToolsControllerApi.check_campaign_probe ...'
|
|
162
|
+
end
|
|
163
|
+
# verify the required parameter 'check_campaign_probe_options' is set
|
|
164
|
+
if @api_client.config.client_side_validation && check_campaign_probe_options.nil?
|
|
165
|
+
fail ArgumentError, "Missing the required parameter 'check_campaign_probe_options' when calling ToolsControllerApi.check_campaign_probe"
|
|
166
|
+
end
|
|
167
|
+
# resource path
|
|
168
|
+
local_var_path = '/tools/check-campaign-probe'
|
|
169
|
+
|
|
170
|
+
# query parameters
|
|
171
|
+
query_params = opts[:query_params] || {}
|
|
172
|
+
|
|
173
|
+
# header parameters
|
|
174
|
+
header_params = opts[:header_params] || {}
|
|
175
|
+
# HTTP header 'Accept' (if needed)
|
|
176
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
|
177
|
+
# HTTP header 'Content-Type'
|
|
178
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
179
|
+
|
|
180
|
+
# form parameters
|
|
181
|
+
form_params = opts[:form_params] || {}
|
|
182
|
+
|
|
183
|
+
# http body (model)
|
|
184
|
+
post_body = opts[:body] || @api_client.object_to_http_body(check_campaign_probe_options)
|
|
185
|
+
|
|
186
|
+
# return_type
|
|
187
|
+
return_type = opts[:return_type] || 'CheckCampaignProbeResults'
|
|
188
|
+
|
|
189
|
+
# auth_names
|
|
190
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
|
191
|
+
|
|
192
|
+
new_options = opts.merge(
|
|
193
|
+
:header_params => header_params,
|
|
194
|
+
:query_params => query_params,
|
|
195
|
+
:form_params => form_params,
|
|
196
|
+
:body => post_body,
|
|
197
|
+
:auth_names => auth_names,
|
|
198
|
+
:return_type => return_type
|
|
199
|
+
)
|
|
200
|
+
|
|
201
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
202
|
+
if @api_client.config.debugging
|
|
203
|
+
@api_client.config.logger.debug "API called: ToolsControllerApi#check_campaign_probe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
204
|
+
end
|
|
205
|
+
return data, status_code, headers
|
|
206
|
+
end
|
|
207
|
+
|
|
208
|
+
# Check DNS propagation for a host and record type across configured resolvers
|
|
209
|
+
# @param check_dns_propagation_options [CheckDnsPropagationOptions]
|
|
210
|
+
# @param [Hash] opts the optional parameters
|
|
211
|
+
# @return [CheckDnsPropagationResults]
|
|
212
|
+
def check_dns_propagation(check_dns_propagation_options, opts = {})
|
|
213
|
+
data, _status_code, _headers = check_dns_propagation_with_http_info(check_dns_propagation_options, opts)
|
|
214
|
+
data
|
|
215
|
+
end
|
|
216
|
+
|
|
217
|
+
# Check DNS propagation for a host and record type across configured resolvers
|
|
218
|
+
# @param check_dns_propagation_options [CheckDnsPropagationOptions]
|
|
219
|
+
# @param [Hash] opts the optional parameters
|
|
220
|
+
# @return [Array<(CheckDnsPropagationResults, Integer, Hash)>] CheckDnsPropagationResults data, response status code and response headers
|
|
221
|
+
def check_dns_propagation_with_http_info(check_dns_propagation_options, opts = {})
|
|
222
|
+
if @api_client.config.debugging
|
|
223
|
+
@api_client.config.logger.debug 'Calling API: ToolsControllerApi.check_dns_propagation ...'
|
|
224
|
+
end
|
|
225
|
+
# verify the required parameter 'check_dns_propagation_options' is set
|
|
226
|
+
if @api_client.config.client_side_validation && check_dns_propagation_options.nil?
|
|
227
|
+
fail ArgumentError, "Missing the required parameter 'check_dns_propagation_options' when calling ToolsControllerApi.check_dns_propagation"
|
|
228
|
+
end
|
|
229
|
+
# resource path
|
|
230
|
+
local_var_path = '/tools/check-dns-propagation'
|
|
231
|
+
|
|
232
|
+
# query parameters
|
|
233
|
+
query_params = opts[:query_params] || {}
|
|
234
|
+
|
|
235
|
+
# header parameters
|
|
236
|
+
header_params = opts[:header_params] || {}
|
|
237
|
+
# HTTP header 'Accept' (if needed)
|
|
238
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
|
239
|
+
# HTTP header 'Content-Type'
|
|
240
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
241
|
+
|
|
242
|
+
# form parameters
|
|
243
|
+
form_params = opts[:form_params] || {}
|
|
244
|
+
|
|
245
|
+
# http body (model)
|
|
246
|
+
post_body = opts[:body] || @api_client.object_to_http_body(check_dns_propagation_options)
|
|
247
|
+
|
|
248
|
+
# return_type
|
|
249
|
+
return_type = opts[:return_type] || 'CheckDnsPropagationResults'
|
|
250
|
+
|
|
251
|
+
# auth_names
|
|
252
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
|
253
|
+
|
|
254
|
+
new_options = opts.merge(
|
|
255
|
+
:header_params => header_params,
|
|
256
|
+
:query_params => query_params,
|
|
257
|
+
:form_params => form_params,
|
|
258
|
+
:body => post_body,
|
|
259
|
+
:auth_names => auth_names,
|
|
260
|
+
:return_type => return_type
|
|
261
|
+
)
|
|
262
|
+
|
|
263
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
264
|
+
if @api_client.config.debugging
|
|
265
|
+
@api_client.config.logger.debug "API called: ToolsControllerApi#check_dns_propagation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
266
|
+
end
|
|
267
|
+
return data, status_code, headers
|
|
268
|
+
end
|
|
269
|
+
|
|
270
|
+
# Run a one-shot free domain monitor posture check
|
|
271
|
+
# @param check_domain_monitor_options [CheckDomainMonitorOptions]
|
|
272
|
+
# @param [Hash] opts the optional parameters
|
|
273
|
+
# @return [CheckDomainMonitorResults]
|
|
274
|
+
def check_domain_monitor(check_domain_monitor_options, opts = {})
|
|
275
|
+
data, _status_code, _headers = check_domain_monitor_with_http_info(check_domain_monitor_options, opts)
|
|
276
|
+
data
|
|
277
|
+
end
|
|
278
|
+
|
|
279
|
+
# Run a one-shot free domain monitor posture check
|
|
280
|
+
# @param check_domain_monitor_options [CheckDomainMonitorOptions]
|
|
281
|
+
# @param [Hash] opts the optional parameters
|
|
282
|
+
# @return [Array<(CheckDomainMonitorResults, Integer, Hash)>] CheckDomainMonitorResults data, response status code and response headers
|
|
283
|
+
def check_domain_monitor_with_http_info(check_domain_monitor_options, opts = {})
|
|
284
|
+
if @api_client.config.debugging
|
|
285
|
+
@api_client.config.logger.debug 'Calling API: ToolsControllerApi.check_domain_monitor ...'
|
|
286
|
+
end
|
|
287
|
+
# verify the required parameter 'check_domain_monitor_options' is set
|
|
288
|
+
if @api_client.config.client_side_validation && check_domain_monitor_options.nil?
|
|
289
|
+
fail ArgumentError, "Missing the required parameter 'check_domain_monitor_options' when calling ToolsControllerApi.check_domain_monitor"
|
|
290
|
+
end
|
|
291
|
+
# resource path
|
|
292
|
+
local_var_path = '/tools/check-domain-monitor'
|
|
293
|
+
|
|
294
|
+
# query parameters
|
|
295
|
+
query_params = opts[:query_params] || {}
|
|
296
|
+
|
|
297
|
+
# header parameters
|
|
298
|
+
header_params = opts[:header_params] || {}
|
|
299
|
+
# HTTP header 'Accept' (if needed)
|
|
300
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
|
301
|
+
# HTTP header 'Content-Type'
|
|
302
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
303
|
+
|
|
304
|
+
# form parameters
|
|
305
|
+
form_params = opts[:form_params] || {}
|
|
306
|
+
|
|
307
|
+
# http body (model)
|
|
308
|
+
post_body = opts[:body] || @api_client.object_to_http_body(check_domain_monitor_options)
|
|
309
|
+
|
|
310
|
+
# return_type
|
|
311
|
+
return_type = opts[:return_type] || 'CheckDomainMonitorResults'
|
|
312
|
+
|
|
313
|
+
# auth_names
|
|
314
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
|
315
|
+
|
|
316
|
+
new_options = opts.merge(
|
|
317
|
+
:header_params => header_params,
|
|
318
|
+
:query_params => query_params,
|
|
319
|
+
:form_params => form_params,
|
|
320
|
+
:body => post_body,
|
|
321
|
+
:auth_names => auth_names,
|
|
322
|
+
:return_type => return_type
|
|
323
|
+
)
|
|
324
|
+
|
|
325
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
326
|
+
if @api_client.config.debugging
|
|
327
|
+
@api_client.config.logger.debug "API called: ToolsControllerApi#check_domain_monitor\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
328
|
+
end
|
|
329
|
+
return data, status_code, headers
|
|
330
|
+
end
|
|
331
|
+
|
|
332
|
+
# Run a one-shot free email audit across links, images, HTML, and client support
|
|
333
|
+
# @param check_email_audit_options [CheckEmailAuditOptions]
|
|
334
|
+
# @param [Hash] opts the optional parameters
|
|
335
|
+
# @return [EmailAuditAnalysisResult]
|
|
336
|
+
def check_email_audit(check_email_audit_options, opts = {})
|
|
337
|
+
data, _status_code, _headers = check_email_audit_with_http_info(check_email_audit_options, opts)
|
|
338
|
+
data
|
|
339
|
+
end
|
|
340
|
+
|
|
341
|
+
# Run a one-shot free email audit across links, images, HTML, and client support
|
|
342
|
+
# @param check_email_audit_options [CheckEmailAuditOptions]
|
|
343
|
+
# @param [Hash] opts the optional parameters
|
|
344
|
+
# @return [Array<(EmailAuditAnalysisResult, Integer, Hash)>] EmailAuditAnalysisResult data, response status code and response headers
|
|
345
|
+
def check_email_audit_with_http_info(check_email_audit_options, opts = {})
|
|
346
|
+
if @api_client.config.debugging
|
|
347
|
+
@api_client.config.logger.debug 'Calling API: ToolsControllerApi.check_email_audit ...'
|
|
348
|
+
end
|
|
349
|
+
# verify the required parameter 'check_email_audit_options' is set
|
|
350
|
+
if @api_client.config.client_side_validation && check_email_audit_options.nil?
|
|
351
|
+
fail ArgumentError, "Missing the required parameter 'check_email_audit_options' when calling ToolsControllerApi.check_email_audit"
|
|
352
|
+
end
|
|
353
|
+
# resource path
|
|
354
|
+
local_var_path = '/tools/check-email-audit'
|
|
355
|
+
|
|
356
|
+
# query parameters
|
|
357
|
+
query_params = opts[:query_params] || {}
|
|
358
|
+
|
|
359
|
+
# header parameters
|
|
360
|
+
header_params = opts[:header_params] || {}
|
|
361
|
+
# HTTP header 'Accept' (if needed)
|
|
362
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
|
363
|
+
# HTTP header 'Content-Type'
|
|
364
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
365
|
+
|
|
366
|
+
# form parameters
|
|
367
|
+
form_params = opts[:form_params] || {}
|
|
368
|
+
|
|
369
|
+
# http body (model)
|
|
370
|
+
post_body = opts[:body] || @api_client.object_to_http_body(check_email_audit_options)
|
|
371
|
+
|
|
372
|
+
# return_type
|
|
373
|
+
return_type = opts[:return_type] || 'EmailAuditAnalysisResult'
|
|
374
|
+
|
|
375
|
+
# auth_names
|
|
376
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
|
377
|
+
|
|
378
|
+
new_options = opts.merge(
|
|
379
|
+
:header_params => header_params,
|
|
380
|
+
:query_params => query_params,
|
|
381
|
+
:form_params => form_params,
|
|
382
|
+
:body => post_body,
|
|
383
|
+
:auth_names => auth_names,
|
|
384
|
+
:return_type => return_type
|
|
385
|
+
)
|
|
386
|
+
|
|
387
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
388
|
+
if @api_client.config.debugging
|
|
389
|
+
@api_client.config.logger.debug "API called: ToolsControllerApi#check_email_audit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
390
|
+
end
|
|
391
|
+
return data, status_code, headers
|
|
392
|
+
end
|
|
393
|
+
|
|
394
|
+
# Run a one-shot combined SPF, DKIM, DMARC, BIMI, MX, MTA-STS, and TLS-RPT check
|
|
395
|
+
# @param check_email_auth_stack_options [CheckEmailAuthStackOptions]
|
|
396
|
+
# @param [Hash] opts the optional parameters
|
|
397
|
+
# @return [CheckEmailAuthStackResults]
|
|
398
|
+
def check_email_auth_stack(check_email_auth_stack_options, opts = {})
|
|
399
|
+
data, _status_code, _headers = check_email_auth_stack_with_http_info(check_email_auth_stack_options, opts)
|
|
400
|
+
data
|
|
401
|
+
end
|
|
402
|
+
|
|
403
|
+
# Run a one-shot combined SPF, DKIM, DMARC, BIMI, MX, MTA-STS, and TLS-RPT check
|
|
404
|
+
# @param check_email_auth_stack_options [CheckEmailAuthStackOptions]
|
|
405
|
+
# @param [Hash] opts the optional parameters
|
|
406
|
+
# @return [Array<(CheckEmailAuthStackResults, Integer, Hash)>] CheckEmailAuthStackResults data, response status code and response headers
|
|
407
|
+
def check_email_auth_stack_with_http_info(check_email_auth_stack_options, opts = {})
|
|
408
|
+
if @api_client.config.debugging
|
|
409
|
+
@api_client.config.logger.debug 'Calling API: ToolsControllerApi.check_email_auth_stack ...'
|
|
410
|
+
end
|
|
411
|
+
# verify the required parameter 'check_email_auth_stack_options' is set
|
|
412
|
+
if @api_client.config.client_side_validation && check_email_auth_stack_options.nil?
|
|
413
|
+
fail ArgumentError, "Missing the required parameter 'check_email_auth_stack_options' when calling ToolsControllerApi.check_email_auth_stack"
|
|
414
|
+
end
|
|
415
|
+
# resource path
|
|
416
|
+
local_var_path = '/tools/check-email-auth-stack'
|
|
417
|
+
|
|
418
|
+
# query parameters
|
|
419
|
+
query_params = opts[:query_params] || {}
|
|
420
|
+
|
|
421
|
+
# header parameters
|
|
422
|
+
header_params = opts[:header_params] || {}
|
|
423
|
+
# HTTP header 'Accept' (if needed)
|
|
424
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
|
425
|
+
# HTTP header 'Content-Type'
|
|
426
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
427
|
+
|
|
428
|
+
# form parameters
|
|
429
|
+
form_params = opts[:form_params] || {}
|
|
430
|
+
|
|
431
|
+
# http body (model)
|
|
432
|
+
post_body = opts[:body] || @api_client.object_to_http_body(check_email_auth_stack_options)
|
|
433
|
+
|
|
434
|
+
# return_type
|
|
435
|
+
return_type = opts[:return_type] || 'CheckEmailAuthStackResults'
|
|
436
|
+
|
|
437
|
+
# auth_names
|
|
438
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
|
439
|
+
|
|
440
|
+
new_options = opts.merge(
|
|
441
|
+
:header_params => header_params,
|
|
442
|
+
:query_params => query_params,
|
|
443
|
+
:form_params => form_params,
|
|
444
|
+
:body => post_body,
|
|
445
|
+
:auth_names => auth_names,
|
|
446
|
+
:return_type => return_type
|
|
447
|
+
)
|
|
448
|
+
|
|
449
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
450
|
+
if @api_client.config.debugging
|
|
451
|
+
@api_client.config.logger.debug "API called: ToolsControllerApi#check_email_auth_stack\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
452
|
+
end
|
|
453
|
+
return data, status_code, headers
|
|
454
|
+
end
|
|
455
|
+
|
|
456
|
+
# Check whether a domain or IP appears on configured DNS blacklists
|
|
457
|
+
# @param check_email_blacklist_options [CheckEmailBlacklistOptions]
|
|
458
|
+
# @param [Hash] opts the optional parameters
|
|
459
|
+
# @return [CheckEmailBlacklistResults]
|
|
460
|
+
def check_email_blacklist(check_email_blacklist_options, opts = {})
|
|
461
|
+
data, _status_code, _headers = check_email_blacklist_with_http_info(check_email_blacklist_options, opts)
|
|
462
|
+
data
|
|
463
|
+
end
|
|
464
|
+
|
|
465
|
+
# Check whether a domain or IP appears on configured DNS blacklists
|
|
466
|
+
# @param check_email_blacklist_options [CheckEmailBlacklistOptions]
|
|
467
|
+
# @param [Hash] opts the optional parameters
|
|
468
|
+
# @return [Array<(CheckEmailBlacklistResults, Integer, Hash)>] CheckEmailBlacklistResults data, response status code and response headers
|
|
469
|
+
def check_email_blacklist_with_http_info(check_email_blacklist_options, opts = {})
|
|
470
|
+
if @api_client.config.debugging
|
|
471
|
+
@api_client.config.logger.debug 'Calling API: ToolsControllerApi.check_email_blacklist ...'
|
|
472
|
+
end
|
|
473
|
+
# verify the required parameter 'check_email_blacklist_options' is set
|
|
474
|
+
if @api_client.config.client_side_validation && check_email_blacklist_options.nil?
|
|
475
|
+
fail ArgumentError, "Missing the required parameter 'check_email_blacklist_options' when calling ToolsControllerApi.check_email_blacklist"
|
|
476
|
+
end
|
|
477
|
+
# resource path
|
|
478
|
+
local_var_path = '/tools/check-email-blacklists'
|
|
479
|
+
|
|
480
|
+
# query parameters
|
|
481
|
+
query_params = opts[:query_params] || {}
|
|
482
|
+
|
|
483
|
+
# header parameters
|
|
484
|
+
header_params = opts[:header_params] || {}
|
|
485
|
+
# HTTP header 'Accept' (if needed)
|
|
486
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
|
487
|
+
# HTTP header 'Content-Type'
|
|
488
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
489
|
+
|
|
490
|
+
# form parameters
|
|
491
|
+
form_params = opts[:form_params] || {}
|
|
492
|
+
|
|
493
|
+
# http body (model)
|
|
494
|
+
post_body = opts[:body] || @api_client.object_to_http_body(check_email_blacklist_options)
|
|
495
|
+
|
|
496
|
+
# return_type
|
|
497
|
+
return_type = opts[:return_type] || 'CheckEmailBlacklistResults'
|
|
498
|
+
|
|
499
|
+
# auth_names
|
|
500
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
|
501
|
+
|
|
502
|
+
new_options = opts.merge(
|
|
503
|
+
:header_params => header_params,
|
|
504
|
+
:query_params => query_params,
|
|
505
|
+
:form_params => form_params,
|
|
506
|
+
:body => post_body,
|
|
507
|
+
:auth_names => auth_names,
|
|
508
|
+
:return_type => return_type
|
|
509
|
+
)
|
|
510
|
+
|
|
511
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
512
|
+
if @api_client.config.debugging
|
|
513
|
+
@api_client.config.logger.debug "API called: ToolsControllerApi#check_email_blacklist\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
514
|
+
end
|
|
515
|
+
return data, status_code, headers
|
|
516
|
+
end
|
|
517
|
+
|
|
22
518
|
# Check email client support for email HTML and CSS features
|
|
23
519
|
# @param check_email_features_client_support_options [CheckEmailFeaturesClientSupportOptions]
|
|
24
520
|
# @param [Hash] opts the optional parameters
|
|
@@ -382,6 +878,68 @@ module MailSlurpClient
|
|
|
382
878
|
return data, status_code, headers
|
|
383
879
|
end
|
|
384
880
|
|
|
881
|
+
# Create an SPF record
|
|
882
|
+
# @param generate_spf_record_options [GenerateSpfRecordOptions]
|
|
883
|
+
# @param [Hash] opts the optional parameters
|
|
884
|
+
# @return [GenerateSpfRecordResults]
|
|
885
|
+
def generate_spf_record(generate_spf_record_options, opts = {})
|
|
886
|
+
data, _status_code, _headers = generate_spf_record_with_http_info(generate_spf_record_options, opts)
|
|
887
|
+
data
|
|
888
|
+
end
|
|
889
|
+
|
|
890
|
+
# Create an SPF record
|
|
891
|
+
# @param generate_spf_record_options [GenerateSpfRecordOptions]
|
|
892
|
+
# @param [Hash] opts the optional parameters
|
|
893
|
+
# @return [Array<(GenerateSpfRecordResults, Integer, Hash)>] GenerateSpfRecordResults data, response status code and response headers
|
|
894
|
+
def generate_spf_record_with_http_info(generate_spf_record_options, opts = {})
|
|
895
|
+
if @api_client.config.debugging
|
|
896
|
+
@api_client.config.logger.debug 'Calling API: ToolsControllerApi.generate_spf_record ...'
|
|
897
|
+
end
|
|
898
|
+
# verify the required parameter 'generate_spf_record_options' is set
|
|
899
|
+
if @api_client.config.client_side_validation && generate_spf_record_options.nil?
|
|
900
|
+
fail ArgumentError, "Missing the required parameter 'generate_spf_record_options' when calling ToolsControllerApi.generate_spf_record"
|
|
901
|
+
end
|
|
902
|
+
# resource path
|
|
903
|
+
local_var_path = '/tools/generate-spf-record'
|
|
904
|
+
|
|
905
|
+
# query parameters
|
|
906
|
+
query_params = opts[:query_params] || {}
|
|
907
|
+
|
|
908
|
+
# header parameters
|
|
909
|
+
header_params = opts[:header_params] || {}
|
|
910
|
+
# HTTP header 'Accept' (if needed)
|
|
911
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
|
912
|
+
# HTTP header 'Content-Type'
|
|
913
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
914
|
+
|
|
915
|
+
# form parameters
|
|
916
|
+
form_params = opts[:form_params] || {}
|
|
917
|
+
|
|
918
|
+
# http body (model)
|
|
919
|
+
post_body = opts[:body] || @api_client.object_to_http_body(generate_spf_record_options)
|
|
920
|
+
|
|
921
|
+
# return_type
|
|
922
|
+
return_type = opts[:return_type] || 'GenerateSpfRecordResults'
|
|
923
|
+
|
|
924
|
+
# auth_names
|
|
925
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
|
926
|
+
|
|
927
|
+
new_options = opts.merge(
|
|
928
|
+
:header_params => header_params,
|
|
929
|
+
:query_params => query_params,
|
|
930
|
+
:form_params => form_params,
|
|
931
|
+
:body => post_body,
|
|
932
|
+
:auth_names => auth_names,
|
|
933
|
+
:return_type => return_type
|
|
934
|
+
)
|
|
935
|
+
|
|
936
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
937
|
+
if @api_client.config.debugging
|
|
938
|
+
@api_client.config.logger.debug "API called: ToolsControllerApi#generate_spf_record\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
939
|
+
end
|
|
940
|
+
return data, status_code, headers
|
|
941
|
+
end
|
|
942
|
+
|
|
385
943
|
# Create a TLS reporting record policy
|
|
386
944
|
# @param generate_tls_reporting_record_options [GenerateTlsReportingRecordOptions]
|
|
387
945
|
# @param [Hash] opts the optional parameters
|
|
@@ -757,6 +1315,68 @@ module MailSlurpClient
|
|
|
757
1315
|
return data, status_code, headers
|
|
758
1316
|
end
|
|
759
1317
|
|
|
1318
|
+
# Lookup and validate a DKIM record
|
|
1319
|
+
# @param lookup_dkim_domain_options [LookupDkimDomainOptions]
|
|
1320
|
+
# @param [Hash] opts the optional parameters
|
|
1321
|
+
# @return [LookupDkimDomainResults]
|
|
1322
|
+
def lookup_dkim_domain(lookup_dkim_domain_options, opts = {})
|
|
1323
|
+
data, _status_code, _headers = lookup_dkim_domain_with_http_info(lookup_dkim_domain_options, opts)
|
|
1324
|
+
data
|
|
1325
|
+
end
|
|
1326
|
+
|
|
1327
|
+
# Lookup and validate a DKIM record
|
|
1328
|
+
# @param lookup_dkim_domain_options [LookupDkimDomainOptions]
|
|
1329
|
+
# @param [Hash] opts the optional parameters
|
|
1330
|
+
# @return [Array<(LookupDkimDomainResults, Integer, Hash)>] LookupDkimDomainResults data, response status code and response headers
|
|
1331
|
+
def lookup_dkim_domain_with_http_info(lookup_dkim_domain_options, opts = {})
|
|
1332
|
+
if @api_client.config.debugging
|
|
1333
|
+
@api_client.config.logger.debug 'Calling API: ToolsControllerApi.lookup_dkim_domain ...'
|
|
1334
|
+
end
|
|
1335
|
+
# verify the required parameter 'lookup_dkim_domain_options' is set
|
|
1336
|
+
if @api_client.config.client_side_validation && lookup_dkim_domain_options.nil?
|
|
1337
|
+
fail ArgumentError, "Missing the required parameter 'lookup_dkim_domain_options' when calling ToolsControllerApi.lookup_dkim_domain"
|
|
1338
|
+
end
|
|
1339
|
+
# resource path
|
|
1340
|
+
local_var_path = '/tools/lookup-dkim-domain'
|
|
1341
|
+
|
|
1342
|
+
# query parameters
|
|
1343
|
+
query_params = opts[:query_params] || {}
|
|
1344
|
+
|
|
1345
|
+
# header parameters
|
|
1346
|
+
header_params = opts[:header_params] || {}
|
|
1347
|
+
# HTTP header 'Accept' (if needed)
|
|
1348
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
|
1349
|
+
# HTTP header 'Content-Type'
|
|
1350
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
1351
|
+
|
|
1352
|
+
# form parameters
|
|
1353
|
+
form_params = opts[:form_params] || {}
|
|
1354
|
+
|
|
1355
|
+
# http body (model)
|
|
1356
|
+
post_body = opts[:body] || @api_client.object_to_http_body(lookup_dkim_domain_options)
|
|
1357
|
+
|
|
1358
|
+
# return_type
|
|
1359
|
+
return_type = opts[:return_type] || 'LookupDkimDomainResults'
|
|
1360
|
+
|
|
1361
|
+
# auth_names
|
|
1362
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
|
1363
|
+
|
|
1364
|
+
new_options = opts.merge(
|
|
1365
|
+
:header_params => header_params,
|
|
1366
|
+
:query_params => query_params,
|
|
1367
|
+
:form_params => form_params,
|
|
1368
|
+
:body => post_body,
|
|
1369
|
+
:auth_names => auth_names,
|
|
1370
|
+
:return_type => return_type
|
|
1371
|
+
)
|
|
1372
|
+
|
|
1373
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
1374
|
+
if @api_client.config.debugging
|
|
1375
|
+
@api_client.config.logger.debug "API called: ToolsControllerApi#lookup_dkim_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1376
|
+
end
|
|
1377
|
+
return data, status_code, headers
|
|
1378
|
+
end
|
|
1379
|
+
|
|
760
1380
|
# Lookup a DMARC record policy
|
|
761
1381
|
# @param lookup_dmarc_domain_options [LookupDmarcDomainOptions]
|
|
762
1382
|
# @param [Hash] opts the optional parameters
|
|
@@ -943,6 +1563,130 @@ module MailSlurpClient
|
|
|
943
1563
|
return data, status_code, headers
|
|
944
1564
|
end
|
|
945
1565
|
|
|
1566
|
+
# Lookup PTR records for an IP address
|
|
1567
|
+
# @param lookup_ptr_options [LookupPtrOptions]
|
|
1568
|
+
# @param [Hash] opts the optional parameters
|
|
1569
|
+
# @return [LookupPtrResults]
|
|
1570
|
+
def lookup_ptr(lookup_ptr_options, opts = {})
|
|
1571
|
+
data, _status_code, _headers = lookup_ptr_with_http_info(lookup_ptr_options, opts)
|
|
1572
|
+
data
|
|
1573
|
+
end
|
|
1574
|
+
|
|
1575
|
+
# Lookup PTR records for an IP address
|
|
1576
|
+
# @param lookup_ptr_options [LookupPtrOptions]
|
|
1577
|
+
# @param [Hash] opts the optional parameters
|
|
1578
|
+
# @return [Array<(LookupPtrResults, Integer, Hash)>] LookupPtrResults data, response status code and response headers
|
|
1579
|
+
def lookup_ptr_with_http_info(lookup_ptr_options, opts = {})
|
|
1580
|
+
if @api_client.config.debugging
|
|
1581
|
+
@api_client.config.logger.debug 'Calling API: ToolsControllerApi.lookup_ptr ...'
|
|
1582
|
+
end
|
|
1583
|
+
# verify the required parameter 'lookup_ptr_options' is set
|
|
1584
|
+
if @api_client.config.client_side_validation && lookup_ptr_options.nil?
|
|
1585
|
+
fail ArgumentError, "Missing the required parameter 'lookup_ptr_options' when calling ToolsControllerApi.lookup_ptr"
|
|
1586
|
+
end
|
|
1587
|
+
# resource path
|
|
1588
|
+
local_var_path = '/tools/lookup-ptr'
|
|
1589
|
+
|
|
1590
|
+
# query parameters
|
|
1591
|
+
query_params = opts[:query_params] || {}
|
|
1592
|
+
|
|
1593
|
+
# header parameters
|
|
1594
|
+
header_params = opts[:header_params] || {}
|
|
1595
|
+
# HTTP header 'Accept' (if needed)
|
|
1596
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
|
1597
|
+
# HTTP header 'Content-Type'
|
|
1598
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
1599
|
+
|
|
1600
|
+
# form parameters
|
|
1601
|
+
form_params = opts[:form_params] || {}
|
|
1602
|
+
|
|
1603
|
+
# http body (model)
|
|
1604
|
+
post_body = opts[:body] || @api_client.object_to_http_body(lookup_ptr_options)
|
|
1605
|
+
|
|
1606
|
+
# return_type
|
|
1607
|
+
return_type = opts[:return_type] || 'LookupPtrResults'
|
|
1608
|
+
|
|
1609
|
+
# auth_names
|
|
1610
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
|
1611
|
+
|
|
1612
|
+
new_options = opts.merge(
|
|
1613
|
+
:header_params => header_params,
|
|
1614
|
+
:query_params => query_params,
|
|
1615
|
+
:form_params => form_params,
|
|
1616
|
+
:body => post_body,
|
|
1617
|
+
:auth_names => auth_names,
|
|
1618
|
+
:return_type => return_type
|
|
1619
|
+
)
|
|
1620
|
+
|
|
1621
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
1622
|
+
if @api_client.config.debugging
|
|
1623
|
+
@api_client.config.logger.debug "API called: ToolsControllerApi#lookup_ptr\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1624
|
+
end
|
|
1625
|
+
return data, status_code, headers
|
|
1626
|
+
end
|
|
1627
|
+
|
|
1628
|
+
# Lookup and validate an SPF record
|
|
1629
|
+
# @param lookup_spf_domain_options [LookupSpfDomainOptions]
|
|
1630
|
+
# @param [Hash] opts the optional parameters
|
|
1631
|
+
# @return [LookupSpfDomainResults]
|
|
1632
|
+
def lookup_spf_domain(lookup_spf_domain_options, opts = {})
|
|
1633
|
+
data, _status_code, _headers = lookup_spf_domain_with_http_info(lookup_spf_domain_options, opts)
|
|
1634
|
+
data
|
|
1635
|
+
end
|
|
1636
|
+
|
|
1637
|
+
# Lookup and validate an SPF record
|
|
1638
|
+
# @param lookup_spf_domain_options [LookupSpfDomainOptions]
|
|
1639
|
+
# @param [Hash] opts the optional parameters
|
|
1640
|
+
# @return [Array<(LookupSpfDomainResults, Integer, Hash)>] LookupSpfDomainResults data, response status code and response headers
|
|
1641
|
+
def lookup_spf_domain_with_http_info(lookup_spf_domain_options, opts = {})
|
|
1642
|
+
if @api_client.config.debugging
|
|
1643
|
+
@api_client.config.logger.debug 'Calling API: ToolsControllerApi.lookup_spf_domain ...'
|
|
1644
|
+
end
|
|
1645
|
+
# verify the required parameter 'lookup_spf_domain_options' is set
|
|
1646
|
+
if @api_client.config.client_side_validation && lookup_spf_domain_options.nil?
|
|
1647
|
+
fail ArgumentError, "Missing the required parameter 'lookup_spf_domain_options' when calling ToolsControllerApi.lookup_spf_domain"
|
|
1648
|
+
end
|
|
1649
|
+
# resource path
|
|
1650
|
+
local_var_path = '/tools/lookup-spf-domain'
|
|
1651
|
+
|
|
1652
|
+
# query parameters
|
|
1653
|
+
query_params = opts[:query_params] || {}
|
|
1654
|
+
|
|
1655
|
+
# header parameters
|
|
1656
|
+
header_params = opts[:header_params] || {}
|
|
1657
|
+
# HTTP header 'Accept' (if needed)
|
|
1658
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
|
1659
|
+
# HTTP header 'Content-Type'
|
|
1660
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
1661
|
+
|
|
1662
|
+
# form parameters
|
|
1663
|
+
form_params = opts[:form_params] || {}
|
|
1664
|
+
|
|
1665
|
+
# http body (model)
|
|
1666
|
+
post_body = opts[:body] || @api_client.object_to_http_body(lookup_spf_domain_options)
|
|
1667
|
+
|
|
1668
|
+
# return_type
|
|
1669
|
+
return_type = opts[:return_type] || 'LookupSpfDomainResults'
|
|
1670
|
+
|
|
1671
|
+
# auth_names
|
|
1672
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
|
1673
|
+
|
|
1674
|
+
new_options = opts.merge(
|
|
1675
|
+
:header_params => header_params,
|
|
1676
|
+
:query_params => query_params,
|
|
1677
|
+
:form_params => form_params,
|
|
1678
|
+
:body => post_body,
|
|
1679
|
+
:auth_names => auth_names,
|
|
1680
|
+
:return_type => return_type
|
|
1681
|
+
)
|
|
1682
|
+
|
|
1683
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
1684
|
+
if @api_client.config.debugging
|
|
1685
|
+
@api_client.config.logger.debug "API called: ToolsControllerApi#lookup_spf_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1686
|
+
end
|
|
1687
|
+
return data, status_code, headers
|
|
1688
|
+
end
|
|
1689
|
+
|
|
946
1690
|
# Lookup a TLS reporting domain policy
|
|
947
1691
|
# @param lookup_tls_reporting_domain_options [LookupTlsReportingDomainOptions]
|
|
948
1692
|
# @param [Hash] opts the optional parameters
|
|
@@ -1004,5 +1748,67 @@ module MailSlurpClient
|
|
|
1004
1748
|
end
|
|
1005
1749
|
return data, status_code, headers
|
|
1006
1750
|
end
|
|
1751
|
+
|
|
1752
|
+
# Run a conservative SMTP connectivity, TLS, and AUTH diagnostic
|
|
1753
|
+
# @param test_smtp_server_options [TestSmtpServerOptions]
|
|
1754
|
+
# @param [Hash] opts the optional parameters
|
|
1755
|
+
# @return [TestSmtpServerResults]
|
|
1756
|
+
def test_smtp_server(test_smtp_server_options, opts = {})
|
|
1757
|
+
data, _status_code, _headers = test_smtp_server_with_http_info(test_smtp_server_options, opts)
|
|
1758
|
+
data
|
|
1759
|
+
end
|
|
1760
|
+
|
|
1761
|
+
# Run a conservative SMTP connectivity, TLS, and AUTH diagnostic
|
|
1762
|
+
# @param test_smtp_server_options [TestSmtpServerOptions]
|
|
1763
|
+
# @param [Hash] opts the optional parameters
|
|
1764
|
+
# @return [Array<(TestSmtpServerResults, Integer, Hash)>] TestSmtpServerResults data, response status code and response headers
|
|
1765
|
+
def test_smtp_server_with_http_info(test_smtp_server_options, opts = {})
|
|
1766
|
+
if @api_client.config.debugging
|
|
1767
|
+
@api_client.config.logger.debug 'Calling API: ToolsControllerApi.test_smtp_server ...'
|
|
1768
|
+
end
|
|
1769
|
+
# verify the required parameter 'test_smtp_server_options' is set
|
|
1770
|
+
if @api_client.config.client_side_validation && test_smtp_server_options.nil?
|
|
1771
|
+
fail ArgumentError, "Missing the required parameter 'test_smtp_server_options' when calling ToolsControllerApi.test_smtp_server"
|
|
1772
|
+
end
|
|
1773
|
+
# resource path
|
|
1774
|
+
local_var_path = '/tools/test-smtp-server'
|
|
1775
|
+
|
|
1776
|
+
# query parameters
|
|
1777
|
+
query_params = opts[:query_params] || {}
|
|
1778
|
+
|
|
1779
|
+
# header parameters
|
|
1780
|
+
header_params = opts[:header_params] || {}
|
|
1781
|
+
# HTTP header 'Accept' (if needed)
|
|
1782
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
|
1783
|
+
# HTTP header 'Content-Type'
|
|
1784
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
1785
|
+
|
|
1786
|
+
# form parameters
|
|
1787
|
+
form_params = opts[:form_params] || {}
|
|
1788
|
+
|
|
1789
|
+
# http body (model)
|
|
1790
|
+
post_body = opts[:body] || @api_client.object_to_http_body(test_smtp_server_options)
|
|
1791
|
+
|
|
1792
|
+
# return_type
|
|
1793
|
+
return_type = opts[:return_type] || 'TestSmtpServerResults'
|
|
1794
|
+
|
|
1795
|
+
# auth_names
|
|
1796
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
|
1797
|
+
|
|
1798
|
+
new_options = opts.merge(
|
|
1799
|
+
:header_params => header_params,
|
|
1800
|
+
:query_params => query_params,
|
|
1801
|
+
:form_params => form_params,
|
|
1802
|
+
:body => post_body,
|
|
1803
|
+
:auth_names => auth_names,
|
|
1804
|
+
:return_type => return_type
|
|
1805
|
+
)
|
|
1806
|
+
|
|
1807
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
1808
|
+
if @api_client.config.debugging
|
|
1809
|
+
@api_client.config.logger.debug "API called: ToolsControllerApi#test_smtp_server\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1810
|
+
end
|
|
1811
|
+
return data, status_code, headers
|
|
1812
|
+
end
|
|
1007
1813
|
end
|
|
1008
1814
|
end
|