ActiveCampaign · derekrushforth · Jan 13, 2018 · Dec 14, 2016 · Dec 14, 2016 · Dec 14, 2016
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 node_modules
 .idea
-secrets.json
+config.json
+secrets.json
diff --git a/Gruntfile.js b/Gruntfile.js
@@ -3,35 +3,76 @@
  * https://github.com/wildbit/grunt-postmark.git
  */
 
-module.exports = function(grunt) {
+module.exports = function (grunt) {
+  var secret = grunt.file.readJSON('secrets.json');
+  var config = grunt.file.readJSON('config.json');
 
   grunt.initConfig({
-    secrets: grunt.file.readJSON('secrets.json'),
+    secret: secret,
+    config: config,
 
     /* Postmark
-    ------------------------------------------------- */
+     ------------------------------------------------- */
     postmark: {
       options: {
-        serverToken: '<%= secrets.serverToken %>'
+        serverToken: "<%= secret.postmark.server_token %>"
       },
       email: {
-        from: '[email protected]',
-        to: '[email protected]',
-        subject: 'Yo',
-        src: ['test/email.html']
+        from: "<%= config.postmark.from %>",
+        to: "<%= config.postmark.to %>",
+        subject: "<%= config.postmark.subject %>",
+        src: ["test/email.html"]
       },
       bulk: {
-        from: '[email protected]',
-        to: '[email protected]',
-        subject: 'Hey',
-        src: ['test/*.html']
+        from: "<%= config.postmark.from %>",
+        to: "<%= config.postmark.to %>",
+        subject: "<%= config.postmark.subject %>",
+        src: ["test/*.html"]
       }
-    }
+    },
+
+    "postmark-templates-upload": {
+      options: {
+        ephemeralUploadResultsProperty: "<%= config.templates && config.templates.ephemeralUploadResultsProperty %>",
+        serverToken: "<%= secret.postmark.server_token %>"
+      },
+      test_email: {
+        name: "testing-postmark-templates-js1-" + new Date().valueOf(),
+        subject: "Testing grunt-postmark-templates",
+        htmlSrc: "test/email.html",
+        textSrc: "test/email.txt"
+      },
+      test_email_again: {
+        name: "testing-postmark-templates-js2-" + new Date().valueOf(),
+        subject: "Testing grunt-postmark-templates (again)",
+        htmlSrc: "test/email.html",
+        textSrc: "test/email.txt"
+      },
+      test_email_inline_body: {
+        name: "testing-postmark-templates-js3-" + new Date().valueOf(),
+        subject: "Testing grunt-postmark-templates (inline body)",
+        htmlBody: "<html><body><h1>Another email test</h1></body></html>",
+        textBody: "Hello from grunt-postmark-templates\n"
+      }
+    },
 
+    "postmark-templates-output": {
+      options: {
+          cleanOutput: "<%= config.templates && config.templates.cleanOutput %>",
+          outputFile: "<%= config.templates && config.templates.outputFile || config.templates && config.templates.file %>",
+          ephemeralUploadResultsProperty: "<%= config.templates && config.templates.ephemeralUploadResultsProperty %>"
+      }
+    },
+
+    "postmark-templates-parse": {
+      options: {
+        inputFile: "<%= config.templates && config.templates.inputFile || config.templates && config.templates.file %>"
+      }
+    }
   });
 
-  grunt.loadTasks('tasks');
+  grunt.loadTasks("tasks");
 
-  grunt.registerTask('default', ['postmark']);
+  grunt.registerTask("default", ["postmark", "postmark-templates"]);
 
 };
diff --git a/README.md b/README.md
@@ -20,38 +20,39 @@ After the plugin is installed, it can be enabled in your Gruntfile:
 grunt.loadNpmTasks('grunt-postmark');
 ```
 
+You'll need to add a [`config.json`](https://github.com/wildbit/mailmason/wiki/Getting-Started#create-configjson-required) and a [`secrets.json`](https://github.com/wildbit/mailmason/wiki/Getting-Started#create-secretsjson-optional) per the `mailmason` configuration.
+
 ## Postmark task
 _Run this task with the `grunt postmark` command._
 
-## Options
-
+### Options
 
-### serverToken
+#### serverToken
 Your server token can be found on your server’s credentials page on [Postmark’s](http://postmarkapp.com) app.
 
 Type: `String`
 
 
-### from
+#### from
 This is the from address you are using to send the email. This must be a confirmed address that's set up on [Postmark’s](http://postmarkapp.com) sender signatures.
 
 Type: `String`
 
 
-### to
+#### to
 The address you’re sending to.
 
 Type: `String`
 
 
-###  subject
+####  subject
 
 Type: `String`
 
 
-## Examples
+### Examples
 
-### Options specified through target
+#### Options specified through target
 
 ```javascript
 grunt.initConfig({
@@ -67,7 +68,7 @@ grunt.initConfig({
 });
 ```
 
-### Specify options through targets or globally
+#### Specify options through targets or globally
 Options specified through a target will always take precedence over global options.
 
 ```javascript
@@ -89,4 +90,181 @@ grunt.initConfig({
      }
    }
 });
+```
+
+## Postmark templates task
+_Run this task with the `grunt postmark-templates` command._
+
+The `postmark-templates` task is an alias of the `postmark-templates-from-targets` task which is itself a two  stepped task – `postmark-templates-upload` followed by `postmark-templates-output`.
+
+`postmark-templates` (`postmark-templates-from-targets`) is intended for programmatic usage from other grunt tasks.
+
+### `postmark-templates-upload` Targets
+
+#### name
+The name of your template.
+
+Type: `String`
+
+
+#### subject
+The subject line of your template.
+
+Type: `String`
+
+#### htmlSrc
+A path to the generated HTML for your template. *Not used if `htmlBody` is specified.*
+
+Type: `String`
+
+
+#### textSrc
+A path to the generated plain text for your template. *Not used if `textBody` is specified.*
+
+Type: `String`
+
+#### htmlBody
+The generated HTML content of your template. *Not required if `htmlSrc` is specified.*
+
+Type: `String`
+
+
+#### textBody
+The generated plain text content of your template. *Not required if `textSrc` is specified.*
+
+Type: `String`
+
+
+### `postmark-templates-upload` Options
+
+#### serverToken
+Your server token can be found on your server’s credentials page on [Postmark’s](http://postmarkapp.com) app.
+
+Type: `String`
+
+
+#### ephemeralUploadResultsProperty
+This is the name of a temporary grunt task configuration property used to communicate the upload results between `postmark-templates-upload` and `postmark-templates-output` without having to write a temporary file. **This should be the same value as `ephemeralUploadResultsProperty` for `postmark-templates-output`.**
+
+Type: `String`
+
+
+### `postmark-templates-output` Options
+
+#### outputFile
+The name of a file to output the results of the upload to Postmark.
+
+Type: `String`
+
+
+#### cleanOutput
+If `true`, do not export `htmlBody`, `htmlSrc`, `textBody` or `textSrc` in the specified `outputFile`.
+
+Type: `Boolean`
+
+
+#### ephemeralUploadResultsProperty
+This is the name of a temporary grunt task configuration property used to communicate the upload results between `postmark-templates-upload` and `postmark-templates-output` without having to write a temporary file. **This should be the same value as `ephemeralUploadResultsProperty` for `postmark-templates-upload`.**
+
+Type: `String`
+
+
+### Example
+
+```javascript
+grunt.initConfig({
+  'postmark-templates-upload': {
+    options: {
+      serverToken: 'POSTMARK_API_TEST',
+      ephemeralUploadResultsProperty: 'temp'
+    },
+    test_email: {
+      name: 'testing-postmark-templates-js1',
+      subject: 'Testing grunt-postmark-templates',
+      htmlSrc: 'test/email.html',
+      textSrc: 'test/email.txt'
+    },
+    test_email_inline_body: {
+      name: 'testing-postmark-templates-js3',
+      subject: 'Testing grunt-postmark-templates (inline body)',
+      htmlBody: '<html><body><h1>Another email test</h1></body></html>',
+      textBody: 'Hello from grunt-postmark-templates\n'
+    }
+  },
+  'postmark-templates-output': {
+    options: {
+        cleanOutput: true,
+        outputFile: 'templates.json',
+        ephemeralUploadResultsProperty: 'temp'
+    }
+  }
+});
+```
+
+## Postmark templates (from file) task
+_Run this task with the `grunt postmark-templates-from-file` command._
+
+The `postmark-templates-from-file` task invokes the `postmark-templates` task with targets read from a JSON file (via `postmark-templates-parse`).
+
+This task is intended for standalone, manual usage.
+
+
+### `postmark-templates-parse` Options
+
+#### inputFile
+The name of a file that specifies templates for uploading to Postmark. These templates take the same shape as defined by `postmark-templates-upload`. This should usually be the same value as `outputFile` for `postmark-templates-output`.
+
+Type: `String`
+
+
+### Example
+
+In your `Gruntfile`:
+
+```javascript
+grunt.initConfig({
+  'postmark-templates-parse': {
+    options: {
+      inputFile: 'templates.json'
+    }
+  },
+  'postmark-templates-upload': {
+    options: {
+      serverToken: 'POSTMARK_API_TEST',
+      ephemeralUploadResultsProperty: 'temp'
+    }
+  },
+  'postmark-templates-output': {
+    options: {
+      cleanOutput: true,
+      outputFile: 'templates.json',
+      ephemeralUploadResultsProperty: 'temp'
+    }
+  }
+});
+```
+
+In the file specified by `inputFile`, in this case, `templates.json`:
+
+```json
+{
+  "test_email": {
+    "name": "testing-postmark-templates-js1",
+    "subject": "Testing grunt-postmark-templates",
+    "htmlSrc": "test/email.html",
+    "textSrc": "test/email.txt"
+  },
+  "test_email_again": {
+    "name": "testing-postmark-templates-js2",
+    "subject": "Testing grunt-postmark-templates (again)",
+    "htmlSrc": "test/email.html",
+    "textSrc": "test/email.txt"
+  },
+  "test_email_inline_body": {
+    "name": "testing-postmark-templates-js3",
+    "subject": "Testing grunt-postmark-templates (inline body)",
+    "htmlBody": "<html><body><h1>Another email test</h1></body></html>",
+    "textBody": "Hello from grunt-postmark-templates\n"
+  }
+}
 ```
diff --git a/example_config.json b/example_config.json
@@ -0,0 +1,16 @@
+// 1. Copy this file to "config.json" for your own version that won't be
+//    tracked in source control.
+//
+// 2. Delete these comments from the configuration so Grunt doesn't get confused
+{
+  "postmark": {
+    "from": "[email protected]",
+    "to": "[email protected]",
+    "subject": "Test Email"
+  },
+  "templates": {
+    "ephemeralUploadResultsProperty": "postmark-templates-upload-results",
+    "cleanOutput": true,
+    "file": "templates.json"
+  }
+}
diff --git a/example_secrets.json b/example_secrets.json
@@ -0,0 +1,9 @@
+// 1. Copy this file to "secrets.json" for your own version that won't be
+//    tracked in source control.
+//
+// 2. Delete these comments from the configuration so Grunt doesn't get confused
+{
+  "postmark": {
+    "server_token": "YOUR_POSTMARK_SERVER_TOKEN_HERE"
+  }
+}
diff --git a/example_templates.json b/example_templates.json
@@ -0,0 +1,20 @@
+{
+  "test_email": {
+    "name": "testing-postmark-templates-js1",
+    "subject": "Testing grunt-postmark-templates",
+    "htmlSrc": "test/email.html",
+    "textSrc": "test/email.txt"
+  },
+  "test_email_again": {
+    "name": "testing-postmark-templates-js2",
+    "subject": "Testing grunt-postmark-templates (again)",
+    "htmlSrc": "test/email.html",
+    "textSrc": "test/email.txt"
+  },
+  "test_email_inline_body": {
+    "name": "testing-postmark-templates-js3",
+    "subject": "Testing grunt-postmark-templates (inline body)",
+    "htmlBody": "<html><body><h1>Another email test</h1></body></html>",
+    "textBody": "Hello from grunt-postmark-templates\n"
+  }
+}