byteskode-mailer
byteskode sendgrid mailer with mongoose persistence and kue support
Note: mailer is configured using config using key mailer
Requirements
Installation
$ npm install --save mongoose byteskode-mailer
Usage
var mongoose = ;var Mail = ; //mail + template datavar mail = recipientName: fakername token: fakerrandom to: fakerinternet baseUrl: fakerinternet subject: 'Account confirmation' type:'confirmation'; //send immediateMail ; //queue for later sending//you will have to implement worker for later resendMail;
API
send(email:Object,[options:Object], callback(error, mail))
Send will compile mail template found at a path obtain using the type
parameter and templateDir
configuration options and set html
value to data. View for sample template directory layout.
Before send all mails are persisted to mongodb using mongoose. mail object should constitute valid nodemailer email fields plus other data to be passed to mail template.
If running in production
and still want to simulate fake sent
pass an additional object with fake
key set to true
.
Note: Current attachment are not supported
Example
//mail + template datavar mail = recipientName: fakername token: fakerrandom to: fakerinternet baseUrl: fakerinternet subject: 'Account confirmation'; //real sendMail ; //simulate sendMail ;
resend([criteria:Object], callback(error, mails))
Resend will try to resend failed mails that are in the database. criteria
is a valid mongoose criteria used to specify which failed mails to resend.
Example
Mail; //or pass criteriaMail;
queue(mail:Object,[options:Object], [callback(error, mail)])
Unlike send, queue will save compiled email for later processing. After mail persisted into database mail:queued
event will be fired with an instance of saved mail. If any error occur an event mail:queue:error
will be fired.
Example
Mail; Mail; //mail details + template datavar mail = recipientName: fakername token: fakerrandom to: fakerinternet baseUrl: fakerinternet subject: 'Account confirmation' type:'confirmation' ; Mail;
requeue([criteria:Object], [callback(error, mail)])
Unlike resend, requeue will fire mail:queued
event on every unsent mail.
Example
Mail; //or pass criteriaMail;
Configuration Options
Base on your environment setup, ensure you have the following configurations in your config
files.
mailer: from: '<yourname> <no-reply@<yourdomain>.com>' sender: '<sendername>' transport: auth: api_key: '<sendgrid_api_key>' model: name:'<name_of_mongoose_model>' fields:<additional_schema_fields> templatesDir:<path_to_ejs_template> kue: // ensure to install kue and add this to support kue concurrency: 10 timeout: 5000 connection: {}
Kue Integration
To add support to kue
ensure you have installed kue and supply the required configuration. The presence of kue
configuration in mailer
config options will signal the use of kue
publisher and worker. See Example
$ npm install --save kue
Kue Mail Worker
In your worker process start the queued mail worker as below
var mongoose = ;var Mail = ; //Alert!: Probably your should start mail processing in your worker process//and not main processMailworkerstart; //listen for the worker queue events//all kue queue events are applicable hereMailworkerqueue; //anywhere in your main process//queue email for sendMail;
Testing
-
Clone this repository
-
Install all development dependencies
$ npm install
- Then run test
$ npm test
Contribute
It will be nice, if you open an issue first so that we can know what is going on, then, fork this repo and push in your ideas. Do not forget to add a bit of test(s) of what value you adding.
Licence
The MIT License (MIT)
Copyright (c) 2015 byteskode, lykmapipo & Contributors
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.