n8n-nodes-postmark-smtp 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +79 -0
- package/package.json +57 -0
package/README.md
ADDED
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
# n8n-nodes-postmark-smtp
|
|
2
|
+
|
|
3
|
+
This is an n8n community node. It lets you use Postmark to send transactional emails directly from your n8n workflows.
|
|
4
|
+
|
|
5
|
+
[n8n](https://n8n.io/) is a fair-code licensed workflow automation platform.
|
|
6
|
+
|
|
7
|
+
[Postmark](https://postmarkapp.com/) is a fast and reliable email delivery service for developers.
|
|
8
|
+
|
|
9
|
+
## Features
|
|
10
|
+
|
|
11
|
+
- **Send Email**: Send individual emails with support for:
|
|
12
|
+
- HTML and Text bodies.
|
|
13
|
+
- Attachments (binary data).
|
|
14
|
+
- CC and BCC recipients.
|
|
15
|
+
- Dynamic sender verification (loads verified domains from your account).
|
|
16
|
+
- **Batch Send Email**: Send multiple emails in a single API request for better performance.
|
|
17
|
+
- **Send Email with Template**: Use Postmark's template feature to send emails by providing a Template ID and a Model (JSON).
|
|
18
|
+
|
|
19
|
+
## Credentials
|
|
20
|
+
|
|
21
|
+
This node requires two types of credentials:
|
|
22
|
+
|
|
23
|
+
1. **Postmark Server Token**: Required for sending emails. You can find this in your Postmark server settings under "API Tokens".
|
|
24
|
+
2. **Postmark Account Token**: Required *only* if you want to use the "From (Domain)" dropdown to fetch verified domains. You can find this in your Postmark account settings.
|
|
25
|
+
|
|
26
|
+
## Installation
|
|
27
|
+
|
|
28
|
+
### Community Node (Recommended)
|
|
29
|
+
You can install this node directly in n8n via the **Settings > Community Nodes** panel. Search for `n8n-nodes-postmark-smtp`.
|
|
30
|
+
|
|
31
|
+
### Manual Installation
|
|
32
|
+
To install this node manually in your n8n Docker instance:
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
docker exec -it n8n npm install n8n-nodes-postmark-smtp
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
## Usage
|
|
39
|
+
|
|
40
|
+
### sending an Email
|
|
41
|
+
1. Select the **Send Email** operation.
|
|
42
|
+
2. Connect your **Postmark Server Token**.
|
|
43
|
+
3. (Optional) Connect your **Postmark Account Token** to auto-populate the *From (Domain)* field.
|
|
44
|
+
4. Enter the *From (Local Part)* (e.g., `info` for `info@example.com`).
|
|
45
|
+
5. Select a valid *From (Domain)*.
|
|
46
|
+
6. Enter the recipient(s) in *To*.
|
|
47
|
+
7. Fill in *Subject*, *HTML Body*, and *Text Body*.
|
|
48
|
+
|
|
49
|
+
### Sending with Templates
|
|
50
|
+
1. Select the **Send Email with Template** operation.
|
|
51
|
+
2. Enter the **Template ID** (found in Postmark UI).
|
|
52
|
+
3. Provide the **Template Model** as a JSON object matching your template variables.
|
|
53
|
+
```json
|
|
54
|
+
{
|
|
55
|
+
"user_name": "John Doe",
|
|
56
|
+
"action_url": "https://example.com/login"
|
|
57
|
+
}
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
## Development
|
|
61
|
+
|
|
62
|
+
To develop and test this node locally:
|
|
63
|
+
|
|
64
|
+
1. **Install dependencies**:
|
|
65
|
+
```bash
|
|
66
|
+
npm install
|
|
67
|
+
```
|
|
68
|
+
2. **Build the node**:
|
|
69
|
+
```bash
|
|
70
|
+
npm run build
|
|
71
|
+
```
|
|
72
|
+
3. **Start n8n with this node**:
|
|
73
|
+
```bash
|
|
74
|
+
npm run dev
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
## License
|
|
78
|
+
|
|
79
|
+
MIT
|
package/package.json
ADDED
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "n8n-nodes-postmark-smtp",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "Postmark SMTP node for n8n",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"n8n-community-node-package"
|
|
7
|
+
],
|
|
8
|
+
"license": "MIT",
|
|
9
|
+
"homepage": "https://github.com/Ytosko/n8n-node-postmark-smtp#readme",
|
|
10
|
+
"author": {
|
|
11
|
+
"name": "Ytosko",
|
|
12
|
+
"email": "ytosko@ytosko.dev"
|
|
13
|
+
},
|
|
14
|
+
"repository": {
|
|
15
|
+
"type": "git",
|
|
16
|
+
"url": "git+https://github.com/Ytosko/n8n-node-postmark-smtp.git"
|
|
17
|
+
},
|
|
18
|
+
"main": "index.js",
|
|
19
|
+
"scripts": {
|
|
20
|
+
"build": "n8n-node build",
|
|
21
|
+
"dev": "n8n-node dev",
|
|
22
|
+
"lint": "n8n-node lint",
|
|
23
|
+
"lint:fix": "n8n-node lint --fix",
|
|
24
|
+
"release": "n8n-node release",
|
|
25
|
+
"test": "jest"
|
|
26
|
+
},
|
|
27
|
+
"files": [
|
|
28
|
+
"dist"
|
|
29
|
+
],
|
|
30
|
+
"n8n": {
|
|
31
|
+
"nodes": [
|
|
32
|
+
"dist/nodes/PostmarkSmtp/PostmarkSmtp.node.js"
|
|
33
|
+
],
|
|
34
|
+
"credentials": [
|
|
35
|
+
"dist/credentials/PostmarkServerToken.credentials.js",
|
|
36
|
+
"dist/credentials/PostmarkAccountToken.credentials.js"
|
|
37
|
+
]
|
|
38
|
+
},
|
|
39
|
+
"devDependencies": {
|
|
40
|
+
"@n8n/node-cli": "^0.17.0",
|
|
41
|
+
"@types/jest": "^29.5.0",
|
|
42
|
+
"@types/node": "^18.15.11",
|
|
43
|
+
"@types/request-promise-native": "^1.0.21",
|
|
44
|
+
"@typescript-eslint/parser": "^8.51.0",
|
|
45
|
+
"eslint": "^8.38.0",
|
|
46
|
+
"eslint-plugin-n8n-nodes-base": "^1.11.0",
|
|
47
|
+
"jest": "^29.5.0",
|
|
48
|
+
"n8n-core": "^1.2.0",
|
|
49
|
+
"n8n-workflow": "^1.2.0",
|
|
50
|
+
"prettier": "^2.8.7",
|
|
51
|
+
"ts-jest": "^29.1.0",
|
|
52
|
+
"typescript": "^5.0.4"
|
|
53
|
+
},
|
|
54
|
+
"peerDependencies": {
|
|
55
|
+
"n8n-workflow": "*"
|
|
56
|
+
}
|
|
57
|
+
}
|