https://github.com/railsware/mailtrap-nodejs
Official mailtrap.io Node.js client
https://github.com/railsware/mailtrap-nodejs
email javascript mail mailtrap-io nodejs typescript
Last synced: 9 months ago
JSON representation
Official mailtrap.io Node.js client
- Host: GitHub
- URL: https://github.com/railsware/mailtrap-nodejs
- Owner: railsware
- License: mit
- Created: 2022-06-13T16:00:30.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-02-28T17:22:29.000Z (10 months ago)
- Last Synced: 2025-04-04T00:29:46.434Z (9 months ago)
- Topics: email, javascript, mail, mailtrap-io, nodejs, typescript
- Language: TypeScript
- Homepage: https://mailtrap.io
- Size: 426 KB
- Stars: 73
- Watchers: 19
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://github.com/railsware/mailtrap-nodejs/actions/workflows/test.yml)
[](https://www.npmjs.com/package/mailtrap)
[](https://www.npmjs.com/package/mailtrap)
# Official Mailtrap Node.js client
This NPM package offers integration with the [official API](https://api-docs.mailtrap.io/) for [Mailtrap](https://mailtrap.io).
Quickly add email sending functionality to your Node.js application with Mailtrap.
## Installation
Use yarn or npm to install the package:
```sh
yarn add mailtrap
# or, if you are using NPM:
npm install mailtrap
```
## Usage
### Minimal
```ts
import { MailtrapClient } from "mailtrap"
/**
* For this example to work, you need to set up a sending domain,
* and obtain a token that is authorized to send from the domain.
*/
const TOKEN = "";
const SENDER_EMAIL = "";
const RECIPIENT_EMAIL = "";
const client = new MailtrapClient({ token: TOKEN });
const sender = { name: "Mailtrap Test", email: SENDER_EMAIL };
client
.send({
from: sender,
to: [{ email: RECIPIENT_EMAIL }],
subject: "Hello from Mailtrap!",
text: "Welcome to Mailtrap Sending!",
})
.then(console.log)
.catch(console.error);
```
Refer to the [`examples`](examples) folder for the source code of this and other advanced examples.
### General API
- [List User & Invite account accesses](examples/general/account-accesses.ts)
- [Remove account access](examples/general/accounts.ts)
- [Permissions](examples/general/permissions.ts)
### Sending API
- [Advanced](examples/sending/everything.ts)
- [Minimal](examples/sending/minimal.ts)
- [Send email using template](examples/sending/template.ts)
- [Nodemailer transport](examples/sending/transport.ts)
### Email testing API
- [Attachments](examples/testing/attachments.ts)
- [Inboxes](examples/testing/inboxes.ts)
- [Messages](examples/testing/messages.ts)
- [Projects](examples/testing/projects.ts)
- [Send mail using template](examples/testing/template.ts)
### Bulk sending API
- [Send mail](examples/bulk/send-mail.ts)
### Nodemailer Transport
> NOTE: [Nodemailer](https://www.npmjs.com/package/nodemailer) is needed as a dependency.
```sh
yarn add nodemailer
# or, if you are using NPM:
npm install --s nodemailer
```
If you're using Typescript, install `@types/nodemailer` as a `devDependency`.
```sh
yarn add --dev @types/nodemailer
# or, if you are using NPM:
npm install --s-dev @types/nodemailer
You can provide Mailtrap specific keys like `category`, `customVariables`, `templateUuid` and `templateVariables`.
```
See transport usage below:
- [Transport](examples/sending/transport.ts)
## Development
This library is developed using [TypeScript](https://www.typescriptlang.org).
Use `yarn lint` to perform linting with [ESLint](https://eslint.org).
## Contributing
Bug reports and pull requests are welcome on [GitHub](https://github.com/railsware/mailtrap-nodejs). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](CODE_OF_CONDUCT.md).
## License
The package is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the Mailtrap project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).
## Compatibility with previous releases
Versions of this package up to 2.0.2 were an [unofficial client](https://github.com/vchin/mailtrap-client) developed by [@vchin](https://github.com/vchin). Package version 3 is a completely new package.