Class: MailSlurpClient::ToolsControllerApi

Inherits:
Object
  • Object
show all
Defined in:
lib/mailslurp_client/api/tools_controller_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ToolsControllerApi

Returns a new instance of ToolsControllerApi.



19
20
21
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#analyze_dmarc_report(analyze_dmarc_report_options, opts = {}) ⇒ AnalyzeDmarcReportResults

Parse and summarize a DMARC aggregate XML report

Parameters:

Returns:



26
27
28
29
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 26

def analyze_dmarc_report(analyze_dmarc_report_options, opts = {})
  data, _status_code, _headers = analyze_dmarc_report_with_http_info(analyze_dmarc_report_options, opts)
  data
end

#analyze_dmarc_report_with_http_info(analyze_dmarc_report_options, opts = {}) ⇒ Array<(AnalyzeDmarcReportResults, Integer, Hash)>

Parse and summarize a DMARC aggregate XML report

Parameters:

Returns:

  • (Array<(AnalyzeDmarcReportResults, Integer, Hash)>) —

    AnalyzeDmarcReportResults data, response status code and response headers



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 35

def analyze_dmarc_report_with_http_info(analyze_dmarc_report_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ToolsControllerApi.analyze_dmarc_report ...'
  end
  # verify the required parameter 'analyze_dmarc_report_options' is set
  if @api_client.config.client_side_validation && analyze_dmarc_report_options.nil?
    fail ArgumentError, "Missing the required parameter 'analyze_dmarc_report_options' when calling ToolsControllerApi.analyze_dmarc_report"
  end
  # resource path
  local_var_path = '/tools/analyze-dmarc-report'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(analyze_dmarc_report_options) 

  # return_type
  return_type = opts[:return_type] || 'AnalyzeDmarcReportResults' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ToolsControllerApi#analyze_dmarc_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#analyze_email_headers(analyze_email_headers_options, opts = {}) ⇒ AnalyzeEmailHeadersResults

Analyze email headers for auth results and delivery path

Parameters:

Returns:



88
89
90
91
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 88

def analyze_email_headers(analyze_email_headers_options, opts = {})
  data, _status_code, _headers = analyze_email_headers_with_http_info(analyze_email_headers_options, opts)
  data
end

#analyze_email_headers_with_http_info(analyze_email_headers_options, opts = {}) ⇒ Array<(AnalyzeEmailHeadersResults, Integer, Hash)>

Analyze email headers for auth results and delivery path

Parameters:

Returns:

  • (Array<(AnalyzeEmailHeadersResults, Integer, Hash)>) —

    AnalyzeEmailHeadersResults data, response status code and response headers



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 97

def analyze_email_headers_with_http_info(analyze_email_headers_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ToolsControllerApi.analyze_email_headers ...'
  end
  # verify the required parameter 'analyze_email_headers_options' is set
  if @api_client.config.client_side_validation && analyze_email_headers_options.nil?
    fail ArgumentError, "Missing the required parameter 'analyze_email_headers_options' when calling ToolsControllerApi.analyze_email_headers"
  end
  # resource path
  local_var_path = '/tools/analyze-email-headers'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(analyze_email_headers_options) 

  # return_type
  return_type = opts[:return_type] || 'AnalyzeEmailHeadersResults' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ToolsControllerApi#analyze_email_headers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#check_campaign_probe(check_campaign_probe_options, opts = {}) ⇒ CheckCampaignProbeResults

Run a one-shot free campaign probe preflight check

Parameters:

Returns:



150
151
152
153
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 150

def check_campaign_probe(check_campaign_probe_options, opts = {})
  data, _status_code, _headers = check_campaign_probe_with_http_info(check_campaign_probe_options, opts)
  data
end

#check_campaign_probe_with_http_info(check_campaign_probe_options, opts = {}) ⇒ Array<(CheckCampaignProbeResults, Integer, Hash)>

Run a one-shot free campaign probe preflight check

Parameters:

Returns:

  • (Array<(CheckCampaignProbeResults, Integer, Hash)>) —

    CheckCampaignProbeResults data, response status code and response headers



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 159

def check_campaign_probe_with_http_info(check_campaign_probe_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ToolsControllerApi.check_campaign_probe ...'
  end
  # verify the required parameter 'check_campaign_probe_options' is set
  if @api_client.config.client_side_validation && check_campaign_probe_options.nil?
    fail ArgumentError, "Missing the required parameter 'check_campaign_probe_options' when calling ToolsControllerApi.check_campaign_probe"
  end
  # resource path
  local_var_path = '/tools/check-campaign-probe'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(check_campaign_probe_options) 

  # return_type
  return_type = opts[:return_type] || 'CheckCampaignProbeResults' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ToolsControllerApi#check_campaign_probe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#check_dns_propagation(check_dns_propagation_options, opts = {}) ⇒ CheckDnsPropagationResults

Check DNS propagation for a host and record type across configured resolvers

Parameters:

Returns:



212
213
214
215
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 212

def check_dns_propagation(check_dns_propagation_options, opts = {})
  data, _status_code, _headers = check_dns_propagation_with_http_info(check_dns_propagation_options, opts)
  data
end

#check_dns_propagation_with_http_info(check_dns_propagation_options, opts = {}) ⇒ Array<(CheckDnsPropagationResults, Integer, Hash)>

Check DNS propagation for a host and record type across configured resolvers

Parameters:

Returns:

  • (Array<(CheckDnsPropagationResults, Integer, Hash)>) —

    CheckDnsPropagationResults data, response status code and response headers



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 221

def check_dns_propagation_with_http_info(check_dns_propagation_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ToolsControllerApi.check_dns_propagation ...'
  end
  # verify the required parameter 'check_dns_propagation_options' is set
  if @api_client.config.client_side_validation && check_dns_propagation_options.nil?
    fail ArgumentError, "Missing the required parameter 'check_dns_propagation_options' when calling ToolsControllerApi.check_dns_propagation"
  end
  # resource path
  local_var_path = '/tools/check-dns-propagation'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(check_dns_propagation_options) 

  # return_type
  return_type = opts[:return_type] || 'CheckDnsPropagationResults' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ToolsControllerApi#check_dns_propagation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#check_domain_monitor(check_domain_monitor_options, opts = {}) ⇒ CheckDomainMonitorResults

Run a one-shot free domain monitor posture check

Parameters:

Returns:



274
275
276
277
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 274

def check_domain_monitor(check_domain_monitor_options, opts = {})
  data, _status_code, _headers = check_domain_monitor_with_http_info(check_domain_monitor_options, opts)
  data
end

#check_domain_monitor_with_http_info(check_domain_monitor_options, opts = {}) ⇒ Array<(CheckDomainMonitorResults, Integer, Hash)>

Run a one-shot free domain monitor posture check

Parameters:

Returns:

  • (Array<(CheckDomainMonitorResults, Integer, Hash)>) —

    CheckDomainMonitorResults data, response status code and response headers



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 283

def check_domain_monitor_with_http_info(check_domain_monitor_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ToolsControllerApi.check_domain_monitor ...'
  end
  # verify the required parameter 'check_domain_monitor_options' is set
  if @api_client.config.client_side_validation && check_domain_monitor_options.nil?
    fail ArgumentError, "Missing the required parameter 'check_domain_monitor_options' when calling ToolsControllerApi.check_domain_monitor"
  end
  # resource path
  local_var_path = '/tools/check-domain-monitor'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(check_domain_monitor_options) 

  # return_type
  return_type = opts[:return_type] || 'CheckDomainMonitorResults' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ToolsControllerApi#check_domain_monitor\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#check_email_audit(check_email_audit_options, opts = {}) ⇒ EmailAuditAnalysisResult

Run a one-shot free email audit across links, images, HTML, and client support

Parameters:

  • check_email_audit_options (CheckEmailAuditOptions)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



336
337
338
339
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 336

def check_email_audit(check_email_audit_options, opts = {})
  data, _status_code, _headers = check_email_audit_with_http_info(check_email_audit_options, opts)
  data
end

#check_email_audit_with_http_info(check_email_audit_options, opts = {}) ⇒ Array<(EmailAuditAnalysisResult, Integer, Hash)>

Run a one-shot free email audit across links, images, HTML, and client support

Parameters:

  • check_email_audit_options (CheckEmailAuditOptions)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailAuditAnalysisResult, Integer, Hash)>) —

    EmailAuditAnalysisResult data, response status code and response headers



345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 345

def check_email_audit_with_http_info(check_email_audit_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ToolsControllerApi.check_email_audit ...'
  end
  # verify the required parameter 'check_email_audit_options' is set
  if @api_client.config.client_side_validation && check_email_audit_options.nil?
    fail ArgumentError, "Missing the required parameter 'check_email_audit_options' when calling ToolsControllerApi.check_email_audit"
  end
  # resource path
  local_var_path = '/tools/check-email-audit'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(check_email_audit_options) 

  # return_type
  return_type = opts[:return_type] || 'EmailAuditAnalysisResult' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ToolsControllerApi#check_email_audit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#check_email_auth_stack(check_email_auth_stack_options, opts = {}) ⇒ CheckEmailAuthStackResults

Run a one-shot combined SPF, DKIM, DMARC, BIMI, MX, MTA-STS, and TLS-RPT check

Parameters:

Returns:



398
399
400
401
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 398

def check_email_auth_stack(check_email_auth_stack_options, opts = {})
  data, _status_code, _headers = check_email_auth_stack_with_http_info(check_email_auth_stack_options, opts)
  data
end

#check_email_auth_stack_with_http_info(check_email_auth_stack_options, opts = {}) ⇒ Array<(CheckEmailAuthStackResults, Integer, Hash)>

Run a one-shot combined SPF, DKIM, DMARC, BIMI, MX, MTA-STS, and TLS-RPT check

Parameters:

Returns:

  • (Array<(CheckEmailAuthStackResults, Integer, Hash)>) —

    CheckEmailAuthStackResults data, response status code and response headers



407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 407

def check_email_auth_stack_with_http_info(check_email_auth_stack_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ToolsControllerApi.check_email_auth_stack ...'
  end
  # verify the required parameter 'check_email_auth_stack_options' is set
  if @api_client.config.client_side_validation && check_email_auth_stack_options.nil?
    fail ArgumentError, "Missing the required parameter 'check_email_auth_stack_options' when calling ToolsControllerApi.check_email_auth_stack"
  end
  # resource path
  local_var_path = '/tools/check-email-auth-stack'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(check_email_auth_stack_options) 

  # return_type
  return_type = opts[:return_type] || 'CheckEmailAuthStackResults' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ToolsControllerApi#check_email_auth_stack\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#check_email_blacklist(check_email_blacklist_options, opts = {}) ⇒ CheckEmailBlacklistResults

Check whether a domain or IP appears on configured DNS blacklists

Parameters:

Returns:



460
461
462
463
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 460

def check_email_blacklist(check_email_blacklist_options, opts = {})
  data, _status_code, _headers = check_email_blacklist_with_http_info(check_email_blacklist_options, opts)
  data
end

#check_email_blacklist_with_http_info(check_email_blacklist_options, opts = {}) ⇒ Array<(CheckEmailBlacklistResults, Integer, Hash)>

Check whether a domain or IP appears on configured DNS blacklists

Parameters:

Returns:

  • (Array<(CheckEmailBlacklistResults, Integer, Hash)>) —

    CheckEmailBlacklistResults data, response status code and response headers



469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 469

def check_email_blacklist_with_http_info(check_email_blacklist_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ToolsControllerApi.check_email_blacklist ...'
  end
  # verify the required parameter 'check_email_blacklist_options' is set
  if @api_client.config.client_side_validation && check_email_blacklist_options.nil?
    fail ArgumentError, "Missing the required parameter 'check_email_blacklist_options' when calling ToolsControllerApi.check_email_blacklist"
  end
  # resource path
  local_var_path = '/tools/check-email-blacklists'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(check_email_blacklist_options) 

  # return_type
  return_type = opts[:return_type] || 'CheckEmailBlacklistResults' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ToolsControllerApi#check_email_blacklist\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#check_email_features_client_support(check_email_features_client_support_options, opts = {}) ⇒ CheckEmailFeaturesClientSupportResults

Check email client support for email HTML and CSS features

Parameters:

Returns:



522
523
524
525
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 522

def check_email_features_client_support(check_email_features_client_support_options, opts = {})
  data, _status_code, _headers = check_email_features_client_support_with_http_info(check_email_features_client_support_options, opts)
  data
end

#check_email_features_client_support_with_http_info(check_email_features_client_support_options, opts = {}) ⇒ Array<(CheckEmailFeaturesClientSupportResults, Integer, Hash)>

Check email client support for email HTML and CSS features

Parameters:

Returns:



531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 531

def check_email_features_client_support_with_http_info(check_email_features_client_support_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ToolsControllerApi.check_email_features_client_support ...'
  end
  # verify the required parameter 'check_email_features_client_support_options' is set
  if @api_client.config.client_side_validation && check_email_features_client_support_options.nil?
    fail ArgumentError, "Missing the required parameter 'check_email_features_client_support_options' when calling ToolsControllerApi.check_email_features_client_support"
  end
  # resource path
  local_var_path = '/tools/check-email-features-client-support'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(check_email_features_client_support_options) 

  # return_type
  return_type = opts[:return_type] || 'CheckEmailFeaturesClientSupportResults' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ToolsControllerApi#check_email_features_client_support\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_new_fake_email_address(opts = {}) ⇒ NewFakeEmailAddressResult

Create a new email address using the fake email domains

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



583
584
585
586
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 583

def create_new_fake_email_address(opts = {})
  data, _status_code, _headers = create_new_fake_email_address_with_http_info(opts)
  data
end

#create_new_fake_email_address_with_http_info(opts = {}) ⇒ Array<(NewFakeEmailAddressResult, Integer, Hash)>

Create a new email address using the fake email domains

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(NewFakeEmailAddressResult, Integer, Hash)>) —

    NewFakeEmailAddressResult data, response status code and response headers



591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 591

def create_new_fake_email_address_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ToolsControllerApi.create_new_fake_email_address ...'
  end
  # resource path
  local_var_path = '/tools/fake-email'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'NewFakeEmailAddressResult' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ToolsControllerApi#create_new_fake_email_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_new_fake_email_address(email_address, opts = {}) ⇒ nil

Delete a fake email address using the fake email domains Delete a fake email address using the fake email domains

Parameters:

  • email_address (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


639
640
641
642
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 639

def delete_new_fake_email_address(email_address, opts = {})
  delete_new_fake_email_address_with_http_info(email_address, opts)
  nil
end

#delete_new_fake_email_address_with_http_info(email_address, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a fake email address using the fake email domains Delete a fake email address using the fake email domains

Parameters:

  • email_address (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 649

def delete_new_fake_email_address_with_http_info(email_address, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ToolsControllerApi.delete_new_fake_email_address ...'
  end
  # verify the required parameter 'email_address' is set
  if @api_client.config.client_side_validation && email_address.nil?
    fail ArgumentError, "Missing the required parameter 'email_address' when calling ToolsControllerApi.delete_new_fake_email_address"
  end
  # resource path
  local_var_path = '/tools/fake-email'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'emailAddress'] = email_address

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ToolsControllerApi#delete_new_fake_email_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#generate_bimi_record(generate_bimi_record_options, opts = {}) ⇒ GenerateBimiRecordResults

Create a BIMI record policy

Parameters:

Returns:



699
700
701
702
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 699

def generate_bimi_record(generate_bimi_record_options, opts = {})
  data, _status_code, _headers = generate_bimi_record_with_http_info(generate_bimi_record_options, opts)
  data
end

#generate_bimi_record_with_http_info(generate_bimi_record_options, opts = {}) ⇒ Array<(GenerateBimiRecordResults, Integer, Hash)>

Create a BIMI record policy

Parameters:

Returns:

  • (Array<(GenerateBimiRecordResults, Integer, Hash)>) —

    GenerateBimiRecordResults data, response status code and response headers



708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 708

def generate_bimi_record_with_http_info(generate_bimi_record_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ToolsControllerApi.generate_bimi_record ...'
  end
  # verify the required parameter 'generate_bimi_record_options' is set
  if @api_client.config.client_side_validation && generate_bimi_record_options.nil?
    fail ArgumentError, "Missing the required parameter 'generate_bimi_record_options' when calling ToolsControllerApi.generate_bimi_record"
  end
  # resource path
  local_var_path = '/tools/generate-bimi-record'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(generate_bimi_record_options) 

  # return_type
  return_type = opts[:return_type] || 'GenerateBimiRecordResults' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ToolsControllerApi#generate_bimi_record\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#generate_dmarc_record(generate_dmarc_record_options, opts = {}) ⇒ GenerateDmarcRecordResults

Create a DMARC record policy

Parameters:

Returns:



761
762
763
764
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 761

def generate_dmarc_record(generate_dmarc_record_options, opts = {})
  data, _status_code, _headers = generate_dmarc_record_with_http_info(generate_dmarc_record_options, opts)
  data
end

#generate_dmarc_record_with_http_info(generate_dmarc_record_options, opts = {}) ⇒ Array<(GenerateDmarcRecordResults, Integer, Hash)>

Create a DMARC record policy

Parameters:

Returns:

  • (Array<(GenerateDmarcRecordResults, Integer, Hash)>) —

    GenerateDmarcRecordResults data, response status code and response headers



770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 770

def generate_dmarc_record_with_http_info(generate_dmarc_record_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ToolsControllerApi.generate_dmarc_record ...'
  end
  # verify the required parameter 'generate_dmarc_record_options' is set
  if @api_client.config.client_side_validation && generate_dmarc_record_options.nil?
    fail ArgumentError, "Missing the required parameter 'generate_dmarc_record_options' when calling ToolsControllerApi.generate_dmarc_record"
  end
  # resource path
  local_var_path = '/tools/generate-dmarc-record'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(generate_dmarc_record_options) 

  # return_type
  return_type = opts[:return_type] || 'GenerateDmarcRecordResults' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ToolsControllerApi#generate_dmarc_record\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#generate_mta_sts_record(generate_mta_sts_record_options, opts = {}) ⇒ GenerateMtaStsRecordResults

Create a TLS reporting record policy

Parameters:

Returns:



823
824
825
826
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 823

def generate_mta_sts_record(generate_mta_sts_record_options, opts = {})
  data, _status_code, _headers = generate_mta_sts_record_with_http_info(generate_mta_sts_record_options, opts)
  data
end

#generate_mta_sts_record_with_http_info(generate_mta_sts_record_options, opts = {}) ⇒ Array<(GenerateMtaStsRecordResults, Integer, Hash)>

Create a TLS reporting record policy

Parameters:

Returns:

  • (Array<(GenerateMtaStsRecordResults, Integer, Hash)>) —

    GenerateMtaStsRecordResults data, response status code and response headers



832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 832

def generate_mta_sts_record_with_http_info(generate_mta_sts_record_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ToolsControllerApi.generate_mta_sts_record ...'
  end
  # verify the required parameter 'generate_mta_sts_record_options' is set
  if @api_client.config.client_side_validation && generate_mta_sts_record_options.nil?
    fail ArgumentError, "Missing the required parameter 'generate_mta_sts_record_options' when calling ToolsControllerApi.generate_mta_sts_record"
  end
  # resource path
  local_var_path = '/tools/generate-mta-sts-record'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(generate_mta_sts_record_options) 

  # return_type
  return_type = opts[:return_type] || 'GenerateMtaStsRecordResults' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ToolsControllerApi#generate_mta_sts_record\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#generate_spf_record(generate_spf_record_options, opts = {}) ⇒ GenerateSpfRecordResults

Create an SPF record

Parameters:

Returns:



885
886
887
888
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 885

def generate_spf_record(generate_spf_record_options, opts = {})
  data, _status_code, _headers = generate_spf_record_with_http_info(generate_spf_record_options, opts)
  data
end

#generate_spf_record_with_http_info(generate_spf_record_options, opts = {}) ⇒ Array<(GenerateSpfRecordResults, Integer, Hash)>

Create an SPF record

Parameters:

Returns:

  • (Array<(GenerateSpfRecordResults, Integer, Hash)>) —

    GenerateSpfRecordResults data, response status code and response headers



894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 894

def generate_spf_record_with_http_info(generate_spf_record_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ToolsControllerApi.generate_spf_record ...'
  end
  # verify the required parameter 'generate_spf_record_options' is set
  if @api_client.config.client_side_validation && generate_spf_record_options.nil?
    fail ArgumentError, "Missing the required parameter 'generate_spf_record_options' when calling ToolsControllerApi.generate_spf_record"
  end
  # resource path
  local_var_path = '/tools/generate-spf-record'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(generate_spf_record_options) 

  # return_type
  return_type = opts[:return_type] || 'GenerateSpfRecordResults' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ToolsControllerApi#generate_spf_record\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#generate_tls_reporting_record(generate_tls_reporting_record_options, opts = {}) ⇒ GenerateTlsReportingRecordResults

Create a TLS reporting record policy

Parameters:

Returns:



947
948
949
950
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 947

def generate_tls_reporting_record(generate_tls_reporting_record_options, opts = {})
  data, _status_code, _headers = generate_tls_reporting_record_with_http_info(generate_tls_reporting_record_options, opts)
  data
end

#generate_tls_reporting_record_with_http_info(generate_tls_reporting_record_options, opts = {}) ⇒ Array<(GenerateTlsReportingRecordResults, Integer, Hash)>

Create a TLS reporting record policy

Parameters:

Returns:



956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 956

def generate_tls_reporting_record_with_http_info(generate_tls_reporting_record_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ToolsControllerApi.generate_tls_reporting_record ...'
  end
  # verify the required parameter 'generate_tls_reporting_record_options' is set
  if @api_client.config.client_side_validation && generate_tls_reporting_record_options.nil?
    fail ArgumentError, "Missing the required parameter 'generate_tls_reporting_record_options' when calling ToolsControllerApi.generate_tls_reporting_record"
  end
  # resource path
  local_var_path = '/tools/generate-tls-reporting-record'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(generate_tls_reporting_record_options) 

  # return_type
  return_type = opts[:return_type] || 'GenerateTlsReportingRecordResults' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ToolsControllerApi#generate_tls_reporting_record\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_fake_email_by_email_address(email_address, opts = {}) ⇒ FakeEmailResult

Parameters:

  • email_address (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1008
1009
1010
1011
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 1008

def get_fake_email_by_email_address(email_address, opts = {})
  data, _status_code, _headers = get_fake_email_by_email_address_with_http_info(email_address, opts)
  data
end

#get_fake_email_by_email_address_with_http_info(email_address, opts = {}) ⇒ Array<(FakeEmailResult, Integer, Hash)>

Returns FakeEmailResult data, response status code and response headers.

Parameters:

  • email_address (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(FakeEmailResult, Integer, Hash)>) —

    FakeEmailResult data, response status code and response headers



1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 1016

def get_fake_email_by_email_address_with_http_info(email_address, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ToolsControllerApi.get_fake_email_by_email_address ...'
  end
  # verify the required parameter 'email_address' is set
  if @api_client.config.client_side_validation && email_address.nil?
    fail ArgumentError, "Missing the required parameter 'email_address' when calling ToolsControllerApi.get_fake_email_by_email_address"
  end
  # resource path
  local_var_path = '/tools/fake-email/byEmailAddress'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'emailAddress'] = email_address

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'FakeEmailResult' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ToolsControllerApi#get_fake_email_by_email_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_fake_email_by_id(id, opts = {}) ⇒ FakeEmailResult

Get a fake email by its ID Get a fake email by its ID

Parameters:

  • id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1069
1070
1071
1072
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 1069

def get_fake_email_by_id(id, opts = {})
  data, _status_code, _headers = get_fake_email_by_id_with_http_info(id, opts)
  data
end

#get_fake_email_by_id_with_http_info(id, opts = {}) ⇒ Array<(FakeEmailResult, Integer, Hash)>

Get a fake email by its ID Get a fake email by its ID

Parameters:

  • id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(FakeEmailResult, Integer, Hash)>) —

    FakeEmailResult data, response status code and response headers



1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 1079

def get_fake_email_by_id_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ToolsControllerApi.get_fake_email_by_id ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ToolsControllerApi.get_fake_email_by_id"
  end
  # resource path
  local_var_path = '/tools/fake-email'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'id'] = id

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'FakeEmailResult' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ToolsControllerApi#get_fake_email_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_fake_email_raw(id, opts = {}) ⇒ String

Get raw fake email content Retrieve the raw content of a fake email by its ID

Parameters:

  • id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


1132
1133
1134
1135
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 1132

def get_fake_email_raw(id, opts = {})
  data, _status_code, _headers = get_fake_email_raw_with_http_info(id, opts)
  data
end

#get_fake_email_raw_with_http_info(id, opts = {}) ⇒ Array<(String, Integer, Hash)>

Get raw fake email content Retrieve the raw content of a fake email by its ID

Parameters:

  • id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Integer, Hash)>) —

    String data, response status code and response headers



1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 1142

def get_fake_email_raw_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ToolsControllerApi.get_fake_email_raw ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ToolsControllerApi.get_fake_email_raw"
  end
  # resource path
  local_var_path = '/tools/fake-email/html'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'id'] = id

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain;charset=utf-8', 'text/html;charset=utf-8', 'text/plain; charset=utf-8', 'text/html; charset=utf-8'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'String' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ToolsControllerApi#get_fake_email_raw\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_fake_emails_for_address(email_address, opts = {}) ⇒ Array<FakeEmailPreview>

Get fake emails for an address Get fake emails for an address

Parameters:

  • email_address (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer)

Returns:



1196
1197
1198
1199
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 1196

def get_fake_emails_for_address(email_address, opts = {})
  data, _status_code, _headers = get_fake_emails_for_address_with_http_info(email_address, opts)
  data
end

#get_fake_emails_for_address_with_http_info(email_address, opts = {}) ⇒ Array<(Array<FakeEmailPreview>, Integer, Hash)>

Get fake emails for an address Get fake emails for an address

Parameters:

  • email_address (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer)

Returns:

  • (Array<(Array<FakeEmailPreview>, Integer, Hash)>) —

    Array<FakeEmailPreview> data, response status code and response headers



1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 1207

def get_fake_emails_for_address_with_http_info(email_address, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ToolsControllerApi.get_fake_emails_for_address ...'
  end
  # verify the required parameter 'email_address' is set
  if @api_client.config.client_side_validation && email_address.nil?
    fail ArgumentError, "Missing the required parameter 'email_address' when calling ToolsControllerApi.get_fake_emails_for_address"
  end
  # resource path
  local_var_path = '/tools/fake-emails'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'emailAddress'] = email_address
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Array<FakeEmailPreview>' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ToolsControllerApi#get_fake_emails_for_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#lookup_bimi_domain(lookup_bimi_domain_options, opts = {}) ⇒ LookupBimiDomainResults

Lookup a BIMI record policy

Parameters:

Returns:



1260
1261
1262
1263
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 1260

def lookup_bimi_domain(lookup_bimi_domain_options, opts = {})
  data, _status_code, _headers = lookup_bimi_domain_with_http_info(lookup_bimi_domain_options, opts)
  data
end

#lookup_bimi_domain_with_http_info(lookup_bimi_domain_options, opts = {}) ⇒ Array<(LookupBimiDomainResults, Integer, Hash)>

Lookup a BIMI record policy

Parameters:

Returns:

  • (Array<(LookupBimiDomainResults, Integer, Hash)>) —

    LookupBimiDomainResults data, response status code and response headers



1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 1269

def lookup_bimi_domain_with_http_info(lookup_bimi_domain_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ToolsControllerApi.lookup_bimi_domain ...'
  end
  # verify the required parameter 'lookup_bimi_domain_options' is set
  if @api_client.config.client_side_validation && lookup_bimi_domain_options.nil?
    fail ArgumentError, "Missing the required parameter 'lookup_bimi_domain_options' when calling ToolsControllerApi.lookup_bimi_domain"
  end
  # resource path
  local_var_path = '/tools/lookup-bimi-domain'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(lookup_bimi_domain_options) 

  # return_type
  return_type = opts[:return_type] || 'LookupBimiDomainResults' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ToolsControllerApi#lookup_bimi_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#lookup_dkim_domain(lookup_dkim_domain_options, opts = {}) ⇒ LookupDkimDomainResults

Lookup and validate a DKIM record

Parameters:

Returns:



1322
1323
1324
1325
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 1322

def lookup_dkim_domain(lookup_dkim_domain_options, opts = {})
  data, _status_code, _headers = lookup_dkim_domain_with_http_info(lookup_dkim_domain_options, opts)
  data
end

#lookup_dkim_domain_with_http_info(lookup_dkim_domain_options, opts = {}) ⇒ Array<(LookupDkimDomainResults, Integer, Hash)>

Lookup and validate a DKIM record

Parameters:

Returns:

  • (Array<(LookupDkimDomainResults, Integer, Hash)>) —

    LookupDkimDomainResults data, response status code and response headers



1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 1331

def lookup_dkim_domain_with_http_info(lookup_dkim_domain_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ToolsControllerApi.lookup_dkim_domain ...'
  end
  # verify the required parameter 'lookup_dkim_domain_options' is set
  if @api_client.config.client_side_validation && lookup_dkim_domain_options.nil?
    fail ArgumentError, "Missing the required parameter 'lookup_dkim_domain_options' when calling ToolsControllerApi.lookup_dkim_domain"
  end
  # resource path
  local_var_path = '/tools/lookup-dkim-domain'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(lookup_dkim_domain_options) 

  # return_type
  return_type = opts[:return_type] || 'LookupDkimDomainResults' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ToolsControllerApi#lookup_dkim_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#lookup_dmarc_domain(lookup_dmarc_domain_options, opts = {}) ⇒ LookupDmarcDomainResults

Lookup a DMARC record policy

Parameters:

Returns:



1384
1385
1386
1387
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 1384

def lookup_dmarc_domain(lookup_dmarc_domain_options, opts = {})
  data, _status_code, _headers = lookup_dmarc_domain_with_http_info(lookup_dmarc_domain_options, opts)
  data
end

#lookup_dmarc_domain_with_http_info(lookup_dmarc_domain_options, opts = {}) ⇒ Array<(LookupDmarcDomainResults, Integer, Hash)>

Lookup a DMARC record policy

Parameters:

Returns:

  • (Array<(LookupDmarcDomainResults, Integer, Hash)>) —

    LookupDmarcDomainResults data, response status code and response headers



1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 1393

def lookup_dmarc_domain_with_http_info(lookup_dmarc_domain_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ToolsControllerApi.lookup_dmarc_domain ...'
  end
  # verify the required parameter 'lookup_dmarc_domain_options' is set
  if @api_client.config.client_side_validation && lookup_dmarc_domain_options.nil?
    fail ArgumentError, "Missing the required parameter 'lookup_dmarc_domain_options' when calling ToolsControllerApi.lookup_dmarc_domain"
  end
  # resource path
  local_var_path = '/tools/lookup-dmarc-domain'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(lookup_dmarc_domain_options) 

  # return_type
  return_type = opts[:return_type] || 'LookupDmarcDomainResults' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ToolsControllerApi#lookup_dmarc_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#lookup_mta_sts_domain(lookup_mta_sts_domain_options, opts = {}) ⇒ LookupMtaStsDomainResults

Lookup a MTA-STS domain policy

Parameters:

Returns:



1446
1447
1448
1449
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 1446

def lookup_mta_sts_domain(lookup_mta_sts_domain_options, opts = {})
  data, _status_code, _headers = lookup_mta_sts_domain_with_http_info(lookup_mta_sts_domain_options, opts)
  data
end

#lookup_mta_sts_domain_with_http_info(lookup_mta_sts_domain_options, opts = {}) ⇒ Array<(LookupMtaStsDomainResults, Integer, Hash)>

Lookup a MTA-STS domain policy

Parameters:

Returns:

  • (Array<(LookupMtaStsDomainResults, Integer, Hash)>) —

    LookupMtaStsDomainResults data, response status code and response headers



1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 1455

def lookup_mta_sts_domain_with_http_info(lookup_mta_sts_domain_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ToolsControllerApi.lookup_mta_sts_domain ...'
  end
  # verify the required parameter 'lookup_mta_sts_domain_options' is set
  if @api_client.config.client_side_validation && lookup_mta_sts_domain_options.nil?
    fail ArgumentError, "Missing the required parameter 'lookup_mta_sts_domain_options' when calling ToolsControllerApi.lookup_mta_sts_domain"
  end
  # resource path
  local_var_path = '/tools/lookup-mta-sts-domain'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(lookup_mta_sts_domain_options) 

  # return_type
  return_type = opts[:return_type] || 'LookupMtaStsDomainResults' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ToolsControllerApi#lookup_mta_sts_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#lookup_mx_record(lookup_mx_records_options, opts = {}) ⇒ LookupMxRecordsResults

Lookup a MX records for a domain

Parameters:

  • lookup_mx_records_options (LookupMxRecordsOptions)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1508
1509
1510
1511
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 1508

def lookup_mx_record(lookup_mx_records_options, opts = {})
  data, _status_code, _headers = lookup_mx_record_with_http_info(lookup_mx_records_options, opts)
  data
end

#lookup_mx_record_with_http_info(lookup_mx_records_options, opts = {}) ⇒ Array<(LookupMxRecordsResults, Integer, Hash)>

Lookup a MX records for a domain

Parameters:

  • lookup_mx_records_options (LookupMxRecordsOptions)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(LookupMxRecordsResults, Integer, Hash)>) —

    LookupMxRecordsResults data, response status code and response headers



1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 1517

def lookup_mx_record_with_http_info(lookup_mx_records_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ToolsControllerApi.lookup_mx_record ...'
  end
  # verify the required parameter 'lookup_mx_records_options' is set
  if @api_client.config.client_side_validation && lookup_mx_records_options.nil?
    fail ArgumentError, "Missing the required parameter 'lookup_mx_records_options' when calling ToolsControllerApi.lookup_mx_record"
  end
  # resource path
  local_var_path = '/tools/lookup-mx-records'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(lookup_mx_records_options) 

  # return_type
  return_type = opts[:return_type] || 'LookupMxRecordsResults' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ToolsControllerApi#lookup_mx_record\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#lookup_ptr(lookup_ptr_options, opts = {}) ⇒ LookupPtrResults

Lookup PTR records for an IP address

Parameters:

  • lookup_ptr_options (LookupPtrOptions)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1570
1571
1572
1573
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 1570

def lookup_ptr(lookup_ptr_options, opts = {})
  data, _status_code, _headers = lookup_ptr_with_http_info(lookup_ptr_options, opts)
  data
end

#lookup_ptr_with_http_info(lookup_ptr_options, opts = {}) ⇒ Array<(LookupPtrResults, Integer, Hash)>

Lookup PTR records for an IP address

Parameters:

  • lookup_ptr_options (LookupPtrOptions)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(LookupPtrResults, Integer, Hash)>) —

    LookupPtrResults data, response status code and response headers



1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 1579

def lookup_ptr_with_http_info(lookup_ptr_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ToolsControllerApi.lookup_ptr ...'
  end
  # verify the required parameter 'lookup_ptr_options' is set
  if @api_client.config.client_side_validation && lookup_ptr_options.nil?
    fail ArgumentError, "Missing the required parameter 'lookup_ptr_options' when calling ToolsControllerApi.lookup_ptr"
  end
  # resource path
  local_var_path = '/tools/lookup-ptr'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(lookup_ptr_options) 

  # return_type
  return_type = opts[:return_type] || 'LookupPtrResults' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ToolsControllerApi#lookup_ptr\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#lookup_spf_domain(lookup_spf_domain_options, opts = {}) ⇒ LookupSpfDomainResults

Lookup and validate an SPF record

Parameters:

  • lookup_spf_domain_options (LookupSpfDomainOptions)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1632
1633
1634
1635
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 1632

def lookup_spf_domain(lookup_spf_domain_options, opts = {})
  data, _status_code, _headers = lookup_spf_domain_with_http_info(lookup_spf_domain_options, opts)
  data
end

#lookup_spf_domain_with_http_info(lookup_spf_domain_options, opts = {}) ⇒ Array<(LookupSpfDomainResults, Integer, Hash)>

Lookup and validate an SPF record

Parameters:

  • lookup_spf_domain_options (LookupSpfDomainOptions)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(LookupSpfDomainResults, Integer, Hash)>) —

    LookupSpfDomainResults data, response status code and response headers



1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 1641

def lookup_spf_domain_with_http_info(lookup_spf_domain_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ToolsControllerApi.lookup_spf_domain ...'
  end
  # verify the required parameter 'lookup_spf_domain_options' is set
  if @api_client.config.client_side_validation && lookup_spf_domain_options.nil?
    fail ArgumentError, "Missing the required parameter 'lookup_spf_domain_options' when calling ToolsControllerApi.lookup_spf_domain"
  end
  # resource path
  local_var_path = '/tools/lookup-spf-domain'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(lookup_spf_domain_options) 

  # return_type
  return_type = opts[:return_type] || 'LookupSpfDomainResults' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ToolsControllerApi#lookup_spf_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#lookup_tls_reporting_domain(lookup_tls_reporting_domain_options, opts = {}) ⇒ LookupTlsReportingDomainResults

Lookup a TLS reporting domain policy

Parameters:

Returns:



1694
1695
1696
1697
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 1694

def lookup_tls_reporting_domain(lookup_tls_reporting_domain_options, opts = {})
  data, _status_code, _headers = lookup_tls_reporting_domain_with_http_info(lookup_tls_reporting_domain_options, opts)
  data
end

#lookup_tls_reporting_domain_with_http_info(lookup_tls_reporting_domain_options, opts = {}) ⇒ Array<(LookupTlsReportingDomainResults, Integer, Hash)>

Lookup a TLS reporting domain policy

Parameters:

Returns:



1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 1703

def lookup_tls_reporting_domain_with_http_info(lookup_tls_reporting_domain_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ToolsControllerApi.lookup_tls_reporting_domain ...'
  end
  # verify the required parameter 'lookup_tls_reporting_domain_options' is set
  if @api_client.config.client_side_validation && lookup_tls_reporting_domain_options.nil?
    fail ArgumentError, "Missing the required parameter 'lookup_tls_reporting_domain_options' when calling ToolsControllerApi.lookup_tls_reporting_domain"
  end
  # resource path
  local_var_path = '/tools/lookup-tls-reporting-domain'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(lookup_tls_reporting_domain_options) 

  # return_type
  return_type = opts[:return_type] || 'LookupTlsReportingDomainResults' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ToolsControllerApi#lookup_tls_reporting_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#test_smtp_server(test_smtp_server_options, opts = {}) ⇒ TestSmtpServerResults

Run a conservative SMTP connectivity, TLS, and AUTH diagnostic

Parameters:

  • test_smtp_server_options (TestSmtpServerOptions)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1756
1757
1758
1759
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 1756

def test_smtp_server(test_smtp_server_options, opts = {})
  data, _status_code, _headers = test_smtp_server_with_http_info(test_smtp_server_options, opts)
  data
end

#test_smtp_server_with_http_info(test_smtp_server_options, opts = {}) ⇒ Array<(TestSmtpServerResults, Integer, Hash)>

Run a conservative SMTP connectivity, TLS, and AUTH diagnostic

Parameters:

  • test_smtp_server_options (TestSmtpServerOptions)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(TestSmtpServerResults, Integer, Hash)>) —

    TestSmtpServerResults data, response status code and response headers



1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 1765

def test_smtp_server_with_http_info(test_smtp_server_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ToolsControllerApi.test_smtp_server ...'
  end
  # verify the required parameter 'test_smtp_server_options' is set
  if @api_client.config.client_side_validation && test_smtp_server_options.nil?
    fail ArgumentError, "Missing the required parameter 'test_smtp_server_options' when calling ToolsControllerApi.test_smtp_server"
  end
  # resource path
  local_var_path = '/tools/test-smtp-server'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(test_smtp_server_options) 

  # return_type
  return_type = opts[:return_type] || 'TestSmtpServerResults' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ToolsControllerApi#test_smtp_server\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end