mailslurp_client 15.19.12 → 15.19.14
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/mailslurp_client/api/email_controller_api.rb +68 -2
- data/lib/mailslurp_client/api/inbox_controller_api.rb +182 -2
- data/lib/mailslurp_client/models/alias_projection.rb +15 -15
- data/lib/mailslurp_client/models/connector_projection.rb +15 -15
- data/lib/mailslurp_client/models/create_domain_options.rb +1 -1
- data/lib/mailslurp_client/models/email_projection.rb +10 -10
- data/lib/mailslurp_client/models/expired_inbox_record_projection.rb +15 -15
- data/lib/mailslurp_client/models/imap_access_details.rb +61 -1
- data/lib/mailslurp_client/models/imap_smtp_access_details.rb +61 -1
- data/lib/mailslurp_client/models/imap_smtp_access_servers.rb +254 -0
- data/lib/mailslurp_client/models/inbox_dto.rb +1 -1
- data/lib/mailslurp_client/models/inbox_forwarder_event_projection.rb +11 -11
- data/lib/mailslurp_client/models/inbox_replier_event_projection.rb +11 -11
- data/lib/mailslurp_client/models/page_alias.rb +10 -10
- data/lib/mailslurp_client/models/page_attachment_entity.rb +10 -10
- data/lib/mailslurp_client/models/page_bounced_email.rb +10 -10
- data/lib/mailslurp_client/models/page_bounced_recipients.rb +10 -10
- data/lib/mailslurp_client/models/page_complaint.rb +10 -10
- data/lib/mailslurp_client/models/page_connector.rb +10 -10
- data/lib/mailslurp_client/models/page_connector_sync_events.rb +10 -10
- data/lib/mailslurp_client/models/page_contact_projection.rb +10 -10
- data/lib/mailslurp_client/models/page_delivery_status.rb +10 -10
- data/lib/mailslurp_client/models/page_email_preview.rb +10 -10
- data/lib/mailslurp_client/models/page_email_projection.rb +10 -10
- data/lib/mailslurp_client/models/page_email_validation_request.rb +10 -10
- data/lib/mailslurp_client/models/page_expired_inbox_record_projection.rb +10 -10
- data/lib/mailslurp_client/models/page_group_projection.rb +10 -10
- data/lib/mailslurp_client/models/page_inbox_forwarder_dto.rb +10 -10
- data/lib/mailslurp_client/models/page_inbox_forwarder_events.rb +10 -10
- data/lib/mailslurp_client/models/page_inbox_projection.rb +10 -10
- data/lib/mailslurp_client/models/page_inbox_replier_dto.rb +10 -10
- data/lib/mailslurp_client/models/page_inbox_replier_events.rb +10 -10
- data/lib/mailslurp_client/models/page_inbox_ruleset_dto.rb +10 -10
- data/lib/mailslurp_client/models/page_list_unsubscribe_recipients.rb +10 -10
- data/lib/mailslurp_client/models/page_missed_email_projection.rb +10 -10
- data/lib/mailslurp_client/models/page_organization_inbox_projection.rb +10 -10
- data/lib/mailslurp_client/models/page_phone_number_projection.rb +10 -10
- data/lib/mailslurp_client/models/page_scheduled_jobs.rb +10 -10
- data/lib/mailslurp_client/models/page_sent_email_projection.rb +10 -10
- data/lib/mailslurp_client/models/page_sent_email_with_queue_projection.rb +10 -10
- data/lib/mailslurp_client/models/page_sms_projection.rb +10 -10
- data/lib/mailslurp_client/models/page_template_projection.rb +10 -10
- data/lib/mailslurp_client/models/page_thread_projection.rb +10 -10
- data/lib/mailslurp_client/models/page_tracking_pixel_projection.rb +10 -10
- data/lib/mailslurp_client/models/page_unknown_missed_email_projection.rb +10 -10
- data/lib/mailslurp_client/models/page_webhook_projection.rb +10 -10
- data/lib/mailslurp_client/models/page_webhook_result.rb +10 -10
- data/lib/mailslurp_client/models/pageable_object.rb +10 -10
- data/lib/mailslurp_client/models/sent_email_projection.rb +21 -21
- data/lib/mailslurp_client/models/server_endpoints.rb +255 -0
- data/lib/mailslurp_client/models/thread_projection.rb +16 -16
- data/lib/mailslurp_client/models/tracking_pixel_projection.rb +10 -10
- data/lib/mailslurp_client/models/update_imap_access_options.rb +220 -0
- data/lib/mailslurp_client/models/update_smtp_access_options.rb +220 -0
- data/lib/mailslurp_client/version.rb +1 -1
- data/lib/mailslurp_client.rb +4 -0
- metadata +6 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 3d308f331b7a60071e6d9d894d84ab9b1b27cd7d8375b33caf305b0a4706996f
|
4
|
+
data.tar.gz: b4fe095d7017bc981091bdb80da093beffa8b436e6360a28784f33db20189fd3
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 0aef479c3bdc376602d786dd04fc1ea876b81da11b83f54ec860bdf394b20e15ec671404489c43e097a8f7d9e20ee0240da080e026bf5de231969e99811acfaf
|
7
|
+
data.tar.gz: 7c8e178a51779ae0c38378959ea966bb63d026b0a6d953bdc96da572305bb4bfaeb5f46bc143273b28388ba6a71cf96073235970872322e4ec893c8e3649c45c
|
@@ -1131,6 +1131,7 @@ module MailSlurpClient
|
|
1131
1131
|
|
1132
1132
|
# Get email count
|
1133
1133
|
# @param [Hash] opts the optional parameters
|
1134
|
+
# @option opts [String] :inbox_id
|
1134
1135
|
# @return [CountDto]
|
1135
1136
|
def get_email_count(opts = {})
|
1136
1137
|
data, _status_code, _headers = get_email_count_with_http_info(opts)
|
@@ -1139,6 +1140,7 @@ module MailSlurpClient
|
|
1139
1140
|
|
1140
1141
|
# Get email count
|
1141
1142
|
# @param [Hash] opts the optional parameters
|
1143
|
+
# @option opts [String] :inbox_id
|
1142
1144
|
# @return [Array<(CountDto, Integer, Hash)>] CountDto data, response status code and response headers
|
1143
1145
|
def get_email_count_with_http_info(opts = {})
|
1144
1146
|
if @api_client.config.debugging
|
@@ -1149,6 +1151,7 @@ module MailSlurpClient
|
|
1149
1151
|
|
1150
1152
|
# query parameters
|
1151
1153
|
query_params = opts[:query_params] || {}
|
1154
|
+
query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
|
1152
1155
|
|
1153
1156
|
# header parameters
|
1154
1157
|
header_params = opts[:header_params] || {}
|
@@ -2293,6 +2296,7 @@ module MailSlurpClient
|
|
2293
2296
|
# Get unread email count
|
2294
2297
|
# Get number of emails unread. Unread means has not been viewed in dashboard or returned in an email API response
|
2295
2298
|
# @param [Hash] opts the optional parameters
|
2299
|
+
# @option opts [String] :inbox_id Optional inbox ID filter
|
2296
2300
|
# @return [UnreadCount]
|
2297
2301
|
def get_unread_email_count(opts = {})
|
2298
2302
|
data, _status_code, _headers = get_unread_email_count_with_http_info(opts)
|
@@ -2302,6 +2306,7 @@ module MailSlurpClient
|
|
2302
2306
|
# Get unread email count
|
2303
2307
|
# Get number of emails unread. Unread means has not been viewed in dashboard or returned in an email API response
|
2304
2308
|
# @param [Hash] opts the optional parameters
|
2309
|
+
# @option opts [String] :inbox_id Optional inbox ID filter
|
2305
2310
|
# @return [Array<(UnreadCount, Integer, Hash)>] UnreadCount data, response status code and response headers
|
2306
2311
|
def get_unread_email_count_with_http_info(opts = {})
|
2307
2312
|
if @api_client.config.debugging
|
@@ -2312,6 +2317,7 @@ module MailSlurpClient
|
|
2312
2317
|
|
2313
2318
|
# query parameters
|
2314
2319
|
query_params = opts[:query_params] || {}
|
2320
|
+
query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
|
2315
2321
|
|
2316
2322
|
# header parameters
|
2317
2323
|
header_params = opts[:header_params] || {}
|
@@ -2346,7 +2352,67 @@ module MailSlurpClient
|
|
2346
2352
|
return data, status_code, headers
|
2347
2353
|
end
|
2348
2354
|
|
2349
|
-
# Mark
|
2355
|
+
# Mark all emails as read or unread
|
2356
|
+
# Marks all emails 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
|
2357
|
+
# @param [Hash] opts the optional parameters
|
2358
|
+
# @option opts [Boolean] :read What value to assign to email read property. Default true. (default to true)
|
2359
|
+
# @option opts [String] :inbox_id Optional inbox ID filter
|
2360
|
+
# @return [nil]
|
2361
|
+
def mark_all_as_read(opts = {})
|
2362
|
+
mark_all_as_read_with_http_info(opts)
|
2363
|
+
nil
|
2364
|
+
end
|
2365
|
+
|
2366
|
+
# Mark all emails as read or unread
|
2367
|
+
# Marks all emails 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
|
2368
|
+
# @param [Hash] opts the optional parameters
|
2369
|
+
# @option opts [Boolean] :read What value to assign to email read property. Default true.
|
2370
|
+
# @option opts [String] :inbox_id Optional inbox ID filter
|
2371
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
2372
|
+
def mark_all_as_read_with_http_info(opts = {})
|
2373
|
+
if @api_client.config.debugging
|
2374
|
+
@api_client.config.logger.debug 'Calling API: EmailControllerApi.mark_all_as_read ...'
|
2375
|
+
end
|
2376
|
+
# resource path
|
2377
|
+
local_var_path = '/emails/read'
|
2378
|
+
|
2379
|
+
# query parameters
|
2380
|
+
query_params = opts[:query_params] || {}
|
2381
|
+
query_params[:'read'] = opts[:'read'] if !opts[:'read'].nil?
|
2382
|
+
query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
|
2383
|
+
|
2384
|
+
# header parameters
|
2385
|
+
header_params = opts[:header_params] || {}
|
2386
|
+
|
2387
|
+
# form parameters
|
2388
|
+
form_params = opts[:form_params] || {}
|
2389
|
+
|
2390
|
+
# http body (model)
|
2391
|
+
post_body = opts[:body]
|
2392
|
+
|
2393
|
+
# return_type
|
2394
|
+
return_type = opts[:return_type]
|
2395
|
+
|
2396
|
+
# auth_names
|
2397
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
2398
|
+
|
2399
|
+
new_options = opts.merge(
|
2400
|
+
:header_params => header_params,
|
2401
|
+
:query_params => query_params,
|
2402
|
+
:form_params => form_params,
|
2403
|
+
:body => post_body,
|
2404
|
+
:auth_names => auth_names,
|
2405
|
+
:return_type => return_type
|
2406
|
+
)
|
2407
|
+
|
2408
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
|
2409
|
+
if @api_client.config.debugging
|
2410
|
+
@api_client.config.logger.debug "API called: EmailControllerApi#mark_all_as_read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2411
|
+
end
|
2412
|
+
return data, status_code, headers
|
2413
|
+
end
|
2414
|
+
|
2415
|
+
# Mark an email as read or unread
|
2350
2416
|
# 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
|
2351
2417
|
# @param email_id [String]
|
2352
2418
|
# @param [Hash] opts the optional parameters
|
@@ -2357,7 +2423,7 @@ module MailSlurpClient
|
|
2357
2423
|
data
|
2358
2424
|
end
|
2359
2425
|
|
2360
|
-
# Mark an email as read
|
2426
|
+
# Mark an email as read or unread
|
2361
2427
|
# 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
|
2362
2428
|
# @param email_id [String]
|
2363
2429
|
# @param [Hash] opts the optional parameters
|
@@ -93,7 +93,7 @@ module MailSlurpClient
|
|
93
93
|
# @option opts [DateTime] :expires_at Optional inbox expiration date. If null then this inbox is permanent and the emails in it won't be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX.
|
94
94
|
# @option opts [Integer] :expires_in Number of milliseconds that inbox should exist for
|
95
95
|
# @option opts [Boolean] :allow_team_access DEPRECATED (team access is always true). Grant team access to this inbox and the emails that belong to it for team members of your organization.
|
96
|
-
# @option opts [String] :inbox_type HTTP (default) or SMTP inbox type. HTTP inboxes are default and best solution for most cases. SMTP inboxes are more reliable for public inbound email consumption (but do not support sending emails). When using custom domains the domain type must match the inbox type. HTTP inboxes are processed by AWS SES while SMTP inboxes use a custom mail server running at `
|
96
|
+
# @option opts [String] :inbox_type HTTP (default) or SMTP inbox type. HTTP inboxes are default and best solution for most cases. SMTP inboxes are more reliable for public inbound email consumption (but do not support sending emails). When using custom domains the domain type must match the inbox type. HTTP inboxes are processed by AWS SES while SMTP inboxes use a custom mail server running at `mxslurp.click`.
|
97
97
|
# @option opts [Boolean] :virtual_inbox Virtual inbox prevents any outbound emails from being sent. It creates sent email records but will never send real emails to recipients. Great for testing and faking email sending.
|
98
98
|
# @option opts [Boolean] :use_short_address Use a shorter email address under 31 characters
|
99
99
|
# @option opts [String] :domain_id ID of custom domain to use for email address.
|
@@ -117,7 +117,7 @@ module MailSlurpClient
|
|
117
117
|
# @option opts [DateTime] :expires_at Optional inbox expiration date. If null then this inbox is permanent and the emails in it won't be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX.
|
118
118
|
# @option opts [Integer] :expires_in Number of milliseconds that inbox should exist for
|
119
119
|
# @option opts [Boolean] :allow_team_access DEPRECATED (team access is always true). Grant team access to this inbox and the emails that belong to it for team members of your organization.
|
120
|
-
# @option opts [String] :inbox_type HTTP (default) or SMTP inbox type. HTTP inboxes are default and best solution for most cases. SMTP inboxes are more reliable for public inbound email consumption (but do not support sending emails). When using custom domains the domain type must match the inbox type. HTTP inboxes are processed by AWS SES while SMTP inboxes use a custom mail server running at `
|
120
|
+
# @option opts [String] :inbox_type HTTP (default) or SMTP inbox type. HTTP inboxes are default and best solution for most cases. SMTP inboxes are more reliable for public inbound email consumption (but do not support sending emails). When using custom domains the domain type must match the inbox type. HTTP inboxes are processed by AWS SES while SMTP inboxes use a custom mail server running at `mxslurp.click`.
|
121
121
|
# @option opts [Boolean] :virtual_inbox Virtual inbox prevents any outbound emails from being sent. It creates sent email records but will never send real emails to recipients. Great for testing and faking email sending.
|
122
122
|
# @option opts [Boolean] :use_short_address Use a shorter email address under 31 characters
|
123
123
|
# @option opts [String] :domain_id ID of custom domain to use for email address.
|
@@ -1490,6 +1490,60 @@ module MailSlurpClient
|
|
1490
1490
|
return data, status_code, headers
|
1491
1491
|
end
|
1492
1492
|
|
1493
|
+
# Get IMAP and SMTP server hosts
|
1494
|
+
# @param [Hash] opts the optional parameters
|
1495
|
+
# @return [ImapSmtpAccessServers]
|
1496
|
+
def get_imap_smtp_access_servers(opts = {})
|
1497
|
+
data, _status_code, _headers = get_imap_smtp_access_servers_with_http_info(opts)
|
1498
|
+
data
|
1499
|
+
end
|
1500
|
+
|
1501
|
+
# Get IMAP and SMTP server hosts
|
1502
|
+
# @param [Hash] opts the optional parameters
|
1503
|
+
# @return [Array<(ImapSmtpAccessServers, Integer, Hash)>] ImapSmtpAccessServers data, response status code and response headers
|
1504
|
+
def get_imap_smtp_access_servers_with_http_info(opts = {})
|
1505
|
+
if @api_client.config.debugging
|
1506
|
+
@api_client.config.logger.debug 'Calling API: InboxControllerApi.get_imap_smtp_access_servers ...'
|
1507
|
+
end
|
1508
|
+
# resource path
|
1509
|
+
local_var_path = '/inboxes/imap-smtp-access/servers'
|
1510
|
+
|
1511
|
+
# query parameters
|
1512
|
+
query_params = opts[:query_params] || {}
|
1513
|
+
|
1514
|
+
# header parameters
|
1515
|
+
header_params = opts[:header_params] || {}
|
1516
|
+
# HTTP header 'Accept' (if needed)
|
1517
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
1518
|
+
|
1519
|
+
# form parameters
|
1520
|
+
form_params = opts[:form_params] || {}
|
1521
|
+
|
1522
|
+
# http body (model)
|
1523
|
+
post_body = opts[:body]
|
1524
|
+
|
1525
|
+
# return_type
|
1526
|
+
return_type = opts[:return_type] || 'ImapSmtpAccessServers'
|
1527
|
+
|
1528
|
+
# auth_names
|
1529
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
1530
|
+
|
1531
|
+
new_options = opts.merge(
|
1532
|
+
:header_params => header_params,
|
1533
|
+
:query_params => query_params,
|
1534
|
+
:form_params => form_params,
|
1535
|
+
:body => post_body,
|
1536
|
+
:auth_names => auth_names,
|
1537
|
+
:return_type => return_type
|
1538
|
+
)
|
1539
|
+
|
1540
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1541
|
+
if @api_client.config.debugging
|
1542
|
+
@api_client.config.logger.debug "API called: InboxControllerApi#get_imap_smtp_access_servers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1543
|
+
end
|
1544
|
+
return data, status_code, headers
|
1545
|
+
end
|
1546
|
+
|
1493
1547
|
# Get Inbox. Returns properties of an inbox.
|
1494
1548
|
# Returns an inbox's properties, including its email address and ID.
|
1495
1549
|
# @param inbox_id [String]
|
@@ -3220,6 +3274,69 @@ module MailSlurpClient
|
|
3220
3274
|
return data, status_code, headers
|
3221
3275
|
end
|
3222
3276
|
|
3277
|
+
# Update IMAP access usernames and passwords
|
3278
|
+
# @param update_imap_access_options [UpdateImapAccessOptions]
|
3279
|
+
# @param [Hash] opts the optional parameters
|
3280
|
+
# @option opts [String] :inbox_id Inbox ID
|
3281
|
+
# @return [nil]
|
3282
|
+
def update_imap_access(update_imap_access_options, opts = {})
|
3283
|
+
update_imap_access_with_http_info(update_imap_access_options, opts)
|
3284
|
+
nil
|
3285
|
+
end
|
3286
|
+
|
3287
|
+
# Update IMAP access usernames and passwords
|
3288
|
+
# @param update_imap_access_options [UpdateImapAccessOptions]
|
3289
|
+
# @param [Hash] opts the optional parameters
|
3290
|
+
# @option opts [String] :inbox_id Inbox ID
|
3291
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
3292
|
+
def update_imap_access_with_http_info(update_imap_access_options, opts = {})
|
3293
|
+
if @api_client.config.debugging
|
3294
|
+
@api_client.config.logger.debug 'Calling API: InboxControllerApi.update_imap_access ...'
|
3295
|
+
end
|
3296
|
+
# verify the required parameter 'update_imap_access_options' is set
|
3297
|
+
if @api_client.config.client_side_validation && update_imap_access_options.nil?
|
3298
|
+
fail ArgumentError, "Missing the required parameter 'update_imap_access_options' when calling InboxControllerApi.update_imap_access"
|
3299
|
+
end
|
3300
|
+
# resource path
|
3301
|
+
local_var_path = '/inboxes/imap-access'
|
3302
|
+
|
3303
|
+
# query parameters
|
3304
|
+
query_params = opts[:query_params] || {}
|
3305
|
+
query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
|
3306
|
+
|
3307
|
+
# header parameters
|
3308
|
+
header_params = opts[:header_params] || {}
|
3309
|
+
# HTTP header 'Content-Type'
|
3310
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
3311
|
+
|
3312
|
+
# form parameters
|
3313
|
+
form_params = opts[:form_params] || {}
|
3314
|
+
|
3315
|
+
# http body (model)
|
3316
|
+
post_body = opts[:body] || @api_client.object_to_http_body(update_imap_access_options)
|
3317
|
+
|
3318
|
+
# return_type
|
3319
|
+
return_type = opts[:return_type]
|
3320
|
+
|
3321
|
+
# auth_names
|
3322
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
3323
|
+
|
3324
|
+
new_options = opts.merge(
|
3325
|
+
:header_params => header_params,
|
3326
|
+
:query_params => query_params,
|
3327
|
+
:form_params => form_params,
|
3328
|
+
:body => post_body,
|
3329
|
+
:auth_names => auth_names,
|
3330
|
+
:return_type => return_type
|
3331
|
+
)
|
3332
|
+
|
3333
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
|
3334
|
+
if @api_client.config.debugging
|
3335
|
+
@api_client.config.logger.debug "API called: InboxControllerApi#update_imap_access\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3336
|
+
end
|
3337
|
+
return data, status_code, headers
|
3338
|
+
end
|
3339
|
+
|
3223
3340
|
# Update Inbox. Change name and description. Email address is not editable.
|
3224
3341
|
# Update editable fields on an inbox
|
3225
3342
|
# @param inbox_id [String]
|
@@ -3289,5 +3406,68 @@ module MailSlurpClient
|
|
3289
3406
|
end
|
3290
3407
|
return data, status_code, headers
|
3291
3408
|
end
|
3409
|
+
|
3410
|
+
# Update SMTP access usernames and passwords
|
3411
|
+
# @param update_smtp_access_options [UpdateSmtpAccessOptions]
|
3412
|
+
# @param [Hash] opts the optional parameters
|
3413
|
+
# @option opts [String] :inbox_id Inbox ID
|
3414
|
+
# @return [nil]
|
3415
|
+
def update_smtp_access(update_smtp_access_options, opts = {})
|
3416
|
+
update_smtp_access_with_http_info(update_smtp_access_options, opts)
|
3417
|
+
nil
|
3418
|
+
end
|
3419
|
+
|
3420
|
+
# Update SMTP access usernames and passwords
|
3421
|
+
# @param update_smtp_access_options [UpdateSmtpAccessOptions]
|
3422
|
+
# @param [Hash] opts the optional parameters
|
3423
|
+
# @option opts [String] :inbox_id Inbox ID
|
3424
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
3425
|
+
def update_smtp_access_with_http_info(update_smtp_access_options, opts = {})
|
3426
|
+
if @api_client.config.debugging
|
3427
|
+
@api_client.config.logger.debug 'Calling API: InboxControllerApi.update_smtp_access ...'
|
3428
|
+
end
|
3429
|
+
# verify the required parameter 'update_smtp_access_options' is set
|
3430
|
+
if @api_client.config.client_side_validation && update_smtp_access_options.nil?
|
3431
|
+
fail ArgumentError, "Missing the required parameter 'update_smtp_access_options' when calling InboxControllerApi.update_smtp_access"
|
3432
|
+
end
|
3433
|
+
# resource path
|
3434
|
+
local_var_path = '/inboxes/smtp-access'
|
3435
|
+
|
3436
|
+
# query parameters
|
3437
|
+
query_params = opts[:query_params] || {}
|
3438
|
+
query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
|
3439
|
+
|
3440
|
+
# header parameters
|
3441
|
+
header_params = opts[:header_params] || {}
|
3442
|
+
# HTTP header 'Content-Type'
|
3443
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
3444
|
+
|
3445
|
+
# form parameters
|
3446
|
+
form_params = opts[:form_params] || {}
|
3447
|
+
|
3448
|
+
# http body (model)
|
3449
|
+
post_body = opts[:body] || @api_client.object_to_http_body(update_smtp_access_options)
|
3450
|
+
|
3451
|
+
# return_type
|
3452
|
+
return_type = opts[:return_type]
|
3453
|
+
|
3454
|
+
# auth_names
|
3455
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
3456
|
+
|
3457
|
+
new_options = opts.merge(
|
3458
|
+
:header_params => header_params,
|
3459
|
+
:query_params => query_params,
|
3460
|
+
:form_params => form_params,
|
3461
|
+
:body => post_body,
|
3462
|
+
:auth_names => auth_names,
|
3463
|
+
:return_type => return_type
|
3464
|
+
)
|
3465
|
+
|
3466
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
|
3467
|
+
if @api_client.config.debugging
|
3468
|
+
@api_client.config.logger.debug "API called: InboxControllerApi#update_smtp_access\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3469
|
+
end
|
3470
|
+
return data, status_code, headers
|
3471
|
+
end
|
3292
3472
|
end
|
3293
3473
|
end
|
@@ -15,12 +15,12 @@ require 'date'
|
|
15
15
|
module MailSlurpClient
|
16
16
|
# Representation of a alias
|
17
17
|
class AliasProjection
|
18
|
-
attr_accessor :user_id
|
19
|
-
|
20
18
|
attr_accessor :email_address
|
21
19
|
|
22
20
|
attr_accessor :inbox_id
|
23
21
|
|
22
|
+
attr_accessor :user_id
|
23
|
+
|
24
24
|
attr_accessor :use_threads
|
25
25
|
|
26
26
|
attr_accessor :created_at
|
@@ -34,9 +34,9 @@ module MailSlurpClient
|
|
34
34
|
# Attribute mapping from ruby-style variable name to JSON key.
|
35
35
|
def self.attribute_map
|
36
36
|
{
|
37
|
-
:'user_id' => :'userId',
|
38
37
|
:'email_address' => :'emailAddress',
|
39
38
|
:'inbox_id' => :'inboxId',
|
39
|
+
:'user_id' => :'userId',
|
40
40
|
:'use_threads' => :'useThreads',
|
41
41
|
:'created_at' => :'createdAt',
|
42
42
|
:'updated_at' => :'updatedAt',
|
@@ -48,9 +48,9 @@ module MailSlurpClient
|
|
48
48
|
# Attribute type mapping.
|
49
49
|
def self.openapi_types
|
50
50
|
{
|
51
|
-
:'user_id' => :'String',
|
52
51
|
:'email_address' => :'String',
|
53
52
|
:'inbox_id' => :'String',
|
53
|
+
:'user_id' => :'String',
|
54
54
|
:'use_threads' => :'Boolean',
|
55
55
|
:'created_at' => :'DateTime',
|
56
56
|
:'updated_at' => :'DateTime',
|
@@ -80,10 +80,6 @@ module MailSlurpClient
|
|
80
80
|
h[k.to_sym] = v
|
81
81
|
}
|
82
82
|
|
83
|
-
if attributes.key?(:'user_id')
|
84
|
-
self.user_id = attributes[:'user_id']
|
85
|
-
end
|
86
|
-
|
87
83
|
if attributes.key?(:'email_address')
|
88
84
|
self.email_address = attributes[:'email_address']
|
89
85
|
end
|
@@ -92,6 +88,10 @@ module MailSlurpClient
|
|
92
88
|
self.inbox_id = attributes[:'inbox_id']
|
93
89
|
end
|
94
90
|
|
91
|
+
if attributes.key?(:'user_id')
|
92
|
+
self.user_id = attributes[:'user_id']
|
93
|
+
end
|
94
|
+
|
95
95
|
if attributes.key?(:'use_threads')
|
96
96
|
self.use_threads = attributes[:'use_threads']
|
97
97
|
end
|
@@ -117,10 +117,6 @@ module MailSlurpClient
|
|
117
117
|
# @return Array for valid properties with the reasons
|
118
118
|
def list_invalid_properties
|
119
119
|
invalid_properties = Array.new
|
120
|
-
if @user_id.nil?
|
121
|
-
invalid_properties.push('invalid value for "user_id", user_id cannot be nil.')
|
122
|
-
end
|
123
|
-
|
124
120
|
if @email_address.nil?
|
125
121
|
invalid_properties.push('invalid value for "email_address", email_address cannot be nil.')
|
126
122
|
end
|
@@ -129,6 +125,10 @@ module MailSlurpClient
|
|
129
125
|
invalid_properties.push('invalid value for "inbox_id", inbox_id cannot be nil.')
|
130
126
|
end
|
131
127
|
|
128
|
+
if @user_id.nil?
|
129
|
+
invalid_properties.push('invalid value for "user_id", user_id cannot be nil.')
|
130
|
+
end
|
131
|
+
|
132
132
|
if @created_at.nil?
|
133
133
|
invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
|
134
134
|
end
|
@@ -147,9 +147,9 @@ module MailSlurpClient
|
|
147
147
|
# Check to see if the all the properties in the model are valid
|
148
148
|
# @return true if the model is valid
|
149
149
|
def valid?
|
150
|
-
return false if @user_id.nil?
|
151
150
|
return false if @email_address.nil?
|
152
151
|
return false if @inbox_id.nil?
|
152
|
+
return false if @user_id.nil?
|
153
153
|
return false if @created_at.nil?
|
154
154
|
return false if @updated_at.nil?
|
155
155
|
return false if @id.nil?
|
@@ -161,9 +161,9 @@ module MailSlurpClient
|
|
161
161
|
def ==(o)
|
162
162
|
return true if self.equal?(o)
|
163
163
|
self.class == o.class &&
|
164
|
-
user_id == o.user_id &&
|
165
164
|
email_address == o.email_address &&
|
166
165
|
inbox_id == o.inbox_id &&
|
166
|
+
user_id == o.user_id &&
|
167
167
|
use_threads == o.use_threads &&
|
168
168
|
created_at == o.created_at &&
|
169
169
|
updated_at == o.updated_at &&
|
@@ -180,7 +180,7 @@ module MailSlurpClient
|
|
180
180
|
# Calculates hash code according to all attributes.
|
181
181
|
# @return [Integer] Hash code
|
182
182
|
def hash
|
183
|
-
[
|
183
|
+
[email_address, inbox_id, user_id, use_threads, created_at, updated_at, name, id].hash
|
184
184
|
end
|
185
185
|
|
186
186
|
# Builds the object from hash
|
@@ -17,12 +17,12 @@ module MailSlurpClient
|
|
17
17
|
class ConnectorProjection
|
18
18
|
attr_accessor :enabled
|
19
19
|
|
20
|
-
attr_accessor :user_id
|
21
|
-
|
22
20
|
attr_accessor :email_address
|
23
21
|
|
24
22
|
attr_accessor :inbox_id
|
25
23
|
|
24
|
+
attr_accessor :user_id
|
25
|
+
|
26
26
|
attr_accessor :sync_enabled
|
27
27
|
|
28
28
|
attr_accessor :sync_schedule_type
|
@@ -61,9 +61,9 @@ module MailSlurpClient
|
|
61
61
|
def self.attribute_map
|
62
62
|
{
|
63
63
|
:'enabled' => :'enabled',
|
64
|
-
:'user_id' => :'userId',
|
65
64
|
:'email_address' => :'emailAddress',
|
66
65
|
:'inbox_id' => :'inboxId',
|
66
|
+
:'user_id' => :'userId',
|
67
67
|
:'sync_enabled' => :'syncEnabled',
|
68
68
|
:'sync_schedule_type' => :'syncScheduleType',
|
69
69
|
:'sync_interval' => :'syncInterval',
|
@@ -77,9 +77,9 @@ module MailSlurpClient
|
|
77
77
|
def self.openapi_types
|
78
78
|
{
|
79
79
|
:'enabled' => :'Boolean',
|
80
|
-
:'user_id' => :'String',
|
81
80
|
:'email_address' => :'String',
|
82
81
|
:'inbox_id' => :'String',
|
82
|
+
:'user_id' => :'String',
|
83
83
|
:'sync_enabled' => :'Boolean',
|
84
84
|
:'sync_schedule_type' => :'String',
|
85
85
|
:'sync_interval' => :'Integer',
|
@@ -114,10 +114,6 @@ module MailSlurpClient
|
|
114
114
|
self.enabled = attributes[:'enabled']
|
115
115
|
end
|
116
116
|
|
117
|
-
if attributes.key?(:'user_id')
|
118
|
-
self.user_id = attributes[:'user_id']
|
119
|
-
end
|
120
|
-
|
121
117
|
if attributes.key?(:'email_address')
|
122
118
|
self.email_address = attributes[:'email_address']
|
123
119
|
end
|
@@ -126,6 +122,10 @@ module MailSlurpClient
|
|
126
122
|
self.inbox_id = attributes[:'inbox_id']
|
127
123
|
end
|
128
124
|
|
125
|
+
if attributes.key?(:'user_id')
|
126
|
+
self.user_id = attributes[:'user_id']
|
127
|
+
end
|
128
|
+
|
129
129
|
if attributes.key?(:'sync_enabled')
|
130
130
|
self.sync_enabled = attributes[:'sync_enabled']
|
131
131
|
end
|
@@ -155,14 +155,14 @@ module MailSlurpClient
|
|
155
155
|
# @return Array for valid properties with the reasons
|
156
156
|
def list_invalid_properties
|
157
157
|
invalid_properties = Array.new
|
158
|
-
if @user_id.nil?
|
159
|
-
invalid_properties.push('invalid value for "user_id", user_id cannot be nil.')
|
160
|
-
end
|
161
|
-
|
162
158
|
if @inbox_id.nil?
|
163
159
|
invalid_properties.push('invalid value for "inbox_id", inbox_id cannot be nil.')
|
164
160
|
end
|
165
161
|
|
162
|
+
if @user_id.nil?
|
163
|
+
invalid_properties.push('invalid value for "user_id", user_id cannot be nil.')
|
164
|
+
end
|
165
|
+
|
166
166
|
if @sync_schedule_type.nil?
|
167
167
|
invalid_properties.push('invalid value for "sync_schedule_type", sync_schedule_type cannot be nil.')
|
168
168
|
end
|
@@ -177,8 +177,8 @@ module MailSlurpClient
|
|
177
177
|
# Check to see if the all the properties in the model are valid
|
178
178
|
# @return true if the model is valid
|
179
179
|
def valid?
|
180
|
-
return false if @user_id.nil?
|
181
180
|
return false if @inbox_id.nil?
|
181
|
+
return false if @user_id.nil?
|
182
182
|
return false if @sync_schedule_type.nil?
|
183
183
|
sync_schedule_type_validator = EnumAttributeValidator.new('String', ["INTERVAL"])
|
184
184
|
return false unless sync_schedule_type_validator.valid?(@sync_schedule_type)
|
@@ -202,9 +202,9 @@ module MailSlurpClient
|
|
202
202
|
return true if self.equal?(o)
|
203
203
|
self.class == o.class &&
|
204
204
|
enabled == o.enabled &&
|
205
|
-
user_id == o.user_id &&
|
206
205
|
email_address == o.email_address &&
|
207
206
|
inbox_id == o.inbox_id &&
|
207
|
+
user_id == o.user_id &&
|
208
208
|
sync_enabled == o.sync_enabled &&
|
209
209
|
sync_schedule_type == o.sync_schedule_type &&
|
210
210
|
sync_interval == o.sync_interval &&
|
@@ -222,7 +222,7 @@ module MailSlurpClient
|
|
222
222
|
# Calculates hash code according to all attributes.
|
223
223
|
# @return [Integer] Hash code
|
224
224
|
def hash
|
225
|
-
[enabled,
|
225
|
+
[enabled, email_address, inbox_id, user_id, sync_enabled, sync_schedule_type, sync_interval, created_at, name, id].hash
|
226
226
|
end
|
227
227
|
|
228
228
|
# Builds the object from hash
|
@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.3.1
|
|
13
13
|
require 'date'
|
14
14
|
|
15
15
|
module MailSlurpClient
|
16
|
-
# Options for creating a domain to use with MailSlurp. You must have ownership access to this domain in order to verify it. Domains will not function correctly until the domain has been verified. See https://www.mailslurp.com/guides/custom-domains for help. Domains can be either `HTTP` or `SMTP` type. The type of domain determines which inboxes can be used with it. `SMTP` inboxes use a mail server running `
|
16
|
+
# Options for creating a domain to use with MailSlurp. You must have ownership access to this domain in order to verify it. Domains will not function correctly until the domain has been verified. See https://www.mailslurp.com/guides/custom-domains for help. Domains can be either `HTTP` or `SMTP` type. The type of domain determines which inboxes can be used with it. `SMTP` inboxes use a mail server running `mxslurp.click` while `HTTP` inboxes are handled by AWS SES.
|
17
17
|
class CreateDomainOptions
|
18
18
|
# The top level domain you wish to use with MailSlurp. Do not specify subdomain just the top level. So `test.com` covers all subdomains such as `mail.test.com`. Don't include a protocol such as `http://`. Once added you must complete the verification steps by adding the returned records to your domain.
|
19
19
|
attr_accessor :domain
|
@@ -15,10 +15,10 @@ require 'date'
|
|
15
15
|
module MailSlurpClient
|
16
16
|
# A compact representation of a full email. Used in list endpoints to keep response sizes low. Body and attachments are not included. To get all fields of the email use the `getEmail` method with the email projection's ID. See `EmailDto` for documentation on projection properties.
|
17
17
|
class EmailProjection
|
18
|
-
attr_accessor :inbox_id
|
19
|
-
|
20
18
|
attr_accessor :attachments
|
21
19
|
|
20
|
+
attr_accessor :inbox_id
|
21
|
+
|
22
22
|
attr_accessor :to
|
23
23
|
|
24
24
|
attr_accessor :domain_id
|
@@ -48,8 +48,8 @@ module MailSlurpClient
|
|
48
48
|
# Attribute mapping from ruby-style variable name to JSON key.
|
49
49
|
def self.attribute_map
|
50
50
|
{
|
51
|
-
:'inbox_id' => :'inboxId',
|
52
51
|
:'attachments' => :'attachments',
|
52
|
+
:'inbox_id' => :'inboxId',
|
53
53
|
:'to' => :'to',
|
54
54
|
:'domain_id' => :'domainId',
|
55
55
|
:'bcc' => :'bcc',
|
@@ -69,8 +69,8 @@ module MailSlurpClient
|
|
69
69
|
# Attribute type mapping.
|
70
70
|
def self.openapi_types
|
71
71
|
{
|
72
|
-
:'inbox_id' => :'String',
|
73
72
|
:'attachments' => :'Array<String>',
|
73
|
+
:'inbox_id' => :'String',
|
74
74
|
:'to' => :'Array<String>',
|
75
75
|
:'domain_id' => :'String',
|
76
76
|
:'bcc' => :'Array<String>',
|
@@ -117,16 +117,16 @@ module MailSlurpClient
|
|
117
117
|
h[k.to_sym] = v
|
118
118
|
}
|
119
119
|
|
120
|
-
if attributes.key?(:'inbox_id')
|
121
|
-
self.inbox_id = attributes[:'inbox_id']
|
122
|
-
end
|
123
|
-
|
124
120
|
if attributes.key?(:'attachments')
|
125
121
|
if (value = attributes[:'attachments']).is_a?(Array)
|
126
122
|
self.attachments = value
|
127
123
|
end
|
128
124
|
end
|
129
125
|
|
126
|
+
if attributes.key?(:'inbox_id')
|
127
|
+
self.inbox_id = attributes[:'inbox_id']
|
128
|
+
end
|
129
|
+
|
130
130
|
if attributes.key?(:'to')
|
131
131
|
if (value = attributes[:'to']).is_a?(Array)
|
132
132
|
self.to = value
|
@@ -234,8 +234,8 @@ module MailSlurpClient
|
|
234
234
|
def ==(o)
|
235
235
|
return true if self.equal?(o)
|
236
236
|
self.class == o.class &&
|
237
|
-
inbox_id == o.inbox_id &&
|
238
237
|
attachments == o.attachments &&
|
238
|
+
inbox_id == o.inbox_id &&
|
239
239
|
to == o.to &&
|
240
240
|
domain_id == o.domain_id &&
|
241
241
|
bcc == o.bcc &&
|
@@ -260,7 +260,7 @@ module MailSlurpClient
|
|
260
260
|
# Calculates hash code according to all attributes.
|
261
261
|
# @return [Integer] Hash code
|
262
262
|
def hash
|
263
|
-
[
|
263
|
+
[attachments, inbox_id, to, domain_id, bcc, cc, read, body_excerpt, team_access, body_md5_hash, text_excerpt, created_at, subject, id, from].hash
|
264
264
|
end
|
265
265
|
|
266
266
|
# Builds the object from hash
|