i18n support

[eladnava]

i18n support

[eladnava]

Hi @bjrmatos,
What an excellent suggestion!

Currently, the only phrases/words that need to be localized are:

• "Hi {name}"
• "Yours truly"
• "All rights reserved"

I'm thinking it would be better if we would make it possible to let users override these phrases with their own, thereby also making it possible to localize them, as well as customize the English ones (some companies wouldn't want to end their e-mails with "Yours truly" for example).

I think it would simply be harder to internationalize each Mailgen theme into 20+ languages and would allow for less flexibility in the end.

So what I'm thinking is the following for overriding the copyright:

// Configure mailgen by setting a theme and your product info
var mailGenerator = new Mailgen({
    theme: 'default',
    product: {
        name: 'Mailgen',
        // Optional override theme's copyright notice
        copyright: '(C) 2016 Mailgen.js'
    }
});

And this is how you would override the rest:

var email = {
    body: {
        greeting: 'Dear', // Optionally override 'Hi'
        name: 'John Appleseed',
        intro: 'Welcome to Mailgen! We’re very excited to have you on board.',
        outro: 'Need help, or have questions? Just reply to this email, we\'d love to help.',
        signature: 'Sincerely' // Optionally override 'Yours truly'
    }
};

This way, you can both customize and internationalize these static phrases in the templates.

What do you think @bjrmatos?

[bjrmatos]

I'm thinking it would be better if we would make it possible to let users override these phrases with their own, thereby also making it possible to localize them, as well as customize the English ones (some companies wouldn't want to end their e-mails with "Yours truly" for example).

I think it would simply be harder to internationalize each Mailgen theme into 20+ languages and would allow for less flexibility in the end.

yes, you're right it'll be harder with more themes, your approach sounds better to me 😄

in the case of new themes, each theme will need to define the custom properties that will allow override the phrases, right? sounds really good to me!

[eladnava]

@bjrmatos Yep! I'm thinking of simply adding new variables that will be available to the themes, e.g. product.copyright, greeting, and signature, which can be overridden with user-supplied phrases.

These variables will fallback to the current English phrases if not supplied by the user.

[eladnava]

@bjrmatos Let me know if you'd like to work on this yourself, and if not, I'd be glad to do it as well. 👍

[bjrmatos]

@eladnava great! unfortunately i only have time on weekends, if you have time to implement this please do! if not i will take care of this in the coming weekend 👍

[eladnava]

@bjrmatos No problem! Found some time and implemented this:
https://github.com/eladnava/mailgen#language-customizations

Thanks again for your suggestion! =)

[bjrmatos]

you're awesome! ❤️