qubrics-mailbox 3.0.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.
- checksums.yaml +7 -0
- data/CHANGELOG.md +108 -0
- data/LICENSE +21 -0
- data/README.md +183 -0
- data/lib/qubrics/mailbox/client.rb +63 -0
- data/lib/qubrics/mailbox/version.rb +7 -0
- data/lib/qubrics/mailbox.rb +12 -0
- data/lib/qubrics_mailbox_generated/api/mailbox_api_api.rb +4371 -0
- data/lib/qubrics_mailbox_generated/api_client.rb +447 -0
- data/lib/qubrics_mailbox_generated/api_error.rb +58 -0
- data/lib/qubrics_mailbox_generated/api_model_base.rb +95 -0
- data/lib/qubrics_mailbox_generated/configuration.rb +400 -0
- data/lib/qubrics_mailbox_generated/models/api_error_detail.rb +219 -0
- data/lib/qubrics_mailbox_generated/models/api_error_error.rb +275 -0
- data/lib/qubrics_mailbox_generated/models/api_error_meta.rb +164 -0
- data/lib/qubrics_mailbox_generated/models/api_error_response.rb +216 -0
- data/lib/qubrics_mailbox_generated/models/batch_delete_mailbox_messages_body.rb +205 -0
- data/lib/qubrics_mailbox_generated/models/batch_update_mailbox_messages_body.rb +227 -0
- data/lib/qubrics_mailbox_generated/models/connection.rb +273 -0
- data/lib/qubrics_mailbox_generated/models/connection_credential.rb +226 -0
- data/lib/qubrics_mailbox_generated/models/connection_mailboxes_inner.rb +190 -0
- data/lib/qubrics_mailbox_generated/models/connection_response.rb +223 -0
- data/lib/qubrics_mailbox_generated/models/connection_team.rb +190 -0
- data/lib/qubrics_mailbox_generated/models/control_mailbox_draft_schedule.rb +232 -0
- data/lib/qubrics_mailbox_generated/models/create_mailbox_draft.rb +448 -0
- data/lib/qubrics_mailbox_generated/models/create_mailbox_draft_attachments_inner.rb +400 -0
- data/lib/qubrics_mailbox_generated/models/create_mailbox_draft_bcc_inner.rb +200 -0
- data/lib/qubrics_mailbox_generated/models/create_mailbox_draft_from.rb +201 -0
- data/lib/qubrics_mailbox_generated/models/create_mailbox_draft_source.rb +235 -0
- data/lib/qubrics_mailbox_generated/models/create_mailbox_folder_body.rb +183 -0
- data/lib/qubrics_mailbox_generated/models/cursor_pagination.rb +173 -0
- data/lib/qubrics_mailbox_generated/models/granted_mailbox.rb +192 -0
- data/lib/qubrics_mailbox_generated/models/granted_mailbox_list_response.rb +251 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_address.rb +176 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_attachment.rb +250 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_attachment_text.rb +337 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_attachment_text_response.rb +223 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_attachment_upload_intent_body.rb +228 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_attachment_upload_intent_result.rb +323 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_attachment_upload_intent_result_headers.rb +191 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_attachment_upload_intent_result_response.rb +223 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_attachment_upload_result.rb +243 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_attachment_upload_result_response.rb +223 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_batch_delete_messages_result.rb +248 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_batch_delete_messages_result_response.rb +223 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_batch_get_body.rb +373 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_batch_get_item.rb +188 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_batch_get_result.rb +220 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_batch_get_result_response.rb +223 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_batch_get_result_states.rb +150 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_batch_message_failure.rb +216 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_batch_message_states.rb +162 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_batch_update_messages_result.rb +248 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_batch_update_messages_result_response.rb +223 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_changes.rb +307 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_changes_response.rb +223 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_content_headers.rb +214 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_content_headers_full_inner.rb +190 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_content_headers_selected.rb +234 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_draft.rb +670 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_draft_delete_response.rb +223 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_draft_delete_response_all_of_data.rb +190 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_draft_list_response.rb +251 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_draft_response.rb +223 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_folder.rb +307 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_folder_cursor_list_response.rb +251 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_folder_deleted_response.rb +223 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_folder_query_changes.rb +270 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_folder_query_changes_added_inner.rb +190 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_folder_query_changes_response.rb +223 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_folder_response.rb +223 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_get_changes200_response.rb +103 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_identity.rb +352 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_identity_cursor_list_response.rb +251 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_identity_list_meta.rb +173 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_identity_response.rb +223 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_me.rb +294 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_me_item_response.rb +223 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_message.rb +594 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_message_content.rb +348 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_message_content_body.rb +352 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_message_content_body_html_cleaning.rb +241 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_message_content_dates.rb +162 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_message_content_participants.rb +262 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_message_content_response.rb +223 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_message_content_states.rb +176 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_message_count.rb +176 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_message_count_response.rb +223 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_message_deleted_response.rb +223 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_message_detail_response.rb +223 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_message_flags.rb +242 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_message_query_changes.rb +270 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_message_query_changes_response.rb +223 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_message_summary.rb +454 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_message_summary_cursor_list_response.rb +251 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_query_meta.rb +173 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_quota.rb +359 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_quota_cursor_list_response.rb +251 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_raw_body.rb +279 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_raw_body_body.rb +200 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_raw_body_response.rb +223 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_realtime_event.rb +366 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_realtime_message.rb +492 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_realtime_message_body.rb +214 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_search_snippet.rb +190 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_search_snippets_result.rb +206 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_search_snippets_result_response.rb +223 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_send_result_response.rb +223 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_send_scope.rb +213 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_sender_choices.rb +217 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_sender_choices_from.rb +213 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_sender_choices_reply_to.rb +213 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_sender_choices_response.rb +223 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_session.rb +294 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_session_capabilities.rb +346 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_session_capabilities_attachments.rb +294 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_session_capabilities_folders.rb +320 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_session_capabilities_identities.rb +268 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_session_capabilities_messages.rb +516 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_session_capabilities_quotas.rb +242 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_session_capabilities_submissions.rb +242 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_session_capabilities_sync.rb +222 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_session_capabilities_threads.rb +268 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_session_endpoints.rb +334 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_session_gated.rb +451 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_session_limits.rb +448 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_session_mailbox.rb +203 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_session_response.rb +223 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_session_states.rb +294 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_submission.rb +321 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_submission_cursor_list_response.rb +251 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_submission_delivery_status.rb +200 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_submission_envelope.rb +178 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_submission_envelope_address.rb +178 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_submission_response.rb +223 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_sync_meta.rb +173 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_thread.rb +377 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_thread_content_meta.rb +244 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_thread_content_meta_states.rb +188 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_thread_content_response.rb +251 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_thread_detail_response.rb +223 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_thread_message_summary_cursor_list_response.rb +251 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_thread_messages_meta.rb +199 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_thread_summary.rb +349 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_thread_summary_cursor_list_response.rb +251 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_thread_summary_states.rb +162 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_typed_changes.rb +164 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_typed_changes_response.rb +223 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_typed_changes_types.rb +192 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_usage.rb +192 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_usage_resource.rb +408 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_usage_response.rb +223 -0
- data/lib/qubrics_mailbox_generated/models/mailbox_usage_states.rb +150 -0
- data/lib/qubrics_mailbox_generated/models/patch_mailbox_folder_body.rb +166 -0
- data/lib/qubrics_mailbox_generated/models/patch_mailbox_message_body.rb +168 -0
- data/lib/qubrics_mailbox_generated/models/response_meta.rb +164 -0
- data/lib/qubrics_mailbox_generated/models/send_mailbox_draft.rb +222 -0
- data/lib/qubrics_mailbox_generated/models/send_mailbox_message_body.rb +326 -0
- data/lib/qubrics_mailbox_generated/models/send_mailbox_message_body_attachments_inner.rb +103 -0
- data/lib/qubrics_mailbox_generated/models/send_mailbox_message_body_attachments_inner_any_of.rb +217 -0
- data/lib/qubrics_mailbox_generated/models/send_mailbox_message_body_attachments_inner_any_of1.rb +217 -0
- data/lib/qubrics_mailbox_generated/models/send_mailbox_message_result.rb +214 -0
- data/lib/qubrics_mailbox_generated/models/success_envelope.rb +192 -0
- data/lib/qubrics_mailbox_generated/models/update_mailbox_draft.rb +437 -0
- data/lib/qubrics_mailbox_generated/models/update_mailbox_identity_body.rb +216 -0
- data/lib/qubrics_mailbox_generated/version.rb +15 -0
- data/lib/qubrics_mailbox_generated.rb +210 -0
- metadata +290 -0
checksums.yaml
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
---
|
|
2
|
+
SHA256:
|
|
3
|
+
metadata.gz: 7d3130292e9c343cb771d9ec5b35f4e18fe6789b6bc6481df30db771b64f8d1b
|
|
4
|
+
data.tar.gz: b56cd530d4a9296ede3761f0205107f85e047925051f89e6625eea85d6102fbe
|
|
5
|
+
SHA512:
|
|
6
|
+
metadata.gz: ed386aebc02037f8f9fa3e74b8e68c5cb139ee86837705e3c12c060a991172ff93cd8b07a9d3a4256b01235206e449cae79557e1f69dfbe547ab121ce6d86c45
|
|
7
|
+
data.tar.gz: 71980b24f0df5b421329035d08fba56f9631ba062cd1e90dfe86933d972eb2c1c1b106bbc9d11ee499675a4bcdc32b011558743658b6716236d417323df5cbaa
|
data/CHANGELOG.md
ADDED
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
## 3.0.0
|
|
4
|
+
|
|
5
|
+
### Changed
|
|
6
|
+
|
|
7
|
+
* Calendar operations and models are excluded from this release.
|
|
8
|
+
* Requires `qubrics-core >= 2.0.0, < 3.0`.
|
|
9
|
+
|
|
10
|
+
## [2.0.2](https://github.com/Sendmux/sendmux-sdk/compare/ruby-mailbox/v2.0.1...ruby-mailbox/v2.0.2) (2026-09-21)
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
### Fixed
|
|
14
|
+
|
|
15
|
+
* **Regenerated models:** `mailbox_get_message` and `mailbox_update_message` results (`MailboxMessageDetailResponse#data`, a `Sendmux::Mailbox::Generated::MailboxMessage`) now carry `message_id`, `in_reply_to` and `references` (`Array<String>`, angle brackets removed) and `reply_to` (`Array<MailboxAddress>`), matching the deployed app schema; 2.0.1 had no attributes for those four fields, so they were dropped on deserialisation and reply and threading headers were unreachable from the typed result. `mailbox_list_content` returns `data` typed as the canonical `MailboxMessageContent`, `mailbox_get_thread_content` returns `data` typed as `Array<MailboxMessageContent>`, `mailbox_list_body` returns `data` typed as `MailboxRawBody`, and `MailboxSubmissionEnvelope#rcpt_to` (`mailbox_get_submission`, `mailbox_list_submissions`) is `Array<MailboxSubmissionEnvelopeAddress>`, instead of the generator's `…AllOfData` and `…RcptToInner` copies of those classes. The wire format is unchanged, and `from`, `raw_body` and `send_scope` are unchanged. The four new attributes are required, so a `MailboxMessage` you construct yourself (fixtures, mocks, wrappers) must now supply them — assigning `nil` or omitting one raises `ArgumentError` — while reading API results is unaffected ([ea211b7](https://github.com/Sendmux/sendmux-sdk/commit/ea211b70ecc1d22404c441ee5fa0d791c7c14e1d)).
|
|
16
|
+
|
|
17
|
+
### Deprecated
|
|
18
|
+
|
|
19
|
+
* `Sendmux::Mailbox::Generated::MailboxMessageContentResponseAllOfData` and `MailboxThreadContentResponseAllOfData` are now deprecated constants aliasing `MailboxMessageContent`, `MailboxRawBodyResponseAllOfData` aliases `MailboxRawBody`, and `MailboxSubmissionEnvelopeRcptToInner` aliases `MailboxSubmissionEnvelopeAddress`. Referencing an old constant still works and, with `Warning[:deprecated]` enabled (`ruby -W:deprecated`), warns that it is deprecated; the aliases are removed in the next major, 3.0 ([ea211b7](https://github.com/Sendmux/sendmux-sdk/commit/ea211b70ecc1d22404c441ee5fa0d791c7c14e1d)).
|
|
20
|
+
|
|
21
|
+
## Verification behind each claim
|
|
22
|
+
|
|
23
|
+
- Operation → model mapping from `packages/ruby/mailbox/lib/sendmux_mailbox_generated/api/*.rb` at f6629095: `mailbox_get_message`/`mailbox_update_message` → `MailboxMessageDetailResponse` (`data: MailboxMessage`, `models/mailbox_message_detail_response.rb:48`); `mailbox_list_content` → `MailboxMessageContentResponse`; `mailbox_get_thread_content` → `MailboxThreadContentResponse`; `mailbox_list_body` → `MailboxRawBodyResponse`; `mailbox_get_submission`/`mailbox_list_submissions` → `MailboxSubmission#envelope` (`models/mailbox_submission.rb:71`).
|
|
24
|
+
- ea211b7 diff: `models/mailbox_message.rb` +118 (four `attr_accessor`s, `Array<String>`/`Array<MailboxAddress>` types, `cannot be nil` validators and writers); `models/mailbox_thread_content_response.rb` `Array<MailboxThreadContentResponseAllOfData>` → `Array<MailboxMessageContent>`; four `…all_of_data.rb`/`…rcpt_to_inner.rb` files deleted (1190 lines); `sendmux_mailbox_generated.rb` adds the four `deprecate_constant` aliases.
|
|
25
|
+
- Isolated install of the built gem (`.claude/artifacts/l22/ruby-mailbox/smoke.log`): types and aliases as stated, 4 deprecation warnings under `-W:deprecated`, `m.message_id = nil` → `ArgumentError: message_id cannot be nil`, `MailboxMessage.new({})` → `ArgumentError: bcc cannot be nil` (first required attribute in order; the four new ones are required too — `openapi_nullable` excludes them).
|
|
26
|
+
- Published `sendmux-mailbox-2.0.1.gem` vs the candidate: 12 member differences, exactly `CHANGELOG.md`, `version.rb`, the five regenerated models, the loader and the four removed copies (`diff-published-2.0.1-vs-candidate-2.0.2.txt`).
|
|
27
|
+
|
|
28
|
+
### Bug Fixes
|
|
29
|
+
|
|
30
|
+
* **ruby-mailbox:** regenerate mailbox models from the deployed v1.8.250 schema ([ea211b7](https://github.com/Sendmux/sendmux-sdk/commit/ea211b70ecc1d22404c441ee5fa0d791c7c14e1d))
|
|
31
|
+
|
|
32
|
+
## [2.0.1](https://github.com/Sendmux/sendmux-sdk/compare/ruby-mailbox/v2.0.0...ruby-mailbox/v2.0.1) (2026-09-20)
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
### Deprecated
|
|
36
|
+
|
|
37
|
+
* `Sendmux::Mailbox::Generated::MailboxRealtimeMessageAllOfBody` is now a deprecated constant aliasing `Sendmux::Mailbox::Generated::MailboxRealtimeMessageBody`, the class of `MailboxRealtimeMessage#body`. Referencing the old constant still works and, with `Warning[:deprecated]` enabled (`ruby -W:deprecated`), warns that it is deprecated; the alias is removed in the next major, 3.0 ([f1108bf](https://github.com/Sendmux/sendmux-sdk/commit/f1108bf40f6c1ff3f3948b49c9ae9dd22b33b3d9)).
|
|
38
|
+
|
|
39
|
+
### Changed
|
|
40
|
+
|
|
41
|
+
* Models are regenerated from the deployed flattened response schemas (docs 86b0f45): `MailboxMe`, `MailboxMessage`, `MailboxRealtimeMessage` and `MailboxThread` are flat objects instead of `allOf` compositions and carry the same attributes, so the wire format is unchanged, `MailboxRealtimeMessageBody` is the generated name of the realtime message body, and those four classes no longer define the generator's `openapi_all_of` introspection method. The `Sendmux::Mailbox::Generated::Mailbox` model, which no operation, README, guide or test referenced, is removed without a deprecation period; `mailbox_get_me` keeps returning `MailboxMe`, which carries the same attributes plus `quota_used_bytes` ([9c05be1](https://github.com/Sendmux/sendmux-sdk/commit/9c05be1bdad88fdcbbbeedf174adce01a6a48ae7)).
|
|
42
|
+
|
|
43
|
+
### Bug Fixes
|
|
44
|
+
|
|
45
|
+
* regenerate SDKs from the deployed flattened response schemas (docs 86b0f45) ([628b161](https://github.com/Sendmux/sendmux-sdk/commit/628b161d2692775ac1f4830c1d64c024ba04ed83))
|
|
46
|
+
* **ruby-mailbox:** keep MailboxRealtimeMessageAllOfBody as a deprecated constant ([f1108bf](https://github.com/Sendmux/sendmux-sdk/commit/f1108bf40f6c1ff3f3948b49c9ae9dd22b33b3d9))
|
|
47
|
+
* **ruby-mailbox:** regenerate flattened mailbox response models ([9c05be1](https://github.com/Sendmux/sendmux-sdk/commit/9c05be1bdad88fdcbbbeedf174adce01a6a48ae7))
|
|
48
|
+
|
|
49
|
+
## [2.0.0](https://github.com/Sendmux/sendmux-sdk/compare/ruby-mailbox/v1.4.0...ruby-mailbox/v2.0.0) (2026-09-19)
|
|
50
|
+
|
|
51
|
+
### Changed
|
|
52
|
+
|
|
53
|
+
* **Breaking:** `mailbox_list_thread_messages` returns `MailboxThreadMessageSummaryCursorListResponse`, whose `meta.thread_id` is required and whose optional `meta.sync_state` is typed; thread-message results you construct (fixtures, mocks, wrappers) must now supply `thread_id`, while reading results is unaffected. `mailbox_list_messages` keeps `MailboxMessageSummaryCursorListResponse`; message, identity, submission, quota, and thread list responses replace the generic `ResponseMeta` with `MailboxSyncMeta`, `MailboxIdentityListMeta`, or `MailboxQueryMeta`, which add optional typed state metadata (`sync_state`, `identity_state`, `query_state`) ([87f54eb](https://github.com/Sendmux/sendmux-sdk/commit/87f54eb1679994ddcbdd68ad25d674ad6978f57f)). See [Migrate from 1.x to 2.0](README.md#migrate-from-1x-to-20).
|
|
54
|
+
|
|
55
|
+
### Bug Fixes
|
|
56
|
+
|
|
57
|
+
* prepare mailbox SDK major releases ([dc01472](https://github.com/Sendmux/sendmux-sdk/commit/dc014724f7f6eb6b93293e6acbcc1a36c5060ebb))
|
|
58
|
+
* **sdk:** preserve streaming arguments and prepare PHP OAuth release ([#207](https://github.com/Sendmux/sendmux-sdk/issues/207)) ([c534588](https://github.com/Sendmux/sendmux-sdk/commit/c53458875cef0bbd601c982308d84bc4e87c961c))
|
|
59
|
+
|
|
60
|
+
## [1.4.0](https://github.com/Sendmux/sendmux-sdk/compare/ruby-mailbox/v1.3.0...ruby-mailbox/v1.4.0) (2026-09-10)
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
### Features
|
|
64
|
+
|
|
65
|
+
* add REST OAuth clients and CLI token lifecycle ([cc4a3aa](https://github.com/Sendmux/sendmux-sdk/commit/cc4a3aa6110378641418a94455ed5b9a986e65ff))
|
|
66
|
+
|
|
67
|
+
## [1.3.0](https://github.com/Sendmux/sendmux-sdk/compare/ruby-mailbox/v1.2.0...ruby-mailbox/v1.3.0) (2026-09-08)
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
### Features
|
|
71
|
+
|
|
72
|
+
* regenerate mailbox models for short-lived attachment download URLs and upload intents
|
|
73
|
+
* add connection checks across SDKs, CLI and MCP ([77f449e](https://github.com/Sendmux/sendmux-sdk/commit/77f449e2c8cba49bc8bc84c49c35baa61120866a))
|
|
74
|
+
* **sdk:** add connection checks across clients, CLI and MCP ([3e02c67](https://github.com/Sendmux/sendmux-sdk/commit/3e02c67dcab45e37dad7abbdd4c4e1bd0b1fbbe6))
|
|
75
|
+
|
|
76
|
+
## [1.2.0](https://github.com/Sendmux/sendmux-sdk/compare/ruby-mailbox/v1.1.0...ruby-mailbox/v1.2.0) (2026-07-08)
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
### Features
|
|
80
|
+
|
|
81
|
+
* **sdk:** add sending attachment upload surfaces ([#96](https://github.com/Sendmux/sendmux-sdk/issues/96)) ([b8f9d5f](https://github.com/Sendmux/sendmux-sdk/commit/b8f9d5fe3c1ae510db82ce05c55cbcad92b43b44))
|
|
82
|
+
|
|
83
|
+
## [1.1.0](https://github.com/Sendmux/sendmux-sdk/compare/ruby-mailbox/v1.0.0...ruby-mailbox/v1.1.0) (2026-07-03)
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
### Features
|
|
87
|
+
|
|
88
|
+
* **sdk:** add zero-context attachment uploads ([a4352ec](https://github.com/Sendmux/sendmux-sdk/commit/a4352ecfd6f2da37c908387450fea141363d0b81))
|
|
89
|
+
* **sdk:** make mailbox attachments agent-ready ([6a145ab](https://github.com/Sendmux/sendmux-sdk/commit/6a145ab1f2735d77783fb36e84aeeeb9bc747827))
|
|
90
|
+
* **sdk:** make mailbox attachments agent-ready ([457ed62](https://github.com/Sendmux/sendmux-sdk/commit/457ed62cf32c91aeac1cfe230d50f4f0b922e7cb))
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
### Bug Fixes
|
|
94
|
+
|
|
95
|
+
* **sdk:** preserve attachment compatibility checks ([e92a1c2](https://github.com/Sendmux/sendmux-sdk/commit/e92a1c250a062f2f39a4f78c166c9e3a743e97ee))
|
|
96
|
+
* **sdk:** regenerate attachment download auth models ([6803890](https://github.com/Sendmux/sendmux-sdk/commit/6803890bad5aba610d5c6ad16ca98d7186ef9347))
|
|
97
|
+
* **sdk:** tolerate realtime events without attachments ([2d2b117](https://github.com/Sendmux/sendmux-sdk/commit/2d2b117945445b0478cf3f1d4f07b1038097f05f))
|
|
98
|
+
|
|
99
|
+
## 1.0.0 (2026-06-02)
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
### Features
|
|
103
|
+
|
|
104
|
+
* **ruby:** add generated SDK packages ([f097fdf](https://github.com/Sendmux/sendmux-sdk/commit/f097fdf6afcbc2a048d9fdb1c9a669fff2a7ca4f))
|
|
105
|
+
|
|
106
|
+
## 1.0.0
|
|
107
|
+
|
|
108
|
+
- Initial generated Ruby Mailbox API package.
|
data/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Sendmux
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
|
13
|
+
all copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
21
|
+
THE SOFTWARE.
|
data/README.md
ADDED
|
@@ -0,0 +1,183 @@
|
|
|
1
|
+
# qubrics-mailbox
|
|
2
|
+
|
|
3
|
+
[](https://rubygems.org/gems/qubrics-mailbox)
|
|
4
|
+
[](https://github.com/qubrics/qubrics-sdk/actions/workflows/ci.yml)
|
|
5
|
+
[](https://github.com/qubrics/qubrics-sdk/blob/main/LICENSE)
|
|
6
|
+
|
|
7
|
+
Ruby SDK package for the Qubrics Mailbox API.
|
|
8
|
+
|
|
9
|
+
## Documentation
|
|
10
|
+
|
|
11
|
+
- Ruby SDK guide: https://qubrics.com/docs/sdks/ruby
|
|
12
|
+
- Mailbox API reference: https://qubrics.com/docs/mailbox-api
|
|
13
|
+
- Source: https://github.com/qubrics/qubrics-sdk/tree/main/packages/ruby/mailbox
|
|
14
|
+
- Changelog: https://github.com/qubrics/qubrics-sdk/blob/main/packages/ruby/mailbox/CHANGELOG.md
|
|
15
|
+
|
|
16
|
+
## Requirements
|
|
17
|
+
|
|
18
|
+
- Ruby 3.1 or newer.
|
|
19
|
+
- A mailbox-scoped `smx_mbx_` key or scoped `smx_agent_` token.
|
|
20
|
+
|
|
21
|
+
For OAuth, use a REST access token with the scopes and mailbox access required by the operation. See [OAuth for REST APIs](https://qubrics.com/docs/developer-tools/oauth).
|
|
22
|
+
|
|
23
|
+
## Installation
|
|
24
|
+
|
|
25
|
+
Version 3.0.0 is not published yet. Calendar operations are excluded from this version.
|
|
26
|
+
|
|
27
|
+
```sh
|
|
28
|
+
gem install qubrics-mailbox
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
Or add it to your Gemfile:
|
|
32
|
+
|
|
33
|
+
```ruby
|
|
34
|
+
gem "qubrics-mailbox", "~> 3.0"
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
## Thread message model migration
|
|
38
|
+
|
|
39
|
+
If you check thread-message result classes or build thread-message fixtures by hand,
|
|
40
|
+
use the thread-specific models below. `mailbox_list_thread_messages` returns
|
|
41
|
+
`MailboxThreadMessageSummaryCursorListResponse` instead of
|
|
42
|
+
`MailboxMessageSummaryCursorListResponse`: its `meta` is
|
|
43
|
+
`MailboxThreadMessagesMeta`, whose `thread_id` is required and whose
|
|
44
|
+
`sync_state` is an optional string. Code that only reads thread-message results
|
|
45
|
+
keeps working.
|
|
46
|
+
|
|
47
|
+
1. Update thread-message class checks to use the class loaded by the public
|
|
48
|
+
entry point:
|
|
49
|
+
|
|
50
|
+
```ruby
|
|
51
|
+
require "qubrics/mailbox"
|
|
52
|
+
|
|
53
|
+
def thread_message_list?(response)
|
|
54
|
+
# Before: response.is_a?(Qubrics::Mailbox::Generated::MailboxMessageSummaryCursorListResponse)
|
|
55
|
+
response.is_a?(Qubrics::Mailbox::Generated::MailboxThreadMessageSummaryCursorListResponse)
|
|
56
|
+
end
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
2. Add the thread identity to every thread-message result you construct. Pass
|
|
60
|
+
the thread's `id` as the `thread_id` argument when you read one from the
|
|
61
|
+
public client:
|
|
62
|
+
|
|
63
|
+
```ruby
|
|
64
|
+
def thread_message_fixture(thread_id)
|
|
65
|
+
# Before: meta: { request_id: "req_fixture" }
|
|
66
|
+
Qubrics::Mailbox::Generated::MailboxThreadMessageSummaryCursorListResponse.build_from_hash(
|
|
67
|
+
ok: true,
|
|
68
|
+
meta: { request_id: "req_fixture", thread_id: thread_id },
|
|
69
|
+
data: [],
|
|
70
|
+
pagination: { has_more: false }
|
|
71
|
+
)
|
|
72
|
+
end
|
|
73
|
+
|
|
74
|
+
def thread_sync_state(client, thread_id)
|
|
75
|
+
response = client.mailbox_api.mailbox_list_thread_messages(thread_id, limit: 50)
|
|
76
|
+
[response.meta.thread_id, response.meta.sync_state]
|
|
77
|
+
end
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
Ordinary `mailbox_list_messages` results remain
|
|
81
|
+
`MailboxMessageSummaryCursorListResponse`: they have no thread identity and
|
|
82
|
+
expose an optional typed `meta.sync_state`. Identity, submission, quota, and
|
|
83
|
+
thread list responses likewise replace the generic `ResponseMeta` with
|
|
84
|
+
`MailboxIdentityListMeta` or `MailboxQueryMeta`, which add optional
|
|
85
|
+
`identity_state` or `query_state`; `meta.request_id` is unchanged everywhere
|
|
86
|
+
and no new field is required there.
|
|
87
|
+
|
|
88
|
+
3. Run your application's tests with the updated bundle. A constructed
|
|
89
|
+
thread-message result without `meta.thread_id` fails with
|
|
90
|
+
`ArgumentError: thread_id cannot be nil`.
|
|
91
|
+
|
|
92
|
+
Update `qubrics-mailbox`, the bundle lock, and affected call sites or fixtures
|
|
93
|
+
together. To roll back, restore those gem requirement, lock, and call-site
|
|
94
|
+
changes together.
|
|
95
|
+
|
|
96
|
+
## OAuth access tokens
|
|
97
|
+
|
|
98
|
+
Pass either `api_key:` or `access_token:`. `access_token:` accepts a bare token string or a callable; the callable is evaluated once per authenticated request. Your application owns token storage, expiry checks and refresh coordination.
|
|
99
|
+
|
|
100
|
+
```ruby
|
|
101
|
+
require "qubrics/mailbox"
|
|
102
|
+
|
|
103
|
+
client = Qubrics::Mailbox::Client.new(
|
|
104
|
+
access_token: -> { ENV.fetch("QUBRICS_ACCESS_TOKEN") }
|
|
105
|
+
)
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
## Usage
|
|
109
|
+
|
|
110
|
+
Create a mailbox client with a mailbox key or scoped agent token for the API-key example below.
|
|
111
|
+
|
|
112
|
+
```ruby
|
|
113
|
+
require "qubrics/mailbox"
|
|
114
|
+
|
|
115
|
+
client = Qubrics::Mailbox::Client.new(
|
|
116
|
+
api_key: ENV.fetch("QUBRICS_MAILBOX_KEY")
|
|
117
|
+
)
|
|
118
|
+
|
|
119
|
+
me = client.mailbox_api.mailbox_get_me
|
|
120
|
+
messages = client.mailbox_api.mailbox_list_messages(limit: 25)
|
|
121
|
+
|
|
122
|
+
puts me.data.email
|
|
123
|
+
puts messages.data.length
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
### Client surface
|
|
127
|
+
|
|
128
|
+
`Qubrics::Mailbox::Client` exposes `client.mailbox_api`, which contains generated mailbox operations such as:
|
|
129
|
+
|
|
130
|
+
- `mailbox_get_me`
|
|
131
|
+
- `mailbox_list_messages`
|
|
132
|
+
- `mailbox_get_message`
|
|
133
|
+
- `mailbox_send_message`
|
|
134
|
+
- `mailbox_list_threads`
|
|
135
|
+
- `mailbox_upload_attachment`
|
|
136
|
+
|
|
137
|
+
When a key grants access to more than one mailbox, pass `mailbox_id:` to operations that accept it.
|
|
138
|
+
|
|
139
|
+
### Pagination and conditional requests
|
|
140
|
+
|
|
141
|
+
Use `Qubrics::Core.each_cursor` for list operations that return cursor pagination. Use the ETag helpers for generated operations that accept `:if_match` or `:if_none_match`.
|
|
142
|
+
|
|
143
|
+
```ruby
|
|
144
|
+
pager = Qubrics::Core.each_cursor(lambda do |opts|
|
|
145
|
+
client.mailbox_api.mailbox_list_messages(opts.merge(limit: 50))
|
|
146
|
+
end)
|
|
147
|
+
|
|
148
|
+
pager.each { |message| puts message.id }
|
|
149
|
+
|
|
150
|
+
client.mailbox_api.mailbox_delete_message(
|
|
151
|
+
"msg_123",
|
|
152
|
+
Qubrics::Core::Headers.if_match('W/"etag"')
|
|
153
|
+
)
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
### Attachments and events
|
|
157
|
+
|
|
158
|
+
Message and event attachment metadata includes `download_url`, a short-lived presigned URL for that single attachment. Fetch it promptly with a plain HTTP client and no `Authorization` header. If it expires, re-fetch the message or attachment metadata to receive a fresh URL.
|
|
159
|
+
|
|
160
|
+
Use `mailbox_upload_attachment` to upload bytes and pass the returned `blob_id` into `mailbox_send_message` attachments. Inline base64 attachments remain available in the generated send body shape for small payloads.
|
|
161
|
+
|
|
162
|
+
`mailbox_stream_events` exposes the Mailbox SSE endpoint for clients that want live `message.received` events.
|
|
163
|
+
|
|
164
|
+
### Errors
|
|
165
|
+
|
|
166
|
+
Generated API errors are mapped to `Qubrics::Core::ApiError`.
|
|
167
|
+
|
|
168
|
+
```ruby
|
|
169
|
+
begin
|
|
170
|
+
client.mailbox_api.mailbox_get_message("msg_123")
|
|
171
|
+
rescue Qubrics::Core::ApiError => error
|
|
172
|
+
warn "#{error.status} #{error.code}: #{error.message}"
|
|
173
|
+
end
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
## Support
|
|
177
|
+
|
|
178
|
+
- Documentation: https://qubrics.com/docs
|
|
179
|
+
- Contact: contact@qubrics.com
|
|
180
|
+
|
|
181
|
+
## Licence
|
|
182
|
+
|
|
183
|
+
MIT licence. See https://github.com/qubrics/qubrics-sdk/blob/main/LICENSE.
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Qubrics
|
|
4
|
+
module Mailbox
|
|
5
|
+
DEFAULT_BASE_URL = 'https://app.qubrics.com/api/v1'
|
|
6
|
+
|
|
7
|
+
class ApiClient < Generated::ApiClient
|
|
8
|
+
def update_params_for_auth!(header_params, query_params, auth_names)
|
|
9
|
+
auth_names = Array(auth_names)
|
|
10
|
+
if !auth_names.empty? && (auth_names - %w[UploadTokenQubrics UploadTokenSendmux]).empty?
|
|
11
|
+
apply_upload_token_auth!(header_params)
|
|
12
|
+
return
|
|
13
|
+
end
|
|
14
|
+
return super unless config.access_token_getter && !auth_names.empty?
|
|
15
|
+
|
|
16
|
+
header_params['Authorization'] = "Bearer #{config.access_token_with_refresh}"
|
|
17
|
+
end
|
|
18
|
+
|
|
19
|
+
def call_api(...)
|
|
20
|
+
super
|
|
21
|
+
rescue Generated::ApiError => e
|
|
22
|
+
raise Qubrics::Core::ErrorMapper.map(e)
|
|
23
|
+
end
|
|
24
|
+
|
|
25
|
+
private
|
|
26
|
+
|
|
27
|
+
def apply_upload_token_auth!(header_params)
|
|
28
|
+
upload_headers = %w[X-Qubrics-Upload-Token X-Sendmux-Upload-Token]
|
|
29
|
+
return if upload_headers.any? { |header| header_params[header] || header_params[header.to_sym] }
|
|
30
|
+
|
|
31
|
+
upload_headers.each do |header|
|
|
32
|
+
token = config.api_key_with_prefix(header)
|
|
33
|
+
next if token.nil? || token.empty?
|
|
34
|
+
|
|
35
|
+
header_params[header] = token
|
|
36
|
+
break
|
|
37
|
+
end
|
|
38
|
+
end
|
|
39
|
+
end
|
|
40
|
+
|
|
41
|
+
class Client
|
|
42
|
+
attr_reader :api_client, :configuration
|
|
43
|
+
|
|
44
|
+
def initialize(api_key: nil, access_token: nil, base_url: nil, retry_options: nil)
|
|
45
|
+
qubrics_base_url = ENV.fetch('QUBRICS_BASE_URL', nil)
|
|
46
|
+
qubrics_base_url = nil if qubrics_base_url&.empty?
|
|
47
|
+
@configuration = Qubrics::Core::Auth.configure_bearer(
|
|
48
|
+
Generated::Configuration.new,
|
|
49
|
+
api_key,
|
|
50
|
+
Qubrics::Core::ApiKeySurface::MAILBOX,
|
|
51
|
+
base_url: base_url || qubrics_base_url || ENV.fetch('SENDMUX_BASE_URL', DEFAULT_BASE_URL),
|
|
52
|
+
access_token: access_token
|
|
53
|
+
)
|
|
54
|
+
Qubrics::Core::Retry.configure(@configuration, retry_options)
|
|
55
|
+
@api_client = ApiClient.new(@configuration)
|
|
56
|
+
end
|
|
57
|
+
|
|
58
|
+
def mailbox_api
|
|
59
|
+
@mailbox_api ||= Generated::MailboxAPIApi.new(@api_client)
|
|
60
|
+
end
|
|
61
|
+
end
|
|
62
|
+
end
|
|
63
|
+
end
|