mailslurp_client 13.0.0 → 14.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/mailslurp_client/api/alias_controller_api.rb +19 -1
- data/lib/mailslurp_client/api/attachment_controller_api.rb +7 -1
- data/lib/mailslurp_client/api/bounce_controller_api.rb +13 -1
- data/lib/mailslurp_client/api/bulk_actions_controller_api.rb +1 -1
- data/lib/mailslurp_client/api/common_actions_controller_api.rb +45 -1
- data/lib/mailslurp_client/api/contact_controller_api.rb +7 -1
- data/lib/mailslurp_client/api/domain_controller_api.rb +1 -1
- data/lib/mailslurp_client/api/email_controller_api.rb +17 -5
- data/lib/mailslurp_client/api/expired_controller_api.rb +7 -1
- data/lib/mailslurp_client/api/export_controller_api.rb +1 -1
- data/lib/mailslurp_client/api/form_controller_api.rb +1 -1
- data/lib/mailslurp_client/api/group_controller_api.rb +13 -1
- data/lib/mailslurp_client/api/inbox_controller_api.rb +52 -7
- data/lib/mailslurp_client/api/inbox_forwarder_controller_api.rb +7 -1
- data/lib/mailslurp_client/api/inbox_ruleset_controller_api.rb +7 -1
- data/lib/mailslurp_client/api/mail_server_controller_api.rb +1 -1
- data/lib/mailslurp_client/api/missed_email_controller_api.rb +94 -1
- data/lib/mailslurp_client/api/sent_emails_controller_api.rb +25 -1
- data/lib/mailslurp_client/api/template_controller_api.rb +81 -7
- data/lib/mailslurp_client/api/tracking_controller_api.rb +7 -1
- data/lib/mailslurp_client/api/wait_for_controller_api.rb +22 -7
- data/lib/mailslurp_client/api/webhook_controller_api.rb +268 -8
- data/lib/mailslurp_client/api_client.rb +1 -1
- data/lib/mailslurp_client/api_error.rb +1 -1
- data/lib/mailslurp_client/configuration.rb +1 -1
- data/lib/mailslurp_client/models/abstract_webhook_payload.rb +3 -3
- data/lib/mailslurp_client/models/alias_dto.rb +1 -1
- data/lib/mailslurp_client/models/alias_projection.rb +1 -1
- data/lib/mailslurp_client/models/attachment_entity.rb +1 -1
- data/lib/mailslurp_client/models/attachment_meta_data.rb +1 -1
- data/lib/mailslurp_client/models/attachment_projection.rb +1 -1
- data/lib/mailslurp_client/models/basic_auth_options.rb +1 -1
- data/lib/mailslurp_client/models/bounce_projection.rb +1 -1
- data/lib/mailslurp_client/models/bounce_recipient.rb +1 -1
- data/lib/mailslurp_client/models/bounced_email_dto.rb +1 -1
- data/lib/mailslurp_client/models/bounced_recipient_dto.rb +1 -1
- data/lib/mailslurp_client/models/bulk_send_email_options.rb +1 -1
- data/lib/mailslurp_client/models/condition_option.rb +1 -1
- data/lib/mailslurp_client/models/contact_dto.rb +1 -1
- data/lib/mailslurp_client/models/contact_projection.rb +1 -1
- data/lib/mailslurp_client/models/content_match_options.rb +1 -1
- data/lib/mailslurp_client/models/create_alias_options.rb +1 -1
- data/lib/mailslurp_client/models/create_contact_options.rb +1 -1
- data/lib/mailslurp_client/models/create_domain_options.rb +1 -1
- data/lib/mailslurp_client/models/create_group_options.rb +1 -1
- data/lib/mailslurp_client/models/create_inbox_dto.rb +2 -2
- data/lib/mailslurp_client/models/create_inbox_forwarder_options.rb +1 -1
- data/lib/mailslurp_client/models/create_inbox_ruleset_options.rb +1 -1
- data/lib/mailslurp_client/models/create_template_options.rb +1 -1
- data/lib/mailslurp_client/models/create_tracking_pixel_options.rb +1 -1
- data/lib/mailslurp_client/models/create_webhook_options.rb +3 -3
- data/lib/mailslurp_client/models/describe_domain_options.rb +1 -1
- data/lib/mailslurp_client/models/describe_mail_server_domain_result.rb +1 -1
- data/lib/mailslurp_client/models/dns_lookup_options.rb +1 -1
- data/lib/mailslurp_client/models/dns_lookup_result.rb +1 -1
- data/lib/mailslurp_client/models/dns_lookup_results.rb +1 -1
- data/lib/mailslurp_client/models/domain_dto.rb +1 -1
- data/lib/mailslurp_client/models/domain_name_record.rb +1 -1
- data/lib/mailslurp_client/models/domain_preview.rb +1 -1
- data/lib/mailslurp_client/models/download_attachment_dto.rb +1 -1
- data/lib/mailslurp_client/models/email.rb +29 -11
- data/lib/mailslurp_client/models/email_analysis.rb +1 -1
- data/lib/mailslurp_client/models/email_content_match_result.rb +1 -1
- data/lib/mailslurp_client/models/email_links_result.rb +1 -1
- data/lib/mailslurp_client/models/email_preview.rb +7 -7
- data/lib/mailslurp_client/models/email_projection.rb +1 -1
- data/lib/mailslurp_client/models/email_recipients.rb +230 -0
- data/lib/mailslurp_client/models/email_text_lines_result.rb +1 -1
- data/lib/mailslurp_client/models/email_verification_result.rb +2 -2
- data/lib/mailslurp_client/models/expiration_defaults.rb +1 -1
- data/lib/mailslurp_client/models/expired_inbox_dto.rb +1 -1
- data/lib/mailslurp_client/models/expired_inbox_record_projection.rb +1 -1
- data/lib/mailslurp_client/models/export_link.rb +1 -1
- data/lib/mailslurp_client/models/export_options.rb +1 -1
- data/lib/mailslurp_client/models/forward_email_options.rb +1 -1
- data/lib/mailslurp_client/models/gravatar_url.rb +1 -1
- data/lib/mailslurp_client/models/group_contacts_dto.rb +1 -1
- data/lib/mailslurp_client/models/group_dto.rb +1 -1
- data/lib/mailslurp_client/models/group_projection.rb +1 -1
- data/lib/mailslurp_client/models/html_validation_result.rb +1 -1
- data/lib/mailslurp_client/models/inbox.rb +1 -1
- data/lib/mailslurp_client/models/inbox_forwarder_dto.rb +1 -1
- data/lib/mailslurp_client/models/inbox_forwarder_test_options.rb +1 -1
- data/lib/mailslurp_client/models/inbox_forwarder_test_result.rb +1 -1
- data/lib/mailslurp_client/models/inbox_projection.rb +1 -1
- data/lib/mailslurp_client/models/inbox_ruleset_dto.rb +1 -1
- data/lib/mailslurp_client/models/inbox_ruleset_test_options.rb +1 -1
- data/lib/mailslurp_client/models/inbox_ruleset_test_result.rb +1 -1
- data/lib/mailslurp_client/models/ip_address_result.rb +1 -1
- data/lib/mailslurp_client/models/json_schema_dto.rb +211 -0
- data/lib/mailslurp_client/models/match_option.rb +1 -1
- data/lib/mailslurp_client/models/match_options.rb +1 -1
- data/lib/mailslurp_client/models/missed_email.rb +1 -6
- data/lib/mailslurp_client/models/missed_email_projection.rb +1 -6
- data/lib/mailslurp_client/models/name_server_record.rb +1 -1
- data/lib/mailslurp_client/models/organization_inbox_projection.rb +1 -1
- data/lib/mailslurp_client/models/page_alias.rb +1 -1
- data/lib/mailslurp_client/models/page_attachment_entity.rb +1 -1
- data/lib/mailslurp_client/models/page_bounced_email.rb +1 -1
- data/lib/mailslurp_client/models/page_bounced_recipients.rb +1 -1
- data/lib/mailslurp_client/models/page_contact_projection.rb +1 -1
- data/lib/mailslurp_client/models/page_email_preview.rb +1 -1
- data/lib/mailslurp_client/models/page_email_projection.rb +1 -1
- data/lib/mailslurp_client/models/page_expired_inbox_record_projection.rb +1 -1
- data/lib/mailslurp_client/models/page_group_projection.rb +1 -1
- data/lib/mailslurp_client/models/page_inbox_forwarder_dto.rb +1 -1
- data/lib/mailslurp_client/models/page_inbox_projection.rb +1 -1
- data/lib/mailslurp_client/models/page_inbox_ruleset_dto.rb +1 -1
- data/lib/mailslurp_client/models/page_missed_email_projection.rb +1 -1
- data/lib/mailslurp_client/models/page_organization_inbox_projection.rb +1 -1
- data/lib/mailslurp_client/models/page_sent_email_projection.rb +1 -1
- data/lib/mailslurp_client/models/page_template_projection.rb +1 -1
- data/lib/mailslurp_client/models/page_thread_projection.rb +1 -1
- data/lib/mailslurp_client/models/page_tracking_pixel_projection.rb +1 -1
- data/lib/mailslurp_client/models/page_unknown_missed_email_projection.rb +299 -0
- data/lib/mailslurp_client/models/page_webhook_projection.rb +2 -1
- data/lib/mailslurp_client/models/page_webhook_result.rb +2 -2
- data/lib/mailslurp_client/models/pageable.rb +1 -1
- data/lib/mailslurp_client/models/raw_email_json.rb +1 -1
- data/lib/mailslurp_client/models/{model_alias.rb → recipient.rb} +14 -74
- data/lib/mailslurp_client/models/reply_to_alias_email_options.rb +1 -1
- data/lib/mailslurp_client/models/reply_to_email_options.rb +1 -1
- data/lib/mailslurp_client/models/send_email_options.rb +1 -1
- data/lib/mailslurp_client/models/sender.rb +234 -0
- data/lib/mailslurp_client/models/sent_email_dto.rb +1 -1
- data/lib/mailslurp_client/models/sent_email_projection.rb +1 -1
- data/lib/mailslurp_client/models/set_inbox_favourited_options.rb +1 -1
- data/lib/mailslurp_client/models/simple_send_email_options.rb +1 -1
- data/lib/mailslurp_client/models/sort.rb +1 -1
- data/lib/mailslurp_client/models/template_dto.rb +1 -1
- data/lib/mailslurp_client/models/template_projection.rb +1 -1
- data/lib/mailslurp_client/models/template_variable.rb +1 -1
- data/lib/mailslurp_client/models/test_new_inbox_forwarder_options.rb +1 -1
- data/lib/mailslurp_client/models/test_new_inbox_ruleset_options.rb +1 -1
- data/lib/mailslurp_client/models/thread_projection.rb +1 -1
- data/lib/mailslurp_client/models/tracking_pixel_dto.rb +1 -1
- data/lib/mailslurp_client/models/tracking_pixel_projection.rb +1 -1
- data/lib/mailslurp_client/models/unknown_missed_email_projection.rb +254 -0
- data/lib/mailslurp_client/models/unread_count.rb +1 -1
- data/lib/mailslurp_client/models/update_alias_options.rb +1 -1
- data/lib/mailslurp_client/models/update_domain_options.rb +1 -1
- data/lib/mailslurp_client/models/update_group_contacts.rb +1 -1
- data/lib/mailslurp_client/models/update_inbox_options.rb +1 -1
- data/lib/mailslurp_client/models/upload_attachment_options.rb +2 -2
- data/lib/mailslurp_client/models/validation_dto.rb +1 -1
- data/lib/mailslurp_client/models/validation_message.rb +1 -1
- data/lib/mailslurp_client/models/verify_email_address_options.rb +1 -1
- data/lib/mailslurp_client/models/wait_for_conditions.rb +43 -3
- data/lib/mailslurp_client/models/webhook_dto.rb +4 -4
- data/lib/mailslurp_client/models/webhook_email_opened_payload.rb +3 -3
- data/lib/mailslurp_client/models/webhook_email_read_payload.rb +312 -0
- data/lib/mailslurp_client/models/webhook_new_attachment_payload.rb +3 -3
- data/lib/mailslurp_client/models/webhook_new_contact_payload.rb +3 -3
- data/lib/mailslurp_client/models/webhook_new_email_payload.rb +8 -8
- data/lib/mailslurp_client/models/webhook_projection.rb +3 -3
- data/lib/mailslurp_client/models/webhook_redrive_result.rb +234 -0
- data/lib/mailslurp_client/models/{webhook_result_entity.rb → webhook_result_dto.rb} +16 -7
- data/lib/mailslurp_client/models/webhook_test_request.rb +1 -1
- data/lib/mailslurp_client/models/webhook_test_response.rb +1 -1
- data/lib/mailslurp_client/models/webhook_test_result.rb +1 -1
- data/lib/mailslurp_client/version.rb +2 -2
- data/lib/mailslurp_client.rb +10 -3
- metadata +11 -4
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#MailSlurp API
|
3
3
|
|
4
|
-
#MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
|
4
|
+
#MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
|
5
5
|
|
6
6
|
The version of the OpenAPI document: 6.5.2
|
7
7
|
|
@@ -202,7 +202,9 @@ module MailSlurpClient
|
|
202
202
|
# List records of expired inboxes
|
203
203
|
# Inboxes created with an expiration date will expire after the given date. An ExpiredInboxRecord is created that records the inboxes old ID and email address. You can still read emails in the inbox (using the inboxes old ID) but the email address associated with the inbox can no longer send or receive emails. Fetch expired inbox records to view the old inboxes properties
|
204
204
|
# @param [Hash] opts the optional parameters
|
205
|
+
# @option opts [DateTime] :before Filter by created at before the given timestamp
|
205
206
|
# @option opts [Integer] :page Optional page index in inbox sent email list pagination (default to 0)
|
207
|
+
# @option opts [DateTime] :since Filter by created at after the given timestamp
|
206
208
|
# @option opts [Integer] :size Optional page size in inbox sent email list pagination (default to 20)
|
207
209
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
|
208
210
|
# @return [PageExpiredInboxRecordProjection]
|
@@ -214,7 +216,9 @@ module MailSlurpClient
|
|
214
216
|
# List records of expired inboxes
|
215
217
|
# Inboxes created with an expiration date will expire after the given date. An ExpiredInboxRecord is created that records the inboxes old ID and email address. You can still read emails in the inbox (using the inboxes old ID) but the email address associated with the inbox can no longer send or receive emails. Fetch expired inbox records to view the old inboxes properties
|
216
218
|
# @param [Hash] opts the optional parameters
|
219
|
+
# @option opts [DateTime] :before Filter by created at before the given timestamp
|
217
220
|
# @option opts [Integer] :page Optional page index in inbox sent email list pagination
|
221
|
+
# @option opts [DateTime] :since Filter by created at after the given timestamp
|
218
222
|
# @option opts [Integer] :size Optional page size in inbox sent email list pagination
|
219
223
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
220
224
|
# @return [Array<(PageExpiredInboxRecordProjection, Integer, Hash)>] PageExpiredInboxRecordProjection data, response status code and response headers
|
@@ -231,7 +235,9 @@ module MailSlurpClient
|
|
231
235
|
|
232
236
|
# query parameters
|
233
237
|
query_params = opts[:query_params] || {}
|
238
|
+
query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
|
234
239
|
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
240
|
+
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
235
241
|
query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
|
236
242
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
237
243
|
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#MailSlurp API
|
3
3
|
|
4
|
-
#MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
|
4
|
+
#MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
|
5
5
|
|
6
6
|
The version of the OpenAPI document: 6.5.2
|
7
7
|
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#MailSlurp API
|
3
3
|
|
4
|
-
#MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
|
4
|
+
#MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
|
5
5
|
|
6
6
|
The version of the OpenAPI document: 6.5.2
|
7
7
|
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#MailSlurp API
|
3
3
|
|
4
|
-
#MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
|
4
|
+
#MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
|
5
5
|
|
6
6
|
The version of the OpenAPI document: 6.5.2
|
7
7
|
|
@@ -209,7 +209,9 @@ module MailSlurpClient
|
|
209
209
|
|
210
210
|
# Get all Contact Groups in paginated format
|
211
211
|
# @param [Hash] opts the optional parameters
|
212
|
+
# @option opts [DateTime] :before Filter by created at before the given timestamp
|
212
213
|
# @option opts [Integer] :page Optional page index in list pagination (default to 0)
|
214
|
+
# @option opts [DateTime] :since Filter by created at after the given timestamp
|
213
215
|
# @option opts [Integer] :size Optional page size in list pagination (default to 20)
|
214
216
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
|
215
217
|
# @return [PageGroupProjection]
|
@@ -220,7 +222,9 @@ module MailSlurpClient
|
|
220
222
|
|
221
223
|
# Get all Contact Groups in paginated format
|
222
224
|
# @param [Hash] opts the optional parameters
|
225
|
+
# @option opts [DateTime] :before Filter by created at before the given timestamp
|
223
226
|
# @option opts [Integer] :page Optional page index in list pagination
|
227
|
+
# @option opts [DateTime] :since Filter by created at after the given timestamp
|
224
228
|
# @option opts [Integer] :size Optional page size in list pagination
|
225
229
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
226
230
|
# @return [Array<(PageGroupProjection, Integer, Hash)>] PageGroupProjection data, response status code and response headers
|
@@ -237,7 +241,9 @@ module MailSlurpClient
|
|
237
241
|
|
238
242
|
# query parameters
|
239
243
|
query_params = opts[:query_params] || {}
|
244
|
+
query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
|
240
245
|
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
246
|
+
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
241
247
|
query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
|
242
248
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
243
249
|
|
@@ -397,7 +403,9 @@ module MailSlurpClient
|
|
397
403
|
# Get group and paginated contacts belonging to it
|
398
404
|
# @param group_id [String] groupId
|
399
405
|
# @param [Hash] opts the optional parameters
|
406
|
+
# @option opts [DateTime] :before Filter by created at before the given timestamp
|
400
407
|
# @option opts [Integer] :page Optional page index in group contact pagination (default to 0)
|
408
|
+
# @option opts [DateTime] :since Filter by created at after the given timestamp
|
401
409
|
# @option opts [Integer] :size Optional page size in group contact pagination (default to 20)
|
402
410
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
|
403
411
|
# @return [PageContactProjection]
|
@@ -409,7 +417,9 @@ module MailSlurpClient
|
|
409
417
|
# Get group and paginated contacts belonging to it
|
410
418
|
# @param group_id [String] groupId
|
411
419
|
# @param [Hash] opts the optional parameters
|
420
|
+
# @option opts [DateTime] :before Filter by created at before the given timestamp
|
412
421
|
# @option opts [Integer] :page Optional page index in group contact pagination
|
422
|
+
# @option opts [DateTime] :since Filter by created at after the given timestamp
|
413
423
|
# @option opts [Integer] :size Optional page size in group contact pagination
|
414
424
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
415
425
|
# @return [Array<(PageContactProjection, Integer, Hash)>] PageContactProjection data, response status code and response headers
|
@@ -430,7 +440,9 @@ module MailSlurpClient
|
|
430
440
|
|
431
441
|
# query parameters
|
432
442
|
query_params = opts[:query_params] || {}
|
443
|
+
query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
|
433
444
|
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
445
|
+
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
434
446
|
query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
|
435
447
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
436
448
|
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#MailSlurp API
|
3
3
|
|
4
|
-
#MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
|
4
|
+
#MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
|
5
5
|
|
6
6
|
The version of the OpenAPI document: 6.5.2
|
7
7
|
|
@@ -22,7 +22,7 @@ module MailSlurpClient
|
|
22
22
|
# Create an inbox email address. An inbox has a real email address and can send and receive emails. Inboxes can be either `SMTP` or `HTTP` inboxes.
|
23
23
|
# Create a new inbox and with a randomized email address to send and receive from. Pass emailAddress parameter if you wish to use a specific email address. Creating an inbox is required before sending or receiving emails. If writing tests it is recommended that you create a new inbox during each test method so that it is unique and empty.
|
24
24
|
# @param [Hash] opts the optional parameters
|
25
|
-
# @option opts [Boolean] :allow_team_access Grant team access to this inbox and the emails that belong to it for team members of your organization.
|
25
|
+
# @option opts [Boolean] :allow_team_access DEPRECATED (team access is always true). Grant team access to this inbox and the emails that belong to it for team members of your organization.
|
26
26
|
# @option opts [String] :description Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with
|
27
27
|
# @option opts [String] :email_address A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as `123@mailslurp.com`. If you use the `useDomainPool` option when the email address is null it will generate an email address with a more varied domain ending such as `123@mailslurp.info` or `123@mailslurp.biz`. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Note domain types must match the inbox type - so `SMTP` inboxes will only work with `SMTP` type domains. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID.
|
28
28
|
# @option opts [DateTime] :expires_at Optional inbox expiration date. If null then this inbox is permanent and the emails in it won't be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX.
|
@@ -41,7 +41,7 @@ module MailSlurpClient
|
|
41
41
|
# Create an inbox email address. An inbox has a real email address and can send and receive emails. Inboxes can be either `SMTP` or `HTTP` inboxes.
|
42
42
|
# Create a new inbox and with a randomized email address to send and receive from. Pass emailAddress parameter if you wish to use a specific email address. Creating an inbox is required before sending or receiving emails. If writing tests it is recommended that you create a new inbox during each test method so that it is unique and empty.
|
43
43
|
# @param [Hash] opts the optional parameters
|
44
|
-
# @option opts [Boolean] :allow_team_access Grant team access to this inbox and the emails that belong to it for team members of your organization.
|
44
|
+
# @option opts [Boolean] :allow_team_access DEPRECATED (team access is always true). Grant team access to this inbox and the emails that belong to it for team members of your organization.
|
45
45
|
# @option opts [String] :description Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with
|
46
46
|
# @option opts [String] :email_address A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as `123@mailslurp.com`. If you use the `useDomainPool` option when the email address is null it will generate an email address with a more varied domain ending such as `123@mailslurp.info` or `123@mailslurp.biz`. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Note domain types must match the inbox type - so `SMTP` inboxes will only work with `SMTP` type domains. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID.
|
47
47
|
# @option opts [DateTime] :expires_at Optional inbox expiration date. If null then this inbox is permanent and the emails in it won't be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX.
|
@@ -412,15 +412,17 @@ module MailSlurpClient
|
|
412
412
|
end
|
413
413
|
|
414
414
|
# List All Inboxes Paginated
|
415
|
-
# List inboxes in paginated form. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative `getInboxes` method returns a full list of inboxes but is limited to 100 results.
|
415
|
+
# List inboxes in paginated form. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative `getInboxes` method returns a full list of inboxes but is limited to 100 results.
|
416
416
|
# @param [Hash] opts the optional parameters
|
417
|
+
# @option opts [DateTime] :before Optional filter by created before given date time
|
417
418
|
# @option opts [Boolean] :favourite Optionally filter results for favourites only (default to false)
|
418
419
|
# @option opts [Integer] :page Optional page index in list pagination (default to 0)
|
419
420
|
# @option opts [String] :search Optionally filter by search words partial matching ID, tags, name, and email address
|
421
|
+
# @option opts [DateTime] :since Optional filter by created after given date time
|
420
422
|
# @option opts [Integer] :size Optional page size in list pagination (default to 20)
|
421
423
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
|
422
424
|
# @option opts [String] :tag Optionally filter by tags. Will return inboxes that include given tags
|
423
|
-
# @option opts [Boolean] :team_access Optionally filter by team access.
|
425
|
+
# @option opts [Boolean] :team_access DEPRECATED. Optionally filter by team access. (default to false)
|
424
426
|
# @return [PageInboxProjection]
|
425
427
|
def get_all_inboxes(opts = {})
|
426
428
|
data, _status_code, _headers = get_all_inboxes_with_http_info(opts)
|
@@ -428,15 +430,17 @@ module MailSlurpClient
|
|
428
430
|
end
|
429
431
|
|
430
432
|
# List All Inboxes Paginated
|
431
|
-
# List inboxes in paginated form. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative `getInboxes` method returns a full list of inboxes but is limited to 100 results.
|
433
|
+
# List inboxes in paginated form. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative `getInboxes` method returns a full list of inboxes but is limited to 100 results.
|
432
434
|
# @param [Hash] opts the optional parameters
|
435
|
+
# @option opts [DateTime] :before Optional filter by created before given date time
|
433
436
|
# @option opts [Boolean] :favourite Optionally filter results for favourites only
|
434
437
|
# @option opts [Integer] :page Optional page index in list pagination
|
435
438
|
# @option opts [String] :search Optionally filter by search words partial matching ID, tags, name, and email address
|
439
|
+
# @option opts [DateTime] :since Optional filter by created after given date time
|
436
440
|
# @option opts [Integer] :size Optional page size in list pagination
|
437
441
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
438
442
|
# @option opts [String] :tag Optionally filter by tags. Will return inboxes that include given tags
|
439
|
-
# @option opts [Boolean] :team_access Optionally filter by team access.
|
443
|
+
# @option opts [Boolean] :team_access DEPRECATED. Optionally filter by team access.
|
440
444
|
# @return [Array<(PageInboxProjection, Integer, Hash)>] PageInboxProjection data, response status code and response headers
|
441
445
|
def get_all_inboxes_with_http_info(opts = {})
|
442
446
|
if @api_client.config.debugging
|
@@ -451,9 +455,11 @@ module MailSlurpClient
|
|
451
455
|
|
452
456
|
# query parameters
|
453
457
|
query_params = opts[:query_params] || {}
|
458
|
+
query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
|
454
459
|
query_params[:'favourite'] = opts[:'favourite'] if !opts[:'favourite'].nil?
|
455
460
|
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
456
461
|
query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
|
462
|
+
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
457
463
|
query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
|
458
464
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
459
465
|
query_params[:'tag'] = opts[:'tag'] if !opts[:'tag'].nil?
|
@@ -496,6 +502,7 @@ module MailSlurpClient
|
|
496
502
|
# List emails that an inbox has received. Only emails that are sent to the inbox's email address will appear in the inbox. It may take several seconds for any email you send to an inbox's email address to appear in the inbox. To make this endpoint wait for a minimum number of emails use the `minCount` parameter. The server will retry the inbox database until the `minCount` is satisfied or the `retryTimeout` is reached
|
497
503
|
# @param inbox_id [String] Id of inbox that emails belongs to
|
498
504
|
# @param [Hash] opts the optional parameters
|
505
|
+
# @option opts [DateTime] :before Exclude emails received after this ISO 8601 date time
|
499
506
|
# @option opts [Integer] :delay_timeout delayTimeout
|
500
507
|
# @option opts [Integer] :limit Limit the result set, ordered by received date time sort direction. Maximum 100. For more listing options see the email controller
|
501
508
|
# @option opts [Integer] :min_count Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached.
|
@@ -514,6 +521,7 @@ module MailSlurpClient
|
|
514
521
|
# List emails that an inbox has received. Only emails that are sent to the inbox's email address will appear in the inbox. It may take several seconds for any email you send to an inbox's email address to appear in the inbox. To make this endpoint wait for a minimum number of emails use the `minCount` parameter. The server will retry the inbox database until the `minCount` is satisfied or the `retryTimeout` is reached
|
515
522
|
# @param inbox_id [String] Id of inbox that emails belongs to
|
516
523
|
# @param [Hash] opts the optional parameters
|
524
|
+
# @option opts [DateTime] :before Exclude emails received after this ISO 8601 date time
|
517
525
|
# @option opts [Integer] :delay_timeout delayTimeout
|
518
526
|
# @option opts [Integer] :limit Limit the result set, ordered by received date time sort direction. Maximum 100. For more listing options see the email controller
|
519
527
|
# @option opts [Integer] :min_count Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached.
|
@@ -540,6 +548,7 @@ module MailSlurpClient
|
|
540
548
|
|
541
549
|
# query parameters
|
542
550
|
query_params = opts[:query_params] || {}
|
551
|
+
query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
|
543
552
|
query_params[:'delayTimeout'] = opts[:'delay_timeout'] if !opts[:'delay_timeout'].nil?
|
544
553
|
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
545
554
|
query_params[:'minCount'] = opts[:'min_count'] if !opts[:'min_count'].nil?
|
@@ -648,7 +657,9 @@ module MailSlurpClient
|
|
648
657
|
# Get a paginated list of emails in an inbox. Does not hold connections open.
|
649
658
|
# @param inbox_id [String] Id of inbox that emails belongs to
|
650
659
|
# @param [Hash] opts the optional parameters
|
660
|
+
# @option opts [DateTime] :before Optional filter by received before given date time
|
651
661
|
# @option opts [Integer] :page Optional page index in inbox emails list pagination (default to 0)
|
662
|
+
# @option opts [DateTime] :since Optional filter by received after given date time
|
652
663
|
# @option opts [Integer] :size Optional page size in inbox emails list pagination (default to 20)
|
653
664
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
|
654
665
|
# @return [PageEmailPreview]
|
@@ -661,7 +672,9 @@ module MailSlurpClient
|
|
661
672
|
# Get a paginated list of emails in an inbox. Does not hold connections open.
|
662
673
|
# @param inbox_id [String] Id of inbox that emails belongs to
|
663
674
|
# @param [Hash] opts the optional parameters
|
675
|
+
# @option opts [DateTime] :before Optional filter by received before given date time
|
664
676
|
# @option opts [Integer] :page Optional page index in inbox emails list pagination
|
677
|
+
# @option opts [DateTime] :since Optional filter by received after given date time
|
665
678
|
# @option opts [Integer] :size Optional page size in inbox emails list pagination
|
666
679
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
667
680
|
# @return [Array<(PageEmailPreview, Integer, Hash)>] PageEmailPreview data, response status code and response headers
|
@@ -682,7 +695,9 @@ module MailSlurpClient
|
|
682
695
|
|
683
696
|
# query parameters
|
684
697
|
query_params = opts[:query_params] || {}
|
698
|
+
query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
|
685
699
|
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
700
|
+
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
686
701
|
query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
|
687
702
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
688
703
|
|
@@ -723,8 +738,10 @@ module MailSlurpClient
|
|
723
738
|
# Returns an inbox's sent email receipts. Call individual sent email endpoints for more details. Note for privacy reasons the full body of sent emails is never stored. An MD5 hash hex is available for comparison instead.
|
724
739
|
# @param inbox_id [String] inboxId
|
725
740
|
# @param [Hash] opts the optional parameters
|
741
|
+
# @option opts [DateTime] :before Optional filter by sent before given date time
|
726
742
|
# @option opts [Integer] :page Optional page index in inbox sent email list pagination (default to 0)
|
727
743
|
# @option opts [String] :search_filter Optional sent email search
|
744
|
+
# @option opts [DateTime] :since Optional filter by sent after given date time
|
728
745
|
# @option opts [Integer] :size Optional page size in inbox sent email list pagination (default to 20)
|
729
746
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
|
730
747
|
# @return [PageSentEmailProjection]
|
@@ -737,8 +754,10 @@ module MailSlurpClient
|
|
737
754
|
# Returns an inbox's sent email receipts. Call individual sent email endpoints for more details. Note for privacy reasons the full body of sent emails is never stored. An MD5 hash hex is available for comparison instead.
|
738
755
|
# @param inbox_id [String] inboxId
|
739
756
|
# @param [Hash] opts the optional parameters
|
757
|
+
# @option opts [DateTime] :before Optional filter by sent before given date time
|
740
758
|
# @option opts [Integer] :page Optional page index in inbox sent email list pagination
|
741
759
|
# @option opts [String] :search_filter Optional sent email search
|
760
|
+
# @option opts [DateTime] :since Optional filter by sent after given date time
|
742
761
|
# @option opts [Integer] :size Optional page size in inbox sent email list pagination
|
743
762
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
744
763
|
# @return [Array<(PageSentEmailProjection, Integer, Hash)>] PageSentEmailProjection data, response status code and response headers
|
@@ -759,8 +778,10 @@ module MailSlurpClient
|
|
759
778
|
|
760
779
|
# query parameters
|
761
780
|
query_params = opts[:query_params] || {}
|
781
|
+
query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
|
762
782
|
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
763
783
|
query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
|
784
|
+
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
764
785
|
query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
|
765
786
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
766
787
|
|
@@ -856,6 +877,8 @@ module MailSlurpClient
|
|
856
877
|
# List Inboxes and email addresses
|
857
878
|
# List the inboxes you have created. Note use of the more advanced `getAllEmails` is recommended and allows paginated access using a limit and sort parameter.
|
858
879
|
# @param [Hash] opts the optional parameters
|
880
|
+
# @option opts [DateTime] :before Optional filter by created before given date time
|
881
|
+
# @option opts [DateTime] :since Optional filter by created after given date time
|
859
882
|
# @option opts [Integer] :size Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated `getAllEmails` for larger queries. (default to 100)
|
860
883
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
|
861
884
|
# @return [Array<Inbox>]
|
@@ -867,6 +890,8 @@ module MailSlurpClient
|
|
867
890
|
# List Inboxes and email addresses
|
868
891
|
# List the inboxes you have created. Note use of the more advanced `getAllEmails` is recommended and allows paginated access using a limit and sort parameter.
|
869
892
|
# @param [Hash] opts the optional parameters
|
893
|
+
# @option opts [DateTime] :before Optional filter by created before given date time
|
894
|
+
# @option opts [DateTime] :since Optional filter by created after given date time
|
870
895
|
# @option opts [Integer] :size Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated `getAllEmails` for larger queries.
|
871
896
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
872
897
|
# @return [Array<(Array<Inbox>, Integer, Hash)>] Array<Inbox> data, response status code and response headers
|
@@ -883,6 +908,8 @@ module MailSlurpClient
|
|
883
908
|
|
884
909
|
# query parameters
|
885
910
|
query_params = opts[:query_params] || {}
|
911
|
+
query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
|
912
|
+
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
886
913
|
query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
|
887
914
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
888
915
|
|
@@ -922,8 +949,10 @@ module MailSlurpClient
|
|
922
949
|
# List Organization Inboxes Paginated
|
923
950
|
# List organization inboxes in paginated form. These are inboxes created with `allowTeamAccess` flag enabled. Organization inboxes are `readOnly` for non-admin users. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time).
|
924
951
|
# @param [Hash] opts the optional parameters
|
952
|
+
# @option opts [DateTime] :before Optional filter by created before given date time
|
925
953
|
# @option opts [Integer] :page Optional page index in list pagination (default to 0)
|
926
954
|
# @option opts [String] :search_filter Optional search filter
|
955
|
+
# @option opts [DateTime] :since Optional filter by created after given date time
|
927
956
|
# @option opts [Integer] :size Optional page size in list pagination (default to 20)
|
928
957
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
|
929
958
|
# @return [PageOrganizationInboxProjection]
|
@@ -935,8 +964,10 @@ module MailSlurpClient
|
|
935
964
|
# List Organization Inboxes Paginated
|
936
965
|
# List organization inboxes in paginated form. These are inboxes created with `allowTeamAccess` flag enabled. Organization inboxes are `readOnly` for non-admin users. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time).
|
937
966
|
# @param [Hash] opts the optional parameters
|
967
|
+
# @option opts [DateTime] :before Optional filter by created before given date time
|
938
968
|
# @option opts [Integer] :page Optional page index in list pagination
|
939
969
|
# @option opts [String] :search_filter Optional search filter
|
970
|
+
# @option opts [DateTime] :since Optional filter by created after given date time
|
940
971
|
# @option opts [Integer] :size Optional page size in list pagination
|
941
972
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
942
973
|
# @return [Array<(PageOrganizationInboxProjection, Integer, Hash)>] PageOrganizationInboxProjection data, response status code and response headers
|
@@ -953,8 +984,10 @@ module MailSlurpClient
|
|
953
984
|
|
954
985
|
# query parameters
|
955
986
|
query_params = opts[:query_params] || {}
|
987
|
+
query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
|
956
988
|
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
957
989
|
query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
|
990
|
+
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
958
991
|
query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
|
959
992
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
960
993
|
|
@@ -995,8 +1028,10 @@ module MailSlurpClient
|
|
995
1028
|
# List all rulesets attached to an inbox
|
996
1029
|
# @param inbox_id [String] inboxId
|
997
1030
|
# @param [Hash] opts the optional parameters
|
1031
|
+
# @option opts [DateTime] :before Optional filter by created before given date time
|
998
1032
|
# @option opts [Integer] :page Optional page index in inbox ruleset list pagination (default to 0)
|
999
1033
|
# @option opts [String] :search_filter Optional search filter
|
1034
|
+
# @option opts [DateTime] :since Optional filter by created after given date time
|
1000
1035
|
# @option opts [Integer] :size Optional page size in inbox ruleset list pagination (default to 20)
|
1001
1036
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
|
1002
1037
|
# @return [PageInboxRulesetDto]
|
@@ -1009,8 +1044,10 @@ module MailSlurpClient
|
|
1009
1044
|
# List all rulesets attached to an inbox
|
1010
1045
|
# @param inbox_id [String] inboxId
|
1011
1046
|
# @param [Hash] opts the optional parameters
|
1047
|
+
# @option opts [DateTime] :before Optional filter by created before given date time
|
1012
1048
|
# @option opts [Integer] :page Optional page index in inbox ruleset list pagination
|
1013
1049
|
# @option opts [String] :search_filter Optional search filter
|
1050
|
+
# @option opts [DateTime] :since Optional filter by created after given date time
|
1014
1051
|
# @option opts [Integer] :size Optional page size in inbox ruleset list pagination
|
1015
1052
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
1016
1053
|
# @return [Array<(PageInboxRulesetDto, Integer, Hash)>] PageInboxRulesetDto data, response status code and response headers
|
@@ -1031,8 +1068,10 @@ module MailSlurpClient
|
|
1031
1068
|
|
1032
1069
|
# query parameters
|
1033
1070
|
query_params = opts[:query_params] || {}
|
1071
|
+
query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
|
1034
1072
|
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
1035
1073
|
query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
|
1074
|
+
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
1036
1075
|
query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
|
1037
1076
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
1038
1077
|
|
@@ -1073,8 +1112,10 @@ module MailSlurpClient
|
|
1073
1112
|
# List all tracking pixels sent from an inbox
|
1074
1113
|
# @param inbox_id [String] inboxId
|
1075
1114
|
# @param [Hash] opts the optional parameters
|
1115
|
+
# @option opts [DateTime] :before Optional filter by created before given date time
|
1076
1116
|
# @option opts [Integer] :page Optional page index in inbox tracking pixel list pagination (default to 0)
|
1077
1117
|
# @option opts [String] :search_filter Optional search filter
|
1118
|
+
# @option opts [DateTime] :since Optional filter by created after given date time
|
1078
1119
|
# @option opts [Integer] :size Optional page size in inbox tracking pixel list pagination (default to 20)
|
1079
1120
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
|
1080
1121
|
# @return [PageTrackingPixelProjection]
|
@@ -1087,8 +1128,10 @@ module MailSlurpClient
|
|
1087
1128
|
# List all tracking pixels sent from an inbox
|
1088
1129
|
# @param inbox_id [String] inboxId
|
1089
1130
|
# @param [Hash] opts the optional parameters
|
1131
|
+
# @option opts [DateTime] :before Optional filter by created before given date time
|
1090
1132
|
# @option opts [Integer] :page Optional page index in inbox tracking pixel list pagination
|
1091
1133
|
# @option opts [String] :search_filter Optional search filter
|
1134
|
+
# @option opts [DateTime] :since Optional filter by created after given date time
|
1092
1135
|
# @option opts [Integer] :size Optional page size in inbox tracking pixel list pagination
|
1093
1136
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
1094
1137
|
# @return [Array<(PageTrackingPixelProjection, Integer, Hash)>] PageTrackingPixelProjection data, response status code and response headers
|
@@ -1109,8 +1152,10 @@ module MailSlurpClient
|
|
1109
1152
|
|
1110
1153
|
# query parameters
|
1111
1154
|
query_params = opts[:query_params] || {}
|
1155
|
+
query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
|
1112
1156
|
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
1113
1157
|
query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
|
1158
|
+
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
1114
1159
|
query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
|
1115
1160
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
1116
1161
|
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#MailSlurp API
|
3
3
|
|
4
|
-
#MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
|
4
|
+
#MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
|
5
5
|
|
6
6
|
The version of the OpenAPI document: 6.5.2
|
7
7
|
|
@@ -268,9 +268,11 @@ module MailSlurpClient
|
|
268
268
|
# List inbox forwarders
|
269
269
|
# List all forwarders attached to an inbox
|
270
270
|
# @param [Hash] opts the optional parameters
|
271
|
+
# @option opts [DateTime] :before Filter by created at before the given timestamp
|
271
272
|
# @option opts [String] :inbox_id Optional inbox id to get forwarders from
|
272
273
|
# @option opts [Integer] :page Optional page index in inbox forwarder list pagination (default to 0)
|
273
274
|
# @option opts [String] :search_filter Optional search filter
|
275
|
+
# @option opts [DateTime] :since Filter by created at after the given timestamp
|
274
276
|
# @option opts [Integer] :size Optional page size in inbox forwarder list pagination (default to 20)
|
275
277
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
|
276
278
|
# @return [PageInboxForwarderDto]
|
@@ -282,9 +284,11 @@ module MailSlurpClient
|
|
282
284
|
# List inbox forwarders
|
283
285
|
# List all forwarders attached to an inbox
|
284
286
|
# @param [Hash] opts the optional parameters
|
287
|
+
# @option opts [DateTime] :before Filter by created at before the given timestamp
|
285
288
|
# @option opts [String] :inbox_id Optional inbox id to get forwarders from
|
286
289
|
# @option opts [Integer] :page Optional page index in inbox forwarder list pagination
|
287
290
|
# @option opts [String] :search_filter Optional search filter
|
291
|
+
# @option opts [DateTime] :since Filter by created at after the given timestamp
|
288
292
|
# @option opts [Integer] :size Optional page size in inbox forwarder list pagination
|
289
293
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
290
294
|
# @return [Array<(PageInboxForwarderDto, Integer, Hash)>] PageInboxForwarderDto data, response status code and response headers
|
@@ -301,9 +305,11 @@ module MailSlurpClient
|
|
301
305
|
|
302
306
|
# query parameters
|
303
307
|
query_params = opts[:query_params] || {}
|
308
|
+
query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
|
304
309
|
query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
|
305
310
|
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
306
311
|
query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
|
312
|
+
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
307
313
|
query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
|
308
314
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
309
315
|
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#MailSlurp API
|
3
3
|
|
4
|
-
#MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
|
4
|
+
#MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
|
5
5
|
|
6
6
|
The version of the OpenAPI document: 6.5.2
|
7
7
|
|
@@ -268,9 +268,11 @@ module MailSlurpClient
|
|
268
268
|
# List inbox rulesets
|
269
269
|
# List all rulesets attached to an inbox
|
270
270
|
# @param [Hash] opts the optional parameters
|
271
|
+
# @option opts [DateTime] :before Filter by created at before the given timestamp
|
271
272
|
# @option opts [String] :inbox_id Optional inbox id to get rulesets from
|
272
273
|
# @option opts [Integer] :page Optional page index in inbox ruleset list pagination (default to 0)
|
273
274
|
# @option opts [String] :search_filter Optional search filter
|
275
|
+
# @option opts [DateTime] :since Filter by created at after the given timestamp
|
274
276
|
# @option opts [Integer] :size Optional page size in inbox ruleset list pagination (default to 20)
|
275
277
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
|
276
278
|
# @return [PageInboxRulesetDto]
|
@@ -282,9 +284,11 @@ module MailSlurpClient
|
|
282
284
|
# List inbox rulesets
|
283
285
|
# List all rulesets attached to an inbox
|
284
286
|
# @param [Hash] opts the optional parameters
|
287
|
+
# @option opts [DateTime] :before Filter by created at before the given timestamp
|
285
288
|
# @option opts [String] :inbox_id Optional inbox id to get rulesets from
|
286
289
|
# @option opts [Integer] :page Optional page index in inbox ruleset list pagination
|
287
290
|
# @option opts [String] :search_filter Optional search filter
|
291
|
+
# @option opts [DateTime] :since Filter by created at after the given timestamp
|
288
292
|
# @option opts [Integer] :size Optional page size in inbox ruleset list pagination
|
289
293
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
290
294
|
# @return [Array<(PageInboxRulesetDto, Integer, Hash)>] PageInboxRulesetDto data, response status code and response headers
|
@@ -301,9 +305,11 @@ module MailSlurpClient
|
|
301
305
|
|
302
306
|
# query parameters
|
303
307
|
query_params = opts[:query_params] || {}
|
308
|
+
query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
|
304
309
|
query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
|
305
310
|
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
306
311
|
query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
|
312
|
+
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
307
313
|
query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
|
308
314
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
309
315
|
|