matrix-org / matrix-org/matrix-spec
Unsubscribing from push email notifications is not specced nor mentioned
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 330
- Forks
- 150
- Avg merge
- 2h 21m
- Merged PRs (30d)
- 3
Description
(noticed from https://github.com/matrix-org/synapse/issues/4249 )
We don't currently even mention unsubscribing from email pushers in the spec, in such a way that the CAN SPAM act and similar legislation requires. We should probably at least mention that a compliant Matrix server SHOULD provide such capability.
Speccing a particular way of unsubscribing is probably not useful, considering that a user will be interacting with it through a link in an email, and not through a Matrix client. However, it may be worth detailing an example API that meets common user requirements.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading this issue alongside matrix-org/synapse#4249 and the existing Matrix specification sections on email pushers. Clarify whether the specification should require unsubscribe capability, document an example API, or both; done means the agreed behavior is explicitly captured in the spec and reviewed for compliance scope.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100