Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Platform email: short, unique mail alias per project on the shared sender domain, independent of the project slug

クローズ
#511 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

@Brooooooklyn がすでに取り組んでいます。

2026年10月22日 から。

  • #553 @Brooooooklyn による — マージ済み

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
35/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
活発
技術スタック
typescript
領域
backend

調査の方向性

Start with the cited email admission, inbound router, runtime inbound handler, and router compile entry points, then trace how the shared recipient service creates and reconciles routing rules and how projects are stored and migrated. The issue identifies the affected integration suites: email admission and email shared recipients. Before implementation, maintainers need to decide the alias ownership rules, whether aliases can change, and whether the original slug remains valid; done means those choices are implemented across routing, runtime, persistence, and tests.

索引モデルが issue の本文から書いたものです。

説明

Use case

We run a self-hosted Void platform serving several brands. Our apps put a signed token in the sub-address so that a reply can be matched to its conversation without storing state, in the shape <slug>+reply+<token>@<mail domain>, with a 50-character token (c|t + 26 + . + 22). The shared domain ties the whole mailbox name to the project slug, and that collides with the RFC 5321 limit on the local part.

Problem

On the shared domain, the project slug is also the mailbox name:

The local part is limited to 64 octets (RFC 5321 section 4.5.3.1.1). With the shape above, the fixed part is +reply+ (7) plus the 50-character token, which is 57 octets. That leaves at most 7 characters for the slug. Descriptive slugs such as brand-feedback cannot be used for mail on the shared domain. The only choices are a shorter token, which weakens the scheme, or a different project name.

Slugs cannot be renamed, so a different name means recreating the project, which changes its URL and loses its deployments.

Proposal

An optional email_alias per project:

  • Short, lowercase and unique across the installation, validated with the slug rules and against EMAIL_RESERVED_SLUGS (reserved-slugs.ts L28-L34) so no project can claim a platform address. It should also be rejected when it equals another project's slug.
  • When set, admission and the router accept <alias>+... in place of <slug>+.... null keeps today's behaviour exactly.
  • The runtime strips the same prefix: stripSlugFromAddress and __VOID_PROJECT_SLUG would carry the alias when one is set.
  • Settable by an administrator or by the project owner (your call). The shared-recipient service creates one exact Cloudflare routing rule per receiving project, so changing the alias needs a reconcile of that rule.

I would expect to touch admission.ts, email-router.ts, the shared recipient service, the projects schema plus an additive migration, and the compile step above, with tests in the email-admission and email-shared-recipients integration suites. Happy to send a PR if you prefer this direction.

Questions for maintainers

  1. Do you prefer an alias field like this, or another approach, for example a shorter token format in apps, or sub-address handling that does not count the slug against the limit?
  2. Should the alias be permanent once mail has been sent from it, or freely changeable? Reply tokens already in flight would break on a change.
  3. Should the old slug keep working as a secondary address while an alias is active?

Related: #509, #510

主要言語
TypeScript
スター
580
フォーク
56
平均マージ
8時間 32分
マージ済み PR(30日)
111

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

voidzero-dev/void のほかの issue

voidzero-dev/void の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。