[⚠️ DEPRECATED ⚠️] Helper server for fxa-auth-server to send email. Use fxa-auth-server directly
JavaScript HTML Shell
Latest commit 44f9667 Feb 17, 2017 @vladikoff vladikoff Release v1.81.0
Permalink
Failed to load latest commit information.
bin changes to make this ready for production (#206) r=vladikoff Sep 7, 2016
config fix(mailer): Slow down the verification reminder emails in dev. (#181) Jul 14, 2016
grunttasks feat(build): Add version-tagging grunt tasks Jun 22, 2016
lib feat(mailer): add support for sending SMS messages Feb 16, 2017
partials refactor(templates): Update to correct font-size and line height (#249)… Jan 20, 2017
scripts feat(mailer): add support for sending SMS messages Feb 16, 2017
templates feat(mailer): add support for sending SMS messages Feb 16, 2017
test feat(mailer): add support for sending SMS messages Feb 16, 2017
.eslintrc chore(lint): add ESLint to repo Jun 18, 2015
.gitignore feat(geo): add state info into emails (#215) r=vbudhram Sep 30, 2016
.travis.yml fix(travis): test on node 4 and 6; always CXX=g++-4.8 Oct 7, 2016
AUTHORS chore(docs): update AUTHORS file (#252) Jan 27, 2017
CHANGELOG.md Release v1.81.0 Feb 17, 2017
Gruntfile.js feat(build): Add version-tagging grunt tasks Jun 22, 2016
LICENSE Add the full text of the MPL 2.0 Sep 22, 2014
README.md fix(l10n): update l10n SHA handling (#238) r=jrgm Dec 13, 2016
config.js fix(config): change reminder poll for many servers (#257), r=@vbudhram Feb 8, 2017
index.js feat(mailer): add support for sending SMS messages Feb 16, 2017
legacy_log.js feat(log): switch to mozlog Jan 19, 2016
log.js feat(log): switch to mozlog Jan 19, 2016
mailer.js fix(dependencies): update bluebird, nodemailer, convict, moment-timez… Feb 1, 2017
npm-shrinkwrap.json Release v1.81.0 Feb 17, 2017
package.json Release v1.81.0 Feb 17, 2017
translator.js fix(l10n): adjust default language (#200) r=vbudhram Aug 15, 2016

README.md

Firefox Accounts Mailer

Build Status Coverage Status

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.