periodicjs.core.mailer
Periodic's Code mailer module exports a single function that asynchronously returns a node mailer transport to send transactional emails with.
Installation
$ npm install periodicjs.core.mailer
This is a part of Periodic's core.
Usage
Sending Emails
JavaScript
var CoreMailer = sampleemail = to: "user@example.com" cc: "service@example.com" subject: "sample email test" generateTextFromHTML: true html: "<h1>Welcome User</h1><p>email rocks</p>" emailtransport; //instance methods const newCoreMailer = config: transportConfig: type: 'stub' transportoptions: debug: true args: '-t' '-i' ; newCoreMailer ; //static methods CoreMailer ; //example transportsconst sendmailTransportExample = "type":"sendmail" "transportoptions": "debug":true "args":"-t""-i" ;const SMTPTransportExample = "type":"SMTP" "transportoptions": "service": "SendGrid" "auth": "user": "username" "pass": "password" ;const SESTransportExample = "type":"ses" "transportoptions": "accessKeyId": "ACCESSKEYID" "secretAccessKey": "SECRETACCESSKEY" ;//all types:const transports = ses sendmail: sendmailTransport 'smtp-pool': smtpPool sendgrid: sgTransport mailgun: mgTransport stub: stubTransport direct: directTransport
API
//options.emailtemplatefilepathCoreMailer; //Promise.resolve(templateString);//options.transportObject.transportType, options.transportObject.transportOptionsCoreMailer; //Promise.resolve(nodemailertransport); //options.to, options.from, options.html, options.subject, etcCoreMailer; //Promise.resolve(emailstatus);
Development
Make sure you have grunt installed
$ npm install -g grunt-cli
For tests
$ grunt test && grunt coveralls
For generating documentation
$ grunt doc
$ jsdoc2md lib/**/*.js > doc/api.md
Notes
- Check out https://github.com/typesettin/periodicjs for the full Periodic Documentation