Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

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

Đang mở
  • Có gì không ổn?
#511 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
35/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
typescript
Lĩnh vực
backend

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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

Ngôn ngữ chính
TypeScript
Star
402
Fork
32
Merge trung bình
11 giờ 52 phút
Pull request đã merge (30 ngày)
88

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của voidzero-dev/void

Tất cả issue của voidzero-dev/void

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.