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

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 IOTA Stiftung.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,25 @@
-# Temporary Holding Version
+# 3Sixty Mailbox Models
 
-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.
+This package defines the shared models and factory helpers for email mailbox ingestion.
+
+## Installation
+
+```shell
+npm install @3sixty/mailbox-models
+```
+
+## Examples
+
+Usage of the APIs is shown in the examples [docs/examples.md](docs/examples.md)
+
+## Reference
+
+Detailed reference documentation for the API can be found in [docs/reference/index.md](docs/reference/index.md)
+
+## Changelog
+
+The changes between each version can be found in [docs/changelog.md](docs/changelog.md)
+
+## Origin
+
+This package is derived from the original [iotaledger/twin-messaging](https://github.com/iotaledger/twin-messaging/tree/next/packages/mailbox-models) repository.

package/dist/es/factories/emailConsumerFactory.js

@@ -0,0 +1,9 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { Factory } from "@3sixty/core";
+/**
+ * Factory for creating email consumer instances.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const EmailConsumerFactory = Factory.createFactory("email-consumer");
+//# sourceMappingURL=emailConsumerFactory.js.map

package/dist/es/factories/emailConsumerFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"emailConsumerFactory.js","sourceRoot":"","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"]}

package/dist/es/factories/emailProtocolConnectorConfigSchemaFactory.js

@@ -0,0 +1,9 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { Factory } from "@3sixty/core";
+/**
+ * Factory for retrieving email protocol connector configuration field definitions.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const EmailProtocolConnectorConfigSchemaFactory = Factory.createFactory("email-protocol-config-schema");
+//# sourceMappingURL=emailProtocolConnectorConfigSchemaFactory.js.map

package/dist/es/factories/emailProtocolConnectorConfigSchemaFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"emailProtocolConnectorConfigSchemaFactory.js","sourceRoot":"","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"]}

package/dist/es/factories/emailProtocolConnectorFactory.js

@@ -0,0 +1,9 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { Factory } from "@3sixty/core";
+/**
+ * Factory for creating email protocol connectors.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const EmailProtocolConnectorFactory = Factory.createFactory("email-protocol");
+//# sourceMappingURL=emailProtocolConnectorFactory.js.map

package/dist/es/factories/emailProtocolConnectorFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"emailProtocolConnectorFactory.js","sourceRoot":"","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"]}

package/dist/es/factories/emailProtocolConnectorStateSchemaFactory.js

@@ -0,0 +1,11 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { Factory } from "@3sixty/core";
+/**
+ * Factory for retrieving email protocol connector state field definitions.
+ * Only the properties a connector holds in its runtime state need registering here, and the ones
+ * marked secure are stored in the vault instead of alongside the rest of the state.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const EmailProtocolConnectorStateSchemaFactory = Factory.createFactory("email-protocol-state-schema");
+//# sourceMappingURL=emailProtocolConnectorStateSchemaFactory.js.map

package/dist/es/factories/emailProtocolConnectorStateSchemaFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"emailProtocolConnectorStateSchemaFactory.js","sourceRoot":"","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"]}

package/dist/es/index.js

@@ -0,0 +1,44 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./factories/emailConsumerFactory.js";
+export * from "./factories/emailProtocolConnectorFactory.js";
+export * from "./factories/emailProtocolConnectorConfigSchemaFactory.js";
+export * from "./factories/emailProtocolConnectorStateSchemaFactory.js";
+export * from "./models/api/IMailboxCompleteAuthRequest.js";
+export * from "./models/api/IMailboxConnectorSchemaRequest.js";
+export * from "./models/api/IMailboxConnectorSchemaResponse.js";
+export * from "./models/api/IMailboxCreateRequest.js";
+export * from "./models/api/IMailboxCreateResponse.js";
+export * from "./models/api/IMailboxGetRequest.js";
+export * from "./models/api/IMailboxGetResponse.js";
+export * from "./models/api/IMailboxListRequest.js";
+export * from "./models/api/IMailboxListResponse.js";
+export * from "./models/api/IMailboxRemoveRequest.js";
+export * from "./models/api/IMailboxUpdateRequest.js";
+export * from "./models/api/IMailboxUpdateResponse.js";
+export * from "./models/api/IMailStorageGetRequest.js";
+export * from "./models/api/IMailStorageGetResponse.js";
+export * from "./models/api/IMailStorageListRequest.js";
+export * from "./models/api/IMailStorageListResponse.js";
+export * from "./models/api/IMailStorageRemoveRequest.js";
+export * from "./models/IEmail.js";
+export * from "./models/IEmailAddress.js";
+export * from "./models/IEmailAttachment.js";
+export * from "./models/IEmailHeader.js";
+export * from "./models/IEmailConsumer.js";
+export * from "./models/IEmailProtocolConnector.js";
+export * from "./models/IEmailProtocolConnectorAuthCallback.js";
+export * from "./models/IEmailProtocolConnectorAuthState.js";
+export * from "./models/IEmailProtocolConnectorOptions.js";
+export * from "./models/IEmailProtocolConnectorRetrievalCallback.js";
+export * from "./models/IMailbox.js";
+export * from "./models/IMailboxCreateResult.js";
+export * from "./models/IMailboxUpdateResult.js";
+export * from "./models/IMailboxComponent.js";
+export * from "./models/IMailboxConfigField.js";
+export * from "./models/IMailStorageComponent.js";
+export * from "./models/IStoredEmail.js";
+export * from "./models/mailboxMetricIds.js";
+export * from "./models/mailboxMetrics.js";
+export * from "./utils/mailHelper.js";
+//# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","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"]}

package/dist/es/models/IEmail.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IEmail.js.map

package/dist/es/models/IEmail.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IEmail.js","sourceRoot":"","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"]}

package/dist/es/models/IEmailAddress.js

@@ -0,0 +1,4 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IEmailAddress.js.map

package/dist/es/models/IEmailAddress.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IEmailAddress.js","sourceRoot":"","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"]}

package/dist/es/models/IEmailAttachment.js

@@ -0,0 +1,4 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IEmailAttachment.js.map

package/dist/es/models/IEmailAttachment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IEmailAttachment.js","sourceRoot":"","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"]}

package/dist/es/models/IEmailConsumer.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IEmailConsumer.js.map

package/dist/es/models/IEmailConsumer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IEmailConsumer.js","sourceRoot":"","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"]}

package/dist/es/models/IEmailHeader.js

@@ -0,0 +1,4 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IEmailHeader.js.map

package/dist/es/models/IEmailHeader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IEmailHeader.js","sourceRoot":"","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"]}

package/dist/es/models/IEmailProtocolConnector.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IEmailProtocolConnector.js.map

package/dist/es/models/IEmailProtocolConnector.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IEmailProtocolConnector.js","sourceRoot":"","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"]}

package/dist/es/models/IEmailProtocolConnectorAuthCallback.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IEmailProtocolConnectorAuthCallback.js.map

package/dist/es/models/IEmailProtocolConnectorAuthCallback.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IEmailProtocolConnectorAuthCallback.js","sourceRoot":"","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"]}

package/dist/es/models/IEmailProtocolConnectorAuthState.js

@@ -0,0 +1,4 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IEmailProtocolConnectorAuthState.js.map

package/dist/es/models/IEmailProtocolConnectorAuthState.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IEmailProtocolConnectorAuthState.js","sourceRoot":"","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"]}

package/dist/es/models/IEmailProtocolConnectorOptions.js

@@ -0,0 +1,4 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IEmailProtocolConnectorOptions.js.map

package/dist/es/models/IEmailProtocolConnectorOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IEmailProtocolConnectorOptions.js","sourceRoot":"","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"]}

package/dist/es/models/IEmailProtocolConnectorRetrievalCallback.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IEmailProtocolConnectorRetrievalCallback.js.map

package/dist/es/models/IEmailProtocolConnectorRetrievalCallback.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IEmailProtocolConnectorRetrievalCallback.js","sourceRoot":"","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"]}

package/dist/es/models/IMailStorageComponent.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IMailStorageComponent.js.map

package/dist/es/models/IMailStorageComponent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IMailStorageComponent.js","sourceRoot":"","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"]}

package/dist/es/models/IMailbox.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IMailbox.js.map

package/dist/es/models/IMailbox.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IMailbox.js","sourceRoot":"","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"]}

package/dist/es/models/IMailboxComponent.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IMailboxComponent.js.map

package/dist/es/models/IMailboxComponent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IMailboxComponent.js","sourceRoot":"","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"]}

package/dist/es/models/IMailboxConfigField.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IMailboxConfigField.js.map

package/dist/es/models/IMailboxConfigField.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IMailboxConfigField.js","sourceRoot":"","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"]}

package/dist/es/models/IMailboxCreateResult.js

@@ -0,0 +1,4 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IMailboxCreateResult.js.map

package/dist/es/models/IMailboxCreateResult.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IMailboxCreateResult.js","sourceRoot":"","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"]}

package/dist/es/models/IMailboxUpdateResult.js

@@ -0,0 +1,4 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IMailboxUpdateResult.js.map

package/dist/es/models/IMailboxUpdateResult.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IMailboxUpdateResult.js","sourceRoot":"","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"]}

package/dist/es/models/IStoredEmail.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IStoredEmail.js.map

package/dist/es/models/IStoredEmail.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IStoredEmail.js","sourceRoot":"","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"]}

package/dist/es/models/api/IMailStorageGetRequest.js

@@ -0,0 +1,4 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IMailStorageGetRequest.js.map

package/dist/es/models/api/IMailStorageGetRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IMailStorageGetRequest.js","sourceRoot":"","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"]}

package/dist/es/models/api/IMailStorageGetResponse.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IMailStorageGetResponse.js.map

package/dist/es/models/api/IMailStorageGetResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IMailStorageGetResponse.js","sourceRoot":"","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"]}

package/dist/es/models/api/IMailStorageListRequest.js

@@ -0,0 +1,4 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IMailStorageListRequest.js.map

package/dist/es/models/api/IMailStorageListRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IMailStorageListRequest.js","sourceRoot":"","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"]}

package/dist/es/models/api/IMailStorageListResponse.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IMailStorageListResponse.js.map

package/dist/es/models/api/IMailStorageListResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IMailStorageListResponse.js","sourceRoot":"","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"]}

package/dist/es/models/api/IMailStorageRemoveRequest.js

@@ -0,0 +1,4 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IMailStorageRemoveRequest.js.map

package/dist/es/models/api/IMailStorageRemoveRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IMailStorageRemoveRequest.js","sourceRoot":"","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"]}

package/dist/es/models/api/IMailboxCompleteAuthRequest.js

@@ -0,0 +1,4 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IMailboxCompleteAuthRequest.js.map