mails 0.0.8 → 1.0.0

package/LICENSE

@@ -1,19 +0,0 @@
-Copyright (c) 2013 turing
-
-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.

package/README.en.md

@@ -1,106 +0,0 @@
-## ![logo](http://ww2.sinaimg.cn/large/61ff0de3gw1eajmy0wdikj2014014wea.jpg) mails ![npm](https://badge.fury.io/js/mails.png)
-
-send beautiful emails made easy, with responsive templates built in.
-
-mails supports [ink](http://zurb.com/ink) responsive email template now!
-
-### Installation
-````
-$ npm install mails
-````
-
-### Example
-````javascript
-var mails = require('mails');
-
-// use built in templates
-mail.render('basic', {
-    name: 'mySite',
-    banner: 'http://mysite.com/banner.jpg'
-}, function(err,html){
-    if (!err) {
-        console.log(html);
-    } else {
-        console.log(err);
-    }
-});
-````
-### Built-in themes
-mails supports several kinds of themes, they are:
-
-- ink themes:
-    - basic
-    - hero
-    - newsletter
-    - sidebar
-    - sidebar-hero
-- mails theme:
-    - one
-
-#### built-in theme useage:
-````javascript
-var mails = require('mails');
-
-mails.render('basic', {
-    name: 'mySite',
-    banner: 'http://mysite.com/banner.jpg'
-}, function(err, html){
-    // do sth.
-});
-````
-#### built-in theme variables:
-take a look:
-(screenshots coming soon...)
-
-### Templates as NPM modules
-you can also push templates as NPM modules, like this:
-````javascript
-var mails = require('mails');
-
-// using templates named `single` under module `mails-mailmao`
-mails.render('mails-mailmao/single', {
-    name: 'mySite',
-    banner: 'http://mysite.com/banner.jpg'
-}, function(err, html){
-    // do sth.
-});
-````
-please feel free to publish your templates to NPM.
-
-### API
-check this file: `index.js`
-
-### Contributing
-- Fork this repo
-- Clone your repo
-- Install dependencies
-- Checkout a feature branch
-- Feel free to add your features
-- Make sure your features are fully tested
-- Open a pull request, and enjoy <3
-
-### MIT license
-Copyright (c) 2013 turing
-
-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.
-
-
----
-![docor](https://cdn1.iconfinder.com/data/icons/windows8_icons_iconpharm/26/doctor.png)
-generated using [docor](https://github.com/turingou/docor.git) @ 0.1.0. brought to you by [turingou](https://github.com/turingou)

package/bin/cli

@@ -1,3 +0,0 @@
-#!/usr/bin/env node
-
-require('../libs/cli')();

package/index.js

@@ -1,6 +0,0 @@
-var render = require('./libs/render'),
-    mailer = require('./libs/mail');
-
-exports.send = mailer.send;
-exports.mail = mailer.mail;
-exports.render = render;

package/libs/cli.js

@@ -1,58 +0,0 @@
-var fs = require('fs'),
-    path = require('path'),
-    exeq = require('exeq'),
-    consoler = require('consoler'),
-    optimist = require('optimist'),
-    argv = optimist.argv,
-    serve = require('./serve');
-
-var commands = {
-    init: function(self, pkg, dir) {
-        var init = exeq([
-            'git clone https://github.com/turingou/mails-scaffold.git .',
-            'rm -rf .git',
-            'npm install'
-        ]);
-        init.on('done', function(count) {
-            return consoler.success('another mail theme created, enjoy!');
-        });
-        init.run();
-    },
-    watch: function(self, pkg, dir) {
-        if (!pkg) return consoler.error('configs required');
-        pkg = pkg.toString();
-        fs.readFile(path.resolve(dir, pkg), function(err, file) {
-            if (err) return consoler.log('404', 'configs not found');
-            try {
-                var data = JSON.parse(file);
-                if (!data['view engine']) return consoler.error('view engine required');
-                try {
-                    var engine = require(data['view engine']),
-                        port = argv.p && !isNaN(parseInt(argv.p, 10)) ? parseInt(argv.p, 10) : 3001;
-                    self.server = serve(dir, {
-                        port: port,
-                        engine: engine,
-                        data: data,
-                        pkg: path.resolve(dir, pkg)
-                    });
-                    return consoler.success('Mails is watching: http://localhost:' + port);
-                } catch (err) {
-                    consoler.error('view engine required');
-                    consoler.error(err);
-                    return false;
-                }
-            } catch (err) {
-                return consoler.error('configs format must be json');
-            }
-        });
-    }
-}
-
-// mails(1)
-exports = module.exports = function() {
-    var arguments = argv._,
-        command = arguments[0];
-    if (!command) return false;
-    if (!commands[command]) return false;
-    return commands[command](this, arguments[1], process.cwd());
-};

package/libs/mail.js

@@ -1,25 +0,0 @@
-var nodemailer = require("nodemailer"),
-    render = require('./render').render;
-
-// 发送邮件
-exports.mail = function(params, callback) {
-    var smtpTransport = nodemailer.createTransport("SMTP", params);
-    return smtpTransport.sendMail({
-        from: params.from,
-        to: params.to,
-        subject: params.subject,
-        html: params.html
-    }, function(error, response) {
-        callback(error, response);
-        return smtpTransport.close();
-    });
-};
-
-// 根据某个主题渲染并发送邮件
-exports.send = function(tpl, params, callback) {
-    return render(tpl, params, function(err, html){
-        if (err) return callback(err);
-        params.html = html;
-        return exports.mail(params, callback);
-    });
-};

package/libs/render.js

@@ -1,13 +0,0 @@
-var render = require('pkghub-render'),
-    juice = require('juice').juiceContent;
-
-// 根据给定的主题名称或者文件名称渲染邮件
-// e.g: exports.render('mails-flat/message', {...}, callback);
-module.exports = function(template, data, callback) {
-    var href = {};
-    render(template, data, function(err, html, dest){
-        if (err) return callback(err);
-        href.url = 'file://' + dest;
-        juice(html, href, callback);
-    });
-}

package/libs/serve.js

@@ -1,59 +0,0 @@
-var fs = require('fs'),
-    Tao = require('tao'),
-    path = require('path'),
-    render = require('./render');
-
-var socketclient = function(port, html) {
-    return html + "<script src=\"http://localhost:" + (port + 1) + "/socket.io/socket.io.js\"></script><script>var socket = io.connect('http://localhost:" + (port + 1) + "');socket.on('updated', function (result) { window.location.reload(); });</script>";
-};
-
-// 开发 mails 主题的辅助工具
-// 监听本地文件变动，并实时刷新页面
-exports = module.exports = function(dir, params, callback) {
-
-    // 初始化服务
-    var server = new Tao({
-        dir: dir,
-        port: params.port,
-        socket: true
-    });
-
-    // 直接访问时渲染页面
-    server.use(function(req, res, next) {
-        if (req.url === '/') return res.end('ok');
-        return next();
-    });
-
-    server.use(function(req, res, next) {
-        var file = req._parsedUrl.pathname,
-            afterfix = file.substr(file.lastIndexOf('.') + 1);
-        fs.exists(path.join(dir, file), function(exist) {
-            if (!exist) return res.end('404');
-            if (afterfix === 'json') return res.end(fs.readFileSync(path.join(dir, file)));
-            render._render({
-                template: path.join(dir, file),
-                data: JSON.parse(fs.readFileSync(params.pkg)),
-                engine: {
-                    name: params.data['view engine'],
-                    _engine: params.engine
-                }
-            }, function(err, html) {
-                if (err) return res.end('render error: ' + err.toString());
-                res.end(socketclient(server.configs.port, html));
-            });
-        })
-    });
-
-    // 检测到模板变动时刷新页面
-    server.watch(function(event, file, stat) {
-        if (!(params.engine && event !== 'removed')) return false;
-        server.emit('updated', {
-            stat: 'ok',
-            file: file
-        });
-    });
-
-    server.run();
-
-    return server;
-};