sendmux-mailbox 1.0.0 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (28) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +22 -0
  3. data/LICENSE +21 -0
  4. data/README.md +105 -0
  5. data/lib/sendmux/mailbox/version.rb +1 -1
  6. data/lib/sendmux_mailbox_generated/api/mailbox_api_api.rb +275 -14
  7. data/lib/sendmux_mailbox_generated/models/batch_delete_mailbox_messages_body.rb +1 -0
  8. data/lib/sendmux_mailbox_generated/models/batch_update_mailbox_messages_body.rb +3 -0
  9. data/lib/sendmux_mailbox_generated/models/{mailbox_message_summary_from.rb → granted_mailbox.rb} +28 -19
  10. data/lib/sendmux_mailbox_generated/models/granted_mailbox_list_response.rb +251 -0
  11. data/lib/sendmux_mailbox_generated/models/mailbox_attachment.rb +3 -1
  12. data/lib/sendmux_mailbox_generated/models/mailbox_attachment_upload_intent_body.rb +228 -0
  13. data/lib/sendmux_mailbox_generated/models/mailbox_attachment_upload_intent_result.rb +323 -0
  14. data/lib/sendmux_mailbox_generated/models/mailbox_attachment_upload_intent_result_headers.rb +191 -0
  15. data/lib/sendmux_mailbox_generated/models/mailbox_attachment_upload_intent_result_response.rb +223 -0
  16. data/lib/sendmux_mailbox_generated/models/mailbox_batch_get_body.rb +10 -0
  17. data/lib/sendmux_mailbox_generated/models/mailbox_changes.rb +11 -1
  18. data/lib/sendmux_mailbox_generated/models/mailbox_message.rb +14 -45
  19. data/lib/sendmux_mailbox_generated/models/mailbox_message_content_participants.rb +2 -16
  20. data/lib/sendmux_mailbox_generated/models/mailbox_message_summary.rb +15 -17
  21. data/lib/sendmux_mailbox_generated/models/mailbox_realtime_event.rb +1 -15
  22. data/lib/sendmux_mailbox_generated/models/mailbox_realtime_message.rb +14 -45
  23. data/lib/sendmux_mailbox_generated/models/mailbox_thread.rb +2 -16
  24. data/lib/sendmux_mailbox_generated/models/mailbox_thread_summary.rb +2 -16
  25. data/lib/sendmux_mailbox_generated/models/send_mailbox_message_body.rb +10 -0
  26. data/lib/sendmux_mailbox_generated.rb +6 -2
  27. metadata +9 -4
  28. data/lib/sendmux_mailbox_generated/models/mailbox_thread_summary_last_message.rb +0 -463
@@ -22,6 +22,7 @@ module Sendmux::Mailbox::Generated
22
22
  # Batch delete mailbox messages
23
23
  # Moves up to 100 messages to Trash by default with state-safe conflict handling. Set `permanent=true` to permanently delete them.
24
24
  # @param [Hash] opts the optional parameters
25
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
25
26
  # @option opts [BatchDeleteMailboxMessagesBody] :batch_delete_mailbox_messages_body
26
27
  # @return [MailboxBatchDeleteMessagesResultResponse]
27
28
  def mailbox_batch_delete_messages(opts = {})
@@ -32,6 +33,7 @@ module Sendmux::Mailbox::Generated
32
33
  # Batch delete mailbox messages
33
34
  # Moves up to 100 messages to Trash by default with state-safe conflict handling. Set `permanent=true` to permanently delete them.
34
35
  # @param [Hash] opts the optional parameters
36
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
35
37
  # @option opts [BatchDeleteMailboxMessagesBody] :batch_delete_mailbox_messages_body
36
38
  # @return [Array<(MailboxBatchDeleteMessagesResultResponse, Integer, Hash)>] MailboxBatchDeleteMessagesResultResponse data, response status code and response headers
37
39
  def mailbox_batch_delete_messages_with_http_info(opts = {})
@@ -43,6 +45,7 @@ module Sendmux::Mailbox::Generated
43
45
 
44
46
  # query parameters
45
47
  query_params = opts[:query_params] || {}
48
+ query_params[:'mailbox_id'] = opts[:'mailbox_id'] if !opts[:'mailbox_id'].nil?
46
49
 
47
50
  # header parameters
48
51
  header_params = opts[:header_params] || {}
@@ -86,6 +89,7 @@ module Sendmux::Mailbox::Generated
86
89
  # Batch get mailbox messages
87
90
  # Returns exact messages by ID. Use `body_mode` to choose summary-only output, raw body output, or clean JSON content. Attachment output remains metadata only; attachment contents are not parsed.
88
91
  # @param [Hash] opts the optional parameters
92
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
89
93
  # @option opts [MailboxBatchGetBody] :mailbox_batch_get_body
90
94
  # @return [MailboxBatchGetResultResponse]
91
95
  def mailbox_batch_get_messages(opts = {})
@@ -96,6 +100,7 @@ module Sendmux::Mailbox::Generated
96
100
  # Batch get mailbox messages
97
101
  # Returns exact messages by ID. Use &#x60;body_mode&#x60; to choose summary-only output, raw body output, or clean JSON content. Attachment output remains metadata only; attachment contents are not parsed.
98
102
  # @param [Hash] opts the optional parameters
103
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
99
104
  # @option opts [MailboxBatchGetBody] :mailbox_batch_get_body
100
105
  # @return [Array<(MailboxBatchGetResultResponse, Integer, Hash)>] MailboxBatchGetResultResponse data, response status code and response headers
101
106
  def mailbox_batch_get_messages_with_http_info(opts = {})
@@ -107,6 +112,7 @@ module Sendmux::Mailbox::Generated
107
112
 
108
113
  # query parameters
109
114
  query_params = opts[:query_params] || {}
115
+ query_params[:'mailbox_id'] = opts[:'mailbox_id'] if !opts[:'mailbox_id'].nil?
110
116
 
111
117
  # header parameters
112
118
  header_params = opts[:header_params] || {}
@@ -150,6 +156,7 @@ module Sendmux::Mailbox::Generated
150
156
  # Batch update mailbox messages
151
157
  # Updates allowed message flags and keywords for up to 100 messages with state-safe conflict handling.
152
158
  # @param [Hash] opts the optional parameters
159
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
153
160
  # @option opts [BatchUpdateMailboxMessagesBody] :batch_update_mailbox_messages_body
154
161
  # @return [MailboxBatchUpdateMessagesResultResponse]
155
162
  def mailbox_batch_update_messages(opts = {})
@@ -160,6 +167,7 @@ module Sendmux::Mailbox::Generated
160
167
  # Batch update mailbox messages
161
168
  # Updates allowed message flags and keywords for up to 100 messages with state-safe conflict handling.
162
169
  # @param [Hash] opts the optional parameters
170
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
163
171
  # @option opts [BatchUpdateMailboxMessagesBody] :batch_update_mailbox_messages_body
164
172
  # @return [Array<(MailboxBatchUpdateMessagesResultResponse, Integer, Hash)>] MailboxBatchUpdateMessagesResultResponse data, response status code and response headers
165
173
  def mailbox_batch_update_messages_with_http_info(opts = {})
@@ -171,6 +179,7 @@ module Sendmux::Mailbox::Generated
171
179
 
172
180
  # query parameters
173
181
  query_params = opts[:query_params] || {}
182
+ query_params[:'mailbox_id'] = opts[:'mailbox_id'] if !opts[:'mailbox_id'].nil?
174
183
 
175
184
  # header parameters
176
185
  header_params = opts[:header_params] || {}
@@ -233,6 +242,7 @@ module Sendmux::Mailbox::Generated
233
242
  # @option opts [String] :before
234
243
  # @option opts [Boolean] :has_attachment
235
244
  # @option opts [Boolean] :is_unread
245
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
236
246
  # @return [MailboxMessageCountResponse]
237
247
  def mailbox_count_messages(opts = {})
238
248
  data, _status_code, _headers = mailbox_count_messages_with_http_info(opts)
@@ -261,6 +271,7 @@ module Sendmux::Mailbox::Generated
261
271
  # @option opts [String] :before
262
272
  # @option opts [Boolean] :has_attachment
263
273
  # @option opts [Boolean] :is_unread
274
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
264
275
  # @return [Array<(MailboxMessageCountResponse, Integer, Hash)>] MailboxMessageCountResponse data, response status code and response headers
265
276
  def mailbox_count_messages_with_http_info(opts = {})
266
277
  if @api_client.config.debugging
@@ -298,6 +309,7 @@ module Sendmux::Mailbox::Generated
298
309
  query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
299
310
  query_params[:'has_attachment'] = opts[:'has_attachment'] if !opts[:'has_attachment'].nil?
300
311
  query_params[:'is_unread'] = opts[:'is_unread'] if !opts[:'is_unread'].nil?
312
+ query_params[:'mailbox_id'] = opts[:'mailbox_id'] if !opts[:'mailbox_id'].nil?
301
313
 
302
314
  # header parameters
303
315
  header_params = opts[:header_params] || {}
@@ -333,9 +345,77 @@ module Sendmux::Mailbox::Generated
333
345
  return data, status_code, headers
334
346
  end
335
347
 
348
+ # Create a presigned mailbox attachment upload
349
+ # Creates a short-lived signed PUT URL for one attachment. The caller must be authenticated to mint the URL; the later PUT uses the signed URL, exact Content-Type, and exact Content-Length without sending an API key. The PUT returns a blob ID that can be supplied to `POST /mailbox/messages/send`.
350
+ # @param [Hash] opts the optional parameters
351
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
352
+ # @option opts [MailboxAttachmentUploadIntentBody] :mailbox_attachment_upload_intent_body
353
+ # @return [MailboxAttachmentUploadIntentResultResponse]
354
+ def mailbox_create_attachment_upload(opts = {})
355
+ data, _status_code, _headers = mailbox_create_attachment_upload_with_http_info(opts)
356
+ data
357
+ end
358
+
359
+ # Create a presigned mailbox attachment upload
360
+ # Creates a short-lived signed PUT URL for one attachment. The caller must be authenticated to mint the URL; the later PUT uses the signed URL, exact Content-Type, and exact Content-Length without sending an API key. The PUT returns a blob ID that can be supplied to &#x60;POST /mailbox/messages/send&#x60;.
361
+ # @param [Hash] opts the optional parameters
362
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
363
+ # @option opts [MailboxAttachmentUploadIntentBody] :mailbox_attachment_upload_intent_body
364
+ # @return [Array<(MailboxAttachmentUploadIntentResultResponse, Integer, Hash)>] MailboxAttachmentUploadIntentResultResponse data, response status code and response headers
365
+ def mailbox_create_attachment_upload_with_http_info(opts = {})
366
+ if @api_client.config.debugging
367
+ @api_client.config.logger.debug 'Calling API: MailboxAPIApi.mailbox_create_attachment_upload ...'
368
+ end
369
+ # resource path
370
+ local_var_path = '/mailbox/attachment-uploads'
371
+
372
+ # query parameters
373
+ query_params = opts[:query_params] || {}
374
+ query_params[:'mailbox_id'] = opts[:'mailbox_id'] if !opts[:'mailbox_id'].nil?
375
+
376
+ # header parameters
377
+ header_params = opts[:header_params] || {}
378
+ # HTTP header 'Accept' (if needed)
379
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
380
+ # HTTP header 'Content-Type'
381
+ content_type = @api_client.select_header_content_type(['application/json'])
382
+ if !content_type.nil?
383
+ header_params['Content-Type'] = content_type
384
+ end
385
+
386
+ # form parameters
387
+ form_params = opts[:form_params] || {}
388
+
389
+ # http body (model)
390
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'mailbox_attachment_upload_intent_body'])
391
+
392
+ # return_type
393
+ return_type = opts[:debug_return_type] || 'MailboxAttachmentUploadIntentResultResponse'
394
+
395
+ # auth_names
396
+ auth_names = opts[:debug_auth_names] || ['bearerAuth']
397
+
398
+ new_options = opts.merge(
399
+ :operation => :"MailboxAPIApi.mailbox_create_attachment_upload",
400
+ :header_params => header_params,
401
+ :query_params => query_params,
402
+ :form_params => form_params,
403
+ :body => post_body,
404
+ :auth_names => auth_names,
405
+ :return_type => return_type
406
+ )
407
+
408
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
409
+ if @api_client.config.debugging
410
+ @api_client.config.logger.debug "API called: MailboxAPIApi#mailbox_create_attachment_upload\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
411
+ end
412
+ return data, status_code, headers
413
+ end
414
+
336
415
  # Create a mailbox folder
337
416
  # Creates a folder in the authenticated mailbox.
338
417
  # @param [Hash] opts the optional parameters
418
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
339
419
  # @option opts [CreateMailboxFolderBody] :create_mailbox_folder_body
340
420
  # @return [MailboxFolderResponse]
341
421
  def mailbox_create_folder(opts = {})
@@ -346,6 +426,7 @@ module Sendmux::Mailbox::Generated
346
426
  # Create a mailbox folder
347
427
  # Creates a folder in the authenticated mailbox.
348
428
  # @param [Hash] opts the optional parameters
429
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
349
430
  # @option opts [CreateMailboxFolderBody] :create_mailbox_folder_body
350
431
  # @return [Array<(MailboxFolderResponse, Integer, Hash)>] MailboxFolderResponse data, response status code and response headers
351
432
  def mailbox_create_folder_with_http_info(opts = {})
@@ -357,6 +438,7 @@ module Sendmux::Mailbox::Generated
357
438
 
358
439
  # query parameters
359
440
  query_params = opts[:query_params] || {}
441
+ query_params[:'mailbox_id'] = opts[:'mailbox_id'] if !opts[:'mailbox_id'].nil?
360
442
 
361
443
  # header parameters
362
444
  header_params = opts[:header_params] || {}
@@ -398,10 +480,11 @@ module Sendmux::Mailbox::Generated
398
480
  end
399
481
 
400
482
  # Delete a mailbox folder
401
- # Deletes an empty custom folder with state-safe conflict handling. Built-in folders and non-empty folders cannot be deleted. Send `If-Match` with a prior ETag to reject stale deletes.
483
+ # Deletes an empty custom folder unconditionally unless `If-Match` is supplied. Built-in folders and non-empty folders cannot be deleted. Send `If-Match` with a prior ETag to reject stale deletes.
402
484
  # @param folder_id [String]
403
485
  # @param [Hash] opts the optional parameters
404
486
  # @option opts [String] :if_match
487
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
405
488
  # @return [MailboxFolderDeletedResponse]
406
489
  def mailbox_delete_folder(folder_id, opts = {})
407
490
  data, _status_code, _headers = mailbox_delete_folder_with_http_info(folder_id, opts)
@@ -409,10 +492,11 @@ module Sendmux::Mailbox::Generated
409
492
  end
410
493
 
411
494
  # Delete a mailbox folder
412
- # Deletes an empty custom folder with state-safe conflict handling. Built-in folders and non-empty folders cannot be deleted. Send &#x60;If-Match&#x60; with a prior ETag to reject stale deletes.
495
+ # Deletes an empty custom folder unconditionally unless &#x60;If-Match&#x60; is supplied. Built-in folders and non-empty folders cannot be deleted. Send &#x60;If-Match&#x60; with a prior ETag to reject stale deletes.
413
496
  # @param folder_id [String]
414
497
  # @param [Hash] opts the optional parameters
415
498
  # @option opts [String] :if_match
499
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
416
500
  # @return [Array<(MailboxFolderDeletedResponse, Integer, Hash)>] MailboxFolderDeletedResponse data, response status code and response headers
417
501
  def mailbox_delete_folder_with_http_info(folder_id, opts = {})
418
502
  if @api_client.config.debugging
@@ -427,6 +511,7 @@ module Sendmux::Mailbox::Generated
427
511
 
428
512
  # query parameters
429
513
  query_params = opts[:query_params] || {}
514
+ query_params[:'mailbox_id'] = opts[:'mailbox_id'] if !opts[:'mailbox_id'].nil?
430
515
 
431
516
  # header parameters
432
517
  header_params = opts[:header_params] || {}
@@ -464,11 +549,12 @@ module Sendmux::Mailbox::Generated
464
549
  end
465
550
 
466
551
  # Delete a mailbox message
467
- # Moves a message to Trash by default with state-safe conflict handling. Set `permanent=true` to permanently delete it. Send `If-Match` with a prior ETag to reject stale deletes.
552
+ # Moves a message to Trash by default, unconditionally unless `If-Match` is supplied. Set `permanent=true` to permanently delete it. Send `If-Match` with a prior ETag to reject stale deletes.
468
553
  # @param message_id [String]
469
554
  # @param [Hash] opts the optional parameters
470
555
  # @option opts [Boolean] :permanent
471
556
  # @option opts [String] :if_match
557
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
472
558
  # @return [MailboxMessageDeletedResponse]
473
559
  def mailbox_delete_message(message_id, opts = {})
474
560
  data, _status_code, _headers = mailbox_delete_message_with_http_info(message_id, opts)
@@ -476,11 +562,12 @@ module Sendmux::Mailbox::Generated
476
562
  end
477
563
 
478
564
  # Delete a mailbox message
479
- # Moves a message to Trash by default with state-safe conflict handling. Set &#x60;permanent&#x3D;true&#x60; to permanently delete it. Send &#x60;If-Match&#x60; with a prior ETag to reject stale deletes.
565
+ # Moves a message to Trash by default, unconditionally unless &#x60;If-Match&#x60; is supplied. Set &#x60;permanent&#x3D;true&#x60; to permanently delete it. Send &#x60;If-Match&#x60; with a prior ETag to reject stale deletes.
480
566
  # @param message_id [String]
481
567
  # @param [Hash] opts the optional parameters
482
568
  # @option opts [Boolean] :permanent
483
569
  # @option opts [String] :if_match
570
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
484
571
  # @return [Array<(MailboxMessageDeletedResponse, Integer, Hash)>] MailboxMessageDeletedResponse data, response status code and response headers
485
572
  def mailbox_delete_message_with_http_info(message_id, opts = {})
486
573
  if @api_client.config.debugging
@@ -496,6 +583,7 @@ module Sendmux::Mailbox::Generated
496
583
  # query parameters
497
584
  query_params = opts[:query_params] || {}
498
585
  query_params[:'permanent'] = opts[:'permanent'] if !opts[:'permanent'].nil?
586
+ query_params[:'mailbox_id'] = opts[:'mailbox_id'] if !opts[:'mailbox_id'].nil?
499
587
 
500
588
  # header parameters
501
589
  header_params = opts[:header_params] || {}
@@ -544,6 +632,7 @@ module Sendmux::Mailbox::Generated
544
632
  # @option opts [String] :identities_since_state
545
633
  # @option opts [String] :quotas_since_state
546
634
  # @option opts [Integer] :limit
635
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
547
636
  # @return [MailboxGetChanges200Response]
548
637
  def mailbox_get_changes(opts = {})
549
638
  data, _status_code, _headers = mailbox_get_changes_with_http_info(opts)
@@ -562,6 +651,7 @@ module Sendmux::Mailbox::Generated
562
651
  # @option opts [String] :identities_since_state
563
652
  # @option opts [String] :quotas_since_state
564
653
  # @option opts [Integer] :limit
654
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
565
655
  # @return [Array<(MailboxGetChanges200Response, Integer, Hash)>] MailboxGetChanges200Response data, response status code and response headers
566
656
  def mailbox_get_changes_with_http_info(opts = {})
567
657
  if @api_client.config.debugging
@@ -589,6 +679,7 @@ module Sendmux::Mailbox::Generated
589
679
  query_params[:'identities_since_state'] = opts[:'identities_since_state'] if !opts[:'identities_since_state'].nil?
590
680
  query_params[:'quotas_since_state'] = opts[:'quotas_since_state'] if !opts[:'quotas_since_state'].nil?
591
681
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
682
+ query_params[:'mailbox_id'] = opts[:'mailbox_id'] if !opts[:'mailbox_id'].nil?
592
683
 
593
684
  # header parameters
594
685
  header_params = opts[:header_params] || {}
@@ -629,6 +720,7 @@ module Sendmux::Mailbox::Generated
629
720
  # @param folder_id [String]
630
721
  # @param [Hash] opts the optional parameters
631
722
  # @option opts [String] :if_none_match
723
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
632
724
  # @return [MailboxFolderResponse]
633
725
  def mailbox_get_folder(folder_id, opts = {})
634
726
  data, _status_code, _headers = mailbox_get_folder_with_http_info(folder_id, opts)
@@ -640,6 +732,7 @@ module Sendmux::Mailbox::Generated
640
732
  # @param folder_id [String]
641
733
  # @param [Hash] opts the optional parameters
642
734
  # @option opts [String] :if_none_match
735
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
643
736
  # @return [Array<(MailboxFolderResponse, Integer, Hash)>] MailboxFolderResponse data, response status code and response headers
644
737
  def mailbox_get_folder_with_http_info(folder_id, opts = {})
645
738
  if @api_client.config.debugging
@@ -654,6 +747,7 @@ module Sendmux::Mailbox::Generated
654
747
 
655
748
  # query parameters
656
749
  query_params = opts[:query_params] || {}
750
+ query_params[:'mailbox_id'] = opts[:'mailbox_id'] if !opts[:'mailbox_id'].nil?
657
751
 
658
752
  # header parameters
659
753
  header_params = opts[:header_params] || {}
@@ -695,6 +789,7 @@ module Sendmux::Mailbox::Generated
695
789
  # @param [Hash] opts the optional parameters
696
790
  # @option opts [String] :since_state
697
791
  # @option opts [Integer] :limit
792
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
698
793
  # @return [MailboxChangesResponse]
699
794
  def mailbox_get_folder_changes(opts = {})
700
795
  data, _status_code, _headers = mailbox_get_folder_changes_with_http_info(opts)
@@ -706,6 +801,7 @@ module Sendmux::Mailbox::Generated
706
801
  # @param [Hash] opts the optional parameters
707
802
  # @option opts [String] :since_state
708
803
  # @option opts [Integer] :limit
804
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
709
805
  # @return [Array<(MailboxChangesResponse, Integer, Hash)>] MailboxChangesResponse data, response status code and response headers
710
806
  def mailbox_get_folder_changes_with_http_info(opts = {})
711
807
  if @api_client.config.debugging
@@ -726,6 +822,7 @@ module Sendmux::Mailbox::Generated
726
822
  query_params = opts[:query_params] || {}
727
823
  query_params[:'since_state'] = opts[:'since_state'] if !opts[:'since_state'].nil?
728
824
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
825
+ query_params[:'mailbox_id'] = opts[:'mailbox_id'] if !opts[:'mailbox_id'].nil?
729
826
 
730
827
  # header parameters
731
828
  header_params = opts[:header_params] || {}
@@ -764,6 +861,7 @@ module Sendmux::Mailbox::Generated
764
861
  # Get mailbox sender identity
765
862
  # Returns the default sender identity and signatures for the authenticated mailbox.
766
863
  # @param [Hash] opts the optional parameters
864
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
767
865
  # @return [MailboxIdentityResponse]
768
866
  def mailbox_get_identity(opts = {})
769
867
  data, _status_code, _headers = mailbox_get_identity_with_http_info(opts)
@@ -773,6 +871,7 @@ module Sendmux::Mailbox::Generated
773
871
  # Get mailbox sender identity
774
872
  # Returns the default sender identity and signatures for the authenticated mailbox.
775
873
  # @param [Hash] opts the optional parameters
874
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
776
875
  # @return [Array<(MailboxIdentityResponse, Integer, Hash)>] MailboxIdentityResponse data, response status code and response headers
777
876
  def mailbox_get_identity_with_http_info(opts = {})
778
877
  if @api_client.config.debugging
@@ -783,6 +882,7 @@ module Sendmux::Mailbox::Generated
783
882
 
784
883
  # query parameters
785
884
  query_params = opts[:query_params] || {}
885
+ query_params[:'mailbox_id'] = opts[:'mailbox_id'] if !opts[:'mailbox_id'].nil?
786
886
 
787
887
  # header parameters
788
888
  header_params = opts[:header_params] || {}
@@ -822,6 +922,7 @@ module Sendmux::Mailbox::Generated
822
922
  # Returns the mailbox the bearer token is scoped to, including live storage usage. Intended for SDK auto-discovery — call once on startup to resolve the mailbox ID. Requires a mailbox-scoped API key; root keys receive 403. Responses carry a weak `ETag` header — send it back as `If-None-Match` on the next request and the server will return `304 Not Modified` (no body) when the mailbox state has not changed.
823
923
  # @param [Hash] opts the optional parameters
824
924
  # @option opts [String] :if_none_match
925
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
825
926
  # @return [MailboxMeItemResponse]
826
927
  def mailbox_get_me(opts = {})
827
928
  data, _status_code, _headers = mailbox_get_me_with_http_info(opts)
@@ -832,6 +933,7 @@ module Sendmux::Mailbox::Generated
832
933
  # Returns the mailbox the bearer token is scoped to, including live storage usage. Intended for SDK auto-discovery — call once on startup to resolve the mailbox ID. Requires a mailbox-scoped API key; root keys receive 403. Responses carry a weak &#x60;ETag&#x60; header — send it back as &#x60;If-None-Match&#x60; on the next request and the server will return &#x60;304 Not Modified&#x60; (no body) when the mailbox state has not changed.
833
934
  # @param [Hash] opts the optional parameters
834
935
  # @option opts [String] :if_none_match
936
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
835
937
  # @return [Array<(MailboxMeItemResponse, Integer, Hash)>] MailboxMeItemResponse data, response status code and response headers
836
938
  def mailbox_get_me_with_http_info(opts = {})
837
939
  if @api_client.config.debugging
@@ -842,6 +944,7 @@ module Sendmux::Mailbox::Generated
842
944
 
843
945
  # query parameters
844
946
  query_params = opts[:query_params] || {}
947
+ query_params[:'mailbox_id'] = opts[:'mailbox_id'] if !opts[:'mailbox_id'].nil?
845
948
 
846
949
  # header parameters
847
950
  header_params = opts[:header_params] || {}
@@ -879,10 +982,11 @@ module Sendmux::Mailbox::Generated
879
982
  end
880
983
 
881
984
  # Get a mailbox message
882
- # Returns one message from the authenticated mailbox. Responses include a weak `ETag` header.
985
+ # Returns one message from the authenticated mailbox. Responses include a weak `ETag` header. When attachment metadata includes short-lived download URLs, a conditional request may return `200` even when the stable message ETag matches so the response can renew expired URLs.
883
986
  # @param message_id [String]
884
987
  # @param [Hash] opts the optional parameters
885
988
  # @option opts [String] :if_none_match
989
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
886
990
  # @return [MailboxMessageDetailResponse]
887
991
  def mailbox_get_message(message_id, opts = {})
888
992
  data, _status_code, _headers = mailbox_get_message_with_http_info(message_id, opts)
@@ -890,10 +994,11 @@ module Sendmux::Mailbox::Generated
890
994
  end
891
995
 
892
996
  # Get a mailbox message
893
- # Returns one message from the authenticated mailbox. Responses include a weak &#x60;ETag&#x60; header.
997
+ # Returns one message from the authenticated mailbox. Responses include a weak &#x60;ETag&#x60; header. When attachment metadata includes short-lived download URLs, a conditional request may return &#x60;200&#x60; even when the stable message ETag matches so the response can renew expired URLs.
894
998
  # @param message_id [String]
895
999
  # @param [Hash] opts the optional parameters
896
1000
  # @option opts [String] :if_none_match
1001
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
897
1002
  # @return [Array<(MailboxMessageDetailResponse, Integer, Hash)>] MailboxMessageDetailResponse data, response status code and response headers
898
1003
  def mailbox_get_message_with_http_info(message_id, opts = {})
899
1004
  if @api_client.config.debugging
@@ -908,6 +1013,7 @@ module Sendmux::Mailbox::Generated
908
1013
 
909
1014
  # query parameters
910
1015
  query_params = opts[:query_params] || {}
1016
+ query_params[:'mailbox_id'] = opts[:'mailbox_id'] if !opts[:'mailbox_id'].nil?
911
1017
 
912
1018
  # header parameters
913
1019
  header_params = opts[:header_params] || {}
@@ -945,11 +1051,13 @@ module Sendmux::Mailbox::Generated
945
1051
  end
946
1052
 
947
1053
  # Download a message attachment
948
- # Streams one attachment from a message in the authenticated mailbox. Supports standard byte ranges.
1054
+ # Streams one attachment from a message through the authenticated endpoint. Attachment metadata also provides short-lived download URLs for clients that cannot set request headers. Supports standard byte ranges.
949
1055
  # @param message_id [String]
950
1056
  # @param attachment_id [String]
951
1057
  # @param [Hash] opts the optional parameters
952
1058
  # @option opts [String] :range
1059
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
1060
+ # @option opts [String] :download_token
953
1061
  # @return [nil]
954
1062
  def mailbox_get_message_attachment(message_id, attachment_id, opts = {})
955
1063
  mailbox_get_message_attachment_with_http_info(message_id, attachment_id, opts)
@@ -957,11 +1065,13 @@ module Sendmux::Mailbox::Generated
957
1065
  end
958
1066
 
959
1067
  # Download a message attachment
960
- # Streams one attachment from a message in the authenticated mailbox. Supports standard byte ranges.
1068
+ # Streams one attachment from a message through the authenticated endpoint. Attachment metadata also provides short-lived download URLs for clients that cannot set request headers. Supports standard byte ranges.
961
1069
  # @param message_id [String]
962
1070
  # @param attachment_id [String]
963
1071
  # @param [Hash] opts the optional parameters
964
1072
  # @option opts [String] :range
1073
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
1074
+ # @option opts [String] :download_token
965
1075
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
966
1076
  def mailbox_get_message_attachment_with_http_info(message_id, attachment_id, opts = {})
967
1077
  if @api_client.config.debugging
@@ -980,6 +1090,8 @@ module Sendmux::Mailbox::Generated
980
1090
 
981
1091
  # query parameters
982
1092
  query_params = opts[:query_params] || {}
1093
+ query_params[:'mailbox_id'] = opts[:'mailbox_id'] if !opts[:'mailbox_id'].nil?
1094
+ query_params[:'download_token'] = opts[:'download_token'] if !opts[:'download_token'].nil?
983
1095
 
984
1096
  # header parameters
985
1097
  header_params = opts[:header_params] || {}
@@ -1021,6 +1133,7 @@ module Sendmux::Mailbox::Generated
1021
1133
  # @param [Hash] opts the optional parameters
1022
1134
  # @option opts [String] :since_state
1023
1135
  # @option opts [Integer] :limit
1136
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
1024
1137
  # @return [MailboxChangesResponse]
1025
1138
  def mailbox_get_quota_changes(opts = {})
1026
1139
  data, _status_code, _headers = mailbox_get_quota_changes_with_http_info(opts)
@@ -1032,6 +1145,7 @@ module Sendmux::Mailbox::Generated
1032
1145
  # @param [Hash] opts the optional parameters
1033
1146
  # @option opts [String] :since_state
1034
1147
  # @option opts [Integer] :limit
1148
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
1035
1149
  # @return [Array<(MailboxChangesResponse, Integer, Hash)>] MailboxChangesResponse data, response status code and response headers
1036
1150
  def mailbox_get_quota_changes_with_http_info(opts = {})
1037
1151
  if @api_client.config.debugging
@@ -1052,6 +1166,7 @@ module Sendmux::Mailbox::Generated
1052
1166
  query_params = opts[:query_params] || {}
1053
1167
  query_params[:'since_state'] = opts[:'since_state'] if !opts[:'since_state'].nil?
1054
1168
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
1169
+ query_params[:'mailbox_id'] = opts[:'mailbox_id'] if !opts[:'mailbox_id'].nil?
1055
1170
 
1056
1171
  # header parameters
1057
1172
  header_params = opts[:header_params] || {}
@@ -1091,6 +1206,7 @@ module Sendmux::Mailbox::Generated
1091
1206
  # Returns mailbox API capabilities, resource state tokens, limits, and disabled feature flags for the authenticated mailbox.
1092
1207
  # @param [Hash] opts the optional parameters
1093
1208
  # @option opts [String] :if_none_match
1209
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
1094
1210
  # @return [MailboxSessionResponse]
1095
1211
  def mailbox_get_session(opts = {})
1096
1212
  data, _status_code, _headers = mailbox_get_session_with_http_info(opts)
@@ -1101,6 +1217,7 @@ module Sendmux::Mailbox::Generated
1101
1217
  # Returns mailbox API capabilities, resource state tokens, limits, and disabled feature flags for the authenticated mailbox.
1102
1218
  # @param [Hash] opts the optional parameters
1103
1219
  # @option opts [String] :if_none_match
1220
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
1104
1221
  # @return [Array<(MailboxSessionResponse, Integer, Hash)>] MailboxSessionResponse data, response status code and response headers
1105
1222
  def mailbox_get_session_with_http_info(opts = {})
1106
1223
  if @api_client.config.debugging
@@ -1111,6 +1228,7 @@ module Sendmux::Mailbox::Generated
1111
1228
 
1112
1229
  # query parameters
1113
1230
  query_params = opts[:query_params] || {}
1231
+ query_params[:'mailbox_id'] = opts[:'mailbox_id'] if !opts[:'mailbox_id'].nil?
1114
1232
 
1115
1233
  # header parameters
1116
1234
  header_params = opts[:header_params] || {}
@@ -1152,6 +1270,7 @@ module Sendmux::Mailbox::Generated
1152
1270
  # @param submission_id [String]
1153
1271
  # @param [Hash] opts the optional parameters
1154
1272
  # @option opts [String] :if_none_match
1273
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
1155
1274
  # @return [MailboxSubmissionResponse]
1156
1275
  def mailbox_get_submission(submission_id, opts = {})
1157
1276
  data, _status_code, _headers = mailbox_get_submission_with_http_info(submission_id, opts)
@@ -1163,6 +1282,7 @@ module Sendmux::Mailbox::Generated
1163
1282
  # @param submission_id [String]
1164
1283
  # @param [Hash] opts the optional parameters
1165
1284
  # @option opts [String] :if_none_match
1285
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
1166
1286
  # @return [Array<(MailboxSubmissionResponse, Integer, Hash)>] MailboxSubmissionResponse data, response status code and response headers
1167
1287
  def mailbox_get_submission_with_http_info(submission_id, opts = {})
1168
1288
  if @api_client.config.debugging
@@ -1177,6 +1297,7 @@ module Sendmux::Mailbox::Generated
1177
1297
 
1178
1298
  # query parameters
1179
1299
  query_params = opts[:query_params] || {}
1300
+ query_params[:'mailbox_id'] = opts[:'mailbox_id'] if !opts[:'mailbox_id'].nil?
1180
1301
 
1181
1302
  # header parameters
1182
1303
  header_params = opts[:header_params] || {}
@@ -1218,6 +1339,7 @@ module Sendmux::Mailbox::Generated
1218
1339
  # @param [Hash] opts the optional parameters
1219
1340
  # @option opts [String] :since_state
1220
1341
  # @option opts [Integer] :limit
1342
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
1221
1343
  # @return [MailboxChangesResponse]
1222
1344
  def mailbox_get_submission_changes(opts = {})
1223
1345
  data, _status_code, _headers = mailbox_get_submission_changes_with_http_info(opts)
@@ -1229,6 +1351,7 @@ module Sendmux::Mailbox::Generated
1229
1351
  # @param [Hash] opts the optional parameters
1230
1352
  # @option opts [String] :since_state
1231
1353
  # @option opts [Integer] :limit
1354
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
1232
1355
  # @return [Array<(MailboxChangesResponse, Integer, Hash)>] MailboxChangesResponse data, response status code and response headers
1233
1356
  def mailbox_get_submission_changes_with_http_info(opts = {})
1234
1357
  if @api_client.config.debugging
@@ -1249,6 +1372,7 @@ module Sendmux::Mailbox::Generated
1249
1372
  query_params = opts[:query_params] || {}
1250
1373
  query_params[:'since_state'] = opts[:'since_state'] if !opts[:'since_state'].nil?
1251
1374
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
1375
+ query_params[:'mailbox_id'] = opts[:'mailbox_id'] if !opts[:'mailbox_id'].nil?
1252
1376
 
1253
1377
  # header parameters
1254
1378
  header_params = opts[:header_params] || {}
@@ -1289,6 +1413,7 @@ module Sendmux::Mailbox::Generated
1289
1413
  # @param thread_id [String]
1290
1414
  # @param [Hash] opts the optional parameters
1291
1415
  # @option opts [String] :if_none_match
1416
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
1292
1417
  # @return [MailboxThreadDetailResponse]
1293
1418
  def mailbox_get_thread(thread_id, opts = {})
1294
1419
  data, _status_code, _headers = mailbox_get_thread_with_http_info(thread_id, opts)
@@ -1300,6 +1425,7 @@ module Sendmux::Mailbox::Generated
1300
1425
  # @param thread_id [String]
1301
1426
  # @param [Hash] opts the optional parameters
1302
1427
  # @option opts [String] :if_none_match
1428
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
1303
1429
  # @return [Array<(MailboxThreadDetailResponse, Integer, Hash)>] MailboxThreadDetailResponse data, response status code and response headers
1304
1430
  def mailbox_get_thread_with_http_info(thread_id, opts = {})
1305
1431
  if @api_client.config.debugging
@@ -1314,6 +1440,7 @@ module Sendmux::Mailbox::Generated
1314
1440
 
1315
1441
  # query parameters
1316
1442
  query_params = opts[:query_params] || {}
1443
+ query_params[:'mailbox_id'] = opts[:'mailbox_id'] if !opts[:'mailbox_id'].nil?
1317
1444
 
1318
1445
  # header parameters
1319
1446
  header_params = opts[:header_params] || {}
@@ -1366,6 +1493,7 @@ module Sendmux::Mailbox::Generated
1366
1493
  # @option opts [Integer] :limit
1367
1494
  # @option opts [String] :sort
1368
1495
  # @option opts [String] :if_none_match
1496
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
1369
1497
  # @return [MailboxThreadContentResponse]
1370
1498
  def mailbox_get_thread_content(thread_id, opts = {})
1371
1499
  data, _status_code, _headers = mailbox_get_thread_content_with_http_info(thread_id, opts)
@@ -1388,6 +1516,7 @@ module Sendmux::Mailbox::Generated
1388
1516
  # @option opts [Integer] :limit
1389
1517
  # @option opts [String] :sort
1390
1518
  # @option opts [String] :if_none_match
1519
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
1391
1520
  # @return [Array<(MailboxThreadContentResponse, Integer, Hash)>] MailboxThreadContentResponse data, response status code and response headers
1392
1521
  def mailbox_get_thread_content_with_http_info(thread_id, opts = {})
1393
1522
  if @api_client.config.debugging
@@ -1445,6 +1574,7 @@ module Sendmux::Mailbox::Generated
1445
1574
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
1446
1575
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
1447
1576
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
1577
+ query_params[:'mailbox_id'] = opts[:'mailbox_id'] if !opts[:'mailbox_id'].nil?
1448
1578
 
1449
1579
  # header parameters
1450
1580
  header_params = opts[:header_params] || {}
@@ -1488,6 +1618,7 @@ module Sendmux::Mailbox::Generated
1488
1618
  # @option opts [String] :part
1489
1619
  # @option opts [Integer] :max_body_chars
1490
1620
  # @option opts [String] :if_none_match
1621
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
1491
1622
  # @return [MailboxRawBodyResponse]
1492
1623
  def mailbox_list_body(message_id, opts = {})
1493
1624
  data, _status_code, _headers = mailbox_list_body_with_http_info(message_id, opts)
@@ -1501,6 +1632,7 @@ module Sendmux::Mailbox::Generated
1501
1632
  # @option opts [String] :part
1502
1633
  # @option opts [Integer] :max_body_chars
1503
1634
  # @option opts [String] :if_none_match
1635
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
1504
1636
  # @return [Array<(MailboxRawBodyResponse, Integer, Hash)>] MailboxRawBodyResponse data, response status code and response headers
1505
1637
  def mailbox_list_body_with_http_info(message_id, opts = {})
1506
1638
  if @api_client.config.debugging
@@ -1529,6 +1661,7 @@ module Sendmux::Mailbox::Generated
1529
1661
  query_params = opts[:query_params] || {}
1530
1662
  query_params[:'part'] = opts[:'part'] if !opts[:'part'].nil?
1531
1663
  query_params[:'max_body_chars'] = opts[:'max_body_chars'] if !opts[:'max_body_chars'].nil?
1664
+ query_params[:'mailbox_id'] = opts[:'mailbox_id'] if !opts[:'mailbox_id'].nil?
1532
1665
 
1533
1666
  # header parameters
1534
1667
  header_params = opts[:header_params] || {}
@@ -1578,6 +1711,7 @@ module Sendmux::Mailbox::Generated
1578
1711
  # @option opts [String] :include_headers
1579
1712
  # @option opts [String] :include_attachments
1580
1713
  # @option opts [String] :if_none_match
1714
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
1581
1715
  # @return [MailboxMessageContentResponse]
1582
1716
  def mailbox_list_content(message_id, opts = {})
1583
1717
  data, _status_code, _headers = mailbox_list_content_with_http_info(message_id, opts)
@@ -1597,6 +1731,7 @@ module Sendmux::Mailbox::Generated
1597
1731
  # @option opts [String] :include_headers
1598
1732
  # @option opts [String] :include_attachments
1599
1733
  # @option opts [String] :if_none_match
1734
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
1600
1735
  # @return [Array<(MailboxMessageContentResponse, Integer, Hash)>] MailboxMessageContentResponse data, response status code and response headers
1601
1736
  def mailbox_list_content_with_http_info(message_id, opts = {})
1602
1737
  if @api_client.config.debugging
@@ -1639,6 +1774,7 @@ module Sendmux::Mailbox::Generated
1639
1774
  query_params[:'include_html'] = opts[:'include_html'] if !opts[:'include_html'].nil?
1640
1775
  query_params[:'include_headers'] = opts[:'include_headers'] if !opts[:'include_headers'].nil?
1641
1776
  query_params[:'include_attachments'] = opts[:'include_attachments'] if !opts[:'include_attachments'].nil?
1777
+ query_params[:'mailbox_id'] = opts[:'mailbox_id'] if !opts[:'mailbox_id'].nil?
1642
1778
 
1643
1779
  # header parameters
1644
1780
  header_params = opts[:header_params] || {}
@@ -1680,6 +1816,7 @@ module Sendmux::Mailbox::Generated
1680
1816
  # @param [Hash] opts the optional parameters
1681
1817
  # @option opts [String] :cursor
1682
1818
  # @option opts [Integer] :limit
1819
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
1683
1820
  # @return [MailboxFolderCursorListResponse]
1684
1821
  def mailbox_list_folders(opts = {})
1685
1822
  data, _status_code, _headers = mailbox_list_folders_with_http_info(opts)
@@ -1691,6 +1828,7 @@ module Sendmux::Mailbox::Generated
1691
1828
  # @param [Hash] opts the optional parameters
1692
1829
  # @option opts [String] :cursor
1693
1830
  # @option opts [Integer] :limit
1831
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
1694
1832
  # @return [Array<(MailboxFolderCursorListResponse, Integer, Hash)>] MailboxFolderCursorListResponse data, response status code and response headers
1695
1833
  def mailbox_list_folders_with_http_info(opts = {})
1696
1834
  if @api_client.config.debugging
@@ -1711,6 +1849,7 @@ module Sendmux::Mailbox::Generated
1711
1849
  query_params = opts[:query_params] || {}
1712
1850
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
1713
1851
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
1852
+ query_params[:'mailbox_id'] = opts[:'mailbox_id'] if !opts[:'mailbox_id'].nil?
1714
1853
 
1715
1854
  # header parameters
1716
1855
  header_params = opts[:header_params] || {}
@@ -1746,11 +1885,86 @@ module Sendmux::Mailbox::Generated
1746
1885
  return data, status_code, headers
1747
1886
  end
1748
1887
 
1888
+ # List granted mailboxes
1889
+ # Lists the mailboxes available to the current mailbox credential or connected app. Use this before choosing a `mailbox_id` for mailbox actions when more than one mailbox is available.
1890
+ # @param [Hash] opts the optional parameters
1891
+ # @option opts [String] :cursor
1892
+ # @option opts [Integer] :limit
1893
+ # @option opts [String] :q
1894
+ # @return [GrantedMailboxListResponse]
1895
+ def mailbox_list_granted_mailboxes(opts = {})
1896
+ data, _status_code, _headers = mailbox_list_granted_mailboxes_with_http_info(opts)
1897
+ data
1898
+ end
1899
+
1900
+ # List granted mailboxes
1901
+ # Lists the mailboxes available to the current mailbox credential or connected app. Use this before choosing a &#x60;mailbox_id&#x60; for mailbox actions when more than one mailbox is available.
1902
+ # @param [Hash] opts the optional parameters
1903
+ # @option opts [String] :cursor
1904
+ # @option opts [Integer] :limit
1905
+ # @option opts [String] :q
1906
+ # @return [Array<(GrantedMailboxListResponse, Integer, Hash)>] GrantedMailboxListResponse data, response status code and response headers
1907
+ def mailbox_list_granted_mailboxes_with_http_info(opts = {})
1908
+ if @api_client.config.debugging
1909
+ @api_client.config.logger.debug 'Calling API: MailboxAPIApi.mailbox_list_granted_mailboxes ...'
1910
+ end
1911
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
1912
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling MailboxAPIApi.mailbox_list_granted_mailboxes, must be smaller than or equal to 100.'
1913
+ end
1914
+
1915
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
1916
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling MailboxAPIApi.mailbox_list_granted_mailboxes, must be greater than or equal to 1.'
1917
+ end
1918
+
1919
+ # resource path
1920
+ local_var_path = '/mailbox/mailboxes'
1921
+
1922
+ # query parameters
1923
+ query_params = opts[:query_params] || {}
1924
+ query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
1925
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
1926
+ query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
1927
+
1928
+ # header parameters
1929
+ header_params = opts[:header_params] || {}
1930
+ # HTTP header 'Accept' (if needed)
1931
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1932
+
1933
+ # form parameters
1934
+ form_params = opts[:form_params] || {}
1935
+
1936
+ # http body (model)
1937
+ post_body = opts[:debug_body]
1938
+
1939
+ # return_type
1940
+ return_type = opts[:debug_return_type] || 'GrantedMailboxListResponse'
1941
+
1942
+ # auth_names
1943
+ auth_names = opts[:debug_auth_names] || ['bearerAuth']
1944
+
1945
+ new_options = opts.merge(
1946
+ :operation => :"MailboxAPIApi.mailbox_list_granted_mailboxes",
1947
+ :header_params => header_params,
1948
+ :query_params => query_params,
1949
+ :form_params => form_params,
1950
+ :body => post_body,
1951
+ :auth_names => auth_names,
1952
+ :return_type => return_type
1953
+ )
1954
+
1955
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1956
+ if @api_client.config.debugging
1957
+ @api_client.config.logger.debug "API called: MailboxAPIApi#mailbox_list_granted_mailboxes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1958
+ end
1959
+ return data, status_code, headers
1960
+ end
1961
+
1749
1962
  # List mailbox sender identities
1750
1963
  # Returns sender identities available to the authenticated mailbox.
1751
1964
  # @param [Hash] opts the optional parameters
1752
1965
  # @option opts [String] :cursor
1753
1966
  # @option opts [Integer] :limit
1967
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
1754
1968
  # @return [MailboxIdentityCursorListResponse]
1755
1969
  def mailbox_list_identities(opts = {})
1756
1970
  data, _status_code, _headers = mailbox_list_identities_with_http_info(opts)
@@ -1762,6 +1976,7 @@ module Sendmux::Mailbox::Generated
1762
1976
  # @param [Hash] opts the optional parameters
1763
1977
  # @option opts [String] :cursor
1764
1978
  # @option opts [Integer] :limit
1979
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
1765
1980
  # @return [Array<(MailboxIdentityCursorListResponse, Integer, Hash)>] MailboxIdentityCursorListResponse data, response status code and response headers
1766
1981
  def mailbox_list_identities_with_http_info(opts = {})
1767
1982
  if @api_client.config.debugging
@@ -1782,6 +1997,7 @@ module Sendmux::Mailbox::Generated
1782
1997
  query_params = opts[:query_params] || {}
1783
1998
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
1784
1999
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
2000
+ query_params[:'mailbox_id'] = opts[:'mailbox_id'] if !opts[:'mailbox_id'].nil?
1785
2001
 
1786
2002
  # header parameters
1787
2003
  header_params = opts[:header_params] || {}
@@ -1843,6 +2059,7 @@ module Sendmux::Mailbox::Generated
1843
2059
  # @option opts [Boolean] :is_unread
1844
2060
  # @option opts [String] :sort_by
1845
2061
  # @option opts [String] :sort_direction
2062
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
1846
2063
  # @return [MailboxMessageSummaryCursorListResponse]
1847
2064
  def mailbox_list_messages(opts = {})
1848
2065
  data, _status_code, _headers = mailbox_list_messages_with_http_info(opts)
@@ -1875,6 +2092,7 @@ module Sendmux::Mailbox::Generated
1875
2092
  # @option opts [Boolean] :is_unread
1876
2093
  # @option opts [String] :sort_by
1877
2094
  # @option opts [String] :sort_direction
2095
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
1878
2096
  # @return [Array<(MailboxMessageSummaryCursorListResponse, Integer, Hash)>] MailboxMessageSummaryCursorListResponse data, response status code and response headers
1879
2097
  def mailbox_list_messages_with_http_info(opts = {})
1880
2098
  if @api_client.config.debugging
@@ -1932,6 +2150,7 @@ module Sendmux::Mailbox::Generated
1932
2150
  query_params[:'is_unread'] = opts[:'is_unread'] if !opts[:'is_unread'].nil?
1933
2151
  query_params[:'sort_by'] = opts[:'sort_by'] if !opts[:'sort_by'].nil?
1934
2152
  query_params[:'sort_direction'] = opts[:'sort_direction'] if !opts[:'sort_direction'].nil?
2153
+ query_params[:'mailbox_id'] = opts[:'mailbox_id'] if !opts[:'mailbox_id'].nil?
1935
2154
 
1936
2155
  # header parameters
1937
2156
  header_params = opts[:header_params] || {}
@@ -1978,6 +2197,7 @@ module Sendmux::Mailbox::Generated
1978
2197
  # @option opts [String] :type
1979
2198
  # @option opts [String] :sort_by
1980
2199
  # @option opts [String] :sort_direction
2200
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
1981
2201
  # @return [MailboxQuotaCursorListResponse]
1982
2202
  def mailbox_list_quotas(opts = {})
1983
2203
  data, _status_code, _headers = mailbox_list_quotas_with_http_info(opts)
@@ -1995,6 +2215,7 @@ module Sendmux::Mailbox::Generated
1995
2215
  # @option opts [String] :type
1996
2216
  # @option opts [String] :sort_by
1997
2217
  # @option opts [String] :sort_direction
2218
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
1998
2219
  # @return [Array<(MailboxQuotaCursorListResponse, Integer, Hash)>] MailboxQuotaCursorListResponse data, response status code and response headers
1999
2220
  def mailbox_list_quotas_with_http_info(opts = {})
2000
2221
  if @api_client.config.debugging
@@ -2037,6 +2258,7 @@ module Sendmux::Mailbox::Generated
2037
2258
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
2038
2259
  query_params[:'sort_by'] = opts[:'sort_by'] if !opts[:'sort_by'].nil?
2039
2260
  query_params[:'sort_direction'] = opts[:'sort_direction'] if !opts[:'sort_direction'].nil?
2261
+ query_params[:'mailbox_id'] = opts[:'mailbox_id'] if !opts[:'mailbox_id'].nil?
2040
2262
 
2041
2263
  # header parameters
2042
2264
  header_params = opts[:header_params] || {}
@@ -2085,6 +2307,7 @@ module Sendmux::Mailbox::Generated
2085
2307
  # @option opts [String] :before
2086
2308
  # @option opts [String] :sort_by
2087
2309
  # @option opts [String] :sort_direction
2310
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
2088
2311
  # @return [MailboxSubmissionCursorListResponse]
2089
2312
  def mailbox_list_submissions(opts = {})
2090
2313
  data, _status_code, _headers = mailbox_list_submissions_with_http_info(opts)
@@ -2104,6 +2327,7 @@ module Sendmux::Mailbox::Generated
2104
2327
  # @option opts [String] :before
2105
2328
  # @option opts [String] :sort_by
2106
2329
  # @option opts [String] :sort_direction
2330
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
2107
2331
  # @return [Array<(MailboxSubmissionCursorListResponse, Integer, Hash)>] MailboxSubmissionCursorListResponse data, response status code and response headers
2108
2332
  def mailbox_list_submissions_with_http_info(opts = {})
2109
2333
  if @api_client.config.debugging
@@ -2144,6 +2368,7 @@ module Sendmux::Mailbox::Generated
2144
2368
  query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
2145
2369
  query_params[:'sort_by'] = opts[:'sort_by'] if !opts[:'sort_by'].nil?
2146
2370
  query_params[:'sort_direction'] = opts[:'sort_direction'] if !opts[:'sort_direction'].nil?
2371
+ query_params[:'mailbox_id'] = opts[:'mailbox_id'] if !opts[:'mailbox_id'].nil?
2147
2372
 
2148
2373
  # header parameters
2149
2374
  header_params = opts[:header_params] || {}
@@ -2186,6 +2411,7 @@ module Sendmux::Mailbox::Generated
2186
2411
  # @option opts [String] :cursor
2187
2412
  # @option opts [Integer] :limit
2188
2413
  # @option opts [String] :sort
2414
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
2189
2415
  # @return [MailboxMessageSummaryCursorListResponse]
2190
2416
  def mailbox_list_thread_messages(thread_id, opts = {})
2191
2417
  data, _status_code, _headers = mailbox_list_thread_messages_with_http_info(thread_id, opts)
@@ -2199,6 +2425,7 @@ module Sendmux::Mailbox::Generated
2199
2425
  # @option opts [String] :cursor
2200
2426
  # @option opts [Integer] :limit
2201
2427
  # @option opts [String] :sort
2428
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
2202
2429
  # @return [Array<(MailboxMessageSummaryCursorListResponse, Integer, Hash)>] MailboxMessageSummaryCursorListResponse data, response status code and response headers
2203
2430
  def mailbox_list_thread_messages_with_http_info(thread_id, opts = {})
2204
2431
  if @api_client.config.debugging
@@ -2228,6 +2455,7 @@ module Sendmux::Mailbox::Generated
2228
2455
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
2229
2456
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
2230
2457
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
2458
+ query_params[:'mailbox_id'] = opts[:'mailbox_id'] if !opts[:'mailbox_id'].nil?
2231
2459
 
2232
2460
  # header parameters
2233
2461
  header_params = opts[:header_params] || {}
@@ -2276,6 +2504,7 @@ module Sendmux::Mailbox::Generated
2276
2504
  # @option opts [Boolean] :has_attachment
2277
2505
  # @option opts [Boolean] :is_unread
2278
2506
  # @option opts [String] :sort_direction
2507
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
2279
2508
  # @return [MailboxThreadSummaryCursorListResponse]
2280
2509
  def mailbox_list_threads(opts = {})
2281
2510
  data, _status_code, _headers = mailbox_list_threads_with_http_info(opts)
@@ -2295,6 +2524,7 @@ module Sendmux::Mailbox::Generated
2295
2524
  # @option opts [Boolean] :has_attachment
2296
2525
  # @option opts [Boolean] :is_unread
2297
2526
  # @option opts [String] :sort_direction
2527
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
2298
2528
  # @return [Array<(MailboxThreadSummaryCursorListResponse, Integer, Hash)>] MailboxThreadSummaryCursorListResponse data, response status code and response headers
2299
2529
  def mailbox_list_threads_with_http_info(opts = {})
2300
2530
  if @api_client.config.debugging
@@ -2327,6 +2557,7 @@ module Sendmux::Mailbox::Generated
2327
2557
  query_params[:'has_attachment'] = opts[:'has_attachment'] if !opts[:'has_attachment'].nil?
2328
2558
  query_params[:'is_unread'] = opts[:'is_unread'] if !opts[:'is_unread'].nil?
2329
2559
  query_params[:'sort_direction'] = opts[:'sort_direction'] if !opts[:'sort_direction'].nil?
2560
+ query_params[:'mailbox_id'] = opts[:'mailbox_id'] if !opts[:'mailbox_id'].nil?
2330
2561
 
2331
2562
  # header parameters
2332
2563
  header_params = opts[:header_params] || {}
@@ -2366,6 +2597,7 @@ module Sendmux::Mailbox::Generated
2366
2597
  # Returns a compact usage view derived from mailbox quota records. Responses include a weak `ETag` header.
2367
2598
  # @param [Hash] opts the optional parameters
2368
2599
  # @option opts [String] :if_none_match
2600
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
2369
2601
  # @return [MailboxUsageResponse]
2370
2602
  def mailbox_list_usage(opts = {})
2371
2603
  data, _status_code, _headers = mailbox_list_usage_with_http_info(opts)
@@ -2376,6 +2608,7 @@ module Sendmux::Mailbox::Generated
2376
2608
  # Returns a compact usage view derived from mailbox quota records. Responses include a weak &#x60;ETag&#x60; header.
2377
2609
  # @param [Hash] opts the optional parameters
2378
2610
  # @option opts [String] :if_none_match
2611
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
2379
2612
  # @return [Array<(MailboxUsageResponse, Integer, Hash)>] MailboxUsageResponse data, response status code and response headers
2380
2613
  def mailbox_list_usage_with_http_info(opts = {})
2381
2614
  if @api_client.config.debugging
@@ -2386,6 +2619,7 @@ module Sendmux::Mailbox::Generated
2386
2619
 
2387
2620
  # query parameters
2388
2621
  query_params = opts[:query_params] || {}
2622
+ query_params[:'mailbox_id'] = opts[:'mailbox_id'] if !opts[:'mailbox_id'].nil?
2389
2623
 
2390
2624
  # header parameters
2391
2625
  header_params = opts[:header_params] || {}
@@ -2427,6 +2661,7 @@ module Sendmux::Mailbox::Generated
2427
2661
  # @param [Hash] opts the optional parameters
2428
2662
  # @option opts [String] :since_query_state
2429
2663
  # @option opts [Integer] :limit
2664
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
2430
2665
  # @return [MailboxFolderQueryChangesResponse]
2431
2666
  def mailbox_query_folder_changes(opts = {})
2432
2667
  data, _status_code, _headers = mailbox_query_folder_changes_with_http_info(opts)
@@ -2438,6 +2673,7 @@ module Sendmux::Mailbox::Generated
2438
2673
  # @param [Hash] opts the optional parameters
2439
2674
  # @option opts [String] :since_query_state
2440
2675
  # @option opts [Integer] :limit
2676
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
2441
2677
  # @return [Array<(MailboxFolderQueryChangesResponse, Integer, Hash)>] MailboxFolderQueryChangesResponse data, response status code and response headers
2442
2678
  def mailbox_query_folder_changes_with_http_info(opts = {})
2443
2679
  if @api_client.config.debugging
@@ -2458,6 +2694,7 @@ module Sendmux::Mailbox::Generated
2458
2694
  query_params = opts[:query_params] || {}
2459
2695
  query_params[:'since_query_state'] = opts[:'since_query_state'] if !opts[:'since_query_state'].nil?
2460
2696
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
2697
+ query_params[:'mailbox_id'] = opts[:'mailbox_id'] if !opts[:'mailbox_id'].nil?
2461
2698
 
2462
2699
  # header parameters
2463
2700
  header_params = opts[:header_params] || {}
@@ -2520,6 +2757,7 @@ module Sendmux::Mailbox::Generated
2520
2757
  # @option opts [Boolean] :is_unread
2521
2758
  # @option opts [String] :sort_by
2522
2759
  # @option opts [String] :sort_direction
2760
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
2523
2761
  # @return [MailboxMessageQueryChangesResponse]
2524
2762
  def mailbox_query_message_changes(opts = {})
2525
2763
  data, _status_code, _headers = mailbox_query_message_changes_with_http_info(opts)
@@ -2553,6 +2791,7 @@ module Sendmux::Mailbox::Generated
2553
2791
  # @option opts [Boolean] :is_unread
2554
2792
  # @option opts [String] :sort_by
2555
2793
  # @option opts [String] :sort_direction
2794
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
2556
2795
  # @return [Array<(MailboxMessageQueryChangesResponse, Integer, Hash)>] MailboxMessageQueryChangesResponse data, response status code and response headers
2557
2796
  def mailbox_query_message_changes_with_http_info(opts = {})
2558
2797
  if @api_client.config.debugging
@@ -2611,6 +2850,7 @@ module Sendmux::Mailbox::Generated
2611
2850
  query_params[:'is_unread'] = opts[:'is_unread'] if !opts[:'is_unread'].nil?
2612
2851
  query_params[:'sort_by'] = opts[:'sort_by'] if !opts[:'sort_by'].nil?
2613
2852
  query_params[:'sort_direction'] = opts[:'sort_direction'] if !opts[:'sort_direction'].nil?
2853
+ query_params[:'mailbox_id'] = opts[:'mailbox_id'] if !opts[:'mailbox_id'].nil?
2614
2854
 
2615
2855
  # header parameters
2616
2856
  header_params = opts[:header_params] || {}
@@ -2669,6 +2909,7 @@ module Sendmux::Mailbox::Generated
2669
2909
  # @option opts [Boolean] :is_unread
2670
2910
  # @option opts [String] :message_ids
2671
2911
  # @option opts [Integer] :limit
2912
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
2672
2913
  # @return [MailboxSearchSnippetsResultResponse]
2673
2914
  def mailbox_search_message_snippets(q, opts = {})
2674
2915
  data, _status_code, _headers = mailbox_search_message_snippets_with_http_info(q, opts)
@@ -2698,6 +2939,7 @@ module Sendmux::Mailbox::Generated
2698
2939
  # @option opts [Boolean] :is_unread
2699
2940
  # @option opts [String] :message_ids
2700
2941
  # @option opts [Integer] :limit
2942
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
2701
2943
  # @return [Array<(MailboxSearchSnippetsResultResponse, Integer, Hash)>] MailboxSearchSnippetsResultResponse data, response status code and response headers
2702
2944
  def mailbox_search_message_snippets_with_http_info(q, opts = {})
2703
2945
  if @api_client.config.debugging
@@ -2748,6 +2990,7 @@ module Sendmux::Mailbox::Generated
2748
2990
  query_params[:'is_unread'] = opts[:'is_unread'] if !opts[:'is_unread'].nil?
2749
2991
  query_params[:'message_ids'] = opts[:'message_ids'] if !opts[:'message_ids'].nil?
2750
2992
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
2993
+ query_params[:'mailbox_id'] = opts[:'mailbox_id'] if !opts[:'mailbox_id'].nil?
2751
2994
 
2752
2995
  # header parameters
2753
2996
  header_params = opts[:header_params] || {}
@@ -2784,9 +3027,10 @@ module Sendmux::Mailbox::Generated
2784
3027
  end
2785
3028
 
2786
3029
  # Send a mailbox message
2787
- # Creates and queues a message from the authenticated mailbox. Supply an `Idempotency-Key` header to safely retry. Attachments may use small inline base64 content or blob IDs returned by `POST /mailbox/attachments:upload`.
3030
+ # Creates and queues a message from the authenticated mailbox. Supply an `Idempotency-Key` header to safely retry. Attachments may use small inline base64 content or blob IDs returned by `POST /mailbox/attachments:upload` or `POST /mailbox/attachment-uploads`.
2788
3031
  # @param [Hash] opts the optional parameters
2789
3032
  # @option opts [String] :idempotency_key
3033
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
2790
3034
  # @option opts [SendMailboxMessageBody] :send_mailbox_message_body
2791
3035
  # @return [MailboxSendResultResponse]
2792
3036
  def mailbox_send_message(opts = {})
@@ -2795,9 +3039,10 @@ module Sendmux::Mailbox::Generated
2795
3039
  end
2796
3040
 
2797
3041
  # Send a mailbox message
2798
- # Creates and queues a message from the authenticated mailbox. Supply an &#x60;Idempotency-Key&#x60; header to safely retry. Attachments may use small inline base64 content or blob IDs returned by &#x60;POST /mailbox/attachments:upload&#x60;.
3042
+ # Creates and queues a message from the authenticated mailbox. Supply an &#x60;Idempotency-Key&#x60; header to safely retry. Attachments may use small inline base64 content or blob IDs returned by &#x60;POST /mailbox/attachments:upload&#x60; or &#x60;POST /mailbox/attachment-uploads&#x60;.
2799
3043
  # @param [Hash] opts the optional parameters
2800
3044
  # @option opts [String] :idempotency_key
3045
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
2801
3046
  # @option opts [SendMailboxMessageBody] :send_mailbox_message_body
2802
3047
  # @return [Array<(MailboxSendResultResponse, Integer, Hash)>] MailboxSendResultResponse data, response status code and response headers
2803
3048
  def mailbox_send_message_with_http_info(opts = {})
@@ -2813,6 +3058,7 @@ module Sendmux::Mailbox::Generated
2813
3058
 
2814
3059
  # query parameters
2815
3060
  query_params = opts[:query_params] || {}
3061
+ query_params[:'mailbox_id'] = opts[:'mailbox_id'] if !opts[:'mailbox_id'].nil?
2816
3062
 
2817
3063
  # header parameters
2818
3064
  header_params = opts[:header_params] || {}
@@ -2862,6 +3108,7 @@ module Sendmux::Mailbox::Generated
2862
3108
  # @option opts [Integer] :ping
2863
3109
  # @option opts [Integer] :close_after
2864
3110
  # @option opts [String] :last_event_id2
3111
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
2865
3112
  # @return [MailboxRealtimeEvent]
2866
3113
  def mailbox_stream_events(opts = {})
2867
3114
  data, _status_code, _headers = mailbox_stream_events_with_http_info(opts)
@@ -2876,6 +3123,7 @@ module Sendmux::Mailbox::Generated
2876
3123
  # @option opts [Integer] :ping
2877
3124
  # @option opts [Integer] :close_after
2878
3125
  # @option opts [String] :last_event_id2
3126
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
2879
3127
  # @return [Array<(MailboxRealtimeEvent, Integer, Hash)>] MailboxRealtimeEvent data, response status code and response headers
2880
3128
  def mailbox_stream_events_with_http_info(opts = {})
2881
3129
  if @api_client.config.debugging
@@ -2906,6 +3154,7 @@ module Sendmux::Mailbox::Generated
2906
3154
  query_params[:'last_event_id'] = opts[:'last_event_id'] if !opts[:'last_event_id'].nil?
2907
3155
  query_params[:'ping'] = opts[:'ping'] if !opts[:'ping'].nil?
2908
3156
  query_params[:'close_after'] = opts[:'close_after'] if !opts[:'close_after'].nil?
3157
+ query_params[:'mailbox_id'] = opts[:'mailbox_id'] if !opts[:'mailbox_id'].nil?
2909
3158
 
2910
3159
  # header parameters
2911
3160
  header_params = opts[:header_params] || {}
@@ -2943,10 +3192,11 @@ module Sendmux::Mailbox::Generated
2943
3192
  end
2944
3193
 
2945
3194
  # Update a mailbox folder
2946
- # Updates a folder with state-safe conflict handling. Send `If-Match` with a prior ETag to reject stale edits.
3195
+ # Updates a folder unconditionally unless `If-Match` is supplied. Send `If-Match` with a prior ETag to reject stale edits.
2947
3196
  # @param folder_id [String]
2948
3197
  # @param [Hash] opts the optional parameters
2949
3198
  # @option opts [String] :if_match
3199
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
2950
3200
  # @option opts [PatchMailboxFolderBody] :patch_mailbox_folder_body
2951
3201
  # @return [MailboxFolderResponse]
2952
3202
  def mailbox_update_folder(folder_id, opts = {})
@@ -2955,10 +3205,11 @@ module Sendmux::Mailbox::Generated
2955
3205
  end
2956
3206
 
2957
3207
  # Update a mailbox folder
2958
- # Updates a folder with state-safe conflict handling. Send &#x60;If-Match&#x60; with a prior ETag to reject stale edits.
3208
+ # Updates a folder unconditionally unless &#x60;If-Match&#x60; is supplied. Send &#x60;If-Match&#x60; with a prior ETag to reject stale edits.
2959
3209
  # @param folder_id [String]
2960
3210
  # @param [Hash] opts the optional parameters
2961
3211
  # @option opts [String] :if_match
3212
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
2962
3213
  # @option opts [PatchMailboxFolderBody] :patch_mailbox_folder_body
2963
3214
  # @return [Array<(MailboxFolderResponse, Integer, Hash)>] MailboxFolderResponse data, response status code and response headers
2964
3215
  def mailbox_update_folder_with_http_info(folder_id, opts = {})
@@ -2974,6 +3225,7 @@ module Sendmux::Mailbox::Generated
2974
3225
 
2975
3226
  # query parameters
2976
3227
  query_params = opts[:query_params] || {}
3228
+ query_params[:'mailbox_id'] = opts[:'mailbox_id'] if !opts[:'mailbox_id'].nil?
2977
3229
 
2978
3230
  # header parameters
2979
3231
  header_params = opts[:header_params] || {}
@@ -3018,6 +3270,7 @@ module Sendmux::Mailbox::Generated
3018
3270
  # Update mailbox sender identity
3019
3271
  # Updates the default sender name, plain text signature, and HTML signature for the authenticated mailbox.
3020
3272
  # @param [Hash] opts the optional parameters
3273
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
3021
3274
  # @option opts [UpdateMailboxIdentityBody] :update_mailbox_identity_body
3022
3275
  # @return [MailboxIdentityResponse]
3023
3276
  def mailbox_update_identity(opts = {})
@@ -3028,6 +3281,7 @@ module Sendmux::Mailbox::Generated
3028
3281
  # Update mailbox sender identity
3029
3282
  # Updates the default sender name, plain text signature, and HTML signature for the authenticated mailbox.
3030
3283
  # @param [Hash] opts the optional parameters
3284
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
3031
3285
  # @option opts [UpdateMailboxIdentityBody] :update_mailbox_identity_body
3032
3286
  # @return [Array<(MailboxIdentityResponse, Integer, Hash)>] MailboxIdentityResponse data, response status code and response headers
3033
3287
  def mailbox_update_identity_with_http_info(opts = {})
@@ -3039,6 +3293,7 @@ module Sendmux::Mailbox::Generated
3039
3293
 
3040
3294
  # query parameters
3041
3295
  query_params = opts[:query_params] || {}
3296
+ query_params[:'mailbox_id'] = opts[:'mailbox_id'] if !opts[:'mailbox_id'].nil?
3042
3297
 
3043
3298
  # header parameters
3044
3299
  header_params = opts[:header_params] || {}
@@ -3080,10 +3335,11 @@ module Sendmux::Mailbox::Generated
3080
3335
  end
3081
3336
 
3082
3337
  # Update mailbox message flags
3083
- # Updates mutable message flags and keywords with state-safe conflict handling. Send `If-Match` with a prior ETag to reject stale edits.
3338
+ # Updates mutable message flags and keywords unconditionally unless `If-Match` is supplied. Send `If-Match` with a prior ETag to reject stale edits.
3084
3339
  # @param message_id [String]
3085
3340
  # @param [Hash] opts the optional parameters
3086
3341
  # @option opts [String] :if_match
3342
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
3087
3343
  # @option opts [PatchMailboxMessageBody] :patch_mailbox_message_body
3088
3344
  # @return [MailboxMessageDetailResponse]
3089
3345
  def mailbox_update_message(message_id, opts = {})
@@ -3092,10 +3348,11 @@ module Sendmux::Mailbox::Generated
3092
3348
  end
3093
3349
 
3094
3350
  # Update mailbox message flags
3095
- # Updates mutable message flags and keywords with state-safe conflict handling. Send &#x60;If-Match&#x60; with a prior ETag to reject stale edits.
3351
+ # Updates mutable message flags and keywords unconditionally unless &#x60;If-Match&#x60; is supplied. Send &#x60;If-Match&#x60; with a prior ETag to reject stale edits.
3096
3352
  # @param message_id [String]
3097
3353
  # @param [Hash] opts the optional parameters
3098
3354
  # @option opts [String] :if_match
3355
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
3099
3356
  # @option opts [PatchMailboxMessageBody] :patch_mailbox_message_body
3100
3357
  # @return [Array<(MailboxMessageDetailResponse, Integer, Hash)>] MailboxMessageDetailResponse data, response status code and response headers
3101
3358
  def mailbox_update_message_with_http_info(message_id, opts = {})
@@ -3111,6 +3368,7 @@ module Sendmux::Mailbox::Generated
3111
3368
 
3112
3369
  # query parameters
3113
3370
  query_params = opts[:query_params] || {}
3371
+ query_params[:'mailbox_id'] = opts[:'mailbox_id'] if !opts[:'mailbox_id'].nil?
3114
3372
 
3115
3373
  # header parameters
3116
3374
  header_params = opts[:header_params] || {}
@@ -3156,6 +3414,7 @@ module Sendmux::Mailbox::Generated
3156
3414
  # Uploads one attachment as binary data and returns a blob ID that can be supplied to `POST /mailbox/messages/send`.
3157
3415
  # @param filename [String]
3158
3416
  # @param [Hash] opts the optional parameters
3417
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
3159
3418
  # @option opts [File] :body
3160
3419
  # @return [MailboxAttachmentUploadResultResponse]
3161
3420
  def mailbox_upload_attachment(filename, opts = {})
@@ -3167,6 +3426,7 @@ module Sendmux::Mailbox::Generated
3167
3426
  # Uploads one attachment as binary data and returns a blob ID that can be supplied to &#x60;POST /mailbox/messages/send&#x60;.
3168
3427
  # @param filename [String]
3169
3428
  # @param [Hash] opts the optional parameters
3429
+ # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
3170
3430
  # @option opts [File] :body
3171
3431
  # @return [Array<(MailboxAttachmentUploadResultResponse, Integer, Hash)>] MailboxAttachmentUploadResultResponse data, response status code and response headers
3172
3432
  def mailbox_upload_attachment_with_http_info(filename, opts = {})
@@ -3183,6 +3443,7 @@ module Sendmux::Mailbox::Generated
3183
3443
  # query parameters
3184
3444
  query_params = opts[:query_params] || {}
3185
3445
  query_params[:'filename'] = filename
3446
+ query_params[:'mailbox_id'] = opts[:'mailbox_id'] if !opts[:'mailbox_id'].nil?
3186
3447
 
3187
3448
  # header parameters
3188
3449
  header_params = opts[:header_params] || {}