Package Health Score

77 / 100

security
No known security issues
popularity
Recognized
maintenance
Sustainable
community
Sustainable

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
3.4.0	\|	07/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.3.0	\|	01/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.0.2	\|	08/2018		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.0.3	\|	04/2018		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.0.21	\|	03/2018		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Recognized

Weekly Downloads (21,158)

GitHub Stars: 62
Forks: 7
Contributors: 20

Direct Usage Popularity

The npm package mailtrap receives a total of 21,158 downloads a week. As such, we scored mailtrap popularity level to be Recognized.

Based on project statistics from the GitHub repository for the npm package mailtrap, we found that it has been starred 62 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: Yes
Contributors: 20
Funding: No

With more than 10 contributors for the mailtrap repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 0
Open PR: 0
Last Release: 5 months ago
Last Commit: 17 days ago

Further analysis of the maintenance status of mailtrap based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that mailtrap demonstrates a positive version release cadence with at least one new version released in the past 12 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=16.20.1

Age: 7 years
Dependencies: 1 Direct
Versions: 43
Install Size: 67.7 kB
Dist-tags: 2
# of Files: 71
Maintainers: 1
TS Typings: Yes

mailtrap has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

Official Mailtrap Node.js client

This NPM package offers integration with the official API for Mailtrap.

Quickly add email sending functionality to your Node.js application with Mailtrap.

Compatibility with previous releases

Versions of this package up to 2.0.2 were an unofficial client developed by @vchin. Package version 3 is a completely new package. It is still under development and does not support the testing API yet. Please continue using version 2 if you need access to the testing API.

Installation

Use yarn or npm to install the package:

yarn add mailtrap

# or, if you are using NPM:
npm install mailtrap

Usage

Minimal

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 folder for the source code of this and other advanced examples.

General API

Sending API

Email testing API

Bulk sending API

Send mail

Nodemailer Transport

> NOTE: Nodemailer is needed as a dependency.

yarn add nodemailer

# or, if you are using NPM:
npm install --s nodemailer

If you're using Typescript, install @types/nodemailer as a devDependency.

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

Development

This library is developed using TypeScript.

Use yarn lint to perform linting with ESLint.

Contributing

Bug reports and pull requests are welcome on GitHub. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The package is available as open source under the terms of the MIT License.

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.

mailtrap dependencies

axios

FAQs

What is mailtrap?

Official mailtrap.io API client. Visit Snyk Advisor to see a full health score report for mailtrap, including popularity, security, maintenance & community analysis.

Is mailtrap popular?

The npm package mailtrap receives a total of 21,158 weekly downloads. As such, mailtrap popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is mailtrap well maintained?

We found indications that mailtrap maintenance is sustainable demonstrating some project activity. We saw a total of 20 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is mailtrap safe to use?

The npm package mailtrap was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 21 December-2024, at 10:18 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (21,158)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

Official Mailtrap Node.js client

Compatibility with previous releases

Installation

Usage

Minimal

General API

Sending API

Email testing API

Bulk sending API

Nodemailer Transport

Development

Contributing

License

Code of Conduct

mailtrap dependencies

mailtrap development dependencies

FAQs

What is mailtrap?

Is mailtrap popular?

Is mailtrap well maintained?

Is mailtrap safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues