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

#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:



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

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:



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 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:



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

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



95
96
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
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 95

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) 


143
144
145
146
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 143

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



153
154
155
156
157
158
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
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 153

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:



203
204
205
206
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 203

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



212
213
214
215
216
217
218
219
220
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
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 212

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:



265
266
267
268
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 265

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



274
275
276
277
278
279
280
281
282
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
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 274

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:



327
328
329
330
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 327

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



336
337
338
339
340
341
342
343
344
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
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 336

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_tls_reporting_record(generate_tls_reporting_record_options, opts = {}) ⇒ GenerateTlsReportingRecordResults

Create a TLS reporting record policy

Parameters:

Returns:



389
390
391
392
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 389

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:



398
399
400
401
402
403
404
405
406
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
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 398

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:



450
451
452
453
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 450

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



458
459
460
461
462
463
464
465
466
467
468
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
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 458

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:



511
512
513
514
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 511

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



521
522
523
524
525
526
527
528
529
530
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
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 521

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) 


574
575
576
577
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 574

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



584
585
586
587
588
589
590
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
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 584

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:



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

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



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
694
695
696
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 649

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:



702
703
704
705
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 702

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



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
756
757
758
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 711

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_dmarc_domain(lookup_dmarc_domain_options, opts = {}) ⇒ LookupDmarcDomainResults

Lookup a DMARC record policy

Parameters:

Returns:



764
765
766
767
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 764

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



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
818
819
820
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 773

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:



826
827
828
829
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 826

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



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
880
881
882
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 835

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_tls_reporting_domain(lookup_tls_reporting_domain_options, opts = {}) ⇒ LookupTlsReportingDomainResults

Lookup a TLS reporting domain policy

Parameters:

Returns:



888
889
890
891
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 888

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:



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
942
943
944
 
# File 'lib/mailslurp_client/api/tools_controller_api.rb', line 897

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