phx-mailer v0.1.0

phx-mailer

Node.js module to use with node-express3-mvc for rendering beautiful emails with ejs templates.

Install

$ git clone https://github.com/physalix/phx-mailer.git
$ npm install

or use it in package.json file :

"phx-mailer":  "git+ssh://git@github.com:physalix/phx-mailer.git"

NOTE: Do not forget to add a config file in your app :

• config/mailer.js

Here is env and parameters to add :

development:
  url: "http://localhost:3000"
  mailer: smtp
  from: "noreply@localhost"
  host: "localhost"
  port: 25
  use_authentication: 0
  user: ""
  pass: ""
test:
  url: "http://localhost"
  mailer: "test"
  from: "noreply@example.com"
production:
  mailer: smtp
  url: "http://yoursitename.tld"
  from: "noreply@yoursitename.tld"
  host: "localhost"
  port: 25
  use_authentication: 0
  user: ""
  pass: ""

Usage

var mailer = require('phx-mailer');

// Load mailer settings
mailer.init();

mailer.sendEmail(
    'test',
     {body: "Hello World",<br/>"},
     {subject: 'Test', email: 'test@test.com', from: 'fs@physalix.com'}
);	

NOTE: You need to create templates in the apps/emails directory :

• test.html
• test.txt

If you need more infos, please use the issue tracker. Feel free to fork and send updates :)

License

(The MIT License)

Copyright (c) 2012 Physalix < fs@physalix.com >

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.