mailslurp_client 12.8.2 → 13.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/mailslurp_client.rb +3 -0
- data/lib/mailslurp_client/api/attachment_controller_api.rb +117 -3
- data/lib/mailslurp_client/api/email_controller_api.rb +193 -2
- data/lib/mailslurp_client/api/inbox_controller_api.rb +6 -0
- data/lib/mailslurp_client/api/wait_for_controller_api.rb +67 -2
- data/lib/mailslurp_client/models/attachment_entity.rb +289 -0
- data/lib/mailslurp_client/models/email_links_result.rb +228 -0
- data/lib/mailslurp_client/models/gravatar_url.rb +225 -0
- data/lib/mailslurp_client/version.rb +1 -1
- metadata +5 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: aad53cc0f0d7d00f6b48444b0eb2029149f9af929e6b77db54af4006ec2f5d4f
|
4
|
+
data.tar.gz: c06e3dc8e6cf79ecdb89fc7c45ac4f25d4548e1c1234bdebd2c6a2068929474d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: fbfa50abc13034db45869b1bbd41ebf8d189eebb1b6264b3cd6718fa41a9af924b3965381d53baff68677ef04c2a41dc220a1e0fe2ea9b219d9a4bb1fda91ed4
|
7
|
+
data.tar.gz: 0b92e39df9d8855080159cf003f4692aae8897419063193fbba38963de5508881b467393944df85097d5fc8ccfb69ac523f30f71e0825fefdc12ab4bb7b8b581
|
data/lib/mailslurp_client.rb
CHANGED
@@ -20,6 +20,7 @@ require 'mailslurp_client/configuration'
|
|
20
20
|
require 'mailslurp_client/models/abstract_webhook_payload'
|
21
21
|
require 'mailslurp_client/models/alias_dto'
|
22
22
|
require 'mailslurp_client/models/alias_projection'
|
23
|
+
require 'mailslurp_client/models/attachment_entity'
|
23
24
|
require 'mailslurp_client/models/attachment_meta_data'
|
24
25
|
require 'mailslurp_client/models/attachment_projection'
|
25
26
|
require 'mailslurp_client/models/basic_auth_options'
|
@@ -54,6 +55,7 @@ require 'mailslurp_client/models/download_attachment_dto'
|
|
54
55
|
require 'mailslurp_client/models/email'
|
55
56
|
require 'mailslurp_client/models/email_analysis'
|
56
57
|
require 'mailslurp_client/models/email_content_match_result'
|
58
|
+
require 'mailslurp_client/models/email_links_result'
|
57
59
|
require 'mailslurp_client/models/email_preview'
|
58
60
|
require 'mailslurp_client/models/email_projection'
|
59
61
|
require 'mailslurp_client/models/email_text_lines_result'
|
@@ -64,6 +66,7 @@ require 'mailslurp_client/models/expired_inbox_record_projection'
|
|
64
66
|
require 'mailslurp_client/models/export_link'
|
65
67
|
require 'mailslurp_client/models/export_options'
|
66
68
|
require 'mailslurp_client/models/forward_email_options'
|
69
|
+
require 'mailslurp_client/models/gravatar_url'
|
67
70
|
require 'mailslurp_client/models/group_contacts_dto'
|
68
71
|
require 'mailslurp_client/models/group_dto'
|
69
72
|
require 'mailslurp_client/models/group_projection'
|
@@ -19,6 +19,58 @@ module MailSlurpClient
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
+
# Delete all attachments
|
23
|
+
# @param [Hash] opts the optional parameters
|
24
|
+
# @return [nil]
|
25
|
+
def delete_all_attachments(opts = {})
|
26
|
+
delete_all_attachments_with_http_info(opts)
|
27
|
+
nil
|
28
|
+
end
|
29
|
+
|
30
|
+
# Delete all attachments
|
31
|
+
# @param [Hash] opts the optional parameters
|
32
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
33
|
+
def delete_all_attachments_with_http_info(opts = {})
|
34
|
+
if @api_client.config.debugging
|
35
|
+
@api_client.config.logger.debug 'Calling API: AttachmentControllerApi.delete_all_attachments ...'
|
36
|
+
end
|
37
|
+
# resource path
|
38
|
+
local_var_path = '/attachments'
|
39
|
+
|
40
|
+
# query parameters
|
41
|
+
query_params = opts[:query_params] || {}
|
42
|
+
|
43
|
+
# header parameters
|
44
|
+
header_params = opts[:header_params] || {}
|
45
|
+
|
46
|
+
# form parameters
|
47
|
+
form_params = opts[:form_params] || {}
|
48
|
+
|
49
|
+
# http body (model)
|
50
|
+
post_body = opts[:body]
|
51
|
+
|
52
|
+
# return_type
|
53
|
+
return_type = opts[:return_type]
|
54
|
+
|
55
|
+
# auth_names
|
56
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
57
|
+
|
58
|
+
new_options = opts.merge(
|
59
|
+
:header_params => header_params,
|
60
|
+
:query_params => query_params,
|
61
|
+
:form_params => form_params,
|
62
|
+
:body => post_body,
|
63
|
+
:auth_names => auth_names,
|
64
|
+
:return_type => return_type
|
65
|
+
)
|
66
|
+
|
67
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
68
|
+
if @api_client.config.debugging
|
69
|
+
@api_client.config.logger.debug "API called: AttachmentControllerApi#delete_all_attachments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
70
|
+
end
|
71
|
+
return data, status_code, headers
|
72
|
+
end
|
73
|
+
|
22
74
|
# Delete an attachment
|
23
75
|
# Email attachments are essentially files with meta data. Files are byte arrays and the meta data is a content type and a filename. These properties allow email clients to display the filename and icon etc. When sending emails with attachments first upload each attachment with an upload endpoint. Record the returned attachment ID and use it with subsequent email sending. For legacy reasons the ID is returned as the first element in an array. Only a single ID is ever returned. To send the attachments pass a list of attachment IDs with `SendEmailOptions` when sending an email. Using the upload endpoints prior to sending mean attachments can easily be reused.
|
24
76
|
# @param attachment_id [String] ID of attachment
|
@@ -203,6 +255,68 @@ module MailSlurpClient
|
|
203
255
|
return data, status_code, headers
|
204
256
|
end
|
205
257
|
|
258
|
+
# Get an attachment entity
|
259
|
+
# Email attachments are essentially files with meta data. Files are byte arrays and the meta data is a content type and a filename. These properties allow email clients to display the filename and icon etc. When sending emails with attachments first upload each attachment with an upload endpoint. Record the returned attachment ID and use it with subsequent email sending. For legacy reasons the ID is returned as the first element in an array. Only a single ID is ever returned. To send the attachments pass a list of attachment IDs with `SendEmailOptions` when sending an email. Using the upload endpoints prior to sending mean attachments can easily be reused.
|
260
|
+
# @param attachment_id [String] ID of attachment
|
261
|
+
# @param [Hash] opts the optional parameters
|
262
|
+
# @return [AttachmentEntity]
|
263
|
+
def get_attachment(attachment_id, opts = {})
|
264
|
+
data, _status_code, _headers = get_attachment_with_http_info(attachment_id, opts)
|
265
|
+
data
|
266
|
+
end
|
267
|
+
|
268
|
+
# Get an attachment entity
|
269
|
+
# Email attachments are essentially files with meta data. Files are byte arrays and the meta data is a content type and a filename. These properties allow email clients to display the filename and icon etc. When sending emails with attachments first upload each attachment with an upload endpoint. Record the returned attachment ID and use it with subsequent email sending. For legacy reasons the ID is returned as the first element in an array. Only a single ID is ever returned. To send the attachments pass a list of attachment IDs with `SendEmailOptions` when sending an email. Using the upload endpoints prior to sending mean attachments can easily be reused.
|
270
|
+
# @param attachment_id [String] ID of attachment
|
271
|
+
# @param [Hash] opts the optional parameters
|
272
|
+
# @return [Array<(AttachmentEntity, Integer, Hash)>] AttachmentEntity data, response status code and response headers
|
273
|
+
def get_attachment_with_http_info(attachment_id, opts = {})
|
274
|
+
if @api_client.config.debugging
|
275
|
+
@api_client.config.logger.debug 'Calling API: AttachmentControllerApi.get_attachment ...'
|
276
|
+
end
|
277
|
+
# verify the required parameter 'attachment_id' is set
|
278
|
+
if @api_client.config.client_side_validation && attachment_id.nil?
|
279
|
+
fail ArgumentError, "Missing the required parameter 'attachment_id' when calling AttachmentControllerApi.get_attachment"
|
280
|
+
end
|
281
|
+
# resource path
|
282
|
+
local_var_path = '/attachments/{attachmentId}'.sub('{' + 'attachmentId' + '}', CGI.escape(attachment_id.to_s))
|
283
|
+
|
284
|
+
# query parameters
|
285
|
+
query_params = opts[:query_params] || {}
|
286
|
+
|
287
|
+
# header parameters
|
288
|
+
header_params = opts[:header_params] || {}
|
289
|
+
# HTTP header 'Accept' (if needed)
|
290
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
291
|
+
|
292
|
+
# form parameters
|
293
|
+
form_params = opts[:form_params] || {}
|
294
|
+
|
295
|
+
# http body (model)
|
296
|
+
post_body = opts[:body]
|
297
|
+
|
298
|
+
# return_type
|
299
|
+
return_type = opts[:return_type] || 'AttachmentEntity'
|
300
|
+
|
301
|
+
# auth_names
|
302
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
303
|
+
|
304
|
+
new_options = opts.merge(
|
305
|
+
:header_params => header_params,
|
306
|
+
:query_params => query_params,
|
307
|
+
:form_params => form_params,
|
308
|
+
:body => post_body,
|
309
|
+
:auth_names => auth_names,
|
310
|
+
:return_type => return_type
|
311
|
+
)
|
312
|
+
|
313
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
314
|
+
if @api_client.config.debugging
|
315
|
+
@api_client.config.logger.debug "API called: AttachmentControllerApi#get_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
316
|
+
end
|
317
|
+
return data, status_code, headers
|
318
|
+
end
|
319
|
+
|
206
320
|
# Get email attachment metadata information
|
207
321
|
# Returns the metadata for an attachment. It is saved separately to the content of the attachment. Contains properties `name` and `content-type` and `content-length` in bytes for a given attachment.
|
208
322
|
# @param attachment_id [String] ID of attachment
|
@@ -404,7 +518,7 @@ module MailSlurpClient
|
|
404
518
|
# Upload an attachment for sending using file byte stream input octet stream. Returns an array whose first element is the ID of the uploaded attachment.
|
405
519
|
# Email attachments are essentially files with meta data. Files are byte arrays and the meta data is a content type and a filename. These properties allow email clients to display the filename and icon etc. When sending emails with attachments first upload each attachment with an upload endpoint. Record the returned attachment ID and use it with subsequent email sending. For legacy reasons the ID is returned as the first element in an array. Only a single ID is ever returned. To send the attachments pass a list of attachment IDs with `SendEmailOptions` when sending an email. Using the upload endpoints prior to sending mean attachments can easily be reused.
|
406
520
|
# @param [Hash] opts the optional parameters
|
407
|
-
# @option opts [String] :
|
521
|
+
# @option opts [String] :content_type Optional contentType for file. For instance `application/pdf`
|
408
522
|
# @option opts [String] :filename Optional filename to save upload with
|
409
523
|
# @option opts [String] :byte_array Byte array request body
|
410
524
|
# @return [Array<String>]
|
@@ -416,7 +530,7 @@ module MailSlurpClient
|
|
416
530
|
# Upload an attachment for sending using file byte stream input octet stream. Returns an array whose first element is the ID of the uploaded attachment.
|
417
531
|
# Email attachments are essentially files with meta data. Files are byte arrays and the meta data is a content type and a filename. These properties allow email clients to display the filename and icon etc. When sending emails with attachments first upload each attachment with an upload endpoint. Record the returned attachment ID and use it with subsequent email sending. For legacy reasons the ID is returned as the first element in an array. Only a single ID is ever returned. To send the attachments pass a list of attachment IDs with `SendEmailOptions` when sending an email. Using the upload endpoints prior to sending mean attachments can easily be reused.
|
418
532
|
# @param [Hash] opts the optional parameters
|
419
|
-
# @option opts [String] :
|
533
|
+
# @option opts [String] :content_type Optional contentType for file. For instance `application/pdf`
|
420
534
|
# @option opts [String] :filename Optional filename to save upload with
|
421
535
|
# @option opts [String] :byte_array Byte array request body
|
422
536
|
# @return [Array<(Array<String>, Integer, Hash)>] Array<String> data, response status code and response headers
|
@@ -429,7 +543,7 @@ module MailSlurpClient
|
|
429
543
|
|
430
544
|
# query parameters
|
431
545
|
query_params = opts[:query_params] || {}
|
432
|
-
query_params[:'
|
546
|
+
query_params[:'contentType'] = opts[:'content_type'] if !opts[:'content_type'].nil?
|
433
547
|
query_params[:'filename'] = opts[:'filename'] if !opts[:'filename'].nil?
|
434
548
|
|
435
549
|
# header parameters
|
@@ -861,6 +861,68 @@ module MailSlurpClient
|
|
861
861
|
return data, status_code, headers
|
862
862
|
end
|
863
863
|
|
864
|
+
# Parse and return list of links found in an email (only works for HTML content)
|
865
|
+
# HTML parsing uses JSoup and UNIX line separators. Searches content for href attributes
|
866
|
+
# @param email_id [String] ID of email to fetch text for
|
867
|
+
# @param [Hash] opts the optional parameters
|
868
|
+
# @return [EmailLinksResult]
|
869
|
+
def get_email_links(email_id, opts = {})
|
870
|
+
data, _status_code, _headers = get_email_links_with_http_info(email_id, opts)
|
871
|
+
data
|
872
|
+
end
|
873
|
+
|
874
|
+
# Parse and return list of links found in an email (only works for HTML content)
|
875
|
+
# HTML parsing uses JSoup and UNIX line separators. Searches content for href attributes
|
876
|
+
# @param email_id [String] ID of email to fetch text for
|
877
|
+
# @param [Hash] opts the optional parameters
|
878
|
+
# @return [Array<(EmailLinksResult, Integer, Hash)>] EmailLinksResult data, response status code and response headers
|
879
|
+
def get_email_links_with_http_info(email_id, opts = {})
|
880
|
+
if @api_client.config.debugging
|
881
|
+
@api_client.config.logger.debug 'Calling API: EmailControllerApi.get_email_links ...'
|
882
|
+
end
|
883
|
+
# verify the required parameter 'email_id' is set
|
884
|
+
if @api_client.config.client_side_validation && email_id.nil?
|
885
|
+
fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.get_email_links"
|
886
|
+
end
|
887
|
+
# resource path
|
888
|
+
local_var_path = '/emails/{emailId}/links'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))
|
889
|
+
|
890
|
+
# query parameters
|
891
|
+
query_params = opts[:query_params] || {}
|
892
|
+
|
893
|
+
# header parameters
|
894
|
+
header_params = opts[:header_params] || {}
|
895
|
+
# HTTP header 'Accept' (if needed)
|
896
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
897
|
+
|
898
|
+
# form parameters
|
899
|
+
form_params = opts[:form_params] || {}
|
900
|
+
|
901
|
+
# http body (model)
|
902
|
+
post_body = opts[:body]
|
903
|
+
|
904
|
+
# return_type
|
905
|
+
return_type = opts[:return_type] || 'EmailLinksResult'
|
906
|
+
|
907
|
+
# auth_names
|
908
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
909
|
+
|
910
|
+
new_options = opts.merge(
|
911
|
+
:header_params => header_params,
|
912
|
+
:query_params => query_params,
|
913
|
+
:form_params => form_params,
|
914
|
+
:body => post_body,
|
915
|
+
:auth_names => auth_names,
|
916
|
+
:return_type => return_type
|
917
|
+
)
|
918
|
+
|
919
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
920
|
+
if @api_client.config.debugging
|
921
|
+
@api_client.config.logger.debug "API called: EmailControllerApi#get_email_links\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
922
|
+
end
|
923
|
+
return data, status_code, headers
|
924
|
+
end
|
925
|
+
|
864
926
|
# Parse and return text from an email, stripping HTML and decoding encoded characters
|
865
927
|
# Parse an email body and return the content as an array of strings. HTML parsing uses JSoup and UNIX line separators.
|
866
928
|
# @param email_id [String] ID of email to fetch text for
|
@@ -1007,10 +1069,74 @@ module MailSlurpClient
|
|
1007
1069
|
return data, status_code, headers
|
1008
1070
|
end
|
1009
1071
|
|
1072
|
+
# Get gravatar url for email address
|
1073
|
+
# @param email_address [String] emailAddress
|
1074
|
+
# @param [Hash] opts the optional parameters
|
1075
|
+
# @option opts [String] :size size
|
1076
|
+
# @return [GravatarUrl]
|
1077
|
+
def get_gravatar_url_for_email_address(email_address, opts = {})
|
1078
|
+
data, _status_code, _headers = get_gravatar_url_for_email_address_with_http_info(email_address, opts)
|
1079
|
+
data
|
1080
|
+
end
|
1081
|
+
|
1082
|
+
# Get gravatar url for email address
|
1083
|
+
# @param email_address [String] emailAddress
|
1084
|
+
# @param [Hash] opts the optional parameters
|
1085
|
+
# @option opts [String] :size size
|
1086
|
+
# @return [Array<(GravatarUrl, Integer, Hash)>] GravatarUrl data, response status code and response headers
|
1087
|
+
def get_gravatar_url_for_email_address_with_http_info(email_address, opts = {})
|
1088
|
+
if @api_client.config.debugging
|
1089
|
+
@api_client.config.logger.debug 'Calling API: EmailControllerApi.get_gravatar_url_for_email_address ...'
|
1090
|
+
end
|
1091
|
+
# verify the required parameter 'email_address' is set
|
1092
|
+
if @api_client.config.client_side_validation && email_address.nil?
|
1093
|
+
fail ArgumentError, "Missing the required parameter 'email_address' when calling EmailControllerApi.get_gravatar_url_for_email_address"
|
1094
|
+
end
|
1095
|
+
# resource path
|
1096
|
+
local_var_path = '/emails/gravatarFor'
|
1097
|
+
|
1098
|
+
# query parameters
|
1099
|
+
query_params = opts[:query_params] || {}
|
1100
|
+
query_params[:'emailAddress'] = email_address
|
1101
|
+
query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
|
1102
|
+
|
1103
|
+
# header parameters
|
1104
|
+
header_params = opts[:header_params] || {}
|
1105
|
+
# HTTP header 'Accept' (if needed)
|
1106
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1107
|
+
|
1108
|
+
# form parameters
|
1109
|
+
form_params = opts[:form_params] || {}
|
1110
|
+
|
1111
|
+
# http body (model)
|
1112
|
+
post_body = opts[:body]
|
1113
|
+
|
1114
|
+
# return_type
|
1115
|
+
return_type = opts[:return_type] || 'GravatarUrl'
|
1116
|
+
|
1117
|
+
# auth_names
|
1118
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
1119
|
+
|
1120
|
+
new_options = opts.merge(
|
1121
|
+
:header_params => header_params,
|
1122
|
+
:query_params => query_params,
|
1123
|
+
:form_params => form_params,
|
1124
|
+
:body => post_body,
|
1125
|
+
:auth_names => auth_names,
|
1126
|
+
:return_type => return_type
|
1127
|
+
)
|
1128
|
+
|
1129
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1130
|
+
if @api_client.config.debugging
|
1131
|
+
@api_client.config.logger.debug "API called: EmailControllerApi#get_gravatar_url_for_email_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1132
|
+
end
|
1133
|
+
return data, status_code, headers
|
1134
|
+
end
|
1135
|
+
|
1010
1136
|
# Get latest email in all inboxes. Most recently received.
|
1011
1137
|
# Get the newest email in all inboxes or in a passed set of inbox IDs
|
1012
1138
|
# @param [Hash] opts the optional parameters
|
1013
|
-
# @option opts [Array<String>] :inbox_ids Optional set of inboxes to filter by. Only get the latest email from these inbox IDs
|
1139
|
+
# @option opts [Array<String>] :inbox_ids Optional set of inboxes to filter by. Only get the latest email from these inbox IDs. If not provided will search across all inboxes
|
1014
1140
|
# @return [Email]
|
1015
1141
|
def get_latest_email(opts = {})
|
1016
1142
|
data, _status_code, _headers = get_latest_email_with_http_info(opts)
|
@@ -1020,7 +1146,7 @@ module MailSlurpClient
|
|
1020
1146
|
# Get latest email in all inboxes. Most recently received.
|
1021
1147
|
# Get the newest email in all inboxes or in a passed set of inbox IDs
|
1022
1148
|
# @param [Hash] opts the optional parameters
|
1023
|
-
# @option opts [Array<String>] :inbox_ids Optional set of inboxes to filter by. Only get the latest email from these inbox IDs
|
1149
|
+
# @option opts [Array<String>] :inbox_ids Optional set of inboxes to filter by. Only get the latest email from these inbox IDs. If not provided will search across all inboxes
|
1024
1150
|
# @return [Array<(Email, Integer, Hash)>] Email data, response status code and response headers
|
1025
1151
|
def get_latest_email_with_http_info(opts = {})
|
1026
1152
|
if @api_client.config.debugging
|
@@ -1383,6 +1509,71 @@ module MailSlurpClient
|
|
1383
1509
|
return data, status_code, headers
|
1384
1510
|
end
|
1385
1511
|
|
1512
|
+
# Mark an email as read
|
1513
|
+
# Marks an email as read or unread. Pass boolean read flag to set value.
|
1514
|
+
# @param email_id [String] emailId
|
1515
|
+
# @param [Hash] opts the optional parameters
|
1516
|
+
# @option opts [Boolean] :read What value to assign to email read property. Default true. (default to true)
|
1517
|
+
# @return [EmailPreview]
|
1518
|
+
def mark_as_read(email_id, opts = {})
|
1519
|
+
data, _status_code, _headers = mark_as_read_with_http_info(email_id, opts)
|
1520
|
+
data
|
1521
|
+
end
|
1522
|
+
|
1523
|
+
# Mark an email as read
|
1524
|
+
# Marks an email as read or unread. Pass boolean read flag to set value.
|
1525
|
+
# @param email_id [String] emailId
|
1526
|
+
# @param [Hash] opts the optional parameters
|
1527
|
+
# @option opts [Boolean] :read What value to assign to email read property. Default true.
|
1528
|
+
# @return [Array<(EmailPreview, Integer, Hash)>] EmailPreview data, response status code and response headers
|
1529
|
+
def mark_as_read_with_http_info(email_id, opts = {})
|
1530
|
+
if @api_client.config.debugging
|
1531
|
+
@api_client.config.logger.debug 'Calling API: EmailControllerApi.mark_as_read ...'
|
1532
|
+
end
|
1533
|
+
# verify the required parameter 'email_id' is set
|
1534
|
+
if @api_client.config.client_side_validation && email_id.nil?
|
1535
|
+
fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.mark_as_read"
|
1536
|
+
end
|
1537
|
+
# resource path
|
1538
|
+
local_var_path = '/emails/{emailId}/read'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))
|
1539
|
+
|
1540
|
+
# query parameters
|
1541
|
+
query_params = opts[:query_params] || {}
|
1542
|
+
query_params[:'read'] = opts[:'read'] if !opts[:'read'].nil?
|
1543
|
+
|
1544
|
+
# header parameters
|
1545
|
+
header_params = opts[:header_params] || {}
|
1546
|
+
# HTTP header 'Accept' (if needed)
|
1547
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1548
|
+
|
1549
|
+
# form parameters
|
1550
|
+
form_params = opts[:form_params] || {}
|
1551
|
+
|
1552
|
+
# http body (model)
|
1553
|
+
post_body = opts[:body]
|
1554
|
+
|
1555
|
+
# return_type
|
1556
|
+
return_type = opts[:return_type] || 'EmailPreview'
|
1557
|
+
|
1558
|
+
# auth_names
|
1559
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
1560
|
+
|
1561
|
+
new_options = opts.merge(
|
1562
|
+
:header_params => header_params,
|
1563
|
+
:query_params => query_params,
|
1564
|
+
:form_params => form_params,
|
1565
|
+
:body => post_body,
|
1566
|
+
:auth_names => auth_names,
|
1567
|
+
:return_type => return_type
|
1568
|
+
)
|
1569
|
+
|
1570
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
|
1571
|
+
if @api_client.config.debugging
|
1572
|
+
@api_client.config.logger.debug "API called: EmailControllerApi#mark_as_read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1573
|
+
end
|
1574
|
+
return data, status_code, headers
|
1575
|
+
end
|
1576
|
+
|
1386
1577
|
# Reply to an email
|
1387
1578
|
# 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`.
|
1388
1579
|
# @param email_id [String] ID of the email that should be replied to
|
@@ -496,12 +496,14 @@ module MailSlurpClient
|
|
496
496
|
# List emails that an inbox has received. Only emails that are sent to the inbox's email address will appear in the inbox. It may take several seconds for any email you send to an inbox's email address to appear in the inbox. To make this endpoint wait for a minimum number of emails use the `minCount` parameter. The server will retry the inbox database until the `minCount` is satisfied or the `retryTimeout` is reached
|
497
497
|
# @param inbox_id [String] Id of inbox that emails belongs to
|
498
498
|
# @param [Hash] opts the optional parameters
|
499
|
+
# @option opts [Integer] :delay_timeout delayTimeout
|
499
500
|
# @option opts [Integer] :limit Limit the result set, ordered by received date time sort direction. Maximum 100. For more listing options see the email controller
|
500
501
|
# @option opts [Integer] :min_count Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached.
|
501
502
|
# @option opts [Integer] :retry_timeout Maximum milliseconds to spend retrying inbox database until minCount emails are returned
|
502
503
|
# @option opts [DateTime] :since Exclude emails received before this ISO 8601 date time
|
503
504
|
# @option opts [Integer] :size Alias for limit. Assessed first before assessing any passed limit.
|
504
505
|
# @option opts [String] :sort Sort the results by received date and direction ASC or DESC
|
506
|
+
# @option opts [Boolean] :unread_only unreadOnly
|
505
507
|
# @return [Array<EmailPreview>]
|
506
508
|
def get_emails(inbox_id, opts = {})
|
507
509
|
data, _status_code, _headers = get_emails_with_http_info(inbox_id, opts)
|
@@ -512,12 +514,14 @@ module MailSlurpClient
|
|
512
514
|
# List emails that an inbox has received. Only emails that are sent to the inbox's email address will appear in the inbox. It may take several seconds for any email you send to an inbox's email address to appear in the inbox. To make this endpoint wait for a minimum number of emails use the `minCount` parameter. The server will retry the inbox database until the `minCount` is satisfied or the `retryTimeout` is reached
|
513
515
|
# @param inbox_id [String] Id of inbox that emails belongs to
|
514
516
|
# @param [Hash] opts the optional parameters
|
517
|
+
# @option opts [Integer] :delay_timeout delayTimeout
|
515
518
|
# @option opts [Integer] :limit Limit the result set, ordered by received date time sort direction. Maximum 100. For more listing options see the email controller
|
516
519
|
# @option opts [Integer] :min_count Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached.
|
517
520
|
# @option opts [Integer] :retry_timeout Maximum milliseconds to spend retrying inbox database until minCount emails are returned
|
518
521
|
# @option opts [DateTime] :since Exclude emails received before this ISO 8601 date time
|
519
522
|
# @option opts [Integer] :size Alias for limit. Assessed first before assessing any passed limit.
|
520
523
|
# @option opts [String] :sort Sort the results by received date and direction ASC or DESC
|
524
|
+
# @option opts [Boolean] :unread_only unreadOnly
|
521
525
|
# @return [Array<(Array<EmailPreview>, Integer, Hash)>] Array<EmailPreview> data, response status code and response headers
|
522
526
|
def get_emails_with_http_info(inbox_id, opts = {})
|
523
527
|
if @api_client.config.debugging
|
@@ -536,12 +540,14 @@ module MailSlurpClient
|
|
536
540
|
|
537
541
|
# query parameters
|
538
542
|
query_params = opts[:query_params] || {}
|
543
|
+
query_params[:'delayTimeout'] = opts[:'delay_timeout'] if !opts[:'delay_timeout'].nil?
|
539
544
|
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
540
545
|
query_params[:'minCount'] = opts[:'min_count'] if !opts[:'min_count'].nil?
|
541
546
|
query_params[:'retryTimeout'] = opts[:'retry_timeout'] if !opts[:'retry_timeout'].nil?
|
542
547
|
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
543
548
|
query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
|
544
549
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
550
|
+
query_params[:'unreadOnly'] = opts[:'unread_only'] if !opts[:'unread_only'].nil?
|
545
551
|
|
546
552
|
# header parameters
|
547
553
|
header_params = opts[:header_params] || {}
|