@3sixty/mailbox-models 0.0.0-stage → 0.20.0-next.1

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 (175) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +24 -2
  3. package/dist/es/factories/emailConsumerFactory.js +9 -0
  4. package/dist/es/factories/emailConsumerFactory.js.map +1 -0
  5. package/dist/es/factories/emailProtocolConnectorConfigSchemaFactory.js +9 -0
  6. package/dist/es/factories/emailProtocolConnectorConfigSchemaFactory.js.map +1 -0
  7. package/dist/es/factories/emailProtocolConnectorFactory.js +9 -0
  8. package/dist/es/factories/emailProtocolConnectorFactory.js.map +1 -0
  9. package/dist/es/factories/emailProtocolConnectorStateSchemaFactory.js +11 -0
  10. package/dist/es/factories/emailProtocolConnectorStateSchemaFactory.js.map +1 -0
  11. package/dist/es/index.js +44 -0
  12. package/dist/es/index.js.map +1 -0
  13. package/dist/es/models/IEmail.js +2 -0
  14. package/dist/es/models/IEmail.js.map +1 -0
  15. package/dist/es/models/IEmailAddress.js +4 -0
  16. package/dist/es/models/IEmailAddress.js.map +1 -0
  17. package/dist/es/models/IEmailAttachment.js +4 -0
  18. package/dist/es/models/IEmailAttachment.js.map +1 -0
  19. package/dist/es/models/IEmailConsumer.js +2 -0
  20. package/dist/es/models/IEmailConsumer.js.map +1 -0
  21. package/dist/es/models/IEmailHeader.js +4 -0
  22. package/dist/es/models/IEmailHeader.js.map +1 -0
  23. package/dist/es/models/IEmailProtocolConnector.js +2 -0
  24. package/dist/es/models/IEmailProtocolConnector.js.map +1 -0
  25. package/dist/es/models/IEmailProtocolConnectorAuthCallback.js +2 -0
  26. package/dist/es/models/IEmailProtocolConnectorAuthCallback.js.map +1 -0
  27. package/dist/es/models/IEmailProtocolConnectorAuthState.js +4 -0
  28. package/dist/es/models/IEmailProtocolConnectorAuthState.js.map +1 -0
  29. package/dist/es/models/IEmailProtocolConnectorOptions.js +4 -0
  30. package/dist/es/models/IEmailProtocolConnectorOptions.js.map +1 -0
  31. package/dist/es/models/IEmailProtocolConnectorRetrievalCallback.js +2 -0
  32. package/dist/es/models/IEmailProtocolConnectorRetrievalCallback.js.map +1 -0
  33. package/dist/es/models/IMailStorageComponent.js +2 -0
  34. package/dist/es/models/IMailStorageComponent.js.map +1 -0
  35. package/dist/es/models/IMailbox.js +2 -0
  36. package/dist/es/models/IMailbox.js.map +1 -0
  37. package/dist/es/models/IMailboxComponent.js +2 -0
  38. package/dist/es/models/IMailboxComponent.js.map +1 -0
  39. package/dist/es/models/IMailboxConfigField.js +2 -0
  40. package/dist/es/models/IMailboxConfigField.js.map +1 -0
  41. package/dist/es/models/IMailboxCreateResult.js +4 -0
  42. package/dist/es/models/IMailboxCreateResult.js.map +1 -0
  43. package/dist/es/models/IMailboxUpdateResult.js +4 -0
  44. package/dist/es/models/IMailboxUpdateResult.js.map +1 -0
  45. package/dist/es/models/IStoredEmail.js +2 -0
  46. package/dist/es/models/IStoredEmail.js.map +1 -0
  47. package/dist/es/models/api/IMailStorageGetRequest.js +4 -0
  48. package/dist/es/models/api/IMailStorageGetRequest.js.map +1 -0
  49. package/dist/es/models/api/IMailStorageGetResponse.js +2 -0
  50. package/dist/es/models/api/IMailStorageGetResponse.js.map +1 -0
  51. package/dist/es/models/api/IMailStorageListRequest.js +4 -0
  52. package/dist/es/models/api/IMailStorageListRequest.js.map +1 -0
  53. package/dist/es/models/api/IMailStorageListResponse.js +2 -0
  54. package/dist/es/models/api/IMailStorageListResponse.js.map +1 -0
  55. package/dist/es/models/api/IMailStorageRemoveRequest.js +4 -0
  56. package/dist/es/models/api/IMailStorageRemoveRequest.js.map +1 -0
  57. package/dist/es/models/api/IMailboxCompleteAuthRequest.js +4 -0
  58. package/dist/es/models/api/IMailboxCompleteAuthRequest.js.map +1 -0
  59. package/dist/es/models/api/IMailboxConnectorSchemaRequest.js +4 -0
  60. package/dist/es/models/api/IMailboxConnectorSchemaRequest.js.map +1 -0
  61. package/dist/es/models/api/IMailboxConnectorSchemaResponse.js +2 -0
  62. package/dist/es/models/api/IMailboxConnectorSchemaResponse.js.map +1 -0
  63. package/dist/es/models/api/IMailboxCreateRequest.js +2 -0
  64. package/dist/es/models/api/IMailboxCreateRequest.js.map +1 -0
  65. package/dist/es/models/api/IMailboxCreateResponse.js +2 -0
  66. package/dist/es/models/api/IMailboxCreateResponse.js.map +1 -0
  67. package/dist/es/models/api/IMailboxGetRequest.js +4 -0
  68. package/dist/es/models/api/IMailboxGetRequest.js.map +1 -0
  69. package/dist/es/models/api/IMailboxGetResponse.js +2 -0
  70. package/dist/es/models/api/IMailboxGetResponse.js.map +1 -0
  71. package/dist/es/models/api/IMailboxListRequest.js +4 -0
  72. package/dist/es/models/api/IMailboxListRequest.js.map +1 -0
  73. package/dist/es/models/api/IMailboxListResponse.js +2 -0
  74. package/dist/es/models/api/IMailboxListResponse.js.map +1 -0
  75. package/dist/es/models/api/IMailboxRemoveRequest.js +4 -0
  76. package/dist/es/models/api/IMailboxRemoveRequest.js.map +1 -0
  77. package/dist/es/models/api/IMailboxUpdateRequest.js +2 -0
  78. package/dist/es/models/api/IMailboxUpdateRequest.js.map +1 -0
  79. package/dist/es/models/api/IMailboxUpdateResponse.js +2 -0
  80. package/dist/es/models/api/IMailboxUpdateResponse.js.map +1 -0
  81. package/dist/es/models/mailboxMetricIds.js +13 -0
  82. package/dist/es/models/mailboxMetricIds.js.map +1 -0
  83. package/dist/es/models/mailboxMetrics.js +16 -0
  84. package/dist/es/models/mailboxMetrics.js.map +1 -0
  85. package/dist/es/utils/mailHelper.js +92 -0
  86. package/dist/es/utils/mailHelper.js.map +1 -0
  87. package/dist/types/factories/emailConsumerFactory.d.ts +6 -0
  88. package/dist/types/factories/emailProtocolConnectorConfigSchemaFactory.d.ts +6 -0
  89. package/dist/types/factories/emailProtocolConnectorFactory.d.ts +6 -0
  90. package/dist/types/factories/emailProtocolConnectorStateSchemaFactory.d.ts +8 -0
  91. package/dist/types/index.d.ts +41 -0
  92. package/dist/types/models/IEmail.d.ts +80 -0
  93. package/dist/types/models/IEmailAddress.d.ts +13 -0
  94. package/dist/types/models/IEmailAttachment.d.ts +17 -0
  95. package/dist/types/models/IEmailConsumer.d.ts +11 -0
  96. package/dist/types/models/IEmailHeader.d.ts +17 -0
  97. package/dist/types/models/IEmailProtocolConnector.d.ts +50 -0
  98. package/dist/types/models/IEmailProtocolConnectorAuthCallback.d.ts +12 -0
  99. package/dist/types/models/IEmailProtocolConnectorAuthState.d.ts +12 -0
  100. package/dist/types/models/IEmailProtocolConnectorOptions.d.ts +19 -0
  101. package/dist/types/models/IEmailProtocolConnectorRetrievalCallback.d.ts +10 -0
  102. package/dist/types/models/IMailStorageComponent.d.ts +39 -0
  103. package/dist/types/models/IMailbox.d.ts +46 -0
  104. package/dist/types/models/IMailboxComponent.d.ts +71 -0
  105. package/dist/types/models/IMailboxConfigField.d.ts +30 -0
  106. package/dist/types/models/IMailboxCreateResult.d.ts +15 -0
  107. package/dist/types/models/IMailboxUpdateResult.d.ts +11 -0
  108. package/dist/types/models/IStoredEmail.d.ts +18 -0
  109. package/dist/types/models/api/IMailStorageGetRequest.d.ts +14 -0
  110. package/dist/types/models/api/IMailStorageGetResponse.d.ts +10 -0
  111. package/dist/types/models/api/IMailStorageListRequest.d.ts +26 -0
  112. package/dist/types/models/api/IMailStorageListResponse.d.ts +19 -0
  113. package/dist/types/models/api/IMailStorageRemoveRequest.d.ts +14 -0
  114. package/dist/types/models/api/IMailboxCompleteAuthRequest.d.ts +16 -0
  115. package/dist/types/models/api/IMailboxConnectorSchemaRequest.d.ts +14 -0
  116. package/dist/types/models/api/IMailboxConnectorSchemaResponse.d.ts +10 -0
  117. package/dist/types/models/api/IMailboxCreateRequest.d.ts +10 -0
  118. package/dist/types/models/api/IMailboxCreateResponse.d.ts +29 -0
  119. package/dist/types/models/api/IMailboxGetRequest.d.ts +14 -0
  120. package/dist/types/models/api/IMailboxGetResponse.d.ts +10 -0
  121. package/dist/types/models/api/IMailboxListRequest.d.ts +18 -0
  122. package/dist/types/models/api/IMailboxListResponse.d.ts +19 -0
  123. package/dist/types/models/api/IMailboxRemoveRequest.d.ts +14 -0
  124. package/dist/types/models/api/IMailboxUpdateRequest.d.ts +19 -0
  125. package/dist/types/models/api/IMailboxUpdateResponse.d.ts +20 -0
  126. package/dist/types/models/mailboxMetricIds.d.ts +13 -0
  127. package/dist/types/models/mailboxMetrics.d.ts +5 -0
  128. package/dist/types/utils/mailHelper.d.ts +41 -0
  129. package/docs/changelog.md +9 -0
  130. package/docs/examples.md +145 -0
  131. package/docs/reference/classes/MailHelper.md +118 -0
  132. package/docs/reference/index.md +55 -0
  133. package/docs/reference/interfaces/IEmail.md +151 -0
  134. package/docs/reference/interfaces/IEmailAddress.md +19 -0
  135. package/docs/reference/interfaces/IEmailAttachment.md +27 -0
  136. package/docs/reference/interfaces/IEmailConsumer.md +21 -0
  137. package/docs/reference/interfaces/IEmailHeader.md +27 -0
  138. package/docs/reference/interfaces/IEmailProtocolConnector.md +154 -0
  139. package/docs/reference/interfaces/IEmailProtocolConnectorAuthState.md +14 -0
  140. package/docs/reference/interfaces/IEmailProtocolConnectorOptions.md +25 -0
  141. package/docs/reference/interfaces/IMailStorageComponent.md +119 -0
  142. package/docs/reference/interfaces/IMailStorageGetRequest.md +17 -0
  143. package/docs/reference/interfaces/IMailStorageGetResponse.md +11 -0
  144. package/docs/reference/interfaces/IMailStorageListRequest.md +35 -0
  145. package/docs/reference/interfaces/IMailStorageListResponse.md +23 -0
  146. package/docs/reference/interfaces/IMailStorageRemoveRequest.md +17 -0
  147. package/docs/reference/interfaces/IMailbox.md +97 -0
  148. package/docs/reference/interfaces/IMailboxCompleteAuthRequest.md +22 -0
  149. package/docs/reference/interfaces/IMailboxComponent.md +191 -0
  150. package/docs/reference/interfaces/IMailboxConfigField.md +51 -0
  151. package/docs/reference/interfaces/IMailboxConnectorSchemaRequest.md +17 -0
  152. package/docs/reference/interfaces/IMailboxConnectorSchemaResponse.md +11 -0
  153. package/docs/reference/interfaces/IMailboxCreateRequest.md +11 -0
  154. package/docs/reference/interfaces/IMailboxCreateResponse.md +40 -0
  155. package/docs/reference/interfaces/IMailboxCreateResult.md +21 -0
  156. package/docs/reference/interfaces/IMailboxGetRequest.md +17 -0
  157. package/docs/reference/interfaces/IMailboxGetResponse.md +11 -0
  158. package/docs/reference/interfaces/IMailboxListRequest.md +23 -0
  159. package/docs/reference/interfaces/IMailboxListResponse.md +23 -0
  160. package/docs/reference/interfaces/IMailboxRemoveRequest.md +17 -0
  161. package/docs/reference/interfaces/IMailboxUpdateRequest.md +25 -0
  162. package/docs/reference/interfaces/IMailboxUpdateResponse.md +26 -0
  163. package/docs/reference/interfaces/IMailboxUpdateResult.md +13 -0
  164. package/docs/reference/interfaces/IStoredEmail.md +247 -0
  165. package/docs/reference/type-aliases/IEmailProtocolConnectorAuthCallback.md +48 -0
  166. package/docs/reference/type-aliases/IEmailProtocolConnectorRetrievalCallback.md +35 -0
  167. package/docs/reference/type-aliases/MailboxMetricIds.md +5 -0
  168. package/docs/reference/variables/EmailConsumerFactory.md +5 -0
  169. package/docs/reference/variables/EmailProtocolConnectorConfigSchemaFactory.md +5 -0
  170. package/docs/reference/variables/EmailProtocolConnectorFactory.md +5 -0
  171. package/docs/reference/variables/EmailProtocolConnectorStateSchemaFactory.md +7 -0
  172. package/docs/reference/variables/MailboxMetricIds.md +13 -0
  173. package/docs/reference/variables/MailboxMetrics.md +5 -0
  174. package/locales/en.json +1 -0
  175. package/package.json +54 -5
package/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2026 IOTA Stiftung.
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
package/README.md CHANGED
@@ -1,3 +1,25 @@
1
- # Temporary Holding Version
1
+ # 3Sixty Mailbox Models
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ This package defines the shared models and factory helpers for email mailbox ingestion.
4
+
5
+ ## Installation
6
+
7
+ ```shell
8
+ npm install @3sixty/mailbox-models
9
+ ```
10
+
11
+ ## Examples
12
+
13
+ Usage of the APIs is shown in the examples [docs/examples.md](docs/examples.md)
14
+
15
+ ## Reference
16
+
17
+ Detailed reference documentation for the API can be found in [docs/reference/index.md](docs/reference/index.md)
18
+
19
+ ## Changelog
20
+
21
+ The changes between each version can be found in [docs/changelog.md](docs/changelog.md)
22
+
23
+ ## Origin
24
+
25
+ This package is derived from the original [iotaledger/twin-messaging](https://github.com/iotaledger/twin-messaging/tree/next/packages/mailbox-models) repository.
@@ -0,0 +1,9 @@
1
+ // Copyright 2026 IOTA Stiftung.
2
+ // SPDX-License-Identifier: Apache-2.0.
3
+ import { Factory } from "@3sixty/core";
4
+ /**
5
+ * Factory for creating email consumer instances.
6
+ */
7
+ // eslint-disable-next-line @typescript-eslint/naming-convention
8
+ export const EmailConsumerFactory = Factory.createFactory("email-consumer");
9
+ //# sourceMappingURL=emailConsumerFactory.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"emailConsumerFactory.js","sources":["../../../src/factories/emailConsumerFactory.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAGvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,oBAAoB,GAAG,OAAO,CAAC,aAAa,CAAiB,gBAAgB,CAAC,CAAC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Factory } from \"@3sixty/core\";\nimport type { IEmailConsumer } from \"../models/IEmailConsumer.js\";\n\n/**\n * Factory for creating email consumer instances.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const EmailConsumerFactory = Factory.createFactory<IEmailConsumer>(\"email-consumer\");\n"]}
@@ -0,0 +1,9 @@
1
+ // Copyright 2026 IOTA Stiftung.
2
+ // SPDX-License-Identifier: Apache-2.0.
3
+ import { Factory } from "@3sixty/core";
4
+ /**
5
+ * Factory for retrieving email protocol connector configuration field definitions.
6
+ */
7
+ // eslint-disable-next-line @typescript-eslint/naming-convention
8
+ export const EmailProtocolConnectorConfigSchemaFactory = Factory.createFactory("email-protocol-config-schema");
9
+ //# sourceMappingURL=emailProtocolConnectorConfigSchemaFactory.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"emailProtocolConnectorConfigSchemaFactory.js","sources":["../../../src/factories/emailProtocolConnectorConfigSchemaFactory.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAGvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,yCAAyC,GAAG,OAAO,CAAC,aAAa,CAE5E,8BAA8B,CAAC,CAAC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Factory } from \"@3sixty/core\";\nimport type { IMailboxConfigField } from \"../models/IMailboxConfigField.js\";\n\n/**\n * Factory for retrieving email protocol connector configuration field definitions.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const EmailProtocolConnectorConfigSchemaFactory = Factory.createFactory<\n\tIMailboxConfigField[]\n>(\"email-protocol-config-schema\");\n"]}
@@ -0,0 +1,9 @@
1
+ // Copyright 2026 IOTA Stiftung.
2
+ // SPDX-License-Identifier: Apache-2.0.
3
+ import { Factory } from "@3sixty/core";
4
+ /**
5
+ * Factory for creating email protocol connectors.
6
+ */
7
+ // eslint-disable-next-line @typescript-eslint/naming-convention
8
+ export const EmailProtocolConnectorFactory = Factory.createFactory("email-protocol");
9
+ //# sourceMappingURL=emailProtocolConnectorFactory.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"emailProtocolConnectorFactory.js","sources":["../../../src/factories/emailProtocolConnectorFactory.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAGvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,6BAA6B,GACzC,OAAO,CAAC,aAAa,CAA0B,gBAAgB,CAAC,CAAC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Factory } from \"@3sixty/core\";\nimport type { IEmailProtocolConnector } from \"../models/IEmailProtocolConnector.js\";\n\n/**\n * Factory for creating email protocol connectors.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const EmailProtocolConnectorFactory =\n\tFactory.createFactory<IEmailProtocolConnector>(\"email-protocol\");\n"]}
@@ -0,0 +1,11 @@
1
+ // Copyright 2026 IOTA Stiftung.
2
+ // SPDX-License-Identifier: Apache-2.0.
3
+ import { Factory } from "@3sixty/core";
4
+ /**
5
+ * Factory for retrieving email protocol connector state field definitions.
6
+ * Only the properties a connector holds in its runtime state need registering here, and the ones
7
+ * marked secure are stored in the vault instead of alongside the rest of the state.
8
+ */
9
+ // eslint-disable-next-line @typescript-eslint/naming-convention
10
+ export const EmailProtocolConnectorStateSchemaFactory = Factory.createFactory("email-protocol-state-schema");
11
+ //# sourceMappingURL=emailProtocolConnectorStateSchemaFactory.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"emailProtocolConnectorStateSchemaFactory.js","sources":["../../../src/factories/emailProtocolConnectorStateSchemaFactory.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAGvC;;;;GAIG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,wCAAwC,GAAG,OAAO,CAAC,aAAa,CAE3E,6BAA6B,CAAC,CAAC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Factory } from \"@3sixty/core\";\nimport type { IMailboxConfigField } from \"../models/IMailboxConfigField.js\";\n\n/**\n * Factory for retrieving email protocol connector state field definitions.\n * Only the properties a connector holds in its runtime state need registering here, and the ones\n * marked secure are stored in the vault instead of alongside the rest of the state.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const EmailProtocolConnectorStateSchemaFactory = Factory.createFactory<\n\tIMailboxConfigField[]\n>(\"email-protocol-state-schema\");\n"]}
@@ -0,0 +1,44 @@
1
+ // Copyright 2026 IOTA Stiftung.
2
+ // SPDX-License-Identifier: Apache-2.0.
3
+ export * from "./factories/emailConsumerFactory.js";
4
+ export * from "./factories/emailProtocolConnectorFactory.js";
5
+ export * from "./factories/emailProtocolConnectorConfigSchemaFactory.js";
6
+ export * from "./factories/emailProtocolConnectorStateSchemaFactory.js";
7
+ export * from "./models/api/IMailboxCompleteAuthRequest.js";
8
+ export * from "./models/api/IMailboxConnectorSchemaRequest.js";
9
+ export * from "./models/api/IMailboxConnectorSchemaResponse.js";
10
+ export * from "./models/api/IMailboxCreateRequest.js";
11
+ export * from "./models/api/IMailboxCreateResponse.js";
12
+ export * from "./models/api/IMailboxGetRequest.js";
13
+ export * from "./models/api/IMailboxGetResponse.js";
14
+ export * from "./models/api/IMailboxListRequest.js";
15
+ export * from "./models/api/IMailboxListResponse.js";
16
+ export * from "./models/api/IMailboxRemoveRequest.js";
17
+ export * from "./models/api/IMailboxUpdateRequest.js";
18
+ export * from "./models/api/IMailboxUpdateResponse.js";
19
+ export * from "./models/api/IMailStorageGetRequest.js";
20
+ export * from "./models/api/IMailStorageGetResponse.js";
21
+ export * from "./models/api/IMailStorageListRequest.js";
22
+ export * from "./models/api/IMailStorageListResponse.js";
23
+ export * from "./models/api/IMailStorageRemoveRequest.js";
24
+ export * from "./models/IEmail.js";
25
+ export * from "./models/IEmailAddress.js";
26
+ export * from "./models/IEmailAttachment.js";
27
+ export * from "./models/IEmailHeader.js";
28
+ export * from "./models/IEmailConsumer.js";
29
+ export * from "./models/IEmailProtocolConnector.js";
30
+ export * from "./models/IEmailProtocolConnectorAuthCallback.js";
31
+ export * from "./models/IEmailProtocolConnectorAuthState.js";
32
+ export * from "./models/IEmailProtocolConnectorOptions.js";
33
+ export * from "./models/IEmailProtocolConnectorRetrievalCallback.js";
34
+ export * from "./models/IMailbox.js";
35
+ export * from "./models/IMailboxCreateResult.js";
36
+ export * from "./models/IMailboxUpdateResult.js";
37
+ export * from "./models/IMailboxComponent.js";
38
+ export * from "./models/IMailboxConfigField.js";
39
+ export * from "./models/IMailStorageComponent.js";
40
+ export * from "./models/IStoredEmail.js";
41
+ export * from "./models/mailboxMetricIds.js";
42
+ export * from "./models/mailboxMetrics.js";
43
+ export * from "./utils/mailHelper.js";
44
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,qCAAqC,CAAC;AACpD,cAAc,8CAA8C,CAAC;AAC7D,cAAc,0DAA0D,CAAC;AACzE,cAAc,yDAAyD,CAAC;AACxE,cAAc,6CAA6C,CAAC;AAC5D,cAAc,gDAAgD,CAAC;AAC/D,cAAc,iDAAiD,CAAC;AAChE,cAAc,uCAAuC,CAAC;AACtD,cAAc,wCAAwC,CAAC;AACvD,cAAc,oCAAoC,CAAC;AACnD,cAAc,qCAAqC,CAAC;AACpD,cAAc,qCAAqC,CAAC;AACpD,cAAc,sCAAsC,CAAC;AACrD,cAAc,uCAAuC,CAAC;AACtD,cAAc,uCAAuC,CAAC;AACtD,cAAc,wCAAwC,CAAC;AACvD,cAAc,wCAAwC,CAAC;AACvD,cAAc,yCAAyC,CAAC;AACxD,cAAc,yCAAyC,CAAC;AACxD,cAAc,0CAA0C,CAAC;AACzD,cAAc,2CAA2C,CAAC;AAC1D,cAAc,oBAAoB,CAAC;AACnC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,0BAA0B,CAAC;AACzC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,qCAAqC,CAAC;AACpD,cAAc,iDAAiD,CAAC;AAChE,cAAc,8CAA8C,CAAC;AAC7D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,sDAAsD,CAAC;AACrE,cAAc,sBAAsB,CAAC;AACrC,cAAc,kCAAkC,CAAC;AACjD,cAAc,kCAAkC,CAAC;AACjD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,iCAAiC,CAAC;AAChD,cAAc,mCAAmC,CAAC;AAClD,cAAc,0BAA0B,CAAC;AACzC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,uBAAuB,CAAC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./factories/emailConsumerFactory.js\";\nexport * from \"./factories/emailProtocolConnectorFactory.js\";\nexport * from \"./factories/emailProtocolConnectorConfigSchemaFactory.js\";\nexport * from \"./factories/emailProtocolConnectorStateSchemaFactory.js\";\nexport * from \"./models/api/IMailboxCompleteAuthRequest.js\";\nexport * from \"./models/api/IMailboxConnectorSchemaRequest.js\";\nexport * from \"./models/api/IMailboxConnectorSchemaResponse.js\";\nexport * from \"./models/api/IMailboxCreateRequest.js\";\nexport * from \"./models/api/IMailboxCreateResponse.js\";\nexport * from \"./models/api/IMailboxGetRequest.js\";\nexport * from \"./models/api/IMailboxGetResponse.js\";\nexport * from \"./models/api/IMailboxListRequest.js\";\nexport * from \"./models/api/IMailboxListResponse.js\";\nexport * from \"./models/api/IMailboxRemoveRequest.js\";\nexport * from \"./models/api/IMailboxUpdateRequest.js\";\nexport * from \"./models/api/IMailboxUpdateResponse.js\";\nexport * from \"./models/api/IMailStorageGetRequest.js\";\nexport * from \"./models/api/IMailStorageGetResponse.js\";\nexport * from \"./models/api/IMailStorageListRequest.js\";\nexport * from \"./models/api/IMailStorageListResponse.js\";\nexport * from \"./models/api/IMailStorageRemoveRequest.js\";\nexport * from \"./models/IEmail.js\";\nexport * from \"./models/IEmailAddress.js\";\nexport * from \"./models/IEmailAttachment.js\";\nexport * from \"./models/IEmailHeader.js\";\nexport * from \"./models/IEmailConsumer.js\";\nexport * from \"./models/IEmailProtocolConnector.js\";\nexport * from \"./models/IEmailProtocolConnectorAuthCallback.js\";\nexport * from \"./models/IEmailProtocolConnectorAuthState.js\";\nexport * from \"./models/IEmailProtocolConnectorOptions.js\";\nexport * from \"./models/IEmailProtocolConnectorRetrievalCallback.js\";\nexport * from \"./models/IMailbox.js\";\nexport * from \"./models/IMailboxCreateResult.js\";\nexport * from \"./models/IMailboxUpdateResult.js\";\nexport * from \"./models/IMailboxComponent.js\";\nexport * from \"./models/IMailboxConfigField.js\";\nexport * from \"./models/IMailStorageComponent.js\";\nexport * from \"./models/IStoredEmail.js\";\nexport * from \"./models/mailboxMetricIds.js\";\nexport * from \"./models/mailboxMetrics.js\";\nexport * from \"./utils/mailHelper.js\";\n"]}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=IEmail.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"IEmail.js","sources":["../../../src/models/IEmail.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IEmailAddress } from \"./IEmailAddress.js\";\nimport type { IEmailAttachment } from \"./IEmailAttachment.js\";\nimport type { IEmailHeader } from \"./IEmailHeader.js\";\n\n/**\n * Interface describing a normalised email message at the connector boundary.\n */\nexport interface IEmail {\n\t/**\n\t * The parsed message headers.\n\t */\n\theaders?: IEmailHeader[];\n\n\t/**\n\t * The unique message identifier.\n\t */\n\tmessageId?: string;\n\n\t/**\n\t * The sender address (From header).\n\t */\n\tfrom?: IEmailAddress;\n\n\t/**\n\t * The Sender header address, when different from From.\n\t */\n\tsender?: IEmailAddress;\n\n\t/**\n\t * The primary recipient addresses.\n\t */\n\tto?: IEmailAddress[];\n\n\t/**\n\t * The carbon-copy recipient addresses.\n\t */\n\tcc?: IEmailAddress[];\n\n\t/**\n\t * The blind carbon-copy recipient addresses.\n\t */\n\tbcc?: IEmailAddress[];\n\n\t/**\n\t * The reply-to addresses.\n\t */\n\treplyTo?: IEmailAddress[];\n\n\t/**\n\t * The final delivery address from the Delivered-To header.\n\t */\n\tdeliveredTo?: string;\n\n\t/**\n\t * The Return-Path address.\n\t */\n\treturnPath?: string;\n\n\t/**\n\t * The Message-ID this message is a reply to.\n\t */\n\tinReplyTo?: string;\n\n\t/**\n\t * The space-separated list of related message identifiers.\n\t */\n\treferences?: string;\n\n\t/**\n\t * The message subject.\n\t */\n\tsubject?: string;\n\n\t/**\n\t * The message date as an ISO 8601 string.\n\t */\n\tdate?: string;\n\n\t/**\n\t * The plain-text body of the message.\n\t */\n\ttextContent?: string;\n\n\t/**\n\t * The HTML body of the message.\n\t */\n\thtmlContent?: string;\n\n\t/**\n\t * The attachments included with the message.\n\t */\n\tattachments?: IEmailAttachment[];\n\n\t/**\n\t * Protocol-level flags on the message, for example \\\\Seen.\n\t */\n\tflags?: string[];\n}\n"]}
@@ -0,0 +1,4 @@
1
+ // Copyright 2026 IOTA Stiftung.
2
+ // SPDX-License-Identifier: Apache-2.0.
3
+ export {};
4
+ //# sourceMappingURL=IEmailAddress.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"IEmailAddress.js","sources":["../../../src/models/IEmailAddress.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Interface describing an email address with an optional display name.\n */\nexport interface IEmailAddress {\n\t/**\n\t * The display name for the address.\n\t */\n\tname?: string;\n\n\t/**\n\t * The email address.\n\t */\n\taddress: string;\n}\n"]}
@@ -0,0 +1,4 @@
1
+ // Copyright 2026 IOTA Stiftung.
2
+ // SPDX-License-Identifier: Apache-2.0.
3
+ export {};
4
+ //# sourceMappingURL=IEmailAttachment.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"IEmailAttachment.js","sources":["../../../src/models/IEmailAttachment.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Interface describing an email attachment.\n */\nexport interface IEmailAttachment {\n\t/**\n\t * The filename of the attachment.\n\t */\n\tfilename?: string;\n\n\t/**\n\t * The MIME content type of the attachment.\n\t */\n\tcontentType: string;\n\n\t/**\n\t * The attachment data encoded as a base64 string.\n\t */\n\tdata: string;\n}\n"]}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=IEmailConsumer.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"IEmailConsumer.js","sources":["../../../src/models/IEmailConsumer.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@3sixty/core\";\n\n/**\n * Interface describing a consumer that is notified when new emails are available.\n */\nexport interface IEmailConsumer extends IComponent {\n\t/**\n\t * Called when new emails have been stored, prompting the consumer to query for them.\n\t * @returns A promise that resolves when the consumer has processed the notification.\n\t */\n\tonNewMessages(): Promise<void>;\n}\n"]}
@@ -0,0 +1,4 @@
1
+ // Copyright 2026 IOTA Stiftung.
2
+ // SPDX-License-Identifier: Apache-2.0.
3
+ export {};
4
+ //# sourceMappingURL=IEmailHeader.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"IEmailHeader.js","sources":["../../../src/models/IEmailHeader.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Interface describing a single parsed email header.\n */\nexport interface IEmailHeader {\n\t/**\n\t * The lowercase header name.\n\t */\n\tkey: string;\n\n\t/**\n\t * The original header name preserving case.\n\t */\n\toriginalKey: string;\n\n\t/**\n\t * The header value.\n\t */\n\tvalue: string;\n}\n"]}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=IEmailProtocolConnector.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"IEmailProtocolConnector.js","sources":["../../../src/models/IEmailProtocolConnector.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@3sixty/core\";\nimport type { IEmailProtocolConnectorAuthCallback } from \"./IEmailProtocolConnectorAuthCallback.js\";\nimport type { IEmailProtocolConnectorAuthState } from \"./IEmailProtocolConnectorAuthState.js\";\nimport type { IEmailProtocolConnectorOptions } from \"./IEmailProtocolConnectorOptions.js\";\nimport type { IEmailProtocolConnectorRetrievalCallback } from \"./IEmailProtocolConnectorRetrievalCallback.js\";\n\n/**\n * Interface describing an email protocol connector that handles message retrieval.\n */\nexport interface IEmailProtocolConnector<\n\tTState = unknown,\n\tTAuthState extends IEmailProtocolConnectorAuthState = IEmailProtocolConnectorAuthState\n> extends IComponent {\n\t/**\n\t * Start the internal polling loop for the given instance.\n\t * @param instanceId The identifier of the mailbox instance being polled.\n\t * @param state The current connector state for the instance.\n\t * @param authCallback Callback invoked when authentication fails during a poll cycle.\n\t * @param retrievalCallback Callback invoked with retrieved messages after each poll cycle.\n\t * @param options Options supplied by the owning component.\n\t * @returns A promise that resolves when the polling loop has been started.\n\t */\n\tretrieve(\n\t\tinstanceId: string,\n\t\tstate: TState,\n\t\tauthCallback: IEmailProtocolConnectorAuthCallback<TAuthState>,\n\t\tretrievalCallback: IEmailProtocolConnectorRetrievalCallback,\n\t\toptions: IEmailProtocolConnectorOptions\n\t): Promise<void>;\n\n\t/**\n\t * Stop the internal polling loop.\n\t * @returns A promise that resolves when the polling loop has been stopped.\n\t */\n\tretrieveStop(): Promise<void>;\n\n\t/**\n\t * Start an authentication flow for a mailbox before it is polled for the first time.\n\t * Only implemented by connectors whose credentials are issued by an external flow, such as\n\t * an OAuth consent redirect, so the caller can hand the flow straight to the operator who\n\t * created the mailbox rather than waiting for the first poll to report it.\n\t * @param instanceId The identifier of the mailbox instance being authenticated.\n\t * @param state The current connector state for the instance, which may already hold credentials.\n\t * @param options Options supplied by the owning component, carrying the callback URI the flow\n\t * must return to and the state which correlates it back to the mailbox.\n\t * @returns The auth state carrying the URL to open for the user, or undefined when the\n\t * mailbox is already able to authenticate itself.\n\t */\n\tinitiateAuth?(\n\t\tinstanceId: string,\n\t\tstate: TState,\n\t\toptions: IEmailProtocolConnectorOptions\n\t): Promise<TAuthState | undefined>;\n\n\t/**\n\t * Complete an authentication flow the connector reported through its auth callback.\n\t * Only implemented by connectors whose credentials are issued by an external flow, such as\n\t * an OAuth consent redirect. The outcome is reported back through the auth callback the\n\t * connector was given by retrieve, so nothing is returned here.\n\t * @param instanceId The identifier of the mailbox instance being authenticated.\n\t * @param authPayload The protocol-specific data handed to the redirect, such as an OAuth code.\n\t * @param options Options supplied by the owning component, carrying the same callback URI the\n\t * flow was started with.\n\t * @returns A promise that resolves when the flow has been completed.\n\t */\n\tcompleteAuth?(\n\t\tinstanceId: string,\n\t\tauthPayload: unknown,\n\t\toptions: IEmailProtocolConnectorOptions\n\t): Promise<void>;\n}\n"]}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=IEmailProtocolConnectorAuthCallback.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"IEmailProtocolConnectorAuthCallback.js","sources":["../../../src/models/IEmailProtocolConnectorAuthCallback.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IError } from \"@3sixty/core\";\nimport type { IEmailProtocolConnectorAuthState } from \"./IEmailProtocolConnectorAuthState.js\";\n\n/**\n * Callback invoked by a protocol connector to report the outcome of an authentication attempt.\n * @param mailboxId The identifier of the mailbox this authentication attempt belongs to.\n * @param updatedState Optional connector state to persist on the mailbox entity, carrying any\n * credentials the flow issued in the properties the connector state schema marks as secure.\n * @param requiresAuth True if authentication failed due to invalid or expired credentials.\n * @param authState Optional state produced during the auth flow, carrying the URL to open.\n * @param authError Optional structured error covering all failure types (auth, connection, timeout, etc.).\n */\nexport type IEmailProtocolConnectorAuthCallback<\n\tTAuthState extends IEmailProtocolConnectorAuthState = IEmailProtocolConnectorAuthState\n> = (\n\tmailboxId: string,\n\tupdatedState: unknown | undefined,\n\trequiresAuth: boolean,\n\tauthState?: TAuthState,\n\tauthError?: IError\n) => Promise<void>;\n"]}
@@ -0,0 +1,4 @@
1
+ // Copyright 2026 IOTA Stiftung.
2
+ // SPDX-License-Identifier: Apache-2.0.
3
+ export {};
4
+ //# sourceMappingURL=IEmailProtocolConnectorAuthState.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"IEmailProtocolConnectorAuthState.js","sources":["../../../src/models/IEmailProtocolConnectorAuthState.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The state a protocol connector produces when a mailbox has to be authenticated by an\n * external flow. Connectors which carry more through the flow extend this with their own\n * properties, but the URL is named here so callers can open it without knowing the protocol.\n */\nexport interface IEmailProtocolConnectorAuthState {\n\t/**\n\t * The URL to open for the user to authenticate the mailbox, such as an OAuth consent URL.\n\t * Absent when the connector has no URL to send the user to.\n\t */\n\tauthUrl?: string;\n}\n"]}
@@ -0,0 +1,4 @@
1
+ // Copyright 2026 IOTA Stiftung.
2
+ // SPDX-License-Identifier: Apache-2.0.
3
+ export {};
4
+ //# sourceMappingURL=IEmailProtocolConnectorOptions.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"IEmailProtocolConnectorOptions.js","sources":["../../../src/models/IEmailProtocolConnectorOptions.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Options supplied to a protocol connector by the component which owns it.\n */\nexport interface IEmailProtocolConnectorOptions {\n\t/**\n\t * The fixed URI an external authentication flow returns to, which correlates the response\n\t * back to the mailbox it belongs to. Connectors which start such a flow must send the\n\t * external service to this URI rather than one of their own.\n\t * Absent when the owning component has no public origin recorded for the mailbox, which\n\t * leaves a connector able to poll with the credentials it has but unable to start a flow.\n\t */\n\tcallbackUri?: string;\n\n\t/**\n\t * The opaque value a connector must carry through an external authentication flow so the\n\t * response returns to the owning component identifying both the partition and the mailbox.\n\t * It is passed back verbatim, so the component needs no search to correlate the callback.\n\t */\n\tcorrelationState: string;\n}\n"]}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=IEmailProtocolConnectorRetrievalCallback.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"IEmailProtocolConnectorRetrievalCallback.js","sources":["../../../src/models/IEmailProtocolConnectorRetrievalCallback.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IError } from \"@3sixty/core\";\nimport type { IEmail } from \"./IEmail.js\";\n\n/**\n * Callback invoked by a protocol connector to persist a single retrieved message.\n * @param mailboxId The identifier of the mailbox this retrieval belongs to.\n * @param message The message to persist.\n * @param updatedState The connector state to persist on the mailbox entity after this message.\n * @returns True if the message was persisted successfully; false causes the connector to exit the polling loop.\n */\nexport type IEmailProtocolConnectorRetrievalCallback = (\n\tmailboxId: string,\n\tmessage: IEmail | undefined,\n\tupdatedState: unknown,\n\tretrievalError?: IError\n) => Promise<boolean>;\n"]}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=IMailStorageComponent.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"IMailStorageComponent.js","sources":["../../../src/models/IMailStorageComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@3sixty/core\";\nimport type { IEmail } from \"./IEmail.js\";\nimport type { IStoredEmail } from \"./IStoredEmail.js\";\n\n/**\n * Interface describing the mail storage component for persisting and querying received emails.\n */\nexport interface IMailStorageComponent extends IComponent {\n\t/**\n\t * Store an email received from a mailbox.\n\t * @param mailboxId The identifier of the mailbox that received the email.\n\t * @param email The email to store.\n\t * @returns The identifier assigned to the stored email.\n\t */\n\tstore(mailboxId: string, email: IEmail): Promise<string>;\n\n\t/**\n\t * Retrieve a stored email by its identifier.\n\t * @param id The identifier of the stored email.\n\t * @returns The stored email.\n\t */\n\tget(id: string): Promise<IStoredEmail>;\n\n\t/**\n\t * Remove a stored email by its identifier.\n\t * @param id The identifier of the stored email to remove.\n\t * @returns A promise that resolves when the email has been removed.\n\t */\n\tremove(id: string): Promise<void>;\n\n\t/**\n\t * Query stored emails received at or after a given epoch.\n\t * @param sinceEpoch The ISO 8601 timestamp to filter emails received at or after.\n\t * @param mailboxId An optional mailbox identifier to restrict results to.\n\t * @param cursor An optional cursor for paginated results.\n\t * @param limit An optional maximum number of results to return.\n\t * @returns A page of stored emails and an optional cursor for the next page.\n\t */\n\tquery(\n\t\tsinceEpoch: string,\n\t\tmailboxId?: string,\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<{ emails: IStoredEmail[]; cursor?: string }>;\n}\n"]}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=IMailbox.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"IMailbox.js","sources":["../../../src/models/IMailbox.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IError } from \"@3sixty/core\";\n\n/**\n * Interface describing a mailbox configuration.\n */\nexport interface IMailbox<TConfig = unknown, TState = unknown, TAuthState = unknown> {\n\t/**\n\t * The unique identifier for the mailbox.\n\t */\n\tid: string;\n\n\t/**\n\t * The display name for the mailbox.\n\t */\n\tname: string;\n\n\t/**\n\t * The connector type identifying which connector handles this mailbox.\n\t */\n\tconnectorType: string;\n\n\t/**\n\t * The connector-owned configuration for this mailbox.\n\t */\n\tconfig?: TConfig;\n\n\t/**\n\t * The connector-owned runtime state for this mailbox.\n\t */\n\tstate?: TState;\n\n\t/**\n\t * Whether this mailbox is active and should be polled.\n\t */\n\tenabled: boolean;\n\n\t/**\n\t * Whether this mailbox is awaiting re-authentication.\n\t */\n\trequiresAuth?: boolean;\n\n\t/**\n\t * Optional protocol-specific state produced during the auth flow, such as an OAuth URL or code.\n\t */\n\tauthState?: TAuthState;\n\n\t/**\n\t * The last error returned by the authentication callback; cleared on successful authentication.\n\t */\n\tauthError?: IError;\n\n\t/**\n\t * The last error returned by the retrieval callback; cleared on successful retrieval.\n\t */\n\tretrievalError?: IError;\n}\n"]}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=IMailboxComponent.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"IMailboxComponent.js","sources":["../../../src/models/IMailboxComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@3sixty/core\";\nimport type { IMailbox } from \"./IMailbox.js\";\nimport type { IMailboxConfigField } from \"./IMailboxConfigField.js\";\nimport type { IMailboxCreateResult } from \"./IMailboxCreateResult.js\";\nimport type { IMailboxUpdateResult } from \"./IMailboxUpdateResult.js\";\n\n/**\n * Interface describing the mailbox management component.\n */\nexport interface IMailboxComponent extends IComponent {\n\t/**\n\t * Create a new mailbox and begin polling for it.\n\t * Connectors whose credentials are issued by an external flow are asked to start it here, so\n\t * the URL the user has to open is returned to the caller which created the mailbox instead of\n\t * only surfacing once the first poll has run.\n\t * @param mailbox The mailbox configuration to create.\n\t * @returns The identifier assigned to the new mailbox, with the URL to open when the mailbox\n\t * must be authenticated before it can be polled.\n\t */\n\tcreateMailbox(\n\t\tmailbox: Pick<IMailbox, \"name\" | \"connectorType\" | \"config\" | \"enabled\">\n\t): Promise<IMailboxCreateResult>;\n\n\t/**\n\t * Update an existing mailbox.\n\t * An update replaces the credentials the mailbox authenticates with, so a connector whose\n\t * credentials are issued by an external flow is asked to start a new one, and the URL the\n\t * user has to open is returned the same way it is when the mailbox is created.\n\t * @param mailbox The updated mailbox configuration.\n\t * @returns The URL to open when the mailbox must be authenticated before it can be polled.\n\t */\n\tupdateMailbox(mailbox: IMailbox): Promise<IMailboxUpdateResult>;\n\n\t/**\n\t * Remove a mailbox and stop polling for it.\n\t * @param id The identifier of the mailbox to remove.\n\t * @returns A promise that resolves when the mailbox has been removed.\n\t */\n\tremoveMailbox(id: string): Promise<void>;\n\n\t/**\n\t * Retrieve a mailbox by its identifier.\n\t * @param id The identifier of the mailbox to retrieve.\n\t * @returns The mailbox.\n\t */\n\tgetMailbox(id: string): Promise<IMailbox>;\n\n\t/**\n\t * List all mailboxes with optional cursor-based pagination.\n\t * @param cursor An optional cursor for paginated results.\n\t * @param limit An optional maximum number of results to return.\n\t * @returns A page of mailboxes and an optional cursor for the next page.\n\t */\n\tlistMailboxes(\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<{ mailboxes: IMailbox[]; cursor?: string }>;\n\n\t/**\n\t * Complete an authentication flow for a mailbox awaiting authentication.\n\t * The mailbox is correlated from the payload's state property, which the connector placed in\n\t * the external flow when it produced its auth state, and which names the partition as well as\n\t * the mailbox. The connector exchanges the payload for its credentials, which are stored on\n\t * the mailbox state, and polling restarts.\n\t * @param authPayload The data handed to the callback URI, carrying the correlating state.\n\t * @returns A promise that resolves when the mailbox has been authenticated.\n\t * @throws NotFoundError if the correlated mailbox does not exist.\n\t * @throws GeneralError if the mailbox is not awaiting authentication, or its connector has no\n\t * authentication flow.\n\t */\n\tcompleteAuth(authPayload: unknown): Promise<void>;\n\n\t/**\n\t * Get the configuration schema for a connector type.\n\t * @param connectorType The connector type to get the schema for.\n\t * @returns The configuration field definitions for the connector.\n\t * @throws NotFoundError if no schema is registered for the connector type.\n\t */\n\tgetSchema(connectorType: string): Promise<IMailboxConfigField[]>;\n}\n"]}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=IMailboxConfigField.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"IMailboxConfigField.js","sources":["../../../src/models/IMailboxConfigField.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { EntitySchemaPropertyType } from \"@3sixty/entity\";\n\n/**\n * Interface describing a single configuration field for a protocol connector.\n */\nexport interface IMailboxConfigField {\n\t/**\n\t * The i18n key for the field label shown in the UI.\n\t */\n\tlabelKey: string;\n\n\t/**\n\t * The key of the property within the connector config object.\n\t */\n\tpropertyKey: string;\n\n\t/**\n\t * The entity schema property type for this field.\n\t */\n\ttype: EntitySchemaPropertyType;\n\n\t/**\n\t * Whether this field holds a sensitive value that should be stored in the vault.\n\t */\n\tisSecure?: boolean;\n\n\t/**\n\t * The element type when `type` is `Array`.\n\t */\n\titemType?: EntitySchemaPropertyType;\n\n\t/**\n\t * An optional default value for the field.\n\t */\n\tdefaultValue?: unknown;\n}\n"]}
@@ -0,0 +1,4 @@
1
+ // Copyright 2026 IOTA Stiftung.
2
+ // SPDX-License-Identifier: Apache-2.0.
3
+ export {};
4
+ //# sourceMappingURL=IMailboxCreateResult.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"IMailboxCreateResult.js","sources":["../../../src/models/IMailboxCreateResult.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The outcome of creating a mailbox.\n */\nexport interface IMailboxCreateResult {\n\t/**\n\t * The identifier assigned to the new mailbox.\n\t */\n\tid: string;\n\n\t/**\n\t * The URL to open for the user when the mailbox cannot be polled until an external\n\t * authentication flow has completed, such as an OAuth consent URL. Absent when the supplied\n\t * configuration is already sufficient to poll the mailbox.\n\t */\n\tauthUrl?: string;\n}\n"]}
@@ -0,0 +1,4 @@
1
+ // Copyright 2026 IOTA Stiftung.
2
+ // SPDX-License-Identifier: Apache-2.0.
3
+ export {};
4
+ //# sourceMappingURL=IMailboxUpdateResult.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"IMailboxUpdateResult.js","sources":["../../../src/models/IMailboxUpdateResult.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The outcome of updating a mailbox.\n */\nexport interface IMailboxUpdateResult {\n\t/**\n\t * The URL to open for the user when the updated mailbox cannot be polled until an external\n\t * authentication flow has completed, such as an OAuth consent URL. Absent when the updated\n\t * configuration is already sufficient to poll the mailbox.\n\t */\n\tauthUrl?: string;\n}\n"]}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=IStoredEmail.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"IStoredEmail.js","sources":["../../../src/models/IStoredEmail.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IEmail } from \"./IEmail.js\";\n\n/**\n * Interface describing an email message persisted by the mail storage component.\n */\nexport interface IStoredEmail extends IEmail {\n\t/**\n\t * The storage entity identifier.\n\t */\n\tid: string;\n\n\t/**\n\t * The identifier of the mailbox that received the message.\n\t */\n\tmailboxId: string;\n\n\t/**\n\t * The ISO 8601 timestamp when the message was stored.\n\t */\n\treceivedAt: string;\n}\n"]}
@@ -0,0 +1,4 @@
1
+ // Copyright 2026 IOTA Stiftung.
2
+ // SPDX-License-Identifier: Apache-2.0.
3
+ export {};
4
+ //# sourceMappingURL=IMailStorageGetRequest.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"IMailStorageGetRequest.js","sources":["../../../../src/models/api/IMailStorageGetRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Request to retrieve a stored email by ID.\n */\nexport interface IMailStorageGetRequest {\n\t/**\n\t * The path parameters.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The identifier of the stored email to retrieve.\n\t\t */\n\t\tid: string;\n\t};\n}\n"]}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=IMailStorageGetResponse.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"IMailStorageGetResponse.js","sources":["../../../../src/models/api/IMailStorageGetResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IStoredEmail } from \"../IStoredEmail.js\";\n\n/**\n * Response from retrieving a stored email.\n */\nexport interface IMailStorageGetResponse {\n\t/**\n\t * The retrieved stored email.\n\t */\n\tbody: IStoredEmail;\n}\n"]}
@@ -0,0 +1,4 @@
1
+ // Copyright 2026 IOTA Stiftung.
2
+ // SPDX-License-Identifier: Apache-2.0.
3
+ export {};
4
+ //# sourceMappingURL=IMailStorageListRequest.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"IMailStorageListRequest.js","sources":["../../../../src/models/api/IMailStorageListRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Request to query stored emails.\n */\nexport interface IMailStorageListRequest {\n\t/**\n\t * The query parameters.\n\t */\n\tquery: {\n\t\t/**\n\t\t * Return only emails received at or after this ISO 8601 timestamp.\n\t\t */\n\t\tsince: string;\n\n\t\t/**\n\t\t * Filter emails by mailbox identifier.\n\t\t */\n\t\tmailboxId?: string;\n\n\t\t/**\n\t\t * The cursor for paginated results.\n\t\t */\n\t\tcursor?: string;\n\n\t\t/**\n\t\t * The maximum number of results to return.\n\t\t */\n\t\tlimit?: string;\n\t};\n}\n"]}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=IMailStorageListResponse.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"IMailStorageListResponse.js","sources":["../../../../src/models/api/IMailStorageListResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IStoredEmail } from \"../IStoredEmail.js\";\n\n/**\n * Response from querying stored emails.\n */\nexport interface IMailStorageListResponse {\n\t/**\n\t * The result body.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The list of stored emails.\n\t\t */\n\t\temails: IStoredEmail[];\n\n\t\t/**\n\t\t * The cursor for the next page of results.\n\t\t */\n\t\tcursor?: string;\n\t};\n}\n"]}
@@ -0,0 +1,4 @@
1
+ // Copyright 2026 IOTA Stiftung.
2
+ // SPDX-License-Identifier: Apache-2.0.
3
+ export {};
4
+ //# sourceMappingURL=IMailStorageRemoveRequest.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"IMailStorageRemoveRequest.js","sources":["../../../../src/models/api/IMailStorageRemoveRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Request to remove a stored email.\n */\nexport interface IMailStorageRemoveRequest {\n\t/**\n\t * The path parameters.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The identifier of the stored email to remove.\n\t\t */\n\t\tid: string;\n\t};\n}\n"]}
@@ -0,0 +1,4 @@
1
+ // Copyright 2026 IOTA Stiftung.
2
+ // SPDX-License-Identifier: Apache-2.0.
3
+ export {};
4
+ //# sourceMappingURL=IMailboxCompleteAuthRequest.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"IMailboxCompleteAuthRequest.js","sources":["../../../../src/models/api/IMailboxCompleteAuthRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Request to complete an authentication flow, sent by the external provider redirecting the\n * browser to the fixed callback route.\n */\nexport interface IMailboxCompleteAuthRequest {\n\t/**\n\t * The query parameters the provider appends to the callback URI.\n\t */\n\tquery: {\n\t\t[propertyKey: string]: string;\n\n\t\t/**\n\t\t * The correlating state the connector placed in the external flow.\n\t\t */\n\t\tstate: string;\n\t};\n}\n"]}