@estaldo/n8n-nodes-postmarkapp 0.1.0

package/dist/nodes/PostmarkEmail/PostmarkEmail.node.js

@@ -0,0 +1,83 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PostmarkEmail = void 0;
+const n8n_workflow_1 = require("n8n-workflow");
+const descriptions_1 = require("./descriptions");
+const helpers_1 = require("./helpers");
+const operations_1 = require("./operations");
+const POSTMARK_BASE_URL = 'https://api.postmarkapp.com';
+class PostmarkEmail {
+    description = {
+        displayName: 'Postmark Email',
+        name: 'postmarkEmail',
+        icon: 'file:postmarkEmail.svg',
+        group: ['output'],
+        version: 1,
+        description: 'Send transactional email via Postmark',
+        defaults: {
+            name: 'Postmark Email',
+        },
+        inputs: ['main'],
+        outputs: ['main'],
+        credentials: [
+            {
+                name: 'postmarkApi',
+                required: true,
+            },
+        ],
+        properties: descriptions_1.ALL_PROPERTIES,
+    };
+    async execute() {
+        const items = this.getInputData();
+        const out = [];
+        for (let i = 0; i < items.length; i++) {
+            const operation = this.getNodeParameter('operation', i);
+            const path = operations_1.OPERATION_ENDPOINTS[operation];
+            if (!path) {
+                throw new n8n_workflow_1.NodeOperationError(this.getNode(), `Unknown operation: ${operation}`, { itemIndex: i });
+            }
+            const defaultStream = this.getNodeParameter('messageStream', i, '');
+            let body;
+            if (operation === operations_1.Operation.Send || operation === operations_1.Operation.SendWithTemplate) {
+                const kind = operation === operations_1.Operation.SendWithTemplate ? 'templated' : 'plain';
+                const source = (0, helpers_1.collectSingleMessage)(this, i, kind);
+                body = (0, helpers_1.buildEmailBody)(this, i, source, kind);
+                (0, helpers_1.applyDefaultMessageStream)(body, defaultStream);
+            }
+            else {
+                const kind = operation === operations_1.Operation.SendBatchWithTemplates ? 'templated' : 'plain';
+                const messages = (0, helpers_1.collectBatchMessages)(this, i, kind);
+                if (messages.length === 0) {
+                    throw new n8n_workflow_1.NodeOperationError(this.getNode(), 'At least one message is required for a batch send', { itemIndex: i });
+                }
+                const messageBodies = messages.map((msg) => {
+                    const built = (0, helpers_1.buildEmailBody)(this, i, msg, kind);
+                    (0, helpers_1.applyDefaultMessageStream)(built, defaultStream);
+                    return built;
+                });
+                // Postmark's two batch endpoints differ in body shape:
+                // - /email/batch              → bare JSON array `[ {...}, {...} ]`.
+                // - /email/batchWithTemplates → `{ "Messages": [ {...} ] }` (property name in
+                //                                the body, not a path component).
+                body = operation === operations_1.Operation.SendBatchWithTemplates
+                    ? { Messages: messageBodies }
+                    : messageBodies;
+            }
+            let response;
+            try {
+                response = (await this.helpers.httpRequestWithAuthentication.call(this, 'postmarkApi', {
+                    method: 'POST',
+                    url: `${POSTMARK_BASE_URL}${path}`,
+                    body,
+                    json: true,
+                }));
+            }
+            catch (err) {
+                throw (0, helpers_1.wrapPostmarkError)(this, err, i);
+            }
+            out.push({ json: response, pairedItem: { item: i } });
+        }
+        return [out];
+    }
+}
+exports.PostmarkEmail = PostmarkEmail;

package/dist/nodes/PostmarkEmail/descriptions/SendEmailBatch.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sendEmailBatchProperty = void 0;
+const operations_1 = require("../operations");
+const additionalFields_1 = require("./additionalFields");
+const BATCH_PLAIN_MESSAGE_VALUES = [
+    {
+        displayName: 'From',
+        name: 'from',
+        type: 'string',
+        default: '',
+        required: true,
+        placeholder: 'sender@example.com',
+        description: 'Sender email address',
+    },
+    {
+        displayName: 'To',
+        name: 'to',
+        type: 'string',
+        default: '',
+        required: true,
+        placeholder: 'recipient@example.com',
+        description: 'Recipient email address. Comma-separate for multiple recipients (max 50 per request).',
+    },
+    {
+        displayName: 'Subject',
+        name: 'subject',
+        type: 'string',
+        default: '',
+        required: true,
+        description: 'Email subject line',
+    },
+    {
+        displayName: 'HTML Body',
+        name: 'htmlBody',
+        type: 'string',
+        typeOptions: { rows: 6 },
+        default: '',
+        description: 'HTML body of the email. At least one of HTML Body or Text Body is required.',
+    },
+    {
+        displayName: 'Text Body',
+        name: 'textBody',
+        type: 'string',
+        typeOptions: { rows: 4 },
+        default: '',
+        description: 'Plain text body of the email. At least one of HTML Body or Text Body is required.',
+    },
+    // Optional fields spread directly inline — workflow authors fill what they want
+    // without first clicking "Add Field" inside each batch message.
+    ...additionalFields_1.OPTIONAL_EMAIL_FIELDS,
+];
+exports.sendEmailBatchProperty = {
+    displayName: 'Messages',
+    name: 'batchMessages',
+    type: 'fixedCollection',
+    default: {},
+    placeholder: 'Add Message',
+    typeOptions: { multipleValues: true, sortable: true },
+    description: 'Emails to send in this batch. Each message is sent as one email.',
+    displayOptions: {
+        show: {
+            operation: [operations_1.Operation.SendBatch],
+        },
+    },
+    options: [
+        {
+            name: 'message',
+            displayName: 'Message',
+            values: BATCH_PLAIN_MESSAGE_VALUES,
+        },
+    ],
+};

package/dist/nodes/PostmarkEmail/descriptions/SendEmailBatchWithTemplates.js

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sendEmailBatchWithTemplatesProperty = void 0;
+const operations_1 = require("../operations");
+const additionalFields_1 = require("./additionalFields");
+const BATCH_TEMPLATED_MESSAGE_VALUES = [
+    {
+        displayName: 'From',
+        name: 'from',
+        type: 'string',
+        default: '',
+        required: true,
+        placeholder: 'sender@example.com',
+        description: 'Sender email address',
+    },
+    {
+        displayName: 'To',
+        name: 'to',
+        type: 'string',
+        default: '',
+        required: true,
+        placeholder: 'recipient@example.com',
+        description: 'Recipient email address. Comma-separate for multiple recipients (max 50 per request).',
+    },
+    {
+        displayName: 'Template Source',
+        name: 'templateSource',
+        type: 'options',
+        default: 'alias',
+        options: [
+            { name: 'Alias', value: 'alias' },
+            { name: 'ID', value: 'id' },
+        ],
+        description: 'How to identify the template',
+    },
+    {
+        displayName: 'Template ID',
+        name: 'templateId',
+        type: 'string',
+        default: '',
+        required: true,
+        placeholder: 'welcome-email or 12345',
+        description: 'Template alias (string) or numeric ID, depending on Template Source',
+    },
+    {
+        displayName: 'Template Model',
+        name: 'templateModel',
+        type: 'json',
+        default: '{}',
+        description: 'JSON object of values to merge into the template',
+    },
+    // Optional fields spread directly inline — workflow authors fill what they want
+    // without first clicking "Add Field" inside each batch message.
+    ...additionalFields_1.OPTIONAL_EMAIL_FIELDS,
+];
+exports.sendEmailBatchWithTemplatesProperty = {
+    displayName: 'Messages',
+    name: 'batchMessagesWithTemplates',
+    type: 'fixedCollection',
+    default: {},
+    placeholder: 'Add Message',
+    typeOptions: { multipleValues: true, sortable: true },
+    description: 'Templated emails to send in this batch. Each message is rendered from its template and sent as one email.',
+    displayOptions: {
+        show: {
+            operation: [operations_1.Operation.SendBatchWithTemplates],
+        },
+    },
+    options: [
+        {
+            name: 'message',
+            displayName: 'Message',
+            values: BATCH_TEMPLATED_MESSAGE_VALUES,
+        },
+    ],
+};

package/dist/nodes/PostmarkEmail/descriptions/SendEmailSingle.js

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sendEmailSingleProperties = void 0;
+const operations_1 = require("../operations");
+// Top-level fields for the `send` operation.
+// From and To are shared with `sendWithTemplate` (their displayOptions cover both single
+// ops). Subject / HTML Body / Text Body are specific to `send`.
+exports.sendEmailSingleProperties = [
+    {
+        displayName: 'From',
+        name: 'from',
+        type: 'string',
+        default: '',
+        required: true,
+        placeholder: 'sender@example.com',
+        description: 'Sender email address',
+        displayOptions: {
+            show: {
+                operation: [operations_1.Operation.Send, operations_1.Operation.SendWithTemplate],
+            },
+        },
+    },
+    {
+        displayName: 'To',
+        name: 'to',
+        type: 'string',
+        default: '',
+        required: true,
+        placeholder: 'recipient@example.com',
+        description: 'Recipient email address. Comma-separate for multiple recipients (max 50 per request).',
+        displayOptions: {
+            show: {
+                operation: [operations_1.Operation.Send, operations_1.Operation.SendWithTemplate],
+            },
+        },
+    },
+    {
+        displayName: 'Subject',
+        name: 'subject',
+        type: 'string',
+        default: '',
+        required: true,
+        description: 'Email subject line',
+        displayOptions: {
+            show: {
+                operation: [operations_1.Operation.Send],
+            },
+        },
+    },
+    {
+        displayName: 'HTML Body',
+        name: 'htmlBody',
+        type: 'string',
+        typeOptions: { rows: 6 },
+        default: '',
+        description: 'HTML body of the email. At least one of HTML Body or Text Body is required.',
+        displayOptions: {
+            show: {
+                operation: [operations_1.Operation.Send],
+            },
+        },
+    },
+    {
+        displayName: 'Text Body',
+        name: 'textBody',
+        type: 'string',
+        typeOptions: { rows: 4 },
+        default: '',
+        description: 'Plain text body of the email. At least one of HTML Body or Text Body is required.',
+        displayOptions: {
+            show: {
+                operation: [operations_1.Operation.Send],
+            },
+        },
+    },
+];

package/dist/nodes/PostmarkEmail/descriptions/SendEmailSingleWithTemplate.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sendEmailSingleWithTemplateProperties = void 0;
+const operations_1 = require("../operations");
+// Top-level fields specific to the `sendWithTemplate` operation. From and To live in
+// SendEmailSingle.ts because they are shared with the plain `send` operation.
+exports.sendEmailSingleWithTemplateProperties = [
+    {
+        displayName: 'Template Source',
+        name: 'templateSource',
+        type: 'options',
+        default: 'alias',
+        options: [
+            { name: 'Alias', value: 'alias' },
+            { name: 'ID', value: 'id' },
+        ],
+        description: 'How to identify the template',
+        displayOptions: {
+            show: {
+                operation: [operations_1.Operation.SendWithTemplate],
+            },
+        },
+    },
+    {
+        displayName: 'Template ID',
+        name: 'templateId',
+        type: 'string',
+        default: '',
+        required: true,
+        placeholder: 'welcome-email or 12345',
+        description: 'Template alias (string) or numeric ID, depending on Template Source',
+        displayOptions: {
+            show: {
+                operation: [operations_1.Operation.SendWithTemplate],
+            },
+        },
+    },
+    {
+        displayName: 'Template Model',
+        name: 'templateModel',
+        type: 'json',
+        default: '{}',
+        description: 'JSON object of values to merge into the template',
+        displayOptions: {
+            show: {
+                operation: [operations_1.Operation.SendWithTemplate],
+            },
+        },
+    },
+];

package/dist/nodes/PostmarkEmail/descriptions/additionalFields.js

@@ -0,0 +1,165 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OPTIONAL_EMAIL_FIELDS = void 0;
+// Optional Postmark body fields. Spread directly into the editor (top-level for single
+// send/sendWithTemplate, nested inside per-message values for batch ops) so workflow
+// authors don't have to click "Add Field" before they can fill in Cc, Tag, Headers,
+// etc. — particularly painful when configuring batch messages.
+exports.OPTIONAL_EMAIL_FIELDS = [
+    {
+        displayName: 'Cc',
+        name: 'Cc',
+        type: 'string',
+        default: '',
+        description: 'Carbon-copy recipient email address(es), comma-separated',
+    },
+    {
+        displayName: 'Bcc',
+        name: 'Bcc',
+        type: 'string',
+        default: '',
+        description: 'Blind-carbon-copy recipient email address(es), comma-separated',
+    },
+    {
+        displayName: 'Reply To',
+        name: 'ReplyTo',
+        type: 'string',
+        default: '',
+        description: 'Reply-To email address override',
+    },
+    {
+        displayName: 'Message Stream',
+        name: 'MessageStream',
+        type: 'string',
+        default: '',
+        placeholder: 'outbound',
+        description: 'Per-message Postmark message stream ID. Overrides the top-level Message Stream parameter for this message only.',
+    },
+    {
+        displayName: 'Tag',
+        name: 'Tag',
+        type: 'string',
+        default: '',
+        description: 'Tag for grouping in stats and webhooks',
+    },
+    {
+        displayName: 'Track Opens',
+        name: 'TrackOpens',
+        type: 'boolean',
+        default: false,
+        description: 'Whether to track email opens (HTML emails only)',
+    },
+    {
+        displayName: 'Track Links',
+        name: 'TrackLinks',
+        type: 'options',
+        default: 'None',
+        description: 'Click tracking mode for links in the email body',
+        options: [
+            { name: 'None', value: 'None' },
+            { name: 'HTML and Text', value: 'HtmlAndText' },
+            { name: 'HTML Only', value: 'HtmlOnly' },
+            { name: 'Text Only', value: 'TextOnly' },
+        ],
+    },
+    {
+        displayName: 'Headers',
+        name: 'Headers',
+        type: 'fixedCollection',
+        default: {},
+        placeholder: 'Add Header',
+        typeOptions: { multipleValues: true },
+        description: 'Custom email headers',
+        options: [
+            {
+                name: 'header',
+                displayName: 'Header',
+                values: [
+                    {
+                        displayName: 'Name',
+                        name: 'Name',
+                        type: 'string',
+                        default: '',
+                        placeholder: 'X-Custom-Header',
+                        description: 'Header name',
+                    },
+                    {
+                        displayName: 'Value',
+                        name: 'Value',
+                        type: 'string',
+                        default: '',
+                        description: 'Header value',
+                    },
+                ],
+            },
+        ],
+    },
+    {
+        displayName: 'Metadata',
+        name: 'Metadata',
+        type: 'fixedCollection',
+        default: {},
+        placeholder: 'Add Metadata Pair',
+        typeOptions: { multipleValues: true },
+        description: 'Custom metadata pairs attached to the email (visible in webhook payloads)',
+        options: [
+            {
+                name: 'pair',
+                displayName: 'Pair',
+                values: [
+                    { displayName: 'Key', name: 'key', type: 'string', default: '' },
+                    { displayName: 'Value', name: 'value', type: 'string', default: '' },
+                ],
+            },
+        ],
+    },
+    {
+        displayName: 'Attachments',
+        name: 'Attachments',
+        type: 'fixedCollection',
+        default: {},
+        placeholder: 'Add Attachment',
+        typeOptions: { multipleValues: true },
+        description: 'File attachments',
+        options: [
+            {
+                name: 'attachment',
+                displayName: 'Attachment',
+                values: [
+                    {
+                        displayName: 'Name',
+                        name: 'Name',
+                        type: 'string',
+                        default: '',
+                        placeholder: 'invoice.pdf',
+                        description: 'Filename to display in the recipient\'s email client',
+                    },
+                    {
+                        displayName: 'Content',
+                        name: 'Content',
+                        type: 'string',
+                        typeOptions: { rows: 4 },
+                        default: '',
+                        description: 'Base64-encoded file content. From a previous binary node, use {{ $binary.data.toString("base64") }}.',
+                    },
+                    {
+                        displayName: 'Content Type',
+                        name: 'ContentType',
+                        type: 'string',
+                        default: '',
+                        placeholder: 'application/pdf',
+                        description: 'MIME type of the attachment, e.g. application/pdf or image/png',
+                    },
+                    {
+                        displayName: 'Content ID',
+                        name: 'ContentID',
+                        type: 'string',
+                        default: '',
+                        placeholder: 'cid:image1',
+                        description: 'Optional. For inline images, set to "cid:imageId" and reference in HTML body via <img src="cid:imageId" />.',
+                    },
+                ],
+            },
+        ],
+    },
+];

package/dist/nodes/PostmarkEmail/descriptions/index.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ALL_PROPERTIES = void 0;
+const operation_1 = require("./operation");
+const SendEmailSingle_1 = require("./SendEmailSingle");
+const SendEmailSingleWithTemplate_1 = require("./SendEmailSingleWithTemplate");
+const SendEmailBatch_1 = require("./SendEmailBatch");
+const SendEmailBatchWithTemplates_1 = require("./SendEmailBatchWithTemplates");
+const sharedFields_1 = require("./sharedFields");
+// Order matters for the editor: it concatenates the visible properties top-to-bottom.
+// Particularly: singleOptionalFields must come *after* the template fields so they
+// render below the Template fields for `sendWithTemplate` (rather than between
+// From/To and the Template fields).
+exports.ALL_PROPERTIES = [
+    operation_1.operationProperty,
+    ...SendEmailSingle_1.sendEmailSingleProperties,
+    ...SendEmailSingleWithTemplate_1.sendEmailSingleWithTemplateProperties,
+    ...sharedFields_1.singleOptionalFields,
+    SendEmailBatch_1.sendEmailBatchProperty,
+    SendEmailBatchWithTemplates_1.sendEmailBatchWithTemplatesProperty,
+    sharedFields_1.messageStreamProperty,
+];

package/dist/nodes/PostmarkEmail/descriptions/operation.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.operationProperty = void 0;
+const operations_1 = require("../operations");
+// The n8n linter's static analysis doesn't recognize `Operation.Send` as a literal default,
+// so it raises `node-param-default-missing` on this object. The default *is* set — suppress
+// the false positive rather than duplicating the value as a magic string.
+// eslint-disable-next-line n8n-nodes-base/node-param-default-missing
+exports.operationProperty = {
+    displayName: 'Operation',
+    name: 'operation',
+    type: 'options',
+    noDataExpression: true,
+    default: operations_1.Operation.Send,
+    options: [
+        {
+            name: 'Send',
+            value: operations_1.Operation.Send,
+            action: 'Send a single email',
+        },
+        {
+            name: 'Send With Template',
+            value: operations_1.Operation.SendWithTemplate,
+            action: 'Send a single templated email',
+        },
+        {
+            name: 'Send Batch',
+            value: operations_1.Operation.SendBatch,
+            action: 'Send multiple emails in one request',
+        },
+        {
+            name: 'Send Batch With Templates',
+            value: operations_1.Operation.SendBatchWithTemplates,
+            action: 'Send multiple templated emails in one request',
+        },
+    ],
+};

package/dist/nodes/PostmarkEmail/descriptions/sharedFields.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.messageStreamProperty = exports.singleOptionalFields = void 0;
+const operations_1 = require("../operations");
+const additionalFields_1 = require("./additionalFields");
+// Single-ops top-level optional fields: the same fields the batch per-message values
+// expose, but with displayOptions injected so they only render for `send` and
+// `sendWithTemplate`. MessageStream is excluded — the dedicated top-level
+// `messageStream` parameter (defined below) handles that case for single ops.
+//
+// Order matters in the editor: this set spreads *after* the template fields so that
+// for `sendWithTemplate` the optional fields render below the Template fields rather
+// than between From/To and them.
+exports.singleOptionalFields = additionalFields_1.OPTIONAL_EMAIL_FIELDS
+    .filter((field) => field.name !== 'MessageStream')
+    .map((field) => ({
+    ...field,
+    displayOptions: {
+        show: {
+            operation: [operations_1.Operation.Send, operations_1.Operation.SendWithTemplate],
+        },
+    },
+}));
+exports.messageStreamProperty = {
+    displayName: 'Message Stream',
+    name: 'messageStream',
+    type: 'string',
+    default: '',
+    placeholder: 'outbound',
+    description: 'Message stream ID used for sending. Leave empty to use the default outbound transactional stream. For batch operations, applied as a default to each message that does not specify its own Message Stream override.',
+};