https://github.com/hakobera/mai

Node module for sending text e-mail, and managing email templates build on emailjs and ejs
https://github.com/hakobera/mai

Last synced: about 1 month ago
JSON representation

Node module for sending text e-mail, and managing email templates build on emailjs and ejs

• Host: GitHub
• URL: https://github.com/hakobera/mai
• Owner: hakobera
• License: mit
• Created: 2011-05-11T08:26:31.000Z (over 13 years ago)
• Default Branch: master
• Last Pushed: 2024-05-01T08:25:49.000Z (8 months ago)
• Last Synced: 2024-10-11T16:37:59.118Z (2 months ago)
• Language: JavaScript
• Homepage:
• Size: 9.77 KB
• Stars: 3
• Watchers: 1
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: Readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        

# Mai

  Mai is an library to send emails, and attachments from node.js to any smtp server

  Mai also support load and management email template.

  Mai is built on [node](http://nodejs.org) and [emailjs](https://github.com/eleith/emailjs).

## Dependencies

Mai is compatible with node 0.4.x.

Mai is depended [emailjs](https://github.com/eleith/emailjs)

## Installation

    $ npm install mai

## Features

  * E-Mail template management

Via [emailjs](https://github.com/eleith/emailjs):

  * works with SSL and TLS smtp servers (ex: gmail)

  * supports smtp authentication (PLAIN, LOGIN, CRAMMD5)

  * emails are queued and the queue is sent asynchronously

  * supports sending html emails and emails with multiple attachments (MIME)

## Emaple

Prepare a email template text file named 'hello.txt' like below, 

and put it in the directory named 'templates'.

    Hello, <%= value %>!

Followings is the code using above template file.

    var Mai = require('mai'),

        conf, mai;

    conf = {

        hostname: 'localhost',

        username: "",

        password: "",

        templatePath: __dirname + '/templates',

        encoding: 'utf-8'

    };

    mai = new Mai(conf);

    

    mai.send({

        from: '[email protected]',

        to: '[email protected], [email protected]',

        subject: 'Hello Subject',

        templateName: 'hello', // templateName is a filename without extension

        params: {

            value: 'world'

        },

        callback: function(err, message) {

            if (err) {

                console.log('ERROR!');

            } else {

                console.log('SUCCESS');

            }

        }

    });

For all, the variables in the template is replaced given value and you can see the mail body text is

	Hello, world!

## License 

(The MIT License)

Copyright (c) 2011 Kazuyuki Honda 

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.