├── .gitignore ├── LICENSE ├── README.md ├── config.default.json ├── config.json ├── gulpfile.js ├── package.json └── src ├── css └── main.css ├── html └── test-template.html └── scss ├── _mixins.scss └── main.scss /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules/ 2 | output/ 3 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Gulp-Email-Creator 2 | 3 | Gulp Email Creator is a gulp workflow inspired by [Lee Munroe's](https://github.com/leemunroe) [grunt-email-design](https://github.com/leemunroe/grunt-email-design) workflow. 4 | 5 | It aims to help speed up email template production by allowing you to use SCSS and inlining the generated CSS for you. 6 | 7 | # Installation 8 | 9 | To use Gulp-Email-Creator you need to have both [Node.js](http://nodejs.org/) and [Gulp.js](http://gulpjs.com/) installed . 10 | 11 | You can install it by cloning this repository to a local folder and running the following from inside the directory. 12 | 13 | ```javascript 14 | npm install 15 | ``` 16 | This will install all dependencies. 17 | 18 | If the install fails try running the install as root. For some reason browsersync seemed to fail for me unless installed as root. 19 | 20 | ```javascript 21 | sudo npm install 22 | ``` 23 | 24 | This now uses [MailChimp's](http://mailchimp.com/) CSS inliner as I've found it to work better across browsers. You will now need a Mailchimp API key which you can add to the `config.json` file. 25 | You can get a Mailchimp API by creating one in your Mailchimp account. [Instructions Here](http://kb.mailchimp.com/accounts/management/about-api-keys) 26 | 27 | # Using the package 28 | 29 | You can use the Gulp-Email-Creator workflow by creating your HTML in the `./src/html/` directory and your SCSS in the `./src/scss/` directory. 30 | 31 | ## Compile Templates 32 | Running `gulp` from the terminal will build the new HTML email template into the `./output/` directory and the proceed to watch `./src/html/` and `./src/scss/` for any updates. 33 | 34 | The gulpfile has browsersync built in and will reload on any HTML or CSS edit, allowing you to focus on your code. 35 | 36 | ## Sending the Template to yourself 37 | Running `gulp send` will allow you to send the compiled template to yourself through [Mailgun](https://mailgun.com) (you'll need to sign up for a free account). The settings for this can be found in the `config.json` file. 38 | 39 | To run this, you can use the following command 40 | 41 | ```javascript 42 | gulp send --template="compiled-template-name.html" 43 | ``` 44 | 45 | ## Testing 46 | 47 | Thanks to the awesome guys over [Litmus](http://litmus.com/), we can now throw your emails straight into their tests. You'll need an active [Litmus](http://litmus.com/) account (well worth the money!) and to get your [static email](https://litmus.com/static-email). Plug this into the `config.json` file and then run the following command. 48 | 49 | ```javascript 50 | gulp litmus --template="compiled-template-name.html" 51 | ``` 52 | In a few seconds/minutes, you'll see the test appear in Limus for you! 53 | 54 | # Contributing # 55 | 56 | Any contributions will be happily recieved. Just open an issue or make a pull request. -------------------------------------------------------------------------------- /config.default.json: -------------------------------------------------------------------------------- 1 | { 2 | "APIKEY": "Add your Mailchimp API Key", 3 | 4 | "testing": { 5 | "from": "Email Address to send from", 6 | "to": "Who do you want to send to? Comma separated", 7 | "subject": "Subject for test email" 8 | }, 9 | 10 | "auth": { 11 | "mailgun": { 12 | "user": "SMTP User", 13 | "pass": "SMTP Password" 14 | } 15 | }, 16 | 17 | "litmus": "Your Litmus static email address" 18 | } -------------------------------------------------------------------------------- /config.json: -------------------------------------------------------------------------------- 1 | { 2 | "APIKEY": "Add your Mailchimp API Key", 3 | 4 | "testing": { 5 | "from": "Email Address to send from", 6 | "to": "Who do you want to send to? Comma separated", 7 | "subject": "Subject for test email" 8 | }, 9 | 10 | "auth": { 11 | "mailgun": { 12 | "user": "SMTP User", 13 | "pass": "SMTP Password" 14 | } 15 | }, 16 | 17 | "litmus": "Your Litmus static email address" 18 | } -------------------------------------------------------------------------------- /gulpfile.js: -------------------------------------------------------------------------------- 1 | // Include gulp 2 | var gulp = require('gulp'); 3 | 4 | // Include Our Plugins 5 | var sass = require('gulp-sass'); 6 | var autoprefixer = require('gulp-autoprefixer'); 7 | var inline = require('gulp-mc-inliner'); 8 | var browserSync = require('browser-sync'); 9 | var reload = browserSync.reload; 10 | var inlinesource = require('gulp-inline-source'); 11 | var util = require('gulp-util'); 12 | var nodemailer = require('nodemailer'); 13 | var fs = require('fs'); 14 | var html_strip = require('htmlstrip-native'); 15 | 16 | // Include the config 17 | var config = require('./config.json'); 18 | 19 | 20 | // Compile Our Sass 21 | gulp.task('sass', function() { 22 | return gulp.src('src/scss/*.scss') 23 | .pipe(sass({errLogToConsole: true})) 24 | .pipe(autoprefixer('last 2 version', 'safari 5', 'ie 8', 'ie 9', 'opera 12.1', 'ios 6', 'android 4')) 25 | .pipe(gulp.dest('src/css')) 26 | .pipe(reload({stream:true})); 27 | }); 28 | 29 | // BrowserSync 30 | gulp.task('browser-sync', function() { 31 | browserSync({ 32 | server: { 33 | baseDir: "./output", 34 | index: "test-template.html" 35 | }, 36 | open: "external", 37 | logPrefix: "Gulp Email Creator" 38 | }); 39 | }); 40 | 41 | // Build our templates 42 | gulp.task('build', function() { 43 | return gulp.src('src/html/*.html') 44 | .pipe(inlinesource()) 45 | .pipe(inline(config.APIKEY, false)) 46 | .pipe(gulp.dest('./output')) 47 | .pipe(reload({stream:true})); 48 | }); 49 | 50 | // Watch Files For Changes 51 | gulp.task('watch', function() { 52 | gulp.watch('src/scss/*.scss', ['sass']); 53 | gulp.watch('src/html/*.html', ['build']); 54 | gulp.watch('src/css/*.css', ['build']); 55 | }); 56 | 57 | // Default Task 58 | gulp.task('default', ['sass', 'browser-sync', 'build', 'watch']); 59 | 60 | // Add ability to send test emails 61 | gulp.task('send', function () { 62 | return sendEmail(util.env.template, config.testing.to); 63 | }); 64 | 65 | gulp.task('litmus', function () { 66 | return sendEmail(util.env.template, config.litmus); 67 | }); 68 | 69 | function sendEmail(template, recipient) { 70 | try { 71 | 72 | var options = { 73 | include_script : false, 74 | include_style : false, 75 | compact_whitespace : true, 76 | include_attributes : { 'alt': true } 77 | }; 78 | 79 | var templatePath = "./output/" + template; 80 | 81 | var transporter = nodemailer.createTransport({ 82 | service: 'Mailgun', 83 | auth: { 84 | user: config.auth.mailgun.user, 85 | pass: config.auth.mailgun.pass 86 | } 87 | }); 88 | 89 | var templateContent = fs.readFileSync(templatePath, encoding = "utf8"); 90 | 91 | var mailOptions = { 92 | from: config.testing.from, // sender address 93 | to: recipient, // list of receivers 94 | subject: config.testing.subject + ' - ' + template, // Subject line 95 | html: templateContent, // html body 96 | text: html_strip.html_strip(templateContent, options) 97 | }; 98 | 99 | transporter.sendMail(mailOptions, function(error, info){ 100 | if(error){ 101 | return util.log(error); 102 | }else{ 103 | return util.log('Message sent: ' + info.response); 104 | } 105 | }); 106 | 107 | } catch (e) { 108 | if(e.code == 'ENOENT') { 109 | util.log('There was an error. Check your template name to make sure it exists in ./output'); 110 | } else if(e instanceof TypeError) { 111 | util.log('There was an error. Please check your config.json to make sure everything is spelled correctly'); 112 | } else { 113 | util.log(e); 114 | } 115 | } 116 | } -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "Gulp-Email-Creator", 3 | "version": "1.0.1", 4 | "description": "A gulp workflow for easing the creation of HTML emails", 5 | "main": "gulpfile.js", 6 | "scripts": { 7 | "test": "gulp" 8 | }, 9 | "repository": { 10 | "type": "git", 11 | "url": "https://github.com/darylldoyle/Gulp-Email-Creator.git" 12 | }, 13 | "keywords": [ 14 | "GulpJS", 15 | "Email" 16 | ], 17 | "author": "Daryll Doyle", 18 | "license": "apache2", 19 | "bugs": { 20 | "url": "https://github.com/darylldoyle/Gulp-Email-Creator/issues" 21 | }, 22 | "homepage": "https://github.com/darylldoyle/Gulp-Email-Creator", 23 | "devDependencies": { 24 | "browser-sync": "^2.18.12", 25 | "gulp": "^3.8.10", 26 | "gulp-autoprefixer": "^4.0.0", 27 | "gulp-inline-source": "^3.1.0", 28 | "gulp-mc-inliner": "0.0.4", 29 | "gulp-sass": "^3.1.0", 30 | "gulp-util": "^3.0.8", 31 | "htmlstrip-native": "^0.1.3", 32 | "mailchimp": "^1.1.0", 33 | "nodemailer": "^4.0.1", 34 | "through2": "^2.0.3", 35 | "tiny-lr": "^1.0.4" 36 | } 37 | } 38 | -------------------------------------------------------------------------------- /src/css/main.css: -------------------------------------------------------------------------------- 1 | html, body { 2 | background: #CCC; } 3 | 4 | table { 5 | border-spacing: 0; } 6 | 7 | .wrapper { 8 | background: #FFF; 9 | max-width: 550px; 10 | margin: 0 auto; 11 | font-family: Arial, "Helvetica Neue", Helvetica, sans-serif; } 12 | .wrapper a { 13 | color: #E82C0C; 14 | text-decoration: none; } 15 | .wrapper a:hover { 16 | text-decoration: underline; } 17 | .wrapper img { 18 | max-width: 100%; } 19 | .wrapper .headerText { 20 | color: #000; } 21 | .wrapper .headerText p { 22 | margin: 2px; 23 | font-size: 12px; 24 | font-size: 0.75rem; } 25 | .wrapper .mainBody > td > table { 26 | padding: 0 20px; } 27 | .wrapper .mainBody > td > table td { 28 | vertical-align: top; 29 | width: 30%; } 30 | .wrapper .mainBody > td > table td:first-child { 31 | padding-right: 20px; 32 | width: 70%; } 33 | -------------------------------------------------------------------------------- /src/html/test-template.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | Gulp-Email-Creator 6 | 7 | 8 | 9 | 10 | 11 | 12 | 15 | 16 | 17 | 20 | 21 | 22 | 51 | 52 |
13 |

This is a bit of header text that should show in the email client

14 |
18 | 19 |
23 | 24 | 25 | 28 | 29 | 30 | 40 | 43 | 44 | 45 | 48 | 49 |
26 |

This is a sample email template

27 |
31 |

It was built using Gulp-Email-Creator Built by Daryll Doyle

32 | 33 |

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod 34 | tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, 35 | quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo 36 | consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse 37 | cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non 38 | proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

39 | 		41 | 42 |
46 |

Some footer text goes here

47 |
50 |
53 | 54 | -------------------------------------------------------------------------------- /src/scss/_mixins.scss: -------------------------------------------------------------------------------- 1 | @function calculateRem($size) { 2 | $remSize: $size / 16px; 3 | @return $remSize * 1rem; 4 | } 5 | 6 | @mixin font-size($size) { 7 | font-size: $size; 8 | font-size: calculateRem($size); 9 | } -------------------------------------------------------------------------------- /src/scss/main.scss: -------------------------------------------------------------------------------- 1 | @import "mixins"; 2 | 3 | html, body { 4 | background: #CCC; 5 | } 6 | 7 | table { 8 | border-spacing: 0; 9 | } 10 | 11 | .wrapper { 12 | background: #FFF; 13 | max-width: 550px; 14 | margin: 0 auto; 15 | font-family: Arial, "Helvetica Neue", Helvetica, sans-serif; 16 | 17 | a { 18 | color: #E82C0C; 19 | text-decoration: none; 20 | 21 | &:hover { 22 | text-decoration: underline; 23 | } 24 | } 25 | 26 | img { 27 | max-width: 100%; 28 | } 29 | 30 | .headerText { 31 | color: #000; 32 | 33 | p { 34 | margin: 2px; 35 | @include font-size(12px); 36 | } 37 | } 38 | 39 | .mainBody > td > table { 40 | padding: 0 20px; 41 | 42 | td { 43 | vertical-align: top; 44 | width: 30%; 45 | 46 | &:first-child { 47 | padding-right: 20px; 48 | width: 70%; 49 | } 50 | } 51 | } 52 | } --------------------------------------------------------------------------------