matrix-org / matrix-org/matrix-spec

Define an event format for email. (SPEC-226)

Open
#99 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-Client-Server enhancement
Dominant language
HTML
Stars
330
Forks
150
Avg merge
2h 21m
Merged PRs (30d)
3

Description

Submitted by @​matthew:matrix.org
There are several email gateways hanging around now, and it's unclear how best to represent email. Is it a custom msgtype on an m.room.message? Does it track additional fields for the SMTP headers? Does it track all the headers? What about the envelope headers? How do we handle mails larger than 65K? Do we split attachments out into MXC URLs, or keep it all mime encoded? etc

(Imported from https://matrix.org/jira/browse/SPEC-226)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing Matrix event and message conventions, then compare the email gateways mentioned in the issue. A complete result would resolve the event type, SMTP and envelope header fields, size handling, and attachment representation, with the format documented in the specification.

Written by the indexing model from the issue text.

Assessment

Domain
backend-api-design, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.