mailslurp_client 15.0.1 → 15.0.5
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/LICENSE +1 -1
- data/lib/mailslurp_client/api/alias_controller_api.rb +59 -55
- data/lib/mailslurp_client/api/attachment_controller_api.rb +49 -60
- data/lib/mailslurp_client/api/bounce_controller_api.rb +26 -18
- data/lib/mailslurp_client/api/bulk_actions_controller_api.rb +15 -15
- data/lib/mailslurp_client/api/common_actions_controller_api.rb +128 -67
- data/lib/mailslurp_client/api/contact_controller_api.rb +22 -22
- data/lib/mailslurp_client/api/domain_controller_api.rb +32 -32
- data/lib/mailslurp_client/api/email_controller_api.rb +190 -116
- data/lib/mailslurp_client/api/expired_controller_api.rb +19 -19
- data/lib/mailslurp_client/api/export_controller_api.rb +38 -38
- data/lib/mailslurp_client/api/form_controller_api.rb +16 -18
- data/lib/mailslurp_client/api/group_controller_api.rb +52 -52
- data/lib/mailslurp_client/api/inbox_controller_api.rb +359 -225
- data/lib/mailslurp_client/api/inbox_forwarder_controller_api.rb +33 -29
- data/lib/mailslurp_client/api/inbox_ruleset_controller_api.rb +33 -29
- data/lib/mailslurp_client/api/mail_server_controller_api.rb +26 -26
- data/lib/mailslurp_client/api/missed_email_controller_api.rb +54 -42
- data/lib/mailslurp_client/api/sent_emails_controller_api.rb +157 -47
- data/lib/mailslurp_client/api/template_controller_api.rb +21 -21
- data/lib/mailslurp_client/api/tracking_controller_api.rb +16 -16
- data/lib/mailslurp_client/api/wait_for_controller_api.rb +128 -88
- data/lib/mailslurp_client/api/webhook_controller_api.rb +102 -86
- data/lib/mailslurp_client/configuration.rb +4 -4
- data/lib/mailslurp_client/models/abstract_webhook_payload.rb +10 -25
- data/lib/mailslurp_client/models/alias_dto.rb +45 -56
- data/lib/mailslurp_client/models/alias_projection.rb +42 -72
- data/lib/mailslurp_client/models/attachment_entity.rb +34 -54
- data/lib/mailslurp_client/models/attachment_meta_data.rb +21 -21
- data/lib/mailslurp_client/models/attachment_projection.rb +36 -51
- data/lib/mailslurp_client/models/basic_auth_options.rb +0 -10
- data/lib/mailslurp_client/models/bounce_projection.rb +13 -23
- data/lib/mailslurp_client/models/bounce_recipient.rb +22 -42
- data/lib/mailslurp_client/models/bounced_email_dto.rb +56 -76
- data/lib/mailslurp_client/models/bounced_recipient_dto.rb +16 -31
- data/lib/mailslurp_client/models/bulk_send_email_options.rb +5 -0
- data/lib/mailslurp_client/models/condition_option.rb +2 -2
- data/lib/mailslurp_client/models/contact_dto.rb +53 -73
- data/lib/mailslurp_client/models/contact_projection.rb +42 -52
- data/lib/mailslurp_client/models/count_dto.rb +206 -0
- data/lib/mailslurp_client/models/create_contact_options.rb +42 -42
- data/lib/mailslurp_client/models/create_domain_options.rb +21 -16
- data/lib/mailslurp_client/models/create_group_options.rb +0 -5
- data/lib/mailslurp_client/models/create_inbox_dto.rb +58 -58
- data/lib/mailslurp_client/models/create_inbox_forwarder_options.rb +19 -14
- data/lib/mailslurp_client/models/create_inbox_ruleset_options.rb +23 -23
- data/lib/mailslurp_client/models/create_template_options.rb +0 -10
- data/lib/mailslurp_client/models/create_webhook_options.rb +18 -18
- data/lib/mailslurp_client/models/describe_mail_server_domain_result.rb +15 -25
- data/lib/mailslurp_client/models/dns_lookup_options.rb +24 -14
- data/lib/mailslurp_client/models/dns_lookup_result.rb +23 -42
- data/lib/mailslurp_client/models/dns_lookup_results.rb +0 -5
- data/lib/mailslurp_client/models/domain_dto.rb +59 -80
- data/lib/mailslurp_client/models/domain_name_record.rb +11 -30
- data/lib/mailslurp_client/models/domain_preview.rb +26 -50
- data/lib/mailslurp_client/models/email.rb +134 -135
- data/lib/mailslurp_client/models/email_analysis.rb +28 -28
- data/lib/mailslurp_client/models/email_content_match_result.rb +13 -23
- data/lib/mailslurp_client/models/email_links_result.rb +13 -23
- data/lib/mailslurp_client/models/email_preview.rb +47 -47
- data/lib/mailslurp_client/models/email_projection.rb +77 -97
- data/lib/mailslurp_client/models/email_recipients.rb +16 -15
- data/lib/mailslurp_client/models/email_text_lines_result.rb +13 -23
- data/lib/mailslurp_client/models/email_verification_result.rb +16 -36
- data/lib/mailslurp_client/models/expiration_defaults.rb +16 -26
- data/lib/mailslurp_client/models/expired_inbox_dto.rb +13 -28
- data/lib/mailslurp_client/models/expired_inbox_record_projection.rb +22 -42
- data/lib/mailslurp_client/models/export_link.rb +0 -5
- data/lib/mailslurp_client/models/export_options.rb +1 -6
- data/lib/mailslurp_client/models/flush_expired_inboxes_result.rb +13 -23
- data/lib/mailslurp_client/models/forward_email_options.rb +36 -31
- data/lib/mailslurp_client/models/gravatar_url.rb +13 -23
- data/lib/mailslurp_client/models/group_contacts_dto.rb +13 -23
- data/lib/mailslurp_client/models/group_dto.rb +22 -37
- data/lib/mailslurp_client/models/group_projection.rb +22 -37
- data/lib/mailslurp_client/models/html_validation_result.rb +13 -14
- data/lib/mailslurp_client/models/{inbox.rb → inbox_dto.rb} +47 -57
- data/lib/mailslurp_client/models/inbox_exists_dto.rb +0 -5
- data/lib/mailslurp_client/models/inbox_forwarder_dto.rb +31 -61
- data/lib/mailslurp_client/models/inbox_forwarder_test_options.rb +0 -5
- data/lib/mailslurp_client/models/inbox_forwarder_test_result.rb +13 -23
- data/lib/mailslurp_client/models/inbox_preview.rb +38 -38
- data/lib/mailslurp_client/models/inbox_ruleset_dto.rb +43 -78
- data/lib/mailslurp_client/models/inbox_ruleset_test_options.rb +0 -5
- data/lib/mailslurp_client/models/inbox_ruleset_test_result.rb +13 -18
- data/lib/mailslurp_client/models/inline_object.rb +221 -0
- data/lib/mailslurp_client/models/ip_address_result.rb +0 -10
- data/lib/mailslurp_client/models/json_schema_dto.rb +0 -5
- data/lib/mailslurp_client/models/match_option.rb +7 -2
- data/lib/mailslurp_client/models/match_options.rb +16 -16
- data/lib/mailslurp_client/models/missed_email.rb +67 -102
- data/lib/mailslurp_client/models/missed_email_projection.rb +19 -29
- data/lib/mailslurp_client/models/name_server_record.rb +10 -30
- data/lib/mailslurp_client/models/organization_inbox_projection.rb +44 -44
- data/lib/mailslurp_client/models/page_alias.rb +52 -52
- data/lib/mailslurp_client/models/page_attachment_entity.rb +52 -52
- data/lib/mailslurp_client/models/page_bounced_email.rb +52 -52
- data/lib/mailslurp_client/models/page_bounced_recipients.rb +52 -52
- data/lib/mailslurp_client/models/page_contact_projection.rb +52 -52
- data/lib/mailslurp_client/models/page_email_preview.rb +52 -52
- data/lib/mailslurp_client/models/page_email_projection.rb +52 -52
- data/lib/mailslurp_client/models/page_expired_inbox_record_projection.rb +52 -52
- data/lib/mailslurp_client/models/page_group_projection.rb +52 -52
- data/lib/mailslurp_client/models/page_inbox_forwarder_dto.rb +52 -52
- data/lib/mailslurp_client/models/page_inbox_projection.rb +52 -52
- data/lib/mailslurp_client/models/page_inbox_ruleset_dto.rb +52 -52
- data/lib/mailslurp_client/models/page_missed_email_projection.rb +52 -52
- data/lib/mailslurp_client/models/page_organization_inbox_projection.rb +52 -52
- data/lib/mailslurp_client/models/page_sent_email_projection.rb +49 -49
- data/lib/mailslurp_client/models/page_template_projection.rb +52 -52
- data/lib/mailslurp_client/models/page_thread_projection.rb +52 -52
- data/lib/mailslurp_client/models/page_tracking_pixel_projection.rb +52 -52
- data/lib/mailslurp_client/models/page_unknown_missed_email_projection.rb +52 -52
- data/lib/mailslurp_client/models/page_webhook_projection.rb +52 -52
- data/lib/mailslurp_client/models/page_webhook_result.rb +52 -52
- data/lib/mailslurp_client/models/pageable.rb +10 -10
- data/lib/mailslurp_client/models/raw_email_json.rb +0 -5
- data/lib/mailslurp_client/models/recipient.rb +13 -23
- data/lib/mailslurp_client/models/reply_to_alias_email_options.rb +38 -37
- data/lib/mailslurp_client/models/reply_to_email_options.rb +51 -50
- data/lib/mailslurp_client/models/send_email_options.rb +107 -115
- data/lib/mailslurp_client/models/sender.rb +14 -23
- data/lib/mailslurp_client/models/sent_email_dto.rb +97 -102
- data/lib/mailslurp_client/models/sent_email_projection.rb +66 -105
- data/lib/mailslurp_client/models/simple_send_email_options.rb +24 -24
- data/lib/mailslurp_client/models/template_dto.rb +22 -47
- data/lib/mailslurp_client/models/template_projection.rb +16 -41
- data/lib/mailslurp_client/models/template_variable.rb +0 -10
- data/lib/mailslurp_client/models/test_new_inbox_forwarder_options.rb +0 -10
- data/lib/mailslurp_client/models/test_new_inbox_ruleset_options.rb +0 -10
- data/lib/mailslurp_client/models/thread_projection.rb +60 -95
- data/lib/mailslurp_client/models/tracking_pixel_dto.rb +43 -68
- data/lib/mailslurp_client/models/tracking_pixel_projection.rb +34 -54
- data/lib/mailslurp_client/models/unknown_missed_email_projection.rb +19 -29
- data/lib/mailslurp_client/models/unread_count.rb +0 -5
- data/lib/mailslurp_client/models/unseen_error_count_dto.rb +0 -5
- data/lib/mailslurp_client/models/update_group_contacts.rb +0 -5
- data/lib/mailslurp_client/models/update_inbox_options.rb +26 -26
- data/lib/mailslurp_client/models/upload_attachment_options.rb +14 -14
- data/lib/mailslurp_client/models/validation_message.rb +1 -5
- data/lib/mailslurp_client/models/verify_email_address_options.rb +0 -5
- data/lib/mailslurp_client/models/wait_for_conditions.rb +48 -58
- data/lib/mailslurp_client/models/webhook_dto.rb +64 -69
- data/lib/mailslurp_client/models/webhook_email_opened_payload.rb +42 -42
- data/lib/mailslurp_client/models/webhook_email_read_payload.rb +49 -49
- data/lib/mailslurp_client/models/webhook_new_attachment_payload.rb +43 -43
- data/lib/mailslurp_client/models/webhook_new_contact_payload.rb +75 -95
- data/lib/mailslurp_client/models/webhook_new_email_payload.rb +84 -84
- data/lib/mailslurp_client/models/webhook_projection.rb +36 -61
- data/lib/mailslurp_client/models/webhook_redrive_result.rb +13 -23
- data/lib/mailslurp_client/models/webhook_result_dto.rb +76 -126
- data/lib/mailslurp_client/models/webhook_test_request.rb +21 -36
- data/lib/mailslurp_client/models/webhook_test_response.rb +13 -13
- data/lib/mailslurp_client/models/webhook_test_result.rb +13 -23
- data/lib/mailslurp_client/version.rb +1 -1
- data/lib/mailslurp_client.rb +3 -1
- metadata +5 -3
@@ -135,37 +135,37 @@ module MailSlurpClient
|
|
135
135
|
|
136
136
|
# Get email attachment bytes. Returned as `octet-stream` with content type header. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints and convert the base 64 encoded content to a file or string.
|
137
137
|
# Returns the specified attachment for a given email as a stream / array of bytes. You can find attachment ids in email responses endpoint responses. The response type is application/octet-stream.
|
138
|
-
# @param attachment_id [String] ID of attachment
|
139
138
|
# @param email_id [String] ID of email
|
139
|
+
# @param attachment_id [String] ID of attachment
|
140
140
|
# @param [Hash] opts the optional parameters
|
141
141
|
# @option opts [String] :api_key Can pass apiKey in url for this request if you wish to download the file in a browser. Content type will be set to original content type of the attachment file. This is so that browsers can download the file correctly.
|
142
|
-
# @return [String]
|
143
|
-
def download_attachment(
|
144
|
-
data, _status_code, _headers = download_attachment_with_http_info(
|
142
|
+
# @return [Array<String>]
|
143
|
+
def download_attachment(email_id, attachment_id, opts = {})
|
144
|
+
data, _status_code, _headers = download_attachment_with_http_info(email_id, attachment_id, opts)
|
145
145
|
data
|
146
146
|
end
|
147
147
|
|
148
148
|
# Get email attachment bytes. Returned as `octet-stream` with content type header. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints and convert the base 64 encoded content to a file or string.
|
149
149
|
# Returns the specified attachment for a given email as a stream / array of bytes. You can find attachment ids in email responses endpoint responses. The response type is application/octet-stream.
|
150
|
-
# @param attachment_id [String] ID of attachment
|
151
150
|
# @param email_id [String] ID of email
|
151
|
+
# @param attachment_id [String] ID of attachment
|
152
152
|
# @param [Hash] opts the optional parameters
|
153
153
|
# @option opts [String] :api_key Can pass apiKey in url for this request if you wish to download the file in a browser. Content type will be set to original content type of the attachment file. This is so that browsers can download the file correctly.
|
154
|
-
# @return [Array<(String
|
155
|
-
def download_attachment_with_http_info(
|
154
|
+
# @return [Array<(Array<String>, Integer, Hash)>] Array<String> data, response status code and response headers
|
155
|
+
def download_attachment_with_http_info(email_id, attachment_id, opts = {})
|
156
156
|
if @api_client.config.debugging
|
157
157
|
@api_client.config.logger.debug 'Calling API: EmailControllerApi.download_attachment ...'
|
158
158
|
end
|
159
|
-
# verify the required parameter 'attachment_id' is set
|
160
|
-
if @api_client.config.client_side_validation && attachment_id.nil?
|
161
|
-
fail ArgumentError, "Missing the required parameter 'attachment_id' when calling EmailControllerApi.download_attachment"
|
162
|
-
end
|
163
159
|
# verify the required parameter 'email_id' is set
|
164
160
|
if @api_client.config.client_side_validation && email_id.nil?
|
165
161
|
fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.download_attachment"
|
166
162
|
end
|
163
|
+
# verify the required parameter 'attachment_id' is set
|
164
|
+
if @api_client.config.client_side_validation && attachment_id.nil?
|
165
|
+
fail ArgumentError, "Missing the required parameter 'attachment_id' when calling EmailControllerApi.download_attachment"
|
166
|
+
end
|
167
167
|
# resource path
|
168
|
-
local_var_path = '/emails/{emailId}/attachments/{attachmentId}'.sub('{' + '
|
168
|
+
local_var_path = '/emails/{emailId}/attachments/{attachmentId}'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s)).sub('{' + 'attachmentId' + '}', CGI.escape(attachment_id.to_s))
|
169
169
|
|
170
170
|
# query parameters
|
171
171
|
query_params = opts[:query_params] || {}
|
@@ -183,7 +183,7 @@ module MailSlurpClient
|
|
183
183
|
post_body = opts[:body]
|
184
184
|
|
185
185
|
# return_type
|
186
|
-
return_type = opts[:return_type] || 'String'
|
186
|
+
return_type = opts[:return_type] || 'Array<String>'
|
187
187
|
|
188
188
|
# auth_names
|
189
189
|
auth_names = opts[:auth_names] || ['API_KEY']
|
@@ -206,35 +206,35 @@ module MailSlurpClient
|
|
206
206
|
|
207
207
|
# Get email attachment as base64 encoded string as an alternative to binary responses. Decode the `base64FileContents` as a `utf-8` encoded string or array of bytes depending on the `contentType`.
|
208
208
|
# Returns the specified attachment for a given email as a base 64 encoded string. The response type is application/json. This method is similar to the `downloadAttachment` method but allows some clients to get around issues with binary responses.
|
209
|
-
# @param attachment_id [String] ID of attachment
|
210
209
|
# @param email_id [String] ID of email
|
210
|
+
# @param attachment_id [String] ID of attachment
|
211
211
|
# @param [Hash] opts the optional parameters
|
212
212
|
# @return [DownloadAttachmentDto]
|
213
|
-
def download_attachment_base64(
|
214
|
-
data, _status_code, _headers = download_attachment_base64_with_http_info(
|
213
|
+
def download_attachment_base64(email_id, attachment_id, opts = {})
|
214
|
+
data, _status_code, _headers = download_attachment_base64_with_http_info(email_id, attachment_id, opts)
|
215
215
|
data
|
216
216
|
end
|
217
217
|
|
218
218
|
# Get email attachment as base64 encoded string as an alternative to binary responses. Decode the `base64FileContents` as a `utf-8` encoded string or array of bytes depending on the `contentType`.
|
219
219
|
# Returns the specified attachment for a given email as a base 64 encoded string. The response type is application/json. This method is similar to the `downloadAttachment` method but allows some clients to get around issues with binary responses.
|
220
|
-
# @param attachment_id [String] ID of attachment
|
221
220
|
# @param email_id [String] ID of email
|
221
|
+
# @param attachment_id [String] ID of attachment
|
222
222
|
# @param [Hash] opts the optional parameters
|
223
223
|
# @return [Array<(DownloadAttachmentDto, Integer, Hash)>] DownloadAttachmentDto data, response status code and response headers
|
224
|
-
def download_attachment_base64_with_http_info(
|
224
|
+
def download_attachment_base64_with_http_info(email_id, attachment_id, opts = {})
|
225
225
|
if @api_client.config.debugging
|
226
226
|
@api_client.config.logger.debug 'Calling API: EmailControllerApi.download_attachment_base64 ...'
|
227
227
|
end
|
228
|
-
# verify the required parameter 'attachment_id' is set
|
229
|
-
if @api_client.config.client_side_validation && attachment_id.nil?
|
230
|
-
fail ArgumentError, "Missing the required parameter 'attachment_id' when calling EmailControllerApi.download_attachment_base64"
|
231
|
-
end
|
232
228
|
# verify the required parameter 'email_id' is set
|
233
229
|
if @api_client.config.client_side_validation && email_id.nil?
|
234
230
|
fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.download_attachment_base64"
|
235
231
|
end
|
232
|
+
# verify the required parameter 'attachment_id' is set
|
233
|
+
if @api_client.config.client_side_validation && attachment_id.nil?
|
234
|
+
fail ArgumentError, "Missing the required parameter 'attachment_id' when calling EmailControllerApi.download_attachment_base64"
|
235
|
+
end
|
236
236
|
# resource path
|
237
|
-
local_var_path = '/emails/{emailId}/attachments/{attachmentId}/base64'.sub('{' + '
|
237
|
+
local_var_path = '/emails/{emailId}/attachments/{attachmentId}/base64'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s)).sub('{' + 'attachmentId' + '}', CGI.escape(attachment_id.to_s))
|
238
238
|
|
239
239
|
# query parameters
|
240
240
|
query_params = opts[:query_params] || {}
|
@@ -242,7 +242,7 @@ module MailSlurpClient
|
|
242
242
|
# header parameters
|
243
243
|
header_params = opts[:header_params] || {}
|
244
244
|
# HTTP header 'Accept' (if needed)
|
245
|
-
header_params['Accept'] = @api_client.select_header_accept(['
|
245
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
246
246
|
|
247
247
|
# form parameters
|
248
248
|
form_params = opts[:form_params] || {}
|
@@ -304,7 +304,7 @@ module MailSlurpClient
|
|
304
304
|
# header parameters
|
305
305
|
header_params = opts[:header_params] || {}
|
306
306
|
# HTTP header 'Accept' (if needed)
|
307
|
-
header_params['Accept'] = @api_client.select_header_accept(['text/
|
307
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'text/html'])
|
308
308
|
|
309
309
|
# form parameters
|
310
310
|
form_params = opts[:form_params] || {}
|
@@ -338,7 +338,7 @@ module MailSlurpClient
|
|
338
338
|
# Returns the specified email body for a given email as a stream / array of bytes.
|
339
339
|
# @param email_id [String] ID of email
|
340
340
|
# @param [Hash] opts the optional parameters
|
341
|
-
# @return [String]
|
341
|
+
# @return [Array<String>]
|
342
342
|
def download_body_bytes(email_id, opts = {})
|
343
343
|
data, _status_code, _headers = download_body_bytes_with_http_info(email_id, opts)
|
344
344
|
data
|
@@ -348,7 +348,7 @@ module MailSlurpClient
|
|
348
348
|
# Returns the specified email body for a given email as a stream / array of bytes.
|
349
349
|
# @param email_id [String] ID of email
|
350
350
|
# @param [Hash] opts the optional parameters
|
351
|
-
# @return [Array<(String
|
351
|
+
# @return [Array<(Array<String>, Integer, Hash)>] Array<String> data, response status code and response headers
|
352
352
|
def download_body_bytes_with_http_info(email_id, opts = {})
|
353
353
|
if @api_client.config.debugging
|
354
354
|
@api_client.config.logger.debug 'Calling API: EmailControllerApi.download_body_bytes ...'
|
@@ -375,7 +375,7 @@ module MailSlurpClient
|
|
375
375
|
post_body = opts[:body]
|
376
376
|
|
377
377
|
# return_type
|
378
|
-
return_type = opts[:return_type] || 'String'
|
378
|
+
return_type = opts[:return_type] || 'Array<String>'
|
379
379
|
|
380
380
|
# auth_names
|
381
381
|
auth_names = opts[:auth_names] || ['API_KEY']
|
@@ -399,7 +399,7 @@ module MailSlurpClient
|
|
399
399
|
# Forward email to recipients
|
400
400
|
# Forward an existing email to new recipients. The sender of the email will be the inbox that received the email you are forwarding. You can override the sender with the `from` option. Note you must have access to the from address in MailSlurp to use the override. For more control consider fetching the email and sending it a new using the send email endpoints.
|
401
401
|
# @param email_id [String] ID of email
|
402
|
-
# @param forward_email_options [ForwardEmailOptions]
|
402
|
+
# @param forward_email_options [ForwardEmailOptions]
|
403
403
|
# @param [Hash] opts the optional parameters
|
404
404
|
# @return [SentEmailDto]
|
405
405
|
def forward_email(email_id, forward_email_options, opts = {})
|
@@ -410,7 +410,7 @@ module MailSlurpClient
|
|
410
410
|
# Forward email to recipients
|
411
411
|
# Forward an existing email to new recipients. The sender of the email will be the inbox that received the email you are forwarding. You can override the sender with the `from` option. Note you must have access to the from address in MailSlurp to use the override. For more control consider fetching the email and sending it a new using the send email endpoints.
|
412
412
|
# @param email_id [String] ID of email
|
413
|
-
# @param forward_email_options [ForwardEmailOptions]
|
413
|
+
# @param forward_email_options [ForwardEmailOptions]
|
414
414
|
# @param [Hash] opts the optional parameters
|
415
415
|
# @return [Array<(SentEmailDto, Integer, Hash)>] SentEmailDto data, response status code and response headers
|
416
416
|
def forward_email_with_http_info(email_id, forward_email_options, opts = {})
|
@@ -434,7 +434,7 @@ module MailSlurpClient
|
|
434
434
|
# header parameters
|
435
435
|
header_params = opts[:header_params] || {}
|
436
436
|
# HTTP header 'Accept' (if needed)
|
437
|
-
header_params['Accept'] = @api_client.select_header_accept(['
|
437
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
438
438
|
# HTTP header 'Content-Type'
|
439
439
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
440
440
|
|
@@ -468,35 +468,35 @@ module MailSlurpClient
|
|
468
468
|
|
469
469
|
# Get email attachment metadata. This is the `contentType` and `contentLength` of an attachment. To get the individual attachments use the `downloadAttachment` methods.
|
470
470
|
# Returns the metadata such as name and content-type for a given attachment and email.
|
471
|
-
# @param attachment_id [String] ID of attachment
|
472
471
|
# @param email_id [String] ID of email
|
472
|
+
# @param attachment_id [String] ID of attachment
|
473
473
|
# @param [Hash] opts the optional parameters
|
474
474
|
# @return [AttachmentMetaData]
|
475
|
-
def get_attachment_meta_data(
|
476
|
-
data, _status_code, _headers = get_attachment_meta_data_with_http_info(
|
475
|
+
def get_attachment_meta_data(email_id, attachment_id, opts = {})
|
476
|
+
data, _status_code, _headers = get_attachment_meta_data_with_http_info(email_id, attachment_id, opts)
|
477
477
|
data
|
478
478
|
end
|
479
479
|
|
480
480
|
# Get email attachment metadata. This is the `contentType` and `contentLength` of an attachment. To get the individual attachments use the `downloadAttachment` methods.
|
481
481
|
# Returns the metadata such as name and content-type for a given attachment and email.
|
482
|
-
# @param attachment_id [String] ID of attachment
|
483
482
|
# @param email_id [String] ID of email
|
483
|
+
# @param attachment_id [String] ID of attachment
|
484
484
|
# @param [Hash] opts the optional parameters
|
485
485
|
# @return [Array<(AttachmentMetaData, Integer, Hash)>] AttachmentMetaData data, response status code and response headers
|
486
|
-
def get_attachment_meta_data_with_http_info(
|
486
|
+
def get_attachment_meta_data_with_http_info(email_id, attachment_id, opts = {})
|
487
487
|
if @api_client.config.debugging
|
488
488
|
@api_client.config.logger.debug 'Calling API: EmailControllerApi.get_attachment_meta_data ...'
|
489
489
|
end
|
490
|
-
# verify the required parameter 'attachment_id' is set
|
491
|
-
if @api_client.config.client_side_validation && attachment_id.nil?
|
492
|
-
fail ArgumentError, "Missing the required parameter 'attachment_id' when calling EmailControllerApi.get_attachment_meta_data"
|
493
|
-
end
|
494
490
|
# verify the required parameter 'email_id' is set
|
495
491
|
if @api_client.config.client_side_validation && email_id.nil?
|
496
492
|
fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.get_attachment_meta_data"
|
497
493
|
end
|
494
|
+
# verify the required parameter 'attachment_id' is set
|
495
|
+
if @api_client.config.client_side_validation && attachment_id.nil?
|
496
|
+
fail ArgumentError, "Missing the required parameter 'attachment_id' when calling EmailControllerApi.get_attachment_meta_data"
|
497
|
+
end
|
498
498
|
# resource path
|
499
|
-
local_var_path = '/emails/{emailId}/attachments/{attachmentId}/metadata'.sub('{' + '
|
499
|
+
local_var_path = '/emails/{emailId}/attachments/{attachmentId}/metadata'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s)).sub('{' + 'attachmentId' + '}', CGI.escape(attachment_id.to_s))
|
500
500
|
|
501
501
|
# query parameters
|
502
502
|
query_params = opts[:query_params] || {}
|
@@ -504,7 +504,7 @@ module MailSlurpClient
|
|
504
504
|
# header parameters
|
505
505
|
header_params = opts[:header_params] || {}
|
506
506
|
# HTTP header 'Accept' (if needed)
|
507
|
-
header_params['Accept'] = @api_client.select_header_accept(['
|
507
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
508
508
|
|
509
509
|
# form parameters
|
510
510
|
form_params = opts[:form_params] || {}
|
@@ -539,8 +539,8 @@ module MailSlurpClient
|
|
539
539
|
# @param email_id [String] ID of email
|
540
540
|
# @param [Hash] opts the optional parameters
|
541
541
|
# @return [Array<AttachmentMetaData>]
|
542
|
-
def
|
543
|
-
data, _status_code, _headers =
|
542
|
+
def get_attachments(email_id, opts = {})
|
543
|
+
data, _status_code, _headers = get_attachments_with_http_info(email_id, opts)
|
544
544
|
data
|
545
545
|
end
|
546
546
|
|
@@ -549,13 +549,13 @@ module MailSlurpClient
|
|
549
549
|
# @param email_id [String] ID of email
|
550
550
|
# @param [Hash] opts the optional parameters
|
551
551
|
# @return [Array<(Array<AttachmentMetaData>, Integer, Hash)>] Array<AttachmentMetaData> data, response status code and response headers
|
552
|
-
def
|
552
|
+
def get_attachments_with_http_info(email_id, opts = {})
|
553
553
|
if @api_client.config.debugging
|
554
|
-
@api_client.config.logger.debug 'Calling API: EmailControllerApi.
|
554
|
+
@api_client.config.logger.debug 'Calling API: EmailControllerApi.get_attachments ...'
|
555
555
|
end
|
556
556
|
# verify the required parameter 'email_id' is set
|
557
557
|
if @api_client.config.client_side_validation && email_id.nil?
|
558
|
-
fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.
|
558
|
+
fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.get_attachments"
|
559
559
|
end
|
560
560
|
# resource path
|
561
561
|
local_var_path = '/emails/{emailId}/attachments'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))
|
@@ -566,7 +566,7 @@ module MailSlurpClient
|
|
566
566
|
# header parameters
|
567
567
|
header_params = opts[:header_params] || {}
|
568
568
|
# HTTP header 'Accept' (if needed)
|
569
|
-
header_params['Accept'] = @api_client.select_header_accept(['
|
569
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
570
570
|
|
571
571
|
# form parameters
|
572
572
|
form_params = opts[:form_params] || {}
|
@@ -591,14 +591,14 @@ module MailSlurpClient
|
|
591
591
|
|
592
592
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
593
593
|
if @api_client.config.debugging
|
594
|
-
@api_client.config.logger.debug "API called: EmailControllerApi#
|
594
|
+
@api_client.config.logger.debug "API called: EmailControllerApi#get_attachments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
595
595
|
end
|
596
596
|
return data, status_code, headers
|
597
597
|
end
|
598
598
|
|
599
599
|
# Get email content including headers and body. Expects email to exist by ID. For emails that may not have arrived yet use the WaitForController.
|
600
600
|
# Returns a email summary object with headers and content. To retrieve the raw unparsed email use the getRawEmail endpoints
|
601
|
-
# @param email_id [String]
|
601
|
+
# @param email_id [String]
|
602
602
|
# @param [Hash] opts the optional parameters
|
603
603
|
# @option opts [Boolean] :decode Decode email body quoted-printable encoding to plain text. SMTP servers often encode text using quoted-printable format (for instance `=D7`). This can be a pain for testing (default to false)
|
604
604
|
# @return [Email]
|
@@ -609,7 +609,7 @@ module MailSlurpClient
|
|
609
609
|
|
610
610
|
# Get email content including headers and body. Expects email to exist by ID. For emails that may not have arrived yet use the WaitForController.
|
611
611
|
# Returns a email summary object with headers and content. To retrieve the raw unparsed email use the getRawEmail endpoints
|
612
|
-
# @param email_id [String]
|
612
|
+
# @param email_id [String]
|
613
613
|
# @param [Hash] opts the optional parameters
|
614
614
|
# @option opts [Boolean] :decode Decode email body quoted-printable encoding to plain text. SMTP servers often encode text using quoted-printable format (for instance `=D7`). This can be a pain for testing
|
615
615
|
# @return [Array<(Email, Integer, Hash)>] Email data, response status code and response headers
|
@@ -631,7 +631,7 @@ module MailSlurpClient
|
|
631
631
|
# header parameters
|
632
632
|
header_params = opts[:header_params] || {}
|
633
633
|
# HTTP header 'Accept' (if needed)
|
634
|
-
header_params['Accept'] = @api_client.select_header_accept(['
|
634
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
635
635
|
|
636
636
|
# form parameters
|
637
637
|
form_params = opts[:form_params] || {}
|
@@ -664,7 +664,7 @@ module MailSlurpClient
|
|
664
664
|
# Get email content regex pattern match results. Runs regex against email body and returns match groups.
|
665
665
|
# Return the matches for a given Java style regex pattern. Do not include the typical `/` at start or end of regex in some languages. Given an example `your code is: 12345` the pattern to extract match looks like `code is: (\\d{6})`. This will return an array of matches with the first matching the entire pattern and the subsequent matching the groups: `['code is: 123456', '123456']` See https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html for more information of available patterns.
|
666
666
|
# @param email_id [String] ID of email to match against
|
667
|
-
# @param content_match_options [ContentMatchOptions]
|
667
|
+
# @param content_match_options [ContentMatchOptions]
|
668
668
|
# @param [Hash] opts the optional parameters
|
669
669
|
# @return [EmailContentMatchResult]
|
670
670
|
def get_email_content_match(email_id, content_match_options, opts = {})
|
@@ -675,7 +675,7 @@ module MailSlurpClient
|
|
675
675
|
# Get email content regex pattern match results. Runs regex against email body and returns match groups.
|
676
676
|
# Return the matches for a given Java style regex pattern. Do not include the typical `/` at start or end of regex in some languages. Given an example `your code is: 12345` the pattern to extract match looks like `code is: (\\d{6})`. This will return an array of matches with the first matching the entire pattern and the subsequent matching the groups: `['code is: 123456', '123456']` See https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html for more information of available patterns.
|
677
677
|
# @param email_id [String] ID of email to match against
|
678
|
-
# @param content_match_options [ContentMatchOptions]
|
678
|
+
# @param content_match_options [ContentMatchOptions]
|
679
679
|
# @param [Hash] opts the optional parameters
|
680
680
|
# @return [Array<(EmailContentMatchResult, Integer, Hash)>] EmailContentMatchResult data, response status code and response headers
|
681
681
|
def get_email_content_match_with_http_info(email_id, content_match_options, opts = {})
|
@@ -699,7 +699,7 @@ module MailSlurpClient
|
|
699
699
|
# header parameters
|
700
700
|
header_params = opts[:header_params] || {}
|
701
701
|
# HTTP header 'Accept' (if needed)
|
702
|
-
header_params['Accept'] = @api_client.select_header_accept(['
|
702
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
703
703
|
# HTTP header 'Content-Type'
|
704
704
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
705
705
|
|
@@ -731,11 +731,65 @@ module MailSlurpClient
|
|
731
731
|
return data, status_code, headers
|
732
732
|
end
|
733
733
|
|
734
|
+
# Get email count
|
735
|
+
# @param [Hash] opts the optional parameters
|
736
|
+
# @return [CountDto]
|
737
|
+
def get_email_count(opts = {})
|
738
|
+
data, _status_code, _headers = get_email_count_with_http_info(opts)
|
739
|
+
data
|
740
|
+
end
|
741
|
+
|
742
|
+
# Get email count
|
743
|
+
# @param [Hash] opts the optional parameters
|
744
|
+
# @return [Array<(CountDto, Integer, Hash)>] CountDto data, response status code and response headers
|
745
|
+
def get_email_count_with_http_info(opts = {})
|
746
|
+
if @api_client.config.debugging
|
747
|
+
@api_client.config.logger.debug 'Calling API: EmailControllerApi.get_email_count ...'
|
748
|
+
end
|
749
|
+
# resource path
|
750
|
+
local_var_path = '/emails/emails/count'
|
751
|
+
|
752
|
+
# query parameters
|
753
|
+
query_params = opts[:query_params] || {}
|
754
|
+
|
755
|
+
# header parameters
|
756
|
+
header_params = opts[:header_params] || {}
|
757
|
+
# HTTP header 'Accept' (if needed)
|
758
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
759
|
+
|
760
|
+
# form parameters
|
761
|
+
form_params = opts[:form_params] || {}
|
762
|
+
|
763
|
+
# http body (model)
|
764
|
+
post_body = opts[:body]
|
765
|
+
|
766
|
+
# return_type
|
767
|
+
return_type = opts[:return_type] || 'CountDto'
|
768
|
+
|
769
|
+
# auth_names
|
770
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
771
|
+
|
772
|
+
new_options = opts.merge(
|
773
|
+
:header_params => header_params,
|
774
|
+
:query_params => query_params,
|
775
|
+
:form_params => form_params,
|
776
|
+
:body => post_body,
|
777
|
+
:auth_names => auth_names,
|
778
|
+
:return_type => return_type
|
779
|
+
)
|
780
|
+
|
781
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
782
|
+
if @api_client.config.debugging
|
783
|
+
@api_client.config.logger.debug "API called: EmailControllerApi#get_email_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
784
|
+
end
|
785
|
+
return data, status_code, headers
|
786
|
+
end
|
787
|
+
|
734
788
|
# Get email content as HTML. For displaying emails in browser context.
|
735
789
|
# Retrieve email content as HTML response for viewing in browsers. Decodes quoted-printable entities and converts charset to UTF-8. Pass your API KEY as a request parameter when viewing in a browser: `?apiKey=xxx`
|
736
|
-
# @param email_id [String]
|
790
|
+
# @param email_id [String]
|
737
791
|
# @param [Hash] opts the optional parameters
|
738
|
-
# @option opts [Boolean] :decode
|
792
|
+
# @option opts [Boolean] :decode (default to false)
|
739
793
|
# @return [String]
|
740
794
|
def get_email_html(email_id, opts = {})
|
741
795
|
data, _status_code, _headers = get_email_html_with_http_info(email_id, opts)
|
@@ -744,9 +798,9 @@ module MailSlurpClient
|
|
744
798
|
|
745
799
|
# Get email content as HTML. For displaying emails in browser context.
|
746
800
|
# Retrieve email content as HTML response for viewing in browsers. Decodes quoted-printable entities and converts charset to UTF-8. Pass your API KEY as a request parameter when viewing in a browser: `?apiKey=xxx`
|
747
|
-
# @param email_id [String]
|
801
|
+
# @param email_id [String]
|
748
802
|
# @param [Hash] opts the optional parameters
|
749
|
-
# @option opts [Boolean] :decode
|
803
|
+
# @option opts [Boolean] :decode
|
750
804
|
# @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
|
751
805
|
def get_email_html_with_http_info(email_id, opts = {})
|
752
806
|
if @api_client.config.debugging
|
@@ -799,21 +853,21 @@ module MailSlurpClient
|
|
799
853
|
# Parse and return text from an email, stripping HTML and decoding encoded characters
|
800
854
|
# Parse an email body and return the content as an array of text. HTML parsing uses JSoup which supports JQuery/CSS style selectors
|
801
855
|
# @param email_id [String] ID of email to perform HTML query on
|
856
|
+
# @param html_selector [String] HTML selector to search for. Uses JQuery/JSoup/CSS style selector like '.my-div' to match content. See https://jsoup.org/apidocs/org/jsoup/select/Selector.html for more information.
|
802
857
|
# @param [Hash] opts the optional parameters
|
803
|
-
# @option opts [String] :html_selector HTML selector to search for. Uses JQuery/JSoup/CSS style selector like '.my-div' to match content. See https://jsoup.org/apidocs/org/jsoup/select/Selector.html for more information.
|
804
858
|
# @return [EmailTextLinesResult]
|
805
|
-
def get_email_html_query(email_id, opts = {})
|
806
|
-
data, _status_code, _headers = get_email_html_query_with_http_info(email_id, opts)
|
859
|
+
def get_email_html_query(email_id, html_selector, opts = {})
|
860
|
+
data, _status_code, _headers = get_email_html_query_with_http_info(email_id, html_selector, opts)
|
807
861
|
data
|
808
862
|
end
|
809
863
|
|
810
864
|
# Parse and return text from an email, stripping HTML and decoding encoded characters
|
811
865
|
# Parse an email body and return the content as an array of text. HTML parsing uses JSoup which supports JQuery/CSS style selectors
|
812
866
|
# @param email_id [String] ID of email to perform HTML query on
|
867
|
+
# @param html_selector [String] HTML selector to search for. Uses JQuery/JSoup/CSS style selector like '.my-div' to match content. See https://jsoup.org/apidocs/org/jsoup/select/Selector.html for more information.
|
813
868
|
# @param [Hash] opts the optional parameters
|
814
|
-
# @option opts [String] :html_selector HTML selector to search for. Uses JQuery/JSoup/CSS style selector like '.my-div' to match content. See https://jsoup.org/apidocs/org/jsoup/select/Selector.html for more information.
|
815
869
|
# @return [Array<(EmailTextLinesResult, Integer, Hash)>] EmailTextLinesResult data, response status code and response headers
|
816
|
-
def get_email_html_query_with_http_info(email_id, opts = {})
|
870
|
+
def get_email_html_query_with_http_info(email_id, html_selector, opts = {})
|
817
871
|
if @api_client.config.debugging
|
818
872
|
@api_client.config.logger.debug 'Calling API: EmailControllerApi.get_email_html_query ...'
|
819
873
|
end
|
@@ -821,17 +875,21 @@ module MailSlurpClient
|
|
821
875
|
if @api_client.config.client_side_validation && email_id.nil?
|
822
876
|
fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.get_email_html_query"
|
823
877
|
end
|
878
|
+
# verify the required parameter 'html_selector' is set
|
879
|
+
if @api_client.config.client_side_validation && html_selector.nil?
|
880
|
+
fail ArgumentError, "Missing the required parameter 'html_selector' when calling EmailControllerApi.get_email_html_query"
|
881
|
+
end
|
824
882
|
# resource path
|
825
883
|
local_var_path = '/emails/{emailId}/htmlQuery'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))
|
826
884
|
|
827
885
|
# query parameters
|
828
886
|
query_params = opts[:query_params] || {}
|
829
|
-
query_params[:'htmlSelector'] =
|
887
|
+
query_params[:'htmlSelector'] = html_selector
|
830
888
|
|
831
889
|
# header parameters
|
832
890
|
header_params = opts[:header_params] || {}
|
833
891
|
# HTTP header 'Accept' (if needed)
|
834
|
-
header_params['Accept'] = @api_client.select_header_accept(['
|
892
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
835
893
|
|
836
894
|
# form parameters
|
837
895
|
form_params = opts[:form_params] || {}
|
@@ -893,7 +951,7 @@ module MailSlurpClient
|
|
893
951
|
# header parameters
|
894
952
|
header_params = opts[:header_params] || {}
|
895
953
|
# HTTP header 'Accept' (if needed)
|
896
|
-
header_params['Accept'] = @api_client.select_header_accept(['
|
954
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
897
955
|
|
898
956
|
# form parameters
|
899
957
|
form_params = opts[:form_params] || {}
|
@@ -961,7 +1019,7 @@ module MailSlurpClient
|
|
961
1019
|
# header parameters
|
962
1020
|
header_params = opts[:header_params] || {}
|
963
1021
|
# HTTP header 'Accept' (if needed)
|
964
|
-
header_params['Accept'] = @api_client.select_header_accept(['
|
1022
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
965
1023
|
|
966
1024
|
# form parameters
|
967
1025
|
form_params = opts[:form_params] || {}
|
@@ -994,14 +1052,14 @@ module MailSlurpClient
|
|
994
1052
|
# Get all emails in all inboxes in paginated form. Email API list all.
|
995
1053
|
# By default returns all emails across all inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages
|
996
1054
|
# @param [Hash] opts the optional parameters
|
997
|
-
# @option opts [DateTime] :before Optional filter emails received before given date time
|
998
1055
|
# @option opts [Array<String>] :inbox_id Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.
|
999
1056
|
# @option opts [Integer] :page Optional page index in email list pagination (default to 0)
|
1000
|
-
# @option opts [String] :search_filter Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body (default to 'false')
|
1001
|
-
# @option opts [DateTime] :since Optional filter emails received after given date time
|
1002
1057
|
# @option opts [Integer] :size Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (default to 20)
|
1003
1058
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
|
1004
1059
|
# @option opts [Boolean] :unread_only Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly (default to false)
|
1060
|
+
# @option opts [String] :search_filter Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body
|
1061
|
+
# @option opts [DateTime] :since Optional filter emails received after given date time
|
1062
|
+
# @option opts [DateTime] :before Optional filter emails received before given date time
|
1005
1063
|
# @return [PageEmailProjection]
|
1006
1064
|
def get_emails_paginated(opts = {})
|
1007
1065
|
data, _status_code, _headers = get_emails_paginated_with_http_info(opts)
|
@@ -1011,19 +1069,23 @@ module MailSlurpClient
|
|
1011
1069
|
# Get all emails in all inboxes in paginated form. Email API list all.
|
1012
1070
|
# By default returns all emails across all inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages
|
1013
1071
|
# @param [Hash] opts the optional parameters
|
1014
|
-
# @option opts [DateTime] :before Optional filter emails received before given date time
|
1015
1072
|
# @option opts [Array<String>] :inbox_id Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.
|
1016
1073
|
# @option opts [Integer] :page Optional page index in email list pagination
|
1017
|
-
# @option opts [String] :search_filter Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body
|
1018
|
-
# @option opts [DateTime] :since Optional filter emails received after given date time
|
1019
1074
|
# @option opts [Integer] :size Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results
|
1020
1075
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
1021
1076
|
# @option opts [Boolean] :unread_only Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly
|
1077
|
+
# @option opts [String] :search_filter Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body
|
1078
|
+
# @option opts [DateTime] :since Optional filter emails received after given date time
|
1079
|
+
# @option opts [DateTime] :before Optional filter emails received before given date time
|
1022
1080
|
# @return [Array<(PageEmailProjection, Integer, Hash)>] PageEmailProjection data, response status code and response headers
|
1023
1081
|
def get_emails_paginated_with_http_info(opts = {})
|
1024
1082
|
if @api_client.config.debugging
|
1025
1083
|
@api_client.config.logger.debug 'Calling API: EmailControllerApi.get_emails_paginated ...'
|
1026
1084
|
end
|
1085
|
+
if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] > 100
|
1086
|
+
fail ArgumentError, 'invalid value for "opts[:"size"]" when calling EmailControllerApi.get_emails_paginated, must be smaller than or equal to 100.'
|
1087
|
+
end
|
1088
|
+
|
1027
1089
|
allowable_values = ["ASC", "DESC"]
|
1028
1090
|
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
1029
1091
|
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
@@ -1033,19 +1095,19 @@ module MailSlurpClient
|
|
1033
1095
|
|
1034
1096
|
# query parameters
|
1035
1097
|
query_params = opts[:query_params] || {}
|
1036
|
-
query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
|
1037
1098
|
query_params[:'inboxId'] = @api_client.build_collection_param(opts[:'inbox_id'], :multi) if !opts[:'inbox_id'].nil?
|
1038
1099
|
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
1039
|
-
query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
|
1040
|
-
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
1041
1100
|
query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
|
1042
1101
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
1043
1102
|
query_params[:'unreadOnly'] = opts[:'unread_only'] if !opts[:'unread_only'].nil?
|
1103
|
+
query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
|
1104
|
+
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
1105
|
+
query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
|
1044
1106
|
|
1045
1107
|
# header parameters
|
1046
1108
|
header_params = opts[:header_params] || {}
|
1047
1109
|
# HTTP header 'Accept' (if needed)
|
1048
|
-
header_params['Accept'] = @api_client.select_header_accept(['
|
1110
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
1049
1111
|
|
1050
1112
|
# form parameters
|
1051
1113
|
form_params = opts[:form_params] || {}
|
@@ -1076,9 +1138,9 @@ module MailSlurpClient
|
|
1076
1138
|
end
|
1077
1139
|
|
1078
1140
|
# Get gravatar url for email address
|
1079
|
-
# @param email_address [String]
|
1141
|
+
# @param email_address [String]
|
1080
1142
|
# @param [Hash] opts the optional parameters
|
1081
|
-
# @option opts [String] :size
|
1143
|
+
# @option opts [String] :size
|
1082
1144
|
# @return [GravatarUrl]
|
1083
1145
|
def get_gravatar_url_for_email_address(email_address, opts = {})
|
1084
1146
|
data, _status_code, _headers = get_gravatar_url_for_email_address_with_http_info(email_address, opts)
|
@@ -1086,9 +1148,9 @@ module MailSlurpClient
|
|
1086
1148
|
end
|
1087
1149
|
|
1088
1150
|
# Get gravatar url for email address
|
1089
|
-
# @param email_address [String]
|
1151
|
+
# @param email_address [String]
|
1090
1152
|
# @param [Hash] opts the optional parameters
|
1091
|
-
# @option opts [String] :size
|
1153
|
+
# @option opts [String] :size
|
1092
1154
|
# @return [Array<(GravatarUrl, Integer, Hash)>] GravatarUrl data, response status code and response headers
|
1093
1155
|
def get_gravatar_url_for_email_address_with_http_info(email_address, opts = {})
|
1094
1156
|
if @api_client.config.debugging
|
@@ -1109,7 +1171,7 @@ module MailSlurpClient
|
|
1109
1171
|
# header parameters
|
1110
1172
|
header_params = opts[:header_params] || {}
|
1111
1173
|
# HTTP header 'Accept' (if needed)
|
1112
|
-
header_params['Accept'] = @api_client.select_header_accept(['
|
1174
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
1113
1175
|
|
1114
1176
|
# form parameters
|
1115
1177
|
form_params = opts[:form_params] || {}
|
@@ -1168,7 +1230,7 @@ module MailSlurpClient
|
|
1168
1230
|
# header parameters
|
1169
1231
|
header_params = opts[:header_params] || {}
|
1170
1232
|
# HTTP header 'Accept' (if needed)
|
1171
|
-
header_params['Accept'] = @api_client.select_header_accept(['
|
1233
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
1172
1234
|
|
1173
1235
|
# form parameters
|
1174
1236
|
form_params = opts[:form_params] || {}
|
@@ -1200,34 +1262,38 @@ module MailSlurpClient
|
|
1200
1262
|
|
1201
1263
|
# Get latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet.
|
1202
1264
|
# Get the newest email in all inboxes or in a passed set of inbox IDs
|
1265
|
+
# @param inbox_id [String] ID of the inbox you want to get the latest email from
|
1203
1266
|
# @param [Hash] opts the optional parameters
|
1204
|
-
# @option opts [String] :inbox_id ID of the inbox you want to get the latest email from
|
1205
1267
|
# @return [Email]
|
1206
|
-
def get_latest_email_in_inbox(opts = {})
|
1207
|
-
data, _status_code, _headers = get_latest_email_in_inbox_with_http_info(opts)
|
1268
|
+
def get_latest_email_in_inbox(inbox_id, opts = {})
|
1269
|
+
data, _status_code, _headers = get_latest_email_in_inbox_with_http_info(inbox_id, opts)
|
1208
1270
|
data
|
1209
1271
|
end
|
1210
1272
|
|
1211
1273
|
# Get latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet.
|
1212
1274
|
# Get the newest email in all inboxes or in a passed set of inbox IDs
|
1275
|
+
# @param inbox_id [String] ID of the inbox you want to get the latest email from
|
1213
1276
|
# @param [Hash] opts the optional parameters
|
1214
|
-
# @option opts [String] :inbox_id ID of the inbox you want to get the latest email from
|
1215
1277
|
# @return [Array<(Email, Integer, Hash)>] Email data, response status code and response headers
|
1216
|
-
def get_latest_email_in_inbox_with_http_info(opts = {})
|
1278
|
+
def get_latest_email_in_inbox_with_http_info(inbox_id, opts = {})
|
1217
1279
|
if @api_client.config.debugging
|
1218
1280
|
@api_client.config.logger.debug 'Calling API: EmailControllerApi.get_latest_email_in_inbox ...'
|
1219
1281
|
end
|
1282
|
+
# verify the required parameter 'inbox_id' is set
|
1283
|
+
if @api_client.config.client_side_validation && inbox_id.nil?
|
1284
|
+
fail ArgumentError, "Missing the required parameter 'inbox_id' when calling EmailControllerApi.get_latest_email_in_inbox"
|
1285
|
+
end
|
1220
1286
|
# resource path
|
1221
1287
|
local_var_path = '/emails/latestIn'
|
1222
1288
|
|
1223
1289
|
# query parameters
|
1224
1290
|
query_params = opts[:query_params] || {}
|
1225
|
-
query_params[:'inboxId'] =
|
1291
|
+
query_params[:'inboxId'] = inbox_id
|
1226
1292
|
|
1227
1293
|
# header parameters
|
1228
1294
|
header_params = opts[:header_params] || {}
|
1229
1295
|
# HTTP header 'Accept' (if needed)
|
1230
|
-
header_params['Accept'] = @api_client.select_header_accept(['
|
1296
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
1231
1297
|
|
1232
1298
|
# form parameters
|
1233
1299
|
form_params = opts[:form_params] || {}
|
@@ -1260,14 +1326,14 @@ module MailSlurpClient
|
|
1260
1326
|
# Get all organization emails. List team or shared test email accounts
|
1261
1327
|
# By default returns all emails across all team inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages
|
1262
1328
|
# @param [Hash] opts the optional parameters
|
1263
|
-
# @option opts [DateTime] :before Optional filter emails received before given date time
|
1264
1329
|
# @option opts [Array<String>] :inbox_id Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.
|
1265
1330
|
# @option opts [Integer] :page Optional page index in email list pagination (default to 0)
|
1266
|
-
# @option opts [String] :search_filter Optional search filter search filter for emails.
|
1267
|
-
# @option opts [DateTime] :since Optional filter emails received after given date time
|
1268
1331
|
# @option opts [Integer] :size Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (default to 20)
|
1269
1332
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
|
1270
1333
|
# @option opts [Boolean] :unread_only Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly (default to false)
|
1334
|
+
# @option opts [String] :search_filter Optional search filter search filter for emails.
|
1335
|
+
# @option opts [DateTime] :since Optional filter emails received after given date time
|
1336
|
+
# @option opts [DateTime] :before Optional filter emails received before given date time
|
1271
1337
|
# @return [PageEmailProjection]
|
1272
1338
|
def get_organization_emails_paginated(opts = {})
|
1273
1339
|
data, _status_code, _headers = get_organization_emails_paginated_with_http_info(opts)
|
@@ -1277,19 +1343,23 @@ module MailSlurpClient
|
|
1277
1343
|
# Get all organization emails. List team or shared test email accounts
|
1278
1344
|
# By default returns all emails across all team inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages
|
1279
1345
|
# @param [Hash] opts the optional parameters
|
1280
|
-
# @option opts [DateTime] :before Optional filter emails received before given date time
|
1281
1346
|
# @option opts [Array<String>] :inbox_id Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.
|
1282
1347
|
# @option opts [Integer] :page Optional page index in email list pagination
|
1283
|
-
# @option opts [String] :search_filter Optional search filter search filter for emails.
|
1284
|
-
# @option opts [DateTime] :since Optional filter emails received after given date time
|
1285
1348
|
# @option opts [Integer] :size Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results
|
1286
1349
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
1287
1350
|
# @option opts [Boolean] :unread_only Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly
|
1351
|
+
# @option opts [String] :search_filter Optional search filter search filter for emails.
|
1352
|
+
# @option opts [DateTime] :since Optional filter emails received after given date time
|
1353
|
+
# @option opts [DateTime] :before Optional filter emails received before given date time
|
1288
1354
|
# @return [Array<(PageEmailProjection, Integer, Hash)>] PageEmailProjection data, response status code and response headers
|
1289
1355
|
def get_organization_emails_paginated_with_http_info(opts = {})
|
1290
1356
|
if @api_client.config.debugging
|
1291
1357
|
@api_client.config.logger.debug 'Calling API: EmailControllerApi.get_organization_emails_paginated ...'
|
1292
1358
|
end
|
1359
|
+
if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] > 100
|
1360
|
+
fail ArgumentError, 'invalid value for "opts[:"size"]" when calling EmailControllerApi.get_organization_emails_paginated, must be smaller than or equal to 100.'
|
1361
|
+
end
|
1362
|
+
|
1293
1363
|
allowable_values = ["ASC", "DESC"]
|
1294
1364
|
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
1295
1365
|
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
@@ -1299,19 +1369,19 @@ module MailSlurpClient
|
|
1299
1369
|
|
1300
1370
|
# query parameters
|
1301
1371
|
query_params = opts[:query_params] || {}
|
1302
|
-
query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
|
1303
1372
|
query_params[:'inboxId'] = @api_client.build_collection_param(opts[:'inbox_id'], :multi) if !opts[:'inbox_id'].nil?
|
1304
1373
|
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
1305
|
-
query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
|
1306
|
-
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
1307
1374
|
query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
|
1308
1375
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
1309
1376
|
query_params[:'unreadOnly'] = opts[:'unread_only'] if !opts[:'unread_only'].nil?
|
1377
|
+
query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
|
1378
|
+
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
1379
|
+
query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
|
1310
1380
|
|
1311
1381
|
# header parameters
|
1312
1382
|
header_params = opts[:header_params] || {}
|
1313
1383
|
# HTTP header 'Accept' (if needed)
|
1314
|
-
header_params['Accept'] = @api_client.select_header_accept(['
|
1384
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
1315
1385
|
|
1316
1386
|
# form parameters
|
1317
1387
|
form_params = opts[:form_params] || {}
|
@@ -1435,7 +1505,7 @@ module MailSlurpClient
|
|
1435
1505
|
# header parameters
|
1436
1506
|
header_params = opts[:header_params] || {}
|
1437
1507
|
# HTTP header 'Accept' (if needed)
|
1438
|
-
header_params['Accept'] = @api_client.select_header_accept(['
|
1508
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
1439
1509
|
|
1440
1510
|
# form parameters
|
1441
1511
|
form_params = opts[:form_params] || {}
|
@@ -1491,7 +1561,7 @@ module MailSlurpClient
|
|
1491
1561
|
# header parameters
|
1492
1562
|
header_params = opts[:header_params] || {}
|
1493
1563
|
# HTTP header 'Accept' (if needed)
|
1494
|
-
header_params['Accept'] = @api_client.select_header_accept(['
|
1564
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
1495
1565
|
|
1496
1566
|
# form parameters
|
1497
1567
|
form_params = opts[:form_params] || {}
|
@@ -1523,7 +1593,7 @@ module MailSlurpClient
|
|
1523
1593
|
|
1524
1594
|
# Mark an email as read on unread
|
1525
1595
|
# Marks an email as read or unread. Pass boolean read flag to set value. This is useful if you want to read an email but keep it as unread
|
1526
|
-
# @param email_id [String]
|
1596
|
+
# @param email_id [String]
|
1527
1597
|
# @param [Hash] opts the optional parameters
|
1528
1598
|
# @option opts [Boolean] :read What value to assign to email read property. Default true. (default to true)
|
1529
1599
|
# @return [EmailPreview]
|
@@ -1534,7 +1604,7 @@ module MailSlurpClient
|
|
1534
1604
|
|
1535
1605
|
# Mark an email as read on unread
|
1536
1606
|
# Marks an email as read or unread. Pass boolean read flag to set value. This is useful if you want to read an email but keep it as unread
|
1537
|
-
# @param email_id [String]
|
1607
|
+
# @param email_id [String]
|
1538
1608
|
# @param [Hash] opts the optional parameters
|
1539
1609
|
# @option opts [Boolean] :read What value to assign to email read property. Default true.
|
1540
1610
|
# @return [Array<(EmailPreview, Integer, Hash)>] EmailPreview data, response status code and response headers
|
@@ -1556,7 +1626,7 @@ module MailSlurpClient
|
|
1556
1626
|
# header parameters
|
1557
1627
|
header_params = opts[:header_params] || {}
|
1558
1628
|
# HTTP header 'Accept' (if needed)
|
1559
|
-
header_params['Accept'] = @api_client.select_header_accept(['
|
1629
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
1560
1630
|
|
1561
1631
|
# form parameters
|
1562
1632
|
form_params = opts[:form_params] || {}
|
@@ -1589,7 +1659,7 @@ module MailSlurpClient
|
|
1589
1659
|
# Reply to an email
|
1590
1660
|
# Send the reply to the email sender or reply-to and include same subject cc bcc etc. Reply to an email and the contents will be sent with the existing subject to the emails `to`, `cc`, and `bcc`.
|
1591
1661
|
# @param email_id [String] ID of the email that should be replied to
|
1592
|
-
# @param reply_to_email_options [ReplyToEmailOptions]
|
1662
|
+
# @param reply_to_email_options [ReplyToEmailOptions]
|
1593
1663
|
# @param [Hash] opts the optional parameters
|
1594
1664
|
# @return [SentEmailDto]
|
1595
1665
|
def reply_to_email(email_id, reply_to_email_options, opts = {})
|
@@ -1600,7 +1670,7 @@ module MailSlurpClient
|
|
1600
1670
|
# Reply to an email
|
1601
1671
|
# Send the reply to the email sender or reply-to and include same subject cc bcc etc. Reply to an email and the contents will be sent with the existing subject to the emails `to`, `cc`, and `bcc`.
|
1602
1672
|
# @param email_id [String] ID of the email that should be replied to
|
1603
|
-
# @param reply_to_email_options [ReplyToEmailOptions]
|
1673
|
+
# @param reply_to_email_options [ReplyToEmailOptions]
|
1604
1674
|
# @param [Hash] opts the optional parameters
|
1605
1675
|
# @return [Array<(SentEmailDto, Integer, Hash)>] SentEmailDto data, response status code and response headers
|
1606
1676
|
def reply_to_email_with_http_info(email_id, reply_to_email_options, opts = {})
|
@@ -1624,7 +1694,7 @@ module MailSlurpClient
|
|
1624
1694
|
# header parameters
|
1625
1695
|
header_params = opts[:header_params] || {}
|
1626
1696
|
# HTTP header 'Accept' (if needed)
|
1627
|
-
header_params['Accept'] = @api_client.select_header_accept(['
|
1697
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
1628
1698
|
# HTTP header 'Content-Type'
|
1629
1699
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1630
1700
|
|
@@ -1658,27 +1728,31 @@ module MailSlurpClient
|
|
1658
1728
|
|
1659
1729
|
# Send email
|
1660
1730
|
# Alias for `InboxController.sendEmail` method - see original method for full details. Sends an email from a given inbox that you have created. If no inbox is supplied a random inbox will be created for you and used to send the email.
|
1731
|
+
# @param send_email_options [SendEmailOptions]
|
1661
1732
|
# @param [Hash] opts the optional parameters
|
1662
1733
|
# @option opts [String] :inbox_id ID of the inbox you want to send the email from
|
1663
1734
|
# @option opts [Boolean] :use_domain_pool Use domain pool. Optionally create inbox to send from using the mailslurp domain pool.
|
1664
|
-
# @option opts [SendEmailOptions] :send_email_options Options for the email
|
1665
1735
|
# @return [nil]
|
1666
|
-
def send_email_source_optional(opts = {})
|
1667
|
-
send_email_source_optional_with_http_info(opts)
|
1736
|
+
def send_email_source_optional(send_email_options, opts = {})
|
1737
|
+
send_email_source_optional_with_http_info(send_email_options, opts)
|
1668
1738
|
nil
|
1669
1739
|
end
|
1670
1740
|
|
1671
1741
|
# Send email
|
1672
1742
|
# Alias for `InboxController.sendEmail` method - see original method for full details. Sends an email from a given inbox that you have created. If no inbox is supplied a random inbox will be created for you and used to send the email.
|
1743
|
+
# @param send_email_options [SendEmailOptions]
|
1673
1744
|
# @param [Hash] opts the optional parameters
|
1674
1745
|
# @option opts [String] :inbox_id ID of the inbox you want to send the email from
|
1675
1746
|
# @option opts [Boolean] :use_domain_pool Use domain pool. Optionally create inbox to send from using the mailslurp domain pool.
|
1676
|
-
# @option opts [SendEmailOptions] :send_email_options Options for the email
|
1677
1747
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
1678
|
-
def send_email_source_optional_with_http_info(opts = {})
|
1748
|
+
def send_email_source_optional_with_http_info(send_email_options, opts = {})
|
1679
1749
|
if @api_client.config.debugging
|
1680
1750
|
@api_client.config.logger.debug 'Calling API: EmailControllerApi.send_email_source_optional ...'
|
1681
1751
|
end
|
1752
|
+
# verify the required parameter 'send_email_options' is set
|
1753
|
+
if @api_client.config.client_side_validation && send_email_options.nil?
|
1754
|
+
fail ArgumentError, "Missing the required parameter 'send_email_options' when calling EmailControllerApi.send_email_source_optional"
|
1755
|
+
end
|
1682
1756
|
# resource path
|
1683
1757
|
local_var_path = '/emails'
|
1684
1758
|
|
@@ -1696,7 +1770,7 @@ module MailSlurpClient
|
|
1696
1770
|
form_params = opts[:form_params] || {}
|
1697
1771
|
|
1698
1772
|
# http body (model)
|
1699
|
-
post_body = opts[:body] || @api_client.object_to_http_body(
|
1773
|
+
post_body = opts[:body] || @api_client.object_to_http_body(send_email_options)
|
1700
1774
|
|
1701
1775
|
# return_type
|
1702
1776
|
return_type = opts[:return_type]
|
@@ -1752,7 +1826,7 @@ module MailSlurpClient
|
|
1752
1826
|
# header parameters
|
1753
1827
|
header_params = opts[:header_params] || {}
|
1754
1828
|
# HTTP header 'Accept' (if needed)
|
1755
|
-
header_params['Accept'] = @api_client.select_header_accept(['
|
1829
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
1756
1830
|
|
1757
1831
|
# form parameters
|
1758
1832
|
form_params = opts[:form_params] || {}
|