Hacktoberfest 2026: die Issues, die Maintainer für den Oktober markiert haben – offen und einsteigerfreundlich. Hacktoberfest-Issues durchsuchen

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

Offen
  • Stimmt etwas nicht?
#511 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Anfängerfreundlichkeit
35/100
Issue-Typ
Feature
Klarheit
Größtenteils klar
Aktivitätsstatus
Aktiv
Tech-Stack
typescript
Bereich
backend

Rechercherichtung

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.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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

Vorherrschende Sprache
TypeScript
Sterne
402
Forks
32
Ø Merge
10 Std. 51 Min.
Gemergte PRs (30 T.)
100

Entwicklungsumgebung

Dieses Projekt bietet weder Dev-Container noch Dockerfile noch Beitragsleitfaden – die Einrichtung liegt bei Ihnen. Beginnen Sie mit der README; die allgemeinen Schritte stehen in unserem Leitfaden für den ersten Beitrag.

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus voidzero-dev/void

Alle Issues in voidzero-dev/void

Ähnliche Issues

Weitere Issues zu TypeScript

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.