JSPM

directus-extension-system-email-i18n

1.1.7
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 7
  • Score
    100M100P100Q67269F
  • License MIT

Directus CMS extension to translate system emails (password reset, user registration and invitation)

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (directus-extension-system-email-i18n) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    Directus i18n for System Emails

    This extension allows you to translate system emails (user invitation, user registration, password reset) per user.



    Installation

    There are multiple way to install an extension.

    Check the official Directus guide for more information.


    A. Installing via the Directus Marketplace

    Simply install it via the marketplace with 1 click.

    Mind that in order to see this in the (self-hosted and Enterprise Cloud) Directus Marketplace, you would need to allow non-sandboxed extensions (see docs).

    B. Installing via the npm Registry

    Use the code from npm via...

    npm install directus-extension-system-email-i18n

    or

    pnpm install directus-extension-system-email-i18n

    ... and include this into your Docker build flow.

    C. Installing via the Extensions Directory

    1. Download the code.
    2. Build it via npm ci && npm run build.
    3. Upload the files to your extensions directory.


    How to use

    • The extension is a hook, which filters all emails sent by Directus.
    • When we are dealing with a system email, it would check for the user's language.
    • If this language is not the default language, it would look for an email template with a language suffix.
    • Additionally (in all cases), it looks for a subject in a respective environment variable I18N_EMAIL_SUBJECTS.

    Warning:
    When you are using this extension, you need to make sure that for every system email type and used language, you have a liquid template set up.
    If a template is missing, emails might not get sent.



    Example

    Let's assume...

    • you are offering English (default) and German as potential languages.
    • you are not offering user invites and have no user registration DOI.
    • so, we only need to translate the password-reset emails.
    1. You would create a template password-reset (for English) and a template password-reset-de (for German).
    2. You would add an environment variable I18N_EMAIL_SUBJECTS with content {"de":{"password-reset": "Passwort zurücksetzen"}}.

    That's it.

    If you would now add Spanish:

    1. add a template password-reset-es
    2. adjust the env var to something like {"de":{"password-reset": "Passwort zurücksetzen"}, "es":{"password-reset": "Restablecer contraseña"}}

    Bonus: You could still also add an alternative English block to the env var in order to change the default subject.



    Contributing

    Anyone is welcome to contribute, but mind the guidelines: