foxcpp / maddy

✉️ Composable all-in-one mail server.
https://maddy.email
GNU General Public License v3.0
5.07k stars 244 forks source link

prepare_email is not documented, user_to_email is poorly described #565

Closed arisudesu closed 1 year ago

arisudesu commented 1 year ago

Describe the bug

prepare_email is missing explanation in reference, as well as user_to_email has poor description as "lookup table" (from what to what?).

It is only possible to deduce from code what it does: prepare_email takes e-mail address from "From" (1) field and maps it to single address or list of some addresses (A). Then authentication e-mail is mapped to list of addresses or domains (B) by user_to_email, and then if any address (or domain) from (A) belongs in (B) user is considered to be allowed sending from (1).

foxcpp commented 1 year ago

Documentation is improved in 6453363 .