buildEmailLink should include locale

[jonas-db]

New Feature / Enhancement Checklist

• I am not disclosing a vulnerability.
• I am not just asking a question.
• I have searched through existing issues.

Current Limitation

It seems that we have to include the locale ourselves in the email links generated by parse-server when we use the localization feature for pages (eg verify email).

  pages: {
    enableRouter: true, // Enables the experimental feature; required for localization
    enableLocalization: true,
    pagesPath: path.join(__dirname, 'static_pages'), 
  },

The link in the email is: .../verify_email?token=UqGZOpLog7HkF75fQiitxjHfy&username=ossmjmfdvpntnximhh%40nvhrw.com
while we would expect for example:
.../verify_email?token=UqGZOpLog7HkF75fQiitxjHfy&username=ossmjmfdvpntnximhh%40nvhrw.com&locale=nl-NL where nl-NL is the value of the field locale of the user

---

It also seems there is a mismatch between names? email_verification_successvs verify_email_success?

(PagesRouters.js):

    id: 'emailVerificationSuccess',
    defaultFile: 'email_verification_success.html',
  }),

yet the url that is generated by parse server: (Config.js):

    return (
      this.customPages.verifyEmailSuccess ||
      `${this.publicServerURL}/apps/verify_email_success.html`
    );
  }

---

We actually can't get the localization to work with the folder structure... include a &locale=nl-NL always returns the default page we provided in static_pages/verify_email_success.html. We have static_pages/nl-NL/verify_email_success.html and it is not picked up? Are we missing configuration?

EDIT: it seems we need to include the locale as .../nl-NL/verify_email..., this is not what is mentioned in the docs:
https://github.com/parse-community/parse-server#pages

Feature / Enhancement Description

After digging, it seems that the buildEmailLink should include the locale as a query parameter:

parse-server/src/Controllers/UserController.js

Line 329 in 4c29d4d

function buildEmailLink(destination, username, token, config) {

Example Use Case

Alternatives / Workarounds

Include the locale parameters ourselves in our own template: {{link}}&locale={{{locale}}}

Tried on beta4

[parse-github-assistant]

Thanks for opening this issue!

• 🎉 We are excited about your ideas for improvement!

[jonas-db]

After some more digging, adding &locale=nl-NL works when using the translations.json approach, but not when using the directory approach..

[mtrezza]

The way this is currently intended to work is that the email adapter localizes the URL, not Parse Server. The reason it is set up like this is because the email adapter already has to localize the email content itself, so localizing a placeholder like the URL is just another aspect of localization.

The only currently known mail adapter that can do that is the Parse Server API Mail Adapter. The process works like this:

1. Parse Server's buildEmailLink creates the basic URL, without locale.
2. The mail adapter composes the email and localizes its content including the URL. See the localeCallback in the docs.

Let us know whether this works for you and where you see room for improvement, especially in the docs.

I'm classifying this issue as a docs issue, however if there is anything that you think may be a bug, please point it out so we can look into it.