Support email 3pid #188

New issue

Open

opened 2021-11-09 01:47:44 +00:00 by jblachly · 6 comments

jblachly commented

2021-11-09 01:47:44 +00:00

(Migrated from gitlab.com)

Problem

Editing user preferences to add or associate an email address with an existing account results in an error.

In elements web app for instance, when adding an email, one is met with error request failed: CORS request rejected: https://server.url/_matrix/client/r0/account/3pid/email/requestToken. Examination of network traffic reveals 404 rather than CORS error per se.

Reason

The endpoint /_matrix/client/r0/account/3pid/email/requestToken [0] does not exist.

Proposal

Support email 3pid throughout the homeserver and identity server; ultimately, we MUST support addition and removal of email to the user account, and we SHOULD support validation of email [0], and using email to recover account / reset password. [1]

Proposed solution

Modify the User struct and database table to include an email field.
Modify endpoint third_party_route in src/client_server/account.rs to return the email 3pid
Add endpoint /_matrix/client/r0/account/3pid/email/requestToken at end of src/client_server/account.rs
(Future) Add email validation workflow; will require one or more email provider backends/APIs. I would defer this work for now and initially just add the email to the account directly to enhance UX.

As a side note, the work could be trivially duplicated (minus step 3, validation) to also support adding phone number/msisdn 3pid type.

References

[0] https://matrix.org/docs/spec/client_server/r0.6.1#post-matrix-client-r0-account-3pid-email-requesttoken

[1] https://matrix.org/docs/spec/client_server/r0.6.1#post-matrix-client-r0-account-password-email-requesttoken

# Problem Editing user preferences to add or associate an email address with an existing account results in an error. In elements web app for instance, when adding an email, one is met with error `request failed: CORS request rejected: https://server.url/_matrix/client/r0/account/3pid/email/requestToken`. Examination of network traffic reveals 404 rather than CORS error _per se_. # Reason The endpoint `/_matrix/client/r0/account/3pid/email/requestToken` [0] does not exist. # Proposal Support email 3pid throughout the homeserver and identity server; ultimately, we MUST support addition and removal of email to the user account, and we SHOULD support validation of email [0], and using email to recover account / reset password. [1] # Proposed solution 1. Modify the `User` struct and database table to include an email field. 2. Modify endpoint `third_party_route` in `src/client_server/account.rs` to return the email 3pid 3. Add endpoint `/_matrix/client/r0/account/3pid/email/requestToken` at end of `src/client_server/account.rs` 4. (Future) Add email validation workflow; will require one or more email provider backends/APIs. I would defer this work for now and initially just add the email to the account directly to enhance UX. As a side note, the work could be trivially duplicated (minus step 3, validation) to also support adding phone number/msisdn 3pid type. # References [0] https://matrix.org/docs/spec/client_server/r0.6.1#post-matrix-client-r0-account-3pid-email-requesttoken [1] https://matrix.org/docs/spec/client_server/r0.6.1#post-matrix-client-r0-account-password-email-requesttoken

jblachly commented

2021-11-09 02:36:00 +00:00

(Migrated from gitlab.com)

Implementation notes

Token management

Spec: https://matrix.org/docs/spec/client_server/r0.6.1#post-matrix-client-r0-account-3pid-email-requesttoken

RUMA: https://github.com/ruma/ruma/blob/main/crates/ruma-client-api/src/r0/account/request_3pid_management_token_via_email.rs

Add 3pid (presumably called via the emailed token callback)

Spec: https://matrix.org/docs/spec/client_server/r0.6.1#post-matrix-client-r0-account-3pid-add

RUMA: https://github.com/ruma/ruma/blob/main/crates/ruma-client-api/src/r0/account/add_3pid.rs

Implementation notes ### Token management Spec: https://matrix.org/docs/spec/client_server/r0.6.1#post-matrix-client-r0-account-3pid-email-requesttoken RUMA: https://github.com/ruma/ruma/blob/main/crates/ruma-client-api/src/r0/account/request_3pid_management_token_via_email.rs ### Add 3pid (presumably called via the emailed token callback) Spec: https://matrix.org/docs/spec/client_server/r0.6.1#post-matrix-client-r0-account-3pid-add RUMA: https://github.com/ruma/ruma/blob/main/crates/ruma-client-api/src/r0/account/add_3pid.rs

jblachly commented

2021-11-09 02:37:40 +00:00

(Migrated from gitlab.com)

changed the description

timokoesters commented

2021-12-14 14:16:34 +00:00

(Migrated from gitlab.com)

This has low priority for now because you can easily use matrix without email.

chris-morgan commented

2022-02-12 05:13:50 +00:00

(Migrated from gitlab.com)

mentioned in issue #237

jblachly commented

2022-07-15 23:11:59 +00:00

(Migrated from gitlab.com)

mentioned in merge request !375

zicklag commented

2024-02-02 01:24:55 +00:00

(Migrated from gitlab.com)

Is this issue what's necessary to support email notifications, and would you be open to PRs for it? I probably won't get the time, but just in case, I might be able to work on it.

I'm unsure if this issue is exactly what's needed, but I've just started up a conduit server as a light-weight replacement for my Rocket.chat server, and the only thing I'm missing so far is the ability to send email notifications for mentions. Is this issue what's necessary to support email notifications, and would you be open to PRs for it? I probably won't get the time, but just in case, I might be able to work on it.