spinupmail 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Rıdvan Aktogan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,80 @@
+# SpinupMail SDK
+
+[SpinupMail](https://spinupmail.com) TypeScript SDK for creating and reading temporary email addresses.
+
+## Install
+
+```bash
+pnpm install spinupmail
+```
+
+## Usage
+
+```ts
+import { SpinupMail } from "spinupmail";
+
+const spinupmail = new SpinupMail();
+
+const address = await spinupmail.addresses.create({
+  acceptedRiskNotice: true,
+});
+
+const email = await spinupmail.inboxes.waitForEmail({
+  addressId: address.id,
+  after: new Date(),
+  subjectIncludes: "verify",
+  timeoutMs: 30_000,
+});
+
+console.log(email.subject);
+```
+
+`new SpinupMail()` defaults to:
+
+- `process.env.SPINUPMAIL_API_KEY`
+- `process.env.SPINUPMAIL_BASE_URL` or `https://api.spinupmail.com`
+- `process.env.SPINUPMAIL_ORGANIZATION_ID` or `process.env.SPINUPMAIL_ORG_ID`
+
+You can override any of them:
+
+```ts
+import { SpinupMail } from "spinupmail";
+
+const spinupmail = new SpinupMail({
+  apiKey: "spin_other_key",
+  organizationId: "org_123",
+});
+```
+
+If you omit `localPart`, the SDK generates a random valid inbox name before sending the request.
+
+Use `search` to match recent emails by indexed content:
+
+```ts
+const email = await spinupmail.inboxes.waitForEmail({
+  addressId: address.id,
+  search: "verify",
+  timeoutMs: 30_000,
+});
+
+const emails = await spinupmail.emails.list({
+  addressId: address.id,
+  search: "verify",
+});
+```
+
+Use `after` with local filters to wait for a specific email after a timestamp:
+
+```ts
+const runStartedAt = new Date();
+
+const email = await spinupmail.inboxes.waitForEmail({
+  addressId: address.id,
+  after: runStartedAt,
+  subjectIncludes: "verify",
+  bodyIncludes: "654321",
+  timeoutMs: 30_000,
+});
+
+console.log(email.text);
+```