Skip to content

Commit 4feed76

Browse files
authored
Merge pull request #6 from railsware/readme-update
Readme update
2 parents bea9674 + d2be47f commit 4feed76

File tree

1 file changed

+38
-5
lines changed

1 file changed

+38
-5
lines changed

README.md

Lines changed: 38 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,39 @@
1-
# Mailtrap.io N8N Integration
1+
# Mailtrap.io N8N Integration - Official
22

33
This is the official Mailtrap.io integration for N8N, allowing you to seamlessly integrate Mailtrap's email testing and delivery services into your N8N workflows.
44

5+
## Prerequisites
6+
7+
Before using this integration, please ensure you have:
8+
- A [Mailtrap.io](https://mailtrap.io/signup) account
9+
- Your sending [domain verified](https://mailtrap.io/sending/domains) in Mailtrap (required for sending emails)
10+
11+
## Installation
12+
13+
### Community Nodes (Recommended)
14+
For n8n version 0.187 and later, you can install this node through the Community Nodes panel:
15+
16+
1. Go to Settings > Community Nodes
17+
2. Select Install
18+
3. Enter `n8n-nodes-mailtrap` in Enter npm package name
19+
4. Agree to the risks of using community nodes
20+
5. Select Install
21+
22+
### Manual Installation
23+
Alternatively, you can install the node manually using one of these methods:
24+
25+
#### Using npm
26+
```bash
27+
npm install n8n-nodes-mailtrap
28+
```
29+
30+
#### Using pnpm
31+
```bash
32+
pnpm add n8n-nodes-mailtrap
33+
```
34+
35+
For more detailed installation instructions, please refer to the [n8n community nodes documentation](https://docs.n8n.io/integrations/community-nodes/installation/).
36+
537
## Features
638

739
This integration provides the following capabilities:
@@ -14,11 +46,12 @@ This integration provides the following capabilities:
1446
- Update contact information
1547
- Get a list of your Mailtrap Lists
1648

17-
## Prerequisites
49+
## Usage
1850

19-
Before using this integration, please ensure you have:
20-
- A [Mailtrap.io](https://mailtrap.io) account
21-
- Your sending domain verified in Mailtrap (required for sending emails)
51+
1. After installation, restart your n8n instance
52+
2. In your n8n workflow, you'll find the Mailtrap node under the "Mailtrap" category
53+
3. Configure the node with your [Mailtrap API token](https://mailtrap.io/api-tokens) (you can find it in your Mailtrap account settings)
54+
4. Use the node to send emails or manage contacts according to your needs
2255

2356
## Node local development setup
2457
### Prerequisites

0 commit comments

Comments
 (0)