mailslurp_client 7.0.7 → 7.0.8

Sign up to get free protection for your applications and to get access to all the features.
Files changed (105) hide show
  1. checksums.yaml +4 -4
  2. data/Makefile +3 -0
  3. data/README.md +26 -13
  4. data/docs/AliasControllerApi.md +337 -0
  5. data/docs/AttachmentControllerApi.md +3 -1
  6. data/docs/AttachmentMetaData.md +4 -4
  7. data/docs/BulkSendEmailOptions.md +1 -1
  8. data/docs/CommonActionsControllerApi.md +60 -9
  9. data/docs/CreateAnonymousAliasOptions.md +17 -0
  10. data/docs/CreateOwnedAliasOptions.md +23 -0
  11. data/docs/EmailAnalysis.md +5 -5
  12. data/docs/FormControllerApi.md +79 -0
  13. data/docs/ForwardEmailOptions.md +7 -7
  14. data/docs/InboxControllerApi.md +54 -1
  15. data/docs/ModelAlias.md +31 -0
  16. data/docs/PageAlias.md +37 -0
  17. data/docs/SimpleSendEmailOptions.md +23 -0
  18. data/docs/ValidationDto.md +2 -2
  19. data/docs/WaitForConditions.md +6 -6
  20. data/docs/WaitForControllerApi.md +3 -3
  21. data/lib/mailslurp_client.rb +8 -1
  22. data/lib/mailslurp_client/api/alias_controller_api.rb +405 -0
  23. data/lib/mailslurp_client/api/attachment_controller_api.rb +4 -1
  24. data/lib/mailslurp_client/api/bulk_actions_controller_api.rb +1 -1
  25. data/lib/mailslurp_client/api/common_actions_controller_api.rb +71 -15
  26. data/lib/mailslurp_client/api/contact_controller_api.rb +1 -1
  27. data/lib/mailslurp_client/api/domain_controller_api.rb +1 -1
  28. data/lib/mailslurp_client/api/email_controller_api.rb +1 -1
  29. data/lib/mailslurp_client/api/form_controller_api.rb +104 -0
  30. data/lib/mailslurp_client/api/group_controller_api.rb +1 -1
  31. data/lib/mailslurp_client/api/inbox_controller_api.rb +60 -1
  32. data/lib/mailslurp_client/api/template_controller_api.rb +1 -1
  33. data/lib/mailslurp_client/api/wait_for_controller_api.rb +5 -5
  34. data/lib/mailslurp_client/api/webhook_controller_api.rb +1 -1
  35. data/lib/mailslurp_client/api_client.rb +1 -1
  36. data/lib/mailslurp_client/api_error.rb +1 -1
  37. data/lib/mailslurp_client/configuration.rb +1 -1
  38. data/lib/mailslurp_client/models/attachment_meta_data.rb +6 -21
  39. data/lib/mailslurp_client/models/basic_auth_options.rb +1 -1
  40. data/lib/mailslurp_client/models/bulk_send_email_options.rb +2 -7
  41. data/lib/mailslurp_client/models/contact_dto.rb +1 -1
  42. data/lib/mailslurp_client/models/contact_projection.rb +1 -1
  43. data/lib/mailslurp_client/models/create_anonymous_alias_options.rb +208 -0
  44. data/lib/mailslurp_client/models/create_contact_options.rb +1 -1
  45. data/lib/mailslurp_client/models/create_domain_options.rb +1 -1
  46. data/lib/mailslurp_client/models/create_group_options.rb +1 -1
  47. data/lib/mailslurp_client/models/create_owned_alias_options.rb +238 -0
  48. data/lib/mailslurp_client/models/create_template_options.rb +1 -1
  49. data/lib/mailslurp_client/models/create_webhook_options.rb +1 -1
  50. data/lib/mailslurp_client/models/domain_dto.rb +1 -1
  51. data/lib/mailslurp_client/models/domain_preview.rb +1 -1
  52. data/lib/mailslurp_client/models/email.rb +2 -2
  53. data/lib/mailslurp_client/models/email_analysis.rb +7 -2
  54. data/lib/mailslurp_client/models/email_preview.rb +2 -2
  55. data/lib/mailslurp_client/models/email_projection.rb +2 -1
  56. data/lib/mailslurp_client/models/forward_email_options.rb +29 -30
  57. data/lib/mailslurp_client/models/group_contacts_dto.rb +1 -1
  58. data/lib/mailslurp_client/models/group_dto.rb +1 -1
  59. data/lib/mailslurp_client/models/group_projection.rb +1 -1
  60. data/lib/mailslurp_client/models/html_validation_result.rb +1 -1
  61. data/lib/mailslurp_client/models/inbox.rb +1 -1
  62. data/lib/mailslurp_client/models/inbox_projection.rb +1 -1
  63. data/lib/mailslurp_client/models/json_node.rb +1 -1
  64. data/lib/mailslurp_client/models/match_option.rb +1 -1
  65. data/lib/mailslurp_client/models/match_options.rb +2 -2
  66. data/lib/mailslurp_client/models/model_alias.rb +284 -0
  67. data/lib/mailslurp_client/models/page_alias.rb +298 -0
  68. data/lib/mailslurp_client/models/page_contact_projection.rb +1 -1
  69. data/lib/mailslurp_client/models/page_email_preview.rb +1 -1
  70. data/lib/mailslurp_client/models/page_email_projection.rb +1 -1
  71. data/lib/mailslurp_client/models/page_group_projection.rb +1 -1
  72. data/lib/mailslurp_client/models/page_inbox_projection.rb +1 -1
  73. data/lib/mailslurp_client/models/page_template_projection.rb +1 -1
  74. data/lib/mailslurp_client/models/page_webhook_projection.rb +1 -1
  75. data/lib/mailslurp_client/models/pageable.rb +1 -1
  76. data/lib/mailslurp_client/models/raw_email_json.rb +1 -1
  77. data/lib/mailslurp_client/models/send_email_options.rb +1 -1
  78. data/lib/mailslurp_client/models/set_inbox_favourited_options.rb +1 -1
  79. data/lib/mailslurp_client/models/simple_send_email_options.rb +237 -0
  80. data/lib/mailslurp_client/models/sort.rb +1 -1
  81. data/lib/mailslurp_client/models/template_dto.rb +1 -1
  82. data/lib/mailslurp_client/models/template_projection.rb +1 -1
  83. data/lib/mailslurp_client/models/template_variable.rb +1 -1
  84. data/lib/mailslurp_client/models/unread_count.rb +1 -1
  85. data/lib/mailslurp_client/models/update_group_contacts.rb +1 -1
  86. data/lib/mailslurp_client/models/update_inbox_options.rb +1 -1
  87. data/lib/mailslurp_client/models/upload_attachment_options.rb +2 -2
  88. data/lib/mailslurp_client/models/validation_dto.rb +3 -11
  89. data/lib/mailslurp_client/models/validation_message.rb +1 -1
  90. data/lib/mailslurp_client/models/wait_for_conditions.rb +8 -7
  91. data/lib/mailslurp_client/models/webhook_dto.rb +1 -1
  92. data/lib/mailslurp_client/models/webhook_projection.rb +1 -1
  93. data/lib/mailslurp_client/models/webhook_test_request.rb +1 -1
  94. data/lib/mailslurp_client/models/webhook_test_response.rb +1 -1
  95. data/lib/mailslurp_client/models/webhook_test_result.rb +1 -1
  96. data/lib/mailslurp_client/version.rb +2 -2
  97. data/mailslurp_client.gemspec +2 -2
  98. data/spec/api/alias_controller_api_spec.rb +107 -0
  99. data/spec/api/form_controller_api_spec.rb +54 -0
  100. data/spec/models/create_anonymous_alias_options_spec.rb +41 -0
  101. data/spec/models/create_owned_alias_options_spec.rb +59 -0
  102. data/spec/models/model_alias_spec.rb +83 -0
  103. data/spec/models/page_alias_spec.rb +101 -0
  104. data/spec/models/simple_send_email_options_spec.rb +59 -0
  105. metadata +33 -3
@@ -3,7 +3,7 @@
3
3
 
4
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
- The version of the OpenAPI document: 67c9a1eda264be4cfe0bb2c76151f0aadf0862bc
6
+ The version of the OpenAPI document: d1659dc1567a5b62f65d0612107a50aace03e085
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 4.2.3
@@ -89,6 +89,7 @@ module MailSlurpClient
89
89
  # @param [Hash] opts the optional parameters
90
90
  # @option opts [String] :content_type contentType
91
91
  # @option opts [String] :filename filename
92
+ # @option opts [String] :x_filename x-filename
92
93
  # @return [Array<String>]
93
94
  def upload_multipart_form(file, opts = {})
94
95
  data, _status_code, _headers = upload_multipart_form_with_http_info(file, opts)
@@ -101,6 +102,7 @@ module MailSlurpClient
101
102
  # @param [Hash] opts the optional parameters
102
103
  # @option opts [String] :content_type contentType
103
104
  # @option opts [String] :filename filename
105
+ # @option opts [String] :x_filename x-filename
104
106
  # @return [Array<(Array<String>, Integer, Hash)>] Array<String> data, response status code and response headers
105
107
  def upload_multipart_form_with_http_info(file, opts = {})
106
108
  if @api_client.config.debugging
@@ -117,6 +119,7 @@ module MailSlurpClient
117
119
  query_params = opts[:query_params] || {}
118
120
  query_params[:'contentType'] = opts[:'content_type'] if !opts[:'content_type'].nil?
119
121
  query_params[:'filename'] = opts[:'filename'] if !opts[:'filename'].nil?
122
+ query_params[:'x-filename'] = opts[:'x_filename'] if !opts[:'x_filename'].nil?
120
123
 
121
124
  # header parameters
122
125
  header_params = opts[:header_params] || {}
@@ -3,7 +3,7 @@
3
3
 
4
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
- The version of the OpenAPI document: 67c9a1eda264be4cfe0bb2c76151f0aadf0862bc
6
+ The version of the OpenAPI document: d1659dc1567a5b62f65d0612107a50aace03e085
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 4.2.3
@@ -3,7 +3,7 @@
3
3
 
4
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
- The version of the OpenAPI document: 67c9a1eda264be4cfe0bb2c76151f0aadf0862bc
6
+ The version of the OpenAPI document: d1659dc1567a5b62f65d0612107a50aace03e085
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 4.2.3
@@ -37,7 +37,7 @@ module MailSlurpClient
37
37
  @api_client.config.logger.debug 'Calling API: CommonActionsControllerApi.create_new_email_address ...'
38
38
  end
39
39
  # resource path
40
- local_var_path = '/newEmailAddress'
40
+ local_var_path = '/createInbox'
41
41
 
42
42
  # query parameters
43
43
  query_params = opts[:query_params] || {}
@@ -75,6 +75,62 @@ module MailSlurpClient
75
75
  return data, status_code, headers
76
76
  end
77
77
 
78
+ # Create new random inbox
79
+ # Returns an Inbox with an `id` and an `emailAddress`
80
+ # @param [Hash] opts the optional parameters
81
+ # @return [Inbox]
82
+ def create_new_email_address1(opts = {})
83
+ data, _status_code, _headers = create_new_email_address1_with_http_info(opts)
84
+ data
85
+ end
86
+
87
+ # Create new random inbox
88
+ # Returns an Inbox with an &#x60;id&#x60; and an &#x60;emailAddress&#x60;
89
+ # @param [Hash] opts the optional parameters
90
+ # @return [Array<(Inbox, Integer, Hash)>] Inbox data, response status code and response headers
91
+ def create_new_email_address1_with_http_info(opts = {})
92
+ if @api_client.config.debugging
93
+ @api_client.config.logger.debug 'Calling API: CommonActionsControllerApi.create_new_email_address1 ...'
94
+ end
95
+ # resource path
96
+ local_var_path = '/newEmailAddress'
97
+
98
+ # query parameters
99
+ query_params = opts[:query_params] || {}
100
+
101
+ # header parameters
102
+ header_params = opts[:header_params] || {}
103
+ # HTTP header 'Accept' (if needed)
104
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
105
+
106
+ # form parameters
107
+ form_params = opts[:form_params] || {}
108
+
109
+ # http body (model)
110
+ post_body = opts[:body]
111
+
112
+ # return_type
113
+ return_type = opts[:return_type] || 'Inbox'
114
+
115
+ # auth_names
116
+ auth_names = opts[:auth_names] || ['API_KEY']
117
+
118
+ new_options = opts.merge(
119
+ :header_params => header_params,
120
+ :query_params => query_params,
121
+ :form_params => form_params,
122
+ :body => post_body,
123
+ :auth_names => auth_names,
124
+ :return_type => return_type
125
+ )
126
+
127
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
128
+ if @api_client.config.debugging
129
+ @api_client.config.logger.debug "API called: CommonActionsControllerApi#create_new_email_address1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
130
+ end
131
+ return data, status_code, headers
132
+ end
133
+
78
134
  # Delete all emails in an inbox
79
135
  # Deletes all emails
80
136
  # @param inbox_id [String] inboxId
@@ -136,28 +192,28 @@ module MailSlurpClient
136
192
  return data, status_code, headers
137
193
  end
138
194
 
139
- # Send an email from a random email address
140
- # To specify an email address first create an inbox and use that with the other send email methods
141
- # @param send_email_options [SendEmailOptions] sendEmailOptions
195
+ # Send an email
196
+ # If no senderId or inboxId provided a random email address will be used to send from.
197
+ # @param email_options [SimpleSendEmailOptions] emailOptions
142
198
  # @param [Hash] opts the optional parameters
143
199
  # @return [nil]
144
- def send_email_simple(send_email_options, opts = {})
145
- send_email_simple_with_http_info(send_email_options, opts)
200
+ def send_email_simple(email_options, opts = {})
201
+ send_email_simple_with_http_info(email_options, opts)
146
202
  nil
147
203
  end
148
204
 
149
- # Send an email from a random email address
150
- # To specify an email address first create an inbox and use that with the other send email methods
151
- # @param send_email_options [SendEmailOptions] sendEmailOptions
205
+ # Send an email
206
+ # If no senderId or inboxId provided a random email address will be used to send from.
207
+ # @param email_options [SimpleSendEmailOptions] emailOptions
152
208
  # @param [Hash] opts the optional parameters
153
209
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
154
- def send_email_simple_with_http_info(send_email_options, opts = {})
210
+ def send_email_simple_with_http_info(email_options, opts = {})
155
211
  if @api_client.config.debugging
156
212
  @api_client.config.logger.debug 'Calling API: CommonActionsControllerApi.send_email_simple ...'
157
213
  end
158
- # verify the required parameter 'send_email_options' is set
159
- if @api_client.config.client_side_validation && send_email_options.nil?
160
- fail ArgumentError, "Missing the required parameter 'send_email_options' when calling CommonActionsControllerApi.send_email_simple"
214
+ # verify the required parameter 'email_options' is set
215
+ if @api_client.config.client_side_validation && email_options.nil?
216
+ fail ArgumentError, "Missing the required parameter 'email_options' when calling CommonActionsControllerApi.send_email_simple"
161
217
  end
162
218
  # resource path
163
219
  local_var_path = '/sendEmail'
@@ -174,7 +230,7 @@ module MailSlurpClient
174
230
  form_params = opts[:form_params] || {}
175
231
 
176
232
  # http body (model)
177
- post_body = opts[:body] || @api_client.object_to_http_body(send_email_options)
233
+ post_body = opts[:body] || @api_client.object_to_http_body(email_options)
178
234
 
179
235
  # return_type
180
236
  return_type = opts[:return_type]
@@ -3,7 +3,7 @@
3
3
 
4
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
- The version of the OpenAPI document: 67c9a1eda264be4cfe0bb2c76151f0aadf0862bc
6
+ The version of the OpenAPI document: d1659dc1567a5b62f65d0612107a50aace03e085
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 4.2.3
@@ -3,7 +3,7 @@
3
3
 
4
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
- The version of the OpenAPI document: 67c9a1eda264be4cfe0bb2c76151f0aadf0862bc
6
+ The version of the OpenAPI document: d1659dc1567a5b62f65d0612107a50aace03e085
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 4.2.3
@@ -3,7 +3,7 @@
3
3
 
4
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
- The version of the OpenAPI document: 67c9a1eda264be4cfe0bb2c76151f0aadf0862bc
6
+ The version of the OpenAPI document: d1659dc1567a5b62f65d0612107a50aace03e085
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 4.2.3
@@ -0,0 +1,104 @@
1
+ =begin
2
+ #MailSlurp API
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
5
+
6
+ The version of the OpenAPI document: d1659dc1567a5b62f65d0612107a50aace03e085
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 4.2.3
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module MailSlurpClient
16
+ class FormControllerApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Submit a form to be parsed and sent as an email to an address determined by the form fields
23
+ # This endpoint allows you to submit HTML forms and receive the field values and files via email. #### Parameters The endpoint looks for special meta parameters in the form fields OR in the URL request parameters. The meta parameters can be used to specify the behaviour of the email. You must provide at-least a `_to` email address or a `_toAlias` email alias ID to tell the endpoint where the form should be emailed. These can be submitted as hidden HTML input fields with the corresponding `name` attributes or as URL query parameters such as `?_to=test@example.com` The endpoint takes all other form fields that are named and includes them in the message body of the email. Files are sent as attachments. #### Submitting This endpoint accepts form submission via POST method. It accepts `application/x-www-form-urlencoded`, and `multipart/form-data` content-types. #### HTML Example ```html <form action=\"https://api.mailslurp.com/forms\" method=\"post\" > <input name=\"_to\" type=\"hidden\" value=\"test@example.com\"/> <textarea name=\"feedback\"></textarea> <button type=\"submit\">Submit</button> </form> ``` #### URL Example ```html <form action=\"https://api.mailslurp.com/forms?_toAlias=test@example.com\" method=\"post\" > <textarea name=\"feedback\"></textarea> <button type=\"submit\">Submit</button> </form> ``` The email address is specified by a `_to` field OR is extracted from an email alias specified by a `_toAlias` field (see the alias controller for more information). Endpoint accepts . You can specify a content type in HTML forms using the `enctype` attribute, for instance: `<form enctype=\"multipart/form-data\">`.
24
+ # @param [Hash] opts the optional parameters
25
+ # @option opts [String] :_email_address Email address of the submitting user. Include this if you wish to record the submitters email address and reply to it later.
26
+ # @option opts [String] :_redirect_to Optional URL to redirect form submitter to after submission. If not present user will see a success message.
27
+ # @option opts [String] :_spam_check Optional but recommended field that catches spammers out. Include as a hidden form field but LEAVE EMPTY. Spam-bots will usually fill every field. If the _spamCheck field is filled the form submission will be ignored.
28
+ # @option opts [String] :_subject Optional subject of the email that will be sent.
29
+ # @option opts [String] :_success_message Optional success message to display if no _redirectTo present.
30
+ # @option opts [String] :_to The email address that submitted form should be sent to. Either this or _toAlias must be present for a form to be successfully submitted..
31
+ # @option opts [String] :_to_alias ID of an email alias to that form should be sent to. Aliases must be created before submission and can be used to hide an email address and reduce spam.
32
+ # @option opts [String] :other_parameters All other parameters or fields will be accepted and attached to the sent email. This includes files and any HTML form field with a name. These fields will become the body of the email that is sent.
33
+ # @return [String]
34
+ def submit_form(opts = {})
35
+ data, _status_code, _headers = submit_form_with_http_info(opts)
36
+ data
37
+ end
38
+
39
+ # Submit a form to be parsed and sent as an email to an address determined by the form fields
40
+ # This endpoint allows you to submit HTML forms and receive the field values and files via email. #### Parameters The endpoint looks for special meta parameters in the form fields OR in the URL request parameters. The meta parameters can be used to specify the behaviour of the email. You must provide at-least a &#x60;_to&#x60; email address or a &#x60;_toAlias&#x60; email alias ID to tell the endpoint where the form should be emailed. These can be submitted as hidden HTML input fields with the corresponding &#x60;name&#x60; attributes or as URL query parameters such as &#x60;?_to&#x3D;test@example.com&#x60; The endpoint takes all other form fields that are named and includes them in the message body of the email. Files are sent as attachments. #### Submitting This endpoint accepts form submission via POST method. It accepts &#x60;application/x-www-form-urlencoded&#x60;, and &#x60;multipart/form-data&#x60; content-types. #### HTML Example &#x60;&#x60;&#x60;html &lt;form action&#x3D;\&quot;https://api.mailslurp.com/forms\&quot; method&#x3D;\&quot;post\&quot; &gt; &lt;input name&#x3D;\&quot;_to\&quot; type&#x3D;\&quot;hidden\&quot; value&#x3D;\&quot;test@example.com\&quot;/&gt; &lt;textarea name&#x3D;\&quot;feedback\&quot;&gt;&lt;/textarea&gt; &lt;button type&#x3D;\&quot;submit\&quot;&gt;Submit&lt;/button&gt; &lt;/form&gt; &#x60;&#x60;&#x60; #### URL Example &#x60;&#x60;&#x60;html &lt;form action&#x3D;\&quot;https://api.mailslurp.com/forms?_toAlias&#x3D;test@example.com\&quot; method&#x3D;\&quot;post\&quot; &gt; &lt;textarea name&#x3D;\&quot;feedback\&quot;&gt;&lt;/textarea&gt; &lt;button type&#x3D;\&quot;submit\&quot;&gt;Submit&lt;/button&gt; &lt;/form&gt; &#x60;&#x60;&#x60; The email address is specified by a &#x60;_to&#x60; field OR is extracted from an email alias specified by a &#x60;_toAlias&#x60; field (see the alias controller for more information). Endpoint accepts . You can specify a content type in HTML forms using the &#x60;enctype&#x60; attribute, for instance: &#x60;&lt;form enctype&#x3D;\&quot;multipart/form-data\&quot;&gt;&#x60;.
41
+ # @param [Hash] opts the optional parameters
42
+ # @option opts [String] :_email_address Email address of the submitting user. Include this if you wish to record the submitters email address and reply to it later.
43
+ # @option opts [String] :_redirect_to Optional URL to redirect form submitter to after submission. If not present user will see a success message.
44
+ # @option opts [String] :_spam_check Optional but recommended field that catches spammers out. Include as a hidden form field but LEAVE EMPTY. Spam-bots will usually fill every field. If the _spamCheck field is filled the form submission will be ignored.
45
+ # @option opts [String] :_subject Optional subject of the email that will be sent.
46
+ # @option opts [String] :_success_message Optional success message to display if no _redirectTo present.
47
+ # @option opts [String] :_to The email address that submitted form should be sent to. Either this or _toAlias must be present for a form to be successfully submitted..
48
+ # @option opts [String] :_to_alias ID of an email alias to that form should be sent to. Aliases must be created before submission and can be used to hide an email address and reduce spam.
49
+ # @option opts [String] :other_parameters All other parameters or fields will be accepted and attached to the sent email. This includes files and any HTML form field with a name. These fields will become the body of the email that is sent.
50
+ # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
51
+ def submit_form_with_http_info(opts = {})
52
+ if @api_client.config.debugging
53
+ @api_client.config.logger.debug 'Calling API: FormControllerApi.submit_form ...'
54
+ end
55
+ # resource path
56
+ local_var_path = '/forms'
57
+
58
+ # query parameters
59
+ query_params = opts[:query_params] || {}
60
+
61
+ # header parameters
62
+ header_params = opts[:header_params] || {}
63
+ # HTTP header 'Accept' (if needed)
64
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
65
+ # HTTP header 'Content-Type'
66
+ header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data', 'application/x-www-form-urlencoded'])
67
+
68
+ # form parameters
69
+ form_params = opts[:form_params] || {}
70
+ form_params['_emailAddress'] = opts[:'_email_address'] if !opts[:'_email_address'].nil?
71
+ form_params['_redirectTo'] = opts[:'_redirect_to'] if !opts[:'_redirect_to'].nil?
72
+ form_params['_spamCheck'] = opts[:'_spam_check'] if !opts[:'_spam_check'].nil?
73
+ form_params['_subject'] = opts[:'_subject'] if !opts[:'_subject'].nil?
74
+ form_params['_successMessage'] = opts[:'_success_message'] if !opts[:'_success_message'].nil?
75
+ form_params['_to'] = opts[:'_to'] if !opts[:'_to'].nil?
76
+ form_params['_toAlias'] = opts[:'_to_alias'] if !opts[:'_to_alias'].nil?
77
+ form_params['otherParameters'] = opts[:'other_parameters'] if !opts[:'other_parameters'].nil?
78
+
79
+ # http body (model)
80
+ post_body = opts[:body]
81
+
82
+ # return_type
83
+ return_type = opts[:return_type] || 'String'
84
+
85
+ # auth_names
86
+ auth_names = opts[:auth_names] || ['API_KEY']
87
+
88
+ new_options = opts.merge(
89
+ :header_params => header_params,
90
+ :query_params => query_params,
91
+ :form_params => form_params,
92
+ :body => post_body,
93
+ :auth_names => auth_names,
94
+ :return_type => return_type
95
+ )
96
+
97
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
98
+ if @api_client.config.debugging
99
+ @api_client.config.logger.debug "API called: FormControllerApi#submit_form\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
100
+ end
101
+ return data, status_code, headers
102
+ end
103
+ end
104
+ end
@@ -3,7 +3,7 @@
3
3
 
4
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
- The version of the OpenAPI document: 67c9a1eda264be4cfe0bb2c76151f0aadf0862bc
6
+ The version of the OpenAPI document: d1659dc1567a5b62f65d0612107a50aace03e085
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 4.2.3
@@ -3,7 +3,7 @@
3
3
 
4
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
- The version of the OpenAPI document: 67c9a1eda264be4cfe0bb2c76151f0aadf0862bc
6
+ The version of the OpenAPI document: d1659dc1567a5b62f65d0612107a50aace03e085
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 4.2.3
@@ -215,6 +215,7 @@ module MailSlurpClient
215
215
  # @option opts [String] :search Optionally filter by search words partial matching ID, tags, name, and email address
216
216
  # @option opts [Integer] :size Optional page size in inbox list pagination (default to 20)
217
217
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
218
+ # @option opts [String] :tag Optionally filter by tags
218
219
  # @return [PageInboxProjection]
219
220
  def get_all_inboxes(opts = {})
220
221
  data, _status_code, _headers = get_all_inboxes_with_http_info(opts)
@@ -229,6 +230,7 @@ module MailSlurpClient
229
230
  # @option opts [String] :search Optionally filter by search words partial matching ID, tags, name, and email address
230
231
  # @option opts [Integer] :size Optional page size in inbox list pagination
231
232
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
233
+ # @option opts [String] :tag Optionally filter by tags
232
234
  # @return [Array<(PageInboxProjection, Integer, Hash)>] PageInboxProjection data, response status code and response headers
233
235
  def get_all_inboxes_with_http_info(opts = {})
234
236
  if @api_client.config.debugging
@@ -248,6 +250,7 @@ module MailSlurpClient
248
250
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
249
251
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
250
252
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
253
+ query_params[:'tag'] = opts[:'tag'] if !opts[:'tag'].nil?
251
254
 
252
255
  # header parameters
253
256
  header_params = opts[:header_params] || {}
@@ -500,6 +503,62 @@ module MailSlurpClient
500
503
  return data, status_code, headers
501
504
  end
502
505
 
506
+ # Get inbox tags
507
+ # Get all inbox tags
508
+ # @param [Hash] opts the optional parameters
509
+ # @return [Array<String>]
510
+ def get_inbox_tags(opts = {})
511
+ data, _status_code, _headers = get_inbox_tags_with_http_info(opts)
512
+ data
513
+ end
514
+
515
+ # Get inbox tags
516
+ # Get all inbox tags
517
+ # @param [Hash] opts the optional parameters
518
+ # @return [Array<(Array<String>, Integer, Hash)>] Array<String> data, response status code and response headers
519
+ def get_inbox_tags_with_http_info(opts = {})
520
+ if @api_client.config.debugging
521
+ @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_inbox_tags ...'
522
+ end
523
+ # resource path
524
+ local_var_path = '/inboxes/tags'
525
+
526
+ # query parameters
527
+ query_params = opts[:query_params] || {}
528
+
529
+ # header parameters
530
+ header_params = opts[:header_params] || {}
531
+ # HTTP header 'Accept' (if needed)
532
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
533
+
534
+ # form parameters
535
+ form_params = opts[:form_params] || {}
536
+
537
+ # http body (model)
538
+ post_body = opts[:body]
539
+
540
+ # return_type
541
+ return_type = opts[:return_type] || 'Array<String>'
542
+
543
+ # auth_names
544
+ auth_names = opts[:auth_names] || ['API_KEY']
545
+
546
+ new_options = opts.merge(
547
+ :header_params => header_params,
548
+ :query_params => query_params,
549
+ :form_params => form_params,
550
+ :body => post_body,
551
+ :auth_names => auth_names,
552
+ :return_type => return_type
553
+ )
554
+
555
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
556
+ if @api_client.config.debugging
557
+ @api_client.config.logger.debug "API called: InboxControllerApi#get_inbox_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
558
+ end
559
+ return data, status_code, headers
560
+ end
561
+
503
562
  # List Inboxes / Email Addresses
504
563
  # List the inboxes you have created
505
564
  # @param [Hash] opts the optional parameters
@@ -3,7 +3,7 @@
3
3
 
4
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
- The version of the OpenAPI document: 67c9a1eda264be4cfe0bb2c76151f0aadf0862bc
6
+ The version of the OpenAPI document: d1659dc1567a5b62f65d0612107a50aace03e085
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 4.2.3
@@ -3,7 +3,7 @@
3
3
 
4
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
- The version of the OpenAPI document: 67c9a1eda264be4cfe0bb2c76151f0aadf0862bc
6
+ The version of the OpenAPI document: d1659dc1567a5b62f65d0612107a50aace03e085
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 4.2.3
@@ -148,11 +148,11 @@ module MailSlurpClient
148
148
  end
149
149
 
150
150
  # Fetch inbox's latest email or if empty wait for an email to arrive
151
- # Will return either the last received email or wait for an email to arrive and return that. If you need to wait for an email for a non-empty inbox see the other receive methods such as waitForNthEmail or waitForEmailCount.
151
+ # Will return either the last received email or wait for an email to arrive and return that. If you need to wait for an email for a non-empty inbox set `unreadOnly=true` or see the other receive methods such as `waitForNthEmail` or `waitForEmailCount`.
152
152
  # @param [Hash] opts the optional parameters
153
153
  # @option opts [String] :inbox_id Id of the inbox we are fetching emails from
154
154
  # @option opts [Integer] :timeout Max milliseconds to wait
155
- # @option opts [Boolean] :unread_only Optional filter for unread only (default to false)
155
+ # @option opts [Boolean] :unread_only Optional filter for unread only. (default to false)
156
156
  # @return [Email]
157
157
  def wait_for_latest_email(opts = {})
158
158
  data, _status_code, _headers = wait_for_latest_email_with_http_info(opts)
@@ -160,11 +160,11 @@ module MailSlurpClient
160
160
  end
161
161
 
162
162
  # Fetch inbox&#39;s latest email or if empty wait for an email to arrive
163
- # Will return either the last received email or wait for an email to arrive and return that. If you need to wait for an email for a non-empty inbox see the other receive methods such as waitForNthEmail or waitForEmailCount.
163
+ # Will return either the last received email or wait for an email to arrive and return that. If you need to wait for an email for a non-empty inbox set &#x60;unreadOnly&#x3D;true&#x60; or see the other receive methods such as &#x60;waitForNthEmail&#x60; or &#x60;waitForEmailCount&#x60;.
164
164
  # @param [Hash] opts the optional parameters
165
165
  # @option opts [String] :inbox_id Id of the inbox we are fetching emails from
166
166
  # @option opts [Integer] :timeout Max milliseconds to wait
167
- # @option opts [Boolean] :unread_only Optional filter for unread only
167
+ # @option opts [Boolean] :unread_only Optional filter for unread only.
168
168
  # @return [Array<(Email, Integer, Hash)>] Email data, response status code and response headers
169
169
  def wait_for_latest_email_with_http_info(opts = {})
170
170
  if @api_client.config.debugging