@plexuslabs/simmail 0.0.0-stage → 0.1.1

package/CHANGELOG.md

@@ -0,0 +1,55 @@
+# Changelog
+
+## 0.1.1 (2026-10-14)
+
+Covers the whole customer API, and adds an object layer on top of the plain calls.
+
+- **Every endpoint**: mailboxes and folders, reading, raw messages and attachments, marking and moving,
+  threads, injecting, signatures, rescue and retry; logins; people (memory, relations, learning from
+  mail, temperaments); cases (people, initiate, regenerate, the story); jobs; the event log and the
+  live event stream (`events()`, an async iterator); AI, pace, recipients, links, retention and Spam &
+  Junk settings; faults and scenarios; inspection and insights; webhooks; the World; `universes`,
+  `status` and connection details.
+- **Objects**: `Message`, `Mailbox`, `Persona`, `Case`, `Job` and `Account`, with the API's fields,
+  camelCase getters and methods (`msg.reply()`, `msg.waitForReply()`, `mailbox.waitForEmail()`,
+  `persona.runDue()`, `deal.initiate()`, …). Waits and lists return them. They are supersets of the
+  0.1.0 answers, so code reading `msg.magic_links` keeps working.
+- **Groups**: `mail.personas`, `mail.cases`, `mail.clock`, `mail.jobs`, `mail.world`, `mail.faults`,
+  `mail.recipients`, `mail.webhooks`, `mail.insights`, `mail.events`, `mail.accounts`, `mail.inspect`,
+  `mail.behaviour`. Each is also callable as the 0.1.0 method of the same name.
+- **Test addresses**: `mail.testAddress({ tag })` makes a fresh address (a `TestAddress` with
+  `waitForEmail()`, `expectNoEmail()`, `list()` and `cleanup()`); `mail.tag(name)` works on every
+  address with a tag; `listMessages` and `deleteMessages` across addresses.
+- **Waits**: `waitForEmail` takes several addresses or `*@domain`, `tag`, `count` (waits for n),
+  `since`, `exclude`, `subjectRegex`/`bodyRegex` (a RegExp works), `header`, `hasAttachment`,
+  `attachmentName` and `linkDomain`; a timeout says what almost matched (`nearMisses`).
+  `expectNoEmail` passes when nothing comes. `waitForEvent` (`persona.waitFor("replied")`) waits for
+  something a person does; `waitForThread` (`msg.waitUntilQuiet()`) for a conversation to go quiet,
+  as a `Conversation`.
+- **Jobs**: filters (`persona`, `kind`, `dueBefore`, `limit`) and `runDue` (`mail.jobs.runDue()`,
+  `persona.runDue()`), on the server.
+- **Named values** for every setting with fixed choices (`Temperament`, `FaultScenario`,
+  `MailboxStatus`, `EventType`, `EventAlias`, `ErrorCode`, …), each the API's plain string, generated
+  from `GET /api/schema` (`sdk/tools/gen_enums.py`); `EnumInfo` and `describe()` give each value's
+  label and description. `mail.schema()` returns the schema itself.
+- **Errors by kind**, chosen by the server's error code: `ValidationError`, `AuthError`,
+  `PlanLimitError`, `ForbiddenError`, `NotFoundError`, `WaitTimeoutError`, `ConflictError`,
+  `UnexpectedEmailError`, `IdempotencyError`, `RateLimitedError`, all `SimmailError`, which carries
+  `code`, `requestId`, `field`, `allowed` and `nearMisses`.
+- **Safe retries**: every `send` and `inject` has its own Idempotency-Key (yours with
+  `idempotencyKey`, none with `false`), and answers say `replayed`. GETs and keyed writes are tried
+  again after a network error, 502 or 503 (`retries`, default 2). `mail.withRequestId(id)` sends your
+  own request id; answers and errors carry `requestId`.
+
+## 0.1.0
+
+First release.
+
+- `waitForEmail`, `waitForReply`: wait for the next email to an address, or a person's reply; codes and magic links already pulled out.
+- `extract`: codes and links from any text or HTML.
+- `mailboxes`, `messages`, `message`: what is in the universe's mailboxes.
+- `send` (with `inReplyTo`), `health` (the inspection report).
+- `accounts`, `createAccount`: your app's SMTP/IMAP logins.
+- `personas`, `createPersona`, `pushCase`.
+- `clock`, `advance`, `freeze`, `speed`, `live`.
+- Settings from `SIMMAIL_URL`, `SIMMAIL_API_KEY`, `SIMMAIL_UNIVERSE`; errors as `SimmailError` with the HTTP status.

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 [yyyy] [name of copyright owner]
+
+   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,209 @@
-# Temporary Holding Version
+# @plexuslabs/simmail
 
-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.
+The official JavaScript and TypeScript client for [simmail](https://www.simmail.dev): a simulated email
+world for testing apps and email agents. Wait for the email your app sends, pull out the code or
+link, get replies from simulated people, and drive the whole world: people, cases, the clock, the
+World's inbound mail, faults, recipients and webhooks.
+
+No dependencies; Node 18 or newer. Full docs: https://www.simmail.dev/docs/
+
+```sh
+npm install --save-dev @plexuslabs/simmail
+```
+
+## Setup
+
+The client reads its settings from the environment, or takes them in `new Simmail({...})`:
+
+| Variable | Meaning |
+| --- | --- |
+| `SIMMAIL_URL` | Your universe's server, such as `https://c1.simmail.dev` (shown on your account page). |
+| `SIMMAIL_API_KEY` | An API key, `smk_…` (Organization → API keys). |
+| `SIMMAIL_UNIVERSE` | Optional: only needed when the key can reach more than one universe. |
+
+Your app sends through simmail's SMTP as usual (the dashboard's *Get started* shows the settings);
+this client is for your tests and tools.
+
+## Wait for an email and use its code (Playwright)
+
+```js
+import { test, expect } from "@playwright/test";
+import { Simmail } from "@plexuslabs/simmail";
+
+const mail = new Simmail();
+
+test("new users can verify their email", async ({ page }) => {
+  const email = `user-${Date.now()}@yourcompany.test`;
+  await page.goto("/signup");
+  await page.fill("#email", email);
+
+  const waiting = mail.mailbox(email).waitForEmail({ subject: "verify", timeout: "20s" });
+  await page.click("text=Create account");
+  const msg = await waiting;
+
+  expect(msg.codes).toHaveLength(1);
+  await page.fill("#code", msg.codes[0]); // or: await page.goto(msg.magicLinks[0])
+});
+```
+
+Start the wait before the click: a wait only sees mail that arrives after it starts, unless you
+pass `existing: true`.
+
+## A fresh address per test
+
+```js
+const addr = await mail.testAddress({ tag: "signup" });       // such as t-k3x9q@inbox.test
+await page.fill("#email", addr.address);
+await page.click("text=Create account");
+
+const welcome = await addr.waitForEmail({ subjectRegex: /welcome/i, timeout: "20s" });
+await addr.expectNoEmail({ within: "5s", subject: "verify" }); // no second email
+await addr.cleanup();                                          // or mail.tag("signup").cleanup()
+```
+
+`waitForEmail` also takes several addresses or `*@domain`, `count` (wait for n emails), `since`,
+`exclude`, `bodyRegex`, `header`, `hasAttachment`, `attachmentName` and `linkDomain`. When nothing
+matches, the `WaitTimeoutError` lists what almost did and why (`nearMisses`).
+
+## Objects you can act on
+
+Answers come back as objects with the API's fields and methods for what you do next:
+
+```js
+import { Simmail, Folder } from "@plexuslabs/simmail";
+
+const msg = await mail.mailbox("app@yourcompany.test").waitForEmail({ from: "dana@harbor.test" });
+await msg.reply({ text: "Thanks, Dana. Tuesday works." });   // threaded, from the mailbox it is in
+const answer = await msg.waitForReply();                     // Dana's next email in this thread
+await msg.markRead();
+await msg.move(Folder.Archive);
+const report = await msg.health();                            // for mail your app sent: spam score, links
+
+for await (const m of mail.mailbox("dana@harbor.test").messages({ folder: Folder.Junk })) {
+  console.log(m.subject, m.isRead);
+}
+```
+
+| Object | What it has |
+| --- | --- |
+| `Message` | `messageId`, `from`, `to`, `subject`, `text`, `html`, `codes`, `magicLinks`, `attachments`; `full()`, `reply()`, `waitForReply()`, `waitUntilQuiet()`, `health()`, `source()`, `attachment(n)`, `markRead()`, `move()` |
+| `Mailbox` | `address`, counts; `waitForEmail()`, `messages()` (async iterator), `list()`, `send()`, `inject()`, `folders()`, `threads()`, `setStatus()` |
+| `Persona` | the person's fields; `update()`, `pause()`, `remember()`, `memory()`, `relations()`, `jobs()`, `runDue()`, `waitFor()`, `waitForReply()`, `mailbox()` |
+| `Case` | `people`, `story`; `push()`, `addPeople()`, `initiate()`, `regenerate()`, `editStory()` |
+| `Job` | `kind`, `state`, `due`; `run()`, `skip()`, `bounce()`, `reschedule()` |
+| `TestAddress` | a fresh address (a `Mailbox`); `waitForEmail()`, `expectNoEmail()`, `list()`, `cleanup()` |
+| `Conversation` | `messages`, `latest`; `waitUntilQuiet()`, `reply()` |
+| `SimEvent` | `kind`, `data`, `personaId`, `messageId`; `persona()` |
+| `Account` | a login; `update()`, `test()`, `delete()` |
+
+Every object still has the API's own field names (`msg.message_id`, `msg.magic_links`), `.raw`
+for the answer as it came, and serialises to it with `JSON.stringify`.
+
+## People, cases and the clock
+
+```js
+import { Simmail, Temperament, LinkHabit, JobKind, EventAlias } from "@plexuslabs/simmail";
+
+const dana = await mail.personas.create({
+  name: "Dana Reyes",
+  addresses: ["dana@harbor.test"],
+  temperament: Temperament.Skeptical,
+  style: { links: LinkHabit.Wary },
+});
+
+const deal = await mail.cases.push("deal-1701", {
+  title: "Sale of 1701 Clark Street",
+  people: [{ ref: "seller", name: "Dana Reyes", addresses: ["dana@harbor.test"] }],
+});
+await deal.initiate({ persona: dana.id, to: "agent@yourcompany.test", intent: "ask about the offer" });
+
+await mail.clock.advance("2d");                    // follow-ups and nudges that were due happen
+await dana.runDue({ kind: JobKind.Reply });        // or run her pending replies now
+
+const sent = await dana.waitFor(EventAlias.Replied, { fast: true });   // or "declined", "clicked", "bounced"
+const talk = await msg.waitUntilQuiet({ quiet: "10s" });               // the whole conversation, once it settles
+console.log(talk.messages.length, talk.latest.subject);
+```
+
+## Chaos, recipients, webhooks and the World
+
+```js
+import { FaultScenario, MailboxStatus, StreamKind, EventType } from "@plexuslabs/simmail";
+
+await mail.faults.add(FaultScenario.GmailRate, { match: "@gmail.com" });  // Gmail rate-limits you
+await mail.recipients.setStatus("old-client@harbor.test", MailboxStatus.Disabled);
+await mail.webhooks.set([{ url: "https://hooks.yourcompany.test/simmail", events: [EventType.PersonaSent, "link.*"] }]);
+await mail.world.set({
+  company: { name: "Acme Realty", domain: "acme-realty.test" },
+  streams: [{ name: "Website leads", kind: StreamKind.Lead, to: ["sales@acme-realty.test"], per_day: 6, enabled: true }],
+});
+
+for await (const event of mail.events({ since: 0 })) {   // the live stream
+  if (event.kind === EventType.PersonaSent) break;
+}
+```
+
+Each group (`mail.personas`, `mail.cases`, `mail.clock`, `mail.jobs`, `mail.world`, `mail.faults`,
+`mail.recipients`, `mail.webhooks`, `mail.insights`, `mail.events`, `mail.accounts`, `mail.inspect`,
+`mail.behaviour`) has the calls for that part of the API. The 0.1.0 methods (`mail.clock()`,
+`mail.advance("2d")`, `mail.waitForEmail({ to })`, …) still work as before.
+
+## Named values
+
+Every setting with fixed choices has named constants: `Temperament`, `Knows`, `Life`, `Length`,
+`Formality`, `MailClient`, `LinkHabit`, `SpamFilter`, `Access`, `Stance`, `MailboxStatus`, `BadKind`,
+`FailAt`, `Stranger`, `Folder`, `AiMode`, `MissingSite`, `LocalLinks`, `Protocol`, `Role`,
+`PersonaSource`, `StreamKind`, `FaultKind`, `FaultStage`, `FaultScenario`, `JobKind`, `JobState`,
+`StoryBy`, `EventType`, `EventAlias`, `ErrorCode`. Each is the API's plain string
+(`Temperament.Skeptical === "skeptical"`), so the string works too. They are generated from the
+server's `GET /api/schema`; `EnumInfo.Temperament.skeptical.description` and
+`describe("Temperament", value)` give the words the dashboard shows.
+
+## What's covered
+
+| Area | Calls |
+| --- | --- |
+| Waiting | `waitForEmail`, `expectNoEmail`, `waitForReply`, `waitForEvent`, `waitForThread`, `extract` |
+| Test addresses | `testAddress`, `createAddress`, `tag`, `listMessages`, `deleteMessages` |
+| Mail | `mailboxes`, `mailbox`, `folders`, `messages`, `message`, `rawMessage`, `attachment`, `updateMessage`, `threads`, `setMailboxStatus`, `send`, `inject`, `signature`, `setSignature`, `rescue`, `retry` |
+| Logins | `accounts`, `createAccount`, `updateAccount`, `deleteAccount`, `testAccount` |
+| People | `personas`, `persona`, `createPersona`, `updatePersona`, `deletePersona`, `personaFromMail`, `temperaments`, `memory`, `addMemory`, `clearMemory`, `addMemoryByExternal`, `relations`, `forgetRelations` |
+| Cases | `cases`, `getCase`, `pushCase`, `addCasePeople`, `initiateCase`, `regenerateCase`, `editCaseStory`, `deleteCase` |
+| Clock and jobs | `clock`, `advance`, `freeze`, `speed`, `live`, `jobs`, `runDue`, `runJob`, `skipJob`, `bounceJob`, `rescheduleJob` |
+| Events | `events` (live stream), `log` |
+| Behaviour | `ai`, `setAi`, `aiBudget`, `pace`, `setPace`, `recipients`, `setRecipients`, `links`, `setLinks`, `retention`, `setRetention`, `pruneRetention`, `junkSettings`, `setJunkSettings` |
+| Chaos | `faults`, `setFaults`, `faultScenarios`, `addFaultScenario` |
+| Inspection | `health`, `insights`, `insightShares`, `shareInsights`, `revokeInsightShare` |
+| Webhooks and the World | `webhooks`, `setWebhooks`, `world`, `setWorld`, `sendFromStream` |
+| Who and where | `me`, `universes`, `status`, `connection`, `connectionCert`, `schema` |
+
+Anything else is one `mail.request(method, path, body, query)` call.
+
+## Errors
+
+A failed call throws a `SimmailError` with the HTTP `status`, the server's message, its `code` (an
+`ErrorCode`) and `requestId`. The subclasses say which kind: `ValidationError` (400, with `field` and
+`allowed`), `AuthError` (401), `PlanLimitError` (402), `ForbiddenError` (403), `NotFoundError` (404),
+`WaitTimeoutError` (408, with `nearMisses`), `ConflictError` (409, such as a person who decided not
+to reply), `UnexpectedEmailError` (409, from `expectNoEmail`, with the `email`), `IdempotencyError`
+(422) and `RateLimitedError` (429, with `retryAfter`).
+
+Every `send` and `inject` carries its own Idempotency-Key, so the client can safely try a write
+again: GETs and keyed writes are retried after a network error, 502 or 503 (`retries`, default 2),
+and an answer the server had already given says `replayed: true`. To follow a request in the
+server's logs, use `mail.withRequestId("ci-1234")`.
+
+```js
+import { WaitTimeoutError } from "@plexuslabs/simmail";
+
+try {
+  await mail.mailbox(email).waitForEmail({ subject: "verify", timeout: "10s" });
+} catch (e) {
+  if (e instanceof WaitTimeoutError) console.log("nothing arrived", e.nearMisses);
+  else throw e;
+}
+```
+
+## License
+
+Apache-2.0

package/enums.d.ts

@@ -0,0 +1,103 @@
+// Generated by sdk/tools/gen_enums.py from GET /api/schema (version 1). Do not edit by hand.
+
+type OneOf<T> = T[keyof T];
+
+/** How a person tends to answer. */
+export declare const Temperament: { readonly Responsive: "responsive"; readonly Busy: "busy"; readonly Procedural: "procedural"; readonly Skeptical: "skeptical"; readonly Flaky: "flaky"; readonly Difficult: "difficult"; readonly Ghost: "ghost" };
+export type Temperament = OneOf<typeof Temperament>;
+/** How much a person knows about their case. */
+export declare const Knows: { readonly All: "all"; readonly Some: "some"; readonly Little: "little" };
+export type Knows = OneOf<typeof Knows>;
+/** Whose hours a person's replies keep. */
+export declare const Life: { readonly Work: "work"; readonly Personal: "personal"; readonly Both: "both" };
+export type Life = OneOf<typeof Life>;
+/** How long a person writes. */
+export declare const Length: { readonly Short: "short"; readonly Medium: "medium"; readonly Long: "long" };
+export type Length = OneOf<typeof Length>;
+/** How formally a person writes. */
+export declare const Formality: { readonly Casual: "casual"; readonly Neutral: "neutral"; readonly Formal: "formal" };
+export type Formality = OneOf<typeof Formality>;
+/** A person's mail program: how their mail looks. */
+export declare const MailClient: { readonly Gmail: "gmail"; readonly Outlook: "outlook"; readonly Apple: "apple"; readonly IPhone: "iphone"; readonly Android: "android"; readonly Plain: "plain" };
+export type MailClient = OneOf<typeof MailClient>;
+/** Whether a person clicks links in mail. */
+export declare const LinkHabit: { readonly Usual: "usual"; readonly Curious: "curious"; readonly Wary: "wary"; readonly Never: "never" };
+export type LinkHabit = OneOf<typeof LinkHabit>;
+/** A person's provider's spam filter. */
+export declare const SpamFilter: { readonly Strict: "strict"; readonly Normal: "normal"; readonly Lenient: "lenient"; readonly None: "none" };
+export type SpamFilter = OneOf<typeof SpamFilter>;
+/** How a person takes in mail. */
+export declare const Access: { readonly ScreenReader: "screen_reader"; readonly LowVision: "low_vision" };
+export type Access = OneOf<typeof Access>;
+/** How a person feels about a sender (it follows the conversation). */
+export declare const Stance: { readonly Warm: "warm"; readonly Neutral: "neutral"; readonly Wary: "wary"; readonly Annoyed: "annoyed"; readonly Done: "done" };
+export type Stance = OneOf<typeof Stance>;
+/** What a bad address does. */
+export declare const BadKind: { readonly Blocked: "blocked"; readonly Disabled: "disabled"; readonly Domain: "domain"; readonly Full: "full"; readonly Unknown: "unknown" };
+export type BadKind = OneOf<typeof BadKind>;
+/** When a bad address fails. */
+export declare const FailAt: { readonly Dsn: "dsn"; readonly Rcpt: "rcpt" };
+export type FailAt = OneOf<typeof FailAt>;
+/** Who is behind a never-seen address. */
+export declare const Stranger: { readonly Off: "off"; readonly Basic: "basic"; readonly Ai: "ai" };
+export type Stranger = OneOf<typeof Stranger>;
+/** A fixed outcome for one address as a recipient (ok clears it). */
+export declare const MailboxStatus: { readonly Ok: "ok"; readonly Blocked: "blocked"; readonly Disabled: "disabled"; readonly Domain: "domain"; readonly Full: "full"; readonly Unknown: "unknown" };
+export type MailboxStatus = OneOf<typeof MailboxStatus>;
+/** What a fault rule does. */
+export declare const FaultKind: { readonly Error: "error"; readonly Greylist: "greylist"; readonly Rate: "rate"; readonly Drop: "drop" };
+export type FaultKind = OneOf<typeof FaultKind>;
+/** When in the SMTP conversation a fault rule acts. */
+export declare const FaultStage: { readonly Mail: "mail"; readonly Rcpt: "rcpt"; readonly Data: "data" };
+export type FaultStage = OneOf<typeof FaultStage>;
+/** Real providers' failures, ready made. */
+export declare const FaultScenario: { readonly GmailUnauthenticated: "gmail-unauthenticated"; readonly GmailRate: "gmail-rate"; readonly GmailNoUser: "gmail-no-user"; readonly GmailOverQuota: "gmail-over-quota"; readonly MicrosoftBusy: "microsoft-busy"; readonly MicrosoftBlocked: "microsoft-blocked"; readonly MicrosoftAccessDenied: "microsoft-access-denied"; readonly YahooDeferred: "yahoo-deferred"; readonly YahooPolicy: "yahoo-policy"; readonly Greylisting: "greylisting"; readonly RateLimit: "rate-limit"; readonly Drop: "drop"; readonly Slow: "slow"; readonly MailboxFull: "mailbox-full" };
+export type FaultScenario = OneOf<typeof FaultScenario>;
+/** When a sender's website does not exist. */
+export declare const MissingSite: { readonly Imagine: "imagine"; readonly Notice: "notice" };
+export type MissingSite = OneOf<typeof MissingSite>;
+/** Links to your own machine or network. */
+export declare const LocalLinks: { readonly Ignore: "ignore"; readonly Broken: "broken" };
+export type LocalLinks = OneOf<typeof LocalLinks>;
+/** What an inbound stream of the World sends. */
+export declare const StreamKind: { readonly Lead: "lead"; readonly Support: "support"; readonly Vendor: "vendor"; readonly Partner: "partner"; readonly Customer: "customer"; readonly Newsletter: "newsletter"; readonly Spam: "spam"; readonly Phishing: "phishing"; readonly Custom: "custom" };
+export type StreamKind = OneOf<typeof StreamKind>;
+/** AI writing on or off. */
+export declare const AiMode: { readonly On: "on"; readonly Off: "off" };
+export type AiMode = OneOf<typeof AiMode>;
+/** Event types, for waits, the event stream and webhooks (a name ending in * matches a prefix). */
+export declare const EventType: { readonly MailDelivered: "mail.delivered"; readonly MailRetried: "mail.retried"; readonly MailDeleted: "mail.deleted"; readonly PersonaReceived: "persona.received"; readonly PersonaSent: "persona.sent"; readonly PersonaIgnored: "persona.ignored"; readonly PersonaBatched: "persona.batched"; readonly PersonaJunked: "persona.junked"; readonly PersonaRescued: "persona.rescued"; readonly PersonaBounced: "persona.bounced"; readonly PersonaPromised: "persona.promised"; readonly PersonaWaiting: "persona.waiting"; readonly PersonaCreated: "persona.created"; readonly PersonaUpdated: "persona.updated"; readonly PersonaMemory: "persona.memory"; readonly LinkOpened: "link.opened"; readonly LinkSkipped: "link.skipped"; readonly LinkFailed: "link.failed"; readonly LinkSender: "link.sender"; readonly InspectScored: "inspect.scored"; readonly InspectLinks: "inspect.links"; readonly WorldMail: "world.mail"; readonly WorldUpdated: "world.updated"; readonly JobScheduled: "job.scheduled"; readonly JobUpdated: "job.updated"; readonly JobDone: "job.done"; readonly JobSkipped: "job.skipped"; readonly JobFailed: "job.failed"; readonly CaseUpdated: "case.updated"; readonly Clock: "clock"; readonly Pace: "pace"; readonly FaultsUpdated: "faults.updated"; readonly JunkSettings: "junk.settings"; readonly NetworkUpdated: "network.updated"; readonly RetentionPruned: "retention.pruned"; readonly WebhookFailed: "webhook.failed"; readonly WriterFallback: "writer.fallback"; readonly AiMode: "ai.mode"; readonly AuthOk: "auth.ok"; readonly AuthFailed: "auth.failed"; readonly CheckReceived: "check.received"; readonly CheckDone: "check.done"; readonly CheckRefused: "check.refused" };
+export type EventType = OneOf<typeof EventType> | (string & {});
+/** What a planned job is. */
+export declare const JobKind: { readonly Reply: "reply"; readonly Followup: "followup"; readonly Correction: "correction"; readonly OutOfOffice: "ooo"; readonly Bounce: "bounce"; readonly Initiate: "initiate"; readonly Deliver: "deliver"; readonly Nudge: "nudge"; readonly Dsn: "dsn"; readonly World: "world"; readonly Visit: "visit" };
+export type JobKind = OneOf<typeof JobKind>;
+/** Where a job stands. */
+export declare const JobState: { readonly Pending: "pending"; readonly Done: "done"; readonly Skipped: "skipped"; readonly Failed: "failed" };
+export type JobState = OneOf<typeof JobState>;
+/** Common folders (any folder name works too). */
+export declare const Folder: { readonly Inbox: "INBOX"; readonly Sent: "Sent"; readonly Drafts: "Drafts"; readonly Archive: "Archive"; readonly Trash: "Trash"; readonly Junk: "Junk" };
+export type Folder = OneOf<typeof Folder> | (string & {});
+/** Which protocol a login test tries. */
+export declare const Protocol: { readonly Smtp: "smtp"; readonly Imap: "imap" };
+export type Protocol = OneOf<typeof Protocol>;
+/** A role in a universe. */
+export declare const Role: { readonly Viewer: "viewer"; readonly Member: "member"; readonly Admin: "admin"; readonly Owner: "owner" };
+export type Role = OneOf<typeof Role>;
+/** Where a persona came from. */
+export declare const PersonaSource: { readonly Api: "api"; readonly Case: "case"; readonly Stranger: "stranger"; readonly World: "world"; readonly Mail: "mail"; readonly Config: "config" };
+export type PersonaSource = OneOf<typeof PersonaSource>;
+/** Who wrote a case's story. */
+export declare const StoryBy: { readonly Ai: "ai"; readonly Template: "template"; readonly Edited: "edited" };
+export type StoryBy = OneOf<typeof StoryBy>;
+/** Friendlier names the event wait accepts for common events. */
+export declare const EventAlias: { readonly Delivered: "delivered"; readonly Received: "received"; readonly Replied: "replied"; readonly Sent: "sent"; readonly Declined: "declined"; readonly Ignored: "ignored"; readonly Junked: "junked"; readonly Bounced: "bounced"; readonly Clicked: "clicked"; readonly OpenedLink: "opened_link"; readonly Promised: "promised"; readonly Rescued: "rescued" };
+export type EventAlias = OneOf<typeof EventAlias>;
+/** The code every error answer carries. */
+export declare const ErrorCode: { readonly BadRequest: "bad_request"; readonly InvalidValue: "invalid_value"; readonly InvalidRegex: "invalid_regex"; readonly Unauthorized: "unauthorized"; readonly NotInPlan: "not_in_plan"; readonly Forbidden: "forbidden"; readonly NotFound: "not_found"; readonly MethodNotAllowed: "method_not_allowed"; readonly Timeout: "timeout"; readonly WaitTimeout: "wait_timeout"; readonly Conflict: "conflict"; readonly UnexpectedEmail: "unexpected_email"; readonly TooLarge: "too_large"; readonly Unprocessable: "unprocessable"; readonly IdempotencyMismatch: "idempotency_mismatch"; readonly RateLimited: "rate_limited"; readonly InternalError: "internal_error"; readonly BadGateway: "bad_gateway"; readonly Unavailable: "unavailable" };
+export type ErrorCode = OneOf<typeof ErrorCode>;
+
+export interface EnumValueInfo { label?: string; description?: string; feature?: string }
+/** Each enum value's label, description and plan feature. */
+export declare const EnumInfo: { readonly [enumName: string]: { readonly [value: string]: EnumValueInfo } };
+/** The label of a value, such as describe("Temperament", "skeptical"). */
+export declare function describe(enumName: string, value: string): string;