@ryusenkei/mail 0.0.0-stage → 0.2.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 RYUSENKEI
+
+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

@@ -1,3 +1,36 @@
-# Temporary Holding Version
+# @ryusenkei/mail
 
-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 shared shape of an email (`Mail`, `MailAddress`), the `Mailer` interface, and the checks every sender runs before sending. Senders for a provider live elsewhere (for example, `cloudflareMailer` in `@ryusenkei/adapter-cloudflare`); `@ryusenkei/form` uses the interface for its mail destination.
+
+## Install
+
+```sh
+pnpm add @ryusenkei/mail
+```
+
+## Interface
+
+```ts
+type Mail = { from: MailAddress; to: MailAddress[]; replyTo?: MailAddress; subject: string; text: string; html?: string };
+interface Mailer { send(mail: Mail): Promise<Result<{ id: string | undefined }, 'invalid_input' | 'rejected'>> }
+```
+
+- `invalid_input`: a malformed address, no recipient, or a line break in a header field (blocks header injection).
+- `rejected`: the provider would not deliver it (a suppressed recipient, a delivery failure).
+- Infrastructure failures are thrown as `TransientError` or `ConfigError` from `@ryusenkei/core`.
+
+## Checks
+
+- `validateMail(mail)` is what every sender runs before sending. It rejects:
+  - CR, LF, NUL, U+0085, U+2028, and U+2029 in the subject or a display name
+  - addresses that fail `isEmailAddress`
+  - an empty `to`
+- `isEmailAddress(value)` is deliberately loose (not full RFC 5322). It rejects whitespace and `< > ( ) " , ; :`. `@ryusenkei/form` uses the same check, so an address that passes the form is never rejected at send time.
+
+## Testing
+
+`memoryMailer()` from `@ryusenkei/mail/testing` validates, then keeps sent mail in `outbox`.
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,28 @@
+import { type Result } from '@ryusenkei/core';
+export type MailAddress = {
+    email: string;
+    name?: string;
+};
+export type Mail = {
+    from: MailAddress;
+    to: MailAddress[];
+    replyTo?: MailAddress;
+    subject: string;
+    text: string;
+    html?: string;
+};
+/**
+ * メール送信の業務の失敗
+ * - 基盤の失敗（送信の API の障害）は `TransientError`、送信元の未認証・binding の不足は `ConfigError` を投げる
+ */
+export type MailError = 'invalid_input' | 'rejected';
+/** メールの送信 */
+export interface Mailer {
+    send(mail: Mail): Promise<Result<{
+        id: string | undefined;
+    }, MailError>>;
+}
+/** メールアドレスとして送れる形か（フォームの検査もこれを使い、送信の時に弾かれないようにする） */
+export declare const isEmailAddress: (value: string) => boolean;
+/** 送信の前の入力の検査（実装は送る前にこれを通す） */
+export declare function validateMail(mail: Mail): Result<void, 'invalid_input'>;

package/dist/index.js

@@ -0,0 +1,18 @@
+import { err, ok } from '@ryusenkei/core';
+// `RFC 5322` の厳密な検査ではなく、明らかな誤りと改行・空白の混入だけを弾く
+const EMAIL = /^[^\s@<>()",;:]+@[^\s@<>()",;:]+\.[^\s@<>()",;:]+$/;
+// `U+0085`・`U+2028`・`U+2029` も、改行として扱うメールの処理系がある
+const HEADER_BREAK = new RegExp(`[\\r\\n\\u0000${String.fromCharCode(0x85, 0x2028, 0x2029)}]`);
+/** メールアドレスとして送れる形か（フォームの検査もこれを使い、送信の時に弾かれないようにする） */
+export const isEmailAddress = (value) => EMAIL.test(value);
+/** 送信の前の入力の検査（実装は送る前にこれを通す） */
+export function validateMail(mail) {
+    const addresses = [mail.from, ...mail.to, ...(mail.replyTo ? [mail.replyTo] : [])];
+    if (!mail.to.length)
+        return err('invalid_input');
+    if (addresses.some((a) => !isEmailAddress(a.email) || (a.name !== undefined && HEADER_BREAK.test(a.name))))
+        return err('invalid_input');
+    if (HEADER_BREAK.test(mail.subject))
+        return err('invalid_input');
+    return ok();
+}

package/dist/testing.d.ts

@@ -0,0 +1,5 @@
+import { type Mail, type Mailer } from './index.ts';
+/** 送ったメールを `outbox` に溜めるメモリの実装（テストと dev 用） */
+export declare function memoryMailer(): Mailer & {
+    outbox: Mail[];
+};

package/dist/testing.js

@@ -0,0 +1,16 @@
+import { ok } from '@ryusenkei/core';
+import { validateMail } from "./index.js";
+/** 送ったメールを `outbox` に溜めるメモリの実装（テストと dev 用） */
+export function memoryMailer() {
+    const outbox = [];
+    return {
+        outbox,
+        async send(mail) {
+            const valid = validateMail(mail);
+            if (!valid.ok)
+                return valid;
+            outbox.push(mail);
+            return ok({ id: `memory-${outbox.length}` });
+        },
+    };
+}

package/package.json

@@ -1,6 +1,43 @@
 {
   "name": "@ryusenkei/mail",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.2.1",
+  "description": "メール送信の型と、宛先・ヘッダーの検査（メモリの実装付き）",
+  "license": "MIT",
+  "author": "RYUSENKEI",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ryusenkei-inc/toolkit.git",
+    "directory": "packages/runtime/mail"
+  },
+  "homepage": "https://github.com/ryusenkei-inc/toolkit/tree/main/packages/runtime/mail",
+  "type": "module",
+  "sideEffects": false,
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./testing": {
+      "types": "./dist/testing.d.ts",
+      "default": "./dist/testing.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "dependencies": {
+    "@ryusenkei/core": "^0.2.0"
+  },
+  "devDependencies": {
+    "typescript": "^5.9.3"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "typecheck": "tsc --noEmit"
+  }
 }