Class: MailSlurpClient::InboxForwarderControllerApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ InboxForwarderControllerApi

Returns a new instance of InboxForwarderControllerApi.



19
20
21
 
# File 'lib/mailslurp_client/api/inbox_forwarder_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/inbox_forwarder_controller_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_new_inbox_forwarder(create_inbox_forwarder_options, opts = {}) ⇒ InboxForwarderDto

Create an inbox forwarder Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving

Parameters:

Options Hash (opts):

  • :inbox_id (String) —

    Inbox id to attach forwarder to

Returns:



28
29
30
31
 
# File 'lib/mailslurp_client/api/inbox_forwarder_controller_api.rb', line 28

def create_new_inbox_forwarder(create_inbox_forwarder_options, opts = {})
  data, _status_code, _headers = create_new_inbox_forwarder_with_http_info(create_inbox_forwarder_options, opts)
  data
end

#create_new_inbox_forwarder_with_http_info(create_inbox_forwarder_options, opts = {}) ⇒ Array<(InboxForwarderDto, Integer, Hash)>

Create an inbox forwarder Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving

Parameters:

Options Hash (opts):

  • :inbox_id (String) —

    Inbox id to attach forwarder to

Returns:

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

    InboxForwarderDto data, response status code and response headers



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
83
84
85
86
87
 
# File 'lib/mailslurp_client/api/inbox_forwarder_controller_api.rb', line 39

def create_new_inbox_forwarder_with_http_info(create_inbox_forwarder_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InboxForwarderControllerApi.create_new_inbox_forwarder ...'
  end
  # verify the required parameter 'create_inbox_forwarder_options' is set
  if @api_client.config.client_side_validation && create_inbox_forwarder_options.nil?
    fail ArgumentError, "Missing the required parameter 'create_inbox_forwarder_options' when calling InboxForwarderControllerApi.create_new_inbox_forwarder"
  end
  # resource path
  local_var_path = '/forwarders'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?

  # 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(create_inbox_forwarder_options) 

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

  # 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: InboxForwarderControllerApi#create_new_inbox_forwarder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_inbox_forwarder(id, opts = {}) ⇒ nil

Delete an inbox forwarder Delete inbox forwarder

Parameters:

  • id (String) —

    ID of inbox forwarder

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

    the optional parameters

Returns:

  • (nil) 


94
95
96
97
 
# File 'lib/mailslurp_client/api/inbox_forwarder_controller_api.rb', line 94

def delete_inbox_forwarder(id, opts = {})
  delete_inbox_forwarder_with_http_info(id, opts)
  nil
end

#delete_inbox_forwarder_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete an inbox forwarder Delete inbox forwarder

Parameters:

  • id (String) —

    ID of inbox forwarder

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
145
146
147
 
# File 'lib/mailslurp_client/api/inbox_forwarder_controller_api.rb', line 104

def delete_inbox_forwarder_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InboxForwarderControllerApi.delete_inbox_forwarder ...'
  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 InboxForwarderControllerApi.delete_inbox_forwarder"
  end
  # resource path
  local_var_path = '/forwarders/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

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

  # 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: InboxForwarderControllerApi#delete_inbox_forwarder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_inbox_forwarders(opts = {}) ⇒ nil

Delete inbox forwarders Delete inbox forwarders. Accepts optional inboxId filter.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :inbox_id (String) —

    Optional inbox id to attach forwarder to

Returns:

  • (nil) 


154
155
156
157
 
# File 'lib/mailslurp_client/api/inbox_forwarder_controller_api.rb', line 154

def delete_inbox_forwarders(opts = {})
  delete_inbox_forwarders_with_http_info(opts)
  nil
end

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

Delete inbox forwarders Delete inbox forwarders. Accepts optional inboxId filter.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :inbox_id (String) —

    Optional inbox id to attach forwarder to

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/mailslurp_client/api/inbox_forwarder_controller_api.rb', line 164

def delete_inbox_forwarders_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InboxForwarderControllerApi.delete_inbox_forwarders ...'
  end
  # resource path
  local_var_path = '/forwarders'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?

  # 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: InboxForwarderControllerApi#delete_inbox_forwarders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_all_inbox_forwarder_events(opts = {}) ⇒ PageInboxForwarderEvents

Get all inbox forwarder events Get all inbox forwarder events

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Optional page index in inbox forwarder event list pagination (default to 0)

  • :size (Integer) —

    Optional page size in inbox forwarder event list pagination (default to 20)

  • :inbox_id (String) —

    Optional inbox ID to filter for

  • :email_id (String) —

    Optional email ID to filter for

  • :sent_id (String) —

    Optional sent ID to filter for

  • :sort (String) —

    Optional createdAt sort direction ASC or DESC (default to 'ASC')

Returns:



216
217
218
219
 
# File 'lib/mailslurp_client/api/inbox_forwarder_controller_api.rb', line 216

def get_all_inbox_forwarder_events(opts = {})
  data, _status_code, _headers = get_all_inbox_forwarder_events_with_http_info(opts)
  data
end

#get_all_inbox_forwarder_events_with_http_info(opts = {}) ⇒ Array<(PageInboxForwarderEvents, Integer, Hash)>

Get all inbox forwarder events Get all inbox forwarder events

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Optional page index in inbox forwarder event list pagination

  • :size (Integer) —

    Optional page size in inbox forwarder event list pagination

  • :inbox_id (String) —

    Optional inbox ID to filter for

  • :email_id (String) —

    Optional email ID to filter for

  • :sent_id (String) —

    Optional sent ID to filter for

  • :sort (String) —

    Optional createdAt sort direction ASC or DESC

Returns:

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

    PageInboxForwarderEvents data, response status code and response headers



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
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/mailslurp_client/api/inbox_forwarder_controller_api.rb', line 231

def get_all_inbox_forwarder_events_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InboxForwarderControllerApi.get_all_inbox_forwarder_events ...'
  end
  allowable_values = ["ASC", "DESC"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/forwarders/events'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
  query_params[:'emailId'] = opts[:'email_id'] if !opts[:'email_id'].nil?
  query_params[:'sentId'] = opts[:'sent_id'] if !opts[:'sent_id'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].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] || 'PageInboxForwarderEvents' 

  # 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: InboxForwarderControllerApi#get_all_inbox_forwarder_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_forwarder_event(event_id, opts = {}) ⇒ InboxForwarderEventDto

Get a forwarder event Get forwarder event

Parameters:

  • event_id (String) —

    ID of inbox forwarder event

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

    the optional parameters

Returns:



289
290
291
292
 
# File 'lib/mailslurp_client/api/inbox_forwarder_controller_api.rb', line 289

def get_forwarder_event(event_id, opts = {})
  data, _status_code, _headers = get_forwarder_event_with_http_info(event_id, opts)
  data
end

#get_forwarder_event_with_http_info(event_id, opts = {}) ⇒ Array<(InboxForwarderEventDto, Integer, Hash)>

Get a forwarder event Get forwarder event

Parameters:

  • event_id (String) —

    ID of inbox forwarder event

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

    the optional parameters

Returns:

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

    InboxForwarderEventDto data, response status code and response headers



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
331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/mailslurp_client/api/inbox_forwarder_controller_api.rb', line 299

def get_forwarder_event_with_http_info(event_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InboxForwarderControllerApi.get_forwarder_event ...'
  end
  # verify the required parameter 'event_id' is set
  if @api_client.config.client_side_validation && event_id.nil?
    fail ArgumentError, "Missing the required parameter 'event_id' when calling InboxForwarderControllerApi.get_forwarder_event"
  end
  # resource path
  local_var_path = '/forwarders/events/{eventId}'.sub('{' + 'eventId' + '}', CGI.escape(event_id.to_s))

  # 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] || 'InboxForwarderEventDto' 

  # 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: InboxForwarderControllerApi#get_forwarder_event\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_inbox_forwarder(id, opts = {}) ⇒ InboxForwarderDto

Get an inbox forwarder Get inbox forwarder

Parameters:

  • id (String) —

    ID of inbox forwarder

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

    the optional parameters

Returns:



351
352
353
354
 
# File 'lib/mailslurp_client/api/inbox_forwarder_controller_api.rb', line 351

def get_inbox_forwarder(id, opts = {})
  data, _status_code, _headers = get_inbox_forwarder_with_http_info(id, opts)
  data
end

#get_inbox_forwarder_event(id, event_id, opts = {}) ⇒ InboxForwarderEventDto

Get an inbox forwarder event Get inbox forwarder event

Parameters:

  • id (String) —

    ID of inbox forwarder

  • event_id (String) —

    ID of inbox forwarder event

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

    the optional parameters

Returns:



414
415
416
417
 
# File 'lib/mailslurp_client/api/inbox_forwarder_controller_api.rb', line 414

def get_inbox_forwarder_event(id, event_id, opts = {})
  data, _status_code, _headers = get_inbox_forwarder_event_with_http_info(id, event_id, opts)
  data
end

#get_inbox_forwarder_event_with_http_info(id, event_id, opts = {}) ⇒ Array<(InboxForwarderEventDto, Integer, Hash)>

Get an inbox forwarder event Get inbox forwarder event

Parameters:

  • id (String) —

    ID of inbox forwarder

  • event_id (String) —

    ID of inbox forwarder event

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

    the optional parameters

Returns:

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

    InboxForwarderEventDto data, response status code and response headers



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
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'lib/mailslurp_client/api/inbox_forwarder_controller_api.rb', line 425

def get_inbox_forwarder_event_with_http_info(id, event_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InboxForwarderControllerApi.get_inbox_forwarder_event ...'
  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 InboxForwarderControllerApi.get_inbox_forwarder_event"
  end
  # verify the required parameter 'event_id' is set
  if @api_client.config.client_side_validation && event_id.nil?
    fail ArgumentError, "Missing the required parameter 'event_id' when calling InboxForwarderControllerApi.get_inbox_forwarder_event"
  end
  # resource path
  local_var_path = '/forwarders/{id}/events/{eventId}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'eventId' + '}', CGI.escape(event_id.to_s))

  # 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] || 'InboxForwarderEventDto' 

  # 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: InboxForwarderControllerApi#get_inbox_forwarder_event\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_inbox_forwarder_events(id, opts = {}) ⇒ PageInboxForwarderEvents

Get an inbox forwarder event list Get inbox forwarder events

Parameters:

  • id (String) —

    ID of inbox forwarder

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Optional page index in inbox forwarder event list pagination (default to 0)

  • :size (Integer) —

    Optional page size in inbox forwarder event list pagination (default to 20)

  • :sort (String) —

    Optional createdAt sort direction ASC or DESC (default to 'ASC')

Returns:



484
485
486
487
 
# File 'lib/mailslurp_client/api/inbox_forwarder_controller_api.rb', line 484

def get_inbox_forwarder_events(id, opts = {})
  data, _status_code, _headers = get_inbox_forwarder_events_with_http_info(id, opts)
  data
end

#get_inbox_forwarder_events_with_http_info(id, opts = {}) ⇒ Array<(PageInboxForwarderEvents, Integer, Hash)>

Get an inbox forwarder event list Get inbox forwarder events

Parameters:

  • id (String) —

    ID of inbox forwarder

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Optional page index in inbox forwarder event list pagination

  • :size (Integer) —

    Optional page size in inbox forwarder event list pagination

  • :sort (String) —

    Optional createdAt sort direction ASC or DESC

Returns:

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

    PageInboxForwarderEvents data, response status code and response headers



497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
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
 
# File 'lib/mailslurp_client/api/inbox_forwarder_controller_api.rb', line 497

def get_inbox_forwarder_events_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InboxForwarderControllerApi.get_inbox_forwarder_events ...'
  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 InboxForwarderControllerApi.get_inbox_forwarder_events"
  end
  allowable_values = ["ASC", "DESC"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/forwarders/{id}/events'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].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] || 'PageInboxForwarderEvents' 

  # 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: InboxForwarderControllerApi#get_inbox_forwarder_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_inbox_forwarder_with_http_info(id, opts = {}) ⇒ Array<(InboxForwarderDto, Integer, Hash)>

Get an inbox forwarder Get inbox forwarder

Parameters:

  • id (String) —

    ID of inbox forwarder

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

    the optional parameters

Returns:

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

    InboxForwarderDto data, response status code and response headers



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
393
394
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'lib/mailslurp_client/api/inbox_forwarder_controller_api.rb', line 361

def get_inbox_forwarder_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InboxForwarderControllerApi.get_inbox_forwarder ...'
  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 InboxForwarderControllerApi.get_inbox_forwarder"
  end
  # resource path
  local_var_path = '/forwarders/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # 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] || 'InboxForwarderDto' 

  # 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: InboxForwarderControllerApi#get_inbox_forwarder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_inbox_forwarders(opts = {}) ⇒ PageInboxForwarderDto

List inbox forwarders List all forwarders attached to an inbox

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :inbox_id (String) —

    Optional inbox id to get forwarders from

  • :page (Integer) —

    Optional page index in inbox forwarder list pagination (default to 0)

  • :size (Integer) —

    Optional page size in inbox forwarder list pagination (default to 20)

  • :sort (String) —

    Optional createdAt sort direction ASC or DESC (default to 'ASC')

  • :search_filter (String) —

    Optional search filter

  • :since (DateTime) —

    Filter by created at after the given timestamp

  • :before (DateTime) —

    Filter by created at before the given timestamp

Returns:



562
563
564
565
 
# File 'lib/mailslurp_client/api/inbox_forwarder_controller_api.rb', line 562

def get_inbox_forwarders(opts = {})
  data, _status_code, _headers = get_inbox_forwarders_with_http_info(opts)
  data
end

#get_inbox_forwarders_with_http_info(opts = {}) ⇒ Array<(PageInboxForwarderDto, Integer, Hash)>

List inbox forwarders List all forwarders attached to an inbox

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :inbox_id (String) —

    Optional inbox id to get forwarders from

  • :page (Integer) —

    Optional page index in inbox forwarder list pagination

  • :size (Integer) —

    Optional page size in inbox forwarder list pagination

  • :sort (String) —

    Optional createdAt sort direction ASC or DESC

  • :search_filter (String) —

    Optional search filter

  • :since (DateTime) —

    Filter by created at after the given timestamp

  • :before (DateTime) —

    Filter by created at before the given timestamp

Returns:

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

    PageInboxForwarderDto data, response status code and response headers



578
579
580
581
582
583
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/inbox_forwarder_controller_api.rb', line 578

def get_inbox_forwarders_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InboxForwarderControllerApi.get_inbox_forwarders ...'
  end
  allowable_values = ["ASC", "DESC"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/forwarders'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
  query_params[:'before'] = opts[:'before'] if !opts[:'before'].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] || 'PageInboxForwarderDto' 

  # 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: InboxForwarderControllerApi#get_inbox_forwarders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#test_inbox_forwarder(id, inbox_forwarder_test_options, opts = {}) ⇒ InboxForwarderTestResult

Test an inbox forwarder Test an inbox forwarder

Parameters:

  • id (String) —

    ID of inbox forwarder

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

    the optional parameters

Returns:



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

def test_inbox_forwarder(id, inbox_forwarder_test_options, opts = {})
  data, _status_code, _headers = test_inbox_forwarder_with_http_info(id, inbox_forwarder_test_options, opts)
  data
end

#test_inbox_forwarder_with_http_info(id, inbox_forwarder_test_options, opts = {}) ⇒ Array<(InboxForwarderTestResult, Integer, Hash)>

Test an inbox forwarder Test an inbox forwarder

Parameters:

  • id (String) —

    ID of inbox forwarder

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

    the optional parameters

Returns:

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

    InboxForwarderTestResult 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
697
698
699
700
 
# File 'lib/mailslurp_client/api/inbox_forwarder_controller_api.rb', line 649

def test_inbox_forwarder_with_http_info(id, inbox_forwarder_test_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InboxForwarderControllerApi.test_inbox_forwarder ...'
  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 InboxForwarderControllerApi.test_inbox_forwarder"
  end
  # verify the required parameter 'inbox_forwarder_test_options' is set
  if @api_client.config.client_side_validation && inbox_forwarder_test_options.nil?
    fail ArgumentError, "Missing the required parameter 'inbox_forwarder_test_options' when calling InboxForwarderControllerApi.test_inbox_forwarder"
  end
  # resource path
  local_var_path = '/forwarders/{id}/test'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # 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(inbox_forwarder_test_options) 

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

  # 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: InboxForwarderControllerApi#test_inbox_forwarder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#test_inbox_forwarders_for_inbox(inbox_id, inbox_forwarder_test_options, opts = {}) ⇒ InboxForwarderTestResult

Test inbox forwarders for inbox Test inbox forwarders for inbox

Parameters:

  • inbox_id (String) —

    ID of inbox

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

    the optional parameters

Returns:



708
709
710
711
 
# File 'lib/mailslurp_client/api/inbox_forwarder_controller_api.rb', line 708

def test_inbox_forwarders_for_inbox(inbox_id, inbox_forwarder_test_options, opts = {})
  data, _status_code, _headers = test_inbox_forwarders_for_inbox_with_http_info(inbox_id, inbox_forwarder_test_options, opts)
  data
end

#test_inbox_forwarders_for_inbox_with_http_info(inbox_id, inbox_forwarder_test_options, opts = {}) ⇒ Array<(InboxForwarderTestResult, Integer, Hash)>

Test inbox forwarders for inbox Test inbox forwarders for inbox

Parameters:

  • inbox_id (String) —

    ID of inbox

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

    the optional parameters

Returns:

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

    InboxForwarderTestResult data, response status code and response headers



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
759
760
761
762
763
764
765
766
767
768
769
770
771
 
# File 'lib/mailslurp_client/api/inbox_forwarder_controller_api.rb', line 719

def test_inbox_forwarders_for_inbox_with_http_info(inbox_id, inbox_forwarder_test_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InboxForwarderControllerApi.test_inbox_forwarders_for_inbox ...'
  end
  # verify the required parameter 'inbox_id' is set
  if @api_client.config.client_side_validation && inbox_id.nil?
    fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxForwarderControllerApi.test_inbox_forwarders_for_inbox"
  end
  # verify the required parameter 'inbox_forwarder_test_options' is set
  if @api_client.config.client_side_validation && inbox_forwarder_test_options.nil?
    fail ArgumentError, "Missing the required parameter 'inbox_forwarder_test_options' when calling InboxForwarderControllerApi.test_inbox_forwarders_for_inbox"
  end
  # resource path
  local_var_path = '/forwarders'

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

  # 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(inbox_forwarder_test_options) 

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

  # 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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InboxForwarderControllerApi#test_inbox_forwarders_for_inbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#test_new_inbox_forwarder(test_new_inbox_forwarder_options, opts = {}) ⇒ InboxForwarderTestResult

Test new inbox forwarder Test new inbox forwarder

Parameters:

Returns:



778
779
780
781
 
# File 'lib/mailslurp_client/api/inbox_forwarder_controller_api.rb', line 778

def test_new_inbox_forwarder(test_new_inbox_forwarder_options, opts = {})
  data, _status_code, _headers = test_new_inbox_forwarder_with_http_info(test_new_inbox_forwarder_options, opts)
  data
end

#test_new_inbox_forwarder_with_http_info(test_new_inbox_forwarder_options, opts = {}) ⇒ Array<(InboxForwarderTestResult, Integer, Hash)>

Test new inbox forwarder Test new inbox forwarder

Parameters:

Returns:

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

    InboxForwarderTestResult data, response status code and response headers



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
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
 
# File 'lib/mailslurp_client/api/inbox_forwarder_controller_api.rb', line 788

def test_new_inbox_forwarder_with_http_info(test_new_inbox_forwarder_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InboxForwarderControllerApi.test_new_inbox_forwarder ...'
  end
  # verify the required parameter 'test_new_inbox_forwarder_options' is set
  if @api_client.config.client_side_validation && test_new_inbox_forwarder_options.nil?
    fail ArgumentError, "Missing the required parameter 'test_new_inbox_forwarder_options' when calling InboxForwarderControllerApi.test_new_inbox_forwarder"
  end
  # resource path
  local_var_path = '/forwarders'

  # 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_new_inbox_forwarder_options) 

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

  # 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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InboxForwarderControllerApi#test_new_inbox_forwarder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_inbox_forwarder(id, create_inbox_forwarder_options, opts = {}) ⇒ InboxForwarderDto

Update an inbox forwarder Update inbox forwarder

Parameters:

  • id (String) —

    ID of inbox forwarder

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

    the optional parameters

Returns:



843
844
845
846
 
# File 'lib/mailslurp_client/api/inbox_forwarder_controller_api.rb', line 843

def update_inbox_forwarder(id, create_inbox_forwarder_options, opts = {})
  data, _status_code, _headers = update_inbox_forwarder_with_http_info(id, create_inbox_forwarder_options, opts)
  data
end

#update_inbox_forwarder_with_http_info(id, create_inbox_forwarder_options, opts = {}) ⇒ Array<(InboxForwarderDto, Integer, Hash)>

Update an inbox forwarder Update inbox forwarder

Parameters:

  • id (String) —

    ID of inbox forwarder

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

    the optional parameters

Returns:

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

    InboxForwarderDto data, response status code and response headers



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
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
 
# File 'lib/mailslurp_client/api/inbox_forwarder_controller_api.rb', line 854

def update_inbox_forwarder_with_http_info(id, create_inbox_forwarder_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InboxForwarderControllerApi.update_inbox_forwarder ...'
  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 InboxForwarderControllerApi.update_inbox_forwarder"
  end
  # verify the required parameter 'create_inbox_forwarder_options' is set
  if @api_client.config.client_side_validation && create_inbox_forwarder_options.nil?
    fail ArgumentError, "Missing the required parameter 'create_inbox_forwarder_options' when calling InboxForwarderControllerApi.update_inbox_forwarder"
  end
  # resource path
  local_var_path = '/forwarders/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # 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(create_inbox_forwarder_options) 

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

  # 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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InboxForwarderControllerApi#update_inbox_forwarder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end