9bd342f5fc
|
||
|---|---|---|
| bin | ||
| config | ||
| grunttasks | ||
| lib | ||
| partials | ||
| scripts | ||
| templates | ||
| test | ||
| .eslintrc | ||
| .gitignore | ||
| .travis.yml | ||
| AUTHORS | ||
| CHANGELOG.md | ||
| Gruntfile.js | ||
| LICENSE | ||
| README.md | ||
| config.js | ||
| index.js | ||
| legacy_log.js | ||
| log.js | ||
| mailer.js | ||
| npm-shrinkwrap.json | ||
| package.json | ||
| translator.js | ||
README.md
Firefox Accounts Mailer
Library to send out verification emails in the fxa-auth-server which renders emails from a template (and handles localization).
The emails are written to postfix which tends sends them off to SES.
The auth-mailer also includes a restify API to send emails, but the auth server is using it as a library at the moment.
Prerequisites
- node 4
- npm 2
- postfix
Changing Templates
If you are changing or adding templates then you need to update .html and .txt templates.
Use the /partials directory to make changes to the HTML templates, then run grunt templates to regenerate the template.
This saves the HTML template into /templates. Then make changes to the .txt template in the /templates directory.
L10N
After updating a string in one of the templates in ./templates you'll need to extract the strings using this script:
extract_strings.sh [--mailer-repo ./fxa-auth-mailer] [--content-repo ./fxa-content-server] [--l10n-repo ./fxa-content-server-l10n] train_number
Production
Use the FXA_L10N_SHA to pin L10N files to certain SHA. If not set then the master SHA will be used.